Commit | Line | Data |
---|---|---|
252b5132 | 1 | /* input_scrub.c - Break up input buffers into whole numbers of lines. |
e13b337a | 2 | Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 2000 |
252b5132 RH |
3 | 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 | |
e13b337a | 20 | 02111-1307, USA. */ |
252b5132 RH |
21 | |
22 | #include <errno.h> /* Need this to make errno declaration right */ | |
23 | #include "as.h" | |
24 | #include "input-file.h" | |
25 | #include "sb.h" | |
26 | #include "listing.h" | |
27 | ||
28 | /* | |
29 | * O/S independent module to supply buffers of sanitised source code | |
30 | * to rest of assembler. We get sanitised input data of arbitrary length. | |
31 | * We break these buffers on line boundaries, recombine pieces that | |
32 | * were broken across buffers, and return a buffer of full lines to | |
33 | * the caller. | |
34 | * The last partial line begins the next buffer we build and return to caller. | |
35 | * The buffer returned to caller is preceeded by BEFORE_STRING and followed | |
36 | * by AFTER_STRING, as sentinels. The last character before AFTER_STRING | |
37 | * is a newline. | |
38 | * Also looks after line numbers, for e.g. error messages. | |
39 | */ | |
40 | ||
41 | /* | |
42 | * We don't care how filthy our buffers are, but our callers assume | |
43 | * that the following sanitation has already been done. | |
44 | * | |
45 | * No comments, reduce a comment to a space. | |
46 | * Reduce a tab to a space unless it is 1st char of line. | |
47 | * All multiple tabs and spaces collapsed into 1 char. Tab only | |
48 | * legal if 1st char of line. | |
49 | * # line file statements converted to .line x;.file y; statements. | |
50 | * Escaped newlines at end of line: remove them but add as many newlines | |
51 | * to end of statement as you removed in the middle, to synch line numbers. | |
52 | */ | |
53 | \f | |
54 | #define BEFORE_STRING ("\n") | |
e13b337a | 55 | #define AFTER_STRING ("\0") /* memcpy of 0 chars might choke. */ |
252b5132 RH |
56 | #define BEFORE_SIZE (1) |
57 | #define AFTER_SIZE (1) | |
58 | ||
e13b337a KH |
59 | static char *buffer_start; /*->1st char of full buffer area. */ |
60 | static char *partial_where; /*->after last full line in buffer. */ | |
61 | static int partial_size; /* >=0. Number of chars in partial line in buffer. */ | |
7152f1dc KH |
62 | |
63 | /* Because we need AFTER_STRING just after last full line, it clobbers | |
64 | 1st part of partial line. So we preserve 1st part of partial line | |
65 | here. */ | |
252b5132 | 66 | static char save_source[AFTER_SIZE]; |
7152f1dc KH |
67 | |
68 | /* What is the largest size buffer that input_file_give_next_buffer() | |
69 | could return to us? */ | |
70 | static unsigned int buffer_length; | |
252b5132 RH |
71 | |
72 | /* The index into an sb structure we are reading from. -1 if none. */ | |
73 | static int sb_index = -1; | |
74 | ||
75 | /* If we are reading from an sb structure, this is it. */ | |
76 | static sb from_sb; | |
77 | ||
9f10757c TW |
78 | /* Should we do a conditional check on from_sb? */ |
79 | static int from_sb_is_expansion = 1; | |
80 | ||
252b5132 RH |
81 | /* The number of nested sb structures we have included. */ |
82 | int macro_nest; | |
83 | ||
84 | /* We can have more than one source file open at once, though the info for all | |
85 | but the latest one are saved off in a struct input_save. These files remain | |
86 | open, so we are limited by the number of open files allowed by the | |
87 | underlying OS. We may also sequentially read more than one source file in an | |
e13b337a | 88 | assembly. */ |
252b5132 RH |
89 | |
90 | /* We must track the physical file and line number for error messages. We also | |
91 | track a "logical" file and line number corresponding to (C?) compiler | |
92 | source line numbers. Whenever we open a file we must fill in | |
e13b337a | 93 | physical_input_file. So if it is NULL we have not opened any files yet. */ |
252b5132 RH |
94 | |
95 | static char *physical_input_file; | |
96 | static char *logical_input_file; | |
97 | ||
e13b337a KH |
98 | typedef unsigned int line_numberT; /* 1-origin line number in a source file. */ |
99 | /* A line ends in '\n' or eof. */ | |
252b5132 RH |
100 | |
101 | static line_numberT physical_input_line; | |
102 | static int logical_input_line; | |
103 | ||
104 | /* Struct used to save the state of the input handler during include files */ | |
7152f1dc KH |
105 | struct input_save { |
106 | char *buffer_start; | |
107 | char *partial_where; | |
108 | int partial_size; | |
109 | char save_source[AFTER_SIZE]; | |
110 | unsigned int buffer_length; | |
111 | char *physical_input_file; | |
112 | char *logical_input_file; | |
113 | line_numberT physical_input_line; | |
114 | int logical_input_line; | |
115 | int sb_index; | |
116 | sb from_sb; | |
117 | int from_sb_is_expansion; /* Should we do a conditional check? */ | |
118 | struct input_save *next_saved_file; /* Chain of input_saves */ | |
119 | char *input_file_save; /* Saved state of input routines */ | |
120 | char *saved_position; /* Caller's saved position in buf */ | |
121 | }; | |
252b5132 RH |
122 | |
123 | static struct input_save *input_scrub_push PARAMS ((char *saved_position)); | |
124 | static char *input_scrub_pop PARAMS ((struct input_save *arg)); | |
125 | static void as_1_char PARAMS ((unsigned int c, FILE * stream)); | |
126 | ||
127 | /* Saved information about the file that .include'd this one. When we hit EOF, | |
e13b337a | 128 | we automatically pop to that file. */ |
252b5132 RH |
129 | |
130 | static struct input_save *next_saved_file; | |
131 | ||
132 | /* Push the state of input reading and scrubbing so that we can #include. | |
133 | The return value is a 'void *' (fudged for old compilers) to a save | |
e13b337a | 134 | area, which can be restored by passing it to input_scrub_pop(). */ |
7152f1dc | 135 | |
252b5132 RH |
136 | static struct input_save * |
137 | input_scrub_push (saved_position) | |
138 | char *saved_position; | |
139 | { | |
140 | register struct input_save *saved; | |
141 | ||
142 | saved = (struct input_save *) xmalloc (sizeof *saved); | |
143 | ||
144 | saved->saved_position = saved_position; | |
145 | saved->buffer_start = buffer_start; | |
146 | saved->partial_where = partial_where; | |
147 | saved->partial_size = partial_size; | |
148 | saved->buffer_length = buffer_length; | |
149 | saved->physical_input_file = physical_input_file; | |
150 | saved->logical_input_file = logical_input_file; | |
151 | saved->physical_input_line = physical_input_line; | |
152 | saved->logical_input_line = logical_input_line; | |
153 | saved->sb_index = sb_index; | |
154 | saved->from_sb = from_sb; | |
9f10757c | 155 | saved->from_sb_is_expansion = from_sb_is_expansion; |
252b5132 RH |
156 | memcpy (saved->save_source, save_source, sizeof (save_source)); |
157 | saved->next_saved_file = next_saved_file; | |
158 | saved->input_file_save = input_file_push (); | |
159 | ||
160 | input_file_begin (); /* Reinitialize! */ | |
161 | logical_input_line = -1; | |
162 | logical_input_file = (char *) NULL; | |
163 | buffer_length = input_file_buffer_size (); | |
164 | sb_index = -1; | |
165 | ||
166 | buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE)); | |
167 | memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE); | |
168 | ||
169 | return saved; | |
7152f1dc | 170 | } |
252b5132 RH |
171 | |
172 | static char * | |
173 | input_scrub_pop (saved) | |
174 | struct input_save *saved; | |
175 | { | |
176 | char *saved_position; | |
177 | ||
178 | input_scrub_end (); /* Finish off old buffer */ | |
179 | ||
180 | input_file_pop (saved->input_file_save); | |
181 | saved_position = saved->saved_position; | |
182 | buffer_start = saved->buffer_start; | |
183 | buffer_length = saved->buffer_length; | |
184 | physical_input_file = saved->physical_input_file; | |
185 | logical_input_file = saved->logical_input_file; | |
186 | physical_input_line = saved->physical_input_line; | |
187 | logical_input_line = saved->logical_input_line; | |
188 | sb_index = saved->sb_index; | |
189 | from_sb = saved->from_sb; | |
9f10757c | 190 | from_sb_is_expansion = saved->from_sb_is_expansion; |
252b5132 RH |
191 | partial_where = saved->partial_where; |
192 | partial_size = saved->partial_size; | |
193 | next_saved_file = saved->next_saved_file; | |
194 | memcpy (save_source, saved->save_source, sizeof (save_source)); | |
195 | ||
196 | free (saved); | |
197 | return saved_position; | |
198 | } | |
199 | \f | |
252b5132 RH |
200 | void |
201 | input_scrub_begin () | |
202 | { | |
203 | know (strlen (BEFORE_STRING) == BEFORE_SIZE); | |
7152f1dc KH |
204 | know (strlen (AFTER_STRING) == AFTER_SIZE |
205 | || (AFTER_STRING[0] == '\0' && AFTER_SIZE == 1)); | |
252b5132 RH |
206 | |
207 | input_file_begin (); | |
208 | ||
209 | buffer_length = input_file_buffer_size (); | |
210 | ||
211 | buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE)); | |
212 | memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE); | |
213 | ||
e13b337a | 214 | /* Line number things. */ |
252b5132 RH |
215 | logical_input_line = -1; |
216 | logical_input_file = (char *) NULL; | |
e13b337a | 217 | physical_input_file = NULL; /* No file read yet. */ |
252b5132 RH |
218 | next_saved_file = NULL; /* At EOF, don't pop to any other file */ |
219 | do_scrub_begin (flag_m68k_mri); | |
220 | } | |
221 | ||
222 | void | |
223 | input_scrub_end () | |
224 | { | |
225 | if (buffer_start) | |
226 | { | |
227 | free (buffer_start); | |
228 | buffer_start = 0; | |
229 | input_file_end (); | |
230 | } | |
231 | } | |
232 | ||
7152f1dc KH |
233 | /* Start reading input from a new file. |
234 | Return start of caller's part of buffer. */ | |
252b5132 | 235 | |
7152f1dc | 236 | char * |
252b5132 RH |
237 | input_scrub_new_file (filename) |
238 | char *filename; | |
239 | { | |
240 | input_file_open (filename, !flag_no_comments); | |
241 | physical_input_file = filename[0] ? filename : _("{standard input}"); | |
242 | physical_input_line = 0; | |
243 | ||
244 | partial_size = 0; | |
245 | return (buffer_start + BEFORE_SIZE); | |
246 | } | |
247 | ||
252b5132 RH |
248 | /* Include a file from the current file. Save our state, cause it to |
249 | be restored on EOF, and begin handling a new file. Same result as | |
e13b337a | 250 | input_scrub_new_file. */ |
252b5132 RH |
251 | |
252 | char * | |
253 | input_scrub_include_file (filename, position) | |
254 | char *filename; | |
255 | char *position; | |
256 | { | |
257 | next_saved_file = input_scrub_push (position); | |
258 | return input_scrub_new_file (filename); | |
259 | } | |
260 | ||
261 | /* Start getting input from an sb structure. This is used when | |
262 | expanding a macro. */ | |
263 | ||
264 | void | |
9f10757c | 265 | input_scrub_include_sb (from, position, is_expansion) |
252b5132 RH |
266 | sb *from; |
267 | char *position; | |
9f10757c | 268 | int is_expansion; |
252b5132 RH |
269 | { |
270 | if (macro_nest > max_macro_nest) | |
dcb87e5c | 271 | as_fatal (_("macros nested too deeply")); |
252b5132 RH |
272 | ++macro_nest; |
273 | ||
9f10757c TW |
274 | #ifdef md_macro_start |
275 | if (is_expansion) | |
276 | { | |
277 | md_macro_start (); | |
278 | } | |
279 | #endif | |
280 | ||
252b5132 RH |
281 | next_saved_file = input_scrub_push (position); |
282 | ||
283 | sb_new (&from_sb); | |
9f10757c | 284 | from_sb_is_expansion = is_expansion; |
252b5132 RH |
285 | if (from->len >= 1 && from->ptr[0] != '\n') |
286 | { | |
287 | /* Add the sentinel required by read.c. */ | |
288 | sb_add_char (&from_sb, '\n'); | |
289 | } | |
290 | sb_add_sb (&from_sb, from); | |
291 | sb_index = 1; | |
292 | ||
293 | /* These variables are reset by input_scrub_push. Restore them | |
294 | since we are, after all, still at the same point in the file. */ | |
295 | logical_input_line = next_saved_file->logical_input_line; | |
296 | logical_input_file = next_saved_file->logical_input_file; | |
297 | } | |
298 | ||
299 | void | |
300 | input_scrub_close () | |
301 | { | |
302 | input_file_close (); | |
303 | } | |
304 | ||
305 | char * | |
306 | input_scrub_next_buffer (bufp) | |
307 | char **bufp; | |
308 | { | |
e13b337a | 309 | register char *limit; /*->just after last char of buffer. */ |
252b5132 RH |
310 | |
311 | if (sb_index >= 0) | |
312 | { | |
313 | if (sb_index >= from_sb.len) | |
314 | { | |
315 | sb_kill (&from_sb); | |
7152f1dc | 316 | if (from_sb_is_expansion |
dcb87e5c | 317 | ) |
7152f1dc KH |
318 | { |
319 | cond_finish_check (macro_nest); | |
9f10757c | 320 | #ifdef md_macro_end |
7152f1dc KH |
321 | /* Allow the target to clean up per-macro expansion |
322 | data. */ | |
323 | md_macro_end (); | |
9f10757c | 324 | #endif |
7152f1dc KH |
325 | } |
326 | --macro_nest; | |
252b5132 RH |
327 | partial_where = NULL; |
328 | if (next_saved_file != NULL) | |
329 | *bufp = input_scrub_pop (next_saved_file); | |
330 | return partial_where; | |
331 | } | |
332 | ||
333 | partial_where = from_sb.ptr + from_sb.len; | |
334 | partial_size = 0; | |
335 | *bufp = from_sb.ptr + sb_index; | |
336 | sb_index = from_sb.len; | |
337 | return partial_where; | |
338 | } | |
339 | ||
340 | *bufp = buffer_start + BEFORE_SIZE; | |
341 | ||
342 | if (partial_size) | |
343 | { | |
344 | memcpy (buffer_start + BEFORE_SIZE, partial_where, | |
345 | (unsigned int) partial_size); | |
346 | memcpy (buffer_start + BEFORE_SIZE, save_source, AFTER_SIZE); | |
347 | } | |
348 | limit = input_file_give_next_buffer (buffer_start | |
349 | + BEFORE_SIZE | |
350 | + partial_size); | |
351 | if (limit) | |
352 | { | |
e13b337a | 353 | register char *p; /* Find last newline. */ |
252b5132 RH |
354 | |
355 | for (p = limit - 1; *p != '\n'; --p) | |
356 | ; | |
357 | ++p; | |
358 | ||
359 | while (p <= buffer_start + BEFORE_SIZE) | |
360 | { | |
361 | int limoff; | |
362 | ||
363 | limoff = limit - buffer_start; | |
364 | buffer_length += input_file_buffer_size (); | |
365 | buffer_start = xrealloc (buffer_start, | |
366 | (BEFORE_SIZE | |
367 | + 2 * buffer_length | |
368 | + AFTER_SIZE)); | |
369 | *bufp = buffer_start + BEFORE_SIZE; | |
370 | limit = input_file_give_next_buffer (buffer_start + limoff); | |
371 | ||
372 | if (limit == NULL) | |
373 | { | |
374 | as_warn (_("partial line at end of file ignored")); | |
375 | partial_where = NULL; | |
376 | if (next_saved_file) | |
377 | *bufp = input_scrub_pop (next_saved_file); | |
378 | return NULL; | |
379 | } | |
380 | ||
381 | for (p = limit - 1; *p != '\n'; --p) | |
382 | ; | |
383 | ++p; | |
384 | } | |
385 | ||
386 | partial_where = p; | |
387 | partial_size = limit - p; | |
388 | memcpy (save_source, partial_where, (int) AFTER_SIZE); | |
389 | memcpy (partial_where, AFTER_STRING, (int) AFTER_SIZE); | |
390 | } | |
391 | else | |
392 | { | |
393 | partial_where = 0; | |
394 | if (partial_size > 0) | |
395 | { | |
396 | as_warn (_("Partial line at end of file ignored")); | |
397 | } | |
398 | ||
399 | /* Tell the listing we've finished the file. */ | |
400 | LISTING_EOF (); | |
401 | ||
e13b337a | 402 | /* If we should pop to another file at EOF, do it. */ |
252b5132 RH |
403 | if (next_saved_file) |
404 | { | |
405 | *bufp = input_scrub_pop (next_saved_file); /* Pop state */ | |
e13b337a | 406 | /* partial_where is now correct to return, since we popped it. */ |
252b5132 RH |
407 | } |
408 | } | |
409 | return (partial_where); | |
7152f1dc | 410 | } |
252b5132 | 411 | \f |
7152f1dc KH |
412 | /* The remaining part of this file deals with line numbers, error |
413 | messages and so on. Return TRUE if we opened any file. */ | |
252b5132 | 414 | |
252b5132 | 415 | int |
7152f1dc | 416 | seen_at_least_1_file () |
252b5132 RH |
417 | { |
418 | return (physical_input_file != NULL); | |
419 | } | |
420 | ||
421 | void | |
422 | bump_line_counters () | |
423 | { | |
424 | if (sb_index < 0) | |
425 | { | |
426 | ++physical_input_line; | |
427 | if (logical_input_line >= 0) | |
428 | ++logical_input_line; | |
429 | } | |
430 | } | |
431 | \f | |
7152f1dc KH |
432 | /* Tells us what the new logical line number and file are. |
433 | If the line_number is -1, we don't change the current logical line | |
434 | number. If it is -2, we decrement the logical line number (this is | |
435 | to support the .appfile pseudo-op inserted into the stream by | |
436 | do_scrub_chars). | |
437 | If the fname is NULL, we don't change the current logical file name. | |
438 | Returns nonzero if the filename actually changes. */ | |
439 | ||
252b5132 RH |
440 | int |
441 | new_logical_line (fname, line_number) | |
7152f1dc | 442 | char *fname; /* DON'T destroy it! We point to it! */ |
252b5132 RH |
443 | int line_number; |
444 | { | |
445 | if (line_number >= 0) | |
446 | logical_input_line = line_number; | |
447 | else if (line_number == -2 && logical_input_line > 0) | |
448 | --logical_input_line; | |
449 | ||
450 | if (fname | |
451 | && (logical_input_file == NULL | |
452 | || strcmp (logical_input_file, fname))) | |
453 | { | |
454 | logical_input_file = fname; | |
455 | return 1; | |
456 | } | |
457 | else | |
458 | return 0; | |
7152f1dc | 459 | } |
252b5132 | 460 | \f |
7152f1dc KH |
461 | /* Return the current file name and line number. |
462 | namep should be char * const *, but there are compilers which screw | |
463 | up declarations like that, and it's easier to avoid it. */ | |
464 | ||
e13b337a | 465 | void |
252b5132 RH |
466 | as_where (namep, linep) |
467 | char **namep; | |
468 | unsigned int *linep; | |
469 | { | |
470 | if (logical_input_file != NULL | |
471 | && (linep == NULL || logical_input_line >= 0)) | |
472 | { | |
473 | *namep = logical_input_file; | |
474 | if (linep != NULL) | |
475 | *linep = logical_input_line; | |
476 | } | |
477 | else if (physical_input_file != NULL) | |
478 | { | |
479 | *namep = physical_input_file; | |
480 | if (linep != NULL) | |
481 | *linep = physical_input_line; | |
482 | } | |
483 | else | |
484 | { | |
485 | *namep = 0; | |
486 | if (linep != NULL) | |
487 | *linep = 0; | |
488 | } | |
7152f1dc | 489 | } |
252b5132 | 490 | \f |
7152f1dc KH |
491 | /* Output to given stream how much of line we have scanned so far. |
492 | Assumes we have scanned up to and including input_line_pointer. | |
493 | No free '\n' at end of line. */ | |
252b5132 | 494 | |
252b5132 RH |
495 | void |
496 | as_howmuch (stream) | |
e13b337a | 497 | FILE *stream; /* Opened for write please. */ |
252b5132 | 498 | { |
e13b337a | 499 | register char *p; /* Scan input line. */ |
252b5132 RH |
500 | |
501 | for (p = input_line_pointer - 1; *p != '\n'; --p) | |
502 | { | |
503 | } | |
e13b337a | 504 | ++p; /* p->1st char of line. */ |
252b5132 RH |
505 | for (; p <= input_line_pointer; p++) |
506 | { | |
e13b337a | 507 | /* Assume ASCII. EBCDIC & other micro-computer char sets ignored. */ |
252b5132 RH |
508 | as_1_char ((unsigned char) *p, stream); |
509 | } | |
510 | } | |
511 | ||
e13b337a | 512 | static void |
252b5132 RH |
513 | as_1_char (c, stream) |
514 | unsigned int c; | |
515 | FILE *stream; | |
516 | { | |
517 | if (c > 127) | |
518 | { | |
519 | (void) putc ('%', stream); | |
520 | c -= 128; | |
521 | } | |
522 | if (c < 32) | |
523 | { | |
524 | (void) putc ('^', stream); | |
525 | c += '@'; | |
526 | } | |
527 | (void) putc (c, stream); | |
528 | } |