Commit | Line | Data |
---|---|---|
c2c6d25f | 1 | /* List lines of source files for GDB, the GNU debugger. |
e2882c85 | 2 | Copyright (C) 1999-2018 Free Software Foundation, Inc. |
c2c6d25f JM |
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 | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
c2c6d25f JM |
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 | |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c2c6d25f JM |
18 | |
19 | #ifndef SOURCE_H | |
20 | #define SOURCE_H | |
21 | ||
da3331ec AC |
22 | struct symtab; |
23 | ||
b46a8d7c TT |
24 | /* See openp function definition for their description. */ |
25 | ||
26 | enum openp_flag | |
27 | { | |
28 | OPF_TRY_CWD_FIRST = 0x01, | |
29 | OPF_SEARCH_IN_PATH = 0x02, | |
30 | OPF_RETURN_REALPATH = 0x04, | |
31 | }; | |
32 | ||
33 | DEF_ENUM_FLAGS_TYPE(openp_flag, openp_flags); | |
34 | ||
e0cc99a6 TT |
35 | extern int openp (const char *, openp_flags, const char *, int, |
36 | gdb::unique_xmalloc_ptr<char> *); | |
b46a8d7c | 37 | |
e0cc99a6 | 38 | extern int source_full_path_of (const char *, gdb::unique_xmalloc_ptr<char> *); |
b46a8d7c TT |
39 | |
40 | extern void mod_path (const char *, char **); | |
41 | ||
42 | extern void add_path (const char *, char **, int); | |
43 | ||
44 | extern void directory_switch (const char *, int); | |
45 | ||
46 | extern char *source_path; | |
47 | ||
48 | extern void init_source_path (void); | |
49 | ||
9340a6c0 PA |
50 | /* This function is capable of finding the absolute path to a |
51 | source file, and opening it, provided you give it a FILENAME. Both the | |
52 | DIRNAME and FULLNAME are only added suggestions on where to find the file. | |
53 | ||
54 | FILENAME should be the filename to open. | |
55 | DIRNAME is the compilation directory of a particular source file. | |
56 | Only some debug formats provide this info. | |
57 | FULLNAME can be the last known absolute path to the file in question. | |
58 | Space for the path must have been malloc'd. If a path substitution | |
59 | is applied we free the old value and set a new one. | |
60 | ||
61 | On Success | |
62 | A valid file descriptor is returned (the return value is positive). | |
63 | FULLNAME is set to the absolute path to the file just opened. | |
64 | The caller is responsible for freeing FULLNAME. | |
65 | ||
66 | On Failure | |
67 | An invalid file descriptor is returned (the return value is negative). | |
68 | FULLNAME is set to NULL. */ | |
69 | extern int find_and_open_source (const char *filename, | |
70 | const char *dirname, | |
e0cc99a6 | 71 | gdb::unique_xmalloc_ptr<char> *fullname); |
9340a6c0 | 72 | |
c2c6d25f JM |
73 | /* Open a source file given a symtab S. Returns a file descriptor or |
74 | negative number for error. */ | |
75 | extern int open_source_file (struct symtab *s); | |
76 | ||
0b581c69 | 77 | extern gdb::unique_xmalloc_ptr<char> rewrite_source_path (const char *path); |
fbd9ab74 | 78 | |
0b0865da | 79 | extern const char *symtab_to_fullname (struct symtab *s); |
57c22c6c | 80 | |
1b56eb55 JK |
81 | /* Returns filename without the compile directory part, basename or absolute |
82 | filename. It depends on 'set filename-display' value. */ | |
83 | extern const char *symtab_to_filename_for_display (struct symtab *symtab); | |
84 | ||
c2c6d25f JM |
85 | /* Create and initialize the table S->line_charpos that records the |
86 | positions of the lines in the source file, which is assumed to be | |
87 | open on descriptor DESC. All set S->nlines to the number of such | |
88 | lines. */ | |
89 | extern void find_source_lines (struct symtab *s, int desc); | |
90 | ||
5166082f PA |
91 | /* Return the first line listed by print_source_lines. Used by |
92 | command interpreters to request listing from a previous point. If | |
93 | 0, then no source lines have yet been listed since the last time | |
94 | the current source line was changed. */ | |
0378c332 FN |
95 | extern int get_first_line_listed (void); |
96 | ||
97 | /* Return the default number of lines to print with commands like the | |
98 | cli "list". The caller of print_source_lines must use this to | |
99 | calculate the end line and use it in the call to print_source_lines | |
c378eb4e | 100 | as it does not automatically use this value. */ |
0378c332 FN |
101 | extern int get_lines_to_list (void); |
102 | ||
103 | /* Return the current source file for listing and next line to list. | |
c378eb4e | 104 | NOTE: The returned sal pc and end fields are not valid. */ |
53cb0458 | 105 | extern struct symtab_and_line get_current_source_symtab_and_line (void); |
0378c332 | 106 | |
53cb0458 FN |
107 | /* If the current source file for listing is not set, try and get a default. |
108 | Usually called before get_current_source_symtab_and_line() is called. | |
0378c332 | 109 | It may err out if a default cannot be determined. |
53cb0458 FN |
110 | We must be cautious about where it is called, as it can recurse as the |
111 | process of determining a new default may call the caller! | |
112 | Use get_current_source_symtab_and_line only to get whatever | |
c378eb4e | 113 | we have without erroring out or trying to get a default. */ |
53cb0458 | 114 | extern void set_default_source_symtab_and_line (void); |
0378c332 FN |
115 | |
116 | /* Return the current default file for listing and next line to list | |
117 | (the returned sal pc and end fields are not valid.) | |
53cb0458 | 118 | and set the current default to whatever is in SAL. |
c378eb4e | 119 | NOTE: The returned sal pc and end fields are not valid. */ |
51abb421 PA |
120 | extern symtab_and_line set_current_source_symtab_and_line |
121 | (const symtab_and_line &sal); | |
0378c332 | 122 | |
c378eb4e | 123 | /* Reset any information stored about a default file and line to print. */ |
53cb0458 | 124 | extern void clear_current_source_symtab_and_line (void); |
29b0e8a2 JM |
125 | |
126 | /* Add a source path substitution rule. */ | |
127 | extern void add_substitute_path_rule (char *, char *); | |
c2c6d25f | 128 | #endif |