Make-lang.in, [...]: Update copyright years and boilerplate.

[thirdparty/gcc.git] / gcc / fortran / scanner.c

/* Character scanner.
   Copyright (C) 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
   Contributed by Andy Vaught

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

/* Set of subroutines to (ultimately) return the next character to the
   various matching subroutines.  This file's job is to read files and
   build up lines that are parsed by the parser.  This means that we
   handle continuation lines and "include" lines.

   The first thing the scanner does is to load an entire file into
   memory.  We load the entire file into memory for a couple reasons.
   The first is that we want to be able to deal with nonseekable input
   (pipes, stdin) and there is a lot of backing up involved during
   parsing.

   The second is that we want to be able to print the locus of errors,
   and an error on line 999999 could conflict with something on line
   one.  Given nonseekable input, we've got to store the whole thing.

   One thing that helps are the column truncation limits that give us
   an upper bound on the size of individual lines.  We don't store the
   truncated stuff.

   From the scanner's viewpoint, the higher level subroutines ask for
   new characters and do a lot of jumping backwards.  */

#include "config.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>

#include "gfortran.h"

/* Structure for holding module and include file search path.  */
typedef struct gfc_directorylist
{
  char *path;
  struct gfc_directorylist *next;
}
gfc_directorylist;

/* List of include file search directories.  */
static gfc_directorylist *include_dirs;

static gfc_file *first_file, *first_duplicated_file;
static int continue_flag, end_flag;

gfc_file *gfc_current_file;


/* Main scanner initialization.  */

void
gfc_scanner_init_1 (void)
{

  gfc_current_file = NULL;
  first_file = NULL;
  first_duplicated_file = NULL;
  end_flag = 0;
}


/* Main scanner destructor.  */

void
gfc_scanner_done_1 (void)
{

  linebuf *lp, *lp2;
  gfc_file *fp, *fp2;

  for (fp = first_file; fp; fp = fp2)
    {

      if (fp->start != NULL)
	{
	  /* Free linebuf blocks */
	  for (fp2 = fp->next; fp2; fp2 = fp2->next)
	    if (fp->start == fp2->start)
	      fp2->start = NULL;

	  for (lp = fp->start; lp; lp = lp2)
	    {
	      lp2 = lp->next;
	      gfc_free (lp);
	    }
	}

      fp2 = fp->next;
      gfc_free (fp);
    }

  for (fp = first_duplicated_file; fp; fp = fp2)
    {
      fp2 = fp->next;
      gfc_free (fp);
    }
}


/* Adds path to the list pointed to by list.  */

void
gfc_add_include_path (const char *path)
{
  gfc_directorylist *dir;
  const char *p;

  p = path;
  while (*p == ' ' || *p == '\t')  /* someone might do 'gfortran "-I include"' */
    if (*p++ == '\0')
      return;

  dir = include_dirs;
  if (!dir)
    {
      dir = include_dirs = gfc_getmem (sizeof (gfc_directorylist));
    }
  else
    {
      while (dir->next)
	dir = dir->next;

      dir->next = gfc_getmem (sizeof (gfc_directorylist));
      dir = dir->next;
    }

  dir->next = NULL;
  dir->path = gfc_getmem (strlen (p) + 2);
  strcpy (dir->path, p);
  strcat (dir->path, "/");	/* make '/' last character */
}


/* Release resources allocated for options.  */

void
gfc_release_include_path (void)
{
  gfc_directorylist *p;

  gfc_free (gfc_option.module_dir);
  while (include_dirs != NULL)
    {
      p = include_dirs;
      include_dirs = include_dirs->next;
      gfc_free (p->path);
      gfc_free (p);
    }
}


/* Opens file for reading, searching through the include directories
   given if necessary.  */

FILE *
gfc_open_included_file (const char *name)
{
  char fullname[PATH_MAX];
  gfc_directorylist *p;
  FILE *f;

  f = gfc_open_file (name);
  if (f != NULL)
    return f;

  for (p = include_dirs; p; p = p->next)
    {
      if (strlen (p->path) + strlen (name) + 1 > PATH_MAX)
	continue;

      strcpy (fullname, p->path);
      strcat (fullname, name);

      f = gfc_open_file (fullname);
      if (f != NULL)
	return f;
    }

  return NULL;
}


/* Return a pointer to the current locus.  */

locus *
gfc_current_locus (void)
{

  if (gfc_current_file == NULL)
    return NULL;
  return &gfc_current_file->loc;
}


