Make remaining OLE interface vtables const.
[wine/wine64.git] / dlls / ole32 / storage32.h
blob4358a19b7733579872ab52342c16e2c7d5eb5c66
1 /*
2 * Compound Storage (32 bit version)
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>)
8 * This include file contains definitions of types and function
9 * prototypes that are used in the many files implementing the
10 * storage functionality
12 * Copyright 1998,1999 Francis Beaudet
13 * Copyright 1998,1999 Thuy Nguyen
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #ifndef __STORAGE32_H__
30 #define __STORAGE32_H__
32 #include <stdarg.h>
34 #include "windef.h"
35 #include "winbase.h"
36 #include "winnt.h"
37 #include "objbase.h"
38 #include "winreg.h"
39 #include "winternl.h"
42 * Definitions for the file format offsets.
44 static const ULONG OFFSET_BIGBLOCKSIZEBITS = 0x0000001e;
45 static const ULONG OFFSET_SMALLBLOCKSIZEBITS = 0x00000020;
46 static const ULONG OFFSET_BBDEPOTCOUNT = 0x0000002C;
47 static const ULONG OFFSET_ROOTSTARTBLOCK = 0x00000030;
48 static const ULONG OFFSET_SBDEPOTSTART = 0x0000003C;
49 static const ULONG OFFSET_SBDEPOTCOUNT = 0x00000040;
50 static const ULONG OFFSET_EXTBBDEPOTSTART = 0x00000044;
51 static const ULONG OFFSET_EXTBBDEPOTCOUNT = 0x00000048;
52 static const ULONG OFFSET_BBDEPOTSTART = 0x0000004C;
53 static const ULONG OFFSET_PS_NAME = 0x00000000;
54 static const ULONG OFFSET_PS_NAMELENGTH = 0x00000040;
55 static const ULONG OFFSET_PS_PROPERTYTYPE = 0x00000042;
56 static const ULONG OFFSET_PS_PREVIOUSPROP = 0x00000044;
57 static const ULONG OFFSET_PS_NEXTPROP = 0x00000048;
58 static const ULONG OFFSET_PS_DIRPROP = 0x0000004C;
59 static const ULONG OFFSET_PS_GUID = 0x00000050;
60 static const ULONG OFFSET_PS_TSS1 = 0x00000064;
61 static const ULONG OFFSET_PS_TSD1 = 0x00000068;
62 static const ULONG OFFSET_PS_TSS2 = 0x0000006C;
63 static const ULONG OFFSET_PS_TSD2 = 0x00000070;
64 static const ULONG OFFSET_PS_STARTBLOCK = 0x00000074;
65 static const ULONG OFFSET_PS_SIZE = 0x00000078;
66 static const WORD DEF_BIG_BLOCK_SIZE_BITS = 0x0009;
67 static const WORD DEF_SMALL_BLOCK_SIZE_BITS = 0x0006;
68 static const WORD DEF_BIG_BLOCK_SIZE = 0x0200;
69 static const WORD DEF_SMALL_BLOCK_SIZE = 0x0040;
70 static const ULONG BLOCK_EXTBBDEPOT = 0xFFFFFFFC;
71 static const ULONG BLOCK_SPECIAL = 0xFFFFFFFD;
72 static const ULONG BLOCK_END_OF_CHAIN = 0xFFFFFFFE;
73 static const ULONG BLOCK_UNUSED = 0xFFFFFFFF;
74 static const ULONG PROPERTY_NULL = 0xFFFFFFFF;
76 #define PROPERTY_NAME_MAX_LEN 0x20
77 #define PROPERTY_NAME_BUFFER_LEN 0x40
79 #define PROPSET_BLOCK_SIZE 0x00000080
82 * Property type of relation
84 #define PROPERTY_RELATION_PREVIOUS 0
85 #define PROPERTY_RELATION_NEXT 1
86 #define PROPERTY_RELATION_DIR 2
89 * Property type constants
91 #define PROPTYPE_STORAGE 0x01
92 #define PROPTYPE_STREAM 0x02
93 #define PROPTYPE_ROOT 0x05
96 * These defines assume a hardcoded blocksize. The code will assert
97 * if the blocksize is different. Some changes will have to be done if it
98 * becomes the case.
100 #define BIG_BLOCK_SIZE 0x200
101 #define COUNT_BBDEPOTINHEADER 109
102 #define LIMIT_TO_USE_SMALL_BLOCK 0x1000
103 #define NUM_BLOCKS_PER_DEPOT_BLOCK 128
105 #define STGM_ACCESS_MODE(stgm) ((stgm)&0x0000f)
106 #define STGM_SHARE_MODE(stgm) ((stgm)&0x000f0)
107 #define STGM_CREATE_MODE(stgm) ((stgm)&0x0f000)
109 #define STGM_KNOWN_FLAGS (0xf0ff | \
110 STGM_TRANSACTED | STGM_CONVERT | STGM_PRIORITY | STGM_NOSCRATCH | \
111 STGM_NOSNAPSHOT | STGM_DIRECT_SWMR | STGM_DELETEONRELEASE | STGM_SIMPLE)
114 * These are signatures to detect the type of Document file.
116 static const BYTE STORAGE_magic[8] ={0xd0,0xcf,0x11,0xe0,0xa1,0xb1,0x1a,0xe1};
117 static const BYTE STORAGE_oldmagic[8] ={0xd0,0xcf,0x11,0xe0,0x0e,0x11,0xfc,0x0d};
120 * Forward declarations of all the structures used by the storage
121 * module.
123 typedef struct StorageBaseImpl StorageBaseImpl;
124 typedef struct StorageImpl StorageImpl;
125 typedef struct StorageInternalImpl StorageInternalImpl;
126 typedef struct BlockChainStream BlockChainStream;
127 typedef struct SmallBlockChainStream SmallBlockChainStream;
128 typedef struct IEnumSTATSTGImpl IEnumSTATSTGImpl;
129 typedef struct StgProperty StgProperty;
130 typedef struct StgStreamImpl StgStreamImpl;
133 * This utility structure is used to read/write the information in a storage
134 * property.
136 struct StgProperty
138 WCHAR name[PROPERTY_NAME_MAX_LEN];
139 WORD sizeOfNameString;
140 BYTE propertyType;
141 ULONG previousProperty;
142 ULONG nextProperty;
143 ULONG dirProperty;
144 GUID propertyUniqueID;
145 ULONG timeStampS1;
146 ULONG timeStampD1;
147 ULONG timeStampS2;
148 ULONG timeStampD2;
149 ULONG startingBlock;
150 ULARGE_INTEGER size;
153 /*************************************************************************
154 * Big Block File support
156 * The big block file is an abstraction of a flat file separated in
157 * same sized blocks. The implementation for the methods described in
158 * this section appear in stg_bigblockfile.c
162 * Declaration of the data structures
164 typedef struct BigBlockFile BigBlockFile,*LPBIGBLOCKFILE;
165 typedef struct MappedPage MappedPage,*LPMAPPEDPAGE;
167 struct BigBlockFile
169 BOOL fileBased;
170 ULARGE_INTEGER filesize;
171 ULONG blocksize;
172 HANDLE hfile;
173 HANDLE hfilemap;
174 DWORD flProtect;
175 MappedPage *maplist;
176 MappedPage *victimhead, *victimtail;
177 ULONG num_victim_pages;
178 ILockBytes *pLkbyt;
179 HGLOBAL hbytearray;
180 LPVOID pbytearray;
184 * Declaration of the functions used to manipulate the BigBlockFile
185 * data structure.
187 BigBlockFile* BIGBLOCKFILE_Construct(HANDLE hFile,
188 ILockBytes* pLkByt,
189 DWORD openFlags,
190 ULONG blocksize,
191 BOOL fileBased);
192 void BIGBLOCKFILE_Destructor(LPBIGBLOCKFILE This);
193 void* BIGBLOCKFILE_GetBigBlock(LPBIGBLOCKFILE This, ULONG index);
194 void* BIGBLOCKFILE_GetROBigBlock(LPBIGBLOCKFILE This, ULONG index);
195 void BIGBLOCKFILE_ReleaseBigBlock(LPBIGBLOCKFILE This, void *pBlock);
196 void BIGBLOCKFILE_SetSize(LPBIGBLOCKFILE This, ULARGE_INTEGER newSize);
197 ULARGE_INTEGER BIGBLOCKFILE_GetSize(LPBIGBLOCKFILE This);
199 /*************************************************************************
200 * Ole Convert support
203 void OLECONVERT_CreateOleStream(LPSTORAGE pStorage);
204 HRESULT OLECONVERT_CreateCompObjStream(LPSTORAGE pStorage, LPCSTR strOleTypeName);
206 /****************************************************************************
207 * Storage32BaseImpl definitions.
209 * This structure defines the base information contained in all implementations
210 * of IStorage32 contained in this file storage implementation.
212 * In OOP terms, this is the base class for all the IStorage32 implementations
213 * contained in this file.
215 struct StorageBaseImpl
217 const IStorageVtbl *lpVtbl; /* Needs to be the first item in the struct
218 * since we want to cast this in a Storage32 pointer */
220 const IPropertySetStorageVtbl *pssVtbl; /* interface for adding a properties stream */
223 * Reference count of this object
225 ULONG ref;
228 * Ancestor storage (top level)
230 StorageImpl* ancestorStorage;
233 * Index of the property for the root of
234 * this storage
236 ULONG rootPropertySetIndex;
239 * virtual Destructor method.
241 void (*v_destructor)(StorageBaseImpl*);
244 * flags that this storage was opened or created with
246 DWORD openFlags;
250 /****************************************************************************
251 * Storage32Impl definitions.
253 * This implementation of the IStorage32 interface represents a root
254 * storage. Basically, a document file.
256 struct StorageImpl
258 struct StorageBaseImpl base;
261 * The following data members are specific to the Storage32Impl
262 * class
264 HANDLE hFile; /* Physical support for the Docfile */
265 LPOLESTR pwcsName; /* Full path of the document file */
267 /* FIXME: should this be in Storage32BaseImpl ? */
268 WCHAR filename[PROPERTY_NAME_BUFFER_LEN];
271 * File header
273 WORD bigBlockSizeBits;
274 WORD smallBlockSizeBits;
275 ULONG bigBlockSize;
276 ULONG smallBlockSize;
277 ULONG bigBlockDepotCount;
278 ULONG rootStartBlock;
279 ULONG smallBlockDepotStart;
280 ULONG extBigBlockDepotStart;
281 ULONG extBigBlockDepotCount;
282 ULONG bigBlockDepotStart[COUNT_BBDEPOTINHEADER];
284 ULONG blockDepotCached[NUM_BLOCKS_PER_DEPOT_BLOCK];
285 ULONG indexBlockDepotCached;
286 ULONG prevFreeBlock;
289 * Abstraction of the big block chains for the chains of the header.
291 BlockChainStream* rootBlockChain;
292 BlockChainStream* smallBlockDepotChain;
293 BlockChainStream* smallBlockRootChain;
296 * Pointer to the big block file abstraction
298 BigBlockFile* bigBlockFile;
301 void StorageImpl_Destroy(
302 StorageBaseImpl* This);
304 HRESULT StorageImpl_Construct(
305 StorageImpl* This,
306 HANDLE hFile,
307 LPCOLESTR pwcsName,
308 ILockBytes* pLkbyt,
309 DWORD openFlags,
310 BOOL fileBased,
311 BOOL fileCreate);
313 BOOL StorageImpl_ReadBigBlock(
314 StorageImpl* This,
315 ULONG blockIndex,
316 void* buffer);
318 BOOL StorageImpl_WriteBigBlock(
319 StorageImpl* This,
320 ULONG blockIndex,
321 void* buffer);
323 void* StorageImpl_GetROBigBlock(
324 StorageImpl* This,
325 ULONG blockIndex);
327 void* StorageImpl_GetBigBlock(
328 StorageImpl* This,
329 ULONG blockIndex);
331 void StorageImpl_ReleaseBigBlock(
332 StorageImpl* This,
333 void* pBigBlock);
335 ULONG StorageImpl_GetNextFreeBigBlock(
336 StorageImpl* This);
338 void StorageImpl_FreeBigBlock(
339 StorageImpl* This,
340 ULONG blockIndex);
342 HRESULT StorageImpl_GetNextBlockInChain(
343 StorageImpl* This,
344 ULONG blockIndex,
345 ULONG* nextBlockIndex);
347 void StorageImpl_SetNextBlockInChain(
348 StorageImpl* This,
349 ULONG blockIndex,
350 ULONG nextBlock);
352 HRESULT StorageImpl_LoadFileHeader(
353 StorageImpl* This);
355 void StorageImpl_SaveFileHeader(
356 StorageImpl* This);
358 BOOL StorageImpl_ReadProperty(
359 StorageImpl* This,
360 ULONG index,
361 StgProperty* buffer);
363 BOOL StorageImpl_WriteProperty(
364 StorageImpl* This,
365 ULONG index,
366 StgProperty* buffer);
368 BlockChainStream* Storage32Impl_SmallBlocksToBigBlocks(
369 StorageImpl* This,
370 SmallBlockChainStream** ppsbChain);
372 ULONG Storage32Impl_GetNextExtendedBlock(StorageImpl* This,
373 ULONG blockIndex);
375 void Storage32Impl_AddBlockDepot(StorageImpl* This,
376 ULONG blockIndex);
378 ULONG Storage32Impl_AddExtBlockDepot(StorageImpl* This);
380 ULONG Storage32Impl_GetExtDepotBlock(StorageImpl* This,
381 ULONG depotIndex);
383 void Storage32Impl_SetExtDepotBlock(StorageImpl* This,
384 ULONG depotIndex,
385 ULONG blockIndex);
386 /****************************************************************************
387 * Storage32InternalImpl definitions.
389 * Definition of the implementation structure for the IStorage32 interface.
390 * This one implements the IStorage32 interface for storage that are
391 * inside another storage.
393 struct StorageInternalImpl
395 struct StorageBaseImpl base;
398 * There is no specific data for this class.
403 * Method definitions for the Storage32InternalImpl class.
405 StorageInternalImpl* StorageInternalImpl_Construct(
406 StorageImpl* ancestorStorage,
407 DWORD openFlags,
408 ULONG rootTropertyIndex);
410 void StorageInternalImpl_Destroy(
411 StorageBaseImpl* This);
413 HRESULT WINAPI StorageInternalImpl_Commit(
414 IStorage* iface,
415 DWORD grfCommitFlags); /* [in] */
417 HRESULT WINAPI StorageInternalImpl_Revert(
418 IStorage* iface);
421 /****************************************************************************
422 * IEnumSTATSTGImpl definitions.
424 * Definition of the implementation structure for the IEnumSTATSTGImpl interface.
425 * This class allows iterating through the content of a storage and to find
426 * specific items inside it.
428 struct IEnumSTATSTGImpl
430 const IEnumSTATSTGVtbl *lpVtbl; /* Needs to be the first item in the struct
431 * since we want to cast this in an IEnumSTATSTG pointer */
433 ULONG ref; /* Reference count */
434 StorageImpl* parentStorage; /* Reference to the parent storage */
435 ULONG firstPropertyNode; /* Index of the root of the storage to enumerate */
438 * The current implementation of the IEnumSTATSTGImpl class uses a stack
439 * to walk the property sets to get the content of a storage. This stack
440 * is implemented by the following 3 data members
442 ULONG stackSize;
443 ULONG stackMaxSize;
444 ULONG* stackToVisit;
446 #define ENUMSTATSGT_SIZE_INCREMENT 10
449 IEnumSTATSTGImpl* IEnumSTATSTGImpl_Construct(
450 StorageImpl* This,
451 ULONG firstPropertyNode);
453 void IEnumSTATSTGImpl_Destroy(
454 IEnumSTATSTGImpl* This);
456 void IEnumSTATSTGImpl_PushSearchNode(
457 IEnumSTATSTGImpl* This,
458 ULONG nodeToPush);
460 ULONG IEnumSTATSTGImpl_PopSearchNode(
461 IEnumSTATSTGImpl* This,
462 BOOL remove);
464 ULONG IEnumSTATSTGImpl_FindProperty(
465 IEnumSTATSTGImpl* This,
466 const OLECHAR* lpszPropName,
467 StgProperty* buffer);
469 INT IEnumSTATSTGImpl_FindParentProperty(
470 IEnumSTATSTGImpl *This,
471 ULONG childProperty,
472 StgProperty *currentProperty,
473 ULONG *propertyId);
476 /****************************************************************************
477 * StgStreamImpl definitions.
479 * This class imlements the IStream32 inteface and represents a stream
480 * located inside a storage object.
482 struct StgStreamImpl
484 const IStreamVtbl *lpVtbl; /* Needs to be the first item in the struct
485 * since we want to cast this to an IStream pointer */
488 * Reference count
490 ULONG ref;
493 * Storage that is the parent(owner) of the stream
495 StorageBaseImpl* parentStorage;
498 * Access mode of this stream.
500 DWORD grfMode;
503 * Index of the property that owns (points to) this stream.
505 ULONG ownerProperty;
508 * Helper variable that contains the size of the stream
510 ULARGE_INTEGER streamSize;
513 * This is the current position of the cursor in the stream
515 ULARGE_INTEGER currentPosition;
518 * The information in the stream is represented by a chain of small blocks
519 * or a chain of large blocks. Depending on the case, one of the two
520 * following variabled points to that information.
522 BlockChainStream* bigBlockChain;
523 SmallBlockChainStream* smallBlockChain;
527 * Method definition for the StgStreamImpl class.
529 StgStreamImpl* StgStreamImpl_Construct(
530 StorageBaseImpl* parentStorage,
531 DWORD grfMode,
532 ULONG ownerProperty);
535 /******************************************************************************
536 * Endian conversion macros
538 #ifdef WORDS_BIGENDIAN
540 #define htole32(x) RtlUlongByteSwap(x)
541 #define htole16(x) RtlUshortByteSwap(x)
542 #define le32toh(x) RtlUlongByteSwap(x)
543 #define le16toh(x) RtlUshortByteSwap(x)
545 #else
547 #define htole32(x) (x)
548 #define htole16(x) (x)
549 #define le32toh(x) (x)
550 #define le16toh(x) (x)
552 #endif
554 /******************************************************************************
555 * The StorageUtl_ functions are miscellaneous utility functions. Most of which
556 * are abstractions used to read values from file buffers without having to
557 * worry about bit order
559 void StorageUtl_ReadWord(const BYTE* buffer, ULONG offset, WORD* value);
560 void StorageUtl_WriteWord(BYTE* buffer, ULONG offset, WORD value);
561 void StorageUtl_ReadDWord(const BYTE* buffer, ULONG offset, DWORD* value);
562 void StorageUtl_WriteDWord(BYTE* buffer, ULONG offset, DWORD value);
563 void StorageUtl_ReadULargeInteger(const BYTE* buffer, ULONG offset,
564 ULARGE_INTEGER* value);
565 void StorageUtl_WriteULargeInteger(BYTE* buffer, ULONG offset,
566 const ULARGE_INTEGER *value);
567 void StorageUtl_ReadGUID(const BYTE* buffer, ULONG offset, GUID* value);
568 void StorageUtl_WriteGUID(BYTE* buffer, ULONG offset, const GUID* value);
569 void StorageUtl_CopyPropertyToSTATSTG(STATSTG* destination,
570 StgProperty* source,
571 int statFlags);
573 /****************************************************************************
574 * BlockChainStream definitions.
576 * The BlockChainStream class is a utility class that is used to create an
577 * abstraction of the big block chains in the storage file.
579 struct BlockChainStream
581 StorageImpl* parentStorage;
582 ULONG* headOfStreamPlaceHolder;
583 ULONG ownerPropertyIndex;
584 ULONG lastBlockNoInSequence;
585 ULONG lastBlockNoInSequenceIndex;
586 ULONG tailIndex;
587 ULONG numBlocks;
591 * Methods for the BlockChainStream class.
593 BlockChainStream* BlockChainStream_Construct(
594 StorageImpl* parentStorage,
595 ULONG* headOfStreamPlaceHolder,
596 ULONG propertyIndex);
598 void BlockChainStream_Destroy(
599 BlockChainStream* This);
601 ULONG BlockChainStream_GetHeadOfChain(
602 BlockChainStream* This);
604 BOOL BlockChainStream_ReadAt(
605 BlockChainStream* This,
606 ULARGE_INTEGER offset,
607 ULONG size,
608 void* buffer,
609 ULONG* bytesRead);
611 BOOL BlockChainStream_WriteAt(
612 BlockChainStream* This,
613 ULARGE_INTEGER offset,
614 ULONG size,
615 const void* buffer,
616 ULONG* bytesWritten);
618 BOOL BlockChainStream_SetSize(
619 BlockChainStream* This,
620 ULARGE_INTEGER newSize);
622 ULARGE_INTEGER BlockChainStream_GetSize(
623 BlockChainStream* This);
625 ULONG BlockChainStream_GetCount(
626 BlockChainStream* This);
628 /****************************************************************************
629 * SmallBlockChainStream definitions.
631 * The SmallBlockChainStream class is a utility class that is used to create an
632 * abstraction of the small block chains in the storage file.
634 struct SmallBlockChainStream
636 StorageImpl* parentStorage;
637 ULONG ownerPropertyIndex;
641 * Methods of the SmallBlockChainStream class.
643 SmallBlockChainStream* SmallBlockChainStream_Construct(
644 StorageImpl* parentStorage,
645 ULONG propertyIndex);
647 void SmallBlockChainStream_Destroy(
648 SmallBlockChainStream* This);
650 ULONG SmallBlockChainStream_GetHeadOfChain(
651 SmallBlockChainStream* This);
653 HRESULT SmallBlockChainStream_GetNextBlockInChain(
654 SmallBlockChainStream* This,
655 ULONG blockIndex,
656 ULONG* nextBlockIndex);
658 void SmallBlockChainStream_SetNextBlockInChain(
659 SmallBlockChainStream* This,
660 ULONG blockIndex,
661 ULONG nextBlock);
663 void SmallBlockChainStream_FreeBlock(
664 SmallBlockChainStream* This,
665 ULONG blockIndex);
667 ULONG SmallBlockChainStream_GetNextFreeBlock(
668 SmallBlockChainStream* This);
670 BOOL SmallBlockChainStream_ReadAt(
671 SmallBlockChainStream* This,
672 ULARGE_INTEGER offset,
673 ULONG size,
674 void* buffer,
675 ULONG* bytesRead);
677 BOOL SmallBlockChainStream_WriteAt(
678 SmallBlockChainStream* This,
679 ULARGE_INTEGER offset,
680 ULONG size,
681 const void* buffer,
682 ULONG* bytesWritten);
684 BOOL SmallBlockChainStream_SetSize(
685 SmallBlockChainStream* This,
686 ULARGE_INTEGER newSize);
688 ULARGE_INTEGER SmallBlockChainStream_GetSize(
689 SmallBlockChainStream* This);
691 ULONG SmallBlockChainStream_GetCount(
692 SmallBlockChainStream* This);
695 #endif /* __STORAGE32_H__ */