RNA_types.h

Go to the documentation of this file.

/*
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
/* Use a define instead of `#pragma once` because of `BKE_addon.h`, `ED_object.h` & others. */
#ifndef __RNA_TYPES_H__
#define __RNA_TYPES_H__
 
#include "../blenlib/BLI_sys_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct BlenderRNA;
struct FunctionRNA;
struct ID;
struct Main;
struct ParameterList;
struct PropertyRNA;
struct ReportList;
struct StructRNA;
struct bContext;
 
typedef struct PointerRNA {
  struct ID *owner_id;
  struct StructRNA *type;
  void *data;
} PointerRNA;
 
typedef struct PropertyPointerRNA {
  PointerRNA ptr;
  struct PropertyRNA *prop;
} PropertyPointerRNA;
 
typedef struct PathResolvedRNA {
  struct PointerRNA ptr;
  struct PropertyRNA *prop;
  int prop_index;
} PathResolvedRNA;
 
/* Property */
 
typedef enum PropertyType {
  PROP_BOOLEAN = 0,
  PROP_INT = 1,
  PROP_FLOAT = 2,
  PROP_STRING = 3,
  PROP_ENUM = 4,
  PROP_POINTER = 5,
  PROP_COLLECTION = 6,
} PropertyType;
 
/* also update rna_property_subtype_unit when you change this */
typedef enum PropertyUnit {
  PROP_UNIT_NONE = (0 << 16),
  PROP_UNIT_LENGTH = (1 << 16),       /* m */
  PROP_UNIT_AREA = (2 << 16),         /* m^2 */
  PROP_UNIT_VOLUME = (3 << 16),       /* m^3 */
  PROP_UNIT_MASS = (4 << 16),         /* kg */
  PROP_UNIT_ROTATION = (5 << 16),     /* radians */
  PROP_UNIT_TIME = (6 << 16),         /* frame */
  PROP_UNIT_VELOCITY = (7 << 16),     /* m/s */
  PROP_UNIT_ACCELERATION = (8 << 16), /* m/(s^2) */
  PROP_UNIT_CAMERA = (9 << 16),       /* mm */
  PROP_UNIT_POWER = (10 << 16),       /* W */
  PROP_UNIT_TEMPERATURE = (11 << 16), /* C */
} PropertyUnit;
 
#define RNA_SUBTYPE_UNIT(subtype) ((subtype)&0x00FF0000)
#define RNA_SUBTYPE_VALUE(subtype) ((subtype) & ~0x00FF0000)
#define RNA_SUBTYPE_UNIT_VALUE(subtype) ((subtype) >> 16)
 
#define RNA_ENUM_BITFLAG_SIZE 32
 
#define RNA_TRANSLATION_PREC_DEFAULT 5
 
#define RNA_STACK_ARRAY 32
 
typedef enum PropertySubType {
  PROP_NONE = 0,
 
  /* strings */
  PROP_FILEPATH = 1,
  PROP_DIRPATH = 2,
  PROP_FILENAME = 3,
  PROP_BYTESTRING = 4,
  /* 5 was used by "PROP_TRANSLATE" sub-type, which is now a flag. */
  PROP_PASSWORD = 6,
 
  /* numbers */
  PROP_PIXEL = 12,
  PROP_UNSIGNED = 13,
  PROP_PERCENTAGE = 14,
  PROP_FACTOR = 15,
  PROP_ANGLE = 16 | PROP_UNIT_ROTATION,
  PROP_TIME = 17 | PROP_UNIT_TIME,
  PROP_DISTANCE = 18 | PROP_UNIT_LENGTH,
  PROP_DISTANCE_CAMERA = 19 | PROP_UNIT_CAMERA,
 
  /* number arrays */
  PROP_COLOR = 20,
  PROP_TRANSLATION = 21 | PROP_UNIT_LENGTH,
  PROP_DIRECTION = 22,
  PROP_VELOCITY = 23 | PROP_UNIT_VELOCITY,
  PROP_ACCELERATION = 24 | PROP_UNIT_ACCELERATION,
  PROP_MATRIX = 25,
  PROP_EULER = 26 | PROP_UNIT_ROTATION,
  PROP_QUATERNION = 27,
  PROP_AXISANGLE = 28,
  PROP_XYZ = 29,
  PROP_XYZ_LENGTH = 29 | PROP_UNIT_LENGTH,
  PROP_COLOR_GAMMA = 30,
  PROP_COORDS = 31,
 
  /* booleans */
  PROP_LAYER = 40,
  PROP_LAYER_MEMBER = 41,
 
  PROP_POWER = 42 | PROP_UNIT_POWER,
 
  /* temperature */
  PROP_TEMPERATURE = 43 | PROP_UNIT_TEMPERATURE,
} PropertySubType;
 
