summaryrefslogtreecommitdiff
path: root/sot/source/sdstor/stgelem.hxx
blob: 951d3503adbcc80d4bcec055116b8750928cc501 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

// This file reflects the structure of MS file elements.
// It is very sensitive to alignment!

#ifndef _STGELEM_HXX
#define _STGELEM_HXX

#ifndef _TOOLS_SOLAR_H
#include <tools/solar.h>
#endif

#include <sot/stg.hxx>

class StgIo;
class SvStream;
class String;

SvStream& operator>>( SvStream&, ClsId& );
SvStream& operator<<( SvStream&, const ClsId& );

class StgHeader
{
    BYTE    cSignature[ 8 ];            // 00 signature (see below)
    ClsId   aClsId;                     // 08 Class ID
    INT32   nVersion;                   // 18 version number
    UINT16  nByteOrder;                 // 1C Unicode byte order indicator
    INT16   nPageSize;                  // 1E 1 << nPageSize = block size
    INT16   nDataPageSize;              // 20 1 << this size == data block size
    BYTE    bDirty;                     // 22 internal dirty flag
    BYTE    cReserved[ 9 ];             // 23
    INT32   nFATSize;                   // 2C total number of FAT pages
    INT32   nTOCstrm;                   // 30 starting page for the TOC stream
    INT32   nReserved;                  // 34
    INT32   nThreshold;                 // 38 minimum file size for big data
    INT32   nDataFAT;                   // 3C page # of 1st data FAT block
    INT32   nDataFATSize;               // 40 # of data fat blocks
    INT32   nMasterChain;               // 44 chain to the next master block
    INT32   nMaster;                    // 48 # of additional master blocks
    INT32   nMasterFAT[ 109 ];          // 4C first 109 master FAT pages
public:
    StgHeader();
    void  Init();                       // initialize the header
    BOOL  Load( StgIo& );
    BOOL  Load( SvStream& );
    BOOL  Store( StgIo& );
    BOOL  Check();                      // check the signature and version
    short GetByteOrder() const          { return nByteOrder;    }
    INT32 GetTOCStart() const           { return nTOCstrm;      }
    void  SetTOCStart( INT32 n );
    INT32 GetDataFATStart() const       { return nDataFAT;      }
    void  SetDataFATStart( INT32 n );
    INT32 GetDataFATSize() const        { return nDataFATSize;  }
    void  SetDataFATSize( INT32 n );
    INT32 GetThreshold() const          { return nThreshold;    }
    short GetPageSize() const           { return nPageSize;     }
    short GetDataPageSize() const       { return nDataPageSize; }
    INT32 GetFATSize() const            { return nFATSize;      }
    void  SetFATSize( INT32 n );
    INT32 GetFATChain() const           { return nMasterChain;  }
    void  SetFATChain( INT32 n );
    INT32 GetMasters() const            { return nMaster;       }
    void  SetMasters( INT32 n );
    short GetFAT1Size() const           { return 109;           }
    const ClsId& GetClassId() const     { return aClsId;        }
    void  SetClassId( const ClsId& );
    INT32 GetFATPage( short ) const;
    void  SetFATPage( short, INT32 );
};

enum StgEntryType {                     // dir entry types:
    STG_EMPTY     = 0,
    STG_STORAGE   = 1,
    STG_STREAM    = 2,
    STG_LOCKBYTES = 3,
    STG_PROPERTY  = 4,
    STG_ROOT      = 5
};

enum StgEntryRef {                      // reference blocks:
    STG_LEFT      = 0,                  // left
    STG_RIGHT     = 1,                  // right
    STG_CHILD     = 2,                  // child
    STG_DATA      = 3                   // data start
};

enum StgEntryTime {                     // time codes:
    STG_MODIFIED  = 0,                  // last modification
    STG_ACCESSED  = 1                   // last access
};

class StgStream;

#define STGENTRY_SIZE 128

class StgEntry {                        // directory enty
    UINT16  nName[ 32 ];                // 00 name as WCHAR
    INT16   nNameLen;                   // 40 size of name in bytes including 00H
    BYTE    cType;                      // 42 entry type
    BYTE    cFlags;                     // 43 0 or 1 (tree balance?)
    INT32   nLeft;                      // 44 left node entry
    INT32   nRight;                     // 48 right node entry
    INT32   nChild;                     // 4C 1st child entry if storage
    ClsId   aClsId;                     // 50 class ID (optional)
    INT32   nFlags;                     // 60 state flags(?)
    INT32   nMtime[ 2 ];                // 64 modification time
    INT32   nAtime[ 2 ];                // 6C creation and access time
    INT32   nPage1;                     // 74 starting block (either direct or translated)
    INT32   nSize;                      // 78 file size
    INT32   nUnknown;                   // 7C unknown
    String  aName;                      // Name as Compare String (ascii, upper)
public:
    BOOL    Init();                     // initialize the data
    BOOL    SetName( const String& );   // store a name (ASCII, up to 32 chars)
    void    GetName( String& rName ) const;
                                        // fill in the name
    short   Compare( const StgEntry& ) const;   // compare two entries
    BOOL    Load( const void* );
    void    Store( void* );
    StgEntryType GetType() const        { return (StgEntryType) cType;  }
    INT32   GetStartPage() const        { return nPage1; }
    void    SetType( StgEntryType t )   { cType = (BYTE) t;             }
    BYTE    GetFlags() const            { return cFlags;                }
    void    SetFlags( BYTE c )          { cFlags = c;                   }
    INT32   GetSize() const             { return nSize;                 }
    void    SetSize( INT32 n )          { nSize = n;                    }
    const   ClsId& GetClassId() const   { return aClsId;                }
    void    SetClassId( const ClsId& );
    INT32   GetLeaf( StgEntryRef ) const;
    void    SetLeaf( StgEntryRef, INT32 );
    const   INT32* GetTime( StgEntryTime ) const;
    void    SetTime( StgEntryTime, INT32* );
};


#define STG_FREE    -1L                 // page is free
#define STG_EOF     -2L                 // page is last page in chain
#define STG_FAT     -3L                 // page is FAT page
#define STG_MASTER  -4L                 // page is master FAT page

#endif