]> git.ipfire.org Git - thirdparty/bash.git/blobdiff - error.c
Bash-5.2 patch 26: fix typo when specifying readline's custom color prefix
[thirdparty/bash.git] / error.c
diff --git a/error.c b/error.c
index 5ffd4abc3e9459148124000cfaea9949d6cd5dc3..3e7a2d6170df22c56d115a76637714c3e42bb959 100644 (file)
--- a/error.c
+++ b/error.c
 /* error.c -- Functions for handling errors. */
-/* Copyright (C) 1993 Free Software Foundation, Inc.
+
+/* Copyright (C) 1993-2021 Free Software Foundation, Inc.
 
    This file is part of GNU Bash, the Bourne Again SHell.
 
-   Bash is free software; you can redistribute it and/or modify it under
-   the terms of the GNU General Public License as published by the Free
-   Software Foundation; either version 2, or (at your option) any later
-   version.
+   Bash is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   Bash is distributed in the hope that it will be useful, but WITHOUT ANY
-   WARRANTY; without even the implied warranty of MERCHANTABILITY or
-   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-   for more details.
+   Bash is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-   You should have received a copy of the GNU General Public License along
-   with Bash; see the file COPYING.  If not, write to the Free Software
-   Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+   You should have received a copy of the GNU General Public License
+   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-#include <stdio.h>
-#include <sys/types.h>
+#include "config.h"
+
+#include "bashtypes.h"
 #include <fcntl.h>
 
-#if defined (HAVE_VFPRINTF)
-#include <varargs.h>
+#if defined (HAVE_UNISTD_H)
+#  include <unistd.h>
+#endif
+
+#if defined (PREFER_STDARG)
+#  include <stdarg.h>
+#else
+#  include <varargs.h>
 #endif
 
+#include <stdio.h>
+
 #include <errno.h>
 #if !defined (errno)
 extern int errno;
 #endif /* !errno */
 
 #include "bashansi.h"
+#include "bashintl.h"
+
+#include "shell.h"
+#include "execute_cmd.h"
 #include "flags.h"
-#include "error.h"
-#include "command.h"
-#include "general.h"
-
-extern int interactive_shell;
-extern char *dollar_vars[];
-extern char *shell_name;
-extern char *the_current_maintainer;
+#include "input.h"
+
+#if defined (HISTORY)
+#  include "bashhist.h"
+#endif
+
+extern int executing_line_number PARAMS((void));
+
 #if defined (JOB_CONTROL)
 extern pid_t shell_pgrp;
+extern int give_terminal_to PARAMS((pid_t, int));
 #endif /* JOB_CONTROL */
 
+#if defined (ARRAY_VARS)
+extern const char * const bash_badsub_errmsg;
+#endif
+
+static void error_prolog PARAMS((int));
+
+/* The current maintainer of the shell.  You change this in the
+   Makefile. */
+#if !defined (MAINTAINER)
+#define MAINTAINER "bash-maintainers@gnu.org"
+#endif
+
+const char * const the_current_maintainer = MAINTAINER;
+
+int gnu_error_format = 0;
+
+static void
+error_prolog (print_lineno)
+     int print_lineno;
+{
+  char *ename;
+  int line;
+
+  ename = get_name_for_error ();
+  line = (print_lineno && interactive_shell == 0) ? executing_line_number () : -1;
+
+  if (line > 0)
+    fprintf (stderr, "%s:%s%d: ", ename, gnu_error_format ? "" : _(" line "), line);
+  else
+    fprintf (stderr, "%s: ", ename);
+}
+
 /* Return the name of the shell or the shell script for error reporting. */
 char *
 get_name_for_error ()
 {
-  char *name = (char *) NULL;
+  char *name;
+#if defined (ARRAY_VARS)
+  SHELL_VAR *bash_source_v;
+  ARRAY *bash_source_a;
+#endif
 
-  if (!interactive_shell)
-    name = dollar_vars[0];
-  if (!name && shell_name && *shell_name)
+  name = (char *)NULL;
+  if (interactive_shell == 0)
+    {
+#if defined (ARRAY_VARS)
+      bash_source_v = find_variable ("BASH_SOURCE");
+      if (bash_source_v && array_p (bash_source_v) &&
+         (bash_source_a = array_cell (bash_source_v)))
+       name = array_reference (bash_source_a, 0);
+      if (name == 0 || *name == '\0')  /* XXX - was just name == 0 */
+#endif
+       name = dollar_vars[0];
+    }
+  if (name == 0 && shell_name && *shell_name)
     name = base_pathname (shell_name);
-  if (!name)
+  if (name == 0)
+#if defined (PROGRAM)
+    name = PROGRAM;
+#else
     name = "bash";
+#endif
 
   return (name);
 }
 
