daily update
[binutils.git] / gas / input-scrub.c
blob7a03965c9672022607c5128e3fe3719c6d0977ba
1 /* input_scrub.c - Break up input buffers into whole numbers of lines.
2 Copyright 1987, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 2000
4 Free Software Foundation, Inc.
6 This file is part of GAS, the GNU Assembler.
8 GAS is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GAS is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GAS; see the file COPYING. If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA. */
23 #include <errno.h> /* Need this to make errno declaration right */
24 #include "as.h"
25 #include "input-file.h"
26 #include "sb.h"
27 #include "listing.h"
30 * O/S independent module to supply buffers of sanitised source code
31 * to rest of assembler. We get sanitised input data of arbitrary length.
32 * We break these buffers on line boundaries, recombine pieces that
33 * were broken across buffers, and return a buffer of full lines to
34 * the caller.
35 * The last partial line begins the next buffer we build and return to caller.
36 * The buffer returned to caller is preceded by BEFORE_STRING and followed
37 * by AFTER_STRING, as sentinels. The last character before AFTER_STRING
38 * is a newline.
39 * Also looks after line numbers, for e.g. error messages.
43 * We don't care how filthy our buffers are, but our callers assume
44 * that the following sanitation has already been done.
46 * No comments, reduce a comment to a space.
47 * Reduce a tab to a space unless it is 1st char of line.
48 * All multiple tabs and spaces collapsed into 1 char. Tab only
49 * legal if 1st char of line.
50 * # line file statements converted to .line x;.file y; statements.
51 * Escaped newlines at end of line: remove them but add as many newlines
52 * to end of statement as you removed in the middle, to synch line numbers.
55 #define BEFORE_STRING ("\n")
56 #define AFTER_STRING ("\0") /* memcpy of 0 chars might choke. */
57 #define BEFORE_SIZE (1)
58 #define AFTER_SIZE (1)
60 static char *buffer_start; /*->1st char of full buffer area. */
61 static char *partial_where; /*->after last full line in buffer. */
62 static int partial_size; /* >=0. Number of chars in partial line in buffer. */
64 /* Because we need AFTER_STRING just after last full line, it clobbers
65 1st part of partial line. So we preserve 1st part of partial line
66 here. */
67 static char save_source[AFTER_SIZE];
69 /* What is the largest size buffer that input_file_give_next_buffer()
70 could return to us? */
71 static unsigned int buffer_length;
73 /* The index into an sb structure we are reading from. -1 if none. */
74 static int sb_index = -1;
76 /* If we are reading from an sb structure, this is it. */
77 static sb from_sb;
79 /* Should we do a conditional check on from_sb? */
80 static int from_sb_is_expansion = 1;
82 /* The number of nested sb structures we have included. */
83 int macro_nest;
85 /* We can have more than one source file open at once, though the info for all
86 but the latest one are saved off in a struct input_save. These files remain
87 open, so we are limited by the number of open files allowed by the
88 underlying OS. We may also sequentially read more than one source file in an
89 assembly. */
91 /* We must track the physical file and line number for error messages. We also
92 track a "logical" file and line number corresponding to (C?) compiler
93 source line numbers. Whenever we open a file we must fill in
94 physical_input_file. So if it is NULL we have not opened any files yet. */
96 static char *physical_input_file;
97 static char *logical_input_file;
99 typedef unsigned int line_numberT; /* 1-origin line number in a source file. */
100 /* A line ends in '\n' or eof. */
102 static line_numberT physical_input_line;
103 static int logical_input_line;
105 /* Struct used to save the state of the input handler during include files */
106 struct input_save {
107 char * buffer_start;
108 char * partial_where;
109 int partial_size;
110 char save_source[AFTER_SIZE];
111 unsigned int buffer_length;
112 char * physical_input_file;
113 char * logical_input_file;
114 line_numberT physical_input_line;
115 int logical_input_line;
116 int sb_index;
117 sb from_sb;
118 int from_sb_is_expansion; /* Should we do a conditional check? */
119 struct input_save * next_saved_file; /* Chain of input_saves. */
120 char * input_file_save; /* Saved state of input routines. */
121 char * saved_position; /* Caller's saved position in buf. */
124 static struct input_save *input_scrub_push (char *saved_position);
125 static char *input_scrub_pop (struct input_save *arg);
126 static void as_1_char (unsigned int c, FILE * stream);
128 /* Saved information about the file that .include'd this one. When we hit EOF,
129 we automatically pop to that file. */
131 static struct input_save *next_saved_file;
133 /* Push the state of input reading and scrubbing so that we can #include.
134 The return value is a 'void *' (fudged for old compilers) to a save
135 area, which can be restored by passing it to input_scrub_pop(). */
137 static struct input_save *
138 input_scrub_push (char *saved_position)
140 register struct input_save *saved;
142 saved = (struct input_save *) xmalloc (sizeof *saved);
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;
155 saved->from_sb_is_expansion = from_sb_is_expansion;
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 ();
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;
166 buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE));
167 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
169 return saved;
172 static char *
173 input_scrub_pop (struct input_save *saved)
175 char *saved_position;
177 input_scrub_end (); /* Finish off old buffer */
179 input_file_pop (saved->input_file_save);
180 saved_position = saved->saved_position;
181 buffer_start = saved->buffer_start;
182 buffer_length = saved->buffer_length;
183 physical_input_file = saved->physical_input_file;
184 logical_input_file = saved->logical_input_file;
185 physical_input_line = saved->physical_input_line;
186 logical_input_line = saved->logical_input_line;
187 sb_index = saved->sb_index;
188 from_sb = saved->from_sb;
189 from_sb_is_expansion = saved->from_sb_is_expansion;
190 partial_where = saved->partial_where;
191 partial_size = saved->partial_size;
192 next_saved_file = saved->next_saved_file;
193 memcpy (save_source, saved->save_source, sizeof (save_source));
195 free (saved);
196 return saved_position;
199 void
200 input_scrub_begin (void)
202 know (strlen (BEFORE_STRING) == BEFORE_SIZE);
203 know (strlen (AFTER_STRING) == AFTER_SIZE
204 || (AFTER_STRING[0] == '\0' && AFTER_SIZE == 1));
206 input_file_begin ();
208 buffer_length = input_file_buffer_size ();
210 buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE));
211 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
213 /* Line number things. */
214 logical_input_line = -1;
215 logical_input_file = (char *) NULL;
216 physical_input_file = NULL; /* No file read yet. */
217 next_saved_file = NULL; /* At EOF, don't pop to any other file */
218 do_scrub_begin (flag_m68k_mri);
221 void
222 input_scrub_end (void)
224 if (buffer_start)
226 free (buffer_start);
227 buffer_start = 0;
228 input_file_end ();
232 /* Start reading input from a new file.
233 Return start of caller's part of buffer. */
235 char *
236 input_scrub_new_file (char *filename)
238 input_file_open (filename, !flag_no_comments);
239 physical_input_file = filename[0] ? filename : _("{standard input}");
240 physical_input_line = 0;
242 partial_size = 0;
243 return (buffer_start + BEFORE_SIZE);
246 /* Include a file from the current file. Save our state, cause it to
247 be restored on EOF, and begin handling a new file. Same result as
248 input_scrub_new_file. */
250 char *
251 input_scrub_include_file (char *filename, char *position)
253 next_saved_file = input_scrub_push (position);
254 return input_scrub_new_file (filename);
257 /* Start getting input from an sb structure. This is used when
258 expanding a macro. */
260 void
261 input_scrub_include_sb (sb *from, char *position, int is_expansion)
263 if (macro_nest > max_macro_nest)
264 as_fatal (_("macros nested too deeply"));
265 ++macro_nest;
267 #ifdef md_macro_start
268 if (is_expansion)
270 md_macro_start ();
272 #endif
274 next_saved_file = input_scrub_push (position);
276 sb_new (&from_sb);
277 from_sb_is_expansion = is_expansion;
278 if (from->len >= 1 && from->ptr[0] != '\n')
280 /* Add the sentinel required by read.c. */
281 sb_add_char (&from_sb, '\n');
283 sb_add_sb (&from_sb, from);
284 sb_index = 1;
286 /* These variables are reset by input_scrub_push. Restore them
287 since we are, after all, still at the same point in the file. */
288 logical_input_line = next_saved_file->logical_input_line;
289 logical_input_file = next_saved_file->logical_input_file;
292 void
293 input_scrub_close (void)
295 input_file_close ();
298 char *
299 input_scrub_next_buffer (char **bufp)
301 register char *limit; /*->just after last char of buffer. */
303 if (sb_index >= 0)
305 if (sb_index >= from_sb.len)
307 sb_kill (&from_sb);
308 if (from_sb_is_expansion
311 cond_finish_check (macro_nest);
312 #ifdef md_macro_end
313 /* Allow the target to clean up per-macro expansion
314 data. */
315 md_macro_end ();
316 #endif
318 --macro_nest;
319 partial_where = NULL;
320 if (next_saved_file != NULL)
321 *bufp = input_scrub_pop (next_saved_file);
322 return partial_where;
325 partial_where = from_sb.ptr + from_sb.len;
326 partial_size = 0;
327 *bufp = from_sb.ptr + sb_index;
328 sb_index = from_sb.len;
329 return partial_where;
332 *bufp = buffer_start + BEFORE_SIZE;
334 if (partial_size)
336 memcpy (buffer_start + BEFORE_SIZE, partial_where,
337 (unsigned int) partial_size);
338 memcpy (buffer_start + BEFORE_SIZE, save_source, AFTER_SIZE);
340 limit = input_file_give_next_buffer (buffer_start
341 + BEFORE_SIZE
342 + partial_size);
343 if (limit)
345 register char *p; /* Find last newline. */
347 for (p = limit - 1; *p != '\n'; --p)
349 ++p;
351 while (p <= buffer_start + BEFORE_SIZE)
353 int limoff;
355 limoff = limit - buffer_start;
356 buffer_length += input_file_buffer_size ();
357 buffer_start = xrealloc (buffer_start,
358 (BEFORE_SIZE
359 + 2 * buffer_length
360 + AFTER_SIZE));
361 *bufp = buffer_start + BEFORE_SIZE;
362 limit = input_file_give_next_buffer (buffer_start + limoff);
364 if (limit == NULL)
366 as_warn (_("partial line at end of file ignored"));
367 partial_where = NULL;
368 if (next_saved_file)
369 *bufp = input_scrub_pop (next_saved_file);
370 return NULL;
373 for (p = limit - 1; *p != '\n'; --p)
375 ++p;
378 partial_where = p;
379 partial_size = limit - p;
380 memcpy (save_source, partial_where, (int) AFTER_SIZE);
381 memcpy (partial_where, AFTER_STRING, (int) AFTER_SIZE);
383 else
385 partial_where = 0;
386 if (partial_size > 0)
388 as_warn (_("partial line at end of file ignored"));
391 /* Tell the listing we've finished the file. */
392 LISTING_EOF ();
394 /* If we should pop to another file at EOF, do it. */
395 if (next_saved_file)
397 *bufp = input_scrub_pop (next_saved_file); /* Pop state */
398 /* partial_where is now correct to return, since we popped it. */
401 return (partial_where);
404 /* The remaining part of this file deals with line numbers, error
405 messages and so on. Return TRUE if we opened any file. */
408 seen_at_least_1_file (void)
410 return (physical_input_file != NULL);
413 void
414 bump_line_counters (void)
416 if (sb_index < 0)
418 ++physical_input_line;
419 if (logical_input_line >= 0)
420 ++logical_input_line;
424 /* Tells us what the new logical line number and file are.
425 If the line_number is -1, we don't change the current logical line
426 number. If it is -2, we decrement the logical line number (this is
427 to support the .appfile pseudo-op inserted into the stream by
428 do_scrub_chars).
429 If the fname is NULL, we don't change the current logical file name.
430 Returns nonzero if the filename actually changes. */
433 new_logical_line (char *fname, /* DON'T destroy it! We point to it! */
434 int line_number)
436 if (line_number >= 0)
437 logical_input_line = line_number;
438 else if (line_number == -2 && logical_input_line > 0)
439 --logical_input_line;
441 if (fname
442 && (logical_input_file == NULL
443 || strcmp (logical_input_file, fname)))
445 logical_input_file = fname;
446 return 1;
448 else
449 return 0;
452 /* Return the current file name and line number.
453 namep should be char * const *, but there are compilers which screw
454 up declarations like that, and it's easier to avoid it. */
456 void
457 as_where (char **namep, unsigned int *linep)
459 if (logical_input_file != NULL
460 && (linep == NULL || logical_input_line >= 0))
462 *namep = logical_input_file;
463 if (linep != NULL)
464 *linep = logical_input_line;
466 else if (physical_input_file != NULL)
468 *namep = physical_input_file;
469 if (linep != NULL)
470 *linep = physical_input_line;
472 else
474 *namep = 0;
475 if (linep != NULL)
476 *linep = 0;
480 /* Output to given stream how much of line we have scanned so far.
481 Assumes we have scanned up to and including input_line_pointer.
482 No free '\n' at end of line. */
484 void
485 as_howmuch (FILE *stream /* Opened for write please. */)
487 register char *p; /* Scan input line. */
489 for (p = input_line_pointer - 1; *p != '\n'; --p)
492 ++p; /* p->1st char of line. */
493 for (; p <= input_line_pointer; p++)
495 /* Assume ASCII. EBCDIC & other micro-computer char sets ignored. */
496 as_1_char ((unsigned char) *p, stream);
500 static void
501 as_1_char (unsigned int c, FILE *stream)
503 if (c > 127)
505 (void) putc ('%', stream);
506 c -= 128;
508 if (c < 32)
510 (void) putc ('^', stream);
511 c += '@';
513 (void) putc (c, stream);