Indentation must be measured in units of the surrounding text,

[mandoc.git] / mandoc.c

diff --git a/mandoc.c b/mandoc.c
index dd2227299931125b571597d81abe627fa6510c9c..d265463b4efeb092cf554f41931308e1265a02cf 100644 (file)
--- a/mandoc.c
+++ b/mandoc.c
@@ -1,7 +1,7 @@
-/*     $Id: mandoc.c,v 1.83 2014/07/06 19:09:00 schwarze Exp $ */
+/*     $Id: mandoc.c,v 1.98 2015/11/12 22:44:27 schwarze Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>

  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -15,9 +15,7 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */

-#ifdef HAVE_CONFIG_H

 #include "config.h"
 #include "config.h"

-#endif

 
 #include <sys/types.h>
 
 
 #include <sys/types.h>
 


@@ -34,8 +32,6 @@
 #include "mandoc_aux.h"
 #include "libmandoc.h"
 
 #include "mandoc_aux.h"
 #include "libmandoc.h"
 

-#define DATESIZE 32
-

 static int      a2time(time_t *, const char *, const char *);
 static char    *time2a(time_t);
 
 static int      a2time(time_t *, const char *, const char *);
 static char    *time2a(time_t);
 


@@ -81,24 +77,13 @@ mandoc_escape(const char **end, const char **start, int *sz)
                break;
        case '[':
                gly = ESCAPE_SPECIAL;
                break;
        case '[':
                gly = ESCAPE_SPECIAL;

-               /*
-                * Unicode escapes are defined in groff as \[uXXXX] to
-                * \[u10FFFF], where the contained value must be a valid
-                * Unicode codepoint.  Here, however, only check whether
-                * it's not a zero-width escape.
-                */
-               if ('u' == (*start)[0] && ']' != (*start)[1])
-                       gly = ESCAPE_UNICODE;

                term = ']';
                break;
        case 'C':
                if ('\'' != **start)
                term = ']';
                break;
        case 'C':
                if ('\'' != **start)

-                       return(ESCAPE_ERROR);
+                       return ESCAPE_ERROR;

                *start = ++*end;
                *start = ++*end;

-               if ('u' == (*start)[0] && '\'' != (*start)[1])
-                       gly = ESCAPE_UNICODE;
-               else
-                       gly = ESCAPE_SPECIAL;
+               gly = ESCAPE_SPECIAL;

                term = '\'';
                break;
 
                term = '\'';
                break;
 


@@ -106,9 +91,10 @@ mandoc_escape(const char **end, const char **start, int *sz)
         * Escapes taking no arguments at all.
         */
        case 'd':
         * Escapes taking no arguments at all.
         */
        case 'd':

-               /* FALLTHROUGH */

        case 'u':
        case 'u':

-               return(ESCAPE_IGNORE);
+       case ',':
+       case '/':
+               return ESCAPE_IGNORE;

 
        /*
         * The \z escape is supposed to output the following
 
        /*
         * The \z escape is supposed to output the following


@@ -117,26 +103,19 @@ mandoc_escape(const char **end, const char **start, int *sz)
         * let us just skip the next character.
         */
        case 'z':
         * let us just skip the next character.
         */
        case 'z':

-               return(ESCAPE_SKIPCHAR);
+               return ESCAPE_SKIPCHAR;

 
        /*
         * Handle all triggers matching \X(xy, \Xx, and \X[xxxx], where
         * 'X' is the trigger.  These have opaque sub-strings.
         */
        case 'F':
 
        /*
         * Handle all triggers matching \X(xy, \Xx, and \X[xxxx], where
         * 'X' is the trigger.  These have opaque sub-strings.
         */
        case 'F':

-               /* FALLTHROUGH */

        case 'g':
        case 'g':

-               /* FALLTHROUGH */

        case 'k':
        case 'k':

-               /* FALLTHROUGH */

        case 'M':
        case 'M':

-               /* FALLTHROUGH */

        case 'm':
        case 'm':

-               /* FALLTHROUGH */

        case 'n':
        case 'n':

-               /* FALLTHROUGH */

        case 'V':
        case 'V':

-               /* FALLTHROUGH */

        case 'Y':
                gly = ESCAPE_IGNORE;
                /* FALLTHROUGH */
        case 'Y':
                gly = ESCAPE_IGNORE;
                /* FALLTHROUGH */


@@ -164,21 +143,18 @@ mandoc_escape(const char **end, const char **start, int *sz)
         * The \B and \w escapes are handled in roff.c, roff_res().
         */
        case 'A':
         * The \B and \w escapes are handled in roff.c, roff_res().
         */
        case 'A':

-               /* FALLTHROUGH */

        case 'b':
        case 'b':

-               /* FALLTHROUGH */

        case 'D':
        case 'D':

-               /* FALLTHROUGH */
-       case 'o':
-               /* FALLTHROUGH */

        case 'R':
        case 'R':

-               /* FALLTHROUGH */

        case 'X':
        case 'X':

-               /* FALLTHROUGH */

        case 'Z':
        case 'Z':

-               if ('\0' == **start)
-                       return(ESCAPE_ERROR);

                gly = ESCAPE_IGNORE;
                gly = ESCAPE_IGNORE;

+               /* FALLTHROUGH */
+       case 'o':
+               if (**start == '\0')
+                       return ESCAPE_ERROR;
+               if (gly == ESCAPE_ERROR)
+                       gly = ESCAPE_OVERSTRIKE;

                term = **start;
                *start = ++*end;
                break;
                term = **start;
                *start = ++*end;
                break;


@@ -188,21 +164,16 @@ mandoc_escape(const char **end, const char **start, int *sz)
         * and 'N' resolves to a numerical expression.
         */
        case 'h':
         * and 'N' resolves to a numerical expression.
         */
        case 'h':

-               /* FALLTHROUGH */

        case 'H':
        case 'H':

-               /* FALLTHROUGH */

        case 'L':
        case 'L':

-               /* FALLTHROUGH */

        case 'l':
        case 'l':

-               /* FALLTHROUGH */

        case 'S':
        case 'S':

-               /* FALLTHROUGH */

        case 'v':
        case 'v':

-               /* FALLTHROUGH */

        case 'x':
                if (strchr(" %&()*+-./0123456789:<=>", **start)) {
        case 'x':
                if (strchr(" %&()*+-./0123456789:<=>", **start)) {

-                       ++*end;
-                       return(ESCAPE_ERROR);
+                       if ('\0' != **start)
+                               ++*end;
+                       return ESCAPE_ERROR;

                }
                gly = ESCAPE_IGNORE;
                term = **start;
                }
                gly = ESCAPE_IGNORE;
                term = **start;


@@ -215,11 +186,11 @@ mandoc_escape(const char **end, const char **start, int *sz)
         */
        case 'N':
                if ('\0' == **start)
         */
        case 'N':
                if ('\0' == **start)

-                       return(ESCAPE_ERROR);
+                       return ESCAPE_ERROR;

                (*end)++;
                if (isdigit((unsigned char)**start)) {
                        *sz = 1;
                (*end)++;
                if (isdigit((unsigned char)**start)) {
                        *sz = 1;

-                       return(ESCAPE_IGNORE);
+                       return ESCAPE_IGNORE;

                }
                (*start)++;
                while (isdigit((unsigned char)**end))
                }
                (*start)++;
                while (isdigit((unsigned char)**end))


@@ -227,7 +198,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
                *sz = *end - *start;
                if ('\0' != **end)
                        (*end)++;
                *sz = *end - *start;
                if ('\0' != **end)
                        (*end)++;