-/* Report an error having to do with FILENAME. */
+/* Report an error having to do with FILENAME.  This does not use
+   sys_error so the filename is not interpreted as a printf-style
+   format string. */
 void
 file_error (filename)
-     char *filename;
+     const char *filename;
 {
   report_error ("%s: %s", filename, strerror (errno));
 }
 
-#if !defined (HAVE_VFPRINTF)
 void
-programming_error (reason, arg1, arg2, arg3, arg4, arg5)
-     char *reason;
+#if defined (PREFER_STDARG)
+programming_error (const char *format, ...)
+#else
+programming_error (format, va_alist)
+     const char *format;
+     va_dcl
+#endif
 {
+  va_list args;
+  char *h;
+
 #if defined (JOB_CONTROL)
-  give_terminal_to (shell_pgrp);
+  give_terminal_to (shell_pgrp, 0);
 #endif /* JOB_CONTROL */
 
-  report_error (reason, arg1, arg2);
+  SH_VA_START (args, format);
+
+  vfprintf (stderr, format, args);
+  fprintf (stderr, "\n");
+  va_end (args);
+
+#if defined (HISTORY)
+  if (remember_on_history)
+    {
+      h = last_history_line ();
+      fprintf (stderr, _("last command: %s\n"), h ? h : "(null)");
+    }
+#endif
+
+#if 0
   fprintf (stderr, "Report this to %s\n", the_current_maintainer);
-  fprintf (stderr, "Stopping myself...");
+#endif
+
+  fprintf (stderr, _("Aborting..."));
   fflush (stderr);
+
   abort ();
 }
 
+/* Print an error message and, if `set -e' has been executed, exit the
+   shell.  Used in this file by file_error and programming_error.  Used
+   outside this file mostly to report substitution and expansion errors,
+   and for bad invocation options. */
 void
-report_error (format, arg1, arg2, arg3, arg4, arg5)
-     char *format;
+#if defined (PREFER_STDARG)
+report_error (const char *format, ...)
+#else
+report_error (format, va_alist)
+     const char *format;
+     va_dcl
+#endif
 {
-  fprintf (stderr, "%s: ", get_name_for_error ());
+  va_list args;
+
+  error_prolog (1);
+
+  SH_VA_START (args, format);
 
-  fprintf (stderr, format, arg1, arg2, arg3, arg4, arg5);
+  vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
+
+  va_end (args);
   if (exit_immediately_on_error)
-    exit (1);
-}  
+    {
+      if (last_command_exit_value == 0)
+       last_command_exit_value = EXECUTION_FAILURE;
+      exit_shell (last_command_exit_value);
+    }
+}
 
 void
-fatal_error (format, arg1, arg2, arg3, arg4, arg5)
-     char *format;
+#if defined (PREFER_STDARG)
+fatal_error (const char *format, ...)
+#else
+fatal_error (format, va_alist)
+     const char *format;
+     va_dcl
+#endif
 {
-  fprintf (stderr, "%s: ", get_name_for_error ());
+  va_list args;
+
+  error_prolog (0);
+
+  SH_VA_START (args, format);
 
-  fprintf (stderr, format, arg1, arg2, arg3, arg4, arg5);
+  vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
 
-  exit (2);
+  va_end (args);
+  sh_exit (2);
 }
 
 void
-internal_error (format, arg1, arg2, arg3, arg4, arg5)
-     char *format;
+#if defined (PREFER_STDARG)
+internal_error (const char *format, ...)
+#else
+internal_error (format, va_alist)
+     const char *format;
+     va_dcl
+#endif
 {
-  fprintf (stderr, "%s: ", get_name_for_error ());
+  va_list args;
+
+  error_prolog (1);
 
-  fprintf (stderr, format, arg1, arg2, arg3, arg4, arg5);
+  SH_VA_START (args, format);
+
+  vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
-}
 
