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
167
168
169
170
171
172
173
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: stgstrms.hxx,v $
* $Revision: 1.4 $
*
* 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.
*
************************************************************************/
#ifndef _STGSTRMS_HXX
#define _STGSTRMS_HXX
#ifndef _TOOLS_STREAM_HXX
#include <tools/stream.hxx>
#endif
class StgIo;
class StgStrm;
class StgPage;
class StgDirEntry;
// The FAT class performs FAT operations on an underlying storage stream.
// This stream is either the physical FAT stream (bPhys == TRUE ) or a normal
// storage stream, which then holds the FAT for small data allocations.
class StgFAT
{ // FAT allocator
StgStrm& rStrm; // underlying stream
INT32 nMaxPage; // highest page allocated so far
short nPageSize; // physical page size
short nEntries; // FAT entries per page
short nOffset; // current offset within page
INT32 nLimit; // search limit recommendation
BOOL bPhys; // TRUE: physical FAT
StgPage* GetPhysPage( INT32 nPage );
BOOL MakeChain( INT32 nStart, INT32 nPages );
BOOL InitNew( INT32 nPage1 );
public:
StgFAT( StgStrm& rStrm, BOOL bMark );
INT32 FindBlock( INT32& nPages );
INT32 GetNextPage( INT32 nPg );
INT32 AllocPages( INT32 nStart, INT32 nPages );
BOOL FreePages( INT32 nStart, BOOL bAll );
INT32 GetMaxPage() { return nMaxPage; }
void SetLimit( INT32 n ) { nLimit = n; }
};
// The base stream class provides basic functionality for seeking
// and accessing the data on a physical basis. It uses the built-in
// FAT class for the page allocations.
class StgStrm { // base class for all streams
protected:
StgIo& rIo; // I/O system
StgFAT* pFat; // FAT stream for allocations
StgDirEntry* pEntry; // dir entry (for ownership)
INT32 nStart; // 1st data page
INT32 nSize; // stream size in bytes
INT32 nPos; // current byte position
INT32 nPage; // current logical page
short nOffset; // offset into current page
short nPageSize; // logical page size
BOOL Copy( INT32 nFrom, INT32 nBytes );
StgStrm( StgIo& );
public:
virtual ~StgStrm();
StgIo& GetIo() { return rIo; }
INT32 GetPos() { return nPos; }
INT32 GetStart() { return nStart; }
INT32 GetSize() { return nSize; }
INT32 GetPage() { return nPage; }
short GetPageSize() { return nPageSize; }
INT32 GetPages();
short GetOffset() { return nOffset;}
void SetEntry( StgDirEntry& );
virtual BOOL SetSize( INT32 );
virtual BOOL Pos2Page( INT32 nBytePos );
virtual INT32 Read( void*, INT32 ) { return 0; }
virtual INT32 Write( const void*, INT32 ) { return 0; }
virtual StgPage* GetPhysPage( INT32 nBytePos, BOOL bForce = FALSE );
virtual BOOL IsSmallStrm() { return FALSE; }
};
// The FAT stream class provides physical access to the master FAT.
// Since this access is implemented as a StgStrm, we can use the
// FAT allocator.
class StgFATStrm : public StgStrm { // the master FAT stream
virtual BOOL Pos2Page( INT32 nBytePos );
BOOL SetPage( short, INT32 );
public:
StgFATStrm( StgIo& );
virtual ~StgFATStrm() {}
using StgStrm::GetPage;
INT32 GetPage( short, BOOL, USHORT *pnMasterAlloc = 0);
virtual BOOL SetSize( INT32 );
virtual StgPage* GetPhysPage( INT32 nBytePos, BOOL bForce = FALSE );
};
// The stream has a size increment which normally is 1, but which can be
// set to any value is you want the size to be incremented by certain values.
class StgDataStrm : public StgStrm // a physical data stream
{
short nIncr; // size adjust increment
void Init( INT32 nBgn, INT32 nLen );
public:
StgDataStrm( StgIo&, INT32 nBgn, INT32 nLen=-1 );
StgDataStrm( StgIo&, StgDirEntry* );
void* GetPtr( INT32 nPos, BOOL bForce, BOOL bDirty );
void SetIncrement( short n ) { nIncr = n ; }
virtual BOOL SetSize( INT32 );
virtual INT32 Read( void*, INT32 );
virtual INT32 Write( const void*, INT32 );
};
// The small stream class provides access to streams with a size < 4096 bytes.
// This stream is a StgStream containing small pages. The FAT for this stream
// is also a StgStream. The start of the FAT is in the header at DataRootPage,
// the stream itself is pointed to by the root entry (it holds start & size).
class StgSmallStrm : public StgStrm // a logical data stream
{
StgStrm* pData; // the data stream
void Init( INT32 nBgn, INT32 nLen );
public:
StgSmallStrm( StgIo&, INT32 nBgn, INT32 nLen );
StgSmallStrm( StgIo&, StgDirEntry* );
virtual INT32 Read( void*, INT32 );
virtual INT32 Write( const void*, INT32 );
virtual BOOL IsSmallStrm() { return TRUE; }
};
class StgTmpStrm : public SvMemoryStream
{
String aName;
SvFileStream* pStrm;
using SvMemoryStream::GetData;
virtual ULONG GetData( void* pData, ULONG nSize );
virtual ULONG PutData( const void* pData, ULONG nSize );
virtual ULONG SeekPos( ULONG nPos );
virtual void FlushData();
public:
StgTmpStrm( ULONG=16 );
~StgTmpStrm();
BOOL Copy( StgTmpStrm& );
void SetSize( ULONG );
ULONG GetSize() const;
};
#endif
|
