2001-04-03 02:26:58 +02:00
|
|
|
// Concept-checking control -*- C++ -*-
|
|
|
|
|
2011-01-03 21:52:22 +01:00
|
|
|
// Copyright (C) 2001, 2009, 2010 Free Software Foundation, Inc.
|
2001-04-03 02:26:58 +02:00
|
|
|
//
|
|
|
|
// 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
|
2009-04-09 17:00:19 +02:00
|
|
|
// Free Software Foundation; either version 3, or (at your option)
|
2001-04-03 02:26:58 +02:00
|
|
|
// 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.
|
|
|
|
|
2009-04-09 17:00:19 +02:00
|
|
|
// 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.
|
2001-04-03 02:26:58 +02:00
|
|
|
|
2009-04-09 17:00:19 +02:00
|
|
|
// 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/>.
|
2001-04-03 02:26:58 +02:00
|
|
|
|
2010-12-19 10:21:16 +01:00
|
|
|
/** @file bits/concept_check.h
|
c_io_stdio.h: Correct grammar in comments.
2001-11-02 Phil Edwards <pme@gcc.gnu.org>
* config/io/c_io_stdio.h: Correct grammar in comments.
* docs/doxygen/Intro.3: Expand "top-level" man page.
* docs/doxygen/doxygroups.cc: New module definitions (comments).
* docs/doxygen/mainpage.doxy: Tweaks.
* docs/doxygen/run_doxygen: Update Doxygen version, massage man pages.
Add @file hooks so that headers are considered to be documented.
* include/bits/basic_ios.h, include/bits/basic_file.h,
include/bits/basic_string.h, include/bits/boost_concept_check.h,
include/bits/char_traits.h, include/bits/codecvt.h,
include/bits/concept_check.h, include/bits/cpp_type_traits.h,
include/bits/fpos.h, include/bits/gslice.h, include/bits/gslice_array.h,
include/bits/indirect_array.h, include/bits/ios_base.h,
include/bits/locale_facets.h, include/bits/localefwd.h,
include/bits/mask_array.h, include/bits/pthread_allocimpl.h,
include/bits/slice.h, include/bits/slice_array.h,
include/bits/std_algorithm.h, include/bits/std_bitset.h,
include/bits/std_complex.h, include/bits/std_deque.h,
include/bits/std_fstream.h, include/bits/std_functional.h,
include/bits/std_iomanip.h, include/bits/std_ios.h,
include/bits/std_iosfwd.h, include/bits/std_iostream.h,
include/bits/std_istream.h, include/bits/std_iterator.h,
include/bits/std_limits.h, include/bits/std_list.h,
include/bits/std_locale.h, include/bits/std_map.h,
include/bits/std_memory.h, include/bits/std_numeric.h,
include/bits/std_ostream.h, include/bits/std_queue.h,
include/bits/std_set.h, include/bits/std_sstream.h,
include/bits/std_stack.h, include/bits/std_streambuf.h,
include/bits/std_string.h, include/bits/std_utility.h,
include/bits/std_valarray.h, include/bits/std_vector.h,
include/bits/stl_algo.h, include/bits/stl_alloc.h,
include/bits/stl_bvector.h, include/bits/stl_construct.h,
include/bits/stl_deque.h, include/bits/stl_heap.h,
include/bits/stl_iterator.h, include/bits/stl_iterator_base_funcs.h,
include/bits/stl_iterator_base_types.h, include/bits/stl_list.h,
include/bits/stl_map.h, include/bits/stl_multimap.h,
include/bits/stl_multiset.h, include/bits/stl_numeric.h,
include/bits/stl_pair.h, include/bits/stl_pthread_alloc.h,
include/bits/stl_queue.h, include/bits/stl_raw_storage_iter.h,
include/bits/stl_relops.h, include/bits/stl_set.h,
include/bits/stl_stack.h, include/bits/stl_tempbuf.h,
include/bits/stl_threads.h, include/bits/stl_tree.h,
include/bits/stl_uninitialized.h, include/bits/stl_vector.h,
include/bits/stream_iterator.h, include/bits/streambuf_iterator.h,
include/bits/stringfwd.h, include/bits/type_traits.h,
include/bits/valarray_array.h, include/bits/valarray_meta.h:
Add hooks, tweak comments only.
* include/bits/stl_algobase.h (swap, min, iter_swap): Also
document these functions.
* include/bits/stl_function.h: Tweak link comments.
From-SVN: r46717
2001-11-02 18:38:11 +01:00
|
|
|
* This is an internal header file, included by other library headers.
|
2010-12-19 10:21:16 +01:00
|
|
|
* Do not attempt to use it directly. @headername{iterator}
|
c_io_stdio.h: Correct grammar in comments.
2001-11-02 Phil Edwards <pme@gcc.gnu.org>
* config/io/c_io_stdio.h: Correct grammar in comments.
* docs/doxygen/Intro.3: Expand "top-level" man page.
* docs/doxygen/doxygroups.cc: New module definitions (comments).
* docs/doxygen/mainpage.doxy: Tweaks.
* docs/doxygen/run_doxygen: Update Doxygen version, massage man pages.
Add @file hooks so that headers are considered to be documented.
* include/bits/basic_ios.h, include/bits/basic_file.h,
include/bits/basic_string.h, include/bits/boost_concept_check.h,
include/bits/char_traits.h, include/bits/codecvt.h,
include/bits/concept_check.h, include/bits/cpp_type_traits.h,
include/bits/fpos.h, include/bits/gslice.h, include/bits/gslice_array.h,
include/bits/indirect_array.h, include/bits/ios_base.h,
include/bits/locale_facets.h, include/bits/localefwd.h,
include/bits/mask_array.h, include/bits/pthread_allocimpl.h,
include/bits/slice.h, include/bits/slice_array.h,
include/bits/std_algorithm.h, include/bits/std_bitset.h,
include/bits/std_complex.h, include/bits/std_deque.h,
include/bits/std_fstream.h, include/bits/std_functional.h,
include/bits/std_iomanip.h, include/bits/std_ios.h,
include/bits/std_iosfwd.h, include/bits/std_iostream.h,
include/bits/std_istream.h, include/bits/std_iterator.h,
include/bits/std_limits.h, include/bits/std_list.h,
include/bits/std_locale.h, include/bits/std_map.h,
include/bits/std_memory.h, include/bits/std_numeric.h,
include/bits/std_ostream.h, include/bits/std_queue.h,
include/bits/std_set.h, include/bits/std_sstream.h,
include/bits/std_stack.h, include/bits/std_streambuf.h,
include/bits/std_string.h, include/bits/std_utility.h,
include/bits/std_valarray.h, include/bits/std_vector.h,
include/bits/stl_algo.h, include/bits/stl_alloc.h,
include/bits/stl_bvector.h, include/bits/stl_construct.h,
include/bits/stl_deque.h, include/bits/stl_heap.h,
include/bits/stl_iterator.h, include/bits/stl_iterator_base_funcs.h,
include/bits/stl_iterator_base_types.h, include/bits/stl_list.h,
include/bits/stl_map.h, include/bits/stl_multimap.h,
include/bits/stl_multiset.h, include/bits/stl_numeric.h,
include/bits/stl_pair.h, include/bits/stl_pthread_alloc.h,
include/bits/stl_queue.h, include/bits/stl_raw_storage_iter.h,
include/bits/stl_relops.h, include/bits/stl_set.h,
include/bits/stl_stack.h, include/bits/stl_tempbuf.h,
include/bits/stl_threads.h, include/bits/stl_tree.h,
include/bits/stl_uninitialized.h, include/bits/stl_vector.h,
include/bits/stream_iterator.h, include/bits/streambuf_iterator.h,
include/bits/stringfwd.h, include/bits/type_traits.h,
include/bits/valarray_array.h, include/bits/valarray_meta.h:
Add hooks, tweak comments only.
* include/bits/stl_algobase.h (swap, min, iter_swap): Also
document these functions.
* include/bits/stl_function.h: Tweak link comments.
From-SVN: r46717
2001-11-02 18:38:11 +01:00
|
|
|
*/
|
|
|
|
|
2003-07-05 06:05:45 +02:00
|
|
|
#ifndef _CONCEPT_CHECK_H
|
|
|
|
#define _CONCEPT_CHECK_H 1
|
2001-04-03 02:26:58 +02:00
|
|
|
|
|
|
|
#pragma GCC system_header
|
|
|
|
|
2001-04-18 03:06:05 +02:00
|
|
|
#include <bits/c++config.h>
|
2001-04-03 02:26:58 +02:00
|
|
|
|
|
|
|
// All places in libstdc++-v3 where these are used, or /might/ be used, or
|
|
|
|
// don't need to be used, or perhaps /should/ be used, are commented with
|
|
|
|
// "concept requirements" (and maybe some more text). So grep like crazy
|
|
|
|
// if you're looking for additional places to use these.
|
|
|
|
|
2001-04-18 03:06:05 +02:00
|
|
|
// Concept-checking code is off by default unless users turn it on via
|
|
|
|
// configure options or editing c++config.h.
|
2001-04-03 02:26:58 +02:00
|
|
|
|
2003-07-05 06:05:45 +02:00
|
|
|
#ifndef _GLIBCXX_CONCEPT_CHECKS
|
2001-04-03 02:26:58 +02:00
|
|
|
|
2003-07-05 06:05:45 +02:00
|
|
|
#define __glibcxx_function_requires(...)
|
|
|
|
#define __glibcxx_class_requires(_a,_b)
|
|
|
|
#define __glibcxx_class_requires2(_a,_b,_c)
|
|
|
|
#define __glibcxx_class_requires3(_a,_b,_c,_d)
|
|
|
|
#define __glibcxx_class_requires4(_a,_b,_c,_d,_e)
|
2001-04-03 02:26:58 +02:00
|
|
|
|
|
|
|
#else // the checks are on
|
|
|
|
|
|
|
|
#include <bits/boost_concept_check.h>
|
|
|
|
|
|
|
|
// Note that the obvious and elegant approach of
|
|
|
|
//
|
2003-07-05 06:05:45 +02:00
|
|
|
//#define glibcxx_function_requires(C) boost::function_requires< boost::C >()
|
2001-04-03 02:26:58 +02:00
|
|
|
//
|
|
|
|
// won't work due to concept templates with more than one parameter, e.g.,
|
|
|
|
// BinaryPredicateConcept. The preprocessor tries to split things up on
|
|
|
|
// the commas in the template argument list. We can't use an inner pair of
|
|
|
|
// parenthesis to hide the commas, because "boost::(Temp<Foo,Bar>)" isn't
|
2001-04-13 11:03:18 +02:00
|
|
|
// a valid instantiation pattern. Thus, we steal a feature from C99.
|
|
|
|
|
2003-07-05 06:05:45 +02:00
|
|
|
#define __glibcxx_function_requires(...) \
|
2001-11-01 16:46:48 +01:00
|
|
|
__gnu_cxx::__function_requires< __gnu_cxx::__VA_ARGS__ >();
|
2003-07-05 06:05:45 +02:00
|
|
|
#define __glibcxx_class_requires(_a,_C) \
|
|
|
|
_GLIBCXX_CLASS_REQUIRES(_a, __gnu_cxx, _C);
|
|
|
|
#define __glibcxx_class_requires2(_a,_b,_C) \
|
|
|
|
_GLIBCXX_CLASS_REQUIRES2(_a, _b, __gnu_cxx, _C);
|
|
|
|
#define __glibcxx_class_requires3(_a,_b,_c,_C) \
|
|
|
|
_GLIBCXX_CLASS_REQUIRES3(_a, _b, _c, __gnu_cxx, _C);
|
|
|
|
#define __glibcxx_class_requires4(_a,_b,_c,_d,_C) \
|
|
|
|
_GLIBCXX_CLASS_REQUIRES4(_a, _b, _c, _d, __gnu_cxx, _C);
|
2001-04-03 02:26:58 +02:00
|
|
|
|
|
|
|
#endif // enable/disable
|
|
|
|
|
2003-07-05 06:05:45 +02:00
|
|
|
#endif // _GLIBCXX_CONCEPT_CHECK
|