[BACK]Return to mandoc.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.c between version 1.4 and 1.110

version 1.4, 2009/10/28 19:21:59 version 1.110, 2018/12/14 06:33:14
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * 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.
  */   */
   #include "config.h"
   
 #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 "mandoc_aux.h"
   #include "mandoc.h"
   #include "roff.h"
 #include "libmandoc.h"  #include "libmandoc.h"
   
 int  static  int      a2time(time_t *, const char *, const char *);
 mandoc_special(const char *p)  static  char    *time2a(time_t);
   
   
   enum mandoc_esc
   mandoc_escape(const char **end, const char **start, int *sz)
 {  {
         int              c;          const char      *local_start;
           int              local_sz, c, i;
         if ('\\' != *p++)          char             term;
                 return(0);          enum mandoc_esc  gly;
   
         switch (*p) {          /*
         case ('\\'):           * When the caller doesn't provide return storage,
            * use local storage.
            */
   
           if (NULL == start)
                   start = &local_start;
           if (NULL == sz)
                   sz = &local_sz;
   
           /*
            * Beyond the backslash, at least one input character
            * is part of the escape sequence.  With one exception
            * (see below), that character won't be returned.
            */
   
           gly = ESCAPE_ERROR;
           *start = ++*end;
           *sz = 0;
           term = '\0';
   
           switch ((*start)[-1]) {
           /*
            * First the glyphs.  There are several different forms of
            * these, but each eventually returns a substring of the glyph
            * name.
            */
           case '(':
                   gly = ESCAPE_SPECIAL;
                   *sz = 2;
                   break;
           case '[':
                   gly = ESCAPE_SPECIAL;
                   term = ']';
                   break;
           case 'C':
                   if ('\'' != **start)
                           return ESCAPE_ERROR;
                   *start = ++*end;
                   gly = ESCAPE_SPECIAL;
                   term = '\'';
                   break;
   
           /*
            * Escapes taking no arguments at all.
            */
           case 'd':
           case 'u':
           case ',':
           case '/':
                   return ESCAPE_IGNORE;
           case 'p':
                   return ESCAPE_BREAK;
   
           /*
            * The \z escape is supposed to output the following
            * character without advancing the cursor position.
            * Since we are mostly dealing with terminal mode,
            * let us just skip the next character.
            */
           case 'z':
                   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':
           case 'g':
           case 'k':
           case 'M':
           case 'm':
           case 'n':
           case 'V':
           case 'Y':
                   gly = ESCAPE_IGNORE;
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case ('\''):          case 'f':
                   if (ESCAPE_ERROR == gly)
                           gly = ESCAPE_FONT;
                   switch (**start) {
                   case '(':
                           *start = ++*end;
                           *sz = 2;
                           break;
                   case '[':
                           *start = ++*end;
                           term = ']';
                           break;
                   default:
                           *sz = 1;
                           break;
                   }
                   break;
           case '*':
                   if (strncmp(*start, "(.T", 3) != 0)
                           abort();
                   gly = ESCAPE_DEVICE;
                   *start = ++*end;
                   *sz = 2;
                   break;
   
           /*
            * These escapes are of the form \X'Y', where 'X' is the trigger
            * and 'Y' is any string.  These have opaque sub-strings.
            * The \B and \w escapes are handled in roff.c, roff_res().
            */
           case 'A':
           case 'b':
           case 'D':
           case 'R':
           case 'X':
           case 'Z':
                   gly = ESCAPE_IGNORE;
                 /* FALLTHROUGH */                  /* FALLTHROUGH */
         case ('`'):          case 'o':
                 /* FALLTHROUGH */                  if (**start == '\0')
         case ('q'):                          return ESCAPE_ERROR;
                 /* FALLTHROUGH */                  if (gly == ESCAPE_ERROR)
         case ('-'):                          gly = ESCAPE_OVERSTRIKE;
                 /* FALLTHROUGH */                  term = **start;
         case ('~'):                  *start = ++*end;
                 /* FALLTHROUGH */                  break;
         case ('^'):  
                 /* FALLTHROUGH */          /*
         case ('%'):           * These escapes are of the form \X'N', where 'X' is the trigger
                 /* FALLTHROUGH */           * and 'N' resolves to a numerical expression.
         case ('0'):           */
                 /* FALLTHROUGH */          case 'h':
         case (' '):          case 'H':
                 /* FALLTHROUGH */          case 'L':
         case ('|'):          case 'l':
                 /* FALLTHROUGH */          case 'S':
         case ('&'):          case 'v':
                 /* FALLTHROUGH */          case 'x':
         case ('.'):                  if (strchr(" %&()*+-./0123456789:<=>", **start)) {
                 /* FALLTHROUGH */                          if ('\0' != **start)
         case (':'):                                  ++*end;
                 /* FALLTHROUGH */                          return ESCAPE_ERROR;
         case ('c'):                  }
                 return(2);                  switch ((*start)[-1]) {
         case ('e'):                  case 'h':
                 return(2);                          gly = ESCAPE_HORIZ;
         case ('f'):                          break;
                 if (0 == *++p || ! isgraph((u_char)*p))                  case 'l':
                         return(0);                          gly = ESCAPE_HLINE;
                 return(3);                          break;
         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:
                           gly = ESCAPE_IGNORE;
                         break;                          break;
                 }                  }
                 return(3);                  term = **start;
         case ('('):                  *start = ++*end;
                 if (0 == *++p || ! isgraph((u_char)*p))  
                         return(0);  
                 if (0 == *++p || ! isgraph((u_char)*p))  
                         return(0);  
                 return(4);  
         case ('['):  
                 break;                  break;
   
           /*
            * Special handling for the numbered character escape.
            * XXX Do any other escapes need similar handling?
            */
           case 'N':
                   if ('\0' == **start)
                           return ESCAPE_ERROR;
                   (*end)++;
                   if (isdigit((unsigned char)**start)) {
                           *sz = 1;
                           return ESCAPE_IGNORE;
                   }
                   (*start)++;
                   while (isdigit((unsigned char)**end))
                           (*end)++;
                   *sz = *end - *start;
                   if ('\0' != **end)
                           (*end)++;
                   return ESCAPE_NUMBERED;
   
           /*
            * Sizes get a special category of their own.
            */
           case 's':
                   gly = ESCAPE_IGNORE;
   
                   /* See +/- counts as a sign. */
                   if ('+' == **end || '-' == **end || ASCII_HYPH == **end)
                           *start = ++*end;
   
                   switch (**end) {
                   case '(':
                           *start = ++*end;
                           *sz = 2;
                           break;
                   case '[':
                           *start = ++*end;
                           term = ']';
                           break;
                   case '\'':
                           *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;
                   }
   
                   break;
   
           /*
            * Anything else is assumed to be a glyph.
            * In this case, pass back the character after the backslash.
            */
         default:          default:
                 return(0);                  gly = ESCAPE_SPECIAL;
                   *start = --*end;
                   *sz = 1;
                   break;
         }          }
   
         for (c = 3, p++; *p && ']' != *p; p++, c++)          assert(ESCAPE_ERROR != gly);
                 if ( ! isgraph((u_char)*p))  
           /*
            * Read up to the terminating character,
            * paying attention to nested escapes.
            */
   
           if ('\0' != term) {
                   while (**end != term) {
                           switch (**end) {
                           case '\0':
                                   return ESCAPE_ERROR;
                           case '\\':
                                   (*end)++;
                                   if (ESCAPE_ERROR ==
                                       mandoc_escape(end, NULL, NULL))
                                           return ESCAPE_ERROR;
                                   break;
                           default:
                                   (*end)++;
                                   break;
                           }
                   }
                   *sz = (*end)++ - *start;
           } else {
                   assert(*sz > 0);
                   if ((size_t)*sz > strlen(*start))
                           return ESCAPE_ERROR;
                   *end += *sz;
           }
   
           /* Run post-processors. */
   
           switch (gly) {
           case ESCAPE_FONT:
                   if (*sz == 2) {
                           if (**start == 'C') {
                                   if ((*start)[1] == 'W' ||
                                       (*start)[1] == 'R') {
                                           gly = ESCAPE_FONTCW;
                                           break;
                                   }
                                   /*
                                    * Treat other constant-width font modes
                                    * just like regular font modes.
                                    */
                                   (*start)++;
                                   (*sz)--;
                           } else {
                                   if ((*start)[0] == 'B' && (*start)[1] == 'I')
                                           gly = ESCAPE_FONTBI;
                                   break;
                           }
                   } else if (*sz != 1) {
                           if (*sz == 0)
                                   gly = ESCAPE_FONTPREV;
                         break;                          break;
                   }
   
         return(*p == ']' ? c : 0);                  switch (**start) {
 }                  case '3':
                   case 'B':
                           gly = ESCAPE_FONTBOLD;
                           break;
                   case '2':
                   case 'I':
                           gly = ESCAPE_FONTITALIC;
                           break;
                   case 'P':
                           gly = ESCAPE_FONTPREV;
                           break;
                   case '1':
                   case 'R':
                           gly = ESCAPE_FONTROMAN;
                           break;
                   }
                   break;
           case ESCAPE_SPECIAL:
                   if (**start == 'c') {
                           if (*sz == 1) {
                                   gly = ESCAPE_NOSPACE;
                                   break;
                           }
                           if (*sz < 6 || *sz > 7 ||
                               strncmp(*start, "char", 4) != 0 ||
                               (int)strspn(*start + 4, "0123456789") + 4 < *sz)
                                   break;
                           c = 0;
                           for (i = 4; i < *sz; i++)
                                   c = 10 * c + ((*start)[i] - '0');
                           if (c < 0x21 || (c > 0x7e && c < 0xa0) || c > 0xff)
                                   break;
                           *start += 4;
                           *sz -= 4;
                           gly = ESCAPE_NUMBERED;
                           break;
                   }
   
                   /*
                    * 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;
           }
   
 void *          return gly;
 mandoc_calloc(size_t num, size_t size)  }
   
   /*
    * 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.
    * NUL-terminate the argument in place.
    * Collapse pairs of quotes inside quoted arguments.
    * Advance the argument pointer to the next argument,
    * or to the NUL byte terminating the argument line.
    */
   char *
   mandoc_getarg(char **cpp, int ln, int *pos)
 {  {
         void            *ptr;          char     *start, *cp;
           int       quoted, pairs, white;
   
         ptr = calloc(num, size);          /* Quoting can only start with a new word. */
         if (NULL == ptr) {          start = *cpp;
                 fprintf(stderr, "memory exhausted\n");          quoted = 0;
                 exit(EXIT_FAILURE);          if ('"' == *start) {
                   quoted = 1;
                   start++;
         }          }
   
         return(ptr);          pairs = 0;
 }          white = 0;
           for (cp = start; '\0' != *cp; cp++) {
   
                   /*
                    * Move the following text left
                    * after quoted quotes and after "\\" and "\t".
                    */
                   if (pairs)
                           cp[-pairs] = cp[0];
   
 void *                  if ('\\' == cp[0]) {
 mandoc_malloc(size_t size)                          /*
 {                           * In copy mode, translate double to single
         void            *ptr;                           * backslashes and backslash-t to literal tabs.
                            */
                           switch (cp[1]) {
                           case 't':
                                   cp[0] = '\t';
                                   /* FALLTHROUGH */
                           case '\\':
                                   pairs++;
                                   cp++;
                                   break;
                           case ' ':
                                   /* Skip escaped blanks. */
                                   if (0 == quoted)
                                           cp++;
                                   break;
                           default:
                                   break;
                           }
                   } 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;
                           }
                   }
           }
   
         ptr = malloc(size);          /* Quoted argument without a closing quote. */
         if (NULL == ptr) {          if (1 == quoted)
                 fprintf(stderr, "memory exhausted\n");                  mandoc_msg(MANDOCERR_ARG_QUOTE, ln, *pos, NULL);
                 exit(EXIT_FAILURE);  
           /* NUL-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;
   
         return(ptr);          if ('\0' == *cp && (white || ' ' == cp[-1]))
                   mandoc_msg(MANDOCERR_SPACE_EOL, ln, *pos, NULL);
   
           return start;
 }  }
   
   static int
 void *  a2time(time_t *t, const char *fmt, const char *p)
 mandoc_realloc(void *ptr, size_t size)  
 {  {
           struct tm        tm;
           char            *pp;
   
         ptr = realloc(ptr, size);          memset(&tm, 0, sizeof(struct tm));
         if (NULL == ptr) {  
                 fprintf(stderr, "memory exhausted\n");          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_reallocf(void *old_ptr, size_t size) /* FIXME: remove (not used) */  
 {  {
         void            *ptr;          struct tm       *tm;
           char            *buf, *p;
           size_t           ssz;
           int              isz;
   
         ptr = realloc(old_ptr, size);          tm = localtime(&t);
         if (NULL == ptr)          if (tm == NULL)
                 free(old_ptr);                  return NULL;
   
         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);
   
           if ((ssz = strftime(p, 10 + 1, "%B ", tm)) == 0)
                   goto fail;
           p += (int)ssz;
   
           /*
            * 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;
   
           if (strftime(p, 4 + 1, "%Y", tm) == 0)
                   goto fail;
           return buf;
   
   fail:
           free(buf);
           return NULL;
   }
   
 char *  char *
 mandoc_strdup(const char *ptr)  mandoc_normdate(struct roff_man *man, char *in, int ln, int pos)
 {  {
         char            *p;          char            *cp;
           time_t           t;
   
         p = strdup(ptr);          /* No date specified: use today's date. */
         if (NULL == p) {  
                 fprintf(stderr, "memory exhausted\n");          if (in == NULL || *in == '\0' || strcmp(in, "$" "Mdocdate$") == 0) {
                 exit(EXIT_FAILURE);                  mandoc_msg(MANDOCERR_DATE_MISSING, ln, pos, NULL);
                   return time2a(time(NULL));
         }          }
   
         return(p);          /* Valid mdoc(7) date format. */
   
           if (a2time(&t, "$" "Mdocdate: %b %d %Y $", in) ||
               a2time(&t, "%b %d, %Y", in)) {
                   cp = time2a(t);
                   if (t > time(NULL) + 86400)
                           mandoc_msg(MANDOCERR_DATE_FUTURE, ln, pos, "%s", cp);
                   else if (*in != '$' && strcmp(in, cp) != 0)
                           mandoc_msg(MANDOCERR_DATE_NORM, ln, pos, "%s", cp);
                   return cp;
           }
   
           /* In man(7), do not warn about the legacy format. */
   
           if (a2time(&t, "%Y-%m-%d", in) == 0)
                   mandoc_msg(MANDOCERR_DATE_BAD, ln, pos, "%s", in);
           else if (t > time(NULL) + 86400)
                   mandoc_msg(MANDOCERR_DATE_FUTURE, ln, pos, "%s", in);
           else if (man->macroset == MACROSET_MDOC)
                   mandoc_msg(MANDOCERR_DATE_LEGACY, ln, pos, "Dd %s", in);
   
           /* Use any non-mdoc(7) date verbatim. */
   
           return mandoc_strdup(in);
   }
   
   int
   mandoc_eos(const char *p, size_t sz)
   {
           const char      *q;
           int              enclosed, found;
   
           if (0 == sz)
                   return 0;
   
           /*
            * End-of-sentence recognition must include situations where
            * some symbols, such as `)', allow prior EOS punctuation to
            * propagate outward.
            */
   
           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 '.':
                   case '!':
                   case '?':
                           found = 1;
                           break;
                   default:
                           return found &&
                               (!enclosed || isalnum((unsigned char)*q));
                   }
           }
   
           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_strntoi(const char *p, size_t sz, int base)
   {
           char             buf[32];
           char            *ep;
           long             v;
   
           if (sz > 31)
                   return -1;
   
           memcpy(buf, p, sz);
           buf[(int)sz] = '\0';
   
           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;
 }  }
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.110
CVSweb