/* Make sure enums are updated with these */
/* HIGHEST FLAG IN USE: 1 << 31
 * FREE FLAGS: 2, 9, 11, 13, 14, 15, 30 */
typedef enum PropertyFlag {
  PROP_EDITABLE = (1 << 0),
  PROP_LIB_EXCEPTION = (1 << 16),
  PROP_ANIMATABLE = (1 << 1),
  PROP_TEXTEDIT_UPDATE = (1u << 31),
 
  /* icon */
  PROP_ICONS_CONSECUTIVE = (1 << 12),
  PROP_ICONS_REVERSE = (1 << 8),
 
  PROP_HIDDEN = (1 << 19),
  PROP_SKIP_SAVE = (1 << 28),
 
  /* numbers */
 
  PROP_PROPORTIONAL = (1 << 26),
 
  /* pointers */
  PROP_ID_REFCOUNT = (1 << 6),
 
  PROP_ID_SELF_CHECK = (1 << 20),
  PROP_NEVER_NULL = (1 << 18),
  PROP_NEVER_UNLINK = (1 << 25),
 
  PROP_PTR_NO_OWNERSHIP = (1 << 7),
 
  PROP_ENUM_FLAG = (1 << 21),
 
  /* need context for update function */
  PROP_CONTEXT_UPDATE = (1 << 22),
  PROP_CONTEXT_PROPERTY_UPDATE = PROP_CONTEXT_UPDATE | (1 << 27),
 
  /* registering */
  PROP_REGISTER = (1 << 4),
  PROP_REGISTER_OPTIONAL = PROP_REGISTER | (1 << 5),
 
  PROP_THICK_WRAP = (1 << 23),
 
  PROP_IDPROPERTY = (1 << 10),
  PROP_DYNAMIC = (1 << 17),
  PROP_ENUM_NO_CONTEXT = (1 << 24),
  PROP_ENUM_NO_TRANSLATE = (1 << 29),
 
  PROP_NO_DEG_UPDATE = (1 << 30),
} PropertyFlag;
 
typedef enum PropertyOverrideFlag {
  PROPOVERRIDE_OVERRIDABLE_LIBRARY = (1 << 0),
 
  PROPOVERRIDE_NO_COMPARISON = (1 << 1),
 
  PROPOVERRIDE_IGNORE = (1 << 2),
 
  /*** Collections-related ***/
 
  PROPOVERRIDE_LIBRARY_INSERTION = (1 << 10),
 
  PROPOVERRIDE_NO_PROP_NAME = (1 << 11),
} PropertyOverrideFlag;
 
typedef enum ParameterFlag {
  PARM_REQUIRED = (1 << 0),
  PARM_OUTPUT = (1 << 1),
  PARM_RNAPTR = (1 << 2),
  PARM_PYFUNC_OPTIONAL = (1 << 3),
} ParameterFlag;
 
struct CollectionPropertyIterator;
struct Link;
typedef int (*IteratorSkipFunc)(struct CollectionPropertyIterator *iter, void *data);
 
typedef struct ListBaseIterator {
  struct Link *link;
  int flag;
  IteratorSkipFunc skip;
} ListBaseIterator;
 
