GDB (xrefs)
Loading...
Searching...
No Matches
annotate.h
Go to the documentation of this file.
1/* Annotation routines for GDB.
2 Copyright (C) 1986-2023 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#ifndef ANNOTATE_H
20#define ANNOTATE_H
21
22#include "symtab.h"
23#include "gdbtypes.h"
24
25extern void annotate_breakpoint (int);
26extern void annotate_catchpoint (int);
27extern void annotate_watchpoint (int);
28extern void annotate_starting (void);
29extern void annotate_stopped (void);
30extern void annotate_exited (int);
31extern void annotate_signalled (void);
32extern void annotate_signal_name (void);
33extern void annotate_signal_name_end (void);
34extern void annotate_signal_string (void);
35extern void annotate_signal_string_end (void);
36extern void annotate_signal (void);
37
38extern void annotate_breakpoints_headers (void);
39extern void annotate_field (int);
40extern void annotate_breakpoints_table (void);
41extern void annotate_record (void);
42extern void annotate_breakpoints_table_end (void);
43
44extern void annotate_frames_invalid (void);
45extern void annotate_new_thread (void);
46extern void annotate_thread_changed (void);
47
48extern void annotate_display_prompt (void);
49
50struct type;
51
52extern void annotate_field_begin (struct type *);
53extern void annotate_field_name_end (void);
54extern void annotate_field_value (void);
55extern void annotate_field_end (void);
56
57extern void annotate_quit (void);
58extern void annotate_error (void);
59extern void annotate_error_begin (void);
60
61extern void annotate_value_history_begin (int, struct type *);
62extern void annotate_value_begin (struct type *);
63extern void annotate_value_history_value (void);
64extern void annotate_value_history_end (void);
65extern void annotate_value_end (void);
66
67extern void annotate_display_begin (void);
68extern void annotate_display_number_end (void);
69extern void annotate_display_format (void);
70extern void annotate_display_expression (void);
71extern void annotate_display_expression_end (void);
72extern void annotate_display_value (void);
73extern void annotate_display_end (void);
74
75extern void annotate_arg_begin (void);
76extern void annotate_arg_name_end (void);
77extern void annotate_arg_value (struct type *);
78extern void annotate_arg_end (void);
79
80/* Wrap calls to annotate_arg_begin and annotate_arg_end in an RAII
81 class. */
83{
86
88};
89
90/* If annotations are turned on then print annotation describing the full
91 name of the source file S and the line number LINE and its corresponding
92 character position.
93
94 MID_STATEMENT is nonzero if the PC is not at the beginning of that
95 line.
96
97 The current symtab and line is updated to reflect S and LINE.
98
99 Return true if the annotation was printed and the current symtab and
100 line were updated, otherwise return false, which can happen if the
101 source file for S can't be found, or LINE is out of range.
102
103 This does leave GDB in the weird situation where, even when annotations
104 are on, we only sometimes print the annotation, and only sometimes
105 update the current symtab and line. However, this particular annotation
106 has behaved this way for some time, and front ends that still use
107 annotations now depend on this behaviour. */
108extern bool annotate_source_line (struct symtab *s, int line,
109 int mid_statement, CORE_ADDR pc);
110
111extern void annotate_frame_begin (int, struct gdbarch *, CORE_ADDR);
112extern void annotate_function_call (void);
113extern void annotate_signal_handler_caller (void);
114extern void annotate_frame_address (void);
115extern void annotate_frame_address_end (void);
116extern void annotate_frame_function_name (void);
117extern void annotate_frame_args (void);
118extern void annotate_frame_source_begin (void);
119extern void annotate_frame_source_file (void);
120extern void annotate_frame_source_file_end (void);
121extern void annotate_frame_source_line (void);
122extern void annotate_frame_source_end (void);
123extern void annotate_frame_where (void);
124extern void annotate_frame_end (void);
125
126extern void annotate_array_section_begin (int, struct type *);
127extern void annotate_elt_rep (unsigned int);
128extern void annotate_elt_rep_end (void);
129extern void annotate_elt (void);
130extern void annotate_array_section_end (void);
131
132extern void (*deprecated_annotate_signalled_hook) (void);
133extern void (*deprecated_annotate_signal_hook) (void);
134
135#endif /* ANNOTATE_H */
void annotate_display_number_end(void)
Definition annotate.c:350
void annotate_error_begin(void)
Definition annotate.c:293
void annotate_frame_source_file_end(void)
Definition annotate.c:533
void annotate_record(void)
Definition annotate.c:187
void annotate_function_call(void)
Definition annotate.c:477
void annotate_display_expression(void)
Definition annotate.c:364
void annotate_starting(void)
Definition annotate.c:97
void annotate_frame_function_name(void)
Definition annotate.c:505
void annotate_field_value(void)
Definition annotate.c:265
void annotate_frames_invalid(void)
Definition annotate.c:201
void annotate_quit(void)
Definition annotate.c:279
void annotate_frame_end(void)
Definition annotate.c:561
void annotate_array_section_begin(int, struct type *)
Definition annotate.c:568
void annotate_field_name_end(void)
Definition annotate.c:258
void annotate_elt_rep_end(void)
Definition annotate.c:586
void annotate_breakpoints_table(void)
Definition annotate.c:180
void annotate_arg_end(void)
Definition annotate.c:417
void annotate_frame_address_end(void)
Definition annotate.c:498
void annotate_value_end(void)
Definition annotate.c:336
bool annotate_source_line(struct symtab *s, int line, int mid_statement, CORE_ADDR pc)
Definition annotate.c:439
void annotate_arg_begin(void)
Definition annotate.c:392
void annotate_elt(void)
Definition annotate.c:593
void annotate_catchpoint(int)
Definition annotate.c:83
void annotate_field(int)
Definition annotate.c:173
void annotate_exited(int)
Definition annotate.c:111
void annotate_signalled(void)
Definition annotate.c:118
void annotate_frame_address(void)
Definition annotate.c:491
void annotate_frame_source_file(void)
Definition annotate.c:526
void annotate_display_end(void)
Definition annotate.c:385
void annotate_arg_name_end(void)
Definition annotate.c:399
void annotate_watchpoint(int)
Definition annotate.c:90
void annotate_value_history_begin(int, struct type *)
Definition annotate.c:300
void(* deprecated_annotate_signalled_hook)(void)
Definition annotate.c:41
void annotate_signal_string(void)
Definition annotate.c:142
void annotate_signal(void)
Definition annotate.c:156
void annotate_signal_string_end(void)
Definition annotate.c:149
void annotate_frame_source_line(void)
Definition annotate.c:540
void annotate_frame_where(void)
Definition annotate.c:554
void annotate_breakpoint(int)
Definition annotate.c:76
void annotate_arg_value(struct type *)
Definition annotate.c:406
void annotate_breakpoints_headers(void)
Definition annotate.c:166
void annotate_value_begin(struct type *)
Definition annotate.c:311
void annotate_frame_source_begin(void)
Definition annotate.c:519
void annotate_frame_source_end(void)
Definition annotate.c:547
void annotate_array_section_end(void)
Definition annotate.c:600
void annotate_new_thread(void)
Definition annotate.c:216
void annotate_error(void)
Definition annotate.c:286
void annotate_signal_handler_caller(void)
Definition annotate.c:484
void annotate_signal_name(void)
Definition annotate.c:128
void annotate_frame_begin(int, struct gdbarch *, CORE_ADDR)
Definition annotate.c:469
void annotate_display_value(void)
Definition annotate.c:378
void annotate_display_begin(void)
Definition annotate.c:343
void annotate_display_format(void)
Definition annotate.c:357
void(* deprecated_annotate_signal_hook)(void)
Definition annotate.c:42
void annotate_signal_name_end(void)
Definition annotate.c:135
void annotate_field_end(void)
Definition annotate.c:272
void annotate_stopped(void)
Definition annotate.c:104
void annotate_field_begin(struct type *)
Definition annotate.c:247
void annotate_display_prompt(void)
Definition annotate.c:611
void annotate_value_history_end(void)
Definition annotate.c:329
void annotate_display_expression_end(void)
Definition annotate.c:371
void annotate_value_history_value(void)
Definition annotate.c:322
void annotate_elt_rep(unsigned int)
Definition annotate.c:579
void annotate_frame_args(void)
Definition annotate.c:512
void annotate_thread_changed(void)
Definition annotate.c:225
void annotate_breakpoints_table_end(void)
Definition annotate.c:194
DISABLE_COPY_AND_ASSIGN(annotate_arg_emitter)