Return to term.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/term.h, Revision 1.6

1.6     ! kristaps    1: /* $Id: term.h,v 1.5 2009/02/24 16:16:45 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:
                     24: __BEGIN_DECLS
                     25:
                     26: struct termp {
                     27:        size_t            rmargin;
                     28:        size_t            maxrmargin;
                     29:        size_t            maxcols;
                     30:        size_t            offset;
                     31:        size_t            col;
                     32:        int               flags;
                     33: #define        TERMP_BOLD       (1 << 0)       /* Embolden words. */
                     34: #define        TERMP_UNDERLINE  (1 << 1)       /* Underline words. */
                     35: #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
                     36: #define        TERMP_NOLPAD     (1 << 3)       /* No leftpad before flush. */
                     37: #define        TERMP_NOBREAK    (1 << 4)       /* No break after flush. */
1.3       kristaps   38: #define        TERMP_LITERAL    (1 << 5)       /* Literal words. */
1.4       kristaps   39: #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
1.1       kristaps   40:        char             *buf;
                     41: };
                     42:
1.6     ! kristaps   43: struct termpair {
        !            44:        int               type;
        !            45: #define        TERMPAIR_FLAG    (1 << 0)
        !            46:        union {
        !            47:                int       flag;
        !            48:        } data;
        !            49: };
        !            50:
        !            51: #define        TERMPAIR_SETFLAG(p, fl) \
        !            52:        do { \
        !            53:                (p)->data.flag = (fl); \
        !            54:                (p)->type = TERMPAIR_FLAG; \
        !            55:        } while (0)
        !            56:
1.1       kristaps   57: struct termact {
                     58:        int             (*pre)(struct termp *,
1.6     ! kristaps   59:                                struct termpair *,
1.1       kristaps   60:                                const struct mdoc_meta *,
                     61:                                const struct mdoc_node *);
1.2       kristaps   62:        void            (*post)(struct termp *,
1.6     ! kristaps   63:                                struct termpair *,
1.1       kristaps   64:                                const struct mdoc_meta *,
                     65:                                const struct mdoc_node *);
                     66: };
                     67:
                     68: void                     newln(struct termp *);
                     69: void                     vspace(struct termp *);
                     70: void                     word(struct termp *, const char *);
                     71: void                     flushln(struct termp *);
1.2       kristaps   72: void                     transcode(struct termp *,
                     73:                                const char *, size_t);
1.1       kristaps   74:
1.5       kristaps   75: void                     subtree(struct termp *,
                     76:                                const struct mdoc_meta *,
                     77:                                const struct mdoc_node *);
                     78:
1.1       kristaps   79: const  struct termact   *termacts;
                     80:
                     81: __END_DECLS
                     82:
                     83: #endif /*!TERM_H*/