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

Diff for /mandoc/mandoc.c between version 1.113 and 1.121

version 1.113, 2018/12/18 22:00:02 version 1.121, 2022/05/19 15:37:47
Line 1 
Line 1 
 /*      $Id$ */  /* $Id$ */
 /*  /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010, 2011, 2015, 2017, 2018, 2019, 2020, 2021
  * Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>   *               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
Line 14 
Line 15 
  * 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.
  */   */
 #include "config.h"  #include "config.h"
   
Line 32 
Line 38 
 #include "mandoc.h"  #include "mandoc.h"
 #include "roff.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);  static  char    *time2a(time_t);
Line 73  mandoc_font(const char *cp, int sz)
Line 80  mandoc_font(const char *cp, int sz)
                 case 'C':                  case 'C':
                         switch (cp[1]) {                          switch (cp[1]) {
                         case 'B':                          case 'B':
                                 return ESCAPE_FONTBOLD;                                  return ESCAPE_FONTCB;
                         case 'I':                          case 'I':
                                 return ESCAPE_FONTITALIC;                                  return ESCAPE_FONTCI;
                         case 'R':                          case 'R':
                         case 'W':                          case 'W':
                                 return ESCAPE_FONTCW;                                  return ESCAPE_FONTCR;
                         default:                          default:
                                 return ESCAPE_ERROR;                                  return ESCAPE_ERROR;
                         }                          }
Line 90  mandoc_font(const char *cp, int sz)
Line 97  mandoc_font(const char *cp, int sz)
         }          }
 }  }
   
 enum mandoc_esc  
 mandoc_escape(const char **end, const char **start, int *sz)  
 {  
         const char      *local_start;  
         int              local_sz, c, i;  
         char             term;  
         enum mandoc_esc  gly;  
   
         /*  
          * When the caller doesn't provide return storage,  
          * use local storage.  
          */  
   
         if (NULL == start)  
                 start = &local_start;  
         if (NULL == sz)  
                 sz = &local_sz;  
   
         /*  
          * Treat "\E" just like "\";  
          * it only makes a difference in copy mode.  
          */  
   
         if (**end == 'E')  
                 ++*end;  
   
         /*  
          * 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 '[':  
                 if (**start == ' ') {  
                         ++*end;  
                         return ESCAPE_ERROR;  
                 }  
                 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 '!':  
         case '?':  
                 return ESCAPE_UNSUPP;  
         case '%':  
         case '&':  
         case ')':  
         case ',':  
         case '/':  
         case '^':  
         case 'a':  
         case 'd':  
         case 'r':  
         case 't':  
         case 'u':  
         case '{':  
         case '|':  
         case '}':  
                 return ESCAPE_IGNORE;  
         case 'c':  
                 return ESCAPE_NOSPACE;  
         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 'f':  
         case 'g':  
         case 'k':  
         case 'M':  
         case 'm':  
         case 'n':  
         case 'O':  
         case 'V':  
         case 'Y':  
                 gly = (*start)[-1] == 'f' ? ESCAPE_FONT : ESCAPE_IGNORE;  
                 switch (**start) {  
                 case '(':  
                         if ((*start)[-1] == 'O')  
                                 gly = ESCAPE_ERROR;  
                         *start = ++*end;  
                         *sz = 2;  
                         break;  
                 case '[':  
                         if ((*start)[-1] == 'O')  
                                 gly = (*start)[1] == '5' ?  
                                     ESCAPE_UNSUPP : ESCAPE_ERROR;  
                         *start = ++*end;  
                         term = ']';  
                         break;  
                 default:  
                         if ((*start)[-1] == 'O') {  
                                 switch (**start) {  
                                 case '0':  
                                         gly = ESCAPE_UNSUPP;  
                                         break;  
                                 case '1':  
                                 case '2':  
                                 case '3':  
                                 case '4':  
                                         break;  
                                 default:  
                                         gly = ESCAPE_ERROR;  
                                         break;  
                                 }  
                         }  
                         *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 */  
         case 'o':  
                 if (**start == '\0')  
                         return ESCAPE_ERROR;  
                 if (gly == ESCAPE_ERROR)  
                         gly = ESCAPE_OVERSTRIKE;  
                 term = **start;  
                 *start = ++*end;  
                 break;  
   
         /*  
          * These escapes are of the form \X'N', where 'X' is the trigger  
          * and 'N' resolves to a numerical expression.  
          */  
         case 'h':  
         case 'H':  
         case 'L':  
         case 'l':  
         case 'S':  
         case 'v':  
         case 'x':  
                 if (strchr(" %&()*+-./0123456789:<=>", **start)) {  
                         if ('\0' != **start)  
                                 ++*end;  
                         return ESCAPE_ERROR;  
                 }  
                 switch ((*start)[-1]) {  
                 case 'h':  
                         gly = ESCAPE_HORIZ;  
                         break;  
                 case 'l':  
                         gly = ESCAPE_HLINE;  
                         break;  
                 default:  
                         gly = ESCAPE_IGNORE;  
                         break;  
                 }  
                 term = **start;  
                 *start = ++*end;  
                 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;  
   
         /*  
          * Several special characters can be encoded as  
          * one-byte escape sequences without using \[].  
          */  
         case ' ':  
         case '\'':  
         case '-':  
         case '.':  
         case '0':  
         case ':':  
         case '_':  
         case '`':  
         case 'e':  
         case '~':  
                 gly = ESCAPE_SPECIAL;  
                 /* FALLTHROUGH */  
         default:  
                 if (gly == ESCAPE_ERROR)  
                         gly = ESCAPE_UNDEF;  
                 *start = --*end;  
                 *sz = 1;  
                 break;  
         }  
   
         /*  
          * 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;  
   
                 /*  
                  * The file chars.c only provides one common list  
                  * of character names, but \[-] == \- is the only  
                  * one of the characters with one-byte names that  
                  * allows enclosing the name in brackets.  
                  */  
                 if (gly == ESCAPE_SPECIAL && *sz == 1 && **start != '-')  
                         return ESCAPE_ERROR;  
         } else {  
                 assert(*sz > 0);  
                 if ((size_t)*sz > strlen(*start))  
                         return ESCAPE_ERROR;  
                 *end += *sz;  
         }  
   
         /* Run post-processors. */  
   
         switch (gly) {  
         case ESCAPE_FONT:  
                 gly = mandoc_font(*start, *sz);  
                 break;  
         case ESCAPE_SPECIAL:  
                 if (**start == 'c') {  
                         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;  
         }  
   
         return gly;  
 }  
   
 static int  static int
 a2time(time_t *t, const char *fmt, const char *p)  a2time(time_t *t, const char *fmt, const char *p)
 {  {
Line 493  time2a(time_t t)
Line 125  time2a(time_t t)
         size_t           ssz;          size_t           ssz;
         int              isz;          int              isz;
   
           buf = NULL;
         tm = localtime(&t);          tm = localtime(&t);
         if (tm == NULL)          if (tm == NULL)
                 return NULL;                  goto fail;
   
         /*          /*
          * Reserve space:           * Reserve space:
Line 519  time2a(time_t t)
Line 152  time2a(time_t t)
          * of looking at LC_TIME.           * of looking at LC_TIME.
          */           */
   
         if ((isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)) == -1)          isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday);
           if (isz < 0 || isz > 4)
                 goto fail;                  goto fail;
         p += isz;          p += isz;
   
