ole32: Remove an unused variable.
[wine] / dlls / ole32 / storage32.h
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  * Copyright 2010 Vincent Povirk for CodeWeavers
15  *
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
29  */
30 #ifndef __STORAGE32_H__
31 #define __STORAGE32_H__
32
33 #include <stdarg.h>
34
35 #include "windef.h"
36 #include "winbase.h"
37 #include "winnt.h"
38 #include "objbase.h"
39 #include "winreg.h"
40 #include "winternl.h"
41 #include "wine/list.h"
42
43 /*
44  * Definitions for the file format offsets.
45  */
46 static const ULONG OFFSET_MINORVERSION       = 0x00000018;
47 static const ULONG OFFSET_MAJORVERSION       = 0x0000001a;
48 static const ULONG OFFSET_BYTEORDERMARKER    = 0x0000001c;
49 static const ULONG OFFSET_BIGBLOCKSIZEBITS   = 0x0000001e;
50 static const ULONG OFFSET_SMALLBLOCKSIZEBITS = 0x00000020;
51 static const ULONG OFFSET_DIRSECTORCOUNT     = 0x00000028;
52 static const ULONG OFFSET_BBDEPOTCOUNT       = 0x0000002C;
53 static const ULONG OFFSET_ROOTSTARTBLOCK     = 0x00000030;
54 static const ULONG OFFSET_SMALLBLOCKLIMIT    = 0x00000038;
55 static const ULONG OFFSET_SBDEPOTSTART       = 0x0000003C;
56 static const ULONG OFFSET_SBDEPOTCOUNT       = 0x00000040;
57 static const ULONG OFFSET_EXTBBDEPOTSTART    = 0x00000044;
58 static const ULONG OFFSET_EXTBBDEPOTCOUNT    = 0x00000048;
59 static const ULONG OFFSET_BBDEPOTSTART       = 0x0000004C;
60 static const ULONG OFFSET_PS_NAME            = 0x00000000;
61 static const ULONG OFFSET_PS_NAMELENGTH      = 0x00000040;
62 static const ULONG OFFSET_PS_STGTYPE         = 0x00000042;
63 static const ULONG OFFSET_PS_LEFTCHILD       = 0x00000044;
64 static const ULONG OFFSET_PS_RIGHTCHILD      = 0x00000048;
65 static const ULONG OFFSET_PS_DIRROOT         = 0x0000004C;
66 static const ULONG OFFSET_PS_GUID            = 0x00000050;
67 static const ULONG OFFSET_PS_CTIMELOW        = 0x00000064;
68 static const ULONG OFFSET_PS_CTIMEHIGH       = 0x00000068;
69 static const ULONG OFFSET_PS_MTIMELOW        = 0x0000006C;
70 static const ULONG OFFSET_PS_MTIMEHIGH       = 0x00000070;
71 static const ULONG OFFSET_PS_STARTBLOCK      = 0x00000074;
72 static const ULONG OFFSET_PS_SIZE            = 0x00000078;
73 static const WORD  DEF_BIG_BLOCK_SIZE_BITS   = 0x0009;
74 static const WORD  MIN_BIG_BLOCK_SIZE_BITS   = 0x0009;
75 static const WORD  MAX_BIG_BLOCK_SIZE_BITS   = 0x000c;
76 static const WORD  DEF_SMALL_BLOCK_SIZE_BITS = 0x0006;
77 static const WORD  DEF_BIG_BLOCK_SIZE        = 0x0200;
78 static const WORD  DEF_SMALL_BLOCK_SIZE      = 0x0040;
79 static const ULONG BLOCK_EXTBBDEPOT          = 0xFFFFFFFC;
80 static const ULONG BLOCK_SPECIAL             = 0xFFFFFFFD;
81 static const ULONG BLOCK_END_OF_CHAIN        = 0xFFFFFFFE;
82 static const ULONG BLOCK_UNUSED              = 0xFFFFFFFF;
83 static const ULONG DIRENTRY_NULL             = 0xFFFFFFFF;
84
85 #define DIRENTRY_NAME_MAX_LEN    0x20
86 #define DIRENTRY_NAME_BUFFER_LEN 0x40
87
88 #define RAW_DIRENTRY_SIZE 0x00000080
89
90 #define HEADER_SIZE 512
91
92 #define MIN_BIG_BLOCK_SIZE 0x200
93 #define MAX_BIG_BLOCK_SIZE 0x1000
94
95 /*
96  * Type of child entry link
97  */
98 #define DIRENTRY_RELATION_PREVIOUS 0
99 #define DIRENTRY_RELATION_NEXT     1
100 #define DIRENTRY_RELATION_DIR      2
101
102 /*
103  * type constant used in files for the root storage
104  */
105 #define STGTY_ROOT 0x05
106
107 #define COUNT_BBDEPOTINHEADER    109
108
109 /* FIXME: This value is stored in the header, but we hard-code it to 0x1000. */
110 #define LIMIT_TO_USE_SMALL_BLOCK 0x1000
111
112 #define STGM_ACCESS_MODE(stgm)   ((stgm)&0x0000f)
113 #define STGM_SHARE_MODE(stgm)    ((stgm)&0x000f0)
114 #define STGM_CREATE_MODE(stgm)   ((stgm)&0x0f000)
115
116 #define STGM_KNOWN_FLAGS (0xf0ff | \
117      STGM_TRANSACTED | STGM_CONVERT | STGM_PRIORITY | STGM_NOSCRATCH | \
118      STGM_NOSNAPSHOT | STGM_DIRECT_SWMR | STGM_DELETEONRELEASE | STGM_SIMPLE)
119
120 /*
121  * Forward declarations of all the structures used by the storage
122  * module.
123  */
124 typedef struct StorageBaseImpl     StorageBaseImpl;
125 typedef struct StorageBaseImplVtbl StorageBaseImplVtbl;
126 typedef struct StorageImpl         StorageImpl;
127 typedef struct BlockChainStream      BlockChainStream;
128 typedef struct SmallBlockChainStream SmallBlockChainStream;
129 typedef struct IEnumSTATSTGImpl      IEnumSTATSTGImpl;
130 typedef struct DirEntry              DirEntry;
131 typedef struct StgStreamImpl         StgStreamImpl;
132
133 /*
134  * A reference to a directory entry in the file or a transacted cache.
135  */
136 typedef ULONG DirRef;
137
138 /*
139  * This utility structure is used to read/write the information in a directory
140  * entry.
141  */
142 struct DirEntry
143 {
144   WCHAR          name[DIRENTRY_NAME_MAX_LEN];
145   WORD           sizeOfNameString;
146   BYTE           stgType;
147   DirRef         leftChild;
148   DirRef         rightChild;
149   DirRef         dirRootEntry;
150   GUID           clsid;
151   FILETIME       ctime;
152   FILETIME       mtime;
153   ULONG          startingBlock;
154   ULARGE_INTEGER size;
155 };
156
157 HRESULT FileLockBytesImpl_Construct(HANDLE hFile, DWORD openFlags, LPCWSTR pwcsName, ILockBytes **pLockBytes);
158
159 /*************************************************************************
160  * Ole Convert support
161  */
162
163 void OLECONVERT_CreateOleStream(LPSTORAGE pStorage);
164 HRESULT OLECONVERT_CreateCompObjStream(LPSTORAGE pStorage, LPCSTR strOleTypeName);
165
166
167 /****************************************************************************
168  * Storage32BaseImpl definitions.
169  *
170  * This structure defines the base information contained in all implementations
171  * of IStorage32 contained in this file storage implementation.
172  *
173  * In OOP terms, this is the base class for all the IStorage32 implementations
174  * contained in this file.
175  */
176 struct StorageBaseImpl
177 {
178   const IStorageVtbl *lpVtbl;    /* Needs to be the first item in the struct
179                             * since we want to cast this in a Storage32 pointer */
180
181   const IPropertySetStorageVtbl *pssVtbl; /* interface for adding a properties stream */
182
183   /*
184    * Stream tracking list
185    */
186
187   struct list strmHead;
188
189   /*
190    * Storage tracking list
191    */
192   struct list storageHead;
193
194   /*
195    * Reference count of this object
196    */
197   LONG ref;
198
199   /*
200    * TRUE if this object has been invalidated
201    */
202   int reverted;
203
204   /*
205    * Index of the directory entry of this storage
206    */
207   DirRef storageDirEntry;
208
209   /*
210    * virtual methods.
211    */
212   const StorageBaseImplVtbl *baseVtbl;
213
214   /*
215    * flags that this storage was opened or created with
216    */
217   DWORD openFlags;
218
219   /*
220    * State bits appear to only be preserved while running. No in the stream
221    */
222   DWORD stateBits;
223
224   BOOL             create;     /* Was the storage created or opened.
225                                   The behaviour of STGM_SIMPLE depends on this */
226   /*
227    * If this storage was opened in transacted mode, the object that implements
228    * the transacted snapshot or cache.
229    */
230   StorageBaseImpl *transactedChild;
231 };
232
233 /* virtual methods for StorageBaseImpl objects */
234 struct StorageBaseImplVtbl {
235   void (*Destroy)(StorageBaseImpl*);
236   void (*Invalidate)(StorageBaseImpl*);
237   HRESULT (*GetFilename)(StorageBaseImpl*,LPWSTR*);
238   HRESULT (*CreateDirEntry)(StorageBaseImpl*,const DirEntry*,DirRef*);
239   HRESULT (*WriteDirEntry)(StorageBaseImpl*,DirRef,const DirEntry*);
240   HRESULT (*ReadDirEntry)(StorageBaseImpl*,DirRef,DirEntry*);
241   HRESULT (*DestroyDirEntry)(StorageBaseImpl*,DirRef);
242   HRESULT (*StreamReadAt)(StorageBaseImpl*,DirRef,ULARGE_INTEGER,ULONG,void*,ULONG*);
243   HRESULT (*StreamWriteAt)(StorageBaseImpl*,DirRef,ULARGE_INTEGER,ULONG,const void*,ULONG*);
244   HRESULT (*StreamSetSize)(StorageBaseImpl*,DirRef,ULARGE_INTEGER);
245   HRESULT (*StreamLink)(StorageBaseImpl*,DirRef,DirRef);
246 };
247
248 static inline void StorageBaseImpl_Destroy(StorageBaseImpl *This)
249 {
250   This->baseVtbl->Destroy(This);
251 }
252
253 static inline void StorageBaseImpl_Invalidate(StorageBaseImpl *This)
254 {
255   This->baseVtbl->Invalidate(This);
256 }
257
258 static inline HRESULT StorageBaseImpl_GetFilename(StorageBaseImpl *This, LPWSTR *result)
259 {
260   return This->baseVtbl->GetFilename(This, result);
261 }
262
263 static inline HRESULT StorageBaseImpl_CreateDirEntry(StorageBaseImpl *This,
264   const DirEntry *newData, DirRef *index)
265 {
266   return This->baseVtbl->CreateDirEntry(This, newData, index);
267 }
268
269 static inline HRESULT StorageBaseImpl_WriteDirEntry(StorageBaseImpl *This,
270   DirRef index, const DirEntry *data)
271 {
272   return This->baseVtbl->WriteDirEntry(This, index, data);
273 }
274
275 static inline HRESULT StorageBaseImpl_ReadDirEntry(StorageBaseImpl *This,
276   DirRef index, DirEntry *data)
277 {
278   return This->baseVtbl->ReadDirEntry(This, index, data);
279 }
280
281 static inline HRESULT StorageBaseImpl_DestroyDirEntry(StorageBaseImpl *This,
282   DirRef index)
283 {
284   return This->baseVtbl->DestroyDirEntry(This, index);
285 }
286
287 /* Read up to size bytes from this directory entry's stream at the given offset. */
288 static inline HRESULT StorageBaseImpl_StreamReadAt(StorageBaseImpl *This,
289   DirRef index, ULARGE_INTEGER offset, ULONG size, void *buffer, ULONG *bytesRead)
290 {
291   return This->baseVtbl->StreamReadAt(This, index, offset, size, buffer, bytesRead);
292 }
293
294 /* Write size bytes to this directory entry's stream at the given offset,
295  * growing the stream if necessary. */
296 static inline HRESULT StorageBaseImpl_StreamWriteAt(StorageBaseImpl *This,
297   DirRef index, ULARGE_INTEGER offset, ULONG size, const void *buffer, ULONG *bytesWritten)
298 {
299   return This->baseVtbl->StreamWriteAt(This, index, offset, size, buffer, bytesWritten);
300 }
301
302 static inline HRESULT StorageBaseImpl_StreamSetSize(StorageBaseImpl *This,
303   DirRef index, ULARGE_INTEGER newsize)
304 {
305   return This->baseVtbl->StreamSetSize(This, index, newsize);
306 }
307
308 /* Make dst point to the same stream that src points to. Other stream operations
309  * will not work properly for entries that point to the same stream, so this
310  * must be a very temporary state, and only one entry pointing to a given stream
311  * may be reachable at any given time. */
312 static inline HRESULT StorageBaseImpl_StreamLink(StorageBaseImpl *This,
313   DirRef dst, DirRef src)
314 {
315   return This->baseVtbl->StreamLink(This, dst, src);
316 }
317
318 /****************************************************************************
319  * StorageBaseImpl stream list handlers
320  */
321
322 void StorageBaseImpl_AddStream(StorageBaseImpl * stg, StgStreamImpl * strm);
323 void StorageBaseImpl_RemoveStream(StorageBaseImpl * stg, StgStreamImpl * strm);
324
325 /* Number of BlockChainStream objects to cache in a StorageImpl */
326 #define BLOCKCHAIN_CACHE_SIZE 4
327
328 /****************************************************************************
329  * Storage32Impl definitions.
330  *
331  * This implementation of the IStorage32 interface represents a root
332  * storage. Basically, a document file.
333  */
334 struct StorageImpl
335 {
336   struct StorageBaseImpl base;
337
338   /*
339    * File header
340    */
341   WORD  bigBlockSizeBits;
342   WORD  smallBlockSizeBits;
343   ULONG bigBlockSize;
344   ULONG smallBlockSize;
345   ULONG bigBlockDepotCount;
346   ULONG rootStartBlock;
347   ULONG smallBlockLimit;
348   ULONG smallBlockDepotStart;
349   ULONG extBigBlockDepotStart;
350   ULONG extBigBlockDepotCount;
351   ULONG bigBlockDepotStart[COUNT_BBDEPOTINHEADER];
352
353   ULONG blockDepotCached[MAX_BIG_BLOCK_SIZE / 4];
354   ULONG indexBlockDepotCached;
355   ULONG prevFreeBlock;
356
357   /* All small blocks before this one are known to be in use. */
358   ULONG firstFreeSmallBlock;
359
360   /*
361    * Abstraction of the big block chains for the chains of the header.
362    */
363   BlockChainStream* rootBlockChain;
364   BlockChainStream* smallBlockDepotChain;
365   BlockChainStream* smallBlockRootChain;
366
367   /* Cache of block chain streams objects for directory entries */
368   BlockChainStream* blockChainCache[BLOCKCHAIN_CACHE_SIZE];
369   UINT blockChainToEvict;
370
371   ILockBytes* lockBytes;
372 };
373
374 HRESULT StorageImpl_ReadRawDirEntry(
375             StorageImpl *This,
376             ULONG index,
377             BYTE *buffer);
378
379 void UpdateRawDirEntry(
380     BYTE *buffer,
381     const DirEntry *newData);
382
383 HRESULT StorageImpl_WriteRawDirEntry(
384             StorageImpl *This,
385             ULONG index,
386             const BYTE *buffer);
387
388 HRESULT StorageImpl_ReadDirEntry(
389             StorageImpl*    This,
390             DirRef          index,
391             DirEntry*       buffer);
392
393 HRESULT StorageImpl_WriteDirEntry(
394             StorageImpl*        This,
395             DirRef              index,
396             const DirEntry*     buffer);
397
398 BlockChainStream* Storage32Impl_SmallBlocksToBigBlocks(
399                       StorageImpl* This,
400                       SmallBlockChainStream** ppsbChain);
401
402 SmallBlockChainStream* Storage32Impl_BigBlocksToSmallBlocks(
403                       StorageImpl* This,
404                       BlockChainStream** ppbbChain);
405
406 /****************************************************************************
407  * StgStreamImpl definitions.
408  *
409  * This class implements the IStream32 interface and represents a stream
410  * located inside a storage object.
411  */
412 struct StgStreamImpl
413 {
414   const IStreamVtbl *lpVtbl;  /* Needs to be the first item in the struct
415                          * since we want to cast this to an IStream pointer */
416
417   /*
418    * We are an entry in the storage object's stream handler list
419    */
420
421   struct list StrmListEntry;
422
423   /*
424    * Reference count
425    */
426   LONG               ref;
427
428   /*
429    * Storage that is the parent(owner) of the stream
430    */
431   StorageBaseImpl* parentStorage;
432
433   /*
434    * Access mode of this stream.
435    */
436   DWORD grfMode;
437
438   /*
439    * Index of the directory entry that owns (points to) this stream.
440    */
441   DirRef             dirEntry;
442
443   /*
444    * This is the current position of the cursor in the stream
445    */
446   ULARGE_INTEGER     currentPosition;
447 };
448
449 /*
450  * Method definition for the StgStreamImpl class.
451  */
452 StgStreamImpl* StgStreamImpl_Construct(
453                 StorageBaseImpl* parentStorage,
454     DWORD            grfMode,
455     DirRef           dirEntry);
456
457
458 /******************************************************************************
459  * Endian conversion macros
460  */
461 #ifdef WORDS_BIGENDIAN
462
463 #define htole32(x) RtlUlongByteSwap(x)
464 #define htole16(x) RtlUshortByteSwap(x)
465 #define lendian32toh(x) RtlUlongByteSwap(x)
466 #define lendian16toh(x) RtlUshortByteSwap(x)
467
468 #else
469
470 #define htole32(x) (x)
471 #define htole16(x) (x)
472 #define lendian32toh(x) (x)
473 #define lendian16toh(x) (x)
474
475 #endif
476
477 /******************************************************************************
478  * The StorageUtl_ functions are miscellaneous utility functions. Most of which
479  * are abstractions used to read values from file buffers without having to
480  * worry about bit order
481  */
482 void StorageUtl_ReadWord(const BYTE* buffer, ULONG offset, WORD* value);
483 void StorageUtl_WriteWord(BYTE* buffer, ULONG offset, WORD value);
484 void StorageUtl_ReadDWord(const BYTE* buffer, ULONG offset, DWORD* value);
485 void StorageUtl_WriteDWord(BYTE* buffer, ULONG offset, DWORD value);
486 void StorageUtl_ReadULargeInteger(const BYTE* buffer, ULONG offset,
487  ULARGE_INTEGER* value);
488 void StorageUtl_WriteULargeInteger(BYTE* buffer, ULONG offset,
489  const ULARGE_INTEGER *value);
490 void StorageUtl_ReadGUID(const BYTE* buffer, ULONG offset, GUID* value);
491 void StorageUtl_WriteGUID(BYTE* buffer, ULONG offset, const GUID* value);
492 void StorageUtl_CopyDirEntryToSTATSTG(StorageBaseImpl *storage,STATSTG* destination,
493  const DirEntry* source, int statFlags);
494
495 /****************************************************************************
496  * BlockChainStream definitions.
497  *
498  * The BlockChainStream class is a utility class that is used to create an
499  * abstraction of the big block chains in the storage file.
500  */
501 struct BlockChainRun
502 {
503   /* This represents a range of blocks that happen reside in consecutive sectors. */
504   ULONG firstSector;
505   ULONG firstOffset;
506   ULONG lastOffset;
507 };
508
509 struct BlockChainStream
510 {
511   StorageImpl* parentStorage;
512   ULONG*       headOfStreamPlaceHolder;
513   DirRef       ownerDirEntry;
514   struct BlockChainRun* indexCache;
515   ULONG        indexCacheLen;
516   ULONG        indexCacheSize;
517   ULONG        tailIndex;
518   ULONG        numBlocks;
519 };
520
521 /*
522  * Methods for the BlockChainStream class.
523  */
524 BlockChainStream* BlockChainStream_Construct(
525                 StorageImpl* parentStorage,
526                 ULONG*         headOfStreamPlaceHolder,
527                 DirRef         dirEntry);
528
529 void BlockChainStream_Destroy(
530                 BlockChainStream* This);
531
532 HRESULT BlockChainStream_ReadAt(
533                 BlockChainStream* This,
534                 ULARGE_INTEGER offset,
535                 ULONG          size,
536                 void*          buffer,
537                 ULONG*         bytesRead);
538
539 HRESULT BlockChainStream_WriteAt(
540                 BlockChainStream* This,
541                 ULARGE_INTEGER offset,
542                 ULONG          size,
543                 const void*    buffer,
544                 ULONG*         bytesWritten);
545
546 BOOL BlockChainStream_SetSize(
547                 BlockChainStream* This,
548                 ULARGE_INTEGER    newSize);
549
550 /****************************************************************************
551  * SmallBlockChainStream definitions.
552  *
553  * The SmallBlockChainStream class is a utility class that is used to create an
554  * abstraction of the small block chains in the storage file.
555  */
556 struct SmallBlockChainStream
557 {
558   StorageImpl* parentStorage;
559   DirRef         ownerDirEntry;
560   ULONG*         headOfStreamPlaceHolder;
561 };
562
563 /*
564  * Methods of the SmallBlockChainStream class.
565  */
566 SmallBlockChainStream* SmallBlockChainStream_Construct(
567            StorageImpl*   parentStorage,
568            ULONG*         headOfStreamPlaceHolder,
569            DirRef         dirEntry);
570
571 void SmallBlockChainStream_Destroy(
572                SmallBlockChainStream* This);
573
574 HRESULT SmallBlockChainStream_ReadAt(
575                SmallBlockChainStream* This,
576                ULARGE_INTEGER offset,
577                ULONG          size,
578                void*          buffer,
579                ULONG*         bytesRead);
580
581 HRESULT SmallBlockChainStream_WriteAt(
582                SmallBlockChainStream* This,
583                ULARGE_INTEGER offset,
584                ULONG          size,
585                const void*    buffer,
586                ULONG*         bytesWritten);
587
588 BOOL SmallBlockChainStream_SetSize(
589                SmallBlockChainStream* This,
590                ULARGE_INTEGER          newSize);
591
592
593 #endif /* __STORAGE32_H__ */