• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2 / Distributed under the Boost Software License, Version 1.0. (See accompanying
3 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
4 /]
5
6[library Boost.STLInterfaces
7    [quickbook 1.3]
8    [authors [Laine, Zach]]
9    [copyright 2019 T. Zachary Laine]
10    [category template]
11    [id stl_interfaces]
12    [dirname stl_interfaces]
13    [purpose
14        A string and rope library targeting standardization.
15    ]
16    [license
17        Distributed under the Boost Software License, Version 1.0.
18        (See accompanying file LICENSE_1_0.txt or copy at
19        [@http://www.boost.org/LICENSE_1_0.txt])
20    ]
21]
22
23[/ QuickBook Document version 1.3 ]
24
25[/ Imports ]
26
27[/ Iterator Examples ]
28[import ../example/repeated_chars_iterator.cpp]
29[import ../example/node_iterator.cpp]
30[import ../example/filtered_int_iterator.cpp]
31[import ../example/random_access_iterator.cpp]
32[import ../example/interoperability.cpp]
33[import ../example/zip_proxy_iterator.cpp]
34[import ../example/back_insert_iterator.cpp]
35[import ../example/reverse_iterator.cpp]
36
37[/ View Examples ]
38[import ../example/drop_while_view.cpp]
39
40[/ Container Examples ]
41[import ../example/static_vector.hpp]
42[import ../example/static_vector.cpp]
43
44[/ Images ]
45
46[def __note__              [$images/note.png]]
47[def __tip__               [$images/tip.png]]
48[def __important__         [$images/important.png]]
49[def __caution__           [$images/caution.png]]
50[def __warning__           [$images/warning.png]]
51
52[/ Links ]
53
54[def _IFaces_              Boost.STLInterfaces]
55[def _iter_iface_          [classref boost::stl_interfaces::v1::iterator_interface `iterator_interface`]]
56[def _proxy_iter_iface_    [classref boost::stl_interfaces::v1::proxy_iterator_interface `proxy_iterator_interface`]]
57[def _view_iface_          [classref boost::stl_interfaces::v1::view_interface `view_interface`]]
58[def _cont_iface_          [classref boost::stl_interfaces::v1::sequence_container_interface `sequence_container_interface`]]
59[def _rev_iter_            [classref boost::stl_interfaces::v1::reverse_iterator `reverse_iterator`]]
60[def _access_              [classref boost::stl_interfaces::access `access`]]
61
62[def _concept_m_           [macroref BOOST_STL_INTERFACES_STATIC_ASSERT_CONCEPT]]
63[def _traits_m_            [macroref BOOST_STL_INTERFACES_STATIC_ASSERT_ITERATOR_TRAITS]]
64
65[def _CRTP_                [@https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern CRTP]]
66[def _Iterator_            [@https://www.boost.org/doc/libs/release/libs/iterator Boost.Iterator]]
67[def _Container_           [@https://www.boost.org/doc/libs/release/libs/container Boost.Container]]
68
69[def _emdash_              \u2014]
70
71[include intro.qbk]
72[include tutorial.qbk]
73[include examples.qbk]
74
75[section Compiler Support]
76
77_IFaces_ is written against the C++14 standard.  It is targetting
78standardization, and the changes required to make it C++11-compatible were
79considered too great.
80
81_IFaces_ should work with any conforming C++14 compiler.  It has been tested with Clang, GCC, and Visual Studio.
82
83[endsect]
84
85[section Reference]
86[xinclude stl_interfaces_reference.xml]
87[endsect]
88
89[include rationale.qbk]
90