Renamed SYS error to ERR, and changed format of message (TECO-32 compatibility).

Franklin Pierce Johnston · Franklin Pierce Johnston · commit 65c3419f4284 · 2021-09-04T13:22:40.000-04:00
diff --git a/etc/errors.pl b/etc/errors.pl
@@ -173,7 +173,15 @@ sub make_errcodes_h
     {
         my $message = $errors{$code}{message};
 
-        $message =~ s/%s/foo/gmsx;
+        if ($code eq 'ERR')
+        {
+            $message =~ s/%s/(error message)/gmsx;
+        }
+        else
+        {
+            $message =~ s/%s/foo/gmsx;
+        }
+
         $message =~ s/%c/x/gmsx;
 
         $errcodes .= sprintf "    E_%s,          ///< %s\n", $code, $message;
diff --git a/etc/errors.xml b/etc/errors.xml
@@ -82,6 +82,12 @@
             <detail>An O command found a duplicate tag within the</detail>
             <detail>command string.</detail>
         </error>
+        <error>
+            <code>ERR</code>
+            <message>%s</message>
+            <detail>A system call failed. The error message text</detail>
+            <detail>explains the error.</detail>
+        </error>
         <error>
             <code>EXT</code>
             <message>Extended feature not enabled</message>
@@ -431,12 +437,6 @@
             <detail>search it is usually necessary to close</detail>
             <detail>the output file and reopen it.</detail>
         </error>
-        <error>
-            <code>SYS</code>
-            <message>System error: &apos;%s&apos;</message>
-            <detail>A system call failed. The error message</detail>
-            <detail>text explains the error.</detail>
-        </error>
         <error>
             <code>TAG</code>
             <message>Missing tag: &apos;!%s!&apos;</message>
diff --git a/include/errcodes.h b/include/errcodes.h
@@ -51,6 +51,7 @@ enum errcodes
     E_DPY,          ///< Display mode error
     E_DTB,          ///< Delete too big
     E_DUP,          ///< Duplicate tag '!foo!'
+    E_ERR,          ///< (error message)
     E_EXT,          ///< Extended feature not enabled
     E_FIL,          ///< Invalid file 'foo'
     E_FNF,          ///< File not found 'foo'
@@ -103,7 +104,6 @@ enum errcodes
     E_POP,          ///< Attempt to move pointer off page with 'x'
     E_SNI,          ///< Semi-colon not in iteration
     E_SRH,          ///< Search failure: 'foo'
-    E_SYS,          ///< System error: 'foo'
     E_TAG,          ///< Missing tag: '!foo!'
     E_TXT,          ///< Invalid text delimiter 'x'
     E_UTC,          ///< Unterminated command string
diff --git a/include/errtables.h b/include/errtables.h
@@ -55,6 +55,7 @@ static struct errlist errlist[] =
     [E_DPY] = { "DPY",  "Display mode error" },
     [E_DTB] = { "DTB",  "Delete too big" },
     [E_DUP] = { "DUP",  "Duplicate tag '!%s!'" },
+    [E_ERR] = { "ERR",  "%s" },
     [E_EXT] = { "EXT",  "Extended feature not enabled" },
     [E_FIL] = { "FIL",  "Invalid file '%s'" },
     [E_FNF] = { "FNF",  "File not found '%s'" },
@@ -107,7 +108,6 @@ static struct errlist errlist[] =
     [E_POP] = { "POP",  "Attempt to move pointer off page with '%s'" },
     [E_SNI] = { "SNI",  "Semi-colon not in iteration" },
     [E_SRH] = { "SRH",  "Search failure: '%s'" },
-    [E_SYS] = { "SYS",  "System error: '%s'" },
     [E_TAG] = { "TAG",  "Missing tag: '!%s!'" },
     [E_TXT] = { "TXT",  "Invalid text delimiter '%s'" },
     [E_UTC] = { "UTC",  "Unterminated command string" },
@@ -152,6 +152,8 @@ static const char *errhelp[] =
               "the current page.",
     [E_DUP] = "An O command found a duplicate tag within the "
               "command string.",
+    [E_ERR] = "A system call failed. The error message text "
+              "explains the error.",
     [E_EXT] = "A command attempted to use an extended feature "
               "which is not currently enabled.",
     [E_FIL] = "An attempt was made to open a directory, FIFO, "
@@ -293,8 +295,6 @@ static const char *errhelp[] =
               "buffer is cleared. In the case of an N "
               "search it is usually necessary to close "
               "the output file and reopen it.",
-    [E_SYS] = "A system call failed. The error message "
-              "text explains the error.",
     [E_TAG] = "The tag specified by an O command cannot "
               "be found. This tag must be in the same macro "
               "level as the O command referencing it.",
diff --git a/src/e_pct_cmd.c b/src/e_pct_cmd.c
@@ -76,7 +76,7 @@ void exec_E_pct(struct cmd *cmd)
 
                 if (fwrite(qreg->text.data, 1uL, size, ofile->fp) != size)
                 {
-                    throw(E_SYS, ofile->name); // Unexpected system error
+                    throw(E_ERR, ofile->name); // General error
                 }
             }
 
