gdb/source.h

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