1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #ifndef _STORE_STORPAGE_HXX_
25*b1cdbd2cSJim Jagielski #define _STORE_STORPAGE_HXX_ "$Revision: 1.6.8.2 $"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "sal/types.h"
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #include "object.hxx"
30*b1cdbd2cSJim Jagielski #include "lockbyte.hxx"
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski #include "storbase.hxx"
33*b1cdbd2cSJim Jagielski #include "storbios.hxx"
34*b1cdbd2cSJim Jagielski #include "stortree.hxx"
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski namespace store
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski struct OStoreDirectoryPageData;
40*b1cdbd2cSJim Jagielski class OStoreDirectoryPageObject;
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski /*========================================================================
43*b1cdbd2cSJim Jagielski *
44*b1cdbd2cSJim Jagielski * OStorePageManager interface.
45*b1cdbd2cSJim Jagielski *
46*b1cdbd2cSJim Jagielski *======================================================================*/
47*b1cdbd2cSJim Jagielski class OStorePageManager : public store::OStorePageBIOS
48*b1cdbd2cSJim Jagielski {
49*b1cdbd2cSJim Jagielski public:
50*b1cdbd2cSJim Jagielski /** Construction.
51*b1cdbd2cSJim Jagielski */
52*b1cdbd2cSJim Jagielski OStorePageManager (void);
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski /** Initialization (two-phase construction).
55*b1cdbd2cSJim Jagielski */
56*b1cdbd2cSJim Jagielski virtual storeError initialize (
57*b1cdbd2cSJim Jagielski ILockBytes * pLockBytes,
58*b1cdbd2cSJim Jagielski storeAccessMode eAccessMode,
59*b1cdbd2cSJim Jagielski sal_uInt16 & rnPageSize);
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski /** isValid.
62*b1cdbd2cSJim Jagielski * @return sal_True upon successful initialization,
63*b1cdbd2cSJim Jagielski * sal_False otherwise.
64*b1cdbd2cSJim Jagielski */
65*b1cdbd2cSJim Jagielski inline sal_Bool isValid (void) const;
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski /** DirectoryPage I/O (managed).
68*b1cdbd2cSJim Jagielski */
69*b1cdbd2cSJim Jagielski static storeError namei (
70*b1cdbd2cSJim Jagielski const rtl_String *pPath,
71*b1cdbd2cSJim Jagielski const rtl_String *pName,
72*b1cdbd2cSJim Jagielski OStorePageKey &rKey);
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski storeError iget (
75*b1cdbd2cSJim Jagielski OStoreDirectoryPageObject & rPage, // [out]
76*b1cdbd2cSJim Jagielski sal_uInt32 nAttrib,
77*b1cdbd2cSJim Jagielski const rtl_String * pPath,
78*b1cdbd2cSJim Jagielski const rtl_String * pName,
79*b1cdbd2cSJim Jagielski storeAccessMode eMode);
80*b1cdbd2cSJim Jagielski
81*b1cdbd2cSJim Jagielski storeError iterate (
82*b1cdbd2cSJim Jagielski OStorePageKey & rKey,
83*b1cdbd2cSJim Jagielski OStorePageLink & rLink,
84*b1cdbd2cSJim Jagielski sal_uInt32 & rAttrib);
85*b1cdbd2cSJim Jagielski
86*b1cdbd2cSJim Jagielski /** attrib [nAttrib = ((nAttrib & ~nMask1) | nMask2)].
87*b1cdbd2cSJim Jagielski * @see store_attrib()
88*b1cdbd2cSJim Jagielski */
89*b1cdbd2cSJim Jagielski storeError attrib (
90*b1cdbd2cSJim Jagielski const OStorePageKey &rKey,
91*b1cdbd2cSJim Jagielski sal_uInt32 nMask1,
92*b1cdbd2cSJim Jagielski sal_uInt32 nMask2,
93*b1cdbd2cSJim Jagielski sal_uInt32 &rAttrib);
94*b1cdbd2cSJim Jagielski
95*b1cdbd2cSJim Jagielski /** link (insert Source Key as hardlink to Destination).
96*b1cdbd2cSJim Jagielski * @see store_link()
97*b1cdbd2cSJim Jagielski */
98*b1cdbd2cSJim Jagielski storeError link (
99*b1cdbd2cSJim Jagielski const OStorePageKey &rSrcKey,
100*b1cdbd2cSJim Jagielski const OStorePageKey &rDstKey);
101*b1cdbd2cSJim Jagielski
102*b1cdbd2cSJim Jagielski /** symlink (insert Source DirectoryPage as symlink to Destination).
103*b1cdbd2cSJim Jagielski * @see store_symlink()
104*b1cdbd2cSJim Jagielski */
105*b1cdbd2cSJim Jagielski storeError symlink (
106*b1cdbd2cSJim Jagielski const rtl_String *pSrcPath,
107*b1cdbd2cSJim Jagielski const rtl_String *pSrcName,
108*b1cdbd2cSJim Jagielski const OStorePageKey &rDstKey);
109*b1cdbd2cSJim Jagielski
110*b1cdbd2cSJim Jagielski /** rename.
111*b1cdbd2cSJim Jagielski * @see store_rename()
112*b1cdbd2cSJim Jagielski */
113*b1cdbd2cSJim Jagielski storeError rename (
114*b1cdbd2cSJim Jagielski const OStorePageKey &rSrcKey,
115*b1cdbd2cSJim Jagielski const rtl_String *pDstPath,
116*b1cdbd2cSJim Jagielski const rtl_String *pDstName);
117*b1cdbd2cSJim Jagielski
118*b1cdbd2cSJim Jagielski /** remove.
119*b1cdbd2cSJim Jagielski * @see store_remove()
120*b1cdbd2cSJim Jagielski */
121*b1cdbd2cSJim Jagielski storeError remove (
122*b1cdbd2cSJim Jagielski const OStorePageKey &rKey);
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski /** rebuild (combines recover and compact from 'Src' to 'Dst').
125*b1cdbd2cSJim Jagielski * @param pSrcLB [in] accessed readonly.
126*b1cdbd2cSJim Jagielski * @param pDstLB [in] truncated and accessed readwrite (as initialize()).
127*b1cdbd2cSJim Jagielski * @return store_E_None upon success.
128*b1cdbd2cSJim Jagielski *
129*b1cdbd2cSJim Jagielski * @see store_rebuildFile()
130*b1cdbd2cSJim Jagielski */
131*b1cdbd2cSJim Jagielski storeError rebuild (
132*b1cdbd2cSJim Jagielski ILockBytes *pSrcLB,
133*b1cdbd2cSJim Jagielski ILockBytes *pDstLB);
134*b1cdbd2cSJim Jagielski
135*b1cdbd2cSJim Jagielski /** IStoreHandle.
136*b1cdbd2cSJim Jagielski */
137*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nTypeId);
138*b1cdbd2cSJim Jagielski
139*b1cdbd2cSJim Jagielski protected:
140*b1cdbd2cSJim Jagielski /** Destruction.
141*b1cdbd2cSJim Jagielski */
142*b1cdbd2cSJim Jagielski virtual ~OStorePageManager (void);
143*b1cdbd2cSJim Jagielski
144*b1cdbd2cSJim Jagielski private:
145*b1cdbd2cSJim Jagielski /** Implementation.
146*b1cdbd2cSJim Jagielski */
147*b1cdbd2cSJim Jagielski typedef OStorePageBIOS base;
148*b1cdbd2cSJim Jagielski typedef OStorePageManager self;
149*b1cdbd2cSJim Jagielski
150*b1cdbd2cSJim Jagielski typedef OStoreBTreeEntry entry;
151*b1cdbd2cSJim Jagielski typedef OStoreBTreeNodeData page;
152*b1cdbd2cSJim Jagielski typedef OStoreBTreeNodeObject node;
153*b1cdbd2cSJim Jagielski
154*b1cdbd2cSJim Jagielski typedef OStoreDirectoryPageData inode;
155*b1cdbd2cSJim Jagielski typedef PageHolderObject< inode > inode_holder_type;
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski /** IStoreHandle TypeId.
158*b1cdbd2cSJim Jagielski */
159*b1cdbd2cSJim Jagielski static const sal_uInt32 m_nTypeId;
160*b1cdbd2cSJim Jagielski
161*b1cdbd2cSJim Jagielski /** IStoreHandle query() template function specialization.
162*b1cdbd2cSJim Jagielski */
163*b1cdbd2cSJim Jagielski friend OStorePageManager*
164*b1cdbd2cSJim Jagielski SAL_CALL query<> (IStoreHandle *pHandle, OStorePageManager*);
165*b1cdbd2cSJim Jagielski
166*b1cdbd2cSJim Jagielski /** Representation.
167*b1cdbd2cSJim Jagielski */
168*b1cdbd2cSJim Jagielski OStoreBTreeRootObject m_aRoot;
169*b1cdbd2cSJim Jagielski
170*b1cdbd2cSJim Jagielski /** DirectoryPage I/O (managed).
171*b1cdbd2cSJim Jagielski */
172*b1cdbd2cSJim Jagielski storeError load_dirpage_Impl ( // @@@ => private: iget() @@@
173*b1cdbd2cSJim Jagielski const OStorePageKey &rKey,
174*b1cdbd2cSJim Jagielski OStoreDirectoryPageObject &rPage);
175*b1cdbd2cSJim Jagielski
176*b1cdbd2cSJim Jagielski storeError save_dirpage_Impl ( // @@@ => private: iget(), rebuild() @@@
177*b1cdbd2cSJim Jagielski const OStorePageKey &rKey,
178*b1cdbd2cSJim Jagielski OStoreDirectoryPageObject &rPage);
179*b1cdbd2cSJim Jagielski
180*b1cdbd2cSJim Jagielski /** find_lookup (node page and index, w/o split).
181*b1cdbd2cSJim Jagielski */
182*b1cdbd2cSJim Jagielski storeError find_lookup (
183*b1cdbd2cSJim Jagielski OStoreBTreeNodeObject & rNode,
184*b1cdbd2cSJim Jagielski sal_uInt16 & rIndex,
185*b1cdbd2cSJim Jagielski OStorePageKey const & rKey);
186*b1cdbd2cSJim Jagielski
187*b1cdbd2cSJim Jagielski /** remove (possibly down from root).
188*b1cdbd2cSJim Jagielski */
189*b1cdbd2cSJim Jagielski storeError remove_Impl (entry & rEntry);
190*b1cdbd2cSJim Jagielski
191*b1cdbd2cSJim Jagielski /** Not implemented.
192*b1cdbd2cSJim Jagielski */
193*b1cdbd2cSJim Jagielski OStorePageManager (const OStorePageManager&);
194*b1cdbd2cSJim Jagielski OStorePageManager& operator= (const OStorePageManager&);
195*b1cdbd2cSJim Jagielski };
196*b1cdbd2cSJim Jagielski
isValid(void) const197*b1cdbd2cSJim Jagielski inline sal_Bool OStorePageManager::isValid (void) const
198*b1cdbd2cSJim Jagielski {
199*b1cdbd2cSJim Jagielski return (base::isValid() /* @@@ NYI && (m_aRoot.is()) */);
200*b1cdbd2cSJim Jagielski }
201*b1cdbd2cSJim Jagielski
202*b1cdbd2cSJim Jagielski template<> inline OStorePageManager*
query(IStoreHandle * pHandle,OStorePageManager *)203*b1cdbd2cSJim Jagielski SAL_CALL query (IStoreHandle *pHandle, OStorePageManager*)
204*b1cdbd2cSJim Jagielski {
205*b1cdbd2cSJim Jagielski if (pHandle && pHandle->isKindOf (OStorePageManager::m_nTypeId))
206*b1cdbd2cSJim Jagielski {
207*b1cdbd2cSJim Jagielski // Handle is kind of OStorePageManager.
208*b1cdbd2cSJim Jagielski return static_cast<OStorePageManager*>(pHandle);
209*b1cdbd2cSJim Jagielski }
210*b1cdbd2cSJim Jagielski return 0;
211*b1cdbd2cSJim Jagielski }
212*b1cdbd2cSJim Jagielski
213*b1cdbd2cSJim Jagielski /*========================================================================
214*b1cdbd2cSJim Jagielski *
215*b1cdbd2cSJim Jagielski * The End.
216*b1cdbd2cSJim Jagielski *
217*b1cdbd2cSJim Jagielski *======================================================================*/
218*b1cdbd2cSJim Jagielski
219*b1cdbd2cSJim Jagielski } // namespace store
220*b1cdbd2cSJim Jagielski
221*b1cdbd2cSJim Jagielski #endif /* !_STORE_STORPAGE_HXX_ */
222*b1cdbd2cSJim Jagielski
223