Porytiles
Loading...
Searching...
No Matches
porytiles::EnumDefinition Struct Reference

The self-contained description a header enum provider needs to scan and validate values. More...

#include <metatile_attribute_schema.hpp>

Collaboration diagram for porytiles::EnumDefinition:
[legend]

Public Member Functions

bool operator== (const EnumDefinition &) const =default
 

Public Attributes

std::string prefix
 
std::uint32_t max_value
 
std::unordered_set< std::string > skipped {}
 
HeaderFormat format {HeaderFormat::either}
 
std::string field_display_name
 

Detailed Description

The self-contained description a header enum provider needs to scan and validate values.

Where ProviderDefinition describes how a field's values are declared in the abstract, an EnumDefinition is the concrete, resolvable form a provider consumes: it adds the field's value cap and a display name for diagnostics, and drops the header path (resolved separately against the project root). It is plain data derived from a ProviderDefinition plus its owning Field via ProviderDefinition::to_enum_definition.

Definition at line 191 of file metatile_attribute_schema.hpp.

Member Function Documentation

◆ operator==()

bool porytiles::EnumDefinition::operator== ( const EnumDefinition ) const
default

Member Data Documentation

◆ field_display_name

std::string porytiles::EnumDefinition::field_display_name

Definition at line 196 of file metatile_attribute_schema.hpp.

◆ format

HeaderFormat porytiles::EnumDefinition::format {HeaderFormat::either}

Definition at line 195 of file metatile_attribute_schema.hpp.

◆ max_value

std::uint32_t porytiles::EnumDefinition::max_value

Definition at line 193 of file metatile_attribute_schema.hpp.

◆ prefix

std::string porytiles::EnumDefinition::prefix

Definition at line 192 of file metatile_attribute_schema.hpp.

◆ skipped

std::unordered_set<std::string> porytiles::EnumDefinition::skipped {}

Definition at line 194 of file metatile_attribute_schema.hpp.


The documentation for this struct was generated from the following file: