ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Classes | Enumerations
aworx::lib::text Namespace Reference

This ALib Module implements string formatting based on "placeholder format strings" similar to good old printf function and similar to what is given with many modern programming language's core libraries.

Please consult ALib Module Text - Programmer's Manual for further information.

Classes

struct  FFormat
 
class  Formatter
 
class  FormatterJavaStyle
 
class  FormatterPythonStyle
 
class  FormatterStdImpl
 
class  Paragraphs
 
class  PropertyFormatter
 
struct  PropertyFormatterMapAppendable
 
class  PropertyFormatters
 
class  Text
 

Enumerations

enum  Exceptions {
  ArgumentIndexIs0 =11, ArgumentIndexOutOfBounds =12, IncompatibleTypeCode =13, MissingClosingBracket =101,
  MissingPrecisionValuePS =102, DuplicateTypeCode =103, UnknownTypeCode =104, ExclamationMarkExpected =105,
  UnknownConversionPS =106, PrecisionSpecificationWithInteger =107, MissingReplacementStrings =108, NegativeValuesInBracketsNotSupported =201,
  MissingPrecisionValueJS =202, HexadecimalFloatFormatNotSupported =203, NoAlternateFormOfConversion =204, NoPrecisionWithConversion =205,
  UnknownDateTimeConversionSuffix =206, UnknownConversionJS =207, UnknownPropertyInFormatString =501, ErrorInResultingFormatString =502,
  MissingConfigurationVariable =510, UnknownMarker =601, EndmarkerWithoutStart =602
}
 

Enumeration Type Documentation

◆ Exceptions

enum Exceptions
strong

Enumeration of exceptions thrown with classes found in module ALib Text.

Enumerator
ArgumentIndexIs0 

Argument index '0' not allowed.

ArgumentIndexOutOfBounds 

Argument index greater than number of arguments available.

IncompatibleTypeCode 

Incompatible type code given argument type found.

MissingClosingBracket 

Thrown by FormatterPythonStyle: Closing bracket '}' not found.

MissingPrecisionValuePS 

Thrown by FormatterPythonStyle: Missing precision integral value after '.' character.

DuplicateTypeCode 

Thrown by FormatterPythonStyle: Duplicate type code.

UnknownTypeCode 

Thrown by FormatterPythonStyle: Unknown type code.

ExclamationMarkExpected 

Thrown by FormatterPythonStyle: Expected '!' not found.

UnknownConversionPS 

Thrown by FormatterPythonStyle: Unknown conversion after '!'.

PrecisionSpecificationWithInteger 

Thrown by FormatterPythonStyle: Precision specification not allowed with integer types.

MissingReplacementStrings 

Thrown by FormatterPythonStyle: Missing replacement strings after conversion !Replace.

NegativeValuesInBracketsNotSupported 

Thrown by FormatterJavaStyle: Formatting of negative values in brackets is not supported.

MissingPrecisionValueJS 

Thrown by FormatterJavaStyle: Missing precision integral value after '.' character.

HexadecimalFloatFormatNotSupported 

Thrown by FormatterJavaStyle: Output of floating point values in hexadecimal format not supported.

NoAlternateFormOfConversion 

Thrown by FormatterJavaStyle: The alternate form '#' is not supported with given conversion.

NoPrecisionWithConversion 

Thrown by FormatterJavaStyle: Precision specification is not supported with given conversion.

UnknownDateTimeConversionSuffix 

Thrown by FormatterJavaStyle: Unknown conversion suffix with with data/time conversion.

UnknownConversionJS 

Thrown by FormatterJavaStyle: Unknown conversion character.

UnknownPropertyInFormatString 

Thrown by constructor of PropertyFormatter when a property identifier parsed from the format string has no corresponding entry in the TCallbackTable provided.

ErrorInResultingFormatString 

Exception entry added in method PropertyFormatter::Format when the underlying formatter throws.

MissingConfigurationVariable 

Thrown by PropertyFormatters::Format if a configuration variable can not be loaded or is empty.

Note
To prevent this, software using this class should provide resourced default values for each formatter variable.
UnknownMarker 

Thrown by Paragraphs::AddMarked when an unknown marker token was found.

EndmarkerWithoutStart 

Thrown by Paragraphs::AddMarked when a property identifier parsed from the format string has no corresponding entry in the TCallbackTable provided.

Definition at line 37 of file text.hpp.