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

Diff for /mandoc/term.h between version 1.23 and 1.75

version 1.23, 2009/03/15 07:08:53 version 1.75, 2010/07/25 11:44:31
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * 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   * 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"  
   
 #define INDENT            6  
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 enum    tsym {  struct  termp;
         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,  
         TERMSYM_LBRACE =        39,  
         TERMSYM_RBRACE =        40,  
         TERMSYM_MAX =           41  
 };  
   
 enum    termenc {  enum    termenc {
         TERMENC_ANSI,          TERMENC_ASCII
         TERMENC_NROFF  
 };  };
   
 struct  termsym {  enum    termtype {
         const char       *sym;          TERMTYPE_CHAR,
         size_t            sz;          TERMTYPE_PS,
           TERMTYPE_PDF
 };  };
   
 struct  termp {  enum    termfont {
         size_t            rmargin;          TERMFONT_NONE = 0,
         size_t            maxrmargin;          TERMFONT_BOLD,
         size_t            maxcols;          TERMFONT_UNDER,
         size_t            offset;          TERMFONT__MAX
         size_t            col;  
         int               iflags;  
 #define TERMP_NOPUNT     (1 << 0)  
         int               flags;  
 #define TERMP_NOSPACE    (1 << 0)       /* No space before words. */  
 #define TERMP_NOLPAD     (1 << 1)       /* No leftpad before flush. */  
 #define TERMP_NOBREAK    (1 << 2)       /* No break after flush. */  
 #define TERMP_LITERAL    (1 << 3)       /* Literal words. */  
 #define TERMP_IGNDELIM   (1 << 4)       /* Delims like regulars. */  
 #define TERMP_NONOSPACE  (1 << 5)       /* No space (no autounset). */  
 #define TERMP_NONOBREAK  (1 << 7)       /* Don't newln NOBREAK. */  
 #define TERMP_STYLE      0xff00         /* Style mask. */  
 #define TERMP_BOLD       (1 << 8)       /* Styles... */  
 #define TERMP_UNDER      (1 << 9)  
 #define TERMP_BLUE       (1 << 10)  
 #define TERMP_RED        (1 << 11)  
 #define TERMP_YELLOW     (1 << 12)  
 #define TERMP_MAGENTA    (1 << 13)  
 #define TERMP_CYAN       (1 << 14)  
 #define TERMP_GREEN      (1 << 15)  
         char             *buf;  
         struct termsym   *symtab;       /* Special-symbol table. */  
         enum termenc      enc;          /* Encoding. */  
 };  };
   
 struct  termpair {  #define TERM_MAXMARGIN    100000 /* FIXME */
         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) \  typedef void    (*term_margin)(struct termp *, const void *);
         do { \  
                 assert(! (TERMPAIR_FLAG & (p)->type)); \  
                 (termp)->flags |= (fl); \  
                 (p)->flag = (fl); \  
                 (p)->type |= TERMPAIR_FLAG; \  
         } while (0)  
   
 struct  termact {  struct  termp_ps {
         int             (*pre)(struct termp *,          int               flags;
                                 struct termpair *,  #define PS_INLINE        (1 << 0)       /* we're in a word */
                                 const struct mdoc_meta *,  #define PS_MARGINS       (1 << 1)       /* we're in the margins */
                                 const struct mdoc_node *);  #define PS_NEWPAGE       (1 << 2)       /* new page, no words yet */
         void            (*post)(struct termp *,          size_t            pscol;        /* visible column (AFM units) */
                                 struct termpair *,          size_t            psrow;        /* visible row (AFM units) */
                                 const struct mdoc_meta *,          char             *psmarg;       /* margin buf */
                                 const struct mdoc_node *);          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) */
           size_t            pdfbytes;
           size_t            pdflastpg;
           size_t            pdfbody;
 };  };
   
 void                      newln(struct termp *);  struct  termp {
 void                      vspace(struct termp *);          enum termtype     type;
 void                      word(struct termp *, const char *);          size_t            defrmargin;   /* Right margin of the device.. */
 void                      flushln(struct termp *);          size_t            rmargin;      /* Current right margin. */
 void                      transcode(struct termp *,          size_t            maxrmargin;   /* Max right margin. */
                                 const char *, size_t);          size_t            maxcols;      /* Max size of buf. */
 void                      subtree(struct termp *,          size_t            offset;       /* Margin offest. */
                                 const struct mdoc_meta *,          size_t            tabwidth;     /* Distance of tab positions. */
                                 const struct mdoc_node *);          size_t            col;          /* Bytes in buf. */
           size_t            viscol;       /* Chars on current line. */
           int               overstep;     /* See termp_flushln(). */
           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_IGNDELIM   (1 << 6)       /* Delims like regulars. */
   #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
   #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 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 *);
   
 const   struct termact   *termacts;  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
   
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.75
CVSweb