better-enums/doc/ApiReference.md

API reference

$internal_toc

Overview

The declaration

#include <enum.h>
<em>ENUM</em>(<em>Enum</em>, <em>underlying_type</em>, <em>A</em>, <em>B</em>, <em>C</em>, ...)

generates a new class type Enum which is notionally similar to the type created by this $cxx11 declaration:

<em>enum class Enum</em> : <em>underlying_type</em> {<em>A</em>, <em>B</em>, <em>C</em>, ...};

That is, Enum is a scoped enumerated type with constants Enum::A, Enum::B, Enum::C, and so on, with memory representation the same as underlying_type. It is possible to supply initializers for any of the constants:

<em>ENUM</em>(Enum, underlying_type, <em>A</em> = <em>1</em>, <em>B</em> = <em>constant_expression</em>, <em>C</em> = <em>A</em>, ...)

The initializers have the same meaning and constraints as in a built-in enum or enum class declaration.

---

The principal differences between the types declared by the ENUM macro and enum class are:

• ENUM is available for $cxx98 compilers supporting __VA_ARGS__ — all major compilers — while enum class is restricted to $cxx11,
• the ENUM type is implicitly convertible to integral types, though this can be disabled when using $cxx11, and
• the ENUM type supports a set of reflective operations, detailed in the rest of this reference.

---

The types produced by the ENUM macro are called Better Enums in the rest of this reference.

Better Enums are similar to their underlying type for the purposes of argument passing. This means that they typically fit into a machine word, and should be passed by value.

All names declared in the scope of a Better Enum are prefixed with an underscore in order to avoid conflicts with potential constant names.

If you are using non-integral underlying types, you need to be aware of section of this reference on underlying types. However, if you are using a regular, integral underlying type, the type Enum::_underlying is the same Enum::_integral, and each of the *_underlying functions is the same as the corresponding *_integral function, so you can safely ignore that whole section.

Running example

The rest of this reference uses the following declaration as a running example:

<em>ENUM</em>(<em>Enum</em>, <em>int</em>, <em>A</em>, <em>B</em>, <em>C</em>)

Helper functions and types

The types and functions described here make it possible to use Better Enums with the rest of $cxx in a reasonable fashion, or else they are referenced in the rest of the documentation.

typedef _enumerated

An internal type used to declare constants. The ENUM macro generates something similar to

<em>struct Enum</em> {
    <em>enum _enumerated</em> : <em>int</em> {<em>A</em>, <em>B</em>, <em>C</em>};
    // ...
};

The user needs to be aware of _enumerated in only one situation. A literal constant such as Enum::A is an expression of type Enum::_enumerated, not Enum. It is not possible to directly call a method on the constant, as in Enum::A._to_string(). This problem is addressed by operator + below.

non-member constexpr Enum unary operator +(_enumerated)

Forces promotion of Enum::_enumerated to Enum. Provided to solve the problem described above. So:

// Does not compile
<em>Enum::A</em>.<em>_to_string</em>()

// Compiles
(<em>+Enum::A</em>).<em>_to_string</em>()

constexpr implicit constructor Enum(_enumerated)

A constructor that performs implicit conversions of Enum::_enumerated to Enum. This allows code to use a literal constant where Enum is expected, and the compiler can do an implicit conversion. For example:

void <em>do_something</em>(<em>Enum value</em>);

do_something(<em>+Enum::A</em>);  // Not necessary
do_something(<em>Enum::A</em>);   // Implicit conversion available

<em>Enum value</em> = <em>Enum::A</em>;    // Implicit conversion

The other constructors of Enum are the implicitly-generated copy and move constructors. There is no default constructor. If you have comments on what a default constructor should do, please let me know.

non-member struct better_enums::optional<Enum>

An optional Enum value. These are returned by the various _nothrow functions, such as _from_string_nothrow. This type is meant to represent the possibility of failure. For example, suppose you have:

<em>better_enums::optional</em>&lt;<em>Enum</em>&gt;    <em>maybe</em> = <em>_from_string_nothrow</em>(<em>"A"</em>);

An optional value such as maybe is convertible to bool. If it converts to true, it holds a valid Enum value. Otherwise, if it converts to false, the operation that produced the optional value failed. So, you can continue with

<em>if</em> (<em>maybe</em>) {
    // The string conversion succeeded
    do_something(<em>*maybe</em>);
}
<em>else</em> {
    // The string conversion failed
}

As you can see, *maybe evaluates to the Enum value, in this case Enum::A.

The rest of this reference refers to this type as simply optional, as if you had entered

using <em>optional</em> = <em>better_enums::optional</em>&lt;<em>Enum</em>&gt;;

Value count and iteration

The types and members described here have to do with the sequence of constants declared, i.e. A, B, C in the running example.

static constexpr size_t _size()

The number of constants declared. Enum::_size() == 3.

static constexpr const size_t _size_constant

Same as _size, but a constant instead of a function. This is provided for use in $cxx98 constant expressions.

typedef _value_iterable

Type of object that permits iteration over the constants. Has at least constexpr begin(), end(), and size() methods, and constexpr operator[]. Iteration visits each declared constant, even if multiple constants have the same value, and visits them in order of declaration. See usage examples under _values.

typedef _value_iterator

Random-access iterator type for _value_iterable. Most operations, including dereferencing, are constexpr. The exceptions are mutating operators such as operator++. In constexpr code, that can be replaced with addition of 1. You typically don't have to refer to this type directly.

static constexpr _value_iterable _values()

constexpr access to the sequence of declared constants. For example:

<em>for</em> (size_t index = 0; <em>index</em> < <em>Enum::_values().size()</em>; ++index)
    do_something(<em>Enum::_values()[index]</em>);

or, using iterators:

<em>for</em> (Enum::_value_iterator iterator = <em>Enum::_values().begin()</em>;
     iterator != <em>Enum::_values().end()</em>; ++iterator) {

    do_something(<em>*iterator</em>);
}

or, in $cxx11:

<em>for</em> (Enum value : <em>Enum::_values()</em>)
    do_something(<em>value</em>);

String conversion and iteration

member constexpr? const char* _to_string() const

Returns the string representation a Better Enum value. For example:

Enum    value = <em>Enum::A</em>;
value.<em>_to_string</em>();     // Same as "A".

If two or more constants have the same numeric value, it is undefined which name _to_string will choose, but it will choose one of them.

If value is not equal to the representation of any declared constant, for example if it was obtained using an unchecked conversion such as

Enum    value = <em>Enum::_from_integral_unchecked</em>(<em>0xbadc0de</em>);

then the behavior of value._to_string is undefined.

Running time is linear in the number of declared constants.

This method is not constexpr by default. Read here for information about making it constexpr.

static constexpr Enum _from_string(const char*)

If the given string is the exact name of a declared constant, returns the constant. Otherwise, throws std::runtime_error. Running time is linear in the number of declared constants multiplied by the length of the longest constant.

static constexpr optional _from_string_nothrow(const char*)

Same as _from_string, but does not throw an exception on failure. Returns an optional value instead.

static constexpr Enum _from_string_nocase(const char*)

Same as _from_string, but comparison is up to case, in the usual sense in the Latin-1 encoding.

static constexpr optional _from_string_nocase_nothrow(const char*)

Is to _from_string_nocase as _from_string_nothrow is to _from_string.

static constexpr bool _is_valid(const char*)

Evaluates to true if and only if the given string is the exact name of a declared constant. Running time is the same as for _from_string.

static constexpr bool _is_valid_nocase(const char*)

The same as _is_valid, but comparison is done up to case as in _from_string_nocase.

static constexpr const char* _name()

Evaluates to the name of the Better Enum type. Enum::_name() is the same string as "Enum".