/* Let a caller move the current read pointer (backwards).  */

void
gfc_set_locus (locus * lp)
{

  gfc_current_file->loc = *lp;
}


/* Test to see if we're at the end of the main source file.  */

int
gfc_at_end (void)
{

  return end_flag;
}


/* Test to see if we're at the end of the current file.  */

int
gfc_at_eof (void)
{

  if (gfc_at_end ())
    return 1;

  if (gfc_current_file->start->lines == 0)
    return 1;			/* Null file */

  if (gfc_current_file->loc.lp == NULL)
    return 1;

  return 0;
}


/* Test to see if we're at the beginning of a new line.  */

int
gfc_at_bol (void)
{
  int i;

  if (gfc_at_eof ())
    return 1;

  i = gfc_current_file->loc.line;

  return gfc_current_file->loc.nextc == gfc_current_file->loc.lp->line[i];
}


/* Test to see if we're at the end of a line.  */

int
gfc_at_eol (void)
{

  if (gfc_at_eof ())
    return 1;

  return *gfc_current_file->loc.nextc == '\0';
}


/* Advance the current line pointer to the next line.  */

void
gfc_advance_line (void)
{
  locus *locp;
  linebuf *lp;

  if (gfc_at_end ())
    return;

  locp = &gfc_current_file->loc;
  lp = locp->lp;
  if (lp == NULL)
    return;

  if (++locp->line >= lp->lines)
    {
      locp->lp = lp = lp->next;
      if (lp == NULL)
	return;	  /* End of this file */

      locp->line = 0;
    }

  locp->nextc = lp->line[locp->line];
}


/* Get the next character from the input, advancing gfc_current_file's
   locus.  When we hit the end of the line or the end of the file, we
   start returning a '\n' in order to complete the current statement.
   No Fortran line conventions are implemented here.

   Requiring explicit advances to the next line prevents the parse
   pointer from being on the wrong line if the current statement ends
   prematurely.  */

static int
next_char (void)
{
  locus *locp;
  int c;

  /* End the current include level, but not if we're in the middle
     of processing a continuation. */
  if (gfc_at_eof ())
    {
      if (continue_flag != 0 || gfc_at_end ())
	return '\n';

      if (gfc_current_file->included_by == NULL)
	end_flag = 1;

      return '\n';
    }

  locp = &gfc_current_file->loc;
  if (locp->nextc == NULL)
    return '\n';

  c = *locp->nextc++;
  if (c == '\0')
    {
      locp->nextc--;	/* Stay stuck on this line */
      c = '\n';
    }

  return c;
}


/* Checks the current line buffer to see if it is an include line.  If
   so, we load the new file and prepare to read from it.  Include
   lines happen at a lower level than regular parsing because the
   string-matching subroutine is far simpler than the normal one.

   We never return a syntax error because a statement like "include = 5"
   is perfectly legal.  We return zero if no include was processed or
   nonzero if we matched an include.  */

int
gfc_check_include (void)
{
  char c, quote, path[PATH_MAX + 1];
  const char *include;
  locus start;
  int i;

  include = "include";

  start = *gfc_current_locus ();
  gfc_gobble_whitespace ();

  /* Match the 'include' */
  while (*include != '\0')
    if (*include++ != gfc_next_char ())
      goto no_include;

  gfc_gobble_whitespace ();

  quote = next_char ();
  if (quote != '"' && quote != '\'')
    goto no_include;

  /* Copy the filename */
  for (i = 0;;)
    {
      c = next_char ();
      if (c == '\n')
	goto no_include;	/* No close quote */
      if (c == quote)
	break;

  /* This shouldn't happen-- PATH_MAX should be way longer than the
     max line length.  */

      if (i >= PATH_MAX)
	gfc_internal_error ("Pathname of include file is too long at %C");

      path[i++] = c;
    }

  path[i] = '\0';
  if (i == 0)
    goto no_include;	/* No filename! */

  /* At this point, we've got a filename to be included.  The rest
     of the include line is ignored */

  gfc_new_file (path, gfc_current_file->form);
  return 1;

no_include:
  gfc_set_locus (&start);
  return 0;
}


/* Skip a comment.  When we come here the parse pointer is positioned
   immediately after the comment character.  If we ever implement
   compiler directives withing comments, here is where we parse the
   directive.  */

static void
skip_comment_line (void)
{
  char c;

  do
    {
      c = next_char ();
    }
  while (c != '\n');

  gfc_advance_line ();
}


