?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
cid#1607171 Data race condition
[LibreOffice.git] / include / oox / dump / dumperbase.hxx
blob64ec991b04fa928d805ca458157ca2e542338931
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
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/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
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 .
18 */
19
20 #ifndef INCLUDED_OOX_DUMP_DUMPERBASE_HXX
21 #define INCLUDED_OOX_DUMP_DUMPERBASE_HXX
22
23 #include <cmath>
24 #include <cstddef>
25 #include <map>
26 #include <memory>
27 #include <set>
28 #include <string_view>
29 #include <utility>
30 #include <vector>
31
32 #include <com/sun/star/uno/Reference.hxx>
33 #include <com/sun/star/uno/Sequence.hxx>
34 #include <com/sun/star/util/DateTime.hpp>
35 #include <oox/helper/binaryinputstream.hxx>
36 #include <oox/helper/binarystreambase.hxx>
37 #include <oox/helper/storagebase.hxx>
38 #include <rtl/string.hxx>
39 #include <rtl/textenc.h>
40 #include <rtl/ustring.hxx>
41 #include <rtl/ustrbuf.hxx>
42 #include <sal/types.h>
43
44 #ifdef DBG_UTIL
45
46 namespace com::sun::star {
47 namespace io { class XInputStream; }
48 namespace io { class XOutputStream; }
49 namespace io { class XTextOutputStream2; }
50 namespace uno { class XComponentContext; }
51 }
52
53 namespace oox {
54 class TextInputStream;
55 }
56
57 namespace oox::core {
58 class FilterBase;
59 }
60
61 namespace oox::dump {
62
63
64 inline constexpr OUString OOX_DUMP_UNUSED = u"unused"_ustr;
65 inline constexpr OUString OOX_DUMP_UNKNOWN = u"?unknown"_ustr;
66
67 #define OOX_DUMP_ERRASCII( ascii ) "?err:" ascii
68
69 #define OOX_DUMP_ERR_NOMAP "no-map"
70 inline constexpr OUString OOX_DUMP_ERR_NONAME = u"no-name"_ustr;
71 #define OOX_DUMP_ERR_STREAM "stream-error"
72
73 #define OOX_DUMP_DUMPEXT ".dump"
74
75 const sal_Unicode OOX_DUMP_STRQUOTE = '\'';
76 const sal_Unicode OOX_DUMP_FMLASTRQUOTE = '"';
77 const sal_Unicode OOX_DUMP_ADDRABS = '$';
78 const sal_Unicode OOX_DUMP_R1C1ROW = 'R';
79 const sal_Unicode OOX_DUMP_R1C1COL = 'C';
80 const sal_Unicode OOX_DUMP_R1C1OPEN = '[';
81 const sal_Unicode OOX_DUMP_R1C1CLOSE = ']';
82 const sal_Unicode OOX_DUMP_RANGESEP = ':';
83 const sal_Unicode OOX_DUMP_BASECLASS = 'B';
84 const sal_Unicode OOX_DUMP_FUNCSEP = ',';
85 const sal_Unicode OOX_DUMP_LISTSEP = ',';
86 const sal_Unicode OOX_DUMP_TABSEP = '!';
87 const sal_Unicode OOX_DUMP_ARRAYSEP = ';';
88 const sal_Unicode OOX_DUMP_EMPTYVALUE = '~';
89 const sal_Unicode OOX_DUMP_CMDPROMPT = '?';
90 const sal_Unicode OOX_DUMP_PLACEHOLDER = '\x01';
91
92 typedef ::std::pair< OUString, OUString > OUStringPair;
93
94 typedef ::std::vector< OUString > OUStringVector;
95 typedef ::std::vector< sal_Int64 > Int64Vector;
96
97
98 /** Static helper functions for system file and stream access. */
99 class InputOutputHelper
100 {
101 public:
102 // file names -------------------------------------------------------------
103
104 static OUString convertFileNameToUrl( const OUString& rFileName );
105 static sal_Int32 getFileNamePos( std::u16string_view rFileUrl );
106 static std::u16string_view getFileNameExtension( std::u16string_view rFileUrl );
107
108 // input streams ----------------------------------------------------------
109
110 static css::uno::Reference< css::io::XInputStream >
111 openInputStream(
112 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
113 const OUString& rFileName );
114
115 // output streams ---------------------------------------------------------
116
117 static css::uno::Reference< css::io::XOutputStream >
118 openOutputStream(
119 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
120 const OUString& rFileName );
121
122 static css::uno::Reference< css::io::XTextOutputStream2 >
123 openTextOutputStream(
124 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
125 const css::uno::Reference< css::io::XOutputStream >& rxOutStrm,
126 rtl_TextEncoding eTextEnc );
127
128 static css::uno::Reference< css::io::XTextOutputStream2 >
129 openTextOutputStream(
130 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
131 const OUString& rFileName,
132 rtl_TextEncoding eTextEnc );
133 };
134
135
136 class BinaryInputStreamRef : public ::oox::BinaryInputStreamRef
137 {
138 public:
139 BinaryInputStreamRef() {}
140
141 /*implicit*/ BinaryInputStreamRef( std::shared_ptr<BinaryInputStream> const & pInStrm ) :
142 ::oox::BinaryInputStreamRef( pInStrm ) {}
143
144 /*implicit*/ BinaryInputStreamRef( const css::uno::Reference< css::io::XInputStream >& rxInStrm ) :
145 ::oox::BinaryInputStreamRef( std::make_shared<BinaryXInputStream>( rxInStrm, true ) ) {}
146
147 template< typename StreamType >
148 /*implicit*/ BinaryInputStreamRef( const std::shared_ptr< StreamType >& rxInStrm ) :
149 ::oox::BinaryInputStreamRef( rxInStrm ) {}
150 };
151
152
153 /** Specifiers for atomic data types. */
154 enum DataType
155 {
156 DATATYPE_VOID, ///< No data type.
157 DATATYPE_INT8, ///< Signed 8-bit integer.
158 DATATYPE_UINT8, ///< Unsigned 8-bit integer.
159 DATATYPE_INT16, ///< Signed 16-bit integer.
160 DATATYPE_UINT16, ///< Unsigned 16-bit integer.
161 DATATYPE_INT32, ///< Signed 32-bit integer.
162 DATATYPE_UINT32, ///< Unsigned 32-bit integer.
163 DATATYPE_INT64, ///< Signed 64-bit integer.
164 DATATYPE_UINT64, ///< Unsigned 64-bit integer.
165 DATATYPE_FLOAT, ///< Floating-point, single precision.
166 DATATYPE_DOUBLE ///< Floating-point, double precision.
167 };
168
169
170 /** Specifiers for the output format of values. */
171 enum FormatType
172 {
173 FORMATTYPE_NONE, ///< No numeric format (e.g. show name only).
174 FORMATTYPE_DEC, ///< Decimal.
175 FORMATTYPE_HEX, ///< Hexadecimal.
176 FORMATTYPE_SHORTHEX, ///< Hexadecimal, as short as possible (no leading zeros).
177 FORMATTYPE_BIN, ///< Binary.
178 FORMATTYPE_FIX, ///< Fixed-point.
179 FORMATTYPE_BOOL ///< Boolean ('true' or 'false').
180 };
181
182
183 /** Describes the output format of a data item.
184
185 Data items are written in the following format:
186
187 <NAME>=<VALUE>=<NAME-FROM-LIST>
188
189 NAME is the name of the data item. The name is contained in the member
190 maItemName. If the name is empty, only the value is written (without a
191 leading equality sign).
192
193 VALUE is the numeric value of the data item. Its format is dependent on the
194 output format given in the member meFmtType. If the format type is
195 FORMATTYPE_NONE, no value is written.
196
197 NAME-FROM-LIST is a symbolic name for the current value of the data item.
198 Various types of name lists produce different names for values, which can
199 be used for enumerations or names for single bits in bitfields (see class
200 NameListBase and derived classes). The name of the list is given in the
201 member maListName. If it is empty, no name is written for the value.
202 */
203 struct ItemFormat
204 {
205 DataType meDataType; ///< Data type of the item.
206 FormatType meFmtType; ///< Output format for the value.
207 OUString maItemName; ///< Name of the item.
208 OUString maListName; ///< Name of a name list to be used for this item.
209
210 explicit ItemFormat();
211
212 void set( DataType eDataType, FormatType eFmtType, const OUString& rItemName );
213
214 /** Initializes the struct from a vector of strings containing the item format.
215
216 The vector must contain at least 2 strings. The struct is filled from
217 the strings in the vector in the following order:
218 1) Data type (one of: [u]int8, [u]int16, [u]int32, [u]int64, float, double).
219 2) Format type (one of: dec, hex, shorthex, bin, fix, bool, unused, unknown).
220 3) Item name (optional).
221 4) Name list name (optional).
222
223 @return Iterator pointing to the first unhandled string.
224 */
225 OUStringVector::const_iterator parse( const OUStringVector& rFormatVec );
226
227 /** Initializes the struct from a string containing the item format.
228
229 The string must have the following format:
230 DATATYPE,FORMATTYPE[,ITEMNAME[,LISTNAME]]
231
232 DATATYPE is the data type of the item (see above for possible values).
233 FORMATTYPE is the format type of the item (see above for possible values).
234 ITEMNAME is the name of the item (optional).
235 LISTNAME is the name of a name list (optional).
236
237 @return List containing remaining unhandled format strings.
238 */
239 OUStringVector parse( std::u16string_view rFormatStr );
240 };
241
242
243 /** Static helper functions for formatted output to strings. */
244 class StringHelper
245 {
246 public:
247 // append string to string ------------------------------------------------
248
249 static void appendChar( OUStringBuffer& rStr, sal_Unicode cChar, sal_Int32 nCount );
250 static void appendString( OUStringBuffer& rStr, std::u16string_view rData, sal_Int32 nWidth, sal_Unicode cFill = ' ' );
251
252 // append decimal ---------------------------------------------------------
253
254 static void appendDec( OUStringBuffer& rStr, sal_uInt8 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
255 static void appendDec( OUStringBuffer& rStr, sal_Int8 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
256 static void appendDec( OUStringBuffer& rStr, sal_uInt16 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
257 static void appendDec( OUStringBuffer& rStr, sal_Int16 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
258 static void appendDec( OUStringBuffer& rStr, sal_uInt32 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
259 static void appendDec( OUStringBuffer& rStr, sal_Int32 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
260 static void appendDec( OUStringBuffer& rStr, sal_uInt64 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
261 static void appendDec( OUStringBuffer& rStr, sal_Int64 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
262 static void appendDec( OUStringBuffer& rStr, double fData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
263
264 // append hexadecimal -----------------------------------------------------
265
266 static void appendHex( OUStringBuffer& rStr, sal_uInt8 nData, bool bPrefix = true );
267 static void appendHex( OUStringBuffer& rStr, sal_Int8 nData, bool bPrefix = true );
268 static void appendHex( OUStringBuffer& rStr, sal_uInt16 nData, bool bPrefix = true );
269 static void appendHex( OUStringBuffer& rStr, sal_Int16 nData, bool bPrefix = true );
270 static void appendHex( OUStringBuffer& rStr, sal_uInt32 nData, bool bPrefix = true );
271 static void appendHex( OUStringBuffer& rStr, sal_Int32 nData, bool bPrefix = true );
272 static void appendHex( OUStringBuffer& rStr, sal_uInt64 nData, bool bPrefix = true );
273 static void appendHex( OUStringBuffer& rStr, sal_Int64 nData, bool bPrefix = true );
274 static void appendHex( OUStringBuffer& rStr, double fData, bool bPrefix = true );
275
276 // append shortened hexadecimal -------------------------------------------
277
278 static void appendShortHex( OUStringBuffer& rStr, sal_uInt8 nData, bool bPrefix = true );
279 static void appendShortHex( OUStringBuffer& rStr, sal_Int8 nData, bool bPrefix = true );
280 static void appendShortHex( OUStringBuffer& rStr, sal_uInt16 nData, bool bPrefix = true );
281 static void appendShortHex( OUStringBuffer& rStr, sal_Int16 nData, bool bPrefix = true );
282 static void appendShortHex( OUStringBuffer& rStr, sal_uInt32 nData, bool bPrefix = true );
283 static void appendShortHex( OUStringBuffer& rStr, sal_Int32 nData, bool bPrefix = true );
284 static void appendShortHex( OUStringBuffer& rStr, sal_uInt64 nData, bool bPrefix = true );
285 static void appendShortHex( OUStringBuffer& rStr, sal_Int64 nData, bool bPrefix = true );
286 static void appendShortHex( OUStringBuffer& rStr, double fData, bool bPrefix = true );
287
288 // append binary ----------------------------------------------------------
289
290 static void appendBin( OUStringBuffer& rStr, sal_uInt8 nData, bool bDots = true );
291 static void appendBin( OUStringBuffer& rStr, sal_Int8 nData, bool bDots = true );
292 static void appendBin( OUStringBuffer& rStr, sal_uInt16 nData, bool bDots = true );
293 static void appendBin( OUStringBuffer& rStr, sal_Int16 nData, bool bDots = true );
294 static void appendBin( OUStringBuffer& rStr, sal_uInt32 nData, bool bDots = true );
295 static void appendBin( OUStringBuffer& rStr, sal_Int32 nData, bool bDots = true );
296 static void appendBin( OUStringBuffer& rStr, sal_uInt64 nData, bool bDots = true );
297 static void appendBin( OUStringBuffer& rStr, sal_Int64 nData, bool bDots = true );
298 static void appendBin( OUStringBuffer& rStr, double fData, bool bDots = true );
299
300 // append fixed-point decimal ---------------------------------------------
301
302 template< typename Type >
303 static void appendFix( OUStringBuffer& rStr, Type nData, sal_Int32 nWidth = 0 );
304
305 // append formatted value -------------------------------------------------
306
307 static void appendBool( OUStringBuffer& rStr, bool bData );
308 template< typename Type >
309 static void appendValue( OUStringBuffer& rStr, Type nData, FormatType eFmtType );
310
311 // encoded text output ----------------------------------------------------
312
313 static void appendCChar( OUStringBuffer& rStr, sal_Unicode cChar, bool bPrefix = true );
314 static void appendEncChar( OUStringBuffer& rStr, sal_Unicode cChar, sal_Int32 nCount, bool bPrefix = true );
315 static void appendEncString( OUStringBuffer& rStr, std::u16string_view rData, bool bPrefix = true );
316
317 // token list -------------------------------------------------------------
318
319 static void appendToken( OUStringBuffer& rStr, std::u16string_view rToken, sal_Unicode cSep = OOX_DUMP_LISTSEP );
320
321 static void appendIndex( OUStringBuffer& rStr, sal_Int64 nIdx );
322
323 static std::u16string_view getToken( std::u16string_view rData, sal_Int32& rnPos, sal_Unicode cSep = OOX_DUMP_LISTSEP );
324
325 /** Encloses the passed string with the passed characters. Uses cOpen, if cClose is NUL. */
326 static void enclose( OUStringBuffer& rStr, sal_Unicode cOpen, sal_Unicode cClose = '\0' );
327
328 // string conversion ------------------------------------------------------
329
330 static std::u16string_view trimSpaces( std::u16string_view rStr );
331 static OUString trimTrailingNul( const OUString& rStr );
332
333 static OString convertToUtf8( std::u16string_view rStr );
334 static DataType convertToDataType( std::u16string_view rStr );
335 static FormatType convertToFormatType( std::u16string_view rStr );
336
337 static bool convertFromDec( sal_Int64& ornData, std::u16string_view rData );
338 static bool convertFromHex( sal_Int64& ornData, std::u16string_view rData );
339
340 static bool convertStringToInt( sal_Int64& ornData, std::u16string_view rData );
341 static bool convertStringToDouble( double& orfData, std::u16string_view rData );
342 static bool convertStringToBool( std::u16string_view rData );
343
344 static OUStringPair convertStringToPair( const OUString& rString, sal_Unicode cSep = '=' );
345
346 // string to list conversion ----------------------------------------------
347
348 static void convertStringToStringList( OUStringVector& orVec, std::u16string_view rData, bool bIgnoreEmpty );
349 static void convertStringToIntList( Int64Vector& orVec, std::u16string_view rData, bool bIgnoreEmpty );
350 };
351
352
353 template< typename Type >
354 void StringHelper::appendFix( OUStringBuffer& rStr, Type nData, sal_Int32 nWidth )
355 {
356 appendDec( rStr, static_cast< double >( nData ) / std::pow( 2.0, 4.0 * sizeof( Type ) ), nWidth );
357 }
358
359 template< typename Type >
360 void StringHelper::appendValue( OUStringBuffer& rStr, Type nData, FormatType eFmtType )
361 {
362 switch( eFmtType )
363 {
364 case FORMATTYPE_DEC: appendDec( rStr, nData ); break;
365 case FORMATTYPE_HEX: appendHex( rStr, nData ); break;
366 case FORMATTYPE_SHORTHEX: appendShortHex( rStr, nData ); break;
367 case FORMATTYPE_BIN: appendBin( rStr, nData ); break;
368 case FORMATTYPE_FIX: appendFix( rStr, nData ); break;
369 case FORMATTYPE_BOOL: appendBool( rStr, static_cast<bool>(nData) ); break; // avoid loplugin:pointerbool warning
370 default:;
371 }
372 }
373
374
375 class String : public OUString
376 {
377 public:
378 String() {}
379 /*implicit*/ String( const OUString& rStr ) : OUString( rStr ) {}
380 /*implicit*/ String( const char* pcStr ) : OUString( OUString::createFromAscii( pcStr ? pcStr : "" ) ) {}
381 /*implicit*/ String( sal_Unicode cChar ) : OUString( cChar ) {}
382
383 bool has() const { return getLength() > 0; }
384 OUString operator()( const char* pcDefault ) const { if( has() ) return *this; return String( pcDefault ); }
385 };
386
387 const String EMPTY_STRING;
388
389
390 /** Base class for all dumper classes.
391
392 Derived classes implement the virtual function implIsValid(). It should
393 check all members the other functions rely on. If the function
394 implIsValid() returns true, all references and pointers can be used without
395 further checking.
396
397 Overview of all classes in this header file based on this Base class:
398
399 Base
400 |
401 +----> NameListBase
402 | |
403 | +----> ConstList ------> MultiList
404 | |
405 | +----> FlagsList ------> CombiList
406 | |
407 | +----> UnitConverter
408 |
409 +----> SharedConfigData
410 |
411 +----> Config
412 |
413 +----> Output
414 |
415 +----> StorageIterator
416 |
417 +----> ObjectBase
418 |
419 +----> StorageObjectBase
420 |
421 +----> OutputObjectBase
422 | |
423 | +----> InputObjectBase
424 | |
425 | +----> BinaryStreamObject
426 | |
427 | +----> TextStreamObjectBase
428 | | |
429 | | +----> TextStreamObject
430 | | |
431 | | +----> XmlStreamObject
432 | |
433 | +----> RecordObjectBase
434 | |
435 | +----> SequenceRecordObjectBase
436 |
437 +----> DumperBase
438 */
439 class Base
440 {
441 public:
442 virtual ~Base();
443
444 Base(Base const &) = default;
445 Base(Base &&) = default;
446 Base & operator =(Base const &) = default;
447 Base & operator =(Base &&) = default;
448
449 bool isValid() const { return implIsValid(); }
450 static bool isValid( const std::shared_ptr< Base >& rxBase ) { return rxBase && rxBase->isValid(); }
451
452 protected:
453 Base() {}
454
455 virtual bool implIsValid() const = 0;
456 };
457
458
459 class ConfigItemBase
460 {
461 public:
462 virtual ~ConfigItemBase();
463 void readConfigBlock( TextInputStream& rStrm );
464
465 protected:
466 ConfigItemBase() {}
467
468 virtual void implProcessConfigItemStr(
469 TextInputStream& rStrm,
470 const OUString& rKey,
471 const OUString& rData );
472
473 virtual void implProcessConfigItemInt(
474 TextInputStream& rStrm,
475 sal_Int64 nKey,
476 const OUString& rData );
477
478 void readConfigBlockContents(
479 TextInputStream& rStrm );
480
481 private:
482 enum LineType { LINETYPE_DATA, LINETYPE_END };
483
484 static LineType readConfigLine(
485 TextInputStream& rStrm,
486 OUString& orKey,
487 OUString& orData );
488
489 void processConfigItem(
490 TextInputStream& rStrm,
491 const OUString& rKey,
492 const OUString& rData );
493 };
494
495
496 class SharedConfigData;
497 class Config;
498
499 class NameListBase;
500 typedef std::shared_ptr< NameListBase > NameListRef;
501
502 /** Base class of all classes providing names for specific values (name lists).
503
504 The idea is to provide a unique interface for all different methods to
505 write specific names for any values. This can be enumerations (dedicated
506 names for a subset of values), or names for bits in bit fields. Classes
507 derived from this base class implement the specific behaviour for the
508 desired purpose.
509 */
510 class NameListBase : public Base, public ConfigItemBase
511 {
512 public:
513 typedef ::std::map< sal_Int64, OUString > OUStringMap;
514 typedef OUStringMap::const_iterator const_iterator;
515
516 public:
517 virtual ~NameListBase() override;
518
519 /** Sets a name for the specified key. */
520 void setName( sal_Int64 nKey, const String& rName );
521
522 /** Include all names of the passed list. */
523 void includeList( const NameListRef& rxList );
524
525 /** Returns true, if the map contains an entry for the passed key. */
526 template< typename Type >
527 bool hasName( Type nKey ) const
528 { return maMap.count( static_cast< sal_Int64 >( nKey ) ) != 0; }
529
530 /** Returns the name for the passed key. */
531 template< typename Type >
532 OUString getName( const Config& rCfg, Type nKey ) const
533 { return implGetName( rCfg, static_cast< sal_Int64 >( nKey ) ); }
534
535 /** Returns a display name for the passed double value. */
536 OUString getName( const Config& rCfg, double fValue ) const
537 { return implGetNameDbl( rCfg, fValue ); }
538
539 /** Returns a map iterator pointing to the first contained name. */
540 const_iterator begin() const { return maMap.begin(); }
541 /** Returns a map iterator pointing one past the last contained name. */
542 const_iterator end() const { return maMap.end(); }
543
544 protected:
545 explicit NameListBase( const SharedConfigData& rCfgData ) : mrCfgData( rCfgData ) {}
546
547 virtual bool implIsValid() const override;
548
549 virtual void implProcessConfigItemStr(
550 TextInputStream& rStrm,
551 const OUString& rKey,
552 const OUString& rData ) override;
553
554 virtual void implProcessConfigItemInt(
555 TextInputStream& rStrm,
556 sal_Int64 nKey,
557 const OUString& rData ) override;
558
559 /** Derived classes set the name for the passed key. */
560 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) = 0;
561 /** Derived classes generate and return the name for the passed key. */
562 virtual OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const = 0;
563 /** Derived classes generate and return the name for the passed double value. */
564 virtual OUString implGetNameDbl( const Config& rCfg, double fValue ) const = 0;
565 /** Derived classes insert all names and other settings from the passed list. */
566 virtual void implIncludeList( const NameListBase& rList ) = 0;
567
568 /** Inserts the passed name into the internal map. */
569 void insertRawName( sal_Int64 nKey, const OUString& rName );
570 /** Returns the name for the passed key, or 0, if nothing found. */
571 const OUString* findRawName( sal_Int64 nKey ) const;
572
573 private:
574 /** Includes name lists, given in a comma separated list of names of the lists. */
575 void include( std::u16string_view rListKeys );
576 /** Excludes names from the list, given in a comma separated list of their keys. */
577 void exclude( std::u16string_view rKeys );
578
579 private:
580 OUStringMap maMap;
581 const SharedConfigData& mrCfgData;
582 };
583
584
585 class ConstList : public NameListBase
586 {
587 public:
588 explicit ConstList( const SharedConfigData& rCfgData );
589
590 /** Enables or disables automatic quotation of returned names. */
591 void setQuoteNames( bool bQuoteNames ) { mbQuoteNames = bQuoteNames; }
592
593 protected:
594 virtual void implProcessConfigItemStr(
595 TextInputStream& rStrm,
596 const OUString& rKey,
597 const OUString& rData ) override;
598
599 /** Sets the name for the passed key. */
600 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) override;
601 /** Returns the name for the passed key, or the default name, if key is not contained. */
602 virtual OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const override;
603 /** Returns the name for the passed double value. */
604 virtual OUString implGetNameDbl( const Config& rCfg, double fValue ) const override;
605 /** Inserts all names from the passed list. */
606 virtual void implIncludeList( const NameListBase& rList ) override;
607
608 private:
609 OUString maDefName;
610 bool mbQuoteNames;
611 };
612
613
614 class MultiList : public ConstList
615 {
616 public:
617 explicit MultiList( const SharedConfigData& rCfgData );
618
619 void setNamesFromVec( sal_Int64 nStartKey, const OUStringVector& rNames );
620
621 protected:
622 virtual void implProcessConfigItemStr(
623 TextInputStream& rStrm,
624 const OUString& rKey,
625 const OUString& rData ) override;
626
627 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) override;
628
629 private:
630 bool mbIgnoreEmpty;
631 };
632
633
634 class FlagsList : public NameListBase
635 {
636 public:
637 explicit FlagsList( const SharedConfigData& rCfgData );
638
639 /** Returns the flags to be ignored on output. */
640 sal_Int64 getIgnoreFlags() const { return mnIgnore; }
641 /** Sets flags to be ignored on output. */
642 void setIgnoreFlags( sal_Int64 nIgnore ) { mnIgnore = nIgnore; }
643
644 protected:
645 virtual void implProcessConfigItemStr(
646 TextInputStream& rStrm,
647 const OUString& rKey,
648 const OUString& rData ) override;
649
650 /** Sets the name for the passed key. */
651 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) override;
652 /** Returns the name for the passed key. */
653 virtual OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const override;
654 /** Returns the name for the passed double value. */
655 virtual OUString implGetNameDbl( const Config& rCfg, double fValue ) const override;
656 /** Inserts all flags from the passed list. */
657 virtual void implIncludeList( const NameListBase& rList ) override;
658
659 private:
660 sal_Int64 mnIgnore;
661 };
662
663
664 class CombiList : public FlagsList
665 {
666 public:
667 explicit CombiList( const SharedConfigData& rCfgData );
668
669 protected:
670 /** Sets the name for the passed key. */
671 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) override;
672 /** Returns the name for the passed key. */
673 virtual OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const override;
674 /** Inserts all flags from the passed list. */
675 virtual void implIncludeList( const NameListBase& rList ) override;
676
677 private:
678 struct ExtItemFormatKey
679 {
680 sal_Int64 mnKey;
681 ::std::pair< sal_Int64, sal_Int64 > maFilter;
682 explicit ExtItemFormatKey( sal_Int64 nKey ) : mnKey( nKey ), maFilter( 0, 0 ) {}
683 bool operator<( const ExtItemFormatKey& rRight ) const;
684
685 };
686 struct ExtItemFormat : public ItemFormat
687 {
688 bool mbShiftValue;
689 ExtItemFormat() : mbShiftValue( true ) {}
690 };
691 typedef ::std::map< ExtItemFormatKey, ExtItemFormat > ExtItemFormatMap;
692 ExtItemFormatMap maFmtMap;
693 };
694
695
696 class UnitConverter : public NameListBase
697 {
698 public:
699 explicit UnitConverter( const SharedConfigData& rCfgData );
700
701 void setUnitName( const String& rUnitName ) { maUnitName = rUnitName; }
702 void setFactor( double fFactor ) { mfFactor = fFactor; }
703
704 protected:
705 /** Sets the name for the passed key. */
706 virtual void implSetName( sal_Int64 nKey, const OUString& rName ) override;
707 /** Returns the converted value with appended unit name. */
708 virtual OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const override;
709 /** Returns the converted value with appended unit name. */
710 virtual OUString implGetNameDbl( const Config& rCfg, double fValue ) const override;
711 /** Empty implementation. */
712 virtual void implIncludeList( const NameListBase& rList ) override;
713
714 private:
715 OUString maUnitName;
716 double mfFactor;
717 };
718
719
720 class NameListWrapper
721 {
722 public:
723 NameListWrapper() {}
724 /*implicit*/ NameListWrapper( const OUString& rListName ) : maName( rListName ) {}
725 /*implicit*/ NameListWrapper( const char* pcListName ) : maName( pcListName ) {}
726 /*implicit*/ NameListWrapper( NameListRef xList ) : mxList(std::move( xList )) {}
727
728 bool isEmpty() const { return !mxList && !maName.has(); }
729 const NameListRef & getNameList( const Config& rCfg ) const;
730
731 private:
732 String maName;
733 mutable NameListRef mxList;
734 };
735
736 const NameListWrapper NO_LIST;
737
738
739 class ItemFormatMap
740 {
741 private:
742 ::std::map< sal_Int64, ItemFormat > maMap;
743
744 public:
745 ItemFormatMap() {}
746 explicit ItemFormatMap( const NameListRef& rxNameList ) { insertFormats( rxNameList ); }
747
748 ::std::map< sal_Int64, ItemFormat >::const_iterator end() const { return maMap.end(); }
749 ::std::map< sal_Int64, ItemFormat >::const_iterator find(sal_Int64 nId) const
750 {
751 return maMap.find(nId);
752 }
753
754 void insertFormats( const NameListRef& rxNameList );
755 };
756
757
758 class SharedConfigData : public Base, public ConfigItemBase
759 {
760 public:
761 explicit SharedConfigData(
762 const OUString& rFileName,
763 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
764 StorageRef xRootStrg,
765 OUString aSysFileName );
766
767 virtual ~SharedConfigData() override;
768
769 const css::uno::Reference< css::uno::XComponentContext >& getContext() const { return mxContext; }
770 const StorageRef& getRootStorage() const { return mxRootStrg; }
771 const OUString& getSysFileName() const { return maSysFileName; }
772
773 const OUString* getOption( const OUString& rKey ) const;
774
775 template< typename ListType >
776 std::shared_ptr< ListType > createNameList( const OUString& rListName );
777 void setNameList( const OUString& rListName, const NameListRef& rxList );
778 void eraseNameList( const OUString& rListName );
779 NameListRef getNameList( const OUString& rListName ) const;
780
781 protected:
782 virtual bool implIsValid() const override;
783 virtual void implProcessConfigItemStr(
784 TextInputStream& rStrm,
785 const OUString& rKey,
786 const OUString& rData ) override;
787
788 private:
789 bool readConfigFile( const OUString& rFileUrl );
790 template< typename ListType >
791 void readNameList( TextInputStream& rStrm, const OUString& rListName );
792 void createShortList( std::u16string_view rData );
793 void createUnitConverter( std::u16string_view rData );
794
795 private:
796 typedef ::std::set< OUString > ConfigFileSet;
797 typedef ::std::map< OUString, OUString > ConfigDataMap;
798 typedef ::std::map< OUString, NameListRef > NameListMap;
799
800 css::uno::Reference< css::uno::XComponentContext > mxContext;
801 StorageRef mxRootStrg;
802 OUString maSysFileName;
803 ConfigFileSet maConfigFiles;
804 ConfigDataMap maConfigData;
805 NameListMap maNameLists;
806 OUString maConfigPath;
807 bool mbLoaded;
808 };
809
810
811 template< typename ListType >
812 std::shared_ptr< ListType > SharedConfigData::createNameList( const OUString& rListName )
813 {
814 std::shared_ptr< ListType > xList;
815 if( !rListName.isEmpty() )
816 {
817 xList = std::make_shared<ListType>( *this );
818 setNameList( rListName, xList );
819 }
820 return xList;
821 }
822
823 template< typename ListType >
824 void SharedConfigData::readNameList( TextInputStream& rStrm, const OUString& rListName )
825 {
826 NameListRef xList = createNameList< ListType >( rListName );
827 if( xList )
828 xList->readConfigBlock( rStrm );
829 }
830
831
832 class Config : public Base
833 {
834 public:
835 explicit Config(
836 const char* pcEnvVar,
837 const ::oox::core::FilterBase& rFilter );
838 explicit Config(
839 const char* pcEnvVar,
840 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
841 const StorageRef& rxRootStrg,
842 const OUString& rSysFileName );
843
844 virtual ~Config() override;
845
846 Config(Config const &) = default;
847 Config(Config &&) = default;
848 Config & operator =(Config const &) = default;
849 Config & operator =(Config &&) = default;
850
851 const css::uno::Reference< css::uno::XComponentContext >& getContext() const { return mxCfgData->getContext(); }
852 const StorageRef& getRootStorage() const { return mxCfgData->getRootStorage(); }
853 const OUString& getSysFileName() const { return mxCfgData->getSysFileName(); }
854
855 const OUString& getStringOption( const String& rKey, const OUString& rDefault ) const;
856 bool getBoolOption( const String& rKey, bool bDefault ) const;
857 template< typename Type >
858 Type getIntOption( const String& rKey, Type nDefault ) const;
859
860 bool isDumperEnabled() const;
861 bool isImportEnabled() const;
862
863 template< typename ListType >
864 std::shared_ptr< ListType > createNameList( const String& rListName );
865 void eraseNameList( const String& rListName );
866 NameListRef getNameList( const String& rListName ) const;
867
868 /** Returns the name for the passed key from the passed name list. */
869 template< typename Type >
870 OUString getName( const NameListWrapper& rListWrp, Type nKey ) const;
871 /** Returns true, if the passed name list contains an entry for the passed key. */
872 template< typename Type >
873 bool hasName( const NameListWrapper& rListWrp, Type nKey ) const;
874
875 protected:
876 Config() {}
877 void construct(
878 const char* pcEnvVar,
879 const ::oox::core::FilterBase& rFilter );
880 void construct(
881 const char* pcEnvVar,
882 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
883 const StorageRef& rxRootStrg,
884 const OUString& rSysFileName );
885
886 virtual bool implIsValid() const override;
887 const OUString* implGetOption( const OUString& rKey ) const;
888
889 private:
890 std::shared_ptr< SharedConfigData > mxCfgData;
891 };
892
893 typedef std::shared_ptr< Config > ConfigRef;
894
895
896 template< typename Type >
897 Type Config::getIntOption( const String& rKey, Type nDefault ) const
898 {
899 sal_Int64 nRawData;
900 const OUString* pData = implGetOption( rKey );
901 return (pData && StringHelper::convertStringToInt( nRawData, *pData )) ?
902 static_cast< Type >( nRawData ) : nDefault;
903 }
904
905 template< typename ListType >
906 std::shared_ptr< ListType > Config::createNameList( const String& rListName )
907 {
908 return mxCfgData->createNameList< ListType >( rListName );
909 }
910
911 template< typename Type >
912 OUString Config::getName( const NameListWrapper& rListWrp, Type nKey ) const
913 {
914 const NameListRef& xList = rListWrp.getNameList( *this );
915 return xList ? xList->getName( *this, nKey ) : OOX_DUMP_ERR_NOMAP;
916 }
917
918 template< typename Type >
919 bool Config::hasName( const NameListWrapper& rListWrp, Type nKey ) const
920 {
921 const NameListRef& xList = rListWrp.getNameList( *this );
922 return xList.get() && xList->hasName( nKey );
923 }
924
925
926 class Output : public Base
927 {
928 public:
929 explicit Output(
930 const css::uno::Reference< css::uno::XComponentContext >& rxContext,
931 const OUString& rFileName );
932
933
934 void newLine();
935 void emptyLine( size_t nCount = 1 );
936
937 void incIndent();
938 void decIndent();
939
940 void startTable( sal_Int32 nW1 );
941 void startTable( sal_Int32 nW1, sal_Int32 nW2 );
942 void startTable( sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3, sal_Int32 nW4 );
943 void startTable( size_t nColCount, const sal_Int32* pnColWidths );
944 void tab();
945 void tab( size_t nCol );
946 void endTable();
947
948 void resetItemIndex( sal_Int64 nIdx = 0 );
949 void startItem( const String& rItemName );
950 void contItem();
951 void endItem();
952
953 void startMultiItems();
954 void endMultiItems();
955
956 void writeChar( sal_Unicode cChar, sal_Int32 nCount = 1 );
957 void writeAscii( const char* pcStr );
958 void writeString( std::u16string_view rStr );
959 void writeArray( const sal_uInt8* pnData, std::size_t nSize, sal_Unicode cSep = OOX_DUMP_LISTSEP );
960 void writeBool( bool bData );
961 void writeDateTime( const css::util::DateTime& rDateTime );
962
963 template< typename Type >
964 void writeDec( Type nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' )
965 { StringHelper::appendDec( maLine, nData, nWidth, cFill ); }
966 template< typename Type >
967 void writeHex( Type nData, bool bPrefix = true )
968 { StringHelper::appendHex( maLine, nData, bPrefix ); }
969 template< typename Type >
970 void writeShortHex( Type nData, bool bPrefix = true )
971 { StringHelper::appendShortHex( maLine, nData, bPrefix ); }
972 template< typename Type >
973 void writeBin( Type nData, bool bDots = true )
974 { StringHelper::appendBin( maLine, nData, bDots ); }
975 template< typename Type >
976 void writeFix( Type nData, sal_Int32 nWidth )
977 { StringHelper::appendFix( maLine, nData, nWidth ); }
978 template< typename Type >
979 void writeValue( Type nData, FormatType eFmtType )
980 { StringHelper::appendValue( maLine, nData, eFmtType ); }
981 template< typename Type >
982 void writeName( const Config& rCfg, Type nData, const NameListWrapper& rListWrp )
983 { writeString( rCfg.getName( rListWrp, nData ) ); }
984
985
986 protected:
987 virtual bool implIsValid() const override;
988
989 private:
990 void writeItemName( const String& rItemName );
991
992 private:
993 css::uno::Reference< css::io::XTextOutputStream2 > mxStrm;
994 OUString maIndent;
995 OUStringBuffer maLine;
996 OUString maLastItem;
997 ::std::vector< sal_Int32 >
998 maColPos;
999 size_t mnCol;
1000 size_t mnItemLevel;
1001 size_t mnMultiLevel;
1002 sal_Int64 mnItemIdx;
1003 sal_Int32 mnLastItem;
1004 };
1005
1006 typedef std::shared_ptr< Output > OutputRef;
1007
1008
1009 class IndentGuard
1010 {
1011 public:
1012 explicit IndentGuard( const OutputRef& rxOut ) : mrOut( *rxOut ) { mrOut.incIndent(); }
1013 ~IndentGuard() { mrOut.decIndent(); }
1014 private:
1015 IndentGuard( const IndentGuard& ) = delete;
1016 IndentGuard& operator=( const IndentGuard& ) = delete;
1017 private:
1018 Output& mrOut;
1019 };
1020
1021
1022 class TableGuard
1023 {
1024 public:
1025 explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1 ) :
1026 mrOut( *rxOut ) { mrOut.startTable( nW1 ); }
1027 explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1, sal_Int32 nW2 ) :
1028 mrOut( *rxOut ) { mrOut.startTable( nW1, nW2 ); }
1029 explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3, sal_Int32 nW4 ) :
1030 mrOut( *rxOut ) { mrOut.startTable( nW1, nW2, nW3, nW4 ); }
1031 explicit TableGuard( const OutputRef& rxOut, size_t nColCount,
1032 const sal_Int32* pnColWidths ) :
1033 mrOut( *rxOut ) { mrOut.startTable( nColCount, pnColWidths ); }
1034 ~TableGuard() { mrOut.endTable(); }
1035 void tab( size_t nCol ) { mrOut.tab( nCol ); }
1036 private:
1037 TableGuard( const TableGuard& ) = delete;
1038 TableGuard& operator=( const TableGuard& ) = delete;
1039 private:
1040 Output& mrOut;
1041 };
1042
1043
1044 class ItemGuard
1045 {
1046 public:
1047 explicit ItemGuard( const OutputRef& rxOut, const String& rName ) :
1048 mrOut( *rxOut ) { mrOut.startItem( rName ); }
1049 ~ItemGuard() { mrOut.endItem(); }
1050 void cont() { mrOut.contItem(); }
1051 private:
1052 ItemGuard( const ItemGuard& ) = delete;
1053 ItemGuard& operator=( const ItemGuard& ) = delete;
1054 private:
1055 Output& mrOut;
1056 };
1057
1058
1059 class MultiItemsGuard
1060 {
1061 public:
1062 explicit MultiItemsGuard( const OutputRef& rxOut ) : mrOut( *rxOut ) { mrOut.startMultiItems(); }
1063 ~MultiItemsGuard() { mrOut.endMultiItems(); }
1064 private:
1065 MultiItemsGuard( const MultiItemsGuard& ) = delete;
1066 MultiItemsGuard& operator=( const MultiItemsGuard& ) = delete;
1067 private:
1068 Output& mrOut;
1069 };
1070
1071
1072 class StorageIterator : public Base
1073 {
1074 public:
1075 explicit StorageIterator( StorageRef xStrg );
1076 virtual ~StorageIterator() override;
1077
1078 StorageIterator& operator++();
1079
1080 OUString getName() const;
1081 bool isStream() const;
1082 bool isStorage() const;
1083
1084 private:
1085 virtual bool implIsValid() const override;
1086
1087 private:
1088 StorageRef mxStrg;
1089 OUStringVector maNames;
1090 OUStringVector::const_iterator maIt;
1091 };
1092
1093
1094 class ObjectBase : public Base
1095 {
1096 public:
1097 virtual ~ObjectBase() override;
1098
1099 ObjectBase(ObjectBase const &) = default;
1100 ObjectBase(ObjectBase &&) = default;
1101 ObjectBase & operator =(ObjectBase const &) = default;
1102 ObjectBase & operator =(ObjectBase &&) = default;
1103
1104 const css::uno::Reference< css::uno::XComponentContext >&
1105 getContext() const { return mxConfig->getContext(); }
1106
1107 void dump();
1108
1109
1110 protected:
1111 ObjectBase() {}
1112
1113 void construct( const ConfigRef& rxConfig );
1114 void construct( const ObjectBase& rParent );
1115
1116 virtual bool implIsValid() const override;
1117 virtual void implDump();
1118
1119
1120 Config& cfg() const { return *mxConfig; }
1121
1122 private:
1123 ConfigRef mxConfig;
1124 };
1125
1126 typedef std::shared_ptr< ObjectBase > ObjectRef;
1127
1128
1129 class StorageObjectBase : public ObjectBase
1130 {
1131 protected:
1132 StorageObjectBase() {}
1133
1134 protected:
1135 using ObjectBase::construct;
1136 void construct( const ObjectBase& rParent, const StorageRef& rxStrg, const OUString& rSysPath );
1137 void construct( const ObjectBase& rParent );
1138
1139 virtual bool implIsValid() const override;
1140 virtual void implDump() override;
1141
1142 virtual void implDumpStream(
1143 const css::uno::Reference< css::io::XInputStream >& rxStrm,
1144 const OUString& rStrgPath,
1145 const OUString& rStrmName,
1146 const OUString& rSysFileName );
1147
1148 virtual void implDumpStorage(
1149 const StorageRef& rxStrg,
1150 const OUString& rStrgPath,
1151 const OUString& rSysPath );
1152
1153 virtual void implDumpBaseStream(
1154 const BinaryInputStreamRef& rxStrm,
1155 const OUString& rSysFileName );
1156
1157 void addPreferredStream( const String& rStrmName );
1158 void addPreferredStorage( const String& rStrgPath );
1159
1160 private:
1161 static OUString getSysFileName(
1162 std::u16string_view rStrmName,
1163 std::u16string_view rSysOutPath );
1164
1165 void extractStream(
1166 StorageBase& rStrg,
1167 const OUString& rStrgPath,
1168 const OUString& rStrmName,
1169 const OUString& rSysFileName );
1170 void extractStorage(
1171 const StorageRef& rxStrg,
1172 const OUString& rStrgPath,
1173 const OUString& rSysPath );
1174
1175 void extractItem(
1176 const StorageRef& rxStrg,
1177 const OUString& rStrgPath,
1178 const OUString& rItemName,
1179 std::u16string_view rSysPath,
1180 bool bIsStrg, bool bIsStrm );
1181
1182 private:
1183 struct PreferredItem
1184 {
1185 OUString maName;
1186 bool mbStorage;
1187
1188 explicit PreferredItem( OUString aName, bool bStorage ) :
1189 maName(std::move( aName )), mbStorage( bStorage ) {}
1190 };
1191 typedef ::std::vector< PreferredItem > PreferredItemVector;
1192
1193 StorageRef mxStrg;
1194 OUString maSysPath;
1195 PreferredItemVector maPreferred;
1196 };
1197
1198
1199 class OutputObjectBase : public ObjectBase
1200 {
1201 public:
1202 virtual ~OutputObjectBase() override;
1203
1204 OutputObjectBase(OutputObjectBase const &) = default;
1205 OutputObjectBase(OutputObjectBase &&) = default;
1206 OutputObjectBase & operator =(OutputObjectBase const &) = default;
1207 OutputObjectBase & operator =(OutputObjectBase &&) = default;
1208
1209 protected:
1210 OutputObjectBase() {}
1211
1212 using ObjectBase::construct;
1213 void construct( const ObjectBase& rParent, const OUString& rSysFileName );
1214 void construct( const OutputObjectBase& rParent );
1215
1216 virtual bool implIsValid() const override;
1217
1218
1219 void writeEmptyItem( const String& rName );
1220 void writeInfoItem( const String& rName, const String& rData );
1221 void writeCharItem( const String& rName, sal_Unicode cData );
1222 void writeStringItem( const String& rName, std::u16string_view rData );
1223 void writeArrayItem( const String& rName, const sal_uInt8* pnData, std::size_t nSize, sal_Unicode cSep = OOX_DUMP_LISTSEP );
1224 void writeDateTimeItem( const String& rName, const css::util::DateTime& rDateTime );
1225 void writeGuidItem( const String& rName, const OUString& rGuid );
1226
1227 template< typename Type >
1228 void addNameToItem( Type nData, const NameListWrapper& rListWrp );
1229
1230 template< typename Type >
1231 void writeNameItem( const String& rName, Type nData, const NameListWrapper& rListWrp );
1232 template< typename Type >
1233 void writeDecItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1234 template< typename Type >
1235 void writeHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1236 template< typename Type >
1237 void writeShortHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1238 template< typename Type >
1239 void writeBinItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1240 template< typename Type >
1241 void writeFixItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1242 template< typename Type >
1243 void writeDecBoolItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
1244 template< typename Type >
1245 void writeValueItem( const String& rName, Type nData, FormatType eFmtType, const NameListWrapper& rListWrp = NO_LIST );
1246
1247 template< typename Type >
1248 void writeValueItem( const ItemFormat& rItemFmt, Type nData );
1249
1250 template< typename Type >
1251 void writeDecPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep = ',' );
1252 template< typename Type >
1253 void writeHexPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep = ',' );
1254
1255 protected:
1256 OutputRef mxOut;
1257 OUString maSysFileName;
1258 };
1259
1260
1261 template< typename Type >
1262 void OutputObjectBase::addNameToItem( Type nData, const NameListWrapper& rListWrp )
1263 {
1264 if( !rListWrp.isEmpty() )
1265 {
1266 mxOut->contItem();
1267 mxOut->writeName( cfg(), nData, rListWrp );
1268 }
1269 }
1270
1271 template< typename Type >
1272 void OutputObjectBase::writeNameItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1273 {
1274 ItemGuard aItem( mxOut, rName );
1275 mxOut->writeName( cfg(), nData, rListWrp );
1276 }
1277
1278 template< typename Type >
1279 void OutputObjectBase::writeDecItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1280 {
1281 ItemGuard aItem( mxOut, rName );
1282 mxOut->writeDec( nData );
1283 addNameToItem( nData, rListWrp );
1284 }
1285
1286 template< typename Type >
1287 void OutputObjectBase::writeHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1288 {
1289 ItemGuard aItem( mxOut, rName );
1290 mxOut->writeHex( nData );
1291 addNameToItem( nData, rListWrp );
1292 }
1293
1294 template< typename Type >
1295 void OutputObjectBase::writeShortHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1296 {
1297 ItemGuard aItem( mxOut, rName );
1298 mxOut->writeShortHex( nData );
1299 addNameToItem( nData, rListWrp );
1300 }
1301
1302 template< typename Type >
1303 void OutputObjectBase::writeBinItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1304 {
1305 ItemGuard aItem( mxOut, rName );
1306 mxOut->writeBin( nData );
1307 addNameToItem( nData, rListWrp );
1308 }
1309
1310 template< typename Type >
1311 void OutputObjectBase::writeFixItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1312 {
1313 ItemGuard aItem( mxOut, rName );
1314 mxOut->writeFix( nData );
1315 addNameToItem( nData, rListWrp );
1316 }
1317
1318 template< typename Type >
1319 void OutputObjectBase::writeDecBoolItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
1320 {
1321 ItemGuard aItem( mxOut, rName );
1322 mxOut->writeDec( nData );
1323 aItem.cont();
1324 mxOut->writeBool( nData != 0 );
1325 addNameToItem( nData, rListWrp );
1326 }
1327
1328 template< typename Type >
1329 void OutputObjectBase::writeValueItem( const String& rName, Type nData, FormatType eFmtType, const NameListWrapper& rListWrp )
1330 {
1331 if( eFmtType == FORMATTYPE_BOOL )
1332 writeDecBoolItem( rName, nData, rListWrp );
1333 else
1334 {
1335 ItemGuard aItem( mxOut, rName );
1336 mxOut->writeValue( nData, eFmtType );
1337 addNameToItem( nData, rListWrp );
1338 }
1339 }
1340
1341 template< typename Type >
1342 void OutputObjectBase::writeValueItem( const ItemFormat& rItemFmt, Type nData )
1343 {
1344 OString aNameUtf8 = StringHelper::convertToUtf8( rItemFmt.maItemName );
1345 writeValueItem( aNameUtf8.getStr(), nData, rItemFmt.meFmtType, rItemFmt.maListName );
1346 }
1347
1348 template< typename Type >
1349 void OutputObjectBase::writeDecPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep )
1350 {
1351 ItemGuard aItem( mxOut, rName );
1352 mxOut->writeDec( nData1 );
1353 mxOut->writeChar( cSep );
1354 mxOut->writeDec( nData2 );
1355 }
1356
1357 template< typename Type >
1358 void OutputObjectBase::writeHexPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep )
1359 {
1360 ItemGuard aItem( mxOut, rName );
1361 mxOut->writeHex( nData1 );
1362 mxOut->writeChar( cSep );
1363 mxOut->writeHex( nData2 );
1364 }
1365
1366
1367 class InputObjectBase : public OutputObjectBase
1368 {
1369 public:
1370 virtual ~InputObjectBase() override;
1371
1372 InputObjectBase(InputObjectBase const &) = default;
1373 InputObjectBase(InputObjectBase &&) = default;
1374 InputObjectBase & operator =(InputObjectBase const &) = default;
1375 InputObjectBase & operator =(InputObjectBase &&) = default;
1376
1377 protected:
1378 InputObjectBase() {}
1379
1380 using OutputObjectBase::construct;
1381 void construct( const ObjectBase& rParent, const BinaryInputStreamRef& rxStrm, const OUString& rSysFileName );
1382 void construct( const OutputObjectBase& rParent, const BinaryInputStreamRef& rxStrm );
1383 void construct( const InputObjectBase& rParent );
1384
1385 virtual bool implIsValid() const override;
1386
1387 void skipBlock( sal_Int64 nBytes, bool bShowSize = true );
1388 void dumpRawBinary( sal_Int64 nBytes, bool bShowOffset, bool bStream = false );
1389
1390 void dumpBinary( const String& rName, sal_Int64 nBytes, bool bShowOffset = true );
1391 void dumpRemaining( sal_Int64 nBytes );
1392 void dumpRemainingTo( sal_Int64 nPos );
1393 void dumpRemainingStream();
1394
1395 void dumpArray( const String& rName, sal_Int32 nBytes, sal_Unicode cSep = OOX_DUMP_LISTSEP );
1396 void dumpUnused( sal_Int32 nBytes ) { dumpArray( OOX_DUMP_UNUSED, nBytes ); }
1397 void dumpUnknown( sal_Int32 nBytes ) { dumpArray( OOX_DUMP_UNKNOWN, nBytes ); }
1398
1399 sal_Unicode dumpUnicode( const String& rName );
1400
1401 OUString dumpCharArray( const String& rName, sal_Int32 nLen, rtl_TextEncoding eTextEnc, bool bHideTrailingNul = false );
1402 OUString dumpUnicodeArray( const String& rName, sal_Int32 nLen, bool bHideTrailingNul = false );
1403
1404 css::util::DateTime dumpFileTime( const String& rName = EMPTY_STRING );
1405 OUString dumpGuid( const String& rName = EMPTY_STRING );
1406
1407 void dumpItem( const ItemFormat& rItemFmt );
1408
1409 template< typename Type >
1410 Type dumpName( const String& rName, const NameListWrapper& rListWrp );
1411 template< typename Type >
1412 Type dumpDec( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1413 template< typename Type >
1414 Type dumpHex( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1415 template< typename Type >
1416 Type dumpBin( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1417 template< typename Type >
1418 Type dumpFix( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1419 template< typename Type >
1420 Type dumpBool( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1421 template< typename Type >
1422 Type dumpValue( const ItemFormat& rItemFmt );
1423
1424 template< typename Type1, typename Type2 >
1425 Type1 dumpName( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1426 template< typename Type1, typename Type2 >
1427 Type1 dumpDec( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1428 template< typename Type1, typename Type2 >
1429 Type1 dumpHex( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1430 template< typename Type1, typename Type2 >
1431 Type1 dumpBin( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1432 template< typename Type1, typename Type2 >
1433 Type1 dumpFix( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1434 template< typename Type1, typename Type2 >
1435 Type1 dumpBool( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
1436 template< typename Type1, typename Type2 >
1437 Type1 dumpValue( bool bType1, const ItemFormat& rItemFmt );
1438
1439 template< typename Type >
1440 void dumpDecPair( const String& rName, sal_Unicode cSep = ',' );
1441 template< typename Type >
1442 void dumpHexPair( const String& rName, sal_Unicode cSep = ',' );
1443
1444 protected:
1445 BinaryInputStreamRef mxStrm;
1446 };
1447
1448
1449 template< typename Type >
1450 Type InputObjectBase::dumpName( const String& rName, const NameListWrapper& rListWrp )
1451 {
1452 Type nData = mxStrm->readValue<Type>();
1453 writeNameItem( rName, nData, rListWrp );
1454 return nData;
1455 }
1456
1457 template< typename Type >
1458 Type InputObjectBase::dumpDec( const String& rName, const NameListWrapper& rListWrp )
1459 {
1460 Type nData = mxStrm->readValue<Type>();
1461 writeDecItem( rName, nData, rListWrp );
1462 return nData;
1463 }
1464
1465 template< typename Type >
1466 Type InputObjectBase::dumpHex( const String& rName, const NameListWrapper& rListWrp )
1467 {
1468 Type nData = mxStrm->readValue<Type>();
1469 writeHexItem( rName, nData, rListWrp );
1470 return nData;
1471 }
1472
1473 template< typename Type >
1474 Type InputObjectBase::dumpBin( const String& rName, const NameListWrapper& rListWrp )
1475 {
1476 Type nData = mxStrm->readValue<Type>();
1477 writeBinItem( rName, nData, rListWrp );
1478 return nData;
1479 }
1480
1481 template< typename Type >
1482 Type InputObjectBase::dumpFix( const String& rName, const NameListWrapper& rListWrp )
1483 {
1484 Type nData = mxStrm->readValue<Type>();
1485 writeFixItem( rName, nData, rListWrp );
1486 return nData;
1487 }
1488
1489 template< typename Type >
1490 Type InputObjectBase::dumpBool( const String& rName, const NameListWrapper& rListWrp )
1491 {
1492 Type nData = mxStrm->readValue<Type>();
1493 writeDecBoolItem( rName, nData, rListWrp );
1494 return nData;
1495 }
1496
1497 template< typename Type >
1498 Type InputObjectBase::dumpValue( const ItemFormat& rItemFmt )
1499 {
1500 Type nData = mxStrm->readValue<Type>();
1501 writeValueItem( rItemFmt, nData );
1502 return nData;
1503 }
1504
1505 template< typename Type1, typename Type2 >
1506 Type1 InputObjectBase::dumpName( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1507 {
1508 return bType1 ? dumpName< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpName< Type2 >( rName, rListWrp ) );
1509 }
1510
1511 template< typename Type1, typename Type2 >
1512 Type1 InputObjectBase::dumpDec( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1513 {
1514 return bType1 ? dumpDec< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpDec< Type2 >( rName, rListWrp ) );
1515 }
1516
1517 template< typename Type1, typename Type2 >
1518 Type1 InputObjectBase::dumpHex( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1519 {
1520 return bType1 ? dumpHex< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpHex< Type2 >( rName, rListWrp ) );
1521 }
1522
1523 template< typename Type1, typename Type2 >
1524 Type1 InputObjectBase::dumpBin( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1525 {
1526 return bType1 ? dumpBin< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpBin< Type2 >( rName, rListWrp ) );
1527 }
1528
1529 template< typename Type1, typename Type2 >
1530 Type1 InputObjectBase::dumpFix( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1531 {
1532 return bType1 ? dumpFix< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpFix< Type2 >( rName, rListWrp ) );
1533 }
1534
1535 template< typename Type1, typename Type2 >
1536 Type1 InputObjectBase::dumpBool( bool bType1, const String& rName, const NameListWrapper& rListWrp )
1537 {
1538 return bType1 ? dumpBool< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpBool< Type2 >( rName, rListWrp ) );
1539 }
1540
1541 template< typename Type1, typename Type2 >
1542 Type1 InputObjectBase::dumpValue( bool bType1, const ItemFormat& rItemFmt )
1543 {
1544 return bType1 ? dumpValue< Type1 >( rItemFmt ) : static_cast< Type1 >( dumpValue< Type2 >( rItemFmt ) );
1545 }
1546
1547 template< typename Type >
1548 void InputObjectBase::dumpDecPair( const String& rName, sal_Unicode cSep )
1549 {
1550 Type nData1, nData2;
1551 *mxStrm >> nData1 >> nData2;
1552 writeDecPairItem( rName, nData1, nData2, cSep );
1553 }
1554
1555 template< typename Type >
1556 void InputObjectBase::dumpHexPair( const String& rName, sal_Unicode cSep )
1557 {
1558 Type nData1, nData2;
1559 *mxStrm >> nData1 >> nData2;
1560 writeHexPairItem( rName, nData1, nData2, cSep );
1561 }
1562
1563
1564 class BinaryStreamObject final : public InputObjectBase
1565 {
1566 public:
1567 explicit BinaryStreamObject(
1568 const ObjectBase& rParent,
1569 const BinaryInputStreamRef& rxStrm,
1570 const OUString& rSysFileName );
1571
1572 private:
1573 void dumpBinaryStream( bool bShowOffset = true );
1574
1575 virtual void implDump() override;
1576 };
1577
1578
1579 class TextStreamObjectBase : public InputObjectBase
1580 {
1581 protected:
1582 TextStreamObjectBase() {}
1583
1584 using InputObjectBase::construct;
1585 void construct(
1586 const ObjectBase& rParent,
1587 const BinaryInputStreamRef& rxStrm,
1588 rtl_TextEncoding eTextEnc,
1589 const OUString& rSysFileName );
1590 void construct(
1591 const OutputObjectBase& rParent,
1592 const BinaryInputStreamRef& rxStrm,
1593 rtl_TextEncoding eTextEnc );
1594
1595 virtual bool implIsValid() const override;
1596 virtual void implDump() override;
1597
1598 virtual void implDumpText( TextInputStream& rTextStrm ) = 0;
1599
1600 private:
1601 void constructTextStrmObj( rtl_TextEncoding eTextEnc );
1602
1603 std::shared_ptr< TextInputStream > mxTextStrm;
1604 };
1605
1606
1607 class TextLineStreamObject final : public TextStreamObjectBase
1608 {
1609 public:
1610 explicit TextLineStreamObject(
1611 const ObjectBase& rParent,
1612 const BinaryInputStreamRef& rxStrm,
1613 rtl_TextEncoding eTextEnc,
1614 const OUString& rSysFileName );
1615
1616 explicit TextLineStreamObject(
1617 const OutputObjectBase& rParent,
1618 const BinaryInputStreamRef& rxStrm,
1619 rtl_TextEncoding eTextEnc );
1620
1621 private:
1622 virtual void implDumpText( TextInputStream& rTextStrm ) override;
1623 void implDumpLine( std::u16string_view rLine, sal_uInt32 nLine );
1624 };
1625
1626
1627 class XmlStreamObject : public TextStreamObjectBase
1628 {
1629 public:
1630 explicit XmlStreamObject(
1631 const ObjectBase& rParent,
1632 const BinaryInputStreamRef& rxStrm,
1633 const OUString& rSysFileName );
1634
1635 protected:
1636 virtual void implDumpText( TextInputStream& rTextStrm ) override;
1637 };
1638
1639
1640 class RecordObjectBase : public InputObjectBase
1641 {
1642 protected:
1643 RecordObjectBase() {}
1644
1645 using InputObjectBase::construct;
1646 void construct(
1647 const ObjectBase& rParent,
1648 const BinaryInputStreamRef& rxBaseStrm,
1649 const OUString& rSysFileName,
1650 const BinaryInputStreamRef& rxRecStrm,
1651 const String& rRecNames,
1652 const String& rSimpleRecs );
1653
1654 sal_Int64 getRecId() const { return mnRecId; }
1655 sal_Int64 getRecSize() const { return mnRecSize; }
1656
1657 virtual bool implIsValid() const override;
1658 virtual void implDump() override;
1659
1660 virtual bool implStartRecord( BinaryInputStream& rBaseStrm, sal_Int64& ornRecPos, sal_Int64& ornRecId, sal_Int64& ornRecSize ) = 0;
1661 virtual void implWriteExtHeader();
1662 virtual void implDumpRecordBody();
1663
1664 private:
1665 void constructRecObjBase(
1666 const BinaryInputStreamRef& rxBaseStrm,
1667 const String& rRecNames,
1668 const String& rSimpleRecs );
1669
1670 void writeHeader();
1671
1672 private:
1673 BinaryInputStreamRef mxBaseStrm;
1674 NameListWrapper maRecNames;
1675 NameListWrapper maSimpleRecs;
1676 sal_Int64 mnRecPos;
1677 sal_Int64 mnRecId;
1678 sal_Int64 mnRecSize;
1679 bool mbShowRecPos;
1680 bool mbBinaryOnly;
1681 };
1682
1683
1684 class SequenceRecordObjectBase : public RecordObjectBase
1685 {
1686 protected:
1687 SequenceRecordObjectBase() : mxRecData( std::make_shared<StreamDataSequence>() ) {}
1688
1689 using RecordObjectBase::construct;
1690 void construct(
1691 const ObjectBase& rParent,
1692 const BinaryInputStreamRef& rxBaseStrm,
1693 const OUString& rSysFileName,
1694 const String& rRecNames,
1695 const String& rSimpleRecs );
1696
1697 virtual bool implStartRecord( BinaryInputStream& rBaseStrm, sal_Int64& ornRecPos, sal_Int64& ornRecId, sal_Int64& ornRecSize ) override;
1698 virtual bool implReadRecordHeader( BinaryInputStream& rBaseStrm, sal_Int64& ornRecId, sal_Int64& ornRecSize ) = 0;
1699
1700 private:
1701 std::shared_ptr< StreamDataSequence > mxRecData;
1702 };
1703
1704
1705 /** Base class for a file dumper. Derived classes implement the implDump()
1706 function to add functionality.
1707 */
1708 class DumperBase : public ObjectBase
1709 {
1710 public:
1711 virtual ~DumperBase() override;
1712
1713 bool isImportEnabled() const;
1714
1715 protected:
1716 DumperBase() {}
1717
1718 using ObjectBase::construct;
1719 void construct( const ConfigRef& rxConfig );
1720 };
1721
1722
1723 } // namespace oox::dump
1724
1725 #define OOX_DUMP_FILE( DumperClassName ) \
1726 do { \
1727 DumperClassName aDumper( *this ); \
1728 aDumper.dump(); \
1729 if( !aDumper.isImportEnabled() ) \
1730 return aDumper.isValid(); \
1731 } while( false )
1732
1733 #else // DBG_UTIL
1734
1735 #define OOX_DUMP_FILE( DumperClassName ) (void)0
1736
1737 #endif // DBG_UTIL
1738 #endif
1739
1740 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE