2 * Paper printing definitions.
4 * This header file defines data structures and constants which are
5 * shared between bk_paper.c and its clients bk_ps.c and bk_pdf.c.
8 #ifndef HALIBUT_PAPER_H
9 #define HALIBUT_PAPER_H
11 typedef struct document_Tag document
;
12 typedef struct font_data_Tag font_data
;
13 typedef struct font_encoding_Tag font_encoding
;
14 typedef struct font_list_Tag font_list
;
15 typedef struct para_data_Tag para_data
;
16 typedef struct line_data_Tag line_data
;
17 typedef struct page_data_Tag page_data
;
18 typedef struct subfont_map_entry_Tag subfont_map_entry
;
19 typedef struct text_fragment_Tag text_fragment
;
20 typedef struct xref_Tag xref
;
21 typedef struct xref_dest_Tag xref_dest
;
22 typedef struct rect_Tag rect
;
25 * This data structure represents the overall document, in the form
26 * it will be given to the client backends.
29 int paper_width
, paper_height
;
35 * This data structure represents a particular font.
37 struct font_data_Tag
{
39 * Specify the PostScript name of the font and its point size.
43 * An array of pointers to the available glyph names, and their
44 * corresponding character widths. These two arrays have
48 const char *const *glyphs
;
51 * For reasonably speedy lookup, we set up a 65536-element
52 * table representing the Unicode BMP (I can conveniently
53 * restrict myself to the BMP for the moment since I happen to
54 * know that no glyph in the Adobe Glyph List falls outside
55 * it), whose elements are indices into the above two arrays.
57 unsigned short bmp
[65536];
59 * At some point I'm going to divide the font into sub-fonts
60 * with largely non-overlapping encoding vectors. This array
61 * will track which glyphs go into which subfonts. Also here I
62 * keep track of the latest subfont of any given font, so I can
63 * go back and extend its encoding.
65 subfont_map_entry
*subfont_map
;
66 font_encoding
*latest_subfont
;
68 * The font list to which this font belongs.
73 struct subfont_map_entry_Tag
{
74 font_encoding
*subfont
;
75 unsigned char position
;
79 * This data structure represents a sub-font: a font with an
82 struct font_encoding_Tag
{
85 char *name
; /* used by client backends */
87 font_data
*font
; /* the parent font structure */
88 const char *vector
[256]; /* the actual encoding vector */
89 int indices
[256]; /* indices back into main font struct */
90 wchar_t to_unicode
[256]; /* PDF will want to know this */
91 int free_pos
; /* space left to extend encoding */
95 * This data structure represents the overall list of sub-fonts in
98 struct font_list_Tag
{
104 * Constants defining array indices for the various fonts used in a
115 * This is the data structure which is stored in the private_data
116 * field of each paragraph. It divides the paragraph up into a
117 * linked list of lines, while at the same time providing for those
118 * lines to be linked together into a much longer list spanning the
119 * whole document for page-breaking purposes.
122 struct para_data_Tag
{
124 * Data about the fonts used in this paragraph. Indices are the
125 * FONT_* constants defined above.
127 font_data
*fonts
[NFONTS
];
130 * Pointers to the first and last line of the paragraph. The
131 * line structures are linked into a list, which runs from
132 * `first' to `last' as might be expected. However, the list
133 * does not terminate there: first->prev will end up pointing
134 * to the last line of the previous paragraph in most cases,
135 * and likewise last->next will point to the first line of the
138 line_data
*first
; /* first line in paragraph */
139 line_data
*last
; /* last line in paragraph */
142 struct line_data_Tag
{
144 * The parent paragraph.
148 * Pointers to join lines into a linked list.
153 * The extent of the text displayed on this line. Also mention
154 * its starting x position, and by how much the width of spaces
155 * needs to be adjusted for paragraph justification.
157 * (Unlike most of the `last' pointers defined in this file,
158 * this `end' pointer points to the word _after_ the last one
159 * that should be displayed on the line. This is how it's
160 * returned from wrap_para().)
165 int hshortfall
, nspaces
; /* for justifying paragraphs */
167 * Auxiliary text: a section number in a margin, or a list item
168 * bullet or number. Also mention where to display this text
169 * relative to the left margin.
175 * This line might have a non-negotiable page break before it.
176 * Also there will be space required above and below it; also I
177 * store the physical line height (defined as the maximum of
178 * the heights of the three fonts in the pdata) because it's
179 * easier than looking it up repeatedly during page breaking.
186 * Penalties for page breaking before or after this line.
188 int penalty_before
, penalty_after
;
190 * These fields are used in the page breaking algorithm.
193 int vshortfall
, text
, space
;
194 line_data
*page_last
; /* last line on a page starting here */
196 * After page breaking, we can assign an actual y-coordinate on
197 * the page to each line. Also we store a pointer back to the
198 * page structure itself.
205 * This data structure is constructed to describe each page of the
208 struct page_data_Tag
{
210 * Pointers to join pages into a linked list.
215 * The set of lines displayed on this page.
217 line_data
*first_line
;
218 line_data
*last_line
;
220 * After text rendering: the set of actual pieces of text
221 * needing to be displayed on this page.
223 text_fragment
*first_text
;
224 text_fragment
*last_text
;
231 * Rectangles to be drawn. (These are currently only used for
232 * underlining chapter titles and drawing horizontal rules.)
237 * This spare pointer field is for use by the client backends.
242 struct text_fragment_Tag
{
250 struct xref_dest_Tag
{
251 enum { NONE
, PAGE
, URL
} type
;
268 * Functions and data exported from psdata.c.
270 wchar_t ps_glyph_to_unicode(char const *glyph
);
271 extern const char *const ps_std_glyphs
[];
272 const int *ps_std_font_widths(char const *fontname
);