/* Comment lines are null lines, lines containing only blanks or lines
   on which the first nonblank line is a '!'.  */

static void
skip_free_comments (void)
{
  locus start;
  char c;

  for (;;)
    {
      start = *gfc_current_locus ();
      if (gfc_at_eof ())
	break;

      do
	{
	  c = next_char ();
	}
      while (gfc_is_whitespace (c));

      if (c == '\n')
	{
	  gfc_advance_line ();
	  continue;
	}

      if (c == '!')
	{
	  skip_comment_line ();
	  continue;
	}

      break;
    }

  gfc_set_locus (&start);
}


/* Skip comment lines in fixed source mode.  We have the same rules as
   in skip_free_comment(), except that we can have a 'c', 'C' or '*'
   in column 1. and a '!' cannot be in* column 6.  */

static void
skip_fixed_comments (void)
{
  locus start;
  int col;
  char c;

  for (;;)
    {
      start = *gfc_current_locus ();
      if (gfc_at_eof ())
	break;

      c = next_char ();
      if (c == '\n')
	{
	  gfc_advance_line ();
	  continue;
	}

      if (c == '!' || c == 'c' || c == 'C' || c == '*')
	{
	  skip_comment_line ();
	  continue;
	}

      col = 1;
      do
	{
	  c = next_char ();
	  col++;
	}
      while (gfc_is_whitespace (c));

      if (c == '\n')
	{
	  gfc_advance_line ();
	  continue;
	}

      if (col != 6 && c == '!')
	{
	  skip_comment_line ();
	  continue;
	}

      break;
    }

  gfc_set_locus (&start);
}


/* Skips the current line if it is a comment.  Assumes that we are at
   the start of the current line.  */

void
gfc_skip_comments (void)
{

  if (!gfc_at_bol () || gfc_current_file->form == FORM_FREE)
    skip_free_comments ();
  else
    skip_fixed_comments ();
}


/* Get the next character from the input, taking continuation lines
   and end-of-line comments into account.  This implies that comment
   lines between continued lines must be eaten here.  For higher-level
   subroutines, this flattens continued lines into a single logical
   line.  The in_string flag denotes whether we're inside a character
   context or not.  */

int
gfc_next_char_literal (int in_string)
{
  locus old_loc;
  int i, c;

  continue_flag = 0;

restart:
  c = next_char ();
  if (gfc_at_end ())
    return c;

  if (gfc_current_file->form == FORM_FREE)
    {

      if (!in_string && c == '!')
	{
	  /* This line can't be continued */
	  do
	    {
	      c = next_char ();
	    }
	  while (c != '\n');

	  goto done;
	}

      if (c != '&')
	goto done;

      /* If the next nonblank character is a ! or \n, we've got a
         continuation line. */
      old_loc = gfc_current_file->loc;

      c = next_char ();
      while (gfc_is_whitespace (c))
	c = next_char ();

      /* Character constants to be continued cannot have commentary
         after the '&'.  */

      if (in_string && c != '\n')
	{
	  gfc_set_locus (&old_loc);
	  c = '&';
	  goto done;
	}

      if (c != '!' && c != '\n')
	{
	  gfc_set_locus (&old_loc);
	  c = '&';
	  goto done;
	}

      continue_flag = 1;
      if (c == '!')
	skip_comment_line ();
      else
	gfc_advance_line ();

      /* We've got a continuation line and need to find where it continues.
         First eat any comment lines.  */
      gfc_skip_comments ();

      /* Now that we have a non-comment line, probe ahead for the
         first non-whitespace character.  If it is another '&', then
         reading starts at the next character, otherwise we must back
         up to where the whitespace started and resume from there.  */

      old_loc = *gfc_current_locus ();

      c = next_char ();
      while (gfc_is_whitespace (c))
	c = next_char ();

      if (c != '&')
	gfc_set_locus (&old_loc);

    }
  else
    {
      /* Fixed form continuation.  */
      if (!in_string && c == '!')
	{
	  /* Skip comment at end of line.  */
	  do
	    {
	      c = next_char ();
	    }
	  while (c != '\n');
	}

      if (c != '\n')
	goto done;

      continue_flag = 1;
      old_loc = *gfc_current_locus ();

      gfc_advance_line ();
      gfc_skip_comments ();

      /* See if this line is a continuation line.  */
      for (i = 0; i < 5; i++)
	{
	  c = next_char ();
	  if (c != ' ')
	    goto not_continuation;
	}

      c = next_char ();
      if (c == '0' || c == ' ')
	goto not_continuation;
    }

  /* Ready to read first character of continuation line, which might
     be another continuation line!  */
  goto restart;

not_continuation:
  c = '\n';
  gfc_set_locus (&old_loc);

done:
  continue_flag = 0;
  return c;
}


