input-scrub.c revision 78828
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. 5 6 This file is part of GAS, the GNU Assembler. 7 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. 12 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. 17 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. */ 22 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" 28 29/* 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 preceeded 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. 40 */ 41 42/* 43 * We don't care how filthy our buffers are, but our callers assume 44 * that the following sanitation has already been done. 45 * 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. 53 */ 54 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) 59 60static char *buffer_start; /*->1st char of full buffer area. */ 61static char *partial_where; /*->after last full line in buffer. */ 62static int partial_size; /* >=0. Number of chars in partial line in buffer. */ 63 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. */ 67static char save_source[AFTER_SIZE]; 68 69/* What is the largest size buffer that input_file_give_next_buffer() 70 could return to us? */ 71static unsigned int buffer_length; 72 73/* The index into an sb structure we are reading from. -1 if none. */ 74static int sb_index = -1; 75 76/* If we are reading from an sb structure, this is it. */ 77static sb from_sb; 78 79/* Should we do a conditional check on from_sb? */ 80static int from_sb_is_expansion = 1; 81 82/* The number of nested sb structures we have included. */ 83int macro_nest; 84 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. */ 90 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. */ 95 96static char *physical_input_file; 97static char *logical_input_file; 98 99typedef unsigned int line_numberT; /* 1-origin line number in a source file. */ 100/* A line ends in '\n' or eof. */ 101 102static line_numberT physical_input_line; 103static int logical_input_line; 104 105/* Struct used to save the state of the input handler during include files */ 106struct 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. */ 122}; 123 124static struct input_save *input_scrub_push PARAMS ((char *saved_position)); 125static char *input_scrub_pop PARAMS ((struct input_save *arg)); 126static void as_1_char PARAMS ((unsigned int c, FILE * stream)); 127 128/* Saved information about the file that .include'd this one. When we hit EOF, 129 we automatically pop to that file. */ 130 131static struct input_save *next_saved_file; 132 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(). */ 136 137static struct input_save * 138input_scrub_push (saved_position) 139 char *saved_position; 140{ 141 register struct input_save *saved; 142 143 saved = (struct input_save *) xmalloc (sizeof *saved); 144 145 saved->saved_position = saved_position; 146 saved->buffer_start = buffer_start; 147 saved->partial_where = partial_where; 148 saved->partial_size = partial_size; 149 saved->buffer_length = buffer_length; 150 saved->physical_input_file = physical_input_file; 151 saved->logical_input_file = logical_input_file; 152 saved->physical_input_line = physical_input_line; 153 saved->logical_input_line = logical_input_line; 154 saved->sb_index = sb_index; 155 saved->from_sb = from_sb; 156 saved->from_sb_is_expansion = from_sb_is_expansion; 157 memcpy (saved->save_source, save_source, sizeof (save_source)); 158 saved->next_saved_file = next_saved_file; 159 saved->input_file_save = input_file_push (); 160 161 input_file_begin (); /* Reinitialize! */ 162 logical_input_line = -1; 163 logical_input_file = (char *) NULL; 164 buffer_length = input_file_buffer_size (); 165 sb_index = -1; 166 167 buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE)); 168 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE); 169 170 return saved; 171} 172 173static char * 174input_scrub_pop (saved) 175 struct input_save *saved; 176{ 177 char *saved_position; 178 179 input_scrub_end (); /* Finish off old buffer */ 180 181 input_file_pop (saved->input_file_save); 182 saved_position = saved->saved_position; 183 buffer_start = saved->buffer_start; 184 buffer_length = saved->buffer_length; 185 physical_input_file = saved->physical_input_file; 186 logical_input_file = saved->logical_input_file; 187 physical_input_line = saved->physical_input_line; 188 logical_input_line = saved->logical_input_line; 189 sb_index = saved->sb_index; 190 from_sb = saved->from_sb; 191 from_sb_is_expansion = saved->from_sb_is_expansion; 192 partial_where = saved->partial_where; 193 partial_size = saved->partial_size; 194 next_saved_file = saved->next_saved_file; 195 memcpy (save_source, saved->save_source, sizeof (save_source)); 196 197 free (saved); 198 return saved_position; 199} 200 201void 202input_scrub_begin () 203{ 204 know (strlen (BEFORE_STRING) == BEFORE_SIZE); 205 know (strlen (AFTER_STRING) == AFTER_SIZE 206 || (AFTER_STRING[0] == '\0' && AFTER_SIZE == 1)); 207 208 input_file_begin (); 209 210 buffer_length = input_file_buffer_size (); 211 212 buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE)); 213 memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE); 214 215 /* Line number things. */ 216 logical_input_line = -1; 217 logical_input_file = (char *) NULL; 218 physical_input_file = NULL; /* No file read yet. */ 219 next_saved_file = NULL; /* At EOF, don't pop to any other file */ 220 do_scrub_begin (flag_m68k_mri); 221} 222 223void 224input_scrub_end () 225{ 226 if (buffer_start) 227 { 228 free (buffer_start); 229 buffer_start = 0; 230 input_file_end (); 231 } 232} 233 234/* Start reading input from a new file. 235 Return start of caller's part of buffer. */ 236 237char * 238input_scrub_new_file (filename) 239 char *filename; 240{ 241 input_file_open (filename, !flag_no_comments); 242 physical_input_file = filename[0] ? filename : _("{standard input}"); 243 physical_input_line = 0; 244 245 partial_size = 0; 246 return (buffer_start + BEFORE_SIZE); 247} 248 249/* Include a file from the current file. Save our state, cause it to 250 be restored on EOF, and begin handling a new file. Same result as 251 input_scrub_new_file. */ 252 253char * 254input_scrub_include_file (filename, position) 255 char *filename; 256 char *position; 257{ 258 next_saved_file = input_scrub_push (position); 259 return input_scrub_new_file (filename); 260} 261 262/* Start getting input from an sb structure. This is used when 263 expanding a macro. */ 264 265void 266input_scrub_include_sb (from, position, is_expansion) 267 sb *from; 268 char *position; 269 int is_expansion; 270{ 271 if (macro_nest > max_macro_nest) 272 as_fatal (_("macros nested too deeply")); 273 ++macro_nest; 274 275#ifdef md_macro_start 276 if (is_expansion) 277 { 278 md_macro_start (); 279 } 280#endif 281 282 next_saved_file = input_scrub_push (position); 283 284 sb_new (&from_sb); 285 from_sb_is_expansion = is_expansion; 286 if (from->len >= 1 && from->ptr[0] != '\n') 287 { 288 /* Add the sentinel required by read.c. */ 289 sb_add_char (&from_sb, '\n'); 290 } 291 sb_add_sb (&from_sb, from); 292 sb_index = 1; 293 294 /* These variables are reset by input_scrub_push. Restore them 295 since we are, after all, still at the same point in the file. */ 296 logical_input_line = next_saved_file->logical_input_line; 297 logical_input_file = next_saved_file->logical_input_file; 298} 299 300void 301input_scrub_close () 302{ 303 input_file_close (); 304} 305 306char * 307input_scrub_next_buffer (bufp) 308 char **bufp; 309{ 310 register char *limit; /*->just after last char of buffer. */ 311 312 if (sb_index >= 0) 313 { 314 if (sb_index >= from_sb.len) 315 { 316 sb_kill (&from_sb); 317 if (from_sb_is_expansion 318 ) 319 { 320 cond_finish_check (macro_nest); 321#ifdef md_macro_end 322 /* Allow the target to clean up per-macro expansion 323 data. */ 324 md_macro_end (); 325#endif 326 } 327 --macro_nest; 328 partial_where = NULL; 329 if (next_saved_file != NULL) 330 *bufp = input_scrub_pop (next_saved_file); 331 return partial_where; 332 } 333 334 partial_where = from_sb.ptr + from_sb.len; 335 partial_size = 0; 336 *bufp = from_sb.ptr + sb_index; 337 sb_index = from_sb.len; 338 return partial_where; 339 } 340 341 *bufp = buffer_start + BEFORE_SIZE; 342 343 if (partial_size) 344 { 345 memcpy (buffer_start + BEFORE_SIZE, partial_where, 346 (unsigned int) partial_size); 347 memcpy (buffer_start + BEFORE_SIZE, save_source, AFTER_SIZE); 348 } 349 limit = input_file_give_next_buffer (buffer_start 350 + BEFORE_SIZE 351 + partial_size); 352 if (limit) 353 { 354 register char *p; /* Find last newline. */ 355 356 for (p = limit - 1; *p != '\n'; --p) 357 ; 358 ++p; 359 360 while (p <= buffer_start + BEFORE_SIZE) 361 { 362 int limoff; 363 364 limoff = limit - buffer_start; 365 buffer_length += input_file_buffer_size (); 366 buffer_start = xrealloc (buffer_start, 367 (BEFORE_SIZE 368 + 2 * buffer_length 369 + AFTER_SIZE)); 370 *bufp = buffer_start + BEFORE_SIZE; 371 limit = input_file_give_next_buffer (buffer_start + limoff); 372 373 if (limit == NULL) 374 { 375 as_warn (_("partial line at end of file ignored")); 376 partial_where = NULL; 377 if (next_saved_file) 378 *bufp = input_scrub_pop (next_saved_file); 379 return NULL; 380 } 381 382 for (p = limit - 1; *p != '\n'; --p) 383 ; 384 ++p; 385 } 386 387 partial_where = p; 388 partial_size = limit - p; 389 memcpy (save_source, partial_where, (int) AFTER_SIZE); 390 memcpy (partial_where, AFTER_STRING, (int) AFTER_SIZE); 391 } 392 else 393 { 394 partial_where = 0; 395 if (partial_size > 0) 396 { 397 as_warn (_("Partial line at end of file ignored")); 398 } 399 400 /* Tell the listing we've finished the file. */ 401 LISTING_EOF (); 402 403 /* If we should pop to another file at EOF, do it. */ 404 if (next_saved_file) 405 { 406 *bufp = input_scrub_pop (next_saved_file); /* Pop state */ 407 /* partial_where is now correct to return, since we popped it. */ 408 } 409 } 410 return (partial_where); 411} 412 413/* The remaining part of this file deals with line numbers, error 414 messages and so on. Return TRUE if we opened any file. */ 415 416int 417seen_at_least_1_file () 418{ 419 return (physical_input_file != NULL); 420} 421 422void 423bump_line_counters () 424{ 425 if (sb_index < 0) 426 { 427 ++physical_input_line; 428 if (logical_input_line >= 0) 429 ++logical_input_line; 430 } 431} 432 433/* Tells us what the new logical line number and file are. 434 If the line_number is -1, we don't change the current logical line 435 number. If it is -2, we decrement the logical line number (this is 436 to support the .appfile pseudo-op inserted into the stream by 437 do_scrub_chars). 438 If the fname is NULL, we don't change the current logical file name. 439 Returns nonzero if the filename actually changes. */ 440 441int 442new_logical_line (fname, line_number) 443 char *fname; /* DON'T destroy it! We point to it! */ 444 int line_number; 445{ 446 if (line_number >= 0) 447 logical_input_line = line_number; 448 else if (line_number == -2 && logical_input_line > 0) 449 --logical_input_line; 450 451 if (fname 452 && (logical_input_file == NULL 453 || strcmp (logical_input_file, fname))) 454 { 455 logical_input_file = fname; 456 return 1; 457 } 458 else 459 return 0; 460} 461 462/* Return the current file name and line number. 463 namep should be char * const *, but there are compilers which screw 464 up declarations like that, and it's easier to avoid it. */ 465 466void 467as_where (namep, linep) 468 char **namep; 469 unsigned int *linep; 470{ 471 if (logical_input_file != NULL 472 && (linep == NULL || logical_input_line >= 0)) 473 { 474 *namep = logical_input_file; 475 if (linep != NULL) 476 *linep = logical_input_line; 477 } 478 else if (physical_input_file != NULL) 479 { 480 *namep = physical_input_file; 481 if (linep != NULL) 482 *linep = physical_input_line; 483 } 484 else 485 { 486 *namep = 0; 487 if (linep != NULL) 488 *linep = 0; 489 } 490} 491 492/* Output to given stream how much of line we have scanned so far. 493 Assumes we have scanned up to and including input_line_pointer. 494 No free '\n' at end of line. */ 495 496void 497as_howmuch (stream) 498 FILE *stream; /* Opened for write please. */ 499{ 500 register char *p; /* Scan input line. */ 501 502 for (p = input_line_pointer - 1; *p != '\n'; --p) 503 { 504 } 505 ++p; /* p->1st char of line. */ 506 for (; p <= input_line_pointer; p++) 507 { 508 /* Assume ASCII. EBCDIC & other micro-computer char sets ignored. */ 509 as_1_char ((unsigned char) *p, stream); 510 } 511} 512 513static void 514as_1_char (c, stream) 515 unsigned int c; 516 FILE *stream; 517{ 518 if (c > 127) 519 { 520 (void) putc ('%', stream); 521 c -= 128; 522 } 523 if (c < 32) 524 { 525 (void) putc ('^', stream); 526 c += '@'; 527 } 528 (void) putc (c, stream); 529} 530