Handles definition of entities, parsing them from entities.ufo. More...

This graph shows which files directly or indirectly include this file:

Data Structures
union	int_float_tu
struct	entityKeyRange_t
struct	entityKeyDef_t
struct	entityDef_t

Macros
#define	ED_MAX_DEFS 64
#define	ED_ERROR -1
#define	ED_OK 1
#define	ED_OPTIONAL (1<<0)
#define	ED_MANDATORY (1<<1)
#define	ED_ABSTRACT (1<<2)
#define	ED_TYPE_FLOAT (1<<3)
#define	ED_TYPE_INT (1<<4)
#define	ED_TYPE_STRING (1<<5)
#define	ED_DEFAULT (1<<6)
#define	ED_MODE_TYPE (1<<7)
#define	ED_RANGE (1<<8)
#define	ED_INSIST_POSITIVE (1<<9)
#define	ED_TYPE_BOOL (1<<10)
#define	ED_CONCRETE (ED_OPTIONAL \| ED_MANDATORY)
#define	ED_KEY_TYPE (ED_TYPE_FLOAT \| ED_TYPE_INT \| ED_TYPE_STRING \| ED_TYPE_BOOL)

Functions
int	ED_GetIntVector (const entityKeyDef_t *kd, int v[], const int n)
	parses a value from the definition
int	ED_Check (const char classname, const char key, const char *value)
	tests if a value string matches the type for this key. Also checks the value against the range, if one was defined.
int	ED_CheckKey (const entityKeyDef_t kd, const char value)
	as ED_Check, but where the entity and key are known, so takes different arguments.
const entityDef_t *	ED_GetEntityDef (const char *classname)
	searches for the parsed entity def by classname
const entityKeyDef_t *	ED_GetKeyDef (const char classname, const char keyname, const int abstract)
	searches for the parsed key def
const entityKeyDef_t *	ED_GetKeyDefEntity (const entityDef_t ed, const char keyname, const int abstract)
	searches for the parsed key def, when the entity def is known
int	ED_Parse (const char *data_p)
const char *	ED_GetLastError (void)
void	ED_Free (void)

Variables
int	numEntityDefs
entityDef_t	entityDefs [ED_MAX_DEFS+1]

Detailed Description

Handles definition of entities, parsing them from entities.ufo.

Definition in file entitiesdef.h.

Macro Definition Documentation

◆ ED_ABSTRACT

#define ED_ABSTRACT (1<<2)

flag and parse mode, radiant use exclusively, should not be in .map file as a key

Definition at line 37 of file entitiesdef.h.

Referenced by ED_Block2Constant(), ED_Constant2Block(), ED_FindKeyDefInArray(), ED_GetKeyDefEntity(), ED_PairParsed(), and ED_ParseEntities().

◆ ED_CONCRETE

#define ED_CONCRETE (ED_OPTIONAL | ED_MANDATORY)

flags indicating that this is a real key for use in a map file

Definition at line 47 of file entitiesdef.h.

◆ ED_DEFAULT

#define ED_DEFAULT (1<<6)

Definition at line 41 of file entitiesdef.h.

Referenced by ED_Block2Constant(), ED_Constant2Block(), and ED_PairParsed().

◆ ED_ERROR

#define ED_ERROR -1

Definition at line 32 of file entitiesdef.h.

Referenced by Check_InfoStartAligned(), Check_InitEntityDefs(), CheckEntities(), ED_Check(), ED_ParseEntities(), and ED_ParseType().

◆ ED_INSIST_POSITIVE

#define ED_INSIST_POSITIVE (1<<9)

the type insists that the values are unsigned

Definition at line 44 of file entitiesdef.h.

Referenced by ED_CheckNumericType(), ED_ParseType(), and ED_ProcessRanges().

◆ ED_KEY_TYPE

#define ED_KEY_TYPE (ED_TYPE_FLOAT | ED_TYPE_INT | ED_TYPE_STRING | ED_TYPE_BOOL)

Definition at line 48 of file entitiesdef.h.

Referenced by ED_CheckKey(), and ED_ProcessRanges().

◆ ED_MANDATORY

#define ED_MANDATORY (1<<1)

flag and parse mode. for entityKeyDef_t flags. entities of this type are not valid without this key. also a parse mode

Definition at line 36 of file entitiesdef.h.

Referenced by CheckEntities(), ED_Block2Constant(), ED_Constant2Block(), ED_PairParsed(), and ED_ParseEntities().

◆ ED_MAX_DEFS

#define ED_MAX_DEFS 64

Definition at line 30 of file entitiesdef.h.

