Bug in utoi(), which made it ignore a leading minus sign when
[sgt/halibut] / paper.h
diff --git a/paper.h b/paper.h
index 8478e25..652fa7e 100644 (file)
--- a/paper.h
+++ b/paper.h
@@ -8,7 +8,19 @@
 #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
+
+/* Glyphs are represented by integer indicies into a table of names. */
+typedef unsigned short glyph;
+#define NOGLYPH 0xFFFF
+
 typedef struct document_Tag document;
+typedef struct glyph_width_Tag glyph_width;
+typedef struct kern_pair_Tag kern_pair;
+typedef struct ligature_Tag ligature;
+typedef struct font_info_Tag font_info;
 typedef struct font_data_Tag font_data;
 typedef struct font_encoding_Tag font_encoding;
 typedef struct font_list_Tag font_list;
@@ -19,6 +31,8 @@ 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
@@ -28,24 +42,61 @@ 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 particular font.
+ * This data structure represents the normal width of a single glyph
+ * in a font.
  */
-struct font_data_Tag {
+struct glyph_width_Tag {
+    glyph glyph;
+    int width;
+};
+
+/*
+ * This data structure represents a kerning pair within a font.
+ */
+struct kern_pair_Tag {
+    /* Glyph indices. */
+    glyph left, right;
+    /* Kern amount, in internal units. */
+    int kern;
+};
+
+/*
+ * ... and this one represents a ligature.
+ */
+struct ligature_Tag {
+    glyph left, right, lig;
+};
+
+/*
+ * This data structure holds static information about a font that doesn't
+ * depend on the particular document.  It gets generated when the font's
+ * metrics are read in.
+ */
+
+font_info *all_fonts;
+
+struct font_info_Tag {
+    font_info *next;
     /*
      * Specify the PostScript name of the font and its point size.
      */
     const char *name;
     /*
-     * An array of pointers to the available glyph names, and their
-     * corresponding character widths. These two arrays have
-     * parallel indices.
+     * Pointer to data about the file containing the font, if any.
      */
-    int nglyphs;
-    const char *const *glyphs;
-    const int *widths;
+    void *fontfile;
+    enum { TYPE1, TRUETYPE } filetype;
+    /* A tree of glyph_widths */
+    tree234 *widths;
+    /* A tree of kern_pairs */
+    tree234 *kerns;
+    /* ... and one of ligatures */
+    tree234 *ligs;
     /*
      * For reasonably speedy lookup, we set up a 65536-element
      * table representing the Unicode BMP (I can conveniently
@@ -53,15 +104,35 @@ struct font_data_Tag {
      * know that no glyph in the Adobe Glyph List falls outside
      * it), whose elements are indices into the above two arrays.
      */
-    unsigned short bmp[65536];
+    glyph bmp[65536];
+    /*
+     * Various bits of metadata needed for the /FontDescriptor dictionary
+     * in PDF.
+     */
+    float fontbbox[4];
+    float capheight;
+    float xheight;
+    float ascent;
+    float descent;
+    float stemv;
+    float stemh;
+    float italicangle;
+};
+
+/*
+ * This structure holds the information about how a font is used
+ * in a document.
+ */
+struct font_data_Tag {
+    font_info const *info;
     /*
      * At some point I'm going to divide the font into sub-fonts
-     * with largely non-overlapping encoding vectors. This array
+     * with largely non-overlapping encoding vectors. This tree
      * will track which glyphs go into which subfonts. Also here I
      * keep track of the latest subfont of any given font, so I can
      * go back and extend its encoding.
      */
-    subfont_map_entry *subfont_map;
+    tree234 *subfont_map;
     font_encoding *latest_subfont;
     /*
      * The font list to which this font belongs.
@@ -84,8 +155,7 @@ struct font_encoding_Tag {
     char *name;                               /* used by client backends */
 
     font_data *font;                  /* the parent font structure */
-    const char *vector[256];          /* the actual encoding vector */
-    int indices[256];                 /* indices back into main font struct */
+    glyph vector[256];                /* the actual encoding vector */
     wchar_t to_unicode[256];          /* PDF will want to know this */
     int free_pos;                     /* space left to extend encoding */
 };
@@ -119,6 +189,7 @@ enum {
  */
 
 struct para_data_Tag {
+    para_data *next;
     /*
      * Data about the fonts used in this paragraph. Indices are the
      * FONT_* constants defined above.
@@ -136,6 +207,33 @@ 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;
+    /*
+     * Sometimes (in code paragraphs) we want to override the flags
+     * passed to render_string().
+     */
+    unsigned extraflags;
+    /*
+     * 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 {
@@ -162,6 +260,7 @@ 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
@@ -188,9 +287,9 @@ struct line_data_Tag {
     /*
      * 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
@@ -227,6 +326,16 @@ struct page_data_Tag {
     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;
@@ -238,6 +347,7 @@ struct text_fragment_Tag {
     font_encoding *fe;
     int fontsize;
     char *text;
+    int width;
 };
 
 struct xref_dest_Tag {
@@ -252,11 +362,67 @@ struct xref_Tag {
     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;
+};
+
+/*
+ * Functions exported from bk_paper.c
+ */
+int width_cmp(void *, void *); /* use when setting up widths */
+int kern_cmp(void *, void *); /* use when setting up kern_pairs */
+int lig_cmp(void *, void *); /* use when setting up ligatures */
+int find_width(font_data *, glyph);
+
 /*
  * Functions and data exported from psdata.c.
  */
-wchar_t ps_glyph_to_unicode(char const *glyph);
+glyph glyph_intern(char const *);
+char const *glyph_extern(glyph);
+wchar_t ps_glyph_to_unicode(glyph);
 extern const char *const ps_std_glyphs[];
+extern glyph const tt_std_glyphs[];
+void init_std_fonts(void);
 const int *ps_std_font_widths(char const *fontname);
+const kern_pair *ps_std_font_kerns(char const *fontname);
+
+/*
+ * Functions exported from bk_pdf.c
+ */
+typedef struct object_Tag object;
+typedef struct objlist_Tag objlist;
+object *new_object(objlist *list);
+void objtext(object *o, char const *text);
+void objstream(object *o, char const *text);
+void objstream_len(object *o, char const *text, size_t len);
+char *pdf_outline_convert(wchar_t *s, int *len);
+
+/*
+ * Function exported from bk_ps.c
+ */
+void ps_token(FILE *fp, int *cc, char const *fmt, ...);
+
+/*
+ * Backend functions exported by in_pf.c
+ */
+void pf_part1(font_info *fi, char **bufp, size_t *lenp);
+void pf_part2(font_info *fi, char **bufp, size_t *lenp);
+void pf_writeps(font_info const *fi, FILE *ofp);
+
+/*
+ * Backend functions exported by in_sfnt.c
+ */
+typedef struct sfnt_Tag sfnt;
+glyph sfnt_indextoglyph(sfnt *sf, unsigned idx);
+unsigned sfnt_glyphtoindex(sfnt *sf, glyph g);
+unsigned sfnt_nglyphs(sfnt *sf);
+void sfnt_writeps(font_info const *fi, FILE *ofp);
+void sfnt_data(font_info *fi, char **bufp, size_t *lenp);
 
 #endif