-#else /* We have VARARGS support, so use it. */
+  va_end (args);
+}
 
 void
-programming_error (va_alist)
+#if defined (PREFER_STDARG)
+internal_warning (const char *format, ...)
+#else
+internal_warning (format, va_alist)
+     const char *format;
      va_dcl
+#endif
 {
   va_list args;
-  char *format;
 
-#if defined (JOB_CONTROL)
-  give_terminal_to (shell_pgrp);
-#endif /* JOB_CONTROL */
+  error_prolog (1);
+  fprintf (stderr, _("warning: "));
+
+  SH_VA_START (args, format);
 
-  va_start (args);
-  format = va_arg (args, char *);
   vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
-  va_end (args);
 
-  fprintf (stderr, "Tell %s to fix this someday.\n", the_current_maintainer);
-  fprintf (stderr, "Stopping myself...");
-  fflush (stderr);
-  abort ();
+  va_end (args);
 }
 
 void
-report_error (va_alist)
+#if defined (PREFER_STDARG)
+internal_inform (const char *format, ...)
+#else
+internal_inform (format, va_alist)
+     const char *format;
      va_dcl
+#endif
 {
   va_list args;
-  char *format;
 
-  fprintf (stderr, "%s: ", get_name_for_error ());
-  va_start (args);
-  format = va_arg (args, char *);
+  error_prolog (1);
+  /* TRANSLATORS: this is a prefix for informational messages. */
+  fprintf (stderr, _("INFORM: "));
+
+  SH_VA_START (args, format);
+
   vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
 
   va_end (args);
-  if (exit_immediately_on_error)
-    exit (1);
 }
 
 void
-fatal_error (va_alist)
+#if defined (PREFER_STDARG)
+internal_debug (const char *format, ...)
+#else
+internal_debug (format, va_alist)
+     const char *format;
      va_dcl
+#endif
 {
+#ifdef DEBUG
   va_list args;
-  char *format;
 
-  fprintf (stderr, "%s: ", get_name_for_error ());
-  va_start (args);
-  format = va_arg (args, char *);
+  error_prolog (1);
+  fprintf (stderr, _("DEBUG warning: "));
+
+  SH_VA_START (args, format);
+
   vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
 
   va_end (args);
-  exit (2);
+#else
+  return;
+#endif
+}
+
+void
+#if defined (PREFER_STDARG)
+sys_error (const char *format, ...)
+#else
+sys_error (format, va_alist)
+     const char *format;
+     va_dcl
+#endif
+{
+  int e;
+  va_list args;
+
+  e = errno;
+  error_prolog (0);
+
+  SH_VA_START (args, format);
+
+  vfprintf (stderr, format, args);
+  fprintf (stderr, ": %s\n", strerror (e));
+
+  va_end (args);
 }
 
+/* An error from the parser takes the general form
+
+       shell_name: input file name: line number: message
+
+   The input file name and line number are omitted if the shell is
+   currently interactive.  If the shell is not currently interactive,
+   the input file name is inserted only if it is different from the
+   shell name. */
 void
-internal_error (va_alist)
+#if defined (PREFER_STDARG)
+parser_error (int lineno, const char *format, ...)
+#else
+parser_error (lineno, format, va_alist)
+     int lineno;
+     const char *format;
      va_dcl
+#endif
 {
   va_list args;
-  char *format;
+  char *ename, *iname;
+
+  ename = get_name_for_error ();
+  iname = yy_input_name ();
+
+  if (interactive)
+    fprintf (stderr, "%s: ", ename);
+  else if (interactive_shell)
+    fprintf (stderr, "%s: %s:%s%d: ", ename, iname, gnu_error_format ? "" : _(" line "), lineno);
+  else if (STREQ (ename, iname))
+    fprintf (stderr, "%s:%s%d: ", ename, gnu_error_format ? "" : _(" line "), lineno);
+  else
+    fprintf (stderr, "%s: %s:%s%d: ", ename, iname, gnu_error_format ? "" : _(" line "), lineno);
+
+  SH_VA_START (args, format);
 
-  fprintf (stderr, "%s: ", get_name_for_error ());
-  va_start (args);
-  format = va_arg (args, char *);
   vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
 
   va_end (args);
+
+  if (exit_immediately_on_error)
+    exit_shell (last_command_exit_value = 2);
+}
+
+#ifdef DEBUG
+/* This assumes ASCII and is suitable only for debugging */
+char *
+strescape (str)
+     const char *str;
+{
+  char *r, *result;
+  unsigned char *s;
+
+  r = result = (char *)xmalloc (strlen (str) * 2 + 1);
+
+  for (s = (unsigned char *)str; s && *s; s++)
+    {
+      if (*s < ' ')
+       {
+         *r++ = '^';
+         *r++ = *s+64;
+       }
+      else if (*s == 127)
+       {
+         *r++ = '^';
+         *r++ = '?';
+       }
+     else
+       *r++ = *s;
+    }
+
+  *r = '\0';
+  return result;
 }
 