diff --git a/src/ek_cmd.c b/src/ek_cmd.c
@@ -57,14 +57,14 @@ void exec_EK(struct cmd *unused)
     {
         if (remove(ofile->temp) != 0)
         {
-            throw(E_SYS, ofile->temp);
+            throw(E_ERR, ofile->temp);
         }
     }
     else if (ofile->name != NULL)
     {
         if (remove(ofile->name) != 0)
         {
-            throw(E_SYS, ofile->name);
+            throw(E_ERR, ofile->name);
         }
     }
 
diff --git a/src/errors.c b/src/errors.c
@@ -211,7 +211,7 @@ static void print_error(int error, const char *err_str, const char *file_str)
         tprint("   ");
         tprint(text, err_str ?: "");
 
-        if (error == E_SYS && file_str != NULL)
+        if (error == E_ERR && file_str != NULL)
         {
             tprint(" for '%s'", file_str);
         }
@@ -313,7 +313,7 @@ void print_verbose(int error)
 ///               character, it is output as [xx]; if it is a control character,
 ///               it is output as ^x.
 ///
-///            3. The E_SYS error code, which includes a string that contains
+///            3. The E_ERR error code, which includes a string that contains
 ///               the name of a file (or which is NULL) that is appended after
 ///               the error message.
 ///
@@ -357,7 +357,7 @@ noreturn void throw(int error, ...)
 
             break;
 
-        case E_SYS:
+        case E_ERR:
             err_str = strerror(errno);  // Convert errno to string
             file_str = va_arg(args, const char *);
 
diff --git a/src/ez_cmd.c b/src/ez_cmd.c
@@ -84,7 +84,7 @@ void exec_EZ(struct cmd *cmd)
             return;
         }
 
-        throw(E_SYS, syscmd);           // Unexpected system error
+        throw(E_ERR, syscmd);           // General error
     }
 
     ez.len = EZ_SIZE;
@@ -112,7 +112,7 @@ void exec_EZ(struct cmd *cmd)
             return;
         }
 
-        throw(E_SYS, syscmd);           // Unexpected system error
+        throw(E_ERR, syscmd);           // General error
     }
 
     ez.len = pos;                       // Length = total bytes read
diff --git a/src/file.c b/src/file.c
@@ -303,7 +303,7 @@ bool open_command(const char *name, uint stream, bool colon, tbuffer *text)
     {
         close_input(stream);
 
-        throw(E_SYS, last_file);        // Unexpected system error
+        throw(E_ERR, last_file);        // General error
     }
 
     size_t size = (size_t)file_stat.st_size;
@@ -318,7 +318,7 @@ bool open_command(const char *name, uint stream, bool colon, tbuffer *text)
         {
             close_input(stream);
 
-            throw(E_SYS, ifile->name);  // Unexpected system error
+            throw(E_ERR, ifile->name);  // General error
         }
 
         text->pos  = 0;
@@ -381,7 +381,7 @@ struct ifile *open_input(const char *name, uint stream, bool colon)
     {
         errno = EPERM;
 
-        throw(E_SYS, name);             // System error
+        throw(E_ERR, name);             // General error
     }
 
     struct ifile *ifile = &ifiles[stream];
@@ -390,7 +390,7 @@ struct ifile *open_input(const char *name, uint stream, bool colon)
 
     if ((ifile->fp = fopen(name, "r")) == NULL)
     {
-        throw(E_SYS, name);             // Unexpected system error
+        throw(E_ERR, name);             // General error
     }
 
     ifile->size = (uint_t)file_stat.st_size;
