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

[mandoc.git] / term.h

diff --git a/term.h b/term.h
index 29cd9ca76144297ee66611edf69f98db76a28cea..3e1d4df06d7e7efb935a020060c31e7014875b13 100644 (file)
--- a/term.h
+++ b/term.h
@@ -1,147 +1,142 @@
-/* $Id: term.h,v 1.19 2009/03/04 14:41:40 kristaps Exp $ */
+/*     $Id: term.h,v 1.74 2010/07/13 23:53:20 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008 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
  *
  * Permission to use, copy, modify, and distribute this software for any

- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.

  *
  *

- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

  */
 #ifndef TERM_H
 #define TERM_H
 
  */
 #ifndef TERM_H
 #define TERM_H
 

-#include "mdoc.h"
-
-#define        INDENT            6
-

 __BEGIN_DECLS
 
 __BEGIN_DECLS
 

-enum   tsym {
-       TERMSYM_RBRACK =        0,
-       TERMSYM_LBRACK =        1,
-       TERMSYM_LARROW =        2,
-       TERMSYM_RARROW =        3,
-       TERMSYM_UARROW =        4,
-       TERMSYM_DARROW =        5,
-       TERMSYM_LSQUOTE =       6,
-       TERMSYM_RSQUOTE =       7,
-       TERMSYM_SQUOTE =        8,
-       TERMSYM_LDQUOTE =       9,
-       TERMSYM_RDQUOTE =       10,
-       TERMSYM_DQUOTE =        11,
-       TERMSYM_LT =            12,
-       TERMSYM_GT =            13,
-       TERMSYM_LE =            14,
-       TERMSYM_GE =            15,
-       TERMSYM_EQ =            16,
-       TERMSYM_NEQ =           17,
-       TERMSYM_ACUTE =         18,
-       TERMSYM_GRAVE =         19,
-       TERMSYM_PI =            20,
-       TERMSYM_PLUSMINUS =     21,
-       TERMSYM_INF =           22,
-       TERMSYM_INF2 =          23,
-       TERMSYM_NAN =           24,
-       TERMSYM_BAR =           25,
-       TERMSYM_BULLET =        26,
-       TERMSYM_AMP =           27,
-       TERMSYM_EM =            28,
-       TERMSYM_EN =            29,
-       TERMSYM_COPY =          30,
-       TERMSYM_ASTERISK =      31,
-       TERMSYM_SLASH =         32,
-       TERMSYM_HYPHEN =        33,
-       TERMSYM_SPACE =         34,
-       TERMSYM_PERIOD =        35,
-       TERMSYM_BREAK =         36,
-       TERMSYM_LANGLE =        37,
-       TERMSYM_RANGLE =        38
+struct termp;
+
+enum   termenc {
+       TERMENC_ASCII

 };
 
 };
 

+enum   termtype {
+       TERMTYPE_CHAR,
+       TERMTYPE_PS
+};

 
 

-enum   tstyle {
-       TERMSTYLE_CLEAR =       0,
-       TERMSTYLE_BOLD =        1,
-       TERMSTYLE_UNDER =       2,
-       TERMSTYLE_MAX =         3
+enum   termfont {
+       TERMFONT_NONE = 0,
+       TERMFONT_BOLD,
+       TERMFONT_UNDER,
+       TERMFONT__MAX

 };
 
 };
 

-struct termsym {
-       const char       *sym;
-       size_t            sz;
+#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 {

-       size_t            rmargin;
-       size_t            maxrmargin;
-       size_t            maxcols;
-       size_t            offset;
-       size_t            col;
+       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            tabwidth;     /* Distance of tab positions. */
+       size_t            col;          /* Bytes in buf. */
+       size_t            viscol;       /* Chars on current line. */
+       int               overstep;     /* See termp_flushln(). */

        int               flags;
        int               flags;

-#define        TERMP_BOLD       (1 << 0)       /* Embolden words. */
-#define        TERMP_UNDERLINE  (1 << 1)       /* Underline words. */
+#define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */

 #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
 #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */

-#define        TERMP_NOLPAD     (1 << 3)       /* No leftpad before flush. */
-#define        TERMP_NOBREAK    (1 << 4)       /* No break after flush. */
-#define        TERMP_LITERAL    (1 << 5)       /* Literal words. */
+#define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
+#define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */

 #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
 #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
 #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
 #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */

-#define        TERMP_NONOBREAK  (1 << 8)
-       char             *buf;
-       struct termsym   *symtab;       /* Special-symbol table. */
-       struct termsym   *styletab;     /* Style table. */
+#define        TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
+#define        TERMP_HANG       (1 << 9)       /* See term_flushln(). */
+#define        TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
+#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_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. */
+       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 termpair {
-       struct termpair  *ppair;
-       int               type;
-#define        TERMPAIR_FLAG    (1 << 0)
-       int               flag;
-       size_t            offset;
-       size_t            rmargin;
-       int               count;
-};
-
-#define        TERMPAIR_SETFLAG(termp, p, fl) \
-       do { \
-               assert(! (TERMPAIR_FLAG & (p)->type)); \
-               (termp)->flags |= (fl); \
-               (p)->flag = (fl); \
-               (p)->type |= TERMPAIR_FLAG; \
-       } while (0)
-
-struct termact {
-       int             (*pre)(struct termp *,
-                               struct termpair *,
-                               const struct mdoc_meta *,
-                               const struct mdoc_node *);
-       void            (*post)(struct termp *,
-                               struct termpair *,
-                               const struct mdoc_meta *,
-                               const struct mdoc_node *);
-};
-
-void                     newln(struct termp *);
-void                     vspace(struct termp *);
-void                     word(struct termp *, const char *);
-void                     flushln(struct termp *);
-void                     transcode(struct termp *, 
-                               const char *, size_t);
-void                     subtree(struct termp *,
-                               const struct mdoc_meta *,
-                               const struct mdoc_node *);
-
-
-const  struct termact   *termacts;
+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_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