| Boost.Locale

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Examples

Classes | Enumerations | Functions
Text Conversions

## Classes

class | boost::locale::converter_base
| This class provides base flags for text manipulation. It is used as base for converter facet. More...
class | boost::locale::converter< Char >
| The facet that implements text manipulation. More...

## Enumerations

enum | boost::locale::norm_type { boost::locale::norm_nfd, boost::locale::norm_nfc, boost::locale::norm_nfkd, boost::locale::norm_nfkc, boost::locale::norm_default = norm_nfc }

## Functions

template<typename CharType >
std::basic_string< CharType > | boost::locale::normalize (std::basic_string< CharType > const &str, norm_type n=norm_default, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::normalize (CharType const *str, norm_type n=norm_default, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::normalize (CharType const *begin, CharType const *end, norm_type n=norm_default, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_upper (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_upper (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_upper (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_lower (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_lower (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_lower (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_title (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_title (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::to_title (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::fold_case (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::fold_case (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType >
std::basic_string< CharType > | boost::locale::fold_case (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())

## Detailed Description

This module provides various function for string manipulation like Unicode normalization, case conversion etc.

## Enumeration Type Documentation

enum boost::locale::norm_type

The type that defined normalization form

Enumerator:

  norm_nfd | Canonical decomposition.
  norm_nfc | Canonical decomposition followed by canonical composition.
  norm_nfkd | Compatibility decomposition.
  norm_nfkc | Compatibility decomposition followed by canonical composition.
  norm_default | Default normalization - canonical decomposition followed by canonical composition.

## Function Documentation

template<typename CharType >

std::basic_string<CharType> boost::locale::fold_case | ( | std::basic_string< CharType > const & | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Fold case of a string str according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

Examples:
  hello.cpp, and whello.cpp.

template<typename CharType >

std::basic_string<CharType> boost::locale::fold_case | ( | CharType const * | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Fold case of a NUL terminated string str according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::fold_case | ( | CharType const * | begin,
|  | CharType const * | end,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Fold case of a string in range [begin,end) according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::normalize | ( | std::basic_string< CharType > const & | str,
|  | norm_type | n = `norm_default`,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Normalize Unicode string str according to normalization form n

Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take in account the locale encoding, because Unicode decomposition and composition are meaningless outside of a Unicode character set.

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::normalize | ( | CharType const * | str,
|  | norm_type | n = `norm_default`,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Normalize NUL terminated Unicode string str according to normalization form n

Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take in account the locale encoding, because Unicode decomposition and composition are meaningless outside of a Unicode character set.

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::normalize | ( | CharType const * | begin,
|  | CharType const * | end,
|  | norm_type | n = `norm_default`,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Normalize Unicode string in range [begin,end) according to normalization form n

Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take in account the locale encoding, because Unicode decomposition and composition are meaningless outside of a Unicode character set.

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_lower | ( | std::basic_string< CharType > const & | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string str to lower case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

Examples:
  conversions.cpp, hello.cpp, wconversions.cpp, and whello.cpp.

template<typename CharType >

std::basic_string<CharType> boost::locale::to_lower | ( | CharType const * | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a NUL terminated string str to lower case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_lower | ( | CharType const * | begin,
|  | CharType const * | end,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string in range [begin,end) to lower case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_title | ( | std::basic_string< CharType > const & | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string str to title case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

Examples:
  hello.cpp, and whello.cpp.

template<typename CharType >

std::basic_string<CharType> boost::locale::to_title | ( | CharType const * | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a NUL terminated string str to title case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_title | ( | CharType const * | begin,
|  | CharType const * | end,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string in range [begin,end) to title case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_upper | ( | std::basic_string< CharType > const & | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string str to upper case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

Examples:
  conversions.cpp, hello.cpp, wconversions.cpp, and whello.cpp.

template<typename CharType >

std::basic_string<CharType> boost::locale::to_upper | ( | CharType const * | str,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a NUL terminated string str to upper case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed

template<typename CharType >

std::basic_string<CharType> boost::locale::to_upper | ( | CharType const * | begin,
|  | CharType const * | end,
|  | std::locale const & | loc = `std::locale()`
| ) |  |

Convert a string in range [begin,end) to upper case according to locale loc

Note:
  throws std::bad_cast if loc does not have converter facet installed