@@ -441,7 +441,7 @@ struct ofile *open_output(const char *name, uint stream, bool colon, int c)
     }
     else if (access(name, W_OK) != 0)   // File exists - is it writeable?
     {
-        throw(E_SYS, name);             // Unexpected system error
+        throw(E_ERR, name);             // General error
     }
     else
     {
@@ -467,7 +467,7 @@ struct ofile *open_output(const char *name, uint stream, bool colon, int c)
             return NULL;
         }
 
-        throw(E_SYS, name);             // Unexpected system error
+        throw(E_ERR, name);             // General error
     }
 
     // Here when we've either just opened a new file that didn't previously
diff --git a/src/file_sys.c b/src/file_sys.c
@@ -187,7 +187,7 @@ int get_wild(void)
             {
                 next_file = NULL;       // Make sure we can't repeat this
 
-                throw(E_SYS, filename);// Unexpected system error
+                throw(E_ERR, filename); // General error
             }
 
             if (S_ISREG(file_stat.st_mode))
@@ -234,7 +234,7 @@ FILE *open_temp(const char *oname, uint stream)
 
     if (stat(oname, &statbuf) != 0)
     {
-        throw(E_SYS, oname);            // Unexpected system error
+        throw(E_ERR, oname);            // General error
     }
 
     char dir[strlen(oname) + 1];
@@ -248,7 +248,7 @@ FILE *open_temp(const char *oname, uint stream)
 
     if (fd == -1)
     {
-        throw(E_SYS, tempfile);         // Unexpected system error
+        throw(E_ERR, tempfile);         // General error
     }
 
     (void)fchmod(fd, statbuf.st_mode);  // Use same permissions as old file
@@ -390,19 +390,19 @@ void rename_output(struct ofile *ofile)
 
         if (rename(ofile->name, saved_name) != 0)
         {
-            throw(E_SYS, ofile->name);  // Unexpected system error
+            throw(E_ERR, ofile->name);  // General error
         }
     }
     else if (remove(ofile->name) != 0)
     {
-        throw(E_SYS, ofile->name);      // Unexpected system error
+        throw(E_ERR, ofile->name);      // General error
     }
 
     // Rename temp. file name to actual name
 
     if (rename(ofile->temp, ofile->name) != 0)
     {
-        throw(E_SYS, ofile->name);      // Unexpected system error
+        throw(E_ERR, ofile->name);      // General error
     }
 }
 
@@ -442,7 +442,7 @@ bool set_wild(const char *filename)
             return false;               // No matches
 
         default:                        // Something unexpected
-            throw(E_SYS, filename);// Unexpected system error
+            throw(E_ERR, filename);// General error
     }
 }
 
diff --git a/src/term_in.c b/src/term_in.c
@@ -719,7 +719,7 @@ static int read_wait(void)
     {
         f.e0.ctrl_c = false;            // No, so reset system flag
 
-        throw(E_SYS, NULL);             // Unexpected system call
+        throw(E_ERR, NULL);             // General error
     }
     else if (f.et.ctrl_c)               // Trapping CTRL/C?
     {
diff --git a/src/term_sys.c b/src/term_sys.c
@@ -104,7 +104,7 @@ static void getsize(void)
     }
     else if (ioctl(fileno(stdin), (ulong)TIOCGWINSZ, &ts) == -1)
     {
-        throw(E_SYS, NULL);             // Unexpected system error
+        throw(E_ERR, NULL);             // General error
     }
     else
     {
diff --git a/test/EL/EL-01b.tec b/test/EL/EL-01b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Open log file
 !! Commands: EL
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/teco.log}     !! Load output file name
 
diff --git a/test/EL/EL-02b.tec b/test/EL/EL-02b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Open log file
 !! Commands: @EL//
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/teco.log}     !! Load output file name
 
diff --git a/test/EW/EW-01b.tec b/test/EW/EW-01b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Open file for writing
 !! Commands: EW
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/foo}  !! Name of output file
 
diff --git a/test/EW/EW-02b.tec b/test/EW/EW-02b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Open file for writing
 !! Commands: @EW//
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/foo}  !! Name of output file
 
diff --git a/test/E_pct/E_pct-01b.tec b/test/E_pct/E_pct-01b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Write Q-register to file
 !! Commands: E%
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/fubar}
 
