Change boolean options to bool instead of int
[deliverable/binutils-gdb.git] / gdb / utils.c
index 6fb5736abb5a74bc3b76deaefb7fb70f477c35ec..b2535ebefd3805c27ebcc41b94d2a0cdc0eaeab1 100644 (file)
@@ -19,7 +19,7 @@
 
 #include "defs.h"
 #include <ctype.h>
-#include "common/gdb_wait.h"
+#include "gdbsupport/gdb_wait.h"
 #include "event-top.h"
 #include "gdbthread.h"
 #include "fnmatch.h"
 #include "gdb_usleep.h"
 #include "interps.h"
 #include "gdb_regex.h"
-#include "common/job-control.h"
-#include "common/selftest.h"
-#include "common/gdb_optional.h"
+#include "gdbsupport/job-control.h"
+#include "gdbsupport/selftest.h"
+#include "gdbsupport/gdb_optional.h"
 #include "cp-support.h"
 #include <algorithm>
-#include "common/pathstuff.h"
+#include "gdbsupport/pathstuff.h"
 #include "cli/cli-style.h"
+#include "gdbsupport/scope-exit.h"
+#include "gdbarch.h"
 
 void (*deprecated_error_begin_hook) (void);
 
@@ -97,13 +99,13 @@ static std::chrono::steady_clock::duration prompt_for_continue_wait_time;
 
 /* A flag indicating whether to timestamp debugging messages.  */
 
-static int debug_timestamp = 0;
+static bool debug_timestamp = false;
 
-/* Nonzero means that strings with character values >0x7F should be printed
-   as octal escapes.  Zero means just print the value (e.g. it's an
+/* True means that strings with character values >0x7F should be printed
+   as octal escapes.  False means just print the value (e.g. it's an
    international character, and the terminal or window can cope.)  */
 
-int sevenbit_strings = 0;
+bool sevenbit_strings = false;
 static void
 show_sevenbit_strings (struct ui_file *file, int from_tty,
                       struct cmd_list_element *c, const char *value)
