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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 76 - (hide annotations)
Mon Dec 25 00:26:53 2000 UTC (23 years, 3 months ago) by frodo
File MIME type: text/plain
File size: 15348 byte(s)
(Frodo) Added word-specific generation routines

1 frodo 2 /*
2     data.h - Part of psiconv, a PSION 5 file formats converter
3 frodo 63 Copyright (c) 1999, 2000 Frodo Looijaard <frodol@dds.nl>
4 frodo 2
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9    
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13     GNU General Public License for more details.
14    
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18     */
19    
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
22     parse routines, and read by the generation routines. */
23    
24     #ifndef PSICONV_DATA_H
25     #define PSICONV_DATA_H
26    
27 frodo 58 #include <psiconv/general.h>
28     #include <psiconv/list.h>
29 frodo 2
30     /* All types which end on _t are plain types; all other types are pointers
31     to structs */
32    
33 frodo 55 #ifdef __cplusplus
34     extern "C" {
35     #endif /* __cplusplus */
36    
37    
38 frodo 2 typedef enum psiconv_file_type {
39     psiconv_unknown_file,
40     psiconv_word_file,
41     psiconv_texted_file,
42 frodo 12 psiconv_mbm_file,
43 frodo 41 psiconv_sketch_file,
44     psiconv_clipart_file
45 frodo 2 } psiconv_file_type_t;
46    
47     /* Length indicators */
48     typedef psiconv_u32 psiconv_S_t;
49     typedef psiconv_u32 psiconv_X_t;
50    
51     /* A string */
52     typedef char *psiconv_string_t;
53    
54     /* In the Psion file, these are identical; but we translate them to more
55     human-readable quantities */
56     typedef float psiconv_length_t; /* For offsets in centimeters */
57     typedef float psiconv_size_t; /* For sizes in points */
58    
59     /* Some enums */
60     typedef enum psiconv_bool
61     {
62     psiconv_bool_false,
63     psiconv_bool_true
64     } psiconv_bool_t;
65    
66     typedef enum psiconv_super_sub
67     { psiconv_normalscript,
68     psiconv_superscript,
69     psiconv_subscript
70     } psiconv_super_sub_t;
71    
72     typedef enum psiconv_justify_hor
73     { psiconv_justify_left,
74     psiconv_justify_centre,
75     psiconv_justify_right,
76     psiconv_justify_full
77     } psiconv_justify_hor_t;
78    
79     typedef enum psiconv_justify_ver
80     { psiconv_justify_top,
81     psiconv_justify_middle,
82     psiconv_justify_bottom
83     } psiconv_justify_ver_t;
84    
85     typedef enum psiconv_border_kind
86     { psiconv_border_none,
87     psiconv_border_solid,
88     psiconv_border_double,
89     psiconv_border_dotted,
90 frodo 67 psiconv_border_dashed,
91     psiconv_border_dotdashed,
92     psiconv_border_dotdotdashed
93 frodo 2 } psiconv_border_kind_t;
94    
95     /* Colors.
96     black: 0x00 0x00 0x00
97     white: 0xff 0xff 0xff */
98 frodo 56 typedef struct psiconv_color_s
99 frodo 2 {
100     psiconv_u8 red;
101     psiconv_u8 green;
102     psiconv_u8 blue;
103     } * psiconv_color;
104    
105 frodo 56 typedef struct psiconv_font_s
106 frodo 2 {
107     char *name;
108     psiconv_u8 screenfont;
109     } *psiconv_font;
110    
111 frodo 56 typedef struct psiconv_border_s
112 frodo 2 {
113     psiconv_border_kind_t kind;
114     psiconv_size_t thickness; /* Set to 1/20 for non-solid lines */
115     psiconv_color color;
116     } *psiconv_border;
117    
118 frodo 56 typedef struct psiconv_bullet_s
119 frodo 2 {
120     psiconv_bool_t on;
121     psiconv_size_t font_size;
122     psiconv_u8 character;
123     psiconv_bool_t indent;
124     psiconv_color color;
125     psiconv_font font;
126     } *psiconv_bullet;
127    
128     typedef enum psiconv_tab_kind
129     {
130     psiconv_tab_left,
131     psiconv_tab_centre,
132     psiconv_tab_right
133     } psiconv_tab_kind_t;
134    
135 frodo 56 typedef struct psiconv_tab_s
136 frodo 2 {
137     psiconv_length_t location;
138     psiconv_tab_kind_t kind;
139     } *psiconv_tab;
140    
141    
142     typedef psiconv_list psiconv_tab_list; /* of struct psiconv_tab */
143    
144 frodo 56 typedef struct psiconv_all_tabs_s
145 frodo 2 {
146     psiconv_length_t normal;
147     psiconv_tab_list extras;
148     } *psiconv_all_tabs;
149    
150 frodo 56 typedef struct psiconv_character_layout_s
151 frodo 2 {
152     psiconv_color color;
153     psiconv_color back_color;
154     psiconv_size_t font_size;
155     psiconv_bool_t italic;
156     psiconv_bool_t bold;
157     psiconv_super_sub_t super_sub;
158     psiconv_bool_t underline;
159 frodo 67 psiconv_bool_t strikethrough;
160 frodo 2 psiconv_font font;
161     } *psiconv_character_layout;
162    
163 frodo 56 typedef struct psiconv_paragraph_layout_s
164 frodo 2 {
165     psiconv_color back_color;
166     psiconv_length_t indent_left;
167     psiconv_length_t indent_right;
168     psiconv_length_t indent_first;
169     psiconv_justify_hor_t justify_hor;
170     psiconv_justify_ver_t justify_ver;
171 frodo 67 psiconv_size_t linespacing;
172     psiconv_bool_t linespacing_exact;
173     psiconv_size_t space_above;
174     psiconv_size_t space_below;
175     psiconv_bool_t keep_together;
176     psiconv_bool_t keep_with_next;
177 frodo 2 psiconv_bool_t on_next_page;
178     psiconv_bool_t no_widow_protection;
179     psiconv_length_t border_distance;
180     psiconv_bullet bullet;
181     psiconv_border left_border;
182     psiconv_border right_border;
183     psiconv_border top_border;
184     psiconv_border bottom_border;
185     psiconv_all_tabs tabs;
186     } *psiconv_paragraph_layout;
187    
188 frodo 56 typedef struct psiconv_header_section_s
189 frodo 2 {
190     psiconv_u32 uid1;
191     psiconv_u32 uid2;
192     psiconv_u32 uid3;
193     psiconv_u32 checksum;
194     psiconv_file_type_t file;
195     } *psiconv_header_section;
196    
197 frodo 56 typedef struct psiconv_section_table_entry_s
198 frodo 2 {
199     psiconv_u32 id;
200     psiconv_u32 offset;
201     } *psiconv_section_table_entry;
202    
203     typedef psiconv_list psiconv_section_table_section;
204     /* Of struct sectiontable_entry */
205    
206 frodo 56 typedef struct psiconv_application_id_section_s
207 frodo 2 {
208     psiconv_u32 id;
209     psiconv_string_t name;
210     } *psiconv_application_id_section;
211    
212 frodo 56 typedef struct psiconv_in_line_layout_s
213 frodo 2 {
214     psiconv_character_layout layout;
215     int length;
216     } *psiconv_in_line_layout;
217    
218     typedef psiconv_list psiconv_in_line_layouts; /* of struct in_line_layout */
219    
220     typedef enum psiconv_replacement_type
221     {
222     psiconv_replace_time,
223     psiconv_replace_date,
224     psiconv_replace_pagenr,
225     psiconv_replace_nr_of_pages,
226     psiconv_replace_filename
227     } psiconv_replacement_type_t;
228    
229 frodo 56 typedef struct psiconv_replacement_s
230 frodo 2 {
231     int offset;
232     int cur_len;
233     psiconv_replacement_type_t type;
234     } *psiconv_replacement;
235    
236     typedef psiconv_list psiconv_replacements; /* of struct replacement */
237    
238 frodo 56 typedef struct psiconv_paragraph_s
239 frodo 2 {
240     char *text;
241     psiconv_character_layout base_character;
242     psiconv_paragraph_layout base_paragraph;
243     psiconv_s16 base_style;
244     psiconv_in_line_layouts in_lines;
245     psiconv_replacements replacements;
246     } *psiconv_paragraph;
247    
248     typedef psiconv_list psiconv_text_and_layout; /* Of struct paragraphs */
249    
250 frodo 56 typedef struct psiconv_texted_section_s
251 frodo 2 {
252     psiconv_text_and_layout paragraphs;
253     } *psiconv_texted_section;
254    
255 frodo 56 typedef struct psiconv_page_header_s
256 frodo 2 {
257     psiconv_bool_t on_first_page;
258     psiconv_paragraph_layout base_paragraph_layout;
259     psiconv_character_layout base_character_layout;
260     psiconv_texted_section text;
261     } *psiconv_page_header;
262    
263 frodo 56 typedef struct psiconv_page_layout_section_s
264 frodo 2 {
265     psiconv_u32 first_page_nr;
266     psiconv_length_t header_dist;
267     psiconv_length_t footer_dist;
268     psiconv_length_t left_margin;
269     psiconv_length_t right_margin;
270     psiconv_length_t top_margin;
271     psiconv_length_t bottom_margin;
272     psiconv_length_t page_width;
273     psiconv_length_t page_height;
274     psiconv_page_header header;
275     psiconv_page_header footer;
276 frodo 76 psiconv_bool_t landscape;
277 frodo 2 } * psiconv_page_layout_section;
278    
279 frodo 56 typedef struct psiconv_word_status_section_s
280 frodo 2 {
281     psiconv_bool_t show_tabs;
282     psiconv_bool_t show_spaces;
283     psiconv_bool_t show_paragraph_ends;
284     psiconv_bool_t show_line_breaks;
285     psiconv_bool_t show_hard_minus;
286     psiconv_bool_t show_hard_space;
287     psiconv_bool_t show_full_pictures;
288     psiconv_bool_t show_full_graphs;
289     psiconv_bool_t show_top_toolbar;
290     psiconv_bool_t show_side_toolbar;
291     psiconv_bool_t fit_lines_to_screen;
292     psiconv_u32 cursor_position;
293     psiconv_u32 display_size;
294     } *psiconv_word_status_section;
295    
296 frodo 56 typedef struct psiconv_word_style_s
297 frodo 2 {
298     psiconv_character_layout character;
299     psiconv_paragraph_layout paragraph;
300     psiconv_u8 hotkey;
301     psiconv_string_t name;
302     psiconv_bool_t built_in;
303 frodo 28 psiconv_u32 outline_level;
304 frodo 2 } *psiconv_word_style;
305    
306     typedef psiconv_list psiconv_word_style_list; /* Of style */
307    
308 frodo 56 typedef struct psiconv_word_styles_section_s
309 frodo 2 {
310     psiconv_word_style normal;
311     psiconv_word_style_list styles;
312     } *psiconv_word_styles_section;
313    
314 frodo 56 typedef struct psiconv_word_f_s
315     {
316 frodo 2 psiconv_page_layout_section page_sec;
317     psiconv_text_and_layout paragraphs;
318     psiconv_word_status_section status_sec;
319     psiconv_word_styles_section styles_sec;
320     } *psiconv_word_f;
321    
322 frodo 56 typedef struct psiconv_texted_f_s
323     {
324 frodo 2 psiconv_page_layout_section page_sec;
325     psiconv_texted_section texted_sec;
326     } *psiconv_texted_f;
327    
328 frodo 42 typedef psiconv_list psiconv_jumptable_section; /* of psiconv_u32 */
329 frodo 12
330 frodo 11 /* Normalized values [0..1] for each component
331     Origin is (x,y)=(0,0), to get pixel at (X,Y) use index [Y*xsize+X] */
332 frodo 56 typedef struct psiconv_paint_data_section_s
333     {
334 frodo 11 psiconv_u32 xsize;
335     psiconv_u32 ysize;
336 frodo 25 psiconv_length_t pic_xsize; /* 0 if not specified */
337     psiconv_length_t pic_ysize; /* 0 if not specified */
338 frodo 11 float *red;
339     float *green;
340     float *blue;
341     } *psiconv_paint_data_section;
342    
343 frodo 12 typedef psiconv_list psiconv_pictures;
344     /* of struct psiconv_paint_data_section */
345    
346 frodo 56 typedef struct psiconv_mbm_f_s
347     {
348 frodo 12 psiconv_pictures sections;
349     } *psiconv_mbm_f;
350    
351 frodo 24 /* This is a little intricated. A picture may be embedded in a larger form.
352     A form is empty, except for the picture. The form has size form_{x,y}size,
353     and the picture is at offset picture_{x,y}_offset within the form. The
354     picture itself has size picture_{x,y}size.
355     Cuts are always <= 1.0; a cut of 0.0 cuts nothing away, a cut of 1.0
356     cuts everything away. */
357 frodo 56 typedef struct psiconv_sketch_section_s
358     {
359 frodo 24 psiconv_u16 form_xsize;
360     psiconv_u16 form_ysize;
361     psiconv_u16 picture_x_offset;
362     psiconv_u16 picture_y_offset;
363     psiconv_u16 picture_xsize;
364     psiconv_u16 picture_ysize;
365     float magnification_x; /* computed relative to first six values */
366     float magnification_y; /* computed relative to first six values */
367     float cut_left; /* computed relative to first six values */
368     float cut_right; /* computed relative to first six values */
369     float cut_top; /* computed relative to first six values */
370     float cut_bottom; /* computed relative to first six values */
371     psiconv_paint_data_section picture;
372     } *psiconv_sketch_section;
373    
374 frodo 56 typedef struct psiconv_sketch_f_s
375     {
376 frodo 24 psiconv_sketch_section sketch_sec;
377     } *psiconv_sketch_f;
378    
379 frodo 56 typedef struct psiconv_clipart_section_s
380     {
381 frodo 41 /* Perhaps later on some currently unknown stuff. */
382     psiconv_paint_data_section picture;
383     } * psiconv_clipart_section;
384    
385     typedef psiconv_list psiconv_cliparts; /* of struct psiconv_clipart_section */
386    
387 frodo 56 typedef struct psiconv_clipart_f_s
388     {
389 frodo 41 psiconv_cliparts sections;
390     } *psiconv_clipart_f;
391    
392 frodo 56 typedef struct psiconv_file_s
393     {
394 frodo 2 psiconv_file_type_t type;
395     void *file;
396     } *psiconv_file;
397    
398    
399     /* UID1 */
400     #define PSICONV_ID_PSION5 0x10000037
401 frodo 41 #define PSICONV_ID_CLIPART 0x10000041
402 frodo 2 /* UID2 */
403     #define PSICONV_ID_DATA_FILE 0x1000006D
404 frodo 12 #define PSICONV_ID_MBM_FILE 0x10000042
405 frodo 2 /* UID3 */
406     #define PSICONV_ID_WORD 0x1000007F
407     #define PSICONV_ID_TEXTED 0x10000085
408 frodo 24 #define PSICONV_ID_SKETCH 0x1000007D
409 frodo 2
410     /* Section table ids */
411     #define PSICONV_ID_WORD_STATUS_SECTION 0x10000243
412     #define PSICONV_ID_APPL_ID_SECTION 0x10000089
413     #define PSICONV_ID_TEXT_SECTION 0x10000106
414     #define PSICONV_ID_LAYOUT_SECTION 0x10000143
415     #define PSICONV_ID_WORD_STYLES_SECTION 0x10000104
416     #define PSICONV_ID_PAGE_LAYOUT_SECTION 0x10000105
417     #define PSICONV_ID_PASSWORD_SECTION 0x100000CD
418 frodo 24 #define PSICONV_ID_SKETCH_SECTION 0x1000007D
419 frodo 2
420     /* Other ids */
421 frodo 76 #define PSICONV_ID_PAGE_DIMENSIONS1 0x100000fd
422     #define PSICONV_ID_PAGE_DIMENSIONS2 0x1000010e
423 frodo 2 #define PSICONV_ID_TEXTED_BODY 0x1000005c
424     #define PSICONV_ID_TEXTED_REPLACEMENT 0x10000063
425     #define PSICONV_ID_TEXTED_UNKNOWN 0x10000065
426     #define PSICONV_ID_TEXTED_LAYOUT 0x10000066
427     #define PSICONV_ID_TEXTED_TEXT 0x10000064
428     #define PSICONV_ID_STYLE_REMOVABLE 0x1000004F
429     #define PSICONV_ID_STYLE_BUILT_IN 0x1000004C
430 frodo 43 #define PSICONV_ID_CLIPART_ITEM 0x10000040
431 frodo 2
432    
433 frodo 62 /* Return a clean layout_status. You can modify it at will. Returns NULL
434     if there is not enough memory. */
435 frodo 2 extern psiconv_character_layout psiconv_basic_character_layout(void);
436    
437 frodo 62 /* Return a clean layout_status. You can modify it at will. Returns NULL
438     if there is not enough memory. */
439 frodo 2 extern psiconv_paragraph_layout psiconv_basic_paragraph_layout(void);
440    
441     /* Clone a layout_status: the new copy is completely independent of the
442 frodo 62 original one. Returns NULL if there is not enough memory. */
443 frodo 2 extern psiconv_paragraph_layout psiconv_clone_paragraph_layout
444     (psiconv_paragraph_layout ls);
445    
446     extern psiconv_character_layout psiconv_clone_character_layout
447     (psiconv_character_layout ls);
448    
449 frodo 62 /* Get a numbered style. Returns NULL if the style is unknown. */
450 frodo 2 extern psiconv_word_style psiconv_get_style (psiconv_word_styles_section ss, int nr);
451    
452     extern void psiconv_free_color(psiconv_color color);
453     extern void psiconv_free_border(psiconv_border border);
454     extern void psiconv_free_bullet(psiconv_bullet bullet);
455     extern void psiconv_free_font(psiconv_font font);
456     extern void psiconv_free_tab(psiconv_tab tab);
457     extern void psiconv_free_tabs(psiconv_all_tabs tabs);
458     extern void psiconv_free_paragraph_layout(psiconv_paragraph_layout layout);
459     extern void psiconv_free_character_layout(psiconv_character_layout layout);
460     extern void psiconv_free_word_style(psiconv_word_style style);
461     extern void psiconv_free_word_styles_section
462     (psiconv_word_styles_section styles);
463     extern void psiconv_free_header_section(psiconv_header_section header);
464     extern void psiconv_free_section_table_entry(psiconv_section_table_entry entry);
465     extern void psiconv_free_section_table_section
466     (psiconv_section_table_section section);
467     extern void psiconv_free_application_id_section
468     (psiconv_application_id_section section);
469     extern void psiconv_free_in_line_layout(psiconv_in_line_layout layout);
470     extern void psiconv_free_in_line_layouts(psiconv_in_line_layouts layouts);
471     extern void psiconv_free_replacement(psiconv_replacement replacement);
472     extern void psiconv_free_replacements(psiconv_replacements replacements);
473     extern void psiconv_free_paragraph(psiconv_paragraph paragraph);
474     extern void psiconv_free_text_and_layout(psiconv_text_and_layout text);
475     extern void psiconv_free_texted_section(psiconv_texted_section section);
476     extern void psiconv_free_page_header(psiconv_page_header header);
477     extern void psiconv_free_page_layout_section
478     (psiconv_page_layout_section section);
479     extern void psiconv_free_word_status_section
480     (psiconv_word_status_section section);
481     extern void psiconv_free_word_f(psiconv_word_f file);
482 frodo 12 extern void psiconv_free_texted_f(psiconv_texted_f file);
483     extern void psiconv_free_paint_data_section(psiconv_paint_data_section section);
484     extern void psiconv_free_pictures(psiconv_pictures section);
485 frodo 42 extern void psiconv_free_jumptable_section
486     (psiconv_jumptable_section section);
487 frodo 12 extern void psiconv_free_mbm_f(psiconv_mbm_f file);
488 frodo 24 extern void psiconv_free_sketch_section(psiconv_sketch_section sec);
489     extern void psiconv_free_sketch_f(psiconv_sketch_f file);
490 frodo 41 extern void psiconv_free_clipart_section(psiconv_clipart_section section);
491     extern void psiconv_free_cliparts(psiconv_cliparts section);
492     extern void psiconv_free_clipart_f(psiconv_clipart_f file);
493 frodo 24
494 frodo 41
495 frodo 2 extern void psiconv_free_file(psiconv_file file);
496    
497 frodo 55 #ifdef __cplusplus
498     }
499     #endif /* __cplusplus */
500 frodo 2
501     #endif /* def PSICONV_DATA_H */

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