libwpd_internal.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) 2002 William Lachance (wrlach@gmail.com)
11  * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
12  *
13  * For minor contributions see the git repository.
14  *
15  * Alternatively, the contents of this file may be used under the terms
16  * of the GNU Lesser General Public License Version 2.1 or later
17  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
18  * applicable instead of those above.
19  *
20  * For further information visit http://libwpd.sourceforge.net
21  */
22 
23 /* "This product is not manufactured, approved, or supported by
24  * Corel Corporation or Corel Corporation Limited."
25  */
26 
27 #ifndef LIBWPD_INTERNAL_H
28 #define LIBWPD_INTERNAL_H
29 
30 #include <librevenge/librevenge.h>
31 #include <librevenge-stream/librevenge-stream.h>
32 #include "WPXEncryption.h"
33 
34 /* Various functions/defines that need not/should not be exported externally */
35 
36 #if defined(HAVE_FUNC_ATTRIBUTE_FORMAT)
37 #define WPD_ATTRIBUTE_PRINTF(fmt, arg) __attribute__((format(printf, fmt, arg)))
38 #else
39 #define WPD_ATTRIBUTE_PRINTF(fmt, arg)
40 #endif
41 
42 #ifdef DEBUG
43 namespace libwpd
44 {
45 void debugPrint(const char *format, ...) WPD_ATTRIBUTE_PRINTF(1, 2);
46 }
47 
48 #define WPD_DEBUG_MSG(M) libwpd::debugPrint M
49 #else
50 #define WPD_DEBUG_MSG(M)
51 #endif
52 
53 #define WPD_NUM_ELEMENTS(array) sizeof(array)/sizeof(array[0])
54 
55 namespace libwpd
56 {
58 {
59  void operator()(void *) {}
60 };
61 }
62 
63 // add more of these as needed for byteswapping
64 // (the 8-bit functions are just there to make things consistent)
65 unsigned char readU8(librevenge::RVNGInputStream *input, WPXEncryption *encryption);
66 unsigned short readU16(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false);
67 signed short readS16(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false);
68 unsigned readU32(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false);
69 
70 librevenge::RVNGString readPascalString(librevenge::RVNGInputStream *input, WPXEncryption *encryption);
71 librevenge::RVNGString readCString(librevenge::RVNGInputStream *input, WPXEncryption *encryption);
72 
73 void appendUCS4(librevenge::RVNGString &str, unsigned ucs4);
74 
75 // Various helper structures for the libwpd parser..
76 
77 int extendedCharacterWP6ToUCS4(unsigned char character, unsigned char characterSet,
78  const unsigned **chars);
79 
80 int extendedCharacterWP5ToUCS4(unsigned char character, unsigned char characterSet,
81  const unsigned **chars);
82 
83 int appleWorldScriptToUCS4(unsigned short character, const unsigned **chars);
84 
85 int extendedCharacterWP42ToUCS4(unsigned char character, const unsigned **chars);
86 
87 unsigned short fixedPointToWPUs(const unsigned fixedPointNumber);
88 double fixedPointToDouble(const unsigned fixedPointNumber);
89 double wpuToFontPointSize(const unsigned short wpuNumber);
90 
103  };
104 
108 
110 
112 
113 // ATTRIBUTE bits
114 #define WPX_EXTRA_LARGE_BIT 1
115 #define WPX_VERY_LARGE_BIT 2
116 #define WPX_LARGE_BIT 4
117 #define WPX_SMALL_PRINT_BIT 8
118 #define WPX_FINE_PRINT_BIT 16
119 #define WPX_SUPERSCRIPT_BIT 32
120 #define WPX_SUBSCRIPT_BIT 64
121 #define WPX_OUTLINE_BIT 128
122 #define WPX_ITALICS_BIT 256
123 #define WPX_SHADOW_BIT 512
124 #define WPX_REDLINE_BIT 1024
125 #define WPX_DOUBLE_UNDERLINE_BIT 2048
126 #define WPX_BOLD_BIT 4096
127 #define WPX_STRIKEOUT_BIT 8192
128 #define WPX_UNDERLINE_BIT 16384
129 #define WPX_SMALL_CAPS_BIT 32768
130 #define WPX_BLINK_BIT 65536
131 #define WPX_REVERSEVIDEO_BIT 131072
132 
133 // JUSTIFICATION bits.
134 #define WPX_PARAGRAPH_JUSTIFICATION_LEFT 0x00
135 #define WPX_PARAGRAPH_JUSTIFICATION_FULL 0x01
136 #define WPX_PARAGRAPH_JUSTIFICATION_CENTER 0x02
137 #define WPX_PARAGRAPH_JUSTIFICATION_RIGHT 0x03
138 #define WPX_PARAGRAPH_JUSTIFICATION_FULL_ALL_LINES 0x04
139 #define WPX_PARAGRAPH_JUSTIFICATION_DECIMAL_ALIGNED 0x05
140 
141 // TABLE POSITION bits.
142 #define WPX_TABLE_POSITION_ALIGN_WITH_LEFT_MARGIN 0x00
143 #define WPX_TABLE_POSITION_ALIGN_WITH_RIGHT_MARGIN 0x01
144 #define WPX_TABLE_POSITION_CENTER_BETWEEN_MARGINS 0x02
145 #define WPX_TABLE_POSITION_FULL 0x03
146 #define WPX_TABLE_POSITION_ABSOLUTE_FROM_LEFT_MARGIN 0x04
147 
148 // TABLE CELL BORDER bits
149 const unsigned char WPX_TABLE_CELL_LEFT_BORDER_OFF = 0x01;
150 const unsigned char WPX_TABLE_CELL_RIGHT_BORDER_OFF = 0x02;
151 const unsigned char WPX_TABLE_CELL_TOP_BORDER_OFF = 0x04;
152 const unsigned char WPX_TABLE_CELL_BOTTOM_BORDER_OFF = 0x08;
153 
154 // BREAK bits
155 #define WPX_PAGE_BREAK 0x00
156 #define WPX_SOFT_PAGE_BREAK 0x01
157 #define WPX_COLUMN_BREAK 0x02
158 
159 // Generic bits
160 #define WPX_LEFT 0x00
161 #define WPX_RIGHT 0x01
162 #define WPX_CENTER 0x02
163 #define WPX_TOP 0x03
164 #define WPX_BOTTOM 0x04
165 
166 struct RGBSColor
167 {
168  RGBSColor(unsigned char r, unsigned char g, unsigned char b, unsigned char s);
169  RGBSColor(unsigned short red, unsigned short green, unsigned short blue); // Construct
170  // RBBSColor from double precision RGB color used by WP3.x for Mac
171  RGBSColor(); // initializes all values to 0
172  unsigned char m_r;
173  unsigned char m_g;
174  unsigned char m_b;
175  unsigned char m_s;
176 };
177 
179 {
180  WPXColumnDefinition(); // initializes all values to 0
181  double m_width;
182  double m_leftGutter;
184 };
185 
187 {
189  unsigned m_attributes;
190  unsigned char m_alignment;
191 };
192 
194 {
195  WPXTabStop();
196  double m_position;
199  unsigned char m_leaderNumSpaces;
200 };
201 
202 // Various exceptions: libwpd does not propagate exceptions externally..
203 
205 {
206 };
207 
209 {
210 };
211 
213 {
214 };
215 
217 {
218 };
219 
221 {
222 };
223 
225 {
226 };
227 
229 {
230 };
231 
232 // Various usefull, but cheesey functions
233 
234 int _extractNumericValueFromRoman(const char romanChar);
235 int _extractDisplayReferenceNumberFromBuf(const librevenge::RVNGString &buf, const WPXNumberingType listType);
236 WPXNumberingType _extractWPXNumberingTypeFromBuf(const librevenge::RVNGString &buf, const WPXNumberingType putativeWPXNumberingType);
237 librevenge::RVNGString _numberingTypeToString(WPXNumberingType t);
238 extern const unsigned macRomanCharacterMap[];
239 librevenge::RVNGString doubleToString(const double value);
240 
241 #endif /* LIBWPD_INTERNAL_H */
242 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
Definition: libwpd_internal.h:209
Definition: libwpd_internal.h:217
Definition: libwpd_internal.h:213
Definition: libwpd_internal.h:225
Definition: libwpd_internal.h:221
Definition: libwpd_internal.h:205
Definition: WPXEncryption.h:36
Definition: libwpd_internal.h:229
WPXHeaderFooterOccurrence
Definition: libwpd_internal.h:96
@ NEVER
Definition: libwpd_internal.h:96
@ EVEN
Definition: libwpd_internal.h:96
@ ODD
Definition: libwpd_internal.h:96
@ ALL
Definition: libwpd_internal.h:96
const unsigned char WPX_TABLE_CELL_BOTTOM_BORDER_OFF
Definition: libwpd_internal.h:152
WPXHeaderFooterType
Definition: libwpd_internal.h:94
@ HEADER
Definition: libwpd_internal.h:94
@ FOOTER
Definition: libwpd_internal.h:94
WPXFormOrientation
Definition: libwpd_internal.h:105
@ LANDSCAPE
Definition: libwpd_internal.h:105
@ PORTRAIT
Definition: libwpd_internal.h:105
WPXPageNumberPosition
Definition: libwpd_internal.h:97
@ PAGENUMBER_POSITION_BOTTOM_INSIDE_LEFT_AND_RIGHT
Definition: libwpd_internal.h:102
@ PAGENUMBER_POSITION_BOTTOM_LEFT_AND_RIGHT
Definition: libwpd_internal.h:100
@ PAGENUMBER_POSITION_BOTTOM_LEFT
Definition: libwpd_internal.h:99
@ PAGENUMBER_POSITION_TOP_CENTER
Definition: libwpd_internal.h:97
@ PAGENUMBER_POSITION_TOP_RIGHT
Definition: libwpd_internal.h:98
@ PAGENUMBER_POSITION_TOP_LEFT_AND_RIGHT
Definition: libwpd_internal.h:98
@ PAGENUMBER_POSITION_TOP_LEFT
Definition: libwpd_internal.h:97
@ PAGENUMBER_POSITION_BOTTOM_RIGHT
Definition: libwpd_internal.h:100
@ PAGENUMBER_POSITION_TOP_INSIDE_LEFT_AND_RIGHT
Definition: libwpd_internal.h:101
@ PAGENUMBER_POSITION_NONE
Definition: libwpd_internal.h:97
@ PAGENUMBER_POSITION_BOTTOM_CENTER
Definition: libwpd_internal.h:99
double wpuToFontPointSize(const unsigned short wpuNumber)
Definition: libwpd_internal.cpp:1179
WPXTabAlignment
Definition: libwpd_internal.h:106
@ CENTER
Definition: libwpd_internal.h:106
@ BAR
Definition: libwpd_internal.h:106
@ LEFT
Definition: libwpd_internal.h:106
@ RIGHT
Definition: libwpd_internal.h:106
@ DECIMAL
Definition: libwpd_internal.h:106
const unsigned char WPX_TABLE_CELL_RIGHT_BORDER_OFF
Definition: libwpd_internal.h:150
const unsigned macRomanCharacterMap[]
Definition: libwpd_internal.cpp:1353
int _extractNumericValueFromRoman(const char romanChar)
Definition: libwpd_internal.cpp:1230
WPXFileType
Definition: libwpd_internal.h:91
@ WP6_DOCUMENT
Definition: libwpd_internal.h:91
@ OTHER
Definition: libwpd_internal.h:91
@ WP5_DOCUMENT
Definition: libwpd_internal.h:91
@ WP42_DOCUMENT
Definition: libwpd_internal.h:91
unsigned short fixedPointToWPUs(const unsigned fixedPointNumber)
Definition: libwpd_internal.cpp:1164
signed short readS16(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false)
Definition: libwpd_internal.cpp:134
#define WPD_ATTRIBUTE_PRINTF(fmt, arg)
Definition: libwpd_internal.h:39
WPXNumberingType _extractWPXNumberingTypeFromBuf(const librevenge::RVNGString &buf, const WPXNumberingType putativeWPXNumberingType)
Definition: libwpd_internal.cpp:1303
librevenge::RVNGString _numberingTypeToString(WPXNumberingType t)
Definition: libwpd_internal.cpp:1323
int _extractDisplayReferenceNumberFromBuf(const librevenge::RVNGString &buf, const WPXNumberingType listType)
Definition: libwpd_internal.cpp:1257
WPXTextColumnType
Definition: libwpd_internal.h:109
@ NEWSPAPER_VERTICAL_BALANCE
Definition: libwpd_internal.h:109
@ NEWSPAPER
Definition: libwpd_internal.h:109
@ PARALLEL_PROTECT
Definition: libwpd_internal.h:109
@ PARALLEL
Definition: libwpd_internal.h:109
void appendUCS4(librevenge::RVNGString &str, unsigned ucs4)
Definition: libwpd_internal.cpp:154
librevenge::RVNGString readCString(librevenge::RVNGInputStream *input, WPXEncryption *encryption)
Definition: libwpd_internal.cpp:184
unsigned char readU8(librevenge::RVNGInputStream *input, WPXEncryption *encryption)
Definition: libwpd_internal.cpp:106
librevenge::RVNGString doubleToString(const double value)
Definition: libwpd_internal.cpp:1385
WPXNumberingType
Definition: libwpd_internal.h:92
@ UPPERCASE
Definition: libwpd_internal.h:92
@ UPPERCASE_ROMAN
Definition: libwpd_internal.h:92
@ ARABIC
Definition: libwpd_internal.h:92
@ LOWERCASE_ROMAN
Definition: libwpd_internal.h:92
@ LOWERCASE
Definition: libwpd_internal.h:92
int extendedCharacterWP5ToUCS4(unsigned char character, unsigned char characterSet, const unsigned **chars)
Definition: libwpd_internal.cpp:1018
WPXHeaderFooterInternalType
Definition: libwpd_internal.h:95
@ FOOTER_B
Definition: libwpd_internal.h:95
@ HEADER_B
Definition: libwpd_internal.h:95
@ FOOTER_A
Definition: libwpd_internal.h:95
@ HEADER_A
Definition: libwpd_internal.h:95
@ DUMMY
Definition: libwpd_internal.h:95
WPXSubDocumentType
Definition: libwpd_internal.h:111
@ WPX_SUBDOCUMENT_TEXT_BOX
Definition: libwpd_internal.h:111
@ WPX_SUBDOCUMENT_NOTE
Definition: libwpd_internal.h:111
@ WPX_SUBDOCUMENT_NONE
Definition: libwpd_internal.h:111
@ WPX_SUBDOCUMENT_COMMENT_ANNOTATION
Definition: libwpd_internal.h:111
@ WPX_SUBDOCUMENT_HEADER_FOOTER
Definition: libwpd_internal.h:111
WPXVerticalAlignment
Definition: libwpd_internal.h:107
@ TOP
Definition: libwpd_internal.h:107
@ MIDDLE
Definition: libwpd_internal.h:107
@ BOTTOM
Definition: libwpd_internal.h:107
@ FULL
Definition: libwpd_internal.h:107
int extendedCharacterWP6ToUCS4(unsigned char character, unsigned char characterSet, const unsigned **chars)
Definition: libwpd_internal.cpp:660
const unsigned char WPX_TABLE_CELL_TOP_BORDER_OFF
Definition: libwpd_internal.h:151
double fixedPointToDouble(const unsigned fixedPointNumber)
Definition: libwpd_internal.cpp:1172
unsigned short readU16(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false)
Definition: libwpd_internal.cpp:119
const unsigned char WPX_TABLE_CELL_LEFT_BORDER_OFF
Definition: libwpd_internal.h:149
WPXNoteType
Definition: libwpd_internal.h:93
@ FOOTNOTE
Definition: libwpd_internal.h:93
@ ENDNOTE
Definition: libwpd_internal.h:93
librevenge::RVNGString readPascalString(librevenge::RVNGInputStream *input, WPXEncryption *encryption)
Definition: libwpd_internal.cpp:163
unsigned readU32(librevenge::RVNGInputStream *input, WPXEncryption *encryption, bool bigendian=false)
Definition: libwpd_internal.cpp:139
int extendedCharacterWP42ToUCS4(unsigned char character, const unsigned **chars)
Definition: libwpd_internal.cpp:1151
int appleWorldScriptToUCS4(unsigned short character, const unsigned **chars)
Definition: libwpd_internal.cpp:1409
Definition: libwpd_internal.h:56
Definition: libwpd_internal.h:167
unsigned char m_b
Definition: libwpd_internal.h:174
RGBSColor()
Definition: libwpd_internal.cpp:1192
unsigned char m_r
Definition: libwpd_internal.h:172
unsigned char m_s
Definition: libwpd_internal.h:175
unsigned char m_g
Definition: libwpd_internal.h:173
Definition: libwpd_internal.h:179
double m_leftGutter
Definition: libwpd_internal.h:182
WPXColumnDefinition()
Definition: libwpd_internal.cpp:1216
double m_width
Definition: libwpd_internal.h:181
double m_rightGutter
Definition: libwpd_internal.h:183
Definition: libwpd_internal.h:187
WPXColumnProperties()
Definition: libwpd_internal.cpp:1223
unsigned char m_alignment
Definition: libwpd_internal.h:190
unsigned m_attributes
Definition: libwpd_internal.h:189
Definition: libwpd_internal.h:194
WPXTabStop()
Definition: libwpd_internal.cpp:1208
WPXTabAlignment m_alignment
Definition: libwpd_internal.h:197
double m_position
Definition: libwpd_internal.h:196
unsigned char m_leaderNumSpaces
Definition: libwpd_internal.h:199
unsigned m_leaderCharacter
Definition: libwpd_internal.h:198
Definition: libwpd_internal.h:58
void operator()(void *)
Definition: libwpd_internal.h:59

Generated for libwpd by doxygen 1.9.1