RNA_types.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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.
 *
 * Contributor(s): Blender Foundation (2008).
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include "BLO_sys_types.h"

#ifndef RNA_TYPES_H
#define RNA_TYPES_H

#ifdef __cplusplus
extern "C" {
#endif

struct ParameterList;
struct FunctionRNA;
struct PropertyRNA;
struct EnumPropertyRNA;
struct StructRNA;
struct BlenderRNA;
struct IDProperty;
struct bContext;
struct Main;
struct ReportList;

typedef struct PointerRNA {
    struct {
        void *data;
    } id;

    struct StructRNA *type;
    void *data;
} PointerRNA;

typedef struct PropertyPointerRNA {
    PointerRNA ptr;
    struct PropertyRNA *prop;
} PropertyPointerRNA;

/* 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) */
} 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

/* also update enums in bpy_props.c when adding items here
 * watch it: these values are written to files as part of
 * node socket button subtypes!
 */
typedef enum PropertySubType {
    PROP_NONE = 0,

    /* strings */
    PROP_FILEPATH = 1,
    PROP_DIRPATH = 2,
    PROP_FILENAME = 3,
    PROP_BYTESTRING = 4, /* a string which should be represented as bytes
                          * in python, still NULL terminated though. */
    PROP_TRANSLATE = 5, /* a string which should be translated */

    /* numbers */
    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,

    /* 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, /* generic array, no units applied, only that x/y/z/w are used (python vec) */

    /* booleans */
    PROP_LAYER = 40,
    PROP_LAYER_MEMBER = 41
} PropertySubType;

/* Make sure enums are updated with thses */
typedef enum PropertyFlag {
    /* editable means the property is editable in the user
     * interface, properties are editable by default except
     * for pointers and collections. */
    PROP_EDITABLE = 1<<0,

    /* this property is editable even if it is lib linked,
     * meaning it will get lost on reload, but it's useful
     * for editing. */
    PROP_LIB_EXCEPTION = 1<<16,

    /* animateable means the property can be driven by some
     * other input, be it animation curves, expressions, ..
     * properties are animateable by default except for pointers
     * and collections */
    PROP_ANIMATABLE = 1<<1,

    /* icon */
    PROP_ICONS_CONSECUTIVE = 1<<12,

    /* hidden in  the user interface */
    PROP_HIDDEN = 1<<19,
    /* do not write in presets */
    PROP_SKIP_SAVE = 1<<28,

    /* function paramater flags */
    PROP_REQUIRED = 1<<2,
    PROP_OUTPUT = 1<<3,
    PROP_RNAPTR = 1<<11,
    /* registering */
    PROP_REGISTER = 1<<4,
    PROP_REGISTER_OPTIONAL = (1<<4)|(1<<5),

    /* pointers */
    PROP_ID_REFCOUNT = 1<<6,

    /* disallow assigning a variable to its self, eg an object tracking its self
     * only apply this to types that are derived from an ID ()*/
    PROP_ID_SELF_CHECK = 1<<20,
    PROP_NEVER_NULL = 1<<18,
    /* currently only used for UI, this is similar to PROP_NEVER_NULL
     * except that the value may be NULL at times, used for ObData, where an Empty's will be NULL
     * but setting NULL on a mesh object is not possible. So, if its not NULL, setting NULL cant be done! */
    PROP_NEVER_UNLINK = 1<<25,

    /* flag contains multiple enums.
     * note: not to be confused with prop->enumbitflags
     * this exposes the flag as multiple options in python and the UI.
     *
     * note: these can't be animated so use with care.
      */
    PROP_ENUM_FLAG = 1<<21,

    /* need context for update function */
    PROP_CONTEXT_UPDATE = 1<<22,
    PROP_CONTEXT_PROPERTY_UPDATE = (1<<22)|(1<<27),

    /* Use for arrays or for any data that should not have a referene kept
     * most common case is functions that return arrays where the array */
    PROP_THICK_WRAP = 1<<23,

    /* Reject values outside limits, use for python api only so far
     * this is for use when silently clamping string length will give
     * bad behavior later. Could also enforce this for INT's and other types.
     * note: currently no support for function arguments or non utf8 paths (filepaths) */
    PROP_NEVER_CLAMP = 1<<26,

    /* internal flags */
    PROP_BUILTIN = 1<<7,
    PROP_EXPORT = 1<<8,
    PROP_RUNTIME = 1<<9,
    PROP_IDPROPERTY = 1<<10,
    PROP_RAW_ACCESS = 1<<13,
    PROP_RAW_ARRAY = 1<<14,
    PROP_FREE_POINTERS = 1<<15,
    PROP_DYNAMIC = 1<<17, /* for dynamic arrays, and retvals of type string */
    PROP_ENUM_NO_CONTEXT = 1<<24 /* for enum that shouldn't be contextual */
} PropertyFlag;

