]> git.cameronkatri.com Git - mandoc.git/blobdiff - mandoc.c
First, properly escape periods with \&. Then consistently refer to
[mandoc.git] / mandoc.c
index f1ac7c9ac8e8c001647f79b307cdb2b20e586383..da4a16067c57d2919c422a0df0419d534726efbd 100644 (file)
--- a/mandoc.c
+++ b/mandoc.c
@@ -1,14 +1,15 @@
-/*     $Id: mandoc.c,v 1.16 2010/05/25 12:37:20 kristaps Exp $ */
+/*     $Id: mandoc.c,v 1.44 2011/03/28 23:52:13 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011 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
  * 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
 #include <string.h>
 #include <time.h>
 
+#include "mandoc.h"
 #include "libmandoc.h"
 
-static int      a2time(time_t *, const char *, const char *);
+#define DATESIZE 32
 
+static int      a2time(time_t *, const char *, const char *);
+static char    *time2a(time_t);
 
 int
-mandoc_special(const char *p)
+mandoc_special(char *p)
 {
-       int              terminator;    /* Terminator for \s. */
-       int              lim;           /* Limit for N in \s. */
-       int              c, i;
+       int              len, i;
+       char             term;
+       char            *sv;
        
-       if ('\\' != *p++)
-               return(0);
+       len = 0;
+       term = '\0';
+       sv = p;
+
+       assert('\\' == *p);
+       p++;
 
