[thirdparty/gcc.git] / libstdc++-v3 / include / debug / formatter.h

// Debug-mode error formatting implementation -*- C++ -*-

// Copyright (C) 2003-2019 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library.  This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.

// This library 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.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

/** @file debug/formatter.h
 *  This file is a GNU debug extension to the Standard C++ Library.
 */

#ifndef _GLIBCXX_DEBUG_FORMATTER_H
#define _GLIBCXX_DEBUG_FORMATTER_H 1

#include <bits/c++config.h>

#if __cpp_rtti
# include <typeinfo>
# define _GLIBCXX_TYPEID(_Type) &typeid(_Type)
#else
namespace std
{
  class type_info;
}
# define _GLIBCXX_TYPEID(_Type) 0
#endif

#if __cplusplus >= 201103L
namespace __gnu_cxx
{
_GLIBCXX_BEGIN_NAMESPACE_VERSION

template<typename _Iterator, typename _Container>
  class __normal_iterator;

_GLIBCXX_END_NAMESPACE_VERSION
}

namespace std
{
_GLIBCXX_BEGIN_NAMESPACE_VERSION

template<typename _Iterator>
  class reverse_iterator;

template<typename _Iterator>
  class move_iterator;

_GLIBCXX_END_NAMESPACE_VERSION
}
#endif

namespace __gnu_debug
{
  using std::type_info;

  template<typename _Iterator>
    bool __check_singular(const _Iterator&);

  class _Safe_sequence_base;

  template<typename _Iterator, typename _Sequence, typename _Category>
    class _Safe_iterator;

  template<typename _Iterator, typename _Sequence>
    class _Safe_local_iterator;

  template<typename _Sequence>
    class _Safe_sequence;

  enum _Debug_msg_id
  {
    // General checks
    __msg_valid_range,
    __msg_insert_singular,
    __msg_insert_different,
    __msg_erase_bad,
    __msg_erase_different,
    __msg_subscript_oob,
    __msg_empty,
    __msg_unpartitioned,
    __msg_unpartitioned_pred,
    __msg_unsorted,
    __msg_unsorted_pred,
    __msg_not_heap,
    __msg_not_heap_pred,
    // std::bitset checks
    __msg_bad_bitset_write,
    __msg_bad_bitset_read,
    __msg_bad_bitset_flip,
    // std::list checks
    __msg_self_splice,
    __msg_splice_alloc,
    __msg_splice_bad,
    __msg_splice_other,
    __msg_splice_overlap,
    // iterator checks
    __msg_init_singular,
    __msg_init_copy_singular,
    __msg_init_const_singular,
    __msg_copy_singular,
    __msg_bad_deref,
    __msg_bad_inc,
    __msg_bad_dec,
    __msg_iter_subscript_oob,
    __msg_advance_oob,
    __msg_retreat_oob,
    __msg_iter_compare_bad,
    __msg_compare_different,
    __msg_iter_order_bad,
    __msg_order_different,
    __msg_distance_bad,
    __msg_distance_different,
    // istream_iterator
    __msg_deref_istream,
    __msg_inc_istream,
    // ostream_iterator
    __msg_output_ostream,
    // istreambuf_iterator
    __msg_deref_istreambuf,
    __msg_inc_istreambuf,
    // forward_list
    __msg_insert_after_end,
    __msg_erase_after_bad,
    __msg_valid_range2,
    // unordered container local iterators
    __msg_local_iter_compare_bad,
    __msg_non_empty_range,
    // self move assign
    __msg_self_move_assign,
    // unordered container buckets
    __msg_bucket_index_oob,
    __msg_valid_load_factor,
    // others
    __msg_equal_allocs,
    __msg_insert_range_from_self,
    __msg_irreflexive_ordering
  };

  class _Error_formatter
  {
    // Tags denoting the type of parameter for construction
    struct _Is_iterator { };
    struct _Is_iterator_value_type { };
    struct _Is_sequence { };
    struct _Is_instance { };

  public:
    /// Whether an iterator is constant, mutable, or unknown
    enum _Constness
    {
      __unknown_constness,
      __const_iterator,
      __mutable_iterator,
      __last_constness
    };

    // The state of the iterator (fine-grained), if we know it.
    enum _Iterator_state
    {
      __unknown_state,
      __singular,	// singular, may still be attached to a sequence
      __begin,		// dereferenceable, and at the beginning
      __middle,		// dereferenceable, not at the beginning
      __end,		// past-the-end, may be at beginning if sequence empty
      __before_begin,	// before begin
      __rbegin,		// dereferenceable, and at the reverse-beginning
      __rmiddle,	// reverse-dereferenceable, not at the reverse-beginning
      __rend,		// reverse-past-the-end
      __last_state
    };

    // A parameter that may be referenced by an error message
    struct _Parameter
    {
      enum
      {
	__unused_param,
	__iterator,
	__sequence,
	__integer,
	__string,
	__instance,
	__iterator_value_type
      } _M_kind;

      struct _Type
      {
	const char*		_M_name;
	const type_info*	_M_type;
      };

      struct _Instance : _Type
      {
	const void*		_M_address;
      };

      union
      {
	// When _M_kind == __iterator
	struct : _Instance
	{
	  _Constness		_M_constness;
	  _Iterator_state	_M_state;
	  const void*		_M_sequence;
	  const type_info*	_M_seq_type;
	} _M_iterator;

	// When _M_kind == __sequence
	_Instance _M_sequence;

	// When _M_kind == __integer
	struct
	{
	  const char*		_M_name;
	  long			_M_value;
	} _M_integer;

