]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/tinfo/comp_scan.c
ncurses 6.4 - patch 20240414
[ncurses.git] / ncurses / tinfo / comp_scan.c
index e747effcae6df501bf46ea7517642fb847abb819..3ba0835e2fb807aed6d27d6e9a2625c909d76f55 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
+,* Copyright 2020-2022,2023 Thomas E. Dickey                                *
+ * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 #include <curses.priv.h>
 
 #include <ctype.h>
-#include <term_entry.h>
 #include <tic.h>
 
-MODULE_ID("$Id: comp_scan.c,v 1.84 2009/05/09 16:37:42 tom Exp $")
+MODULE_ID("$Id: comp_scan.c,v 1.122 2023/05/27 20:13:10 tom Exp $")
 
 /*
  * Maximum length of string capability we'll accept before raising an error.
@@ -62,6 +62,7 @@ MODULE_ID("$Id: comp_scan.c,v 1.84 2009/05/09 16:37:42 tom Exp $")
 #define iswhite(ch)    (ch == ' '  ||  ch == '\t')
 
 NCURSES_EXPORT_VAR (int) _nc_syntax = 0;         /* termcap or terminfo? */
+NCURSES_EXPORT_VAR (int) _nc_strict_bsd = 1;  /* ncurses extended termcap? */
 NCURSES_EXPORT_VAR (long) _nc_curr_file_pos = 0; /* file offset of current line */
 NCURSES_EXPORT_VAR (long) _nc_comment_start = 0; /* start of comment range before name */
 NCURSES_EXPORT_VAR (long) _nc_comment_end = 0;   /* end of comment range before name */
@@ -111,6 +112,9 @@ static FILE *yyin;          /* scanner's input file descriptor */
 NCURSES_EXPORT(void)
 _nc_reset_input(FILE *fp, char *buf)
 {
+    TR(TRACE_DATABASE,
+       (T_CALLED("_nc_reset_input(fp=%p, buf=%p)"), (void *) fp, buf));
+
     pushtype = NO_PUSHBACK;
     if (pushname != 0)
        pushname[0] = '\0';
@@ -120,6 +124,8 @@ _nc_reset_input(FILE *fp, char *buf)
     if (fp != 0)
        _nc_curr_line = 0;
     _nc_curr_col = 0;
+
+    returnVoidDB;
 }
 
 /*
@@ -128,14 +134,45 @@ _nc_reset_input(FILE *fp, char *buf)
  *     Returns the final nonblank character on the current input buffer
  */
 static int
-last_char(void)
+last_char(int from_end)
 {
     size_t len = strlen(bufptr);
+    int result = 0;
+
     while (len--) {
-       if (!isspace(UChar(bufptr[len])))
-           return bufptr[len];
+       if (!isspace(UChar(bufptr[len]))) {
+           if (from_end <= (int) len)
+               result = bufptr[(int) len - from_end];
+           break;
+       }
+    }
+    return result;
+}
+
+/*
+ * Read, like fgets(), but error-out if the input contains nulls.
+ */
+static int
+get_text(char *buffer, int length)
+{
+    int count = 0;
+    int limit = length - 1;
+
+    while (limit-- > 0) {
+       int ch = fgetc(yyin);
+
+       if (ch == '\0') {
+           _nc_err_abort("This is not a text-file");
+       } else if (ch == EOF) {
+           break;
+       }
+       ++count;
+       *buffer++ = (char) ch;
+       if (ch == '\n')
+           break;
     }
-    return 0;
+    *buffer = '\0';
+    return count;
 }
 
 /*
@@ -163,6 +200,8 @@ next_char(void)
        if (result != 0) {
            FreeAndNull(result);
            FreeAndNull(pushname);
+           bufptr = 0;
+           bufstart = 0;
            allocated = 0;
        }
        /*
@@ -184,35 +223,41 @@ next_char(void)
         * quite hard to get completely right.  Try it and see.  If you
         * succeed, don't forget to hack push_back() correspondingly.
         */
