src/location.h

   1 /* Locations for Bison
   2    Copyright (C) 2002, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   3
   4    This file is part of Bison, the GNU Compiler Compiler.
   5
   6    This program 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 of the License, or
   9    (at your option) any later version.
  10
  11    This program 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.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef LOCATION_H_
  20 # define LOCATION_H_
  21
  22 # include "uniqstr.h"
  23
  24 /* A boundary between two characters.  */
  25 typedef struct
  26 {
  27   /* The name of the file that contains the boundary.  */
  28   uniqstr file;
  29
  30   /* The (origin-1) line that contains the boundary.
  31      If this is INT_MAX, the line number has overflowed.  */
  32   int line;
  33
  34   /* The (origin-1) column just after the boundary.  This is neither a
  35      byte count, nor a character count; it is a column count.
  36      If this is INT_MAX, the column number has overflowed.  */
  37   int column;
  38
  39 } boundary;
  40
  41 /* Set the position of \a a. */
  42 static inline void
  43 boundary_set (boundary *b, const char *f, int l, int c)
  44 {
  45   b->file = f;
  46   b->line = l;
  47   b->column = c;
  48 }
  49
  50 /* Return nonzero if A and B are equal boundaries.  */
  51 static inline bool
  52 equal_boundaries (boundary a, boundary b)
  53 {
  54   return (a.column == b.column
  55           && a.line == b.line
  56           && UNIQSTR_EQ (a.file, b.file));
  57 }
  58
  59 /* A location, that is, a region of source code.  */
  60 typedef struct
  61 {
  62   /* Boundary just before the location starts.  */
  63   boundary start;
  64
  65   /* Boundary just after the location ends.  */
  66   boundary end;
  67
  68 } location;
  69
  70 #define YYLTYPE location
  71
  72 #define EMPTY_LOCATION_INIT {{NULL, 0, 0}, {NULL, 0, 0}}
  73 extern location const empty_location;
  74
  75 /* Set *LOC and adjust scanner cursor to account for token TOKEN of
  76    size SIZE.  */
  77 void location_compute (location *loc,
  78                        boundary *cur, char const *token, size_t size);
  79
  80 void location_print (FILE *out, location loc);
  81
  82 /* LOC_STR must be formatted as `file:line.column', it will be modified.  */
  83 void boundary_set_from_string (boundary *bound, char *loc_str);
  84
  85 #endif /* ! defined LOCATION_H_ */