gdb/mi/mi-console.c

   1 /* MI Console code.
   2
   3    Copyright (C) 2000-2014 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Solutions (a Red Hat company).
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 /* An MI console is a kind of ui_file stream that sends output to
  23    stdout, but encapsulated and prefixed with a distinctive string;
  24    for instance, error output is normally identified by a leading
  25    "&".  */
  26
  27 #include "defs.h"
  28 #include "mi-console.h"
  29 #include <string.h>
  30
  31 static ui_file_fputs_ftype mi_console_file_fputs;
  32 static ui_file_flush_ftype mi_console_file_flush;
  33 static ui_file_delete_ftype mi_console_file_delete;
  34
  35 struct mi_console_file
  36   {
  37     int *magic;
  38     struct ui_file *raw;
  39     struct ui_file *buffer;
  40     const char *prefix;
  41     char quote;
  42   };
  43
  44 /* Use the address of this otherwise-unused global as a magic number
  45    identifying this class of ui_file objects.  */
  46 static int mi_console_file_magic;
  47
  48 /* Create a console that wraps the given output stream RAW with the
  49    string PREFIX and quoting it with QUOTE.  */
  50
  51 struct ui_file *
  52 mi_console_file_new (struct ui_file *raw, const char *prefix, char quote)
  53 {
  54   struct ui_file *ui_file = ui_file_new ();
  55   struct mi_console_file *mi_console = XNEW (struct mi_console_file);
  56
  57   mi_console->magic = &mi_console_file_magic;
  58   mi_console->raw = raw;
  59   mi_console->buffer = mem_fileopen ();
  60   mi_console->prefix = prefix;
  61   mi_console->quote = quote;
  62   set_ui_file_fputs (ui_file, mi_console_file_fputs);
  63   set_ui_file_flush (ui_file, mi_console_file_flush);
  64   set_ui_file_data (ui_file, mi_console, mi_console_file_delete);
  65
  66   return ui_file;
  67 }
  68
  69 static void
  70 mi_console_file_delete (struct ui_file *file)
  71 {
  72   struct mi_console_file *mi_console = ui_file_data (file);
  73
  74   if (mi_console->magic != &mi_console_file_magic)
  75     internal_error (__FILE__, __LINE__,
  76                     _("mi_console_file_delete: bad magic number"));
  77
  78   xfree (mi_console);
  79 }
  80
  81 static void
  82 mi_console_file_fputs (const char *buf, struct ui_file *file)
  83 {
  84   struct mi_console_file *mi_console = ui_file_data (file);
  85
  86   if (mi_console->magic != &mi_console_file_magic)
  87     internal_error (__FILE__, __LINE__,
  88                     "mi_console_file_fputs: bad magic number");
  89
  90   /* Append the text to our internal buffer.  */
  91   fputs_unfiltered (buf, mi_console->buffer);
  92   /* Flush when an embedded newline is present anywhere in the buffer.  */
  93   if (strchr (buf, '\n') != NULL)
  94     gdb_flush (file);
  95 }
  96
  97 /* Transform a byte sequence into a console output packet.  */
  98
  99 static void
 100 mi_console_raw_packet (void *data, const char *buf, long length_buf)
 101 {
 102   struct mi_console_file *mi_console = data;
 103
 104   if (mi_console->magic != &mi_console_file_magic)
 105     internal_error (__FILE__, __LINE__,
 106                     _("mi_console_raw_packet: bad magic number"));
 107
 108   if (length_buf > 0)
 109     {
 110       fputs_unfiltered (mi_console->prefix, mi_console->raw);
 111       if (mi_console->quote)
 112         {
 113           fputs_unfiltered ("\"", mi_console->raw);
 114           fputstrn_unfiltered (buf, length_buf,
 115                                mi_console->quote, mi_console->raw);
 116           fputs_unfiltered ("\"\n", mi_console->raw);
 117         }
 118       else
 119         {
 120           fputstrn_unfiltered (buf, length_buf, 0, mi_console->raw);
 121           fputs_unfiltered ("\n", mi_console->raw);
 122         }
 123       gdb_flush (mi_console->raw);
 124     }
 125 }
 126
 127 static void
 128 mi_console_file_flush (struct ui_file *file)
 129 {
 130   struct mi_console_file *mi_console = ui_file_data (file);
 131
 132   if (mi_console->magic != &mi_console_file_magic)
 133     internal_error (__FILE__, __LINE__,
 134                     _("mi_console_file_flush: bad magic number"));
 135
 136   ui_file_put (mi_console->buffer, mi_console_raw_packet, mi_console);
 137   ui_file_rewind (mi_console->buffer);
 138
 139 }
 140
 141 /* Change the underlying stream of the console directly; this is
 142    useful as a minimum-impact way to reflect external changes like
 143    logging enable/disable.  */
 144
 145 void
 146 mi_console_set_raw (struct ui_file *file, struct ui_file *raw)
 147 {
 148   struct mi_console_file *mi_console = ui_file_data (file);
 149
 150   if (mi_console->magic != &mi_console_file_magic)
 151     internal_error (__FILE__, __LINE__,
 152                     _("mi_console_file_set_raw: bad magic number"));
 153
 154   mi_console->raw = raw;
 155 }