Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

The MPL Reference Manual: string
Prev Next | Back Along | Up Home | Full TOC Front Page / Sequences / Classes / string

string

Description

string is a variadic, bidirectional, extensible Integral Sequence Wrapper of characters that supports amortized constant-time insertion and removal of elements at both ends, and linear-time insertion and removal of elements in the middle. The parameters to string are multi-character literals, giving a somewhat readable syntax for compile-time strings. string can also be an argument to the c_str metafunction, which generates a null-terminated character array that facilitates interoperability with runtime string processing routines.

Header

Sequence form Header
Variadic #include <boost/mpl/string.hpp>

Expression semantics

In the following table, s is an instance of string, pos and last are iterators into s, r is a Forward Sequence of characters, n and x are Integral Constants, and c1,c2,... cn are arbitrary (multi-)characters.

Expression Semantics 
string<c1,c2,... cn>
string of characters c1,c2,... cn; see Variadic Sequence. 
string<c1,c2,... cn>::type
Identical to string<c1,c2,... cn>; see Variadic Sequence.
begin::type An iterator pointing to the beginning of s; see Bidirectional Sequence.
end::type An iterator pointing to the end of s; see Bidirectional Sequence.
size::type The size of s; see Bidirectional Sequence.
empty::type A boolean Integral Constant c such that c::value == true if and only if the sequence is empty; see Bidirectional Sequence.
front::type The first element in s; see Bidirectional Sequence.
back::type The last element in s; see Bidirectional Sequence.
insert::type A new string of following elements: [begin::type, pos), x, [pos, end::type); see Extensible Sequence.
insert_range::type A new string of following elements: [begin::type, pos), [begin::type, end::type) [pos, end::type); see Extensible Sequence.
erase::type A new string of following elements: [begin::type, pos), [next::type, end::type); see Extensible Sequence.
erase::type A new string of following elements: [begin::type, pos), [last, end::type); see Extensible Sequence.
clear::type An empty string; see Extensible Sequence.
push_back::type A new string of following elements: [begin::type, end::type), x; see Back Extensible Sequence.
pop_back::type A new string of following elements: [begin::type, prior< end::type >::type); see Back Extensible Sequence.
push_front::type A new string of following elements: [begin::type, end::type), x; see Front Extensible Sequence.
pop_front::type A new string of following elements: [next< begin::type >::type, end::type); see Front Extensible Sequence.
c_str::value A null-terminated byte string such that c_str::value[n] is equal to the n-th character in s, and c_str::value[size::type::value] is '\0'.

Example

typedef mpl::string<'hell','o wo','rld'> hello;
typedef mpl::push_backchar_<'!'> >::type hello2;

BOOST_ASSERT(0 == std::strcmp(mpl::c_str::value, "hello world!"));
Prev Next | Back Along | Up Home | Full TOC
Copyright © 2009 Eric Niebler
Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)