-       size_t used;
        size_t len;
 
        do {
+           size_t used = 0;
            bufstart = 0;
-           used = 0;
            do {
                if (used + (LEXBUFSIZ / 4) >= allocated) {
                    allocated += (allocated + LEXBUFSIZ);
                    result = typeRealloc(char, allocated, result);
                    if (result == 0)
                        return (EOF);
-                   bufstart = result;
+                   if (bufstart)
+                       bufstart = result;
                }
                if (used == 0)
                    _nc_curr_file_pos = ftell(yyin);
 
-               if (fgets(result + used, (int) (allocated - used), yyin) != 0) {
+               if (get_text(result + used, (int) (allocated - used))) {
                    bufstart = result;
                    if (used == 0) {
+                       if (_nc_curr_line == 0
+                           && IS_TIC_MAGIC(result)) {
+                           _nc_err_abort("This is a compiled terminal description, not a source");
+                       }
                        _nc_curr_line++;
                        _nc_curr_col = 0;
                    }
                } else {
                    if (used != 0)
-                       strcat(result, "\n");
+                       _nc_STRCAT(result, "\n", allocated);
                }
                if ((bufptr = bufstart) != 0) {
                    used = strlen(bufptr);
+                   if (used == 0)
+                       return (EOF);
                    while (iswhite(*bufptr)) {
                        if (*bufptr == '\t') {
                            _nc_curr_col = (_nc_curr_col | 7) + 1;
@@ -253,12 +298,12 @@ next_char(void)
 }
 
 static void
-push_back(char c)
+push_back(int c)
 /* push a character back onto the input stream */
 {
     if (bufptr == bufstart)
-       _nc_syserr_abort("Can't backspace off beginning of line");
-    *--bufptr = c;
+       _nc_syserr_abort("cannot backspace off beginning of line");
+    *--bufptr = (char) c;
     _nc_curr_col--;
 }
 
@@ -266,14 +311,16 @@ static long
 stream_pos(void)
 /* return our current character position in the input stream */
 {
-    return (yyin ? ftell(yyin) : (bufptr ? bufptr - bufstart : 0));
+    return (yyin ? ftell(yyin) : (bufptr ? (long) (bufptr - bufstart) : 0));
 }
 
 static bool
 end_of_stream(void)
 /* are we at end of input? */
 {
-    return ((yyin ? feof(yyin) : (bufptr && *bufptr == '\0'))
+    return ((yyin
+            ? (feof(yyin) && (bufptr == NULL || *bufptr == '\0'))
+            : (bufptr && *bufptr == '\0'))
            ? TRUE : FALSE);
 }
 
@@ -281,9 +328,11 @@ end_of_stream(void)
 static NCURSES_INLINE int
 eat_escaped_newline(int ch)
 {
-    if (ch == '\\')
-       while ((ch = next_char()) == '\n' || iswhite(ch))
-           continue;
+    if (ch == '\\') {
+       while ((ch = next_char()) == '\n' || iswhite(ch)) {
+           /* EMPTY */ ;
+       }
+    }
     return ch;
 }
 
@@ -296,6 +345,8 @@ eat_escaped_newline(int ch)
        *tok_ptr++ = (char) ch; \
        *tok_ptr = '\0'
 
+static char *tok_buf;
+
 /*
  *     int
  *     get_token()
@@ -333,15 +384,14 @@ NCURSES_EXPORT(int)
 _nc_get_token(bool silent)
 {
     static const char terminfo_punct[] = "@%&*!#";
-    static char *tok_buf;
 
-    char *after_list;
-    char *after_name;
+    char *after_name;          /* after primary name */
+    char *after_list;          /* after primary and alias list */
     char *numchk;
     char *tok_ptr;
     char *s;
     char numbuf[80];
-    int ch;
+    int ch, c0, c1;
     int dot_flag = FALSE;
     int type;
     long number;
@@ -352,6 +402,8 @@ _nc_get_token(bool silent)
     int old_col;
 #endif
 
+    DEBUG(3, (T_CALLED("_nc_get_token(silent=%d)"), silent));
+
     if (pushtype != NO_PUSHBACK) {
        int retval = pushtype;
 
@@ -364,17 +416,18 @@ _nc_get_token(bool silent)
            pushname[0] = '\0';
 
        /* currtok wasn't altered by _nc_push_token() */
+       DEBUG(3, (T_RETURN("%d"), retval));
        return (retval);
     }
 
     if (end_of_stream()) {
        yyin = 0;
-       next_char();            /* frees its allocated memory */
+       (void) next_char();     /* frees its allocated memory */
        if (tok_buf != 0) {
            if (_nc_curr_token.tk_name == tok_buf)
                _nc_curr_token.tk_name = 0;
-           FreeAndNull(tok_buf);
        }
+       DEBUG(3, (T_RETURN("%d"), EOF));
        return (EOF);
     }
 
@@ -383,10 +436,10 @@ _nc_get_token(bool silent)
     while ((ch = next_char()) == '\n' || iswhite(ch)) {
        if (ch == '\n')
            had_newline = TRUE;
-       continue;
     }
 
     ch = eat_escaped_newline(ch);
+    _nc_curr_token.tk_valstring = 0;
 
 #ifdef TRACE
     old_line = _nc_curr_line;
@@ -407,8 +460,9 @@ _nc_get_token(bool silent)
            dot_flag = TRUE;
            DEBUG(8, ("dot-flag set"));
 
-           while ((ch = next_char()) == '.' || iswhite(ch))
-               continue;
+           while ((ch = next_char()) == '.' || iswhite(ch)) {
+               /* EMPTY */ ;
+           }
        }
 
        if (ch == EOF) {
@@ -421,10 +475,10 @@ _nc_get_token(bool silent)
 #if NCURSES_EXT_FUNCS
            && !(ch == '.' && _nc_disable_period)
 #endif
-           && !strchr(terminfo_punct, (char) ch)) {
+           && ((strchr) (terminfo_punct, (char) ch) == 0)) {
            if (!silent)
                _nc_warning("Illegal character (expected alphanumeric or %s) - '%s'",
-                           terminfo_punct, unctrl((chtype) ch));
+                           terminfo_punct, unctrl(UChar(ch)));
            _nc_panic_mode(separator);
            goto start_token;
        }
@@ -454,7 +508,7 @@ _nc_get_token(bool silent)
                    after_list = tok_ptr;
                    if (after_name == 0)
                        after_name = tok_ptr;
-               } else if (ch == ':' && last_char() != ',') {
+               } else if (ch == ':' && last_char(0) != ',') {
                    _nc_syntax = SYN_TERMCAP;
                    separator = ':';
                    break;
@@ -468,19 +522,70 @@ _nc_get_token(bool silent)
                    if (after_name == 0)
                        break;
                    /*
-                    * If we see a comma, we assume this is terminfo unless we
-                    * subsequently run into a colon.  But we don't stop
-                    * looking for a colon until hitting a newline.  This
-                    * allows commas to be embedded in description fields of
-                    * either syntax.
+                    * We saw a comma, but are not entirely sure this is
+                    * terminfo format, since we can still be parsing the
+                    * description field (for either syntax).
+                    *
+                    * A properly formatted termcap line ends with either a
+                    * colon, or a backslash after a colon.  It is possible
+                    * to have a backslash in the middle of a capability, but
+                    * then there would be no leading whitespace on the next
+                    * line - something we want to discourage.
                     */
+                   c0 = last_char(0);
+                   c1 = last_char(1);
+                   if (c1 != ':' && c0 != '\\' && c0 != ':') {
+                       bool capability = FALSE;
+
+                       /*
+                        * Since it is not termcap, assume the line is terminfo
+                        * format.  However, the comma can be embedded in a
+                        * description field.  It also can be a separator
+                        * between a description field and a capability.
+                        *
+                        * Improve the guess by checking if the next word after
+                        * the comma does not look like a capability.  In that
+                        * case, extend the description past the comma.
+                        */
+                       for (s = bufptr; isspace(UChar(*s)); ++s) {
+                           ;
+                       }
+                       if (islower(UChar(*s))) {
+                           char *name = s;
+                           while (isalnum(UChar(*s))) {
+                               ++s;
+                           }
+                           if (*s == '#' || *s == '=' || *s == '@') {
+                               /*
+                                * Checking solely with syntax allows us to
+                                * support extended capabilities with string
+                                * values.
+                                */
+                               capability = TRUE;
+                           } else if (*s == ',') {
+                               c0 = *s;
+                               *s = '\0';
+                               /*
+                                * Otherwise, we can handle predefined boolean
+                                * capabilities, still aided by syntax.
+                                */
+                               if (_nc_find_entry(name,
+                                                  _nc_get_hash_table(FALSE))) {
+                                   capability = TRUE;
+                               }
+                               *s = (char) c0;
+                           }
+                       }
+                       if (capability) {
+                           break;
+                       }
+                   }
                } else
                    ch = eat_escaped_newline(ch);
 
                if (OkToAdd()) {
                    AddCh(ch);
                } else {
-                   ch = EOF;
                    break;
                }
            }
@@ -490,7 +595,7 @@ _nc_get_token(bool silent)
                 * Grrr...what we ought to do here is barf, complaining that
                 * the entry is malformed.  But because a couple of name fields
                 * in the 8.2 termcap file end with |\, we just have to assume
-                * it's termcap syntax.
+                * it is termcap syntax.
                 */
                _nc_syntax = SYN_TERMCAP;
                separator = ':';
@@ -498,8 +603,9 @@ _nc_get_token(bool silent)
                /* throw away trailing /, *$/ */
                for (--tok_ptr;
                     iswhite(*tok_ptr) || *tok_ptr == ',';
-                    tok_ptr--)
-                   continue;
+                    tok_ptr--) {
+                   /* EMPTY */ ;
+               }
                tok_ptr[1] = '\0';
            }
 
