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

Annotation of mandoc/term.h, Revision 1.21

1.21    ! kristaps    1: /* $Id: term.h,v 1.20 2009/03/11 00:39:58 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
                      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
                      7:  * above copyright notice and this permission notice appear in all
                      8:  * copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11:  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12:  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13:  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16:  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17:  * PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #ifndef TERM_H
                     20: #define TERM_H
                     21:
                     22: #include "mdoc.h"
                     23:
1.13      kristaps   24: #define        INDENT            6
                     25:
1.1       kristaps   26: __BEGIN_DECLS
                     27:
1.14      kristaps   28: enum   tsym {
                     29:        TERMSYM_RBRACK =        0,
                     30:        TERMSYM_LBRACK =        1,
                     31:        TERMSYM_LARROW =        2,
                     32:        TERMSYM_RARROW =        3,
                     33:        TERMSYM_UARROW =        4,
                     34:        TERMSYM_DARROW =        5,
                     35:        TERMSYM_LSQUOTE =       6,
                     36:        TERMSYM_RSQUOTE =       7,
                     37:        TERMSYM_SQUOTE =        8,
                     38:        TERMSYM_LDQUOTE =       9,
                     39:        TERMSYM_RDQUOTE =       10,
                     40:        TERMSYM_DQUOTE =        11,
                     41:        TERMSYM_LT =            12,
                     42:        TERMSYM_GT =            13,
                     43:        TERMSYM_LE =            14,
                     44:        TERMSYM_GE =            15,
                     45:        TERMSYM_EQ =            16,
                     46:        TERMSYM_NEQ =           17,
                     47:        TERMSYM_ACUTE =         18,
                     48:        TERMSYM_GRAVE =         19,
                     49:        TERMSYM_PI =            20,
                     50:        TERMSYM_PLUSMINUS =     21,
                     51:        TERMSYM_INF =           22,
                     52:        TERMSYM_INF2 =          23,
                     53:        TERMSYM_NAN =           24,
                     54:        TERMSYM_BAR =           25,
                     55:        TERMSYM_BULLET =        26,
                     56:        TERMSYM_AMP =           27,
1.15      kristaps   57:        TERMSYM_EM =            28,
                     58:        TERMSYM_EN =            29,
                     59:        TERMSYM_COPY =          30,
                     60:        TERMSYM_ASTERISK =      31,
                     61:        TERMSYM_SLASH =         32,
                     62:        TERMSYM_HYPHEN =        33,
                     63:        TERMSYM_SPACE =         34,
                     64:        TERMSYM_PERIOD =        35,
1.18      kristaps   65:        TERMSYM_BREAK =         36,
                     66:        TERMSYM_LANGLE =        37,
1.20      kristaps   67:        TERMSYM_RANGLE =        38,
                     68:        TERMSYM_LBRACE =        39,
1.21    ! kristaps   69:        TERMSYM_RBRACE =        40,
        !            70:        TERMSYM_MAX =           41
1.14      kristaps   71: };
                     72:
                     73:
                     74: enum   tstyle {
                     75:        TERMSTYLE_CLEAR =       0,
                     76:        TERMSTYLE_BOLD =        1,
                     77:        TERMSTYLE_UNDER =       2,
                     78:        TERMSTYLE_MAX =         3
                     79: };
                     80:
                     81: struct termsym {
                     82:        const char       *sym;
                     83:        size_t            sz;
                     84: };
                     85:
1.1       kristaps   86: struct termp {
                     87:        size_t            rmargin;
                     88:        size_t            maxrmargin;
                     89:        size_t            maxcols;
                     90:        size_t            offset;
                     91:        size_t            col;
                     92:        int               flags;
                     93: #define        TERMP_BOLD       (1 << 0)       /* Embolden words. */
                     94: #define        TERMP_UNDERLINE  (1 << 1)       /* Underline words. */
                     95: #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
                     96: #define        TERMP_NOLPAD     (1 << 3)       /* No leftpad before flush. */
                     97: #define        TERMP_NOBREAK    (1 << 4)       /* No break after flush. */
1.3       kristaps   98: #define        TERMP_LITERAL    (1 << 5)       /* Literal words. */
1.4       kristaps   99: #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
1.10      kristaps  100: #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
1.19      kristaps  101: #define        TERMP_NONOBREAK  (1 << 8)
1.1       kristaps  102:        char             *buf;
1.14      kristaps  103:        struct termsym   *symtab;       /* Special-symbol table. */
                    104:        struct termsym   *styletab;     /* Style table. */
1.1       kristaps  105: };
                    106:
1.6       kristaps  107: struct termpair {
1.9       kristaps  108:        struct termpair  *ppair;
1.6       kristaps  109:        int               type;
                    110: #define        TERMPAIR_FLAG    (1 << 0)
1.7       kristaps  111:        int               flag;
                    112:        size_t            offset;
1.8       kristaps  113:        size_t            rmargin;
1.9       kristaps  114:        int               count;
1.6       kristaps  115: };
                    116:
1.12      kristaps  117: #define        TERMPAIR_SETFLAG(termp, p, fl) \
1.6       kristaps  118:        do { \
1.7       kristaps  119:                assert(! (TERMPAIR_FLAG & (p)->type)); \
1.12      kristaps  120:                (termp)->flags |= (fl); \
1.7       kristaps  121:                (p)->flag = (fl); \
                    122:                (p)->type |= TERMPAIR_FLAG; \
1.6       kristaps  123:        } while (0)
                    124:
1.1       kristaps  125: struct termact {
                    126:        int             (*pre)(struct termp *,
1.6       kristaps  127:                                struct termpair *,
1.1       kristaps  128:                                const struct mdoc_meta *,
                    129:                                const struct mdoc_node *);
1.2       kristaps  130:        void            (*post)(struct termp *,
1.6       kristaps  131:                                struct termpair *,
1.1       kristaps  132:                                const struct mdoc_meta *,
                    133:                                const struct mdoc_node *);
                    134: };
                    135:
                    136: void                     newln(struct termp *);
                    137: void                     vspace(struct termp *);
                    138: void                     word(struct termp *, const char *);
                    139: void                     flushln(struct termp *);
1.2       kristaps  140: void                     transcode(struct termp *,
                    141:                                const char *, size_t);
1.5       kristaps  142: void                     subtree(struct termp *,
                    143:                                const struct mdoc_meta *,
                    144:                                const struct mdoc_node *);
                    145:
1.14      kristaps  146:
1.1       kristaps  147: const  struct termact   *termacts;
                    148:
                    149: __END_DECLS
                    150:
                    151: #endif /*!TERM_H*/

CVSweb