gas/input-scrub.c

   1 /* input_scrub.c - Break up input buffers into whole numbers of lines.
   2    Copyright (C) 1987, 90, 91, 92, 93, 94, 95, 96, 97, 2000
   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
  20    02111-1307, USA.  */
  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")
  55 #define AFTER_STRING ("\0")     /* memcpy of 0 chars might choke.  */
  56 #define BEFORE_SIZE (1)
  57 #define AFTER_SIZE  (1)
  58
  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.  */
  62 static char save_source[AFTER_SIZE];
  63 /* Because we need AFTER_STRING just after last */
  64 /* full line, it clobbers 1st part of partial */
  65 /* line. So we preserve 1st part of partial */
  66 /* line here.  */
  67 static unsigned int buffer_length;      /* What is the largest size buffer that */
  68 /* input_file_give_next_buffer() could */
  69 /* return to us? */
  70
  71 /* The index into an sb structure we are reading from.  -1 if none.  */
  72 static int sb_index = -1;
  73
  74 /* If we are reading from an sb structure, this is it.  */
  75 static sb from_sb;
  76
  77 /* Should we do a conditional check on from_sb? */
  78 static int from_sb_is_expansion = 1;
  79
  80 /* The number of nested sb structures we have included.  */
  81 int macro_nest;
  82
  83 /* We can have more than one source file open at once, though the info for all
  84    but the latest one are saved off in a struct input_save.  These files remain
  85    open, so we are limited by the number of open files allowed by the
  86    underlying OS. We may also sequentially read more than one source file in an
  87    assembly.  */
  88
  89 /* We must track the physical file and line number for error messages. We also
  90    track a "logical" file and line number corresponding to (C?)  compiler
  91    source line numbers.  Whenever we open a file we must fill in
  92    physical_input_file. So if it is NULL we have not opened any files yet.  */
  93
  94 static char *physical_input_file;
  95 static char *logical_input_file;
  96
  97 typedef unsigned int line_numberT;      /* 1-origin line number in a source file.  */
  98 /* A line ends in '\n' or eof.  */
  99
 100 static line_numberT physical_input_line;
 101 static int logical_input_line;
 102
 103 /* Struct used to save the state of the input handler during include files */
 104 struct input_save
 105   {
 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   };
 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,
 128    we automatically pop to that file.  */
 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
 134    area, which can be restored by passing it to input_scrub_pop().  */
 135 static struct input_save *
 136 input_scrub_push (saved_position)
 137      char *saved_position;
 138 {
 139   register struct input_save *saved;
 140
 141   saved = (struct input_save *) xmalloc (sizeof *saved);
 142
 143   saved->saved_position = saved_position;
 144   saved->buffer_start = buffer_start;
 145   saved->partial_where = partial_where;
 146   saved->partial_size = partial_size;
 147   saved->buffer_length = buffer_length;
 148   saved->physical_input_file = physical_input_file;
 149   saved->logical_input_file = logical_input_file;
 150   saved->physical_input_line = physical_input_line;
 151   saved->logical_input_line = logical_input_line;
 152   saved->sb_index = sb_index;
 153   saved->from_sb = from_sb;
 154   saved->from_sb_is_expansion = from_sb_is_expansion;
 155   memcpy (saved->save_source, save_source, sizeof (save_source));
 156   saved->next_saved_file = next_saved_file;
 157   saved->input_file_save = input_file_push ();
 158
 159   input_file_begin ();          /* Reinitialize! */
 160   logical_input_line = -1;
 161   logical_input_file = (char *) NULL;
 162   buffer_length = input_file_buffer_size ();
 163   sb_index = -1;
 164
 165   buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE));
 166   memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
 167
 168   return saved;
 169 }                               /* input_scrub_push() */
 170
 171 static char *
 172 input_scrub_pop (saved)
 173      struct input_save *saved;
 174 {
 175   char *saved_position;
 176
 177   input_scrub_end ();           /* Finish off old buffer */
 178
 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));
 194
 195   free (saved);
 196   return saved_position;
 197 }
 198 \f
 199
 200 void
 201 input_scrub_begin ()
 202 {
 203   know (strlen (BEFORE_STRING) == BEFORE_SIZE);
 204   know (strlen (AFTER_STRING) == AFTER_SIZE || (AFTER_STRING[0] == '\0' && AFTER_SIZE == 1));
 205
 206   input_file_begin ();
 207
 208   buffer_length = input_file_buffer_size ();
 209
 210   buffer_start = xmalloc ((BEFORE_SIZE + buffer_length + buffer_length + AFTER_SIZE));
 211   memcpy (buffer_start, BEFORE_STRING, (int) BEFORE_SIZE);
 212
 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);
 219 }
 220
 221 void
 222 input_scrub_end ()
 223 {
 224   if (buffer_start)
 225     {
 226       free (buffer_start);
 227       buffer_start = 0;
 228       input_file_end ();
 229     }
 230 }
 231
 232 /* Start reading input from a new file.  */
 233
 234 char *                          /* Return start of caller's part of buffer.  */
 235 input_scrub_new_file (filename)
 236      char *filename;
 237 {
 238   input_file_open (filename, !flag_no_comments);
 239   physical_input_file = filename[0] ? filename : _("{standard input}");
 240   physical_input_line = 0;
 241
 242   partial_size = 0;
 243   return (buffer_start + BEFORE_SIZE);
 244 }
 245
 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.  */
 249
 250 char *
 251 input_scrub_include_file (filename, position)
 252      char *filename;
 253      char *position;
 254 {
 255   next_saved_file = input_scrub_push (position);
 256   return input_scrub_new_file (filename);
 257 }
 258
 259 /* Start getting input from an sb structure.  This is used when
 260    expanding a macro.  */
 261
 262 void
 263 input_scrub_include_sb (from, position, is_expansion)
 264      sb *from;
 265      char *position;
 266      int is_expansion;
 267 {
 268   if (macro_nest > max_macro_nest)
 269     as_fatal (_("macros nested too deeply"));
 270   ++macro_nest;
 271
 272 #ifdef md_macro_start
 273   if (is_expansion)
 274     {
 275       md_macro_start ();
 276     }
 277 #endif
 278
 279   next_saved_file = input_scrub_push (position);
 280
 281   sb_new (&from_sb);
 282   from_sb_is_expansion = is_expansion;
 283   if (from->len >= 1 && from->ptr[0] != '\n')
 284     {
 285       /* Add the sentinel required by read.c.  */
 286       sb_add_char (&from_sb, '\n');
 287     }
 288   sb_add_sb (&from_sb, from);
 289   sb_index = 1;
 290
 291   /* These variables are reset by input_scrub_push.  Restore them
 292      since we are, after all, still at the same point in the file.  */
 293   logical_input_line = next_saved_file->logical_input_line;
 294   logical_input_file = next_saved_file->logical_input_file;
 295 }
 296
 297 void
 298 input_scrub_close ()
 299 {
 300   input_file_close ();
 301 }
 302
 303 char *
 304 input_scrub_next_buffer (bufp)
 305      char **bufp;
 306 {
 307   register char *limit;         /*->just after last char of buffer.  */
 308
 309   if (sb_index >= 0)
 310     {
 311       if (sb_index >= from_sb.len)
 312         {
 313           sb_kill (&from_sb);
 314           if (from_sb_is_expansion
 315               )
 316             {
 317               cond_finish_check (macro_nest);
 318 #ifdef md_macro_end
 319               /* allow the target to clean up per-macro expansion data */
 320               md_macro_end ();
 321 #endif
 322             }
 323           --macro_nest;
 324           partial_where = NULL;
 325           if (next_saved_file != NULL)
 326             *bufp = input_scrub_pop (next_saved_file);
 327           return partial_where;
 328         }
 329
 330       partial_where = from_sb.ptr + from_sb.len;
 331       partial_size = 0;
 332       *bufp = from_sb.ptr + sb_index;
 333       sb_index = from_sb.len;
 334       return partial_where;
 335     }
 336
 337   *bufp = buffer_start + BEFORE_SIZE;
 338
 339   if (partial_size)
 340     {
 341       memcpy (buffer_start + BEFORE_SIZE, partial_where,
 342               (unsigned int) partial_size);
 343       memcpy (buffer_start + BEFORE_SIZE, save_source, AFTER_SIZE);
 344     }
 345   limit = input_file_give_next_buffer (buffer_start
 346                                        + BEFORE_SIZE
 347                                        + partial_size);
 348   if (limit)
 349     {
 350       register char *p;         /* Find last newline.  */
 351
 352       for (p = limit - 1; *p != '\n'; --p)
 353         ;
 354       ++p;
 355
 356       while (p <= buffer_start + BEFORE_SIZE)
 357         {
 358           int limoff;
 359
 360           limoff = limit - buffer_start;
 361           buffer_length += input_file_buffer_size ();
 362           buffer_start = xrealloc (buffer_start,
 363                                    (BEFORE_SIZE
 364                                     + 2 * buffer_length
 365                                     + AFTER_SIZE));
 366           *bufp = buffer_start + BEFORE_SIZE;
 367           limit = input_file_give_next_buffer (buffer_start + limoff);
 368
 369           if (limit == NULL)
 370             {
 371               as_warn (_("partial line at end of file ignored"));
 372               partial_where = NULL;
 373               if (next_saved_file)
 374                 *bufp = input_scrub_pop (next_saved_file);
 375               return NULL;
 376             }
 377
 378           for (p = limit - 1; *p != '\n'; --p)
 379             ;
 380           ++p;
 381         }
 382
 383       partial_where = p;
 384       partial_size = limit - p;
 385       memcpy (save_source, partial_where, (int) AFTER_SIZE);
 386       memcpy (partial_where, AFTER_STRING, (int) AFTER_SIZE);
 387     }
 388   else
 389     {
 390       partial_where = 0;
 391       if (partial_size > 0)
 392         {
 393           as_warn (_("Partial line at end of file ignored"));
 394         }
 395
 396       /* Tell the listing we've finished the file.  */
 397       LISTING_EOF ();
 398
 399       /* If we should pop to another file at EOF, do it.  */
 400       if (next_saved_file)
 401         {
 402           *bufp = input_scrub_pop (next_saved_file);    /* Pop state */
 403           /* partial_where is now correct to return, since we popped it.  */
 404         }
 405     }
 406   return (partial_where);
 407 }                               /* input_scrub_next_buffer() */
 408 \f
 409 /*
 410  * The remaining part of this file deals with line numbers, error
 411  * messages and so on.
 412  */
 413
 414 int
 415 seen_at_least_1_file ()         /* TRUE if we opened any file.  */
 416 {
 417   return (physical_input_file != NULL);
 418 }
 419
 420 void
 421 bump_line_counters ()
 422 {
 423   if (sb_index < 0)
 424     {
 425       ++physical_input_line;
 426       if (logical_input_line >= 0)
 427         ++logical_input_line;
 428     }
 429 }
 430 \f
 431 /*
 432  *                      new_logical_line()
 433  *
 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
 438  * do_scrub_chars).
 439  * If the fname is NULL, we don't change the current logical file name.
 440  * Returns nonzero if the filename actually changes.
 441  */
 442 int
 443 new_logical_line (fname, line_number)
 444      char *fname;               /* DON'T destroy it! We point to it! */
 445      int line_number;
 446 {
 447   if (line_number >= 0)
 448     logical_input_line = line_number;
 449   else if (line_number == -2 && logical_input_line > 0)
 450     --logical_input_line;
 451
 452   if (fname
 453       && (logical_input_file == NULL
 454           || strcmp (logical_input_file, fname)))
 455     {
 456       logical_input_file = fname;
 457       return 1;
 458     }
 459   else
 460     return 0;
 461 }                               /* new_logical_line() */
 462 \f
 463 /*
 464  *                      a s _ w h e r e ()
 465  *
 466  * Return the current file name and line number.
 467  * namep should be char * const *, but there are compilers which screw
 468  * up declarations like that, and it's easier to avoid it.
 469  */
 470 void
 471 as_where (namep, linep)
 472      char **namep;
 473      unsigned int *linep;
 474 {
 475   if (logical_input_file != NULL
 476       && (linep == NULL || logical_input_line >= 0))
 477     {
 478       *namep = logical_input_file;
 479       if (linep != NULL)
 480         *linep = logical_input_line;
 481     }
 482   else if (physical_input_file != NULL)
 483     {
 484       *namep = physical_input_file;
 485       if (linep != NULL)
 486         *linep = physical_input_line;
 487     }
 488   else
 489     {
 490       *namep = 0;
 491       if (linep != NULL)
 492         *linep = 0;
 493     }
 494 }                               /* as_where() */
 495 \f
 496
 497 /*
 498  *                      a s _ h o w m u c h ()
 499  *
 500  * Output to given stream how much of line we have scanned so far.
 501  * Assumes we have scanned up to and including input_line_pointer.
 502  * No free '\n' at end of line.
 503  */
 504 void
 505 as_howmuch (stream)
 506      FILE *stream;              /* Opened for write please.  */
 507 {
 508   register char *p;             /* Scan input line.  */
 509   /* register char c; JF unused */
 510
 511   for (p = input_line_pointer - 1; *p != '\n'; --p)
 512     {
 513     }
 514   ++p;                          /* p->1st char of line.  */
 515   for (; p <= input_line_pointer; p++)
 516     {
 517       /* Assume ASCII. EBCDIC & other micro-computer char sets ignored.  */
 518       as_1_char ((unsigned char) *p, stream);
 519     }
 520 }
 521
 522 static void
 523 as_1_char (c, stream)
 524      unsigned int c;
 525      FILE *stream;
 526 {
 527   if (c > 127)
 528     {
 529       (void) putc ('%', stream);
 530       c -= 128;
 531     }
 532   if (c < 32)
 533     {
 534       (void) putc ('^', stream);
 535       c += '@';
 536     }
 537   (void) putc (c, stream);
 538 }
 539
 540 /* end of input_scrub.c */