@@ -117,7 +119,7 @@ show_sevenbit_strings (struct ui_file *file, int from_tty,
 
 const char *warning_pre_print = "\nwarning: ";
 
-int pagination_enabled = 1;
+bool pagination_enabled = true;
 static void
 show_pagination_enabled (struct ui_file *file, int from_tty,
                         struct cmd_list_element *c, const char *value)
@@ -126,35 +128,6 @@ show_pagination_enabled (struct ui_file *file, int from_tty,
 }
 
 \f
-/* Cleanup utilities.
-
-   These are not defined in cleanups.c (nor declared in cleanups.h)
-   because while they use the "cleanup API" they are not part of the
-   "cleanup API".  */
-
-/* This function is useful for cleanups.
-   Do
-
-   foo = xmalloc (...);
-   old_chain = make_cleanup (free_current_contents, &foo);
-
-   to arrange to free the object thus allocated.  */
-
-void
-free_current_contents (void *ptr)
-{
-  void **location = (void **) ptr;
-
-  if (location == NULL)
-    internal_error (__FILE__, __LINE__,
-                   _("free_current_contents: NULL pointer"));
-  if (*location != NULL)
-    {
-      xfree (*location);
-      *location = NULL;
-    }
-}
-\f
 
 
 /* Print a warning message.  The first argument STRING is the warning
@@ -328,7 +301,7 @@ internal_vproblem (struct internal_problem *problem,
 
   /* Don't allow infinite error/warning recursion.  */
   {
-    static char msg[] = "Recursive internal problem.\n";
+    static const char msg[] = "Recursive internal problem.\n";
 
     switch (dejavu)
       {
@@ -558,10 +531,10 @@ add_internal_problem_command (struct internal_problem *problem)
   if (problem->user_settable_should_quit)
     {
       set_doc = xstrprintf (_("Set whether GDB should quit "
-                             "when an %s is detected"),
+                             "when an %s is detected."),
                            problem->name);
       show_doc = xstrprintf (_("Show whether GDB will quit "
-                              "when an %s is detected"),
+                              "when an %s is detected."),
                             problem->name);
       add_setshow_enum_cmd ("quit", class_maintenance,
                            internal_problem_modes,
@@ -581,10 +554,10 @@ add_internal_problem_command (struct internal_problem *problem)
   if (problem->user_settable_should_dump_core)
     {
       set_doc = xstrprintf (_("Set whether GDB should create a core "
-                             "file of GDB when %s is detected"),
+                             "file of GDB when %s is detected."),
                            problem->name);
       show_doc = xstrprintf (_("Show whether GDB will create a core "
-                              "file of GDB when %s is detected"),
+                              "file of GDB when %s is detected."),
                             problem->name);
       add_setshow_enum_cmd ("corefile", class_maintenance,
                            internal_problem_modes,
@@ -706,9 +679,6 @@ maybe_quit (void)
     quit ();
 
   quit_handler ();
-
-  if (deprecated_interactive_hook)
-    deprecated_interactive_hook ();
 }
 
 \f
@@ -889,7 +859,6 @@ defaulted_query (const char *ctlstr, const char defchar, va_list args)
       printf_filtered (_("(%s or %s) [answered %c; "
                         "input not from terminal]\n"),
                       y_string, n_string, def_answer);
-      gdb_flush (gdb_stdout);
 
       return def_value;
     }
@@ -1282,6 +1251,9 @@ static const char *wrap_indent;
 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
    is not in effect.  */
 static int wrap_column;
+
+/* The style applied at the time that wrap_here was called.  */
+static ui_file_style wrap_style;
 \f
 
 /* Initialize the number of lines per page and chars per line.  */
@@ -1376,11 +1348,30 @@ set_screen_size (void)
   int rows = lines_per_page;
   int cols = chars_per_line;
 
-  if (rows <= 0)
-    rows = INT_MAX;
+  /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
+     A negative number can be seen here with the "set width/height"
+     commands and either:
+
+     - the user specified "unlimited", which maps to UINT_MAX, or
+     - the user spedified some number between INT_MAX and UINT_MAX.
+
+     Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
+     overflow in rl_set_screen_size, which multiplies rows and columns
+     to compute the number of characters on the screen.  */
+
+  const int sqrt_int_max = INT_MAX >> (sizeof (int) * 8 / 2);
 
-  if (cols <= 0)
-    cols = INT_MAX;
+  if (rows <= 0 || rows > sqrt_int_max)
+    {
+      rows = sqrt_int_max;
+      lines_per_page = UINT_MAX;
+    }
+
+  if (cols <= 0 || cols > sqrt_int_max)
+    {
+      cols = sqrt_int_max;
+      chars_per_line = UINT_MAX;
+    }
 
   /* Update Readline's idea of the terminal size.  */
   rl_set_screen_size (rows, cols);
@@ -1427,36 +1418,19 @@ set_screen_width_and_height (int width, int height)
 
 static ui_file_style applied_style;
 
-/* The currently desired style.  This can differ from the applied
-   style when showing the pagination prompt.  */
-
-static ui_file_style desired_style;
-
-/* Emit an ANSI style escape for STYLE to the wrap buffer.  */
+/* Emit an ANSI style escape for STYLE.  If STREAM is nullptr, emit to
+   the wrap buffer; otherwise emit to STREAM.  */
 
 static void
-emit_style_escape (const ui_file_style &style)
+emit_style_escape (const ui_file_style &style,
+                  struct ui_file *stream = nullptr)
 {
-  if (applied_style == style)
-    return;
   applied_style = style;
 
-  wrap_buffer.append (style.to_ansi ());
-}
-
-/* See utils.h.  */
-
-bool
-can_emit_style_escape (struct ui_file *stream)
-{
-  if (stream != gdb_stdout
-      || !cli_styling
-      || !ui_file_isatty (stream))
-    return false;
-  const char *term = getenv ("TERM");
-  if (term == nullptr || !strcmp (term, "dumb"))
-    return false;
-  return true;
+  if (stream == nullptr)
+    wrap_buffer.append (style.to_ansi ());
+  else
+    fputs_unfiltered (style.to_ansi ().c_str (), stream);
 }
 
 /* Set the current output style.  This will affect future uses of the
@@ -1465,12 +1439,14 @@ can_emit_style_escape (struct ui_file *stream)
 static void
 set_output_style (struct ui_file *stream, const ui_file_style &style)
 {
-  if (!can_emit_style_escape (stream)
-      || style == desired_style)
+  if (!stream->can_emit_style_escape ())
     return;
 
-  desired_style = style;
-  emit_style_escape (style);
+  /* Note that we may not pass STREAM here, when we want to emit to
+     the wrap buffer, not directly to STREAM.  */
+  if (stream == gdb_stdout)
+    stream = nullptr;
+  emit_style_escape (style, stream);
 }
 
 /* See utils.h.  */