-       switch (*p) {
-       case ('\''):
+       switch (*p++) {
+#if 0
+       case ('Z'):
+               /* FALLTHROUGH */
+       case ('X'):
+               /* FALLTHROUGH */
+       case ('x'):
                /* FALLTHROUGH */
-       case ('`'):
+       case ('S'):
                /* FALLTHROUGH */
-       case ('q'):
+       case ('R'):
                /* FALLTHROUGH */
-       case ('-'):
+       case ('N'):
                /* FALLTHROUGH */
-       case ('~'):
+       case ('l'):
                /* FALLTHROUGH */
-       case ('^'):
+       case ('L'):
                /* FALLTHROUGH */
-       case ('%'):
+       case ('H'):
                /* FALLTHROUGH */
-       case ('0'):
+       case ('h'):
                /* FALLTHROUGH */
-       case (' '):
+       case ('D'):
                /* FALLTHROUGH */
-       case ('|'):
+       case ('C'):
                /* FALLTHROUGH */
-       case ('&'):
+       case ('b'):
                /* FALLTHROUGH */
-       case ('.'):
+       case ('B'):
+               /* FALLTHROUGH */
+       case ('a'):
+               /* FALLTHROUGH */
+       case ('A'):
+               if (*p++ != '\'')
+                       return(0);
+               term = '\'';
+               break;
+#endif
+       case ('h'):
                /* FALLTHROUGH */
-       case (':'):
+       case ('v'):
                /* 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;
-               }
+               if (ASCII_HYPH == *p)
+                       *p = '-';
 
-               if (*p == '+' || *p == '-') {
-                       ++p;
-                       ++c;
+               i = 0;
+               if ('+' == *p || '-' == *p) {
+                       p++;
+                       i = 1;
                }
 
-               if (*p == '\'') {
-                       if (terminator)
-                               return(0);
-                       lim = 0;
-                       terminator = 1;
-                       ++p;
-                       ++c;
-               } else if (*p == '[') {
-                       if (terminator)
-                               return(0);
-                       lim = 0;
-                       terminator = 2;
-                       ++p;
-                       ++c;
-               } else if (*p == '(') {
-                       if (terminator)
-                               return(0);
-                       lim = 2;
-                       terminator = 3;
-                       ++p;
-                       ++c;
+               switch (*p++) {
+               case ('('):
+                       len = 2;
+                       break;
+               case ('['):
+                       term = ']';
+                       break;
+               case ('\''):
+                       term = '\'';
+                       break;
+               case ('0'):
+                       i = 1;
+                       /* FALLTHROUGH */
+               default:
+                       len = 1;
+                       p--;
+                       break;
                }
 
-               /* 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)
+               if (ASCII_HYPH == *p)
+                       *p = '-';
+               if ('+' == *p || '-' == *p) {
+                       if (i)
+                               return(0);
+                       p++;
+               } 
+               
+               /* Handle embedded numerical subexp or escape. */
+
+               if ('(' == *p) {
+                       while (*p && ')' != *p)
+                               if ('\\' == *p++) {
+                                       i = mandoc_special(--p);
+                                       if (0 == i)
+                                               return(0);
+                                       p += i;
+                               }
+
+                       if (')' == *p++)
                                break;
-                       ++p;
-                       ++c;
-               }
 
-               if (terminator && terminator < 3) {
-                       if (1 == terminator && *p != '\'')
-                               return(0);
-                       if (2 == terminator && *p != ']')
+                       return(0);
+               } else if ('\\' == *p) {
+                       if (0 == (i = mandoc_special(p)))
                                return(0);
-                       ++p;
-                       ++c;
+                       p += i;
                }
 
-               return(c);
+               break;
+#if 0
+       case ('Y'):
+               /* FALLTHROUGH */
+       case ('V'):
+               /* FALLTHROUGH */
+       case ('$'):
+               /* FALLTHROUGH */
+       case ('n'):
+               /* FALLTHROUGH */
+#endif
+       case ('k'):
+               /* FALLTHROUGH */
+       case ('M'):
+               /* FALLTHROUGH */
+       case ('m'):
+               /* FALLTHROUGH */
        case ('f'):
                /* FALLTHROUGH */
        case ('F'):
                /* FALLTHROUGH */
        case ('*'):
-               if (0 == *++p || ! isgraph((u_char)*p))
-                       return(0);
-               switch (*p) {
+               switch (*p++) {
                case ('('):
-                       if (0 == *++p || ! isgraph((u_char)*p))
-                               return(0);
-                       return(4);
+                       len = 2;
+                       break;
                case ('['):
-                       for (c = 3, p++; *p && ']' != *p; p++, c++)
-                               if ( ! isgraph((u_char)*p))
-                                       break;
-                       return(*p == ']' ? c : 0);
+                       term = ']';
+                       break;
                default:
+                       len = 1;
+                       p--;
                        break;
                }
-               return(3);
+               break;
        case ('('):
-               if (0 == *++p || ! isgraph((u_char)*p))
-                       return(0);
-               if (0 == *++p || ! isgraph((u_char)*p))
-                       return(0);
-               return(4);
+               len = 2;
+               break;
        case ('['):
+               term = ']';
                break;
+       case ('z'):
+               len = 1;
+               if ('\\' == *p) {
+                       if (0 == (i = mandoc_special(p)))
+                               return(0);
+                       p += i;
+                       return(*p ? (int)(p - sv) : 0);
+               }
+               break;
+       case ('o'):
+               /* FALLTHROUGH */
+       case ('w'):
+               if ('\'' == *p++) {
+                       term = '\'';
+                       break;
+               }
+               /* FALLTHROUGH */
        default:
-               return(0);
+               len = 1;
+               p--;
+               break;
        }
 
-       for (c = 3, p++; *p && ']' != *p; p++, c++)
-               if ( ! isgraph((u_char)*p))
-                       break;
+       if (term) {
+               for ( ; *p && term != *p; p++)
+                       if (ASCII_HYPH == *p)
+                               *p = '-';
+               return(*p ? (int)(p - sv) : 0);
+       }
 
-       return(*p == ']' ? c : 0);
+       for (i = 0; *p && i < len; i++, p++)
+               if (ASCII_HYPH == *p)
+                       *p = '-';
+       return(i == len ? (int)(p - sv) : 0);
 }
 
 
@@ -197,7 +236,7 @@ mandoc_calloc(size_t num, size_t size)
        ptr = calloc(num, size);
        if (NULL == ptr) {
                perror(NULL);
-               exit(EXIT_FAILURE);
+               exit((int)MANDOCLEVEL_SYSERR);
        }
 
        return(ptr);
@@ -212,7 +251,7 @@ mandoc_malloc(size_t size)
        ptr = malloc(size);
        if (NULL == ptr) {
                perror(NULL);
-               exit(EXIT_FAILURE);
+               exit((int)MANDOCLEVEL_SYSERR);
        }
 
        return(ptr);
@@ -226,7 +265,7 @@ mandoc_realloc(void *ptr, size_t size)
        ptr = realloc(ptr, size);
        if (NULL == ptr) {
                perror(NULL);
-               exit(EXIT_FAILURE);
+               exit((int)MANDOCLEVEL_SYSERR);
        }
 
        return(ptr);
@@ -241,12 +280,88 @@ mandoc_strdup(const char *ptr)
        p = strdup(ptr);
        if (NULL == p) {
                perror(NULL);
-               exit(EXIT_FAILURE);
+               exit((int)MANDOCLEVEL_SYSERR);
        }
 
        return(p);
 }
 
+/*
+ * Parse a quoted or unquoted roff-style request or macro argument.
+ * Return a pointer to the parsed argument, which is either the original
+ * pointer or advanced by one byte in case the argument is quoted.
+ * Null-terminate the argument in place.
+ * Collapse pairs of quotes inside quoted arguments.
+ * Advance the argument pointer to the next argument,
+ * or to the null byte terminating the argument line.
+ */
+char *
+mandoc_getarg(struct mparse *parse, char **cpp, int ln, int *pos)
+{
+       char     *start, *cp;
+       int       quoted, pairs, white;
+
+       /* Quoting can only start with a new word. */
+       start = *cpp;
+       if ('"' == *start) {
+               quoted = 1;
+               start++;
+       } else
+               quoted = 0;
+
+       pairs = 0;
+       white = 0;
+       for (cp = start; '\0' != *cp; cp++) {
+               /* Move left after quoted quotes and escaped backslashes. */
+               if (pairs)
+                       cp[-pairs] = cp[0];
+               if ('\\' == cp[0]) {
+                       if ('\\' == cp[1]) {
+                               /* Poor man's copy mode. */
+                               pairs++;
+                               cp++;
+                       } else if (0 == quoted && ' ' == cp[1])
+                               /* Skip escaped blanks. */
+                               cp++;
+               } else if (0 == quoted) {
+                       if (' ' == cp[0]) {
+                               /* Unescaped blanks end unquoted args. */
+                               white = 1;
+                               break;
+                       }
+               } else if ('"' == cp[0]) {
+                       if ('"' == cp[1]) {
+                               /* Quoted quotes collapse. */
+                               pairs++;
+                               cp++;
+                       } else {
+                               /* Unquoted quotes end quoted args. */
+                               quoted = 2;
+                               break;
+                       }
+               }
+       }
+
+       /* Quoted argument without a closing quote. */
+       if (1 == quoted)
+               mandoc_msg(MANDOCERR_BADQUOTE, parse, ln, *pos, NULL);
+
+       /* Null-terminate this argument and move to the next one. */
+       if (pairs)
+               cp[-pairs] = '\0';
+       if ('\0' != *cp) {
+               *cp++ = '\0';
+               while (' ' == *cp)
+                       cp++;
+       }
+       *pos += (int)(cp - start) + (quoted ? 1 : 0);
+       *cpp = cp;
+
+       if ('\0' == *cp && (white || ' ' == cp[-1]))
+               mandoc_msg(MANDOCERR_EOLNSPACE, parse, ln, *pos, NULL);
+
+       return(start);
+}
 
 static int
 a2time(time_t *t, const char *fmt, const char *p)
@@ -265,45 +380,67 @@ a2time(time_t *t, const char *fmt, const char *p)
        return(0);
 }
 