	// When _M_kind == __string
	struct
	{
	  const char*		_M_name;
	  const char*		_M_value;
	} _M_string;

	// When _M_kind == __instance
	_Instance _M_instance;

	// When _M_kind == __iterator_value_type
	_Type _M_iterator_value_type;
      } _M_variant;

      _Parameter() : _M_kind(__unused_param), _M_variant() { }

      _Parameter(long __value, const char* __name)
      : _M_kind(__integer), _M_variant()
      {
	_M_variant._M_integer._M_name = __name;
	_M_variant._M_integer._M_value = __value;
      }

      _Parameter(const char* __value, const char* __name)
      : _M_kind(__string), _M_variant()
      {
	_M_variant._M_string._M_name = __name;
	_M_variant._M_string._M_value = __value;
      }

      template<typename _Iterator, typename _Sequence, typename _Category>
	_Parameter(_Safe_iterator<_Iterator, _Sequence, _Category> const& __it,
		   const char* __name, _Is_iterator)
	: _M_kind(__iterator),  _M_variant()
	{
	  _M_variant._M_iterator._M_name = __name;
	  _M_variant._M_iterator._M_address = std::__addressof(__it);
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(_Iterator);
	  _M_variant._M_iterator._M_constness =
	    __it._S_constant() ? __const_iterator : __mutable_iterator;
	  _M_variant._M_iterator._M_sequence = __it._M_get_sequence();
	  _M_variant._M_iterator._M_seq_type = _GLIBCXX_TYPEID(_Sequence);

	  if (__it._M_singular())
	    _M_variant._M_iterator._M_state = __singular;
	  else
	    {
	      if (__it._M_is_before_begin())
		_M_variant._M_iterator._M_state = __before_begin;
	      else if (__it._M_is_end())
		_M_variant._M_iterator._M_state = __end;
	      else if (__it._M_is_begin())
		_M_variant._M_iterator._M_state = __begin;
	      else
		_M_variant._M_iterator._M_state = __middle;
	    }
	}

      template<typename _Iterator, typename _Sequence>
	_Parameter(_Safe_local_iterator<_Iterator, _Sequence> const& __it,
		   const char* __name, _Is_iterator)
	: _M_kind(__iterator),  _M_variant()
	{
	  _M_variant._M_iterator._M_name = __name;
	  _M_variant._M_iterator._M_address = std::__addressof(__it);
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(_Iterator);
	  _M_variant._M_iterator._M_constness =
	  _M_variant._M_iterator._M_constness =
	    __it._S_constant() ? __const_iterator : __mutable_iterator;
	  _M_variant._M_iterator._M_sequence = __it._M_get_sequence();
	  _M_variant._M_iterator._M_seq_type = _GLIBCXX_TYPEID(_Sequence);

	  if (__it._M_singular())
	    _M_variant._M_iterator._M_state = __singular;
	  else
	    {
	      if (__it._M_is_end())
		_M_variant._M_iterator._M_state = __end;
	      else if (__it._M_is_begin())
		_M_variant._M_iterator._M_state = __begin;
	      else
		_M_variant._M_iterator._M_state = __middle;
	    }
	}

      template<typename _Type>
	_Parameter(const _Type* const& __it, const char* __name, _Is_iterator)
	: _M_kind(__iterator), _M_variant()
	{
	  _M_variant._M_iterator._M_name = __name;
	  _M_variant._M_iterator._M_address = std::__addressof(__it);
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
	  _M_variant._M_iterator._M_constness = __const_iterator;
	  _M_variant._M_iterator._M_state = __it ? __unknown_state : __singular;
	  _M_variant._M_iterator._M_sequence = 0;
	  _M_variant._M_iterator._M_seq_type = 0;
	}

      template<typename _Type>
	_Parameter(_Type* const& __it, const char* __name, _Is_iterator)
	: _M_kind(__iterator), _M_variant()
	{
	  _M_variant._M_iterator._M_name = __name;
	  _M_variant._M_iterator._M_address = std::__addressof(__it);
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
	  _M_variant._M_iterator._M_constness = __mutable_iterator;
	  _M_variant._M_iterator._M_state = __it ? __unknown_state : __singular;
	  _M_variant._M_iterator._M_sequence = 0;
	  _M_variant._M_iterator._M_seq_type = 0;
	}

      template<typename _Iterator>
	_Parameter(_Iterator const& __it, const char* __name, _Is_iterator)
	: _M_kind(__iterator), _M_variant()
	{
	  _M_variant._M_iterator._M_name = __name;
	  _M_variant._M_iterator._M_address = std::__addressof(__it);
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
	  _M_variant._M_iterator._M_constness = __unknown_constness;
	  _M_variant._M_iterator._M_state =
	    __gnu_debug::__check_singular(__it) ? __singular : __unknown_state;
	  _M_variant._M_iterator._M_sequence = 0;
	  _M_variant._M_iterator._M_seq_type = 0;
	}

#if __cplusplus >= 201103L
      // The following constructors are only defined in C++11 to take
      // advantage of the constructor delegation feature.
      template<typename _Iterator, typename _Container>
        _Parameter(
	  __gnu_cxx::__normal_iterator<_Iterator, _Container> const& __it,
	const char* __name, _Is_iterator)
	: _Parameter(__it.base(), __name, _Is_iterator{})
	{ _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it); }

      template<typename _Iterator>
	_Parameter(std::reverse_iterator<_Iterator> const& __it,
		   const char* __name, _Is_iterator)
	: _Parameter(__it.base(), __name, _Is_iterator{})
	{
	  _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
	  _M_variant._M_iterator._M_state
	    = _S_reverse_state(_M_variant._M_iterator._M_state);
	}

