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