binutils-gdb/gdb/mi/mi-console.c
Simon Marchi 303a33faef mi: Use the value in mi_console_file->quote as the quoting character
In mi_interpreter_init, multiple MI consoles/channels are created and a quoting
character is given.  In mi_console_raw_packet, we check if the value is not 0
to decide if we should quote the string, but we don't use the value. It is
hardcoded to ".  We might never use another quoting character than an actual
quote, but I suggest we change it, for correctness.  There is not visible
behavior change.

I changed the latest fputs_unfiltered changed to fputc_unfiltered just to stay
consistent.

gdb/ChangeLog:

2014-05-12  Simon Marchi  <simon.marchi@ericsson.com>

	* mi/mi-console.c (mi_console_raw_packet): Use the value from
	mi_console->quote as the quoting character.
2014-05-12 15:44:19 -04:00

157 lines
4.6 KiB
C

/* MI Console code.
Copyright (C) 2000-2014 Free Software Foundation, Inc.
Contributed by Cygnus Solutions (a Red Hat company).
This file is part of GDB.
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 3 of the License, or
(at your option) any later version.
This program 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 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 <string.h>
static ui_file_fputs_ftype mi_console_file_fputs;
static ui_file_flush_ftype mi_console_file_flush;
static ui_file_delete_ftype mi_console_file_delete;
struct mi_console_file
{
int *magic;
struct ui_file *raw;
struct ui_file *buffer;
const char *prefix;
char quote;
};
/* 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)
{
struct ui_file *ui_file = ui_file_new ();
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 ();
mi_console->prefix = prefix;
mi_console->quote = quote;
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;
}
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)
{
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. */
fputs_unfiltered (buf, mi_console->buffer);
/* 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. */
static void
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_raw_packet: bad magic number"));
if (length_buf > 0)
{
fputs_unfiltered (mi_console->prefix, mi_console->raw);
if (mi_console->quote)
{
fputc_unfiltered (mi_console->quote, mi_console->raw);
fputstrn_unfiltered (buf, length_buf,
mi_console->quote, mi_console->raw);
fputc_unfiltered (mi_console->quote, mi_console->raw);
fputc_unfiltered ('\n', mi_console->raw);
}
else
{
fputstrn_unfiltered (buf, length_buf, 0, mi_console->raw);
fputc_unfiltered ('\n', mi_console->raw);
}
gdb_flush (mi_console->raw);
}
}
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;
}