summaryrefslogtreecommitdiffstats
path: root/private/ole32/stg/h/dl.hxx
blob: a9067ba81687a4b62b7c0ddba2853f020872c5b0 (plain) (blame)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
//+-------------------------------------------------------------------------
//
//  Microsoft Windows
//  Copyright (C) Microsoft Corporation, 1992 - 1992.
//
//  File:       dl.hxx
//
//  Contents:   Delta list headers for streams
//
//  Classes:    SDeltaBlock
//              CDeltaList
//
//  History:    28-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

#ifndef __DL_HXX__
#define __DL_HXX__

#define DL_GET 0
#define DL_CREATE 1
#define DL_READ 2

class CTransactedStream;
SAFE_DFBASED_PTR(CBasedTransactedStreamPtr, CTransactedStream);

#define CBITPERUSHORT 16

//+-------------------------------------------------------------------------
//
//  Class:      SDeltaBlock (db)
//
//  Purpose:    A single block of delta list entries.
//
//  Interface:
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//  Notes:
//
//--------------------------------------------------------------------------

struct SDeltaBlock
{
public:
#ifndef _MAC
    inline
#endif
    SDeltaBlock();

#ifndef _MAC
    inline
#endif
    void *operator new(size_t size, IMalloc * const pMalloc);

    inline const BOOL IsOwned(const USHORT uOffset);
    inline void MakeOwned(const USHORT uOffset);

    SECT    _sect[CSECTPERBLOCK];
    USHORT    _fOwn[(CSECTPERBLOCK / CBITPERUSHORT)];
};
SAFE_DFBASED_PTR(CBasedDeltaBlockPtr, SDeltaBlock);
SAFE_DFBASED_PTR(CBasedDeltaBlockPtrPtr, CBasedDeltaBlockPtr);


inline const BOOL SDeltaBlock::IsOwned(const USHORT uOffset)
{
    msfAssert(uOffset < CSECTPERBLOCK);
    return (_fOwn[uOffset / CBITPERUSHORT] &
            (1 << (uOffset % CBITPERUSHORT))) != 0;
}

inline void SDeltaBlock::MakeOwned(const USHORT uOffset)
{
    msfAssert(uOffset < CSECTPERBLOCK);
    msfAssert(!IsOwned(uOffset));
    msfAssert((uOffset / CBITPERUSHORT) < (CSECTPERBLOCK / CBITPERUSHORT));
    
    _fOwn[uOffset / CBITPERUSHORT] |= (1 << (uOffset % CBITPERUSHORT));
}

//+-------------------------------------------------------------------------
//
//  Class:      CDeltaList (dl)
//
//  Purpose:    Delta list for transacted streans.
//
//  Interface:
//
//  History:    21-Jan-92   PhilipLa    Created.
//
//  Notes:
//
//--------------------------------------------------------------------------

class CDeltaList
{
public:
#ifdef USE_NOSCRATCH    
    CDeltaList(CMStream *pms, CMStream *pmsScratch);
#else
    CDeltaList(CMStream *pmsScratch);
#endif    

    SCODE Init(ULONG ulSize, CTransactedStream *ptsParent);
    SCODE InitResize(ULONG ulSize);

    ~CDeltaList();

    SCODE GetMap(SECT sectOld, const DWORD dwFlags, SECT *psectRet);

    void BeginCommit(CTransactedStream *ptsParent);
    void EndCommit(CDeltaList *pdlNew, DFLAGS df);

    inline ILockBytes *GetDataILB(void);
    inline ILockBytes *GetControlILB(void);

    inline CFat * GetDataFat(void);
    inline CFat * GetControlFat(void);

    inline USHORT GetDataSectorSize(void);
    inline USHORT GetDataSectorShift(void);
    
    inline USHORT GetControlSectorSize(void);
    
    void Empty(void);

    inline BOOL IsEmpty(void);
    inline BOOL IsInMemory(void);
    inline BOOL IsInStream(void);
    
#ifdef USE_NOSCRATCH    
    inline BOOL IsNoScratch(void);
#endif    

    SCODE IsOwned(SECT sect, SECT sectMap, BOOL *fOwn);


private:
    CBasedDeltaBlockPtrPtr _apdb;
    ULONG _ulSize;

    CBasedMStreamPtr _pmsScratch;
    
#ifdef USE_NOSCRATCH    
    CBasedMStreamPtr _pms;
#endif
    
    CBasedTransactedStreamPtr _ptsParent;
    SECT _sectStart;

    SCODE InitStreamBlock(ULONG ul);

    SCODE ReadMap(SECT *psectStart, SECT sect, SECT *psectRet);
    SCODE WriteMap(SECT *psectStart, SECT sect, SECT sectMap);

