alib::strings::compatibility::std Namespace Reference

Description:

This namespace documents compatibility features of ALib Strings and the standard C++ class library found in namespace std.

Type Index:
struct	equal_to< alib::strings::TString< TChar > >
struct	equal_to_string_ignore_case
struct	hash< alib::strings::TString< TChar > >
struct	hash_string_ignore_case
struct	less< alib::strings::TString< TChar > >
struct	less_string_ignore_case
class	StringReader
class	StringWriter
struct	T_SuppressStdOstreamOperator
struct	TISReadLine

Function Index:
std::ostream &	operator<< (std::ostream &stream, const alib::NString &string)
ALIB_API std::ostream &	operator<< (std::ostream &stream, const alib::WString &string)
template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::nchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>
std::ostream &	operator<< (std::ostream &stream, const TAppendable &appendable)
std::ostream *	operator<< (std::ostream *stream, const alib::NString &string)
std::ostream *	operator<< (std::ostream *stream, const alib::WString &string)
template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::nchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>
std::ostream *	operator<< (std::ostream *stream, const TAppendable &appendable)
ALIB_API std::wostream &	operator<< (std::wostream &stream, const alib::NString &string)
std::wostream &	operator<< (std::wostream &stream, const alib::WString &string)
template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::wchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>
std::wostream &	operator<< (std::wostream &stream, const TAppendable &appendable)
std::wostream *	operator<< (std::wostream *stream, const alib::NString &string)
std::wostream *	operator<< (std::wostream *stream, const alib::WString &string)
template<typename TAppendable , typename TAllocator , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::wchar,TAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>
std::wostream *	operator<< (std::wostream *stream, const TAppendable &appendable)
std::basic_istream< wchar_t > &	operator>> (std::basic_istream< wchar_t > &stream, alib::WAString &string)
std::basic_istream< wchar_t > *	operator>> (std::basic_istream< wchar_t > *stream, alib::WAString &string)
std::istream &	operator>> (std::istream &stream, alib::NAString &string)
std::istream *	operator>> (std::istream *stream, alib::NAString &string)

Function Details:

operator<<() [1/12]

std::ostream & operator<< ( std::ostream & stream, const alib::NString & string )

inline

Copies the contents of the given NString to into the std::ostream given as reference.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 371 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [2/12]

ALIB_API std::ostream & operator<<	(	std::ostream &	stream,
		const alib::WString &	string )

Copies the contents of the given WString to into the std::ostream given as reference.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Here is the call graph for this function:

operator<<() [3/12]

template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::nchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>

std::ostream & operator<<	(	std::ostream &	stream,
		const TAppendable &	appendable )

Copies the contents of the given appendable type the std::ostream given as reference.

Note

Unlike this documentation indicates, this operator is defined in the global namespace.

Template Parameters

TAppendable

The appendable type.

Parameters

stream	The std::ostream object to write the given String into.
appendable	The object whose contents is to be written into the given stream.

Returns

The ostream to allow concatenated operations.

Definition at line 597 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [4/12]

std::ostream * operator<< ( std::ostream * stream, const alib::NString & string )

inline

Copies the contents of the given NString to into the std::ostream given as pointer.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 386 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [5/12]

std::ostream * operator<< ( std::ostream * stream, const alib::WString & string )

inline

Copies the contents of the given WString to into the std::ostream given as pointer.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 410 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [6/12]

template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::nchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>

std::ostream * operator<<	(	std::ostream *	stream,
		const TAppendable &	appendable )

Copies the contents of the given appendable type the std::ostream given as pointer.

Note

Unlike this documentation indicates, this operator is defined in the global namespace.

Template Parameters

TAppendable

The appendable type.

Parameters

stream	The std::ostream object to write the given String into.
appendable	The object whose contents is to be written into the given stream.

Returns

The ostream to allow concatenated operations.

Definition at line 624 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [7/12]

ALIB_API std::wostream & operator<<	(	std::wostream &	stream,
		const alib::NString &	string )

Copies the contents of the given NString to into the std::wostream given as reference.

Note

This operator uses a local string buffer of 256 bytes size to convert the given narrow string to an string of wchar_t characters that the output stream accepts. In case that the given string is larger, a dynamic memory allocation has to be made.
In performance-critical code that writes larger string data, a custom conversion method, that for example reuses a buffer, may be appropriate.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Here is the call graph for this function:

operator<<() [8/12]