      template<typename _Iterator, typename _Sequence, typename _Category>
	_Parameter(std::reverse_iterator<_Safe_iterator<_Iterator, _Sequence,
							_Category>> const& __it,
	  const char* __name, _Is_iterator)
	: _Parameter(__it.base(), __name, _Is_iterator{})
	{
	  _M_variant._M_iterator._M_type
	    = _GLIBCXX_TYPEID(std::reverse_iterator<_Iterator>);
	  _M_variant._M_iterator._M_state
	    = _S_reverse_state(_M_variant._M_iterator._M_state);
	}

      template<typename _Iterator>
	_Parameter(std::move_iterator<_Iterator> const& __it,
		   const char* __name, _Is_iterator)
	: _Parameter(__it.base(), __name, _Is_iterator{})
	{ _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it); }

      template<typename _Iterator, typename _Sequence, typename _Category>
	_Parameter(std::move_iterator<_Safe_iterator<_Iterator, _Sequence,
						     _Category>> const& __it,
	  const char* __name, _Is_iterator)
	: _Parameter(__it.base(), __name, _Is_iterator{})
      {
	_M_variant._M_iterator._M_type
	  = _GLIBCXX_TYPEID(std::move_iterator<_Iterator>);
      }

    private:
      _Iterator_state
      _S_reverse_state(_Iterator_state __state)
      {
	  switch (__state)
	    {
	    case __begin:
	      return __rend;
	    case __middle:
	      return __rmiddle;
	    case __end:
	      return __rbegin;
	    default:
	      return __state;
	    }
      }

    public:
#endif

      template<typename _Sequence>
	_Parameter(const _Safe_sequence<_Sequence>& __seq,
		   const char* __name, _Is_sequence)
	: _M_kind(__sequence), _M_variant()
	{
	  _M_variant._M_sequence._M_name = __name;
	  _M_variant._M_sequence._M_address =
	    static_cast<const _Sequence*>(std::__addressof(__seq));
	  _M_variant._M_sequence._M_type = _GLIBCXX_TYPEID(_Sequence);
	}

      template<typename _Sequence>
	_Parameter(const _Sequence& __seq, const char* __name, _Is_sequence)
	: _M_kind(__sequence), _M_variant()
	{
	  _M_variant._M_sequence._M_name = __name;
	  _M_variant._M_sequence._M_address = std::__addressof(__seq);
	  _M_variant._M_sequence._M_type = _GLIBCXX_TYPEID(_Sequence);
	}

      template<typename _Iterator>
	_Parameter(const _Iterator& __it, const char* __name,
		   _Is_iterator_value_type)
	: _M_kind(__iterator_value_type), _M_variant()
	{
	  _M_variant._M_iterator_value_type._M_name = __name;
	  _M_variant._M_iterator_value_type._M_type =
	    _GLIBCXX_TYPEID(typename std::iterator_traits<_Iterator>::value_type);
	}

      template<typename _Type>
	_Parameter(const _Type& __inst, const char* __name, _Is_instance)
	: _M_kind(__instance), _M_variant()
	{
	  _M_variant._M_instance._M_name = __name;
	  _M_variant._M_instance._M_address = &__inst;
	  _M_variant._M_instance._M_type = _GLIBCXX_TYPEID(_Type);
	}

#if !_GLIBCXX_INLINE_VERSION
      void
      _M_print_field(const _Error_formatter* __formatter,
		     const char* __name) const _GLIBCXX_DEPRECATED;

      void
      _M_print_description(const _Error_formatter* __formatter)
	const _GLIBCXX_DEPRECATED;
#endif
    };

    template<typename _Iterator>
      _Error_formatter&
      _M_iterator(const _Iterator& __it, const char* __name = 0)
      {
	if (_M_num_parameters < std::size_t(__max_parameters))
	  _M_parameters[_M_num_parameters++] = _Parameter(__it, __name,
							  _Is_iterator());
	return *this;
      }

    template<typename _Iterator>
      _Error_formatter&
      _M_iterator_value_type(const _Iterator& __it,
			     const char* __name = 0)
      {
	if (_M_num_parameters < __max_parameters)
	  _M_parameters[_M_num_parameters++] =
	    _Parameter(__it, __name, _Is_iterator_value_type());
	return *this;
      }

    _Error_formatter&
    _M_integer(long __value, const char* __name = 0)
    {
      if (_M_num_parameters < __max_parameters)
	_M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
      return *this;
    }

    _Error_formatter&
    _M_string(const char* __value, const char* __name = 0)
    {
      if (_M_num_parameters < __max_parameters)
	_M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
      return *this;
    }

    template<typename _Sequence>
      _Error_formatter&
      _M_sequence(const _Sequence& __seq, const char* __name = 0)
      {
	if (_M_num_parameters < __max_parameters)
	  _M_parameters[_M_num_parameters++] = _Parameter(__seq, __name,
							  _Is_sequence());
	return *this;
      }

    template<typename _Type>
      _Error_formatter&
      _M_instance(const _Type& __inst, const char* __name = 0)
      {
	if (_M_num_parameters < __max_parameters)
	  _M_parameters[_M_num_parameters++] = _Parameter(__inst, __name,
							  _Is_instance());
	return *this;
      }

    _Error_formatter&
    _M_message(const char* __text)
    { _M_text = __text; return *this; }

    // Kept const qualifier for backward compatibility, to keep the same
    // exported symbol.
    _Error_formatter&
    _M_message(_Debug_msg_id __id) const throw ();

    _GLIBCXX_NORETURN void
    _M_error() const;

