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 /* Number of internal units per PostScript point. */
12 #define UNITS_PER_PT 1000
13 #define FUNITS_PER_PT 1000.0
15 typedef struct document_Tag document
;
16 typedef struct kern_pair_Tag kern_pair
;
17 typedef struct font_info_Tag font_info
;
18 typedef struct font_data_Tag font_data
;
19 typedef struct font_encoding_Tag font_encoding
;
20 typedef struct font_list_Tag font_list
;
21 typedef struct para_data_Tag para_data
;
22 typedef struct line_data_Tag line_data
;
23 typedef struct page_data_Tag page_data
;
24 typedef struct subfont_map_entry_Tag subfont_map_entry
;
25 typedef struct text_fragment_Tag text_fragment
;
26 typedef struct xref_Tag xref
;
27 typedef struct xref_dest_Tag xref_dest
;
28 typedef struct rect_Tag rect
;
29 typedef struct outline_element_Tag outline_element
;
32 * This data structure represents the overall document, in the form
33 * it will be given to the client backends.
36 int paper_width
, paper_height
;
39 outline_element
*outline_elements
;
40 int n_outline_elements
;
44 * This data structure represents a kerning pair within a font.
46 struct kern_pair_Tag
{
47 /* Glyph indices, in font_data.glyphs. */
48 unsigned short left
, right
;
49 /* Kern amount, in internal units. */
54 * This data structure holds static information about a font that doesn't
55 * depend on the particular document. It gets generated when the font's
56 * metrics are read in.
61 struct font_info_Tag
{
64 * Specify the PostScript name of the font and its point size.
68 * The file containing this font, if any.
73 * Lengths of the unencrypted and encrypted portions of the font.
75 long length1
, length2
;
77 * An array of pointers to the available glyph names, and their
78 * corresponding character widths. These two arrays have
82 const char *const *glyphs
;
85 * Glyph indices sorted into glyph-name order, for name-to-index
88 unsigned short *glyphsbyname
;
89 /* A tree of kern_pairs */
92 * For reasonably speedy lookup, we set up a 65536-element
93 * table representing the Unicode BMP (I can conveniently
94 * restrict myself to the BMP for the moment since I happen to
95 * know that no glyph in the Adobe Glyph List falls outside
96 * it), whose elements are indices into the above two arrays.
98 unsigned short bmp
[65536];
100 * Various bits of metadata needed for the /FontDescriptor dictionary
114 * This structure holds the information about how a font is used
117 struct font_data_Tag
{
118 font_info
const *info
;
120 * At some point I'm going to divide the font into sub-fonts
121 * with largely non-overlapping encoding vectors. This array
122 * will track which glyphs go into which subfonts. Also here I
123 * keep track of the latest subfont of any given font, so I can
124 * go back and extend its encoding.
126 subfont_map_entry
*subfont_map
;
127 font_encoding
*latest_subfont
;
129 * The font list to which this font belongs.
134 struct subfont_map_entry_Tag
{
135 font_encoding
*subfont
;
136 unsigned char position
;
140 * This data structure represents a sub-font: a font with an
143 struct font_encoding_Tag
{
146 char *name
; /* used by client backends */
148 font_data
*font
; /* the parent font structure */
149 const char *vector
[256]; /* the actual encoding vector */
150 int indices
[256]; /* indices back into main font struct */
151 wchar_t to_unicode
[256]; /* PDF will want to know this */
152 int free_pos
; /* space left to extend encoding */
156 * This data structure represents the overall list of sub-fonts in
157 * the whole document.
159 struct font_list_Tag
{
165 * Constants defining array indices for the various fonts used in a
176 * This is the data structure which is stored in the private_data
177 * field of each paragraph. It divides the paragraph up into a
178 * linked list of lines, while at the same time providing for those
179 * lines to be linked together into a much longer list spanning the
180 * whole document for page-breaking purposes.
183 struct para_data_Tag
{
186 * Data about the fonts used in this paragraph. Indices are the
187 * FONT_* constants defined above.
189 font_data
*fonts
[NFONTS
];
192 * Pointers to the first and last line of the paragraph. The
193 * line structures are linked into a list, which runs from
194 * `first' to `last' as might be expected. However, the list
195 * does not terminate there: first->prev will end up pointing
196 * to the last line of the previous paragraph in most cases,
197 * and likewise last->next will point to the first line of the
200 line_data
*first
; /* first line in paragraph */
201 line_data
*last
; /* last line in paragraph */
203 * Some paragraphs have associated graphics; currently this is
204 * nothing more complex than a single black rectangle.
207 RECT_NONE
, RECT_CHAPTER_UNDERLINE
, RECT_RULE
210 * We left- and right-justify in special circumstances.
216 * For constructing the page outline.
218 int outline_level
; /* 0=title 1=C 2=H 3=S 4=S2... */
219 wchar_t *outline_title
;
221 * For adding the page number of a contents entry afterwards.
223 paragraph
*contents_entry
;
226 struct line_data_Tag
{
228 * The parent paragraph.
232 * Pointers to join lines into a linked list.
237 * The extent of the text displayed on this line. Also mention
238 * its starting x position, and by how much the width of spaces
239 * needs to be adjusted for paragraph justification.
241 * (Unlike most of the `last' pointers defined in this file,
242 * this `end' pointer points to the word _after_ the last one
243 * that should be displayed on the line. This is how it's
244 * returned from wrap_para().)
249 int hshortfall
, nspaces
; /* for justifying paragraphs */
252 * Auxiliary text: a section number in a margin, or a list item
253 * bullet or number. Also mention where to display this text
254 * relative to the left margin.
260 * This line might have a non-negotiable page break before it.
261 * Also there will be space required above and below it; also I
262 * store the physical line height (defined as the maximum of
263 * the heights of the three fonts in the pdata) because it's
264 * easier than looking it up repeatedly during page breaking.
271 * Penalties for page breaking before or after this line.
273 int penalty_before
, penalty_after
;
275 * These fields are used in the page breaking algorithm.
278 int *vshortfall
, *text
, *space
;
279 line_data
**page_last
; /* last line on a page starting here */
281 * After page breaking, we can assign an actual y-coordinate on
282 * the page to each line. Also we store a pointer back to the
283 * page structure itself.
290 * This data structure is constructed to describe each page of the
293 struct page_data_Tag
{
295 * Pointers to join pages into a linked list.
300 * The set of lines displayed on this page.
302 line_data
*first_line
;
303 line_data
*last_line
;
305 * After text rendering: the set of actual pieces of text
306 * needing to be displayed on this page.
308 text_fragment
*first_text
;
309 text_fragment
*last_text
;
316 * Rectangles to be drawn. (These are currently only used for
317 * underlining chapter titles and drawing horizontal rules.)
322 * The page number, as a string.
326 * This spare pointer field is for use by the client backends.
331 struct text_fragment_Tag
{
340 struct xref_dest_Tag
{
341 enum { NONE
, PAGE
, URL
} type
;
357 struct outline_element_Tag
{
358 int level
; /* 0=title 1=C 2=H 3=S 4=S2... */
363 * Functions exported from bk_paper.c
365 int kern_cmp(void *, void *); /* use when setting up kern_pairs */
366 void font_index_glyphs(font_info
*fi
);
367 int find_glyph(font_info
*fi
, char const *name
);
371 * Functions and data exported from psdata.c.
373 wchar_t ps_glyph_to_unicode(char const *glyph
);
374 extern const char *const ps_std_glyphs
[];
375 void init_std_fonts(void);
376 const int *ps_std_font_widths(char const *fontname
);
377 const kern_pair
*ps_std_font_kerns(char const *fontname
);
380 * Function from bk_pdf.c borrowed by bk_ps.c
382 char *pdf_outline_convert(wchar_t *s
, int *len
);
385 * Backend functions exported by in_pf.c
387 void pf_part1(font_info
*fi
, char **bufp
, size_t *lenp
);
388 void pf_part2(font_info
*fi
, char **bufp
, size_t *lenp
);