Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_SW_SOURCE_CORE_INC_LAYCACHE_HXX
      21             : #define INCLUDED_SW_SOURCE_CORE_INC_LAYCACHE_HXX
      22             : 
      23             : #include <tools/solar.h>
      24             : 
      25             : class SwDoc;
      26             : class SwLayCacheImpl;
      27             : class SvStream;
      28             : 
      29             : /*************************************************************************
      30             :  *                      class SwLayoutCache
      31             :  *
      32             :  * This class allows to save layout information in the file and it contains
      33             :  * this information after loading of a file.
      34             :  * Call Write(..) with a stream and the document to save and the page break
      35             :  * information of the document will be written.
      36             :  * Call Read(..) with a stream and the member pLayCacheImpl will
      37             :  * read the information from the stream and store it in an internal structur.
      38             :  * There's a simple locking mechanism at these classes,
      39             :  * if somebody reads the information, he increments the lock count by 1,
      40             :  * during the Read(..) function the lock count will set to $8000.
      41             :  *
      42             :  **************************************************************************/
      43             : class SwLayoutCache
      44             : {
      45             :     SwLayCacheImpl *pImpl;
      46             :     sal_uInt16 nLockCount;
      47             : 
      48             : public:
      49           0 :     SwLayoutCache() : pImpl( NULL ), nLockCount( 0 ) {}
      50             :     ~SwLayoutCache();
      51             : 
      52             :     void Read( SvStream &rStream );
      53             :     void Write( SvStream &rStream, const SwDoc& rDoc );
      54             : 
      55             :     void ClearImpl();
      56           0 :     sal_Bool IsLocked() const { return nLockCount > 0; }
      57           0 :     sal_uInt16& GetLockCount() { return nLockCount; }
      58           0 :     SwLayCacheImpl *LockImpl()
      59           0 :         { if( nLockCount & 0x8000 ) return NULL;
      60           0 :           if ( pImpl )
      61           0 :             ++nLockCount;
      62           0 :           return pImpl; }
      63           0 :     void UnlockImpl() { --nLockCount; }
      64             : 
      65             : #ifdef DBG_UTIL
      66             :     sal_Bool CompareLayout( const SwDoc& rDoc ) const;
      67             : #endif
      68             : };
      69             : #endif
      70             : 
      71             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */