Remove a cleanup from gdbserver
[external/binutils.git] / gdb / annotate.h
1 /* Annotation routines for GDB.
2    Copyright (C) 1986-2018 Free Software Foundation, Inc.
3
4    This file is part of GDB.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 #include "symtab.h"
20 #include "gdbtypes.h"
21
22 extern void annotate_breakpoint (int);
23 extern void annotate_catchpoint (int);
24 extern void annotate_watchpoint (int);
25 extern void annotate_starting (void);
26 extern void annotate_stopped (void);
27 extern void annotate_exited (int);
28 extern void annotate_signalled (void);
29 extern void annotate_signal_name (void);
30 extern void annotate_signal_name_end (void);
31 extern void annotate_signal_string (void);
32 extern void annotate_signal_string_end (void);
33 extern void annotate_signal (void);
34
35 extern void annotate_breakpoints_headers (void);
36 extern void annotate_field (int);
37 extern void annotate_breakpoints_table (void);
38 extern void annotate_record (void);
39 extern void annotate_breakpoints_table_end (void);
40
41 extern void annotate_frames_invalid (void);
42 extern void annotate_new_thread (void);
43 extern void annotate_thread_changed (void);
44
45 extern void annotate_display_prompt (void);
46
47 struct type;
48
49 extern void annotate_field_begin (struct type *);
50 extern void annotate_field_name_end (void);
51 extern void annotate_field_value (void);
52 extern void annotate_field_end (void);
53
54 extern void annotate_quit (void);
55 extern void annotate_error (void);
56 extern void annotate_error_begin (void);
57
58 extern void annotate_value_history_begin (int, struct type *);
59 extern void annotate_value_begin (struct type *);
60 extern void annotate_value_history_value (void);
61 extern void annotate_value_history_end (void);
62 extern void annotate_value_end (void);
63
64 extern void annotate_display_begin (void);
65 extern void annotate_display_number_end (void);
66 extern void annotate_display_format (void);
67 extern void annotate_display_expression (void);
68 extern void annotate_display_expression_end (void);
69 extern void annotate_display_value (void);
70 extern void annotate_display_end (void);
71
72 extern void annotate_arg_begin (void);
73 extern void annotate_arg_name_end (void);
74 extern void annotate_arg_value (struct type *);
75 extern void annotate_arg_end (void);
76
77 /* Wrap calls to annotate_arg_begin and annotate_arg_end in an RAII
78    class. */
79 struct annotate_arg_emitter
80 {
81   annotate_arg_emitter () { annotate_arg_begin (); }
82   ~annotate_arg_emitter () { annotate_arg_end (); }
83
84   DISABLE_COPY_AND_ASSIGN (annotate_arg_emitter);
85 };
86
87 extern void annotate_source (char *, int, int, int,
88                              struct gdbarch *, CORE_ADDR);
89
90 extern void annotate_frame_begin (int, struct gdbarch *, CORE_ADDR);
91 extern void annotate_function_call (void);
92 extern void annotate_signal_handler_caller (void);
93 extern void annotate_frame_address (void);
94 extern void annotate_frame_address_end (void);
95 extern void annotate_frame_function_name (void);
96 extern void annotate_frame_args (void);
97 extern void annotate_frame_source_begin (void);
98 extern void annotate_frame_source_file (void);
99 extern void annotate_frame_source_file_end (void);
100 extern void annotate_frame_source_line (void);
101 extern void annotate_frame_source_end (void);
102 extern void annotate_frame_where (void);
103 extern void annotate_frame_end (void);
104
105 extern void annotate_array_section_begin (int, struct type *);
106 extern void annotate_elt_rep (unsigned int);
107 extern void annotate_elt_rep_end (void);
108 extern void annotate_elt (void);
109 extern void annotate_array_section_end (void);
110
111 extern void (*deprecated_annotate_signalled_hook) (void);
112 extern void (*deprecated_annotate_signal_hook) (void);