std::wostream & operator<< ( std::wostream & stream, const alib::WString & string )

inline

Copies the contents of the given WString to into the std::wostream given as reference.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 459 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [9/12]

template<typename TAppendable , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::wchar,alib::lang::HeapAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>

std::wostream & operator<<	(	std::wostream &	stream,
		const TAppendable &	appendable )

Copies the contents of the given appendable type the std::ostream given as reference.

Note

Unlike this documentation indicates, this operator is defined in the global namespace.

Template Parameters

TAppendable

The appendable type.

Parameters

stream	The std::ostream object to write the given String into.
appendable	The object whose contents is to be written into the given stream.

Returns

The ostream to allow concatenated operations.

Definition at line 648 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [10/12]

std::wostream * operator<< ( std::wostream * stream, const alib::NString & string )

inline

Copies the contents of the given NString to into the std::wostream given as pointer.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

See also

The notes on memory efficiency, documented with operator operator<<(std::wostream&,const NString&) which this operator uses inline.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 445 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [11/12]

std::wostream * operator<< ( std::wostream * stream, const alib::WString & string )

inline

Copies the contents of the given WString to into the std::wostream given as pointer.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The ostream object to write the given String into.
string	The String to write into the given ostream.

Returns

The ostream to allow concatenated operations.

Definition at line 482 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator<<() [12/12]

template<typename TAppendable , typename TAllocator , typename TEnableIf = typename std::enable_if< alib::strings::TT_IsAppendable<TAppendable,alib::wchar,TAllocator>::value && !alib::strings::compatibility::std::T_SuppressStdOstreamOperator<TAppendable>::value >::type>

std::wostream * operator<<	(	std::wostream *	stream,
		const TAppendable &	appendable )

Copies the contents of the given appendable type the std::ostream given as pointer.

Note

Unlike this documentation indicates, this operator is defined in the global namespace.

Template Parameters

TAppendable	The appendable type.
TAllocator	The allocator type, as prototyped with Allocator.

Parameters

stream	The std::ostream object to write the given String into.
appendable	The object whose contents is to be written into the given stream.

Returns

The ostream to allow concatenated operations.

Definition at line 678 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator>>() [1/4]

std::basic_istream< wchar_t > & operator>> ( std::basic_istream< wchar_t > & stream, alib::WAString & string )

inline

Clears the given WAString and extracts data from the std::istream into it. The extractions ends with either the end of the std::istream or when reading a newline character.

Note

If code selection symbol ALIB_CHARACTERS_NATIVE_WCHAR evaluates to false, a local buffer is used to convert the string of wchar_t characters that the input stream provides. In case that the string read from the stream is larger, a dynamic memory allocation has to be made.
In performance-critical code that receives larger string data, a custom conversion method that, for example, reuses a buffer may be appropriate.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The istream object to extract data from.
string	The AString to receive data.

Returns

The ostream to allow concatenated operations.

Definition at line 541 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator>>() [2/4]

std::basic_istream< wchar_t > * operator>> ( std::basic_istream< wchar_t > * stream, alib::WAString & string )

inline

Clears the given WAString and extracts data from the std::istream into it. The extractions ends with either the end of the std::istream or when reading a newline character.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

See also

The notes on memory efficiency, documented with operator operator>>(std::basic_istream<wchar_t>&, WAString& ) which this operator uses inline.

Parameters

stream	The istream object to extract data from.
string	The AString to receive data.

Returns

The ostream to allow concatenated operations.

Definition at line 570 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator>>() [3/4]

std::istream & operator>> ( std::istream & stream, alib::NAString & string )

inline

Clears the given NAString and extracts data from the std::istream into it. The extractions ends with either the end of the std::istream or when reading a newline character.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The istream object to extract data from.
string	The AString to receive data.

Returns

The ostream to allow concatenated operations.

Definition at line 497 of file std_strings_iostream.hpp.

Here is the call graph for this function:

operator>>() [4/4]

std::istream * operator>> ( std::istream * stream, alib::NAString & string )

inline

Clears the given NAString and extracts data from the std::istream into it. The extractions ends with either the end of the std::istream or when reading a newline character.

Note

Unlike this documentation indicates, the operator is defined in the global namespace.

Parameters

stream	The istream object to extract data from.
string	The AString to receive data.

Returns

The ostream to allow concatenated operations.

Definition at line 513 of file std_strings_iostream.hpp.

Here is the call graph for this function: