It turns out that the man format requires the \& sequence (to

[sgt/halibut] / paper.h

diff --git a/paper.h b/paper.h
index 3b4a944..6813fe6 100644 (file)
--- a/paper.h
+++ b/paper.h
@@ -8,7 +8,12 @@
 #ifndef HALIBUT_PAPER_H
 #define HALIBUT_PAPER_H
 
+/* Number of internal units per PostScript point. */
+#define UNITS_PER_PT 1000
+#define FUNITS_PER_PT 1000.0
+
 typedef struct document_Tag document;
+typedef struct kern_pair_Tag kern_pair;
 typedef struct font_data_Tag font_data;
 typedef struct font_encoding_Tag font_encoding;
 typedef struct font_list_Tag font_list;
@@ -17,6 +22,10 @@ typedef struct line_data_Tag line_data;
 typedef struct page_data_Tag page_data;
 typedef struct subfont_map_entry_Tag subfont_map_entry;
 typedef struct text_fragment_Tag text_fragment;
+typedef struct xref_Tag xref;
+typedef struct xref_dest_Tag xref_dest;
+typedef struct rect_Tag rect;
+typedef struct outline_element_Tag outline_element;
 
 /*
  * This data structure represents the overall document, in the form
@@ -26,6 +35,18 @@ struct document_Tag {
     int paper_width, paper_height;
     font_list *fonts;
     page_data *pages;
+    outline_element *outline_elements;
+    int n_outline_elements;
+};
+
+/*
+ * This data structure represents a kerning pair within a font.
+ */
+struct kern_pair_Tag {
+    /* Glyph indices, in font_data.glyphs. */
+    unsigned short left, right;
+    /* Kern amount, in internal units. */
+    int kern;
 };
 
 /*
@@ -44,6 +65,7 @@ struct font_data_Tag {
     int nglyphs;
     const char *const *glyphs;
     const int *widths;
+    tree234 *kerns;
     /*
      * For reasonably speedy lookup, we set up a 65536-element
      * table representing the Unicode BMP (I can conveniently
@@ -117,6 +139,7 @@ enum {
  */
 
 struct para_data_Tag {
+    para_data *next;
     /*
      * Data about the fonts used in this paragraph. Indices are the
      * FONT_* constants defined above.
@@ -134,6 +157,28 @@ struct para_data_Tag {
      */
     line_data *first;                 /* first line in paragraph */
     line_data *last;                  /* last line in paragraph */
+    /*
+     * Some paragraphs have associated graphics; currently this is
+     * nothing more complex than a single black rectangle.
+     */
+    enum {
+       RECT_NONE, RECT_CHAPTER_UNDERLINE, RECT_RULE
+    } rect_type;
+    /*
+     * We left- and right-justify in special circumstances.
+     */
+    enum {
+       JUST, LEFT, RIGHT
+    } justification;
+    /*
+     * For constructing the page outline.
+     */
+    int outline_level;                /* 0=title 1=C 2=H 3=S 4=S2... */
+    wchar_t *outline_title;
+    /*
+     * For adding the page number of a contents entry afterwards.
+     */
+    paragraph *contents_entry;
 };
 
 struct line_data_Tag {
@@ -160,12 +205,14 @@ struct line_data_Tag {
     word *end;
     int xpos;
     int hshortfall, nspaces;          /* for justifying paragraphs */
+    int real_shortfall;
     /*
      * Auxiliary text: a section number in a margin, or a list item
      * bullet or number. Also mention where to display this text
      * relative to the left margin.
      */
     word *aux_text;
+    word *aux_text_2;
     int aux_left_indent;
     /*
      * This line might have a non-negotiable page break before it.
@@ -179,11 +226,15 @@ struct line_data_Tag {
     int space_after;
     int line_height;
     /*
+     * Penalties for page breaking before or after this line.
+     */
+    int penalty_before, penalty_after;
+    /*
      * These fields are used in the page breaking algorithm.
      */
-    int bestcost;
-    int vshortfall, text, space;
-    line_data *page_last;             /* last line on a page starting here */
+    int *bestcost;
+    int *vshortfall, *text, *space;
+    line_data **page_last;            /* last line on a page starting here */
     /*
      * After page breaking, we can assign an actual y-coordinate on
      * the page to each line. Also we store a pointer back to the
@@ -215,6 +266,21 @@ struct page_data_Tag {
     text_fragment *first_text;
     text_fragment *last_text;
     /*
+     * Cross-references.
+     */
+    xref *first_xref;
+    xref *last_xref;
+    /*
+     * Rectangles to be drawn. (These are currently only used for
+     * underlining chapter titles and drawing horizontal rules.)
+     */
+    rect *first_rect;
+    rect *last_rect;
+    /*
+     * The page number, as a string.
+     */
+    wchar_t *number;
+    /*
      * This spare pointer field is for use by the client backends.
      */
     void *spare;
@@ -226,6 +292,29 @@ struct text_fragment_Tag {
     font_encoding *fe;
     int fontsize;
     char *text;
+    int width;
+};
+
+struct xref_dest_Tag {
+    enum { NONE, PAGE, URL } type;
+    page_data *page;
+    char *url;
+};
+
+struct xref_Tag {
+    xref *next;
+    int lx, rx, ty, by;
+    xref_dest dest;
+};
+
+struct rect_Tag {
+    rect *next;
+    int x, y, w, h;
+};
+
+struct outline_element_Tag {
+    int level;                        /* 0=title 1=C 2=H 3=S 4=S2... */
+    para_data *pdata;
 };
 
 /*
@@ -234,5 +323,6 @@ struct text_fragment_Tag {
 wchar_t ps_glyph_to_unicode(char const *glyph);
 extern const char *const ps_std_glyphs[];
 const int *ps_std_font_widths(char const *fontname);
+const kern_pair *ps_std_font_kerns(char const *fontname);
 
 #endif