gdb/source.h

   1 /* List lines of source files for GDB, the GNU debugger.
   2    Copyright (C) 1999-2024 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 SOURCE_H
  20 #define SOURCE_H
  21
  22 #include "gdbsupport/scoped_fd.h"
  23
  24 struct symtab;
  25
  26 /* See openp function definition for their description.  */
  27
  28 enum openp_flag
  29 {
  30   OPF_TRY_CWD_FIRST = 0x01,
  31   OPF_SEARCH_IN_PATH = 0x02,
  32   OPF_RETURN_REALPATH = 0x04,
  33 };
  34
  35 DEF_ENUM_FLAGS_TYPE(openp_flag, openp_flags);
  36
  37 extern int openp (const char *, openp_flags, const char *, int,
  38                   gdb::unique_xmalloc_ptr<char> *);
  39
  40 extern int source_full_path_of (const char *, gdb::unique_xmalloc_ptr<char> *);
  41
  42 extern void mod_path (const char *, std::string &);
  43
  44 extern void add_path (const char *, char **, int);
  45 extern void add_path (const char *, std::string &, int);
  46
  47 extern void directory_switch (const char *, int);
  48
  49 extern std::string source_path;
  50
  51 extern void init_source_path (void);
  52
  53 /* This function is capable of finding the absolute path to a
  54    source file, and opening it, provided you give it a FILENAME.  Both the
  55    DIRNAME and FULLNAME are only added suggestions on where to find the file.
  56
  57    FILENAME should be the filename to open.
  58    DIRNAME is the compilation directory of a particular source file.
  59            Only some debug formats provide this info.
  60    FULLNAME can be the last known absolute path to the file in question.
  61      Space for the path must have been malloc'd.  If a path substitution
  62      is applied we free the old value and set a new one.
  63
  64    On Success
  65      A valid file descriptor is returned (the return value is positive).
  66      FULLNAME is set to the absolute path to the file just opened.
  67      The caller is responsible for freeing FULLNAME.
  68
  69    On Failure
  70      An invalid file descriptor is returned.  The value of this file
  71      descriptor is a negative errno indicating the reason for the failure.
  72      FULLNAME is set to NULL.  */
  73 extern scoped_fd find_and_open_source (const char *filename,
  74                                        const char *dirname,
  75                                        gdb::unique_xmalloc_ptr<char> *fullname);
  76
  77 /* A wrapper for find_and_open_source that returns the full name.  If
  78    the full name cannot be found, a full name is constructed based on
  79    the parameters, passing them through rewrite_source_path.  */
  80
  81 extern gdb::unique_xmalloc_ptr<char> find_source_or_rewrite
  82      (const char *filename, const char *dirname);
  83
  84 /* Open a source file given a symtab S.  Returns a file descriptor or
  85    negative errno indicating the reason for the failure.  */
  86 extern scoped_fd open_source_file (struct symtab *s);
  87
  88 extern gdb::unique_xmalloc_ptr<char> rewrite_source_path (const char *path);
  89
  90 extern const char *symtab_to_fullname (struct symtab *s);
  91
  92 /* Returns filename without the compile directory part, basename or absolute
  93    filename.  It depends on 'set filename-display' value.  */
  94 extern const char *symtab_to_filename_for_display (struct symtab *symtab);
  95
  96 /* Return the first line listed by print_source_lines.  Used by
  97    command interpreters to request listing from a previous point.  If
  98    0, then no source lines have yet been listed since the last time
  99    the current source line was changed.  */
 100 extern int get_first_line_listed (void);
 101
 102 /* Return the default number of lines to print with commands like the
 103    cli "list".  The caller of print_source_lines must use this to
 104    calculate the end line and use it in the call to print_source_lines
 105    as it does not automatically use this value.  */
 106 extern int get_lines_to_list (void);
 107
 108 /* Return the current source file for listing and next line to list.
 109    NOTE: The returned sal pc and end fields are not valid.  */
 110 extern struct symtab_and_line get_current_source_symtab_and_line (void);
 111
 112 /* If the current source file for listing is not set, try and get a default.
 113    Usually called before get_current_source_symtab_and_line() is called.
 114    It may err out if a default cannot be determined.
 115    We must be cautious about where it is called, as it can recurse as the
 116    process of determining a new default may call the caller!
 117    Use get_current_source_symtab_and_line only to get whatever
 118    we have without erroring out or trying to get a default.  */
 119 extern void set_default_source_symtab_and_line (void);
 120
 121 /* Return the current default file for listing and next line to list
 122    (the returned sal pc and end fields are not valid.)
 123    and set the current default to whatever is in SAL.
 124    NOTE: The returned sal pc and end fields are not valid.  */
 125 extern symtab_and_line set_current_source_symtab_and_line
 126   (const symtab_and_line &sal);
 127
 128 /* Reset any information stored about a default file and line to print.  */
 129 extern void clear_current_source_symtab_and_line (void);
 130
 131 /* Add a source path substitution rule.  */
 132 extern void add_substitute_path_rule (const char *, const char *);
 133
 134 /* Flags passed as 4th argument to print_source_lines.  */
 135 enum print_source_lines_flag
 136   {
 137     /* Do not print an error message.  */
 138     PRINT_SOURCE_LINES_NOERROR = (1 << 0),
 139
 140     /* Print the filename in front of the source lines.  */
 141     PRINT_SOURCE_LINES_FILENAME = (1 << 1)
 142   };
 143 DEF_ENUM_FLAGS_TYPE (enum print_source_lines_flag, print_source_lines_flags);
 144
 145 /* Show source lines from the file of symtab S, starting with line
 146    number LINE and stopping before line number STOPLINE.  If this is
 147    not the command line version, then the source is shown in the source
 148    window otherwise it is simply printed.  */
 149 extern void print_source_lines (struct symtab *s, int line, int stopline,
 150                                 print_source_lines_flags flags);
 151
 152 /* Wrap up the logic to build a line number range for passing to
 153    print_source_lines when using get_lines_to_list.  An instance of this
 154    class can be built from a single line number and a direction (forward or
 155    backward) the range is then computed using get_lines_to_list.  */
 156 class source_lines_range
 157 {
 158 public:
 159   /* When constructing the range from a single line number, does the line
 160      range extend forward, or backward.  */
 161   enum direction
 162   {
 163    FORWARD,
 164    BACKWARD
 165   };
 166
 167   /* Construct a SOURCE_LINES_RANGE starting at STARTLINE and extending in
 168    direction DIR.  The number of lines is from GET_LINES_TO_LIST.  If the
 169    direction is backward then the start is actually (STARTLINE -
 170    GET_LINES_TO_LIST).  There is also logic in place to ensure the start
 171    is always 1 or more, and the end will be at most INT_MAX.  */
 172   explicit source_lines_range (int startline, direction dir = FORWARD);
 173
 174   /* Construct a SOURCE_LINES_RANGE from STARTLINE to STOPLINE.  */
 175   explicit source_lines_range (int startline, int stopline)
 176     : m_startline (startline),
 177       m_stopline (stopline)
 178   { /* Nothing.  */ }
 179
 180   /* Return the line to start listing from.  */
 181   int startline () const
 182   { return m_startline; }
 183
 184   /* Return the line after the last line that should be listed.  */
 185   int stopline () const
 186   { return m_stopline; }
 187
 188 private:
 189
 190   /* The start and end of the range.  */
 191   int m_startline;
 192   int m_stopline;
 193 };
 194
 195 /* Get the number of the last line in the given symtab.  */
 196 extern int last_symtab_line (struct symtab *s);
 197
 198 /* Check if the line LINE can be found in the symtab S, so that it can be
 199    printed.  */
 200 extern bool can_print_line (struct symtab *s, int line);
 201
 202 /* Variation of previous print_source_lines that takes a range instead of a
 203    start and end line number.  */
 204 extern void print_source_lines (struct symtab *s, source_lines_range r,
 205                                 print_source_lines_flags flags);
 206
 207 /* Forget what we learned about line positions in source files, and
 208    which directories contain them; must check again now since files
 209    may be found in a different directory now.  */
 210 extern void forget_cached_source_info (void);
 211
 212 /* Find a source file default for the "list" command.  This should
 213    only be called when the user actually tries to use the default,
 214    since we produce an error if we can't find a reasonable default.
 215    Also, since this can cause symbols to be read, doing it before we
 216    need to would make things slower than necessary.  */
 217 extern void select_source_symtab ();
 218
 219 #endif