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

Annotation of mandoc/term.h, Revision 1.130

1.130   ! schwarze    1: /*     $Id: term.h,v 1.129 2017/06/17 14:55:30 schwarze Exp $ */
1.1       kristaps    2: /*
1.87      schwarze    3:  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.119     schwarze    4:  * Copyright (c) 2011-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.36      kristaps    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.112     schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.36      kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.112     schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.36      kristaps   13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   17:  */
                     18:
1.28      kristaps   19: enum   termenc {
1.84      kristaps   20:        TERMENC_ASCII,
1.85      kristaps   21:        TERMENC_LOCALE,
                     22:        TERMENC_UTF8
1.28      kristaps   23: };
                     24:
1.58      kristaps   25: enum   termtype {
                     26:        TERMTYPE_CHAR,
1.75      kristaps   27:        TERMTYPE_PS,
                     28:        TERMTYPE_PDF
1.58      kristaps   29: };
                     30:
1.51      kristaps   31: enum   termfont {
                     32:        TERMFONT_NONE = 0,
                     33:        TERMFONT_BOLD,
1.68      kristaps   34:        TERMFONT_UNDER,
1.93      schwarze   35:        TERMFONT_BI,
1.68      kristaps   36:        TERMFONT__MAX
1.51      kristaps   37: };
1.53      kristaps   38:
1.130   ! schwarze   39: struct eqn_box;
1.112     schwarze   40: struct roff_meta;
1.119     schwarze   41: struct roff_node;
                     42: struct tbl_span;
1.107     schwarze   43: struct termp;
                     44:
1.112     schwarze   45: typedef void   (*term_margin)(struct termp *, const struct roff_meta *);
1.58      kristaps   46:
1.78      kristaps   47: struct termp_tbl {
                     48:        int               width;        /* width in fixed chars */
                     49:        int               decimal;      /* decimal point position */
                     50: };
                     51:
1.125     schwarze   52: struct termp_col {
                     53:        int              *buf;          /* Output buffer. */
                     54:        size_t            maxcols;      /* Allocated bytes in buf. */
1.127     schwarze   55:        size_t            lastcol;      /* Last byte in buf. */
1.126     schwarze   56:        size_t            col;          /* Byte in buf to be written. */
1.125     schwarze   57:        size_t            rmargin;      /* Current right margin. */
                     58:        size_t            offset;       /* Current left margin. */
                     59: };
                     60:
