[BACK]Return to term.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/term.h between version 1.19 and 1.93

version 1.19, 2009/03/04 14:41:40 version 1.93, 2013/08/08 20:07:47
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
 #ifndef TERM_H  #ifndef TERM_H
 #define TERM_H  #define TERM_H
   
 #include "mdoc.h"  __BEGIN_DECLS
   
 #define INDENT            6  struct  termp;
   
 __BEGIN_DECLS  enum    termenc {
           TERMENC_ASCII,
           TERMENC_LOCALE,
           TERMENC_UTF8
   };
   
 enum    tsym {  enum    termtype {
         TERMSYM_RBRACK =        0,          TERMTYPE_CHAR,
         TERMSYM_LBRACK =        1,          TERMTYPE_PS,
         TERMSYM_LARROW =        2,          TERMTYPE_PDF
         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  
 };  };
   
   enum    termfont {
 enum    tstyle {          TERMFONT_NONE = 0,
         TERMSTYLE_CLEAR =       0,          TERMFONT_BOLD,
         TERMSTYLE_BOLD =        1,          TERMFONT_UNDER,
         TERMSTYLE_UNDER =       2,          TERMFONT_BI,
         TERMSTYLE_MAX =         3          TERMFONT__MAX
 };  };
   
 struct  termsym {  #define TERM_MAXMARGIN    100000 /* FIXME */
         const char       *sym;  
         size_t            sz;  typedef void    (*term_margin)(struct termp *, const void *);
   
   struct  termp_tbl {
           int               width;        /* width in fixed chars */
           int               decimal;      /* decimal point position */
 };  };
   
 struct  termp {  struct  termp {
         size_t            rmargin;          enum termtype     type;
         size_t            maxrmargin;          struct rofftbl    tbl;          /* table configuration */
         size_t            maxcols;          int               mdocstyle;    /* imitate mdoc(7) output */
         size_t            offset;          size_t            defindent;    /* Default indent for text. */
         size_t            col;          size_t            defrmargin;   /* Right margin of the device. */
           size_t            rmargin;      /* Current right margin. */
           size_t            maxrmargin;   /* Max right margin. */
           int               maxcols;      /* Max size of buf. */
           size_t            offset;       /* Margin offest. */
           size_t            tabwidth;     /* Distance of tab positions. */
           int               col;          /* Bytes in buf. */
           size_t            viscol;       /* Chars on current line. */
           int               overstep;     /* See termp_flushln(). */
           int               skipvsp;      /* Vertical space to skip. */
         int               flags;          int               flags;
 #define TERMP_BOLD       (1 << 0)       /* Embolden words. */  #define TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */
 #define TERMP_UNDERLINE  (1 << 1)       /* Underline words. */  
 #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)       /* See term_flushln(). */
 #define TERMP_NOBREAK    (1 << 4)       /* No break after flush. */  
 #define TERMP_LITERAL    (1 << 5)       /* Literal words. */  
 #define TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */  #define TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
 #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */  #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
 #define TERMP_NONOBREAK  (1 << 8)  #define TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
         char             *buf;  #define TERMP_HANG       (1 << 9)       /* See term_flushln(). */
         struct termsym   *symtab;       /* Special-symbol table. */  #define TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
         struct termsym   *styletab;     /* Style table. */  #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. */
   #define TERMP_SKIPCHAR   (1 << 16)      /* Skip the next character. */
           int              *buf;          /* Output buffer. */
           enum termenc      enc;          /* Type of encoding. */
           struct mchars    *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 *, int);
           void            (*begin)(struct termp *);
           void            (*end)(struct termp *);
           void            (*endline)(struct termp *);
           void            (*advance)(struct termp *, size_t);
           size_t          (*width)(const struct termp *, int);
           double          (*hspan)(const struct termp *,
                                   const struct roffsu *);
           const void       *argf;         /* arg for headf/footf */
           struct termp_ps  *ps;
 };  };
   
 struct  termpair {  void              term_eqn(struct termp *, const struct eqn *);
         struct termpair  *ppair;  void              term_tbl(struct termp *, const struct tbl_span *);
         int               type;  void              term_free(struct termp *);
 #define TERMPAIR_FLAG    (1 << 0)  void              term_newln(struct termp *);
         int               flag;  void              term_vspace(struct termp *);
         size_t            offset;  void              term_word(struct termp *, const char *);
         size_t            rmargin;  void              term_flushln(struct termp *);
         int               count;  void              term_begin(struct termp *, term_margin,
 };                          term_margin, const void *);
   void              term_end(struct termp *);
   
 #define TERMPAIR_SETFLAG(termp, p, fl) \  size_t            term_hspan(const struct termp *,
         do { \                          const struct roffsu *);
                 assert(! (TERMPAIR_FLAG & (p)->type)); \  size_t            term_vspan(const struct termp *,
                 (termp)->flags |= (fl); \                          const struct roffsu *);
                 (p)->flag = (fl); \  size_t            term_strlen(const struct termp *, const char *);
                 (p)->type |= TERMPAIR_FLAG; \  size_t            term_len(const struct termp *, size_t);
         } while (0)  
   
 struct  termact {  enum termfont     term_fonttop(struct termp *);
         int             (*pre)(struct termp *,  const void       *term_fontq(struct termp *);
                                 struct termpair *,  void              term_fontpush(struct termp *, enum termfont);
                                 const struct mdoc_meta *,  void              term_fontpop(struct termp *);
                                 const struct mdoc_node *);  void              term_fontpopq(struct termp *, const void *);
         void            (*post)(struct termp *,  void              term_fontrepl(struct termp *, enum termfont);
                                 struct termpair *,  void              term_fontlast(struct termp *);
                                 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;  
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.19  
changed lines
  Added in v.1.93
CVSweb