Referenced by ED_ParseEntities().

◆ ED_MODE_TYPE

#define ED_MODE_TYPE (1<<7)

flag parse mode indicating that a type is being parsed

Definition at line 42 of file entitiesdef.h.

Referenced by ED_Block2Constant(), ED_Constant2Block(), and ED_PairParsed().

◆ ED_OK

#define ED_OK 1

Definition at line 33 of file entitiesdef.h.

Referenced by ED_AllocEntityDef(), ED_AllocRange(), ED_CheckDefaultTypes(), ED_CheckKey(), ED_CheckNumber(), ED_CheckNumericType(), ED_CheckRange(), ED_GetIntVector(), ED_GetIntVectorFromString(), ED_PairParsed(), ED_Parse(), ED_ParseEntities(), ED_ParseType(), ED_ProcessRanges(), and TEST_F().

◆ ED_OPTIONAL

#define ED_OPTIONAL (1<<0)

flag and parse mode

Definition at line 35 of file entitiesdef.h.

Referenced by ED_Block2Constant(), ED_Constant2Block(), and ED_PairParsed().

◆ ED_RANGE

#define ED_RANGE (1<<8)

Definition at line 43 of file entitiesdef.h.

Referenced by ED_Block2Constant(), ED_Constant2Block(), and ED_PairParsed().

◆ ED_TYPE_BOOL

#define ED_TYPE_BOOL (1<<10)

Definition at line 45 of file entitiesdef.h.

Referenced by ED_CheckKey(), ED_CheckNumber(), ED_CheckNumericType(), ED_CheckRange(), ED_Constant2Type(), ED_ProcessRanges(), and ED_Type2Constant().

◆ ED_TYPE_FLOAT

#define ED_TYPE_FLOAT (1<<3)

Definition at line 38 of file entitiesdef.h.

Referenced by ED_CheckKey(), ED_CheckNumber(), ED_CheckNumericType(), ED_CheckRange(), ED_Constant2Type(), ED_ProcessRanges(), and ED_Type2Constant().

◆ ED_TYPE_INT

#define ED_TYPE_INT (1<<4)

Definition at line 39 of file entitiesdef.h.

Referenced by ED_CheckKey(), ED_CheckNumber(), ED_CheckNumericType(), ED_CheckRange(), ED_Constant2Type(), ED_ParseType(), ED_ProcessRanges(), and ED_Type2Constant().

◆ ED_TYPE_STRING

#define ED_TYPE_STRING (1<<5)

Definition at line 40 of file entitiesdef.h.

Referenced by ED_CheckKey(), ED_Constant2Type(), ED_ParseType(), ED_ProcessRanges(), and ED_Type2Constant().

Function Documentation

◆ ED_Check()

int ED_Check	(	const char *	classname,
		const char *	key,
		const char *	value )

tests if a value string matches the type for this key. Also checks the value against the range, if one was defined.

Returns: ED_OK or ED_ERROR

See also: ED_GetLastError

Note: abstract (radiant) keys may not have types. keys used here must be declared in entities.ufo in an optional or mandatory block.

Definition at line 357 of file entitiesdef.cpp.

References ED_CheckKey(), ED_ERROR, ED_GetKeyDef(), and key.

◆ ED_CheckKey()

int ED_CheckKey	(	const entityKeyDef_t *	kd,
		const char *	value )

as ED_Check, but where the entity and key are known, so takes different arguments.

Returns: ED_ERROR or ED_OK

See also: ED_GetLastError

Definition at line 372 of file entitiesdef.cpp.

References ED_CheckNumericType(), ED_KEY_TYPE, ED_OK, ED_RETURN_ERROR, ED_TEST_RETURN_ERROR, ED_TYPE_BOOL, ED_TYPE_FLOAT, ED_TYPE_INT, ED_TYPE_STRING, and entityKeyDef_t::flags.

Referenced by CheckEntities(), ED_Check(), and ED_CheckDefaultTypes().

◆ ED_Free()

void ED_Free ( void )

Definition at line 827 of file entitiesdef.cpp.

References entityDefs, entityKeyRange_t::fArr, i, entityKeyRange_t::iArr, entityKeyDef_t::name, numEntityDefs, and entityKeyRange_t::str.

Referenced by Check_Free(), and TEST_F().

◆ ED_GetEntityDef()

const entityDef_t * ED_GetEntityDef ( const char * classname )

searches for the parsed entity def by classname

Returns: nullptr if the entity def is not found. call ED_GetLastError to get a relevant message.

Definition at line 815 of file entitiesdef.cpp.

