* ChangeLog: Fix typos.
[external/binutils.git] / gas / symbols.h
1 /* symbols.h -
2    Copyright 1987, 1990, 1992, 1993, 1994, 1995, 1997, 1999, 2000, 2001,
3    2002, 2003 Free Software Foundation, Inc.
4
5    This file is part of GAS, the GNU Assembler.
6
7    GAS 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, or (at your option)
10    any later version.
11
12    GAS 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 GAS; see the file COPYING.  If not, write to the Free
19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifdef BFD_ASSEMBLER
23 /* The BFD code wants to walk the list in both directions.  */
24 #undef  SYMBOLS_NEED_BACKPOINTERS
25 #define SYMBOLS_NEED_BACKPOINTERS
26 #endif
27
28 #ifndef BFD_ASSEMBLER
29 /* The non-BFD code expects to be able to manipulate the symbol fields
30    directly.  */
31 #include "struc-symbol.h"
32 #endif
33
34 extern struct obstack notes;    /* eg FixS live here.  */
35
36 extern struct obstack cond_obstack;     /* this is where we track .ifdef/.endif
37                                        (if we do that at all).  */
38
39 extern symbolS *symbol_rootP;   /* all the symbol nodes */
40 extern symbolS *symbol_lastP;   /* last struct symbol we made, or NULL */
41
42 extern symbolS abs_symbol;
43
44 extern int symbol_table_frozen;
45
46 /* This is non-zero if symbols are case sensitive, which is the
47    default.  */
48 extern int symbols_case_sensitive;
49
50 char *decode_local_label_name PARAMS ((char *s));
51 symbolS *symbol_find PARAMS ((const char *name));
52 symbolS *symbol_find_exact PARAMS ((const char *name));
53 symbolS *symbol_find_base PARAMS ((const char *name, int strip_underscore));
54 symbolS *symbol_find_or_make PARAMS ((const char *name));
55 symbolS *symbol_make PARAMS ((const char *name));
56 symbolS *symbol_new PARAMS ((const char *name, segT segment, valueT value,
57                              fragS * frag));
58 symbolS *symbol_create PARAMS ((const char *name, segT segment, valueT value,
59                                 fragS * frag));
60 struct local_symbol *local_symbol_make PARAMS ((const char *name, segT section, 
61                                          valueT value, fragS * frag));
62 symbolS *symbol_temp_new PARAMS ((segT, valueT, fragS *));
63 symbolS *symbol_temp_new_now PARAMS ((void));
64 symbolS *symbol_temp_make PARAMS ((void));
65
66 symbolS *colon PARAMS ((const char *sym_name));
67 void local_colon PARAMS ((int n));
68 void symbol_begin PARAMS ((void));
69 void symbol_print_statistics PARAMS ((FILE *));
70 void symbol_table_insert PARAMS ((symbolS * symbolP));
71 valueT resolve_symbol_value PARAMS ((symbolS *));
72 void resolve_local_symbol_values PARAMS ((void));
73
74 void print_symbol_value PARAMS ((symbolS *));
75 void print_expr PARAMS ((expressionS *));
76 void print_expr_1 PARAMS ((FILE *, expressionS *));
77 void print_symbol_value_1 PARAMS ((FILE *, symbolS *));
78
79 int dollar_label_defined PARAMS ((long l));
80 void dollar_label_clear PARAMS ((void));
81 void define_dollar_label PARAMS ((long l));
82 char *dollar_label_name PARAMS ((long l, int augend));
83
84 void fb_label_instance_inc PARAMS ((long label));
85 char *fb_label_name PARAMS ((long n, long augend));
86
87 extern void copy_symbol_attributes PARAMS ((symbolS *, symbolS *));
88
89 /* Get and set the values of symbols.  These used to be macros.  */
90 extern valueT S_GET_VALUE PARAMS ((symbolS *));
91 extern void S_SET_VALUE PARAMS ((symbolS *, valueT));
92
93 #ifdef BFD_ASSEMBLER
94 extern int S_IS_FUNCTION PARAMS ((symbolS *));
95 extern int S_IS_EXTERNAL PARAMS ((symbolS *));
96 extern int S_IS_WEAK PARAMS ((symbolS *));
97 extern int S_IS_COMMON PARAMS ((symbolS *));
98 extern int S_IS_DEFINED PARAMS ((symbolS *));
99 extern int S_FORCE_RELOC PARAMS ((symbolS *, int));
100 extern int S_IS_DEBUG PARAMS ((symbolS *));
101 extern int S_IS_LOCAL PARAMS ((symbolS *));
102 extern int S_IS_EXTERN PARAMS ((symbolS *));
103 extern int S_IS_STABD PARAMS ((symbolS *));
104 extern const char *S_GET_NAME PARAMS ((symbolS *));
105 extern segT S_GET_SEGMENT PARAMS ((symbolS *));
106 extern void S_SET_SEGMENT PARAMS ((symbolS *, segT));
107 extern void S_SET_EXTERNAL PARAMS ((symbolS *));
108 extern void S_SET_NAME PARAMS ((symbolS *, char *));
109 extern void S_CLEAR_EXTERNAL PARAMS ((symbolS *));
110 extern void S_SET_WEAK PARAMS ((symbolS *));
111 extern void S_SET_THREAD_LOCAL PARAMS ((symbolS *));
112 #endif
113
114 #ifndef WORKING_DOT_WORD
115 struct broken_word
116   {
117     /* Linked list -- one of these structures per ".word x-y+C"
118        expression.  */
119     struct broken_word *next_broken_word;
120     /* Segment and subsegment for broken word.  */
121     segT seg;
122     subsegT subseg;
123     /* Which frag is this broken word in?  */
124     fragS *frag;
125     /* Where in the frag is it?  */
126     char *word_goes_here;
127     /* Where to add the break.  */
128     fragS *dispfrag;            /* where to add the break */
129     /* Operands of expression.  */
130     symbolS *add;
131     symbolS *sub;
132     offsetT addnum;
133
134     int added;                  /* nasty thing happened yet? */
135     /* 1: added and has a long-jump */
136     /* 2: added but uses someone elses long-jump */
137
138     /* Pointer to broken_word with a similar long-jump.  */
139     struct broken_word *use_jump;
140   };
141 extern struct broken_word *broken_words;
142 #endif /* ndef WORKING_DOT_WORD */
143
144 /*
145  * Current means for getting from symbols to segments and vice verse.
146  * This will change for infinite-segments support (e.g. COFF).
147  */
148 extern const segT N_TYPE_seg[]; /* subseg.c */
149
150 #define SEGMENT_TO_SYMBOL_TYPE(seg)  ( seg_N_TYPE [(int) (seg)] )
151 extern const short seg_N_TYPE[];/* subseg.c */
152
153 #define N_REGISTER      30      /* Fake N_TYPE value for SEG_REGISTER */
154
155 void symbol_clear_list_pointers PARAMS ((symbolS * symbolP));
156
157 #ifdef SYMBOLS_NEED_BACKPOINTERS
158
159 void symbol_insert PARAMS ((symbolS * addme, symbolS * target,
160                             symbolS ** rootP, symbolS ** lastP));
161 void symbol_remove PARAMS ((symbolS * symbolP, symbolS ** rootP,
162                             symbolS ** lastP));
163
164 extern symbolS *symbol_previous PARAMS ((symbolS *));
165
166 #endif /* SYMBOLS_NEED_BACKPOINTERS */
167
168 void verify_symbol_chain PARAMS ((symbolS * rootP, symbolS * lastP));
169 void verify_symbol_chain_2 PARAMS ((symbolS * symP));
170
171 void symbol_append PARAMS ((symbolS * addme, symbolS * target,
172                             symbolS ** rootP, symbolS ** lastP));
173
174 extern symbolS *symbol_next PARAMS ((symbolS *));
175
176 extern expressionS *symbol_get_value_expression PARAMS ((symbolS *));
177 extern void symbol_set_value_expression PARAMS ((symbolS *,
178                                                  const expressionS *));
179 extern void symbol_set_value_now PARAMS ((symbolS *));
180 extern void symbol_set_frag PARAMS ((symbolS *, fragS *));
181 extern fragS *symbol_get_frag PARAMS ((symbolS *));
182 extern void symbol_mark_used PARAMS ((symbolS *));
183 extern void symbol_clear_used PARAMS ((symbolS *));
184 extern int symbol_used_p PARAMS ((symbolS *));
185 extern void symbol_mark_used_in_reloc PARAMS ((symbolS *));
186 extern void symbol_clear_used_in_reloc PARAMS ((symbolS *));
187 extern int symbol_used_in_reloc_p PARAMS ((symbolS *));
188 extern void symbol_mark_mri_common PARAMS ((symbolS *));
189 extern void symbol_clear_mri_common PARAMS ((symbolS *));
190 extern int symbol_mri_common_p PARAMS ((symbolS *));
191 extern void symbol_mark_written PARAMS ((symbolS *));
192 extern void symbol_clear_written PARAMS ((symbolS *));
193 extern int symbol_written_p PARAMS ((symbolS *));
194 extern void symbol_mark_resolved PARAMS ((symbolS *));
195 extern int symbol_resolved_p PARAMS ((symbolS *));
196 extern int symbol_section_p PARAMS ((symbolS *));
197 extern int symbol_equated_p PARAMS ((symbolS *));
198 extern int symbol_equated_reloc_p PARAMS ((symbolS *));
199 extern int symbol_constant_p PARAMS ((symbolS *));
200
201 #ifdef BFD_ASSEMBLER
202 extern asymbol *symbol_get_bfdsym PARAMS ((symbolS *));
203 extern void symbol_set_bfdsym PARAMS ((symbolS *, asymbol *));
204 #endif
205
206 #ifdef OBJ_SYMFIELD_TYPE
207 OBJ_SYMFIELD_TYPE *symbol_get_obj PARAMS ((symbolS *));
208 void symbol_set_obj PARAMS ((symbolS *, OBJ_SYMFIELD_TYPE *));
209 #endif
210
211 #ifdef TC_SYMFIELD_TYPE
212 TC_SYMFIELD_TYPE *symbol_get_tc PARAMS ((symbolS *));
213 void symbol_set_tc PARAMS ((symbolS *, TC_SYMFIELD_TYPE *));
214 #endif