1 // Debug-mode error formatting implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 /** @file debug/formatter.h
27 * This file is a GNU debug extension to the Standard C++ Library.
30 #ifndef _GLIBCXX_DEBUG_FORMATTER_H
31 #define _GLIBCXX_DEBUG_FORMATTER_H 1
33 #include <bits/c++config.h>
34 #include <bits/cpp_type_traits.h>
41 template<typename _Iterator>
42 bool __check_singular(_Iterator&);
44 class _Safe_sequence_base;
46 template<typename _Iterator, typename _Sequence>
49 template<typename _Sequence>
56 __msg_insert_singular,
57 __msg_insert_different,
59 __msg_erase_different,
63 __msg_unpartitioned_pred,
69 __msg_bad_bitset_write,
70 __msg_bad_bitset_read,
71 __msg_bad_bitset_flip,
80 __msg_init_copy_singular,
81 __msg_init_const_singular,
86 __msg_iter_subscript_oob,
89 __msg_iter_compare_bad,
90 __msg_compare_different,
92 __msg_order_different,
94 __msg_distance_different,
100 // istreambuf_iterator
101 __msg_deref_istreambuf,
102 __msg_inc_istreambuf,
104 __msg_insert_after_end,
105 __msg_erase_after_bad,
109 class _Error_formatter
111 /// Whether an iterator is constant, mutable, or unknown
120 // The state of the iterator (fine-grained), if we know it.
124 __singular, // singular, may still be attached to a sequence
125 __begin, // dereferenceable, and at the beginning
126 __middle, // dereferenceable, not at the beginning
127 __end, // past-the-end, may be at beginning if sequence empty
128 __before_begin, // before begin
132 // Tags denoting the type of parameter for construction
133 struct _Is_iterator { };
134 struct _Is_sequence { };
136 // A parameter that may be referenced by an error message
150 // When _M_kind == __iterator
154 const void* _M_address;
155 const type_info* _M_type;
156 _Constness _M_constness;
157 _Iterator_state _M_state;
158 const void* _M_sequence;
159 const type_info* _M_seq_type;
162 // When _M_kind == __sequence
166 const void* _M_address;
167 const type_info* _M_type;
170 // When _M_kind == __integer
177 // When _M_kind == __string
181 const char* _M_value;
185 _Parameter() : _M_kind(__unused_param), _M_variant() { }
187 _Parameter(long __value, const char* __name)
188 : _M_kind(__integer), _M_variant()
190 _M_variant._M_integer._M_name = __name;
191 _M_variant._M_integer._M_value = __value;
194 _Parameter(const char* __value, const char* __name)
195 : _M_kind(__string), _M_variant()
197 _M_variant._M_string._M_name = __name;
198 _M_variant._M_string._M_value = __value;
201 template<typename _Iterator, typename _Sequence>
202 _Parameter(const _Safe_iterator<_Iterator, _Sequence>& __it,
203 const char* __name, _Is_iterator)
204 : _M_kind(__iterator), _M_variant()
206 _M_variant._M_iterator._M_name = __name;
207 _M_variant._M_iterator._M_address = &__it;
209 _M_variant._M_iterator._M_type = &typeid(__it);
211 _M_variant._M_iterator._M_type = 0;
213 _M_variant._M_iterator._M_constness =
214 std::__are_same<_Safe_iterator<_Iterator, _Sequence>,
215 typename _Sequence::iterator>::
216 __value ? __mutable_iterator : __const_iterator;
217 _M_variant._M_iterator._M_sequence = __it._M_get_sequence();
219 _M_variant._M_iterator._M_seq_type = &typeid(_Sequence);
221 _M_variant._M_iterator._M_seq_type = 0;
224 if (__it._M_singular())
225 _M_variant._M_iterator._M_state = __singular;
228 if (__it._M_is_before_begin())
229 _M_variant._M_iterator._M_state = __before_begin;
230 else if (__it._M_is_end())
231 _M_variant._M_iterator._M_state = __end;
232 else if (__it._M_is_begin())
233 _M_variant._M_iterator._M_state = __begin;
235 _M_variant._M_iterator._M_state = __middle;
239 template<typename _Type>
240 _Parameter(const _Type*& __it, const char* __name, _Is_iterator)
241 : _M_kind(__iterator), _M_variant()
243 _M_variant._M_iterator._M_name = __name;
244 _M_variant._M_iterator._M_address = &__it;
246 _M_variant._M_iterator._M_type = &typeid(__it);
248 _M_variant._M_iterator._M_type = 0;
250 _M_variant._M_iterator._M_constness = __mutable_iterator;
251 _M_variant._M_iterator._M_state = __it? __unknown_state : __singular;
252 _M_variant._M_iterator._M_sequence = 0;
253 _M_variant._M_iterator._M_seq_type = 0;
256 template<typename _Type>
257 _Parameter(_Type*& __it, const char* __name, _Is_iterator)
258 : _M_kind(__iterator), _M_variant()
260 _M_variant._M_iterator._M_name = __name;
261 _M_variant._M_iterator._M_address = &__it;
263 _M_variant._M_iterator._M_type = &typeid(__it);
265 _M_variant._M_iterator._M_type = 0;
267 _M_variant._M_iterator._M_constness = __const_iterator;
268 _M_variant._M_iterator._M_state = __it? __unknown_state : __singular;
269 _M_variant._M_iterator._M_sequence = 0;
270 _M_variant._M_iterator._M_seq_type = 0;
273 template<typename _Iterator>
274 _Parameter(const _Iterator& __it, const char* __name, _Is_iterator)
275 : _M_kind(__iterator), _M_variant()
277 _M_variant._M_iterator._M_name = __name;
278 _M_variant._M_iterator._M_address = &__it;
280 _M_variant._M_iterator._M_type = &typeid(__it);
282 _M_variant._M_iterator._M_type = 0;
284 _M_variant._M_iterator._M_constness = __unknown_constness;
285 _M_variant._M_iterator._M_state =
286 __gnu_debug::__check_singular(__it)? __singular : __unknown_state;
287 _M_variant._M_iterator._M_sequence = 0;
288 _M_variant._M_iterator._M_seq_type = 0;
291 template<typename _Sequence>
292 _Parameter(const _Safe_sequence<_Sequence>& __seq,
293 const char* __name, _Is_sequence)
294 : _M_kind(__sequence), _M_variant()
296 _M_variant._M_sequence._M_name = __name;
297 _M_variant._M_sequence._M_address =
298 static_cast<const _Sequence*>(&__seq);
300 _M_variant._M_sequence._M_type = &typeid(_Sequence);
302 _M_variant._M_sequence._M_type = 0;
306 template<typename _Sequence>
307 _Parameter(const _Sequence& __seq, const char* __name, _Is_sequence)
308 : _M_kind(__sequence), _M_variant()
310 _M_variant._M_sequence._M_name = __name;
311 _M_variant._M_sequence._M_address = &__seq;
313 _M_variant._M_sequence._M_type = &typeid(_Sequence);
315 _M_variant._M_sequence._M_type = 0;
320 _M_print_field(const _Error_formatter* __formatter,
321 const char* __name) const;
324 _M_print_description(const _Error_formatter* __formatter) const;
327 friend struct _Parameter;
330 template<typename _Iterator>
331 const _Error_formatter&
332 _M_iterator(const _Iterator& __it, const char* __name = 0) const
334 if (_M_num_parameters < std::size_t(__max_parameters))
335 _M_parameters[_M_num_parameters++] = _Parameter(__it, __name,
340 const _Error_formatter&
341 _M_integer(long __value, const char* __name = 0) const
343 if (_M_num_parameters < std::size_t(__max_parameters))
344 _M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
348 const _Error_formatter&
349 _M_string(const char* __value, const char* __name = 0) const
351 if (_M_num_parameters < std::size_t(__max_parameters))
352 _M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
356 template<typename _Sequence>
357 const _Error_formatter&
358 _M_sequence(const _Sequence& __seq, const char* __name = 0) const
360 if (_M_num_parameters < std::size_t(__max_parameters))
361 _M_parameters[_M_num_parameters++] = _Parameter(__seq, __name,
366 const _Error_formatter&
367 _M_message(const char* __text) const
368 { _M_text = __text; return *this; }
370 const _Error_formatter&
371 _M_message(_Debug_msg_id __id) const throw ();
373 _GLIBCXX_NORETURN void
377 _Error_formatter(const char* __file, std::size_t __line)
378 : _M_file(__file), _M_line(__line), _M_num_parameters(0), _M_text(0),
379 _M_max_length(78), _M_column(1), _M_first_line(true), _M_wordwrap(false)
380 { _M_get_max_length(); }
382 template<typename _Tp>
384 _M_format_word(char*, int, const char*, _Tp) const throw ();
387 _M_print_word(const char* __word) const;
390 _M_print_string(const char* __string) const;
393 _M_get_max_length() const throw ();
395 enum { __max_parameters = 9 };
399 mutable _Parameter _M_parameters[__max_parameters];
400 mutable std::size_t _M_num_parameters;
401 mutable const char* _M_text;
402 mutable std::size_t _M_max_length;
403 enum { _M_indent = 4 } ;
404 mutable std::size_t _M_column;
405 mutable bool _M_first_line;
406 mutable bool _M_wordwrap;
409 static _Error_formatter
410 _M_at(const char* __file, std::size_t __line)
411 { return _Error_formatter(__file, __line); }
413 } // namespace __gnu_debug