Annotation of mandoc/term.h, Revision 1.55
1.55 ! joerg 1: /* $Id: term.h,v 1.54 2010/05/12 16:01:01 kristaps Exp $ */
1.1 kristaps 2: /*
1.37 kristaps 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.36 kristaps 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.36 kristaps 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:
1.28 kristaps 22: enum termenc {
1.46 kristaps 23: TERMENC_ASCII
1.28 kristaps 24: };
25:
1.51 kristaps 26: enum termfont {
27: TERMFONT_NONE = 0,
28: TERMFONT_BOLD,
29: TERMFONT_UNDER
30: };
1.53 kristaps 31:
32: #define TERM_MAXMARGIN 100000 /* FIXME */
1.51 kristaps 33:
1.1 kristaps 34: struct termp {
1.55 ! joerg 35: size_t defrmargin; /* Right margin of the device.. */
1.27 kristaps 36: size_t rmargin; /* Current right margin. */
37: size_t maxrmargin; /* Max right margin. */
38: size_t maxcols; /* Max size of buf. */
39: size_t offset; /* Margin offest. */
40: size_t col; /* Bytes in buf. */
1.52 kristaps 41: int overstep; /* See termp_flushln(). */
1.1 kristaps 42: int flags;
1.54 kristaps 43: #define TERMP_SENTENCE (1 << 1) /* Space before a sentence. */
1.38 kristaps 44: #define TERMP_NOSPACE (1 << 2) /* No space before words. */
1.39 kristaps 45: #define TERMP_NOLPAD (1 << 3) /* See term_flushln(). */
46: #define TERMP_NOBREAK (1 << 4) /* See term_flushln(). */
1.38 kristaps 47: #define TERMP_IGNDELIM (1 << 6) /* Delims like regulars. */
48: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
1.39 kristaps 49: #define TERMP_DANGLE (1 << 8) /* See term_flushln(). */
50: #define TERMP_HANG (1 << 9) /* See term_flushln(). */
1.41 kristaps 51: #define TERMP_TWOSPACE (1 << 10) /* See term_flushln(). */
1.42 kristaps 52: #define TERMP_NOSPLIT (1 << 11) /* See termp_an_pre/post(). */
53: #define TERMP_SPLIT (1 << 12) /* See termp_an_pre/post(). */
54: #define TERMP_ANPREC (1 << 13) /* See termp_an_pre(). */
1.27 kristaps 55: char *buf; /* Output buffer. */
1.28 kristaps 56: enum termenc enc; /* Type of encoding. */
1.27 kristaps 57: void *symtab; /* Encoded-symbol table. */
1.51 kristaps 58: enum termfont fontl; /* Last font set. */
59: enum termfont fontq[10]; /* Symmetric fonts. */
60: int fonti; /* Index of font stack. */
1.1 kristaps 61: };
62:
1.29 kristaps 63: void term_newln(struct termp *);
64: void term_vspace(struct termp *);
65: void term_word(struct termp *, const char *);
66: void term_flushln(struct termp *);
1.1 kristaps 67:
1.49 kristaps 68: size_t term_hspan(const struct roffsu *);
69: size_t term_vspan(const struct roffsu *);
1.48 kristaps 70:
1.51 kristaps 71: enum termfont term_fonttop(struct termp *);
72: const void *term_fontq(struct termp *);
73: void term_fontpush(struct termp *, enum termfont);
74: void term_fontpop(struct termp *);
75: void term_fontpopq(struct termp *, const void *);
76: void term_fontrepl(struct termp *, enum termfont);
77: void term_fontlast(struct termp *);
78:
1.1 kristaps 79: __END_DECLS
80:
81: #endif /*!TERM_H*/
CVSweb