data/location.cc

   1 # C++ skeleton for Bison
   2
   3 # Copyright (C) 2002-2007, 2009-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
  19 b4_output_begin([b4_dir_prefix[]position.hh])
  20 b4_copyright([Positions for Bison parsers in C++],
  21              [2002-2007, 2009-2012])[
  22
  23 /**
  24  ** \file ]b4_dir_prefix[position.hh
  25  ** Define the ]b4_namespace_ref[::position class.
  26  */
  27
  28 ]b4_cpp_guard_open([b4_dir_prefix[]position.hh])[
  29
  30 # include <algorithm> // std::max
  31 # include <iostream>
  32 # include <string>
  33
  34 ]b4_null_define[
  35
  36 ]b4_namespace_open[
  37   /// Abstract a position.
  38   class position
  39   {
  40   public:
  41 ]m4_ifdef([b4_location_constructors], [[
  42     /// Construct a position.
  43     explicit position (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
  44                        unsigned int l = ]b4_location_initial_line[u,
  45                        unsigned int c = ]b4_location_initial_column[u)
  46       : filename (f)
  47       , line (l)
  48       , column (c)
  49     {
  50     }
  51
  52 ]])[
  53     /// Initialization.
  54     void initialize (]b4_percent_define_get([[filename_type]])[* fn = YY_NULL,
  55                      unsigned int l = ]b4_location_initial_line[u,
  56                      unsigned int c = ]b4_location_initial_column[u)
  57     {
  58       filename = fn;
  59       line = l;
  60       column = c;
  61     }
  62
  63     /** \name Line and Column related manipulators
  64      ** \{ */
  65     /// (line related) Advance to the COUNT next lines.
  66     void lines (int count = 1)
  67     {
  68       column = ]b4_location_initial_column[u;
  69       line += count;
  70     }
  71
  72     /// (column related) Advance to the COUNT next columns.
  73     void columns (int count = 1)
  74     {
  75       column = std::max (]b4_location_initial_column[u, column + count);
  76     }
  77     /** \} */
  78
  79     /// File name to which this position refers.
  80     ]b4_percent_define_get([[filename_type]])[* filename;
  81     /// Current line number.
  82     unsigned int line;
  83     /// Current column number.
  84     unsigned int column;
  85   };
  86
  87   /// Add and assign a position.
  88   inline position&
  89   operator+= (position& res, const int width)
  90   {
  91     res.columns (width);
  92     return res;
  93   }
  94
  95   /// Add two position objects.
  96   inline const position
  97   operator+ (const position& begin, const int width)
  98   {
  99     position res = begin;
 100     return res += width;
 101   }
 102
 103   /// Add and assign a position.
 104   inline position&
 105   operator-= (position& res, const int width)
 106   {
 107     return res += -width;
 108   }
 109
 110   /// Add two position objects.
 111   inline const position
 112   operator- (const position& begin, const int width)
 113   {
 114     return begin + -width;
 115   }
 116 ]b4_percent_define_flag_if([[define_location_comparison]], [[
 117   /// Compare two position objects.
 118   inline bool
 119   operator== (const position& pos1, const position& pos2)
 120   {
 121     return (pos1.line == pos2.line
 122             && pos1.column == pos2.column
 123             && (pos1.filename == pos2.filename
 124                 || (pos1.filename && pos2.filename
 125                     && *pos1.filename == *pos2.filename)));
 126   }
 127
 128   /// Compare two position objects.
 129   inline bool
 130   operator!= (const position& pos1, const position& pos2)
 131   {
 132     return !(pos1 == pos2);
 133   }
 134 ]])[
 135   /** \brief Intercept output stream redirection.
 136    ** \param ostr the destination output stream
 137    ** \param pos a reference to the position to redirect
 138    */
 139   inline std::ostream&
 140   operator<< (std::ostream& ostr, const position& pos)
 141   {
 142     if (pos.filename)
 143       ostr << *pos.filename << ':';
 144     return ostr << pos.line << '.' << pos.column;
 145   }
 146
 147 ]b4_namespace_close[
 148 ]b4_cpp_guard_close([b4_dir_prefix[]position.hh])
 149 b4_output_end()
 150
 151
 152 b4_output_begin([b4_dir_prefix[]location.hh])
 153 b4_copyright([Locations for Bison parsers in C++],
 154              [2002-2007, 2009-2012])[
 155
 156 /**
 157  ** \file ]b4_dir_prefix[location.hh
 158  ** Define the ]b4_namespace_ref[::location class.
 159  */
 160
 161 ]b4_cpp_guard_open([b4_dir_prefix[]location.hh])[
 162
 163 # include "position.hh"
 164
 165 ]b4_namespace_open[
 166
 167   /// Abstract a location.
 168   class location
 169   {
 170   public:
 171 ]m4_ifdef([b4_location_constructors], [
 172     /// Construct a location from \a b to \a e.
 173     location (const position& b, const position& e)
 174       : begin (b)
 175       , end (e)
 176     {
 177     }
 178
 179     /// Construct a 0-width location in \a p.
 180     explicit location (const position& p = position ())
 181       : begin (p)
 182       , end (p)
 183     {
 184     }
 185
 186     /// Construct a 0-width location in \a f, \a l, \a c.
 187     explicit location (]b4_percent_define_get([[filename_type]])[* f,
 188                        unsigned int l = ]b4_location_initial_line[u,
 189                        unsigned int c = ]b4_location_initial_column[u)
 190       : begin (f, l, c)
 191       , end (f, l, c)
 192     {
 193     }
 194
 195 ])[
 196     /// Initialization.
 197     void initialize (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
 198                      unsigned int l = ]b4_location_initial_line[u,
 199                      unsigned int c = ]b4_location_initial_column[u)
 200     {
 201       begin.initialize (f, l, c);
 202       end = begin;
 203     }
 204
 205     /** \name Line and Column related manipulators
 206      ** \{ */
 207   public:
 208     /// Reset initial location to final location.
 209     void step ()
 210     {
 211       begin = end;
 212     }
 213
 214     /// Extend the current location to the COUNT next columns.
 215     void columns (unsigned int count = 1)
 216     {
 217       end += count;
 218     }
 219
 220     /// Extend the current location to the COUNT next lines.
 221     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 ]b4_cpp_guard_close([b4_dir_prefix[]location.hh])
 296 b4_output_end()