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

Annotation of mandoc/term.h, Revision 1.65

1.65    ! kristaps    1: /*     $Id: term.h,v 1.64 2010/06/19 20:46:28 kristaps Exp $ */
1.1       kristaps    2: /*
1.64      kristaps    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.36      kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.36      kristaps    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.
1.1       kristaps   16:  */
                     17: #ifndef TERM_H
                     18: #define TERM_H
                     19:
                     20: __BEGIN_DECLS
                     21:
1.58      kristaps   22: struct termp;
                     23:
1.28      kristaps   24: enum   termenc {
1.46      kristaps   25:        TERMENC_ASCII
1.28      kristaps   26: };
                     27:
1.58      kristaps   28: enum   termtype {
                     29:        TERMTYPE_CHAR,
                     30:        TERMTYPE_PS
                     31: };
                     32:
1.51      kristaps   33: enum   termfont {
                     34:        TERMFONT_NONE = 0,
                     35:        TERMFONT_BOLD,
                     36:        TERMFONT_UNDER
                     37: };
1.53      kristaps   38:
                     39: #define        TERM_MAXMARGIN    100000 /* FIXME */
1.51      kristaps   40:
1.58      kristaps   41: typedef void   (*term_margin)(struct termp *, const void *);
                     42:
1.60      kristaps   43: struct termp_ps {
1.61      kristaps   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 */
1.62      kristaps   53:        char              last;         /* character buffer */
1.63      kristaps   54:        enum termfont     lastf;        /* last set font */
1.60      kristaps   55: };
                     56:
1.1       kristaps   57: struct termp {
1.58      kristaps   58:        enum termtype     type;
1.55      joerg      59:        size_t            defrmargin;   /* Right margin of the device.. */
1.27      kristaps   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. */
1.56      schwarze   64:        size_t            tabwidth;     /* Distance of tab positions. */
1.27      kristaps   65:        size_t            col;          /* Bytes in buf. */
1.57      schwarze   66:        size_t            viscol;       /* Chars on current line. */
1.52      kristaps   67:        int               overstep;     /* See termp_flushln(). */
1.1       kristaps   68:        int               flags;
1.54      kristaps   69: #define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */
1.38      kristaps   70: #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
1.39      kristaps   71: #define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
                     72: #define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
1.38      kristaps   73: #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
                     74: #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
1.39      kristaps   75: #define        TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
                     76: #define        TERMP_HANG       (1 << 9)       /* See term_flushln(). */
1.41      kristaps   77: #define        TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
1.42      kristaps   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(). */
1.27      kristaps   81:        char             *buf;          /* Output buffer. */
1.28      kristaps   82:        enum termenc      enc;          /* Type of encoding. */
1.27      kristaps   83:        void             *symtab;       /* Encoded-symbol table. */
1.51      kristaps   84:        enum termfont     fontl;        /* Last font set. */
                     85:        enum termfont     fontq[10];    /* Symmetric fonts. */
                     86:        int               fonti;        /* Index of font stack. */
1.58      kristaps   87:        term_margin       headf;        /* invoked to print head */
                     88:        term_margin       footf;        /* invoked to print foot */
1.60      kristaps   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);
1.65    ! kristaps   94:        size_t          (*width)(const struct termp *, char);
1.58      kristaps   95:        const void       *argf;         /* arg for headf/footf */
1.60      kristaps   96:        union {
                     97:                struct termp_ps ps;
                     98:        } engine;
1.1       kristaps   99: };
                    100:
1.59      kristaps  101: struct termp    *term_alloc(enum termenc);
                    102: void             term_free(struct termp *);
1.29      kristaps  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 *);
1.58      kristaps  107: void             term_begin(struct termp *, term_margin,
                    108:                        term_margin, const void *);
                    109: void             term_end(struct termp *);
1.1       kristaps  110:
1.65    ! kristaps  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);
1.48      kristaps  117:
1.51      kristaps  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:
1.1       kristaps  126: __END_DECLS
                    127:
                    128: #endif /*!TERM_H*/

CVSweb