gdb/source.h

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