Format gdb-gdb.py.in with autopep8
[external/binutils.git] / gdb / gdb-stabs.h
1 /* Definitions for symbol-reading containing "stabs", for GDB.
2    Copyright (C) 1992-2018 Free Software Foundation, Inc.
3    Contributed by Cygnus Support.  Written by John Gilmore.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 /* This file exists to hold the common definitions required of most of
21    the symbol-readers that end up using stabs.  The common use of
22    these `symbol-type-specific' customizations of the generic data
23    structures makes the stabs-oriented symbol readers able to call
24    each others' functions as required.  */
25
26 #if !defined (GDBSTABS_H)
27 #define GDBSTABS_H
28
29 /* The tag used to find the DBX info attached to an objfile.  This is
30    global because it is referenced by several modules.  */
31 extern const struct objfile_data *dbx_objfile_data_key;
32
33 /* Information is passed among various dbxread routines for accessing
34    symbol files.  A pointer to this structure is kept in the objfile,
35    using the dbx_objfile_data_key.  */
36
37 struct dbx_symfile_info
38   {
39     CORE_ADDR text_addr;        /* Start of text section */
40     int text_size;              /* Size of text section */
41     int symcount;               /* How many symbols are there in the file */
42     char *stringtab;            /* The actual string table */
43     int stringtab_size;         /* Its size */
44     file_ptr symtab_offset;     /* Offset in file to symbol table */
45     int symbol_size;            /* Bytes in a single symbol */
46
47     /* See stabsread.h for the use of the following.  */
48     struct header_file *header_files;
49     int n_header_files;
50     int n_allocated_header_files;
51
52     /* Pointers to BFD sections.  These are used to speed up the building of
53        minimal symbols.  */
54     asection *text_section;
55     asection *data_section;
56     asection *bss_section;
57
58     /* Pointer to the separate ".stab" section, if there is one.  */
59     asection *stab_section;
60   };
61
62 #define DBX_SYMFILE_INFO(o) \
63   ((struct dbx_symfile_info *) objfile_data ((o), dbx_objfile_data_key))
64 #define DBX_TEXT_ADDR(o)        (DBX_SYMFILE_INFO(o)->text_addr)
65 #define DBX_TEXT_SIZE(o)        (DBX_SYMFILE_INFO(o)->text_size)
66 #define DBX_SYMCOUNT(o)         (DBX_SYMFILE_INFO(o)->symcount)
67 #define DBX_STRINGTAB(o)        (DBX_SYMFILE_INFO(o)->stringtab)
68 #define DBX_STRINGTAB_SIZE(o)   (DBX_SYMFILE_INFO(o)->stringtab_size)
69 #define DBX_SYMTAB_OFFSET(o)    (DBX_SYMFILE_INFO(o)->symtab_offset)
70 #define DBX_SYMBOL_SIZE(o)      (DBX_SYMFILE_INFO(o)->symbol_size)
71 #define DBX_TEXT_SECTION(o)     (DBX_SYMFILE_INFO(o)->text_section)
72 #define DBX_DATA_SECTION(o)     (DBX_SYMFILE_INFO(o)->data_section)
73 #define DBX_BSS_SECTION(o)      (DBX_SYMFILE_INFO(o)->bss_section)
74 #define DBX_STAB_SECTION(o)     (DBX_SYMFILE_INFO(o)->stab_section)
75
76 #endif /* GDBSTABS_H */