Update copyright year range in all GDB files

[thirdparty/binutils-gdb.git] / gdb / source.h

diff --git a/gdb/source.h b/gdb/source.h
index 44f0a4a7f5f96690f2668c2a61b523d57adc21b1..77fd4cdaba492b5ed60d86a5470455c946137c03 100644 (file)
--- a/gdb/source.h
+++ b/gdb/source.h
@@ -1,5 +1,5 @@
 /* List lines of source files for GDB, the GNU debugger.
-   Copyright (C) 1999, 2007, 2008 Free Software Foundation, Inc.
+   Copyright (C) 1999-2018 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -21,12 +21,40 @@
 
 struct symtab;
 
+/* This function is capable of finding the absolute path to a
+   source file, and opening it, provided you give it a FILENAME.  Both the
+   DIRNAME and FULLNAME are only added suggestions on where to find the file.
+
+   FILENAME should be the filename to open.
+   DIRNAME is the compilation directory of a particular source file.
+          Only some debug formats provide this info.
+   FULLNAME can be the last known absolute path to the file in question.
+     Space for the path must have been malloc'd.  If a path substitution
+     is applied we free the old value and set a new one.
+
+   On Success
+     A valid file descriptor is returned (the return value is positive).
+     FULLNAME is set to the absolute path to the file just opened.
+     The caller is responsible for freeing FULLNAME.
+
+   On Failure
+     An invalid file descriptor is returned (the return value is negative).
+     FULLNAME is set to NULL.  */
+extern int find_and_open_source (const char *filename,
+                                const char *dirname,
+                                char **fullname);
+
 /* Open a source file given a symtab S.  Returns a file descriptor or
    negative number for error.  */
 extern int open_source_file (struct symtab *s);
 
-extern char* psymtab_to_fullname (struct partial_symtab *ps);
-extern char* symtab_to_fullname (struct symtab *s);
+extern gdb::unique_xmalloc_ptr<char> rewrite_source_path (const char *path);
+
+extern const char *symtab_to_fullname (struct symtab *s);
+
+/* Returns filename without the compile directory part, basename or absolute
+   filename.  It depends on 'set filename-display' value.  */
+extern const char *symtab_to_filename_for_display (struct symtab *symtab);
 
 /* Create and initialize the table S->line_charpos that records the
    positions of the lines in the source file, which is assumed to be
@@ -34,19 +62,20 @@ extern char* symtab_to_fullname (struct symtab *s);
    lines.  */
 extern void find_source_lines (struct symtab *s, int desc);
 
-/* Return the first line listed by print_source_lines.
-   Used by command interpreters to request listing from
-   a previous point. */
+/* Return the first line listed by print_source_lines.  Used by
+   command interpreters to request listing from a previous point.  If
+   0, then no source lines have yet been listed since the last time
+   the current source line was changed.  */
 extern int get_first_line_listed (void);
 
 /* Return the default number of lines to print with commands like the
    cli "list".  The caller of print_source_lines must use this to
    calculate the end line and use it in the call to print_source_lines
-   as it does not automatically use this value. */
+   as it does not automatically use this value.  */
 extern int get_lines_to_list (void);
 
 /* Return the current source file for listing and next line to list.
-   NOTE: The returned sal pc and end fields are not valid. */
+   NOTE: The returned sal pc and end fields are not valid.  */
 extern struct symtab_and_line get_current_source_symtab_and_line (void);
 
 /* If the current source file for listing is not set, try and get a default.
@@ -55,15 +84,19 @@ extern struct symtab_and_line get_current_source_symtab_and_line (void);
    We must be cautious about where it is called, as it can recurse as the
    process of determining a new default may call the caller!
    Use get_current_source_symtab_and_line only to get whatever
-   we have without erroring out or trying to get a default. */
+   we have without erroring out or trying to get a default.  */
 extern void set_default_source_symtab_and_line (void);
 
 /* Return the current default file for listing and next line to list
    (the returned sal pc and end fields are not valid.)
    and set the current default to whatever is in SAL.
-   NOTE: The returned sal pc and end fields are not valid. */
-extern struct symtab_and_line set_current_source_symtab_and_line (const struct symtab_and_line *);
+   NOTE: The returned sal pc and end fields are not valid.  */
+extern symtab_and_line set_current_source_symtab_and_line
+  (const symtab_and_line &sal);
 
-/* Reset any information stored about a default file and line to print. */
+/* Reset any information stored about a default file and line to print.  */
 extern void clear_current_source_symtab_and_line (void);
+
+/* Add a source path substitution rule.  */
+extern void add_substitute_path_rule (char *, char *);
 #endif