#if !_GLIBCXX_INLINE_VERSION
    template<typename _Tp>
      void
      _M_format_word(char*, int, const char*, _Tp)
      const throw () _GLIBCXX_DEPRECATED;

    void
    _M_print_word(const char* __word) const _GLIBCXX_DEPRECATED;

    void
    _M_print_string(const char* __string) const _GLIBCXX_DEPRECATED;
#endif

  private:
    _Error_formatter(const char* __file, unsigned int __line,
		     const char* __function)
    : _M_file(__file), _M_line(__line), _M_num_parameters(0), _M_text(0)
    , _M_function(__function)
    { }

#if !_GLIBCXX_INLINE_VERSION
    void
    _M_get_max_length() const throw () _GLIBCXX_DEPRECATED;
#endif

    enum { __max_parameters = 9 };

    const char*		_M_file;
    unsigned int	_M_line;
    _Parameter		_M_parameters[__max_parameters];
    unsigned int	_M_num_parameters;
    const char*		_M_text;
    const char*		_M_function;

  public:
    static _Error_formatter&
    _S_at(const char* __file, unsigned int __line, const char* __function)
    {
      static _Error_formatter __formatter(__file, __line, __function);
      return __formatter;
    }
  };
} // namespace __gnu_debug

#undef _GLIBCXX_TYPEID

#endif
Commit	Line	Data
285b36d6 BK	1	// Debug-mode error formatting implementation -- C++ --
285b36d6 BK	2
a5544970	3	// Copyright (C) 2003-2019 Free Software Foundation, Inc.
285b36d6 BK	4	//
	5	// This file is part of the GNU ISO C++ Library. This library is free
	6	// software; you can redistribute it and/or modify it under the
	7	// terms of the GNU General Public License as published by the
748086b7	8	// Free Software Foundation; either version 3, or (at your option)
285b36d6 BK	9	// any later version.
	10
	11	// This library is distributed in the hope that it will be useful,
	12	// but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	// GNU General Public License for more details.
	15
748086b7 JJ	16	// Under Section 7 of GPL version 3, you are granted additional
	17	// permissions described in the GCC Runtime Library Exception, version
	18	// 3.1, as published by the Free Software Foundation.
285b36d6	19
748086b7 JJ	20	// You should have received a copy of the GNU General Public License and
	21	// a copy of the GCC Runtime Library Exception along with this program;
	22	// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
	23	// <http://www.gnu.org/licenses/>.
285b36d6	24
78a53887 BK	25	/** @file debug/formatter.h
	26	* This file is a GNU debug extension to the Standard C++ Library.
	27	*/
	28
285b36d6 BK	29	#ifndef _GLIBCXX_DEBUG_FORMATTER_H
	30	#define _GLIBCXX_DEBUG_FORMATTER_H 1
	31
b8add594	32	#include <bits/c++config.h>
fa5cc2db FD	33
	34	#if __cpp_rtti
	35	# include <typeinfo>
	36	# define _GLIBCXX_TYPEID(_Type) &typeid(_Type)
	37	#else
	38	namespace std
	39	{
	40	class type_info;
	41	}
	42	# define _GLIBCXX_TYPEID(_Type) 0
	43	#endif
285b36d6	44
6c882d0f FD	45	#if __cplusplus >= 201103L
	46	namespace __gnu_cxx
	47	{
	48	_GLIBCXX_BEGIN_NAMESPACE_VERSION
	49
	50	template<typename _Iterator, typename _Container>
	51	class __normal_iterator;
	52
	53	_GLIBCXX_END_NAMESPACE_VERSION
	54	}
	55
	56	namespace std
	57	{
	58	_GLIBCXX_BEGIN_NAMESPACE_VERSION
	59
	60	template<typename _Iterator>
	61	class reverse_iterator;
	62
	63	template<typename _Iterator>
	64	class move_iterator;
	65
	66	_GLIBCXX_END_NAMESPACE_VERSION
	67	}
	68	#endif
	69
