1 /*
2 * Compound Storage (32 bit version)
3 *
4 * Implemented using the documentation of the LAOLA project at
5 * <URL:http://wwwwbs.cs.tu-berlin.de/~schwartz/pmh/index.html>
6 * (Thanks to Martin Schwartz <schwartz@cs.tu-berlin.de>)
7 *
8 * This include file contains definitions of types and function
9 * prototypes that are used in the many files implementing the
10 * storage functionality
11 *
12 * Copyright 1998,1999 Francis Beaudet
13 * Copyright 1998,1999 Thuy Nguyen
14 *
15 * This library is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU Lesser General Public
17 * License as published by the Free Software Foundation; either
18 * version 2.1 of the License, or (at your option) any later version.
19 *
20 * This library is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * Lesser General Public License for more details.
24 *
25 * You should have received a copy of the GNU Lesser General Public
26 * License along with this library; if not, write to the Free Software
27 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 */
29 #ifndef __STORAGE32_H__
30 #define __STORAGE32_H__
31
32 #include <stdarg.h>
33
34 #include "windef.h"
35 #include "winbase.h"
36 #include "winnt.h"
37 #include "objbase.h"
38 #include "winreg.h"
39 #include "winternl.h"
40 #include "wine/list.h"
41
42 /*
43 * Definitions for the file format offsets.
44 */
45 static const ULONG OFFSET_BIGBLOCKSIZEBITS = 0x0000001e;
46 static const ULONG OFFSET_SMALLBLOCKSIZEBITS = 0x00000020;
47 static const ULONG OFFSET_BBDEPOTCOUNT = 0x0000002C;
48 static const ULONG OFFSET_ROOTSTARTBLOCK = 0x00000030;
49 static const ULONG OFFSET_SBDEPOTSTART = 0x0000003C;
50 static const ULONG OFFSET_SBDEPOTCOUNT = 0x00000040;
51 static const ULONG OFFSET_EXTBBDEPOTSTART = 0x00000044;
52 static const ULONG OFFSET_EXTBBDEPOTCOUNT = 0x00000048;
53 static const ULONG OFFSET_BBDEPOTSTART = 0x0000004C;
54 static const ULONG OFFSET_PS_NAME = 0x00000000;
55 static const ULONG OFFSET_PS_NAMELENGTH = 0x00000040;
56 static const ULONG OFFSET_PS_PROPERTYTYPE = 0x00000042;
57 static const ULONG OFFSET_PS_PREVIOUSPROP = 0x00000044;
58 static const ULONG OFFSET_PS_NEXTPROP = 0x00000048;
59 static const ULONG OFFSET_PS_DIRPROP = 0x0000004C;
60 static const ULONG OFFSET_PS_GUID = 0x00000050;
61 static const ULONG OFFSET_PS_TSS1 = 0x00000064;
62 static const ULONG OFFSET_PS_TSD1 = 0x00000068;
63 static const ULONG OFFSET_PS_TSS2 = 0x0000006C;
64 static const ULONG OFFSET_PS_TSD2 = 0x00000070;
65 static const ULONG OFFSET_PS_STARTBLOCK = 0x00000074;
66 static const ULONG OFFSET_PS_SIZE = 0x00000078;
67 static const WORD DEF_BIG_BLOCK_SIZE_BITS = 0x0009;
68 static const WORD DEF_SMALL_BLOCK_SIZE_BITS = 0x0006;
69 static const WORD DEF_BIG_BLOCK_SIZE = 0x0200;
70 static const WORD DEF_SMALL_BLOCK_SIZE = 0x0040;
71 static const ULONG BLOCK_EXTBBDEPOT = 0xFFFFFFFC;
72 static const ULONG BLOCK_SPECIAL = 0xFFFFFFFD;
73 static const ULONG BLOCK_END_OF_CHAIN = 0xFFFFFFFE;
74 static const ULONG BLOCK_UNUSED = 0xFFFFFFFF;
75 static const ULONG PROPERTY_NULL = 0xFFFFFFFF;
76
77 #define PROPERTY_NAME_MAX_LEN 0x20
78 #define PROPERTY_NAME_BUFFER_LEN 0x40
79
80 #define PROPSET_BLOCK_SIZE 0x00000080
81
82 /*
83 * Property type of relation
84 */
85 #define PROPERTY_RELATION_PREVIOUS 0
86 #define PROPERTY_RELATION_NEXT 1
87 #define PROPERTY_RELATION_DIR 2
88
89 /*
90 * Property type constants
91 */
92 #define PROPTYPE_STORAGE 0x01
93 #define PROPTYPE_STREAM 0x02
94 #define PROPTYPE_ROOT 0x05
95
96 /*
97 * These defines assume a hardcoded blocksize. The code will assert
98 * if the blocksize is different. Some changes will have to be done if it
99 * becomes the case.
100 */
101 #define BIG_BLOCK_SIZE 0x200
102 #define COUNT_BBDEPOTINHEADER 109
103 #define LIMIT_TO_USE_SMALL_BLOCK 0x1000
104 #define NUM_BLOCKS_PER_DEPOT_BLOCK 128
105
106 #define STGM_ACCESS_MODE(stgm) ((stgm)&0x0000f)
107 #define STGM_SHARE_MODE(stgm) ((stgm)&0x000f0)
108 #define STGM_CREATE_MODE(stgm) ((stgm)&0x0f000)
109
110 #define STGM_KNOWN_FLAGS (0xf0ff | \
111 STGM_TRANSACTED | STGM_CONVERT | STGM_PRIORITY | STGM_NOSCRATCH | \
112 STGM_NOSNAPSHOT | STGM_DIRECT_SWMR | STGM_DELETEONRELEASE | STGM_SIMPLE)
113
114 /*
115 * Forward declarations of all the structures used by the storage
116 * module.
117 */
118 typedef struct StorageBaseImpl StorageBaseImpl;
119 typedef struct StorageImpl StorageImpl;
120 typedef struct BlockChainStream BlockChainStream;
121 typedef struct SmallBlockChainStream SmallBlockChainStream;
122 typedef struct IEnumSTATSTGImpl IEnumSTATSTGImpl;
123 typedef struct StgProperty StgProperty;
124 typedef struct StgStreamImpl StgStreamImpl;
125
126 /*
127 * This utility structure is used to read/write the information in a storage
128 * property.
129 */
130 struct StgProperty
131 {
132 WCHAR name[PROPERTY_NAME_MAX_LEN];
133 WORD sizeOfNameString;
134 BYTE propertyType;
135 ULONG previousProperty;
136 ULONG nextProperty;
137 ULONG dirProperty;
138 GUID propertyUniqueID;
139 ULONG timeStampS1;
140 ULONG timeStampD1;
141 ULONG timeStampS2;
142 ULONG timeStampD2;
143 ULONG startingBlock;
144 ULARGE_INTEGER size;
145 };
146
147 /*************************************************************************
148 * Big Block File support
149 *
150 * The big block file is an abstraction of a flat file separated in
151 * same sized blocks. The implementation for the methods described in
152 * this section appear in stg_bigblockfile.c
153 */
154
155 typedef struct BigBlockFile BigBlockFile,*LPBIGBLOCKFILE;
156
157 /*
158 * Declaration of the functions used to manipulate the BigBlockFile
159 * data structure.
160 */
161 BigBlockFile* BIGBLOCKFILE_Construct(HANDLE hFile,
162 ILockBytes* pLkByt,
163 DWORD openFlags,
164 ULONG blocksize,
165 BOOL fileBased);
166 void BIGBLOCKFILE_Destructor(LPBIGBLOCKFILE This);
167 HRESULT BIGBLOCKFILE_EnsureExists(LPBIGBLOCKFILE This, ULONG index);
168 HRESULT BIGBLOCKFILE_SetSize(LPBIGBLOCKFILE This, ULARGE_INTEGER newSize);
169 HRESULT BIGBLOCKFILE_ReadAt(LPBIGBLOCKFILE This, ULARGE_INTEGER offset,
170 void* buffer, ULONG size, ULONG* bytesRead);
171 HRESULT BIGBLOCKFILE_WriteAt(LPBIGBLOCKFILE This, ULARGE_INTEGER offset,
172 const void* buffer, ULONG size, ULONG* bytesRead);
173
174 /*************************************************************************
175 * Ole Convert support
176 */
177
178 void OLECONVERT_CreateOleStream(LPSTORAGE pStorage);
179 HRESULT OLECONVERT_CreateCompObjStream(LPSTORAGE pStorage, LPCSTR strOleTypeName);
180
181 /****************************************************************************
182 * Storage32BaseImpl definitions.
183 *
184 * This structure defines the base information contained in all implementations
185 * of IStorage32 contained in this file storage implementation.
186 *
187 * In OOP terms, this is the base class for all the IStorage32 implementations
188 * contained in this file.
189 */
190 struct StorageBaseImpl
191 {
192 const IStorageVtbl *lpVtbl; /* Needs to be the first item in the struct
193 * since we want to cast this in a Storage32 pointer */
194
195 const IPropertySetStorageVtbl *pssVtbl; /* interface for adding a properties stream */
196
197 /*
198 * Stream tracking list
199 */
200
201 struct list strmHead;
202
203 /*
204 * Reference count of this object
205 */
206 LONG ref;
207
208 /*
209 * Ancestor storage (top level)
210 */
211 StorageImpl* ancestorStorage;
212
213 /*
214 * Index of the property for the root of
215 * this storage
216 */
217 ULONG rootPropertySetIndex;
218
219 /*
220 * virtual Destructor method.
221 */
222 void (*v_destructor)(StorageBaseImpl*);
223
224 /*
225 * flags that this storage was opened or created with
226 */
227 DWORD openFlags;
228
229 /*
230 * State bits appear to only be preserved while running. No in the stream
231 */
232 DWORD stateBits;
233 };
234
235 /****************************************************************************
236 * StorageBaseImpl stream list handlers
237 */
238
239 void StorageBaseImpl_AddStream(StorageBaseImpl * stg, StgStreamImpl * strm);
240 void StorageBaseImpl_RemoveStream(StorageBaseImpl * stg, StgStreamImpl * strm);
241
242 /****************************************************************************
243 * Storage32Impl definitions.
244 *
245 * This implementation of the IStorage32 interface represents a root
246 * storage. Basically, a document file.
247 */
248 struct StorageImpl
249 {
250 struct StorageBaseImpl base;
251
252 /*
253 * The following data members are specific to the Storage32Impl
254 * class
255 */
256 HANDLE hFile; /* Physical support for the Docfile */
257 LPOLESTR pwcsName; /* Full path of the document file */
258 BOOL create; /* Was the storage created or opened.
259 The behaviour of STGM_SIMPLE depends on this */
260
261 /* FIXME: should this be in Storage32BaseImpl ? */
262 WCHAR filename[PROPERTY_NAME_BUFFER_LEN];
263
264 /*
265 * File header
266 */
267 WORD bigBlockSizeBits;
268 WORD smallBlockSizeBits;
269 ULONG bigBlockSize;
270 ULONG smallBlockSize;
271 ULONG bigBlockDepotCount;
272 ULONG rootStartBlock;
273 ULONG smallBlockDepotStart;
274 ULONG extBigBlockDepotStart;
275 ULONG extBigBlockDepotCount;
276 ULONG bigBlockDepotStart[COUNT_BBDEPOTINHEADER];
277
278 ULONG blockDepotCached[NUM_BLOCKS_PER_DEPOT_BLOCK];
279 ULONG indexBlockDepotCached;
280 ULONG prevFreeBlock;
281
282 /*
283 * Abstraction of the big block chains for the chains of the header.
284 */
285 BlockChainStream* rootBlockChain;
286 BlockChainStream* smallBlockDepotChain;
287 BlockChainStream* smallBlockRootChain;
288
289 /*
290 * Pointer to the big block file abstraction
291 */
292 BigBlockFile* bigBlockFile;
293 };
294
295 BOOL StorageImpl_ReadProperty(
296 StorageImpl* This,
297 ULONG index,
298 StgProperty* buffer);
299
300 BOOL StorageImpl_WriteProperty(
301 StorageImpl* This,
302 ULONG index,
303 const StgProperty* buffer);
304
305 BlockChainStream* Storage32Impl_SmallBlocksToBigBlocks(
306 StorageImpl* This,
307 SmallBlockChainStream** ppsbChain);
308
309 /****************************************************************************
310 * StgStreamImpl definitions.
311 *
312 * This class implements the IStream32 interface and represents a stream
313 * located inside a storage object.
314 */
315 struct StgStreamImpl
316 {
317 const IStreamVtbl *lpVtbl; /* Needs to be the first item in the struct
318 * since we want to cast this to an IStream pointer */
319
320 /*
321 * We are an entry in the storage object's stream handler list
322 */
323
324 struct list StrmListEntry;
325
326 /*
327 * Reference count
328 */
329 LONG ref;
330
331 /*
332 * Storage that is the parent(owner) of the stream
333 */
334 StorageBaseImpl* parentStorage;
335
336 /*
337 * Access mode of this stream.
338 */
339 DWORD grfMode;
340
341 /*
342 * Index of the property that owns (points to) this stream.
343 */
344 ULONG ownerProperty;
345
346 /*
347 * Helper variable that contains the size of the stream
348 */
349 ULARGE_INTEGER streamSize;
350
351 /*
352 * This is the current position of the cursor in the stream
353 */
354 ULARGE_INTEGER currentPosition;
355
356 /*
357 * The information in the stream is represented by a chain of small blocks
358 * or a chain of large blocks. Depending on the case, one of the two
359 * following variables points to that information.
360 */
361 BlockChainStream* bigBlockChain;
362 SmallBlockChainStream* smallBlockChain;
363 };
364
365 /*
366 * Method definition for the StgStreamImpl class.
367 */
368 StgStreamImpl* StgStreamImpl_Construct(
369 StorageBaseImpl* parentStorage,
370 DWORD grfMode,
371 ULONG ownerProperty);
372
373
374 /******************************************************************************
375 * Endian conversion macros
376 */
377 #ifdef WORDS_BIGENDIAN
378
379 #define htole32(x) RtlUlongByteSwap(x)
380 #define htole16(x) RtlUshortByteSwap(x)
381 #define lendian32toh(x) RtlUlongByteSwap(x)
382 #define lendian16toh(x) RtlUshortByteSwap(x)
383
384 #else
385
386 #define htole32(x) (x)
387 #define htole16(x) (x)
388 #define lendian32toh(x) (x)
389 #define lendian16toh(x) (x)
390
391 #endif
392
393 /******************************************************************************
394 * The StorageUtl_ functions are miscellaneous utility functions. Most of which
395 * are abstractions used to read values from file buffers without having to
396 * worry about bit order
397 */
398 void StorageUtl_ReadWord(const BYTE* buffer, ULONG offset, WORD* value);
399 void StorageUtl_WriteWord(BYTE* buffer, ULONG offset, WORD value);
400 void StorageUtl_ReadDWord(const BYTE* buffer, ULONG offset, DWORD* value);
401 void StorageUtl_WriteDWord(BYTE* buffer, ULONG offset, DWORD value);
402 void StorageUtl_ReadULargeInteger(const BYTE* buffer, ULONG offset,
403 ULARGE_INTEGER* value);
404 void StorageUtl_WriteULargeInteger(BYTE* buffer, ULONG offset,
405 const ULARGE_INTEGER *value);
406 void StorageUtl_ReadGUID(const BYTE* buffer, ULONG offset, GUID* value);
407 void StorageUtl_WriteGUID(BYTE* buffer, ULONG offset, const GUID* value);
408 void StorageUtl_CopyPropertyToSTATSTG(STATSTG* destination, const StgProperty* source,
409 int statFlags);
410
411 /****************************************************************************
412 * BlockChainStream definitions.
413 *
414 * The BlockChainStream class is a utility class that is used to create an
415 * abstraction of the big block chains in the storage file.
416 */
417 struct BlockChainStream
418 {
419 StorageImpl* parentStorage;
420 ULONG* headOfStreamPlaceHolder;
421 ULONG ownerPropertyIndex;
422 ULONG lastBlockNoInSequence;
423 ULONG lastBlockNoInSequenceIndex;
424 ULONG tailIndex;
425 ULONG numBlocks;
426 };
427
428 /*
429 * Methods for the BlockChainStream class.
430 */
431 BlockChainStream* BlockChainStream_Construct(
432 StorageImpl* parentStorage,
433 ULONG* headOfStreamPlaceHolder,
434 ULONG propertyIndex);
435
436 void BlockChainStream_Destroy(
437 BlockChainStream* This);
438
439 HRESULT BlockChainStream_ReadAt(
440 BlockChainStream* This,
441 ULARGE_INTEGER offset,
442 ULONG size,
443 void* buffer,
444 ULONG* bytesRead);
445
446 HRESULT BlockChainStream_WriteAt(
447 BlockChainStream* This,
448 ULARGE_INTEGER offset,
449 ULONG size,
450 const void* buffer,
451 ULONG* bytesWritten);
452
453 BOOL BlockChainStream_SetSize(
454 BlockChainStream* This,
455 ULARGE_INTEGER newSize);
456
457 /****************************************************************************
458 * SmallBlockChainStream definitions.
459 *
460 * The SmallBlockChainStream class is a utility class that is used to create an
461 * abstraction of the small block chains in the storage file.
462 */
463 struct SmallBlockChainStream
464 {
465 StorageImpl* parentStorage;
466 ULONG ownerPropertyIndex;
467 };
468
469 /*
470 * Methods of the SmallBlockChainStream class.
471 */
472 SmallBlockChainStream* SmallBlockChainStream_Construct(
473 StorageImpl* parentStorage,
474 ULONG propertyIndex);
475
476 void SmallBlockChainStream_Destroy(
477 SmallBlockChainStream* This);
478
479 HRESULT SmallBlockChainStream_ReadAt(
480 SmallBlockChainStream* This,
481 ULARGE_INTEGER offset,
482 ULONG size,
483 void* buffer,
484 ULONG* bytesRead);
485
486 HRESULT SmallBlockChainStream_WriteAt(
487 SmallBlockChainStream* This,
488 ULARGE_INTEGER offset,
489 ULONG size,
490 const void* buffer,
491 ULONG* bytesWritten);
492
493 BOOL SmallBlockChainStream_SetSize(
494 SmallBlockChainStream* This,
495 ULARGE_INTEGER newSize);
496
497
498 #endif /* __STORAGE32_H__ */
499
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.