-
-/*
- * 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)
+static char *
+time2a(time_t t)
 {
-       time_t           t;
+       struct tm        tm;
+       char            *buf, *p;
+       size_t           ssz;
+       int              isz;
 
-       if (MTIME_MDOCDATE & flags) {
-               if (0 == strcmp(p, "$" "Mdocdate$"))
-                       return(time(NULL));
-               if (a2time(&t, "$" "Mdocdate: %b %d %Y $", p))
-                       return(t);
-       }
+       localtime_r(&t, &tm);
 
-       if (MTIME_CANONICAL & flags || MTIME_REDUCED & flags) 
-               if (a2time(&t, "%b %d, %Y", p))
-                       return(t);
+       /*
+        * 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);
 
-       if (MTIME_ISO_8601 & flags) 
-               if (a2time(&t, "%Y-%m-%d", p))
-                       return(t);
+       if (0 == (ssz = strftime(p, 10 + 1, "%B ", &tm)))
+               goto fail;
+       p += (int)ssz;
 
-       if (MTIME_REDUCED & flags) {
-               if (a2time(&t, "%d, %Y", p))
-                       return(t);
-               if (a2time(&t, "%Y", p))
-                       return(t);
-       }
+       if (-1 == (isz = snprintf(p, 4 + 1, "%d, ", tm.tm_mday)))
+               goto fail;
+       p += isz;
 
-       return(0);
+       if (0 == strftime(p, 4 + 1, "%Y", &tm))
+               goto fail;
+       return(buf);
+
+fail:
+       free(buf);
+       return(NULL);
 }
 
+char *
+mandoc_normdate(struct mparse *parse, char *in, int ln, int pos)
+{
+       char            *out;
+       time_t           t;
+
+       if (NULL == in || '\0' == *in ||
+           0 == strcmp(in, "$" "Mdocdate$")) {
+               mandoc_msg(MANDOCERR_NODATE, parse, ln, pos, NULL);
+               time(&t);
+       }
+       else if (!a2time(&t, "$" "Mdocdate: %b %d %Y $", in) &&
+           !a2time(&t, "%b %d, %Y", in) &&
+           !a2time(&t, "%Y-%m-%d", in)) {
+               mandoc_msg(MANDOCERR_BADDATE, parse, ln, pos, NULL);
+               t = 0;
+       }
+       out = t ? time2a(t) : NULL;
+       return(out ? out : mandoc_strdup(in));
+}
 
 int
-mandoc_eos(const char *p, size_t sz)
+mandoc_eos(const char *p, size_t sz, int enclosed)
 {
+       const char *q;
+       int found;
 
        if (0 == sz)
                return(0);
@@ -314,8 +451,9 @@ mandoc_eos(const char *p, size_t sz)
         * propogate outward.
         */
 
-       for ( ; sz; sz--) {
-               switch (p[(int)sz - 1]) {
+       found = 0;
+       for (q = p + (int)sz - 1; q >= p; q--) {
+               switch (*q) {
                case ('\"'):
                        /* FALLTHROUGH */
                case ('\''):
@@ -323,25 +461,24 @@ mandoc_eos(const char *p, size_t sz)
                case (']'):
                        /* FALLTHROUGH */
                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);
+                       found = 1;
+                       break;
                default:
-                       return(0);
+                       return(found && (!enclosed || isalnum((unsigned char)*q)));
                }
        }
 
-       return(0);
+       return(found && !enclosed);
 }
 
-
 int
 mandoc_hyph(const char *start, const char *c)
 {
@@ -368,3 +505,29 @@ mandoc_hyph(const char *start, const char *c)
 
        return(1);
 }
+
+/*
+ * Find out whether a line is a macro line or not.  If it is, adjust the
+ * current position and return one; if it isn't, return zero and don't
+ * change the current position.
+ */
+int
+mandoc_getcontrol(const char *cp, int *ppos)
+{
+       int             pos;
+
+       pos = *ppos;
+
+       if ('\\' == cp[pos] && '.' == cp[pos + 1])
+               pos += 2;
+       else if ('.' == cp[pos] || '\'' == cp[pos])
+               pos++;
+       else
+               return(0);
+
+       while (' ' == cp[pos] || '\t' == cp[pos])
+               pos++;
+
+       *ppos = pos;
+       return(1);
+}