Annotation of docbook2mdoc/macro.c, Revision 1.19
1.19 ! schwarze 1: /* $Id: macro.c,v 1.18 2019/05/01 17:20:47 schwarze Exp $ */
1.1 schwarze 2: /*
3: * Copyright (c) 2019 Ingo Schwarze <schwarze@openbsd.org>
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 AUTHORS DISCLAIM ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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: #include <assert.h>
18: #include <ctype.h>
19: #include <stdio.h>
1.6 schwarze 20: #include <string.h>
1.1 schwarze 21:
22: #include "node.h"
23: #include "macro.h"
24:
25: /*
26: * The implementation of the macro line formatter,
27: * a part of the mdoc(7) formatter.
28: */
29:
30: void
1.18 schwarze 31: para_check(struct format *f)
32: {
33: if (f->parastate != PARA_WANT)
34: return;
35: if (f->linestate != LINE_NEW) {
36: putchar('\n');
37: f->linestate = LINE_NEW;
38: }
39: puts(".Pp");
40: f->parastate = PARA_HAVE;
41: }
42:
43: void
1.1 schwarze 44: macro_open(struct format *f, const char *name)
45: {
1.18 schwarze 46: para_check(f);
1.1 schwarze 47: switch (f->linestate) {
1.9 schwarze 48: case LINE_MACRO:
49: if (f->flags & FMT_NOSPC) {
50: fputs(" Ns ", stdout);
51: break;
52: }
1.19 ! schwarze 53: if (f->nofill || f->flags & (FMT_CHILD | FMT_IMPL)) {
1.9 schwarze 54: putchar(' ');
55: break;
56: }
57: /* FALLTHROUGH */
1.1 schwarze 58: case LINE_TEXT:
1.18 schwarze 59: if (f->nofill && f->linestate == LINE_TEXT)
1.17 schwarze 60: fputs(" \\c", stdout);
1.1 schwarze 61: putchar('\n');
62: /* FALLTHROUGH */
63: case LINE_NEW:
64: putchar('.');
65: f->linestate = LINE_MACRO;
1.9 schwarze 66: f->flags = 0;
1.1 schwarze 67: break;
68: }
69: fputs(name, stdout);
1.9 schwarze 70: f->flags &= FMT_IMPL;
71: f->flags |= FMT_ARG;
1.14 schwarze 72: f->parastate = PARA_MID;
1.1 schwarze 73: }
74:
75: void
76: macro_close(struct format *f)
77: {
1.9 schwarze 78: if (f->linestate != LINE_NEW)
79: putchar('\n');
1.1 schwarze 80: f->linestate = LINE_NEW;
1.9 schwarze 81: f->flags = 0;
1.1 schwarze 82: }
83:
84: void
85: macro_line(struct format *f, const char *name)
86: {
1.7 schwarze 87: macro_close(f);
1.1 schwarze 88: macro_open(f, name);
89: macro_close(f);
90: }
91:
92: /*
93: * Print an argument string on a macro line, collapsing whitespace.
94: */
95: void
96: macro_addarg(struct format *f, const char *arg, int flags)
97: {
98: const char *cp;
1.13 schwarze 99: int quote_now;
1.1 schwarze 100:
101: assert(f->linestate == LINE_MACRO);
102:
103: /* Quote if requested and necessary. */
104:
1.13 schwarze 105: quote_now = 0;
1.1 schwarze 106: if ((flags & (ARG_SINGLE | ARG_QUOTED)) == ARG_SINGLE) {
107: for (cp = arg; *cp != '\0'; cp++)
108: if (isspace((unsigned char)*cp))
109: break;
110: if (*cp != '\0') {
111: if (flags & ARG_SPACE) {
112: putchar(' ');
113: flags &= ~ ARG_SPACE;
114: }
115: putchar('"');
116: flags = ARG_QUOTED;
1.13 schwarze 117: quote_now = 1;
1.1 schwarze 118: }
119: }
120:
121: for (cp = arg; *cp != '\0'; cp++) {
122:
123: /* Collapse whitespace. */
124:
125: if (isspace((unsigned char)*cp)) {
126: flags |= ARG_SPACE;
127: continue;
128: } else if (flags & ARG_SPACE) {
129: putchar(' ');
130: flags &= ~ ARG_SPACE;
131: }
132:
133: /* Escape us if we look like a macro. */
134:
1.12 schwarze 135: if ((flags & (ARG_QUOTED | ARG_UPPER)) == 0 &&
1.1 schwarze 136: (cp == arg || isspace((unsigned char)cp[-1])) &&
137: isupper((unsigned char)cp[0]) &&
138: islower((unsigned char)cp[1]) &&
139: (cp[2] == '\0' || cp[2] == ' ' ||
1.12 schwarze 140: ((cp[3] == '\0' || cp[3] == ' ') &&
141: (strncmp(cp, "Brq", 3) == 0 ||
142: strncmp(cp, "Bro", 3) == 0 ||
143: strncmp(cp, "Brc", 3) == 0 ||
144: strncmp(cp, "Bsx", 3) == 0))))
1.1 schwarze 145: fputs("\\&", stdout);
146:
147: if (*cp == '"')
148: fputs("\\(dq", stdout);
149: else if (flags & ARG_UPPER)
150: putchar(toupper((unsigned char)*cp));
151: else
152: putchar(*cp);
153: if (*cp == '\\')
154: putchar('e');
155: }
1.13 schwarze 156: if (quote_now)
157: putchar('"');
1.14 schwarze 158: f->parastate = PARA_MID;
1.1 schwarze 159: }
160:
161: void
162: macro_argline(struct format *f, const char *name, const char *arg)
163: {
164: macro_open(f, name);
165: macro_addarg(f, arg, ARG_SPACE);
166: macro_close(f);
167: }
168:
169: /*
170: * Recursively append text from the children of a node to a macro line.
171: */
172: void
1.8 schwarze 173: macro_addnode(struct format *f, struct pnode *n, int flags)
1.1 schwarze 174: {
1.5 schwarze 175: struct pnode *nc;
1.15 schwarze 176: int is_text, quote_now;
1.1 schwarze 177:
178: assert(f->linestate == LINE_MACRO);
179:
180: /*
1.2 schwarze 181: * If this node or its only child is a text node, just add
182: * that text, letting macro_addarg() decide about quoting.
1.1 schwarze 183: */
184:
1.8 schwarze 185: while ((nc = TAILQ_FIRST(&n->childq)) != NULL &&
1.5 schwarze 186: TAILQ_NEXT(nc, child) == NULL)
1.8 schwarze 187: n = nc;
1.5 schwarze 188:
1.8 schwarze 189: if (n->node == NODE_TEXT || n->node == NODE_ESCAPE) {
190: macro_addarg(f, n->b, flags);
1.14 schwarze 191: f->parastate = PARA_MID;
1.1 schwarze 192: return;
193: }
194:
195: /*
196: * If we want the argument quoted and are not already
197: * in a quoted context, quote now.
198: */
199:
200: quote_now = 0;
201: if (flags & ARG_SINGLE) {
202: if ((flags & ARG_QUOTED) == 0) {
203: if (flags & ARG_SPACE) {
204: putchar(' ');
205: flags &= ~ARG_SPACE;
206: }
207: putchar('"');
208: flags |= ARG_QUOTED;
209: quote_now = 1;
210: }
211: flags &= ~ARG_SINGLE;
212: }
213:
214: /*
215: * Iterate to child and sibling nodes,
216: * inserting whitespace between nodes.
217: */
218:
1.5 schwarze 219: while (nc != NULL) {
220: macro_addnode(f, nc, flags);
1.15 schwarze 221: is_text = pnode_class(nc->node) == CLASS_TEXT;
1.5 schwarze 222: nc = TAILQ_NEXT(nc, child);
1.15 schwarze 223: if (nc == NULL || pnode_class(nc->node) != CLASS_TEXT)
224: is_text = 0;
1.16 schwarze 225: if (is_text && (nc->flags & NFLAG_SPC) == 0)
1.15 schwarze 226: flags &= ~ARG_SPACE;
227: else
228: flags |= ARG_SPACE;
1.1 schwarze 229: }
230: if (quote_now)
231: putchar('"');
1.14 schwarze 232: f->parastate = PARA_MID;
1.1 schwarze 233: }
234:
235: void
1.8 schwarze 236: macro_nodeline(struct format *f, const char *name, struct pnode *n, int flags)
1.1 schwarze 237: {
238: macro_open(f, name);
1.8 schwarze 239: macro_addnode(f, n, ARG_SPACE | flags);
1.1 schwarze 240: macro_close(f);
1.2 schwarze 241: }
242:
243:
244: /*
245: * Print a word on the current text line if one is open, or on a new text
246: * line otherwise. The flag ARG_SPACE inserts spaces between words.
247: */
248: void
1.10 schwarze 249: print_text(struct format *f, const char *word, int flags)
250: {
1.18 schwarze 251: para_check(f);
1.2 schwarze 252: switch (f->linestate) {
253: case LINE_NEW:
254: break;
255: case LINE_TEXT:
256: if (flags & ARG_SPACE)
257: putchar(' ');
258: break;
259: case LINE_MACRO:
260: macro_close(f);
261: break;
262: }
1.11 schwarze 263: if (f->linestate == LINE_NEW && (*word == '.' || *word == '\''))
264: fputs("\\&", stdout);
1.10 schwarze 265: while (*word != '\0') {
266: putchar(*word);
267: if (*word++ == '\\')
268: putchar('e');
269: }
1.2 schwarze 270: f->linestate = LINE_TEXT;
1.14 schwarze 271: f->parastate = PARA_MID;
1.9 schwarze 272: f->flags = 0;
1.2 schwarze 273: }
274:
275: /*
276: * Recursively print the content of a node on a text line.
277: */
278: void
279: print_textnode(struct format *f, struct pnode *n)
280: {
281: struct pnode *nc;
282:
1.3 schwarze 283: if (n->node == NODE_TEXT || n->node == NODE_ESCAPE)
1.2 schwarze 284: print_text(f, n->b, ARG_SPACE);
285: else
286: TAILQ_FOREACH(nc, &n->childq, child)
287: print_textnode(f, nc);
1.1 schwarze 288: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to macro.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / docbook2mdoc