src/location.h

   1 /* Locations for Bison
   2    Copyright (C) 2002, 2004-2010 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   /* If nonnegative, the (origin-1) line that contains the boundary.
  31      If this is INT_MAX, the line number has overflowed.
  32
  33      Meaningless and not displayed if negative.
  34   */
  35   int line;
  36
  37   /* If nonnegative, the (origin-1) column just after the boundary.
  38      This is neither a byte count, nor a character count; it is a
  39      column count.  If this is INT_MAX, the column number has
  40      overflowed.
  41
  42      Meaningless and not displayed if negative.
  43   */
  44   int column;
  45
  46 } boundary;
  47
  48 /* Set the position of \a a. */
  49 static inline void
  50 boundary_set (boundary *b, const char *f, int l, int c)
  51 {
  52   b->file = f;
  53   b->line = l;
  54   b->column = c;
  55 }
  56
  57 /* Return -1, 0, 1, depending whether a is before, equal, or
  58    after b.  */
  59 static inline int
  60 boundary_cmp (boundary a, boundary b)
  61 {
  62   int res = strcmp (a.file, b.file);
  63   if (!res)
  64     res = a.line - b.line;
  65   if (!res)
  66     res = a.column - b.column;
  67   return res;
  68 }
  69
  70 /* Return nonzero if A and B are equal boundaries.  */
  71 static inline bool
  72 equal_boundaries (boundary a, boundary b)
  73 {
  74   return (a.column == b.column
  75           && a.line == b.line
  76           && UNIQSTR_EQ (a.file, b.file));
  77 }
  78
  79 /* A location, that is, a region of source code.  */
  80 typedef struct
  81 {
  82   /* Boundary just before the location starts.  */
  83   boundary start;
  84
  85   /* Boundary just after the location ends.  */
  86   boundary end;
  87
  88 } location;
  89
  90 #define YYLTYPE location
  91
  92 #define EMPTY_LOCATION_INIT {{NULL, 0, 0}, {NULL, 0, 0}}
  93 extern location const empty_location;
  94
  95 /* Set *LOC and adjust scanner cursor to account for token TOKEN of
  96    size SIZE.  */
  97 void location_compute (location *loc,
  98                        boundary *cur, char const *token, size_t size);
  99
 100 /* Print location to file. Return number of actually printed
 101    characters.  */
 102 unsigned location_print (FILE *out, location loc);
 103
 104 /* Return -1, 0, 1, depending whether a is before, equal, or
 105    after b.  */
 106 static inline int
 107 location_cmp (location a, location b)
 108 {
 109   int res = boundary_cmp (a.start, b.start);
 110   if (!res)
 111     res = boundary_cmp (a.end, b.end);
 112   return res;
 113 }
 114
 115 /* LOC_STR must be formatted as `file:line.column', it will be modified.  */
 116 void boundary_set_from_string (boundary *bound, char *loc_str);
 117
 118 #endif /* ! defined LOCATION_H_ */