UTF8-CPP: UTF-8 with C++ in a Portable Way

Introduction

Table of Contents

Installation

Examples of use

Introductory Sample

Checking if a file contains valid UTF-8 text

Ensure that a string contains valid UTF-8 text

Points of interest

Design goals and decisions

Alternatives

Reference

Functions From utf8 Namespace

utf8::append

octetiterator append(utfchar32t cp, octetiterator result)

void append(utfchar32t cp, std::string& s);

utf8::append16

worditerator append16(utfchar32t cp, worditerator result)

void append(utfchar32t cp, std::u16string& s)

utf8::next

utf8::next16

utf8::peeknext

utf8::prior

utf8::advance

utf8::distance

utf8::utf16to8

octetiterator utf16to8 (u16bititerator start, u16bititerator end, octetiterator result)

std::string utf16to8(const std::u16string& s)

std::string utf16to8(std::u16stringview s)

utf8::utf16tou8

std::u8string utf16tou8(const std::u16string& s)

std::u8string utf16tou8(const std::u16stringview& s)

utf8::utf8to16

u16bititerator utf8to16 (octetiterator start, octetiterator end, u16bititerator result)

std::u16string utf8to16(const std::string& s)

std::u16string utf8to16(std::stringview s)

std::u16string utf8to16(std::u8string& s)

std::u16string utf8to16(std::u8stringview& s)

utf8::utf32to8

octetiterator utf32to8 (u32bititerator start, u32bititerator end, octetiterator result)

std::string utf32to8(const std::u32string& s)

std::u8string utf32to8(const std::u32string& s)

std::u8string utf32to8(const std::u32stringview& s)

std::string utf32to8(const std::u32string& s)

std::string utf32to8(std::u32stringview s)

utf8::utf8to32

u32bititerator utf8to32 (octetiterator start, octetiterator end, u32bititerator result)

std::u32string utf8to32(const std::u8string& s)

std::u32string utf8to32(const std::u8stringview& s)

std::u32string utf8to32(const std::string& s)

std::u32string utf8to32(std::stringview s)

utf8::findinvalid

octetiterator findinvalid(octetiterator start, octetiterator end)

const char findinvalid(const char str)

std::sizet findinvalid(const std::string& s)

std::sizet findinvalid(std::stringview s)

utf8::isvalid

bool isvalid(octetiterator start, octetiterator end)

bool isvalid(const char str)

bool isvalid(const std::string& s)

bool isvalid(std::stringview s)

utf8::replaceinvalid

outputiterator replaceinvalid(octetiterator start, octetiterator end, outputiterator out, utfchar32t replacement)

std::string replaceinvalid(const std::string& s, utfchar32t replacement)

std::string replaceinvalid(std::stringview s, char32t replacement)

utf8::startswithbom

bool startswithbom (octetiterator it, octetiterator end)

bool startswithbom(const std::string& s)

bool startswithbom(std::stringview s)

Types From utf8 Namespace

utf8::exception

utf8::invalidcodepoint

utf8::invalidutf8

utf8::invalidutf16

utf8::notenoughroom

utf8::iterator

Member functions

Functions From utf8::unchecked Namespace

utf8::unchecked::append

utf8::unchecked::append16

utf8::unchecked::next

utf8::next16

utf8::unchecked::peeknext

utf8::unchecked::prior

utf8::unchecked::advance

utf8::unchecked::distance

utf8::unchecked::utf16to8

utf8::unchecked::utf8to16

utf8::unchecked::utf32to8

utf8::unchecked::utf8to32

utf8::unchecked::replaceinvalid

Types From utf8::unchecked Namespace

utf8::iterator

Member functions