@@ -521,14 +627,15 @@ _nc_get_token(bool silent)
             */
            if (after_list != 0) {
                if (!silent) {
-                   if (*after_list == '\0')
+                   if (*after_list == '\0' || strchr("|", after_list[1]) != NULL) {
                        _nc_warning("empty longname field");
-                   else if (strchr(after_list, ' ') == 0)
+                   } else if (strchr(after_list, ' ') == 0) {
                        _nc_warning("older tic versions may treat the description field as an alias");
+                   }
                }
            } else {
                after_list = tok_buf + strlen(tok_buf);
-               DEBUG(1, ("missing description"));
+               DEBUG(2, ("missing description"));
            }
 
            /*
@@ -589,7 +696,7 @@ _nc_get_token(bool silent)
            case '@':
                if ((ch = next_char()) != separator && !silent)
                    _nc_warning("Missing separator after `%s', have %s",
-                               tok_buf, unctrl((chtype) ch));
+                               tok_buf, unctrl(UChar(ch)));
                _nc_curr_token.tk_name = tok_buf;
                type = CANCEL;
                break;
@@ -607,10 +714,18 @@ _nc_get_token(bool silent)
                    if (numchk == numbuf)
                        _nc_warning("no value given for `%s'", tok_buf);
                    if ((*numchk != '\0') || (ch != separator))
-                       _nc_warning("Missing separator");
+                       _nc_warning("Missing separator for `%s'", tok_buf);
+                   if (number < 0)
+                       _nc_warning("value of `%s' cannot be negative", tok_buf);
+                   if (number > MAX_OF_TYPE(NCURSES_INT2)) {
+                       _nc_warning("limiting value of `%s' from %#lx to %#x",
+                                   tok_buf,
+                                   number, MAX_OF_TYPE(NCURSES_INT2));
+                       number = MAX_OF_TYPE(NCURSES_INT2);
+                   }
                }
                _nc_curr_token.tk_name = tok_buf;
-               _nc_curr_token.tk_valnumber = number;
+               _nc_curr_token.tk_valnumber = (int) number;
                type = NUMBER;
                break;
 
@@ -630,8 +745,7 @@ _nc_get_token(bool silent)
                /* just to get rid of the compiler warning */
                type = UNDEF;
                if (!silent)
