binutils-gdb/gdb/mi/mi-console.h

/* MI Command Set - MI Console.
   Copyright (C) 2000-2022 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/>.  */

#ifndef MI_MI_CONSOLE_H
#define MI_MI_CONSOLE_H

/* An output stream for MI.  Wraps a given output stream with a prefix
   and handles quoting.  This stream is locally buffered.  */

class mi_console_file : public ui_file
{
public:
  /* Create a console that wraps the given output stream RAW with the
     string PREFIX and quoting it with QUOTE.  */
  mi_console_file (ui_file *raw, const char *prefix, char quote);

  /* MI-specific API.  */
  void set_raw (ui_file *raw);

  /* ui_file-specific methods.  */

  void flush () override;

  void write (const char *buf, long length_buf) override;

  void write_async_safe (const char *buf, long length_buf) override;

private:
  /* The wrapped raw output stream.  */
  ui_file *m_raw;

  /* The local buffer.  */
  string_file m_buffer;

  /* The prefix.  */
  const char *m_prefix;

  /* The quote char.  */
  char m_quote;
};

#endif /* MI_MI_CONSOLE_H */