]> git.saurik.com Git - bison.git/blob - data/location.cc
* doc/bison.texinfo (Calc++ Parsing Driver): Let "parse" return an
[bison.git] / data / location.cc
1 # C++ skeleton for Bison
2
3 # Copyright (C) 2002, 2003, 2004, 2005, 2006 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 2 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, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 # 02110-1301 USA
19
20 # We do want M4 expansion after # for CPP macros.
21 m4_changecom()
22 m4_divert_push(0)dnl
23 @output(b4_dir_prefix[]position.hh@)
24 b4_copyright([Positions for Bison parsers in C++],
25 [2002, 2003, 2004, 2005, 2006])[
26
27 /**
28 ** \file position.hh
29 ** Define the ]b4_percent_define_get([[namespace]])[::position class.
30 */
31
32 #ifndef BISON_POSITION_HH
33 # define BISON_POSITION_HH
34
35 # include <iostream>
36 # include <string>
37 # include <algorithm>
38
39 namespace ]b4_percent_define_get([[namespace]])[
40 {
41 /// Abstract a position.
42 class position
43 {
44 public:
45 ]m4_ifdef([b4_location_constructors], [
46 /// Construct a position.
47 position ()
48 : filename (0), line (]b4_location_initial_line[), column (]b4_location_initial_column[)
49 {
50 }
51
52 ])[
53 /// Initialization.
54 inline void initialize (]b4_percent_define_get([[filename_type]])[* fn)
55 {
56 filename = fn;
57 line = ]b4_location_initial_line[;
58 column = ]b4_location_initial_column[;
59 }
60
61 /** \name Line and Column related manipulators
62 ** \{ */
63 public:
64 /// (line related) Advance to the COUNT next lines.
65 inline void lines (int count = 1)
66 {
67 column = ]b4_location_initial_column[;
68 line += count;
69 }
70
71 /// (column related) Advance to the COUNT next columns.
72 inline void columns (int count = 1)
73 {
74 column = std::max (]b4_location_initial_column[u, column + count);
75 }
76 /** \} */
77
78 public:
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 const 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 const 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 ]m4_if(b4_percent_define_get([[define_location_comparison]]), [1], [[
117 /// Compare two position objects.
118 inline bool
119 operator== (const position& pos1, const position& pos2)
120 {
121 return
122 (pos1.filename == pos2.filename
123 || pos1.filename && pos2.filename && *pos1.filename == *pos2.filename)
124 && pos1.line == pos2.line && pos1.column == pos2.column;
125 }
126
127 /// Compare two position objects.
128 inline bool
129 operator!= (const position& pos1, const position& pos2)
130 {
131 return !(pos1 == pos2);
132 }
133 ]])[
134 /** \brief Intercept output stream redirection.
135 ** \param ostr the destination output stream
136 ** \param pos a reference to the position to redirect
137 */
138 inline std::ostream&
139 operator<< (std::ostream& ostr, const position& pos)
140 {
141 if (pos.filename)
142 ostr << *pos.filename << ':';
143 return ostr << pos.line << '.' << pos.column;
144 }
145
146 }
147 #endif // not BISON_POSITION_HH]
148 @output(b4_dir_prefix[]location.hh@)
149 b4_copyright([Locations for Bison parsers in C++],
150 [2002, 2003, 2004, 2005, 2006])[
151
152 /**
153 ** \file location.hh
154 ** Define the ]b4_percent_define_get([[namespace]])[::location class.
155 */
156
157 #ifndef BISON_LOCATION_HH
158 # define BISON_LOCATION_HH
159
160 # include <iostream>
161 # include <string>
162 # include "position.hh"
163
164 namespace ]b4_percent_define_get([[namespace]])[
165 {
166
167 /// Abstract a location.
168 class location
169 {
170 public:
171 ]m4_ifdef([b4_location_constructors], [
172 /// Construct a location.
173 location ()
174 : begin (), end ()
175 {
176 }
177
178 ])[
179 /// Initialization.
180 inline void initialize (]b4_percent_define_get([[filename_type]])[* fn)
181 {
182 begin.initialize (fn);
183 end = begin;
184 }
185
186 /** \name Line and Column related manipulators
187 ** \{ */
188 public:
189 /// Reset initial location to final location.
190 inline void step ()
191 {
192 begin = end;
193 }
194
195 /// Extend the current location to the COUNT next columns.
196 inline void columns (unsigned int count = 1)
197 {
198 end += count;
199 }
200
201 /// Extend the current location to the COUNT next lines.
202 inline void lines (unsigned int count = 1)
203 {
204 end.lines (count);
205 }
206 /** \} */
207
208
209 public:
210 /// Beginning of the located region.
211 position begin;
212 /// End of the located region.
213 position end;
214 };
215
216 /// Join two location objects to create a location.
217 inline const location operator+ (const location& begin, const location& end)
218 {
219 location res = begin;
220 res.end = end.end;
221 return res;
222 }
223
224 /// Add two location objects.
225 inline const location operator+ (const location& begin, unsigned int width)
226 {
227 location res = begin;
228 res.columns (width);
229 return res;
230 }
231
232 /// Add and assign a location.
233 inline location& operator+= (location& res, unsigned int width)
234 {
235 res.columns (width);
236 return res;
237 }
238 ]m4_if(b4_percent_define_get([[define_location_comparison]]), [1], [[
239 /// Compare two location objects.
240 inline bool
241 operator== (const location& loc1, const location& loc2)
242 {
243 return loc1.begin == loc2.begin && loc1.end == loc2.end;
244 }
245
246 /// Compare two location objects.
247 inline bool
248 operator!= (const location& loc1, const location& loc2)
249 {
250 return !(loc1 == loc2);
251 }
252 ]])[
253 /** \brief Intercept output stream redirection.
254 ** \param ostr the destination output stream
255 ** \param loc a reference to the location to redirect
256 **
257 ** Avoid duplicate information.
258 */
259 inline std::ostream& operator<< (std::ostream& ostr, const location& loc)
260 {
261 position last = loc.end - 1;
262 ostr << loc.begin;
263 if (last.filename
264 && (!loc.begin.filename
265 || *loc.begin.filename != *last.filename))
266 ostr << '-' << last;
267 else if (loc.begin.line != last.line)
268 ostr << '-' << last.line << '.' << last.column;
269 else if (loc.begin.column != last.column)
270 ostr << '-' << last.column;
271 return ostr;
272 }
273
274 }
275
276 #endif // not BISON_LOCATION_HH]
277 m4_divert_pop(0)
278 m4_changecom([#])