store/source/storpage.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: storpage.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 _STORE_STORPAGE_HXX_
  32 #define _STORE_STORPAGE_HXX_ "$Revision: 1.6.8.2 $"
  33
  34 #include "sal/types.h"
  35
  36 #include "object.hxx"
  37 #include "lockbyte.hxx"
  38
  39 #include "storbase.hxx"
  40 #include "storbios.hxx"
  41 #include "stortree.hxx"
  42
  43 namespace store
  44 {
  45
  46 struct OStoreDirectoryPageData;
  47 class  OStoreDirectoryPageObject;
  48
  49 /*========================================================================
  50  *
  51  * OStorePageManager interface.
  52  *
  53  *======================================================================*/
  54 class OStorePageManager : public store::OStorePageBIOS
  55 {
  56 public:
  57     /** Construction.
  58      */
  59     OStorePageManager (void);
  60
  61     /** Initialization (two-phase construction).
  62      */
  63     virtual storeError initialize (
  64         ILockBytes *    pLockBytes,
  65         storeAccessMode eAccessMode,
  66         sal_uInt16 &    rnPageSize);
  67
  68     /** isValid.
  69      *  @return sal_True  upon successful initialization,
  70      *          sal_False otherwise.
  71      */
  72     inline sal_Bool isValid (void) const;
  73
  74     /** DirectoryPage I/O (managed).
  75      */
  76     static storeError namei (
  77         const rtl_String *pPath,
  78         const rtl_String *pName,
  79         OStorePageKey    &rKey);
  80
  81     storeError iget (
  82         OStoreDirectoryPageObject & rPage, // [out]
  83         sal_uInt32                  nAttrib,
  84         const rtl_String *          pPath,
  85         const rtl_String *          pName,
  86         storeAccessMode             eMode);
  87
  88     storeError iterate (
  89         OStorePageKey &  rKey,
  90         OStorePageLink & rLink,
  91         sal_uInt32 &     rAttrib);
  92
  93     /** attrib [nAttrib = ((nAttrib & ~nMask1) | nMask2)].
  94      *  @see store_attrib()
  95      */
  96     storeError attrib (
  97         const OStorePageKey &rKey,
  98         sal_uInt32           nMask1,
  99         sal_uInt32           nMask2,
 100         sal_uInt32          &rAttrib);
 101
 102     /** link (insert Source Key as hardlink to Destination).
 103      *  @see store_link()
 104      */
 105     storeError link (
 106         const OStorePageKey &rSrcKey,
 107         const OStorePageKey &rDstKey);
 108
 109     /** symlink (insert Source DirectoryPage as symlink to Destination).
 110      *  @see store_symlink()
 111      */
 112     storeError symlink (
 113         const rtl_String    *pSrcPath,
 114         const rtl_String    *pSrcName,
 115         const OStorePageKey &rDstKey);
 116
 117     /** rename.
 118      *  @see store_rename()
 119      */
 120     storeError rename (
 121         const OStorePageKey &rSrcKey,
 122         const rtl_String    *pDstPath,
 123         const rtl_String    *pDstName);
 124
 125     /** remove.
 126      *  @see store_remove()
 127      */
 128     storeError remove (
 129         const OStorePageKey &rKey);
 130
 131     /** rebuild (combines recover and compact from 'Src' to 'Dst').
 132      *  @param  pSrcLB [in] accessed readonly.
 133      *  @param  pDstLB [in] truncated and accessed readwrite (as initialize()).
 134      *  @return store_E_None upon success.
 135      *
 136      *  @see store_rebuildFile()
 137      */
 138     storeError rebuild (
 139         ILockBytes *pSrcLB,
 140         ILockBytes *pDstLB);
 141
 142     /** IStoreHandle.
 143      */
 144     virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nTypeId);
 145
 146 protected:
 147     /** Destruction.
 148     */
 149     virtual ~OStorePageManager (void);
 150
 151 private:
 152     /** Implementation.
 153     */
 154     typedef OStorePageBIOS            base;
 155     typedef OStorePageManager         self;
 156
 157     typedef OStoreBTreeEntry          entry;
 158     typedef OStoreBTreeNodeData       page;
 159     typedef OStoreBTreeNodeObject     node;
 160
 161     typedef OStoreDirectoryPageData   inode;
 162     typedef PageHolderObject< inode > inode_holder_type;
 163
 164     /** IStoreHandle TypeId.
 165      */
 166     static const sal_uInt32 m_nTypeId;
 167
 168     /** IStoreHandle query() template function specialization.
 169      */
 170     friend OStorePageManager*
 171     SAL_CALL query<> (IStoreHandle *pHandle, OStorePageManager*);
 172
 173     /** Representation.
 174     */
 175     OStoreBTreeRootObject m_aRoot;
 176
 177     /** DirectoryPage I/O (managed).
 178      */
 179     storeError load_dirpage_Impl ( // @@@ => private: iget() @@@
 180         const OStorePageKey       &rKey,
 181         OStoreDirectoryPageObject &rPage);
 182
 183     storeError save_dirpage_Impl ( // @@@ => private: iget(), rebuild() @@@
 184         const OStorePageKey       &rKey,
 185         OStoreDirectoryPageObject &rPage);
 186
 187     /** find_lookup (node page and index, w/o split).
 188     */
 189     storeError find_lookup (
 190         OStoreBTreeNodeObject & rNode,
 191         sal_uInt16 &            rIndex,
 192         OStorePageKey const &   rKey);
 193
 194     /** remove (possibly down from root).
 195     */
 196     storeError remove_Impl (entry & rEntry);
 197
 198     /** Not implemented.
 199     */
 200     OStorePageManager (const OStorePageManager&);
 201     OStorePageManager& operator= (const OStorePageManager&);
 202 };
 203
 204 inline sal_Bool OStorePageManager::isValid (void) const
 205 {
 206     return (base::isValid() /* @@@ NYI && (m_aRoot.is()) */);
 207 }
 208
 209 template<> inline OStorePageManager*
 210 SAL_CALL query (IStoreHandle *pHandle, OStorePageManager*)
 211 {
 212     if (pHandle && pHandle->isKindOf (OStorePageManager::m_nTypeId))
 213     {
 214         // Handle is kind of OStorePageManager.
 215         return static_cast<OStorePageManager*>(pHandle);
 216     }
 217     return 0;
 218 }
 219
 220 /*========================================================================
 221  *
 222  * The End.
 223  *
 224  *======================================================================*/
 225
 226 } // namespace store
 227
 228 #endif /* !_STORE_STORPAGE_HXX_ */
 229