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

Annotation of mandoc/term.h, Revision 1.29

1.29    ! kristaps    1: /* $Id: term.h,v 1.28 2009/03/19 16:17:27 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.27      kristaps   24: /* FIXME - clean up tabs. */
1.25      kristaps   25:
1.13      kristaps   26: #define        INDENT            6
                     27:
1.1       kristaps   28: __BEGIN_DECLS
                     29:
1.28      kristaps   30: enum   termenc {
                     31:        TERMENC_ASCII,
                     32:        TERMENC_LATIN1,
                     33:        TERMENC_UTF8
                     34: };
                     35:
1.1       kristaps   36: struct termp {
1.27      kristaps   37:        size_t            rmargin;      /* Current right margin. */
                     38:        size_t            maxrmargin;   /* Max right margin. */
                     39:        size_t            maxcols;      /* Max size of buf. */
                     40:        size_t            offset;       /* Margin offest. */
                     41:        size_t            col;          /* Bytes in buf. */
1.1       kristaps   42:        int               flags;
1.22      kristaps   43: #define        TERMP_NOSPACE    (1 << 0)       /* No space before words. */
                     44: #define        TERMP_NOLPAD     (1 << 1)       /* No leftpad before flush. */
                     45: #define        TERMP_NOBREAK    (1 << 2)       /* No break after flush. */
                     46: #define        TERMP_LITERAL    (1 << 3)       /* Literal words. */
                     47: #define        TERMP_IGNDELIM   (1 << 4)       /* Delims like regulars. */
                     48: #define        TERMP_NONOSPACE  (1 << 5)       /* No space (no autounset). */
                     49: #define        TERMP_NONOBREAK  (1 << 7)       /* Don't newln NOBREAK. */
1.27      kristaps   50: #define        TERMP_STYLE       0x0300        /* Style mask. */
1.22      kristaps   51: #define        TERMP_BOLD       (1 << 8)       /* Styles... */
                     52: #define        TERMP_UNDER      (1 << 9)
1.27      kristaps   53:        char             *buf;          /* Output buffer. */
1.28      kristaps   54:        enum termenc      enc;          /* Type of encoding. */
1.27      kristaps   55:        void             *symtab;       /* Encoded-symbol table. */
1.1       kristaps   56: };
                     57:
1.25      kristaps   58: /* XXX - clean this up. */
                     59:
1.6       kristaps   60: struct termpair {
1.9       kristaps   61:        struct termpair  *ppair;
1.6       kristaps   62:        int               type;
                     63: #define        TERMPAIR_FLAG    (1 << 0)
1.7       kristaps   64:        int               flag;
                     65:        size_t            offset;
1.8       kristaps   66:        size_t            rmargin;
1.9       kristaps   67:        int               count;
1.6       kristaps   68: };
                     69:
1.12      kristaps   70: #define        TERMPAIR_SETFLAG(termp, p, fl) \
1.6       kristaps   71:        do { \
1.7       kristaps   72:                assert(! (TERMPAIR_FLAG & (p)->type)); \
1.12      kristaps   73:                (termp)->flags |= (fl); \
1.7       kristaps   74:                (p)->flag = (fl); \
                     75:                (p)->type |= TERMPAIR_FLAG; \
1.6       kristaps   76:        } while (0)
                     77:
1.1       kristaps   78: struct termact {
1.25      kristaps   79:        int     (*pre)(struct termp *, struct termpair *,
                     80:                        const struct mdoc_meta *,
                     81:                        const struct mdoc_node *);
                     82:        void    (*post)(struct termp *, struct termpair *,
                     83:                        const struct mdoc_meta *,
                     84:                        const struct mdoc_node *);
1.1       kristaps   85: };
                     86:
1.29    ! kristaps   87: void            *term_ascii2htab(void);
        !            88: const char      *term_a2ascii(void *, const char *, size_t, size_t *);
        !            89: void             term_asciifree(void *);
        !            90:
        !            91: void             term_newln(struct termp *);
        !            92: void             term_vspace(struct termp *);
        !            93: void             term_word(struct termp *, const char *);
        !            94: void             term_flushln(struct termp *);
        !            95: void             term_node(struct termp *, struct termpair *,
        !            96:                        const struct mdoc_meta *,
        !            97:                        const struct mdoc_node *);
1.14      kristaps   98:
1.1       kristaps   99: const  struct termact   *termacts;
                    100:
                    101: __END_DECLS
                    102:
                    103: #endif /*!TERM_H*/

CVSweb