+2011-08-06 Benjamin Kosnik <bkoz@redhat.com>
+
+ * doc/doxygen/user.cfg.in (PDF_HYPERLINKS): To NO.
+
+2011-08-06 Benjamin Kosnik <bkoz@redhat.com>
+
+ * doc/doxygen/user.cfg.in: Add scoped_allocator.
+
+ * include/debug/safe_sequence.h: Fix doxygen markup.
+ * include/debug/safe_unordered_base.h: Same.
+ * include/debug/safe_local_iterator.tcc: Same.
+ * include/debug/safe_unordered_container.h: Same.
+ * include/std/valarray: Same.
+ * include/std/iomanip: Same.
+ * include/std/streambuf: Same.
+ * include/std/bitset: Same.
+ * include/std/fstream: Same.
+ * include/std/functional: Same.
+ * include/std/istream: Same.
+ * include/std/ostream: Same.
+ * include/std/scoped_allocator: Same.
+ * include/std/sstream: Same.
+ * include/parallel/multiway_merge.h: Same.
+ * include/parallel/base.h: Same.
+ * include/parallel/for_each_selectors.h: Same.
+ * include/parallel/multiway_mergesort.h: Same.
+ * include/parallel/search.h: Same.
+ * include/parallel/partial_sum.h: Same.
+ * include/parallel/queue.h: Same.
+ * include/parallel/sort.h: Same.
+ * include/parallel/random_number.h: Same.
+ * include/ext/vstring.h: Same.
+ * include/ext/algorithm: Same.
+ * include/ext/pb_ds/assoc_container.h: Same.
+ * include/ext/bitmap_allocator.h: Same.
+ * include/ext/stdio_filebuf.h: Same.
+ * include/ext/memory: Same.
+ * include/ext/functional: Same.
+ * include/bits/basic_ios.h: Same.
+ * include/bits/stl_list.h: Same.
+ * include/bits/stl_map.h: Same.
+ * include/bits/stl_algobase.h: Same.
+ * include/bits/stl_queue.h: Same.
+ * include/bits/gslice.h: Same.
+ * include/bits/locale_classes.h: Same.
+ * include/bits/stl_set.h: Same.
+ * include/bits/locale_facets.h: Same.
+ * include/bits/stl_stack.h: Same.
+ * include/bits/stl_heap.h: Same.
+ * include/bits/forward_list.h: Same.
+ * include/bits/stream_iterator.h: Same.
+ * include/bits/basic_string.h: Same.
+ * include/bits/stl_multimap.h: Same.
+ * include/bits/stl_pair.h: Same.
+ * include/bits/ios_base.h: Same.
+ * include/bits/stl_numeric.h: Same.
+ * include/bits/stl_vector.h: Same.
+ * include/bits/stl_deque.h: Same.
+ * include/bits/codecvt.h: Same.
+ * include/bits/stl_multiset.h: Same.
+ * include/bits/stl_uninitialized.h: Same.
+ * include/bits/ptr_traits.h: Same.
+ * include/bits/slice_array.h: Same.
+ * include/bits/stl_iterator_base_funcs.h: Same.
+ * include/bits/stl_algo.h: Same.
+ * include/bits/stl_iterator.h: Same.
+ * include/bits/stl_tempbuf.h: Same.
+ * include/bits/regex.h: Same.
+ * include/bits/range_access.h: Same.
+ * include/bits/random.h: Same.
+ * include/bits/alloc_traits.h: Same.
+ * include/bits/regex_error.h: Same.
+ * include/bits/locale_facets_nonio.h: Same.
+ * include/bits/stl_relops.h: Same.
+ * include/backward/auto_ptr.h: Same.
+ * libsupc++/initializer_list: Same.
+
+ * testsuite/23_containers/list/requirements/dr438/assign_neg.cc:
+ Adjust line numbers.
+ * testsuite/23_containers/list/requirements/dr438/insert_neg.cc: Same.
+ * testsuite/23_containers/list/requirements/dr438/constructor_1_neg.cc:
+ Same.
+ * testsuite/23_containers/list/requirements/dr438/constructor_2_neg.cc:
+ Same.
+
2011-08-05 Rainer Orth <ro@CeBiTec.Uni-Bielefeld.DE>
* acinclude.m4 (GLIBCXX_EXPORT_INCLUDES): Point TOPLEVEL_INCLUDES
include/random \
include/ratio \
include/regex \
+ include/scoped_allocator \
include/set \
include/sstream \
include/stack \
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
-PDF_HYPERLINKS = YES
+PDF_HYPERLINKS = NO
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
/**
* @brief An %auto_ptr is usually constructed from a raw pointer.
- * @param p A pointer (defaults to NULL).
+ * @param __p A pointer (defaults to NULL).
*
- * This object now @e owns the object pointed to by @a p.
+ * This object now @e owns the object pointed to by @a __p.
*/
explicit
auto_ptr(element_type* __p = 0) throw() : _M_ptr(__p) { }
/**
* @brief An %auto_ptr can be constructed from another %auto_ptr.
- * @param a Another %auto_ptr of the same type.
+ * @param __a Another %auto_ptr of the same type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership.
*/
auto_ptr(auto_ptr& __a) throw() : _M_ptr(__a.release()) { }
/**
* @brief An %auto_ptr can be constructed from another %auto_ptr.
- * @param a Another %auto_ptr of a different but related type.
+ * @param __a Another %auto_ptr of a different but related type.
*
* A pointer-to-Tp1 must be convertible to a
* pointer-to-Tp/element_type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership.
*/
template<typename _Tp1>
/**
* @brief %auto_ptr assignment operator.
- * @param a Another %auto_ptr of the same type.
+ * @param __a Another %auto_ptr of the same type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership. The object that this one @e
* used to own and track has been deleted.
*/
/**
* @brief %auto_ptr assignment operator.
- * @param a Another %auto_ptr of a different but related type.
+ * @param __a Another %auto_ptr of a different but related type.
*
* A pointer-to-Tp1 must be convertible to a pointer-to-Tp/element_type.
*
- * This object now @e owns the object previously owned by @a a,
+ * This object now @e owns the object previously owned by @a __a,
* which has given up ownership. The object that this one @e
* used to own and track has been deleted.
*/
/**
* @brief Forcibly deletes the managed object.
- * @param p A pointer (defaults to NULL).
+ * @param __p A pointer (defaults to NULL).
*
- * This object now @e owns the object pointed to by @a p. The
+ * This object now @e owns the object pointed to by @a __p. The
* previous object has been deleted.
*/
void
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
+/** @file bits/alloc_traits.h
+ * This is an internal header file, included by other library headers.
+ * Do not attempt to use it directly. @headername{scoped_allocator}
+ */
+
#ifndef _ALLOC_TRAITS_H
#define _ALLOC_TRAITS_H 1
/**
* @brief Allocate memory.
- * @param a An allocator.
- * @param n The number of objects to allocate space for.
+ * @param __a An allocator.
+ * @param __n The number of objects to allocate space for.
*
* Calls @c a.allocate(n)
*/
/**
* @brief Allocate memory.
- * @param a An allocator.
- * @param n The number of objects to allocate space for.
- * @param hint Aid to locality.
+ * @param __a An allocator.
+ * @param __n The number of objects to allocate space for.
+ * @param __hint Aid to locality.
* @return Memory of suitable size and alignment for @a n objects
* of type @c value_type
*
/**
* @brief Deallocate memory.
- * @param a An allocator.
- * @param p Pointer to the memory to deallocate.
- * @param n The number of objects space was allocated for.
+ * @param __a An allocator.
+ * @param __p Pointer to the memory to deallocate.
+ * @param __n The number of objects space was allocated for.
*
* Calls <tt> a.deallocate(p, n) </tt>
*/
{ __a.deallocate(__p, __n); }
/**
- * @brief Construct an object of type @a Tp
- * @param a An allocator.
- * @param p Pointer to memory of suitable size and alignment for Tp
- * @param args Constructor arguments.
+ * @brief Construct an object of type @a _Tp
+ * @param __a An allocator.
+ * @param __p Pointer to memory of suitable size and alignment for Tp
+ * @param __args Constructor arguments.
*
- * Calls <tt> a.construct(p, std::forward<Args>(args)...) </tt>
+ * Calls <tt> __a.construct(__p, std::forward<Args>(__args)...) </tt>
* if that expression is well-formed, otherwise uses placement-new
- * to construct an object of type @a Tp at location @a p from the
- * arguments @a args...
+ * to construct an object of type @a _Tp at location @a __p from the
+ * arguments @a __args...
*/
template<typename _Tp, typename... _Args>
static void construct(_Alloc& __a, _Tp* __p, _Args&&... __args)
{ _S_construct(__a, __p, std::forward<_Args>(__args)...); }
/**
- * @brief Destroy an object of type @a Tp
- * @param a An allocator.
- * @param p Pointer to the object to destroy
+ * @brief Destroy an object of type @a _Tp
+ * @param __a An allocator.
+ * @param __p Pointer to the object to destroy
*
- * Calls @c a.destroy(p) if that expression is well-formed,
- * otherwise calls @c p->~Tp()
+ * Calls @c __a.destroy(__p) if that expression is well-formed,
+ * otherwise calls @c __p->~_Tp()
*/
template <class _Tp>
static void destroy(_Alloc& __a, _Tp* __p)
/**
* @brief The maximum supported allocation size
- * @param a An allocator.
- * @return @c a.max_size() or @c numeric_limits<size_type>::max()
+ * @param __a An allocator.
+ * @return @c __a.max_size() or @c numeric_limits<size_type>::max()
*
- * Returns @c a.max_size() if that expression is well-formed,
+ * Returns @c __a.max_size() if that expression is well-formed,
* otherwise returns @c numeric_limits<size_type>::max()
*/
static size_type max_size(const _Alloc& __a)
/**
* @brief Obtain an allocator to use when copying a container.
- * @param rhs An allocator.
- * @return @c rhs.select_on_container_copy_construction() or @a rhs
+ * @param __rhs An allocator.
+ * @return @c __rhs.select_on_container_copy_construction() or @a __rhs
*
- * Returns @c rhs.select_on_container_copy_construction() if that
- * expression is well-formed, otherwise returns @a rhs
+ * Returns @c __rhs.select_on_container_copy_construction() if that
+ * expression is well-formed, otherwise returns @a __rhs
*/
static _Alloc
select_on_container_copy_construction(const _Alloc& __rhs)
/**
* @brief [Re]sets the error state.
- * @param state The new state flag(s) to set.
+ * @param __state The new state flag(s) to set.
*
* See std::ios_base::iostate for the possible bit values. Most
* users will not need to pass an argument.
/**
* @brief Sets additional flags in the error state.
- * @param state The additional state flag(s) to set.
+ * @param __state The additional state flag(s) to set.
*
* See std::ios_base::iostate for the possible bit values.
*/
/**
* @brief Throwing exceptions on errors.
- * @param except The new exceptions mask.
+ * @param __except The new exceptions mask.
*
* By default, error flags are set silently. You can set an
* exceptions mask for each stream; if a bit in the mask becomes set
/**
* @brief Ties this stream to an output stream.
- * @param tiestr The output stream.
+ * @param __tiestr The output stream.
* @return The previously tied output stream, or NULL if the stream
* was not tied.
*
/**
* @brief Changing the underlying buffer.
- * @param sb The new stream buffer.
+ * @param __sb The new stream buffer.
* @return The previous stream buffer.
*
* Associates a new buffer with the current stream, and clears the
/**
* @brief Sets a new @a empty character.
- * @param ch The new character.
+ * @param __ch The new character.
* @return The previous fill character.
*
* The fill character is used to fill out space when P+ characters
// Locales:
/**
* @brief Moves to a new locale.
- * @param loc The new locale.
+ * @param __loc The new locale.
* @return The previous locale.
*
* Calls @c ios_base::imbue(loc), and if a stream buffer is associated
/**
* @brief Squeezes characters.
- * @param c The character to narrow.
- * @param dfault The character to narrow.
+ * @param __c The character to narrow.
+ * @param __dfault The character to narrow.
* @return The narrowed character.
*
* Maps a character of @c char_type to a character of @c char,
/**
* @brief Widens characters.
- * @param c The character to widen.
+ * @param __c The character to widen.
* @return The widened character.
*
* Maps a character of @c char to a character of @c char_type.
// NB: per LWG issue 42, semantics different from IS:
/**
* @brief Construct string with copy of value of @a str.
- * @param str Source string.
+ * @param __str Source string.
*/
basic_string(const basic_string& __str);
/**
* @brief Construct string as copy of a substring.
- * @param str Source string.
- * @param pos Index of first character to copy from.
- * @param n Number of characters to copy (default remainder).
+ * @param __str Source string.
+ * @param __pos Index of first character to copy from.
+ * @param __n Number of characters to copy (default remainder).
*/
basic_string(const basic_string& __str, size_type __pos,
size_type __n = npos);
/**
* @brief Construct string as copy of a substring.
- * @param str Source string.
- * @param pos Index of first character to copy from.
- * @param n Number of characters to copy.
- * @param a Allocator to use.
+ * @param __str Source string.
+ * @param __pos Index of first character to copy from.
+ * @param __n Number of characters to copy.
+ * @param __a Allocator to use.
*/
basic_string(const basic_string& __str, size_type __pos,
size_type __n, const _Alloc& __a);
/**
* @brief Construct string initialized by a character %array.
- * @param s Source character %array.
- * @param n Number of characters to copy.
- * @param a Allocator to use (default is default allocator).
+ * @param __s Source character %array.
+ * @param __n Number of characters to copy.
+ * @param __a Allocator to use (default is default allocator).
*
- * NB: @a s must have at least @a n characters, '\\0'
+ * NB: @a __s must have at least @a __n characters, '\\0'
* has no special meaning.
*/
basic_string(const _CharT* __s, size_type __n,
const _Alloc& __a = _Alloc());
/**
* @brief Construct string as copy of a C string.
- * @param s Source C string.
- * @param a Allocator to use (default is default allocator).
+ * @param __s Source C string.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(const _CharT* __s, const _Alloc& __a = _Alloc());
/**
* @brief Construct string as multiple characters.
- * @param n Number of characters.
- * @param c Character to use.
- * @param a Allocator to use (default is default allocator).
+ * @param __n Number of characters.
+ * @param __c Character to use.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc());
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Move construct string.
- * @param str Source string.
+ * @param __str Source string.
*
- * The newly-created string contains the exact contents of @a str.
- * @a str is a valid, but unspecified string.
+ * The newly-created string contains the exact contents of @a __str.
+ * @a __str is a valid, but unspecified string.
**/
basic_string(basic_string&& __str) noexcept
: _M_dataplus(__str._M_dataplus)
/**
* @brief Construct string from an initializer %list.
- * @param l std::initializer_list of characters.
- * @param a Allocator to use (default is default allocator).
+ * @param __l std::initializer_list of characters.
+ * @param __a Allocator to use (default is default allocator).
*/
basic_string(initializer_list<_CharT> __l, const _Alloc& __a = _Alloc());
#endif // __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Construct string as copy of a range.
- * @param beg Start of range.
- * @param end End of range.
- * @param a Allocator to use (default is default allocator).
+ * @param __beg Start of range.
+ * @param __end End of range.
+ * @param __a Allocator to use (default is default allocator).
*/
template<class _InputIterator>
basic_string(_InputIterator __beg, _InputIterator __end,
/**
* @brief Assign the value of @a str to this string.
- * @param str Source string.
+ * @param __str Source string.
*/
basic_string&
operator=(const basic_string& __str)
/**
* @brief Copy contents of @a s into this string.
- * @param s Source null-terminated string.
+ * @param __s Source null-terminated string.
*/
basic_string&
operator=(const _CharT* __s)
/**
* @brief Set value to string of length 1.
- * @param c Source character.
+ * @param __c Source character.
*
* Assigning to a character makes this string length 1 and
* (*this)[0] == @a c.
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Move assign the value of @a str to this string.
- * @param str Source string.
+ * @param __str Source string.
*
* The contents of @a str are moved into this string (without copying).
* @a str is a valid, but unspecified string.
/**
* @brief Set value to string constructed from initializer %list.
- * @param l std::initializer_list.
+ * @param __l std::initializer_list.
*/
basic_string&
operator=(initializer_list<_CharT> __l)
/**
* @brief Resizes the %string to the specified number of characters.
- * @param n Number of characters the %string should contain.
- * @param c Character to fill any new elements.
+ * @param __n Number of characters the %string should contain.
+ * @param __c Character to fill any new elements.
*
* This function will %resize the %string to the specified
* number of characters. If the number is smaller than the
* %string's current size the %string is truncated, otherwise
- * the %string is extended and new elements are %set to @a c.
+ * the %string is extended and new elements are %set to @a __c.
*/
void
resize(size_type __n, _CharT __c);
/**
* @brief Resizes the %string to the specified number of characters.
- * @param n Number of characters the %string should contain.
+ * @param __n Number of characters the %string should contain.
*
* This function will resize the %string to the specified length. If
* the new size is smaller than the %string's current size the %string
/**
* @brief Attempt to preallocate enough memory for specified number of
* characters.
- * @param res_arg Number of characters required.
- * @throw std::length_error If @a res_arg exceeds @c max_size().
+ * @param __res_arg Number of characters required.
+ * @throw std::length_error If @a __res_arg exceeds @c max_size().
*
* This function attempts to reserve enough memory for the
* %string to hold the specified number of characters. If the
// Element access:
/**
* @brief Subscript access to the data contained in the %string.
- * @param pos The index of the character to access.
+ * @param __pos The index of the character to access.
* @return Read-only (constant) reference to the character.
*
* This operator allows for easy, array-style, data access.
/**
* @brief Subscript access to the data contained in the %string.
- * @param pos The index of the character to access.
+ * @param __pos The index of the character to access.
* @return Read/write reference to the character.
*
* This operator allows for easy, array-style, data access.
/**
* @brief Provides access to the data contained in the %string.
- * @param n The index of the character to access.
+ * @param __n The index of the character to access.
* @return Read-only (const) reference to the character.
* @throw std::out_of_range If @a n is an invalid index.
*
/**
* @brief Provides access to the data contained in the %string.
- * @param n The index of the character to access.
+ * @param __n The index of the character to access.
* @return Read/write reference to the character.
* @throw std::out_of_range If @a n is an invalid index.
*
// Modifiers:
/**
* @brief Append a string to this string.
- * @param str The string to append.
+ * @param __str The string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a C string.
- * @param s The C string to append.
+ * @param __s The C string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a character.
- * @param c The character to append.
+ * @param __c The character to append.
* @return Reference to this string.
*/
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Append an initializer_list of characters.
- * @param l The initializer_list of characters to be appended.
+ * @param __l The initializer_list of characters to be appended.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a string to this string.
- * @param str The string to append.
+ * @param __str The string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a substring.
- * @param str The string to append.
- * @param pos Index of the first character of str to append.
- * @param n The number of characters to append.
+ * @param __str The string to append.
+ * @param __pos Index of the first character of str to append.
+ * @param __n The number of characters to append.
* @return Reference to this string.
- * @throw std::out_of_range if @a pos is not a valid index.
+ * @throw std::out_of_range if @a __pos is not a valid index.
*
- * This function appends @a n characters from @a str starting at @a pos
- * to this string. If @a n is is larger than the number of available
- * characters in @a str, the remainder of @a str is appended.
+ * This function appends @a __n characters from @a __str
+ * starting at @a __pos to this string. If @a __n is is larger
+ * than the number of available characters in @a __str, the
+ * remainder of @a __str is appended.
*/
basic_string&
append(const basic_string& __str, size_type __pos, size_type __n);
/**
* @brief Append a C substring.
- * @param s The C string to append.
- * @param n The number of characters to append.
+ * @param __s The C string to append.
+ * @param __n The number of characters to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a C string.
- * @param s The C string to append.
+ * @param __s The C string to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append multiple characters.
- * @param n The number of characters to append.
- * @param c The character to use.
+ * @param __n The number of characters to append.
+ * @param __c The character to use.
* @return Reference to this string.
*
- * Appends n copies of c to this string.
+ * Appends __n copies of __c to this string.
*/
basic_string&
append(size_type __n, _CharT __c);
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Append an initializer_list of characters.
- * @param l The initializer_list of characters to append.
+ * @param __l The initializer_list of characters to append.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Append a range of characters.
- * @param first Iterator referencing the first character to append.
- * @param last Iterator marking the end of the range.
+ * @param __first Iterator referencing the first character to append.
+ * @param __last Iterator marking the end of the range.
* @return Reference to this string.
*
- * Appends characters in the range [first,last) to this string.
+ * Appends characters in the range [__first,__last) to this string.
*/
template<class _InputIterator>
basic_string&
/**
* @brief Append a single character.
- * @param c Character to append.
+ * @param __c Character to append.
*/
void
push_back(_CharT __c)
/**
* @brief Set value to contents of another string.
- * @param str Source string to use.
+ * @param __str Source string to use.
* @return Reference to this string.
*/
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Set value to contents of another string.
- * @param str Source string to use.
+ * @param __str Source string to use.
* @return Reference to this string.
*
- * This function sets this string to the exact contents of @a str.
- * @a str is a valid, but unspecified string.
+ * This function sets this string to the exact contents of @a __str.
+ * @a __str is a valid, but unspecified string.
*/
basic_string&
assign(basic_string&& __str)
/**
* @brief Set value to a substring of a string.
- * @param str The string to use.
- * @param pos Index of the first character of str.
- * @param n Number of characters to use.
+ * @param __str The string to use.
+ * @param __pos Index of the first character of str.
+ * @param __n Number of characters to use.
* @return Reference to this string.
* @throw std::out_of_range if @a pos is not a valid index.
*
- * This function sets this string to the substring of @a str consisting
- * of @a n characters at @a pos. If @a n is is larger than the number
- * of available characters in @a str, the remainder of @a str is used.
+ * This function sets this string to the substring of @a __str
+ * consisting of @a __n characters at @a __pos. If @a __n is
+ * is larger than the number of available characters in @a
+ * __str, the remainder of @a __str is used.
*/
basic_string&
assign(const basic_string& __str, size_type __pos, size_type __n)
/**
* @brief Set value to a C substring.
- * @param s The C string to use.
- * @param n Number of characters to use.
+ * @param __s The C string to use.
+ * @param __n Number of characters to use.
* @return Reference to this string.
*
- * This function sets the value of this string to the first @a n
- * characters of @a s. If @a n is is larger than the number of
- * available characters in @a s, the remainder of @a s is used.
+ * This function sets the value of this string to the first @a __n
+ * characters of @a __s. If @a __n is is larger than the number of
+ * available characters in @a __s, the remainder of @a __s is used.
*/
basic_string&
assign(const _CharT* __s, size_type __n);
/**
* @brief Set value to contents of a C string.
- * @param s The C string to use.
+ * @param __s The C string to use.
* @return Reference to this string.
*
- * This function sets the value of this string to the value of @a s.
- * The data is copied, so there is no dependence on @a s once the
+ * This function sets the value of this string to the value of @a __s.
+ * The data is copied, so there is no dependence on @a __s once the
* function returns.
*/
basic_string&
/**
* @brief Set value to multiple characters.
- * @param n Length of the resulting string.
- * @param c The character to use.
+ * @param __n Length of the resulting string.
+ * @param __c The character to use.
* @return Reference to this string.
*
- * This function sets the value of this string to @a n copies of
- * character @a c.
+ * This function sets the value of this string to @a __n copies of
+ * character @a __c.
*/
basic_string&
assign(size_type __n, _CharT __c)
/**
* @brief Set value to a range of characters.
- * @param first Iterator referencing the first character to append.
- * @param last Iterator marking the end of the range.
+ * @param __first Iterator referencing the first character to append.
+ * @param __last Iterator marking the end of the range.
* @return Reference to this string.
*
- * Sets value of string to characters in the range [first,last).
+ * Sets value of string to characters in the range [__first,__last).
*/
template<class _InputIterator>
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Set value to an initializer_list of characters.
- * @param l The initializer_list of characters to assign.
+ * @param __l The initializer_list of characters to assign.
* @return Reference to this string.
*/
basic_string&
/**
* @brief Insert multiple characters.
- * @param p Iterator referencing location in string to insert at.
- * @param n Number of characters to insert
- * @param c The character to insert.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __n Number of characters to insert
+ * @param __c The character to insert.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts @a n copies of character @a c starting at the position
- * referenced by iterator @a p. If adding characters causes the length
- * to exceed max_size(), length_error is thrown. The value of the
- * string doesn't change if an error is thrown.
+ * Inserts @a __n copies of character @a __c starting at the
+ * position referenced by iterator @a __p. If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
void
insert(iterator __p, size_type __n, _CharT __c)
/**
* @brief Insert a range of characters.
- * @param p Iterator referencing location in string to insert at.
- * @param beg Start of range.
- * @param end End of range.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __beg Start of range.
+ * @param __end End of range.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts characters in range [beg,end). If adding characters causes
- * the length to exceed max_size(), length_error is thrown. The value
- * of the string doesn't change if an error is thrown.
+ * Inserts characters in range [__beg,__end). If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
template<class _InputIterator>
void
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Insert an initializer_list of characters.
- * @param p Iterator referencing location in string to insert at.
- * @param l The initializer_list of characters to insert.
+ * @param __p Iterator referencing location in string to insert at.
+ * @param __l The initializer_list of characters to insert.
* @throw std::length_error If new length exceeds @c max_size().
*/
void
/**
* @brief Insert value of a string.
- * @param pos1 Iterator referencing location in string to insert at.
- * @param str The string to insert.
+ * @param __pos1 Iterator referencing location in string to insert at.
+ * @param __str The string to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts value of @a str starting at @a pos1. If adding characters
- * causes the length to exceed max_size(), length_error is thrown. The
- * value of the string doesn't change if an error is thrown.
+ * Inserts value of @a __str starting at @a __pos1. If adding
+ * characters causes the length to exceed max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
insert(size_type __pos1, const basic_string& __str)
/**
* @brief Insert a substring.
- * @param pos1 Iterator referencing location in string to insert at.
- * @param str The string to insert.
- * @param pos2 Start of characters in str to insert.
- * @param n Number of characters to insert.
+ * @param __pos1 Iterator referencing location in string to insert at.
+ * @param __str The string to insert.
+ * @param __pos2 Start of characters in str to insert.
+ * @param __n Number of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
* @throw std::out_of_range If @a pos1 > size() or
- * @a pos2 > @a str.size().
+ * @a __pos2 > @a str.size().
*
- * Starting at @a pos1, insert @a n character of @a str beginning with
- * @a pos2. If adding characters causes the length to exceed
- * max_size(), length_error is thrown. If @a pos1 is beyond the end of
- * this string or @a pos2 is beyond the end of @a str, out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Starting at @a pos1, insert @a __n character of @a __str
+ * beginning with @a __pos2. If adding characters causes the
+ * length to exceed max_size(), length_error is thrown. If @a
+ * __pos1 is beyond the end of this string or @a __pos2 is
+ * beyond the end of @a __str, out_of_range is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
insert(size_type __pos1, const basic_string& __str,
/**
* @brief Insert a C substring.
- * @param pos Iterator referencing location in string to insert at.
- * @param s The C string to insert.
- * @param n The number of characters to insert.
+ * @param __pos Iterator referencing location in string to insert at.
+ * @param __s The C string to insert.
+ * @param __n The number of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
- * @throw std::out_of_range If @a pos is beyond the end of this
+ * @throw std::out_of_range If @a __pos is beyond the end of this
* string.
*
- * Inserts the first @a n characters of @a s starting at @a pos. If
- * adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos is beyond end(), out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Inserts the first @a __n characters of @a __s starting at @a
+ * __pos. If adding characters causes the length to exceed
+ * max_size(), length_error is thrown. If @a __pos is beyond
+ * end(), out_of_range is thrown. The value of the string
+ * doesn't change if an error is thrown.
*/
basic_string&
insert(size_type __pos, const _CharT* __s, size_type __n);
/**
* @brief Insert a C string.
- * @param pos Iterator referencing location in string to insert at.
- * @param s The C string to insert.
+ * @param __pos Iterator referencing location in string to insert at.
+ * @param __s The C string to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
*
- * Inserts the first @a n characters of @a s starting at @a pos. If
+ * Inserts the first @a n characters of @a __s starting at @a __pos. If
* adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos is beyond end(), out_of_range is
+ * length_error is thrown. If @a __pos is beyond end(), out_of_range is
* thrown. The value of the string doesn't change if an error is
* thrown.
*/
/**
* @brief Insert multiple characters.
- * @param pos Index in string to insert at.
- * @param n Number of characters to insert
- * @param c The character to insert.
+ * @param __pos Index in string to insert at.
+ * @param __n Number of characters to insert
+ * @param __c The character to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
- * @throw std::out_of_range If @a pos is beyond the end of this
+ * @throw std::out_of_range If @a __pos is beyond the end of this
* string.
*
- * Inserts @a n copies of character @a c starting at index @a pos. If
- * adding characters causes the length to exceed max_size(),
- * length_error is thrown. If @a pos > length(), out_of_range is
- * thrown. The value of the string doesn't change if an error is
- * thrown.
+ * Inserts @a __n copies of character @a __c starting at index
+ * @a __pos. If adding characters causes the length to exceed
+ * max_size(), length_error is thrown. If @a __pos > length(),
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
insert(size_type __pos, size_type __n, _CharT __c)
/**
* @brief Insert one character.
- * @param p Iterator referencing position in string to insert at.
- * @param c The character to insert.
+ * @param __p Iterator referencing position in string to insert at.
+ * @param __c The character to insert.
* @return Iterator referencing newly inserted char.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Inserts character @a c at position referenced by @a p. If adding
- * character causes the length to exceed max_size(), length_error is
- * thrown. If @a p is beyond end of string, out_of_range is thrown.
- * The value of the string doesn't change if an error is thrown.
+ * Inserts character @a __c at position referenced by @a __p.
+ * If adding character causes the length to exceed max_size(),
+ * length_error is thrown. If @a __p is beyond end of string,
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
iterator
insert(iterator __p, _CharT __c)
/**
* @brief Remove characters.
- * @param pos Index of first character to remove (default 0).
- * @param n Number of characters to remove (default remainder).
+ * @param __pos Index of first character to remove (default 0).
+ * @param __n Number of characters to remove (default remainder).
* @return Reference to this string.
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
*
- * Removes @a n characters from this string starting at @a pos. The
- * length of the string is reduced by @a n. If there are < @a n
- * characters to remove, the remainder of the string is truncated. If
- * @a p is beyond end of string, out_of_range is thrown. The value of
- * the string doesn't change if an error is thrown.
+ * Removes @a __n characters from this string starting at @a
+ * __pos. The length of the string is reduced by @a __n. If
+ * there are < @a __n characters to remove, the remainder of
+ * the string is truncated. If @a __p is beyond end of string,
+ * out_of_range is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
erase(size_type __pos = 0, size_type __n = npos)
/**
* @brief Remove one character.
- * @param position Iterator referencing the character to remove.
+ * @param __position Iterator referencing the character to remove.
* @return iterator referencing same location after removal.
*
- * Removes the character at @a position from this string. The value
+ * Removes the character at @a __position from this string. The value
* of the string doesn't change if an error is thrown.
*/
iterator
/**
* @brief Remove a range of characters.
- * @param first Iterator referencing the first character to remove.
- * @param last Iterator referencing the end of the range.
+ * @param __first Iterator referencing the first character to remove.
+ * @param __last Iterator referencing the end of the range.
* @return Iterator referencing location of first after removal.
*
* Removes the characters in the range [first,last) from this string.
/**
* @brief Replace characters with value from another string.
- * @param pos Index of first character to replace.
- * @param n Number of characters to be replaced.
- * @param str String to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n Number of characters to be replaced.
+ * @param __str String to insert.
* @return Reference to this string.
* @throw std::out_of_range If @a pos is beyond the end of this
* string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos+n) from this string.
- * In place, the value of @a str is inserted. If @a pos is beyond end
- * of string, out_of_range is thrown. If the length of the result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [__pos,__pos+__n) from
+ * this string. In place, the value of @a __str is inserted.
+ * If @a __pos is beyond end of string, out_of_range is thrown.
+ * If the length of the result exceeds max_size(), length_error
+ * is thrown. The value of the string doesn't change if an
+ * error is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n, const basic_string& __str)
/**
* @brief Replace characters with value from another string.
- * @param pos1 Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param str String to insert.
- * @param pos2 Index of first character of str to use.
- * @param n2 Number of characters from str to use.
+ * @param __pos1 Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __str String to insert.
+ * @param __pos2 Index of first character of str to use.
+ * @param __n2 Number of characters from str to use.
* @return Reference to this string.
- * @throw std::out_of_range If @a pos1 > size() or @a pos2 >
- * str.size().
+ * @throw std::out_of_range If @a __pos1 > size() or @a __pos2 >
+ * __str.size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos1,pos1 + n) from this
- * string. In place, the value of @a str is inserted. If @a pos is
+ * Removes the characters in the range [__pos1,__pos1 + n) from this
+ * string. In place, the value of @a __str is inserted. If @a __pos is
* beyond end of string, out_of_range is thrown. If the length of the
* result exceeds max_size(), length_error is thrown. The value of the
* string doesn't change if an error is thrown.
/**
* @brief Replace characters with value of a C substring.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param s C string to insert.
- * @param n2 Number of characters from @a s to use.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __s C string to insert.
+ * @param __n2 Number of characters from @a s to use.
* @return Reference to this string.
* @throw std::out_of_range If @a pos1 > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, the first @a n2 characters of @a s are inserted, or all
- * of @a s if @a n2 is too large. If @a pos is beyond end of string,
- * out_of_range is thrown. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__pos,__pos + __n1)
+ * from this string. In place, the first @a __n2 characters of
+ * @a __s are inserted, or all of @a __s if @a __n2 is too large. If
+ * @a __pos is beyond end of string, out_of_range is thrown. If
+ * the length of result exceeds max_size(), length_error is
+ * thrown. The value of the string doesn't change if an error
+ * is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, const _CharT* __s,
/**
* @brief Replace characters with value of a C string.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param s C string to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __s C string to insert.
* @return Reference to this string.
* @throw std::out_of_range If @a pos > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, the characters of @a s are inserted. If @a pos is beyond
- * end of string, out_of_range is thrown. If the length of result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [__pos,__pos + __n1)
+ * from this string. In place, the characters of @a __s are
+ * inserted. If @a __pos is beyond end of string, out_of_range
+ * is thrown. If the length of result exceeds max_size(),
+ * length_error is thrown. The value of the string doesn't
+ * change if an error is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, const _CharT* __s)
/**
* @brief Replace characters with multiple characters.
- * @param pos Index of first character to replace.
- * @param n1 Number of characters to be replaced.
- * @param n2 Number of characters to insert.
- * @param c Character to insert.
+ * @param __pos Index of first character to replace.
+ * @param __n1 Number of characters to be replaced.
+ * @param __n2 Number of characters to insert.
+ * @param __c Character to insert.
* @return Reference to this string.
- * @throw std::out_of_range If @a pos > size().
+ * @throw std::out_of_range If @a __pos > size().
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [pos,pos + n1) from this string.
- * In place, @a n2 copies of @a c are inserted. If @a pos is beyond
- * end of string, out_of_range is thrown. If the length of result
- * exceeds max_size(), length_error is thrown. The value of the string
- * doesn't change if an error is thrown.
+ * Removes the characters in the range [pos,pos + n1) from this
+ * string. In place, @a __n2 copies of @a __c are inserted.
+ * If @a __pos is beyond end of string, out_of_range is thrown.
+ * If the length of result exceeds max_size(), length_error is
+ * thrown. The value of the string doesn't change if an error
+ * is thrown.
*/
basic_string&
replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c)
/**
* @brief Replace range of characters with string.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param str String value to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __str String value to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the value of
- * @a str is inserted. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the value of @a __str is inserted. If the length of result
+ * exceeds max_size(), length_error is thrown. The value of
+ * the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const basic_string& __str)
/**
* @brief Replace range of characters with C substring.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param s C string value to insert.
- * @param n Number of characters from s to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __s C string value to insert.
+ * @param __n Number of characters from s to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the first @a
- * n characters of @a s are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the first @a __n characters of @a __s are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const _CharT* __s, size_type __n)
/**
* @brief Replace range of characters with C string.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param s C string value to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __s C string value to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, the
- * characters of @a s are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * the characters of @a __s are inserted. If the length of
+ * result exceeds max_size(), length_error is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, const _CharT* __s)
/**
* @brief Replace range of characters with multiple characters
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param n Number of characters to insert.
- * @param c Character to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __n Number of characters to insert.
+ * @param __c Character to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, @a n copies
- * of @a c are inserted. If the length of result exceeds max_size(),
- * length_error is thrown. The value of the string doesn't change if
- * an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * @a __n copies of @a __c are inserted. If the length of
+ * result exceeds max_size(), length_error is thrown. The
+ * value of the string doesn't change if an error is thrown.
*/
basic_string&
replace(iterator __i1, iterator __i2, size_type __n, _CharT __c)
/**
* @brief Replace range of characters with range.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param k1 Iterator referencing start of range to insert.
- * @param k2 Iterator referencing end of range to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __k1 Iterator referencing start of range to insert.
+ * @param __k2 Iterator referencing end of range to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, characters
- * in the range [k1,k2) are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * characters in the range [__k1,__k2) are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
template<class _InputIterator>
basic_string&
#ifdef __GXX_EXPERIMENTAL_CXX0X__
/**
* @brief Replace range of characters with initializer_list.
- * @param i1 Iterator referencing start of range to replace.
- * @param i2 Iterator referencing end of range to replace.
- * @param l The initializer_list of characters to insert.
+ * @param __i1 Iterator referencing start of range to replace.
+ * @param __i2 Iterator referencing end of range to replace.
+ * @param __l The initializer_list of characters to insert.
* @return Reference to this string.
* @throw std::length_error If new length exceeds @c max_size().
*
- * Removes the characters in the range [i1,i2). In place, characters
- * in the range [k1,k2) are inserted. If the length of result exceeds
- * max_size(), length_error is thrown. The value of the string doesn't
- * change if an error is thrown.
+ * Removes the characters in the range [__i1,__i2). In place,
+ * characters in the range [__k1,__k2) are inserted. If the
+ * length of result exceeds max_size(), length_error is thrown.
+ * The value of the string doesn't change if an error is
+ * thrown.
*/
basic_string& replace(iterator __i1, iterator __i2,
initializer_list<_CharT> __l)
/**
* @brief Copy substring into C string.
- * @param s C string to copy value into.
- * @param n Number of characters to copy.
- * @param pos Index of first character to copy.
+ * @param __s C string to copy value into.
+ * @param __n Number of characters to copy.
+ * @param __pos Index of first character to copy.
* @return Number of characters actually copied
- * @throw std::out_of_range If pos > size().
+ * @throw std::out_of_range If __pos > size().
*
- * Copies up to @a n characters starting at @a pos into the C string @a
- * s. If @a pos is %greater than size(), out_of_range is thrown.
+ * Copies up to @a __n characters starting at @a __pos into the
+ * C string @a __s. If @a __pos is %greater than size(),
+ * out_of_range is thrown.
*/
size_type
copy(_CharT* __s, size_type __n, size_type __pos = 0) const;
/**
* @brief Swap contents with another string.
- * @param s String to swap with.
+ * @param __s String to swap with.
*
- * Exchanges the contents of this string with that of @a s in constant
+ * Exchanges the contents of this string with that of @a __s in constant
* time.
*/
void
/**
* @brief Find position of a C substring.
- * @param s C string to locate.
- * @param pos Index of character to search from.
- * @param n Number of characters from @a s to search for.
+ * @param __s C string to locate.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from @a s to search for.
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for the first @a n characters
- * in @a s within this string. If found, returns the index where it
- * begins. If not found, returns npos.
+ * Starting from @a __pos, searches forward for the first @a
+ * __n characters in @a __s within this string. If found,
+ * returns the index where it begins. If not found, returns
+ * npos.
*/
size_type
find(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find position of a string.
- * @param str String to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __str String to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for value of @a str within
+ * Starting from @a __pos, searches forward for value of @a __str within
* this string. If found, returns the index where it begins. If not
* found, returns npos.
*/
/**
* @brief Find position of a C string.
- * @param s C string to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __s C string to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of start of first occurrence.
*
- * Starting from @a pos, searches forward for the value of @a s within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches forward for the value of @a
+ * __s within this string. If found, returns the index where
+ * it begins. If not found, returns npos.
*/
size_type
find(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches forward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
find(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPT;
/**
* @brief Find last position of a string.
- * @param str String to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __str String to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for value of @a str within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches backward for value of @a
+ * __str within this string. If found, returns the index where
+ * it begins. If not found, returns npos.
*/
size_type
rfind(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a C substring.
- * @param s C string to locate.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to search for.
+ * @param __s C string to locate.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to search for.
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for the first @a n
- * characters in @a s within this string. If found, returns the index
- * where it begins. If not found, returns npos.
+ * Starting from @a __pos, searches backward for the first @a
+ * __n characters in @a __s within this string. If found,
+ * returns the index where it begins. If not found, returns
+ * npos.
*/
size_type
rfind(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find last position of a C string.
- * @param s C string to locate.
- * @param pos Index of character to start search at (default end).
+ * @param __s C string to locate.
+ * @param __pos Index of character to start search at (default end).
* @return Index of start of last occurrence.
*
- * Starting from @a pos, searches backward for the value of @a s within
- * this string. If found, returns the index where it begins. If not
- * found, returns npos.
+ * Starting from @a __pos, searches backward for the value of
+ * @a __s within this string. If found, returns the index
+ * where it begins. If not found, returns npos.
*/
size_type
rfind(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches backward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
rfind(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPT;
/**
* @brief Find position of a character of string.
- * @param str String containing characters to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __str String containing characters to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the characters of
- * @a str within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * characters of @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_first_of(const basic_string& __str, size_type __pos = 0) const
/**
* @brief Find position of a character of C substring.
- * @param s String containing characters to locate.
- * @param pos Index of character to search from.
- * @param n Number of characters from s to search for.
+ * @param __s String containing characters to locate.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from s to search for.
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the first @a n
- * characters of @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * first @a __n characters of @a __s within this string. If
+ * found, returns the index where it was found. If not found,
+ * returns npos.
*/
size_type
find_first_of(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find position of a character of C string.
- * @param s String containing characters to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __s String containing characters to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for one of the characters of
- * @a s within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for one of the
+ * characters of @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_first_of(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for the character @a c within
- * this string. If found, returns the index where it was found. If
- * not found, returns npos.
+ * Starting from @a __pos, searches forward for the character
+ * @a __c within this string. If found, returns the index
+ * where it was found. If not found, returns npos.
*
- * Note: equivalent to find(c, pos).
+ * Note: equivalent to find(__c, __pos).
*/
size_type
find_first_of(_CharT __c, size_type __pos = 0) const _GLIBCXX_NOEXCEPT
/**
* @brief Find last position of a character of string.
- * @param str String containing characters to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __str String containing characters to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the characters of
- * @a str within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * characters of @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_of(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a character of C substring.
- * @param s C string containing characters to locate.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to search for.
+ * @param __s C string containing characters to locate.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to search for.
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the first @a n
- * characters of @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * first @a __n characters of @a __s within this string. If
+ * found, returns the index where it was found. If not found,
+ * returns npos.
*/
size_type
find_last_of(const _CharT* __s, size_type __pos, size_type __n) const;
/**
* @brief Find last position of a character of C string.
- * @param s C string containing characters to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __s C string containing characters to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for one of the characters of
- * @a s within this string. If found, returns the index where it was
- * found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for one of the
+ * characters of @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_last_of(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a character.
- * @param c Character to locate.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to locate.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for @a c within this string.
- * If found, returns the index where it was found. If not found,
- * returns npos.
+ * Starting from @a __pos, searches backward for @a __c within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*
- * Note: equivalent to rfind(c, pos).
+ * Note: equivalent to rfind(__c, __pos).
*/
size_type
find_last_of(_CharT __c, size_type __pos = npos) const _GLIBCXX_NOEXCEPT
/**
* @brief Find position of a character not in string.
- * @param str String containing characters to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __str String containing characters to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in @a str within this string. If found, returns the index where it
+ * Starting from @a __pos, searches forward for a character not contained
+ * in @a __str within this string. If found, returns the index where it
* was found. If not found, returns npos.
*/
size_type
/**
* @brief Find position of a character not in C substring.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search from.
- * @param n Number of characters from s to consider.
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search from.
+ * @param __n Number of characters from __s to consider.
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in the first @a n characters of @a s within this string. If found,
- * returns the index where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character not
+ * contained in the first @a __n characters of @a __s within
+ * this string. If found, returns the index where it was
+ * found. If not found, returns npos.
*/
size_type
find_first_not_of(const _CharT* __s, size_type __pos,
/**
* @brief Find position of a character not in C string.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character not contained
- * in @a s within this string. If found, returns the index where it
- * was found. If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character not
+ * contained in @a __s within this string. If found, returns
+ * the index where it was found. If not found, returns npos.
*/
size_type
find_first_not_of(const _CharT* __s, size_type __pos = 0) const
/**
* @brief Find position of a different character.
- * @param c Character to avoid.
- * @param pos Index of character to search from (default 0).
+ * @param __c Character to avoid.
+ * @param __pos Index of character to search from (default 0).
* @return Index of first occurrence.
*
- * Starting from @a pos, searches forward for a character other than @a c
- * within this string. If found, returns the index where it was found.
- * If not found, returns npos.
+ * Starting from @a __pos, searches forward for a character
+ * other than @a __c within this string. If found, returns the
+ * index where it was found. If not found, returns npos.
*/
size_type
find_first_not_of(_CharT __c, size_type __pos = 0) const
/**
* @brief Find last position of a character not in string.
- * @param str String containing characters to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __str String containing characters to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in @a str within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for a character
+ * not contained in @a __str within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_not_of(const basic_string& __str, size_type __pos = npos) const
/**
* @brief Find last position of a character not in C substring.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search back from.
- * @param n Number of characters from s to consider.
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search back from.
+ * @param __n Number of characters from s to consider.
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in the first @a n characters of @a s within this string.
+ * Starting from @a __pos, searches backward for a character not
+ * contained in the first @a __n characters of @a __s within this string.
* If found, returns the index where it was found. If not found,
* returns npos.
*/
size_type __n) const;
/**
* @brief Find last position of a character not in C string.
- * @param s C string containing characters to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __s C string containing characters to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character not
- * contained in @a s within this string. If found, returns the index
- * where it was found. If not found, returns npos.
+ * Starting from @a __pos, searches backward for a character
+ * not contained in @a __s within this string. If found,
+ * returns the index where it was found. If not found, returns
+ * npos.
*/
size_type
find_last_not_of(const _CharT* __s, size_type __pos = npos) const
/**
* @brief Find last position of a different character.
- * @param c Character to avoid.
- * @param pos Index of character to search back from (default end).
+ * @param __c Character to avoid.
+ * @param __pos Index of character to search back from (default end).
* @return Index of last occurrence.
*
- * Starting from @a pos, searches backward for a character other than
- * @a c within this string. If found, returns the index where it was
+ * Starting from @a __pos, searches backward for a character other than
+ * @a __c within this string. If found, returns the index where it was
* found. If not found, returns npos.
*/
size_type
/**
* @brief Get a substring.
- * @param pos Index of first character (default 0).
- * @param n Number of characters in substring (default remainder).
+ * @param __pos Index of first character (default 0).
+ * @param __n Number of characters in substring (default remainder).
* @return The new string.
- * @throw std::out_of_range If pos > size().
+ * @throw std::out_of_range If __pos > size().
*
- * Construct and return a new string using the @a n characters starting
- * at @a pos. If the string is too short, use the remainder of the
- * characters. If @a pos is beyond the end of the string, out_of_range
- * is thrown.
+ * Construct and return a new string using the @a __n
+ * characters starting at @a __pos. If the string is too
+ * short, use the remainder of the characters. If @a __pos is
+ * beyond the end of the string, out_of_range is thrown.
*/
basic_string
substr(size_type __pos = 0, size_type __n = npos) const
/**
* @brief Compare to a string.
- * @param str String to compare against.
+ * @param __str String to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Returns an integer < 0 if this string is ordered before @a str, 0 if
- * their values are equivalent, or > 0 if this string is ordered after
- * @a str. Determines the effective length rlen of the strings to
- * compare as the smallest of size() and str.size(). The function
- * then compares the two strings by calling traits::compare(data(),
- * str.data(),rlen). If the result of the comparison is nonzero returns
- * it, otherwise the shorter one is ordered first.
+ * Returns an integer < 0 if this string is ordered before @a
+ * __str, 0 if their values are equivalent, or > 0 if this
+ * string is ordered after @a __str. Determines the effective
+ * length rlen of the strings to compare as the smallest of
+ * size() and str.size(). The function then compares the two
+ * strings by calling traits::compare(data(), str.data(),rlen).
+ * If the result of the comparison is nonzero returns it,
+ * otherwise the shorter one is ordered first.
*/
int
compare(const basic_string& __str) const
/**
* @brief Compare substring to a string.
- * @param pos Index of first character of substring.
- * @param n Number of characters in substring.
- * @param str String to compare against.
+ * @param __pos Index of first character of substring.
+ * @param __n Number of characters in substring.
+ * @param __str String to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n characters starting
- * at @a pos. Returns an integer < 0 if the substring is ordered
- * before @a str, 0 if their values are equivalent, or > 0 if the
- * substring is ordered after @a str. Determines the effective length
- * rlen of the strings to compare as the smallest of the length of the
- * substring and @a str.size(). The function then compares the two
- * strings by calling traits::compare(substring.data(),str.data(),rlen).
- * If the result of the comparison is nonzero returns it, otherwise the
- * shorter one is ordered first.
+ * Form the substring of this string from the @a __n characters
+ * starting at @a __pos. Returns an integer < 0 if the
+ * substring is ordered before @a __str, 0 if their values are
+ * equivalent, or > 0 if the substring is ordered after @a
+ * __str. Determines the effective length rlen of the strings
+ * to compare as the smallest of the length of the substring
+ * and @a __str.size(). The function then compares the two
+ * strings by calling
+ * traits::compare(substring.data(),str.data(),rlen). If the
+ * result of the comparison is nonzero returns it, otherwise
+ * the shorter one is ordered first.
*/
int
compare(size_type __pos, size_type __n, const basic_string& __str) const;
/**
* @brief Compare substring to a substring.
- * @param pos1 Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param str String to compare against.
- * @param pos2 Index of first character of substring of str.
- * @param n2 Number of characters in substring of str.
+ * @param __pos1 Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __str String to compare against.
+ * @param __pos2 Index of first character of substring of str.
+ * @param __n2 Number of characters in substring of str.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos1. Form the substring of @a str from the @a n2 characters
- * starting at @a pos2. Returns an integer < 0 if this substring is
- * ordered before the substring of @a str, 0 if their values are
- * equivalent, or > 0 if this substring is ordered after the substring
- * of @a str. Determines the effective length rlen of the strings
- * to compare as the smallest of the lengths of the substrings. The
- * function then compares the two strings by calling
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a __pos1. Form the substring of @a
+ * __str from the @a __n2 characters starting at @a __pos2.
+ * Returns an integer < 0 if this substring is ordered before
+ * the substring of @a __str, 0 if their values are equivalent,
+ * or > 0 if this substring is ordered after the substring of
+ * @a __str. Determines the effective length rlen of the
+ * strings to compare as the smallest of the lengths of the
+ * substrings. The function then compares the two strings by
+ * calling
* traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen).
- * If the result of the comparison is nonzero returns it, otherwise the
- * shorter one is ordered first.
+ * If the result of the comparison is nonzero returns it,
+ * otherwise the shorter one is ordered first.
*/
int
compare(size_type __pos1, size_type __n1, const basic_string& __str,
/**
* @brief Compare to a C string.
- * @param s C string to compare against.
+ * @param __s C string to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Returns an integer < 0 if this string is ordered before @a s, 0 if
+ * Returns an integer < 0 if this string is ordered before @a __s, 0 if
* their values are equivalent, or > 0 if this string is ordered after
- * @a s. Determines the effective length rlen of the strings to
+ * @a __s. Determines the effective length rlen of the strings to
* compare as the smallest of size() and the length of a string
- * constructed from @a s. The function then compares the two strings
+ * constructed from @a __s. The function then compares the two strings
* by calling traits::compare(data(),s,rlen). If the result of the
* comparison is nonzero returns it, otherwise the shorter one is
* ordered first.
// 5 String::compare specification questionable
/**
* @brief Compare substring to a C string.
- * @param pos Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param s C string to compare against.
+ * @param __pos Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __s C string to compare against.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos. Returns an integer < 0 if the substring is ordered
- * before @a s, 0 if their values are equivalent, or > 0 if the
- * substring is ordered after @a s. Determines the effective length
- * rlen of the strings to compare as the smallest of the length of the
- * substring and the length of a string constructed from @a s. The
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a pos. Returns an integer < 0 if
+ * the substring is ordered before @a __s, 0 if their values
+ * are equivalent, or > 0 if the substring is ordered after @a
+ * __s. Determines the effective length rlen of the strings to
+ * compare as the smallest of the length of the substring and
+ * the length of a string constructed from @a __s. The
* function then compares the two string by calling
- * traits::compare(substring.data(),s,rlen). If the result of the
- * comparison is nonzero returns it, otherwise the shorter one is
- * ordered first.
+ * traits::compare(substring.data(),__s,rlen). If the result of
+ * the comparison is nonzero returns it, otherwise the shorter
+ * one is ordered first.
*/
int
compare(size_type __pos, size_type __n1, const _CharT* __s) const;
/**
* @brief Compare substring against a character %array.
- * @param pos1 Index of first character of substring.
- * @param n1 Number of characters in substring.
- * @param s character %array to compare against.
- * @param n2 Number of characters of s.
+ * @param __pos Index of first character of substring.
+ * @param __n1 Number of characters in substring.
+ * @param __s character %array to compare against.
+ * @param __n2 Number of characters of s.
* @return Integer < 0, 0, or > 0.
*
- * Form the substring of this string from the @a n1 characters starting
- * at @a pos1. Form a string from the first @a n2 characters of @a s.
- * Returns an integer < 0 if this substring is ordered before the string
- * from @a s, 0 if their values are equivalent, or > 0 if this substring
- * is ordered after the string from @a s. Determines the effective
- * length rlen of the strings to compare as the smallest of the length
- * of the substring and @a n2. The function then compares the two
- * strings by calling traits::compare(substring.data(),s,rlen). If the
- * result of the comparison is nonzero returns it, otherwise the shorter
+ * Form the substring of this string from the @a __n1
+ * characters starting at @a __pos. Form a string from the
+ * first @a __n2 characters of @a __s. Returns an integer < 0
+ * if this substring is ordered before the string from @a __s,
+ * 0 if their values are equivalent, or > 0 if this substring
+ * is ordered after the string from @a __s. Determines the
+ * effective length rlen of the strings to compare as the
+ * smallest of the length of the substring and @a __n2. The
+ * function then compares the two strings by calling
+ * traits::compare(substring.data(),s,rlen). If the result of
+ * the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
* NB: s must have at least n2 characters, '\\0' has
// operator+
/**
* @brief Concatenate two strings.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with value of @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with value of @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT, _Traits, _Alloc>
/**
* @brief Concatenate C string and string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with value of @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with value of @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT,_Traits,_Alloc>
/**
* @brief Concatenate character and string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_string<_CharT,_Traits,_Alloc>
/**
* @brief Concatenate string and C string.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_string<_CharT, _Traits, _Alloc>
/**
* @brief Concatenate string and character.
- * @param lhs First string.
- * @param rhs Last string.
- * @return New string with @a lhs followed by @a rhs.
+ * @param __lhs First string.
+ * @param __rhs Last string.
+ * @return New string with @a __lhs followed by @a __rhs.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_string<_CharT, _Traits, _Alloc>
// operator ==
/**
* @brief Test equivalence of two strings.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test equivalence of C string and string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a rhs.compare(@a lhs) == 0. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __rhs.compare(@a __lhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test equivalence of string and C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs.compare(@a __rhs) == 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator !=
/**
* @brief Test difference of two strings.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test difference of C string and string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a rhs.compare(@a lhs) != 0. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __rhs.compare(@a __lhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test difference of string and C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs.compare(@a __rhs) != 0. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator <
/**
* @brief Test if string precedes string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string precedes C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string precedes string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs precedes @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs precedes @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator >
/**
* @brief Test if string follows string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string follows C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string follows string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs follows @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs follows @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator <=
/**
* @brief Test if string doesn't follow string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string doesn't follow C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string doesn't follow string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs doesn't follow @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs doesn't follow @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
// operator >=
/**
* @brief Test if string doesn't precede string.
- * @param lhs First string.
- * @param rhs Second string.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs First string.
+ * @param __rhs Second string.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if string doesn't precede C string.
- * @param lhs String.
- * @param rhs C string.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs String.
+ * @param __rhs C string.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Test if C string doesn't precede string.
- * @param lhs C string.
- * @param rhs String.
- * @return True if @a lhs doesn't precede @a rhs. False otherwise.
+ * @param __lhs C string.
+ * @param __rhs String.
+ * @return True if @a __lhs doesn't precede @a __rhs. False otherwise.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline bool
/**
* @brief Swap contents of two strings.
- * @param lhs First string.
- * @param rhs Second string.
+ * @param __lhs First string.
+ * @param __rhs Second string.
*
- * Exchanges the contents of @a lhs and @a rhs in constant time.
+ * Exchanges the contents of @a __lhs and @a __rhs in constant time.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline void
/**
* @brief Read stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from @a is into @a str until whitespace is found, the
- * end of the stream is encountered, or str.max_size() is reached. If
- * is.width() is non-zero, that is the limit on the number of characters
- * stored into @a str. Any previous contents of @a str are erased.
+ * Stores characters from @a __is into @a __str until whitespace is
+ * found, the end of the stream is encountered, or str.max_size()
+ * is reached. If is.width() is non-zero, that is the limit on the
+ * number of characters stored into @a __str. Any previous
+ * contents of @a __str are erased.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_istream<_CharT, _Traits>&
/**
* @brief Write string to a stream.
- * @param os Output stream.
- * @param str String to write out.
+ * @param __os Output stream.
+ * @param __str String to write out.
* @return Reference to the output stream.
*
- * Output characters of @a str into os following the same rules as for
+ * Output characters of @a __str into os following the same rules as for
* writing a C string.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
/**
* @brief Read a line from stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
- * @param delim Character marking end of line.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
+ * @param __delim Character marking end of line.
* @return Reference to the input stream.
*
- * Stores characters from @a is into @a str until @a delim is found, the
- * end of the stream is encountered, or str.max_size() is reached. If
- * is.width() is non-zero, that is the limit on the number of characters
- * stored into @a str. Any previous contents of @a str are erased. If @a
- * delim was encountered, it is extracted but not stored into @a str.
+ * Stores characters from @a __is into @a __str until @a __delim is
+ * found, the end of the stream is encountered, or str.max_size()
+ * is reached. If is.width() is non-zero, that is the limit on the
+ * number of characters stored into @a __str. Any previous
+ * contents of @a __str are erased. If @a __delim was encountered,
+ * it is extracted but not stored into @a __str.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
basic_istream<_CharT, _Traits>&
/**
* @brief Read a line from stream into a string.
- * @param is Input stream.
- * @param str Buffer to store into.
+ * @param __is Input stream.
+ * @param __str Buffer to store into.
* @return Reference to the input stream.
*
- * Stores characters from is into @a str until '\n' is
+ * Stores characters from is into @a __str until '\n' is
* found, the end of the stream is encountered, or str.max_size()
- * is reached. If is.width() is non-zero, that is the limit on the
- * number of characters stored into @a str. Any previous contents
- * of @a str are erased. If end of line was encountered, it is
- * extracted but not stored into @a str.
+ * is reached. If __is.width() is non-zero, that is the limit on
+ * the number of characters stored into @a __str. Any previous
+ * contents of @a __str are erased. If end of line was
+ * encountered, it is extracted but not stored into @a __str.
*/
template<typename _CharT, typename _Traits, typename _Alloc>
inline basic_istream<_CharT, _Traits>&
* output, returns codecvt_base::partial. Otherwise the
* conversion failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param from Start of input.
- * @param from_end End of input.
- * @param from_next Returns start of unconverted data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __from Start of input.
+ * @param __from_end End of input.
+ * @param __from_next Returns start of unconverted data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
* output has insufficient space, returns codecvt_base::partial.
* Otherwise the reset failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
* output, returns codecvt_base::partial. Otherwise the
* conversion failed and codecvt_base::error is returned.
*
- * @param state Persistent conversion state data.
- * @param from Start of input.
- * @param from_end End of input.
- * @param from_next Returns start of unconverted data.
- * @param to Start of output buffer.
- * @param to_end End of output buffer.
- * @param to_next Returns start of unused output area.
+ * @param __state Persistent conversion state data.
+ * @param __from Start of input.
+ * @param __from_end End of input.
+ * @param __from_next Returns start of unconverted data.
+ * @param __to Start of output buffer.
+ * @param __to_end End of output buffer.
+ * @param __to_next Returns start of unused output area.
* @return codecvt_base::result.
*/
result
/**
* @brief Creates a %forward_list with no elements.
- * @param al An allocator object.
+ * @param __al An allocator object.
*/
explicit
forward_list(const _Alloc& __al = _Alloc())
/**
* @brief Copy constructor with allocator argument.
- * @param list Input list to copy.
- * @param al An allocator object.
+ * @param __list Input list to copy.
+ * @param __al An allocator object.
*/
forward_list(const forward_list& __list, const _Alloc& __al)
: _Base(__list, __al)
/**
* @brief Move constructor with allocator argument.
- * @param list Input list to move.
- * @param al An allocator object.
+ * @param __list Input list to move.
+ * @param __al An allocator object.
*/
forward_list(forward_list&& __list, const _Alloc& __al)
: _Base(std::move(__list), __al)
/**
* @brief Creates a %forward_list with default constructed elements.
- * @param n The number of elements to initially create.
+ * @param __n The number of elements to initially create.
*
- * This constructor creates the %forward_list with @a n default
+ * This constructor creates the %forward_list with @a __n default
* constructed elements.
*/
explicit
/**
* @brief Creates a %forward_list with copies of an exemplar element.
- * @param n The number of elements to initially create.
- * @param value An element to copy.
- * @param al An allocator object.
+ * @param __n The number of elements to initially create.
+ * @param __value An element to copy.
+ * @param __al An allocator object.
*
- * This constructor fills the %forward_list with @a n copies of @a
- * value.
+ * This constructor fills the %forward_list with @a __n copies of
+ * @a __value.
*/
forward_list(size_type __n, const _Tp& __value,
const _Alloc& __al = _Alloc())
/**
* @brief Builds a %forward_list from a range.
- * @param first An input iterator.
- * @param last An input iterator.
- * @param al An allocator object.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
+ * @param __al An allocator object.
*
* Create a %forward_list consisting of copies of the elements from
- * [@a first,@a last). This is linear in N (where N is
- * distance(@a first,@a last)).
+ * [@a __first,@a __last). This is linear in N (where N is
+ * distance(@a __first,@a __last)).
*/
template<typename _InputIterator>
forward_list(_InputIterator __first, _InputIterator __last,
/**
* @brief The %forward_list copy constructor.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
* The newly-created %forward_list uses a copy of the allocation
- * object used by @a list.
+ * object used by @a __list.
*/
forward_list(const forward_list& __list)
: _Base(__list._M_get_Node_allocator())
/**
* @brief The %forward_list move constructor.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
* The newly-created %forward_list contains the exact contents of @a
- * forward_list. The contents of @a list are a valid, but unspecified
+ * forward_list. The contents of @a __list are a valid, but unspecified
* %forward_list.
*/
forward_list(forward_list&& __list) noexcept
/**
* @brief Builds a %forward_list from an initializer_list
- * @param il An initializer_list of value_type.
- * @param al An allocator object.
+ * @param __il An initializer_list of value_type.
+ * @param __al An allocator object.
*
* Create a %forward_list consisting of copies of the elements
- * in the initializer_list @a il. This is linear in il.size().
+ * in the initializer_list @a __il. This is linear in __il.size().
*/
forward_list(std::initializer_list<_Tp> __il,
const _Alloc& __al = _Alloc())
/**
* @brief The %forward_list assignment operator.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
- * All the elements of @a list are copied, but unlike the copy
+ * All the elements of @a __list are copied, but unlike the copy
* constructor, the allocator object is not copied.
*/
forward_list&
/**
* @brief The %forward_list move assignment operator.
- * @param list A %forward_list of identical element and allocator
+ * @param __list A %forward_list of identical element and allocator
* types.
*
- * The contents of @a list are moved into this %forward_list
- * (without copying). @a list is a valid, but unspecified
+ * The contents of @a __list are moved into this %forward_list
+ * (without copying). @a __list is a valid, but unspecified
* %forward_list
*/
forward_list&
/**
* @brief The %forward_list initializer list assignment operator.
- * @param il An initializer_list of value_type.
+ * @param __il An initializer_list of value_type.
*
* Replace the contents of the %forward_list with copies of the
- * elements in the initializer_list @a il. This is linear in
- * il.size().
+ * elements in the initializer_list @a __il. This is linear in
+ * __il.size().
*/
forward_list&
operator=(std::initializer_list<_Tp> __il)
/**
* @brief Assigns a range to a %forward_list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
*
* This function fills a %forward_list with copies of the elements
- * in the range [@a first,@a last).
+ * in the range [@a __first,@a __last).
*
* Note that the assignment completely changes the %forward_list and
* that the resulting %forward_list's size is the same as the number
/**
* @brief Assigns a given value to a %forward_list.
- * @param n Number of elements to be assigned.
- * @param val Value to be assigned.
+ * @param __n Number of elements to be assigned.
+ * @param __val Value to be assigned.
*
- * This function fills a %forward_list with @a n copies of the given
+ * This function fills a %forward_list with @a __n copies of the given
* value. Note that the assignment completely changes the
* %forward_list and that the resulting %forward_list's size is the
* same as the number of elements assigned. Old data may be lost.
/**
* @brief Assigns an initializer_list to a %forward_list.
- * @param il An initializer_list of value_type.
+ * @param __il An initializer_list of value_type.
*
* Replace the contents of the %forward_list with copies of the
- * elements in the initializer_list @a il. This is linear in
+ * elements in the initializer_list @a __il. This is linear in
* il.size().
*/
void
/**
* @brief Constructs object in %forward_list at the front of the
* list.
- * @param args Arguments.
+ * @param __args Arguments.
*
* This function will insert an object of type Tp constructed
* with Tp(std::forward<Args>(args)...) at the front of the list
/**
* @brief Add data to the front of the %forward_list.
- * @param val Data to be added.
+ * @param __val Data to be added.
*
* This is a typical stack operation. The function creates an
* element at the front of the %forward_list and assigns the given
/**
* @brief Constructs object in %forward_list after the specified
* iterator.
- * @param pos A const_iterator into the %forward_list.
- * @param args Arguments.
+ * @param __pos A const_iterator into the %forward_list.
+ * @param __args Arguments.
* @return An iterator that points to the inserted data.
*
* This function will insert an object of type T constructed
/**
* @brief Inserts given value into %forward_list after specified
* iterator.
- * @param pos An iterator into the %forward_list.
- * @param val Data to be inserted.
+ * @param __pos An iterator into the %forward_list.
+ * @param __val Data to be inserted.
* @return An iterator that points to the inserted data.
*
* This function will insert a copy of the given value after
/**
* @brief Inserts a number of copies of given data into the
* %forward_list.
- * @param pos An iterator into the %forward_list.
- * @param n Number of elements to be inserted.
- * @param val Data to be inserted.
+ * @param __pos An iterator into the %forward_list.
+ * @param __n Number of elements to be inserted.
+ * @param __val Data to be inserted.
* @return An iterator pointing to the last inserted copy of
* @a val or @a pos if @a n == 0.
*
/**
* @brief Inserts a range into the %forward_list.
- * @param position An iterator into the %forward_list.
- * @param first An input iterator.
- * @param last An input iterator.
+ * @param __pos An iterator into the %forward_list.
+ * @param __first An input iterator.
+ * @param __last An input iterator.
* @return An iterator pointing to the last inserted element or
- * @a pos if @a first == @a last.
+ * @a __pos if @a __first == @a __last.
*
- * This function will insert copies of the data in the range [@a
- * first,@a last) into the %forward_list after the location specified
- * by @a pos.
+ * This function will insert copies of the data in the range
+ * [@a __first,@a __last) into the %forward_list after the
+ * location specified by @a __pos.
*
* This operation is linear in the number of elements inserted and
* does not invalidate iterators and references.
/**
* @brief Inserts the contents of an initializer_list into
* %forward_list after the specified iterator.
- * @param pos An iterator into the %forward_list.
- * @param il An initializer_list of value_type.
+ * @param __pos An iterator into the %forward_list.
+ * @param __il An initializer_list of value_type.
* @return An iterator pointing to the last inserted element
- * or @a pos if @a il is empty.
+ * or @a __pos if @a __il is empty.
*
* This function will insert copies of the data in the
- * initializer_list @a il into the %forward_list before the location
- * specified by @a pos.
+ * initializer_list @a __il into the %forward_list before the location
+ * specified by @a __pos.
*
* This operation is linear in the number of elements inserted and
* does not invalidate iterators and references.
/**
* @brief Removes the element pointed to by the iterator following
* @c pos.
- * @param pos Iterator pointing before element to be erased.
+ * @param __pos Iterator pointing before element to be erased.
* @return An iterator pointing to the element following the one
* that was erased, or end() if no such element exists.
*
/**
* @brief Remove a range of elements.
- * @param pos Iterator pointing before the first element to be
- * erased.
- * @param last Iterator pointing to one past the last element to be
- * erased.
- * @return @last.
+ * @param __pos Iterator pointing before the first element to be
+ * erased.
+ * @param __last Iterator pointing to one past the last element to be
+ * erased.
+ * @return @ __last.
*
- * This function will erase the elements in the range @a
- * (pos,last) and shorten the %forward_list accordingly.
+ * This function will erase the elements in the range
+ * @a (__pos,__last) and shorten the %forward_list accordingly.
*
* This operation is linear time in the size of the range and only
* invalidates iterators/references to the element being removed.
/**
* @brief Swaps data with another %forward_list.
- * @param list A %forward_list of the same element and allocator
- * types.
+ * @param __list A %forward_list of the same element and allocator
+ * types.
*
* This exchanges the elements between two lists in constant
* time. Note that the global std::swap() function is
/**
* @brief Resizes the %forward_list to the specified number of
* elements.
- * @param sz Number of elements the %forward_list should contain.
+ * @param __sz Number of elements the %forward_list should contain.
*
* This function will %resize the %forward_list to the specified
* number of elements. If the number is smaller than the
/**
* @brief Resizes the %forward_list to the specified number of
* elements.
- * @param sz Number of elements the %forward_list should contain.
- * @param val Data with which new elements should be populated.
+ * @param __sz Number of elements the %forward_list should contain.
+ * @param __val Data with which new elements should be populated.
*
* This function will %resize the %forward_list to the specified
* number of elements. If the number is smaller than the
/**
* @brief Insert contents of another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
*
* The elements of @a list are inserted in constant time after
* the element referenced by @a pos. @a list becomes an empty
/**
* @brief Insert element from another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
- * @param i Iterator referencing the element before the element
- * to move.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
+ * @param __i Iterator referencing the element before the element
+ * to move.
*
* Removes the element in list @a list referenced by @a i and
* inserts it into the current list after @a pos.
/**
* @brief Insert range from another %forward_list.
- * @param pos Iterator referencing the element to insert after.
- * @param list Source list.
- * @param before Iterator referencing before the start of range
- * in list.
- * @param last Iterator referencing the end of range in list.
+ * @param __pos Iterator referencing the element to insert after.
+ * @param __list Source list.
+ * @param __before Iterator referencing before the start of range
+ * in list.
+ * @param __last Iterator referencing the end of range in list.
*
- * Removes elements in the range (before,last) and inserts them
- * after @a pos in constant time.
+ * Removes elements in the range (__before,__last) and inserts them
+ * after @a __pos in constant time.
*
- * Undefined if @a pos is in (before,last).
+ * Undefined if @a __pos is in (__before,__last).
*/
void
splice_after(const_iterator __pos, forward_list&& __list,
/**
* @brief Remove all elements equal to value.
- * @param val The value to remove.
+ * @param __val The value to remove.
*
- * Removes every element in the list equal to @a value.
+ * Removes every element in the list equal to @a __val.
* Remaining elements stay in list order. Note that this
* function only erases the elements, and that if the elements
* themselves are pointers, the pointed-to memory is not
/**
* @brief Remove all elements satisfying a predicate.
- * @param pred Unary predicate function or object.
+ * @param __pred Unary predicate function or object.
*
* Removes every element in the list for which the predicate
* returns true. Remaining elements stay in list order. Note
/**
* @brief Remove consecutive elements satisfying a predicate.
- * @param binary_pred Binary predicate function or object.
+ * @param __binary_pred Binary predicate function or object.
*
* For each consecutive set of elements [first,last) that
* satisfy predicate(first,i) where i is an iterator in
/**
* @brief Merge sorted lists.
- * @param list Sorted list to merge.
+ * @param __list Sorted list to merge.
*
* Assumes that both @a list and this list are sorted according to
- * operator<(). Merges elements of @a list into this list in
- * sorted order, leaving @a list empty when complete. Elements in
- * this list precede elements in @a list that are equal.
+ * operator<(). Merges elements of @a __list into this list in
+ * sorted order, leaving @a __list empty when complete. Elements in
+ * this list precede elements in @a __list that are equal.
*/
void
merge(forward_list&& __list)
/**
* @brief Merge sorted lists according to comparison function.
- * @param list Sorted list to merge.
- * @param comp Comparison function defining sort order.
+ * @param __list Sorted list to merge.
+ * @param __comp Comparison function defining sort order.
*
- * Assumes that both @a list and this list are sorted according to
- * comp. Merges elements of @a list into this list
- * in sorted order, leaving @a list empty when complete. Elements
- * in this list precede elements in @a list that are equivalent
+ * Assumes that both @a __list and this list are sorted according to
+ * comp. Merges elements of @a __list into this list
+ * in sorted order, leaving @a __list empty when complete. Elements
+ * in this list precede elements in @a __list that are equivalent
* according to comp().
*/
template<typename _Comp>
/**
* @brief Forward list equality comparison.
- * @param lx A %forward_list
- * @param ly A %forward_list of the same type as @a lx.
+ * @param __lx A %forward_list
+ * @param __ly A %forward_list of the same type as @a __lx.
* @return True iff the size and elements of the forward lists are equal.
*
* This is an equivalence relation. It is linear in the size of the
/**
* @brief Forward list ordering relation.
- * @param lx A %forward_list.
- * @param ly A %forward_list of the same type as @a lx.
- * @return True iff @a lx is lexicographically less than @a ly.
+ * @param __lx A %forward_list.
+ * @param __ly A %forward_list of the same type as @a __lx.
+ * @return True iff @a __lx is lexicographically less than @a __ly.
*
* This is a total ordering relation. It is linear in the size of the
* forward lists. The elements must be comparable with @c <.
// The template and inlines for the -*- C++ -*- gslice class.
-// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2004, 2005, 2006, 2009, 2010
-// Free Software Foundation, Inc.
+// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2004, 2005, 2006, 2009, 2010,
+// 2011 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
* Constructs a slice with as many dimensions as the length of the @a l
* and @a s arrays.
*
- * @param o Offset in array of first element.
- * @param l Array of dimension lengths.
- * @param s Array of dimension strides between array elements.
+ * @param __o Offset in array of first element.
+ * @param __l Array of dimension lengths.
+ * @param __s Array of dimension strides between array elements.
*/
- gslice(size_t, const valarray<size_t>&, const valarray<size_t>&);
+ gslice(size_t __o, const valarray<size_t>& __l,
+ const valarray<size_t>& __s);
// XXX: the IS says the copy-ctor and copy-assignment operators are
// synthesized by the compiler but they are just unsuitable
/**
* @brief The type of an event callback function.
- * @param event One of the members of the event enum.
- * @param ios_base Reference to the ios_base object.
- * @param int The integer provided when the callback was registered.
+ * @param __e One of the members of the event enum.
+ * @param __b Reference to the ios_base object.
+ * @param __i The integer provided when the callback was registered.
*
* Event callbacks are user defined functions that get called during
* several ios_base and basic_ios functions, specifically imbue(),
* copyfmt(), and ~ios().
*/
- typedef void (*event_callback) (event, ios_base&, int);
+ typedef void (*event_callback) (event __e, ios_base& __b, int __i);
/**
* @brief Add the callback __fn with parameter __index.
/**
* @brief Setting new format flags all at once.
- * @param fmtfl The new flags to set.
+ * @param __fmtfl The new flags to set.
* @return The previous format control flags.
*
- * This function overwrites all the format flags with @a fmtfl.
+ * This function overwrites all the format flags with @a __fmtfl.
*/
fmtflags
flags(fmtflags __fmtfl)
/**
* @brief Setting new format flags.
- * @param fmtfl Additional flags to set.
+ * @param __fmtfl Additional flags to set.
* @return The previous format control flags.
*
* This function sets additional flags in format control. Flags that
/**
* @brief Setting new format flags.
- * @param fmtfl Additional flags to set.
- * @param mask The flags mask for @a fmtfl.
+ * @param __fmtfl Additional flags to set.
+ * @param __mask The flags mask for @a fmtfl.
* @return The previous format control flags.
*
* This function clears @a mask in the format flags, then sets
/**
* @brief Clearing format flags.
- * @param mask The flags to unset.
+ * @param __mask The flags to unset.
*
- * This function clears @a mask in the format flags.
+ * This function clears @a __mask in the format flags.
*/
void
unsetf(fmtflags __mask)
/**
* @brief Changing flags.
- * @param prec The new precision value.
+ * @param __prec The new precision value.
* @return The previous value of precision().
*/
streamsize
/**
* @brief Changing flags.
- * @param wide The new width value.
+ * @param __wide The new width value.
* @return The previous value of width().
*/
streamsize
// [27.4.2.4] ios_base static members
/**
* @brief Interaction with the standard C I/O objects.
- * @param sync Whether to synchronize or not.
+ * @param __sync Whether to synchronize or not.
* @return True if the standard streams were previously synchronized.
*
* The synchronization referred to is @e only that between the standard
// [27.4.2.3] ios_base locale functions
/**
* @brief Setting a new locale.
- * @param loc The new locale.
+ * @param __loc The new locale.
* @return The previous locale.
*
* Sets the new locale for this stream, and then invokes each callback
*
* Constructs a copy of @a other.
*
- * @param other The locale to copy.
+ * @param __other The locale to copy.
*/
locale(const locale& __other) throw();
*
* Constructs a copy of the named C library locale.
*
- * @param s Name of the locale to construct.
- * @throw std::runtime_error if s is null or an undefined locale.
+ * @param __s Name of the locale to construct.
+ * @throw std::runtime_error if __s is null or an undefined locale.
*/
explicit
locale(const char* __s);
* cat are replaced with those from the locale named by @a s. If base is
* named, this locale instance will also be named.
*
- * @param base The locale to copy.
- * @param s Name of the locale to use facets from.
- * @param cat Set of categories defining the facets to use from s.
- * @throw std::runtime_error if s is null or an undefined locale.
+ * @param __base The locale to copy.
+ * @param __s Name of the locale to use facets from.
+ * @param __cat Set of categories defining the facets to use from __s.
+ * @throw std::runtime_error if __s is null or an undefined locale.
*/
locale(const locale& __base, const char* __s, category __cat);
* cat are replaced with those from the locale @a add. If @a base and @a
* add are named, this locale instance will also be named.
*
- * @param base The locale to copy.
- * @param add The locale to use facets from.
- * @param cat Set of categories defining the facets to use from add.
+ * @param __base The locale to copy.
+ * @param __add The locale to use facets from.
+ * @param __cat Set of categories defining the facets to use from add.
*/
locale(const locale& __base, const locale& __add, category __cat);
/**
* @brief Construct locale with another facet.
*
- * Constructs a copy of the locale @a other. The facet @f is added to
- * @other, replacing an existing facet of type Facet if there is one. If
- * @f is null, this locale is a copy of @a other.
+ * Constructs a copy of the locale @a __other. The facet @a __f
+ * is added to @a __other, replacing an existing facet of type
+ * Facet if there is one. If @a __f is null, this locale is a
+ * copy of @a __other.
*
- * @param other The locale to copy.
- * @param f The facet to add in.
+ * @param __other The locale to copy.
+ * @param __f The facet to add in.
*/
template<typename _Facet>
locale(const locale& __other, _Facet* __f);
*
* Set this locale to be a copy of @a other.
*
- * @param other The locale to copy.
+ * @param __other The locale to copy.
* @return A reference to this locale.
*/
const locale&
* existing facet of type Facet from the locale @a other into the new
* locale.
*
- * @param Facet The facet type to copy from other
- * @param other The locale to copy from.
+ * @tparam _Facet The facet type to copy from other
+ * @param __other The locale to copy from.
* @return Newly constructed locale.
- * @throw std::runtime_error if other has no facet of type Facet.
+ * @throw std::runtime_error if __other has no facet of type _Facet.
*/
template<typename _Facet>
locale
/**
* @brief Locale equality.
*
- * @param other The locale to compare against.
+ * @param __other The locale to compare against.
* @return True if other and this refer to the same locale instance, are
* copies, or have the same name. False otherwise.
*/
/**
* @brief Locale inequality.
*
- * @param other The locale to compare against.
- * @return ! (*this == other)
+ * @param __other The locale to compare against.
+ * @return ! (*this == __other)
*/
bool
operator!=(const locale& __other) const throw()
* std::sort(v.begin(), v.end(), loc);
* @endcode
*
- * @param s1 First string to compare.
- * @param s2 Second string to compare.
- * @return True if collate<Char> facet compares s1 < s2, else false.
+ * @param __s1 First string to compare.
+ * @param __s2 Second string to compare.
+ * @return True if collate<_Char> facet compares __s1 < __s2, else false.
*/
template<typename _Char, typename _Traits, typename _Alloc>
bool
* copy of the previous global locale. If the argument has a name, it
* will also call std::setlocale(LC_ALL, loc.name()).
*
- * @param locale The new locale to make global.
+ * @param __loc The new locale to make global.
* @return Copy of the old global locale.
*/
static locale
- global(const locale&);
+ global(const locale& __loc);
/**
* @brief Return reference to the C locale.
* facet is destroyed when the last referencing locale is destroyed.
* Otherwise the facet will never be destroyed.
*
- * @param refs The initial value for reference count.
+ * @param __refs The initial value for reference count.
*/
explicit
facet(size_t __refs = 0) throw() : _M_refcount(__refs ? 1 : 0)
* provided as the template parameter. Facets derived from the facet
* parameter will also return true.
*
- * @param Facet The facet type to test the presence of.
- * @param locale The locale to test.
- * @return true if locale contains a facet of type Facet, else false.
+ * @tparam _Facet The facet type to test the presence of.
+ * @param __loc The locale to test.
+ * @return true if __loc contains a facet of type _Facet, else false.
*/
template<typename _Facet>
bool
* there is a suitable facet to return. It throws std::bad_cast if the
* locale doesn't contain a facet of type Facet.
*
- * @param Facet The facet type to access.
- * @param locale The locale to use.
+ * @tparam _Facet The facet type to access.
+ * @param __loc The locale to use.
* @return Reference to facet of type Facet.
- * @throw std::bad_cast if locale doesn't contain a facet of type Facet.
+ * @throw std::bad_cast if __loc doesn't contain a facet of type _Facet.
*/
template<typename _Facet>
const _Facet&
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
collate(size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param refs Passed to the base facet class.
+ * @param __cloc The C locale.
+ * @param __refs Passed to the base facet class.
*/
explicit
collate(__c_locale __cloc, size_t __refs = 0)
* This function compares two strings and returns the result by calling
* collate::do_compare().
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
+ * @param __lo1 Start of string 1.
+ * @param __hi1 End of string 1.
+ * @param __lo2 Start of string 2.
+ * @param __hi2 End of string 2.
* @return 1 if string1 > string2, -1 if string1 < string2, else 0.
*/
int
* locales, it may replace two chars with one, change a char for
* another, etc. It does so by returning collate::do_transform().
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Transformed string_type.
*/
string_type
* This function computes and returns a hash on the input string. It
* does so by returning collate::do_hash().
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Hash value.
*/
long
* This function is a hook for derived classes to change the value
* returned. @see compare().
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
+ * @param __lo1 Start of string 1.
+ * @param __hi1 End of string 1.
+ * @param __lo2 Start of string 2.
+ * @param __hi2 End of string 2.
* @return 1 if string1 > string2, -1 if string1 < string2, else 0.
*/
virtual int
* This function is a hook for derived classes to change the value
* returned.
*
- * @param lo1 Start of string 1.
- * @param hi1 End of string 1.
- * @param lo2 Start of string 2.
- * @param hi2 End of string 2.
- * @return 1 if string1 > string2, -1 if string1 < string2, else 0.
+ * @param __lo Start.
+ * @param __hi End.
+ * @return transformed string.
*/
virtual string_type
do_transform(const _CharT* __lo, const _CharT* __hi) const;
* This function computes and returns a hash on the input string. This
* function is a hook for derived classes to change the value returned.
*
- * @param lo Start of string.
- * @param hi End of string.
+ * @param __lo Start of string.
+ * @param __hi End of string.
* @return Hash value.
*/
virtual long
/**
* @brief Test char_type classification.
*
- * This function finds a mask M for @a c and compares it to mask @a m.
- * It does so by returning the value of ctype<char_type>::do_is().
+ * This function finds a mask M for @a __c and compares it to
+ * mask @a __m. It does so by returning the value of
+ * ctype<char_type>::do_is().
*
- * @param c The char_type to compare the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The char_type to compare the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
bool
is(mask __m, char_type __c) const
* as the char array. It does so by returning the value of
* ctype<char_type>::do_is().
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
const char_type*
is(const char_type *__lo, const char_type *__hi, mask *__vec) const
* [lo,hi) for which is(m,c) is true. It does so by returning
* ctype<char_type>::do_scan_is().
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to matching char_type if found, else @a __hi.
*/
const char_type*
scan_is(mask __m, const char_type* __lo, const char_type* __hi) const
* [lo,hi) for which is(m,c) is false. It does so by returning
* ctype<char_type>::do_scan_not().
*
- * @param m The mask to compare against.
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return Pointer to non-matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to non-matching char if found, else @a __hi.
*/
const char_type*
scan_not(mask __m, const char_type* __lo, const char_type* __hi) const
* If not possible (for example, '2'), returns the argument. It does
* so by returning ctype<char_type>::do_toupper().
*
- * @param c The char_type to convert.
- * @return The uppercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The uppercase char_type if convertible, else @a __c.
*/
char_type
toupper(char_type __c) const
* uppercase if possible. Other elements remain untouched. It does so
* by returning ctype<char_type>:: do_toupper(lo, hi).
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
toupper(char_type *__lo, const char_type* __hi) const
* not possible (for example, '2'), returns the argument. It does so
* by returning ctype<char_type>::do_tolower(c).
*
- * @param c The char_type to convert.
- * @return The lowercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The lowercase char_type if convertible, else @a __c.
*/
char_type
tolower(char_type __c) const
/**
* @brief Convert array to lowercase.
*
- * This function converts each char_type in the range [lo,hi) to
+ * This function converts each char_type in the range [__lo,__hi) to
* lowercase if possible. Other elements remain untouched. It does so
- * by returning ctype<char_type>:: do_tolower(lo, hi).
+ * by returning ctype<char_type>:: do_tolower(__lo, __hi).
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
tolower(char_type* __lo, const char_type* __hi) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted char_type.
*/
char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char*
widen(const char* __lo, const char* __hi, char_type* __to) const
* This function converts the char_type to char using the simplest
* reasonable transformation. If the conversion fails, dfault is
* returned instead. It does so by returning
- * ctype<char_type>::do_narrow(c).
+ * ctype<char_type>::do_narrow(__c).
*
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char_type to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char_type to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
char
* simplest reasonable transformation and writes the results to the
* destination array. For any char_type in the input that cannot be
* converted, @a dfault is used instead. It does so by returning
- * ctype<char_type>::do_narrow(lo, hi, dfault, to).
+ * ctype<char_type>::do_narrow(__lo, __hi, __dfault, __to).
*
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char_type*
narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char *__to) const
+ char __dfault, char* __to) const
{ return this->do_narrow(__lo, __hi, __dfault, __to); }
protected:
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param c The char_type to find the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The char_type to find the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
virtual bool
do_is(mask __m, char_type __c) const = 0;
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
virtual const char_type*
do_is(const char_type* __lo, const char_type* __hi,
* @brief Find char_type matching mask
*
* This function searches for and returns the first char_type c in
- * [lo,hi) for which is(m,c) is true.
+ * [__lo,__hi) for which is(__m,c) is true.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching char_type if found, else @a __hi.
*/
virtual const char_type*
do_scan_is(mask __m, const char_type* __lo,
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching char_type if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching char_type if found, else @a __hi.
*/
virtual const char_type*
do_scan_not(mask __m, const char_type* __lo,
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The char_type to convert.
- * @return The uppercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The uppercase char_type if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const = 0;
+ do_toupper(char_type __c) const = 0;
/**
* @brief Convert array to uppercase.
*
- * This virtual function converts each char_type in the range [lo,hi)
+ * This virtual function converts each char_type in the range [__lo,__hi)
* to uppercase if possible. Other elements remain untouched.
*
* do_toupper() is a hook for a derived facet to change the behavior of
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const = 0;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The char_type to convert.
- * @return The lowercase char_type if convertible, else @a c.
+ * @param __c The char_type to convert.
+ * @return The lowercase char_type if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const = 0;
+ do_tolower(char_type __c) const = 0;
/**
* @brief Convert array to lowercase.
*
- * This virtual function converts each char_type in the range [lo,hi)
+ * This virtual function converts each char_type in the range [__lo,__hi)
* to lowercase if possible. Other elements remain untouched.
*
* do_tolower() is a hook for a derived facet to change the behavior of
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const = 0;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted char_type
*/
virtual char_type
- do_widen(char) const = 0;
+ do_widen(char __c) const = 0;
/**
* @brief Widen char array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi,
- char_type* __dest) const = 0;
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const = 0;
/**
* @brief Narrow char_type to char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char_type to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char_type to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type, char __dfault) const = 0;
+ do_narrow(char_type __c, char __dfault) const = 0;
/**
* @brief Narrow char_type array to char
*
- * This virtual function converts each char_type in the range [lo,hi) to
- * char using the simplest reasonable transformation and writes the
- * results to the destination array. For any element in the input that
- * cannot be converted, @a dfault is used instead.
+ * This virtual function converts each char_type in the range
+ * [__lo,__hi) to char using the simplest reasonable
+ * transformation and writes the results to the destination
+ * array. For any element in the input that cannot be
+ * converted, @a __dfault is used instead.
*
* do_narrow() is a hook for a derived facet to change the behavior of
* narrowing. do_narrow() must always return the same result for the
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const = 0;
+ char __dfault, char* __to) const = 0;
};
/**
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const;
+ char __dfault, char* __to) const;
};
template<typename _CharT>
*
* This is the constructor provided by the standard.
*
- * @param table If non-zero, table is used as the per-char mask.
+ * @param __table If non-zero, table is used as the per-char mask.
* Else classic_table() is used.
- * @param del If true, passes ownership of table to this facet.
- * @param refs Passed to the base facet class.
+ * @param __del If true, passes ownership of table to this facet.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(const mask* __table = 0, bool __del = false, size_t __refs = 0);
*
* This constructor is used to construct the initial C locale facet.
*
- * @param cloc Handle to C locale data.
- * @param table If non-zero, table is used as the per-char mask.
- * @param del If true, passes ownership of table to this facet.
- * @param refs Passed to the base facet class.
+ * @param __cloc Handle to C locale data.
+ * @param __table If non-zero, table is used as the per-char mask.
+ * @param __del If true, passes ownership of table to this facet.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(__c_locale __cloc, const mask* __table = 0, bool __del = false,
/**
* @brief Test char classification.
*
- * This function compares the mask table[c] to @a m.
+ * This function compares the mask table[c] to @a __m.
*
- * @param c The char to compare the mask of.
- * @param m The mask to compare against.
- * @return True if m & table[c] is true, false otherwise.
+ * @param __c The char to compare the mask of.
+ * @param __m The mask to compare against.
+ * @return True if __m & table[__c] is true, false otherwise.
*/
inline bool
is(mask __m, char __c) const;
* successively writes it to vec. vec must have as many elements as
* the char array.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
inline const char*
is(const char* __lo, const char* __hi, mask* __vec) const;
* This function searches for and returns the first char in [lo,hi) for
* which is(m,char) is true.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching char if found, else @a __hi.
*/
inline const char*
scan_is(mask __m, const char* __lo, const char* __hi) const;
* @brief Find char not matching a mask
*
* This function searches for and returns a pointer to the first char
- * in [lo,hi) for which is(m,char) is false.
+ * in [__lo,__hi) for which is(m,char) is false.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching char if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching char if found, else @a __hi.
*/
inline const char*
scan_not(mask __m, const char* __lo, const char* __hi) const;
* toupper() acts as if it returns ctype<char>::do_toupper(c).
* do_toupper() must always return the same result for the same input.
*
- * @param c The char to convert.
- * @return The uppercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The uppercase char if convertible, else @a __c.
*/
char_type
toupper(char_type __c) const
/**
* @brief Convert array to uppercase.
*
- * This function converts each char in the range [lo,hi) to uppercase
+ * This function converts each char in the range [__lo,__hi) to uppercase
* if possible. Other chars remain untouched.
*
- * toupper() acts as if it returns ctype<char>:: do_toupper(lo, hi).
+ * toupper() acts as if it returns ctype<char>:: do_toupper(__lo, __hi).
* do_toupper() must always return the same result for the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
toupper(char_type *__lo, const char_type* __hi) const
* This function converts the char argument to lowercase if possible.
* If not possible (for example, '2'), returns the argument.
*
- * tolower() acts as if it returns ctype<char>::do_tolower(c).
+ * tolower() acts as if it returns ctype<char>::do_tolower(__c).
* do_tolower() must always return the same result for the same input.
*
- * @param c The char to convert.
- * @return The lowercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The lowercase char if convertible, else @a __c.
*/
char_type
tolower(char_type __c) const
* This function converts each char in the range [lo,hi) to lowercase
* if possible. Other chars remain untouched.
*
- * tolower() acts as if it returns ctype<char>:: do_tolower(lo, hi).
+ * tolower() acts as if it returns ctype<char>:: do_tolower(__lo, __hi).
* do_tolower() must always return the same result for the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
const char_type*
tolower(char_type* __lo, const char_type* __hi) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted character.
*/
char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char*
widen(const char* __lo, const char* __hi, char_type* __to) const
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted character.
*/
char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
const char_type*
narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char *__to) const
+ char __dfault, char* __to) const
{
if (__builtin_expect(_M_narrow_ok == 1, true))
{
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The char to convert.
- * @return The uppercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The uppercase char if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const;
+ do_toupper(char_type __c) const;
/**
* @brief Convert array to uppercase.
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The char to convert.
- * @return The lowercase char if convertible, else @a c.
+ * @param __c The char to convert.
+ * @return The lowercase char if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const;
+ do_tolower(char_type __c) const;
/**
* @brief Convert array to lowercase.
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to first char in range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to first char in range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted character.
*/
virtual char_type
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi, char_type* __dest) const
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const
{
- __builtin_memcpy(__dest, __lo, __hi - __lo);
+ __builtin_memcpy(__to, __lo, __hi - __lo);
return __hi;
}
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The char to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type __c, char) const
+ do_narrow(char_type __c, char __dfault) const
{ return __c; }
/**
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char, char* __dest) const
+ char __dfault, char* __to) const
{
- __builtin_memcpy(__dest, __lo, __hi - __lo);
+ __builtin_memcpy(__to, __lo, __hi - __lo);
return __hi;
}
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(size_t __refs = 0);
*
* This constructor is used to construct the initial C locale facet.
*
- * @param cloc Handle to C locale data.
- * @param refs Passed to the base facet class.
+ * @param __cloc Handle to C locale data.
+ * @param __refs Passed to the base facet class.
*/
explicit
ctype(__c_locale __cloc, size_t __refs = 0);
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param c The wchar_t to find the mask of.
- * @param m The mask to compare against.
- * @return (M & m) != 0.
+ * @param __c The wchar_t to find the mask of.
+ * @param __m The mask to compare against.
+ * @return (M & __m) != 0.
*/
virtual bool
do_is(mask __m, char_type __c) const;
* classifying. do_is() must always return the same result for the
* same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param vec Pointer to an array of mask storage.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __vec Pointer to an array of mask storage.
+ * @return @a __hi.
*/
virtual const char_type*
do_is(const char_type* __lo, const char_type* __hi, mask* __vec) const;
* @brief Find wchar_t matching mask
*
* This function searches for and returns the first wchar_t c in
- * [lo,hi) for which is(m,c) is true.
+ * [__lo,__hi) for which is(__m,c) is true.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a matching wchar_t if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a matching wchar_t if found, else @a __hi.
*/
virtual const char_type*
do_scan_is(mask __m, const char_type* __lo, const char_type* __hi) const;
* @brief Find wchar_t not matching mask
*
* This function searches for and returns a pointer to the first
- * wchar_t c of [lo,hi) for which is(m,c) is false.
+ * wchar_t c of [__lo,__hi) for which is(__m,c) is false.
*
* do_scan_is() is a hook for a derived facet to change the behavior of
* match searching. do_is() must always return the same result for the
* same input.
*
- * @param m The mask to compare against.
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return Pointer to a non-matching wchar_t if found, else @a hi.
+ * @param __m The mask to compare against.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return Pointer to a non-matching wchar_t if found, else @a __hi.
*/
virtual const char_type*
do_scan_not(mask __m, const char_type* __lo,
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param c The wchar_t to convert.
- * @return The uppercase wchar_t if convertible, else @a c.
+ * @param __c The wchar_t to convert.
+ * @return The uppercase wchar_t if convertible, else @a __c.
*/
virtual char_type
- do_toupper(char_type) const;
+ do_toupper(char_type __c) const;
/**
* @brief Convert array to uppercase.
* uppercasing. do_toupper() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_toupper(char_type* __lo, const char_type* __hi) const;
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param c The wchar_t to convert.
- * @return The lowercase wchar_t if convertible, else @a c.
+ * @param __c The wchar_t to convert.
+ * @return The lowercase wchar_t if convertible, else @a __c.
*/
virtual char_type
- do_tolower(char_type) const;
+ do_tolower(char_type __c) const;
/**
* @brief Convert array to lowercase.
* lowercasing. do_tolower() must always return the same result for
* the same input.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @return @a __hi.
*/
virtual const char_type*
do_tolower(char_type* __lo, const char_type* __hi) const;
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The char to convert.
+ * @param __c The char to convert.
* @return The converted wchar_t.
*/
virtual char_type
- do_widen(char) const;
+ do_widen(char __c) const;
/**
* @brief Widen char array to wchar_t array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start range.
- * @param hi Pointer to end of range.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start range.
+ * @param __hi Pointer to end of range.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char*
- do_widen(const char* __lo, const char* __hi, char_type* __dest) const;
+ do_widen(const char* __lo, const char* __hi, char_type* __to) const;
/**
* @brief Narrow wchar_t to char
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param c The wchar_t to convert.
- * @param dfault Char to return if conversion fails.
+ * @param __c The wchar_t to convert.
+ * @param __dfault Char to return if conversion fails.
* @return The converted char.
*/
virtual char
- do_narrow(char_type, char __dfault) const;
+ do_narrow(char_type __c, char __dfault) const;
/**
* @brief Narrow wchar_t array to char array
* Note: this is not what you want for codepage conversions. See
* codecvt for that.
*
- * @param lo Pointer to start of range.
- * @param hi Pointer to end of range.
- * @param dfault Char to use if conversion fails.
- * @param to Pointer to the destination array.
- * @return @a hi.
+ * @param __lo Pointer to start of range.
+ * @param __hi Pointer to end of range.
+ * @param __dfault Char to use if conversion fails.
+ * @param __to Pointer to the destination array.
+ * @return @a __hi.
*/
virtual const char_type*
do_narrow(const char_type* __lo, const char_type* __hi,
- char __dfault, char* __dest) const;
+ char __dfault, char* __to) const;
// For use at construction time only.
void
/**
* @brief Numpunct constructor.
*
- * @param refs Refcount to pass to the base class.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(size_t __refs = 0)
* This is a constructor for use by the library itself to set up the
* predefined locale facets.
*
- * @param cache __numpunct_cache object.
- * @param refs Refcount to pass to the base class.
+ * @param __cache __numpunct_cache object.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(__cache_type* __cache, size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param refs Refcount to pass to the base class.
+ * @param __cloc The C locale.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
numpunct(__c_locale __cloc, size_t __refs = 0)
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
num_get(size_t __refs = 0) : facet(__refs) { }
* except if the value is 1, sets @a v to true, if the value is 0, sets
* @a v to false, and otherwise set err to ios_base::failbit.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
* Sets err to ios_base::eofbit if the stream is emptied.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __in Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
iter_type
* hook for derived classes to change the value returned. @see get()
* for more details.
*
- * @param in Start of input stream.
- * @param end End of input stream.
- * @param io Source of locale and flags.
- * @param err Error flags to set.
- * @param v Value to format and insert.
+ * @param __beg Start of input stream.
+ * @param __end End of input stream.
+ * @param __io Source of locale and flags.
+ * @param __err Error flags to set.
+ * @param __v Value to format and insert.
* @return Iterator after reading.
*/
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, bool&) const;
-
- virtual iter_type
do_get(iter_type __beg, iter_type __end, ios_base& __io,
ios_base::iostate& __err, long& __v) const
{ return _M_extract_int(__beg, __end, __io, __err, __v); }
#endif
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
- float&) const;
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, bool&) const;
+
+ virtual iter_type
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, float&) const;
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
double&) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- __do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ __do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
double&) const;
#else
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
long double&) const;
#endif
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
- void*&) const;
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, void*&) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
+ do_get(iter_type, iter_type, ios_base&, ios_base::iostate&,
long double&) const;
#endif
//@}
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
num_put(size_t __refs = 0) : facet(__refs) { }
* If ios_base::boolalpha is set, writes ctype<CharT>::truename() or
* ctype<CharT>::falsename(). Otherwise formats @a v as an int.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, bool __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, bool __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
//@{
/**
* immediately after either a '+' or '-' or after '0x' or '0X'.
* Otherwise, padding occurs at the beginning.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, long __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
unsigned long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
#ifdef _GLIBCXX_USE_LONG_LONG
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, long long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, long long __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
unsigned long long __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
#endif
//@}
* immediately after either a '+' or '-' or after '0x' or '0X'.
* Otherwise, padding occurs at the beginning.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill, double __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ put(iter_type __s, ios_base& __io, char_type __fill, double __v) const
+ { return this->do_put(__s, __io, __fill, __v); }
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
long double __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
//@}
/**
* This function formats @a v as an unsigned long with ios_base::hex
* and ios_base::showbase set.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
iter_type
- put(iter_type __s, ios_base& __f, char_type __fill,
+ put(iter_type __s, ios_base& __io, char_type __fill,
const void* __v) const
- { return this->do_put(__s, __f, __fill, __v); }
+ { return this->do_put(__s, __io, __fill, __v); }
protected:
template<typename _ValueT>
* inserting them into a stream. This function is a hook for derived
* classes to change the value returned.
*
- * @param s Stream to write to.
- * @param io Source of locale and flags.
- * @param fill Char_type to use for filling.
- * @param v Value to format and insert.
+ * @param __s Stream to write to.
+ * @param __io Source of locale and flags.
+ * @param __fill Char_type to use for filling.
+ * @param __v Value to format and insert.
* @return Iterator after writing.
*/
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, bool __v) const;
+ do_put(iter_type __s, ios_base& __io, char_type __fill, bool __v) const;
virtual iter_type
do_put(iter_type __s, ios_base& __io, char_type __fill, long __v) const
#endif
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, double __v) const;
+ do_put(iter_type, ios_base&, char_type, double) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- __do_put(iter_type, ios_base&, char_type __fill, double __v) const;
+ __do_put(iter_type, ios_base&, char_type, double) const;
#else
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
+ do_put(iter_type, ios_base&, char_type, long double) const;
#endif
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, const void* __v) const;
+ do_put(iter_type, ios_base&, char_type, const void*) const;
// XXX GLIBCXX_ABI Deprecated
#if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
virtual iter_type
- do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
+ do_put(iter_type, ios_base&, char_type, long double) const;
#endif
//@}
};
{ return use_facet<ctype<_CharT> >(__loc).tolower(__c); }
_GLIBCXX_END_NAMESPACE_VERSION
-} // namespace
+} // namespace std
# include <bits/locale_facets.tcc>
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
* @param refs Passed to the base facet class.
*/
explicit
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
time_get(size_t __refs = 0)
* the end, err |= ios_base::failbit. If parsing reads all the
* characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond time string.
*/
iter_type
* the end, err |= ios_base::failbit. If parsing reads all the
* characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond date string.
*/
iter_type
* If an error occurs before the end, err |= ios_base::failbit. If
* parsing reads all the characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond weekday name.
*/
iter_type
* parsing reads all the characters, err |=
* ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond month name.
*/
iter_type
* If an error occurs before the end, err |= ios_base::failbit. If
* parsing reads all the characters, err |= ios_base::eofbit.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond year.
*/
iter_type
* derived classes to change the value returned. @see get_time() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond time string.
*/
virtual iter_type
* derived classes to change the value returned. @see get_date() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond date string.
*/
virtual iter_type
* classes to change the value returned. @see get_weekday() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond weekday name.
*/
virtual iter_type
* classes to change the value returned. @see get_monthname() for
* details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond month name.
*/
virtual iter_type
* hook for derived classes to change the value returned. @see
* get_year() for details.
*
- * @param beg Start of string to parse.
- * @param end End of string to parse.
- * @param io Source of the locale.
- * @param err Error flags to set.
- * @param tm Pointer to struct tm to fill in.
+ * @param __beg Start of string to parse.
+ * @param __end End of string to parse.
+ * @param __io Source of the locale.
+ * @param __err Error flags to set.
+ * @param __tm Pointer to struct tm to fill in.
* @return Iterator to first char beyond year.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
time_put(size_t __refs = 0)
* provided format string. The format string is interpreted as by
* strftime().
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param beg Start of format string.
- * @param end End of format string.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __beg Start of format string.
+ * @param __end End of format string.
* @return Iterator after writing.
*/
iter_type
* are interpreted as by strftime(). It does so by returning
* time_put::do_put().
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param format Format char.
- * @param mod Optional modifier char.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __format Format char.
+ * @param __mod Optional modifier char.
* @return Iterator after writing.
*/
iter_type
* for derived classes to change the value returned. @see put() for
* more details.
*
- * @param s The stream to write to.
- * @param io Source of locale.
- * @param fill char_type to use for padding.
- * @param tm Struct tm with date and time info to format.
- * @param format Format char.
- * @param mod Optional modifier char.
+ * @param __s The stream to write to.
+ * @param __io Source of locale.
+ * @param __fill char_type to use for padding.
+ * @param __tm Struct tm with date and time info to format.
+ * @param __format Format char.
+ * @param __mod Optional modifier char.
* @return Iterator after writing.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(size_t __refs = 0)
*
* This is an internal constructor.
*
- * @param cache Cache for optimization.
- * @param refs Passed to the base facet class.
+ * @param __cache Cache for optimization.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(__cache_type* __cache, size_t __refs = 0)
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
- * @param refs Passed to the base facet class.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
+ * @param __refs Passed to the base facet class.
*/
explicit
moneypunct(__c_locale __cloc, const char* __s, size_t __refs = 0)
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
money_get(size_t __refs = 0) : facet(__refs) { }
/**
* @brief Read and parse a monetary value.
*
- * This function reads characters from @a s, interprets them as a
+ * This function reads characters from @a __s, interprets them as a
* monetary value according to moneypunct and ctype facets retrieved
* from io.getloc(), and returns the result in @a units as an integral
* value moneypunct::frac_digits() * the actual amount. For example,
*
* This function works by returning the result of do_get().
*
- * @param s Start of characters to parse.
- * @param end End of characters to parse.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param err Error field to set if parsing fails.
- * @param units Place to store result of parsing.
+ * @param __s Start of characters to parse.
+ * @param __end End of characters to parse.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __err Error field to set if parsing fails.
+ * @param __units Place to store result of parsing.
* @return Iterator referencing first character beyond valid money
* amount.
*/
/**
* @brief Read and parse a monetary value.
*
- * This function reads characters from @a s, interprets them as
+ * This function reads characters from @a __s, interprets them as
* a monetary value according to moneypunct and ctype facets
* retrieved from io.getloc(), and returns the result in @a
* digits. For example, the string $10.01 in a US locale would
*
* This function works by returning the result of do_get().
*
- * @param s Start of characters to parse.
- * @param end End of characters to parse.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param err Error field to set if parsing fails.
- * @param digits Place to store result of parsing.
+ * @param __s Start of characters to parse.
+ * @param __end End of characters to parse.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __err Error field to set if parsing fails.
+ * @param __digits Place to store result of parsing.
* @return Iterator referencing first character beyond valid money
* amount.
*/
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
money_put(size_t __refs = 0) : facet(__refs) { }
*
* This function formats @a units as a monetary value according to
* moneypunct and ctype facets retrieved from io.getloc(), and writes
- * the resulting characters to @a s. For example, the value 1001 in a
- * US locale would write <code>$10.01</code> to @a s.
+ * the resulting characters to @a __s. For example, the value 1001 in a
+ * US locale would write <code>$10.01</code> to @a __s.
*
* This function works by returning the result of do_put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __units Place to store result of parsing.
* @return Iterator after writing.
*/
iter_type
*
* This function formats @a digits as a monetary value
* according to moneypunct and ctype facets retrieved from
- * io.getloc(), and writes the resulting characters to @a s.
+ * io.getloc(), and writes the resulting characters to @a __s.
* For example, the string <code>1001</code> in a US locale
- * would write <code>$10.01</code> to @a s.
+ * would write <code>$10.01</code> to @a __s.
*
* This function works by returning the result of do_put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __digits Place to store result of parsing.
* @return Iterator after writing.
*/
iter_type
*
* This function formats @a units as a monetary value according to
* moneypunct and ctype facets retrieved from io.getloc(), and writes
- * the resulting characters to @a s. For example, the value 1001 in a
- * US locale would write <code>$10.01</code> to @a s.
+ * the resulting characters to @a __s. For example, the value 1001 in a
+ * US locale would write <code>$10.01</code> to @a __s.
*
* This function is a hook for derived classes to change the value
* returned. @see put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __units Place to store result of parsing.
* @return Iterator after writing.
*/
// XXX GLIBCXX_ABI Deprecated
*
* This function formats @a digits as a monetary value
* according to moneypunct and ctype facets retrieved from
- * io.getloc(), and writes the resulting characters to @a s.
+ * io.getloc(), and writes the resulting characters to @a __s.
* For example, the string <code>1001</code> in a US locale
- * would write <code>$10.01</code> to @a s.
+ * would write <code>$10.01</code> to @a __s.
*
* This function is a hook for derived classes to change the value
* returned. @see put().
*
- * @param s The stream to write to.
- * @param intl Parameter to use_facet<moneypunct<CharT,intl> >.
- * @param io Source of facets and io state.
- * @param fill char_type to use for padding.
- * @param units Place to store result of parsing.
+ * @param __s The stream to write to.
+ * @param __intl Parameter to use_facet<moneypunct<CharT,intl> >.
+ * @param __io Source of facets and io state.
+ * @param __fill char_type to use for padding.
+ * @param __digits Place to store result of parsing.
* @return Iterator after writing.
*/
virtual iter_type
*
* This is the constructor provided by the standard.
*
- * @param refs Passed to the base facet class.
+ * @param __refs Passed to the base facet class.
*/
explicit
messages(size_t __refs = 0);
* This is a constructor for use by the library itself to set up new
* locales.
*
- * @param cloc The C locale.
- * @param s The name of a locale.
- * @param refs Refcount to pass to the base class.
+ * @param __cloc The C locale.
+ * @param __s The name of a locale.
+ * @param __refs Refcount to pass to the base class.
*/
explicit
messages(__c_locale __cloc, const char* __s, size_t __refs = 0);
* @brief Open a message catalog.
*
* This function opens and returns a handle to a message catalog by
- * returning do_open(s, loc).
+ * returning do_open(__s, __loc).
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
* @return Handle to the catalog or value < 0 if open fails.
*/
catalog
* message catalog root directory for gnu gettext and is ignored
* otherwise.
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
- * @param dir Message catalog root directory.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
+ * @param __dir Message catalog root directory.
* @return Handle to the catalog or value < 0 if open fails.
*/
catalog
* This function retrieves and returns a message from a catalog by
* returning do_get(c, set, msgid, s).
*
- * For gnu, @a set and @a msgid are ignored. Returns gettext(s).
+ * For gnu, @a __set and @a msgid are ignored. Returns gettext(s).
* For default, returns s. For ieee, returns catgets(c,set,msgid,s).
*
- * @param c The catalog to access.
- * @param set Implementation-defined.
- * @param msgid Implementation-defined.
- * @param s Default return value if retrieval fails.
- * @return Retrieved message or @a s if get fails.
+ * @param __c The catalog to access.
+ * @param __set Implementation-defined.
+ * @param __msgid Implementation-defined.
+ * @param __s Default return value if retrieval fails.
+ * @return Retrieved message or @a __s if get fails.
*/
string_type
get(catalog __c, int __set, int __msgid, const string_type& __s) const
*
* Closes catalog @a c by calling do_close(c).
*
- * @param c The catalog to close.
+ * @param __c The catalog to close.
*/
void
close(catalog __c) const
* implementation-defined manner. This function is a hook for derived
* classes to change the value returned.
*
- * @param s The catalog to open.
- * @param loc Locale to use for character set conversions.
+ * @param __s The catalog to open.
+ * @param __loc Locale to use for character set conversions.
* @return Handle to the opened catalog, value < 0 if open failed.
*/
virtual catalog
* implementation-defined manner. This function is a hook for derived
* classes to change the value returned.
*
- * For gnu, @a set and @a msgid are ignored. Returns gettext(s).
+ * For gnu, @a __set and @a __msgid are ignored. Returns gettext(s).
* For default, returns s. For ieee, returns catgets(c,set,msgid,s).
*
- * @param c The catalog to access.
- * @param set Implementation-defined.
- * @param msgid Implementation-defined.
- * @param s Default return value if retrieval fails.
- * @return Retrieved message or @a s if get fails.
+ * @param __c The catalog to access.
+ * @param __set Implementation-defined.
+ * @param __msgid Implementation-defined.
+ * @param __s Default return value if retrieval fails.
+ * @return Retrieved message or @a __s if get fails.
*/
virtual string_type
do_get(catalog, int, int, const string_type& __dfault) const;
/*
* @brief Close a message catalog.
*
- * @param c The catalog to close.
+ * @param __c The catalog to close.
*/
virtual void
do_close(catalog) const;
string_type
_M_convert_from_char(char*) const
{
-#if 0
- // Length of message string without terminating null.
- size_t __len = char_traits<char>::length(__msg) - 1;
-
- // "everybody can easily convert the string using
- // mbsrtowcs/wcsrtombs or with iconv()"
-
- // Convert char* to _CharT in locale used to open catalog.
- // XXX need additional template parameter on messages class for this..
- // typedef typename codecvt<char, _CharT, _StateT> __codecvt_type;
- typedef typename codecvt<char, _CharT, mbstate_t> __codecvt_type;
-
- __codecvt_type::state_type __state;
- // XXX may need to initialize state.
- //initialize_state(__state._M_init());
-
- char* __from_next;
- // XXX what size for this string?
- _CharT* __to = static_cast<_CharT*>(__builtin_alloca(__len + 1));
- const __codecvt_type& __cvt = use_facet<__codecvt_type>(_M_locale_conv);
- __cvt.out(__state, __msg, __msg + __len, __from_next,
- __to, __to + __len + 1, __to_next);
- return string_type(__to);
-#endif
-#if 0
- typedef ctype<_CharT> __ctype_type;
- // const __ctype_type& __cvt = use_facet<__ctype_type>(_M_locale_msg);
- const __ctype_type& __cvt = use_facet<__ctype_type>(locale());
- // XXX Again, proper length of converted string an issue here.
- // For now, assume the converted length is not larger.
- _CharT* __dest = static_cast<_CharT*>(__builtin_alloca(__len + 1));
- __cvt.widen(__msg, __msg + __len, __dest);
- return basic_string<_CharT>(__dest);
-#endif
+ // XXX
return string_type();
}
};
/**
* @brief Obtain a pointer to an object
- * @param r A reference to an object of type @c element_type
- * @return @c addressof(r)
+ * @param __r A reference to an object of type @c element_type
+ * @return @c addressof(__r)
*/
static pointer
pointer_to(typename __ptrtr_not_void<element_type>::__type& __r) noexcept
template<typename _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
_UIntType1 __m1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::linear_congruential_engine<_UIntType1,
- __a1, __c1, __m1>&);
+ __a1, __c1, __m1>& __lcr);
/**
* @brief Sets the state of the engine by reading its textual
template<typename _UIntType1, _UIntType1 __a1, _UIntType1 __c1,
_UIntType1 __m1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::linear_congruential_engine<_UIntType1, __a1,
- __c1, __m1>&);
+ __c1, __m1>& __lcr);
private:
_UIntType _M_x;
* This algorithm was originally invented by Makoto Matsumoto and
* Takuji Nishimura.
*
- * @var word_size The number of bits in each element of the state vector.
- * @var state_size The degree of recursion.
- * @var shift_size The period parameter.
- * @var mask_bits The separation point bit index.
- * @var parameter_a The last row of the twist matrix.
- * @var output_u The first right-shift tempering matrix parameter.
- * @var output_s The first left-shift tempering matrix parameter.
- * @var output_b The first left-shift tempering matrix mask.
- * @var output_t The second left-shift tempering matrix parameter.
- * @var output_c The second left-shift tempering matrix mask.
- * @var output_l The second right-shift tempering matrix parameter.
+ * @tparam __w Word size, the number of bits in each element of
+ * the state vector.
+ * @tparam __n The degree of recursion.
+ * @tparam __m The period parameter.
+ * @tparam __r The separation point bit index.
+ * @tparam __a The last row of the twist matrix.
+ * @tparam __u The first right-shift tempering matrix parameter.
+ * @tparam __d The first right-shift tempering matrix mask.
+ * @tparam __s The first left-shift tempering matrix parameter.
+ * @tparam __b The first left-shift tempering matrix mask.
+ * @tparam __t The second left-shift tempering matrix parameter.
+ * @tparam __c The second left-shift tempering matrix mask.
+ * @tparam __l The second right-shift tempering matrix parameter.
+ * @tparam __f Initialization multiplier.
*/
template<typename _UIntType, size_t __w,
size_t __n, size_t __m, size_t __r,
_UIntType1 __c1, size_t __l1, _UIntType1 __f1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::mersenne_twister_engine<_UIntType1, __w1, __n1,
__m1, __r1, __a1, __u1, __d1, __s1, __b1, __t1, __c1,
- __l1, __f1>&);
+ __l1, __f1>& __x);
/**
* @brief Extracts the current state of a % mersenne_twister_engine
_UIntType1 __c1, size_t __l1, _UIntType1 __f1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::mersenne_twister_engine<_UIntType1, __w1, __n1, __m1,
__r1, __a1, __u1, __d1, __s1, __b1, __t1, __c1,
- __l1, __f1>&);
+ __l1, __f1>& __x);
private:
_UIntType _M_x[state_size];
* @brief Copy constructs a %discard_block_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- discard_block_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne), _M_n(0) { }
+ discard_block_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng), _M_n(0) { }
/**
* @brief Move constructs a %discard_block_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- discard_block_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne)), _M_n(0) { }
+ discard_block_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng)), _M_n(0) { }
/**
* @brief Seed constructs a %discard_block_engine engine.
template<typename _RandomNumberEngine1, size_t __p1, size_t __r1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::discard_block_engine<_RandomNumberEngine1,
- __p1, __r1>&);
+ __p1, __r1>& __x);
/**
* @brief Extracts the current state of a % subtract_with_carry_engine
template<typename _RandomNumberEngine1, size_t __p1, size_t __r1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
std::discard_block_engine<_RandomNumberEngine1,
- __p1, __r1>&);
+ __p1, __r1>& __x);
private:
_RandomNumberEngine _M_b;
* @brief Copy constructs a %independent_bits_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- independent_bits_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne) { }
+ independent_bits_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng) { }
/**
* @brief Move constructs a %independent_bits_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- independent_bits_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne)) { }
+ independent_bits_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng)) { }
/**
* @brief Seed constructs a %independent_bits_engine engine.
* @brief Copy constructs a %shuffle_order_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- shuffle_order_engine(const _RandomNumberEngine& __rne)
- : _M_b(__rne)
+ shuffle_order_engine(const _RandomNumberEngine& __rng)
+ : _M_b(__rng)
{ _M_initialize(); }
/**
* @brief Move constructs a %shuffle_order_engine engine.
*
* Copies an existing base class random number generator.
- * @param rng An existing (base class) engine object.
+ * @param __rng An existing (base class) engine object.
*/
explicit
- shuffle_order_engine(_RandomNumberEngine&& __rne)
- : _M_b(std::move(__rne))
+ shuffle_order_engine(_RandomNumberEngine&& __rng)
+ : _M_b(std::move(__rng))
{ _M_initialize(); }
/**
template<typename _RandomNumberEngine1, size_t __k1,
typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
const std::shuffle_order_engine<_RandomNumberEngine1,
- __k1>&);
+ __k1>& __x);
/**
* @brief Extracts the current state of a % subtract_with_carry_engine
template<typename _RandomNumberEngine1, size_t __k1,
typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::shuffle_order_engine<_RandomNumberEngine1, __k1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>& __is,
+ std::shuffle_order_engine<_RandomNumberEngine1, __k1>& __x);
private:
void _M_initialize()
/**
* @brief Constructs a uniform_real_distribution object.
*
- * @param __min [IN] The lower bound of the distribution.
- * @param __max [IN] The upper bound of the distribution.
+ * @param __a [IN] The lower bound of the distribution.
+ * @param __b [IN] The upper bound of the distribution.
*/
explicit
uniform_real_distribution(_RealType __a = _RealType(0),
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_ostream<_CharT, _Traits>&
- operator<<(std::basic_ostream<_CharT, _Traits>&,
- const std::normal_distribution<_RealType1>&);
+ operator<<(std::basic_ostream<_CharT, _Traits>& __os,
+ const std::normal_distribution<_RealType1>& __x);
/**
* @brief Extracts a %normal_distribution random number distribution
*/
template<typename _RealType1, typename _CharT, typename _Traits>
friend std::basic_istream<_CharT, _Traits>&
- operator>>(std::basic_istream<_CharT, _Traits>&,
- std::normal_distribution<_RealType1>&);
+ operator>>(std::basic_istream<_CharT, _Traits>&
OSDN Git Service
