gdb/source.h

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