-               return(ESCAPE_NUMBERED);
+               return ESCAPE_NUMBERED;

 
        /*
         * Sizes get a special category of their own.
 
        /*
         * Sizes get a special category of their own.


@@ -237,7 +208,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
 
                /* See +/- counts as a sign. */
                if ('+' == **end || '-' == **end || ASCII_HYPH == **end)
 
                /* See +/- counts as a sign. */
                if ('+' == **end || '-' == **end || ASCII_HYPH == **end)

-                       (*end)++;
+                       *start = ++*end;

 
                switch (**end) {
                case '(':
 
                switch (**end) {
                case '(':


@@ -252,6 +223,12 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        *start = ++*end;
                        term = '\'';
                        break;
                        *start = ++*end;
                        term = '\'';
                        break;

+               case '3':
+               case '2':
+               case '1':
+                       *sz = (*end)[-1] == 's' &&
+                           isdigit((unsigned char)(*end)[1]) ? 2 : 1;
+                       break;

                default:
                        *sz = 1;
                        break;
                default:
                        *sz = 1;
                        break;


@@ -281,12 +258,12 @@ mandoc_escape(const char **end, const char **start, int *sz)
                while (**end != term) {
                        switch (**end) {
                        case '\0':
                while (**end != term) {
                        switch (**end) {
                        case '\0':

-                               return(ESCAPE_ERROR);
+                               return ESCAPE_ERROR;

                        case '\\':
                                (*end)++;
                                if (ESCAPE_ERROR ==
                                    mandoc_escape(end, NULL, NULL))
                        case '\\':
                                (*end)++;
                                if (ESCAPE_ERROR ==
                                    mandoc_escape(end, NULL, NULL))

-                                       return(ESCAPE_ERROR);
+                                       return ESCAPE_ERROR;

                                break;
                        default:
                                (*end)++;
                                break;
                        default:
                                (*end)++;


@@ -297,7 +274,7 @@ mandoc_escape(const char **end, const char **start, int *sz)
        } else {
                assert(*sz > 0);
                if ((size_t)*sz > strlen(*start))
        } else {
                assert(*sz > 0);
                if ((size_t)*sz > strlen(*start))

-                       return(ESCAPE_ERROR);
+                       return ESCAPE_ERROR;

                *end += *sz;
        }
 
                *end += *sz;
        }
 


@@ -323,12 +300,10 @@ mandoc_escape(const char **end, const char **start, int *sz)
 
                switch (**start) {
                case '3':
 
                switch (**start) {
                case '3':

-                       /* FALLTHROUGH */

                case 'B':
                        gly = ESCAPE_FONTBOLD;
                        break;
                case '2':
                case 'B':
                        gly = ESCAPE_FONTBOLD;
                        break;
                case '2':

-                       /* FALLTHROUGH */

                case 'I':
                        gly = ESCAPE_FONTITALIC;
                        break;
                case 'I':
                        gly = ESCAPE_FONTITALIC;
                        break;


@@ -336,7 +311,6 @@ mandoc_escape(const char **end, const char **start, int *sz)
                        gly = ESCAPE_FONTPREV;
                        break;
                case '1':
                        gly = ESCAPE_FONTPREV;
                        break;
                case '1':

-                       /* FALLTHROUGH */

                case 'R':
                        gly = ESCAPE_FONTROMAN;
                        break;
                case 'R':
                        gly = ESCAPE_FONTROMAN;
                        break;


@@ -345,12 +319,30 @@ mandoc_escape(const char **end, const char **start, int *sz)
        case ESCAPE_SPECIAL:
                if (1 == *sz && 'c' == **start)
                        gly = ESCAPE_NOSPACE;
        case ESCAPE_SPECIAL:
                if (1 == *sz && 'c' == **start)
                        gly = ESCAPE_NOSPACE;

+               /*
+                * Unicode escapes are defined in groff as \[u0000]
+                * to \[u10FFFF], where the contained value must be
+                * a valid Unicode codepoint.  Here, however, only
+                * check the length and range.
+                */
+               if (**start != 'u' || *sz < 5 || *sz > 7)
+                       break;
+               if (*sz == 7 && ((*start)[1] != '1' || (*start)[2] != '0'))
+                       break;
+               if (*sz == 6 && (*start)[1] == '0')
+                       break;
+               if (*sz == 5 && (*start)[1] == 'D' &&
+                   strchr("89ABCDEF", (*start)[2]) != NULL)
+                       break;
+               if ((int)strspn(*start + 1, "0123456789ABCDEFabcdef")
+                   + 1 == *sz)
+                       gly = ESCAPE_UNICODE;

                break;
        default:
                break;
        }
 
                break;
        default:
                break;
        }
 

-       return(gly);
+       return gly;

 }
 
 /*
 }
 
 /*


@@ -445,7 +437,7 @@ mandoc_getarg(struct mparse *parse, char **cpp, int ln, int *pos)
        if ('\0' == *cp && (white || ' ' == cp[-1]))
                mandoc_msg(MANDOCERR_SPACE_EOL, parse, ln, *pos, NULL);
 
        if ('\0' == *cp && (white || ' ' == cp[-1]))
                mandoc_msg(MANDOCERR_SPACE_EOL, parse, ln, *pos, NULL);
 

-       return(start);
+       return start;

 }
 
 static int
 }
 
 static int


@@ -457,15 +449,15 @@ a2time(time_t *t, const char *fmt, const char *p)
        memset(&tm, 0, sizeof(struct tm));
 
        pp = NULL;
        memset(&tm, 0, sizeof(struct tm));
 
        pp = NULL;

-#ifdef HAVE_STRPTIME
+#if HAVE_STRPTIME

        pp = strptime(p, fmt, &tm);
 #endif
        if (NULL != pp && '\0' == *pp) {
                *t = mktime(&tm);
        pp = strptime(p, fmt, &tm);
 #endif
        if (NULL != pp && '\0' == *pp) {
                *t = mktime(&tm);

-               return(1);
+               return 1;

        }
 
        }
 

-       return(0);
+       return 0;

 }
 
 static char *
 }
 
 static char *


@@ -477,6 +469,8 @@ time2a(time_t t)
        int              isz;
 
        tm = localtime(&t);
        int              isz;
 
        tm = localtime(&t);

+       if (tm == NULL)
+               return NULL;

 
        /*
         * Reserve space:
 
        /*
         * Reserve space:


@@ -484,45 +478,61 @@ time2a(time_t t)
         * up to 2 characters for the day + comma + blank
         * 4 characters for the year and a terminating '\0'
         */
         * 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);
 
        p = buf = mandoc_malloc(10 + 4 + 4 + 1);
 

-       if (0 == (ssz = strftime(p, 10 + 1, "%B ", tm)))
+       if ((ssz = strftime(p, 10 + 1, "%B ", tm)) == 0)

                goto fail;
        p += (int)ssz;
 
                goto fail;
        p += (int)ssz;
 

-       if (-1 == (isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)))
+       /*
+        * 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.
+        */
+
+       if ((isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)) == -1)

                goto fail;
        p += isz;
 
                goto fail;
        p += isz;
 

