Annotation of mandoc/mandoc.c, Revision 1.91
1.91 ! schwarze 1: /* $Id: mandoc.c,v 1.90 2015/01/01 18:11:45 schwarze Exp $ */
1.1 kristaps 2: /*
1.90 schwarze 3: * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
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
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
1.36 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 kristaps 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.36 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 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.
17: */
1.9 kristaps 18: #include "config.h"
1.7 kristaps 19:
1.2 kristaps 20: #include <sys/types.h>
21:
1.1 kristaps 22: #include <assert.h>
23: #include <ctype.h>
1.50 kristaps 24: #include <errno.h>
25: #include <limits.h>
1.1 kristaps 26: #include <stdlib.h>
1.4 kristaps 27: #include <stdio.h>
28: #include <string.h>
1.7 kristaps 29: #include <time.h>
1.1 kristaps 30:
1.18 kristaps 31: #include "mandoc.h"
1.76 schwarze 32: #include "mandoc_aux.h"
1.1 kristaps 33: #include "libmandoc.h"
34:
1.37 schwarze 35: #define DATESIZE 32
36:
1.18 kristaps 37: static int a2time(time_t *, const char *, const char *);
1.37 schwarze 38: static char *time2a(time_t);
1.7 kristaps 39:
1.45 kristaps 40:
41: enum mandoc_esc
1.74 schwarze 42: mandoc_escape(const char **end, const char **start, int *sz)
1.1 kristaps 43: {
1.65 schwarze 44: const char *local_start;
45: int local_sz;
46: char term;
1.79 schwarze 47: enum mandoc_esc gly;
1.45 kristaps 48:
1.65 schwarze 49: /*
50: * When the caller doesn't provide return storage,
51: * use local storage.
52: */
53:
54: if (NULL == start)
55: start = &local_start;
56: if (NULL == sz)
57: sz = &local_sz;
58:
59: /*
60: * Beyond the backslash, at least one input character
61: * is part of the escape sequence. With one exception
62: * (see below), that character won't be returned.
63: */
64:
1.45 kristaps 65: gly = ESCAPE_ERROR;
1.65 schwarze 66: *start = ++*end;
67: *sz = 0;
1.64 schwarze 68: term = '\0';
1.18 kristaps 69:
1.65 schwarze 70: switch ((*start)[-1]) {
1.45 kristaps 71: /*
72: * First the glyphs. There are several different forms of
73: * these, but each eventually returns a substring of the glyph
74: * name.
75: */
1.79 schwarze 76: case '(':
1.45 kristaps 77: gly = ESCAPE_SPECIAL;
1.65 schwarze 78: *sz = 2;
1.45 kristaps 79: break;
1.79 schwarze 80: case '[':
1.45 kristaps 81: gly = ESCAPE_SPECIAL;
82: term = ']';
83: break;
1.79 schwarze 84: case 'C':
1.65 schwarze 85: if ('\'' != **start)
1.45 kristaps 86: return(ESCAPE_ERROR);
1.65 schwarze 87: *start = ++*end;
1.87 schwarze 88: gly = ESCAPE_SPECIAL;
1.45 kristaps 89: term = '\'';
90: break;
1.72 schwarze 91:
92: /*
93: * Escapes taking no arguments at all.
94: */
1.79 schwarze 95: case 'd':
1.72 schwarze 96: /* FALLTHROUGH */
1.79 schwarze 97: case 'u':
1.72 schwarze 98: return(ESCAPE_IGNORE);
1.63 schwarze 99:
100: /*
101: * The \z escape is supposed to output the following
1.79 schwarze 102: * character without advancing the cursor position.
1.63 schwarze 103: * Since we are mostly dealing with terminal mode,
104: * let us just skip the next character.
105: */
1.79 schwarze 106: case 'z':
1.63 schwarze 107: return(ESCAPE_SKIPCHAR);
1.1 kristaps 108:
1.45 kristaps 109: /*
110: * Handle all triggers matching \X(xy, \Xx, and \X[xxxx], where
111: * 'X' is the trigger. These have opaque sub-strings.
112: */
1.79 schwarze 113: case 'F':
1.45 kristaps 114: /* FALLTHROUGH */
1.79 schwarze 115: case 'g':
1.24 kristaps 116: /* FALLTHROUGH */
1.79 schwarze 117: case 'k':
1.24 kristaps 118: /* FALLTHROUGH */
1.79 schwarze 119: case 'M':
1.24 kristaps 120: /* FALLTHROUGH */
1.79 schwarze 121: case 'm':
1.24 kristaps 122: /* FALLTHROUGH */
1.79 schwarze 123: case 'n':
1.24 kristaps 124: /* FALLTHROUGH */
1.79 schwarze 125: case 'V':
1.24 kristaps 126: /* FALLTHROUGH */
1.79 schwarze 127: case 'Y':
1.60 schwarze 128: gly = ESCAPE_IGNORE;
1.24 kristaps 129: /* FALLTHROUGH */
1.79 schwarze 130: case 'f':
1.45 kristaps 131: if (ESCAPE_ERROR == gly)
132: gly = ESCAPE_FONT;
1.65 schwarze 133: switch (**start) {
1.79 schwarze 134: case '(':
1.65 schwarze 135: *start = ++*end;
136: *sz = 2;
1.45 kristaps 137: break;
1.79 schwarze 138: case '[':
1.65 schwarze 139: *start = ++*end;
1.45 kristaps 140: term = ']';
141: break;
142: default:
1.65 schwarze 143: *sz = 1;
1.45 kristaps 144: break;
145: }
146: break;
147:
148: /*
149: * These escapes are of the form \X'Y', where 'X' is the trigger
150: * and 'Y' is any string. These have opaque sub-strings.
1.78 schwarze 151: * The \B and \w escapes are handled in roff.c, roff_res().
1.45 kristaps 152: */
1.79 schwarze 153: case 'A':
1.24 kristaps 154: /* FALLTHROUGH */
1.79 schwarze 155: case 'b':
1.24 kristaps 156: /* FALLTHROUGH */
1.79 schwarze 157: case 'D':
1.24 kristaps 158: /* FALLTHROUGH */
1.79 schwarze 159: case 'R':
1.73 schwarze 160: /* FALLTHROUGH */
1.79 schwarze 161: case 'X':
1.24 kristaps 162: /* FALLTHROUGH */
1.79 schwarze 163: case 'Z':
1.91 ! schwarze 164: gly = ESCAPE_IGNORE;
! 165: /* FALLTHROUGH */
! 166: case 'o':
! 167: if (**start == '\0')
1.45 kristaps 168: return(ESCAPE_ERROR);
1.91 ! schwarze 169: if (gly == ESCAPE_ERROR)
! 170: gly = ESCAPE_OVERSTRIKE;
1.77 schwarze 171: term = **start;
1.65 schwarze 172: *start = ++*end;
1.24 kristaps 173: break;
1.45 kristaps 174:
175: /*
176: * These escapes are of the form \X'N', where 'X' is the trigger
177: * and 'N' resolves to a numerical expression.
178: */
1.79 schwarze 179: case 'h':
1.28 kristaps 180: /* FALLTHROUGH */
1.79 schwarze 181: case 'H':
1.45 kristaps 182: /* FALLTHROUGH */
1.79 schwarze 183: case 'L':
1.45 kristaps 184: /* FALLTHROUGH */
1.79 schwarze 185: case 'l':
1.45 kristaps 186: /* FALLTHROUGH */
1.79 schwarze 187: case 'S':
1.45 kristaps 188: /* FALLTHROUGH */
1.79 schwarze 189: case 'v':
1.28 kristaps 190: /* FALLTHROUGH */
1.79 schwarze 191: case 'x':
1.82 schwarze 192: if (strchr(" %&()*+-./0123456789:<=>", **start)) {
1.86 kristaps 193: if ('\0' != **start)
194: ++*end;
1.65 schwarze 195: return(ESCAPE_ERROR);
1.82 schwarze 196: }
1.73 schwarze 197: gly = ESCAPE_IGNORE;
1.77 schwarze 198: term = **start;
1.65 schwarze 199: *start = ++*end;
1.45 kristaps 200: break;
1.60 schwarze 201:
202: /*
203: * Special handling for the numbered character escape.
204: * XXX Do any other escapes need similar handling?
205: */
1.79 schwarze 206: case 'N':
1.65 schwarze 207: if ('\0' == **start)
1.60 schwarze 208: return(ESCAPE_ERROR);
1.65 schwarze 209: (*end)++;
210: if (isdigit((unsigned char)**start)) {
211: *sz = 1;
1.60 schwarze 212: return(ESCAPE_IGNORE);
1.65 schwarze 213: }
214: (*start)++;
1.60 schwarze 215: while (isdigit((unsigned char)**end))
216: (*end)++;
1.65 schwarze 217: *sz = *end - *start;
1.60 schwarze 218: if ('\0' != **end)
219: (*end)++;
220: return(ESCAPE_NUMBERED);
1.45 kristaps 221:
1.79 schwarze 222: /*
1.45 kristaps 223: * Sizes get a special category of their own.
224: */
1.79 schwarze 225: case 's':
1.45 kristaps 226: gly = ESCAPE_IGNORE;
1.28 kristaps 227:
1.45 kristaps 228: /* See +/- counts as a sign. */
1.65 schwarze 229: if ('+' == **end || '-' == **end || ASCII_HYPH == **end)
1.90 schwarze 230: *start = ++*end;
1.8 kristaps 231:
1.65 schwarze 232: switch (**end) {
1.79 schwarze 233: case '(':
1.65 schwarze 234: *start = ++*end;
235: *sz = 2;
1.22 kristaps 236: break;
1.79 schwarze 237: case '[':
1.65 schwarze 238: *start = ++*end;
1.64 schwarze 239: term = ']';
1.22 kristaps 240: break;
1.79 schwarze 241: case '\'':
1.65 schwarze 242: *start = ++*end;
1.64 schwarze 243: term = '\'';
1.22 kristaps 244: break;
245: default:
1.65 schwarze 246: *sz = 1;
1.22 kristaps 247: break;
1.8 kristaps 248: }
249:
1.45 kristaps 250: break;
1.33 kristaps 251:
1.45 kristaps 252: /*
253: * Anything else is assumed to be a glyph.
1.65 schwarze 254: * In this case, pass back the character after the backslash.
1.45 kristaps 255: */
256: default:
257: gly = ESCAPE_SPECIAL;
1.65 schwarze 258: *start = --*end;
259: *sz = 1;
1.22 kristaps 260: break;
1.45 kristaps 261: }
262:
263: assert(ESCAPE_ERROR != gly);
264:
265: /*
1.64 schwarze 266: * Read up to the terminating character,
267: * paying attention to nested escapes.
1.45 kristaps 268: */
269:
270: if ('\0' != term) {
1.64 schwarze 271: while (**end != term) {
272: switch (**end) {
1.79 schwarze 273: case '\0':
1.64 schwarze 274: return(ESCAPE_ERROR);
1.79 schwarze 275: case '\\':
1.64 schwarze 276: (*end)++;
277: if (ESCAPE_ERROR ==
278: mandoc_escape(end, NULL, NULL))
279: return(ESCAPE_ERROR);
280: break;
281: default:
282: (*end)++;
283: break;
284: }
285: }
1.65 schwarze 286: *sz = (*end)++ - *start;
1.64 schwarze 287: } else {
1.65 schwarze 288: assert(*sz > 0);
289: if ((size_t)*sz > strlen(*start))
1.45 kristaps 290: return(ESCAPE_ERROR);
1.65 schwarze 291: *end += *sz;
1.45 kristaps 292: }
293:
294: /* Run post-processors. */
295:
296: switch (gly) {
1.79 schwarze 297: case ESCAPE_FONT:
1.68 schwarze 298: if (2 == *sz) {
299: if ('C' == **start) {
300: /*
301: * Treat constant-width font modes
302: * just like regular font modes.
303: */
304: (*start)++;
305: (*sz)--;
306: } else {
307: if ('B' == (*start)[0] && 'I' == (*start)[1])
308: gly = ESCAPE_FONTBI;
309: break;
310: }
1.65 schwarze 311: } else if (1 != *sz)
1.45 kristaps 312: break;
1.61 kristaps 313:
1.65 schwarze 314: switch (**start) {
1.79 schwarze 315: case '3':
1.45 kristaps 316: /* FALLTHROUGH */
1.79 schwarze 317: case 'B':
1.45 kristaps 318: gly = ESCAPE_FONTBOLD;
319: break;
1.79 schwarze 320: case '2':
1.45 kristaps 321: /* FALLTHROUGH */
1.79 schwarze 322: case 'I':
1.45 kristaps 323: gly = ESCAPE_FONTITALIC;
1.22 kristaps 324: break;
1.79 schwarze 325: case 'P':
1.45 kristaps 326: gly = ESCAPE_FONTPREV;
1.22 kristaps 327: break;
1.79 schwarze 328: case '1':
1.45 kristaps 329: /* FALLTHROUGH */
1.79 schwarze 330: case 'R':
1.45 kristaps 331: gly = ESCAPE_FONTROMAN;
1.1 kristaps 332: break;
333: }
1.46 kristaps 334: break;
1.79 schwarze 335: case ESCAPE_SPECIAL:
1.65 schwarze 336: if (1 == *sz && 'c' == **start)
1.45 kristaps 337: gly = ESCAPE_NOSPACE;
1.87 schwarze 338: /*
1.88 schwarze 339: * Unicode escapes are defined in groff as \[u0000]
1.87 schwarze 340: * to \[u10FFFF], where the contained value must be
341: * a valid Unicode codepoint. Here, however, only
1.88 schwarze 342: * check the length and range.
1.87 schwarze 343: */
1.88 schwarze 344: if (**start != 'u' || *sz < 5 || *sz > 7)
345: break;
346: if (*sz == 7 && ((*start)[1] != '1' || (*start)[2] != '0'))
347: break;
348: if (*sz == 6 && (*start)[1] == '0')
349: break;
350: if ((int)strspn(*start + 1, "0123456789ABCDEFabcdef")
1.87 schwarze 351: + 1 == *sz)
352: gly = ESCAPE_UNICODE;
1.22 kristaps 353: break;
1.1 kristaps 354: default:
1.22 kristaps 355: break;
1.1 kristaps 356: }
357:
1.45 kristaps 358: return(gly);
1.36 schwarze 359: }
360:
361: /*
362: * Parse a quoted or unquoted roff-style request or macro argument.
363: * Return a pointer to the parsed argument, which is either the original
364: * pointer or advanced by one byte in case the argument is quoted.
1.71 schwarze 365: * NUL-terminate the argument in place.
1.36 schwarze 366: * Collapse pairs of quotes inside quoted arguments.
367: * Advance the argument pointer to the next argument,
1.71 schwarze 368: * or to the NUL byte terminating the argument line.
1.36 schwarze 369: */
370: char *
1.48 kristaps 371: mandoc_getarg(struct mparse *parse, char **cpp, int ln, int *pos)
1.36 schwarze 372: {
373: char *start, *cp;
374: int quoted, pairs, white;
375:
376: /* Quoting can only start with a new word. */
377: start = *cpp;
1.47 kristaps 378: quoted = 0;
1.36 schwarze 379: if ('"' == *start) {
380: quoted = 1;
381: start++;
1.79 schwarze 382: }
1.36 schwarze 383:
384: pairs = 0;
385: white = 0;
386: for (cp = start; '\0' != *cp; cp++) {
1.67 schwarze 387:
388: /*
389: * Move the following text left
390: * after quoted quotes and after "\\" and "\t".
391: */
1.36 schwarze 392: if (pairs)
393: cp[-pairs] = cp[0];
1.67 schwarze 394:
1.36 schwarze 395: if ('\\' == cp[0]) {
1.67 schwarze 396: /*
397: * In copy mode, translate double to single
398: * backslashes and backslash-t to literal tabs.
399: */
400: switch (cp[1]) {
1.79 schwarze 401: case 't':
1.67 schwarze 402: cp[0] = '\t';
403: /* FALLTHROUGH */
1.79 schwarze 404: case '\\':
1.36 schwarze 405: pairs++;
406: cp++;
1.67 schwarze 407: break;
1.79 schwarze 408: case ' ':
1.36 schwarze 409: /* Skip escaped blanks. */
1.67 schwarze 410: if (0 == quoted)
411: cp++;
412: break;
413: default:
414: break;
415: }
1.36 schwarze 416: } else if (0 == quoted) {
417: if (' ' == cp[0]) {
418: /* Unescaped blanks end unquoted args. */
419: white = 1;
420: break;
421: }
422: } else if ('"' == cp[0]) {
423: if ('"' == cp[1]) {
424: /* Quoted quotes collapse. */
425: pairs++;
426: cp++;
427: } else {
428: /* Unquoted quotes end quoted args. */
429: quoted = 2;
430: break;
431: }
432: }
433: }
434:
435: /* Quoted argument without a closing quote. */
1.48 kristaps 436: if (1 == quoted)
1.83 schwarze 437: mandoc_msg(MANDOCERR_ARG_QUOTE, parse, ln, *pos, NULL);
1.36 schwarze 438:
1.71 schwarze 439: /* NUL-terminate this argument and move to the next one. */
1.36 schwarze 440: if (pairs)
441: cp[-pairs] = '\0';
442: if ('\0' != *cp) {
443: *cp++ = '\0';
444: while (' ' == *cp)
445: cp++;
446: }
1.39 kristaps 447: *pos += (int)(cp - start) + (quoted ? 1 : 0);
1.36 schwarze 448: *cpp = cp;
449:
1.48 kristaps 450: if ('\0' == *cp && (white || ' ' == cp[-1]))
1.83 schwarze 451: mandoc_msg(MANDOCERR_SPACE_EOL, parse, ln, *pos, NULL);
1.36 schwarze 452:
453: return(start);
1.4 kristaps 454: }
1.7 kristaps 455:
456: static int
457: a2time(time_t *t, const char *fmt, const char *p)
458: {
459: struct tm tm;
460: char *pp;
461:
462: memset(&tm, 0, sizeof(struct tm));
463:
1.56 kristaps 464: pp = NULL;
1.85 schwarze 465: #if HAVE_STRPTIME
1.7 kristaps 466: pp = strptime(p, fmt, &tm);
1.56 kristaps 467: #endif
1.7 kristaps 468: if (NULL != pp && '\0' == *pp) {
469: *t = mktime(&tm);
470: return(1);
471: }
472:
473: return(0);
474: }
475:
1.37 schwarze 476: static char *
477: time2a(time_t t)
478: {
1.56 kristaps 479: struct tm *tm;
1.38 schwarze 480: char *buf, *p;
481: size_t ssz;
1.37 schwarze 482: int isz;
483:
1.56 kristaps 484: tm = localtime(&t);
1.89 schwarze 485: if (tm == NULL)
486: return(NULL);
1.37 schwarze 487:
1.38 schwarze 488: /*
489: * Reserve space:
490: * up to 9 characters for the month (September) + blank
491: * up to 2 characters for the day + comma + blank
492: * 4 characters for the year and a terminating '\0'
493: */
494: p = buf = mandoc_malloc(10 + 4 + 4 + 1);
495:
1.56 kristaps 496: if (0 == (ssz = strftime(p, 10 + 1, "%B ", tm)))
1.38 schwarze 497: goto fail;
498: p += (int)ssz;
1.37 schwarze 499:
1.56 kristaps 500: if (-1 == (isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)))
1.38 schwarze 501: goto fail;
1.37 schwarze 502: p += isz;
503:
1.56 kristaps 504: if (0 == strftime(p, 4 + 1, "%Y", tm))
1.38 schwarze 505: goto fail;
506: return(buf);
507:
508: fail:
509: free(buf);
510: return(NULL);
1.37 schwarze 511: }
512:
513: char *
1.42 kristaps 514: mandoc_normdate(struct mparse *parse, char *in, int ln, int pos)
1.7 kristaps 515: {
1.37 schwarze 516: char *out;
1.7 kristaps 517: time_t t;
518:
1.37 schwarze 519: if (NULL == in || '\0' == *in ||
520: 0 == strcmp(in, "$" "Mdocdate$")) {
1.80 schwarze 521: mandoc_msg(MANDOCERR_DATE_MISSING, parse, ln, pos, NULL);
1.37 schwarze 522: time(&t);
523: }
1.62 schwarze 524: else if (a2time(&t, "%Y-%m-%d", in))
525: t = 0;
1.37 schwarze 526: else if (!a2time(&t, "$" "Mdocdate: %b %d %Y $", in) &&
1.62 schwarze 527: !a2time(&t, "%b %d, %Y", in)) {
1.81 schwarze 528: mandoc_msg(MANDOCERR_DATE_BAD, parse, ln, pos, in);
1.37 schwarze 529: t = 0;
1.7 kristaps 530: }
1.37 schwarze 531: out = t ? time2a(t) : NULL;
1.38 schwarze 532: return(out ? out : mandoc_strdup(in));
1.7 kristaps 533: }
534:
1.12 kristaps 535: int
1.75 schwarze 536: mandoc_eos(const char *p, size_t sz)
1.12 kristaps 537: {
1.75 schwarze 538: const char *q;
539: int enclosed, found;
1.12 kristaps 540:
1.13 kristaps 541: if (0 == sz)
542: return(0);
1.12 kristaps 543:
1.14 kristaps 544: /*
545: * End-of-sentence recognition must include situations where
546: * some symbols, such as `)', allow prior EOS punctuation to
1.49 kristaps 547: * propagate outward.
1.14 kristaps 548: */
549:
1.75 schwarze 550: enclosed = found = 0;
1.25 kristaps 551: for (q = p + (int)sz - 1; q >= p; q--) {
1.23 schwarze 552: switch (*q) {
1.79 schwarze 553: case '\"':
1.14 kristaps 554: /* FALLTHROUGH */
1.79 schwarze 555: case '\'':
1.15 kristaps 556: /* FALLTHROUGH */
1.79 schwarze 557: case ']':
1.14 kristaps 558: /* FALLTHROUGH */
1.79 schwarze 559: case ')':
1.23 schwarze 560: if (0 == found)
561: enclosed = 1;
1.14 kristaps 562: break;
1.79 schwarze 563: case '.':
1.14 kristaps 564: /* FALLTHROUGH */
1.79 schwarze 565: case '!':
1.14 kristaps 566: /* FALLTHROUGH */
1.79 schwarze 567: case '?':
1.23 schwarze 568: found = 1;
569: break;
1.14 kristaps 570: default:
1.27 joerg 571: return(found && (!enclosed || isalnum((unsigned char)*q)));
1.14 kristaps 572: }
1.12 kristaps 573: }
574:
1.23 schwarze 575: return(found && !enclosed);
1.44 kristaps 576: }
1.50 kristaps 577:
578: /*
579: * Convert a string to a long that may not be <0.
580: * If the string is invalid, or is less than 0, return -1.
581: */
582: int
1.54 kristaps 583: mandoc_strntoi(const char *p, size_t sz, int base)
1.50 kristaps 584: {
585: char buf[32];
586: char *ep;
587: long v;
588:
589: if (sz > 31)
590: return(-1);
591:
592: memcpy(buf, p, sz);
1.51 kristaps 593: buf[(int)sz] = '\0';
1.50 kristaps 594:
595: errno = 0;
596: v = strtol(buf, &ep, base);
597:
598: if (buf[0] == '\0' || *ep != '\0')
599: return(-1);
600:
1.54 kristaps 601: if (v > INT_MAX)
602: v = INT_MAX;
603: if (v < INT_MIN)
604: v = INT_MIN;
1.50 kristaps 605:
606: return((int)v);
607: }
CVSweb