version 1.13, 2010/05/14 14:09:13 |
version 1.121, 2022/05/19 15:37:47 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2010, 2011, 2015, 2017, 2018, 2019, 2020, 2021 |
|
* Ingo Schwarze <schwarze@openbsd.org> |
|
* Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
* copyright notice and this permission notice appear in all copies. |
* 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 |
* 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 |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* 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" |
#include "config.h" |
#endif |
|
|
|
#include <sys/types.h> |
#include <sys/types.h> |
|
|
#include <assert.h> |
#include <assert.h> |
#include <ctype.h> |
#include <ctype.h> |
|
#include <errno.h> |
|
#include <limits.h> |
#include <stdlib.h> |
#include <stdlib.h> |
#include <stdio.h> |
#include <stdio.h> |
#include <string.h> |
#include <string.h> |
#include <time.h> |
#include <time.h> |
|
|
|
#include "mandoc_aux.h" |
|
#include "mandoc.h" |
|
#include "roff.h" |
#include "libmandoc.h" |
#include "libmandoc.h" |
|
#include "roff_int.h" |
|
|
static int a2time(time_t *, const char *, const char *); |
static int a2time(time_t *, const char *, const char *); |
|
static char *time2a(time_t); |
|
|
|
|
int |
enum mandoc_esc |
mandoc_special(const char *p) |
mandoc_font(const char *cp, int sz) |
{ |
{ |
int terminator; /* Terminator for \s. */ |
switch (sz) { |
int lim; /* Limit for N in \s. */ |
case 0: |
int c, i; |
return ESCAPE_FONTPREV; |
|
case 1: |
if ('\\' != *p++) |
switch (cp[0]) { |
return(0); |
case 'B': |
|
case '3': |
switch (*p) { |
return ESCAPE_FONTBOLD; |
case ('\''): |
case 'I': |
/* FALLTHROUGH */ |
case '2': |
case ('`'): |
return ESCAPE_FONTITALIC; |
/* FALLTHROUGH */ |
case 'P': |
case ('q'): |
return ESCAPE_FONTPREV; |
/* FALLTHROUGH */ |
case 'R': |
case ('-'): |
case '1': |
/* FALLTHROUGH */ |
return ESCAPE_FONTROMAN; |
case ('~'): |
case '4': |
/* FALLTHROUGH */ |
return ESCAPE_FONTBI; |
case ('^'): |
default: |
/* FALLTHROUGH */ |
return ESCAPE_ERROR; |
case ('%'): |
|
/* FALLTHROUGH */ |
|
case ('0'): |
|
/* FALLTHROUGH */ |
|
case (' '): |
|
/* FALLTHROUGH */ |
|
case ('|'): |
|
/* FALLTHROUGH */ |
|
case ('&'): |
|
/* FALLTHROUGH */ |
|
case ('.'): |
|
/* FALLTHROUGH */ |
|
case (':'): |
|
/* FALLTHROUGH */ |
|
case ('c'): |
|
return(2); |
|
case ('e'): |
|
return(2); |
|
case ('s'): |
|
if ('\0' == *++p) |
|
return(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; |
|
} |
} |
|
case 2: |
if (*p == '+' || *p == '-') { |
switch (cp[0]) { |
++p; |
case 'B': |
++c; |
switch (cp[1]) { |
} |
case 'I': |
|
return ESCAPE_FONTBI; |
if (*p == '\'') { |
default: |
if (terminator) |
return ESCAPE_ERROR; |
return(0); |
} |
lim = 0; |
case 'C': |
terminator = 1; |
switch (cp[1]) { |
++p; |
case 'B': |
++c; |
return ESCAPE_FONTCB; |
} else if (*p == '[') { |
case 'I': |
if (terminator) |
return ESCAPE_FONTCI; |
return(0); |
case 'R': |
lim = 0; |
case 'W': |
terminator = 2; |
return ESCAPE_FONTCR; |
++p; |
default: |
++c; |
return ESCAPE_ERROR; |
} else if (*p == '(') { |
} |
if (terminator) |
|
return(0); |
|
lim = 2; |
|
terminator = 3; |
|
++p; |
|
++c; |
|
} |
|
|
|
/* TODO: needs to handle floating point. */ |
|
|
|
if ( ! isdigit((u_char)*p)) |
|
return(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(0); |
|
if (2 == terminator && *p != ']') |
|
return(0); |
|
++p; |
|
++c; |
|
} |
|
|
|
return(c); |
|
case ('f'): |
|
/* FALLTHROUGH */ |
|
case ('F'): |
|
/* FALLTHROUGH */ |
|
case ('*'): |
|
if (0 == *++p || ! isgraph((u_char)*p)) |
|
return(0); |
|
switch (*p) { |
|
case ('('): |
|
if (0 == *++p || ! isgraph((u_char)*p)) |
|
return(0); |
|
return(4); |
|
case ('['): |
|
for (c = 3, p++; *p && ']' != *p; p++, c++) |
|
if ( ! isgraph((u_char)*p)) |
|
break; |
|
return(*p == ']' ? c : 0); |
|
default: |
default: |
break; |
return ESCAPE_ERROR; |
} |
} |
return(3); |
|
case ('('): |
|
if (0 == *++p || ! isgraph((u_char)*p)) |
|
return(0); |
|
if (0 == *++p || ! isgraph((u_char)*p)) |
|
return(0); |
|
return(4); |
|
case ('['): |
|
break; |
|
default: |
default: |
return(0); |
return ESCAPE_ERROR; |
} |
} |
|
|
for (c = 3, p++; *p && ']' != *p; p++, c++) |
|
if ( ! isgraph((u_char)*p)) |
|
break; |
|
|
|
return(*p == ']' ? c : 0); |
|
} |
} |
|
|
|
static int |
void * |
a2time(time_t *t, const char *fmt, const char *p) |
mandoc_calloc(size_t num, size_t size) |
|
{ |
{ |
void *ptr; |
struct tm tm; |
|
char *pp; |
|
|
ptr = calloc(num, size); |
memset(&tm, 0, sizeof(struct tm)); |
if (NULL == ptr) { |
|
perror(NULL); |
pp = NULL; |
exit(EXIT_FAILURE); |
#if HAVE_STRPTIME |
|
pp = strptime(p, fmt, &tm); |
|
#endif |
|
if (NULL != pp && '\0' == *pp) { |
|
*t = mktime(&tm); |
|
return 1; |
} |
} |
|
|
return(ptr); |
return 0; |
} |
} |
|
|
|
static char * |
void * |
time2a(time_t t) |
mandoc_malloc(size_t size) |
|
{ |
{ |
void *ptr; |
struct tm *tm; |
|
char *buf, *p; |
|
size_t ssz; |
|
int isz; |
|
|
ptr = malloc(size); |
buf = NULL; |
if (NULL == ptr) { |
tm = localtime(&t); |
perror(NULL); |
if (tm == NULL) |
exit(EXIT_FAILURE); |
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 * |
if ((ssz = strftime(p, 10 + 1, "%B ", tm)) == 0) |
mandoc_realloc(void *ptr, size_t size) |
goto fail; |
{ |
p += (int)ssz; |
|
|
ptr = realloc(ptr, size); |
/* |
if (NULL == ptr) { |
* The output format is just "%d" here, not "%2d" or "%02d". |
perror(NULL); |
* That's also the reason why we can't just format the |
exit(EXIT_FAILURE); |
* 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; |
|
|
|
fail: |
|
free(buf); |
|
return mandoc_strdup(""); |
|
} |
|
|
char * |
char * |
mandoc_strdup(const char *ptr) |
mandoc_normdate(struct roff_node *nch, struct roff_node *nbl) |
{ |
{ |
char *p; |
char *cp; |
|
time_t t; |
|
|
p = strdup(ptr); |
/* No date specified. */ |
if (NULL == p) { |
|
perror(NULL); |
if (nch == NULL) { |
exit(EXIT_FAILURE); |
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(p); |
/* Valid mdoc(7) date format. */ |
} |
|
|
|
|
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; |
|
} |
|
|
static int |
/* In man(7), do not warn about the legacy format. */ |
a2time(time_t *t, const char *fmt, const char *p) |
|
{ |
|
struct tm tm; |
|
char *pp; |
|
|
|
memset(&tm, 0, sizeof(struct tm)); |
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); |
|
|
pp = strptime(p, fmt, &tm); |
/* Use any non-mdoc(7) date verbatim. */ |
if (NULL != pp && '\0' == *pp) { |
|
*t = mktime(&tm); |
|
return(1); |
|
} |
|
|
|
return(0); |
return mandoc_strdup(nch->string); |
} |
} |
|
|
|
int |
/* |
mandoc_eos(const char *p, size_t sz) |
* 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; |
const char *q; |
|
int enclosed, found; |
|
|
if (MTIME_MDOCDATE & flags) { |
if (0 == sz) |
if (0 == strcmp(p, "$" "Mdocdate$")) |
return 0; |
return(time(NULL)); |
|
if (a2time(&t, "$" "Mdocdate: %b %d %Y $", p)) |
|
return(t); |
|
} |
|
|
|
if (MTIME_CANONICAL & flags || MTIME_REDUCED & flags) |
/* |
if (a2time(&t, "%b %d, %Y", p)) |
* End-of-sentence recognition must include situations where |
return(t); |
* some symbols, such as `)', allow prior EOS punctuation to |
|
* propagate outward. |
|
*/ |
|
|
if (MTIME_ISO_8601 & flags) |
enclosed = found = 0; |
if (a2time(&t, "%Y-%m-%d", p)) |
for (q = p + (int)sz - 1; q >= p; q--) { |
return(t); |
switch (*q) { |
|
case '\"': |
if (MTIME_REDUCED & flags) { |
case '\'': |
if (a2time(&t, "%d, %Y", p)) |
case ']': |
return(t); |
case ')': |
if (a2time(&t, "%Y", p)) |
if (0 == found) |
return(t); |
enclosed = 1; |
|
break; |
|
case '.': |
|
case '!': |
|
case '?': |
|
found = 1; |
|
break; |
|
default: |
|
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 |
int |
mandoc_eos(const char *p, size_t sz) |
mandoc_strntoi(const char *p, size_t sz, int base) |
{ |
{ |
|
char buf[32]; |
|
char *ep; |
|
long v; |
|
|
if (0 == sz) |
if (sz > 31) |
return(0); |
return -1; |
|
|
switch (p[(int)sz - 1]) { |
memcpy(buf, p, sz); |
case ('.'): |
buf[(int)sz] = '\0'; |
/* Escaped periods. */ |
|
if (sz > 1 && '\\' == p[(int)sz - 2]) |
|
return(0); |
|
/* FALLTHROUGH */ |
|
case ('!'): |
|
/* FALLTHROUGH */ |
|
case ('?'): |
|
break; |
|
default: |
|
return(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; |
} |
} |