diff --git a/test/E_pct/E_pct-02b.tec b/test/E_pct/E_pct-02b.tec
@@ -1,6 +1,6 @@
 !! TECO-64 test script: Write Q-register to file
 !! Commands: @E%//
-!! Expect: ?SYS
+!! Expect: ?ERR
 
 @^UA{/dev/fubar}
 
diff --git a/test/errors/ERR.log b/test/errors/ERR.log
@@ -0,0 +1 @@
+?ERR   Permission denied for '/dev/foo' in macro at line 7
diff --git a/test/errors/ERR.tec b/test/errors/ERR.tec
@@ -0,0 +1,7 @@
+!! TECO-64 test script: Test ERR error
+!! Commands: ?ERR
+!! Expect: ?ERR [ERR.log]
+
+@^UA{/dev/foo}  !! Name of output file
+
+@EW/^EQA/       !! Open file for writing
diff --git a/test/errors/SYS.log b/test/errors/SYS.log
diff --git a/test/errors/SYS.tec b/test/errors/SYS.tec

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ void exec_E_pct(struct cmd *cmd)`
`76`	`76`
`77`	`77`	`if (fwrite(qreg->text.data, 1uL, size, ofile->fp) != size)`
`78`	`78`	`{`
`79`		`- throw(E_SYS, ofile->name); // Unexpected system error`
	`79`	`+ throw(E_ERR, ofile->name); // General error`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
Original file line number	Diff line number	Diff line change
`@@ -57,14 +57,14 @@ void exec_EK(struct cmd *unused)`
`57`	`57`	`{`
`58`	`58`	`if (remove(ofile->temp) != 0)`
`59`	`59`	`{`
`60`		`- throw(E_SYS, ofile->temp);`
	`60`	`+ throw(E_ERR, ofile->temp);`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	`else if (ofile->name != NULL)`
`64`	`64`	`{`
`65`	`65`	`if (remove(ofile->name) != 0)`
`66`	`66`	`{`
`67`		`- throw(E_SYS, ofile->name);`
	`67`	`+ throw(E_ERR, ofile->name);`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ void exec_EZ(struct cmd *cmd)`
`84`	`84`	`return;`
`85`	`85`	`}`
`86`	`86`
`87`		`- throw(E_SYS, syscmd); // Unexpected system error`
	`87`	`+ throw(E_ERR, syscmd); // General error`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`ez.len = EZ_SIZE;`
`@@ -112,7 +112,7 @@ void exec_EZ(struct cmd *cmd)`
`112`	`112`	`return;`
`113`	`113`	`}`
`114`	`114`
`115`		`- throw(E_SYS, syscmd); // Unexpected system error`
	`115`	`+ throw(E_ERR, syscmd); // General error`
`116`	`116`	`}`
`117`	`117`
`118`	`118`	`ez.len = pos; // Length = total bytes read`
Original file line number	Diff line number	Diff line change
`@@ -303,7 +303,7 @@ bool open_command(const char name, uint stream, bool colon, tbuffer text)`
`303`	`303`	`{`
`304`	`304`	`close_input(stream);`
`305`	`305`
`306`		`- throw(E_SYS, last_file); // Unexpected system error`
	`306`	`+ throw(E_ERR, last_file); // General error`
`307`	`307`	`}`
`308`	`308`
`309`	`309`	`size_t size = (size_t)file_stat.st_size;`
`@@ -318,7 +318,7 @@ bool open_command(const char name, uint stream, bool colon, tbuffer text)`
`318`	`318`	`{`
`319`	`319`	`close_input(stream);`
`320`	`320`
`321`		`- throw(E_SYS, ifile->name); // Unexpected system error`
	`321`	`+ throw(E_ERR, ifile->name); // General error`
`322`	`322`	`}`
`323`	`323`
`324`	`324`	`text->pos = 0;`
`@@ -381,7 +381,7 @@ struct ifile open_input(const char name, uint stream, bool colon)`
`381`	`381`	`{`
`382`	`382`	`errno = EPERM;`
`383`	`383`
`384`		`- throw(E_SYS, name); // System error`
	`384`	`+ throw(E_ERR, name); // General error`