typedef _name_iterable

Type of object that permits iteration over names of declared constants. Has at least constexpr begin(), end(), and size() methods. operator[] is also available, but is constexpr if and only if _to_string is constexpr. Iteration visits constants in order of declaration. See usage example under _names.

typedef _name_iterator

Random-access iterator type for _name_iterable. Most operations are constexpr, but dereferencing is constexpr if and only if _to_string is constexpr. Mutating operators such as operator++ are not constexpr due to their nature — adding 1 is a constexpr alternative. You typically don't have to refer to this type directly.

static constexpr? _name_iterable _names()

Access to the sequence of declared constant names. For example:

<em>for</em> (size_t index = 0; <em>index</em> < <em>Enum::_names().size()</em>; ++index)
    std::cout << <em>Enum::_names()[index]</em> << std::endl;

or, using iterators:

<em>for</em> (Enum::_name_iterator iterator = <em>Enum::_names().begin()</em>;
     iterator != <em>Enum::_names().end()</em>; ++iterator) {

    std::cout << <em>*iterator</em> << std::endl;
}

or, in $cxx11:

<em>for</em> (const char *name : <em>Enum::_names()</em>)
    std::cout << <em>name</em> << std::endl;

constexpr if and only if _to_string is constexpr.

Integer conversion

Better Enums are already represented as integers at run time. Values of the running example type Enum are the same as ints. However, Enum is a distinct type from int during type checking, the main difference being that its range of valid values is restricted to only the ones you have declared.

This section describes the various translations between Enum and int that are available. Each one translates the type, but at run time, most are no-ops, or validity checks followed by no-ops.

typedef _integral

The underlying or representation type of the Better Enum. For example, Enum::_integral is the same type as int. Each Better Enum has the same size and alignment requirement as its representation type.

member constexpr _integral _to_integral() const

No-op conversion of a Better Enum to a value of its representation type. For example,

(+<em>Enum::C</em>)<em>._to_integral</em>() == <em>2</em>

Note that Better Enums are already implicitly convertible to their underlying integral types by default. You may still want to use this function, however, for clarity, and to ensure that your code remains compatible if the strict conversions feature is enabled later.

static constexpr Enum _from_integral(_integral)

Checked conversion of an integer to a Better Enum value. The check runs in time linear in the number of declared constants, but the conversion itself is a no-op. Throws std::runtime_error if the given integer is not the numeric value of one of the declared constants.

<em>Enum::_from_integral</em>(<em>2</em>);    // Enum::C
<em>Enum::_from_integral</em>(<em>42</em>);   // std::runtime_error

static constexpr optional _from_integral_nothrow(_integral)

Checked conversion as _from_integral, but does not throw an exception on failure. Returns an optional value instead.

static constexpr Enum _from_integral_unchecked(_integral)

No-op unchecked conversion of an integer to a Better Enum value. If the given integer is not the numeric value of one of the declared constants, the behavior of all subsequent operations on the Better Enum value is undefined.

This is the direct inverse of _to_integral. Here are no-op round trips between int and Enum:

<em>Enum::_from_integral_unchecked</em>(value.<em>_to_integral</em>());
<em>Enum::_from_integral_unchecked</em>(integer).<em>_to_integral</em>();

You should not use this function on untrusted input, however.

static constexpr bool _is_valid(_integral)

Evaluates to true if and only if the given integer is the numeric value of one of the declared constants. Running time is linear in the number of declared constants.

Stream operators

non-member std::ostream& operator <<(std::ostream&, const Enum&)

Formats the given enum to the given stream in the same way as _to_string.

non-member std::istream& operator >>(std::istream&, Enum&)

Reads from the given stream and attempts to parse an enum value in the same way as _from_string. In case of failure, sets the stream's failbit.

Non-integral underlying type

This section is relevant only if you are using an underlying type that is not an integral type — otherwise, Enum::_underlying is the same as Enum::_integral, and all the functions described here are redundant with their corresponding functions in the section on integer conversions.

