Annotation of mandoc/term.h, Revision 1.115
1.115 ! schwarze 1: /* $Id: term.h,v 1.114 2015/04/29 18:35:00 schwarze Exp $ */
1.1 kristaps 2: /*
1.87 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.112 schwarze 4: * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.36 kristaps 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.112 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.36 kristaps 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.112 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.36 kristaps 13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18:
1.28 kristaps 19: enum termenc {
1.84 kristaps 20: TERMENC_ASCII,
1.85 kristaps 21: TERMENC_LOCALE,
22: TERMENC_UTF8
1.28 kristaps 23: };
24:
1.58 kristaps 25: enum termtype {
26: TERMTYPE_CHAR,
1.75 kristaps 27: TERMTYPE_PS,
28: TERMTYPE_PDF
1.58 kristaps 29: };
30:
1.51 kristaps 31: enum termfont {
32: TERMFONT_NONE = 0,
33: TERMFONT_BOLD,
1.68 kristaps 34: TERMFONT_UNDER,
1.93 schwarze 35: TERMFONT_BI,
1.68 kristaps 36: TERMFONT__MAX
1.51 kristaps 37: };
1.53 kristaps 38:
39: #define TERM_MAXMARGIN 100000 /* FIXME */
1.51 kristaps 40:
1.112 schwarze 41: struct roff_meta;
1.107 schwarze 42: struct termp;
43:
1.112 schwarze 44: typedef void (*term_margin)(struct termp *, const struct roff_meta *);
1.58 kristaps 45:
1.78 kristaps 46: struct termp_tbl {
47: int width; /* width in fixed chars */
48: int decimal; /* decimal point position */
49: };
50:
1.1 kristaps 51: struct termp {
1.58 kristaps 52: enum termtype type;
1.79 kristaps 53: struct rofftbl tbl; /* table configuration */
1.102 schwarze 54: int synopsisonly; /* print the synopsis only */
1.90 schwarze 55: int mdocstyle; /* imitate mdoc(7) output */
1.115 ! schwarze 56: size_t line; /* Current output line number. */
1.89 schwarze 57: size_t defindent; /* Default indent for text. */
1.78 kristaps 58: size_t defrmargin; /* Right margin of the device. */
1.98 schwarze 59: size_t lastrmargin; /* Right margin before the last ll. */
1.27 kristaps 60: size_t rmargin; /* Current right margin. */
61: size_t maxrmargin; /* Max right margin. */
1.94 schwarze 62: size_t maxcols; /* Max size of buf. */
1.27 kristaps 63: size_t offset; /* Margin offest. */
1.56 schwarze 64: size_t tabwidth; /* Distance of tab positions. */
1.94 schwarze 65: size_t col; /* Bytes in buf. */
1.57 schwarze 66: size_t viscol; /* Chars on current line. */
1.95 schwarze 67: size_t trailspace; /* See termp_flushln(). */
1.52 kristaps 68: int overstep; /* See termp_flushln(). */
1.91 schwarze 69: int skipvsp; /* Vertical space to skip. */
1.1 kristaps 70: int flags;
1.114 schwarze 71: #define TERMP_SENTENCE (1 << 0) /* Space before a sentence. */
72: #define TERMP_NOSPACE (1 << 1) /* No space before words. */
73: #define TERMP_NONOSPACE (1 << 2) /* No space (no autounset). */
74: #define TERMP_NBRWORD (1 << 3) /* Make next word nonbreaking. */
75: #define TERMP_KEEP (1 << 4) /* Keep words together. */
76: #define TERMP_PREKEEP (1 << 5) /* ...starting with the next one. */
77: #define TERMP_BACKAFTER (1 << 6) /* Back up after next character. */
78: #define TERMP_BACKBEFORE (1 << 7) /* Back up before next character. */
1.96 schwarze 79: #define TERMP_NOBREAK (1 << 8) /* See term_flushln(). */
1.100 schwarze 80: #define TERMP_BRIND (1 << 9) /* See term_flushln(). */
81: #define TERMP_DANGLE (1 << 10) /* See term_flushln(). */
82: #define TERMP_HANG (1 << 11) /* See term_flushln(). */
1.103 schwarze 83: #define TERMP_NOSPLIT (1 << 12) /* Do not break line before .An. */
84: #define TERMP_SPLIT (1 << 13) /* Break line before .An. */
1.108 schwarze 85: #define TERMP_NONEWLINE (1 << 14) /* No line break in nofill mode. */
1.81 kristaps 86: int *buf; /* Output buffer. */
1.28 kristaps 87: enum termenc enc; /* Type of encoding. */
1.105 schwarze 88: const struct mchars *symtab; /* Character table. */
1.51 kristaps 89: enum termfont fontl; /* Last font set. */
1.109 schwarze 90: enum termfont *fontq; /* Symmetric fonts. */
91: int fontsz; /* Allocated size of font stack */
1.51 kristaps 92: int fonti; /* Index of font stack. */
1.58 kristaps 93: term_margin headf; /* invoked to print head */
94: term_margin footf; /* invoked to print foot */
1.81 kristaps 95: void (*letter)(struct termp *, int);
1.60 kristaps 96: void (*begin)(struct termp *);
97: void (*end)(struct termp *);
98: void (*endline)(struct termp *);
99: void (*advance)(struct termp *, size_t);
1.113 schwarze 100: void (*setwidth)(struct termp *, int, int);
1.81 kristaps 101: size_t (*width)(const struct termp *, int);
1.113 schwarze 102: int (*hspan)(const struct termp *,
1.70 kristaps 103: const struct roffsu *);
1.58 kristaps 104: const void *argf; /* arg for headf/footf */
1.83 kristaps 105: struct termp_ps *ps;
1.1 kristaps 106: };
1.107 schwarze 107:
108: __BEGIN_DECLS
109:
110: struct tbl_span;
111: struct eqn;
1.104 schwarze 112:
113: const char *ascii_uc2str(int);
1.1 kristaps 114:
1.86 kristaps 115: void term_eqn(struct termp *, const struct eqn *);
1.77 kristaps 116: void term_tbl(struct termp *, const struct tbl_span *);
1.59 kristaps 117: void term_free(struct termp *);
1.29 kristaps 118: void term_newln(struct termp *);
119: void term_vspace(struct termp *);
120: void term_word(struct termp *, const char *);
121: void term_flushln(struct termp *);
1.101 schwarze 122: void term_begin(struct termp *, term_margin,
1.112 schwarze 123: term_margin, const struct roff_meta *);
1.58 kristaps 124: void term_end(struct termp *);
1.1 kristaps 125:
1.99 schwarze 126: void term_setwidth(struct termp *, const char *);
1.110 schwarze 127: int term_hspan(const struct termp *, const struct roffsu *);
128: int term_vspan(const struct termp *, const struct roffsu *);
1.65 kristaps 129: size_t term_strlen(const struct termp *, const char *);
130: size_t term_len(const struct termp *, size_t);
1.48 kristaps 131:
1.51 kristaps 132: void term_fontpush(struct termp *, enum termfont);
133: void term_fontpop(struct termp *);
1.111 schwarze 134: void term_fontpopq(struct termp *, int);
1.51 kristaps 135: void term_fontrepl(struct termp *, enum termfont);
136: void term_fontlast(struct termp *);
137:
1.1 kristaps 138: __END_DECLS
CVSweb