/* Get the next character of input, folded to lowercase.  In fixed
   form mode, we also ignore spaces.  When matcher subroutines are
   parsing character literals, they have to call
   gfc_next_char_literal().  */

int
gfc_next_char (void)
{
  int c;

  do
    {
      c = gfc_next_char_literal (0);
    }
  while (gfc_current_file->form == FORM_FIXED && gfc_is_whitespace (c));

  return TOLOWER (c);
}


int
gfc_peek_char (void)
{
  locus old_loc;
  int c;

  old_loc = *gfc_current_locus ();
  c = gfc_next_char ();
  gfc_set_locus (&old_loc);

  return c;
}


/* Recover from an error.  We try to get past the current statement
   and get lined up for the next.  The next statement follows a '\n'
   or a ';'.  We also assume that we are not within a character
   constant, and deal with finding a '\'' or '"'.  */

void
gfc_error_recovery (void)
{
  char c, delim;

  if (gfc_at_eof ())
    return;

  for (;;)
    {
      c = gfc_next_char ();
      if (c == '\n' || c == ';')
	break;

      if (c != '\'' && c != '"')
	{
	  if (gfc_at_eof ())
	    break;
	  continue;
	}
      delim = c;

      for (;;)
	{
	  c = next_char ();

	  if (c == delim)
	    break;
	  if (c == '\n')
	    goto done;
	  if (c == '\\')
	    {
	      c = next_char ();
	      if (c == '\n')
		goto done;
	    }
	}
      if (gfc_at_eof ())
	break;
    }

done:
  if (c == '\n')
    gfc_advance_line ();
}


/* Read ahead until the next character to be read is not whitespace.  */

void
gfc_gobble_whitespace (void)
{
  locus old_loc;
  int c;

  do
    {
      old_loc = *gfc_current_locus ();
      c = gfc_next_char_literal (0);
    }
  while (gfc_is_whitespace (c));

  gfc_set_locus (&old_loc);
}


/* Load a single line into the buffer.  We truncate lines that are too
   long.  In fixed mode, we expand a tab that occurs within the
   statement label region to expand to spaces that leave the next
   character in the source region.  */

static void
load_line (FILE * input, gfc_source_form form, char *buffer,
	   char *filename, int linenum)
{
  int c, maxlen, i, trunc_flag;

  maxlen = (form == FORM_FREE) ? 132 : gfc_option.fixed_line_length;

  i = 0;

  for (;;)
    {
      c = fgetc (input);

      if (c == EOF)
	break;
      if (c == '\n')
	break;

      if (c == '\r')
	continue;		/* Gobble characters */
      if (c == '\0')
	continue;

      if (form == FORM_FIXED && c == '\t' && i <= 6)
	{			/* Tab expandsion */
	  while (i <= 6)
	    {
	      *buffer++ = ' ';
	      i++;
	    }

	  continue;
	}

      *buffer++ = c;
      i++;

      if (i >= maxlen)
	{			/* Truncate the rest of the line */
	  trunc_flag = 1;

	  for (;;)
	    {
	      c = fgetc (input);
	      if (c == '\n' || c == EOF)
		break;

	      if (gfc_option.warn_line_truncation
		  && trunc_flag
		  && !gfc_is_whitespace (c))
		{
		  gfc_warning_now ("Line %d of %s is being truncated",
				   linenum, filename);
		  trunc_flag = 0;
		}
	    }

	  ungetc ('\n', input);
	}
    }

  *buffer = '\0';
}


/* Load a file into memory by calling load_line until the file ends.  */

