Annotation of mandoc/term.h, Revision 1.11
1.11 ! kristaps 1: /* $Id: term.h,v 1.10 2009/02/25 17:02:47 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.10 kristaps 40: #define TERMP_NONOSPACE (1 << 7) /* No space (no autounset). */
1.11 ! kristaps 41: #define TERMP_NORPAD (1 << 8) /* No rightpad. */
1.1 kristaps 42: char *buf;
43: };
44:
1.6 kristaps 45: struct termpair {
1.9 kristaps 46: struct termpair *ppair;
1.6 kristaps 47: int type;
48: #define TERMPAIR_FLAG (1 << 0)
1.7 kristaps 49: int flag;
50: size_t offset;
1.8 kristaps 51: size_t rmargin;
1.9 kristaps 52: int count;
1.6 kristaps 53: };
54:
55: #define TERMPAIR_SETFLAG(p, fl) \
56: do { \
1.7 kristaps 57: assert(! (TERMPAIR_FLAG & (p)->type)); \
58: (p)->flag = (fl); \
59: (p)->type |= TERMPAIR_FLAG; \
1.6 kristaps 60: } while (0)
61:
1.1 kristaps 62: struct termact {
63: int (*pre)(struct termp *,
1.6 kristaps 64: struct termpair *,
1.1 kristaps 65: const struct mdoc_meta *,
66: const struct mdoc_node *);
1.2 kristaps 67: void (*post)(struct termp *,
1.6 kristaps 68: struct termpair *,
1.1 kristaps 69: const struct mdoc_meta *,
70: const struct mdoc_node *);
71: };
72:
73: void newln(struct termp *);
74: void vspace(struct termp *);
75: void word(struct termp *, const char *);
76: void flushln(struct termp *);
1.2 kristaps 77: void transcode(struct termp *,
78: const char *, size_t);
1.1 kristaps 79:
1.5 kristaps 80: void subtree(struct termp *,
81: const struct mdoc_meta *,
82: const struct mdoc_node *);
83:
1.1 kristaps 84: const struct termact *termacts;
85:
86: __END_DECLS
87:
88: #endif /*!TERM_H*/
CVSweb