gdb/source.h

   1 /* List lines of source files for GDB, the GNU debugger.
   2    Copyright 1999 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 2 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, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef SOURCE_H
  22 #define SOURCE_H
  23
  24 /* Open a source file given a symtab S.  Returns a file descriptor or
  25    negative number for error.  */
  26 extern int open_source_file (struct symtab *s);
  27
  28 /* Create and initialize the table S->line_charpos that records the
  29    positions of the lines in the source file, which is assumed to be
  30    open on descriptor DESC.  All set S->nlines to the number of such
  31    lines.  */
  32 extern void find_source_lines (struct symtab *s, int desc);
  33
  34 /* Return the first line listed by print_source_lines.
  35    Used by command interpreters to request listing from
  36    a previous point. */
  37 extern int get_first_line_listed (void);
  38
  39 /* Return the default number of lines to print with commands like the
  40    cli "list".  The caller of print_source_lines must use this to
  41    calculate the end line and use it in the call to print_source_lines
  42    as it does not automatically use this value. */
  43 extern int get_lines_to_list (void);
  44
  45 /* Return the current source file for listing and next line to list.
  46    NOTE: The returned sal pc and end fields are not valid. */
  47 extern void clear_current_source_symtab_and_line (void);
  48
  49 /* Return the current source file for listing and next line to list.
  50    If a file is not set, try and get a default.
  51    It may err out if a default cannot be determined.
  52    Depending on where it is called, it can recurse as the process of
  53    determining a new default may call the caler!
  54    Use get_current_source_symtab_and_line instead to get whatever
  55    we have without erroring out or trying to get a default.
  56    NOTE: The returned sal pc and end fields are not valid. */
  57 extern struct symtab_and_line get_current_source_symtab_and_line (void);
  58
  59 /* Return the current default file for listing and next line to list
  60    (the returned sal pc and end fields are not valid.)
  61    and set the surrent default to whatever is in SAL */
  62 extern struct symtab_and_line get_current_or_default_source_symtab_and_line (void);
  63
  64 /* Reset any information stored about a default file and line to print. */
  65 extern struct symtab_and_line set_current_source_symtab_and_line (struct symtab_and_line *);
  66 #endif