1.1       kristaps   61: struct termp {
1.125     schwarze   62:        struct rofftbl    tbl;          /* Table configuration. */
                     63:        struct termp_col *tcols;        /* Array of table columns. */
                     64:        struct termp_col *tcol;         /* Current table column. */
                     65:        size_t            maxtcol;      /* Allocated table columns. */
1.126     schwarze   66:        size_t            lasttcol;     /* Last column currently used. */
1.115     schwarze   67:        size_t            line;         /* Current output line number. */
1.89      schwarze   68:        size_t            defindent;    /* Default indent for text. */
1.78      kristaps   69:        size_t            defrmargin;   /* Right margin of the device. */
1.98      schwarze   70:        size_t            lastrmargin;  /* Right margin before the last ll. */
1.27      kristaps   71:        size_t            maxrmargin;   /* Max right margin. */
1.124     schwarze   72:        size_t            col;          /* Byte position in buf. */
1.57      schwarze   73:        size_t            viscol;       /* Chars on current line. */
1.126     schwarze   74:        size_t            trailspace;   /* See term_flushln(). */
1.122     schwarze   75:        size_t            minbl;        /* Minimum blanks before next field. */
1.125     schwarze   76:        int               synopsisonly; /* Print the synopsis only. */
                     77:        int               mdocstyle;    /* Imitate mdoc(7) output. */
1.121     schwarze   78:        int               ti;           /* Temporary indent for one line. */
1.91      schwarze   79:        int               skipvsp;      /* Vertical space to skip. */
1.1       kristaps   80:        int               flags;
1.114     schwarze   81: #define        TERMP_SENTENCE   (1 << 0)       /* Space before a sentence. */
                     82: #define        TERMP_NOSPACE    (1 << 1)       /* No space before words. */
                     83: #define        TERMP_NONOSPACE  (1 << 2)       /* No space (no autounset). */
                     84: #define        TERMP_NBRWORD    (1 << 3)       /* Make next word nonbreaking. */
                     85: #define        TERMP_KEEP       (1 << 4)       /* Keep words together. */
                     86: #define        TERMP_PREKEEP    (1 << 5)       /* ...starting with the next one. */
                     87: #define        TERMP_BACKAFTER  (1 << 6)       /* Back up after next character. */
                     88: #define        TERMP_BACKBEFORE (1 << 7)       /* Back up before next character. */
1.96      schwarze   89: #define        TERMP_NOBREAK    (1 << 8)       /* See term_flushln(). */
1.116     schwarze   90: #define        TERMP_BRTRSP     (1 << 9)       /* See term_flushln(). */
                     91: #define        TERMP_BRIND      (1 << 10)      /* See term_flushln(). */
1.122     schwarze   92: #define        TERMP_HANG       (1 << 11)      /* See term_flushln(). */
                     93: #define        TERMP_NOPAD      (1 << 12)      /* See term_flushln(). */
1.116     schwarze   94: #define        TERMP_NOSPLIT    (1 << 13)      /* Do not break line before .An. */
                     95: #define        TERMP_SPLIT      (1 << 14)      /* Break line before .An. */
                     96: #define        TERMP_NONEWLINE  (1 << 15)      /* No line break in nofill mode. */
1.123     schwarze   97: #define        TERMP_BRNEVER    (1 << 16)      /* Don't even break at maxrmargin. */
                     98: #define        TERMP_NOBUF      (1 << 17)      /* Bypass output buffer. */
                     99: #define        TERMP_NEWMC      (1 << 18)      /* No .mc printed yet. */
                    100: #define        TERMP_ENDMC      (1 << 19)      /* Next break ends .mc mode. */
1.127     schwarze  101: #define        TERMP_MULTICOL   (1 << 20)      /* Multiple column mode. */
1.125     schwarze  102:        enum termtype     type;         /* Terminal, PS, or PDF. */
1.28      kristaps  103:        enum termenc      enc;          /* Type of encoding. */
1.51      kristaps  104:        enum termfont     fontl;        /* Last font set. */
1.109     schwarze  105:        enum termfont    *fontq;        /* Symmetric fonts. */
                    106:        int               fontsz;       /* Allocated size of font stack */
1.51      kristaps  107:        int               fonti;        /* Index of font stack. */
1.58      kristaps  108:        term_margin       headf;        /* invoked to print head */
                    109:        term_margin       footf;        /* invoked to print foot */
1.81      kristaps  110:        void            (*letter)(struct termp *, int);
1.60      kristaps  111:        void            (*begin)(struct termp *);
                    112:        void            (*end)(struct termp *);
                    113:        void            (*endline)(struct termp *);
                    114:        void            (*advance)(struct termp *, size_t);
1.113     schwarze  115:        void            (*setwidth)(struct termp *, int, int);
1.81      kristaps  116:        size_t          (*width)(const struct termp *, int);
1.113     schwarze  117:        int             (*hspan)(const struct termp *,
1.70      kristaps  118:                                const struct roffsu *);
1.58      kristaps  119:        const void       *argf;         /* arg for headf/footf */
1.123     schwarze  120:        const char       *mc;           /* Margin character. */
1.83      kristaps  121:        struct termp_ps  *ps;
1.1       kristaps  122: };
1.107     schwarze  123:
                    124:
1.119     schwarze  125: const char      *ascii_uc2str(int);
1.104     schwarze  126:
1.119     schwarze  127: void             roff_term_pre(struct termp *, const struct roff_node *);
1.1       kristaps  128:
1.130   ! schwarze  129: void             term_eqn(struct termp *, const struct eqn_box *);
1.77      kristaps  130: void             term_tbl(struct termp *, const struct tbl_span *);
1.59      kristaps  131: void             term_free(struct termp *);
1.127     schwarze  132: void             term_setcol(struct termp *, size_t);
1.29      kristaps  133: void             term_newln(struct termp *);
                    134: void             term_vspace(struct termp *);
                    135: void             term_word(struct termp *, const char *);
                    136: void             term_flushln(struct termp *);
1.101     schwarze  137: void             term_begin(struct termp *, term_margin,
1.112     schwarze  138:                        term_margin, const struct roff_meta *);
1.58      kristaps  139: void             term_end(struct termp *);
1.1       kristaps  140:
1.99      schwarze  141: void             term_setwidth(struct termp *, const char *);
1.110     schwarze  142: int              term_hspan(const struct termp *, const struct roffsu *);
1.128     schwarze  143: int              term_hen(const struct termp *, const struct roffsu *);
1.110     schwarze  144: int              term_vspan(const struct termp *, const struct roffsu *);
1.65      kristaps  145: size_t           term_strlen(const struct termp *, const char *);
                    146: size_t           term_len(const struct termp *, size_t);
1.120     schwarze  147:
                    148: void             term_tab_set(const struct termp *, const char *);
1.129     schwarze  149: void             term_tab_iset(size_t);
1.120     schwarze  150: size_t           term_tab_next(size_t);
1.48      kristaps  151:
1.51      kristaps  152: void             term_fontpush(struct termp *, enum termfont);
                    153: void             term_fontpop(struct termp *);
1.111     schwarze  154: void             term_fontpopq(struct termp *, int);
1.51      kristaps  155: void             term_fontrepl(struct termp *, enum termfont);
                    156: void             term_fontlast(struct termp *);

CVSweb