Line 529  time2a(time_t t)
Line 163  time2a(time_t t)
   
 fail:  fail:
         free(buf);          free(buf);
         return NULL;          return mandoc_strdup("");
 }  }
   
 char *  char *
 mandoc_normdate(struct roff_man *man, char *in, int ln, int pos)  mandoc_normdate(struct roff_node *nch, struct roff_node *nbl)
 {  {
         char            *cp;          char            *cp;
         time_t           t;          time_t           t;
   
         /* No date specified: use today's date. */          /* No date specified. */
   
         if (in == NULL || *in == '\0' || strcmp(in, "$" "Mdocdate$") == 0) {          if (nch == NULL) {
                 mandoc_msg(MANDOCERR_DATE_MISSING, ln, pos, NULL);                  if (nbl == NULL)
                 return time2a(time(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));
   
         /* Valid mdoc(7) date format. */          /* Valid mdoc(7) date format. */
   
         if (a2time(&t, "$" "Mdocdate: %b %d %Y $", in) ||          if (a2time(&t, "$" "Mdocdate: %b %d %Y $", nch->string) ||
             a2time(&t, "%b %d, %Y", in)) {              a2time(&t, "%b %d, %Y", nch->string)) {
                 cp = time2a(t);                  cp = time2a(t);
                 if (t > time(NULL) + 86400)                  if (t > time(NULL) + 86400)
                         mandoc_msg(MANDOCERR_DATE_FUTURE, ln, pos, "%s", cp);                          mandoc_msg(MANDOCERR_DATE_FUTURE, nch->line,
                 else if (*in != '$' && strcmp(in, cp) != 0)                              nch->pos, "%s %s", roff_name[nbl->tok], cp);
                         mandoc_msg(MANDOCERR_DATE_NORM, ln, pos, "%s", 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;                  return cp;
         }          }
   
         /* In man(7), do not warn about the legacy format. */          /* In man(7), do not warn about the legacy format. */
   
         if (a2time(&t, "%Y-%m-%d", in) == 0)          if (a2time(&t, "%Y-%m-%d", nch->string) == 0)
                 mandoc_msg(MANDOCERR_DATE_BAD, ln, pos, "%s", in);                  mandoc_msg(MANDOCERR_DATE_BAD, nch->line, nch->pos,
                       "%s %s", roff_name[nbl->tok], nch->string);
         else if (t > time(NULL) + 86400)          else if (t > time(NULL) + 86400)
                 mandoc_msg(MANDOCERR_DATE_FUTURE, ln, pos, "%s", in);                  mandoc_msg(MANDOCERR_DATE_FUTURE, nch->line, nch->pos,
         else if (man->macroset == MACROSET_MDOC)                      "%s %s", roff_name[nbl->tok], nch->string);
                 mandoc_msg(MANDOCERR_DATE_LEGACY, ln, pos, "Dd %s", in);          else if (nbl->tok == MDOC_Dd)
                   mandoc_msg(MANDOCERR_DATE_LEGACY, nch->line, nch->pos,
                       "Dd %s", nch->string);
   
         /* Use any non-mdoc(7) date verbatim. */          /* Use any non-mdoc(7) date verbatim. */
   
         return mandoc_strdup(in);          return mandoc_strdup(nch->string);
 }  }
   
 int  int
Legend:
Removed from v.1.113  
changed lines
  Added in v.1.121
CVSweb