-       if (0 == strftime(p, 4 + 1, "%Y", tm))
+       if (strftime(p, 4 + 1, "%Y", tm) == 0)

                goto fail;
                goto fail;

-       return(buf);
+       return buf;

 
 fail:
        free(buf);
 
 fail:
        free(buf);

-       return(NULL);
+       return NULL;

 }
 
 char *
 mandoc_normdate(struct mparse *parse, char *in, int ln, int pos)
 {
 }
 
 char *
 mandoc_normdate(struct mparse *parse, char *in, int ln, int pos)
 {

-       char            *out;

        time_t           t;
 
        time_t           t;
 

-       if (NULL == in || '\0' == *in ||
-           0 == strcmp(in, "$" "Mdocdate$")) {
+       /* No date specified: use today's date. */
+
+       if (in == NULL || *in == '\0' || strcmp(in, "$" "Mdocdate$") == 0) {

                mandoc_msg(MANDOCERR_DATE_MISSING, parse, ln, pos, NULL);
                mandoc_msg(MANDOCERR_DATE_MISSING, parse, ln, pos, NULL);

-               time(&t);
+               return time2a(time(NULL));

        }
        }

-       else if (a2time(&t, "%Y-%m-%d", in))
-               t = 0;
-       else if (!a2time(&t, "$" "Mdocdate: %b %d %Y $", in) &&
-           !a2time(&t, "%b %d, %Y", in)) {
+
+       /* Valid mdoc(7) date format. */
+
+       if (a2time(&t, "$" "Mdocdate: %b %d %Y $", in) ||
+           a2time(&t, "%b %d, %Y", in))
+               return time2a(t);
+
+       /* Do not warn about the legacy man(7) format. */
+
+       if ( ! a2time(&t, "%Y-%m-%d", in))

                mandoc_msg(MANDOCERR_DATE_BAD, parse, ln, pos, in);
                mandoc_msg(MANDOCERR_DATE_BAD, parse, ln, pos, in);

-               t = 0;
-       }
-       out = t ? time2a(t) : NULL;
-       return(out ? out : mandoc_strdup(in));
+
+       /* Use any non-mdoc(7) date verbatim. */
+
+       return mandoc_strdup(in);

 }
 
 int
 }
 
 int


