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

Annotation of mandoc/term.h, Revision 1.33

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

CVSweb