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

Annotation of mandoc/term.h, Revision 1.71

1.71    ! kristaps    1: /*     $Id: term.h,v 1.70 2010/06/30 12:27:55 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,
1.68      kristaps   36:        TERMFONT_UNDER,
                     37:        TERMFONT__MAX
1.51      kristaps   38: };
1.53      kristaps   39:
                     40: #define        TERM_MAXMARGIN    100000 /* FIXME */
1.51      kristaps   41:
1.58      kristaps   42: typedef void   (*term_margin)(struct termp *, const void *);
                     43:
1.60      kristaps   44: struct termp_ps {
1.61      kristaps   45:        int               psstate;      /* state of ps output */
                     46: #define        PS_INLINE        (1 << 0)       /* we're in a word */
                     47: #define        PS_MARGINS       (1 << 1)       /* we're in the margins */
1.69      kristaps   48:        size_t            pscol;        /* visible column (AFM units) */
                     49:        size_t            psrow;        /* visible row (AFM units) */
1.61      kristaps   50:        char             *psmarg;       /* margin buf */
                     51:        size_t            psmargsz;     /* margin buf size */
1.68      kristaps   52:        size_t            psmargcur;    /* cur index in margin buf */
1.62      kristaps   53:        char              last;         /* character buffer */
1.63      kristaps   54:        enum termfont     lastf;        /* last set font */
1.68      kristaps   55:        size_t            pages;        /* number of pages shown */
1.69      kristaps   56:        size_t            lineheight;   /* line height (AFM units) */
                     57:        size_t            top;          /* body top (AFM units) */
                     58:        size_t            bottom;       /* body bottom (AFM units) */
                     59:        size_t            height;       /* page height (AFM units */
                     60:        size_t            width;        /* page width (AFM units) */
                     61:        size_t            left;         /* body left (AFM units) */
                     62:        size_t            header;       /* header pos (AFM units) */
                     63:        size_t            footer;       /* footer pos (AFM units) */
1.60      kristaps   64: };
                     65:
1.1       kristaps   66: struct termp {
1.58      kristaps   67:        enum termtype     type;
1.55      joerg      68:        size_t            defrmargin;   /* Right margin of the device.. */
1.27      kristaps   69:        size_t            rmargin;      /* Current right margin. */
                     70:        size_t            maxrmargin;   /* Max right margin. */
                     71:        size_t            maxcols;      /* Max size of buf. */
                     72:        size_t            offset;       /* Margin offest. */
1.56      schwarze   73:        size_t            tabwidth;     /* Distance of tab positions. */
1.27      kristaps   74:        size_t            col;          /* Bytes in buf. */
1.57      schwarze   75:        size_t            viscol;       /* Chars on current line. */
1.52      kristaps   76:        int               overstep;     /* See termp_flushln(). */
1.1       kristaps   77:        int               flags;
1.54      kristaps   78: #define        TERMP_SENTENCE   (1 << 1)       /* Space before a sentence. */
1.38      kristaps   79: #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
1.39      kristaps   80: #define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
                     81: #define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
1.38      kristaps   82: #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
                     83: #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
1.39      kristaps   84: #define        TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
                     85: #define        TERMP_HANG       (1 << 9)       /* See term_flushln(). */
1.41      kristaps   86: #define        TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
1.42      kristaps   87: #define        TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
                     88: #define        TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
                     89: #define        TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
1.66      schwarze   90: #define        TERMP_KEEP       (1 << 14)      /* Keep words together. */
                     91: #define        TERMP_PREKEEP    (1 << 15)      /* ...starting with the next one. */
1.27      kristaps   92:        char             *buf;          /* Output buffer. */
1.28      kristaps   93:        enum termenc      enc;          /* Type of encoding. */
1.27      kristaps   94:        void             *symtab;       /* Encoded-symbol table. */
1.51      kristaps   95:        enum termfont     fontl;        /* Last font set. */
                     96:        enum termfont     fontq[10];    /* Symmetric fonts. */
                     97:        int               fonti;        /* Index of font stack. */
1.58      kristaps   98:        term_margin       headf;        /* invoked to print head */
                     99:        term_margin       footf;        /* invoked to print foot */
1.60      kristaps  100:        void            (*letter)(struct termp *, char);
                    101:        void            (*begin)(struct termp *);
                    102:        void            (*end)(struct termp *);
                    103:        void            (*endline)(struct termp *);
                    104:        void            (*advance)(struct termp *, size_t);
1.65      kristaps  105:        size_t          (*width)(const struct termp *, char);
1.71    ! kristaps  106:        double          (*hspan)(const struct termp *,
1.70      kristaps  107:                                const struct roffsu *);
1.58      kristaps  108:        const void       *argf;         /* arg for headf/footf */
1.60      kristaps  109:        union {
                    110:                struct termp_ps ps;
                    111:        } engine;
1.1       kristaps  112: };
                    113:
1.59      kristaps  114: struct termp    *term_alloc(enum termenc);
                    115: void             term_free(struct termp *);
1.29      kristaps  116: void             term_newln(struct termp *);
                    117: void             term_vspace(struct termp *);
                    118: void             term_word(struct termp *, const char *);
                    119: void             term_flushln(struct termp *);
1.58      kristaps  120: void             term_begin(struct termp *, term_margin,
                    121:                        term_margin, const void *);
                    122: void             term_end(struct termp *);
1.1       kristaps  123:
1.65      kristaps  124: size_t           term_hspan(const struct termp *,
                    125:                        const struct roffsu *);
                    126: size_t           term_vspan(const struct termp *,
                    127:                        const struct roffsu *);
                    128: size_t           term_strlen(const struct termp *, const char *);
                    129: size_t           term_len(const struct termp *, size_t);
1.48      kristaps  130:
1.51      kristaps  131: enum termfont    term_fonttop(struct termp *);
                    132: const void      *term_fontq(struct termp *);
                    133: void             term_fontpush(struct termp *, enum termfont);
                    134: void             term_fontpop(struct termp *);
                    135: void             term_fontpopq(struct termp *, const void *);
                    136: void             term_fontrepl(struct termp *, enum termfont);
                    137: void             term_fontlast(struct termp *);
                    138:
1.1       kristaps  139: __END_DECLS
                    140:
                    141: #endif /*!TERM_H*/

CVSweb