MSPUBCollector.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /*
3  * This file is part of the libmspub 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 
10 #ifndef INCLUDED_MSPUBCOLLECTOR_H
11 #define INCLUDED_MSPUBCOLLECTOR_H
12 
13 #include <list>
14 #include <map>
15 #include <set>
16 #include <utility>
17 #include <vector>
18 
19 #include <librevenge/librevenge.h>
20 
21 #include "BorderArtInfo.h"
22 #include "ColorReference.h"
23 #include "EmbeddedFontInfo.h"
24 #include "MSPUBTypes.h"
25 #include "PolygonUtils.h"
26 #include "ShapeInfo.h"
27 #include "ShapeType.h"
28 #include "VerticalAlign.h"
29 
30 namespace libmspub
31 {
32 
33 class Fill;
34 class ShapeGroupElement;
35 class VectorTransformation2D;
36 
37 struct Arrow;
38 struct Coordinate;
39 struct Dash;
40 struct Line;
41 struct Shadow;
42 struct TableInfo;
43 
45 {
46  friend class Fill;
47  friend class ImgFill;
48  friend class SolidFill;
49  friend class GradientFill;
50  friend class PatternFill;
51 public:
52  typedef std::list<ContentChunkReference>::const_iterator ccr_iterator_t;
53 
54  MSPUBCollector(librevenge::RVNGDrawingInterface *painter);
55  virtual ~MSPUBCollector();
56 
57  // collector functions
58  void collectMetaData(const librevenge::RVNGPropertyList &metaData);
59 
60  bool addPage(unsigned seqNum);
61  bool addTextString(const std::vector<TextParagraph> &str, unsigned id);
62  void addTextShape(unsigned stringId, unsigned seqNum);
63  bool addImage(unsigned index, ImgType type, librevenge::RVNGBinaryData img);
64  void setBorderImageOffset(unsigned index, unsigned offset);
65  librevenge::RVNGBinaryData *addBorderImage(ImgType type, unsigned borderArtIndex);
66  void setShapePage(unsigned seqNum, unsigned pageSeqNum);
67 
68  void setNextPage(unsigned seqNum);
69 
70  void setShapeType(unsigned seqNum, ShapeType type);
71  void setShapeCropType(unsigned seqNum, ShapeType cropType);
72  void setShapePictureRecolor(unsigned seqNum, const ColorReference &recolor);
73  void setShapePictureBrightness(unsigned seqNum, int brightness);
74  void setShapePictureContrast(unsigned seqNum, int contrast);
75  void setShapeTableInfo(unsigned seqNum, const TableInfo &ti);
76  void setShapeBorderImageId(unsigned seqNum, unsigned borderImageId);
77  void setShapeCoordinatesInEmu(unsigned seqNum, int xs, int ys, int xe, int ye);
78  void setShapeImgIndex(unsigned seqNum, unsigned index);
79  void setShapeFill(unsigned seqNum, std::shared_ptr<Fill> fill, bool skipIfNotBg);
80  void setShapeDash(unsigned seqNum, const Dash &dash);
81  void setAdjustValue(unsigned seqNum, unsigned index, int adjust);
82  void setShapeRotation(unsigned seqNum, double rotation);
83  void setShapeFlip(unsigned, bool, bool);
84  void setShapeMargins(unsigned seqNum, unsigned left, unsigned top, unsigned right, unsigned bottom);
85  void setShapeBorderPosition(unsigned seqNum, BorderPosition pos);
86  void setShapeCoordinatesRotated90(unsigned seqNum);
87  void setShapeCustomPath(unsigned seqNum,
88  const DynamicCustomShape &shape);
89  void setShapeClipPath(unsigned seqNum, const std::vector<libmspub::Vertex> &clip);
90  void setShapeVerticalTextAlign(unsigned seqNum, VerticalAlign va);
91  void designateMasterPage(unsigned seqNum);
92  void setMasterPage(unsigned pageSeqNum, unsigned masterSeqNum);
93  void setShapeStretchBorderArt(unsigned seqNum);
94  void setShapeShadow(unsigned seqNum, const Shadow &shadow);
95 
96  // Microsoft "Embedded OpenType" ... need to figure out how to convert
97  // this to a sane format and how to get LibreOffice to understand embedded fonts.
98  void addEOTFont(const librevenge::RVNGString &name, const librevenge::RVNGBinaryData &data);
99 
100  void beginGroup();
101  bool endGroup();
102 
103  void setShapeLineBackColor(unsigned seqNum, ColorReference backColor);
104  void addShapeLine(unsigned seqNum, Line line);
105  void setShapeOrder(unsigned seqNum);
106  void setPageBgShape(unsigned pageSeqNum, unsigned seqNum);
107  void setWidthInEmu(unsigned long);
108  void setHeightInEmu(unsigned long);
109  void setShapeNumColumns(unsigned seqNum, unsigned numColumns);
110  void setShapeColumnSpacing(unsigned seqNum, unsigned spacing);
111  void setShapeBeginArrow(unsigned seqNum, const Arrow &arrow);
112  void setShapeEndArrow(unsigned seqNum, const Arrow &arrow);
113 
115  void addFont(std::vector<unsigned char> name);
116 
117  void addDefaultCharacterStyle(const CharacterStyle &style);
118  void addDefaultParagraphStyle(const ParagraphStyle &style);
119  void addPaletteColor(Color);
120  bool setCurrentGroupSeqNum(unsigned seqNum);
121 
122  void useEncodingHeuristic();
123 
124  void setTableCellTextEnds(unsigned textId, const std::vector<unsigned> &ends);
125  void setTextStringOffset(unsigned textId, unsigned offset);
126 
127  bool go();
128 
129  bool hasPage(unsigned seqNum) const;
130 private:
131 
132  struct PageInfo
133  {
134  std::vector<std::shared_ptr<ShapeGroupElement>> m_shapeGroupsOrdered;
136  };
137 
140 
141  librevenge::RVNGDrawingInterface *m_painter;
142  std::list<ContentChunkReference> m_contentChunkReferences;
143  double m_width, m_height;
145  unsigned short m_numPages;
146  std::map<unsigned, std::vector<TextParagraph> > m_textStringsById;
147  std::map<unsigned, PageInfo> m_pagesBySeqNum;
148  std::vector<std::pair<ImgType, librevenge::RVNGBinaryData> > m_images;
149  std::vector<BorderArtInfo> m_borderImages;
150  std::vector<ColorReference> m_textColors;
151  std::vector<std::vector<unsigned char> > m_fonts;
152  std::vector<CharacterStyle> m_defaultCharStyles;
153  std::vector<ParagraphStyle> m_defaultParaStyles;
154  std::map<unsigned, ShapeType> m_shapeTypesBySeqNum;
155  std::vector<Color> m_paletteColors;
156  std::vector<unsigned> m_shapeSeqNumsOrdered;
157  std::map<unsigned, unsigned> m_pageSeqNumsByShapeSeqNum;
158  std::map<unsigned, unsigned> m_bgShapeSeqNumsByPageSeqNum;
159  std::set<unsigned> m_skipIfNotBgSeqNums;
160  std::shared_ptr<ShapeGroupElement> m_currentShapeGroup;
161  std::vector<std::shared_ptr<ShapeGroupElement>> m_topLevelShapes;
162  std::map<unsigned, std::shared_ptr<ShapeGroupElement>> m_groupsBySeqNum;
163  std::list<EmbeddedFontInfo> m_embeddedFonts;
164  std::map<unsigned, ShapeInfo> m_shapeInfosBySeqNum;
165  std::set<unsigned> m_masterPages;
167  std::map<unsigned, unsigned> m_masterPagesByPageSeqNum;
168  std::map<unsigned, std::vector<unsigned> > m_tableCellTextEndsByTextId;
169  std::map<unsigned, unsigned> m_stringOffsetsByTextId;
170  mutable std::vector<bool> m_calculationValuesSeen;
171  std::vector<unsigned> m_pageSeqNumsOrdered;
173  std::vector<unsigned char> m_allText;
174  mutable boost::optional<const char *> m_calculatedEncoding;
175  librevenge::RVNGPropertyList m_metaData;
176 
177  // helper functions
178  std::vector<int> getShapeAdjustValues(const ShapeInfo &info) const;
179  boost::optional<unsigned> getMasterPageSeqNum(unsigned pageSeqNum) const;
180  void setRectCoordProps(Coordinate, librevenge::RVNGPropertyList *) const;
181  boost::optional<std::vector<libmspub::TextParagraph> > getShapeText(const ShapeInfo &info) const;
184  void assignShapesToPages();
185  void writePage(unsigned pageSeqNum) const;
186  void writePageShapes(unsigned pageSeqNum) const;
187  void writePageBackground(unsigned pageSeqNum) const;
188  void writeImage(double x, double y, double height, double width,
189  ImgType type, const librevenge::RVNGBinaryData &blob,
190  boost::optional<Color> oneBitColor) const;
191  bool pageIsMaster(unsigned pageSeqNum) const;
192 
193  std::function<void(void)> paintShape(const ShapeInfo &info, const Coordinate &relativeTo, const VectorTransformation2D &foldedTransform, bool isGroup, const VectorTransformation2D &thisTransform) const;
194  double getCalculationValue(const ShapeInfo &info, unsigned index, bool recursiveEntry, const std::vector<int> &adjustValues) const;
195 
196  librevenge::RVNGPropertyList getCharStyleProps(const CharacterStyle &, boost::optional<unsigned> defaultCharStyleIndex) const;
197  librevenge::RVNGPropertyList getParaStyleProps(const ParagraphStyle &, boost::optional<unsigned> defaultParaStyleIndex) const;
198  double getSpecialValue(const ShapeInfo &info, const CustomShape &shape, int arg, const std::vector<int> &adjustValues) const;
199  void ponderStringEncoding(const std::vector<TextParagraph> &str);
200  const char *getCalculatedEncoding() const;
201 public:
202  static librevenge::RVNGString getColorString(const Color &);
203 };
204 
205 } // namespace libmspub
206 
207 #endif /* INCLUDED_MSPUBCOLLECTOR_H */
208 /* vim:set shiftwidth=2 softtabstop=2 expandtab: */
void setShapeClipPath(unsigned seqNum, const std::vector< libmspub::Vertex > &clip)
Definition: MSPUBCollector.cpp:540
bool addImage(unsigned index, ImgType type, librevenge::RVNGBinaryData img)
Definition: MSPUBCollector.cpp:1914
std::vector< ParagraphStyle > m_defaultParaStyles
Definition: MSPUBCollector.h:153
void addBlackToPaletteIfNecessary()
Definition: MSPUBCollector.cpp:1728
void setShapeBeginArrow(unsigned seqNum, const Arrow &arrow)
Definition: MSPUBCollector.cpp:379
std::map< unsigned, ShapeType > m_shapeTypesBySeqNum
Definition: MSPUBCollector.h:154
void setShapeBorderImageId(unsigned seqNum, unsigned borderImageId)
Definition: MSPUBCollector.cpp:529
void ponderStringEncoding(const std::vector< TextParagraph > &str)
Definition: MSPUBCollector.cpp:1887
std::map< unsigned, std::vector< TextParagraph > > m_textStringsById
Definition: MSPUBCollector.h:146
void writePageBackground(unsigned pageSeqNum) const
Definition: MSPUBCollector.cpp:1803
std::vector< CharacterStyle > m_defaultCharStyles
Definition: MSPUBCollector.h:152
void setBorderImageOffset(unsigned index, unsigned offset)
Definition: MSPUBCollector.cpp:1943
Definition: TableInfo.h:34
Definition: MSPUBTypes.h:199
void setShapeShadow(unsigned seqNum, const Shadow &shadow)
Definition: MSPUBCollector.cpp:515
void setPageBgShape(unsigned pageSeqNum, unsigned seqNum)
Definition: MSPUBCollector.cpp:585
librevenge::RVNGDrawingInterface * m_painter
Definition: MSPUBCollector.h:141
void setNextPage(unsigned seqNum)
Definition: MSPUBCollector.cpp:470
Definition: Arrow.h:30
void writeImage(double x, double y, double height, double width, ImgType type, const librevenge::RVNGBinaryData &blob, boost::optional< Color > oneBitColor) const
Definition: MSPUBCollector.cpp:1315
void setShapeMargins(unsigned seqNum, unsigned left, unsigned top, unsigned right, unsigned bottom)
Definition: MSPUBCollector.cpp:580
void setShapeColumnSpacing(unsigned seqNum, unsigned spacing)
Definition: MSPUBCollector.cpp:409
std::vector< BorderArtInfo > m_borderImages
Definition: MSPUBCollector.h:149
std::vector< std::vector< unsigned char > > m_fonts
Definition: MSPUBCollector.h:151
void addDefaultParagraphStyle(const ParagraphStyle &style)
Definition: MSPUBCollector.cpp:1487
Definition: MSPUBCollector.h:132
librevenge::RVNGPropertyList getParaStyleProps(const ParagraphStyle &, boost::optional< unsigned > defaultParaStyleIndex) const
Definition: MSPUBCollector.cpp:1538
librevenge::RVNGBinaryData * addBorderImage(ImgType type, unsigned borderArtIndex)
Definition: MSPUBCollector.cpp:1932
Definition: Fill.h:22
void setAdjustValue(unsigned seqNum, unsigned index, int adjust)
Definition: MSPUBCollector.cpp:1477
void setTextStringOffset(unsigned textId, unsigned offset)
Definition: MSPUBCollector.cpp:498
void setRectCoordProps(Coordinate, librevenge::RVNGPropertyList *) const
Definition: MSPUBCollector.cpp:420
Definition: PolygonUtils.h:92
void setShapeNumColumns(unsigned seqNum, unsigned numColumns)
Definition: MSPUBCollector.cpp:403
boost::optional< std::vector< libmspub::TextParagraph > > getShapeText(const ShapeInfo &info) const
Definition: MSPUBCollector.cpp:648
void setShapeRotation(unsigned seqNum, double rotation)
Definition: MSPUBCollector.cpp:1461
void writePage(unsigned pageSeqNum) const
Definition: MSPUBCollector.cpp:1764
Definition: Fill.h:35
std::set< unsigned > m_skipIfNotBgSeqNums
Definition: MSPUBCollector.h:159
void addTextShape(unsigned stringId, unsigned seqNum)
Definition: MSPUBCollector.cpp:1503
void designateMasterPage(unsigned seqNum)
Definition: MSPUBCollector.cpp:1979
bool m_heightSet
Definition: MSPUBCollector.h:144
void setShapeCropType(unsigned seqNum, ShapeType cropType)
Definition: MSPUBCollector.cpp:1989
Definition: Fill.h:51
BorderPosition
Definition: MSPUBTypes.h:26
Definition: ColorReference.h:19
void setShapeFill(unsigned seqNum, std::shared_ptr< Fill > fill, bool skipIfNotBg)
Definition: MSPUBCollector.cpp:1519
boost::optional< unsigned > getMasterPageSeqNum(unsigned pageSeqNum) const
Definition: MSPUBCollector.cpp:1753
void setMasterPage(unsigned pageSeqNum, unsigned masterSeqNum)
Definition: MSPUBCollector.cpp:1984
void setShapeCoordinatesRotated90(unsigned seqNum)
Definition: MSPUBCollector.cpp:524
bool m_widthSet
Definition: MSPUBCollector.h:144
bool setCurrentGroupSeqNum(unsigned seqNum)
Definition: MSPUBCollector.cpp:590
void setShapeCustomPath(unsigned seqNum, const DynamicCustomShape &shape)
Definition: MSPUBCollector.cpp:534
bool m_encodingHeuristic
Definition: MSPUBCollector.h:172
Definition: Dash.h:49
void addEOTFont(const librevenge::RVNGString &name, const librevenge::RVNGBinaryData &data)
Definition: MSPUBCollector.cpp:356
std::map< unsigned, std::vector< unsigned > > m_tableCellTextEndsByTextId
Definition: MSPUBCollector.h:168
void useEncodingHeuristic()
Definition: MSPUBCollector.cpp:510
void setShapeStretchBorderArt(unsigned seqNum)
Definition: MSPUBCollector.cpp:415
std::list< EmbeddedFontInfo > m_embeddedFonts
Definition: MSPUBCollector.h:163
Definition: Fill.h:75
virtual ~MSPUBCollector()
Definition: MSPUBCollector.cpp:1457
std::map< unsigned, std::shared_ptr< ShapeGroupElement > > m_groupsBySeqNum
Definition: MSPUBCollector.h:162
void setShapeEndArrow(unsigned seqNum, const Arrow &arrow)
Definition: MSPUBCollector.cpp:391
void addDefaultCharacterStyle(const CharacterStyle &style)
Definition: MSPUBCollector.cpp:1482
Definition: Coordinate.h:17
std::vector< std::shared_ptr< ShapeGroupElement > > m_shapeGroupsOrdered
Definition: MSPUBCollector.h:134
bool addTextString(const std::vector< TextParagraph > &str, unsigned id)
Definition: MSPUBCollector.cpp:1876
std::map< unsigned, unsigned > m_pageSeqNumsByShapeSeqNum
Definition: MSPUBCollector.h:157
bool addPage(unsigned seqNum)
Definition: MSPUBCollector.cpp:1492
void addTextColor(ColorReference c)
Definition: MSPUBCollector.cpp:1974
static librevenge::RVNGString getColorString(const Color &)
Definition: MSPUBCollector.cpp:1720
std::set< unsigned > m_masterPages
Definition: MSPUBCollector.h:165
std::map< unsigned, unsigned > m_bgShapeSeqNumsByPageSeqNum
Definition: MSPUBCollector.h:158
std::set< unsigned > m_shapesWithCoordinatesRotated90
Definition: MSPUBCollector.h:166
ImgType
Definition: MSPUBTypes.h:213
unsigned short m_numPages
Definition: MSPUBCollector.h:145
void collectMetaData(const librevenge::RVNGPropertyList &metaData)
Definition: MSPUBCollector.cpp:351
void setShapeImgIndex(unsigned seqNum, unsigned index)
Definition: MSPUBCollector.cpp:1508
std::vector< int > getShapeAdjustValues(const ShapeInfo &info) const
Definition: MSPUBCollector.cpp:624
std::shared_ptr< ShapeGroupElement > m_currentShapeGroup
Definition: MSPUBCollector.h:160
std::list< ContentChunkReference > m_contentChunkReferences
Definition: MSPUBCollector.h:142
void addFont(std::vector< unsigned char > name)
Definition: MSPUBCollector.cpp:1533
void setShapePictureBrightness(unsigned seqNum, int brightness)
Definition: MSPUBCollector.cpp:367
void setShapePictureContrast(unsigned seqNum, int contrast)
Definition: MSPUBCollector.cpp:373
void assignShapesToPages()
Definition: MSPUBCollector.cpp:1736
bool hasPage(unsigned seqNum) const
Definition: MSPUBCollector.cpp:575
bool go()
Definition: MSPUBCollector.cpp:1832
MSPUBCollector & operator=(const MSPUBCollector &)
std::vector< bool > m_calculationValuesSeen
Definition: MSPUBCollector.h:170
double getCalculationValue(const ShapeInfo &info, unsigned index, bool recursiveEntry, const std::vector< int > &adjustValues) const
Definition: MSPUBCollector.cpp:1377
std::vector< std::shared_ptr< ShapeGroupElement > > m_topLevelShapes
Definition: MSPUBCollector.h:161
librevenge::RVNGPropertyList m_metaData
Definition: MSPUBCollector.h:175
Definition: MSPUBTypes.h:163
void setShapeCoordinatesInEmu(unsigned seqNum, int xs, int ys, int xe, int ye)
Definition: MSPUBCollector.cpp:1528
const char * getCalculatedEncoding() const
Definition: MSPUBCollector.cpp:1247
PageInfo()
Definition: MSPUBCollector.h:135
double m_width
Definition: MSPUBCollector.h:143
std::map< unsigned, unsigned > m_masterPagesByPageSeqNum
Definition: MSPUBCollector.h:167
Definition: Arrow.h:13
void setShapeBorderPosition(unsigned seqNum, BorderPosition pos)
Definition: MSPUBCollector.cpp:570
Definition: PolygonUtils.h:59
void beginGroup()
Definition: MSPUBCollector.cpp:545
std::vector< unsigned > m_shapeSeqNumsOrdered
Definition: MSPUBCollector.h:156
void setShapePage(unsigned seqNum, unsigned pageSeqNum)
Definition: MSPUBCollector.cpp:1968
boost::optional< const char * > m_calculatedEncoding
Definition: MSPUBCollector.h:174
librevenge::RVNGPropertyList getCharStyleProps(const CharacterStyle &, boost::optional< unsigned > defaultCharStyleIndex) const
Definition: MSPUBCollector.cpp:1621
void setShapeDash(unsigned seqNum, const Dash &dash)
Definition: MSPUBCollector.cpp:1514
void setShapeTableInfo(unsigned seqNum, const TableInfo &ti)
Definition: MSPUBCollector.cpp:397
void addShapeLine(unsigned seqNum, Line line)
Definition: MSPUBCollector.cpp:565
bool pageIsMaster(unsigned pageSeqNum) const
Definition: MSPUBCollector.cpp:1827
void setShapeOrder(unsigned seqNum)
Definition: MSPUBCollector.cpp:601
std::map< unsigned, unsigned > m_stringOffsetsByTextId
Definition: MSPUBCollector.h:169
std::vector< unsigned char > m_allText
Definition: MSPUBCollector.h:173
Definition: VectorTransformation2D.h:25
Definition: MSPUBTypes.h:112
void writePageShapes(unsigned pageSeqNum) const
Definition: MSPUBCollector.cpp:1796
std::vector< std::pair< ImgType, librevenge::RVNGBinaryData > > m_images
Definition: MSPUBCollector.h:148
std::list< ContentChunkReference >::const_iterator ccr_iterator_t
Definition: MSPUBCollector.h:52
void addPaletteColor(Color)
Definition: MSPUBCollector.cpp:610
void setShapePictureRecolor(unsigned seqNum, const ColorReference &recolor)
Definition: MSPUBCollector.cpp:361
void setupShapeStructures(ShapeGroupElement &elt)
Definition: MSPUBCollector.cpp:662
Definition: MSPUBCollector.h:44
void setShapeType(unsigned seqNum, ShapeType type)
Definition: MSPUBCollector.cpp:1472
void setShapeVerticalTextAlign(unsigned seqNum, VerticalAlign va)
Definition: MSPUBCollector.cpp:385
double m_height
Definition: MSPUBCollector.h:143
MSPUBCollector(librevenge::RVNGDrawingInterface *painter)
Definition: MSPUBCollector.cpp:475
std::map< unsigned, PageInfo > m_pagesBySeqNum
Definition: MSPUBCollector.h:147
Definition: Fill.h:63
std::vector< ColorReference > m_textColors
Definition: MSPUBCollector.h:150
VerticalAlign
Definition: VerticalAlign.h:15
Definition: ShapeGroupElement.h:27
double getSpecialValue(const ShapeInfo &info, const CustomShape &shape, int arg, const std::vector< int > &adjustValues) const
Definition: MSPUBCollector.cpp:1337
std::map< unsigned, ShapeInfo > m_shapeInfosBySeqNum
Definition: MSPUBCollector.h:164
void setWidthInEmu(unsigned long)
Definition: MSPUBCollector.cpp:1900
ShapeType
Definition: ShapeType.h:15
Definition: ShapeInfo.h:37
void setHeightInEmu(unsigned long)
Definition: MSPUBCollector.cpp:1907
std::function< void(void)> paintShape(const ShapeInfo &info, const Coordinate &relativeTo, const VectorTransformation2D &foldedTransform, bool isGroup, const VectorTransformation2D &thisTransform) const
Definition: MSPUBCollector.cpp:690
bool endGroup()
Definition: MSPUBCollector.cpp:555
std::vector< Color > m_paletteColors
Definition: MSPUBCollector.h:155
void setTableCellTextEnds(unsigned textId, const std::vector< unsigned > &ends)
Definition: MSPUBCollector.cpp:504
Definition: Line.h:20
Definition: Shadow.h:26
void setShapeFlip(unsigned, bool, bool)
Definition: MSPUBCollector.cpp:1467
void setShapeLineBackColor(unsigned seqNum, ColorReference backColor)
Definition: MSPUBCollector.cpp:1309
std::vector< unsigned > m_pageSeqNumsOrdered
Definition: MSPUBCollector.h:171

Generated for libmspub by doxygen 1.8.14