285b36d6 BK	70	namespace __gnu_debug
285b36d6 BK	71	{
45f388bb BK	72	using std::type_info;
45f388bb BK	73
1f5ca1a1	74	template<typename _Iterator>
3ff4317f	75	bool __check_singular(const _Iterator&);
1f5ca1a1	76
285b36d6 BK	77	class _Safe_sequence_base;
285b36d6 BK	78
e9afbed0	79	template<typename _Iterator, typename _Sequence, typename _Category>
285b36d6 BK	80	class _Safe_iterator;
285b36d6 BK	81
77e0bf4e FD	82	template<typename _Iterator, typename _Sequence>
	83	class _Safe_local_iterator;
	84
526da49c	85	template<typename _Sequence>
285b36d6 BK	86	class _Safe_sequence;
	87
	88	enum _Debug_msg_id
	89	{
	90	// General checks
	91	__msg_valid_range,
	92	__msg_insert_singular,
	93	__msg_insert_different,
	94	__msg_erase_bad,
	95	__msg_erase_different,
	96	__msg_subscript_oob,
	97	__msg_empty,
	98	__msg_unpartitioned,
	99	__msg_unpartitioned_pred,
	100	__msg_unsorted,
	101	__msg_unsorted_pred,
	102	__msg_not_heap,
	103	__msg_not_heap_pred,
	104	// std::bitset checks
	105	__msg_bad_bitset_write,
	106	__msg_bad_bitset_read,
	107	__msg_bad_bitset_flip,
	108	// std::list checks
	109	__msg_self_splice,
	110	__msg_splice_alloc,
	111	__msg_splice_bad,
	112	__msg_splice_other,
	113	__msg_splice_overlap,
	114	// iterator checks
	115	__msg_init_singular,
	116	__msg_init_copy_singular,
	117	__msg_init_const_singular,
	118	__msg_copy_singular,
	119	__msg_bad_deref,
	120	__msg_bad_inc,
	121	__msg_bad_dec,
	122	__msg_iter_subscript_oob,
	123	__msg_advance_oob,
	124	__msg_retreat_oob,
	125	__msg_iter_compare_bad,
	126	__msg_compare_different,
	127	__msg_iter_order_bad,
	128	__msg_order_different,
	129	__msg_distance_bad,
	130	__msg_distance_different,
	131	// istream_iterator
	132	__msg_deref_istream,
	133	__msg_inc_istream,
	134	// ostream_iterator
	135	__msg_output_ostream,
	136	// istreambuf_iterator
	137	__msg_deref_istreambuf,
b8b4301e PC	138	__msg_inc_istreambuf,
	139	// forward_list
	140	__msg_insert_after_end,
	141	__msg_erase_after_bad,
77e0bf4e	142	__msg_valid_range2,
7181e991	143	// unordered container local iterators
a8028a3e	144	__msg_local_iter_compare_bad,
739fd6a6 PC	145	__msg_non_empty_range,
739fd6a6 PC	146	// self move assign
7181e991 FD	147	__msg_self_move_assign,
7181e991 FD	148	// unordered container buckets
14cbb5d8	149	__msg_bucket_index_oob,
e77c9aed	150	__msg_valid_load_factor,
5720787a FD	151	// others
5720787a FD	152	__msg_equal_allocs,
630a286a FD	153	__msg_insert_range_from_self,
630a286a FD	154	__msg_irreflexive_ordering
285b36d6 BK	155	};
	156
	157	class _Error_formatter
	158	{
814e52ca FD	159	// Tags denoting the type of parameter for construction
	160	struct _Is_iterator { };
	161	struct _Is_iterator_value_type { };
	162	struct _Is_sequence { };
	163	struct _Is_instance { };
	164
	165	public:
285b36d6 BK	166	/// Whether an iterator is constant, mutable, or unknown
	167	enum _Constness
	168	{
	169	__unknown_constness,
	170	__const_iterator,
	171	__mutable_iterator,
	172	__last_constness
526da49c	173	};
285b36d6 BK	174
	175	// The state of the iterator (fine-grained), if we know it.
	176	enum _Iterator_state
	177	{
	178	__unknown_state,
fa5cc2db FD	179	__singular, // singular, may still be attached to a sequence
	180	__begin, // dereferenceable, and at the beginning
	181	__middle, // dereferenceable, not at the beginning
	182	__end, // past-the-end, may be at beginning if sequence empty
	183	__before_begin, // before begin
6c882d0f FD	184	__rbegin, // dereferenceable, and at the reverse-beginning
	185	__rmiddle, // reverse-dereferenceable, not at the reverse-beginning
	186	__rend, // reverse-past-the-end
285b36d6 BK	187	__last_state
	188	};
	189
285b36d6 BK	190	// A parameter that may be referenced by an error message
	191	struct _Parameter
	192	{
526da49c BI	193	enum
	194	{
	195	__unused_param,
	196	__iterator,
	197	__sequence,
285b36d6	198	__integer,
adad2a7d FD	199	__string,
	200	__instance,
	201	__iterator_value_type
285b36d6	202	} _M_kind;
526da49c	203
adad2a7d FD	204	struct _Type
	205	{
	206	const char* _M_name;
	207	const type_info* _M_type;
	208	};
	209
	210	struct _Instance : _Type
	211	{
	212	const void* _M_address;
	213	};
	214
285b36d6 BK	215	union
	216	{
	217	// When _M_kind == __iterator
adad2a7d	218	struct : _Instance
285b36d6	219	{
fa5cc2db FD	220	_Constness _M_constness;
	221	_Iterator_state _M_state;
	222	const void* _M_sequence;
	223	const type_info* _M_seq_type;
285b36d6	224	} _M_iterator;
526da49c	225
285b36d6	226	// When _M_kind == __sequence
adad2a7d	227	_Instance _M_sequence;
285b36d6 BK	228
	229	// When _M_kind == __integer
	230	struct
	231	{
fa5cc2db FD	232	const char* _M_name;
fa5cc2db FD	233	long _M_value;
285b36d6 BK	234	} _M_integer;
	235
	236	// When _M_kind == __string
	237	struct
	238	{
fa5cc2db FD	239	const char* _M_name;
fa5cc2db FD	240	const char* _M_value;
285b36d6	241	} _M_string;
adad2a7d FD	242
	243	// When _M_kind == __instance
	244	_Instance _M_instance;
	245
	246	// When _M_kind == __iterator_value_type
	247	_Type _M_iterator_value_type;
285b36d6 BK	248	} _M_variant;
285b36d6 BK	249
26c691a8	250	_Parameter() : _M_kind(__unused_param), _M_variant() { }
526da49c	251
fa5cc2db	252	_Parameter(long __value, const char* __name)
26c691a8	253	: _M_kind(__integer), _M_variant()
526da49c	254	{
285b36d6	255	_M_variant._M_integer._M_name = __name;
526da49c	256	_M_variant._M_integer._M_value = __value;
285b36d6 BK	257	}
285b36d6 BK	258
fa5cc2db	259	_Parameter(const char* __value, const char* __name)
26c691a8	260	: _M_kind(__string), _M_variant()
285b36d6 BK	261	{
285b36d6 BK	262	_M_variant._M_string._M_name = __name;
526da49c	263	_M_variant._M_string._M_value = __value;
285b36d6 BK	264	}
285b36d6 BK	265
e9afbed0 FD	266	template<typename _Iterator, typename _Sequence, typename _Category>
e9afbed0 FD	267	_Parameter(_Safe_iterator<_Iterator, _Sequence, _Category> const& __it,
285b36d6	268	const char* __name, _Is_iterator)
26c691a8	269	: _M_kind(__iterator), _M_variant()
fa5cc2db	270	{
285b36d6	271	_M_variant._M_iterator._M_name = __name;
200fcd33	272	_M_variant._M_iterator._M_address = std::__addressof(__it);
6c882d0f	273	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(_Iterator);
526da49c	274	_M_variant._M_iterator._M_constness =
6c882d0f	275	__it._S_constant() ? __const_iterator : __mutable_iterator;
285b36d6	276	_M_variant._M_iterator._M_sequence = __it._M_get_sequence();
fa5cc2db	277	_M_variant._M_iterator._M_seq_type = _GLIBCXX_TYPEID(_Sequence);
285b36d6 BK	278
	279	if (__it._M_singular())
	280	_M_variant._M_iterator._M_state = __singular;
	281	else
	282	{
b8b4301e PC	283	if (__it._M_is_before_begin())
	284	_M_variant._M_iterator._M_state = __before_begin;
	285	else if (__it._M_is_end())
285b36d6	286	_M_variant._M_iterator._M_state = __end;
b8b4301e	287	else if (__it._M_is_begin())
285b36d6 BK	288	_M_variant._M_iterator._M_state = __begin;
	289	else
	290	_M_variant._M_iterator._M_state = __middle;
	291	}
	292	}
	293
77e0bf4e	294	template<typename _Iterator, typename _Sequence>
adad2a7d	295	_Parameter(_Safe_local_iterator<_Iterator, _Sequence> const& __it,
77e0bf4e FD	296	const char* __name, _Is_iterator)
	297	: _M_kind(__iterator), _M_variant()
	298	{
	299	_M_variant._M_iterator._M_name = __name;
200fcd33	300	_M_variant._M_iterator._M_address = std::__addressof(__it);
6c882d0f FD	301	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(_Iterator);
6c882d0f FD	302	_M_variant._M_iterator._M_constness =
77e0bf4e	303	_M_variant._M_iterator._M_constness =
6c882d0f	304	__it._S_constant() ? __const_iterator : __mutable_iterator;
77e0bf4e	305	_M_variant._M_iterator._M_sequence = __it._M_get_sequence();
fa5cc2db	306	_M_variant._M_iterator._M_seq_type = _GLIBCXX_TYPEID(_Sequence);
77e0bf4e FD	307
	308	if (__it._M_singular())
	309	_M_variant._M_iterator._M_state = __singular;
	310	else
	311	{
	312	if (__it._M_is_end())
	313	_M_variant._M_iterator._M_state = __end;
	314	else if (__it._M_is_begin())
	315	_M_variant._M_iterator._M_state = __begin;
	316	else
	317	_M_variant._M_iterator._M_state = __middle;
	318	}
	319	}
	320
285b36d6	321	template<typename _Type>
adad2a7d	322	_Parameter(const _Type* const& __it, const char* __name, _Is_iterator)
fa5cc2db FD	323	: _M_kind(__iterator), _M_variant()
fa5cc2db FD	324	{
285b36d6	325	_M_variant._M_iterator._M_name = __name;
200fcd33	326	_M_variant._M_iterator._M_address = std::__addressof(__it);
fa5cc2db	327	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
adad2a7d FD	328	_M_variant._M_iterator._M_constness = __const_iterator;
adad2a7d FD	329	_M_variant._M_iterator._M_state = __it ? __unknown_state : __singular;
285b36d6 BK	330	_M_variant._M_iterator._M_sequence = 0;
	331	_M_variant._M_iterator._M_seq_type = 0;
	332	}
	333
	334	template<typename _Type>
adad2a7d	335	_Parameter(_Type* const& __it, const char* __name, _Is_iterator)
fa5cc2db FD	336	: _M_kind(__iterator), _M_variant()
fa5cc2db FD	337	{
285b36d6	338	_M_variant._M_iterator._M_name = __name;
200fcd33	339	_M_variant._M_iterator._M_address = std::__addressof(__it);
fa5cc2db	340	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
adad2a7d FD	341	_M_variant._M_iterator._M_constness = __mutable_iterator;
adad2a7d FD	342	_M_variant._M_iterator._M_state = __it ? __unknown_state : __singular;
285b36d6 BK	343	_M_variant._M_iterator._M_sequence = 0;
	344	_M_variant._M_iterator._M_seq_type = 0;
	345	}
526da49c	346
285b36d6	347	template<typename _Iterator>
adad2a7d	348	_Parameter(_Iterator const& __it, const char* __name, _Is_iterator)
fa5cc2db FD	349	: _M_kind(__iterator), _M_variant()
fa5cc2db FD	350	{
285b36d6	351	_M_variant._M_iterator._M_name = __name;
200fcd33	352	_M_variant._M_iterator._M_address = std::__addressof(__it);
fa5cc2db	353	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
285b36d6	354	_M_variant._M_iterator._M_constness = __unknown_constness;
526da49c	355	_M_variant._M_iterator._M_state =
adad2a7d	356	__gnu_debug::__check_singular(__it) ? __singular : __unknown_state;
285b36d6 BK	357	_M_variant._M_iterator._M_sequence = 0;
	358	_M_variant._M_iterator._M_seq_type = 0;
	359	}
	360
6c882d0f FD	361	#if __cplusplus >= 201103L
	362	// The following constructors are only defined in C++11 to take
	363	// advantage of the constructor delegation feature.
	364	template<typename _Iterator, typename _Container>
	365	_Parameter(
	366	__gnu_cxx::__normal_iterator<_Iterator, _Container> const& __it,
	367	const char* __name, _Is_iterator)
	368	: _Parameter(__it.base(), __name, _Is_iterator{})
	369	{ _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it); }
	370
	371	template<typename _Iterator>
	372	_Parameter(std::reverse_iterator<_Iterator> const& __it,
	373	const char* __name, _Is_iterator)
	374	: _Parameter(__it.base(), __name, _Is_iterator{})
	375	{
	376	_M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it);
	377	_M_variant._M_iterator._M_state
	378	= _S_reverse_state(_M_variant._M_iterator._M_state);
	379	}
	380
e9afbed0 FD	381	template<typename _Iterator, typename _Sequence, typename _Category>
	382	_Parameter(std::reverse_iterator<_Safe_iterator<_Iterator, _Sequence,
	383	_Category>> const& __it,
	384	const char* __name, _Is_iterator)
6c882d0f FD	385	: _Parameter(__it.base(), __name, _Is_iterator{})
	386	{
	387	_M_variant._M_iterator._M_type
	388	= _GLIBCXX_TYPEID(std::reverse_iterator<_Iterator>);
	389	_M_variant._M_iterator._M_state
	390	= _S_reverse_state(_M_variant._M_iterator._M_state);
	391	}
	392
	393	template<typename _Iterator>
	394	_Parameter(std::move_iterator<_Iterator> const& __it,
	395	const char* __name, _Is_iterator)
	396	: _Parameter(__it.base(), __name, _Is_iterator{})
	397	{ _M_variant._M_iterator._M_type = _GLIBCXX_TYPEID(__it); }
	398
e9afbed0 FD	399	template<typename _Iterator, typename _Sequence, typename _Category>
	400	_Parameter(std::move_iterator<_Safe_iterator<_Iterator, _Sequence,
	401	_Category>> const& __it,
	402	const char* __name, _Is_iterator)
6c882d0f FD	403	: _Parameter(__it.base(), __name, _Is_iterator{})
	404	{
	405	_M_variant._M_iterator._M_type
	406	= _GLIBCXX_TYPEID(std::move_iterator<_Iterator>);
	407	}
	408
	409	private:
	410	_Iterator_state
	411	_S_reverse_state(_Iterator_state __state)
	412	{
	413	switch (__state)
	414	{
	415	case __begin:
	416	return __rend;
	417	case __middle:
	418	return __rmiddle;
	419	case __end:
	420	return __rbegin;
	421	default:
	422	return __state;
	423	}
	424	}
	425
	426	public:
	427	#endif
	428
285b36d6	429	template<typename _Sequence>
fa5cc2db	430	_Parameter(const _Safe_sequence<_Sequence>& __seq,
285b36d6	431	const char* __name, _Is_sequence)
fa5cc2db FD	432	: _M_kind(__sequence), _M_variant()
fa5cc2db FD	433	{
285b36d6	434	_M_variant._M_sequence._M_name = __name;
526da49c	435	_M_variant._M_sequence._M_address =
200fcd33	436	static_cast<const _Sequence*>(std::__addressof(__seq));
fa5cc2db	437	_M_variant._M_sequence._M_type = _GLIBCXX_TYPEID(_Sequence);
285b36d6 BK	438	}
	439
	440	template<typename _Sequence>
fa5cc2db FD	441	_Parameter(const _Sequence& __seq, const char* __name, _Is_sequence)
	442	: _M_kind(__sequence), _M_variant()
	443	{
285b36d6	444	_M_variant._M_sequence._M_name = __name;
200fcd33	445	_M_variant._M_sequence._M_address = std::__addressof(__seq);
fa5cc2db	446	_M_variant._M_sequence._M_type = _GLIBCXX_TYPEID(_Sequence);
285b36d6	447	}
526da49c	448
adad2a7d FD	449	template<typename _Iterator>
	450	_Parameter(const _Iterator& __it, const char* __name,
	451	_Is_iterator_value_type)
	452	: _M_kind(__iterator_value_type), _M_variant()
	453	{
	454	_M_variant._M_iterator_value_type._M_name = __name;
	455	_M_variant._M_iterator_value_type._M_type =
	456	_GLIBCXX_TYPEID(typename std::iterator_traits<_Iterator>::value_type);
	457	}
	458
	459	template<typename _Type>
	460	_Parameter(const _Type& __inst, const char* __name, _Is_instance)
	461	: _M_kind(__instance), _M_variant()
	462	{
	463	_M_variant._M_instance._M_name = __name;
	464	_M_variant._M_instance._M_address = &__inst;
	465	_M_variant._M_instance._M_type = _GLIBCXX_TYPEID(_Type);
	466	}
	467
dc4dd7f6	468	#if !_GLIBCXX_INLINE_VERSION
285b36d6	469	void
526da49c	470	_M_print_field(const _Error_formatter* __formatter,
814e52ca	471	const char* __name) const _GLIBCXX_DEPRECATED;
526da49c	472
285b36d6	473	void
814e52ca FD	474	_M_print_description(const _Error_formatter* __formatter)
814e52ca FD	475	const _GLIBCXX_DEPRECATED;
dc4dd7f6	476	#endif
285b36d6 BK	477	};
285b36d6 BK	478
285b36d6	479	template<typename _Iterator>
814e52ca FD	480	_Error_formatter&
814e52ca FD	481	_M_iterator(const _Iterator& __it, const char* __name = 0)
285b36d6	482	{
8fc81078	483	if (_M_num_parameters < std::size_t(__max_parameters))
285b36d6 BK	484	_M_parameters[_M_num_parameters++] = _Parameter(__it, __name,
	485	_Is_iterator());
	486	return *this;
	487	}
	488
