term.h

   1 /*      $Id: term.h,v 1.65 2010/06/25 18:53:14 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
   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 above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifndef TERM_H
  18 #define TERM_H
  19
  20 __BEGIN_DECLS
  21
  22 struct  termp;
  23
  24 enum    termenc {
  25         TERMENC_ASCII
  26 };
  27
  28 enum    termtype {
  29         TERMTYPE_CHAR,
  30         TERMTYPE_PS
  31 };
  32
  33 enum    termfont {
  34         TERMFONT_NONE = 0,
  35         TERMFONT_BOLD,
  36         TERMFONT_UNDER
  37 };
  38
  39 #define TERM_MAXMARGIN    100000 /* FIXME */
  40
  41 typedef void    (*term_margin)(struct termp *, const void *);
  42
  43 struct  termp_ps {
  44         int               psstate;      /* state of ps output */
  45 #define PS_INLINE        (1 << 0)       /* we're in a word */
  46 #define PS_MARGINS       (1 << 1)       /* we're in the margins */
  47         size_t            pscol;        /* visible column */
  48         size_t            psrow;        /* visible row */
  49         char             *psmarg;       /* margin buf */
  50         size_t            psmargsz;     /* margin buf size */
  51         size_t            psmargcur;    /* current pos in margin buf */
  52         size_t            pspage;       /* current page */
  53         char              last;         /* character buffer */
  54         enum termfont     lastf;        /* last set font */
  55 };
  56
  57 struct  termp {
  58         enum termtype     type;
  59         size_t            defrmargin;   /* Right margin of the device.. */
  60         size_t            rmargin;      /* Current right margin. */
  61         size_t            maxrmargin;   /* Max right margin. */
  62         size_t            maxcols;      /* Max size of buf. */
  63         size_t            offset;       /* Margin offest. */
  64         size_t            tabwidth;     /* Distance of tab positions. */
  65         size_t            col;          /* Bytes in buf. */
  66         size_t            viscol;       /* Chars on current line. */
  67         int               overstep;     /* See termp_flushln(). */
  68         int               flags;
  69 #define TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */
  70 #define TERMP_NOSPACE    (1 << 2)       /* No space before words. */
  71 #define TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
  72 #define TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
  73 #define TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
  74 #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
  75 #define TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
  76 #define TERMP_HANG       (1 << 9)       /* See term_flushln(). */
  77 #define TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
  78 #define TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
  79 #define TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
  80 #define TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
  81         char             *buf;          /* Output buffer. */
  82         enum termenc      enc;          /* Type of encoding. */
  83         void             *symtab;       /* Encoded-symbol table. */
  84         enum termfont     fontl;        /* Last font set. */
  85         enum termfont     fontq[10];    /* Symmetric fonts. */
  86         int               fonti;        /* Index of font stack. */
  87         term_margin       headf;        /* invoked to print head */
  88         term_margin       footf;        /* invoked to print foot */
  89         void            (*letter)(struct termp *, char);
  90         void            (*begin)(struct termp *);
  91         void            (*end)(struct termp *);
  92         void            (*endline)(struct termp *);
  93         void            (*advance)(struct termp *, size_t);
  94         size_t          (*width)(const struct termp *, char);
  95         const void       *argf;         /* arg for headf/footf */
  96         union {
  97                 struct termp_ps ps;
  98         } engine;
  99 };
 100
 101 struct termp     *term_alloc(enum termenc);
 102 void              term_free(struct termp *);
 103 void              term_newln(struct termp *);
 104 void              term_vspace(struct termp *);
 105 void              term_word(struct termp *, const char *);
 106 void              term_flushln(struct termp *);
 107 void              term_begin(struct termp *, term_margin,
 108                         term_margin, const void *);
 109 void              term_end(struct termp *);
 110
 111 size_t            term_hspan(const struct termp *,
 112                         const struct roffsu *);
 113 size_t            term_vspan(const struct termp *,
 114                         const struct roffsu *);
 115 size_t            term_strlen(const struct termp *, const char *);
 116 size_t            term_len(const struct termp *, size_t);
 117
 118 enum termfont     term_fonttop(struct termp *);
 119 const void       *term_fontq(struct termp *);
 120 void              term_fontpush(struct termp *, enum termfont);
 121 void              term_fontpop(struct termp *);
 122 void              term_fontpopq(struct termp *, const void *);
 123 void              term_fontrepl(struct termp *, enum termfont);
 124 void              term_fontlast(struct termp *);
 125
 126 __END_DECLS
 127
 128 #endif /*!TERM_H*/