    void FreeStream(SECT sectStart, ULONG ulSize);

    SCODE FindOffset(
            SECT *psectStart,
            SECT sect,
            ULARGE_INTEGER *pulRet,
            BOOL fWrite);

    SCODE DumpList(void);

#if DBG == 1
    void PrintList(void);
#endif
    
    void ReleaseBlock(ULONG oBlock);

    inline CBasedDeltaBlockPtr * GetNewDeltaArray(ULONG ulSize);
};
SAFE_DFBASED_PTR(CBasedDeltaListPtr, CDeltaList);

//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetDataILB, public
//
//  Synopsis:   Return pointer to ILockBytes for storing data
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline ILockBytes * CDeltaList::GetDataILB(void)
{
#ifdef USE_NOSCRATCH    
    if (_pms)
        return _pms->GetILB();
    else
#endif        
        return _pmsScratch->GetILB();
}


//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetControlILB, public
//
//  Synopsis:   Return pointer to ILockBytes for storing control information
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline ILockBytes * CDeltaList::GetControlILB(void)
{
    return _pmsScratch->GetILB();
}


//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetDataFat, public
//
//  Synopsis:   Return pointer to fat to use for storing stream data
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline CFat * CDeltaList::GetDataFat(void)
{
#ifdef USE_NOSCRATCH    
    if (_pms)
        return _pmsScratch->GetMiniFat();
    else
#endif        
        return _pmsScratch->GetFat();
}


//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetControlFat, public
//
//  Synopsis:   Return pointer to fat to use for storing control information
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline CFat * CDeltaList::GetControlFat(void)
{
    return _pmsScratch->GetFat();
}

//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetDataSectorSize, public
//
//  Synopsis:   Return sector size for storing stream data
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline USHORT CDeltaList::GetDataSectorSize(void)
{
#ifdef USE_NOSCRATCH    
    if (_pms)
        return _pms->GetSectorSize();
    else
        return _pmsScratch->GetSectorSize();
#else
    return SCRATCHSECTORSIZE;
#endif    
}

//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetDataSectorShift, public
//
//  Synopsis:   Return sector size for storing stream data
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline USHORT CDeltaList::GetDataSectorShift(void)
{
#ifdef USE_NOSCRATCH    
    if (_pms)
        return _pms->GetSectorShift();
    else
        return _pmsScratch->GetSectorShift();
#else
    return SCRATCHSECTORSHIFT;
#endif    
}

//+-------------------------------------------------------------------------
//
//  Method:     CDeltaList::GetControlSectorSize, public
//
//  Synopsis:   Return sector size for storing control information
//
//  History:    10-Jul-92   PhilipLa    Created.
//
//--------------------------------------------------------------------------

inline USHORT CDeltaList::GetControlSectorSize(void)
{
#ifdef USE_NOSCRATCH    
    return _pmsScratch->GetSectorSize();
#else
    return SCRATCHSECTORSIZE;
#endif    
}

#ifdef USE_NOSCRATCH
//+---------------------------------------------------------------------------
//
//  Member:	CDeltaList::IsNoScratch, public
//
//  Synopsis:	Return TRUE if the delta list is in no-scratch mode
//
//  Arguments:	None.
//
//  History:	19-Nov-92	PhilipLa	Created
//
//----------------------------------------------------------------------------

inline BOOL CDeltaList::IsNoScratch(void)
{
    return (_pms != NULL);
}
#endif

//+---------------------------------------------------------------------------
//
//  Member:	CDeltaList::IsEmpty, public
//
//  Synopsis:	Return TRUE if the delta list contains no changes.
//
//  Arguments:	None.
//
//  History:	19-Nov-92	PhilipLa	Created
//
//----------------------------------------------------------------------------

inline BOOL CDeltaList::IsEmpty(void)
{
    return ((_apdb == NULL) && (_sectStart == ENDOFCHAIN));
}


//+---------------------------------------------------------------------------
//
//  Member:	CDeltaList::IsInMemory, public
//
//  Synopsis:	Return TRUE if the delta list is in memory
//
//  Arguments:	None.
//
//  History:	19-Nov-92	PhilipLa	Created
//
//----------------------------------------------------------------------------

inline BOOL CDeltaList::IsInMemory(void)
{
    return (_apdb != NULL);
}


//+---------------------------------------------------------------------------
//
//  Member:	CDeltaList::IsInStream, public
//
//  Synopsis:	Return TRUE if the delta list is in a stream
//
//  Arguments:	None.
//
//  History:	19-Nov-92	PhilipLa	Created
//
//----------------------------------------------------------------------------

inline BOOL CDeltaList::IsInStream(void)
{
    return ((_apdb == NULL) && (_sectStart != ENDOFCHAIN));
}

#endif //__DL_HXX__