typedef struct ArrayIterator {
  char *ptr;
  char *endptr;
  void *free_ptr;
  int itemsize;
 
  int length;
 
  IteratorSkipFunc skip;
} ArrayIterator;
 
typedef struct CountIterator {
  void *ptr;
  int item;
} CountIterator;
 
typedef struct CollectionPropertyIterator {
  /* internal */
  PointerRNA parent;
  PointerRNA builtin_parent;
  struct PropertyRNA *prop;
  union {
    ArrayIterator array;
    ListBaseIterator listbase;
    CountIterator count;
    void *custom;
  } internal;
  int idprop;
  int level;
 
  /* external */
  PointerRNA ptr;
  int valid;
} CollectionPropertyIterator;
 
typedef struct CollectionPointerLink {
  struct CollectionPointerLink *next, *prev;
  PointerRNA ptr;
} CollectionPointerLink;
 
typedef struct CollectionListBase {
  struct CollectionPointerLink *first, *last;
} CollectionListBase;
 
typedef enum RawPropertyType {
  PROP_RAW_UNSET = -1,
  PROP_RAW_INT, /* XXX - abused for types that are not set, eg. MFace.verts, needs fixing. */
  PROP_RAW_SHORT,
  PROP_RAW_CHAR,
  PROP_RAW_BOOLEAN,
  PROP_RAW_DOUBLE,
  PROP_RAW_FLOAT,
} RawPropertyType;
 
typedef struct RawArray {
  void *array;
  RawPropertyType type;
  int len;
  int stride;
} RawArray;
 
typedef struct EnumPropertyItem {
  int value;
  const char *identifier;
  int icon;
  const char *name;
  const char *description;
} EnumPropertyItem;
 
/* extended versions with PropertyRNA argument */
typedef bool (*BooleanPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*BooleanPropertySetFunc)(struct PointerRNA *ptr,
                                       struct PropertyRNA *prop,
                                       bool value);
typedef void (*BooleanArrayPropertyGetFunc)(struct PointerRNA *ptr,
                                            struct PropertyRNA *prop,
                                            bool *values);
typedef void (*BooleanArrayPropertySetFunc)(struct PointerRNA *ptr,
                                            struct PropertyRNA *prop,
                                            const bool *values);
typedef int (*IntPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*IntPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
typedef void (*IntArrayPropertyGetFunc)(struct PointerRNA *ptr,
                                        struct PropertyRNA *prop,
                                        int *values);
typedef void (*IntArrayPropertySetFunc)(struct PointerRNA *ptr,
                                        struct PropertyRNA *prop,
                                        const int *values);
typedef void (*IntPropertyRangeFunc)(struct PointerRNA *ptr,
                                     struct PropertyRNA *prop,
                                     int *min,
                                     int *max,
                                     int *softmin,
                                     int *softmax);
typedef float (*FloatPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*FloatPropertySetFunc)(struct PointerRNA *ptr,
                                     struct PropertyRNA *prop,
                                     float value);
typedef void (*FloatArrayPropertyGetFunc)(struct PointerRNA *ptr,
                                          struct PropertyRNA *prop,
                                          float *values);
typedef void (*FloatArrayPropertySetFunc)(struct PointerRNA *ptr,
                                          struct PropertyRNA *prop,
                                          const float *values);
typedef void (*FloatPropertyRangeFunc)(struct PointerRNA *ptr,
                                       struct PropertyRNA *prop,
                                       float *min,
                                       float *max,
                                       float *softmin,
                                       float *softmax);
typedef void (*StringPropertyGetFunc)(struct PointerRNA *ptr,
                                      struct PropertyRNA *prop,
                                      char *value);
typedef int (*StringPropertyLengthFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*StringPropertySetFunc)(struct PointerRNA *ptr,
                                      struct PropertyRNA *prop,
                                      const char *value);
typedef int (*EnumPropertyGetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*EnumPropertySetFunc)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
/* same as PropEnumItemFunc */
typedef const EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C,
                                                        PointerRNA *ptr,
                                                        struct PropertyRNA *prop,
                                                        bool *r_free);
 
