entitiesdef.h

Go to the documentation of this file.

/*
All original material Copyright (C) 2002-2010 UFO: Alien Invasion.

Copyright (C) 1997-2001 Id Software, Inc.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#ifndef ENITIESDEF_H
# define ENITIESDEF_H

#ifdef __cplusplus
extern "C" {
#endif

# 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_CONCRETE     (ED_OPTIONAL | ED_MANDATORY) 
# define    ED_KEY_TYPE     (ED_TYPE_FLOAT | ED_TYPE_INT | ED_TYPE_STRING)

typedef union int_float_u {
    int i;
    float f;
} int_float_tu;

typedef struct entityKeyRange_s {
    char    *str;       
    int     *iArr;      
    float   *fArr;      
    int     numElements;
    int     continuous; 
} entityKeyRange_t;

typedef struct entityKeyDef_s {
    char    *name;      
    char    *desc;      
    char    *defaultVal;
    int     flags;      
    int     vLen;       
    entityKeyRange_t **ranges; 
    int     numRanges;  
} entityKeyDef_t;

typedef struct entityDef_s {
    char            *classname;
    entityKeyDef_t  *keyDefs;
    int             numKeyDefs;
} entityDef_t;

int ED_GetDefaultFloat(float *defaultBuf, const int n, const entityKeyDef_t *kd);
int ED_GetDefaultInt(int *defaultBuf, const int n, const entityKeyDef_t *kd);
int ED_GetDefaultString(char *defaultBuf, const size_t n, const entityKeyDef_t *kd);

int ED_GetIntVector(const entityKeyDef_t *kd, int v[], const int n);
int ED_Check(const char *classname, const char *key, const char *value);
int ED_CheckKey(const entityKeyDef_t *kd, const char *value);
const entityDef_t *ED_GetEntityDef(const char *classname);
const entityKeyDef_t *ED_GetKeyDef(const char *classname, const char *keyname, const int abstract);
const entityKeyDef_t *ED_GetKeyDefEntity(const entityDef_t *ed, const char *keyname, const int abstract);
int ED_Parse(const char *data_p);
const char *ED_GetLastError(void);
void ED_Free(void);

extern int numEntityDefs;
extern entityDef_t entityDefs[ED_MAX_DEFS + 1];

#ifdef __cplusplus
}
#endif

#endif