New documentation style
[external/binutils.git] / bfd / libcoff.h
1 /* BFD COFF object file private structure.
2    Copyright (C) 1990-1991 Free Software Foundation, Inc.
3    Written by Cygnus Support.
4
5 This file is part of BFD, the Binary File Descriptor library.
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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
20
21
22 /* Object file tdata; access macros */
23
24 #define coff_data(bfd)          ((coff_data_type *) ((bfd)->tdata))
25 #define exec_hdr(bfd)           (coff_data(bfd)->hdr)
26 #define obj_symbols(bfd)        (coff_data(bfd)->symbols)
27 #define obj_sym_filepos(bfd)    (coff_data(bfd)->sym_filepos)
28
29 #define obj_relocbase(bfd)      (coff_data(bfd)->relocbase)
30 #define obj_raw_syments(bfd)    (coff_data(bfd)->raw_syments)
31 #define obj_convert(bfd)        (coff_data(bfd)->conversion_table)
32 #if CFILE_STUFF
33 #define obj_symbol_slew(bfd)    (coff_data(bfd)->symbol_index_slew)
34 #else
35 #define obj_symbol_slew(bfd) 0
36 #endif
37
38 #if 0
39 typedef struct coff_ptr_struct
40 {
41   unsigned int offset;
42   char fix_tag;
43   char fix_end;
44   union {
45     union internal_auxent auxent;
46     struct internal_syment syment;
47   } u;
48 } combined_entry_type;
49
50
51 typedef struct 
52 {
53   asymbol symbol;
54   combined_entry_type *native;
55   struct lineno_cache_entry *lineno;
56 } coff_symbol_type;
57 #endif
58
59 /* `Tdata' information kept for COFF files.  */
60
61 typedef struct coff_tdata
62 {
63   struct   coff_symbol_struct *symbols; /* symtab for input bfd */
64   unsigned int *conversion_table;
65   file_ptr sym_filepos;
66
67   long symbol_index_slew;       /* used during read to mark whether a
68                                    C_FILE symbol as been added. */
69
70   struct coff_ptr_struct *raw_syments;
71   struct lineno *raw_linenos;
72   unsigned int raw_syment_count;
73   unsigned short flags;
74
75   /* These are only valid once writing has begun */
76   long int relocbase;
77
78   /* These members communicate important constants about the symbol table
79      to GDB's symbol-reading code.  These `constants' unfortunately vary
80      from coff implementation to implementation...  */
81   unsigned local_n_btmask;
82   unsigned local_n_btshft;
83   unsigned local_n_tmask;
84   unsigned local_n_tshift;
85   unsigned local_symesz;
86   unsigned local_auxesz;
87   unsigned local_linesz;
88 } coff_data_type;
89
90 /* We take the address of the first element of a asymbol to ensure that the
91  * macro is only ever applied to an asymbol.  */
92 #define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
93
94
95
96 /*THE FOLLOWING IS EXTRACTED FROM THE SOURCE*/
97
98 /*:coffcode.h*/
99 typedef struct coff_ptr_struct 
100 {
101 unsigned int offset;
102 char fix_tag;
103 char fix_end;
104 union {
105    union internal_auxent auxent;
106    struct internal_syment syment;
107  } u;
108 } combined_entry_type;
109 typedef struct coff_symbol_struct
110 {
111 asymbol symbol;
112 combined_entry_type *native;
113 struct lineno_cache_entry *lineno;
114 } coff_symbol_type;
115