data/location.cc

   1 # C++ skeleton for Bison
   2
   3 # Copyright (C) 2002-2012 Free Software Foundation, Inc.
   4
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 m4_pushdef([b4_copyright_years],
  19            [2002-2012])
  20
  21 # b4_position_define
  22 # ------------------
  23 # Define class position.
  24 m4_define([b4_position_define],
  25 [[  /// Abstract a position.
  26   class position
  27   {
  28   public:
  29 ]m4_ifdef([b4_location_constructors], [[
  30     /// Construct a position.
  31     explicit position (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
  32                        unsigned int l = ]b4_location_initial_line[u,
  33                        unsigned int c = ]b4_location_initial_column[u)
  34       : filename (f)
  35       , line (l)
  36       , column (c)
  37     {
  38     }
  39
  40 ]])[
  41     /// Initialization.
  42     void initialize (]b4_percent_define_get([[filename_type]])[* fn = YY_NULL,
  43                      unsigned int l = ]b4_location_initial_line[u,
  44                      unsigned int c = ]b4_location_initial_column[u)
  45     {
  46       filename = fn;
  47       line = l;
  48       column = c;
  49     }
  50
  51     /** \name Line and Column related manipulators
  52      ** \{ */
  53     /// (line related) Advance to the COUNT next lines.
  54     void lines (int count = 1)
  55     {
  56       column = ]b4_location_initial_column[u;
  57       line += count;
  58     }
  59
  60     /// (column related) Advance to the COUNT next columns.
  61     void columns (int count = 1)
  62     {
  63       column = std::max (]b4_location_initial_column[u, column + count);
  64     }
  65     /** \} */
  66
  67     /// File name to which this position refers.
  68     ]b4_percent_define_get([[filename_type]])[* filename;
  69     /// Current line number.
  70     unsigned int line;
  71     /// Current column number.
  72     unsigned int column;
  73   };
  74
  75   /// Add and assign a position.
  76   inline position&
  77   operator+= (position& res, const int width)
  78   {
  79     res.columns (width);
  80     return res;
  81   }
  82
  83   /// Add two position objects.
  84   inline const position
  85   operator+ (const position& begin, const int width)
  86   {
  87     position res = begin;
  88     return res += width;
  89   }
  90
  91   /// Add and assign a position.
  92   inline position&
  93   operator-= (position& res, const int width)
  94   {
  95     return res += -width;
  96   }
  97
  98   /// Add two position objects.
  99   inline const position
 100   operator- (const position& begin, const int width)
 101   {
 102     return begin + -width;
 103   }
 104 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 105   /// Compare two position objects.
 106   inline bool
 107   operator== (const position& pos1, const position& pos2)
 108   {
 109     return (pos1.line == pos2.line
 110             && pos1.column == pos2.column
 111             && (pos1.filename == pos2.filename
 112                 || (pos1.filename && pos2.filename
 113                     && *pos1.filename == *pos2.filename)));
 114   }
 115
 116   /// Compare two position objects.
 117   inline bool
 118   operator!= (const position& pos1, const position& pos2)
 119   {
 120     return !(pos1 == pos2);
 121   }
 122 ]])[
 123   /** \brief Intercept output stream redirection.
 124    ** \param ostr the destination output stream
 125    ** \param pos a reference to the position to redirect
 126    */
 127   template <typename YYChar>
 128   inline std::basic_ostream<YYChar>&
 129   operator<< (std::basic_ostream<YYChar>& ostr, const position& pos)
 130   {
 131     if (pos.filename)
 132       ostr << *pos.filename << ':';
 133     return ostr << pos.line << '.' << pos.column;
 134   }
 135 ]])
 136
 137
 138 # b4_location_define
 139 # ------------------
 140 m4_define([b4_location_define],
 141 [[  /// Abstract a location.
 142   class location
 143   {
 144   public:
 145 ]m4_ifdef([b4_location_constructors], [
 146     /// Construct a location from \a b to \a e.
 147     location (const position& b, const position& e)
 148       : begin (b)
 149       , end (e)
 150     {
 151     }
 152
 153     /// Construct a 0-width location in \a p.
 154     explicit location (const position& p = position ())
 155       : begin (p)
 156       , end (p)
 157     {
 158     }
 159
 160     /// Construct a 0-width location in \a f, \a l, \a c.
 161     explicit location (]b4_percent_define_get([[filename_type]])[* f,
 162                        unsigned int l = ]b4_location_initial_line[u,
 163                        unsigned int c = ]b4_location_initial_column[u)
 164       : begin (f, l, c)
 165       , end (f, l, c)
 166     {
 167     }
 168
 169 ])[
 170     /// Initialization.
 171     void initialize (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
 172                      unsigned int l = ]b4_location_initial_line[u,
 173                      unsigned int c = ]b4_location_initial_column[u)
 174     {
 175       begin.initialize (f, l, c);
 176       end = begin;
 177     }
 178
 179     /** \name Line and Column related manipulators
 180      ** \{ */
 181   public:
 182     /// Reset initial location to final location.
 183     void step ()
 184     {
 185       begin = end;
 186     }
 187
 188     /// Extend the current location to the COUNT next columns.
 189     void columns (unsigned int count = 1)
 190     {
 191       end += count;
 192     }
 193
 194     /// Extend the current location to the COUNT next lines.
 195     void lines (unsigned int count = 1)
 196     {
 197       end.lines (count);
 198     }
 199     /** \} */
 200
 201
 202   public:
 203     /// Beginning of the located region.
 204     position begin;
 205     /// End of the located region.
 206     position end;
 207   };
 208
 209   /// Join two location objects to create a location.
 210   inline const location operator+ (const location& begin, const location& end)
 211   {
 212     location res = begin;
 213     res.end = end.end;
 214     return res;
 215   }
 216
 217   /// Add two location objects.
 218   inline const location operator+ (const location& begin, unsigned int width)
 219   {
 220     location res = begin;
 221     res.columns (width);
 222     return res;
 223   }
 224
 225   /// Add and assign a location.
 226   inline location& operator+= (location& res, unsigned int width)
 227   {
 228     res.columns (width);
 229     return res;
 230   }
 231 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 232   /// Compare two location objects.
 233   inline bool
 234   operator== (const location& loc1, const location& loc2)
 235   {
 236     return loc1.begin == loc2.begin && loc1.end == loc2.end;
 237   }
 238
 239   /// Compare two location objects.
 240   inline bool
 241   operator!= (const location& loc1, const location& loc2)
 242   {
 243     return !(loc1 == loc2);
 244   }
 245 ]])[
 246   /** \brief Intercept output stream redirection.
 247    ** \param ostr the destination output stream
 248    ** \param loc a reference to the location to redirect
 249    **
 250    ** Avoid duplicate information.
 251    */
 252   template <typename YYChar>
 253   inline std::basic_ostream<YYChar>&
 254   operator<< (std::basic_ostream<YYChar>& ostr, const location& loc)
 255   {
 256     position last = loc.end - 1;
 257     ostr << loc.begin;
 258     if (last.filename
 259         && (!loc.begin.filename
 260             || *loc.begin.filename != *last.filename))
 261       ostr << '-' << last;
 262     else if (loc.begin.line != last.line)
 263       ostr << '-' << last.line  << '.' << last.column;
 264     else if (loc.begin.column != last.column)
 265       ostr << '-' << last.column;
 266     return ostr;
 267   }
 268 ]])
 269
 270
 271 # We do want M4 expansion after # for CPP macros.
 272 m4_changecom()
 273 b4_defines_if([
 274 b4_output_begin([b4_dir_prefix[]position.hh])
 275 b4_copyright([Positions for Bison parsers in C++])[
 276
 277 /**
 278  ** \file ]b4_dir_prefix[position.hh
 279  ** Define the ]b4_namespace_ref[::position class.
 280  */
 281
 282 ]b4_cpp_guard_open([b4_dir_prefix[]position.hh])[
 283
 284 # include <algorithm> // std::max
 285 # include <iostream>
 286 # include <string>
 287
 288 ]b4_null_define[
 289
 290 ]b4_namespace_open[
 291 ]b4_position_define[
 292 ]b4_namespace_close[
 293 ]b4_cpp_guard_close([b4_dir_prefix[]position.hh])
 294 b4_output_end()
 295
 296
 297 b4_output_begin([b4_dir_prefix[]location.hh])
 298 b4_copyright([Locations for Bison parsers in C++])[
 299
 300 /**
 301  ** \file ]b4_dir_prefix[location.hh
 302  ** Define the ]b4_namespace_ref[::location class.
 303  */
 304
 305 ]b4_cpp_guard_open([b4_dir_prefix[]location.hh])[
 306
 307 # include "position.hh"
 308
 309 ]b4_namespace_open[
 310 ]b4_location_define[
 311 ]b4_namespace_close[
 312 ]b4_cpp_guard_close([b4_dir_prefix[]location.hh])
 313 b4_output_end()
 314 ])
 315
 316
 317 m4_popdef([b4_copyright_years])