-itrace (va_alist)
+void
+#if defined (PREFER_STDARG)
+itrace (const char *format, ...)
+#else
+itrace (format, va_alist)
+     const char *format;
      va_dcl
+#endif
 {
   va_list args;
-  char *format;
 
-  fprintf(stderr, "TRACE: pid %d: ", getpid());
-  va_start (args);
-  format = va_arg (args, char *);
+  fprintf(stderr, "TRACE: pid %ld: ", (long)getpid());
+
+  SH_VA_START (args, format);
+
   vfprintf (stderr, format, args);
   fprintf (stderr, "\n");
 
@@ -211,28 +441,32 @@ itrace (va_alist)
   fflush(stderr);
 }
 
-#if 0
 /* A trace function for silent debugging -- doesn't require a control
    terminal. */
-trace (va_alist)
+void
+#if defined (PREFER_STDARG)
+trace (const char *format, ...)
+#else
+trace (format, va_alist)
+     const char *format;
      va_dcl
+#endif
 {
   va_list args;
-  char *format;
   static FILE *tracefp = (FILE *)NULL;
 
   if (tracefp == NULL)
-    tracefp = fopen("/usr/tmp/bash-trace.log", "a+");
+    tracefp = fopen("/tmp/bash-trace.log", "a+");
 
   if (tracefp == NULL)
     tracefp = stderr;
   else
     fcntl (fileno (tracefp), F_SETFD, 1);     /* close-on-exec */
 
-  fprintf(tracefp, "TRACE: pid %d: ", getpid());
+  fprintf(tracefp, "TRACE: pid %ld: ", (long)getpid());
+
+  SH_VA_START (args, format);
 
-  va_start (args);
-  format = va_arg (args, char *);
   vfprintf (tracefp, format, args);
   fprintf (tracefp, "\n");
 
@@ -240,5 +474,64 @@ trace (va_alist)
 
   fflush(tracefp);
 }
+
+#endif /* DEBUG */
+
+/* **************************************************************** */
+/*                                                                 */
+/*                 Common error reporting                          */
+/*                                                                 */
+/* **************************************************************** */
+
+
+static const char * const cmd_error_table[] = {
+       N_("unknown command error"),    /* CMDERR_DEFAULT */
+       N_("bad command type"),         /* CMDERR_BADTYPE */
+       N_("bad connector"),            /* CMDERR_BADCONN */
+       N_("bad jump"),                 /* CMDERR_BADJUMP */
+       0
+};
+
+void
+command_error (func, code, e, flags)
+     const char *func;
+     int code, e, flags;       /* flags currently unused */
+{
+  if (code > CMDERR_LAST)
+    code = CMDERR_DEFAULT;
+
+  programming_error ("%s: %s: %d", func, _(cmd_error_table[code]), e);
+}
+
+char *
+command_errstr (code)
+     int code;
+{
+  if (code > CMDERR_LAST)
+    code = CMDERR_DEFAULT;
+
+  return (_(cmd_error_table[code]));
+}
+
+#ifdef ARRAY_VARS
+void
+err_badarraysub (s)
+     const char *s;
+{
+  report_error ("%s: %s", s, _(bash_badsub_errmsg));
+}
 #endif
-#endif /* HAVE_VFPRINTF */
+
+void
+err_unboundvar (s)
+     const char *s;
+{
+  report_error (_("%s: unbound variable"), s);
+}
+
+void
+err_readonly (s)
+     const char *s;
+{
+  report_error (_("%s: readonly variable"), s);
+}