libwpd_internal.h

Go to the documentation of this file.
00001 /* libwpd
00002  * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
00003  * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
00004  *  
00005  * This library is free software; you can redistribute it and/or
00006  * modify it under the terms of the GNU Library General Public
00007  * License as published by the Free Software Foundation; either
00008  * version 2 of the License, or (at your option) any later version.
00009  *
00010  * This library is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  * Library General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU Library General Public
00016  * License along with this library; if not, write to the Free Software
00017  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
00018  *
00019  * For further information visit http://libwpd.sourceforge.net
00020  */
00021 
00022 /* "This product is not manufactured, approved, or supported by 
00023  * Corel Corporation or Corel Corporation Limited."
00024  */
00025 
00026 #ifndef LIBWPD_INTERNAL_H
00027 #define LIBWPD_INTERNAL_H
00028 #include "WPXStream.h"
00029 #include <stdio.h>
00030 #include <string>
00031 #include "WPXString.h"
00032 
00033 /* Various functions/defines that need not/should not be exported externally */
00034 
00035 #ifdef _MSC_VER
00036 #include <minmax.h>
00037 #define LIBWPD_MIN min
00038 #define LIBWPD_MAX max
00039 #else
00040 #define LIBWPD_MIN std::min
00041 #define LIBWPD_MAX std::max
00042 #endif
00043 
00044 #define WPD_CHECK_FILE_ERROR(v) if (v==EOF) { WPD_DEBUG_MSG(("X_CheckFileError: %d\n", __LINE__)); throw FileException(); }
00045 #define WPD_CHECK_FILE_SEEK_ERROR(v) if (v) { WPD_DEBUG_MSG(("X_CheckFileSeekError: %d\n", __LINE__)); throw FileException(); }
00046 #define WPD_CHECK_FILE_READ_ERROR(v,num_elements) if (v != num_elements) {\
00047  WPD_DEBUG_MSG(("X_CheckFileReadElementError: %d\n", __LINE__)); throw FileException(); }
00048 
00049 #define DELETEP(m) if (m) { delete m; m = NULL; }
00050  
00051 #ifdef DEBUG
00052 #define WPD_DEBUG_MSG(M) printf M
00053 #else
00054 #define WPD_DEBUG_MSG(M)
00055 #endif
00056 
00057 #define WPD_LE_GET_GUINT8(p) (*(uint8_t const *)(p))
00058 #define WPD_LE_GET_GUINT16(p)                             \
00059         (uint16_t)((((uint8_t const *)(p))[0] << 0)  |    \
00060                   (((uint8_t const *)(p))[1] << 8))
00061 #define WPD_LE_GET_GUINT32(p) \
00062         (uint32_t)((((uint8_t const *)(p))[0] << 0)  |    \
00063                   (((uint8_t const *)(p))[1] << 8)  |    \
00064                   (((uint8_t const *)(p))[2] << 16) |    \
00065                   (((uint8_t const *)(p))[3] << 24))
00066 
00067 #define WPD_BE_GET_GUINT8(p) (*(uint8_t const *)(p))
00068 #define WPD_BE_GET_GUINT16(p)                           \
00069         (uint16_t)((((uint8_t const *)(p))[1] << 0)  |    \
00070                   (((uint8_t const *)(p))[0] << 8))
00071 #define WPD_BE_GET_GUINT32(p)                           \
00072         (uint32_t)((((uint8_t const *)(p))[3] << 0)  |    \
00073                   (((uint8_t const *)(p))[2] << 8)  |    \
00074                   (((uint8_t const *)(p))[1] << 16) |    \
00075                   (((uint8_t const *)(p))[0] << 24))
00076 
00077 // add more of these as needed for byteswapping
00078 // (the 8-bit functions are just there to make things consistent)
00079 int8_t read8(WPXInputStream *input); 
00080 uint8_t readU8(WPXInputStream *input); 
00081 uint16_t readU16(WPXInputStream *input, bool bigendian=false);
00082 uint32_t readU32(WPXInputStream *input, bool bigendian=false);
00083 
00084 WPXString readPascalString(WPXInputStream *input);
00085 WPXString readCString(WPXInputStream *input);
00086 
00087 void appendUCS4(WPXString &str, uint32_t ucs4);
00088 
00089 // Various helper structures for the libwpd parser..
00090 
00091 int extendedCharacterWP6ToUCS2(uint8_t character, uint8_t characterSet,
00092                             const uint16_t **chars);
00093 
00094 int extendedCharacterWP5ToUCS2(uint8_t character, uint8_t characterSet,
00095                             const uint16_t **chars);
00096 
00097 uint16_t fixedPointToWPUs(const uint32_t fixedPointNumber);
00098 float fixedPointToFloat(const uint32_t fixedPointNumber);
00099 
00100 enum WPXFileType { WP6_DOCUMENT, WP5_DOCUMENT, WP42_DOCUMENT, OTHER };
00101 enum WPXNumberingType { ARABIC, LOWERCASE, UPPERCASE, LOWERCASE_ROMAN, UPPERCASE_ROMAN };
00102 enum WPXNoteType { FOOTNOTE, ENDNOTE };
00103 enum WPXHeaderFooterType { HEADER, FOOTER };
00104 enum WPXHeaderFooterInternalType { HEADER_A, HEADER_B, FOOTER_A, FOOTER_B, DUMMY };
00105 enum WPXHeaderFooterOccurence { ODD, EVEN, ALL, NEVER };
00106 enum WPXFormOrientation { PORTRAIT, LANDSCAPE };
00107 enum WPXTabAlignment { LEFT, RIGHT, CENTER, DECIMAL, BAR };
00108 enum WPXVerticalAlignment { TOP, MIDDLE, BOTTOM, FULL };
00109 
00110 enum WPXTextColumnType { NEWSPAPER, NEWSPAPER_VERTICAL_BALANCE, PARALLEL, PARALLEL_PROTECT };
00111 
00112 // ATTRIBUTE bits
00113 #define WPX_EXTRA_LARGE_BIT 1
00114 #define WPX_VERY_LARGE_BIT 2
00115 #define WPX_LARGE_BIT 4
00116 #define WPX_SMALL_PRINT_BIT 8
00117 #define WPX_FINE_PRINT_BIT 16
00118 #define WPX_SUPERSCRIPT_BIT 32
00119 #define WPX_SUBSCRIPT_BIT 64
00120 #define WPX_OUTLINE_BIT 128
00121 #define WPX_ITALICS_BIT 256
00122 #define WPX_SHADOW_BIT 512
00123 #define WPX_REDLINE_BIT 1024
00124 #define WPX_DOUBLE_UNDERLINE_BIT 2048
00125 #define WPX_BOLD_BIT 4096
00126 #define WPX_STRIKEOUT_BIT 8192
00127 #define WPX_UNDERLINE_BIT 16384
00128 #define WPX_SMALL_CAPS_BIT 32768
00129 #define WPX_BLINK_BIT 65536
00130 #define WPX_REVERSEVIDEO_BIT 131072
00131 
00132 // JUSTIFICATION bits.
00133 #define WPX_PARAGRAPH_JUSTIFICATION_LEFT 0x00
00134 #define WPX_PARAGRAPH_JUSTIFICATION_FULL 0x01
00135 #define WPX_PARAGRAPH_JUSTIFICATION_CENTER 0x02
00136 #define WPX_PARAGRAPH_JUSTIFICATION_RIGHT 0x03
00137 #define WPX_PARAGRAPH_JUSTIFICATION_FULL_ALL_LINES 0x04
00138 #define WPX_PARAGRAPH_JUSTIFICATION_DECIMAL_ALIGNED 0x05
00139 
00140 // TABLE POSITION bits.
00141 #define WPX_TABLE_POSITION_ALIGN_WITH_LEFT_MARGIN 0x00
00142 #define WPX_TABLE_POSITION_ALIGN_WITH_RIGHT_MARGIN 0x01
00143 #define WPX_TABLE_POSITION_CENTER_BETWEEN_MARGINS 0x02
00144 #define WPX_TABLE_POSITION_FULL 0x03
00145 #define WPX_TABLE_POSITION_ABSOLUTE_FROM_LEFT_MARGIN 0x04
00146 
00147 // TABLE CELL BORDER bits
00148 const uint8_t WPX_TABLE_CELL_LEFT_BORDER_OFF = 0x01;
00149 const uint8_t WPX_TABLE_CELL_RIGHT_BORDER_OFF = 0x02;
00150 const uint8_t WPX_TABLE_CELL_TOP_BORDER_OFF = 0x04;
00151 const uint8_t WPX_TABLE_CELL_BOTTOM_BORDER_OFF = 0x08;
00152 
00153 // BREAK bits
00154 #define WPX_PAGE_BREAK 0x00
00155 #define WPX_SOFT_PAGE_BREAK 0x01
00156 #define WPX_COLUMN_BREAK 0x02
00157 
00158 // Generic bits
00159 #define WPX_LEFT 0x00
00160 #define WPX_RIGHT 0x01
00161 #define WPX_CENTER 0x02
00162 #define WPX_TOP 0x03
00163 #define WPX_BOTTOM 0x04
00164 
00165 typedef struct _RGBSColor RGBSColor;
00166 struct _RGBSColor
00167 {
00168         _RGBSColor(uint8_t r, uint8_t g, uint8_t b, uint8_t s);
00169         _RGBSColor(uint16_t red, uint16_t green, uint16_t blue); // Construct
00170         // RBBSColor from double precision RGB color used by WP3.x for Mac
00171         _RGBSColor(); // initializes all values to 0
00172         uint8_t m_r;
00173         uint8_t m_g;
00174         uint8_t m_b;
00175         uint8_t m_s;
00176 };
00177 
00178 typedef struct _WPXColumnDefinition WPXColumnDefinition;
00179 struct _WPXColumnDefinition
00180 {
00181         _WPXColumnDefinition(); // initializes all values to 0
00182         float m_width;
00183         float m_leftGutter;
00184         float m_rightGutter;
00185 };
00186 
00187 typedef struct _WPXColumnProperties WPXColumnProperties;
00188 struct _WPXColumnProperties
00189 {
00190         _WPXColumnProperties();
00191         uint32_t m_attributes;
00192         uint8_t m_alignment;
00193 };
00194 
00195 typedef struct _WPXTabStop WPXTabStop;
00196 struct _WPXTabStop
00197 {
00198         _WPXTabStop(float position, WPXTabAlignment alignment, uint16_t leaderCharacter, uint8_t leaderNumSpaces);
00199         _WPXTabStop();
00200         float m_position;
00201         WPXTabAlignment m_alignment;
00202         uint16_t m_leaderCharacter;
00203         uint8_t m_leaderNumSpaces;
00204 };
00205 
00206 // Various exceptions: libwpd does not propagate exceptions externally..
00207 
00208 class VersionException
00209 {
00210         // needless to say, we could flesh this class out a bit
00211 };
00212 
00213 class FileException
00214 {
00215         // needless to say, we could flesh this class out a bit
00216 };
00217 
00218 class ParseException
00219 {
00220         // needless to say, we could flesh this class out a bit
00221 };
00222 
00223 class GenericException
00224 {
00225         // needless to say, we could flesh this class out a bit
00226 };
00227 
00228 class UnsupportedEncryptionException
00229 {
00230         // needless to say, we could flesh this class out a bit
00231 };
00232 
00233 // Various usefull, but cheesey functions
00234 
00235 int _extractNumericValueFromRoman(const char romanChar);
00236 int _extractDisplayReferenceNumberFromBuf(const WPXString &buf, const WPXNumberingType listType);
00237 WPXNumberingType _extractWPXNumberingTypeFromBuf(const WPXString &buf, const WPXNumberingType putativeWPXNumberingType);
00238 WPXString _numberingTypeToString(WPXNumberingType t);
00239 extern const uint16_t macintoshCharacterMap[];
00240 
00241 #endif /* LIBWPD_INTERNAL_H */

Generated on Tue Mar 13 14:02:01 2007 for libwpd by doxygen 1.5.1