Return to term.h CVS log

Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/term.h, Revision 1.15

1.15    ! schwarze    1: /*     $Id: term.h,v 1.14 2010/03/26 01:22:07 schwarze Exp $ */
1.1       kristaps    2: /*
1.2       schwarze    3:  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.2       schwarze    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.2       schwarze    9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16:  */
                     17: #ifndef TERM_H
                     18: #define TERM_H
                     19:
                     20: __BEGIN_DECLS
                     21:
                     22: enum   termenc {
1.11      schwarze   23:        TERMENC_ASCII
1.1       kristaps   24: };
                     25:
1.13      schwarze   26: enum   termfont {
                     27:        TERMFONT_NONE = 0,
                     28:        TERMFONT_BOLD,
                     29:        TERMFONT_UNDER
                     30: };
                     31:
1.1       kristaps   32: struct termp {
                     33:        size_t            rmargin;      /* Current right margin. */
                     34:        size_t            maxrmargin;   /* Max right margin. */
                     35:        size_t            maxcols;      /* Max size of buf. */
                     36:        size_t            offset;       /* Margin offest. */
                     37:        size_t            col;          /* Bytes in buf. */
1.15    ! schwarze   38:        size_t            viscol;       /* Chars on current line. */
1.14      schwarze   39:        int               overstep;     /* See termp_flushln(). */
1.1       kristaps   40:        int               flags;
1.4       schwarze   41: #define        TERMP_NOSPACE    (1 << 2)       /* No space before words. */
1.5       schwarze   42: #define        TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
                     43: #define        TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
1.4       schwarze   44: #define        TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
                     45: #define        TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
1.5       schwarze   46: #define        TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
                     47: #define        TERMP_HANG       (1 << 9)       /* See term_flushln(). */
1.6       schwarze   48: #define        TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
1.7       schwarze   49: #define        TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
                     50: #define        TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
                     51: #define        TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
1.1       kristaps   52:        char             *buf;          /* Output buffer. */
                     53:        enum termenc      enc;          /* Type of encoding. */
                     54:        void             *symtab;       /* Encoded-symbol table. */
1.13      schwarze   55:        enum termfont     fontl;        /* Last font set. */
                     56:        enum termfont     fontq[10];    /* Symmetric fonts. */
                     57:        int               fonti;        /* Index of font stack. */
1.1       kristaps   58: };
                     59:
                     60: void             term_newln(struct termp *);
                     61: void             term_vspace(struct termp *);
                     62: void             term_word(struct termp *, const char *);
                     63: void             term_flushln(struct termp *);
1.12      schwarze   64:
                     65: size_t           term_hspan(const struct roffsu *);
                     66: size_t           term_vspan(const struct roffsu *);
1.13      schwarze   67:
                     68: enum termfont    term_fonttop(struct termp *);
                     69: const void      *term_fontq(struct termp *);
                     70: void             term_fontpush(struct termp *, enum termfont);
                     71: void             term_fontpop(struct termp *);
                     72: void             term_fontpopq(struct termp *, const void *);
                     73: void             term_fontrepl(struct termp *, enum termfont);
                     74: void             term_fontlast(struct termp *);
1.1       kristaps   75:
                     76: __END_DECLS
                     77:
                     78: #endif /*!TERM_H*/