References entityDef_t::classname, entityDefs, lastErr, entityDef_t::numKeyDefs, and Q_streq.

Referenced by CheckEntities(), ED_GetKeyDef(), and ED_ParseEntities().

◆ ED_GetIntVector()

int ED_GetIntVector	(	const entityKeyDef_t *	kd,
		int	v[],
		const int	n )

parses a value from the definition

Parameters

	kd	the key definition to parse from
[out]	v	the array of int to put the answer in it must have enough space for n elements.
	n	the number of elements expected in the vector

Returns: ED_ERROR or ED_OK

See also: ED_GetLastError.

Definition at line 208 of file entitiesdef.cpp.

References entityKeyDef_t::desc, ED_GetIntVectorFromString(), ED_OK, ED_PASS_ERROR, and v.

Referenced by Check_InfoStartAligned().

◆ ED_GetKeyDef()

const entityKeyDef_t * ED_GetKeyDef	(	const char *	classname,
		const char *	keyname,
		const int	abstract )

searches for the parsed key def

Parameters

classname	The name, eg. "func_door"
keyname	The key we are looking for
abstract	send abstract to find an abstract key with this name

Returns: nullptr if the entity def or key def is not found. call ED_GetLastError to get a relevant message.

Definition at line 775 of file entitiesdef.cpp.

References ED_GetEntityDef(), and ED_GetKeyDefEntity().

Referenced by ED_Check().

◆ ED_GetKeyDefEntity()

const entityKeyDef_t * ED_GetKeyDefEntity	(	const entityDef_t *	ed,
		const char *	keyname,
		const int	abstract )

searches for the parsed key def, when the entity def is known

Parameters

ed	The list of keys for the entity
keyname	The key we are looking for
abstract	send a nonzero value if the abstract (radiant - not in any block) version of the key is required

Returns: nullptr if the entity def or key def is not found. call ED_GetLastError to get a relevant message.

Definition at line 789 of file entitiesdef.cpp.

References entityDef_t::classname, ED_ABSTRACT, entityKeyDef_t::flags, entityDef_t::keyDefs, lastErr, entityKeyDef_t::name, and Q_streq.

Referenced by Check_InfoStartAligned(), CheckEntities(), and ED_GetKeyDef().

◆ ED_GetLastError()

const char * ED_GetLastError ( void )

Definition at line 763 of file entitiesdef.cpp.

References lastErr.

Referenced by Check_InfoStartAligned(), Check_InitEntityDefs(), and CheckEntities().

◆ ED_Parse()

int ED_Parse ( const char * data_p )

parses entity definitions from entities.ufo

Returns: ED_OK or ED_ERR

See also: ED_GetLastErr

Definition at line 738 of file entitiesdef.cpp.

References ED_CheckDefaultTypes(), ED_OK, ED_ParseEntities(), ED_PASS_ERROR, ED_ProcessRanges(), ED_TEST_RETURN_ERROR, entityDefs, lastErr, numEntityDefs, and OBJZERO.

Referenced by Check_InitEntityDefs(), and TEST_F().

Variable Documentation

◆ entityDefs

entityDef_t entityDefs[ED_MAX_DEFS+1]

extern

Definition at line 46 of file entitiesdef.cpp.

Referenced by Check_Stats(), ED_AllocEntityDef(), ED_CheckDefaultTypes(), ED_Free(), ED_GetEntityDef(), ED_Parse(), ED_ProcessRanges(), and TEST_F().

◆ numEntityDefs

int numEntityDefs

extern

Definition at line 45 of file entitiesdef.cpp.

Referenced by Check_InitEntityDefs(), Check_Stats(), ED_Free(), ED_Parse(), ED_ParseEntities(), and TEST_F().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ED_ABSTRACT

◆ ED_CONCRETE

◆ ED_DEFAULT

◆ ED_ERROR

◆ ED_INSIST_POSITIVE

◆ ED_KEY_TYPE

◆ ED_MANDATORY

◆ ED_MAX_DEFS

◆ ED_MODE_TYPE

◆ ED_OK

◆ ED_OPTIONAL

◆ ED_RANGE

◆ ED_TYPE_BOOL

◆ ED_TYPE_FLOAT

◆ ED_TYPE_INT

◆ ED_TYPE_STRING

Function Documentation

◆ ED_Check()

◆ ED_CheckKey()

◆ ED_Free()

◆ ED_GetEntityDef()

◆ ED_GetIntVector()

◆ ED_GetKeyDef()

◆ ED_GetKeyDefEntity()

◆ ED_GetLastError()

◆ ED_Parse()

Variable Documentation

◆ entityDefs

◆ numEntityDefs