@@ -1478,13 +1454,12 @@ set_output_style (struct ui_file *stream, const ui_file_style &style)
 void
 reset_terminal_style (struct ui_file *stream)
 {
-  if (can_emit_style_escape (stream))
+  if (stream->can_emit_style_escape ())
     {
       /* Force the setting, regardless of what we think the setting
         might already be.  */
-      desired_style = ui_file_style ();
-      applied_style = desired_style;
-      wrap_buffer.append (desired_style.to_ansi ());
+      applied_style = ui_file_style ();
+      wrap_buffer.append (applied_style.to_ansi ());
     }
 }
 
@@ -1504,7 +1479,8 @@ prompt_for_continue (void)
   bool disable_pagination = pagination_disabled_for_command;
 
   /* Clear the current styling.  */
-  emit_style_escape (ui_file_style ());
+  if (gdb_stdout->can_emit_style_escape ())
+    emit_style_escape (ui_file_style (), gdb_stdout);
 
   if (annotation_level > 1)
     printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
@@ -1550,9 +1526,6 @@ prompt_for_continue (void)
   reinitialize_more_filter ();
   pagination_disabled_for_command = disable_pagination;
 
-  /* Restore the current styling.  */
-  emit_style_escape (desired_style);
-
   dont_repeat ();              /* Forget prev cmd -- CR won't repeat it.  */
 }
 
@@ -1589,7 +1562,7 @@ reinitialize_more_filter (void)
 static void
 flush_wrap_buffer (struct ui_file *stream)
 {
-  if (!wrap_buffer.empty ())
+  if (stream == gdb_stdout && !wrap_buffer.empty ())
     {
       fputs_unfiltered (wrap_buffer.c_str (), stream);
       wrap_buffer.clear ();
@@ -1644,6 +1617,7 @@ wrap_here (const char *indent)
        wrap_indent = "";
       else
        wrap_indent = indent;
+      wrap_style = applied_style;
     }
 }
 
@@ -1743,6 +1717,14 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
       return;
     }
 
+  auto buffer_clearer
+    = make_scope_exit ([&] ()
+                      {
+                        wrap_buffer.clear ();
+                        wrap_column = 0;
+                        wrap_indent = "";
+                      });
+
   /* Go through and output each character.  Show line extension
      when this is necessary; prompt user for new page when this is
      necessary.  */