@@ -532,7 +542,7 @@ mandoc_eos(const char *p, size_t sz)
        int              enclosed, found;
 
        if (0 == sz)
        int              enclosed, found;
 
        if (0 == sz)

-               return(0);
+               return 0;

 
        /*
         * End-of-sentence recognition must include situations where
 
        /*
         * End-of-sentence recognition must include situations where


@@ -544,28 +554,24 @@ mandoc_eos(const char *p, size_t sz)
        for (q = p + (int)sz - 1; q >= p; q--) {
                switch (*q) {
                case '\"':
        for (q = p + (int)sz - 1; q >= p; q--) {
                switch (*q) {
                case '\"':

-                       /* FALLTHROUGH */

                case '\'':
                case '\'':

-                       /* FALLTHROUGH */

                case ']':
                case ']':

-                       /* FALLTHROUGH */

                case ')':
                        if (0 == found)
                                enclosed = 1;
                        break;
                case '.':
                case ')':
                        if (0 == found)
                                enclosed = 1;
                        break;
                case '.':

-                       /* FALLTHROUGH */

                case '!':
                case '!':

-                       /* FALLTHROUGH */

                case '?':
                        found = 1;
                        break;
                default:
                case '?':
                        found = 1;
                        break;
                default:

-                       return(found && (!enclosed || isalnum((unsigned char)*q)));
+                       return found &&
+                           (!enclosed || isalnum((unsigned char)*q));

                }
        }
 
                }
        }
 

-       return(found && !enclosed);
+       return found && !enclosed;

 }
 
 /*
 }
 
 /*


@@ -580,7 +586,7 @@ mandoc_strntoi(const char *p, size_t sz, int base)
        long             v;
 
        if (sz > 31)
        long             v;
 
        if (sz > 31)

-               return(-1);
+               return -1;

 
        memcpy(buf, p, sz);
        buf[(int)sz] = '\0';
 
        memcpy(buf, p, sz);
        buf[(int)sz] = '\0';


@@ -589,12 +595,12 @@ mandoc_strntoi(const char *p, size_t sz, int base)
        v = strtol(buf, &ep, base);
 
        if (buf[0] == '\0' || *ep != '\0')
        v = strtol(buf, &ep, base);
 
        if (buf[0] == '\0' || *ep != '\0')

-               return(-1);
+               return -1;

 
        if (v > INT_MAX)
                v = INT_MAX;
        if (v < INT_MIN)
                v = INT_MIN;
 
 
        if (v > INT_MAX)
                v = INT_MAX;
        if (v < INT_MIN)
                v = INT_MIN;
 

-       return((int)v);
+       return (int)v;

 }
 }