=================================================================== RCS file: /cvs/mandoc/mandoc.c,v retrieving revision 1.18 retrieving revision 1.121 diff -u -p -r1.18 -r1.121 --- mandoc/mandoc.c 2010/06/09 19:22:56 1.18 +++ mandoc/mandoc.c 2022/05/19 15:37:47 1.121 @@ -1,396 +1,293 @@ -/* $Id: mandoc.c,v 1.18 2010/06/09 19:22:56 kristaps Exp $ */ +/* $Id: mandoc.c,v 1.121 2022/05/19 15:37:47 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2010, 2011, 2015, 2017, 2018, 2019, 2020, 2021 + * Ingo Schwarze + * Copyright (c) 2009, 2010 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + * + * Utility functions to handle end of sentence punctuation + * and dates and times, for use by mdoc(7) and man(7) parsers. + * Utility functions to handle fonts and numbers, + * for use by mandoc(1) parsers and formatters. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include #include #include +#include +#include #include #include #include #include +#include "mandoc_aux.h" #include "mandoc.h" +#include "roff.h" #include "libmandoc.h" +#include "roff_int.h" static int a2time(time_t *, const char *, const char *); -static int spec_norm(char *, int); +static char *time2a(time_t); -/* - * "Normalise" a special string by converting its ASCII_HYPH entries - * into actual hyphens. - */ -static int -spec_norm(char *p, int sz) +enum mandoc_esc +mandoc_font(const char *cp, int sz) { - int i; - - for (i = 0; i < sz; i++) - if (ASCII_HYPH == p[i]) - p[i] = '-'; - - return(sz); -} - - -int -mandoc_special(char *p) -{ - int terminator; /* Terminator for \s. */ - int lim; /* Limit for N in \s. */ - int c, i; - char *sv; - - sv = p; - - if ('\\' != *p++) - return(spec_norm(sv, 0)); - - switch (*p) { - case ('\''): - /* FALLTHROUGH */ - case ('`'): - /* FALLTHROUGH */ - case ('q'): - /* FALLTHROUGH */ - case (ASCII_HYPH): - /* FALLTHROUGH */ - case ('-'): - /* FALLTHROUGH */ - case ('~'): - /* FALLTHROUGH */ - case ('^'): - /* FALLTHROUGH */ - case ('%'): - /* FALLTHROUGH */ - case ('0'): - /* FALLTHROUGH */ - case (' '): - /* FALLTHROUGH */ - case ('}'): - /* FALLTHROUGH */ - case ('|'): - /* FALLTHROUGH */ - case ('&'): - /* FALLTHROUGH */ - case ('.'): - /* FALLTHROUGH */ - case (':'): - /* FALLTHROUGH */ - case ('c'): - /* FALLTHROUGH */ - case ('e'): - return(spec_norm(sv, 2)); - case ('s'): - if ('\0' == *++p) - return(spec_norm(sv, 2)); - - c = 2; - terminator = 0; - lim = 1; - - if (*p == '\'') { - lim = 0; - terminator = 1; - ++p; - ++c; - } else if (*p == '[') { - lim = 0; - terminator = 2; - ++p; - ++c; - } else if (*p == '(') { - lim = 2; - terminator = 3; - ++p; - ++c; + switch (sz) { + case 0: + return ESCAPE_FONTPREV; + case 1: + switch (cp[0]) { + case 'B': + case '3': + return ESCAPE_FONTBOLD; + case 'I': + case '2': + return ESCAPE_FONTITALIC; + case 'P': + return ESCAPE_FONTPREV; + case 'R': + case '1': + return ESCAPE_FONTROMAN; + case '4': + return ESCAPE_FONTBI; + default: + return ESCAPE_ERROR; } - - if (*p == '+' || *p == '-') { - ++p; - ++c; - } - - if (*p == '\'') { - if (terminator) - return(spec_norm(sv, 0)); - lim = 0; - terminator = 1; - ++p; - ++c; - } else if (*p == '[') { - if (terminator) - return(spec_norm(sv, 0)); - lim = 0; - terminator = 2; - ++p; - ++c; - } else if (*p == '(') { - if (terminator) - return(spec_norm(sv, 0)); - lim = 2; - terminator = 3; - ++p; - ++c; - } - - /* TODO: needs to handle floating point. */ - - if ( ! isdigit((u_char)*p)) - return(spec_norm(sv, 0)); - - for (i = 0; isdigit((u_char)*p); i++) { - if (lim && i >= lim) - break; - ++p; - ++c; - } - - if (terminator && terminator < 3) { - if (1 == terminator && *p != '\'') - return(spec_norm(sv, 0)); - if (2 == terminator && *p != ']') - return(spec_norm(sv, 0)); - ++p; - ++c; - } - - return(spec_norm(sv, c)); - case ('f'): - /* FALLTHROUGH */ - case ('F'): - /* FALLTHROUGH */ - case ('*'): - if ('\0' == *++p || isspace((u_char)*p)) - return(spec_norm(sv, 0)); - switch (*p) { - case ('('): - if ('\0' == *++p || isspace((u_char)*p)) - return(spec_norm(sv, 0)); - return(spec_norm(sv, 4)); - case ('['): - for (c = 3, p++; *p && ']' != *p; p++, c++) - if (isspace((u_char)*p)) - break; - return(spec_norm(sv, *p == ']' ? c : 0)); + case 2: + switch (cp[0]) { + case 'B': + switch (cp[1]) { + case 'I': + return ESCAPE_FONTBI; + default: + return ESCAPE_ERROR; + } + case 'C': + switch (cp[1]) { + case 'B': + return ESCAPE_FONTCB; + case 'I': + return ESCAPE_FONTCI; + case 'R': + case 'W': + return ESCAPE_FONTCR; + default: + return ESCAPE_ERROR; + } default: - break; + return ESCAPE_ERROR; } - return(spec_norm(sv, 3)); - case ('('): - if ('\0' == *++p || isspace((u_char)*p)) - return(spec_norm(sv, 0)); - if ('\0' == *++p || isspace((u_char)*p)) - return(spec_norm(sv, 0)); - return(spec_norm(sv, 4)); - case ('['): - break; default: - return(spec_norm(sv, 0)); + return ESCAPE_ERROR; } - - for (c = 3, p++; *p && ']' != *p; p++, c++) - if (isspace((u_char)*p)) - break; - - return(spec_norm(sv, *p == ']' ? c : 0)); } - -void * -mandoc_calloc(size_t num, size_t size) +static int +a2time(time_t *t, const char *fmt, const char *p) { - void *ptr; + struct tm tm; + char *pp; - ptr = calloc(num, size); - if (NULL == ptr) { - perror(NULL); - exit(EXIT_FAILURE); + memset(&tm, 0, sizeof(struct tm)); + + pp = NULL; +#if HAVE_STRPTIME + pp = strptime(p, fmt, &tm); +#endif + if (NULL != pp && '\0' == *pp) { + *t = mktime(&tm); + return 1; } - return(ptr); + return 0; } - -void * -mandoc_malloc(size_t size) +static char * +time2a(time_t t) { - void *ptr; + struct tm *tm; + char *buf, *p; + size_t ssz; + int isz; - ptr = malloc(size); - if (NULL == ptr) { - perror(NULL); - exit(EXIT_FAILURE); - } + buf = NULL; + tm = localtime(&t); + if (tm == NULL) + goto fail; - return(ptr); -} + /* + * Reserve space: + * up to 9 characters for the month (September) + blank + * up to 2 characters for the day + comma + blank + * 4 characters for the year and a terminating '\0' + */ + p = buf = mandoc_malloc(10 + 4 + 4 + 1); -void * -mandoc_realloc(void *ptr, size_t size) -{ + if ((ssz = strftime(p, 10 + 1, "%B ", tm)) == 0) + goto fail; + p += (int)ssz; - ptr = realloc(ptr, size); - if (NULL == ptr) { - perror(NULL); - exit(EXIT_FAILURE); - } + /* + * The output format is just "%d" here, not "%2d" or "%02d". + * That's also the reason why we can't just format the + * date as a whole with "%B %e, %Y" or "%B %d, %Y". + * Besides, the present approach is less prone to buffer + * overflows, in case anybody should ever introduce the bug + * of looking at LC_TIME. + */ - return(ptr); -} + isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday); + if (isz < 0 || isz > 4) + goto fail; + p += isz; + if (strftime(p, 4 + 1, "%Y", tm) == 0) + goto fail; + return buf; -char * -mandoc_strdup(const char *ptr) -{ - char *p; - - p = strdup(ptr); - if (NULL == p) { - perror(NULL); - exit(EXIT_FAILURE); - } - - return(p); +fail: + free(buf); + return mandoc_strdup(""); } - -static int -a2time(time_t *t, const char *fmt, const char *p) +char * +mandoc_normdate(struct roff_node *nch, struct roff_node *nbl) { - struct tm tm; - char *pp; + char *cp; + time_t t; - memset(&tm, 0, sizeof(struct tm)); + /* No date specified. */ - pp = strptime(p, fmt, &tm); - if (NULL != pp && '\0' == *pp) { - *t = mktime(&tm); - return(1); + if (nch == NULL) { + if (nbl == NULL) + mandoc_msg(MANDOCERR_DATE_MISSING, 0, 0, NULL); + else + mandoc_msg(MANDOCERR_DATE_MISSING, nbl->line, + nbl->pos, "%s", roff_name[nbl->tok]); + return mandoc_strdup(""); } + if (*nch->string == '\0') { + mandoc_msg(MANDOCERR_DATE_MISSING, nch->line, + nch->pos, "%s", roff_name[nbl->tok]); + return mandoc_strdup(""); + } + if (strcmp(nch->string, "$" "Mdocdate$") == 0) + return time2a(time(NULL)); - return(0); -} + /* Valid mdoc(7) date format. */ - -/* - * Convert from a manual date string (see mdoc(7) and man(7)) into a - * date according to the stipulated date type. - */ -time_t -mandoc_a2time(int flags, const char *p) -{ - time_t t; - - if (MTIME_MDOCDATE & flags) { - if (0 == strcmp(p, "$" "Mdocdate$")) - return(time(NULL)); - if (a2time(&t, "$" "Mdocdate: %b %d %Y $", p)) - return(t); + if (a2time(&t, "$" "Mdocdate: %b %d %Y $", nch->string) || + a2time(&t, "%b %d, %Y", nch->string)) { + cp = time2a(t); + if (t > time(NULL) + 86400) + mandoc_msg(MANDOCERR_DATE_FUTURE, nch->line, + nch->pos, "%s %s", roff_name[nbl->tok], cp); + else if (*nch->string != '$' && + strcmp(nch->string, cp) != 0) + mandoc_msg(MANDOCERR_DATE_NORM, nch->line, + nch->pos, "%s %s", roff_name[nbl->tok], cp); + return cp; } - if (MTIME_CANONICAL & flags || MTIME_REDUCED & flags) - if (a2time(&t, "%b %d, %Y", p)) - return(t); + /* In man(7), do not warn about the legacy format. */ - if (MTIME_ISO_8601 & flags) - if (a2time(&t, "%Y-%m-%d", p)) - return(t); + if (a2time(&t, "%Y-%m-%d", nch->string) == 0) + mandoc_msg(MANDOCERR_DATE_BAD, nch->line, nch->pos, + "%s %s", roff_name[nbl->tok], nch->string); + else if (t > time(NULL) + 86400) + mandoc_msg(MANDOCERR_DATE_FUTURE, nch->line, nch->pos, + "%s %s", roff_name[nbl->tok], nch->string); + else if (nbl->tok == MDOC_Dd) + mandoc_msg(MANDOCERR_DATE_LEGACY, nch->line, nch->pos, + "Dd %s", nch->string); - if (MTIME_REDUCED & flags) { - if (a2time(&t, "%d, %Y", p)) - return(t); - if (a2time(&t, "%Y", p)) - return(t); - } + /* Use any non-mdoc(7) date verbatim. */ - return(0); + return mandoc_strdup(nch->string); } - int mandoc_eos(const char *p, size_t sz) { + const char *q; + int enclosed, found; if (0 == sz) - return(0); + return 0; /* * End-of-sentence recognition must include situations where * some symbols, such as `)', allow prior EOS punctuation to - * propogate outward. + * propagate outward. */ - for ( ; sz; sz--) { - switch (p[(int)sz - 1]) { - case ('\"'): - /* FALLTHROUGH */ - case ('\''): - /* FALLTHROUGH */ - case (']'): - /* FALLTHROUGH */ - case (')'): + enclosed = found = 0; + for (q = p + (int)sz - 1; q >= p; q--) { + switch (*q) { + case '\"': + case '\'': + case ']': + case ')': + if (0 == found) + enclosed = 1; break; - case ('.'): - /* Escaped periods. */ - if (sz > 1 && '\\' == p[(int)sz - 2]) - return(0); - /* FALLTHROUGH */ - case ('!'): - /* FALLTHROUGH */ - case ('?'): - return(1); + case '.': + case '!': + case '?': + found = 1; + break; default: - return(0); + return found && + (!enclosed || isalnum((unsigned char)*q)); } } - return(0); + return found && !enclosed; } - +/* + * Convert a string to a long that may not be <0. + * If the string is invalid, or is less than 0, return -1. + */ int -mandoc_hyph(const char *start, const char *c) +mandoc_strntoi(const char *p, size_t sz, int base) { + char buf[32]; + char *ep; + long v; - /* - * Choose whether to break at a hyphenated character. We only - * do this if it's free-standing within a word. - */ + if (sz > 31) + return -1; - /* Skip first/last character of buffer. */ - if (c == start || '\0' == *(c + 1)) - return(0); - /* Skip first/last character of word. */ - if ('\t' == *(c + 1) || '\t' == *(c - 1)) - return(0); - if (' ' == *(c + 1) || ' ' == *(c - 1)) - return(0); - /* Skip double invocations. */ - if ('-' == *(c + 1) || '-' == *(c - 1)) - return(0); - /* Skip escapes. */ - if ('\\' == *(c - 1)) - return(0); + memcpy(buf, p, sz); + buf[(int)sz] = '\0'; - return(1); + errno = 0; + v = strtol(buf, &ep, base); + + if (buf[0] == '\0' || *ep != '\0') + return -1; + + if (v > INT_MAX) + v = INT_MAX; + if (v < INT_MIN) + v = INT_MIN; + + return (int)v; }