1999-09-22 05:28:34 +02:00
|
|
|
/* List lines of source files for GDB, the GNU debugger.
|
2012-01-04 09:17:56 +01:00
|
|
|
Copyright (C) 1999, 2007-2012 Free Software Foundation, Inc.
|
1999-09-22 05:28:34 +02:00
|
|
|
|
|
|
|
This file is part of GDB.
|
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
2007-08-23 20:08:50 +02:00
|
|
|
the Free Software Foundation; either version 3 of the License, or
|
1999-09-22 05:28:34 +02:00
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
2007-08-23 20:08:50 +02:00
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
1999-09-22 05:28:34 +02:00
|
|
|
|
|
|
|
#ifndef SOURCE_H
|
|
|
|
#define SOURCE_H
|
|
|
|
|
2003-04-12 Andrew Cagney <cagney@redhat.com>
* gdbarch.sh: Add missing opaque declarations.
* gdbarch.h: Regnerate.
* symtab.h: Add missing opaque declarations.
* value.h, target.h, symfile.h, stabsread.h: Ditto.
* x86-64-tdep.h, xmodem.h, monitor.h, typeprint.h: Ditto.
* srec.h, solib-svr4.h, source.h, inferior.h: Ditto.
* ser-unix.h, serial.h, remote-utils.h, gdbcore.h: Ditto.
* ppc-tdep.h, ocd.h, mips-tdep.h, gdbtypes.h: Ditto.
* buildsym.h, builtin-regs.h, linespec.h, language.h: Ditto.
* i387-tdep.h, gdbthread.h, event-top.h, gdb.h: Ditto.
* dwarf2cfi.h, doublest.h, disasm.h, cp-abi.h: Ditto.
* cli-out.h, c-lang.h, ax-gdb.h, arch-utils.h: Ditto.
* ada-lang.h, config/nm-lynx.h, config/nm-linux.h: Ditto.
* config/sparc/tm-sp64.h, config/rs6000/tm-rs6000.h: Ditto.
* config/pa/tm-hppah.h, config/m68k/tm-delta68.h: Ditto.
* cli/cli-setshow.h, cli/cli-script.h: Ditto.
2003-04-12 19:41:26 +02:00
|
|
|
struct symtab;
|
|
|
|
|
2012-03-01 22:09:16 +01:00
|
|
|
/* 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);
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* 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);
|
|
|
|
|
2004-06-10 22:05:45 +02:00
|
|
|
extern char* symtab_to_fullname (struct symtab *s);
|
|
|
|
|
1999-09-22 05:28:34 +02:00
|
|
|
/* Create and initialize the table S->line_charpos that records the
|
|
|
|
positions of the lines in the source file, which is assumed to be
|
|
|
|
open on descriptor DESC. All set S->nlines to the number of such
|
|
|
|
lines. */
|
|
|
|
extern void find_source_lines (struct symtab *s, int desc);
|
|
|
|
|
2002-09-20 16:58:59 +02:00
|
|
|
/* Return the first line listed by print_source_lines.
|
|
|
|
Used by command interpreters to request listing from
|
2011-01-11 22:53:25 +01:00
|
|
|
a previous point. */
|
2002-09-20 16:58:59 +02:00
|
|
|
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
|
2011-01-11 22:53:25 +01:00
|
|
|
as it does not automatically use this value. */
|
2002-09-20 16:58:59 +02:00
|
|
|
extern int get_lines_to_list (void);
|
|
|
|
|
|
|
|
/* Return the current source file for listing and next line to list.
|
2011-01-11 22:53:25 +01:00
|
|
|
NOTE: The returned sal pc and end fields are not valid. */
|
2002-09-23 00:18:41 +02:00
|
|
|
extern struct symtab_and_line get_current_source_symtab_and_line (void);
|
2002-09-20 16:58:59 +02:00
|
|
|
|
2002-09-23 00:18:41 +02:00
|
|
|
/* If the current source file for listing is not set, try and get a default.
|
|
|
|
Usually called before get_current_source_symtab_and_line() is called.
|
2002-09-20 16:58:59 +02:00
|
|
|
It may err out if a default cannot be determined.
|
2002-09-23 00:18:41 +02:00
|
|
|
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
|
2011-01-11 22:53:25 +01:00
|
|
|
we have without erroring out or trying to get a default. */
|
2002-09-23 00:18:41 +02:00
|
|
|
extern void set_default_source_symtab_and_line (void);
|
2002-09-20 16:58:59 +02:00
|
|
|
|
|
|
|
/* Return the current default file for listing and next line to list
|
|
|
|
(the returned sal pc and end fields are not valid.)
|
2002-09-23 00:18:41 +02:00
|
|
|
and set the current default to whatever is in SAL.
|
2011-01-11 22:53:25 +01:00
|
|
|
NOTE: The returned sal pc and end fields are not valid. */
|
2002-09-23 00:18:41 +02:00
|
|
|
extern struct symtab_and_line set_current_source_symtab_and_line (const struct symtab_and_line *);
|
2002-09-20 16:58:59 +02:00
|
|
|
|
2011-01-11 22:53:25 +01:00
|
|
|
/* Reset any information stored about a default file and line to print. */
|
2002-09-23 00:18:41 +02:00
|
|
|
extern void clear_current_source_symtab_and_line (void);
|
2009-04-21 12:13:05 +02:00
|
|
|
|
|
|
|
/* Add a source path substitution rule. */
|
|
|
|
extern void add_substitute_path_rule (char *, char *);
|
1999-09-22 05:28:34 +02:00
|
|
|
#endif
|