fix doc example typo
[boost.git] / boost / circular_buffer.hpp
blob13cc94fef7963b3183fa7482f4d0bf70cd17d831
1 // Circular buffer library header file.
3 // Copyright (c) 2003-2008 Jan Gaspar
5 // Use, modification, and distribution is subject to the Boost Software
6 // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
7 // http://www.boost.org/LICENSE_1_0.txt)
9 // See www.boost.org/libs/circular_buffer for documentation.
11 #if !defined(BOOST_CIRCULAR_BUFFER_HPP)
12 #define BOOST_CIRCULAR_BUFFER_HPP
14 #if defined(_MSC_VER) && _MSC_VER >= 1200
15 #pragma once
16 #endif
18 #include <boost/circular_buffer_fwd.hpp>
19 #include <boost/detail/workaround.hpp>
21 // BOOST_CB_ENABLE_DEBUG: Debug support control.
22 #if defined(NDEBUG) || defined(BOOST_CB_DISABLE_DEBUG)
23 #define BOOST_CB_ENABLE_DEBUG 0
24 #else
25 #define BOOST_CB_ENABLE_DEBUG 1
26 #endif
28 // BOOST_CB_ASSERT: Runtime assertion.
29 #if BOOST_CB_ENABLE_DEBUG
30 #include <boost/assert.hpp>
31 #define BOOST_CB_ASSERT(Expr) BOOST_ASSERT(Expr)
32 #else
33 #define BOOST_CB_ASSERT(Expr) ((void)0)
34 #endif
36 // BOOST_CB_STATIC_ASSERT: Compile time assertion.
37 #if BOOST_WORKAROUND(BOOST_MSVC, < 1300)
38 #define BOOST_CB_STATIC_ASSERT(Expr) ((void)0)
39 #else
40 #include <boost/static_assert.hpp>
41 #define BOOST_CB_STATIC_ASSERT(Expr) BOOST_STATIC_ASSERT(Expr)
42 #endif
44 // BOOST_CB_IS_CONVERTIBLE: Check if Iterator::value_type is convertible to Type.
45 #if BOOST_WORKAROUND(__BORLANDC__, <= 0x0550) || BOOST_WORKAROUND(__MWERKS__, <= 0x2407) || \
46 BOOST_WORKAROUND(BOOST_MSVC, < 1300)
47 #define BOOST_CB_IS_CONVERTIBLE(Iterator, Type) ((void)0)
48 #else
49 #include <boost/detail/iterator.hpp>
50 #include <boost/type_traits/is_convertible.hpp>
51 #define BOOST_CB_IS_CONVERTIBLE(Iterator, Type) \
52 BOOST_CB_STATIC_ASSERT((is_convertible<typename detail::iterator_traits<Iterator>::value_type, Type>::value))
53 #endif
55 // BOOST_CB_ASSERT_TEMPLATED_ITERATOR_CONSTRUCTORS:
56 // Check if the STL provides templated iterator constructors for its containers.
57 #if defined(BOOST_NO_TEMPLATED_ITERATOR_CONSTRUCTORS)
58 #define BOOST_CB_ASSERT_TEMPLATED_ITERATOR_CONSTRUCTORS BOOST_CB_STATIC_ASSERT(false);
59 #else
60 #define BOOST_CB_ASSERT_TEMPLATED_ITERATOR_CONSTRUCTORS ((void)0);
61 #endif
63 #include <boost/circular_buffer/debug.hpp>
64 #include <boost/circular_buffer/details.hpp>
65 #include <boost/circular_buffer/base.hpp>
66 #include <boost/circular_buffer/space_optimized.hpp>
68 #undef BOOST_CB_ASSERT_TEMPLATED_ITERATOR_CONSTRUCTORS
69 #undef BOOST_CB_IS_CONVERTIBLE
70 #undef BOOST_CB_STATIC_ASSERT
71 #undef BOOST_CB_ASSERT
72 #undef BOOST_CB_ENABLE_DEBUG
74 #endif // #if !defined(BOOST_CIRCULAR_BUFFER_HPP)