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

Annotation of mandoc/term.h, Revision 1.78

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

CVSweb