adad2a7d	489	template<typename _Iterator>
814e52ca	490	_Error_formatter&
adad2a7d	491	_M_iterator_value_type(const _Iterator& __it,
814e52ca	492	const char* __name = 0)
adad2a7d	493	{
814e52ca	494	if (_M_num_parameters < __max_parameters)
adad2a7d FD	495	_M_parameters[_M_num_parameters++] =
	496	_Parameter(__it, __name, _Is_iterator_value_type());
	497	return *this;
	498	}
	499
814e52ca FD	500	_Error_formatter&
814e52ca FD	501	_M_integer(long __value, const char* __name = 0)
285b36d6	502	{
814e52ca	503	if (_M_num_parameters < __max_parameters)
285b36d6 BK	504	_M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
	505	return *this;
	506	}
	507
814e52ca FD	508	_Error_formatter&
814e52ca FD	509	_M_string(const char* __value, const char* __name = 0)
285b36d6	510	{
814e52ca	511	if (_M_num_parameters < __max_parameters)
285b36d6 BK	512	_M_parameters[_M_num_parameters++] = _Parameter(__value, __name);
	513	return *this;
	514	}
	515
	516	template<typename _Sequence>
814e52ca FD	517	_Error_formatter&
814e52ca FD	518	_M_sequence(const _Sequence& __seq, const char* __name = 0)
285b36d6	519	{
814e52ca	520	if (_M_num_parameters < __max_parameters)
526da49c	521	_M_parameters[_M_num_parameters++] = _Parameter(__seq, __name,
285b36d6 BK	522	_Is_sequence());
	523	return *this;
	524	}
	525
