doc: fix some invalid @ref.

[bison.git] / data / location.cc

diff --git a/data/location.cc b/data/location.cc
index 2226adca7aa28c5b75dd5f247e57763700e26d91..cb0f1f91fb604f06170bdb67ad49dc538c28eb29 100644 (file)
--- a/data/location.cc
+++ b/data/location.cc
@@ -1,35 +1,30 @@
-m4_divert(-1)
-

 # C++ skeleton for Bison
 
 # C++ skeleton for Bison
 

-# Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+# Copyright (C) 2002-2007, 2009-2012 Free Software Foundation, Inc.

 
 

-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify

 # it under the terms of the GNU General Public License as published by
 # it under the terms of the GNU General Public License as published by

-# the Free Software Foundation; either version 2 of the License, or
+# the Free Software Foundation, either version 3 of the License, or

 # (at your option) any later version.
 # (at your option) any later version.

-
+#

 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.

-
+#

 # You should have received a copy of the GNU General Public License
 # You should have received a copy of the GNU General Public License

-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-# 02110-1301  USA
-
-m4_include(b4_pkgdatadir/[c++.m4])
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.

 
 # We do want M4 expansion after # for CPP macros.
 m4_changecom()
 
 # We do want M4 expansion after # for CPP macros.
 m4_changecom()

-m4_divert(0)dnl
-@output b4_dir_prefix[]position.hh
-b4_copyright([Position class for Bison C++ parsers], [2002, 2003, 2004, 2005])[
+m4_divert_push(0)dnl
+@output(b4_dir_prefix[]position.hh@)@
+b4_copyright([Positions for Bison parsers in C++],
+             [2002-2007, 2009-2012])[

 
 /**
  ** \file position.hh
 
 /**
  ** \file position.hh

- ** Define the position class.
+ ** Define the ]b4_namespace_ref[::position class.

  */
 
 #ifndef BISON_POSITION_HH
  */
 
 #ifndef BISON_POSITION_HH


@@ -37,56 +32,55 @@ b4_copyright([Position class for Bison C++ parsers], [2002, 2003, 2004, 2005])[
 
 # include <iostream>
 # include <string>
 
 # include <iostream>
 # include <string>

+# include <algorithm>

 
 

-namespace yy
-{
+]b4_null_define[
+
+]b4_namespace_open[

   /// Abstract a position.
   class position
   {
   public:
   /// Abstract a position.
   class position
   {
   public:

-    /// Initial column number.
-    static const unsigned int initial_column = 0;
-    /// Initial line number.
-    static const unsigned int initial_line = 1;
-
-    /** \name Ctor & dtor.
-     ** \{ */
-  public:
+]m4_ifdef([b4_location_constructors], [[

     /// Construct a position.
     /// Construct a position.

-    position () :
-      filename (0),
-      line (initial_line),
-      column (initial_column)
+    explicit position (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
+                       unsigned int l = ]b4_location_initial_line[u,
+                       unsigned int c = ]b4_location_initial_column[u)
+      : filename (f)
+      , line (l)
+      , column (c)

     {
     }
     {
     }

-    /** \} */

 
 

+]])[
+    /// Initialization.
+    void initialize (]b4_percent_define_get([[filename_type]])[* fn = YY_NULL,
+                     unsigned int l = ]b4_location_initial_line[u,
+                     unsigned int c = ]b4_location_initial_column[u)
+    {
+      filename = fn;
+      line = l;
+      column = c;
+    }

 
     /** \name Line and Column related manipulators
      ** \{ */
 
     /** \name Line and Column related manipulators
      ** \{ */

-  public:

     /// (line related) Advance to the COUNT next lines.
     /// (line related) Advance to the COUNT next lines.

-    inline void lines (int count = 1)
+    void lines (int count = 1)

     {
     {

-      column = initial_column;
+      column = ]b4_location_initial_column[u;

       line += count;
     }
 
     /// (column related) Advance to the COUNT next columns.
       line += count;
     }
 
     /// (column related) Advance to the COUNT next columns.

-    inline void columns (int count = 1)
+    void columns (int count = 1)

     {
     {

-      int leftmost = initial_column;
-      int current  = column;
-      if (leftmost <= current + count)
-       column += count;
-      else
-       column = initial_column;
+      column = std::max (]b4_location_initial_column[u, column + count);

     }
     /** \} */
 
     }
     /** \} */
 

-  public:

     /// File name to which this position refers.
     /// File name to which this position refers.

-    ]b4_filename_type[* filename;
+    ]b4_percent_define_get([[filename_type]])[* filename;

     /// Current line number.
     unsigned int line;
     /// Current column number.
     /// Current line number.
     unsigned int line;
     /// Current column number.


@@ -122,7 +116,25 @@ namespace yy
   {
     return begin + -width;
   }
   {
     return begin + -width;
   }

+]b4_percent_define_flag_if([[define_location_comparison]], [[
+  /// Compare two position objects.
+  inline bool
+  operator== (const position& pos1, const position& pos2)
+  {
+    return (pos1.line == pos2.line
+            && pos1.column == pos2.column
+            && (pos1.filename == pos2.filename
+                || (pos1.filename && pos2.filename
+                    && *pos1.filename == *pos2.filename)));
+  }

 
 

+  /// Compare two position objects.
+  inline bool
+  operator!= (const position& pos1, const position& pos2)
+  {
+    return !(pos1 == pos2);
+  }
+]])[

   /** \brief Intercept output stream redirection.
    ** \param ostr the destination output stream
    ** \param pos a reference to the position to redirect
   /** \brief Intercept output stream redirection.
    ** \param ostr the destination output stream
    ** \param pos a reference to the position to redirect


@@ -135,14 +147,15 @@ namespace yy
     return ostr << pos.line << '.' << pos.column;
   }
 
     return ostr << pos.line << '.' << pos.column;
   }
 

-}
+]b4_namespace_close[

 #endif // not BISON_POSITION_HH]
 #endif // not BISON_POSITION_HH]

-@output b4_dir_prefix[]location.hh
-b4_copyright([Location class for Bison C++ parsers], [2002, 2003, 2004, 2005])[
+@output(b4_dir_prefix[]location.hh@)@
+b4_copyright([Locations for Bison parsers in C++],
+             [2002-2007, 2009-2012])[

 
 /**
  ** \file location.hh
 
 /**
  ** \file location.hh

- ** Define the location class.
+ ** Define the ]b4_namespace_ref[::location class.

  */
 
 #ifndef BISON_LOCATION_HH
  */
 
 #ifndef BISON_LOCATION_HH


@@ -152,41 +165,63 @@ b4_copyright([Location class for Bison C++ parsers], [2002, 2003, 2004, 2005])[
 # include <string>
 # include "position.hh"
 
 # include <string>
 # include "position.hh"
 

-namespace yy
-{
+]b4_namespace_open[

 
   /// Abstract a location.
   class location
   {
 
   /// Abstract a location.
   class location
   {

-    /** \name Ctor & dtor.
-     ** \{ */

   public:
   public:

-    /// Construct a location.
-    location () :
-      begin (),
-      end ()
+]m4_ifdef([b4_location_constructors], [
+    /// Construct a location from \a b to \a e.
+    location (const position& b, const position& e)
+      : begin (b)
+      , end (e)
+    {
+    }
+
+    /// Construct a 0-width location in \a p.
+    explicit location (const position& p = position ())
+      : begin (p)
+      , end (p)

     {
     }
     {
     }

-    /** \} */

 
 

+    /// Construct a 0-width location in \a f, \a l, \a c.
+    explicit location (]b4_percent_define_get([[filename_type]])[* f,
+                       unsigned int l = ]b4_location_initial_line[u,
+                       unsigned int c = ]b4_location_initial_column[u)
+      : begin (f, l, c)
+      , end (f, l, c)
+    {
+    }
+
+])[
+    /// Initialization.
+    void initialize (]b4_percent_define_get([[filename_type]])[* f = YY_NULL,
+                     unsigned int l = ]b4_location_initial_line[u,
+                     unsigned int c = ]b4_location_initial_column[u)
+    {
+      begin.initialize (f, l, c);
+      end = begin;
+    }

 
     /** \name Line and Column related manipulators
      ** \{ */
   public:
     /// Reset initial location to final location.
 
     /** \name Line and Column related manipulators
      ** \{ */
   public:
     /// Reset initial location to final location.

-    inline void step ()
+    void step ()

     {
       begin = end;
     }
 
     /// Extend the current location to the COUNT next columns.
     {
       begin = end;
     }
 
     /// Extend the current location to the COUNT next columns.

-    inline void columns (unsigned int count = 1)
+    void columns (unsigned int count = 1)

     {
       end += count;
     }
 
     /// Extend the current location to the COUNT next lines.
     {
       end += count;
     }
 
     /// Extend the current location to the COUNT next lines.

-    inline void lines (unsigned int count = 1)
+    void lines (unsigned int count = 1)

     {
       end.lines (count);
     }
     {
       end.lines (count);
     }


@@ -222,7 +257,21 @@ namespace yy
     res.columns (width);
     return res;
   }
     res.columns (width);
     return res;
   }

+]b4_percent_define_flag_if([[define_location_comparison]], [[
+  /// Compare two location objects.
+  inline bool
+  operator== (const location& loc1, const location& loc2)
+  {
+    return loc1.begin == loc2.begin && loc1.end == loc2.end;
+  }

 
 

+  /// Compare two location objects.
+  inline bool
+  operator!= (const location& loc1, const location& loc2)
+  {
+    return !(loc1 == loc2);
+  }
+]])[

   /** \brief Intercept output stream redirection.
    ** \param ostr the destination output stream
    ** \param loc a reference to the location to redirect
   /** \brief Intercept output stream redirection.
    ** \param ostr the destination output stream
    ** \param loc a reference to the location to redirect


@@ -244,8 +293,8 @@ namespace yy
     return ostr;
   }
 
     return ostr;
   }
 

-}
+]b4_namespace_close[

 
 #endif // not BISON_LOCATION_HH]
 
 #endif // not BISON_LOCATION_HH]

-m4_divert(-1)
+m4_divert_pop(0)

 m4_changecom([#])
 m4_changecom([#])