1 /* input_scrub.c - Break up input buffers into whole numbers of lines.
2 Copyright (C) 1987-2017 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 3, 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 the Free
18 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
22 #include "filenames.h"
23 #include "input-file.h"
28 * O/S independent module to supply buffers of sanitised source code
29 * to rest of assembler. We get sanitised input data of arbitrary length.
30 * We break these buffers on line boundaries, recombine pieces that
31 * were broken across buffers, and return a buffer of full lines to
33 * The last partial line begins the next buffer we build and return to caller.
34 * The buffer returned to caller is preceded by BEFORE_STRING and followed
35 * by AFTER_STRING, as sentinels. The last character before AFTER_STRING
37 * Also looks after line numbers, for e.g. error messages.
41 * We don't care how filthy our buffers are, but our callers assume
42 * that the following sanitation has already been done.
44 * No comments, reduce a comment to a space.
45 * Reduce a tab to a space unless it is 1st char of line.
46 * All multiple tabs and spaces collapsed into 1 char. Tab only
47 * legal if 1st char of line.
48 * # line file statements converted to .line x;.file y; statements.
49 * Escaped newlines at end of line: remove them but add as many newlines
50 * to end of statement as you removed in the middle, to synch line numbers.
53 #define BEFORE_STRING ("\n")
54 #define AFTER_STRING ("\0") /* memcpy of 0 chars might choke. */
55 #define BEFORE_SIZE (1)
56 #define AFTER_SIZE (1)
58 #ifndef TC_EOL_IN_INSN
59 #define TC_EOL_IN_INSN(P) 0
62 static char *buffer_start
; /*->1st char of full buffer area. */
63 static char *partial_where
; /*->after last full line in buffer. */
64 static size_t partial_size
; /* >=0. Number of chars in partial line in buffer. */
66 /* Because we need AFTER_STRING just after last full line, it clobbers
67 1st part of partial line. So we preserve 1st part of partial line
69 static char save_source
[AFTER_SIZE
];
71 /* The size of the input buffer we concatenate
72 input_file_give_next_buffer chunks into. Excludes the BEFORE and
74 static size_t buffer_length
;
76 /* The index into an sb structure we are reading from. -1 if none. */
77 static size_t sb_index
= -1;
79 /* If we are reading from an sb structure, this is it. */
82 /* Should we do a conditional check on from_sb? */
83 static int from_sb_is_expansion
= 1;
85 /* The number of nested sb structures we have included. */
88 /* We can have more than one source file open at once, though the info for all
89 but the latest one are saved off in a struct input_save. These files remain
90 open, so we are limited by the number of open files allowed by the
91 underlying OS. We may also sequentially read more than one source file in an
94 /* We must track the physical file and line number for error messages. We also
95 track a "logical" file and line number corresponding to (C?) compiler
96 source line numbers. Whenever we open a file we must fill in
97 physical_input_file. So if it is NULL we have not opened any files yet. */
99 static const char *physical_input_file
;
100 static const char *logical_input_file
;
102 /* 1-origin line number in a source file. */
103 /* A line ends in '\n' or eof. */
104 static unsigned int physical_input_line
;
105 static int logical_input_line
;
107 /* Struct used to save the state of the input handler during include files */
110 char * partial_where
;
112 char save_source
[AFTER_SIZE
];
113 size_t buffer_length
;
114 const char * physical_input_file
;
115 const char * logical_input_file
;
116 unsigned int physical_input_line
;
117 int logical_input_line
;
120 int from_sb_is_expansion
; /* Should we do a conditional check? */
121 struct input_save
* next_saved_file
; /* Chain of input_saves. */
122 char * input_file_save
; /* Saved state of input routines. */
123 char * saved_position
; /* Caller's saved position in buf. */
126 static struct input_save
*input_scrub_push (char *saved_position
);
127 static char *input_scrub_pop (struct input_save
*arg
);
129 /* Saved information about the file that .include'd this one. When we hit EOF,
130 we automatically pop to that file. */
132 static struct input_save
*next_saved_file
;
134 /* Initialize input buffering. */
137 input_scrub_reinit (void)
139 input_file_begin (); /* Reinitialize! */
140 logical_input_line
= -1;
141 logical_input_file
= NULL
;
143 buffer_length
= input_file_buffer_size () * 2;
144 buffer_start
= XNEWVEC (char, BEFORE_SIZE
+ AFTER_SIZE
+ 1 + buffer_length
);
145 memcpy (buffer_start
, BEFORE_STRING
, (int) BEFORE_SIZE
);
148 /* Push the state of input reading and scrubbing so that we can #include.
149 The return value is a 'void *' (fudged for old compilers) to a save
150 area, which can be restored by passing it to input_scrub_pop(). */
152 static struct input_save
*
153 input_scrub_push (char *saved_position
)
155 struct input_save
*saved
;
157 saved
= XNEW (struct input_save
);
159 saved
->saved_position
= saved_position
;
160 saved
->buffer_start
= buffer_start
;
161 saved
->partial_where
= partial_where
;
162 saved
->partial_size
= partial_size
;
163 saved
->buffer_length
= buffer_length
;
164 saved
->physical_input_file
= physical_input_file
;
165 saved
->logical_input_file
= logical_input_file
;
166 saved
->physical_input_line
= physical_input_line
;
167 saved
->logical_input_line
= logical_input_line
;
168 saved
->sb_index
= sb_index
;
169 saved
->from_sb
= from_sb
;
170 saved
->from_sb_is_expansion
= from_sb_is_expansion
;
171 memcpy (saved
->save_source
, save_source
, sizeof (save_source
));
172 saved
->next_saved_file
= next_saved_file
;
173 saved
->input_file_save
= input_file_push ();
177 input_scrub_reinit ();
183 input_scrub_pop (struct input_save
*saved
)
185 char *saved_position
;
187 input_scrub_end (); /* Finish off old buffer */
189 input_file_pop (saved
->input_file_save
);
190 saved_position
= saved
->saved_position
;
191 buffer_start
= saved
->buffer_start
;
192 buffer_length
= saved
->buffer_length
;
193 physical_input_file
= saved
->physical_input_file
;
194 logical_input_file
= saved
->logical_input_file
;
195 physical_input_line
= saved
->physical_input_line
;
196 logical_input_line
= saved
->logical_input_line
;
197 sb_index
= saved
->sb_index
;
198 from_sb
= saved
->from_sb
;
199 from_sb_is_expansion
= saved
->from_sb_is_expansion
;
200 partial_where
= saved
->partial_where
;
201 partial_size
= saved
->partial_size
;
202 next_saved_file
= saved
->next_saved_file
;
203 memcpy (save_source
, saved
->save_source
, sizeof (save_source
));
206 return saved_position
;
210 input_scrub_begin (void)
212 know (strlen (BEFORE_STRING
) == BEFORE_SIZE
);
213 know (strlen (AFTER_STRING
) == AFTER_SIZE
214 || (AFTER_STRING
[0] == '\0' && AFTER_SIZE
== 1));
216 physical_input_file
= NULL
; /* No file read yet. */
217 next_saved_file
= NULL
; /* At EOF, don't pop to any other file */
218 input_scrub_reinit ();
219 do_scrub_begin (flag_m68k_mri
);
223 input_scrub_end (void)
233 /* Start reading input from a new file.
234 Return start of caller's part of buffer. */
237 input_scrub_new_file (const char *filename
)
239 input_file_open (filename
, !flag_no_comments
);
240 physical_input_file
= filename
[0] ? filename
: _("{standard input}");
241 physical_input_line
= 0;
244 return (buffer_start
+ BEFORE_SIZE
);
247 /* Include a file from the current file. Save our state, cause it to
248 be restored on EOF, and begin handling a new file. Same result as
249 input_scrub_new_file. */
252 input_scrub_include_file (const char *filename
, char *position
)
254 next_saved_file
= input_scrub_push (position
);
255 return input_scrub_new_file (filename
);
258 /* Start getting input from an sb structure. This is used when
259 expanding a macro. */
262 input_scrub_include_sb (sb
*from
, char *position
, int is_expansion
)
266 if (macro_nest
> max_macro_nest
)
267 as_fatal (_("macros nested too deeply"));
270 #ifdef md_macro_start
277 next_saved_file
= input_scrub_push (position
);
279 /* Allocate sufficient space: from->len + optional newline. */
280 newline
= from
->len
>= 1 && from
->ptr
[0] != '\n';
281 sb_build (&from_sb
, from
->len
+ newline
);
282 from_sb_is_expansion
= is_expansion
;
285 /* Add the sentinel required by read.c. */
286 sb_add_char (&from_sb
, '\n');
288 sb_scrub_and_add_sb (&from_sb
, from
);
290 /* Make sure the parser looks at defined contents when it scans for
291 e.g. end-of-line at the end of a macro. */
292 sb_terminate (&from_sb
);
296 /* These variables are reset by input_scrub_push. Restore them
297 since we are, after all, still at the same point in the file. */
298 logical_input_line
= next_saved_file
->logical_input_line
;
299 logical_input_file
= next_saved_file
->logical_input_file
;
303 input_scrub_close (void)
306 physical_input_line
= 0;
307 logical_input_line
= -1;
311 input_scrub_next_buffer (char **bufp
)
313 char *limit
; /*->just after last char of buffer. */
315 if (sb_index
!= (size_t) -1)
317 if (sb_index
>= from_sb
.len
)
320 if (from_sb_is_expansion
)
322 cond_finish_check (macro_nest
);
324 /* Allow the target to clean up per-macro expansion
330 partial_where
= NULL
;
332 if (next_saved_file
!= NULL
)
333 *bufp
= input_scrub_pop (next_saved_file
);
334 return partial_where
;
337 partial_where
= from_sb
.ptr
+ from_sb
.len
;
339 *bufp
= from_sb
.ptr
+ sb_index
;
340 sb_index
= from_sb
.len
;
341 return partial_where
;
346 memmove (buffer_start
+ BEFORE_SIZE
, partial_where
, partial_size
);
347 memcpy (buffer_start
+ BEFORE_SIZE
, save_source
, AFTER_SIZE
);
353 char *start
= buffer_start
+ BEFORE_SIZE
+ partial_size
;
355 *bufp
= buffer_start
+ BEFORE_SIZE
;
356 limit
= input_file_give_next_buffer (start
);
360 /* End of this file. */
363 as_warn (_("end of file not at end of a line; newline inserted"));
364 p
= buffer_start
+ BEFORE_SIZE
+ partial_size
;
370 /* Terminate the buffer to avoid confusing TC_EOL_IN_INSN. */
373 /* Find last newline. */
374 for (p
= limit
- 1; *p
!= '\n' || TC_EOL_IN_INSN (p
); --p
)
380 /* We found a newline in the newly read chars. */
382 partial_size
= limit
- p
;
384 /* Save the fragment after that last newline. */
385 memcpy (save_source
, partial_where
, (int) AFTER_SIZE
);
386 memcpy (partial_where
, AFTER_STRING
, (int) AFTER_SIZE
);
387 return partial_where
;
390 /* Didn't find a newline. Read more text. */
391 partial_size
= limit
- (buffer_start
+ BEFORE_SIZE
);
392 if (buffer_length
- input_file_buffer_size () < partial_size
)
394 /* Increase the buffer when it doesn't have room for the
395 next block of input. */
397 buffer_start
= XRESIZEVEC (char, buffer_start
,
399 + BEFORE_SIZE
+ AFTER_SIZE
+ 1));
403 /* Tell the listing we've finished the file. */
406 /* If we should pop to another file at EOF, do it. */
407 partial_where
= NULL
;
409 *bufp
= input_scrub_pop (next_saved_file
);
411 return partial_where
;
414 /* The remaining part of this file deals with line numbers, error
415 messages and so on. Return TRUE if we opened any file. */
418 seen_at_least_1_file (void)
420 return (physical_input_file
!= NULL
);
424 bump_line_counters (void)
426 if (sb_index
== (size_t) -1)
428 ++physical_input_line
;
429 if (logical_input_line
>= 0)
430 ++logical_input_line
;
434 /* Tells us what the new logical line number and file are.
435 If the line_number is -1, we don't change the current logical line
436 number. If it is -2, we decrement the logical line number (this is
437 to support the .appfile pseudo-op inserted into the stream by
439 If the fname is NULL, we don't change the current logical file name.
440 Returns nonzero if the filename actually changes. */
443 new_logical_line_flags (const char *fname
, /* DON'T destroy it! We point to it! */
452 if (line_number
!= -1)
457 /* FIXME: we could check that include nesting is correct. */
463 if (line_number
>= 0)
464 logical_input_line
= line_number
;
465 else if (line_number
== -1 && fname
&& !*fname
&& (flags
& (1 << 2)))
467 logical_input_file
= physical_input_file
;
468 logical_input_line
= physical_input_line
;
473 && (logical_input_file
== NULL
474 || filename_cmp (logical_input_file
, fname
)))
476 logical_input_file
= fname
;
484 new_logical_line (const char *fname
, int line_number
)
486 return new_logical_line_flags (fname
, line_number
, 0);
490 /* Return the current physical input file name and line number, if known */
493 as_where_physical (unsigned int *linep
)
495 if (physical_input_file
!= NULL
)
498 *linep
= physical_input_line
;
499 return physical_input_file
;
507 /* Return the current file name and line number. */
510 as_where (unsigned int *linep
)
512 if (logical_input_file
!= NULL
513 && (linep
== NULL
|| logical_input_line
>= 0))
516 *linep
= logical_input_line
;
517 return logical_input_file
;
520 return as_where_physical (linep
);
This page took 0.04635 seconds and 4 git commands to generate.