src/location.h

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