typedef struct PropertyRNA PropertyRNA;
 
/* Parameter List */
 
typedef struct ParameterList {
  void *data;
 
  struct FunctionRNA *func;
 
  int alloc_size;
 
  int arg_count, ret_count;
} ParameterList;
 
typedef struct ParameterIterator {
  struct ParameterList *parms;
  /* PointerRNA funcptr; */ /*UNUSED*/
  void *data;
  int size, offset;
 
  PropertyRNA *parm;
  int valid;
} ParameterIterator;
 
typedef struct ParameterDynAlloc {
  intptr_t array_tot;
  void *array;
} ParameterDynAlloc;
 
/* Function */
 
typedef enum FunctionFlag {
  FUNC_USE_SELF_ID = (1 << 11),
 
  FUNC_NO_SELF = (1 << 0),
  FUNC_USE_SELF_TYPE = (1 << 1),
 
  /* Pass Main, bContext and/or ReportList. */
  FUNC_USE_MAIN = (1 << 2),
  FUNC_USE_CONTEXT = (1 << 3),
  FUNC_USE_REPORTS = (1 << 4),
 
  /***** Registering of Python subclasses. *****/
  FUNC_REGISTER = (1 << 5),
  FUNC_REGISTER_OPTIONAL = FUNC_REGISTER | (1 << 6),
  FUNC_ALLOW_WRITE = (1 << 12),
 
  /***** Internal flags. *****/
  FUNC_BUILTIN = (1 << 7),
  FUNC_EXPORT = (1 << 8),
  FUNC_RUNTIME = (1 << 9),
  FUNC_FREE_POINTERS = (1 << 10),
} FunctionFlag;
 
typedef void (*CallFunc)(struct bContext *C,
                         struct ReportList *reports,
                         PointerRNA *ptr,
                         ParameterList *parms);
 
typedef struct FunctionRNA FunctionRNA;
 
/* Struct */
 
typedef enum StructFlag {
  STRUCT_ID = (1 << 0),
  STRUCT_ID_REFCOUNT = (1 << 1),
  STRUCT_UNDO = (1 << 2),
 
  /* internal flags */
  STRUCT_RUNTIME = (1 << 3),
  /* STRUCT_GENERATED = (1 << 4), */ /* UNUSED */
  STRUCT_FREE_POINTERS = (1 << 5),
  STRUCT_NO_IDPROPERTIES = (1 << 6),
  STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7),
  STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8),
  STRUCT_PUBLIC_NAMESPACE = (1 << 9),
  STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10),
  STRUCT_NO_CONTEXT_WITHOUT_OWNER_ID = (1 << 11),
} StructFlag;
 
typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);
typedef int (*StructCallbackFunc)(struct bContext *C,
                                  struct PointerRNA *ptr,
                                  struct FunctionRNA *func,
                                  ParameterList *list);
typedef void (*StructFreeFunc)(void *data);
typedef struct StructRNA *(*StructRegisterFunc)(struct Main *bmain,
                                                struct ReportList *reports,
                                                void *data,
                                                const char *identifier,
                                                StructValidateFunc validate,
                                                StructCallbackFunc call,
                                                StructFreeFunc free);
 
typedef void (*StructUnregisterFunc)(struct Main *bmain, struct StructRNA *type);
typedef void **(*StructInstanceFunc)(PointerRNA *ptr);
 
typedef struct StructRNA StructRNA;
 
typedef struct BlenderRNA BlenderRNA;
 
typedef struct ExtensionRNA {
  void *data;
  StructRNA *srna;
  StructCallbackFunc call;
  StructFreeFunc free;
} ExtensionRNA;
 
#ifdef __cplusplus
}
#endif
 
#endif /* __RNA_TYPES_H__ */