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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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.
*
************************************************************************/
#include <bf_svtools/filerec.hxx>
#include <osl/endian.h>
namespace binfilter
{
//========================================================================
/* Die folgenden Makros extrahieren Teilbereiche aus einem UINT32 Wert.
Diese UINT32-Werte werden anstelle der einzelnen Werte gestreamt,
um Calls zu sparen.
*/
#define SFX_REC_PRE(n) ( ((n) & 0x000000FF) )
#define SFX_REC_OFS(n) ( ((n) & 0xFFFFFF00) >> 8 )
#define SFX_REC_TYP(n) ( ((n) & 0x000000FF) )
#define SFX_REC_VER(n) ( ((n) & 0x0000FF00) >> 8 )
#define SFX_REC_TAG(n) ( ((n) & 0xFFFF0000) >> 16 )
#define SFX_REC_CONTENT_VER(n) ( ((n) & 0x000000FF) )
#define SFX_REC_CONTENT_OFS(n) ( ((n) & 0xFFFFFF00) >> 8 )
//-------------------------------------------------------------------------
/* Die folgenden Makros setzen Teilbereiche zu einem UINT32 Wert zusammen.
Diese UINT32-Werte werden anstelle der einzelnen Werte gestreamt,
um Calls zu sparen.
*/
#define SFX_REC_HEADER(nRecType,nContentTag,nContentVer) \
( UINT32(nRecType) | \
( UINT32(nContentVer) << 8 ) | \
( UINT32(nContentTag) << 16 ) )
//=========================================================================
bool SfxMiniRecordReader::SetHeader_Impl( UINT32 nHeader )
/* [Beschreibung]
Interne Methode zum nachtr"aglichen Verarbeiten eines extern gelesenen
Headers. Falls der Header eine End-Of-Records-Kennung darstellt,
wird am Stream ein Errorcode gesetzt und FALSE zur"uckgeliefert. Im
Fehlerfall wird der Stream jedoch nicht auf den Record-Anfang zur"uck-
gesetzt.
*/
{
bool bRet = true;
// Record-Ende und Pre-Tag aus dem Header ermitteln
_nEofRec = _pStream->Tell() + SFX_REC_OFS(nHeader);
_nPreTag = sal::static_int_cast< BYTE >(SFX_REC_PRE(nHeader));
// wenn End-Of-Record-Kennung, dann Fehler
if ( _nPreTag == SFX_REC_PRETAG_EOR )
{
_pStream->SetError( ERRCODE_IO_WRONGFORMAT );
bRet = false;
}
return bRet;
}
//-------------------------------------------------------------------------
SfxMiniRecordReader::SfxMiniRecordReader
(
SvStream* pStream, /* <SvStream>, an dessen aktueller
Position sich ein <SfxMiniRecord>
befindet.
*/
BYTE nTag // Pre-Tag des gew"unschten Records
)
/* [Beschreibung]
Dieser Ctor interpretiert 'pStream' ab der aktuellen Position als
eine l"uckenlose Folge von, von dieser Klassen-Gruppe interpretierbaren,
Records. Der in dieser Folge erste als <SfxMiniRecord> interpretierbare
(also ggf. auch ein extended-Record) mit dem PreTag 'nTag' wird ge"offnet
und durch diese Instanz repr"asentiert.
Wird das Ende des Streams oder die Kennung SFX_REC_PRETAG_EOR
erreicht, bevor ein Record mit dem ge"unschten Pre-Tag gefunden wird,
ist die erzeugte Instanz ung"ultig ('IsValid() == FALSE'). Ein ent-
sprechender Error-Code (ERRCODE_IO_EOF bzw. ERRCODE_IO_WRONGFORMAT)
ist dann am Stream gesetzt, dessen Position ist dann au\serdem unver-
"andert.
Bei 'nTag==SFX_FILEREC_PRETAG_EOR' wird nicht versucht, einen Record
zu lesen, es wird sofort 'IsValid()' auf FALSE gesetzt und kein Error-Code
am Stream gesetzt. Dies ist dauzu gedacht, ohne 'new' und 'delete'
abw"rtskompatibel SfxMiniRecords einbauen zu k"onnen. Siehe dazu
<SfxItemSet::Load()>.
[Anwendungsvorschlag]
Wird dieser Ctor in einer bereits ausgelieferten Programmversion
verwendet, k"onnen in das File-Format jeweils davor kompatibel neue
Records mit einer anderen Kennung eingef"ugt werden. Diese werden
schlie\slich automatisch "uberlesen. Erkauft wird diese M"oglichkeit
allerdings mit etwas schlechterem Laufzeitverhalten im Vergleich mit
direktem 'drauf-los-lesen', der sich jedoch auf einen Vergleich zweier
Bytes reduziert, falls der gesuchte Record der erste in der Folge ist.
*/
: _pStream( pStream ),
_bSkipped( nTag == SFX_REC_PRETAG_EOR )
{
// ggf. ignorieren (s.o.)
if ( _bSkipped )
{
_nPreTag = nTag;
return;
}
// StartPos merken, um im Fehlerfall zur"uck-seeken zu k"onnen
UINT32 nStartPos = pStream->Tell();
// passenden Record suchen
while(TRUE)
{
// Header lesen
DBG( DbgOutf( "SfxFileRec: searching record at %ul", pStream->Tell() ) );
UINT32 nHeader(0);
*pStream >> nHeader;
// Headerdaten von Basisklasse extrahieren lassen
SetHeader_Impl( nHeader );
// ggf. Fehler behandeln
if ( !pStream->good() )
_nPreTag = SFX_REC_PRETAG_EOR;
else if ( _nPreTag == SFX_REC_PRETAG_EOR )
pStream->SetError( ERRCODE_IO_WRONGFORMAT );
else
{
// wenn gefunden, dann Schleife abbrechen
if ( _nPreTag == nTag )
break;
// sonst skippen und weitersuchen
pStream->Seek( _nEofRec );
continue;
}
// Fehler => zur"uck-seeken
pStream->Seek( nStartPos );
break;
}
}
//=========================================================================
inline bool SfxSingleRecordReader::ReadHeader_Impl( USHORT nTypes )
/* [Beschreibung]
Interne Methode zum Einlesen eines SfxMultiRecord-Headers, nachdem
die Basisklasse bereits initialisiert und deren Header gelesen ist.
Ggf. ist ein Error-Code am Stream gesetzt, im Fehlerfall wird jedoch
nicht zur"uckge-seekt.
*/
{
bool bRet;
// Basisklassen-Header einlesen
UINT32 nHeader(0);
*_pStream >> nHeader;
if ( !SetHeader_Impl( nHeader ) )
bRet = FALSE;
else
{
// eigenen Header einlesen
*_pStream >> nHeader;
_nRecordVer = sal::static_int_cast< BYTE >(SFX_REC_VER(nHeader));
_nRecordTag = sal::static_int_cast< UINT16 >(SFX_REC_TAG(nHeader));
// falscher Record-Typ?
_nRecordType = sal::static_int_cast< BYTE >(SFX_REC_TYP(nHeader));
bRet = 0 != ( nTypes & _nRecordType);
}
return bRet;
}
//-------------------------------------------------------------------------
SfxSingleRecordReader::SfxSingleRecordReader( SvStream *pStream, USHORT nTag )
{
// StartPos merken, um im Fehlerfall zur"uck-seeken zu k"onnen
UINT32 nStartPos = pStream->Tell();
// richtigen Record suchen, ggf. Error-Code setzen und zur"uck-seeken
Construct_Impl( pStream );
if ( !FindHeader_Impl( SFX_REC_TYPE_SINGLE, nTag ) )
{
// Error-Code setzen und zur"uck-seeken
pStream->Seek( nStartPos );
pStream->SetError( ERRCODE_IO_WRONGFORMAT );
}
}
//-------------------------------------------------------------------------
bool SfxSingleRecordReader::FindHeader_Impl
(
UINT16 nTypes, // arithm. Veroderung erlaubter Record-Typen
UINT16 nTag // zu findende Record-Art-Kennung
)
/* [Beschreibung]
Interne Methode zum lesen des Headers des ersten Record, der einem
der Typen in 'nTypes' entspricht und mit der Art-Kennung 'nTag'
gekennzeichnet ist.
Kann ein solcher Record nicht gefunden werden, wird am Stream ein
Errorcode gesetzt, zur"uck-geseekt und FALSE zur"uckgeliefert.
*/
{
// StartPos merken, um im Fehlerfall zur"uck-seeken zu k"onnen
UINT32 nStartPos = _pStream->Tell();
// richtigen Record suchen
while ( _pStream->good() )
{
// Header lesen
UINT32 nHeader(0);
DBG( DbgOutf( "SfxFileRec: searching record at %ul", _pStream->Tell() ) );
*_pStream >> nHeader;
if ( !_pStream->good() || !SetHeader_Impl( nHeader ) )
// EOR => Such-Schleife abbreichen
break;
// Extended Record gefunden?
if ( _nPreTag == SFX_REC_PRETAG_EXT )
{
// Extended Header lesen
*_pStream >> nHeader;
if ( !_pStream->good() )
break;
_nRecordTag = sal::static_int_cast< UINT16 >(SFX_REC_TAG(nHeader));
// richtigen Record gefunden?
if ( _nRecordTag == nTag )
{
// gefundener Record-Typ passend?
_nRecordType = sal::static_int_cast< BYTE >(
SFX_REC_TYP(nHeader));
if ( nTypes & _nRecordType )
// ==> gefunden
return TRUE;
// error => Such-Schleife abbrechen
break;
}
}
// sonst skippen
if ( _pStream->good() )
_pStream->Seek( _nEofRec );
}
// Fehler setzen und zur"uck-seeken
_pStream->SetError( ERRCODE_IO_WRONGFORMAT );
_pStream->Seek( nStartPos );
return FALSE;
}
//=========================================================================
bool SfxMultiRecordReader::ReadHeader_Impl()
/* [Beschreibung]
Interne Methode zum Einlesen eines SfxMultiRecord-Headers, nachdem
die Basisklasse bereits initialisiert und deren Header gelesen ist.
Ggf. ist ein Error-Code am Stream gesetzt, im Fehlerfall wird jedoch
nicht zur"uckge-seekt.
*/
{
// eigenen Header lesen
*_pStream >> _nContentCount;
*_pStream >> _nContentSize; // Fix: jedes einzelnen, Var|Mix: Tabellen-Pos.
// mu\s noch eine Tabelle mit Content-Offsets geladen werden?
if ( _nRecordType != SFX_REC_TYPE_FIXSIZE )
{
// Tabelle aus dem Stream einlesen
UINT32 nContentPos = _pStream->Tell();
if ( _nRecordType == SFX_REC_TYPE_VARSIZE_RELOC ||
_nRecordType == SFX_REC_TYPE_MIXTAGS_RELOC )
_pStream->SeekRel( + _nContentSize );
else
_pStream->Seek( _nContentSize );
_pContentOfs = new UINT32[_nContentCount];
memset(_pContentOfs, 0, _nContentCount*sizeof(UINT32));
//! darf man jetzt so einr"ucken
#if defined(OSL_LITENDIAN)
_pStream->Read( _pContentOfs, sizeof(UINT32)*_nContentCount );
#else
for ( USHORT n = 0; n < _nContentCount; ++n )
*_pStream >> _pContentOfs[n];
#endif
_pStream->Seek( nContentPos );
}
// Header konnte gelesen werden, wenn am Stream kein Error gesetzt ist
return !_pStream->GetError();
}
//-------------------------------------------------------------------------
SfxMultiRecordReader::SfxMultiRecordReader( SvStream *pStream, UINT16 nTag )
: _pContentOfs(0)
, _nContentSize(0)
, _nContentCount(0)
, _nContentNo(0)
{
// Position im Stream merken, um im Fehlerfall zur"uck-seeken zu k"onnen
_nStartPos = pStream->Tell();
// passenden Record suchen und Basisklasse initialisieren
SfxSingleRecordReader::Construct_Impl( pStream );
if ( SfxSingleRecordReader::FindHeader_Impl( SFX_REC_TYPE_FIXSIZE |
SFX_REC_TYPE_VARSIZE | SFX_REC_TYPE_VARSIZE_RELOC |
SFX_REC_TYPE_MIXTAGS | SFX_REC_TYPE_MIXTAGS_RELOC,
nTag ) )
{
// eigenen Header dazu-lesen
if ( !ReadHeader_Impl() )
// nicht lesbar => als ung"ultig markieren und zur"uck-seeken
SetInvalid_Impl( _nStartPos);
}
}
//-------------------------------------------------------------------------
SfxMultiRecordReader::~SfxMultiRecordReader()
{
delete[] _pContentOfs;
}
//-------------------------------------------------------------------------
bool SfxMultiRecordReader::GetContent()
/* [Beschreibung]
Positioniert den Stream an den Anfang des n"chsten bzw. beim 1. Aufruf
auf den Anfang des ersten Contents im Record und liest ggf. dessen
Header ein.
Liegt laut Record-Header kein Content mehr vor, wird FALSE zur"uck-
gegeben. Trotz einem TRUE-Returnwert kann am Stream ein Fehlercode
gesetzt sein, z.B. falls er unvorhergesehenerweise (kaputtes File)
zuende ist.
*/
{
// noch ein Content vorhanden?
if ( _nContentNo < _nContentCount )
{
// den Stream an den Anfang des Contents positionieren
UINT32 nOffset = _nRecordType == SFX_REC_TYPE_FIXSIZE
? _nContentNo * _nContentSize
: SFX_REC_CONTENT_OFS(_pContentOfs[_nContentNo]);
UINT32 nNewPos = _nStartPos + nOffset;
DBG_ASSERT( nNewPos >= _pStream->Tell(), "SfxMultiRecordReader::GetContent() - New position before current, to much data red!" );
// correct stream pos in every case;
// the if clause was added by MT a long time ago,
// maybe to 'repair' other corrupt documents; but this
// gives errors when writing with 5.1 and reading with current
// versions, so we decided to remove the if clause
// if ( nNewPos > _pStream->Tell() )
_pStream->Seek( nNewPos );
// ggf. Content-Header lesen
if ( _nRecordType == SFX_REC_TYPE_MIXTAGS ||
_nRecordType == SFX_REC_TYPE_MIXTAGS_RELOC )
{
_nContentVer = sal::static_int_cast< BYTE >(
SFX_REC_CONTENT_VER(_pContentOfs[_nContentNo]));
*_pStream >> _nContentTag;
}
// ContentNo weiterz"ahlen
++_nContentNo;
return TRUE;
}
return FALSE;
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|