store/source/storpage.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _STORE_STORPAGE_HXX_
  30 #define _STORE_STORPAGE_HXX_
  31
  32 #include "sal/types.h"
  33
  34 #include "object.hxx"
  35 #include "lockbyte.hxx"
  36
  37 #include "storbase.hxx"
  38 #include "storbios.hxx"
  39 #include "stortree.hxx"
  40
  41 namespace store
  42 {
  43
  44 struct OStoreDirectoryPageData;
  45 class  OStoreDirectoryPageObject;
  46
  47 /*========================================================================
  48  *
  49  * OStorePageManager interface.
  50  *
  51  *======================================================================*/
  52 class OStorePageManager : public store::OStorePageBIOS
  53 {
  54 public:
  55     /** Construction.
  56      */
  57     OStorePageManager (void);
  58
  59     /** Initialization (two-phase construction).
  60      */
  61     virtual storeError initialize (
  62         ILockBytes *    pLockBytes,
  63         storeAccessMode eAccessMode,
  64         sal_uInt16 &    rnPageSize);
  65
  66     /** isValid.
  67      *  @return sal_True  upon successful initialization,
  68      *          sal_False otherwise.
  69      */
  70     inline sal_Bool isValid (void) const;
  71
  72     /** DirectoryPage I/O (managed).
  73      */
  74     static storeError namei (
  75         const rtl_String *pPath,
  76         const rtl_String *pName,
  77         OStorePageKey    &rKey);
  78
  79     storeError iget (
  80         OStoreDirectoryPageObject & rPage, // [out]
  81         sal_uInt32                  nAttrib,
  82         const rtl_String *          pPath,
  83         const rtl_String *          pName,
  84         storeAccessMode             eMode);
  85
  86     storeError iterate (
  87         OStorePageKey &  rKey,
  88         OStorePageLink & rLink,
  89         sal_uInt32 &     rAttrib);
  90
  91     /** attrib [nAttrib = ((nAttrib & ~nMask1) | nMask2)].
  92      *  @see store_attrib()
  93      */
  94     storeError attrib (
  95         const OStorePageKey &rKey,
  96         sal_uInt32           nMask1,
  97         sal_uInt32           nMask2,
  98         sal_uInt32          &rAttrib);
  99
 100     /** link (insert Source Key as hardlink to Destination).
 101      *  @see store_link()
 102      */
 103     storeError link (
 104         const OStorePageKey &rSrcKey,
 105         const OStorePageKey &rDstKey);
 106
 107     /** symlink (insert Source DirectoryPage as symlink to Destination).
 108      *  @see store_symlink()
 109      */
 110     storeError symlink (
 111         const rtl_String    *pSrcPath,
 112         const rtl_String    *pSrcName,
 113         const OStorePageKey &rDstKey);
 114
 115     /** rename.
 116      *  @see store_rename()
 117      */
 118     storeError rename (
 119         const OStorePageKey &rSrcKey,
 120         const rtl_String    *pDstPath,
 121         const rtl_String    *pDstName);
 122
 123     /** remove.
 124      *  @see store_remove()
 125      */
 126     storeError remove (
 127         const OStorePageKey &rKey);
 128
 129     /** rebuild (combines recover and compact from 'Src' to 'Dst').
 130      *  @param  pSrcLB [in] accessed readonly.
 131      *  @param  pDstLB [in] truncated and accessed readwrite (as initialize()).
 132      *  @return store_E_None upon success.
 133      *
 134      *  @see store_rebuildFile()
 135      */
 136     storeError rebuild (
 137         ILockBytes *pSrcLB,
 138         ILockBytes *pDstLB);
 139
 140     /** IStoreHandle.
 141      */
 142     virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nTypeId);
 143
 144 protected:
 145     /** Destruction.
 146     */
 147     virtual ~OStorePageManager (void);
 148
 149 private:
 150     /** Implementation.
 151     */
 152     typedef OStorePageBIOS            base;
 153     typedef OStorePageManager         self;
 154
 155     typedef OStoreBTreeEntry          entry;
 156     typedef OStoreBTreeNodeData       page;
 157     typedef OStoreBTreeNodeObject     node;
 158
 159     typedef OStoreDirectoryPageData   inode;
 160     typedef PageHolderObject< inode > inode_holder_type;
 161
 162     /** IStoreHandle TypeId.
 163      */
 164     static const sal_uInt32 m_nTypeId;
 165
 166     /** IStoreHandle query() template function specialization.
 167      */
 168     friend OStorePageManager*
 169     SAL_CALL query<> (IStoreHandle *pHandle, OStorePageManager*);
 170
 171     /** Representation.
 172     */
 173     OStoreBTreeRootObject m_aRoot;
 174
 175     /** DirectoryPage I/O (managed).
 176      */
 177     storeError load_dirpage_Impl ( // @@@ => private: iget() @@@
 178         const OStorePageKey       &rKey,
 179         OStoreDirectoryPageObject &rPage);
 180
 181     storeError save_dirpage_Impl ( // @@@ => private: iget(), rebuild() @@@
 182         const OStorePageKey       &rKey,
 183         OStoreDirectoryPageObject &rPage);
 184
 185     /** find_lookup (node page and index, w/o split).
 186     */
 187     storeError find_lookup (
 188         OStoreBTreeNodeObject & rNode,
 189         sal_uInt16 &            rIndex,
 190         OStorePageKey const &   rKey);
 191
 192     /** remove (possibly down from root).
 193     */
 194     storeError remove_Impl (entry & rEntry);
 195
 196     /** Not implemented.
 197     */
 198     OStorePageManager (const OStorePageManager&);
 199     OStorePageManager& operator= (const OStorePageManager&);
 200 };
 201
 202 inline sal_Bool OStorePageManager::isValid (void) const
 203 {
 204     return (base::isValid() /* @@@ NYI && (m_aRoot.is()) */);
 205 }
 206
 207 template<> inline OStorePageManager*
 208 SAL_CALL query (IStoreHandle *pHandle, SAL_UNUSED_PARAMETER OStorePageManager*)
 209 {
 210     if (pHandle && pHandle->isKindOf (OStorePageManager::m_nTypeId))
 211     {
 212         // Handle is kind of OStorePageManager.
 213         return static_cast<OStorePageManager*>(pHandle);
 214     }
 215     return 0;
 216 }
 217
 218 /*========================================================================
 219  *
 220  * The End.
 221  *
 222  *======================================================================*/
 223
 224 } // namespace store
 225
 226 #endif /* !_STORE_STORPAGE_HXX_ */
 227
 228 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */