1 // Debug-mode error formatting implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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 _Iterator, typename _Sequence>
50 class _Safe_local_iterator;
52 template<typename _Sequence>
59 __msg_insert_singular,
60 __msg_insert_different,
62 __msg_erase_different,
66 __msg_unpartitioned_pred,
72 __msg_bad_bitset_write,
73 __msg_bad_bitset_read,
74 __msg_bad_bitset_flip,
83 __msg_init_copy_singular,
84 __msg_init_const_singular,
89 __msg_iter_subscript_oob,
92 __msg_iter_compare_bad,
93 __msg_compare_different,
95 __msg_order_different,
97 __msg_distance_different,
102 __msg_output_ostream,
103 // istreambuf_iterator
104 __msg_deref_istreambuf,
105 __msg_inc_istreambuf,
107 __msg_insert_after_end,
108 __msg_erase_after_bad,
110 // unordered sequence local iterators
111 __msg_local_iter_compare_bad,
112 __msg_non_empty_range
115 class _Error_formatter
117 /// Whether an iterator is constant, mutable, or unknown
126 // The state of the iterator (fine-grained), if we know it.
130 __singular, // singular, may still be attached to a sequence
131 __begin, // dereferenceable, and at the beginning
132 __middle, // dereferenceable, not at the beginning
133 __end, // past-the-end, may be at beginning if sequence empty
134 __before_begin, // before begin
138 // Tags denoting the type of parameter for construction
139 struct _Is_iterator { };
140 struct _Is_sequence { };
142 // A parameter that may be referenced by an error message
156 // When _M_kind == __iterator
160 const void* _M_address;
161 const type_info* _M_type;
162 _Constness _M_constness;
163 _Iterator_state _M_state;
164 const void* _M_sequence;
165 const type_info* _M_seq_type;
168 // When _M_kind == __sequence
172 const void* _M_address;
173 const type_info* _M_type;
176 // When _M_kind == __integer
183 // When _M_kind == __string
187 const char* _M_value;
191 _Parameter() : _M_kind(__unused_param), _M_variant() { }
193 _Parameter(long __value, const char* __name)
194 : _M_kind(__integer), _M_variant()
196 _M_variant._M_integer._M_name = __name;
197 _M_variant._M_integer._M_value = __value;
200 _Parameter(const char* __value, const char* __name)
201 : _M_kind(__string), _M_variant()
203 _M_variant._M_string._M_name = __name;
204 _M_variant._M_string._M_value = __value;
207 template<typename _Iterator, typename _Sequence>
208 _Parameter(const _Safe_iterator<_Iterator, _Sequence>& __it,
209 const char* __name, _Is_iterator)
210 : _M_kind(__iterator), _M_variant()
212 _M_variant._M_iterator._M_name = __name;
213 _M_variant._M_iterator._M_address = &__it;
215 _M_variant._M_iterator._M_type = &typeid(__it);
217 _M_variant._M_iterator._M_type = 0;
219 _M_variant._M_iterator._M_constness =
220 std::__are_same<_Safe_iterator<_Iterator, _Sequence>,
221 typename _Sequence::iterator>::
222 __value ? __mutable_iterator : __const_iterator;
223 _M_variant._M_iterator._M_sequence = __it._M_get_sequence();
225 _M_variant._M_iterator._M_seq_type = &typeid(_Sequence);
227 _M_variant._M_iterator._M_seq_type = 0;
230 if (__it._M_singular())
231 _M_variant._M_iterator._M_state = __singular;
234 if (__it._M_is_before_begin())
235 _M_variant._M_iterator._M_state = __before_begin;
236 else if (__it._M_is_end())
237 _M_variant._M_iterator._M_state = __end;
238 else if (__it._M_is_begin())
239 _M_variant._M_iterator._M_state = __begin;
241 _M_variant._M_iterator._M_state = __middle;
245 template<typename _Iterator, typename _Sequence>
246 _Parameter(const _Safe_local_iterator<_Iterator, _Sequence>& __it,
247 const char* __name, _Is_iterator)
248 : _M_kind(__iterator), _M_variant()
250 _M_variant._M_iterator._M_name = __name;
251 _M_variant._M_iterator._M_address = &__it;
253 _M_variant._M_iterator._M_type = &typeid(__it);
255 _M_variant._M_iterator._M_type = 0;
257 _M_variant._M_iterator._M_constness =
258 std::__are_same<_Safe_local_iterator<_Iterator, _Sequence>,
259 typename _Sequence::local_iterator>::
260 __value ? __mutable_iterator : __const_iterator;
261 _M_variant._M_iterator._M_sequence = __it._M_get_sequence();
263 _M_variant._M_iterator._M_seq_type = &typeid(_Sequence);
265 _M_variant._M_iterator._M_seq_type = 0;
268 if (__it._M_singular())
269 _M_variant._M_iterator._M_state = __singular;
272 if (__it._M_is_end())
273 _M_variant._M_iterator._M_state = __end;
274 else if (__it._M_is_begin())
275 _M_variant._M_iterator._M_state = __begin;
277 _M_variant._M_iterator._M_state = __middle;
281 template<typename _Type>
282 _Parameter(const _Type*& __it, const char* __name, _Is_iterator)
283 : _M_kind(__iterator), _M_variant()
285 _M_variant._M_iterator._M_name = __name;
286 _M_variant._M_iterator._M_address = &__it;
288 _M_variant._M_iterator._M_type = &typeid(__it);
290 _M_variant._M_iterator._M_type = 0;
292 _M_variant._M_iterator._M_constness = __mutable_iterator;
293 _M_variant._M_iterator._M_state = __it? __unknown_state : __singular;
294 _M_variant._M_iterator._M_sequence = 0;
295 _M_variant._M_iterator._M_seq_type = 0;
298 template<typename _Type>
299 _Parameter(_Type*& __it, const char* __name, _Is_iterator)
300 : _M_kind(__iterator), _M_variant()
302 _M_variant._M_iterator._M_name = __name;
303 _M_variant._M_iterator._M_address = &__it;
305 _M_variant._M_iterator._M_type = &typeid(__it);
307 _M_variant._M_iterator._M_type = 0;
309 _M_variant._M_iterator._M_constness = __const_iterator;
310 _M_variant._M_iterator._M_state = __it? __unknown_state : __singular;
311 _M_variant._M_iterator._M_sequence = 0;
312 _M_variant._M_iterator._M_seq_type = 0;
315 template<typename _Iterator>
316 _Parameter(const _Iterator& __it, const char* __name, _Is_iterator)
317 : _M_kind(__iterator), _M_variant()
319 _M_variant._M_iterator._M_name = __name;
320 _M_variant._M_iterator._M_address = &__it;
322 _M_variant._M_iterator._M_type = &typeid(__it);
324 _M_variant._M_iterator._M_type = 0;
326 _M_variant._M_iterator._M_constness = __unknown_constness;
327 _M_variant._M_iterator._M_state =
328 __gnu_debug::__check_singular(__it)? __singular : __unknown_state;
329 _M_variant._M_iterator._M_sequence = 0;
330 _M_variant._M_iterator._M_seq_type = 0;
333 template<typename _Sequence>
334 _Parameter(const _Safe_sequence<_Sequence>& __seq,
335 const char* __name, _Is_sequence)
336 : _M_kind(__sequence), _M_variant()
338 _M_variant._M_sequence._M_name = __name;
339 _M_variant._M_sequence._M_address =
340 static_cast<const _Sequence*>(&__seq);
342 _M_variant._M_sequence._M_type = &typeid(_Sequence);
344 _M_variant._M_sequence._M_type = 0;
348 template<typename _Sequence>
349 _Parameter(const _Sequence& __seq, const char* __name, _Is_sequence)
350 : _M_kind(__sequence), _M_variant()
352 _M_variant._M_sequence._M_name = __name;
353 _M_variant._M_sequence._M_address = &__seq;
355 _M_variant._M_sequence._M_type = &typeid(_Sequence);
357 _M_variant._M_sequence._M_type = 0;
362 _M_print_field(const _Error_formatter* __formatter,
363 const char* __name) const;
366 _M_print_description(const _Error_formatter* __formatter) const;
369 friend struct _Parameter;
372 template<typename _Iterator>
373 const _Error_formatter&
374 _M_iterator(const _Iterator& __it, const char* __name = 0) const
376 if (_M_num_parameters < std::size_t(__max_parameters))
377 _M_parameters[_M_num_parameters++] = _Parameter(__it, __name,
382 const _Error_formatter&
383 _M_integer(long __value, const char* __name = 0) const
385 if (_M_num_parameters < std::size_t(__max_parameters))
386 _M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
390 const _Error_formatter&
391 _M_string(const char* __value, const char* __name = 0) const
393 if (_M_num_parameters < std::size_t(__max_parameters))
394 _M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
398 template<typename _Sequence>
399 const _Error_formatter&
400 _M_sequence(const _Sequence& __seq, const char* __name = 0) const
402 if (_M_num_parameters < std::size_t(__max_parameters))
403 _M_parameters[_M_num_parameters++] = _Parameter(__seq, __name,
408 const _Error_formatter&
409 _M_message(const char* __text) const
410 { _M_text = __text; return *this; }
412 const _Error_formatter&
413 _M_message(_Debug_msg_id __id) const throw ();
415 _GLIBCXX_NORETURN void
419 _Error_formatter(const char* __file, std::size_t __line)
420 : _M_file(__file), _M_line(__line), _M_num_parameters(0), _M_text(0),
421 _M_max_length(78), _M_column(1), _M_first_line(true), _M_wordwrap(false)
422 { _M_get_max_length(); }
424 template<typename _Tp>
426 _M_format_word(char*, int, const char*, _Tp) const throw ();
429 _M_print_word(const char* __word) const;
432 _M_print_string(const char* __string) const;
435 _M_get_max_length() const throw ();
437 enum { __max_parameters = 9 };
441 mutable _Parameter _M_parameters[__max_parameters];
442 mutable std::size_t _M_num_parameters;
443 mutable const char* _M_text;
444 mutable std::size_t _M_max_length;
445 enum { _M_indent = 4 } ;
446 mutable std::size_t _M_column;
447 mutable bool _M_first_line;
448 mutable bool _M_wordwrap;
451 static _Error_formatter
452 _M_at(const char* __file, std::size_t __line)
453 { return _Error_formatter(__file, __line); }
455 } // namespace __gnu_debug