term.h

   1 /* $Id: term.h,v 1.16 2009/03/03 22:17:19 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the
   7  * above copyright notice and this permission notice appear in all
   8  * copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  * PERFORMANCE OF THIS SOFTWARE.
  18  */
  19 #ifndef TERM_H
  20 #define TERM_H
  21
  22 #include "mdoc.h"
  23
  24 #define INDENT            6
  25
  26 __BEGIN_DECLS
  27
  28 enum    tsym {
  29         TERMSYM_RBRACK =        0,
  30         TERMSYM_LBRACK =        1,
  31         TERMSYM_LARROW =        2,
  32         TERMSYM_RARROW =        3,
  33         TERMSYM_UARROW =        4,
  34         TERMSYM_DARROW =        5,
  35         TERMSYM_LSQUOTE =       6,
  36         TERMSYM_RSQUOTE =       7,
  37         TERMSYM_SQUOTE =        8,
  38         TERMSYM_LDQUOTE =       9,
  39         TERMSYM_RDQUOTE =       10,
  40         TERMSYM_DQUOTE =        11,
  41         TERMSYM_LT =            12,
  42         TERMSYM_GT =            13,
  43         TERMSYM_LE =            14,
  44         TERMSYM_GE =            15,
  45         TERMSYM_EQ =            16,
  46         TERMSYM_NEQ =           17,
  47         TERMSYM_ACUTE =         18,
  48         TERMSYM_GRAVE =         19,
  49         TERMSYM_PI =            20,
  50         TERMSYM_PLUSMINUS =     21,
  51         TERMSYM_INF =           22,
  52         TERMSYM_INF2 =          23,
  53         TERMSYM_NAN =           24,
  54         TERMSYM_BAR =           25,
  55         TERMSYM_BULLET =        26,
  56         TERMSYM_AMP =           27,
  57         TERMSYM_EM =            28,
  58         TERMSYM_EN =            29,
  59         TERMSYM_COPY =          30,
  60         TERMSYM_ASTERISK =      31,
  61         TERMSYM_SLASH =         32,
  62         TERMSYM_HYPHEN =        33,
  63         TERMSYM_SPACE =         34,
  64         TERMSYM_PERIOD =        35,
  65         TERMSYM_BREAK =         36
  66 };
  67
  68
  69 enum    tstyle {
  70         TERMSTYLE_CLEAR =       0,
  71         TERMSTYLE_BOLD =        1,
  72         TERMSTYLE_UNDER =       2,
  73         TERMSTYLE_MAX =         3
  74 };
  75
  76 struct  termsym {
  77         const char       *sym;
  78         size_t            sz;
  79 };
  80
  81 struct  termp {
  82         size_t            rmargin;
  83         size_t            maxrmargin;
  84         size_t            maxcols;
  85         size_t            offset;
  86         size_t            col;
  87         int               flags;
  88 #define TERMP_BOLD       (1 << 0)       /* Embolden words. */
  89 #define TERMP_UNDERLINE  (1 << 1)       /* Underline words. */
  90 #define TERMP_NOSPACE    (1 << 2)       /* No space before words. */
  91 #define TERMP_NOLPAD     (1 << 3)       /* No leftpad before flush. */
  92 #define TERMP_NOBREAK    (1 << 4)       /* No break after flush. */
  93 #define TERMP_LITERAL    (1 << 5)       /* Literal words. */
  94 #define TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
  95 #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
  96 #define TERMP_NORPAD     (1 << 8)       /* No rightpad. */
  97 #define TERMP_NOINSET    (1 << 9)       /* If NOBREAK, no inset. */
  98         char             *buf;
  99         struct termsym   *symtab;       /* Special-symbol table. */
 100         struct termsym   *styletab;     /* Style table. */
 101 };
 102
 103 struct  termpair {
 104         struct termpair  *ppair;
 105         int               type;
 106 #define TERMPAIR_FLAG    (1 << 0)
 107         int               flag;
 108         size_t            offset;
 109         size_t            rmargin;
 110         int               count;
 111 };
 112
 113 #define TERMPAIR_SETFLAG(termp, p, fl) \
 114         do { \
 115                 assert(! (TERMPAIR_FLAG & (p)->type)); \
 116                 (termp)->flags |= (fl); \
 117                 (p)->flag = (fl); \
 118                 (p)->type |= TERMPAIR_FLAG; \
 119         } while (0)
 120
 121 struct  termact {
 122         int             (*pre)(struct termp *,
 123                                 struct termpair *,
 124                                 const struct mdoc_meta *,
 125                                 const struct mdoc_node *);
 126         void            (*post)(struct termp *,
 127                                 struct termpair *,
 128                                 const struct mdoc_meta *,
 129                                 const struct mdoc_node *);
 130 };
 131
 132 void                      newln(struct termp *);
 133 void                      vspace(struct termp *);
 134 void                      word(struct termp *, const char *);
 135 void                      flushln(struct termp *);
 136 void                      transcode(struct termp *,
 137                                 const char *, size_t);
 138 void                      subtree(struct termp *,
 139                                 const struct mdoc_meta *,
 140                                 const struct mdoc_node *);
 141
 142
 143 const   struct termact   *termacts;
 144
 145 __END_DECLS
 146
 147 #endif /*!TERM_H*/