data/location.cc

   1 # C++ skeleton for Bison
   2
   3 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation,
   4 # Inc.
   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 m4_pushdef([b4_copyright_years],
  20            [2002, 2003, 2004, 2005, 2006, 2007, 2008])
  21
  22 # We do want M4 expansion after # for CPP macros.
  23 m4_changecom()
  24 m4_divert_push(0)dnl
  25 @output(b4_dir_prefix[]position.hh@)@
  26 b4_copyright([Positions for Bison parsers in C++])[
  27
  28 /**
  29  ** \file position.hh
  30  ** Define the ]b4_namespace_ref[::position class.
  31  */
  32
  33 #ifndef BISON_POSITION_HH
  34 # define BISON_POSITION_HH
  35
  36 # include <iostream>
  37 # include <string>
  38 # include <algorithm>
  39
  40 ]b4_namespace_open[
  41   /// Abstract a position.
  42   class position
  43   {
  44   public:
  45 ]m4_ifdef([b4_location_constructors], [[
  46     /// Construct a position.
  47     explicit position (]b4_percent_define_get([[filename_type]])[* f = 0,
  48                        unsigned int l = ]b4_location_initial_line[u,
  49                        unsigned int c = ]b4_location_initial_column[u)
  50       : filename (f)
  51       , line (l)
  52       , column (c)
  53     {
  54     }
  55
  56 ]])[
  57     /// Initialization.
  58     inline void initialize (]b4_percent_define_get([[filename_type]])[* fn)
  59     {
  60       filename = fn;
  61       line = ]b4_location_initial_line[u;
  62       column = ]b4_location_initial_column[u;
  63     }
  64
  65     /** \name Line and Column related manipulators
  66      ** \{ */
  67     /// (line related) Advance to the COUNT next lines.
  68     /// Set current column to initial value.
  69     inline void lines (int count = 1)
  70     {
  71       column = ]b4_location_initial_column[u;
  72       line += count;
  73     }
  74
  75     /// (column related) Advance to the COUNT next columns.
  76     inline void columns (int count = 1)
  77     {
  78       column = std::max (]b4_location_initial_column[u, column + count);
  79     }
  80     /** \} */
  81
  82     /// File name to which this position refers.
  83     ]b4_percent_define_get([[filename_type]])[* filename;
  84     /// Current line number.
  85     unsigned int line;
  86     /// Current column number.
  87     unsigned int column;
  88   };
  89
  90   /// Add and assign a position.
  91   inline const position&
  92   operator+= (position& res, const int width)
  93   {
  94     res.columns (width);
  95     return res;
  96   }
  97
  98   /// Add two position objects.
  99   inline const position
 100   operator+ (const position& begin, const int width)
 101   {
 102     position res = begin;
 103     return res += width;
 104   }
 105
 106   /// Add and assign a position.
 107   inline const position&
 108   operator-= (position& res, const int width)
 109   {
 110     return res += -width;
 111   }
 112
 113   /// Add two position objects.
 114   inline const position
 115   operator- (const position& begin, const int width)
 116   {
 117     return begin + -width;
 118   }
 119 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 120   /// Compare two position objects.
 121   inline bool
 122   operator== (const position& pos1, const position& pos2)
 123   {
 124     return
 125       (pos1.filename == pos2.filename
 126        || pos1.filename && pos2.filename && *pos1.filename == *pos2.filename)
 127       && pos1.line == pos2.line && pos1.column == pos2.column;
 128   }
 129
 130   /// Compare two position objects.
 131   inline bool
 132   operator!= (const position& pos1, const position& pos2)
 133   {
 134     return !(pos1 == pos2);
 135   }
 136 ]])[
 137   /** \brief Intercept output stream redirection.
 138    ** \param ostr the destination output stream
 139    ** \param pos a reference to the position to redirect
 140    */
 141   inline std::ostream&
 142   operator<< (std::ostream& ostr, const position& pos)
 143   {
 144     if (pos.filename)
 145       ostr << *pos.filename << ':';
 146     return ostr << pos.line << '.' << pos.column;
 147   }
 148
 149 ]b4_namespace_close[
 150 #endif // not BISON_POSITION_HH]
 151 @output(b4_dir_prefix[]location.hh@)@
 152 b4_copyright([Locations for Bison parsers in C++])[
 153
 154 /**
 155  ** \file location.hh
 156  ** Define the ]b4_namespace_ref[::location class.
 157  */
 158
 159 #ifndef BISON_LOCATION_HH
 160 # define BISON_LOCATION_HH
 161
 162 # include <iostream>
 163 # include <string>
 164 # include "position.hh"
 165
 166 ]b4_namespace_open[
 167
 168   /// Abstract a location.
 169   class location
 170   {
 171   public:
 172 ]m4_ifdef([b4_location_constructors], [
 173     /// Construct a location from \a b to \a e.
 174     location (const position& b, const position& e)
 175       : begin (b)
 176       , end (e)
 177     {
 178     }
 179
 180     /// Construct a 0-width location in \a p.
 181     explicit location (const position& p = position ())
 182       : begin (p)
 183       , end (p)
 184     {
 185     }
 186
 187     /// Construct a 0-width location in \a f, \a l, \a c.
 188     explicit location (]b4_percent_define_get([[filename_type]])[* f,
 189                        unsigned int l = ]b4_location_initial_line[u,
 190                        unsigned int c = ]b4_location_initial_column[u)
 191       : begin (f, l, c)
 192       , end (f, l, c)
 193     {
 194     }
 195
 196 ])[
 197     /// Initialization.
 198     inline void initialize (]b4_percent_define_get([[filename_type]])[* fn)
 199     {
 200       begin.initialize (fn);
 201       end = begin;
 202     }
 203
 204     /** \name Line and Column related manipulators
 205      ** \{ */
 206   public:
 207     /// Reset initial location to final location.
 208     inline void step ()
 209     {
 210       begin = end;
 211     }
 212
 213     /// Extend the current location to the COUNT next columns.
 214     inline void columns (unsigned int count = 1)
 215     {
 216       end += count;
 217     }
 218
 219     /// Extend the current location to the COUNT next lines.
 220     inline void lines (unsigned int count = 1)
 221     {
 222       end.lines (count);
 223     }
 224     /** \} */
 225
 226
 227   public:
 228     /// Beginning of the located region.
 229     position begin;
 230     /// End of the located region.
 231     position end;
 232   };
 233
 234   /// Join two location objects to create a location.
 235   inline const location operator+ (const location& begin, const location& end)
 236   {
 237     location res = begin;
 238     res.end = end.end;
 239     return res;
 240   }
 241
 242   /// Add two location objects.
 243   inline const location operator+ (const location& begin, unsigned int width)
 244   {
 245     location res = begin;
 246     res.columns (width);
 247     return res;
 248   }
 249
 250   /// Add and assign a location.
 251   inline location& operator+= (location& res, unsigned int width)
 252   {
 253     res.columns (width);
 254     return res;
 255   }
 256 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 257   /// Compare two location objects.
 258   inline bool
 259   operator== (const location& loc1, const location& loc2)
 260   {
 261     return loc1.begin == loc2.begin && loc1.end == loc2.end;
 262   }
 263
 264   /// Compare two location objects.
 265   inline bool
 266   operator!= (const location& loc1, const location& loc2)
 267   {
 268     return !(loc1 == loc2);
 269   }
 270 ]])[
 271   /** \brief Intercept output stream redirection.
 272    ** \param ostr the destination output stream
 273    ** \param loc a reference to the location to redirect
 274    **
 275    ** Avoid duplicate information.
 276    */
 277   inline std::ostream& operator<< (std::ostream& ostr, const location& loc)
 278   {
 279     position last = loc.end - 1;
 280     ostr << loc.begin;
 281     if (last.filename
 282         && (!loc.begin.filename
 283             || *loc.begin.filename != *last.filename))
 284       ostr << '-' << last;
 285     else if (loc.begin.line != last.line)
 286       ostr << '-' << last.line  << '.' << last.column;
 287     else if (loc.begin.column != last.column)
 288       ostr << '-' << last.column;
 289     return ostr;
 290   }
 291
 292 ]b4_namespace_close[
 293
 294 #endif // not BISON_LOCATION_HH]
 295 m4_divert_pop(0)
 296 m4_popdef([b4_copyright_years])dnl
 297 m4_changecom([#])