svtools/inc/cacheoptions.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cacheoptions.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SVTOOLS_CACHEOPTIONS_HXX
  32 #define INCLUDED_SVTOOLS_CACHEOPTIONS_HXX
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include "svtools/svldllapi.h"
  39 #include <sal/types.h>
  40 #include <osl/mutex.hxx>
  41 #include <rtl/ustring.hxx>
  42
  43 //_________________________________________________________________________________________________________________
  44 //      forward declarations
  45 //_________________________________________________________________________________________________________________
  46
  47 /*-************************************************************************************************************//**
  48     @short                      forward declaration to our private date container implementation
  49     @descr                      We use these class as internal member to support small memory requirements.
  50                     You can create the container if it is neccessary. The class which use these mechanism
  51                     is faster and smaller then a complete implementation!
  52 *//*-*************************************************************************************************************/
  53
  54 class SvtCacheOptions_Impl;
  55
  56 //_________________________________________________________________________________________________________________
  57 //      declarations
  58 //_________________________________________________________________________________________________________________
  59
  60 /*-************************************************************************************************************//**
  61     @short                      collect informations about startup features
  62     @descr          -
  63
  64     @implements         -
  65     @base                       -
  66
  67     @devstatus          ready to use
  68 *//*-*************************************************************************************************************/
  69
  70 class SVL_DLLPUBLIC SvtCacheOptions
  71 {
  72     //-------------------------------------------------------------------------------------------------------------
  73     //  public methods
  74     //-------------------------------------------------------------------------------------------------------------
  75
  76     public:
  77
  78         //---------------------------------------------------------------------------------------------------------
  79         //      constructor / destructor
  80         //---------------------------------------------------------------------------------------------------------
  81
  82         /*-****************************************************************************************************//**
  83             @short              standard constructor and destructor
  84             @descr              This will initialize an instance with default values.
  85                         We implement these class with a refcount mechanism! Every instance of this class increase it
  86                         at create and decrease it at delete time - but all instances use the same data container!
  87                         He is implemented as a static member ...
  88
  89             @seealso    member m_nRefCount
  90             @seealso    member m_pDataContainer
  91
  92             @param              -
  93             @return             -
  94
  95             @onerror    -
  96         *//*-*****************************************************************************************************/
  97
  98          SvtCacheOptions();
  99         ~SvtCacheOptions();
 100
 101         //---------------------------------------------------------------------------------------------------------
 102         //      interface
 103         //---------------------------------------------------------------------------------------------------------
 104
 105         /*-****************************************************************************************************//**
 106             @short              interface methods to get and set value of config key "org.openoffice.Office.Common/_3D-Engine/..."
 107             @descr      These options describe internal states to enable/disable features of installed office.
 108
 109                         GetWriterOLE_Objects()
 110                         SetWriterOLE_Objects()                          =>      set the number of Writer OLE objects to be cached
 111
 112                         GetDrawingEngineOLE_Objects()
 113                         SetDrawingEngineOLE_Objects()           =>      set the number of DrawingEngine OLE objects to be cached
 114
 115                         GetGraphicManagerTotalCacheSize()
 116                         SetGraphicManagerTotalCacheSize()       =>      set the maximum cache size used by GraphicManager to cache graphic objects
 117
 118                         GetGraphicManagerObjectCacheSize()
 119                         SetGraphicManagerObjectCacheSize()      =>      set the maximum cache size for one GraphicObject to be cached by GraphicManager
 120
 121             @seealso    configuration package "org.openoffice.Office.Common/_3D-Engine"
 122         *//*-*****************************************************************************************************/
 123
 124         sal_Int32       GetWriterOLE_Objects() const;
 125         sal_Int32       GetDrawingEngineOLE_Objects() const;
 126         sal_Int32       GetGraphicManagerTotalCacheSize() const;
 127         sal_Int32       GetGraphicManagerObjectCacheSize() const;
 128         sal_Int32       GetGraphicManagerObjectReleaseTime() const;
 129
 130         void            SetWriterOLE_Objects( sal_Int32 nObjects );
 131         void            SetDrawingEngineOLE_Objects( sal_Int32 nObjects );
 132         void            SetGraphicManagerTotalCacheSize( sal_Int32 nTotalCacheSize );
 133         void            SetGraphicManagerObjectCacheSize( sal_Int32 nObjectCacheSize );
 134         void        SetGraphicManagerObjectReleaseTime( sal_Int32 nReleaseTimeSeconds );
 135
 136     //-------------------------------------------------------------------------------------------------------------
 137     //  private methods
 138     //-------------------------------------------------------------------------------------------------------------
 139
 140     private:
 141
 142         /*-****************************************************************************************************//**
 143             @short              return a reference to a static mutex
 144             @descr              These class use his own static mutex to be threadsafe.
 145                         We create a static mutex only for one ime and use at different times.
 146
 147             @seealso    -
 148
 149             @param              -
 150             @return             A reference to a static mutex member.
 151
 152             @onerror    -
 153         *//*-*****************************************************************************************************/
 154
 155         SVL_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex();
 156
 157     //-------------------------------------------------------------------------------------------------------------
 158     //  private member
 159     //-------------------------------------------------------------------------------------------------------------
 160
 161     private:
 162
 163         /*Attention
 164
 165             Don't initialize these static member in these header!
 166             a) Double dfined symbols will be detected ...
 167             b) and unresolved externals exist at linking time.
 168             Do it in your source only.
 169          */
 170
 171         static SvtCacheOptions_Impl*    m_pDataContainer        ;       /// impl. data container as dynamic pointer for smaller memory requirements!
 172         static sal_Int32                                m_nRefCount                     ;       /// internal ref count mechanism
 173
 174 };
 175
 176 #endif // #ifndef INCLUDED_SVTOOLS_CACHEOPTIONS_HXX