594f99959df2f9dc97ca4788b5780fe199012720
[dragonfly.git] / usr.bin / mandoc / term.h
1 /*      $Id: term.h,v 1.12 2009/10/21 19:13:51 schwarze Exp $ */
2 /*
3  * Copyright (c) 2008, 2009 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 above
7  * copyright notice and this permission notice appear in all copies.
8  *
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.
16  */
17 #ifndef TERM_H
18 #define TERM_H
19
20 __BEGIN_DECLS
21
22 enum    termenc {
23         TERMENC_ASCII
24 };
25
26 struct  termp {
27         size_t            rmargin;      /* Current right margin. */
28         size_t            maxrmargin;   /* Max right margin. */
29         size_t            maxcols;      /* Max size of buf. */
30         size_t            offset;       /* Margin offest. */
31         size_t            col;          /* Bytes in buf. */
32         int               flags;
33 #define TERMP_NOSPACE    (1 << 2)       /* No space before words. */
34 #define TERMP_NOLPAD     (1 << 3)       /* See term_flushln(). */
35 #define TERMP_NOBREAK    (1 << 4)       /* See term_flushln(). */
36 #define TERMP_IGNDELIM   (1 << 6)       /* Delims like regulars. */
37 #define TERMP_NONOSPACE  (1 << 7)       /* No space (no autounset). */
38 #define TERMP_DANGLE     (1 << 8)       /* See term_flushln(). */
39 #define TERMP_HANG       (1 << 9)       /* See term_flushln(). */
40 #define TERMP_TWOSPACE   (1 << 10)      /* See term_flushln(). */
41 #define TERMP_NOSPLIT    (1 << 11)      /* See termp_an_pre/post(). */
42 #define TERMP_SPLIT      (1 << 12)      /* See termp_an_pre/post(). */
43 #define TERMP_ANPREC     (1 << 13)      /* See termp_an_pre(). */
44         int               bold;
45         int               under;
46         char             *buf;          /* Output buffer. */
47         enum termenc      enc;          /* Type of encoding. */
48         void             *symtab;       /* Encoded-symbol table. */
49 };
50
51 void              term_newln(struct termp *);
52 void              term_vspace(struct termp *);
53 void              term_word(struct termp *, const char *);
54 void              term_flushln(struct termp *);
55
56 size_t            term_hspan(const struct roffsu *);
57 size_t            term_vspan(const struct roffsu *);
58
59 __END_DECLS
60
61 #endif /*!TERM_H*/