laycache.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SW_SOURCE_CORE_INC_LAYCACHE_HXX
#define INCLUDED_SW_SOURCE_CORE_INC_LAYCACHE_HXX

#include <sal/types.h>
#include <memory>

class SwDoc;
class SwLayCacheImpl;
class SvStream;

/*
 * This class allows to save layout information in the file and it contains
 * this information after loading of a file.
 * Call Write(..) with a stream and the document to save and the page break
 * information of the document will be written.
 * Call Read(..) with a stream and the member pLayCacheImpl will
 * read the information from the stream and store it in an internal structure.
 * There's a simple locking mechanism at these classes,
 * if somebody reads the information, he increments the lock count by 1,
 * during the Read(..) function the lock count will set to $8000.
 */
class SwLayoutCache
{
    std::unique_ptr<SwLayCacheImpl> m_pImpl;
    sal_uInt16 m_nLockCount;

public:
    SwLayoutCache();
    ~SwLayoutCache();

    void Read( SvStream &rStream );
    static void Write( SvStream &rStream, const SwDoc& rDoc );

    void ClearImpl();
    bool IsLocked() const { return m_nLockCount > 0; }
    sal_uInt16& GetLockCount() { return m_nLockCount; }
    SwLayCacheImpl *LockImpl()
        { if( m_nLockCount & 0x8000 ) return nullptr;
          if ( m_pImpl )
            ++m_nLockCount;
          return m_pImpl.get(); }
    void UnlockImpl() { --m_nLockCount; }

#ifdef DBG_UTIL
    bool CompareLayout( const SwDoc& rDoc ) const;
#endif
};
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */