10.2.1 Creating a parser
10.2.2 Registering a new structure type
10.2.3 Adding a new flag
10.2.4 Adding a new property
10.2.5 Adding a new value list property
10.2.6 Adding a new list property
10.2.7 Adding a sub-structure
10.2.8 Getting a structure type's name
10.2.9 Checking if a property is mandatory
10.2.10 Retrieving the type of a property
Creating a parser
Use this function to create a generic parser. Then you'll specialize this parser by defining the structures it can read.
C++ : TCODParser::TCODParser()
C : TCOD_parser_t TCOD_parser_new()
Py : parser_new()
Example :
C++ : TCODParser myParser();
C : TCOD_parser_t my_parser = TCOD_parser_new();
Py : parser=libtcod.parser_new()
Registering a new structure type
Use this function to register a new structure type.
C++ : TCODParserStruct *TCODParser::newStructure(const char *name)
C : TCOD_parser_struct_t TCOD_parser_new_struct(TCOD_parser_t parser, char *name)
Py : parser_new_struct(parser, name)
| Parameter | Description |
|---|
| parser | In the C version, the parser handler, returned by TCOD_parser_new. |
| name | The name of the structure type (in the example, this would be "item_type"). |
Example :
C++ : TCODParser parser();
TCODParserStruct *itemTypeStruct = parser.newStructrue("item_type");
C : TCOD_parser_t parser = TCOD_parser_new();
TCOD_parser_struct_t item_type_struct = TCOD_parser_new_struct(parser, "item_type");
Py : parser=libtcod.parser_new()
item_type_struct = libtcod.parser_new_struct(parser, "item_type")
Adding a new flag
Use this function to add a flag property to a structure type. A flag is a simplified boolean property. It cannot be mandatory : either it's present and it's true, or it's absent and it's false.
C++ : void TCODParserStruct::addFlag(const char *name)
C : void TCOD_struct_add_flag(TCOD_parser_struct_t str,char *name)
Py : struct_add_flag(str,name)
| Parameter | Description |
|---|
| str | In the C version, the structure handler, returned by TCOD_parser_new_struct. |
| name | The name of the flag (in the example, this would be "abstract"). |
Example :
C++ : itemTypeStruct->addFlag("abstract");
C : TCOD_struct_add_flag(item_type_struct, "abstract");
Py : libtcod.struct_add_flag(item_type_struct, "abstract")
Adding a new property
Use this function to add a standard property to a structure type. Check standard property types here.
C++ : void TCODParserStruct::addProperty(const char *name, TCOD_value_type_t type, bool mandatory)
C : void TCOD_struct_add_property(TCOD_parser_struct_t str, char *name, TCOD_value_type_t type, bool mandatory)
Py : struct_add_property(str, name, type, mandatory)
| Parameter | Description |
|---|
| str | In the C version, the structure handler, returned by TCOD_parser_new_struct. |
| name | The name of the property (in the example, this would be "cost" or "damages" or ...). |
| type | The type of the property. It can be a standard type (see this) or a custom type (see this). |
| mandatory | Is this property mandatory ? If true and the property is not defined in the file, the parser will raise an error. |
Example :
C++ : itemTypeStruct->addProperty("cost",TCOD_TYPE_INT,true);
itemTypeStruct->addProperty("weight",TCOD_TYPE_FLOAT,true);
itemTypeStruct->addProperty("deal_damage",TCOD_TYPE_BOOL,true);
C : TCOD_struct_add_property(item_type_struct, "cost", TCOD_TYPE_INT, true);
TCOD_struct_add_property(item_type_struct, "damages", TCOD_TYPE_DICE, true);
TCOD_struct_add_property(item_type_struct, "color", TCOD_TYPE_COLOR, true);
TCOD_struct_add_property(item_type_struct, "damaged_color", TCOD_TYPE_COLOR, true);
Py : libtcod.struct_add_property(item_type_struct, "cost", libtcod.TYPE_INT, True)
libtcod.struct_add_property(item_type_struct, "damages", libtcod.TYPE_DICE, True)
libtcod.struct_add_property(item_type_struct, "color", libtcod.TYPE_COLOR, True)
libtcod.struct_add_property(item_type_struct, "damaged_color", libtcod.TYPE_COLOR, True)
Adding a new value-list property
A value-list property is a string property for which we define the list of allowed values. The parser will raise an error if the file contains an unauthorized value for this property.
The first value-list property that you add to a structure type will have the TCOD_TYPE_VALUELIST00 type. The next TCOD_TYPE_VALUELIST01. You can define up to 16 value list property for each structure type. The last one has the type TCOD_TYPE_VALUELIST15.
You must provide a value list as a NULL terminated array of strings.
C++ : void TCODParserStruct::addValueList(const char *name, const char **value_list, bool mandatory)
C : void TCOD_struct_add_value_list(TCOD_parser_struct_t str, char *name, char **value_list, bool mandatory)
Py : struct_add_value_list(str, name, value_list, mandatory)
| Parameter | Description |
|---|
| str | In the C version, the structure handler, returned by TCOD_parser_new_struct. |
| name | The name of the property (in the example, this would be "damage_type"). |
| value_list | The list of allowed strings. |
| mandatory | Is this property mandatory ? If true and the property is not defined in the file, the parser will raise an error. |
Example :
C++ : static const char *damageTypes[] = { "slash", "pierce", "bludgeon", NULL }; // note the ending NULL
itemTypeStruct->addValueList("damage_type", damageTypes, true);
C : static const char *damage_types[] = { "slash", "pierce", "bludgeon", NULL };
TCOD_struct_add_value_list(item_type_struct, "damage_type", damage_types, true);
Py : damage_types = [ "slash", "pierce", "bludgeon" ]
litbcod.struct_add_value_list(item_type_struct, "damage_type", damage_types, True)
Adding a new list property
Use this function to add a list property to a structure type.
C++ : void TCODParserStruct::addListProperty(const char *name, TCOD_value_type_t type, bool mandatory)
C : void TCOD_struct_add_list_property(TCOD_parser_struct_t str, char *name, TCOD_value_type_t type, bool mandatory)
Py : struct_add_list_property(str, name, type, mandatory)
| Parameter | Description |
|---|
| str | In the C version, the structure handler, returned by TCOD_parser_new_struct. |
| name | The name of the property (in the example, this would be "cost" or "damages" or ...). |
| type | The type of the list elements. It must be a standard type (see this) or a custom type (see this). It cannot be TCOD_TYPE_LIST. |
| mandatory | Is this property mandatory ? If true and the property is not defined in the file, the parser will raise an error. |
Example :
C++ : itemTypeStruct->addListProperty("intList",TCOD_TYPE_INT,true);
itemTypeStruct->addListProperty("floatList",TCOD_TYPE_FLOAT,true);
itemTypeStruct->addListProperty("stringList",TCOD_TYPE_STRING,true);
C : TCOD_struct_add_list_property(item_type_struct, "intList", TCOD_TYPE_INT, true);
TCOD_struct_add_list_property(item_type_struct, "floatList", TCOD_TYPE_FLOAT, true);
TCOD_struct_add_list_property(item_type_struct, "stringList", TCOD_TYPE_STRING, true);
Py : libtcod.struct_add_list_property(item_type_struct, "intList", libtcod.TYPE_INT, True)
libtcod.struct_add_list_property(item_type_struct, "floatList", libtcod.TYPE_FLOAT, True)
libtcod.struct_add_list_property(item_type_struct, "stringList", libtcod.TYPE_STRING, True)
Adding a sub-structure
A structure can contains others structures. You can tell the parser which structures are allowed inside one structure type with this function.
C++ : void TCODParserStruct::addStructure(TCODParserStruct *sub_structure)
C : void TCOD_struct_add_structure(TCOD_parser_struct_t str, TCOD_parser_struct_t sub_structure)
Py : struct_add_structure(str, sub_structure)
| Parameter | Description |
|---|
| str | In the C version, the structure handler, returned by TCOD_parser_new_struct. |
| sub_structure | The structure type that can be embedded. |
Example :
The item_type structure can contain itself :
C++ : itemTypeStruct->addStructure(itemTypeStruct);
C : TCOD_struct_add_value_list(item_type_struct, item_type_struct);
Py : libtcod.struct_add_value_list(item_type_struct, item_type_struct)
Getting a structure type's name
You can retrieve the name of the structure type with these functions. Warning ! Do not confuse the structure type's name with the structure's name :
item_type "sword" { ... }
Here, the structure type's name is "item_type", the structure name is "sword". Obviously, the structure name cannot be retrieved from the TCODParserStruct object because it's only known at "runtime" (while parsing the file).
C++ : const char *TCODParserStruct::getName() const
C : const char *TCOD_struct_get_name(TCOD_parser_struct_t str)
Py : struct_get_name(str)
Example :
C++ : const char *structName = itemTypeStruct->getName(); // returns "item_type"
C : const char *struct_name = TCOD_struct_get_name(item_type_struct);
Py : struct_name = libtcod.struct_get_name(item_type_struct)
Checking if a property is mandatory
You can know if a property is mandatory :
C++ : bool TCODParserStruct::isPropertyMandatory(const char *name) const
C : bool TCOD_struct_is_mandatory(TCOD_parser_struct_t str,const char *name)
Py : struct_is_mandatory(str,name)
Example :
C++ : bool costMandatory = itemTypeStruct->isPropertyMandatory("cost");
C : bool cost_mandatory = TCOD_struct_is_mandatory(item_type_struct, "cost");
Py : cost_mandatory = libtcod.struct_is_mandatory(item_type_struct, "cost")
Retrieving the type of a property
You get the type of a property :
C++ : TCOD_value_type_t TCODParserStruct::getPropertyType(const char *name) const
C : TCOD_value_type_t TCOD_struct_get_type(TCOD_parser_struct_t str, const char *name)
Py : struct_get_type(str, name)
In the case of a list property, the value returned is a bitwise or of TCOD_TYPE_LIST and the list element's type.
For example, for a list of int, it will return TCOD_TYPE_LIST | TCOD_TYPE_INT.
Example :
C++ : TCOD_value_type_t costType = itemTypeStruct->getPropertyType("cost"); // returns TCOD_TYPE_INT
TCOD_value_type_t intListType = itemTypeStruct->getPropertyType("intList"); // returns TCOD_TYPE_LIST|TCOD_TYPE_INT
C : TCOD_value_type_t cost_type = TCOD_struct_get_type(item_type_struct, "cost");
Py : cost_type = libtcod.struct_get_type(item_type_struct, "cost")