That section is written for the simple, but common case where the underlying type is an integral type, in order to avoid overloading users not using the feature described here with unnecessary generality. The information in that section is fully accurate for integral underlying types, but for non-integral underlying types this section corrects it.

The rest of this section will assume that your non-integral underlying type is called Underlying.

In this case, the memory representation of your Better Enum type is the same as for Underlying. In fact, this is always true — the memory representation is always the same as for the underlying type. It is only a matter of whether that type is integral or not.

When Underlying is not integral, Better Enums still needs an integral representation of Underlying for use in switch. That is the true meaning of the member type _integral. It's just that when Underlying is integral to begin with, it is its own integral representation, and the two types collapse.

To support non-integral underlying types, Better Enums requires a two-way mapping between Underlying and some type _integral. In case Underlying is integral, however, that mapping is simply the identity function. Otherwise, you have to supply a mapping as shown here.

In short, the underlying type is "first-class," whether it is integral or not, and the type _integral is a helper type. When Underlying is integral, the various *_integral functions just happen to work with the underlying type, as a special case. The material in this section is for the general case where Underlying is not integral.

typename _underlying

Enum::_underlying is the same type as Underlying. It has to satisfy the requirements given here.

non-member specialization struct better_enums::integral_mapping<Underlying>

You should specialize this template for Underlying, as shown in the example. The specialization needs the following members:

• A type integral_representation, which gives an integral type that Better Enums will use to make Underlying compatible with switch statements, and to define an ordering on the generated Better Enums type. This type is not the internal representation of the Better Enum — the Better Enum's memory representation is the same as Underlying.
• A function constexpr static integral_representation to_integral(const Underlying&).
• A function constexpr static Underlying from_integral(integral_representation).

In $cxx98, the above functions don't have to be constexpr.

You can avoid specializing this template, but its default implementation puts additional requirements on Underlying in order to be able to define default versions of to_integral and from_integral:

• Underlying must have a member type integral_representation, with the same meaning as above.
• Underlying must have a conversion constexpr operator integral_representation() const.
• Underlying must have a constructor constexpr Underlying(integral_representation). This constructor can be explicit.

Again, in $cxx98, these members don't have to be constexpr.

member constexpr _underlying _to_underlying() const

No-op conversion of a Better Enum to its underlying type. Behaves as _to_integral, except that the text concerning implicit conversions is irrelevant when _underlying is not the same as _integral. Implicit conversions, if not disabled, are always to _integral.

static constexpr Enum _from_underlying(_underlying)

Same as _from_integral, but for the underlying type. In fact, from_integral is a wrapper that first converts the integer to a value of the underlying type (a no-op when the types are equal), and then calls _from_underlying.

static constexpr optional _from_underlying_nothrow(_underlying)

Same as _from_integral_nothrow, but for the underlying type. _from_integral_nothrow is a wrapper as described above.

static constexpr Enum _from_underlying_unchecked(_underlying)

Same as _from_integral_unchecked, but for the underlying type. _from_integral_unchecked is a wrapper as described above.

static constexpr bool _is_valid(_underlying)

Replaces _is_valid(_integral). In fact, this function is the only one defined, but in the case where _integral is _underlying, this function's signature is equivalent to _is_valid(_integral).

static constexpr _value_iterable _values — _underlying[]()

Collection of declared enum values, stored in memory as instances of the underlying type.

Replaces _values, the collection of integral values of declared constants. In fact, this is the only member defined — in the case where _integral is the same as _underlying, the definition in the section on integer conversions is equivalent to this one.

member constexpr const _underlying& operator *() const

Returns a reference to the wrapped underlying value. There is also a non-const version.

member constexpr const _underlying* operator ->() const

Returns a pointer to the wrapped underlying value that is suitable for member access, if _underlying has members.

%% class = api

%% description = Detailed description of the Better Enums API.