@@ -1759,6 +1741,8 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
 
       while (*lineptr && *lineptr != '\n')
        {
+         int skip_bytes;
+
          /* Print a single line.  */
          if (*lineptr == '\t')
            {
@@ -1769,6 +1753,14 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
              chars_printed = ((chars_printed >> 3) + 1) << 3;
              lineptr++;
            }
+         else if (*lineptr == '\033'
+                  && skip_ansi_escape (lineptr, &skip_bytes))
+           {
+             wrap_buffer.append (lineptr, skip_bytes);
+             /* Note that we don't consider this a character, so we
+                don't increment chars_printed here.  */
+             lineptr += skip_bytes;
+           }
          else
            {
              wrap_buffer.push_back (*lineptr);
@@ -1780,31 +1772,50 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
            {
              unsigned int save_chars = chars_printed;
 
+             /* If we change the style, below, we'll want to reset it
+                before continuing to print.  If there is no wrap
+                column, then we'll only reset the style if the pager
+                prompt is given; and to avoid emitting style
+                sequences in the middle of a run of text, we track
+                this as well.  */
+             ui_file_style save_style;
+             bool did_paginate = false;
+
              chars_printed = 0;
              lines_printed++;
-             /* If we aren't actually wrapping, don't output newline --
-                if chars_per_line is right, we probably just overflowed
-                anyway; if it's wrong, let us keep going.  */
              if (wrap_column)
                {
-                 emit_style_escape (ui_file_style ());
-                 flush_wrap_buffer (stream);
+                 save_style = wrap_style;
+                 if (stream->can_emit_style_escape ())
+                   emit_style_escape (ui_file_style (), stream);
+                 /* If we aren't actually wrapping, don't output
+                    newline -- if chars_per_line is right, we
+                    probably just overflowed anyway; if it's wrong,
+                    let us keep going.  */
                  fputc_unfiltered ('\n', stream);
                }
+             else
+               {
+                 save_style = applied_style;
+                 flush_wrap_buffer (stream);
+               }
 
              /* Possible new page.  Note that
                 PAGINATION_DISABLED_FOR_COMMAND might be set during
                 this loop, so we must continue to check it here.  */
              if (lines_printed >= lines_per_page - 1
                  && !pagination_disabled_for_command)
-               prompt_for_continue ();
+               {
+                 prompt_for_continue ();
+                 did_paginate = true;
+               }
 
              /* Now output indentation and wrapped string.  */
              if (wrap_column)
                {
                  fputs_unfiltered (wrap_indent, stream);
-                 emit_style_escape (desired_style);
-                 flush_wrap_buffer (stream);
+                 if (stream->can_emit_style_escape ())
+                   emit_style_escape (save_style, stream);
                  /* FIXME, this strlen is what prevents wrap_indent from
                     containing tabs.  However, if we recurse to print it
                     and count its chars, we risk trouble if wrap_indent is
@@ -1815,6 +1826,8 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
                    + (save_chars - wrap_column);
                  wrap_column = 0;      /* And disable fancy wrap */
                }
+             else if (did_paginate && stream->can_emit_style_escape ())
+               emit_style_escape (save_style, stream);
            }
        }
 
@@ -1828,6 +1841,8 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
          lineptr++;
        }
     }
+
+  buffer_clearer.release ();
 }
 
 void
@@ -1842,9 +1857,52 @@ void
 fputs_styled (const char *linebuffer, const ui_file_style &style,
              struct ui_file *stream)
 {
-  set_output_style (stream, style);
-  fputs_maybe_filtered (linebuffer, stream, 1);
-  set_output_style (stream, ui_file_style ());
+  /* This just makes it so we emit somewhat fewer escape
+     sequences.  */
+  if (style.is_default ())
+    fputs_maybe_filtered (linebuffer, stream, 1);
+  else
+    {
+      set_output_style (stream, style);
+      fputs_maybe_filtered (linebuffer, stream, 1);
+      set_output_style (stream, ui_file_style ());
+    }
+}
+
+/* See utils.h.  */
+
+void
+fputs_highlighted (const char *str, const compiled_regex &highlight,
+                  struct ui_file *stream)
+{
+  regmatch_t pmatch;
+
+  while (*str && highlight.exec (str, 1, &pmatch, 0) == 0)
+    {
+      size_t n_highlight = pmatch.rm_eo - pmatch.rm_so;
+
+      /* Output the part before pmatch with current style.  */
+      while (pmatch.rm_so > 0)
+       {
+         fputc_filtered (*str, stream);
+         pmatch.rm_so--;
+         str++;
+       }
+
+      /* Output pmatch with the highlight style.  */
+      set_output_style (stream, highlight_style.style ());
+      while (n_highlight > 0)
+       {
+         fputc_filtered (*str, stream);
+         n_highlight--;
+         str++;
+       }
+      set_output_style (stream, ui_file_style ());
+    }
+
+  /* Output the trailing part of STR not matching HIGHLIGHT.  */
+  if (*str)
+    fputs_filtered (str, stream);
 }
 
 int
@@ -2713,7 +2771,7 @@ subset_compare (const char *string_to_compare, const char *template_string)
 {
   int match;
 
-  if (template_string != (char *) NULL && string_to_compare != (char *) NULL
+  if (template_string != NULL && string_to_compare != NULL
       && strlen (string_to_compare) <= strlen (template_string))
     match =
       (startswith (template_string, string_to_compare));
This page took 0.030419 seconds and 4 git commands to generate.