Note discarding of \m, \M, and \s in COMPATIBILITY sections.

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index 5824f2a5e6cca23f21d6931ea032909f88d167f4..3e1d4df06d7e7efb935a020060c31e7014875b13 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,6 +1,6 @@
-/*     $Id: term.h,v 1.47 2009/09/17 07:41:28 kristaps Exp $ */
+/*     $Id: term.h,v 1.74 2010/07/13 23:53:20 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -19,17 +19,65 @@
 
 __BEGIN_DECLS
 
 
 __BEGIN_DECLS
 

+struct termp;
+

 enum   termenc {
        TERMENC_ASCII
 };
 
 enum   termenc {
        TERMENC_ASCII
 };
 

+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS
+};
+
+enum   termfont {
+       TERMFONT_NONE = 0,
+       TERMFONT_BOLD,
+       TERMFONT_UNDER,
+       TERMFONT__MAX
+};
+
+#define        TERM_MAXMARGIN    100000 /* FIXME */
+
+typedef void   (*term_margin)(struct termp *, const void *);
+
+struct termp_ps {
+       int               flags;
+#define        PS_INLINE        (1 << 0)       /* we're in a word */
+#define        PS_MARGINS       (1 << 1)       /* we're in the margins */
+#define        PS_NEWPAGE       (1 << 2)       /* new page, no words yet */
+       size_t            pscol;        /* visible column (AFM units) */
+       size_t            psrow;        /* visible row (AFM units) */
+       char             *psmarg;       /* margin buf */
+       size_t            psmargsz;     /* margin buf size */
+       size_t            psmargcur;    /* cur index in margin buf */
+       char              last;         /* character buffer */
+       enum termfont     lastf;        /* last set font */
+       size_t            scale;        /* font scaling factor */
+       size_t            pages;        /* number of pages shown */
+       size_t            lineheight;   /* line height (AFM units) */
+       size_t            top;          /* body top (AFM units) */
+       size_t            bottom;       /* body bottom (AFM units) */
+       size_t            height;       /* page height (AFM units */
+       size_t            width;        /* page width (AFM units) */
+       size_t            left;         /* body left (AFM units) */
+       size_t            header;       /* header pos (AFM units) */
+       size_t            footer;       /* footer pos (AFM units) */
+};
+

 struct termp {
 struct termp {

+       enum termtype     type;
+       size_t            defrmargin;   /* Right margin of the device.. */

        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            maxcols;      /* Max size of buf. */
        size_t            offset;       /* Margin offest. */
        size_t            rmargin;      /* Current right margin. */
        size_t            maxrmargin;   /* Max right margin. */
        size_t            maxcols;      /* Max size of buf. */
        size_t            offset;       /* Margin offest. */

+       size_t            tabwidth;     /* Distance of tab positions. */

        size_t            col;          /* Bytes in buf. */
        size_t            col;          /* Bytes in buf. */

+       size_t            viscol;       /* Chars on current line. */
+       int               overstep;     /* See termp_flushln(). */

        int               flags;
        int               flags;

+#define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */

 #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
 #define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
 #define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
 #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
 #define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
 #define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */


@@ -41,17 +89,54 @@ struct      termp {
 #define        TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
 #define        TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
 #define        TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
 #define        TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
 #define        TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
 #define        TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */

-       int               bold;
-       int               under;
+#define        TERMP_KEEP       (1 << 14)      /* Keep words together. */
+#define        TERMP_PREKEEP    (1 << 15)      /* ...starting with the next one. */

        char             *buf;          /* Output buffer. */
        enum termenc      enc;          /* Type of encoding. */
        void             *symtab;       /* Encoded-symbol table. */
        char             *buf;          /* Output buffer. */
        enum termenc      enc;          /* Type of encoding. */
        void             *symtab;       /* Encoded-symbol table. */

+       enum termfont     fontl;        /* Last font set. */
+       enum termfont     fontq[10];    /* Symmetric fonts. */
+       int               fonti;        /* Index of font stack. */
+       term_margin       headf;        /* invoked to print head */
+       term_margin       footf;        /* invoked to print foot */
+       void            (*letter)(struct termp *, char);
+       void            (*begin)(struct termp *);
+       void            (*end)(struct termp *);
+       void            (*endline)(struct termp *);
+       void            (*advance)(struct termp *, size_t);
+       size_t          (*width)(const struct termp *, char);
+       double          (*hspan)(const struct termp *,
+                               const struct roffsu *);
+       const void       *argf;         /* arg for headf/footf */
+       union {
+               struct termp_ps ps;
+       } engine;

 };
 
 };
 

+struct termp    *term_alloc(enum termenc);
+void             term_free(struct termp *);

 void             term_newln(struct termp *);
 void             term_vspace(struct termp *);
 void             term_word(struct termp *, const char *);
 void             term_flushln(struct termp *);
 void             term_newln(struct termp *);
 void             term_vspace(struct termp *);
 void             term_word(struct termp *, const char *);
 void             term_flushln(struct termp *);

+void             term_begin(struct termp *, term_margin, 
+                       term_margin, const void *);
+void             term_end(struct termp *);
+
+size_t           term_hspan(const struct termp *, 
+                       const struct roffsu *);
+size_t           term_vspan(const struct termp *,
+                       const struct roffsu *);
+size_t           term_strlen(const struct termp *, const char *);
+size_t           term_len(const struct termp *, size_t);
+
+enum termfont    term_fonttop(struct termp *);
+const void      *term_fontq(struct termp *);
+void             term_fontpush(struct termp *, enum termfont);
+void             term_fontpop(struct termp *);
+void             term_fontpopq(struct termp *, const void *);
+void             term_fontrepl(struct termp *, enum termfont);
+void             term_fontlast(struct termp *);

 
 __END_DECLS
 
 
 __END_DECLS