Annotation of src/usr.bin/mandoc/term.h, Revision 1.4
1.4 ! schwarze 1: /* $Id: term.h,v 1.3 2009/06/15 01:07:46 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: /* FIXME - clean up tabs. */
21:
1.3 schwarze 22: #define INDENT 5
23: #define HALFINDENT 3
1.1 kristaps 24:
25: __BEGIN_DECLS
26:
27: enum termenc {
28: TERMENC_ASCII,
29: TERMENC_LATIN1, /* Not implemented. */
30: TERMENC_UTF8 /* Not implemented. */
31: };
32:
33: struct termp {
34: size_t rmargin; /* Current right margin. */
35: size_t maxrmargin; /* Max right margin. */
36: size_t maxcols; /* Max size of buf. */
37: size_t offset; /* Margin offest. */
38: size_t col; /* Bytes in buf. */
39: int flags;
1.4 ! schwarze 40: #define TERMP_STYLE 0x3 /* Style mask. */
! 41: #define TERMP_BOLD (1 << 0) /* Styles... */
! 42: #define TERMP_UNDER (1 << 1)
! 43: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
! 44: #define TERMP_NOLPAD (1 << 3) /* See termp_newline(). */
! 45: #define TERMP_NOBREAK (1 << 4) /* See termp_newline(). */
! 46: #define TERMP_LITERAL (1 << 5) /* Literal words. */
! 47: #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
! 48: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
! 49: #define TERMP_DANGLE (1 << 8) /* See termp_newline(). */
! 50: #define TERMP_HANG (1 << 9) /* See termp_newline(). */
1.1 kristaps 51: char *buf; /* Output buffer. */
52: enum termenc enc; /* Type of encoding. */
53: void *symtab; /* Encoded-symbol table. */
54: };
55:
56: void *term_ascii2htab(void);
57: const char *term_a2ascii(void *, const char *, size_t, size_t *);
58: void term_asciifree(void *);
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 *);
64:
65: __END_DECLS
66:
67: #endif /*!TERM_H*/