adad2a7d	526	template<typename _Type>
814e52ca FD	527	_Error_formatter&
814e52ca FD	528	_M_instance(const _Type& __inst, const char* __name = 0)
adad2a7d	529	{
814e52ca	530	if (_M_num_parameters < __max_parameters)
adad2a7d FD	531	_M_parameters[_M_num_parameters++] = _Parameter(__inst, __name,
	532	_Is_instance());
	533	return *this;
	534	}
	535
814e52ca FD	536	_Error_formatter&
814e52ca FD	537	_M_message(const char* __text)
285b36d6 BK	538	{ _M_text = __text; return *this; }
285b36d6 BK	539
814e52ca FD	540	// Kept const qualifier for backward compatibility, to keep the same
	541	// exported symbol.
	542	_Error_formatter&
5d51b87a	543	_M_message(_Debug_msg_id __id) const throw ();
285b36d6	544
b8add594	545	_GLIBCXX_NORETURN void
285b36d6 BK	546	_M_error() const;
285b36d6 BK	547
dc4dd7f6	548	#if !_GLIBCXX_INLINE_VERSION
9dc420e6	549	template<typename _Tp>
4be58168	550	void
814e52ca FD	551	_M_format_word(char, int, const char, _Tp)
814e52ca FD	552	const throw () _GLIBCXX_DEPRECATED;
4be58168	553
526da49c	554	void
814e52ca	555	_M_print_word(const char* __word) const _GLIBCXX_DEPRECATED;
285b36d6	556
526da49c	557	void
814e52ca	558	_M_print_string(const char* __string) const _GLIBCXX_DEPRECATED;
dc4dd7f6	559	#endif
285b36d6	560
adad2a7d	561	private:
a5277405 FD	562	_Error_formatter(const char* __file, unsigned int __line,
a5277405 FD	563	const char* __function)
814e52ca	564	: _M_file(__file), _M_line(__line), _M_num_parameters(0), _M_text(0)
a5277405	565	, _M_function(__function)
814e52ca	566	{ }
fa5cc2db	567
dc4dd7f6	568	#if !_GLIBCXX_INLINE_VERSION
5dddb7e5	569	void
814e52ca	570	_M_get_max_length() const throw () _GLIBCXX_DEPRECATED;
dc4dd7f6	571	#endif
5dddb7e5	572
285b36d6 BK	573	enum { __max_parameters = 9 };
285b36d6 BK	574
fa5cc2db	575	const char* _M_file;
814e52ca FD	576	unsigned int _M_line;
	577	_Parameter _M_parameters[__max_parameters];
	578	unsigned int _M_num_parameters;
	579	const char* _M_text;
a5277405	580	const char* _M_function;
285b36d6 BK	581
285b36d6 BK	582	public:
814e52ca	583	static _Error_formatter&
a5277405	584	_S_at(const char* __file, unsigned int __line, const char* __function)
814e52ca	585	{
a5277405	586	static _Error_formatter __formatter(__file, __line, __function);
814e52ca FD	587	return __formatter;
814e52ca FD	588	}
285b36d6 BK	589	};
	590	} // namespace __gnu_debug
	591
fa5cc2db FD	592	#undef _GLIBCXX_TYPEID
fa5cc2db FD	593
526da49c	594	#endif