WPXContentListener.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwpd
3  * Version: MPL 2.0 / LGPLv2.1+
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  * Major Contributor(s):
10  * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
11  *
12  * For minor contributions see the git repository.
13  *
14  * Alternatively, the contents of this file may be used under the terms
15  * of the GNU Lesser General Public License Version 2.1 or later
16  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
17  * applicable instead of those above.
18  *
19  * For further information visit http://libwpd.sourceforge.net
20  */
21 
22 /* "This product is not manufactured, approved, or supported by
23  * Corel Corporation or Corel Corporation Limited."
24  */
25 
26 #ifndef WPXCONTENTLISTENER_H
27 #define WPXCONTENTLISTENER_H
28 
29 #include "WPXTable.h"
30 #include "libwpd_internal.h"
31 #include "WPXSubDocument.h"
32 #include "WPXPageSpan.h"
33 #include "WPXListener.h"
34 #include <memory>
35 #include <vector>
36 #include <list>
37 #include <set>
38 
40 {
42  unsigned char m_positionBits;
43  double m_leftOffset;
44  std::vector < WPXColumnDefinition > m_columns;
45  std::vector < WPXColumnProperties > m_columnsProperties;
46 };
47 
49 {
52 
54  double m_fontSize;
55  std::unique_ptr<librevenge::RVNGString> m_fontName;
56  std::unique_ptr<RGBSColor> m_fontColor;
57  std::unique_ptr<RGBSColor> m_highlightColor;
58 
61  unsigned char m_paragraphJustification;
62  unsigned char m_tempParagraphJustification; // TODO: remove this one after the tabs are properly implemented
64 
70 
74 
76 
77  std::vector<unsigned int> m_numRowsToSkip;
91 
92  unsigned m_currentPage;
95 
97  unsigned m_numColumns;
98  std::vector < WPXColumnDefinition > m_textColumns;
100 
104 
109  double m_paragraphMarginLeft; // resulting paragraph margin that is one of the paragraph
110  double m_paragraphMarginRight; // properties
113  double m_leftMarginByPageMarginChange; // part of the margin due to the PAGE margin change
114  double m_rightMarginByPageMarginChange; // inside a page that already has content.
115  double m_sectionMarginLeft; // In multicolumn sections, the above two will be rather interpreted
116  double m_sectionMarginRight; // as section margin change
117  double m_leftMarginByParagraphMarginChange; // part of the margin due to the PARAGRAPH
118  double m_rightMarginByParagraphMarginChange; // margin change (in WP6)
119  double m_leftMarginByTabs; // part of the margin due to the LEFT or LEFT/RIGHT Indent; the
120  double m_rightMarginByTabs; // only part of the margin that is reset at the end of a paragraph
121 
122  double m_listReferencePosition; // position from the left page margin of the list number/bullet
123  double m_listBeginPosition; // position from the left page margin of the beginning of the list
124 
125  double m_paragraphTextIndent; // resulting first line indent that is one of the paragraph properties
126  double m_textIndentByParagraphIndentChange; // part of the indent due to the PARAGRAPH indent (WP6???)
127  double m_textIndentByTabs; // part of the indent due to the "Back Tab" or "Left Tab"
128 
129  unsigned char m_currentListLevel;
130 
132  std::vector<WPXTabStop> m_tabStops;
134 
135  std::set <const WPXSubDocument *> m_subDocuments;
136 
138  bool m_isNote;
140 
141 private:
144 };
145 
147 {
148 protected:
149  WPXContentListener(std::list<WPXPageSpan> &pageList, librevenge::RVNGTextInterface *documentInterface);
150  ~WPXContentListener() override;
151 
152  void startDocument();
153  void startSubDocument();
154  void endDocument();
155  void endSubDocument();
156  void handleSubDocument(const WPXSubDocument *subDocument, WPXSubDocumentType subDocumentType, WPXTableList tableList, unsigned nextTableIndice);
157  void insertBreak(const unsigned char breakType);
158  void lineSpacingChange(const double lineSpacing);
159  void justificationChange(const unsigned char justification);
160 
161  std::unique_ptr<WPXContentParsingState> m_ps; // parse state
162  librevenge::RVNGTextInterface *m_documentInterface;
163  librevenge::RVNGPropertyList m_metaData;
164 
165  virtual void _handleSubDocument(const WPXSubDocument *subDocument, WPXSubDocumentType subDocumentType, WPXTableList tableList, unsigned nextTableIndice) = 0;
166  virtual void _flushText() = 0;
167  virtual void _changeList() = 0;
168 
169  void _openSection();
170  void _closeSection();
171 
172  void _openPageSpan();
173  void _closePageSpan();
174 
175  void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
176  void _getTabStops(librevenge::RVNGPropertyListVector &tabStops);
177  void _appendJustification(librevenge::RVNGPropertyList &propList, int justification);
178  void _resetParagraphState(const bool isListElement=false);
179  virtual void _openParagraph();
180  void _closeParagraph();
181 
182  void _openListElement();
183  void _closeListElement();
184 
185  void _openSpan();
186  void _closeSpan();
187 
188  void _openTable();
189  void _closeTable();
190  void _openTableRow(const double height, const bool isMinimumHeight, const bool isHeaderRow);
191  void _closeTableRow();
192  void _openTableCell(const unsigned char colSpan, const unsigned char rowSpan, const unsigned char borderBits,
193  const RGBSColor *cellFgColor, const RGBSColor *cellBgColor,
194  const RGBSColor *cellBorderColor,
195  const WPXVerticalAlignment cellVerticalAlignment);
196  void _closeTableCell();
197 
198  double _movePositionToFirstColumn(double position);
199 
200  double _getNextTabStop() const;
201  double _getPreviousTabStop() const;
202 
203  void _insertText(const librevenge::RVNGString &textBuffer);
204 
205  void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);
206 
207  void _insertPageNumberParagraph(WPXPageNumberPosition position, WPXNumberingType type, librevenge::RVNGString fontName, double fontSize);
208 
209  unsigned _mapNonUnicodeCharacter(unsigned character);
210 
211 private:
214  librevenge::RVNGString _colorToString(const RGBSColor *color);
215  librevenge::RVNGString _mergeColorsToString(const RGBSColor *fgColor, const RGBSColor *bgColor);
216  unsigned _mapSymbolFontCharacter(unsigned character);
217  unsigned _mapDingbatsFontCharacter(unsigned character);
218 };
219 
220 #endif /* WPXCONTENTLISTENER_H */
221 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WPXNumberingType
Definition: libwpd_internal.h:92
void _openTableCell(const unsigned char colSpan, const unsigned char rowSpan, const unsigned char borderBits, const RGBSColor *cellFgColor, const RGBSColor *cellBgColor, const RGBSColor *cellBorderColor, const WPXVerticalAlignment cellVerticalAlignment)
Definition: WPXContentListener.cpp:1101
unsigned m_textAttributeBits
Definition: WPXContentListener.h:53
librevenge::RVNGString _colorToString(const RGBSColor *color)
Definition: WPXContentListener.cpp:1380
void handleSubDocument(const WPXSubDocument *subDocument, WPXSubDocumentType subDocumentType, WPXTableList tableList, unsigned nextTableIndice)
Creates an new document state.
Definition: WPXContentListener.cpp:1195
double m_listReferencePosition
Definition: WPXContentListener.h:122
double m_leftOffset
Definition: WPXContentListener.h:43
bool m_isSectionOpened
Definition: WPXContentListener.h:67
virtual void _handleSubDocument(const WPXSubDocument *subDocument, WPXSubDocumentType subDocumentType, WPXTableList tableList, unsigned nextTableIndice)=0
WPXContentListener & operator=(const WPXContentListener &)
std::set< const WPXSubDocument * > m_subDocuments
Definition: WPXContentListener.h:135
WPXContentListener(std::list< WPXPageSpan > &pageList, librevenge::RVNGTextInterface *documentInterface)
Definition: WPXContentListener.cpp:126
void _openTableRow(const double height, const bool isMinimumHeight, const bool isHeaderRow)
Definition: WPXContentListener.cpp:999
unsigned m_numPagesRemainingInSpan
Definition: WPXContentListener.h:93
double _getPreviousTabStop() const
Definition: WPXContentListener.cpp:1362
void justificationChange(const unsigned char justification)
Definition: WPXContentListener.cpp:1304
~WPXContentParsingState()
Definition: WPXContentListener.cpp:122
bool m_isTableCellOpened
Definition: WPXContentListener.h:85
void startSubDocument()
Definition: WPXContentListener.cpp:153
double m_pageMarginBottom
Definition: WPXContentListener.h:108
WPXContentParsingState()
Definition: WPXContentListener.cpp:31
std::vector< WPXColumnDefinition > m_textColumns
Definition: WPXContentListener.h:98
void endDocument()
Definition: WPXContentListener.cpp:159
void _resetParagraphState(const bool isListElement=false)
Definition: WPXContentListener.cpp:528
void _openSection()
Definition: WPXContentListener.cpp:193
double m_pageFormWidth
Definition: WPXContentListener.h:102
std::unique_ptr< WPXContentParsingState > m_ps
Definition: WPXContentListener.h:161
void _closeListElement()
Definition: WPXContentListener.cpp:772
unsigned _mapDingbatsFontCharacter(unsigned character)
Definition: WPXContentListener.cpp:1506
bool m_isListElementOpened
Definition: WPXContentListener.h:73
virtual void _changeList()=0
std::vector< WPXColumnDefinition > m_columns
Definition: WPXContentListener.h:44
void _closeSection()
Definition: WPXContentListener.cpp:233
Definition: WPXListener.h:34
WPXTableDefinition m_tableDefinition
Definition: WPXContentListener.h:78
Definition: WPXContentListener.h:39
void _openSpan()
Definition: WPXContentListener.cpp:791
bool m_isHeaderFooterWithoutParagraph
Definition: WPXContentListener.h:69
std::vector< WPXColumnProperties > m_columnsProperties
Definition: WPXContentListener.h:45
bool m_isPageSpanOpened
Definition: WPXContentListener.h:66
void insertBreak(const unsigned char breakType)
Definition: WPXContentListener.cpp:1242
bool m_isSpanOpened
Definition: WPXContentListener.h:71
double m_sectionMarginRight
Definition: WPXContentListener.h:116
std::vector< WPXTabStop > m_tabStops
Definition: WPXContentListener.h:132
int m_currentTableCellNumberInRow
Definition: WPXContentListener.h:81
unsigned char m_tempParagraphJustification
Definition: WPXContentListener.h:62
void _getTabStops(librevenge::RVNGPropertyListVector &tabStops)
Definition: WPXContentListener.cpp:673
virtual void _openParagraph()
Definition: WPXContentListener.cpp:496
double m_pageMarginLeft
Definition: WPXContentListener.h:105
double m_paragraphLineSpacing
Definition: WPXContentListener.h:63
librevenge::RVNGPropertyList m_metaData
Definition: WPXContentListener.h:163
bool m_firstParagraphInPageSpan
Definition: WPXContentListener.h:75
WPXSubDocumentType
Definition: libwpd_internal.h:111
WPXContentParsingState & operator=(const WPXContentParsingState &)
unsigned char m_paragraphJustificationBeforeTable
Definition: WPXContentListener.h:90
void _closeTableCell()
Definition: WPXContentListener.cpp:1172
bool m_isTableOpened
Definition: WPXContentListener.h:82
double m_pageMarginTop
Definition: WPXContentListener.h:107
void _openPageSpan()
Definition: WPXContentListener.cpp:295
unsigned m_currentPageNumber
Definition: WPXContentListener.h:94
unsigned char m_positionBits
Definition: WPXContentListener.h:42
Definition: WPXContentListener.h:146
void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList)
Definition: WPXContentListener.cpp:660
unsigned _mapSymbolFontCharacter(unsigned character)
Definition: WPXContentListener.cpp:1461
Definition: WPXTable.h:79
bool m_isTableRowOpened
Definition: WPXContentListener.h:83
void _openTable()
Definition: WPXContentListener.cpp:911
void _insertText(const librevenge::RVNGString &textBuffer)
Definition: WPXContentListener.cpp:624
double m_textIndentByParagraphIndentChange
Definition: WPXContentListener.h:126
double m_paragraphMarginTop
Definition: WPXContentListener.h:111
double m_paragraphMarginBottom
Definition: WPXContentListener.h:112
double m_leftMarginByPageMarginChange
Definition: WPXContentListener.h:113
Definition: WPXContentListener.h:48
WPXTableDefinition()
Definition: WPXContentListener.h:41
double m_paragraphMarginLeft
Definition: WPXContentListener.h:109
bool m_isParagraphColumnBreak
Definition: WPXContentListener.h:59
double m_listBeginPosition
Definition: WPXContentListener.h:123
void _insertPageNumberParagraph(WPXPageNumberPosition position, WPXNumberingType type, librevenge::RVNGString fontName, double fontSize)
Definition: WPXContentListener.cpp:250
WPXFormOrientation m_pageFormOrientation
Definition: WPXContentListener.h:103
unsigned char m_paragraphJustification
Definition: WPXContentListener.h:61
double m_fontSize
Definition: WPXContentListener.h:54
bool m_isCellWithoutParagraph
Definition: WPXContentListener.h:87
WPXFormOrientation
Definition: libwpd_internal.h:105
unsigned char m_currentListLevel
Definition: WPXContentListener.h:129
bool m_isParagraphOpened
Definition: WPXContentListener.h:72
bool m_isTabPositionRelative
Definition: WPXContentListener.h:133
bool m_isTableColumnOpened
Definition: WPXContentListener.h:84
double m_textIndentByTabs
Definition: WPXContentListener.h:127
double m_rightMarginByParagraphMarginChange
Definition: WPXContentListener.h:118
Definition: WPXSubDocument.h:34
int m_currentTableRow
Definition: WPXContentListener.h:80
bool m_sectionAttributesChanged
Definition: WPXContentListener.h:96
double m_paragraphMarginRight
Definition: WPXContentListener.h:110
WPXVerticalAlignment
Definition: libwpd_internal.h:107
double _movePositionToFirstColumn(double position)
Definition: WPXContentListener.cpp:1430
librevenge::RVNGString _mergeColorsToString(const RGBSColor *fgColor, const RGBSColor *bgColor)
Definition: WPXContentListener.cpp:1399
bool m_isRowWithoutCell
Definition: WPXContentListener.h:88
void _closeTableRow()
Definition: WPXContentListener.cpp:1034
void _closeTable()
Definition: WPXContentListener.cpp:970
double m_sectionMarginLeft
Definition: WPXContentListener.h:115
double m_rightMarginByPageMarginChange
Definition: WPXContentListener.h:114
int m_currentTableCol
Definition: WPXContentListener.h:79
bool m_inSubDocument
Definition: WPXContentListener.h:137
std::vector< unsigned int > m_numRowsToSkip
Definition: WPXContentListener.h:77
unsigned m_numColumns
Definition: WPXContentListener.h:97
unsigned m_currentPage
Definition: WPXContentListener.h:92
void endSubDocument()
Definition: WPXContentListener.cpp:180
void _openListElement()
Definition: WPXContentListener.cpp:742
std::unique_ptr< RGBSColor > m_highlightColor
Definition: WPXContentListener.h:57
double m_pageFormLength
Definition: WPXContentListener.h:101
bool m_wasHeaderRow
Definition: WPXContentListener.h:86
void _appendJustification(librevenge::RVNGPropertyList &propList, int justification)
Definition: WPXContentListener.cpp:556
Definition: libwpd_internal.h:166
double m_rightMarginByTabs
Definition: WPXContentListener.h:120
~WPXContentListener() override
Definition: WPXContentListener.cpp:134
bool m_isNote
Definition: WPXContentListener.h:138
void _closeSpan()
Definition: WPXContentListener.cpp:899
double m_paragraphTextIndent
Definition: WPXContentListener.h:125
std::unique_ptr< RGBSColor > m_fontColor
Definition: WPXContentListener.h:56
double m_leftMarginByTabs
Definition: WPXContentListener.h:119
void _closeParagraph()
Definition: WPXContentListener.cpp:725
WPXPageNumberPosition
Definition: libwpd_internal.h:97
unsigned m_alignmentCharacter
Definition: WPXContentListener.h:131
bool m_isParagraphPageBreak
Definition: WPXContentListener.h:60
virtual void _flushText()=0
double m_pageMarginRight
Definition: WPXContentListener.h:106
std::unique_ptr< librevenge::RVNGString > m_fontName
Definition: WPXContentListener.h:55
void startDocument()
Definition: WPXContentListener.cpp:138
unsigned m_cellAttributeBits
Definition: WPXContentListener.h:89
void lineSpacingChange(const double lineSpacing)
Definition: WPXContentListener.cpp:1296
double _getNextTabStop() const
Definition: WPXContentListener.cpp:1344
bool m_isPageSpanBreakDeferred
Definition: WPXContentListener.h:68
librevenge::RVNGTextInterface * m_documentInterface
Definition: WPXContentListener.h:162
double m_leftMarginByParagraphMarginChange
Definition: WPXContentListener.h:117
void _closePageSpan()
Definition: WPXContentListener.cpp:482
WPXSubDocumentType m_subDocumentType
Definition: WPXContentListener.h:139
bool m_isDocumentStarted
Definition: WPXContentListener.h:65
void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false)
Definition: WPXContentListener.cpp:582
bool m_isTextColumnWithoutParagraph
Definition: WPXContentListener.h:99
unsigned _mapNonUnicodeCharacter(unsigned character)
Definition: WPXContentListener.cpp:1450

Generated for libwpd by doxygen 1.8.14