change delegation for to_read_description

[deliverable/binutils-gdb.git] / gdb / mi / mi-console.c

diff --git a/gdb/mi/mi-console.c b/gdb/mi/mi-console.c
index d0da0868e1d8a33b8d4127ef84496c94561c4434..dbad19932cd02eb80538a0f245e1fe972969d249 100644 (file)
--- a/gdb/mi/mi-console.c
+++ b/gdb/mi/mi-console.c
@@ -1,6 +1,6 @@
 /* MI Console code.
 
-   Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
+   Copyright (C) 2000-2014 Free Software Foundation, Inc.
 
    Contributed by Cygnus Solutions (a Red Hat company).
 
@@ -8,7 +8,7 @@
 
    This program 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 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
@@ -17,15 +17,16 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor,
-   Boston, MA 02110-1301, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/* An MI console is a kind of ui_file stream that sends output to
+   stdout, but encapsulated and prefixed with a distinctive string;
+   for instance, error output is normally identified by a leading
+   "&".  */
 
 #include "defs.h"
 #include "mi-console.h"
-#include "gdb_string.h"
-
-/* MI-console: send output to std-out but correcty encapsulated */
+#include <string.h>
 
 static ui_file_fputs_ftype mi_console_file_fputs;
 static ui_file_flush_ftype mi_console_file_flush;
@@ -40,14 +41,19 @@ struct mi_console_file
     char quote;
   };
 
-int mi_console_file_magic;
+/* Use the address of this otherwise-unused global as a magic number
+   identifying this class of ui_file objects.  */
+static int mi_console_file_magic;
+
+/* Create a console that wraps the given output stream RAW with the
+   string PREFIX and quoting it with QUOTE.  */
 
 struct ui_file *
-mi_console_file_new (struct ui_file *raw,
-                    const char *prefix, char quote)
+mi_console_file_new (struct ui_file *raw, const char *prefix, char quote)
 {
   struct ui_file *ui_file = ui_file_new ();
-  struct mi_console_file *mi_console = XMALLOC (struct mi_console_file);
+  struct mi_console_file *mi_console = XNEW (struct mi_console_file);
+
   mi_console->magic = &mi_console_file_magic;
   mi_console->raw = raw;
   mi_console->buffer = mem_fileopen ();
@@ -56,6 +62,7 @@ mi_console_file_new (struct ui_file *raw,
   set_ui_file_fputs (ui_file, mi_console_file_fputs);
   set_ui_file_flush (ui_file, mi_console_file_flush);
   set_ui_file_data (ui_file, mi_console, mi_console_file_delete);
+
   return ui_file;
 }
 
@@ -63,37 +70,40 @@ static void
 mi_console_file_delete (struct ui_file *file)
 {
   struct mi_console_file *mi_console = ui_file_data (file);
+
   if (mi_console->magic != &mi_console_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("mi_console_file_delete: bad magic number"));
+
   xfree (mi_console);
 }
 
 static void
-mi_console_file_fputs (const char *buf,
-                      struct ui_file *file)
+mi_console_file_fputs (const char *buf, struct ui_file *file)
 {
   struct mi_console_file *mi_console = ui_file_data (file);
+
   if (mi_console->magic != &mi_console_file_magic)
     internal_error (__FILE__, __LINE__,
                    "mi_console_file_fputs: bad magic number");
-  /* Append the text to our internal buffer */
+
+  /* Append the text to our internal buffer.  */
   fputs_unfiltered (buf, mi_console->buffer);
-  /* Flush when an embedded \n */
+  /* Flush when an embedded newline is present anywhere in the buffer.  */
   if (strchr (buf, '\n') != NULL)
     gdb_flush (file);
 }
 
-/* Transform a byte sequence into a console output packet. */
+/* Transform a byte sequence into a console output packet.  */
+
 static void
-mi_console_raw_packet (void *data,
-                      const char *buf,
-                      long length_buf)
+mi_console_raw_packet (void *data, const char *buf, long length_buf)
 {
   struct mi_console_file *mi_console = data;
+
   if (mi_console->magic != &mi_console_file_magic)
     internal_error (__FILE__, __LINE__,
-                   _("mi_console_file_transform: bad magic number"));
+                   _("mi_console_raw_packet: bad magic number"));
 
   if (length_buf > 0)
     {
@@ -101,7 +111,8 @@ mi_console_raw_packet (void *data,
       if (mi_console->quote)
        {
          fputs_unfiltered ("\"", mi_console->raw);
-         fputstrn_unfiltered (buf, length_buf, mi_console->quote, mi_console->raw);
+         fputstrn_unfiltered (buf, length_buf,
+                              mi_console->quote, mi_console->raw);
          fputs_unfiltered ("\"\n", mi_console->raw);
        }
       else
@@ -117,9 +128,28 @@ static void
 mi_console_file_flush (struct ui_file *file)
 {
   struct mi_console_file *mi_console = ui_file_data (file);
+
   if (mi_console->magic != &mi_console_file_magic)
     internal_error (__FILE__, __LINE__,
                    _("mi_console_file_flush: bad magic number"));
+
   ui_file_put (mi_console->buffer, mi_console_raw_packet, mi_console);
   ui_file_rewind (mi_console->buffer);
+
+}
+
+/* Change the underlying stream of the console directly; this is
+   useful as a minimum-impact way to reflect external changes like
+   logging enable/disable.  */
+
+void
+mi_console_set_raw (struct ui_file *file, struct ui_file *raw)
+{
+  struct mi_console_file *mi_console = ui_file_data (file);
+
+  if (mi_console->magic != &mi_console_file_magic)
+    internal_error (__FILE__, __LINE__,
+                   _("mi_console_file_set_raw: bad magic number"));
+
+  mi_console->raw = raw;
 }