git.oblomov.eu Git - wine/blob - 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  *
  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_STGTYPE         = 0x00000042;
  57 static const ULONG OFFSET_PS_LEFTCHILD       = 0x00000044;
  58 static const ULONG OFFSET_PS_RIGHTCHILD      = 0x00000048;
  59 static const ULONG OFFSET_PS_DIRROOT         = 0x0000004C;
  60 static const ULONG OFFSET_PS_GUID            = 0x00000050;
  61 static const ULONG OFFSET_PS_CTIMELOW        = 0x00000064;
  62 static const ULONG OFFSET_PS_CTIMEHIGH       = 0x00000068;
  63 static const ULONG OFFSET_PS_MTIMELOW        = 0x0000006C;
  64 static const ULONG OFFSET_PS_MTIMEHIGH       = 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 DIRENTRY_NULL             = 0xFFFFFFFF;
  76
  77 #define DIRENTRY_NAME_MAX_LEN    0x20
  78 #define DIRENTRY_NAME_BUFFER_LEN 0x40
  79
  80 #define RAW_DIRENTRY_SIZE 0x00000080
  81
  82 /*
  83  * Type of child entry link
  84  */
  85 #define DIRENTRY_RELATION_PREVIOUS 0
  86 #define DIRENTRY_RELATION_NEXT     1
  87 #define DIRENTRY_RELATION_DIR      2
  88
  89 /*
  90  * type constant used in files for the root storage
  91  */
  92 #define STGTY_ROOT 0x05
  93
  94 /*
  95  * These defines assume a hardcoded blocksize. The code will assert
  96  * if the blocksize is different. Some changes will have to be done if it
  97  * becomes the case.
  98  */
  99 #define BIG_BLOCK_SIZE           0x200
 100 #define COUNT_BBDEPOTINHEADER    109
 101 #define LIMIT_TO_USE_SMALL_BLOCK 0x1000
 102 #define NUM_BLOCKS_PER_DEPOT_BLOCK 128
 103
 104 #define STGM_ACCESS_MODE(stgm)   ((stgm)&0x0000f)
 105 #define STGM_SHARE_MODE(stgm)    ((stgm)&0x000f0)
 106 #define STGM_CREATE_MODE(stgm)   ((stgm)&0x0f000)
 107
 108 #define STGM_KNOWN_FLAGS (0xf0ff | \
 109      STGM_TRANSACTED | STGM_CONVERT | STGM_PRIORITY | STGM_NOSCRATCH | \
 110      STGM_NOSNAPSHOT | STGM_DIRECT_SWMR | STGM_DELETEONRELEASE | STGM_SIMPLE)
 111
 112 /*
 113  * Forward declarations of all the structures used by the storage
 114  * module.
 115  */
 116 typedef struct StorageBaseImpl     StorageBaseImpl;
 117 typedef struct StorageImpl         StorageImpl;
 118 typedef struct BlockChainStream      BlockChainStream;
 119 typedef struct SmallBlockChainStream SmallBlockChainStream;
 120 typedef struct IEnumSTATSTGImpl      IEnumSTATSTGImpl;
 121 typedef struct DirEntry              DirEntry;
 122 typedef struct StgStreamImpl         StgStreamImpl;
 123
 124 /*
 125  * This utility structure is used to read/write the information in a directory
 126  * entry.
 127  */
 128 struct DirEntry
 129 {
 130   WCHAR          name[DIRENTRY_NAME_MAX_LEN];
 131   WORD           sizeOfNameString;
 132   BYTE           stgType;
 133   ULONG          leftChild;
 134   ULONG          rightChild;
 135   ULONG          dirRootEntry;
 136   GUID           clsid;
 137   FILETIME       ctime;
 138   FILETIME       mtime;
 139   ULONG          startingBlock;
 140   ULARGE_INTEGER size;
 141 };
 142
 143 /*************************************************************************
 144  * Big Block File support
 145  *
 146  * The big block file is an abstraction of a flat file separated in
 147  * same sized blocks. The implementation for the methods described in
 148  * this section appear in stg_bigblockfile.c
 149  */
 150
 151 typedef struct BigBlockFile BigBlockFile,*LPBIGBLOCKFILE;
 152
 153 /*
 154  * Declaration of the functions used to manipulate the BigBlockFile
 155  * data structure.
 156  */
 157 BigBlockFile*  BIGBLOCKFILE_Construct(HANDLE hFile,
 158                                       ILockBytes* pLkByt,
 159                                       DWORD openFlags,
 160                                       ULONG blocksize,
 161                                       BOOL fileBased);
 162 void           BIGBLOCKFILE_Destructor(LPBIGBLOCKFILE This);
 163 HRESULT        BIGBLOCKFILE_EnsureExists(LPBIGBLOCKFILE This, ULONG index);
 164 HRESULT        BIGBLOCKFILE_SetSize(LPBIGBLOCKFILE This, ULARGE_INTEGER newSize);
 165 HRESULT        BIGBLOCKFILE_ReadAt(LPBIGBLOCKFILE This, ULARGE_INTEGER offset,
 166            void* buffer, ULONG size, ULONG* bytesRead);
 167 HRESULT        BIGBLOCKFILE_WriteAt(LPBIGBLOCKFILE This, ULARGE_INTEGER offset,
 168            const void* buffer, ULONG size, ULONG* bytesRead);
 169
 170 /*************************************************************************
 171  * Ole Convert support
 172  */
 173
 174 void OLECONVERT_CreateOleStream(LPSTORAGE pStorage);
 175 HRESULT OLECONVERT_CreateCompObjStream(LPSTORAGE pStorage, LPCSTR strOleTypeName);
 176
 177 /****************************************************************************
 178  * Storage32BaseImpl definitions.
 179  *
 180  * This structure defines the base information contained in all implementations
 181  * of IStorage32 contained in this file storage implementation.
 182  *
 183  * In OOP terms, this is the base class for all the IStorage32 implementations
 184  * contained in this file.
 185  */
 186 struct StorageBaseImpl
 187 {
 188   const IStorageVtbl *lpVtbl;    /* Needs to be the first item in the struct
 189                             * since we want to cast this in a Storage32 pointer */
 190
 191   const IPropertySetStorageVtbl *pssVtbl; /* interface for adding a properties stream */
 192
 193   /*
 194    * Stream tracking list
 195    */
 196
 197   struct list strmHead;
 198
 199   /*
 200    * Reference count of this object
 201    */
 202   LONG ref;
 203
 204   /*
 205    * Ancestor storage (top level)
 206    */
 207   StorageImpl* ancestorStorage;
 208
 209   /*
 210    * Index of the directory entry of this storage
 211    */
 212   ULONG storageDirEntry;
 213
 214   /*
 215    * virtual Destructor method.
 216    */
 217   void (*v_destructor)(StorageBaseImpl*);
 218
 219   /*
 220    * flags that this storage was opened or created with
 221    */
 222   DWORD openFlags;
 223
 224   /*
 225    * State bits appear to only be preserved while running. No in the stream
 226    */
 227   DWORD stateBits;
 228 };
 229
 230 /****************************************************************************
 231  * StorageBaseImpl stream list handlers
 232  */
 233
 234 void StorageBaseImpl_AddStream(StorageBaseImpl * stg, StgStreamImpl * strm);
 235 void StorageBaseImpl_RemoveStream(StorageBaseImpl * stg, StgStreamImpl * strm);
 236
 237 /****************************************************************************
 238  * Storage32Impl definitions.
 239  *
 240  * This implementation of the IStorage32 interface represents a root
 241  * storage. Basically, a document file.
 242  */
 243 struct StorageImpl
 244 {
 245   struct StorageBaseImpl base;
 246
 247   /*
 248    * The following data members are specific to the Storage32Impl
 249    * class
 250    */
 251   HANDLE           hFile;      /* Physical support for the Docfile */
 252   LPOLESTR         pwcsName;   /* Full path of the document file */
 253   BOOL             create;     /* Was the storage created or opened.
 254                                   The behaviour of STGM_SIMPLE depends on this */
 255
 256   /* FIXME: should this be in Storage32BaseImpl ? */
 257   WCHAR            filename[DIRENTRY_NAME_BUFFER_LEN];
 258
 259   /*
 260    * File header
 261    */
 262   WORD  bigBlockSizeBits;
 263   WORD  smallBlockSizeBits;
 264   ULONG bigBlockSize;
 265   ULONG smallBlockSize;
 266   ULONG bigBlockDepotCount;
 267   ULONG rootStartBlock;
 268   ULONG smallBlockDepotStart;
 269   ULONG extBigBlockDepotStart;
 270   ULONG extBigBlockDepotCount;
 271   ULONG bigBlockDepotStart[COUNT_BBDEPOTINHEADER];
 272
 273   ULONG blockDepotCached[NUM_BLOCKS_PER_DEPOT_BLOCK];
 274   ULONG indexBlockDepotCached;
 275   ULONG prevFreeBlock;
 276
 277   /*
 278    * Abstraction of the big block chains for the chains of the header.
 279    */
 280   BlockChainStream* rootBlockChain;
 281   BlockChainStream* smallBlockDepotChain;
 282   BlockChainStream* smallBlockRootChain;
 283
 284   /*
 285    * Pointer to the big block file abstraction
 286    */
 287   BigBlockFile* bigBlockFile;
 288 };
 289
 290 HRESULT StorageImpl_ReadRawDirEntry(
 291             StorageImpl *This,
 292             ULONG index,
 293             BYTE *buffer);
 294
 295 void UpdateRawDirEntry(
 296     BYTE *buffer,
 297     const DirEntry *newData);
 298
 299 HRESULT StorageImpl_WriteRawDirEntry(
 300             StorageImpl *This,
 301             ULONG index,
 302             const BYTE *buffer);
 303
 304 BOOL StorageImpl_ReadDirEntry(
 305             StorageImpl*    This,
 306             ULONG           index,
 307             DirEntry*       buffer);
 308
 309 BOOL StorageImpl_WriteDirEntry(
 310             StorageImpl*        This,
 311             ULONG               index,
 312             const DirEntry*     buffer);
 313
 314 BlockChainStream* Storage32Impl_SmallBlocksToBigBlocks(
 315                       StorageImpl* This,
 316                       SmallBlockChainStream** ppsbChain);
 317
 318 SmallBlockChainStream* Storage32Impl_BigBlocksToSmallBlocks(
 319                       StorageImpl* This,
 320                       BlockChainStream** ppbbChain);
 321
 322 /****************************************************************************
 323  * StgStreamImpl definitions.
 324  *
 325  * This class implements the IStream32 interface and represents a stream
 326  * located inside a storage object.
 327  */
 328 struct StgStreamImpl
 329 {
 330   const IStreamVtbl *lpVtbl;  /* Needs to be the first item in the struct
 331                          * since we want to cast this to an IStream pointer */
 332
 333   /*
 334    * We are an entry in the storage object's stream handler list
 335    */
 336
 337   struct list StrmListEntry;
 338
 339   /*
 340    * Reference count
 341    */
 342   LONG               ref;
 343
 344   /*
 345    * Storage that is the parent(owner) of the stream
 346    */
 347   StorageBaseImpl* parentStorage;
 348
 349   /*
 350    * Access mode of this stream.
 351    */
 352   DWORD grfMode;
 353
 354   /*
 355    * Index of the directory entry that owns (points to) this stream.
 356    */
 357   ULONG              dirEntry;
 358
 359   /*
 360    * Helper variable that contains the size of the stream
 361    */
 362   ULARGE_INTEGER     streamSize;
 363
 364   /*
 365    * This is the current position of the cursor in the stream
 366    */
 367   ULARGE_INTEGER     currentPosition;
 368
 369   /*
 370    * The information in the stream is represented by a chain of small blocks
 371    * or a chain of large blocks. Depending on the case, one of the two
 372    * following variables points to that information.
 373    */
 374   BlockChainStream*      bigBlockChain;
 375   SmallBlockChainStream* smallBlockChain;
 376 };
 377
 378 /*
 379  * Method definition for the StgStreamImpl class.
 380  */
 381 StgStreamImpl* StgStreamImpl_Construct(
 382                 StorageBaseImpl* parentStorage,
 383     DWORD            grfMode,
 384     ULONG            dirEntry);
 385
 386
 387 /******************************************************************************
 388  * Endian conversion macros
 389  */
 390 #ifdef WORDS_BIGENDIAN
 391
 392 #define htole32(x) RtlUlongByteSwap(x)
 393 #define htole16(x) RtlUshortByteSwap(x)
 394 #define lendian32toh(x) RtlUlongByteSwap(x)
 395 #define lendian16toh(x) RtlUshortByteSwap(x)
 396
 397 #else
 398
 399 #define htole32(x) (x)
 400 #define htole16(x) (x)
 401 #define lendian32toh(x) (x)
 402 #define lendian16toh(x) (x)
 403
 404 #endif
 405
 406 /******************************************************************************
 407  * The StorageUtl_ functions are miscellaneous utility functions. Most of which
 408  * are abstractions used to read values from file buffers without having to
 409  * worry about bit order
 410  */
 411 void StorageUtl_ReadWord(const BYTE* buffer, ULONG offset, WORD* value);
 412 void StorageUtl_WriteWord(BYTE* buffer, ULONG offset, WORD value);
 413 void StorageUtl_ReadDWord(const BYTE* buffer, ULONG offset, DWORD* value);
 414 void StorageUtl_WriteDWord(BYTE* buffer, ULONG offset, DWORD value);
 415 void StorageUtl_ReadULargeInteger(const BYTE* buffer, ULONG offset,
 416  ULARGE_INTEGER* value);
 417 void StorageUtl_WriteULargeInteger(BYTE* buffer, ULONG offset,
 418  const ULARGE_INTEGER *value);
 419 void StorageUtl_ReadGUID(const BYTE* buffer, ULONG offset, GUID* value);
 420 void StorageUtl_WriteGUID(BYTE* buffer, ULONG offset, const GUID* value);
 421 void StorageUtl_CopyDirEntryToSTATSTG(STATSTG* destination, const DirEntry* source,
 422  int statFlags);
 423
 424 /****************************************************************************
 425  * BlockChainStream definitions.
 426  *
 427  * The BlockChainStream class is a utility class that is used to create an
 428  * abstraction of the big block chains in the storage file.
 429  */
 430 struct BlockChainStream
 431 {
 432   StorageImpl* parentStorage;
 433   ULONG*       headOfStreamPlaceHolder;
 434   ULONG        ownerDirEntry;
 435   ULONG        lastBlockNoInSequence;
 436   ULONG        lastBlockNoInSequenceIndex;
 437   ULONG        tailIndex;
 438   ULONG        numBlocks;
 439 };
 440
 441 /*
 442  * Methods for the BlockChainStream class.
 443  */
 444 BlockChainStream* BlockChainStream_Construct(
 445                 StorageImpl* parentStorage,
 446                 ULONG*         headOfStreamPlaceHolder,
 447                 ULONG          dirEntry);
 448
 449 void BlockChainStream_Destroy(
 450                 BlockChainStream* This);
 451
 452 HRESULT BlockChainStream_ReadAt(
 453                 BlockChainStream* This,
 454                 ULARGE_INTEGER offset,
 455                 ULONG          size,
 456                 void*          buffer,
 457                 ULONG*         bytesRead);
 458
 459 HRESULT BlockChainStream_WriteAt(
 460                 BlockChainStream* This,
 461                 ULARGE_INTEGER offset,
 462                 ULONG          size,
 463                 const void*    buffer,
 464                 ULONG*         bytesWritten);
 465
 466 BOOL BlockChainStream_SetSize(
 467                 BlockChainStream* This,
 468                 ULARGE_INTEGER    newSize);
 469
 470 /****************************************************************************
 471  * SmallBlockChainStream definitions.
 472  *
 473  * The SmallBlockChainStream class is a utility class that is used to create an
 474  * abstraction of the small block chains in the storage file.
 475  */
 476 struct SmallBlockChainStream
 477 {
 478   StorageImpl* parentStorage;
 479   ULONG          ownerDirEntry;
 480   ULONG*         headOfStreamPlaceHolder;
 481 };
 482
 483 /*
 484  * Methods of the SmallBlockChainStream class.
 485  */
 486 SmallBlockChainStream* SmallBlockChainStream_Construct(
 487            StorageImpl*   parentStorage,
 488            ULONG*         headOfStreamPlaceHolder,
 489            ULONG          dirEntry);
 490
 491 void SmallBlockChainStream_Destroy(
 492                SmallBlockChainStream* This);
 493
 494 HRESULT SmallBlockChainStream_ReadAt(
 495                SmallBlockChainStream* This,
 496                ULARGE_INTEGER offset,
 497                ULONG          size,
 498                void*          buffer,
 499                ULONG*         bytesRead);
 500
 501 HRESULT SmallBlockChainStream_WriteAt(
 502                SmallBlockChainStream* This,
 503                ULARGE_INTEGER offset,
 504                ULONG          size,
 505                const void*    buffer,
 506                ULONG*         bytesWritten);
 507
 508 BOOL SmallBlockChainStream_SetSize(
 509                SmallBlockChainStream* This,
 510                ULARGE_INTEGER          newSize);
 511
 512
 513 #endif /* __STORAGE32_H__ */