binutils-gdb/gdb/tui/tui-out.h
Pedro Alves cb24623460 Add comments describing tui_ui_out and its fields, cleanup a bit
This commit add comments describing tui_ui_out and its fields, and
cleans up the code a little bit.

Also switch to using in-class initialization so that the initial
values can be seen alongside the comments.

I see no reason for initializing m_line as -1 instead of 0, since all
the checks in the .c file are of the form "> 0".  AFAICS there's no
practical difference between -1 and 0.  So it seems simpler to
initialize it as 0.

There's a bit of redundancy in tui_ui_out::do_field_string, which is
fixed by this commit.

gdb/ChangeLog:
2019-03-19  Pedro Alves  <palves@redhat.com>

	* tui/tui-out.c (tui_ui_out::do_field_string): Simplify.
	(tui_ui_out::do_text): Add comments.  Reset M_LINE to 0 instead of
	to -1.  Fix TABs vs spaces.
	(tui_ui_out::tui_ui_out): Don't initialize fields here.
	* tui/tui-out.h (tui_ui_out) Add intro comments.
	<m_line, m_start_of_line>: In-class initialize, and add describing
	comment.
2019-03-19 18:08:27 +00:00

66 lines
2.5 KiB
C++

/* Copyright (C) 2016-2019 Free Software Foundation, Inc.
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 TUI_TUI_OUT_H
#define TUI_TUI_OUT_H
#include "cli-out.h"
/* A ui_out class for the TUI. This is just like the CLI's ui_out,
except that it overrides output methods to detect when a source
line is being printed and show the source in the TUI's source
window instead of printing the line in the console window. */
class tui_ui_out : public cli_ui_out
{
public:
explicit tui_ui_out (ui_file *stream);
protected:
void do_field_int (int fldno, int width, ui_align align, const char *fldname,
int value) override;
void do_field_string (int fldno, int width, ui_align align, const char *fldname,
const char *string, ui_out_style_kind style) override;
void do_field_fmt (int fldno, int width, ui_align align, const char *fldname,
const char *format, va_list args) override
ATTRIBUTE_PRINTF (6,0);
void do_text (const char *string) override;
private:
/* These fields are used to make print_source_lines show the source
in the TUI's source window instead of in the console.
M_START_OF_LINE is incremented whenever something is output to
the ui_out. If an integer field named "line" is printed on the
ui_out, and nothing else has been printed yet (both
M_START_OF_LINE and M_LINE are still 0), we assume
print_source_lines is starting to print a source line, and thus
record the line number in M_LINE. Afterwards, when we see a
string field named "fullname" being output, we take the fullname
and the recorded line and show the source line in the TUI's
source window. tui_ui_out::do_text() suppresses text output
until it sees an endline being printed, at which point these
variables are reset back to 0. */
int m_line = 0;
int m_start_of_line = 0;
};
extern tui_ui_out *tui_out_new (struct ui_file *stream);
#endif /* TUI_TUI_OUT_H */