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