source/blender/makesrna/RNA_types.h

   1 /**
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19  *
  20  * Contributor(s): Blender Foundation (2008).
  21  *
  22  * ***** END GPL LICENSE BLOCK *****
  23  */
  24
  25 #ifndef RNA_TYPES
  26 #define RNA_TYPES
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 struct ParameterList;
  33 struct FunctionRNA;
  34 struct PropertyRNA;
  35 struct StructRNA;
  36 struct BlenderRNA;
  37 struct IDProperty;
  38 struct bContext;
  39 struct ReportList;
  40
  41 /* Pointer
  42  *
  43  * RNA pointers are not a single C pointer but include the type,
  44  * and a pointer to the ID struct that owns the struct, since
  45  * in some cases this information is needed to correctly get/set
  46  * the properties and validate them. */
  47
  48 typedef struct PointerRNA {
  49         struct {
  50                 void *data;
  51         } id;
  52
  53         struct StructRNA *type;
  54         void *data;
  55 } PointerRNA;
  56
  57 /* Property */
  58
  59 typedef enum PropertyType {
  60         PROP_BOOLEAN = 0,
  61         PROP_INT = 1,
  62         PROP_FLOAT = 2,
  63         PROP_STRING = 3,
  64         PROP_ENUM = 4,
  65         PROP_POINTER = 5,
  66         PROP_COLLECTION = 6
  67 } PropertyType;
  68
  69 typedef enum PropertySubType {
  70         PROP_NONE = 0,
  71         PROP_UNSIGNED = 1,
  72         PROP_FILEPATH = 2,
  73         PROP_DIRPATH = 3,
  74         PROP_COLOR = 4,
  75         PROP_VECTOR = 5,
  76         PROP_MATRIX = 6,
  77         PROP_ROTATION = 7,
  78         PROP_NEVER_NULL = 8,
  79         PROP_PERCENTAGE = 9
  80 } PropertySubType;
  81
  82 typedef enum PropertyFlag {
  83         /* editable means the property is editable in the user
  84          * interface, properties are editable by default except
  85          * for pointers and collections. */
  86         PROP_EDITABLE = 1,
  87
  88         /* animateable means the property can be driven by some
  89          * other input, be it animation curves, expressions, ..
  90          * properties are animateable by default except for pointers
  91          * and collections */
  92         PROP_ANIMATEABLE = 2,
  93
  94         /* icon */
  95         PROP_ICONS_CONSECUTIVE = 4096,
  96
  97         /* function paramater flags */
  98         PROP_REQUIRED = 4,
  99         PROP_RETURN = 8,
 100         PROP_RNAPTR = 2048,
 101
 102         /* registering */
 103         PROP_REGISTER = 16,
 104         PROP_REGISTER_OPTIONAL = 16|32,
 105
 106         /* pointers */
 107         PROP_ID_REFCOUNT = 64,
 108
 109         /* internal flags */
 110         PROP_BUILTIN = 128,
 111         PROP_EXPORT = 256,
 112         PROP_RUNTIME = 512,
 113         PROP_IDPROPERTY = 1024,
 114         PROP_RAW_ACCESS = 8192,
 115         PROP_RAW_ARRAY = 16384,
 116         PROP_FREE_POINTERS = 32768
 117 } PropertyFlag;
 118
 119 typedef struct CollectionPropertyIterator {
 120         /* internal */
 121         PointerRNA parent;
 122         PointerRNA builtin_parent;
 123         struct PropertyRNA *prop;
 124         void *internal;
 125         int idprop;
 126         int level;
 127
 128         /* external */
 129         int valid;
 130         PointerRNA ptr;
 131 } CollectionPropertyIterator;
 132
 133 typedef struct CollectionPointerLink {
 134         struct CollectionPointerLink *next, *prev;
 135         PointerRNA ptr;
 136 } CollectionPointerLink;
 137
 138 typedef enum RawPropertyType {
 139         PROP_RAW_CHAR,
 140         PROP_RAW_SHORT,
 141         PROP_RAW_INT,
 142         PROP_RAW_FLOAT,
 143         PROP_RAW_DOUBLE
 144 } RawPropertyType;
 145
 146 typedef struct RawArray {
 147         void *array;
 148         RawPropertyType type;
 149         int len;
 150         int stride;
 151 } RawArray;
 152
 153 typedef struct EnumPropertyItem {
 154         int value;
 155         const char *identifier;
 156         int icon;
 157         const char *name;
 158         const char *description;
 159 } EnumPropertyItem;
 160
 161 typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, int *free);
 162
 163 typedef struct PropertyRNA PropertyRNA;
 164
 165 /* Parameter List */
 166
 167 typedef struct ParameterList {
 168         /* storage for parameters */
 169         void *data;
 170
 171         /* store the parameter count */
 172         int tot;
 173
 174         /* function passed at creation time */
 175         struct FunctionRNA *func;
 176 } ParameterList;
 177
 178 typedef struct ParameterIterator {
 179         struct ParameterList *parms;
 180         PointerRNA funcptr;
 181         void *data;
 182         int size, offset;
 183
 184         PropertyRNA *parm;
 185         int valid;
 186 } ParameterIterator;
 187
 188 /* Function */
 189
 190 typedef enum FunctionFlag {
 191         FUNC_NO_SELF = 1, /* for static functions */
 192         FUNC_USE_CONTEXT = 2,
 193         FUNC_USE_REPORTS = 4,
 194
 195         /* registering */
 196         FUNC_REGISTER = 8,
 197         FUNC_REGISTER_OPTIONAL = 8|16,
 198
 199         /* internal flags */
 200         FUNC_BUILTIN = 128,
 201         FUNC_EXPORT = 256,
 202         FUNC_RUNTIME = 512,
 203         FUNC_FREE_POINTERS = 1024
 204 } FunctionFlag;
 205
 206 typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);
 207
 208 typedef struct FunctionRNA FunctionRNA;
 209
 210 /* Struct */
 211
 212 typedef enum StructFlag {
 213         /* indicates that this struct is an ID struct, and to use refcounting */
 214         STRUCT_ID = 1,
 215         STRUCT_ID_REFCOUNT = 2,
 216
 217         /* internal flags */
 218         STRUCT_RUNTIME = 4,
 219         STRUCT_GENERATED = 8,
 220         STRUCT_FREE_POINTERS = 16
 221 } StructFlag;
 222
 223 typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
 224 typedef int (*StructCallbackFunc)(struct PointerRNA *ptr, struct FunctionRNA *func, ParameterList *list);
 225 typedef void (*StructFreeFunc)(void *data);
 226 typedef struct StructRNA *(*StructRegisterFunc)(const struct bContext *C, struct ReportList *reports, void *data,
 227         StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free);
 228 typedef void (*StructUnregisterFunc)(const struct bContext *C, struct StructRNA *type);
 229
 230 typedef struct StructRNA StructRNA;
 231
 232 /* Blender RNA
 233  *
 234  * Root RNA data structure that lists all struct types. */
 235
 236 typedef struct BlenderRNA BlenderRNA;
 237
 238 /* Extending
 239  *
 240  * This struct must be embedded in *Type structs in
 241  * order to make then definable through RNA. */
 242
 243 typedef struct ExtensionRNA {
 244         void *data;
 245         StructRNA *srna;
 246
 247         int (*call)(PointerRNA *, FunctionRNA *, ParameterList *);
 248         void (*free)(void *data);
 249 } ExtensionRNA;
 250
 251 #ifdef __cplusplus
 252 }
 253 #endif
 254
 255 #endif /* RNA_TYPES */
 256
 257