typedef struct CollectionPropertyIterator {
    /* internal */
    PointerRNA parent;
    PointerRNA builtin_parent;
    struct PropertyRNA *prop;
    void *internal;
    int idprop;
    int level;

    /* external */
    PointerRNA ptr;
    int valid;
} CollectionPropertyIterator;

typedef struct CollectionPointerLink {
    struct CollectionPointerLink *next, *prev;
    PointerRNA ptr;
} CollectionPointerLink;

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_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;

/* this is a copy of 'PropEnumItemFunc' defined in rna_internal_types.h */
typedef EnumPropertyItem *(*EnumPropertyItemFunc)(struct bContext *C, PointerRNA *ptr, struct PropertyRNA *prop, int *free);

typedef struct PropertyRNA PropertyRNA;

/* Parameter List */

typedef struct ParameterList {
    /* storage for parameters */
    void *data;

    /* function passed at creation time */
    struct FunctionRNA *func;

    /* store the parameter size */
    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;

/* mainly to avoid confusing casts */
typedef struct ParameterDynAlloc {
    intptr_t array_tot; /* important, this breaks when set to an int */
    void *array;
} ParameterDynAlloc;

/* Function */

typedef enum FunctionFlag {
    FUNC_NO_SELF = 1, /* for static functions */
    FUNC_USE_MAIN = 2,
    FUNC_USE_CONTEXT = 4,
    FUNC_USE_REPORTS = 8,
    FUNC_USE_SELF_ID = 2048,

    /* registering */
    FUNC_REGISTER = 16,
    FUNC_REGISTER_OPTIONAL = 16|32,

    /* internal flags */
    FUNC_BUILTIN = 128,
    FUNC_EXPORT = 256,
    FUNC_RUNTIME = 512,
    FUNC_FREE_POINTERS = 1024
} FunctionFlag;

typedef void (*CallFunc)(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, ParameterList *parms);

typedef struct FunctionRNA FunctionRNA;

/* Struct */

typedef enum StructFlag {
    /* indicates that this struct is an ID struct, and to use refcounting */
    STRUCT_ID = 1,
    STRUCT_ID_REFCOUNT = 2,
    STRUCT_UNDO = 4, /* defaults on, clear for user preferences and similar */

    /* internal flags */
    STRUCT_RUNTIME = 8,
    STRUCT_GENERATED = 16,
    STRUCT_FREE_POINTERS = 32,
    STRUCT_NO_IDPROPERTIES = 64 /* Menu's and Panels don't need properties */
} 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;

/* Blender RNA
 *
 * Root RNA data structure that lists all struct types. */

typedef struct BlenderRNA BlenderRNA;

/* Extending
 *
 * This struct must be embedded in *Type structs in
 * order to make then definable through RNA. */

typedef struct ExtensionRNA {
    void *data;
    StructRNA *srna;
    StructCallbackFunc call;
    StructFreeFunc free;
    
} ExtensionRNA;

#ifdef __cplusplus
}
#endif

#endif /* RNA_TYPES_H */