nss: upgrade to release 3.73
[LibreOffice.git] / sw / source / filter / ww8 / ww8scan.hxx
blobb9beb92652e0c7bedf60e24bf27022525eadfa59
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef INCLUDED_SW_SOURCE_FILTER_WW8_WW8SCAN_HXX
21 #define INCLUDED_SW_SOURCE_FILTER_WW8_WW8SCAN_HXX
23 #include <cassert>
24 #include <cstddef>
25 #include <deque>
26 #include <memory>
27 #include <stack>
28 #include <unordered_map>
29 #include <vector>
31 #include <osl/endian.h>
32 #include <tools/solar.h>
33 #include <tools/stream.hxx>
34 #include <rtl/ustring.hxx>
36 #include "ww8struc.hxx"
37 #include "types.hxx"
39 class SvStream;
41 //Commonly used string literals for stream and storage names in word docs
42 namespace SL
44 const char aObjectPool[] = "ObjectPool";
45 const char a1Table[] = "1Table";
46 const char a0Table[] = "0Table";
47 const char aData[] = "Data";
48 const char aCheckBox[] = "CheckBox";
49 const char aListBox[] = "ListBox";
50 const char aTextField[] = "TextField";
51 const char aMSMacroCmds[] = "MSMacroCmds";
54 struct SprmInfo
56 unsigned int nLen : 6;
57 unsigned int nVari : 2;
60 struct SprmInfoRow {
61 sal_uInt16 nId; ///< A ww8 sprm is hardcoded as 16bits
62 SprmInfo info;
65 class wwSprmSearcher {
66 public:
67 //see Read_AmbiguousSPRM for the bPatchCJK oddity
68 wwSprmSearcher(SprmInfoRow const * rows, std::size_t size, bool bPatchCJK = false) {
69 for (std::size_t i = 0; i != size; ++i) {
70 bool ins = map_.emplace(rows[i].nId, rows[i].info).second;
71 assert(ins); (void) ins;
73 if (bPatchCJK)
74 patchCJKVariant();
77 SprmInfo const * search(sal_uInt16 id) const {
78 Map::const_iterator i(map_.find(id));
79 return i == map_.end() ? nullptr : &i->second;
82 private:
83 typedef std::unordered_map<sal_uInt16, SprmInfo> Map;
85 Map map_;
87 void patchCJKVariant();
90 class WW8Fib;
92 struct SprmResult
94 const sal_uInt8* pSprm;
95 sal_Int32 nRemainingData;
96 SprmResult()
97 : pSprm(nullptr)
98 , nRemainingData(0)
101 SprmResult(const sal_uInt8* pInSprm, sal_Int32 nInRemainingData)
102 : pSprm(pInSprm)
103 , nRemainingData(nInRemainingData)
109 wwSprmParser knows how to take a sequence of bytes and split it up into
110 sprms and their arguments
112 class wwSprmParser
114 private:
115 ww::WordVersion meVersion;
116 sal_uInt8 mnDelta;
117 const wwSprmSearcher *mpKnownSprms;
118 static const wwSprmSearcher* GetWW8SprmSearcher();
119 static const wwSprmSearcher* GetWW6SprmSearcher(const WW8Fib& rFib);
120 static const wwSprmSearcher* GetWW2SprmSearcher();
122 SprmInfo GetSprmInfo(sal_uInt16 nId) const;
124 sal_uInt8 SprmDataOfs(sal_uInt16 nId) const;
126 public:
127 enum SprmType {L_FIX=0, L_VAR=1, L_VAR2=2};
129 //7- ids are very different to 8+ ones
130 explicit wwSprmParser(const WW8Fib& rFib);
131 /// Return the SPRM id at the beginning of this byte sequence
132 sal_uInt16 GetSprmId(const sal_uInt8* pSp) const;
134 sal_Int32 GetSprmSize(sal_uInt16 nId, const sal_uInt8* pSprm, sal_Int32 nRemLen) const;
136 /// Get known len of a sprms head, the bytes of the sprm id + any bytes
137 /// reserved to hold a variable length
138 sal_Int32 DistanceToData(sal_uInt16 nId) const;
140 /// Get len of a sprms data area, ignoring the bytes of the sprm id and
141 /// ignoring any len bytes. Reports the remaining data after those bytes
142 sal_uInt16 GetSprmTailLen(sal_uInt16 nId, const sal_uInt8* pSprm, sal_Int32 nRemLen) const;
144 /// The minimum acceptable sprm len possible for this type of parser
145 int MinSprmLen() const { return (IsSevenMinus(meVersion)) ? 2 : 3; }
147 /// Returns the offset to data of the first sprm of id nId, 0
148 // if not found. nLen must be the <= length of pSprms
149 SprmResult findSprmData(sal_uInt16 nId, sal_uInt8* pSprms, sal_Int32 nLen) const;
151 ww::WordVersion GetFIBVersion() const { return meVersion; }
154 //Read a Pascal-style, i.e. single byte string length followed
155 //by string contents
156 inline OUString read_uInt8_PascalString(SvStream& rStrm, rtl_TextEncoding eEnc)
158 return read_uInt8_lenPrefixed_uInt8s_ToOUString(rStrm, eEnc);
161 inline OUString read_uInt16_PascalString(SvStream& rStrm)
163 return read_uInt16_lenPrefixed_uInt16s_ToOUString(rStrm);
166 //Belt and Braces strings, i.e. Pascal-style strings followed by
167 //null termination, Spolsky calls them "fucked strings" FWIW
168 //http://www.joelonsoftware.com/articles/fog0000000319.html
169 OUString read_uInt8_BeltAndBracesString(SvStream& rStrm, rtl_TextEncoding eEnc);
170 OUString read_uInt16_BeltAndBracesString(SvStream& rStrm);
172 //--Line above which the code has meaningful comments
174 class WW8ScannerBase;
175 class WW8PLCFspecial;
176 struct WW8PLCFxDesc;
177 class WW8PLCFx_PCD;
180 reads array of strings (see MS documentation: String Table stored in File)
181 returns NOT the original pascal strings but an array of converted char*
183 attention: the *extra data* of each string are SKIPPED and ignored
185 void WW8ReadSTTBF(bool bVer8, SvStream& rStrm, sal_uInt32 nStart, sal_Int32 nLen,
186 sal_uInt16 nExtraLen, rtl_TextEncoding eCS, std::vector<OUString> &rArray,
187 std::vector<ww::bytes>* pExtraArray = nullptr, std::vector<OUString>* pValueArray = nullptr);
189 struct WW8FieldDesc
191 WW8_CP nLen; ///< total length (to skip over text)
192 WW8_CP nSCode; ///< start of instructions code
193 WW8_CP nLCode; ///< length
194 WW8_CP nSRes; ///< start of result
195 WW8_CP nLRes; ///< length ( == 0, if no result )
196 sal_uInt16 nId; ///< WW-id for fields
197 sal_uInt8 nOpt; ///< WW-Flags ( e.g.: changed by user )
198 bool bCodeNest:1; ///< instruction used recursively
199 bool bResNest:1; ///< instruction inserted into result
202 struct WW8PLCFxSave1
204 sal_uInt32 nPLCFxPos;
205 sal_uInt32 nPLCFxPos2; ///< for PLCF_Cp_Fkp: PieceIter-Pos
206 tools::Long nPLCFxMemOfs;
207 WW8_CP nStartCp; ///< for cp based iterator like PAP and CHP
208 tools::Long nCpOfs;
209 WW8_FC nStartFC;
210 WW8_CP nAttrStart;
211 WW8_CP nAttrEnd;
212 bool bLineEnd;
216 among others for fields, that is, the same number of attr as positions,
217 if Ctor-Param bNoEnd = false
219 class WW8PLCFspecial // iterator for PLCFs
221 private:
222 std::unique_ptr<sal_Int32[]> pPLCF_PosArray; ///< pointer to Pos-array and to the whole structure
223 sal_uInt8* pPLCF_Contents; ///< pointer to content-array-part of Pos-array
224 tools::Long nIMax; ///< number of elements
225 tools::Long nIdx; ///< marker where we currently are
226 sal_uInt32 nStru;
228 WW8PLCFspecial(const WW8PLCFspecial&) = delete;
229 WW8PLCFspecial& operator=(const WW8PLCFspecial&) = delete;
231 public:
232 WW8PLCFspecial(SvStream* pSt, sal_uInt32 nFilePos, sal_uInt32 nPLCF,
233 sal_uInt32 nStruct);
234 tools::Long GetIdx() const { return nIdx; }
235 void SetIdx( tools::Long nI ) { nIdx = nI; }
236 tools::Long GetIMax() const { return nIMax; }
237 bool SeekPos(tools::Long nPos); // walks over FC- or CP-value
238 // resp. next biggest value
239 bool SeekPosExact(tools::Long nPos);
240 sal_Int32 Where() const
241 { return ( nIdx >= nIMax ) ? SAL_MAX_INT32 : pPLCF_PosArray[nIdx]; }
242 bool Get(WW8_CP& rStart, void*& rpValue) const;
243 bool GetData(tools::Long nIdx, WW8_CP& rPos, void*& rpValue) const;
245 const void* GetData( tools::Long nInIdx ) const
247 return ( nInIdx >= nIMax ) ? nullptr
248 : static_cast<const void*>(&pPLCF_Contents[nInIdx * nStru]);
250 sal_Int32 GetPos( tools::Long nInIdx ) const
251 { return ( nInIdx >= nIMax ) ? SAL_MAX_INT32 : pPLCF_PosArray[nInIdx]; }
253 void advance()
255 if (nIdx <= nIMax)
256 ++nIdx;
260 /** simple Iterator for SPRMs */
261 class WW8SprmIter
263 private:
264 const wwSprmParser &mrSprmParser;
265 // these members will be updated
266 const sal_uInt8* pSprms; // remaining part of the SPRMs ( == start of current SPRM)
267 const sal_uInt8* pCurrentParams; // start of current SPRM's parameters
268 sal_uInt16 nCurrentId;
269 sal_Int32 nCurrentSize;
271 sal_Int32 nRemLen; // length of remaining SPRMs (including current SPRM)
273 void UpdateMyMembers();
275 public:
276 explicit WW8SprmIter(const sal_uInt8* pSprms_, sal_Int32 nLen_,
277 const wwSprmParser &rSprmParser);
278 void SetSprms(const sal_uInt8* pSprms_, sal_Int32 nLen_);
279 SprmResult FindSprm(sal_uInt16 nId, bool bFindFirst, const sal_uInt8* pNextByteMatch = nullptr);
280 void advance();
281 const sal_uInt8* GetSprms() const
282 { return ( pSprms && (0 < nRemLen) ) ? pSprms : nullptr; }
283 const sal_uInt8* GetCurrentParams() const { return pCurrentParams; }
284 sal_uInt16 GetCurrentId() const { return nCurrentId; }
285 sal_Int32 GetRemLen() const { return nRemLen; }
287 private:
288 WW8SprmIter(const WW8SprmIter&) = delete;
289 WW8SprmIter& operator=(const WW8SprmIter&) = delete;
292 /* among others for FKPs to normal attr., i.e. one less attr than positions */
293 class WW8PLCF // Iterator for PLCFs
295 private:
296 std::unique_ptr<WW8_CP[]> pPLCF_PosArray; // pointer to Pos-array and the whole structure
297 sal_uInt8* pPLCF_Contents; // pointer to content-array-part of Pos-array
298 sal_Int32 nIMax; // number of elements
299 sal_Int32 nIdx;
300 int nStru;
302 void ReadPLCF(SvStream& rSt, WW8_FC nFilePos, sal_uInt32 nPLCF);
305 If a PLC is missing in the doc and the FKPs stand alone,
306 we create a PLC with this:
308 void GeneratePLCF(SvStream& rSt, sal_Int32 nPN, sal_Int32 ncpN);
310 void MakeFailedPLCF();
312 void TruncToSortedRange();
313 public:
314 WW8PLCF(SvStream& rSt, WW8_FC nFilePos, sal_Int32 nPLCF, int nStruct,
315 WW8_CP nStartPos = -1);
318 the following ctor generates a PLC from nPN and ncpN, if necessary
320 WW8PLCF(SvStream& rSt, WW8_FC nFilePos, sal_Int32 nPLCF, int nStruct,
321 WW8_CP nStartPos, sal_Int32 nPN, sal_Int32 ncpN);
323 sal_Int32 GetIdx() const { return nIdx; }
324 void SetIdx( sal_Int32 nI ) { nIdx = nI; }
325 sal_Int32 GetIMax() const { return nIMax; }
326 bool SeekPos(WW8_CP nPos);
327 WW8_CP Where() const;
328 bool Get(WW8_CP& rStart, WW8_CP& rEnd, void*& rpValue) const;
329 void advance() { if( nIdx < nIMax ) ++nIdx; }
331 const void* GetData( sal_Int32 nInIdx ) const
333 return ( nInIdx >= nIMax ) ? nullptr :
334 static_cast<const void*>(&pPLCF_Contents[nInIdx * nStru]);
338 /* for Piece Table (.i.e. FastSave Table) */
339 class WW8PLCFpcd
341 friend class WW8PLCFpcd_Iter;
343 std::unique_ptr<WW8_CP[]> pPLCF_PosArray; // pointer to Pos-array and the whole structure
344 sal_uInt8* pPLCF_Contents; // pointer to content-array-part of Pos-array
345 sal_Int32 nIMax;
346 sal_uInt32 nStru;
348 WW8PLCFpcd(const WW8PLCFpcd&) = delete;
349 WW8PLCFpcd& operator=(const WW8PLCFpcd&) = delete;
351 void TruncToSortedRange();
353 public:
354 WW8PLCFpcd(SvStream* pSt, sal_uInt32 nFilePos, sal_uInt32 nPLCF,
355 sal_uInt32 nStruct);
358 /* multiple WW8PLCFpcd_Iter may point to the same WW8PLCFpcd !!! */
359 class WW8PLCFpcd_Iter
361 private:
362 WW8PLCFpcd& rPLCF;
363 tools::Long nIdx;
365 WW8PLCFpcd_Iter(const WW8PLCFpcd_Iter&) = delete;
366 WW8PLCFpcd_Iter& operator=(const WW8PLCFpcd_Iter&) = delete;
368 public:
369 WW8PLCFpcd_Iter( WW8PLCFpcd& rPLCFpcd, tools::Long nStartPos = -1 );
370 tools::Long GetIdx() const { return nIdx; }
371 void SetIdx( tools::Long nI ) { nIdx = nI; }
372 tools::Long GetIMax() const { return rPLCF.nIMax; }
373 bool SeekPos(tools::Long nPos);
374 sal_Int32 Where() const;
375 bool Get(WW8_CP& rStart, WW8_CP& rEnd, void*& rpValue) const;
376 void advance()
378 if( nIdx < rPLCF.nIMax )
379 ++nIdx;
383 // PLCF-type:
384 enum ePLCFT{ CHP=0, PAP, SEP, /*HED, FNR, ENR,*/ PLCF_END };
386 //It's hardcoded that eFTN be the first one: a very poor hack, needs to be fixed
387 enum eExtSprm { eFTN = 256, eEDN = 257, eFLD = 258, eBKN = 259, eAND = 260, eATNBKN = 261, eFACTOIDBKN = 262 };
390 pure virtual:
392 class WW8PLCFx // virtual iterator for Piece Table Exceptions
394 private:
395 const WW8Fib& mrFib;
396 bool bIsSprm; // PLCF of Sprms or other stuff ( Footnote, ... )
397 WW8_FC nStartFc;
398 bool bDirty;
400 WW8PLCFx(const WW8PLCFx&) = delete;
401 WW8PLCFx& operator=(const WW8PLCFx&) = delete;
403 public:
404 WW8PLCFx(const WW8Fib& rFib, bool bSprm)
405 : mrFib(rFib)
406 , bIsSprm(bSprm)
407 , nStartFc(-1)
408 , bDirty(false)
411 virtual ~WW8PLCFx() {}
412 bool IsSprm() const { return bIsSprm; }
413 virtual sal_uInt32 GetIdx() const = 0;
414 virtual void SetIdx(sal_uInt32 nIdx) = 0;
415 virtual sal_uInt32 GetIdx2() const;
416 virtual void SetIdx2(sal_uInt32 nIdx);
417 virtual bool SeekPos(WW8_CP nCpPos) = 0;
418 virtual WW8_FC Where() = 0;
419 virtual void GetSprms( WW8PLCFxDesc* p );
420 virtual tools::Long GetNoSprms( WW8_CP& rStart, WW8_CP&, sal_Int32& rLen );
421 virtual void advance() = 0;
422 virtual sal_uInt16 GetIstd() const { return 0xffff; }
423 virtual void Save( WW8PLCFxSave1& rSave ) const;
424 virtual void Restore( const WW8PLCFxSave1& rSave );
425 ww::WordVersion GetFIBVersion() const;
426 const WW8Fib& GetFIB() const { return mrFib; }
427 void SetStartFc( WW8_FC nFc ) { nStartFc = nFc; }
428 WW8_FC GetStartFc() const { return nStartFc; }
429 void SetDirty(bool bIn) {bDirty=bIn;}
430 bool GetDirty() const {return bDirty;}
433 class WW8PLCFx_PCDAttrs : public WW8PLCFx
435 private:
436 WW8PLCFpcd_Iter* pPcdI;
437 WW8PLCFx_PCD* pPcd;
438 std::vector<std::unique_ptr<sal_uInt8[]>> const & mrGrpprls; // attribute of Piece-table
439 SVBT32 aShortSprm; // mini storage: can contain ONE sprm with
440 // 1 byte param
442 WW8PLCFx_PCDAttrs(const WW8PLCFx_PCDAttrs&) = delete;
443 WW8PLCFx_PCDAttrs& operator=(const WW8PLCFx_PCDAttrs&) = delete;
445 public:
446 WW8PLCFx_PCDAttrs(const WW8Fib& rFib, WW8PLCFx_PCD* pPLCFx_PCD,
447 const WW8ScannerBase* pBase );
448 virtual sal_uInt32 GetIdx() const override;
449 virtual void SetIdx(sal_uInt32 nI) override;
450 virtual bool SeekPos(WW8_CP nCpPos) override;
451 virtual WW8_CP Where() override;
452 virtual void GetSprms( WW8PLCFxDesc* p ) override;
453 virtual void advance() override;
455 WW8PLCFpcd_Iter* GetIter() const { return pPcdI; }
458 class WW8PLCFx_PCD : public WW8PLCFx // iterator for Piece table
460 private:
461 std::unique_ptr<WW8PLCFpcd_Iter> pPcdI;
462 bool bVer67;
463 WW8_CP nClipStart;
465 WW8PLCFx_PCD(const WW8PLCFx_PCD&) = delete;
466 WW8PLCFx_PCD& operator=(const WW8PLCFx_PCD&) = delete;
468 public:
469 WW8PLCFx_PCD(const WW8Fib& rFib, WW8PLCFpcd* pPLCFpcd,
470 WW8_CP nStartCp, bool bVer67P);
471 virtual ~WW8PLCFx_PCD() override;
472 sal_uInt32 GetIMax() const;
473 virtual sal_uInt32 GetIdx() const override;
474 virtual void SetIdx(sal_uInt32 nI) override;
475 virtual bool SeekPos(WW8_CP nCpPos) override;
476 virtual WW8_CP Where() override;
477 virtual tools::Long GetNoSprms( WW8_CP& rStart, WW8_CP&, sal_Int32& rLen ) override;
478 virtual void advance() override;
479 WW8_CP CurrentPieceStartFc2Cp( WW8_FC nStartPos );
480 WW8_FC CurrentPieceStartCp2Fc( WW8_CP nCp );
481 static void CurrentPieceFc2Cp(WW8_CP& rStartPos, WW8_CP& rEndPos,
482 const WW8ScannerBase *pSBase);
483 WW8PLCFpcd_Iter* GetPLCFIter() { return pPcdI.get(); }
484 void SetClipStart(WW8_CP nIn) { nClipStart = nIn; }
485 WW8_CP GetClipStart() const { return nClipStart; }
487 static sal_Int32 TransformPieceAddress(tools::Long nfc, bool& bIsUnicodeAddress)
489 bIsUnicodeAddress = 0 == (0x40000000 & nfc);
490 return bIsUnicodeAddress ? nfc : (nfc & 0x3fffFFFF) / 2;
495 Iterator for Piece Table Exceptions of Fkps
496 works only with FCs, not with CPs ! ( Low-Level )
498 class WW8PLCFx_Fc_FKP : public WW8PLCFx
500 public:
501 class WW8Fkp // Iterator for Formatted Disk Page
503 private:
504 class Entry
506 public:
507 WW8_FC mnFC;
509 sal_uInt8* mpData;
510 sal_uInt16 mnLen;
511 sal_uInt16 mnIStd; // only for Fkp.Papx (actually Style-Nr)
512 bool mbMustDelete;
514 explicit Entry(WW8_FC nFC) : mnFC(nFC), mpData(nullptr), mnLen(0),
515 mnIStd(0), mbMustDelete(false) {}
516 Entry(const Entry &rEntry);
517 ~Entry();
518 bool operator<(const Entry& rEntry) const;
519 Entry& operator=(const Entry& rEntry);
522 sal_uInt8 maRawData[512];
523 std::vector<Entry> maEntries;
525 tools::Long nItemSize; // either 1 Byte or a complete BX
527 // Offset in Stream where last read of 512 bytes took place
528 tools::Long nFilePos;
529 sal_uInt8 mnIdx; // Pos marker
530 ePLCFT ePLCF;
531 sal_uInt8 mnIMax; // number of entries
532 int mnMustRemainCached; // after SaveAllPLCFx, before RestoreAllPLCFx
534 wwSprmParser maSprmParser;
536 //Fill in an Entry with sanity testing
537 void FillEntry(Entry &rEntry, std::size_t nDataOffset, sal_uInt16 nLen);
539 public:
540 WW8Fkp (const WW8Fib& rFib, SvStream* pFKPStrm,
541 SvStream* pDataStrm, tools::Long _nFilePos, tools::Long nItemSiz, ePLCFT ePl,
542 WW8_FC nStartFc);
543 void Reset(WW8_FC nPos);
544 tools::Long GetFilePos() const { return nFilePos; }
545 sal_uInt8 GetIdx() const { return mnIdx; }
546 void SetIdx(sal_uInt8 nI);
547 bool SeekPos(WW8_FC nFc);
548 WW8_FC Where() const
550 return (mnIdx < mnIMax) ? maEntries[mnIdx].mnFC : WW8_FC_MAX;
552 void advance()
554 if (mnIdx < mnIMax)
555 ++mnIdx;
557 sal_uInt8* Get( WW8_FC& rStart, WW8_FC& rEnd, sal_Int32& rLen ) const;
558 sal_uInt16 GetIstd() const { return maEntries[mnIdx].mnIStd; }
561 returns a real pointer to the Sprm of type nId,
562 if such a thing is in the Fkp.
564 sal_uInt8* GetLenAndIStdAndSprms(sal_Int32& rLen) const;
567 calls GetLenAndIStdAndSprms()...
568 2020 bFindFirst note: Normally the last SPRM takes effect, so I don't know why HasSprm always returned the first value!
569 I don't dare to change the default due to regression potential (and slower in the few cases looking for a boolean result),
570 but first thing to try is use FindFirst as false.
572 SprmResult HasSprm(sal_uInt16 nId, bool bFindFirst = true);
573 void HasSprm(sal_uInt16 nId, std::vector<SprmResult> &rResult);
575 const wwSprmParser &GetSprmParser() const { return maSprmParser; }
577 void IncMustRemainCache() { ++mnMustRemainCached; }
578 bool IsMustRemainCache() const { return mnMustRemainCached > 0; }
579 void DecMustRemainCache() { --mnMustRemainCached; }
582 private:
583 SvStream* pFKPStrm; // input file
584 SvStream* pDataStrm; // input file
585 std::unique_ptr<WW8PLCF> pPLCF;
586 protected:
587 WW8Fkp* pFkp;
588 private:
591 Keep a cache of eMaxCache entries of previously seen pFkps, which
592 speeds up considerably table parsing and load save plcfs for what turn
593 out to be small text frames, which frames generally are
595 size : cache hits
596 cache all : 19168 pap, 48 chp
597 == 100 : 19166 pap, 48 chp
598 == 50 : 18918 pap, 48 chp
599 == 10 : 18549 pap, 47 chp
600 == 5 : 18515 pap, 47 chp
602 std::deque<std::unique_ptr<WW8Fkp>> maFkpCache;
603 enum Limits {eMaxCache = 50000};
605 bool NewFkp();
607 WW8PLCFx_Fc_FKP(const WW8PLCFx_Fc_FKP&) = delete;
608 WW8PLCFx_Fc_FKP& operator=(const WW8PLCFx_Fc_FKP&) = delete;
610 protected:
611 ePLCFT ePLCF;
612 std::unique_ptr<WW8PLCFx_PCDAttrs> pPCDAttrs;
614 public:
615 WW8PLCFx_Fc_FKP( SvStream* pSt, SvStream* pTableSt, SvStream* pDataSt,
616 const WW8Fib& rFib, ePLCFT ePl, WW8_FC nStartFcL );
617 virtual ~WW8PLCFx_Fc_FKP() override;
618 virtual sal_uInt32 GetIdx() const override;
619 virtual void SetIdx(sal_uInt32 nIdx) override;
620 virtual bool SeekPos(WW8_FC nFcPos) override;
621 virtual WW8_FC Where() override;
622 sal_uInt8* GetSprmsAndPos( WW8_FC& rStart, WW8_FC& rEnd, sal_Int32& rLen );
623 virtual void advance() override;
624 virtual sal_uInt16 GetIstd() const override;
625 void GetPCDSprms( WW8PLCFxDesc& rDesc );
626 SprmResult HasSprm(sal_uInt16 nId, bool bFindFirst = true);
627 void HasSprm(sal_uInt16 nId, std::vector<SprmResult> &rResult);
628 bool HasFkp() const { return (nullptr != pFkp); }
631 /// iterator for Piece Table Exceptions of Fkps works on CPs (high-level)
632 class WW8PLCFx_Cp_FKP : public WW8PLCFx_Fc_FKP
634 private:
635 const WW8ScannerBase& rSBase;
636 std::unique_ptr<WW8PLCFx_PCD> pPcd;
637 WW8PLCFpcd_Iter *pPieceIter;
638 WW8_CP nAttrStart, nAttrEnd;
639 bool bLineEnd : 1;
640 bool bComplex : 1;
642 WW8PLCFx_Cp_FKP(const WW8PLCFx_Cp_FKP&) = delete;
643 WW8PLCFx_Cp_FKP& operator=(const WW8PLCFx_Cp_FKP&) = delete;
645 public:
646 WW8PLCFx_Cp_FKP( SvStream* pSt, SvStream* pTableSt, SvStream* pDataSt,
647 const WW8ScannerBase& rBase, ePLCFT ePl );
648 virtual ~WW8PLCFx_Cp_FKP() override;
649 void ResetAttrStartEnd();
650 sal_uInt32 GetPCDIdx() const;
651 virtual sal_uInt32 GetIdx2() const override;
652 virtual void SetIdx2(sal_uInt32 nIdx) override;
653 virtual bool SeekPos(WW8_CP nCpPos) override;
654 virtual WW8_CP Where() override;
655 virtual void GetSprms( WW8PLCFxDesc* p ) override;
656 virtual void advance() override;
657 virtual void Save( WW8PLCFxSave1& rSave ) const override;
658 virtual void Restore( const WW8PLCFxSave1& rSave ) override;
661 /// Iterator for Piece Table Exceptions of Sepx
662 class WW8PLCFx_SEPX : public WW8PLCFx
664 private:
665 wwSprmParser maSprmParser;
666 SvStream* pStrm;
667 std::unique_ptr<WW8PLCF> pPLCF;
668 std::unique_ptr<sal_uInt8[]> pSprms;
669 sal_uInt16 nArrMax;
670 sal_uInt16 nSprmSiz;
672 WW8PLCFx_SEPX(const WW8PLCFx_SEPX&) = delete;
673 WW8PLCFx_SEPX& operator=(const WW8PLCFx_SEPX&) = delete;
675 public:
676 WW8PLCFx_SEPX( SvStream* pSt, SvStream* pTablexySt, const WW8Fib& rFib,
677 WW8_CP nStartCp );
678 virtual ~WW8PLCFx_SEPX() override;
679 virtual sal_uInt32 GetIdx() const override;
680 virtual void SetIdx(sal_uInt32 nIdx) override;
681 virtual bool SeekPos(WW8_CP nCpPos) override;
682 virtual WW8_CP Where() override;
683 virtual void GetSprms( WW8PLCFxDesc* p ) override;
684 virtual void advance() override;
685 SprmResult HasSprm( sal_uInt16 nId ) const;
686 SprmResult HasSprm( sal_uInt16 nId, sal_uInt8 n2nd ) const;
687 SprmResult HasSprm( sal_uInt16 nId, const sal_uInt8* pOtherSprms,
688 tools::Long nOtherSprmSiz ) const;
689 bool Find4Sprms(sal_uInt16 nId1, sal_uInt16 nId2, sal_uInt16 nId3, sal_uInt16 nId4,
690 SprmResult& r1, SprmResult& r2, SprmResult& r3, SprmResult& r4) const;
693 /// iterator for footnotes/endnotes and comments
694 class WW8PLCFx_SubDoc : public WW8PLCFx
696 private:
697 std::unique_ptr<WW8PLCF> pRef;
698 std::unique_ptr<WW8PLCF> pText;
700 WW8PLCFx_SubDoc(const WW8PLCFx_SubDoc&) = delete;
701 WW8PLCFx_SubDoc& operator=(const WW8PLCFx_SubDoc&) = delete;
703 public:
704 WW8PLCFx_SubDoc(SvStream* pSt, const WW8Fib& rFib, WW8_CP nStartCp,
705 tools::Long nFcRef, tools::Long nLenRef, tools::Long nFcText, tools::Long nLenText, tools::Long nStruc);
706 virtual ~WW8PLCFx_SubDoc() override;
707 virtual sal_uInt32 GetIdx() const override;
708 virtual void SetIdx(sal_uInt32 nIdx) override;
709 virtual bool SeekPos(WW8_CP nCpPos) override;
710 virtual WW8_CP Where() override;
712 // returns reference descriptors
713 const void* GetData() const
715 return pRef ? pRef->GetData( pRef->GetIdx() ) : nullptr;
718 virtual void GetSprms(WW8PLCFxDesc* p) override;
719 virtual void advance() override;
720 tools::Long Count() const { return pRef ? pRef->GetIMax() : 0; }
723 /// Iterator for fields
724 class WW8PLCFx_FLD : public WW8PLCFx
726 private:
727 std::unique_ptr<WW8PLCFspecial> pPLCF;
728 const WW8Fib& rFib;
729 WW8PLCFx_FLD(const WW8PLCFx_FLD&) = delete;
730 WW8PLCFx_FLD& operator=(const WW8PLCFx_FLD &) = delete;
732 public:
733 WW8PLCFx_FLD(SvStream* pSt, const WW8Fib& rMyFib, short nType);
734 virtual ~WW8PLCFx_FLD() override;
735 virtual sal_uInt32 GetIdx() const override;
736 virtual void SetIdx(sal_uInt32 nIdx) override;
737 virtual bool SeekPos(WW8_CP nCpPos) override;
738 virtual WW8_CP Where() override;
739 virtual void GetSprms(WW8PLCFxDesc* p) override;
740 virtual void advance() override;
741 bool StartPosIsFieldStart();
742 bool EndPosIsFieldEnd(WW8_CP&);
743 bool GetPara(tools::Long nIdx, WW8FieldDesc& rF);
746 enum eBookStatus { BOOK_NORMAL = 0, BOOK_IGNORE = 0x1, BOOK_FIELD = 0x2 };
748 /// Iterator for Booknotes
749 class WW8PLCFx_Book : public WW8PLCFx
751 private:
752 std::unique_ptr<WW8PLCFspecial> pBook[2]; // Start and End Position
753 std::vector<OUString> aBookNames; // Name
754 std::vector<eBookStatus> aStatus;
755 tools::Long nIMax; // Number of Booknotes
756 sal_uInt16 nIsEnd;
757 sal_Int32 nBookmarkId; // counter incremented by GetUniqueBookmarkName.
759 WW8PLCFx_Book(const WW8PLCFx_Book&) = delete;
760 WW8PLCFx_Book& operator=(const WW8PLCFx_Book&) = delete;
762 public:
763 WW8PLCFx_Book(SvStream* pTableSt,const WW8Fib& rFib);
764 virtual ~WW8PLCFx_Book() override;
765 tools::Long GetIMax() const { return nIMax; }
766 virtual sal_uInt32 GetIdx() const override;
767 virtual void SetIdx(sal_uInt32 nI) override;
768 virtual sal_uInt32 GetIdx2() const override;
769 virtual void SetIdx2(sal_uInt32 nIdx) override;
770 virtual bool SeekPos(WW8_CP nCpPos) override;
771 virtual WW8_CP Where() override;
772 virtual tools::Long GetNoSprms( WW8_CP& rStart, WW8_CP& rEnd, sal_Int32& rLen ) override;
773 virtual void advance() override;
774 const OUString* GetName() const;
775 WW8_CP GetStartPos() const
776 { return nIsEnd ? WW8_CP_MAX : pBook[0]->Where(); }
777 tools::Long GetLen() const;
778 bool GetIsEnd() const { return nIsEnd != 0; }
779 tools::Long GetHandle() const;
780 void SetStatus( sal_uInt16 nIndex, eBookStatus eStat );
781 void MapName(OUString& rName);
782 OUString GetBookmark(tools::Long nStart,tools::Long nEnd, sal_uInt16 &nIndex);
783 eBookStatus GetStatus() const;
784 OUString GetUniqueBookmarkName(const OUString &rSuggestedName);
787 /// Handles the import of PlcfAtnBkf and PlcfAtnBkl: start / end position of annotation marks.
788 class WW8PLCFx_AtnBook : public WW8PLCFx
790 private:
791 /// Start and end positions.
792 std::unique_ptr<WW8PLCFspecial> m_pBook[2];
793 /// Number of annotation marks
794 sal_Int32 nIMax;
795 bool m_bIsEnd;
797 WW8PLCFx_AtnBook(const WW8PLCFx_AtnBook&) = delete;
798 WW8PLCFx_AtnBook& operator=(const WW8PLCFx_AtnBook&) = delete;
800 public:
801 WW8PLCFx_AtnBook(SvStream* pTableSt,const WW8Fib& rFib);
802 virtual ~WW8PLCFx_AtnBook() override;
803 virtual sal_uInt32 GetIdx() const override;
804 virtual void SetIdx(sal_uInt32 nI) override;
805 virtual sal_uInt32 GetIdx2() const override;
806 virtual void SetIdx2(sal_uInt32 nIdx) override;
807 virtual bool SeekPos(WW8_CP nCpPos) override;
808 virtual WW8_CP Where() override;
809 virtual tools::Long GetNoSprms( WW8_CP& rStart, WW8_CP& rEnd, sal_Int32& rLen ) override;
810 virtual void advance() override;
812 /// Handle is the unique ID of an annotation mark.
813 tools::Long getHandle() const;
814 bool getIsEnd() const;
817 /// Handles the import of PlcfBkfFactoid and PlcfBklFactoid: start / end position of factoids.
818 class WW8PLCFx_FactoidBook : public WW8PLCFx
820 private:
821 /// Start and end positions.
822 std::unique_ptr<WW8PLCFspecial> m_pBook[2];
823 /// Number of factoid marks
824 sal_Int32 m_nIMax;
825 bool m_bIsEnd;
827 WW8PLCFx_FactoidBook(const WW8PLCFx_FactoidBook&) = delete;
828 WW8PLCFx_FactoidBook& operator=(const WW8PLCFx_FactoidBook&) = delete;
830 public:
831 WW8PLCFx_FactoidBook(SvStream* pTableSt,const WW8Fib& rFib);
832 virtual ~WW8PLCFx_FactoidBook() override;
833 virtual sal_uInt32 GetIdx() const override;
834 virtual void SetIdx(sal_uInt32 nI) override;
835 virtual sal_uInt32 GetIdx2() const override;
836 virtual void SetIdx2(sal_uInt32 nIdx) override;
837 virtual bool SeekPos(WW8_CP nCpPos) override;
838 virtual WW8_CP Where() override;
839 virtual tools::Long GetNoSprms(WW8_CP& rStart, WW8_CP& rEnd, sal_Int32& rLen) override;
840 virtual void advance() override;
842 /// Handle is the unique ID of a factoid mark.
843 tools::Long getHandle() const;
844 bool getIsEnd() const;
848 this is what we use outside:
850 struct WW8PLCFManResult
852 WW8_CP nCpPos; // attribute starting position
853 tools::Long nMemLen; // length for previous
854 tools::Long nCp2OrIdx; // footnote-textpos or index in PLCF
855 WW8_CP nCurrentCp; // only used by caller
856 const sal_uInt8* pMemPos;// Mem-Pos for Sprms
857 sal_uInt16 nSprmId; // Sprm-Id ( 0 = invalid Id -> skip! )
858 // (2..255) or pseudo-Sprm-Id (256..260)
859 // from Winword-Ver8 Sprm-Id (800..) resp.
860 sal_uInt8 nFlags; // start of paragraph or section
863 enum ManMaskTypes
865 MAN_MASK_NEW_PAP = 1, // new line
866 MAN_MASK_NEW_SEP = 2 // new section
869 enum ManTypes // enums for PLCFMan-ctor
871 MAN_MAINTEXT = 0, MAN_FTN = 1, MAN_EDN = 2, MAN_HDFT = 3, MAN_AND = 4,
872 MAN_TXBX = 5, MAN_TXBX_HDFT = 6
876 this is what the manager uses inside:
878 struct WW8PLCFxDesc
880 WW8PLCFx* pPLCFx;
881 std::stack<sal_uInt16>* pIdStack; // memory for Attr-Id for Attr-end(s)
882 const sal_uInt8* pMemPos;// where are the Sprm(s)
883 tools::Long nOrigSprmsLen;
885 WW8_CP nStartPos;
886 WW8_CP nEndPos;
888 WW8_CP nOrigStartPos;
889 WW8_CP nOrigEndPos; // The ending character position of a paragraph is
890 // always one before the end reported in the FKP,
891 // also a character run that ends on the same location
892 // as the paragraph mark is adjusted to end just before
893 // the paragraph mark so as to handle their close
894 // first. The value being used to determining where the
895 // properties end is in nEndPos, but the original
896 // unadjusted end character position is important as
897 // it can be used as the beginning cp of the next set
898 // of properties
900 WW8_CP nCp2OrIdx; // where are the NoSprm(s)
901 sal_Int32 nSprmsLen; // how many bytes for further Sprms / length of footnote
902 tools::Long nCpOfs; // for Offset Header .. Footnote
903 bool bFirstSprm; // for recognizing the first Sprm of a group
904 bool bRealLineEnd; // false for Pap-Piece-end
905 sal_Int16 nRelativeJustify;
906 void Save( WW8PLCFxSave1& rSave ) const;
907 void Restore( const WW8PLCFxSave1& rSave );
908 //With nStartPos set to WW8_CP_MAX then in the case of a pap or chp
909 //GetSprms will not search for the sprms, but instead take the
910 //existing ones.
911 WW8PLCFxDesc()
912 : pPLCFx(nullptr)
913 , pIdStack(nullptr)
914 , pMemPos(nullptr)
915 , nOrigSprmsLen(0)
916 , nStartPos(WW8_CP_MAX)
917 , nEndPos(WW8_CP_MAX)
918 , nOrigStartPos(WW8_CP_MAX)
919 , nOrigEndPos(WW8_CP_MAX)
920 , nCp2OrIdx(WW8_CP_MAX)
921 , nSprmsLen(0)
922 , nCpOfs(0)
923 , bFirstSprm(false)
924 , bRealLineEnd(false)
925 , nRelativeJustify(-1)
928 void ReduceByOffset();
931 struct WW8PLCFxSaveAll;
932 class WW8PLCFMan
934 public:
935 enum WW8PLCFManLimits {MAN_PLCF_COUNT = 12};
937 private:
938 wwSprmParser maSprmParser;
939 WW8_CP m_nCpO; //< Origin Cp -- the basis for nNewCp
941 WW8_CP m_nLineEnd; // points *after* the <CR>
942 sal_uInt16 m_nPLCF; // this many PLCFs are managed
943 ManTypes m_nManType;
944 bool mbDoingDrawTextBox; //Normally we adjust the end of attributes
945 //so that the end of a paragraph occurs
946 //before the para end mark, but for
947 //drawboxes we want the true offsets
949 WW8PLCFxDesc m_aD[MAN_PLCF_COUNT];
950 WW8PLCFxDesc *m_pChp, *m_pPap, *m_pSep, *m_pField, *m_pFootnote, *m_pEdn, *m_pBkm, *m_pPcd,
951 *m_pPcdA, *m_pAnd, *m_pAtnBkm, *m_pFactoidBkm;
952 WW8PLCFspecial *m_pFdoa, *m_pTxbx, *m_pTxbxBkd,*m_pMagicTables, *m_pSubdocs;
953 sal_uInt8* m_pExtendedAtrds;
955 const WW8Fib* m_pWwFib;
957 sal_uInt16 WhereIdx(bool* pbStart, WW8_CP * pPos=nullptr) const;
958 void AdjustEnds(WW8PLCFxDesc& rDesc);
959 void GetNewSprms(WW8PLCFxDesc& rDesc);
960 static void GetNewNoSprms(WW8PLCFxDesc& rDesc);
961 void GetSprmStart(short nIdx, WW8PLCFManResult* pRes) const;
962 void GetSprmEnd(short nIdx, WW8PLCFManResult* pRes) const;
963 void GetNoSprmStart(short nIdx, WW8PLCFManResult* pRes) const;
964 void GetNoSprmEnd(short nIdx, WW8PLCFManResult* pRes) const;
965 void AdvSprm(short nIdx, bool bStart);
966 void AdvNoSprm(short nIdx, bool bStart);
967 sal_uInt16 GetId(const WW8PLCFxDesc* p ) const;
969 bool IsSprmLegalForCategory(sal_uInt16 nSprmId, short nIdx) const;
971 public:
972 WW8PLCFMan(const WW8ScannerBase* pBase, ManTypes nType, tools::Long nStartCp,
973 bool bDoingDrawTextBox = false);
974 ~WW8PLCFMan();
977 Where asks on which following position any Attr changes...
979 WW8_CP Where() const;
981 bool Get(WW8PLCFManResult* pResult) const;
982 void advance();
983 sal_uInt16 GetColl() const; // index of actual Style
984 WW8PLCFx_FLD* GetField() const;
985 WW8PLCFx_SubDoc* GetEdn() const { return static_cast<WW8PLCFx_SubDoc*>(m_pEdn->pPLCFx); }
986 WW8PLCFx_SubDoc* GetFootnote() const { return static_cast<WW8PLCFx_SubDoc*>(m_pFootnote->pPLCFx); }
987 WW8PLCFx_SubDoc* GetAtn() const { return static_cast<WW8PLCFx_SubDoc*>(m_pAnd->pPLCFx); }
988 WW8PLCFx_Book* GetBook() const { return static_cast<WW8PLCFx_Book*>(m_pBkm->pPLCFx); }
989 WW8PLCFx_AtnBook* GetAtnBook() const { return static_cast<WW8PLCFx_AtnBook*>(m_pAtnBkm->pPLCFx); }
990 WW8PLCFx_FactoidBook* GetFactoidBook() const { return static_cast<WW8PLCFx_FactoidBook*>(m_pFactoidBkm->pPLCFx); }
991 tools::Long GetCpOfs() const { return m_pChp->nCpOfs; } // for Header/Footer...
993 /* asks, if *current paragraph* has an Sprm of this type */
994 SprmResult HasParaSprm(sal_uInt16 nId) const;
996 /* asks, if *current textrun* has an Sprm of this type */
997 SprmResult HasCharSprm(sal_uInt16 nId) const;
998 void HasCharSprm(sal_uInt16 nId, std::vector<SprmResult> &rResult) const;
1000 WW8PLCFx_Cp_FKP* GetChpPLCF() const
1001 { return static_cast<WW8PLCFx_Cp_FKP*>(m_pChp->pPLCFx); }
1002 WW8PLCFx_Cp_FKP* GetPapPLCF() const
1003 { return static_cast<WW8PLCFx_Cp_FKP*>(m_pPap->pPLCFx); }
1004 WW8PLCFx_SEPX* GetSepPLCF() const
1005 { return static_cast<WW8PLCFx_SEPX*>(m_pSep->pPLCFx); }
1006 WW8PLCFxDesc* GetPap() const { return m_pPap; }
1007 void TransferOpenSprms(std::stack<sal_uInt16> &rStack);
1008 void SeekPos( tools::Long nNewCp );
1009 void SaveAllPLCFx( WW8PLCFxSaveAll& rSave ) const;
1010 void RestoreAllPLCFx( const WW8PLCFxSaveAll& rSave );
1011 WW8PLCFspecial* GetFdoa() const { return m_pFdoa; }
1012 WW8PLCFspecial* GetTxbx() const { return m_pTxbx; }
1013 WW8PLCFspecial* GetTxbxBkd() const { return m_pTxbxBkd; }
1014 WW8PLCFspecial* GetMagicTables() const { return m_pMagicTables; }
1015 WW8PLCFspecial* GetWkbPLCF() const { return m_pSubdocs; }
1016 sal_uInt8* GetExtendedAtrds() const { return m_pExtendedAtrds; }
1017 ManTypes GetManType() const { return m_nManType; }
1018 bool GetDoingDrawTextBox() const { return mbDoingDrawTextBox; }
1021 struct WW8PLCFxSaveAll
1023 WW8PLCFxSave1 aS[WW8PLCFMan::MAN_PLCF_COUNT] = {};
1024 WW8PLCFxSaveAll() = default;
1027 class WW8ScannerBase
1029 friend WW8PLCFx_PCDAttrs::WW8PLCFx_PCDAttrs(const WW8Fib& rFib,
1030 WW8PLCFx_PCD* pPLCFx_PCD, const WW8ScannerBase* pBase );
1031 friend WW8PLCFx_Cp_FKP::WW8PLCFx_Cp_FKP( SvStream*, SvStream*, SvStream*,
1032 const WW8ScannerBase&, ePLCFT );
1034 friend WW8PLCFMan::WW8PLCFMan(const WW8ScannerBase*, ManTypes, tools::Long, bool);
1035 friend class SwWW8FltControlStack;
1037 private:
1038 WW8Fib* m_pWw8Fib;
1039 std::unique_ptr<WW8PLCFx_Cp_FKP> m_pChpPLCF; // Character-Attrs
1040 std::unique_ptr<WW8PLCFx_Cp_FKP> m_pPapPLCF; // Paragraph-Attrs
1041 std::unique_ptr<WW8PLCFx_SEPX> m_pSepPLCF; // Section-Attrs
1042 std::unique_ptr<WW8PLCFx_SubDoc> m_pFootnotePLCF; // Footnotes
1043 std::unique_ptr<WW8PLCFx_SubDoc> m_pEdnPLCF; // EndNotes
1044 std::unique_ptr<WW8PLCFx_SubDoc> m_pAndPLCF; // Comments
1045 std::unique_ptr<WW8PLCFx_FLD> m_pFieldPLCF; // Fields in Main Text
1046 std::unique_ptr<WW8PLCFx_FLD> m_pFieldHdFtPLCF; // Fields in Header / Footer
1047 std::unique_ptr<WW8PLCFx_FLD> m_pFieldTxbxPLCF; // Fields in Textboxes in Main Text
1048 std::unique_ptr<WW8PLCFx_FLD> m_pFieldTxbxHdFtPLCF; // Fields in Textboxes in Header / Footer
1049 std::unique_ptr<WW8PLCFx_FLD> m_pFieldFootnotePLCF; // Fields in Footnotes
1050 std::unique_ptr<WW8PLCFx_FLD> m_pFieldEdnPLCF; // Fields in Endnotes
1051 std::unique_ptr<WW8PLCFx_FLD> m_pFieldAndPLCF; // Fields in Comments
1052 std::unique_ptr<WW8PLCFspecial> m_pMainFdoa; // Graphic Primitives in Main Text
1053 std::unique_ptr<WW8PLCFspecial> m_pHdFtFdoa; // Graphic Primitives in Header / Footer
1054 std::unique_ptr<WW8PLCFspecial> m_pMainTxbx; // Textboxes in Main Text
1055 std::unique_ptr<WW8PLCFspecial> m_pMainTxbxBkd; // Break-Descriptors for them
1056 std::unique_ptr<WW8PLCFspecial> m_pHdFtTxbx; // TextBoxes in Header / Footer
1057 std::unique_ptr<WW8PLCFspecial> m_pHdFtTxbxBkd; // Break-Descriptors for previous
1058 std::unique_ptr<WW8PLCFspecial> m_pMagicTables; // Break-Descriptors for them
1059 std::unique_ptr<WW8PLCFspecial> m_pSubdocs; // subdoc references in master document
1060 std::unique_ptr<sal_uInt8[]>
1061 m_pExtendedAtrds; // Extended ATRDs
1062 std::unique_ptr<WW8PLCFx_Book> m_pBook; // Bookmarks
1063 std::unique_ptr<WW8PLCFx_AtnBook> m_pAtnBook; // Annotationmarks
1064 /// Smart tag bookmarks.
1065 std::unique_ptr<WW8PLCFx_FactoidBook> m_pFactoidBook;
1067 std::unique_ptr<WW8PLCFpcd> m_pPiecePLCF; // for FastSave ( Basis-PLCF without iterator )
1068 std::unique_ptr<WW8PLCFpcd_Iter> m_pPieceIter; // for FastSave ( iterator for previous )
1069 std::unique_ptr<WW8PLCFx_PCD> m_pPLCFx_PCD; // ditto
1070 std::unique_ptr<WW8PLCFx_PCDAttrs> m_pPLCFx_PCDAttrs;
1071 std::vector<std::unique_ptr<sal_uInt8[]>> m_aPieceGrpprls; // attributes of Piece-Table
1073 std::unique_ptr<WW8PLCFpcd> OpenPieceTable( SvStream* pStr, const WW8Fib* pWwF );
1075 WW8ScannerBase(const WW8ScannerBase&) = delete;
1076 WW8ScannerBase& operator=(const WW8ScannerBase&) = delete;
1078 public:
1079 WW8ScannerBase( SvStream* pSt, SvStream* pTableSt, SvStream* pDataSt,
1080 WW8Fib* pWwF );
1081 ~WW8ScannerBase();
1082 bool AreThereFootnotes() const { return m_pFootnotePLCF->Count() > 0; };
1083 bool AreThereEndnotes() const { return m_pEdnPLCF->Count() > 0; };
1085 //If you use WW8Fc2Cp you are almost certainly doing the wrong thing
1086 //when it comes to fastsaved files, avoid like the plague. For export
1087 //given that we never write fastsaved files you can use it, otherwise
1088 //I will beat you with a stick
1089 WW8_CP WW8Fc2Cp(WW8_FC nFcPos) const ;
1090 WW8_FC WW8Cp2Fc(WW8_CP nCpPos, bool* pIsUnicode = nullptr,
1091 WW8_CP* pNextPieceCp = nullptr, bool* pTestFlag = nullptr) const;
1093 sal_Int32 WW8ReadString(SvStream& rStrm, OUString& rStr, WW8_CP nCurrentStartCp,
1094 tools::Long nTotalLen, rtl_TextEncoding eEnc ) const;
1098 /** FIB - the File Information Block
1100 The FIB contains a "magic word" and pointers to the various other parts of
1101 the file, as well as information about the length of the file.
1102 The FIB starts at the beginning of the file.
1104 class WW8Fib
1106 private:
1107 sal_Unicode m_nNumDecimalSep = u'\0';
1109 public:
1111 Program-Version asked for by us:
1112 in Ctor we check if it matches the value of nFib
1114 6 == "WinWord 6 or WinWord 95",
1115 7 == "only WinWord 95"
1116 8 == "WinWord 97 or newer"
1118 sal_uInt8 m_nVersion = 0;
1120 error status
1122 ErrCode m_nFibError;
1124 data read from FIB by Ctor
1125 (corresponds only approximately to the real structure
1126 of the Winword-FIB)
1128 sal_uInt16 m_wIdent = 0; // 0x0 int magic number
1130 File Information Block (FIB) values:
1131 WinWord 1.0 = 33
1132 WinWord 2.0 = 45
1133 WinWord 6.0c for 16bit = 101
1134 Word 6/32 bit = 104
1135 Word 95 = 104
1136 Word 97 = 193
1137 Word 2000 = 217
1138 Word 2002 = 257
1139 Word 2003 = 268
1140 Word 2007 = 274
1142 sal_uInt16 m_nFib = 0; // 0x2 FIB version written
1143 sal_uInt16 m_nProduct = 0; // 0x4 product version written by
1144 LanguageType m_lid; // 0x6 language stamp---localized version;
1145 WW8_PN m_pnNext = 0; // 0x8
1147 bool m_fDot :1 /*= false*/; // 0xa 0001
1148 bool m_fGlsy :1 /*= false*/;
1149 bool m_fComplex :1 /*= false*/; // 0004 when 1, file is in complex, fast-saved format.
1150 bool m_fHasPic :1 /*= false*/; // 0008 file contains 1 or more pictures
1151 sal_uInt16 m_cQuickSaves :4 /*= 0*/; // 00F0 count of times file was quicksaved
1152 bool m_fEncrypted :1 /*= false*/; //0100 1 if file is encrypted, 0 if not
1153 bool m_fWhichTableStm :1 /*= false*/; //0200 When 0, this fib refers to the table stream
1154 bool m_fReadOnlyRecommended :1 /*= false*/;
1155 bool m_fWriteReservation :1 /*= false*/;
1156 // named "0Table", when 1, this fib refers to the
1157 // table stream named "1Table". Normally, a file
1158 // will have only one table stream, but under unusual
1159 // circumstances a file may have table streams with
1160 // both names. In that case, this flag must be used
1161 // to decide which table stream is valid.
1163 bool m_fExtChar :1 /*= false*/; // 1000 =1, when using extended character set in file
1164 bool m_fFarEast :1 /*= false*/; // 4000 =1, probably, when far-East language variants of Word is used to create a file #i90932#
1166 bool m_fObfuscated :1 /*= false*/; // 8000=1. specifies whether the document is obfuscated using XOR obfuscation. otherwise this bit MUST be ignored.
1168 sal_uInt16 m_nFibBack = 0; // 0xc
1169 sal_uInt16 m_nHash = 0; // 0xe file encrypted hash
1170 sal_uInt16 m_nKey = 0; // 0x10 file encrypted key
1171 sal_uInt8 m_envr = 0; // 0x12 environment in which file was created
1172 // 0 created by Win Word / 1 created by Mac Word
1173 bool m_fMac :1 /*= false*/; // 0x13 when 1, this file was last saved in the Mac environment
1174 bool m_fEmptySpecial :1 /*= false*/;
1175 bool m_fLoadOverridePage :1 /*= false*/;
1176 bool m_fFuturesavedUndo :1 /*= false*/;
1177 bool m_fWord97Saved :1 /*= false*/;
1178 bool m_fWord2000Saved :1 /*= false*/;
1179 sal_uInt8 :2;
1181 sal_uInt16 m_chse = 0; // 0x14 default extended character set id for text in document stream. (overridden by chp.chse)
1182 // 0 = ANSI / 256 Macintosh character set.
1183 sal_uInt16 m_chseTables = 0; // 0x16 default extended character set id for text in
1184 // internal data structures: 0 = ANSI, 256 = Macintosh
1185 WW8_FC m_fcMin = 0; // 0x18 file offset of first character of text
1186 WW8_FC m_fcMac = 0; // 0x1c file offset of last character of text + 1
1188 // start of WW8 section
1189 sal_uInt16 m_csw = 0; // Count of fields in the array of "shorts"
1191 // marker: "rgsw" Beginning of the array of shorts
1192 sal_uInt16 m_wMagicCreated = 0; // unique number Identifying the File's creator
1193 // 0x6A62 is the creator ID for Word and is reserved.
1194 // Other creators should choose a different value.
1195 sal_uInt16 m_wMagicRevised = 0; // identifies the File's last modifier
1196 sal_uInt16 m_wMagicCreatedPrivate = 0; // private data
1197 sal_uInt16 m_wMagicRevisedPrivate = 0; // private data
1199 LanguageType m_lidFE; // Language id if document was written by Far East version
1200 // of Word (i.e. FIB.fFarEast is on)
1201 sal_uInt16 m_clw = 0; // Number of fields in the array of longs
1203 // end of WW8 section
1205 // Marker: "rglw" Beginning of the array of longs
1206 WW8_FC m_cbMac = 0; // 0x20 file offset of last byte written to file + 1.
1208 // WW8_FC u4[4]; // 0x24
1209 WW8_CP m_ccpText = 0; // 0x34 length of main document text stream
1210 WW8_CP m_ccpFootnote = 0; // 0x38 length of footnote subdocument text stream
1211 WW8_CP m_ccpHdr = 0; // 0x3c length of header subdocument text stream
1212 WW8_CP m_ccpMcr = 0; // 0x40 length of macro subdocument text stream
1213 WW8_CP m_ccpAtn = 0; // 0x44 length of annotation subdocument text stream
1214 WW8_CP m_ccpEdn = 0; // 0x48 length of endnote subdocument text stream
1215 WW8_CP m_ccpTxbx = 0; // 0x4c length of textbox subdocument text stream
1216 WW8_CP m_ccpHdrTxbx = 0; // 0x50 length of header textbox subdocument text stream
1218 // start of WW8 section
1219 sal_Int32 m_pnFbpChpFirst = 0; // when there was insufficient memory for Word to expand
1220 // the PLCFbte at save time, the PLCFbte is written
1221 // to the file in a linked list of 512-byte pieces
1222 // starting with this pn.
1223 sal_Int32 m_pnFbpPapFirst = 0; // when there was insufficient memory for Word to expand
1224 // the PLCFbte at save time, the PLCFbte is written to
1225 // the file in a linked list of 512-byte pieces
1226 // starting with this pn
1228 sal_Int32 m_pnFbpLvcFirst = 0; // when there was insufficient memory for Word to expand
1229 // the PLCFbte at save time, the PLCFbte is written to
1230 // the file in a linked list of 512-byte pieces
1231 // starting with this pn
1232 sal_Int32 m_pnLvcFirst = 0; // the page number of the lowest numbered page in the
1233 // document that records LVC FKP information
1234 sal_Int32 m_cpnBteLvc = 0; // count of LVC FKPs recorded in file. In non-complex
1235 // files if the number of entries in the PLCFbtePapx is
1236 // less than this, the PLCFbtePapx is incomplete.
1237 sal_Int32 m_fcIslandFirst = 0; // ?
1238 sal_Int32 m_fcIslandLim = 0; // ?
1239 sal_uInt16 m_cfclcb = 0; // Number of fields in the array of FC/LCB pairs.
1240 /// Specifies the count of 16-bit values corresponding to fibRgCswNew that follow.
1241 sal_uInt16 m_cswNew = 0;
1243 // end of WW8 section
1245 // Marker: "rgfclcb" Beginning of array of FC/LCB pairs.
1246 WW8_FC m_fcStshfOrig = 0; // file offset of original allocation for STSH in table
1247 // stream. During fast save Word will attempt to reuse
1248 // this allocation if STSH is small enough to fit.
1249 sal_Int32 m_lcbStshfOrig = 0; // 0x5c count of bytes of original STSH allocation
1250 WW8_FC m_fcStshf = 0; // 0x60 file offset of STSH in file.
1251 sal_Int32 m_lcbStshf = 0; // 0x64 count of bytes of current STSH allocation
1252 WW8_FC m_fcPlcffndRef = 0; // 0x68 file offset of footnote reference PLCF.
1253 sal_Int32 m_lcbPlcffndRef = 0; // 0x6c count of bytes of footnote reference PLCF
1254 // == 0 if no footnotes defined in document.
1256 WW8_FC m_fcPlcffndText = 0; // 0x70 file offset of footnote text PLCF.
1257 sal_Int32 m_lcbPlcffndText = 0; // 0x74 count of bytes of footnote text PLCF.
1258 // == 0 if no footnotes defined in document
1260 WW8_FC m_fcPlcfandRef = 0; // 0x78 file offset of annotation reference PLCF.
1261 sal_Int32 m_lcbPlcfandRef = 0; // 0x7c count of bytes of annotation reference PLCF.
1263 WW8_FC m_fcPlcfandText = 0; // 0x80 file offset of annotation text PLCF.
1264 sal_Int32 m_lcbPlcfandText = 0; // 0x84 count of bytes of the annotation text PLCF
1266 WW8_FC m_fcPlcfsed = 0; // 8x88 file offset of section descriptor PLCF.
1267 sal_Int32 m_lcbPlcfsed = 0; // 0x8c count of bytes of section descriptor PLCF.
1269 WW8_FC m_fcPlcfpad = 0; // 0x90 file offset of paragraph descriptor PLCF
1270 sal_Int32 m_lcbPlcfpad = 0; // 0x94 count of bytes of paragraph descriptor PLCF.
1271 // ==0 if file was never viewed in Outline view.
1272 // Should not be written by third party creators
1274 WW8_FC m_fcPlcfphe = 0; // 0x98 file offset of PLCF of paragraph heights.
1275 sal_Int32 m_lcbPlcfphe = 0; // 0x9c count of bytes of paragraph height PLCF.
1276 // ==0 when file is non-complex.
1278 WW8_FC m_fcSttbfglsy = 0; // 0xa0 file offset of glossary string table.
1279 sal_Int32 m_lcbSttbfglsy = 0; // 0xa4 count of bytes of glossary string table.
1280 // == 0 for non-glossary documents.
1281 // !=0 for glossary documents.
1283 WW8_FC m_fcPlcfglsy = 0; // 0xa8 file offset of glossary PLCF.
1284 sal_Int32 m_lcbPlcfglsy = 0; // 0xac count of bytes of glossary PLCF.
1285 // == 0 for non-glossary documents.
1286 // !=0 for glossary documents.
1288 WW8_FC m_fcPlcfhdd = 0; // 0xb0 byte offset of header PLCF.
1289 sal_Int32 m_lcbPlcfhdd = 0; // 0xb4 count of bytes of header PLCF.
1290 // == 0 if document contains no headers
1292 WW8_FC m_fcPlcfbteChpx = 0; // 0xb8 file offset of character property bin table.PLCF.
1293 sal_Int32 m_lcbPlcfbteChpx = 0;// 0xbc count of bytes of character property bin table PLCF.
1295 WW8_FC m_fcPlcfbtePapx = 0; // 0xc0 file offset of paragraph property bin table.PLCF.
1296 sal_Int32 m_lcbPlcfbtePapx = 0;// 0xc4 count of bytes of paragraph property bin table PLCF.
1298 WW8_FC m_fcPlcfsea = 0; // 0xc8 file offset of PLCF reserved for private use. The SEA is 6 bytes long.
1299 sal_Int32 m_lcbPlcfsea = 0; // 0xcc count of bytes of private use PLCF.
1301 WW8_FC m_fcSttbfffn = 0; // 0xd0 file offset of font information STTBF. See the FFN file structure definition.
1302 sal_Int32 m_lcbSttbfffn = 0; // 0xd4 count of bytes in sttbfffn.
1304 WW8_FC m_fcPlcffldMom = 0; // 0xd8 offset in doc stream to the PLCF of field positions in the main document.
1305 sal_Int32 m_lcbPlcffldMom = 0; // 0xdc
1307 WW8_FC m_fcPlcffldHdr = 0; // 0xe0 offset in doc stream to the PLCF of field positions in the header subdocument.
1308 sal_Int32 m_lcbPlcffldHdr = 0; // 0xe4
1310 WW8_FC m_fcPlcffldFootnote = 0; // 0xe8 offset in doc stream to the PLCF of field positions in the footnote subdocument.
1311 sal_Int32 m_lcbPlcffldFootnote = 0; // 0xec
1313 WW8_FC m_fcPlcffldAtn = 0; // 0xf0 offset in doc stream to the PLCF of field positions in the annotation subdocument.
1314 sal_Int32 m_lcbPlcffldAtn = 0; // 0xf4
1316 WW8_FC m_fcPlcffldMcr = 0; // 0xf8 offset in doc stream to the PLCF of field positions in the macro subdocument.
1317 sal_Int32 m_lcbPlcffldMcr = 0; // 9xfc
1319 WW8_FC m_fcSttbfbkmk = 0; // 0x100 offset in document stream of the STTBF that records bookmark names in the main document
1320 sal_Int32 m_lcbSttbfbkmk = 0; // 0x104
1322 WW8_FC m_fcPlcfbkf = 0; // 0x108 offset in document stream of the PLCF that records the beginning CP offsets of bookmarks in the main document. See BKF
1323 sal_Int32 m_lcbPlcfbkf = 0; // 0x10c
1325 WW8_FC m_fcPlcfbkl = 0; // 0x110 offset in document stream of the PLCF that records the ending CP offsets of bookmarks recorded in the main document. See the BKL structure definition.
1326 sal_Int32 m_lcbPlcfbkl = 0; // 0x114 sal_Int32
1328 WW8_FC m_fcCmds = 0; // 0x118 FC
1329 sal_uInt32 m_lcbCmds = 0; // 0x11c
1331 WW8_FC m_fcPlcfmcr = 0; // 0x120 FC
1332 sal_Int32 m_lcbPlcfmcr = 0; // 0x124
1334 WW8_FC m_fcSttbfmcr = 0; // 0x128 FC
1335 sal_Int32 m_lcbSttbfmcr = 0; // 0x12c
1337 WW8_FC m_fcPrDrvr = 0; // 0x130 file offset of the printer driver information (names of drivers, port etc...)
1338 sal_Int32 m_lcbPrDrvr = 0; // 0x134 count of bytes of the printer driver information (names of drivers, port etc...)
1340 WW8_FC m_fcPrEnvPort = 0; // 0x138 file offset of the print environment in portrait mode.
1341 sal_Int32 m_lcbPrEnvPort = 0; // 0x13c count of bytes of the print environment in portrait mode.
1343 WW8_FC m_fcPrEnvLand = 0; // 0x140 file offset of the print environment in landscape mode.
1344 sal_Int32 m_lcbPrEnvLand = 0; // 0x144 count of bytes of the print environment in landscape mode.
1346 WW8_FC m_fcWss = 0; // 0x148 file offset of Window Save State data structure. See WSS.
1347 sal_Int32 m_lcbWss = 0; // 0x14c count of bytes of WSS. ==0 if unable to store the window state.
1349 WW8_FC m_fcDop = 0; // 0x150 file offset of document property data structure.
1350 sal_uInt32 m_lcbDop = 0; // 0x154 count of bytes of document properties.
1351 // cbDOP is 84 when nFib < 103
1353 WW8_FC m_fcSttbfAssoc = 0; // 0x158 offset to STTBF of associated strings. See STTBFASSOC.
1354 sal_Int32 m_lcbSttbfAssoc = 0; // 0x15C
1356 WW8_FC m_fcClx = 0; // 0x160 file offset of beginning of information for complex files.
1357 sal_Int32 m_lcbClx = 0; // 0x164 count of bytes of complex file information. 0 if file is non-complex.
1359 WW8_FC m_fcPlcfpgdFootnote = 0; // 0x168 file offset of page descriptor PLCF for footnote subdocument.
1360 sal_Int32 m_lcbPlcfpgdFootnote = 0; // 0x16C count of bytes of page descriptor PLCF for footnote subdocument.
1361 // ==0 if document has not been paginated. The length of the PGD is 8 bytes.
1363 WW8_FC m_fcAutosaveSource = 0; // 0x170 file offset of the name of the original file.
1364 sal_Int32 m_lcbAutosaveSource = 0; // 0x174 count of bytes of the name of the original file.
1366 WW8_FC m_fcGrpStAtnOwners = 0; // 0x178 group of strings recording the names of the owners of annotations
1367 sal_Int32 m_lcbGrpStAtnOwners = 0; // 0x17C count of bytes of the group of strings
1369 WW8_FC m_fcSttbfAtnbkmk = 0; // 0x180 file offset of the sttbf that records names of bookmarks in the annotation subdocument
1370 sal_Int32 m_lcbSttbfAtnbkmk = 0; // 0x184 length in bytes of the sttbf that records names of bookmarks in the annotation subdocument
1372 // end of WW67 section
1374 WW8_FC m_fcPlcfdoaMom = 0; // 0x192 file offset of the FDOA (drawn object) PLCF for main document.
1375 // ==0 if document has no drawn objects. The length of the FDOA is 6 bytes.
1376 // unused starting from Ver8
1377 sal_Int32 m_lcbPlcfdoaMom = 0; // 0x196 length in bytes of the FDOA PLCF of the main document
1378 // unused starting from Ver8
1379 WW8_FC m_fcPlcfdoaHdr = 0; // 0x19A file offset of the FDOA (drawn object) PLCF for the header document.
1380 // ==0 if document has no drawn objects. The length of the FDOA is 6 bytes.
1381 // unused starting from Ver8
1382 sal_Int32 m_lcbPlcfdoaHdr = 0; // 0x19E length in bytes of the FDOA PLCF of the header document
1383 // unused starting from Ver8
1385 WW8_FC m_fcPlcfspaMom = 0; // offset in table stream of the FSPA PLCF for main document.
1386 // == 0 if document has no office art objects
1387 // was empty reserve in Ver67
1388 sal_Int32 m_lcbPlcfspaMom = 0; // length in bytes of the FSPA PLCF of the main document
1389 // was empty reserve in Ver67
1390 WW8_FC m_fcPlcfspaHdr = 0; // offset in table stream of the FSPA PLCF for header document.
1391 // == 0 if document has no office art objects
1392 // was empty reserve in Ver67
1393 sal_Int32 m_lcbPlcfspaHdr = 0; // length in bytes of the FSPA PLCF of the header document
1394 // was empty reserve in Ver67
1396 WW8_FC m_fcPlcfAtnbkf = 0; // 0x1B2 file offset of BKF (bookmark first) PLCF of the annotation subdocument
1397 sal_Int32 m_lcbPlcfAtnbkf = 0; // 0x1B6 length in bytes of BKF (bookmark first) PLCF of the annotation subdocument
1399 WW8_FC m_fcPlcfAtnbkl = 0; // 0x1BA file offset of BKL (bookmark last) PLCF of the annotation subdocument
1400 sal_Int32 m_lcbPlcfAtnbkl = 0; // 0x1BE length in bytes of BKL (bookmark first) PLCF of the annotation subdocument
1402 WW8_FC m_fcPms = 0; // 0x1C2 file offset of PMS (Print Merge State) information block
1403 sal_Int32 m_lcbPMS = 0; // 0x1C6 length in bytes of PMS
1405 WW8_FC m_fcFormFieldSttbf = 0; // 0x1CA file offset of form field Sttbf which contains strings used in form field dropdown controls
1406 sal_Int32 m_lcbFormFieldSttbf = 0; // 0x1CE length in bytes of form field Sttbf
1408 WW8_FC m_fcPlcfendRef = 0; // 0x1D2 file offset of PLCFendRef which points to endnote references in the main document stream
1409 sal_Int32 m_lcbPlcfendRef = 0; // 0x1D6
1411 WW8_FC m_fcPlcfendText = 0; // 0x1DA file offset of PLCFendRef which points to endnote text in the endnote document
1412 // stream which corresponds with the PLCFendRef
1413 sal_Int32 m_lcbPlcfendText = 0; // 0x1DE
1415 WW8_FC m_fcPlcffldEdn = 0; // 0x1E2 offset to PLCF of field positions in the endnote subdoc
1416 sal_Int32 m_lcbPlcffldEdn = 0; // 0x1E6
1418 WW8_FC m_fcPlcfpgdEdn = 0; // 0x1EA offset to PLCF of page boundaries in the endnote subdoc.
1419 sal_Int32 m_lcbPlcfpgdEdn = 0; // 0x1EE
1421 WW8_FC m_fcDggInfo = 0; // offset in table stream of the office art object table data.
1422 // The format of office art object table data is found in a separate document.
1423 // was empty reserve in Ver67
1424 sal_Int32 m_lcbDggInfo = 0; // length in bytes of the office art object table data
1425 // was empty reserve in Ver67
1427 WW8_FC m_fcSttbfRMark = 0; // 0x1fa offset to STTBF that records the author abbreviations...
1428 sal_Int32 m_lcbSttbfRMark = 0; // 0x1fe
1429 WW8_FC m_fcSttbfCaption = 0; // 0x202 offset to STTBF that records caption titles...
1430 sal_Int32 m_lcbSttbfCaption = 0; // 0x206
1431 WW8_FC m_fcSttbAutoCaption = 0; // offset in table stream to the STTBF that records the object names and
1432 // indices into the caption STTBF for objects which get auto captions.
1433 sal_Int32 m_lcbSttbAutoCaption = 0; // 0x20e
1435 WW8_FC m_fcPlcfwkb = 0; // 0x212 offset to PLCF that describes the boundaries of contributing documents...
1436 sal_Int32 m_lcbPlcfwkb = 0; // 0x216
1438 WW8_FC m_fcPlcfspl = 0; // offset in table stream of PLCF (of SPLS structures) that records spell check state
1439 // was empty reserve in Ver67
1440 sal_Int32 m_lcbPlcfspl = 0; // was empty reserve in Ver67
1442 WW8_FC m_fcPlcftxbxText = 0; // 0x222 ...PLCF of beginning CP in the text box subdoc
1443 sal_Int32 m_lcbPlcftxbxText = 0; // 0x226
1444 WW8_FC m_fcPlcffldTxbx = 0; // 0x22a ...PLCF of field boundaries recorded in the textbox subdoc.
1445 sal_Int32 m_lcbPlcffldTxbx = 0; // 0x22e
1446 WW8_FC m_fcPlcfHdrtxbxText = 0;// 0x232 ...PLCF of beginning CP in the header text box subdoc
1447 sal_Int32 m_lcbPlcfHdrtxbxText = 0;// 0x236
1448 WW8_FC m_fcPlcffldHdrTxbx = 0;// 0x23a ...PLCF of field boundaries recorded in the header textbox subdoc.
1449 sal_Int32 m_lcbPlcffldHdrTxbx = 0;// 0x23e
1450 WW8_FC m_fcStwUser = 0;
1451 sal_uInt32 m_lcbStwUser = 0;
1452 WW8_FC m_fcSttbttmbd = 0;
1453 sal_uInt32 m_lcbSttbttmbd = 0;
1455 WW8_FC m_fcSttbFnm = 0; // 0x02da offset in the table stream of masters subdocument names
1456 sal_Int32 m_lcbSttbFnm = 0; // 0x02de length
1459 special list handling for WW8
1461 WW8_FC m_fcPlcfLst = 0; // 0x02e2 offset in the table stream of list format information.
1462 sal_Int32 m_lcbPlcfLst = 0; // 0x02e6 length
1463 WW8_FC m_fcPlfLfo = 0; // 0x02ea offset in the table stream of list format override information.
1464 sal_Int32 m_lcbPlfLfo = 0; // 0x02ee length
1466 special Break handling for text-box-stories in WW8
1468 WW8_FC m_fcPlcftxbxBkd = 0; // 0x02f2 PLCF for TextBox-Break-descriptors in the Maintext
1469 sal_Int32 m_lcbPlcftxbxBkd = 0; // 0x02f6
1470 WW8_FC m_fcPlcfHdrtxbxBkd = 0;// 0x02fa PLCF for TextBox-Break-descriptors in the Header-/Footer- area
1471 sal_Int32 m_lcbPlcfHdrtxbxBkd = 0;// 0x02fe
1473 // 0x302 - 372 == ignore
1475 ListNames (skip to here!)
1477 WW8_FC m_fcSttbListNames = 0;// 0x0372 PLCF for Listname Table
1478 sal_Int32 m_lcbSttbListNames = 0;// 0x0376
1480 WW8_FC m_fcPlcfTch = 0;
1481 sal_Int32 m_lcbPlcfTch = 0;
1483 // 0x38A - 41A == ignore
1484 WW8_FC m_fcAtrdExtra = 0;
1485 sal_uInt32 m_lcbAtrdExtra = 0;
1487 // 0x422 - 0x429 == ignore
1489 /// 0x42a smart-tag bookmark string table offset.
1490 WW8_FC m_fcSttbfBkmkFactoid = 0;
1491 /// 0x42e smart-tag bookmark string table length.
1492 sal_uInt32 m_lcbSttbfBkmkFactoid = 0;
1493 /// 0x432 smart-tag bookmark starts offset.
1494 WW8_FC m_fcPlcfBkfFactoid = 0;
1495 /// 0x436 smart-tag bookmark ends length.
1496 sal_uInt32 m_lcbPlcfBkfFactoid = 0;
1498 // 0x43a - 0x441 == ignore
1500 /// 0x442 smart-tag bookmark ends offset.
1501 WW8_FC m_fcPlcfBklFactoid = 0;
1502 /// 0x446 smart-tag bookmark ends length.
1503 sal_uInt32 m_lcbPlcfBklFactoid = 0;
1504 /// 0x44a smart tag data offset.
1505 WW8_FC m_fcFactoidData = 0;
1506 /// 0x44e smart tag data length.
1507 sal_uInt32 m_lcbFactoidData = 0;
1509 // 0x452 - 0x4b9 == ignore
1511 /// 0x4ba Plcffactoid offset.
1512 WW8_FC m_fcPlcffactoid = 0;
1513 /// 0x4be Plcffactoid offset.
1514 sal_uInt32 m_lcbPlcffactoid = 0;
1516 // 0x4bf - 0x4d4 == ignore
1518 WW8_FC m_fcHplxsdr = 0; //bizarrely, word xp seems to require this set to shows dates from AtrdExtra
1519 sal_uInt32 m_lcbHplxsdr = 0;
1522 general variables that were used for Ver67 and Ver8,
1523 even though they had different sizes in the corresponding files:
1525 sal_Int32 m_pnChpFirst = 0;
1526 sal_Int32 m_pnPapFirst = 0;
1527 sal_Int32 m_cpnBteChp = 0;
1528 sal_Int32 m_cpnBtePap = 0;
1530 The actual nFib, moved here because some readers assumed
1531 they couldn't read any format with nFib > some constant
1533 sal_uInt16 m_nFib_actual = 0; // 0x05bc #i56856#
1535 WW8Fib(SvStream& rStrm, sal_uInt8 nWantedVersion,sal_uInt32 nOffset=0);
1536 explicit WW8Fib(sal_uInt8 nVersion, bool bDot = false);
1538 void WriteHeader(SvStream& rStrm);
1539 void Write(SvStream& rStrm);
1540 static rtl_TextEncoding GetFIBCharset(sal_uInt16 chs, LanguageType nLidLocale);
1541 ww::WordVersion GetFIBVersion() const;
1542 bool GetBaseCp(ManTypes nType, WW8_CP * cp) const;
1543 sal_Unicode getNumDecimalSep() const { return m_nNumDecimalSep;}
1546 class WW8Style
1548 protected:
1549 WW8Fib& m_rFib;
1550 SvStream& m_rStream;
1552 sal_uInt16 m_cstd; // Count of styles in stylesheet
1553 sal_uInt16 m_cbSTDBaseInFile; // Length of STD Base as stored in a file
1554 sal_uInt16 m_fStdStylenamesWritten : 1; // Are built-in stylenames stored?
1555 sal_uInt16 : 15; // Spare flags
1556 sal_uInt16 m_stiMaxWhenSaved; // Max sti known when file was written
1557 sal_uInt16 m_istdMaxFixedWhenSaved; // How many fixed-index istds are there?
1558 sal_uInt16 m_nVerBuiltInNamesWhenSaved; // Current version of built-in stylenames
1559 // ftc used by StandardChpStsh for this document
1560 sal_uInt16 m_ftcAsci;
1561 // CJK ftc used by StandardChpStsh for this document
1562 sal_uInt16 m_ftcFE;
1563 // CTL/Other ftc used by StandardChpStsh for this document
1564 sal_uInt16 m_ftcOther;
1565 // CTL ftc used by StandardChpStsh for this document
1566 sal_uInt16 m_ftcBi;
1568 //No copying
1569 WW8Style(const WW8Style&);
1570 WW8Style& operator=(const WW8Style&);
1572 public:
1573 WW8Style( SvStream& rSt, WW8Fib& rFibPara );
1574 std::unique_ptr<WW8_STD> Read1STDFixed(sal_uInt16& rSkip);
1575 std::unique_ptr<WW8_STD> Read1Style(sal_uInt16& rSkip, OUString* pString);
1576 sal_uInt16 GetCount() const { return m_cstd; }
1579 class WW8Fonts final
1581 private:
1582 WW8Fonts(const WW8Fonts&) = delete;
1583 WW8Fonts& operator=(const WW8Fonts&) = delete;
1585 std::vector<WW8_FFN> m_aFontA; // Array of Pointers to Font Description
1587 public:
1588 WW8Fonts( SvStream& rSt, WW8Fib const & rFib );
1589 const WW8_FFN* GetFont( sal_uInt16 nNum ) const;
1590 sal_uInt16 GetMax() const { return m_aFontA.size(); }
1593 typedef sal_uInt8 HdFtFlags;
1594 namespace nsHdFtFlags
1596 const HdFtFlags WW8_HEADER_EVEN = 0x01;
1597 const HdFtFlags WW8_HEADER_ODD = 0x02;
1598 const HdFtFlags WW8_FOOTER_EVEN = 0x04;
1599 const HdFtFlags WW8_FOOTER_ODD = 0x08;
1600 const HdFtFlags WW8_HEADER_FIRST = 0x10;
1601 const HdFtFlags WW8_FOOTER_FIRST = 0x20;
1604 /// Document Properties
1605 struct WW8Dop
1607 public:
1608 /* Error Status */
1609 ErrCode nDopError;
1611 Corresponds only roughly to the actual structure of the Winword DOP,
1612 the winword FIB version matters to what exists.
1614 bool fFacingPages : 1 /*= false*/; // 1 when facing pages should be printed
1616 bool fWidowControl : 1 /*= false*/; //a: orig 97 docs say
1617 // 1 when widow control is in effect. 0 when widow control disabled.
1618 //b: MS-DOC: Word Binary File Format (.doc) Structure Specification 2008 says
1619 // B - unused1 (1 bit): Undefined and MUST be ignored.
1621 bool fPMHMainDoc : 1 /*= false*/; // 1 when doc is a main doc for Print Merge Helper, 0 when not; default=0
1622 sal_uInt16 grfSuppression : 2 /*= 0*/; // 0 Default line suppression storage; 0= form letter line suppression; 1= no line suppression; default=0
1623 sal_uInt16 fpc : 2 /*= 0*/; // 1 footnote position code: 0 as endnotes, 1 at bottom of page, 2 immediately beneath text
1624 sal_uInt16 : 1; // 0 unused
1626 sal_uInt16 grpfIhdt : 8 /*= 0*/; // 0 specification of document headers and footers. See explanation under Headers and Footers topic.
1628 sal_uInt16 rncFootnote : 2 /*= 0*/; // 0 restart index for footnotes, 0 don't restart note numbering, 1 section, 2 page
1629 sal_uInt16 nFootnote : 14 /*= 0*/; // 1 initial footnote number for document
1630 bool fOutlineDirtySave : 1 /*= false*/; // when 1, indicates that information in the hPLCFpad should be refreshed since outline has been dirtied
1631 sal_uInt16 : 7; // reserved
1632 bool fOnlyMacPics : 1 /*= false*/; // when 1, Word believes all pictures recorded in the document were created on a Macintosh
1633 bool fOnlyWinPics : 1 /*= false*/; // when 1, Word believes all pictures recorded in the document were created in Windows
1634 bool fLabelDoc : 1 /*= false*/; // when 1, document was created as a print merge labels document
1635 bool fHyphCapitals : 1 /*= false*/; // when 1, Word is allowed to hyphenate words that are capitalized. When 0, capitalized may not be hyphenated
1636 bool fAutoHyphen : 1 /*= false*/; // when 1, Word will hyphenate newly typed text as a background task
1637 bool fFormNoFields : 1 /*= false*/;
1638 bool fLinkStyles : 1 /*= false*/; // when 1, Word will merge styles from its template
1639 bool fRevMarking : 1 /*= false*/; // when 1, Word will mark revisions as the document is edited
1640 bool fBackup : 1 /*= false*/; // always make backup when document saved when 1.
1641 bool fExactCWords : 1 /*= false*/;
1642 bool fPagHidden : 1 /*= false*/;
1643 bool fPagResults : 1 /*= false*/;
1644 bool fLockAtn : 1 /*= false*/; // when 1, annotations are locked for editing
1645 bool fMirrorMargins : 1 /*= false*/; // swap margins on left/right pages when 1.
1646 bool fReadOnlyRecommended : 1 /*= false*/;// user has recommended that this doc be opened read-only when 1
1647 bool fDfltTrueType : 1 /*= false*/; // when 1, use TrueType fonts by default (flag obeyed only when doc was created by WinWord 2.x)
1648 bool fPagSuppressTopSpacing : 1 /*= false*/;//when 1, file created with SUPPRESSTOPSPACING=YES in win.ini. (flag obeyed only when doc was created by WinWord 2.x).
1649 bool fProtEnabled : 1 /*= false*/; // when 1, document is protected from edit operations
1650 bool fDispFormFieldSel : 1 /*= false*/;// when 1, restrict selections to occur only within form fields
1651 bool fRMView : 1 /*= false*/; // when 1, show revision markings on screen
1652 bool fRMPrint : 1 /*= false*/; // when 1, print revision marks when document is printed
1653 bool fWriteReservation : 1 /*= false*/;
1654 bool fLockRev : 1 /*= false*/; // when 1, the current revision marking state is locked
1655 bool fEmbedFonts : 1 /*= false*/; // when 1, document contains embedded True Type fonts
1656 // compatibility options
1657 bool copts_fNoTabForInd : 1 /*= false*/; // when 1, don't add automatic tab stops for hanging indent
1658 bool copts_fNoSpaceRaiseLower : 1 /*= false*/; // when 1, don't add extra space for raised or lowered characters
1659 bool copts_fSupressSpbfAfterPgBrk : 1 /*= false*/; // when 1, suppress the paragraph Space Before and Space After options after a page break
1660 bool copts_fWrapTrailSpaces : 1 /*= false*/; // when 1, wrap trailing spaces at the end of a line to the next line
1661 bool copts_fMapPrintTextColor : 1 /*= false*/; // when 1, print colors as black on non-color printers
1662 bool copts_fNoColumnBalance : 1 /*= false*/; // when 1, don't balance columns for Continuous Section starts
1663 bool copts_fConvMailMergeEsc : 1 /*= false*/;
1664 bool copts_fSupressTopSpacing : 1 /*= false*/; // when 1, suppress extra line spacing at top of page
1665 bool copts_fOrigWordTableRules : 1 /*= false*/; // when 1, combine table borders like Word 5.x for the Macintosh
1666 bool copts_fTransparentMetafiles : 1 /*= false*/; // when 1, don't blank area between metafile pictures
1667 bool copts_fShowBreaksInFrames : 1 /*= false*/; // when 1, show hard page or column breaks in frames
1668 bool copts_fSwapBordersFacingPgs : 1 /*= false*/; // when 1, swap left and right pages on odd facing pages
1669 bool copts_fExpShRtn : 1 /*= false*/; // when 1, expand character spaces on the line ending SHIFT+RETURN // #i56856#
1671 sal_Int16 dxaTab = 0; // 720 twips - default tab width
1672 sal_uInt16 wSpare = 0;
1673 sal_uInt16 dxaHotZ = 0; // width of hyphenation hot zone measured in twips
1674 sal_uInt16 cConsecHypLim = 0; // number of lines allowed to have consecutive hyphens
1675 sal_uInt16 wSpare2 = 0; // reserved
1676 sal_Int32 dttmCreated = 0; // DTTM date and time document was created
1677 sal_Int32 dttmRevised = 0; // DTTM date and time document was last revised
1678 sal_Int32 dttmLastPrint = 0; // DTTM date and time document was last printed
1679 sal_Int16 nRevision = 0; // number of times document has been revised since its creation
1680 sal_Int32 tmEdited = 0; // time document was last edited
1681 sal_Int32 cWords = 0; // count of words tallied by last Word Count execution
1682 sal_Int32 cCh = 0; // count of characters tallied by last Word Count execution
1683 sal_Int16 cPg = 0; // count of pages tallied by last Word Count execution
1684 sal_Int32 cParas = 0; // count of paragraphs tallied by last Word Count execution
1685 sal_uInt16 rncEdn : 2 /*= 0*/; // restart endnote number code: 0 don't restart endnote numbering, 1 section, 2 page
1686 sal_uInt16 nEdn : 14 /*= 0*/; // beginning endnote number
1687 sal_uInt16 epc : 2 /*= 0*/; // endnote position code: 0 at end of section, 3 at end of document
1689 bool fPrintFormData : 1 /*= false*/; // only print data inside of form fields
1690 bool fSaveFormData : 1 /*= false*/; // only save document data that is inside of a form field.
1691 bool fShadeFormData : 1 /*= false*/; // shade form fields
1692 sal_uInt16 : 2; // reserved
1693 bool fWCFootnoteEdn : 1 /*= false*/; // when 1, include footnotes and endnotes in word count
1694 sal_Int32 cLines = 0; // count of lines tallied by last Word Count operation
1695 sal_Int32 cWordsFootnoteEnd = 0; // count of words in footnotes and endnotes tallied by last Word Count operation
1696 sal_Int32 cChFootnoteEdn = 0; // count of characters in footnotes and endnotes tallied by last Word Count operation
1697 sal_Int16 cPgFootnoteEdn = 0; // count of pages in footnotes and endnotes tallied by last Word Count operation
1698 sal_Int32 cParasFootnoteEdn = 0; // count of paragraphs in footnotes and endnotes tallied by last Word Count operation
1699 sal_Int32 cLinesFootnoteEdn = 0; // count of paragraphs in footnotes and endnotes tallied by last Word Count operation
1700 sal_Int32 lKeyProtDoc = 0; // document protection password key, only valid if dop.fProtEnabled, dop.fLockAtn or dop.fLockRev are 1.
1701 sal_uInt16 wvkSaved : 3 /*= 0*/; // document view kind: 0 Normal view, 1 Outline view, 2 Page View
1702 sal_uInt16 wScaleSaved : 9 /*= 0*/; ///< Specifies the zoom percentage that was in use when the document was saved.
1703 sal_uInt16 zkSaved : 2 /*= 0*/; // document zoom type: 0 percent, 1 whole/entire page, 2 page width, 3 text width/optimal
1704 bool fRotateFontW6 : 1 /*= false*/;
1705 bool iGutterPos : 1 /*= false*/;
1707 // this should be the end for nFib < 103, otherwise the file is broken!
1710 for nFib >= 103 it continues:
1712 bool fNoTabForInd : 1 /*= false*/; // see above in compatibility options
1713 bool fNoSpaceRaiseLower : 1 /*= false*/; // see above
1714 bool fSupressSpbfAfterPageBreak : 1 /*= false*/; // see above
1715 bool fWrapTrailSpaces : 1 /*= false*/; // see above
1716 bool fMapPrintTextColor : 1 /*= false*/; // see above
1717 bool fNoColumnBalance : 1 /*= false*/; // see above
1718 bool fConvMailMergeEsc : 1 /*= false*/; // see above
1719 bool fSupressTopSpacing : 1 /*= false*/; // see above
1720 bool fOrigWordTableRules : 1 /*= false*/; // see above
1721 bool fTransparentMetafiles : 1 /*= false*/; // see above
1722 bool fShowBreaksInFrames : 1 /*= false*/; // see above
1723 bool fSwapBordersFacingPgs : 1 /*= false*/; // see above
1724 bool fCompatibilityOptions_Unknown1_13 : 1 /*= false*/; // #i78591#
1725 bool fExpShRtn : 1 /*= false*/; // #i78591# and #i56856#
1726 bool fCompatibilityOptions_Unknown1_15 : 1 /*= false*/; // #i78591#
1727 bool fCompatibilityOptions_Unknown1_16 : 1 /*= false*/; // #i78591#
1728 bool fSuppressTopSpacingMac5 : 1 /*= false*/; // Suppress extra line spacing at top
1729 // of page like MacWord 5.x
1730 bool fTruncDxaExpand : 1 /*= false*/; // Expand/Condense by whole number of points
1731 bool fPrintBodyBeforeHdr : 1 /*= false*/; // Print body text before header/footer
1732 bool fNoLeading : 1 /*= false*/; // Don't add extra spacebetween rows of text
1733 bool fCompatibilityOptions_Unknown1_21 : 1 /*= false*/; // #i78591#
1734 bool fMWSmallCaps : 1 /*= false*/; // Use larger small caps like MacWord 5.x
1735 bool fCompatibilityOptions_Unknown1_23 : 1 /*= false*/; // #i78591#
1736 bool fCompatibilityOptions_Unknown1_24 : 1 /*= false*/; // #i78591#
1737 bool fCompatibilityOptions_Unknown1_25 : 1 /*= false*/; // #i78591#
1738 bool fCompatibilityOptions_Unknown1_26 : 1 /*= false*/; // #i78591#
1739 bool fCompatibilityOptions_Unknown1_27 : 1 /*= false*/; // #i78591#
1740 bool fCompatibilityOptions_Unknown1_28 : 1 /*= false*/; // #i78591#
1741 bool fCompatibilityOptions_Unknown1_29 : 1 /*= false*/; // #i78591#
1742 bool fCompatibilityOptions_Unknown1_30 : 1 /*= false*/; // #i78591#
1743 bool fCompatibilityOptions_Unknown1_31 : 1 /*= false*/; // #i78591#
1744 bool fUsePrinterMetrics : 1 /*= false*/; //The magic option
1746 // this should be the end for nFib <= 105, otherwise the file is broken!
1749 for nFib > 105 it continues:
1751 sal_Int16 adt = 0; // Autoformat Document Type:
1752 // 0 for normal.
1753 // 1 for letter, and
1754 // 2 for email.
1755 WW8DopTypography doptypography = {}; // see WW8STRUC.HXX
1756 WW8_DOGRID dogrid = {}; // see WW8STRUC.HXX
1757 sal_uInt16 : 1; // reserved
1758 sal_uInt16 lvl : 4 /*= 0*/; // Which outline levels are showing in outline view
1759 sal_uInt16 : 4; // reserved
1760 bool fHtmlDoc : 1 /*= false*/; // This file is based upon an HTML file
1761 sal_uInt16 : 1; // reserved
1762 bool fSnapBorder : 1 /*= false*/; // Snap table and page borders to page border
1763 bool fIncludeHeader : 1 /*= false*/; // Place header inside page border
1764 bool fIncludeFooter : 1 /*= false*/; // Place footer inside page border
1765 bool fForcePageSizePag : 1 /*= false*/; // Are we in online view
1766 bool fMinFontSizePag : 1 /*= false*/; // Are we auto-promoting fonts to >= hpsZoomFontPag?
1767 bool fHaveVersions : 1 /*= false*/; // versioning is turned on
1768 bool fAutoVersion : 1 /*= false*/; // autoversioning is enabled
1769 sal_uInt16 : 14; // reserved
1770 // Skip 12 Bytes here: ASUMI
1771 sal_Int32 cChWS = 0;
1772 sal_Int32 cChWSFootnoteEdn = 0;
1773 sal_Int32 grfDocEvents = 0;
1774 // Skip 4+30+8 Bytes here
1775 sal_Int32 cDBC = 0;
1776 sal_Int32 cDBCFootnoteEdn = 0;
1777 // Skip 4 Bytes here
1778 sal_Int16 nfcFootnoteRef = 0;
1779 sal_Int16 nfcEdnRef = 0;
1780 sal_Int16 hpsZoomFontPag = 0;
1781 sal_Int16 dywDispPag = 0;
1783 bool fCompatibilityOptions_Unknown2_1 : 1 /*= false*/; // #i78591#
1784 bool fCompatibilityOptions_Unknown2_2 : 1 /*= false*/; // #i78591#
1785 bool fDontUseHTMLAutoSpacing : 1 /*= false*/;
1786 bool fCompatibilityOptions_Unknown2_4 : 1 /*= false*/; // #i78591#
1787 bool fCompatibilityOptions_Unknown2_5 : 1 /*= false*/; // #i78591#
1788 bool fCompatibilityOptions_Unknown2_6 : 1 /*= false*/; // #i78591#
1789 bool fCompatibilityOptions_Unknown2_7 : 1 /*= false*/; // #i78591#
1790 bool fCompatibilityOptions_Unknown2_8 : 1 /*= false*/; // #i78591#
1791 bool fCompatibilityOptions_Unknown2_9 : 1 /*= false*/; // #i78591#
1792 bool fCompatibilityOptions_Unknown2_10 : 1 /*= false*/; // #i78591#
1793 bool fCompatibilityOptions_Unknown2_11 : 1 /*= false*/; // #i78591#
1794 bool fCompatibilityOptions_Unknown2_12 : 1 /*= false*/; // #i78591#
1795 bool fCompatibilityOptions_Unknown2_13 : 1 /*= false*/; // #i78591#
1796 bool fCompatibilityOptions_Unknown2_14 : 1 /*= false*/; // #i78591#
1797 bool fCompatibilityOptions_Unknown2_15 : 1 /*= false*/; // #i78591#
1798 bool fCompatibilityOptions_Unknown2_16 : 1 /*= false*/; // #i78591#
1799 bool fCompatibilityOptions_Unknown2_17 : 1 /*= false*/; // #i78591#
1800 bool fCompatibilityOptions_Unknown2_18 : 1 /*= false*/; // #i78591#
1801 bool fCompatibilityOptions_Unknown2_19 : 1 /*= false*/; // #i78591#
1802 bool fCompatibilityOptions_Unknown2_20 : 1 /*= false*/; // #i78591#
1803 bool fCompatibilityOptions_Unknown2_21 : 1 /*= false*/; // #i78591#
1804 bool fCompatibilityOptions_Unknown2_22 : 1 /*= false*/; // #i78591#
1805 bool fCompatibilityOptions_Unknown2_23 : 1 /*= false*/; // #i78591#
1806 bool fCompatibilityOptions_Unknown2_24 : 1 /*= false*/; // #i78591#
1807 bool fCompatibilityOptions_Unknown2_25 : 1 /*= false*/; // #i78591#
1808 bool fCompatibilityOptions_Unknown2_26 : 1 /*= false*/; // #i78591#
1809 bool fCompatibilityOptions_Unknown2_27 : 1 /*= false*/; // #i78591#
1810 bool fCompatibilityOptions_Unknown2_28 : 1 /*= false*/; // #i78591#
1811 bool fCompatibilityOptions_Unknown2_29 : 1 /*= false*/; // #i78591#
1812 bool fCompatibilityOptions_Unknown2_30 : 1 /*= false*/; // #i78591#
1813 bool fCompatibilityOptions_Unknown2_31 : 1 /*= false*/; // #i78591#
1814 bool fCompatibilityOptions_Unknown2_32 : 1 /*= false*/; // #i78591#
1816 sal_uInt16 fUnknown3 : 15 /*= 0*/;
1817 bool fUseBackGroundInAllmodes : 1 /*= false*/;
1819 bool fDoNotEmbedSystemFont : 1 /*= false*/;
1820 bool fWordCompat : 1 /*= false*/;
1821 bool fLiveRecover : 1 /*= false*/;
1822 bool fEmbedFactoids : 1 /*= false*/;
1823 bool fFactoidXML : 1 /*= false*/;
1824 bool fFactoidAllDone : 1 /*= false*/;
1825 bool fFolioPrint : 1 /*= false*/;
1826 bool fReverseFolio : 1 /*= false*/;
1827 sal_uInt16 iTextLineEnding : 3 /*= 0*/;
1828 bool fHideFcc : 1 /*= false*/;
1829 bool fAcetateShowMarkup : 1 /*= false*/;
1830 bool fAcetateShowAtn : 1 /*= false*/;
1831 bool fAcetateShowInsDel : 1 /*= false*/;
1832 bool fAcetateShowProps : 1 /*= false*/;
1834 bool bUseThaiLineBreakingRules = false;
1836 /* Constructor for importing, needs to know the version of word used */
1837 WW8Dop(SvStream& rSt, sal_Int16 nFib, sal_Int32 nPos, sal_uInt32 nSize);
1839 /* Constructs default DOP suitable for exporting */
1840 WW8Dop();
1841 void Write(SvStream& rStrm, WW8Fib& rFib) const;
1843 sal_uInt32 GetCompatibilityOptions() const;
1844 void SetCompatibilityOptions(sal_uInt32 a32Bit);
1845 // i#78591#
1846 sal_uInt32 GetCompatibilityOptions2() const;
1847 void SetCompatibilityOptions2(sal_uInt32 a32Bit);
1850 class WW8PLCF_HdFt
1852 private:
1853 WW8PLCF aPLCF;
1854 short nIdxOffset;
1856 public:
1857 WW8PLCF_HdFt( SvStream* pSt, WW8Fib const & rFib, WW8Dop const & rDop );
1858 bool GetTextPos(sal_uInt8 grpfIhdt, sal_uInt8 nWhich, WW8_CP& rStart, WW8_CP& rLen);
1859 void GetTextPosExact(short nIdx, WW8_CP& rStart, WW8_CP& rLen);
1860 void UpdateIndex( sal_uInt8 grpfIhdt );
1863 Word2CHPX ReadWord2Chpx(SvStream &rSt, std::size_t nOffset, sal_uInt8 nSize);
1864 std::vector<sal_uInt8> ChpxToSprms(const Word2CHPX &rChpx);
1866 [[nodiscard]] bool checkRead(SvStream &rSt, void *pDest, sal_uInt32 nLength);
1868 //MS has a (slightly) inaccurate view of how many twips
1869 //are in the default letter size of a page
1870 const sal_uInt16 lLetterWidth = 12242;
1871 const sal_uInt16 lLetterHeight = 15842;
1873 #ifdef OSL_BIGENDIAN
1874 void swapEndian(sal_Unicode *pString);
1875 #endif
1877 #endif
1879 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */