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 classes and functions.

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

To get 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.

Command

Base class for command line programs.

CommandLine

Parse command line arguments and options.

DiagnosticOutput

Output diagnostic messages, with optional location and source information in a format suitable for parsing by IDEs.

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.

FlagSet

A set of flags. The possible flags are defined by an enum type.

HexCoder

Encode and decode hexadecimal data to strings or output streams.

Int

This class provides static methods for various integer utility functions.

Location

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

SearchPath

Search files in a list of directories.

Symbol

A cheap and small representation of a string.

SystemEnvironment

Access to system environment variables.

UTF8

Utility functions for working with UTF-8 and Unicode code-points.

Util

This header file collects various utility functions.

Value

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