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

Annotation of mandoc/term.h, Revision 1.23

1.23    ! kristaps    1: /* $Id: term.h,v 1.22 2009/03/14 12:35:02 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:
1.22      kristaps   73: enum   termenc {
                     74:        TERMENC_ANSI,
                     75:        TERMENC_NROFF
1.14      kristaps   76: };
                     77:
                     78: struct termsym {
                     79:        const char       *sym;
                     80:        size_t            sz;
                     81: };
                     82:
1.1       kristaps   83: struct termp {
                     84:        size_t            rmargin;
                     85:        size_t            maxrmargin;
                     86:        size_t            maxcols;
                     87:        size_t            offset;
                     88:        size_t            col;
1.23    ! kristaps   89:        int               iflags;
        !            90: #define        TERMP_NOPUNT     (1 << 0)
1.1       kristaps   91:        int               flags;
1.22      kristaps   92: #define        TERMP_NOSPACE    (1 << 0)       /* No space before words. */
                     93: #define        TERMP_NOLPAD     (1 << 1)       /* No leftpad before flush. */
                     94: #define        TERMP_NOBREAK    (1 << 2)       /* No break after flush. */
                     95: #define        TERMP_LITERAL    (1 << 3)       /* Literal words. */
                     96: #define        TERMP_IGNDELIM   (1 << 4)       /* Delims like regulars. */
                     97: #define        TERMP_NONOSPACE  (1 << 5)       /* No space (no autounset). */
                     98: #define        TERMP_NONOBREAK  (1 << 7)       /* Don't newln NOBREAK. */
                     99: #define        TERMP_STYLE      0xff00         /* Style mask. */
                    100: #define        TERMP_BOLD       (1 << 8)       /* Styles... */
                    101: #define        TERMP_UNDER      (1 << 9)
                    102: #define        TERMP_BLUE       (1 << 10)
                    103: #define        TERMP_RED        (1 << 11)
                    104: #define        TERMP_YELLOW     (1 << 12)
                    105: #define        TERMP_MAGENTA    (1 << 13)
                    106: #define        TERMP_CYAN       (1 << 14)
                    107: #define        TERMP_GREEN      (1 << 15)
1.1       kristaps  108:        char             *buf;
1.14      kristaps  109:        struct termsym   *symtab;       /* Special-symbol table. */
1.22      kristaps  110:        enum termenc      enc;          /* Encoding. */
1.1       kristaps  111: };
                    112:
1.6       kristaps  113: struct termpair {
1.9       kristaps  114:        struct termpair  *ppair;
1.6       kristaps  115:        int               type;
                    116: #define        TERMPAIR_FLAG    (1 << 0)
1.7       kristaps  117:        int               flag;
                    118:        size_t            offset;
1.8       kristaps  119:        size_t            rmargin;
1.9       kristaps  120:        int               count;
1.6       kristaps  121: };
                    122:
1.12      kristaps  123: #define        TERMPAIR_SETFLAG(termp, p, fl) \
1.6       kristaps  124:        do { \
1.7       kristaps  125:                assert(! (TERMPAIR_FLAG & (p)->type)); \
1.12      kristaps  126:                (termp)->flags |= (fl); \
1.7       kristaps  127:                (p)->flag = (fl); \
                    128:                (p)->type |= TERMPAIR_FLAG; \
1.6       kristaps  129:        } while (0)
                    130:
1.1       kristaps  131: struct termact {
                    132:        int             (*pre)(struct termp *,
1.6       kristaps  133:                                struct termpair *,
1.1       kristaps  134:                                const struct mdoc_meta *,
                    135:                                const struct mdoc_node *);
1.2       kristaps  136:        void            (*post)(struct termp *,
1.6       kristaps  137:                                struct termpair *,
1.1       kristaps  138:                                const struct mdoc_meta *,
                    139:                                const struct mdoc_node *);
                    140: };
                    141:
                    142: void                     newln(struct termp *);
                    143: void                     vspace(struct termp *);
                    144: void                     word(struct termp *, const char *);
                    145: void                     flushln(struct termp *);
1.2       kristaps  146: void                     transcode(struct termp *,
                    147:                                const char *, size_t);
1.5       kristaps  148: void                     subtree(struct termp *,
                    149:                                const struct mdoc_meta *,
                    150:                                const struct mdoc_node *);
                    151:
1.14      kristaps  152:
1.1       kristaps  153: const  struct termact   *termacts;
                    154:
                    155: __END_DECLS
                    156:
                    157: #endif /*!TERM_H*/

CVSweb