`385`	`385`	`}`
`386`	`386`
`387`	`387`	`struct ifile *ifile = &ifiles[stream];`
`@@ -390,7 +390,7 @@ struct ifile open_input(const char name, uint stream, bool colon)`
`390`	`390`
`391`	`391`	`if ((ifile->fp = fopen(name, "r")) == NULL)`
`392`	`392`	`{`
`393`		`- throw(E_SYS, name); // Unexpected system error`
	`393`	`+ throw(E_ERR, name); // General error`
`394`	`394`	`}`
`395`	`395`
`396`	`396`	`ifile->size = (uint_t)file_stat.st_size;`
`@@ -441,7 +441,7 @@ struct ofile open_output(const char name, uint stream, bool colon, int c)`
`441`	`441`	`}`
`442`	`442`	`else if (access(name, W_OK) != 0) // File exists - is it writeable?`
`443`	`443`	`{`
`444`		`- throw(E_SYS, name); // Unexpected system error`
	`444`	`+ throw(E_ERR, name); // General error`
`445`	`445`	`}`
`446`	`446`	`else`
`447`	`447`	`{`
`@@ -467,7 +467,7 @@ struct ofile open_output(const char name, uint stream, bool colon, int c)`
`467`	`467`	`return NULL;`
`468`	`468`	`}`
`469`	`469`
`470`		`- throw(E_SYS, name); // Unexpected system error`
	`470`	`+ throw(E_ERR, name); // General error`
`471`	`471`	`}`
`472`	`472`
`473`	`473`	`// Here when we've either just opened a new file that didn't previously`
Original file line number	Diff line number	Diff line change
`@@ -187,7 +187,7 @@ int get_wild(void)`
`187`	`187`	`{`
`188`	`188`	`next_file = NULL; // Make sure we can't repeat this`
`189`	`189`
`190`		`- throw(E_SYS, filename);// Unexpected system error`
	`190`	`+ throw(E_ERR, filename); // General error`
`191`	`191`	`}`
`192`	`192`
`193`	`193`	`if (S_ISREG(file_stat.st_mode))`
`@@ -234,7 +234,7 @@ FILE open_temp(const char oname, uint stream)`
`234`	`234`
`235`	`235`	`if (stat(oname, &statbuf) != 0)`
`236`	`236`	`{`
`237`		`- throw(E_SYS, oname); // Unexpected system error`
	`237`	`+ throw(E_ERR, oname); // General error`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`char dir[strlen(oname) + 1];`
`@@ -248,7 +248,7 @@ FILE open_temp(const char oname, uint stream)`
`248`	`248`
`249`	`249`	`if (fd == -1)`
`250`	`250`	`{`
`251`		`- throw(E_SYS, tempfile); // Unexpected system error`
	`251`	`+ throw(E_ERR, tempfile); // General error`
`252`	`252`	`}`
`253`	`253`
`254`	`254`	`(void)fchmod(fd, statbuf.st_mode); // Use same permissions as old file`
`@@ -390,19 +390,19 @@ void rename_output(struct ofile *ofile)`
`390`	`390`
`391`	`391`	`if (rename(ofile->name, saved_name) != 0)`
`392`	`392`	`{`
`393`		`- throw(E_SYS, ofile->name); // Unexpected system error`
	`393`	`+ throw(E_ERR, ofile->name); // General error`
`394`	`394`	`}`
`395`	`395`	`}`
`396`	`396`	`else if (remove(ofile->name) != 0)`
`397`	`397`	`{`
`398`		`- throw(E_SYS, ofile->name); // Unexpected system error`
	`398`	`+ throw(E_ERR, ofile->name); // General error`
`399`	`399`	`}`
`400`	`400`
`401`	`401`	`// Rename temp. file name to actual name`
`402`	`402`
`403`	`403`	`if (rename(ofile->temp, ofile->name) != 0)`
`404`	`404`	`{`
`405`		`- throw(E_SYS, ofile->name); // Unexpected system error`
	`405`	`+ throw(E_ERR, ofile->name); // General error`
`406`	`406`	`}`
`407`	`407`	`}`
`408`	`408`
`@@ -442,7 +442,7 @@ bool set_wild(const char *filename)`
`442`	`442`	`return false; // No matches`
`443`	`443`
`444`	`444`	`default: // Something unexpected`
`445`		`- throw(E_SYS, filename);// Unexpected system error`
	`445`	`+ throw(E_ERR, filename);// General error`
`446`	`446`	`}`
`447`	`447`	`}`
`448`	`448`