Branch data 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 _STORE_STORLCKB_HXX_
21 : : #define _STORE_STORLCKB_HXX_
22 : :
23 : : #include "sal/types.h"
24 : :
25 : : #include "rtl/ustring.h"
26 : : #include "rtl/ref.hxx"
27 : :
28 : : #include "object.hxx"
29 : : #include "storbase.hxx"
30 : : #include "storpage.hxx"
31 : :
32 : : namespace store
33 : : {
34 : :
35 : : struct OStoreDataPageData;
36 : : struct OStoreDirectoryPageData;
37 : :
38 : : /*========================================================================
39 : : *
40 : : * OStoreLockBytes interface.
41 : : *
42 : : *======================================================================*/
43 : : class OStoreLockBytes : public store::OStoreObject
44 : : {
45 : : public:
46 : : /** Construction.
47 : : */
48 : : OStoreLockBytes (void);
49 : :
50 : : /** create (two-phase construction).
51 : : * @param pManager [in]
52 : : * @param pPath [in]
53 : : * @param pName [in]
54 : : * @param eMode [in]
55 : : * @return store_E_None upon success
56 : : */
57 : : storeError create (
58 : : OStorePageManager *pManager,
59 : : rtl_String *pPath,
60 : : rtl_String *pName,
61 : : storeAccessMode eAccessMode);
62 : :
63 : : /** Read at Offset into Buffer.
64 : : * @param nOffset [in]
65 : : * @param pBuffer [out]
66 : : * @param nBytes [in]
67 : : * @param rnDone [out]
68 : : * @return store_E_None upon success
69 : : */
70 : : storeError readAt (
71 : : sal_uInt32 nOffset,
72 : : void *pBuffer,
73 : : sal_uInt32 nBytes,
74 : : sal_uInt32 &rnDone);
75 : :
76 : : /** Write at Offset from Buffer.
77 : : * @param nOffset [in]
78 : : * @param pBuffer [in]
79 : : * @param nBytes [in]
80 : : * @param rnDone [out]
81 : : * @return store_E_None upon success
82 : : */
83 : : storeError writeAt (
84 : : sal_uInt32 nOffset,
85 : : const void *pBuffer,
86 : : sal_uInt32 nBytes,
87 : : sal_uInt32 &rnDone);
88 : :
89 : : /** flush.
90 : : * @return store_E_None upon success
91 : : */
92 : : storeError flush (void);
93 : :
94 : : /** setSize.
95 : : * @param nSize [in]
96 : : * @return store_E_None upon success
97 : : */
98 : : storeError setSize (sal_uInt32 nSize);
99 : :
100 : : /** stat.
101 : : * @paran rnSize [out]
102 : : * @return store_E_None upon success
103 : : */
104 : : storeError stat (sal_uInt32 &rnSize);
105 : :
106 : : /** IStoreHandle.
107 : : */
108 : : virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nMagic);
109 : :
110 : : protected:
111 : : /** Destruction (OReference).
112 : : */
113 : : virtual ~OStoreLockBytes (void);
114 : :
115 : : private:
116 : : /** IStoreHandle TypeId.
117 : : */
118 : : static const sal_uInt32 m_nTypeId;
119 : :
120 : : /** IStoreHandle query() template specialization.
121 : : */
122 : : friend OStoreLockBytes*
123 : : SAL_CALL query<> (IStoreHandle *pHandle, OStoreLockBytes*);
124 : :
125 : : /** Representation.
126 : : */
127 : : rtl::Reference<OStorePageManager> m_xManager;
128 : :
129 : : typedef OStoreDataPageData data;
130 : : typedef OStoreDirectoryPageData inode;
131 : :
132 : : typedef PageHolderObject< inode > inode_holder_type;
133 : : inode_holder_type m_xNode;
134 : :
135 : : bool m_bWriteable;
136 : :
137 : : /** Not implemented.
138 : : */
139 : : OStoreLockBytes (const OStoreLockBytes&);
140 : : OStoreLockBytes& operator= (const OStoreLockBytes&);
141 : : };
142 : :
143 : : template<> inline OStoreLockBytes*
144 : 919348 : SAL_CALL query (IStoreHandle *pHandle, SAL_UNUSED_PARAMETER OStoreLockBytes*)
145 : : {
146 [ + - ][ + - ]: 919348 : if (pHandle && pHandle->isKindOf (OStoreLockBytes::m_nTypeId))
[ + - ]
147 : : {
148 : : // Handle is kind of OStoreLockBytes.
149 : 919348 : return static_cast<OStoreLockBytes*>(pHandle);
150 : : }
151 : 919348 : return 0;
152 : : }
153 : :
154 : : /*========================================================================
155 : : *
156 : : * The End.
157 : : *
158 : : *======================================================================*/
159 : :
160 : : } // namespace store
161 : :
162 : : #endif /* !_STORE_STORLCKB_HXX_ */
163 : :
164 : : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
