data/location.cc

   1 # C++ skeleton for Bison
   2
   3 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
   4 # Free Software Foundation, 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, 2009])
  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 (pos1.line == pos2.line
 125             && pos1.column == pos2.column
 126             && (pos1.filename == pos2.filename
 127                 || (pos1.filename && pos2.filename
 128                     && *pos1.filename == *pos2.filename)));
 129   }
 130
 131   /// Compare two position objects.
 132   inline bool
 133   operator!= (const position& pos1, const position& pos2)
 134   {
 135     return !(pos1 == pos2);
 136   }
 137 ]])[
 138   /** \brief Intercept output stream redirection.
 139    ** \param ostr the destination output stream
 140    ** \param pos a reference to the position to redirect
 141    */
 142   inline std::ostream&
 143   operator<< (std::ostream& ostr, const position& pos)
 144   {
 145     if (pos.filename)
 146       ostr << *pos.filename << ':';
 147     return ostr << pos.line << '.' << pos.column;
 148   }
 149
 150 ]b4_namespace_close[
 151 #endif // not BISON_POSITION_HH]
 152 @output(b4_dir_prefix[]location.hh@)@
 153 b4_copyright([Locations for Bison parsers in C++])[
 154
 155 /**
 156  ** \file location.hh
 157  ** Define the ]b4_namespace_ref[::location class.
 158  */
 159
 160 #ifndef BISON_LOCATION_HH
 161 # define BISON_LOCATION_HH
 162
 163 # include <iostream>
 164 # include <string>
 165 # include "position.hh"
 166
 167 ]b4_namespace_open[
 168
 169   /// Abstract a location.
 170   class location
 171   {
 172   public:
 173 ]m4_ifdef([b4_location_constructors], [
 174     /// Construct a location from \a b to \a e.
 175     location (const position& b, const position& e)
 176       : begin (b)
 177       , end (e)
 178     {
 179     }
 180
 181     /// Construct a 0-width location in \a p.
 182     explicit location (const position& p = position ())
 183       : begin (p)
 184       , end (p)
 185     {
 186     }
 187
 188     /// Construct a 0-width location in \a f, \a l, \a c.
 189     explicit location (]b4_percent_define_get([[filename_type]])[* f,
 190                        unsigned int l = ]b4_location_initial_line[u,
 191                        unsigned int c = ]b4_location_initial_column[u)
 192       : begin (f, l, c)
 193       , end (f, l, c)
 194     {
 195     }
 196
 197 ])[
 198     /// Initialization.
 199     inline void initialize (]b4_percent_define_get([[filename_type]])[* fn)
 200     {
 201       begin.initialize (fn);
 202       end = begin;
 203     }
 204
 205     /** \name Line and Column related manipulators
 206      ** \{ */
 207   public:
 208     /// Reset initial location to final location.
 209     inline void step ()
 210     {
 211       begin = end;
 212     }
 213
 214     /// Extend the current location to the COUNT next columns.
 215     inline void columns (unsigned int count = 1)
 216     {
 217       end += count;
 218     }
 219
 220     /// Extend the current location to the COUNT next lines.
 221     inline void lines (unsigned int count = 1)
 222     {
 223       end.lines (count);
 224     }
 225     /** \} */
 226
 227
 228   public:
 229     /// Beginning of the located region.
 230     position begin;
 231     /// End of the located region.
 232     position end;
 233   };
 234
 235   /// Join two location objects to create a location.
 236   inline const location operator+ (const location& begin, const location& end)
 237   {
 238     location res = begin;
 239     res.end = end.end;
 240     return res;
 241   }
 242
 243   /// Add two location objects.
 244   inline const location operator+ (const location& begin, unsigned int width)
 245   {
 246     location res = begin;
 247     res.columns (width);
 248     return res;
 249   }
 250
 251   /// Add and assign a location.
 252   inline location& operator+= (location& res, unsigned int width)
 253   {
 254     res.columns (width);
 255     return res;
 256   }
 257 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 258   /// Compare two location objects.
 259   inline bool
 260   operator== (const location& loc1, const location& loc2)
 261   {
 262     return loc1.begin == loc2.begin && loc1.end == loc2.end;
 263   }
 264
 265   /// Compare two location objects.
 266   inline bool
 267   operator!= (const location& loc1, const location& loc2)
 268   {
 269     return !(loc1 == loc2);
 270   }
 271 ]])[
 272   /** \brief Intercept output stream redirection.
 273    ** \param ostr the destination output stream
 274    ** \param loc a reference to the location to redirect
 275    **
 276    ** Avoid duplicate information.
 277    */
 278   inline std::ostream& operator<< (std::ostream& ostr, const location& loc)
 279   {
 280     position last = loc.end - 1;
 281     ostr << loc.begin;
 282     if (last.filename
 283         && (!loc.begin.filename
 284             || *loc.begin.filename != *last.filename))
 285       ostr << '-' << last;
 286     else if (loc.begin.line != last.line)
 287       ostr << '-' << last.line  << '.' << last.column;
 288     else if (loc.begin.column != last.column)
 289       ostr << '-' << last.column;
 290     return ostr;
 291   }
 292
 293 ]b4_namespace_close[
 294
 295 #endif // not BISON_LOCATION_HH]
 296 m4_divert_pop(0)
 297 m4_popdef([b4_copyright_years])dnl
 298 m4_changecom([#])