gdb/mi/mi-console.c - gdb

Global variables defined

Data types defined

Functions defined

Source code

  1. /* MI Console code.

  3.    Copyright (C) 2000-2015 Free Software Foundation, Inc.

  5.    Contributed by Cygnus Solutions (a Red Hat company).

  7.    This file is part of GDB.

  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.

  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.

  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/>.  */

  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.    "&".  */

  27. #include "defs.h"
  28. #include "mi-console.h"
  29. ‌static ui_file_fputs_ftype mi_console_file_fputs;
  30. ‌static ui_file_flush_ftype mi_console_file_flush;
  31. ‌static ui_file_delete_ftype mi_console_file_delete;

  33. ‌struct mi_console_file
  34.   {
  35.     int *magic;
  36.     struct ui_file *raw;
  37.     struct ui_file *buffer;
  38.     const char *prefix;
  39.     char quote;
  40.   };

  42. /* Use the address of this otherwise-unused global as a magic number
  43.    identifying this class of ui_file objects.  */
  44. ‌static int mi_console_file_magic;

  46. /* Create a console that wraps the given output stream RAW with the
  47.    string PREFIX and quoting it with QUOTE.  */

  49. struct ui_file *
  50. ‌mi_console_file_new (struct ui_file *raw, const char *prefix, char quote)
  51. {
  52.   struct ui_file *ui_file = ui_file_new ();
  53.   struct mi_console_file *mi_console = XNEW (struct mi_console_file);

  55.   mi_console->magic = &mi_console_file_magic;
  56.   mi_console->raw = raw;
  57.   mi_console->buffer = mem_fileopen ();
  58.   mi_console->prefix = prefix;
  59.   mi_console->quote = quote;
  60.   set_ui_file_fputs (ui_file, mi_console_file_fputs);
  61.   set_ui_file_flush (ui_file, mi_console_file_flush);
  62.   set_ui_file_data (ui_file, mi_console, mi_console_file_delete);

  64.   return ui_file;
  65. }

  67. static void
  68. ‌mi_console_file_delete (struct ui_file *file)
  69. {
  70.   struct mi_console_file *mi_console = ui_file_data (file);

  72.   if (mi_console->magic != &mi_console_file_magic)
  73.     internal_error (__FILE__, __LINE__,
  74.                     _("mi_console_file_delete: bad magic number"));

  76.   xfree (mi_console);
  77. }

  79. static void
  80. ‌mi_console_file_fputs (const char *buf, struct ui_file *file)
  81. {
  82.   struct mi_console_file *mi_console = ui_file_data (file);

  84.   if (mi_console->magic != &mi_console_file_magic)
  85.     internal_error (__FILE__, __LINE__,
  86.                     "mi_console_file_fputs: bad magic number");

  88.   /* Append the text to our internal buffer.  */
  89.   fputs_unfiltered (buf, mi_console->buffer);
  90.   /* Flush when an embedded newline is present anywhere in the buffer.  */
  91.   if (strchr (buf, '\n') != NULL)
  92.     gdb_flush (file);
  93. }

  95. /* Transform a byte sequence into a console output packet.  */

  97. static void
  98. ‌mi_console_raw_packet (void *data, const char *buf, long length_buf)
  99. {
  100.   struct mi_console_file *mi_console = data;

  102.   if (mi_console->magic != &mi_console_file_magic)
  103.     internal_error (__FILE__, __LINE__,
  104.                     _("mi_console_raw_packet: bad magic number"));

  106.   if (length_buf > 0)
  107.     {
  108.       fputs_unfiltered (mi_console->prefix, mi_console->raw);
  109.       if (mi_console->quote)
  110.         {
  111.           fputc_unfiltered (mi_console->quote, mi_console->raw);
  112.           fputstrn_unfiltered (buf, length_buf,
  113.                                mi_console->quote, mi_console->raw);
  114.           fputc_unfiltered (mi_console->quote, mi_console->raw);
  115.           fputc_unfiltered ('\n', mi_console->raw);
  116.         }
  117.       else
  118.         {
  119.           fputstrn_unfiltered (buf, length_buf, 0, mi_console->raw);
  120.           fputc_unfiltered ('\n', mi_console->raw);
  121.         }
  122.       gdb_flush (mi_console->raw);
  123.     }
  124. }

  126. static void
  127. ‌mi_console_file_flush (struct ui_file *file)
  128. {
  129.   struct mi_console_file *mi_console = ui_file_data (file);

  131.   if (mi_console->magic != &mi_console_file_magic)
  132.     internal_error (__FILE__, __LINE__,
  133.                     _("mi_console_file_flush: bad magic number"));

  135.   ui_file_put (mi_console->buffer, mi_console_raw_packet, mi_console);
  136.   ui_file_rewind (mi_console->buffer);

  138. }

  140. /* Change the underlying stream of the console directly; this is
  141.    useful as a minimum-impact way to reflect external changes like
  142.    logging enable/disable.  */

  144. void
  145. ‌mi_console_set_raw (struct ui_file *file, struct ui_file *raw)
  146. {
  147.   struct mi_console_file *mi_console = ui_file_data (file);

  149.   if (mi_console->magic != &mi_console_file_magic)
  150.     internal_error (__FILE__, __LINE__,
  151.                     _("mi_console_file_set_raw: bad magic number"));

  153.   mi_console->raw = raw;
  154. }