-                   _nc_warning("Illegal character - '%s'",
-                               unctrl((chtype) ch));
+                   _nc_warning("Illegal character - '%s'", unctrl(UChar(ch)));
            }
        }                       /* end else (first_column == FALSE) */
     }                          /* end else (ch != EOF) */
@@ -696,6 +810,7 @@ _nc_get_token(bool silent)
               : "<null>"),
              type));
 
+    DEBUG(3, (T_RETURN("%d"), type));
     return (type);
 }
 
@@ -719,62 +834,63 @@ _nc_get_token(bool silent)
  */
 
 NCURSES_EXPORT(int)
-_nc_trans_string(char *ptr, char *last)
+_nc_trans_string(char *ptr, const char *const last)
 {
     int count = 0;
     int number = 0;
     int i, c;
-    chtype ch, last_ch = '\0';
+    int last_ch = '\0';
     bool ignored = FALSE;
     bool long_warning = FALSE;
 
-    while ((ch = c = next_char()) != (chtype) separator && c != EOF) {
+    while ((c = next_char()) != separator && c != EOF) {
        if (ptr >= (last - 1)) {
            if (c != EOF) {
                while ((c = next_char()) != separator && c != EOF) {
                    ;
                }
-               ch = c;
            }
            break;
        }
        if ((_nc_syntax == SYN_TERMCAP) && c == '\n')
            break;
-       if (ch == '^' && last_ch != '%') {
-           ch = c = next_char();
+       if (c == '^' && last_ch != '%') {
+           c = next_char();
            if (c == EOF)
                _nc_err_abort(MSG_NO_INPUTS);
 
-           if (!(is7bits(ch) && isprint(ch))) {
-               _nc_warning("Illegal ^ character - '%s'", unctrl(ch));
+           if (!(is7bits(c) && isprint(c))) {
+               _nc_warning("Illegal ^ character - '%s'", unctrl(UChar(c)));
            }
-           if (ch == '?') {
+           if (c == '?' && (_nc_syntax != SYN_TERMCAP)) {
                *(ptr++) = '\177';
-               if (_nc_tracing)
-                   _nc_warning("Allow ^? as synonym for \\177");
            } else {
-               if ((ch &= 037) == 0)
-                   ch = 128;
-               *(ptr++) = (char) (ch);
+               if ((c &= 037) == 0)
+                   c = 128;
+               *(ptr++) = (char) (c);
            }
-       } else if (ch == '\\') {
-           ch = c = next_char();
+       } else if (c == '\\') {
+           bool strict_bsd = ((_nc_syntax == SYN_TERMCAP) && _nc_strict_bsd);
+
+           c = next_char();
            if (c == EOF)
                _nc_err_abort(MSG_NO_INPUTS);
 
-           if (ch >= '0' && ch <= '7') {
-               number = ch - '0';
+           if (isoctal(c) || (strict_bsd && isdigit(c))) {
+               number = c - '0';
                for (i = 0; i < 2; i++) {
-                   ch = c = next_char();
+                   c = next_char();
                    if (c == EOF)
                        _nc_err_abort(MSG_NO_INPUTS);
 
-                   if (c < '0' || c > '7') {
+                   if (!isoctal(c)) {
                        if (isdigit(c)) {
-                           _nc_warning("Non-octal digit `%c' in \\ sequence", c);
-                           /* allow the digit; it'll do less harm */
+                           if (!strict_bsd) {
+                               _nc_warning("Non-octal digit `%c' in \\ sequence", c);
+                               /* allow the digit; it'll do less harm */
+                           }
                        } else {
-                           push_back((char) c);
+                           push_back(c);
                            break;
                        }
                    }
@@ -782,21 +898,16 @@ _nc_trans_string(char *ptr, char *last)
                    number = number * 8 + c - '0';
                }
 
-               if (number == 0)
+               number = UChar(number);
+               if (number == 0 && !strict_bsd)
                    number = 0200;
                *(ptr++) = (char) number;
            } else {
                switch (c) {
                case 'E':
-               case 'e':
                    *(ptr++) = '\033';
                    break;
 
-               case 'a':
-                   *(ptr++) = '\007';
-                   break;
-
-               case 'l':
                case 'n':
                    *(ptr++) = '\n';
                    break;
@@ -809,10 +920,6 @@ _nc_trans_string(char *ptr, char *last)
                    *(ptr++) = '\010';
                    break;
 
-               case 's':
-                   *(ptr++) = ' ';
-                   break;
-
                case 'f':
                    *(ptr++) = '\014';
                    break;
@@ -833,40 +940,57 @@ _nc_trans_string(char *ptr, char *last)
                    *(ptr++) = ',';
                    break;
 
-               case ':':
-                   *(ptr++) = ':';
-                   break;
-
                case '\n':
                    continue;
 
                default:
-                   _nc_warning("Illegal character '%s' in \\ sequence",
-                               unctrl(ch));
+                   if ((_nc_syntax == SYN_TERMINFO) || !_nc_strict_bsd) {
+                       switch (c) {
+                       case 'a':
+                           c = '\007';
+                           break;
+                       case 'e':
+                           c = '\033';
+                           break;
+                       case 'l':
+                           c = '\n';
+                           break;
+                       case 's':
+                           c = ' ';
+                           break;
+                       case ':':
+                           c = ':';
+                           break;
+                       default:
+                           _nc_warning("Illegal character '%s' in \\ sequence",
+                                       unctrl(UChar(c)));
+                           break;
+                       }
+                   }
                    /* FALLTHRU */
                case '|':
-                   *(ptr++) = (char) ch;
-               }               /* endswitch (ch) */
-           }                   /* endelse (ch < '0' ||  ch > '7') */
+                   *(ptr++) = (char) c;
+               }               /* endswitch (c) */
+           }                   /* endelse (c < '0' ||  c > '7') */
        }
-       /* end else if (ch == '\\') */
-       else if (ch == '\n' && (_nc_syntax == SYN_TERMINFO)) {
+       /* end else if (c == '\\') */
+       else if (c == '\n' && (_nc_syntax == SYN_TERMINFO)) {
            /*
             * Newlines embedded in a terminfo string are ignored, provided
             * that the next line begins with whitespace.
             */
            ignored = TRUE;
        } else {
-           *(ptr++) = (char) ch;
+           *(ptr++) = (char) c;
        }
 
        if (!ignored) {
            if (_nc_curr_col <= 1) {
-               push_back((char) ch);
-               ch = '\n';
+               push_back(c);
+               c = '\n';
                break;
            }
-           last_ch = ch;
+           last_ch = c;
            count++;
        }
        ignored = FALSE;
@@ -879,7 +1003,7 @@ _nc_trans_string(char *ptr, char *last)
 
     *ptr = '\0';
 
-    return (ch);
+    return (c);
 }
 
 /*
@@ -916,10 +1040,8 @@ _nc_push_token(int tokclass)
 NCURSES_EXPORT(void)
 _nc_panic_mode(char ch)
 {
-    int c;
-
     for (;;) {
-       c = next_char();
+       int c = next_char();
        if (c == ch)
            return;
        if (c == EOF)
@@ -934,5 +1056,8 @@ _nc_comp_scan_leaks(void)
     if (pushname != 0) {
        FreeAndNull(pushname);
     }
+    if (tok_buf != 0) {
+       FreeAndNull(tok_buf);
+    }
 }
 #endif