source/blender/makesrna/intern/rna_internal_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_INTERNAL_TYPES
  26 #define RNA_INTERNAL_TYPES
  27
  28 #include "DNA_listBase.h"
  29
  30 struct BlenderRNA;
  31 struct ContainerRNA;
  32 struct StructRNA;
  33 struct PropertyRNA;
  34 struct PointerRNA;
  35 struct FunctionRNA;
  36 struct ReportList;
  37 struct CollectionPropertyIterator;
  38 struct bContext;
  39 struct IDProperty;
  40 struct GHash;
  41
  42 #ifdef UNIT_TEST
  43 #define RNA_MAX_ARRAY_LENGTH 64
  44 #else
  45 #define RNA_MAX_ARRAY_LENGTH 32
  46 #endif
  47
  48 #define RNA_MAX_ARRAY_DIMENSION 3
  49
  50 /* Function Callbacks */
  51
  52 typedef void (*UpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
  53 typedef int (*EditableFunc)(struct PointerRNA *ptr);
  54 typedef struct IDProperty* (*IDPropertiesFunc)(struct PointerRNA *ptr, int create);
  55 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
  56 typedef char *(*StructPathFunc)(struct PointerRNA *ptr);
  57
  58 typedef int (*PropArrayLengthGetFunc)(struct PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION]);
  59 typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
  60 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
  61 typedef void (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int *values);
  62 typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, const int *values);
  63 typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
  64 typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
  65 typedef void (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int *values);
  66 typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, const int *values);
  67 typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max);
  68 typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
  69 typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
  70 typedef void (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, float *values);
  71 typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, const float *values);
  72 typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max);
  73 typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
  74 typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
  75 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
  76 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
  77 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
  78 typedef EnumPropertyItem *(*PropEnumItemFunc)(struct bContext *C, struct PointerRNA *ptr, int *free);
  79 typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
  80 typedef StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
  81 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
  82 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
  83 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
  84 typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
  85 typedef PointerRNA (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
  86 typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
  87 typedef PointerRNA (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key);
  88 typedef PointerRNA (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key);
  89
  90 /* Container - generic abstracted container of RNA properties */
  91 typedef struct ContainerRNA {
  92         void *next, *prev;
  93
  94         struct GHash *prophash;
  95         ListBase properties;
  96 } ContainerRNA;
  97
  98 struct FunctionRNA {
  99         /* structs are containers of properties */
 100         ContainerRNA cont;
 101
 102         /* unique identifier */
 103         const char *identifier;
 104         /* various options */
 105         int flag;
 106
 107         /* single line description, displayed in the tooltip for example */
 108         const char *description;
 109
 110         /* callback to execute the function */
 111         CallFunc call;
 112
 113         /* parameter for the return value */
 114         PropertyRNA *ret;
 115 };
 116
 117 struct PropertyRNA {
 118         struct PropertyRNA *next, *prev;
 119
 120         /* magic bytes to distinguish with IDProperty */
 121         int magic;
 122
 123         /* unique identifier */
 124         const char *identifier;
 125         /* various options */
 126         int flag;
 127
 128         /* user readable name */
 129         const char *name;
 130         /* single line description, displayed in the tooltip for example */
 131         const char *description;
 132         /* icon ID */
 133         int icon;
 134
 135         /* property type as it appears to the outside */
 136         PropertyType type;
 137         /* subtype, 'interpretation' of the property */
 138         PropertySubType subtype;
 139         /* if non-NULL, overrides arraylength. Must not return 0? */
 140         PropArrayLengthGetFunc getlength;
 141         /* dimension of array */
 142         unsigned int arraydimension;
 143         /* array lengths lengths for all dimensions (when arraydimension > 0) */
 144         unsigned int arraylength[RNA_MAX_ARRAY_DIMENSION];
 145         unsigned int totarraylength;
 146
 147         /* callback for updates on change */
 148         UpdateFunc update;
 149         int noteflag;
 150
 151         /* callback for testing if editable/evaluated */
 152         EditableFunc editable;
 153
 154         /* raw access */
 155         int rawoffset;
 156         RawPropertyType rawtype;
 157
 158         /* This is used for accessing props/functions of this property
 159          * any property can have this but should only be used for collections and arrays
 160          * since python will convert int/bool/pointer's */
 161         struct StructRNA *srna; /* attributes attached directly to this collection */
 162 };
 163
 164 /* Property Types */
 165
 166 typedef struct BooleanPropertyRNA {
 167         PropertyRNA property;
 168
 169         PropBooleanGetFunc get;
 170         PropBooleanSetFunc set;
 171
 172         PropBooleanArrayGetFunc getarray;
 173         PropBooleanArraySetFunc setarray;
 174
 175         int defaultvalue;
 176         const int *defaultarray;
 177 } BooleanPropertyRNA;
 178
 179 typedef struct IntPropertyRNA {
 180         PropertyRNA property;
 181
 182         PropIntGetFunc get;
 183         PropIntSetFunc set;
 184
 185         PropIntArrayGetFunc getarray;
 186         PropIntArraySetFunc setarray;
 187
 188         PropIntRangeFunc range;
 189
 190         int softmin, softmax;
 191         int hardmin, hardmax;
 192         int step;
 193
 194         int defaultvalue;
 195         const int *defaultarray;
 196 } IntPropertyRNA;
 197
 198 typedef struct FloatPropertyRNA {
 199         PropertyRNA property;
 200
 201         PropFloatGetFunc get;
 202         PropFloatSetFunc set;
 203
 204         PropFloatArrayGetFunc getarray;
 205         PropFloatArraySetFunc setarray;
 206
 207         PropFloatRangeFunc range;
 208
 209         float softmin, softmax;
 210         float hardmin, hardmax;
 211         float step;
 212         int precision;
 213
 214         float defaultvalue;
 215         const float *defaultarray;
 216 } FloatPropertyRNA;
 217
 218 typedef struct StringPropertyRNA {
 219         PropertyRNA property;
 220
 221         PropStringGetFunc get;
 222         PropStringLengthFunc length;
 223         PropStringSetFunc set;
 224
 225         int maxlength;  /* includes string terminator! */
 226
 227         const char *defaultvalue;
 228 } StringPropertyRNA;
 229
 230 typedef struct EnumPropertyRNA {
 231         PropertyRNA property;
 232
 233         PropEnumGetFunc get;
 234         PropEnumSetFunc set;
 235         PropEnumItemFunc itemf;
 236
 237         EnumPropertyItem *item;
 238         int totitem;
 239
 240         int defaultvalue;
 241 } EnumPropertyRNA;
 242
 243 typedef struct PointerPropertyRNA {
 244         PropertyRNA property;
 245
 246         PropPointerGetFunc get;
 247         PropPointerSetFunc set;
 248         PropPointerTypeFunc typef;
 249
 250         struct StructRNA *type;
 251 } PointerPropertyRNA;
 252
 253 typedef struct CollectionPropertyRNA {
 254         PropertyRNA property;
 255
 256         PropCollectionBeginFunc begin;
 257         PropCollectionNextFunc next;
 258         PropCollectionEndFunc end;                                              /* optional */
 259         PropCollectionGetFunc get;
 260         PropCollectionLengthFunc length;                                /* optional */
 261         PropCollectionLookupIntFunc lookupint;                  /* optional */
 262         PropCollectionLookupStringFunc lookupstring;    /* optional */
 263
 264         struct StructRNA *item_type;                    /* the type of this item */
 265 } CollectionPropertyRNA;
 266
 267
 268 /* changes to this struct require updating rna_generate_struct in makesrna.c */
 269 struct StructRNA {
 270         /* structs are containers of properties */
 271         ContainerRNA cont;
 272
 273         /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
 274          * which is useful for subclassing RNA */
 275         void *py_type;
 276         void *blender_type;
 277
 278         /* unique identifier */
 279         const char *identifier;
 280         /* various options */
 281         int flag;
 282
 283         /* user readable name */
 284         const char *name;
 285         /* single line description, displayed in the tooltip for example */
 286         const char *description;
 287         /* icon ID */
 288         int icon;
 289
 290         /* property that defines the name */
 291         PropertyRNA *nameproperty;
 292
 293         /* property to iterate over properties */
 294         PropertyRNA *iteratorproperty;
 295
 296         /* struct this is derivedfrom */
 297         struct StructRNA *base;
 298
 299         /* only use for nested structs, where both the parent and child access
 300          * the same C Struct but nesting is used for grouping properties.
 301          * The parent property is used so we know NULL checks are not needed,
 302          * and that this struct will never exist without its parent */
 303         struct StructRNA *nested;
 304
 305         /* function to give the more specific type */
 306         StructRefineFunc refine;
 307
 308         /* function to find path to this struct in an ID */
 309         StructPathFunc path;
 310
 311         /* function to register/unregister subclasses */
 312         StructRegisterFunc reg;
 313         StructUnregisterFunc unreg;
 314
 315         /* callback to get id properties */
 316         IDPropertiesFunc idproperties;
 317
 318         /* functions of this struct */
 319         ListBase functions;
 320 };
 321
 322 /* Blender RNA
 323  *
 324  * Root RNA data structure that lists all struct types. */
 325
 326 struct BlenderRNA {
 327         ListBase structs;
 328 };
 329
 330 #endif /* RNA_INTERNAL_TYPES */
 331