1 /* input_scrub.c - Break up input buffers into whole numbers of lines.
2 Copyright (C) 1987, 1990, 1991, 1992 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
6 GAS is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GAS is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GAS; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 #include <errno.h> /* Need this to make errno declaration right */
22 #include "input-file.h"
25 * O/S independent module to supply buffers of sanitised source code
26 * to rest of assembler. We get sanitized input data of arbitrary length.
27 * We break these buffers on line boundaries, recombine pieces that
28 * were broken across buffers, and return a buffer of full lines to
30 * The last partial line begins the next buffer we build and return to caller.
31 * The buffer returned to caller is preceeded by BEFORE_STRING and followed
32 * by AFTER_STRING, as sentinels. The last character before AFTER_STRING
34 * Also looks after line numbers, for e.g. error messages.
38 * We don't care how filthy our buffers are, but our callers assume
39 * that the following sanitation has already been done.
41 * No comments, reduce a comment to a space.
42 * Reduce a tab to a space unless it is 1st char of line.
43 * All multiple tabs and spaces collapsed into 1 char. Tab only
44 * legal if 1st char of line.
45 * # line file statements converted to .line x;.file y; statements.
46 * Escaped newlines at end of line: remove them but add as many newlines
47 * to end of statement as you removed in the middle, to synch line numbers.
50 #define BEFORE_STRING ("\n")
51 #define AFTER_STRING ("\0") /* memcpy of 0 chars might choke. */
52 #define BEFORE_SIZE (1)
53 #define AFTER_SIZE (1)
55 static char * buffer_start
; /*->1st char of full buffer area. */
56 static char * partial_where
; /*->after last full line in buffer. */
57 static int partial_size
; /* >=0. Number of chars in partial line in buffer. */
58 static char save_source
[AFTER_SIZE
];
59 /* Because we need AFTER_STRING just after last */
60 /* full line, it clobbers 1st part of partial */
61 /* line. So we preserve 1st part of partial */
63 static int buffer_length
; /* What is the largest size buffer that */
64 /* input_file_give_next_buffer() could */
67 /* Saved information about the file that .include'd this one. When we hit EOF,
68 we automatically pop to that file. */
70 static char *next_saved_file
;
72 /* We can have more than one source file open at once, though the info for all
73 but the latest one are saved off in a struct input_save. These files remain
74 open, so we are limited by the number of open files allowed by the
75 underlying OS. We may also sequentially read more than one source file in an
78 /* We must track the physical file and line number for error messages. We also
79 track a "logical" file and line number corresponding to (C?) compiler
80 source line numbers. Whenever we open a file we must fill in
81 physical_input_file. So if it is NULL we have not opened any files yet. */
83 char *physical_input_file
;
84 char *logical_input_file
;
86 typedef unsigned int line_numberT
; /* 1-origin line number in a source file. */
87 /* A line ends in '\n' or eof. */
89 line_numberT physical_input_line
;
90 line_numberT logical_input_line
;
92 /* Struct used to save the state of the input handler during include files */
97 char save_source
[AFTER_SIZE
];
99 char *physical_input_file
;
100 char *logical_input_file
;
101 line_numberT physical_input_line
;
102 line_numberT logical_input_line
;
103 char *next_saved_file
; /* Chain of input_saves */
104 char *input_file_save
; /* Saved state of input routines */
105 char *saved_position
; /* Caller's saved position in buf */
109 static void as_1_char(unsigned int c
, FILE *stream
);
111 static void as_1_char();
112 #endif /* not __STDC__ */
114 /* Push the state of input reading and scrubbing so that we can #include.
115 The return value is a 'void *' (fudged for old compilers) to a save
116 area, which can be restored by passing it to input_scrub_pop(). */
117 char *input_scrub_push(saved_position
)
118 char *saved_position
;
120 register struct input_save
*saved
;
122 saved
= (struct input_save
*) xmalloc(sizeof *saved
);
124 saved
->saved_position
= saved_position
;
125 saved
->buffer_start
= buffer_start
;
126 saved
->partial_where
= partial_where
;
127 saved
->partial_size
= partial_size
;
128 saved
->buffer_length
= buffer_length
;
129 saved
->physical_input_file
= physical_input_file
;
130 saved
->logical_input_file
= logical_input_file
;
131 saved
->physical_input_line
= physical_input_line
;
132 saved
->logical_input_line
= logical_input_line
;
133 memcpy(saved
->save_source
, save_source
, sizeof(save_source
));
134 saved
->next_saved_file
= next_saved_file
;
135 saved
->input_file_save
= input_file_push();
137 input_scrub_begin(); /* Reinitialize! */
139 return((char *) saved
);
140 } /* input_scrub_push() */
143 input_scrub_pop (arg
)
146 register struct input_save
*saved
;
147 char *saved_position
;
149 input_scrub_end (); /* Finish off old buffer */
151 saved
= (struct input_save
*)arg
;
153 input_file_pop (saved
->input_file_save
);
154 saved_position
= saved
->saved_position
;
155 buffer_start
= saved
->buffer_start
;
156 buffer_length
= saved
->buffer_length
;
157 physical_input_file
= saved
->physical_input_file
;
158 logical_input_file
= saved
->logical_input_file
;
159 physical_input_line
= saved
->physical_input_line
;
160 logical_input_line
= saved
->logical_input_line
;
161 partial_where
= saved
->partial_where
;
162 partial_size
= saved
->partial_size
;
163 next_saved_file
= saved
->next_saved_file
;
164 memcpy(save_source
, saved
->save_source
, sizeof (save_source
));
167 return saved_position
;
174 know(strlen(BEFORE_STRING
) == BEFORE_SIZE
);
175 know(strlen(AFTER_STRING
) == AFTER_SIZE
|| (AFTER_STRING
[0] == '\0' && AFTER_SIZE
== 1));
179 buffer_length
= input_file_buffer_size ();
181 buffer_start
= xmalloc((long)(BEFORE_SIZE
+ buffer_length
+ buffer_length
+ AFTER_SIZE
));
182 memcpy(buffer_start
, BEFORE_STRING
, (int) BEFORE_SIZE
);
184 /* Line number things. */
185 logical_input_line
= 0;
186 logical_input_file
= (char *)NULL
;
187 physical_input_file
= NULL
; /* No file read yet. */
188 next_saved_file
= NULL
; /* At EOF, don't pop to any other file */
203 /* Start reading input from a new file. */
205 char * /* Return start of caller's part of buffer. */
206 input_scrub_new_file (filename
)
209 input_file_open (filename
, !flagseen
['f']);
210 physical_input_file
= filename
[0] ? filename
: "{standard input}";
211 physical_input_line
= 0;
214 return (buffer_start
+ BEFORE_SIZE
);
218 /* Include a file from the current file. Save our state, cause it to
219 be restored on EOF, and begin handling a new file. Same result as
220 input_scrub_new_file. */
223 input_scrub_include_file (filename
, position
)
227 next_saved_file
= input_scrub_push(position
);
228 return input_scrub_new_file (filename
);
237 input_scrub_next_buffer (bufp
)
240 register char * limit
; /*->just after last char of buffer. */
242 *bufp
= buffer_start
+ BEFORE_SIZE
;
250 limit
= input_file_give_next_buffer(buffer_start
+BEFORE_SIZE
);
254 as_warn("Partial line at end of file ignored");
255 return partial_where
;
259 memcpy(partial_where
, save_source
, (int) AFTER_SIZE
);
260 do_scrub(partial_where
,partial_size
,buffer_start
+BEFORE_SIZE
,limit
-(buffer_start
+BEFORE_SIZE
),&out_string
,&out_length
);
261 limit
=out_string
+ out_length
;
262 for(p
=limit
;*--p
!='\n';)
265 if(p
<=buffer_start
+BEFORE_SIZE
)
266 as_fatal("Source line too long. Please change file '%s' and re-make the assembler.", __FILE__
);
269 partial_size
= limit
-p
;
270 memcpy(save_source
, partial_where
, (int) AFTER_SIZE
);
271 memcpy(partial_where
, AFTER_STRING
, (int) AFTER_SIZE
);
276 return partial_where
;
279 /* We're not preprocessing. Do the right thing */
282 memcpy(buffer_start
+ BEFORE_SIZE
, partial_where
, (int) partial_size
);
283 memcpy(buffer_start
+ BEFORE_SIZE
, save_source
, (int) AFTER_SIZE
);
285 limit
= input_file_give_next_buffer (buffer_start
+ BEFORE_SIZE
+ partial_size
);
287 register char * p
; /* Find last newline. */
289 for (p
= limit
; *--p
!= '\n';) ;;
291 if (p
<= buffer_start
+ BEFORE_SIZE
) {
292 as_fatal("Source line too long. Please change file %s then rebuild assembler.", __FILE__
);
295 partial_size
= limit
- p
;
296 memcpy(save_source
, partial_where
, (int) AFTER_SIZE
);
297 memcpy(partial_where
, AFTER_STRING
, (int) AFTER_SIZE
);
300 if (partial_size
> 0) {
301 as_warn("Partial line at end of file ignored");
303 /* If we should pop to another file at EOF, do it. */
304 if (next_saved_file
) {
305 *bufp
= input_scrub_pop (next_saved_file
); /* Pop state */
306 /* partial_where is now correct to return, since we popped it. */
309 return(partial_where
);
310 } /* input_scrub_next_buffer() */
313 * The remaining part of this file deals with line numbers, error
314 * messages and so on.
319 seen_at_least_1_file () /* TRUE if we opened any file. */
321 return (physical_input_file
!= NULL
);
325 bump_line_counters ()
327 ++ physical_input_line
;
328 /* ++ logical_input_line; FIXME-now remove this. */
334 * Tells us what the new logical line number and file are.
335 * If the line_number is <0, we don't change the current logical line number.
336 * If the fname is NULL, we don't change the current logical file name.
338 void new_logical_line(fname
, line_number
)
339 char *fname
; /* DON'T destroy it! We point to it! */
343 logical_input_file
= fname
;
344 } /* if we have a file name */
346 if (line_number
>= 0) {
347 logical_input_line
= line_number
;
348 } /* if we have a line number */
349 } /* new_logical_line() */
354 * Write a line to stderr locating where we are in reading
355 * input source files.
356 * As a sop to the debugger of AS, pretty-print the offending line.
362 if (logical_input_file
&& (logical_input_line
> 0)) {
363 p
= logical_input_file
;
364 line
= logical_input_line
;
366 p
= physical_input_file
;
367 line
= physical_input_line
;
368 } /* line number should match file name */
370 fprintf(stderr
, "%s:%u: ", p
, line
);
373 if (physical_input_file
) {
374 if (input_file_is_open()) { /* we can still read lines from source */
375 fprintf (stderr
," @ physical line %ld., file \"%s\"",
376 (long) physical_input_line
, physical_input_file
);
377 fprintf (stderr
," @ logical line %ld., file \"%s\"\n",
378 (long) logical_input_line
, logical_input_file
);
379 (void)putc(' ', stderr
);
381 (void)putc('\n', stderr
);
383 fprintf(stderr
, " After reading source.\n");
384 } /* input file is still open */
386 fprintf(stderr
, " Before reading source.\n");
387 } /* we tried to read SOME source */
397 * a s _ h o w m u c h ()
399 * Output to given stream how much of line we have scanned so far.
400 * Assumes we have scanned up to and including input_line_pointer.
401 * No free '\n' at end of line.
405 FILE * stream
; /* Opened for write please. */
407 register char * p
; /* Scan input line. */
408 /* register char c; JF unused */
410 for (p
= input_line_pointer
- 1; * p
!= '\n'; --p
)
413 ++ p
; /* p->1st char of line. */
414 for (; p
<= input_line_pointer
; p
++)
416 /* Assume ASCII. EBCDIC & other micro-computer char sets ignored. */
417 /* c = *p & 0xFF; JF unused */
418 as_1_char(*p
, stream
);
422 static void as_1_char (c
,stream
)
428 (void)putc('%', stream
);
433 (void)putc('^', stream
);
436 (void)putc(c
, stream
);
446 /* end of input_scrub.c */