static void
load_file (FILE * input, gfc_file * fp)
{
  char *linep, line[GFC_MAX_LINE + 1];
  int len, linenum;
  linebuf *lp;

  fp->start = lp = gfc_getmem (sizeof (linebuf));

  linenum = 1;
  lp->lines = 0;
  lp->start_line = 1;
  lp->next = NULL;

  linep = (char *) (lp + 1);

  /* Load the file.  */
  for (;;)
    {
      load_line (input, fp->form, line, fp->filename, linenum);
      linenum++;

      len = strlen (line);

      if (feof (input) && len == 0)
	break;

      /* See if we need another linebuf.  */
      if (((char *) &lp->line[lp->lines + 2]) > linep - len - 1)
	{
	  lp->next = gfc_getmem (sizeof (linebuf));

	  lp->next->start_line = lp->start_line + lp->lines;
	  lp = lp->next;
	  lp->lines = 0;

	  linep = (char *) (lp + 1);
	}

      linep = linep - len - 1;
      lp->line[lp->lines++] = linep;
      strcpy (linep, line);
    }
}


/* Determine the source form from the filename extension.  We assume
   case insensitivity. */

static gfc_source_form
form_from_filename (const char *filename)
{

  static const struct
  {
    const char *extension;
    gfc_source_form form;
  }
  exttype[] =
  {
    {
    ".f90", FORM_FREE}
    ,
    {
    ".f95", FORM_FREE}
    ,
    {
    ".f", FORM_FIXED}
    ,
    {
    ".for", FORM_FIXED}
    ,
    {
    "", FORM_UNKNOWN}
  };		/* sentinel value */

  gfc_source_form f_form;
  const char *fileext;
  int i;

  /* Find end of file name.  */
  i = 0;
  while ((i < PATH_MAX) && (filename[i] != '\0'))
    i++;

  /* Improperly terminated or too-long filename.  */
  if (i == PATH_MAX)
    return FORM_UNKNOWN;

  /* Find last period.  */
  while (i >= 0 && (filename[i] != '.'))
    i--;

  /* Did we see a file extension?  */
  if (i < 0)
    return FORM_UNKNOWN; /* Nope  */

  /* Get file extension and compare it to others.  */
  fileext = &(filename[i]);

  i = -1;
  f_form = FORM_UNKNOWN;
  do
    {
      i++;
      if (strcasecmp (fileext, exttype[i].extension) == 0)
	{
	  f_form = exttype[i].form;
	  break;
	}
    }
  while (exttype[i].form != FORM_UNKNOWN);

  return f_form;
}


/* Open a new file and start scanning from that file.  Every new file
   gets a gfc_file node, even if it is a duplicate file.  Returns SUCCESS
   if everything went OK, FAILURE otherwise.  */

try
gfc_new_file (const char *filename, gfc_source_form form)
{
  gfc_file *fp, *fp2;
  FILE *input;
  int len;

  len = strlen (filename);
  if (len > PATH_MAX)
    {
      gfc_error_now ("Filename '%s' is too long- ignoring it", filename);
      return FAILURE;
    }

  fp = gfc_getmem (sizeof (gfc_file));

  /* Make sure this file isn't being included recursively.  */
  for (fp2 = gfc_current_file; fp2; fp2 = fp2->included_by)
    if (strcmp (filename, fp2->filename) == 0)
      {
	gfc_error_now ("Recursive inclusion of file '%s' at %C- ignoring it",
		       filename);
	gfc_free (fp);
	return FAILURE;
      }

  /* See if the file has already been included.  */
  for (fp2 = first_file; fp2; fp2 = fp2->next)
    if (strcmp (filename, fp2->filename) == 0)
      {
	*fp = *fp2;
	fp->next = first_duplicated_file;
	first_duplicated_file = fp;
	goto init_fp;
      }

  strcpy (fp->filename, filename);

  if (gfc_current_file == NULL)
    input = gfc_open_file (filename);
  else
    input = gfc_open_included_file (filename);

  if (input == NULL)
    {
      if (gfc_current_file == NULL)
	gfc_error_now ("Can't open file '%s'", filename);
      else
	gfc_error_now ("Can't open file '%s' included at %C", filename);

      gfc_free (fp);
      return FAILURE;
    }

  /* Decide which form the file will be read in as.  */
  if (form != FORM_UNKNOWN)
    fp->form = form;
  else
    {
      fp->form = form_from_filename (filename);

      if (fp->form == FORM_UNKNOWN)
	{
	  fp->form = FORM_FREE;
	  gfc_warning_now ("Reading file %s as free form", filename);
	}
    }

  fp->next = first_file;
  first_file = fp;

  load_file (input, fp);
  fclose (input);

init_fp:
  fp->included_by = gfc_current_file;
  gfc_current_file = fp;

  fp->loc.line = 0;
  fp->loc.lp = fp->start;
  fp->loc.nextc = fp->start->line[0];
  fp->loc.file = fp;

  return SUCCESS;
}