utf8 Namespace Reference

Namespaces
	internal
	unchecked

Classes
class	invalid_code_point
class	invalid_utf16
class	invalid_utf8
class	iterator
class	not_enough_room

Typedefs
typedef unsigned char	uint8_t
typedef unsigned short	uint16_t
typedef unsigned int	uint32_t

Functions
template<typename octet_iterator , typename output_iterator >
output_iterator	replace_invalid (octet_iterator start, octet_iterator end, output_iterator out, uint32_t replacement)
	The library API - functions intended to be called by the users. More...
template<typename octet_iterator , typename output_iterator >
output_iterator	replace_invalid (octet_iterator start, octet_iterator end, output_iterator out)
template<typename octet_iterator >
octet_iterator	append (uint32_t cp, octet_iterator result)
template<typename octet_iterator >
uint32_t	next (octet_iterator &it, octet_iterator end)
template<typename octet_iterator >
uint32_t	prior (octet_iterator &it, octet_iterator start)
template<typename octet_iterator >
uint32_t	previous (octet_iterator &it, octet_iterator pass_start)
	Deprecated in versions that include "prior". More...
template<typename octet_iterator , typename distance_type >
void	advance (octet_iterator &it, distance_type n, octet_iterator end)
template<typename octet_iterator >
std::iterator_traits < octet_iterator > ::difference_type	distance (octet_iterator first, octet_iterator last)
template<typename u16bit_iterator , typename octet_iterator >
octet_iterator	utf16to8 (u16bit_iterator start, u16bit_iterator end, octet_iterator result)
template<typename u16bit_iterator , typename octet_iterator >
u16bit_iterator	utf8to16 (octet_iterator start, octet_iterator end, u16bit_iterator result)
template<typename octet_iterator , typename u32bit_iterator >
octet_iterator	utf32to8 (u32bit_iterator start, u32bit_iterator end, octet_iterator result)
template<typename octet_iterator , typename u32bit_iterator >
u32bit_iterator	utf8to32 (octet_iterator start, octet_iterator end, u32bit_iterator result)
template<typename octet_iterator >
octet_iterator	find_invalid (octet_iterator start, octet_iterator end)
template<typename octet_iterator >
bool	is_valid (octet_iterator start, octet_iterator end)
template<typename octet_iterator >
bool	is_bom (octet_iterator it)

Variables
const uint8_t	bom [] = {0xef, 0xbb, 0xbf}
	The library API - functions intended to be called by the users. More...

Typedef Documentation

typedef unsigned short utf8::uint16_t

Definition at line 39 of file core.h.

typedef unsigned int utf8::uint32_t

Definition at line 40 of file core.h.

typedef unsigned char utf8::uint8_t

Definition at line 38 of file core.h.

Function Documentation

template<typename octet_iterator , typename distance_type >

void utf8::advance	(	octet_iterator &	it,
		distance_type	n,
		octet_iterator	end
	)

Definition at line 179 of file checked.h.

References next().

Referenced by utf8::internal::validate_next().

Here is the caller graph for this function:

template<typename octet_iterator >

octet_iterator utf8::append	(	uint32_t	cp,
		octet_iterator	result
	)

Definition at line 107 of file checked.h.

References utf8::internal::CODE_POINT_MAX, and utf8::internal::is_code_point_valid().

Referenced by FIFE::FontBase::getAsImageMultiline(), fcn::UTF8StringEditor::insertChar(), replace_invalid(), FIFE::FontBase::splitTextToWidth(), utf16to8(), and utf32to8().

Here is the caller graph for this function:

template<typename octet_iterator >

std::iterator_traits<octet_iterator>::difference_type utf8::distance	(	octet_iterator	first,
		octet_iterator	last
	)

Definition at line 187 of file checked.h.

References next().

Referenced by fcn::UTF8StringEditor::countChars(), FIFE::RoutePather::followRoute(), FIFE::CellCache::getCellsInCircle(), FIFE::Layer::getInstancesInCircle(), FIFE::EventManager::processMouseEvent(), FIFE::MultiLayerSearch::searchBetweenTargetsMap(), FIFE::FontBase::splitTextToWidth(), and utf8::internal::validate_next().

Here is the caller graph for this function:

template<typename octet_iterator >

octet_iterator utf8::find_invalid	(	octet_iterator	start,
		octet_iterator	end
	)

Definition at line 229 of file core.h.

References utf8::internal::OK, and utf8::internal::validate_next().

Referenced by is_valid().

Here is the caller graph for this function:

template<typename octet_iterator >

bool utf8::is_bom ( octet_iterator  it )

inline

Definition at line 247 of file core.h.

References bom, and utf8::internal::mask8().

template<typename octet_iterator >

bool utf8::is_valid ( octet_iterator  start, octet_iterator  end  )

inline

