/[public]/psiconv/trunk/lib/psiconv/data.h
ViewVC logotype

Diff of /psiconv/trunk/lib/psiconv/data.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 187 Revision 188
16 along with this program; if not, write to the Free Software 16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18*/ 18*/
19 19
20/* This file contains the declarations of all types that are used to 20/* This file contains the declarations of all types that are used to
21 represent the Word file. Variables of these types are written by the 21 represent the Psion files. Variables of these types are written by the
22 parse routines, and read by the generation routines. */ 22 parse routines, and read by the generation routines.
23
24 Mostly, the data structures reflect the file format documentation,
25 as included in the formats directory. When in doubt, refer there. */
23 26
24#ifndef PSICONV_DATA_H 27#ifndef PSICONV_DATA_H
25#define PSICONV_DATA_H 28#define PSICONV_DATA_H
26 29
27#include <psiconv/general.h> 30#include <psiconv/general.h>
28#include <psiconv/list.h> 31#include <psiconv/list.h>
29 32
30/* All types which end on _t are plain types; all other types are pointers 33/* All types which end on _t are plain types; all other types are pointers
31 to structs */ 34 to structs. */
32 35
33#ifdef __cplusplus 36#ifdef __cplusplus
34extern "C" { 37extern "C" {
35#endif /* __cplusplus */ 38#endif /* __cplusplus */
36 39
37/* Forward declaration (for psiconv_embedded_object_section) */ 40/* Forward declaration (for psiconv_embedded_object_section) */
38typedef struct psiconv_file_s *psiconv_file; 41typedef struct psiconv_file_s *psiconv_file;
39 42
43
44/* Enums and simple types */
45
46
47/* Floating point number representation */
40typedef double psiconv_float_t; 48typedef double psiconv_float_t;
41 49
50/* The supported file types. */
42typedef enum psiconv_file_type { 51typedef enum psiconv_file_type {
43 psiconv_unknown_file, 52 psiconv_unknown_file,
44 psiconv_word_file, 53 psiconv_word_file,
45 psiconv_texted_file, 54 psiconv_texted_file,
46 psiconv_mbm_file, 55 psiconv_mbm_file,
47 psiconv_sketch_file, 56 psiconv_sketch_file,
48 psiconv_clipart_file, 57 psiconv_clipart_file,
49 psiconv_sheet_file 58 psiconv_sheet_file
50} psiconv_file_type_t; 59} psiconv_file_type_t;
51 60
52/* Length indicators */ 61/* String representation. A string is an array of UCS2 characters, terminated
53typedef psiconv_u32 psiconv_S_t; 62 by a 0. So they are just like normal C strings, except that they are built
54typedef psiconv_u32 psiconv_X_t; 63 of psiconv_ucs2 elements instead of char elements.
55 64 The psiconv_ucs2 type holds 16 bits; see unicode.h for more information. */
56/* A string */
57typedef psiconv_ucs2 *psiconv_string_t; 65typedef psiconv_ucs2 *psiconv_string_t;
58 66
67/* Represent lengths (in centimeters) and sizes (in points).
59/* In the Psion file, these are identical; but we translate them to more 68 In the Psion file, these are identical; but we translate them to more
60 human-readable quantities */ 69 human-readable quantities */
61typedef float psiconv_length_t; /* For offsets in centimeters */ 70typedef float psiconv_length_t; /* For offsets in centimeters */
62typedef float psiconv_size_t; /* For sizes in points */ 71typedef float psiconv_size_t; /* For sizes in points */
63 72
64/* Some enums */ 73/* Represent booleans. As false is zero in the enum, you can still do things
74 like { if (test) ... } instead of { if (test == psiconv_bool_true) ... }.
75 Choose whatever style suits you best. */
65typedef enum psiconv_bool 76typedef enum psiconv_bool
66{ 77{
67 psiconv_bool_false, 78 psiconv_bool_false,
68 psiconv_bool_true 79 psiconv_bool_true
69} psiconv_bool_t; 80} psiconv_bool_t;
70 81
82/* Some kind of three-valued boolean, used at several places. */
71typedef enum psiconv_triple 83typedef enum psiconv_triple
72{ 84{
73 psiconv_triple_on, 85 psiconv_triple_on,
74 psiconv_triple_off, 86 psiconv_triple_off,
75 psiconv_triple_auto 87 psiconv_triple_auto
76} psiconv_triple_t; 88} psiconv_triple_t;
77 89
90/* Text can be in superscript or subscript or neither, but never both
91 superscript and subscript at once. Also, super-superscript and things
92 like that do not exist in the Psion world. */
78typedef enum psiconv_super_sub 93typedef enum psiconv_super_sub
79{ psiconv_normalscript, 94{ psiconv_normalscript,
80 psiconv_superscript, 95 psiconv_superscript,
81 psiconv_subscript 96 psiconv_subscript
82} psiconv_super_sub_t; 97} psiconv_super_sub_t;
83 98
99/* Horizontal justification. */
84typedef enum psiconv_justify_hor 100typedef enum psiconv_justify_hor
85{ psiconv_justify_left, 101{ psiconv_justify_left,
86 psiconv_justify_centre, 102 psiconv_justify_centre,
87 psiconv_justify_right, 103 psiconv_justify_right,
88 psiconv_justify_full 104 psiconv_justify_full
89} psiconv_justify_hor_t; 105} psiconv_justify_hor_t;
90 106
107/* Vertical justification. */
91typedef enum psiconv_justify_ver 108typedef enum psiconv_justify_ver
92{ psiconv_justify_top, 109{ psiconv_justify_top,
93 psiconv_justify_middle, 110 psiconv_justify_middle,
94 psiconv_justify_bottom 111 psiconv_justify_bottom
95} psiconv_justify_ver_t; 112} psiconv_justify_ver_t;
96 113
114/* Borders around text fields. */
97typedef enum psiconv_border_kind 115typedef enum psiconv_border_kind
98{ psiconv_border_none, 116{ psiconv_border_none, /* No border */
99 psiconv_border_solid, 117 psiconv_border_solid, /* Single line */
100 psiconv_border_double, 118 psiconv_border_double, /* Double line */
101 psiconv_border_dotted, 119 psiconv_border_dotted, /* Dotted line: . . . . . */
102 psiconv_border_dashed, 120 psiconv_border_dashed, /* Dashed line: _ _ _ _ _ */
103 psiconv_border_dotdashed, 121 psiconv_border_dotdashed, /* Dotted/dashed line: _ . _ . _ */
104 psiconv_border_dotdotdashed 122 psiconv_border_dotdotdashed /* Dotted/dashed line: . . _ . . _ */
105} psiconv_border_kind_t; 123} psiconv_border_kind_t;
106 124
125/* Though each printer driver has its own fonts for printing, they are
126 represented on the Psion screen by a few built-in fonts. */
107typedef enum psiconv_screenfont 127typedef enum psiconv_screenfont
108{ 128{
109 psiconv_font_misc, 129 psiconv_font_misc, /* Nonproportional symbols, like Wingbat? */
110 psiconv_font_sansserif, 130 psiconv_font_sansserif, /* Proportional sans-serif, like Arial */
111 psiconv_font_nonprop, 131 psiconv_font_nonprop, /* Nonproportional, like Courier */
112 psiconv_font_serif 132 psiconv_font_serif /* Proportional serifed, like Times */
113} psiconv_screenfont_t; 133} psiconv_screenfont_t;
114 134
115/* Colors. 135
136/* The kind of tab. Note that decimal tabs are not supported by the Psion. */
137typedef enum psiconv_tab_kind
138{
139 psiconv_tab_left, /* Left tab */
140 psiconv_tab_centre, /* Centre tab */
141 psiconv_tab_right /* Right tab */
142} psiconv_tab_kind_t;
143
144/* When text has to be replaced, the kind of replacement to do
145 (not yet implemented!) */
146typedef enum psiconv_replacement_type
147{
148 psiconv_replace_time,
149 psiconv_replace_date,
150 psiconv_replace_pagenr,
151 psiconv_replace_nr_of_pages,
152 psiconv_replace_filename
153} psiconv_replacement_type_t;
154
155
156/* Here starts the struct definitions */
157
158/* The color of a single pixel, in RGB format.
116 black: 0x00 0x00 0x00 159 Black: 0x00 0x00 0x00
117 white: 0xff 0xff 0xff */ 160 White: 0xff 0xff 0xff */
118typedef struct psiconv_color_s 161typedef struct psiconv_color_s
119{ 162{
120 psiconv_u8 red; 163 psiconv_u8 red;
121 psiconv_u8 green; 164 psiconv_u8 green;
122 psiconv_u8 blue; 165 psiconv_u8 blue;
123} * psiconv_color; 166} * psiconv_color;
124 167
168
169/* Complete font information: both a printer font and a corresponding screen
170 font to display it. */
125typedef struct psiconv_font_s 171typedef struct psiconv_font_s
126{ 172{
127 psiconv_string_t name; 173 psiconv_string_t name; /* Printer font */
128 psiconv_screenfont_t screenfont; 174 psiconv_screenfont_t screenfont; /* Screen font */
129} *psiconv_font; 175} *psiconv_font;
130 176
177/* Complete border information */
131typedef struct psiconv_border_s 178typedef struct psiconv_border_s
132{ 179{
133 psiconv_border_kind_t kind; 180 psiconv_border_kind_t kind; /* Border kind */
134 psiconv_size_t thickness; /* Set to 1/20 for non-solid lines */ 181 psiconv_size_t thickness; /* Set to 1/20 for non-solid lines */
135 psiconv_color color; 182 psiconv_color color; /* Border color */
136} *psiconv_border; 183} *psiconv_border;
137 184
185/* Complete bullet information.
186 If indent if off, the bullet is at the first line indentation level,
187 and the line text begins right after it. If it is on, the bullet is at
188 the minimum of the first line and left indentation, and the text starts
189 at the maximum of both. */
138typedef struct psiconv_bullet_s 190typedef struct psiconv_bullet_s
139{ 191{
140 psiconv_bool_t on; 192 psiconv_bool_t on; /* Whether the bullet is shown */
141 psiconv_size_t font_size; 193 psiconv_size_t font_size; /* Bullet font size */
142 psiconv_ucs2 character; 194 psiconv_ucs2 character; /* Bullet character */
143 psiconv_bool_t indent; 195 psiconv_bool_t indent; /* Whether to indent (see above */
144 psiconv_color color; 196 psiconv_color color; /* Bullet color */
145 psiconv_font font; 197 psiconv_font font; /* Bullet font */
146} *psiconv_bullet; 198} *psiconv_bullet;
147 199
148typedef enum psiconv_tab_kind 200/* Complete single tab information */
149{
150 psiconv_tab_left,
151 psiconv_tab_centre,
152 psiconv_tab_right
153} psiconv_tab_kind_t;
154
155typedef struct psiconv_tab_s 201typedef struct psiconv_tab_s
156{ 202{
157 psiconv_length_t location; 203 psiconv_length_t location; /* The indentation level */
158 psiconv_tab_kind_t kind; 204 psiconv_tab_kind_t kind; /* Tab kind */
159} *psiconv_tab; 205} *psiconv_tab;
160 206
161 207/* A list of tabs */
162typedef psiconv_list psiconv_tab_list; /* of struct psiconv_tab */ 208typedef psiconv_list psiconv_tab_list; /* of struct psiconv_tab_s */
163 209
210/* Information about all tabs.
211 Normal tabs start after the rightmost extra tab */
164typedef struct psiconv_all_tabs_s 212typedef struct psiconv_all_tabs_s
165{ 213{
166 psiconv_length_t normal; 214 psiconv_length_t normal; /* Normal tab distance */
167 psiconv_tab_list extras; 215 psiconv_tab_list extras; /* Additional defined tabs */
168} *psiconv_all_tabs; 216} *psiconv_all_tabs;
169 217
218/* Character layout.
219 This structure holds all layout information that can be applied on the
220 character level (as opposed to layouts that only apply to whole
221 paragraphs).
222 Note that at all times, this structure holds the complete layout
223 information; we do not use incremental layouts, unlike the Psion
224 file format itself. So if an italic text is also underlined, the
225 character_layout will have both set for that region. */
170typedef struct psiconv_character_layout_s 226typedef struct psiconv_character_layout_s
171{ 227{
172 psiconv_color color; 228 psiconv_color color; /* Character color */
173 psiconv_color back_color; 229 psiconv_color back_color; /* Background color */
174 psiconv_size_t font_size; 230 psiconv_size_t font_size; /* Font size */
175 psiconv_bool_t italic; 231 psiconv_bool_t italic; /* Use italics? */
176 psiconv_bool_t bold; 232 psiconv_bool_t bold; /* Use bold? */
177 psiconv_super_sub_t super_sub; 233 psiconv_super_sub_t super_sub; /* Use super/subscript? */
178 psiconv_bool_t underline; 234 psiconv_bool_t underline; /* Underline? */
179 psiconv_bool_t strikethrough; 235 psiconv_bool_t strikethrough; /* Strike through? */
180 psiconv_font font; 236 psiconv_font font; /* Character font */
181} *psiconv_character_layout; 237} *psiconv_character_layout;
182 238
239/* Paragraph layout.
240 This structure holds all layout information that can be applied on the
241 paragraph level (as opposed to layouts that also apply to single
242 characters).
243 Note that at all times, this structure holds the complete layout
244 information; we do not use incremental layouts, unlike the Psion
245 file format itself.
246 Linespacing is the amount of vertical space between lines. If
247 linespacing_exact is set, this amount is used even if that would make
248 text overlap; if it is not set, a greater distance is used if text would
249 otherwise overlap.
250 Several booleans determine where page breaks may be set. keep_together
251 forbids page breaks in the middle of the paragraph; keep_with_next
252 forbids page breaks between this and the next paragraph. on_next_page
253 forces a pagebreak before the paragraph. no_widow_protection allows
254 one single line of the paragraph on a page, and the rest on another page.
255 Sheet cell text normally does not wrap; wrap_to_fit_cell allows this. */
183typedef struct psiconv_paragraph_layout_s 256typedef struct psiconv_paragraph_layout_s
184{ 257{
185 psiconv_color back_color; 258 psiconv_color back_color; /* Background color */
186 psiconv_length_t indent_left; 259 psiconv_length_t indent_left; /* Left indentation (except first line) */
187 psiconv_length_t indent_right; 260 psiconv_length_t indent_right; /* Right indentation */
188 psiconv_length_t indent_first; 261 psiconv_length_t indent_first; /* First line left indentation */
189 psiconv_justify_hor_t justify_hor; 262 psiconv_justify_hor_t justify_hor; /* Horizontal justification */
190 psiconv_justify_ver_t justify_ver; 263 psiconv_justify_ver_t justify_ver; /* Vertical justification */
191 psiconv_size_t linespacing; 264 psiconv_size_t linespacing; /* The linespacing */
192 psiconv_bool_t linespacing_exact; 265 psiconv_bool_t linespacing_exact; /* Is linespacing exact or the minimum? */
193 psiconv_size_t space_above; 266 psiconv_size_t space_above; /* Vertical space before the paragraph */
194 psiconv_size_t space_below; 267 psiconv_size_t space_below; /* Vertical space after the paragraph */
195 psiconv_bool_t keep_together; 268 psiconv_bool_t keep_together; /* Keep lines on one page? */
196 psiconv_bool_t keep_with_next; 269 psiconv_bool_t keep_with_next; /* Disallow pagebreak after paragraph? */
197 psiconv_bool_t on_next_page; 270 psiconv_bool_t on_next_page; /* Force page break before paragraph? */
198 psiconv_bool_t no_widow_protection; 271 psiconv_bool_t no_widow_protection; /* Undo widow protection? */
199 psiconv_bool_t wrap_to_fit_cell; 272 psiconv_bool_t wrap_to_fit_cell; /* Wrap sheet cell text? */
200 psiconv_length_t border_distance; 273 psiconv_length_t border_distance; /* Distance to borders */
201 psiconv_bullet bullet; 274 psiconv_bullet bullet; /* Bullet information */
202 psiconv_border left_border; 275 psiconv_border left_border; /* Left border information */
203 psiconv_border right_border; 276 psiconv_border right_border; /* Right border information */
204 psiconv_border top_border; 277 psiconv_border top_border; /* Top border information */
205 psiconv_border bottom_border; 278 psiconv_border bottom_border; /* Bottom border information */
206 psiconv_all_tabs tabs; 279 psiconv_all_tabs tabs; /* All tab information */
207} *psiconv_paragraph_layout; 280} *psiconv_paragraph_layout;
208 281
282/* A Header Section.
283 It contains the three UIDs and the checksum, and the type of file.
284 As the type of file uniquely defines the UIDs, and as the UIDs determine
285 the checksum, this is never included in a regular psiconv_file structure.
286 It can be used to read the header section separately, though. */
209typedef struct psiconv_header_section_s 287typedef struct psiconv_header_section_s
210{ 288{
211 psiconv_u32 uid1; 289 psiconv_u32 uid1;
212 psiconv_u32 uid2; 290 psiconv_u32 uid2;
213 psiconv_u32 uid3; 291 psiconv_u32 uid3;
214 psiconv_u32 checksum; 292 psiconv_u32 checksum;
215 psiconv_file_type_t file; 293 psiconv_file_type_t file;
216} *psiconv_header_section; 294} *psiconv_header_section;
217 295
296/* A Section Table Section entry.
297 Each entry has a UID and an offset.
298 This is never included in a regular psiconv_file structure, as the
299 information is too low-level. It is used internally, though. */
218typedef struct psiconv_section_table_entry_s 300typedef struct psiconv_section_table_entry_s
219{ 301{
220 psiconv_u32 id; 302 psiconv_u32 id; /* Section UID */
221 psiconv_u32 offset; 303 psiconv_u32 offset; /* Section offset within the file */
222} *psiconv_section_table_entry; 304} *psiconv_section_table_entry;
223 305
306/* A Section Table Section.
307 A list of sections and their offsets.
308 It is simply a list of Section Table Section Entries.
309 This is never included in a regular psiconv_file structure, as the
310 information is too low-level. It is used internally, though. */
224typedef psiconv_list psiconv_section_table_section; 311typedef psiconv_list psiconv_section_table_section;
225/* Of struct sectiontable_entry */ 312 /* Of struct psiconv_sectiontable_entry_s */
226 313
314/* An Application ID Section.
315 The type of file.
316 Never included in a regular psiconv_file structure, because it is too
317 low-level. You can always recover it if you know the file type. Used
318 internally.
319 The name should probably be case-insensitive. */
227typedef struct psiconv_application_id_section_s 320typedef struct psiconv_application_id_section_s
228{ 321{
229 psiconv_u32 id; 322 psiconv_u32 id; /* File type UID */
230 psiconv_string_t name; 323 psiconv_string_t name; /* File type name */
231} *psiconv_application_id_section; 324} *psiconv_application_id_section;
232 325
326/* An Object Icon Section.
327 The icon used for an embedded object. */
233typedef struct psiconv_object_icon_section_s 328typedef struct psiconv_object_icon_section_s
234{ 329{
235 psiconv_length_t icon_width; 330 psiconv_length_t icon_width; /* Icon width */
236 psiconv_length_t icon_height; 331 psiconv_length_t icon_height; /* Icon height */
237 psiconv_string_t icon_name; 332 psiconv_string_t icon_name; /* Icon name */
238} *psiconv_object_icon_section; 333} *psiconv_object_icon_section;
239 334
335/* An Object Display Section.
336 How an embedded icon should be displayed.
337 The sizes are computed after cropping or resizing; if the object is shown
338 as an icon, the icon sizes are used here. */
240typedef struct psiconv_object_display_section_s 339typedef struct psiconv_object_display_section_s
241{ 340{
242 psiconv_bool_t show_icon; 341 psiconv_bool_t show_icon; /* Show an icon or the whole file? */
243 psiconv_length_t width; 342 psiconv_length_t width; /* Object display width */
244 psiconv_length_t height; 343 psiconv_length_t height; /* Object display height */
245} *psiconv_object_display_section; 344} *psiconv_object_display_section;
246 345
346/* An Embedded Object Section.
347 All data about an embedded object.
348 An object is another psiconv_file, which is embedded in the current
349 file. Objects can also be embedded in each other, of course. */
247typedef struct psiconv_embedded_object_section_s 350typedef struct psiconv_embedded_object_section_s
248{ 351{
249 psiconv_object_icon_section icon; 352 psiconv_object_icon_section icon; /* Icon information */
250 psiconv_object_display_section display; 353 psiconv_object_display_section display; /* Display information */
251 psiconv_file object; 354 psiconv_file object; /* The object itself */
252} *psiconv_embedded_object_section; 355} *psiconv_embedded_object_section;
253 356
357/* Inline character-level layout information.
358 Information how some characters should be laid out.
359 Note that, though you can choose specific layouts for an object, this
360 will probably not affect the object's rendering.
361 Usually, object will be NULL, and the object_width and object_height
362 will be ignored.
363 The object sizes are the same as in the Object Display Section, so
364 this information seems to be redundant. */
254typedef struct psiconv_in_line_layout_s 365typedef struct psiconv_in_line_layout_s
255{ 366{
256 psiconv_character_layout layout; 367 psiconv_character_layout layout; /* Layout information */
257 int length; 368 int length; /* Number of characters */
258 /* If object is NULL, this does not apply to an object */ 369 psiconv_embedded_object_section object; /* Embedded object or NULL */
259 psiconv_embedded_object_section object; 370 psiconv_length_t object_width; /* Object display width */
260 psiconv_length_t object_width; 371 psiconv_length_t object_height; /* Object display height */
261 psiconv_length_t object_height;
262} *psiconv_in_line_layout; 372} *psiconv_in_line_layout;
263 373
374/* Inline character information for a whole line.
375 A list of inline character information */
264typedef psiconv_list psiconv_in_line_layouts; /* of struct in_line_layout */ 376typedef psiconv_list psiconv_in_line_layouts;
377 /* of struct psiconv_in_line_layout_s */
265 378
266typedef enum psiconv_replacement_type 379/* What to replace where in text. Not yet implemented!
267{ 380 (not yet implemented!) */
268 psiconv_replace_time,
269 psiconv_replace_date,
270 psiconv_replace_pagenr,
271 psiconv_replace_nr_of_pages,
272 psiconv_replace_filename
273} psiconv_replacement_type_t;
274
275typedef struct psiconv_replacement_s 381typedef struct psiconv_replacement_s
276{ 382{
277 int offset; 383 int offset; /* Offset in text */
278 int cur_len; 384 int cur_len; /* Length of text to replace */
279 psiconv_replacement_type_t type; 385 psiconv_replacement_type_t type; /* Kind of replacement */
280} *psiconv_replacement; 386} *psiconv_replacement;
281 387
388/* A list of replacements */
282typedef psiconv_list psiconv_replacements; /* of struct replacement */ 389typedef psiconv_list psiconv_replacements; /* of struct psiconv_replacement_s */
283 390
391/* A paragraph of text.
392 Layout and actual paragraph text are combined here, even though
393 they are seperated in the Psion file format.
394 The base style is referred to, but the base_character and
395 base_paragraph have all style settings already incorporated.
396 The base style can be found using the psiconv_get_style function.
397 The in_lines are either an empty list, or they should apply to exactly
398 the number of characters in this paragraph */
284typedef struct psiconv_paragraph_s 399typedef struct psiconv_paragraph_s
285{ 400{
286 psiconv_string_t text; 401 psiconv_string_t text; /* Paragraph text */
287 psiconv_character_layout base_character; 402 psiconv_character_layout base_character; /* Base character layout */
288 psiconv_paragraph_layout base_paragraph; 403 psiconv_paragraph_layout base_paragraph; /* Base paragraph layout */
289 psiconv_s16 base_style; 404 psiconv_s16 base_style; /* Paragraph style */
290 psiconv_in_line_layouts in_lines; 405 psiconv_in_line_layouts in_lines; /* In-paragraph layout */
291 psiconv_replacements replacements; 406 psiconv_replacements replacements; /* Replacements like the date */
292} *psiconv_paragraph; 407} *psiconv_paragraph;
293 408
409/* A collection of text paragraphs */
294typedef psiconv_list psiconv_text_and_layout; /* Of struct paragraphs */ 410typedef psiconv_list psiconv_text_and_layout;
411 /* Of struct psiconv_paragraph_s */
295 412
413/* A TextEd Section.
414 Text and simple layout, without styles. */
296typedef struct psiconv_texted_section_s 415typedef struct psiconv_texted_section_s
297{ 416{
298 psiconv_text_and_layout paragraphs; 417 psiconv_text_and_layout paragraphs;
299} *psiconv_texted_section; 418} *psiconv_texted_section;
300 419
420/* A Page Header.
421 All information about a page header or footer.
422 An explicit base paragraph and character layout is found; this is used
423 as a sort of base style, on which all further formatting is based */
301typedef struct psiconv_page_header_s 424typedef struct psiconv_page_header_s
302{ 425{
303 psiconv_bool_t on_first_page; 426 psiconv_bool_t on_first_page; /* Display on first page? */
304 psiconv_paragraph_layout base_paragraph_layout; 427 psiconv_paragraph_layout base_paragraph_layout; /* Base paragraph layout */
305 psiconv_character_layout base_character_layout; 428 psiconv_character_layout base_character_layout; /* Base character layout */
306 psiconv_texted_section text; 429 psiconv_texted_section text; /* The actual text */
307} *psiconv_page_header; 430} *psiconv_page_header;
308 431
432/* A Page Layout Section
433 All information about the layout of a page.
434 Margins, page size, the header, the footer and page numbers */
309typedef struct psiconv_page_layout_section_s 435typedef struct psiconv_page_layout_section_s
310{ 436{
311 psiconv_u32 first_page_nr; 437 psiconv_u32 first_page_nr; /* Page numbers start counting here */
312 psiconv_length_t header_dist; 438 psiconv_length_t header_dist; /* Distance of header to text */
313 psiconv_length_t footer_dist; 439 psiconv_length_t footer_dist; /* Distance of footer to text */
314 psiconv_length_t left_margin; 440 psiconv_length_t left_margin; /* Left margin */
315 psiconv_length_t right_margin; 441 psiconv_length_t right_margin; /* Right margin */
316 psiconv_length_t top_margin; 442 psiconv_length_t top_margin; /* Top margin */
317 psiconv_length_t bottom_margin; 443 psiconv_length_t bottom_margin; /* Bottom margin */
318 psiconv_length_t page_width; 444 psiconv_length_t page_width; /* Page width */
319 psiconv_length_t page_height; 445 psiconv_length_t page_height; /* Page height */
320 psiconv_page_header header; 446 psiconv_page_header header; /* Header information */
321 psiconv_page_header footer; 447 psiconv_page_header footer; /* Footer information */
322 psiconv_bool_t landscape; 448 psiconv_bool_t landscape; /* Landscape orientation? */
323} * psiconv_page_layout_section; 449} * psiconv_page_layout_section;
324 450
451/* A Word Status Section
452 Settings of the Word program.
453 Several whitespace and related characters can be explicitely shown.
454 Embedded pictures and graphs can be iconized or displayed full.
455 Toolbars can be shown or hidden.
456 Long lines can be wrapped, or you have to use scrolling.
457 The cursor position is the character number of the text.
458 Zoom level: 1000 is "normal" */
325typedef struct psiconv_word_status_section_s 459typedef struct psiconv_word_status_section_s
326{ 460{
327 psiconv_bool_t show_tabs; 461 psiconv_bool_t show_tabs; /* Show tabs? */
328 psiconv_bool_t show_spaces; 462 psiconv_bool_t show_spaces; /* Show spaces? */
329 psiconv_bool_t show_paragraph_ends; 463 psiconv_bool_t show_paragraph_ends; /* Show paragraph ends? */
330 psiconv_bool_t show_line_breaks; 464 psiconv_bool_t show_line_breaks; /* Show line breaks */
331 psiconv_bool_t show_hard_minus; 465 psiconv_bool_t show_hard_minus; /* Show hard dashes? */
332 psiconv_bool_t show_hard_space; 466 psiconv_bool_t show_hard_space; /* Show hard spaces? */
333 psiconv_bool_t show_full_pictures; 467 psiconv_bool_t show_full_pictures; /* Show embedded pictures (or iconize)? */
334 psiconv_bool_t show_full_graphs; 468 psiconv_bool_t show_full_graphs; /* Show embedded graphs (or iconize)? */
335 psiconv_bool_t show_top_toolbar; 469 psiconv_bool_t show_top_toolbar; /* Show top toolbar? */
336 psiconv_bool_t show_side_toolbar; 470 psiconv_bool_t show_side_toolbar; /* Show side toolbar? */
337 psiconv_bool_t fit_lines_to_screen; 471 psiconv_bool_t fit_lines_to_screen; /* Wrap lines? */
338 psiconv_u32 cursor_position; 472 psiconv_u32 cursor_position; /* Cursor position (character number) */
339 psiconv_u32 display_size; 473 psiconv_u32 display_size; /* Zooming level */
340} *psiconv_word_status_section; 474} *psiconv_word_status_section;
341 475
476/* A Word Style.
477 All information about a single Style.
478 A builtin style may not be changed in the Word program.
479 Outline level is zero if unused. */
342typedef struct psiconv_word_style_s 480typedef struct psiconv_word_style_s
343{ 481{
344 psiconv_character_layout character; 482 psiconv_character_layout character; /* character-level layout */
345 psiconv_paragraph_layout paragraph; 483 psiconv_paragraph_layout paragraph; /* paragraph-level layout */
346 psiconv_u8 hotkey; 484 psiconv_ucs2 hotkey; /* The hotkey */
347 psiconv_string_t name; 485 psiconv_string_t name; /* Style name */
348 psiconv_bool_t built_in; 486 psiconv_bool_t built_in; /* Builtin style? */
349 psiconv_u32 outline_level; 487 psiconv_u32 outline_level; /* Outline level */
350} *psiconv_word_style; 488} *psiconv_word_style;
351 489
490/* A list of Word Styles */
352typedef psiconv_list psiconv_word_style_list; /* Of style */ 491typedef psiconv_list psiconv_word_style_list;
492 /* Of struct psiconv_word_style_s */
353 493
494/* A Word Styles Section
495 All information about styles. */
354typedef struct psiconv_word_styles_section_s 496typedef struct psiconv_word_styles_section_s
355{ 497{
356 psiconv_word_style normal; 498 psiconv_word_style normal; /* The normal (unspecified) style */
357 psiconv_word_style_list styles; 499 psiconv_word_style_list styles; /* All other defined styles */
358} *psiconv_word_styles_section; 500} *psiconv_word_styles_section;
359 501
502/* A Word File
503 All information about a Word File.
504 Note that a section can be NULL if it is not present. */
360typedef struct psiconv_word_f_s 505typedef struct psiconv_word_f_s
361{ 506{
362 psiconv_page_layout_section page_sec; 507 psiconv_page_layout_section page_sec; /* Page layout */
363 psiconv_text_and_layout paragraphs; 508 psiconv_text_and_layout paragraphs; /* Text and text layout */
364 psiconv_word_status_section status_sec; 509 psiconv_word_status_section status_sec; /* Internal Word program settings */
365 psiconv_word_styles_section styles_sec; 510 psiconv_word_styles_section styles_sec; /* Styles */
366} *psiconv_word_f; 511} *psiconv_word_f;
367 512
513/* A TextEd File
514 All information about a TextEd File.
515 Note that a section can be NULL if it is not present. */
368typedef struct psiconv_texted_f_s 516typedef struct psiconv_texted_f_s
369{ 517{
370 psiconv_page_layout_section page_sec; 518 psiconv_page_layout_section page_sec; /* Page layout */
371 psiconv_texted_section texted_sec; 519 psiconv_texted_section texted_sec; /* Text and text layout */
372} *psiconv_texted_f; 520} *psiconv_texted_f;
373 521
522/* A Jumptable Section.
523 A simple list of offsets.
524 This is never included in a regular psiconv_file structure, as the
525 information is too low-level. It is used internally, though. */
374typedef psiconv_list psiconv_jumptable_section; /* of psiconv_u32 */ 526typedef psiconv_list psiconv_jumptable_section; /* of psiconv_u32 */
375 527
528/* A Paint Data Section
529 A collection of pixels.
376/* Normalized values [0..1] for each component 530 Normalized values [0..1] for each color component.
377 Origin is (x,y)=(0,0), to get pixel at (X,Y) use index [Y*xsize+X] */ 531 Origin is (x,y)=(0,0), to get pixel at (X,Y) use index [Y*xsize+X] */
378typedef struct psiconv_paint_data_section_s 532typedef struct psiconv_paint_data_section_s
379{ 533{
380 psiconv_u32 xsize; 534 psiconv_u32 xsize; /* Number of pixels in a row */
381 psiconv_u32 ysize; 535 psiconv_u32 ysize; /* Number of pixels in a column */
382 psiconv_length_t pic_xsize; /* 0 if not specified */ 536 psiconv_length_t pic_xsize; /* 0 if not specified */
383 psiconv_length_t pic_ysize; /* 0 if not specified */ 537 psiconv_length_t pic_ysize; /* 0 if not specified */
384 float *red; 538 float *red;
385 float *green; 539 float *green;
386 float *blue; 540 float *blue;
387} *psiconv_paint_data_section; 541} *psiconv_paint_data_section;
388 542
543/* A collection of Paint Data Sections */
389typedef psiconv_list psiconv_pictures; 544typedef psiconv_list psiconv_pictures;
390 /* of struct psiconv_paint_data_section */ 545 /* of struct psiconv_paint_data_section_s */
391 546
547/* A MBM file
548 All information about a MBM file
549 MBM files contain one or more pictures. */
392typedef struct psiconv_mbm_f_s 550typedef struct psiconv_mbm_f_s
393{ 551{
394 psiconv_pictures sections; 552 psiconv_pictures sections;
395} *psiconv_mbm_f; 553} *psiconv_mbm_f;
396 554
428{ 586{
429 /* Perhaps later on some currently unknown stuff. */ 587 /* Perhaps later on some currently unknown stuff. */
430 psiconv_paint_data_section picture; 588 psiconv_paint_data_section picture;
431} * psiconv_clipart_section; 589} * psiconv_clipart_section;
432 590
433typedef psiconv_list psiconv_cliparts; /* of struct psiconv_clipart_section */ 591typedef psiconv_list psiconv_cliparts; /* of struct psiconv_clipart_section_s */
434 592
435typedef struct psiconv_clipart_f_s 593typedef struct psiconv_clipart_f_s
436{ 594{
437 psiconv_cliparts sections; 595 psiconv_cliparts sections;
438} *psiconv_clipart_f; 596} *psiconv_clipart_f;
540 psiconv_sheet_cell_layout layout; 698 psiconv_sheet_cell_layout layout;
541 psiconv_bool_t calculated; 699 psiconv_bool_t calculated;
542 psiconv_u32 ref_formula; 700 psiconv_u32 ref_formula;
543} *psiconv_sheet_cell; 701} *psiconv_sheet_cell;
544 702
545typedef psiconv_list psiconv_sheet_cell_list; 703typedef psiconv_list psiconv_sheet_cell_list;
704 /* Of struct psiconv_sheet_cell_s */
546 705
547typedef struct psiconv_sheet_status_section_s 706typedef struct psiconv_sheet_status_section_s
548{ 707{
549 psiconv_bool_t show_graph; 708 psiconv_bool_t show_graph;
550 psiconv_u32 cursor_row; 709 psiconv_u32 cursor_row;

Legend:
Removed from v.187  
changed lines
  Added in v.188

frodo@frodo.looijaard.name
ViewVC Help
Powered by ViewVC 1.1.26