Skip to content

Reference

This section contains reference documentation for the public API of T'Pau C++ Kernal. It is meant to be comprehensive and detailed, but may not be the best place to start for new users. It is intended to be used as a reference for specific functions, classes.

Warning

The API is still in development and may change in breaking ways.

The concepts and design decisions behind the API are explained in the Explanations section.

For getting started, please refer to the Tutorials section. For practical instructions, see the How-To Guides section.

Base64Coder

Encode and decode Base64 data to strings or output streams.

Coder

The base class for all coders, providing the framework to encode and decode data.

Exception

The base class for all exceptions thrown by T'Pau C++ Kernal. It allows adding system errors to the exception message.

FileReader

Read text or binary files.

FileSource

Read text files character by character, with support for peeking and ungetting characters, and resetting to a specific location.

HexCoder

Encode and decode hexadecimal data to strings or output streams.

Location

A location in a source file, consisting of a file name and a range of line and column numbers.

Path

Search files in a list of directories.

Symbol

A cheap and small representation of a string.

Value

Values of various types, and operations on them, with type and overflow checking.