Definition at line 241 of file core.h.

References find_invalid().

Referenced by FIFE::FontBase::getStringIndexAt(), and FIFE::TrueTypeFont::getWidth().

Here is the caller graph for this function:

template<typename octet_iterator >

uint32_t utf8::next	(	octet_iterator &	it,
		octet_iterator	end
	)

Definition at line 136 of file checked.h.

References utf8::internal::INCOMPLETE_SEQUENCE, utf8::internal::INVALID_CODE_POINT, utf8::internal::INVALID_LEAD, utf8::internal::NOT_ENOUGH_ROOM, utf8::internal::OK, utf8::internal::OVERLONG_SEQUENCE, and utf8::internal::validate_next().

Referenced by advance(), distance(), fcn::UTF8StringEditor::eraseChar(), FIFE::FontBase::getAsImageMultiline(), fcn::UTF8StringEditor::getOffset(), FIFE::FontBase::getStringIndexAt(), FIFE::ImageFontBase::getWidth(), fcn::UTF8StringEditor::insertChar(), fcn::UTF8StringEditor::nextChar(), utf8::iterator< octet_iterator >::operator*(), utf8::iterator< octet_iterator >::operator++(), previous(), prior(), FIFE::ImageFontBase::renderString(), FIFE::MultiLayerSearch::searchBetweenTargetsMap(), FIFE::FontBase::splitTextToWidth(), FIFE::SubImageFont::SubImageFont(), utf8to16(), and utf8to32().

Here is the caller graph for this function:

template<typename octet_iterator >

uint32_t utf8::previous	(	octet_iterator &	it,
		octet_iterator	pass_start
	)

Deprecated in versions that include "prior".

Definition at line 168 of file checked.h.

References utf8::internal::is_trail(), and next().

template<typename octet_iterator >

uint32_t utf8::prior	(	octet_iterator &	it,
		octet_iterator	start
	)

Definition at line 156 of file checked.h.

References utf8::internal::is_trail(), and next().

Referenced by utf8::iterator< octet_iterator >::operator--(), and fcn::UTF8StringEditor::prevChar().

Here is the caller graph for this function:

template<typename octet_iterator , typename output_iterator >

output_iterator utf8::replace_invalid	(	octet_iterator	start,
		octet_iterator	end,
		output_iterator	out,
		uint32_t	replacement
	)

The library API - functions intended to be called by the users.

Definition at line 69 of file checked.h.

References append(), utf8::internal::INCOMPLETE_SEQUENCE, utf8::internal::INVALID_CODE_POINT, utf8::internal::INVALID_LEAD, utf8::internal::is_trail(), utf8::internal::NOT_ENOUGH_ROOM, utf8::internal::OK, utf8::internal::OVERLONG_SEQUENCE, and utf8::internal::validate_next().

Referenced by replace_invalid().

Here is the caller graph for this function:

template<typename octet_iterator , typename output_iterator >

output_iterator utf8::replace_invalid ( octet_iterator  start, octet_iterator  end, output_iterator  out  )

inline

Definition at line 100 of file checked.h.

References utf8::internal::mask16(), and replace_invalid().

template<typename u16bit_iterator , typename octet_iterator >

octet_iterator utf8::utf16to8	(	u16bit_iterator	start,
		u16bit_iterator	end,
		octet_iterator	result
	)

Definition at line 196 of file checked.h.

References append(), utf8::internal::is_surrogate(), utf8::internal::mask16(), utf8::internal::SURROGATE_OFFSET, utf8::internal::TRAIL_SURROGATE_MAX, and utf8::internal::TRAIL_SURROGATE_MIN.

template<typename octet_iterator , typename u32bit_iterator >

octet_iterator utf8::utf32to8	(	u32bit_iterator	start,
		u32bit_iterator	end,
		octet_iterator	result
	)

Definition at line 234 of file checked.h.

References append().

template<typename u16bit_iterator , typename octet_iterator >

u16bit_iterator utf8::utf8to16	(	octet_iterator	start,
		octet_iterator	end,
		u16bit_iterator	result
	)

Definition at line 219 of file checked.h.

References utf8::internal::LEAD_OFFSET, next(), and utf8::internal::TRAIL_SURROGATE_MIN.

template<typename octet_iterator , typename u32bit_iterator >

u32bit_iterator utf8::utf8to32	(	octet_iterator	start,
		octet_iterator	end,
		u32bit_iterator	result
	)

Definition at line 243 of file checked.h.

References next().

Referenced by FIFE::FontBase::getAsImageMultiline(), and FIFE::FontBase::splitTextToWidth().

Here is the caller graph for this function:

Variable Documentation

const uint8_t utf8::bom[] = {0xef, 0xbb, 0xbf}

The library API - functions intended to be called by the users.

Definition at line 226 of file core.h.

Referenced by is_bom().