Merge from 2.5 r20991 through r21037
[blender.git] / source / blender / makesrna / intern / rna_internal_types.h
index 0c2eedff564c8059be498a82319f11f322abd749..8bae21cca2b1f622e7492b1433d86f341499c7e9 100644 (file)
 #include "DNA_listBase.h"
 
 struct BlenderRNA;
+struct ContainerRNA;
 struct StructRNA;
 struct PropertyRNA;
 struct PointerRNA;
+struct FunctionRNA;
+struct ReportList;
 struct CollectionPropertyIterator;
 struct bContext;
+struct IDProperty;
+struct GHash;
 
 #define RNA_MAX_ARRAY 32
 
@@ -40,7 +45,9 @@ struct bContext;
 
 typedef void (*UpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
 typedef int (*EditableFunc)(struct PointerRNA *ptr);
+typedef struct IDProperty* (*IDPropertiesFunc)(struct PointerRNA *ptr, int create);
 typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
+typedef char *(*StructPathFunc)(struct PointerRNA *ptr);
 
 typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
 typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
@@ -61,7 +68,9 @@ typedef int (*PropStringLengthFunc)(struct PointerRNA *ptr);
 typedef void (*PropStringSetFunc)(struct PointerRNA *ptr, const char *value);
 typedef int (*PropEnumGetFunc)(struct PointerRNA *ptr);
 typedef void (*PropEnumSetFunc)(struct PointerRNA *ptr, int value);
+typedef EnumPropertyItem *(*PropEnumItemFunc)(struct PointerRNA *ptr);
 typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
+typedef StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
 typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
 typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
 typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
@@ -71,6 +80,41 @@ typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
 typedef PointerRNA (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key);
 typedef PointerRNA (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key);
 
+/* Container - generic abstracted container of RNA properties */
+typedef struct ContainerRNA {
+       void *next, *prev;
+
+       struct GHash *prophash;
+       ListBase properties;
+} ContainerRNA;
+
+struct ParameterList {
+       /* storage for parameters */
+       void *data;
+
+       /* function passed at creation time */
+       FunctionRNA *func;
+};
+
+struct FunctionRNA {
+       /* structs are containers of properties */
+       ContainerRNA cont;
+
+       /* unique identifier */
+       const char *identifier;
+       /* various options */
+       int flag;
+
+       /* single line description, displayed in the tooltip for example */
+       const char *description;
+
+       /* callback to execute the function */
+       CallFunc call;
+
+       /* parameter for the return value */
+       PropertyRNA *ret;
+};
+
 struct PropertyRNA {
        struct PropertyRNA *next, *prev;
 
@@ -86,6 +130,8 @@ struct PropertyRNA {
        const char *name;
        /* single line description, displayed in the tooltip for example */
        const char *description;
+       /* icon ID */
+       int icon;
 
        /* property type as it appears to the outside */
        PropertyType type;
@@ -173,6 +219,7 @@ typedef struct EnumPropertyRNA {
 
        PropEnumGetFunc get;
        PropEnumSetFunc set;
+       PropEnumItemFunc itemf;
 
        const EnumPropertyItem *item;
        int totitem;
@@ -185,8 +232,9 @@ typedef struct PointerPropertyRNA {
 
        PropPointerGetFunc get;
        PropPointerSetFunc set;
+       PropPointerTypeFunc typef;
 
-       struct StructRNA *structtype;
+       struct StructRNA *type;
 } PointerPropertyRNA;
 
 typedef struct CollectionPropertyRNA {
@@ -199,18 +247,21 @@ typedef struct CollectionPropertyRNA {
        PropCollectionLengthFunc length;                                /* optional */
        PropCollectionLookupIntFunc lookupint;                  /* optional */
        PropCollectionLookupStringFunc lookupstring;    /* optional */
+       FunctionRNA *add, *remove;
 
-       struct StructRNA *structtype;
+       struct StructRNA *type;
 } CollectionPropertyRNA;
 
 
 /* changes to this struct require updating rna_generate_struct in makesrna.c */
 struct StructRNA {
-       struct StructRNA *next, *prev;
+       /* structs are containers of properties */
+       ContainerRNA cont;
 
        /* python type, this is a subtype of pyrna_struct_Type but used so each struct can have its own type
         * which is useful for subclassing RNA */
        void *py_type;
+       void *blender_type;
        
        /* unique identifier */
        const char *identifier;
@@ -221,6 +272,8 @@ struct StructRNA {
        const char *name;
        /* single line description, displayed in the tooltip for example */
        const char *description;
+       /* icon ID */
+       int icon;
        
        /* property that defines the name */
        PropertyRNA *nameproperty;
@@ -240,8 +293,18 @@ struct StructRNA {
        /* function to give the more specific type */
        StructRefineFunc refine; 
 
-       /* properties of this struct */
-       ListBase properties; 
+       /* function to find path to this struct in an ID */
+       StructPathFunc path; 
+
+       /* function to register/unregister subclasses */
+       StructRegisterFunc reg; 
+       StructUnregisterFunc unreg; 
+
+       /* callback to get id properties */
+       IDPropertiesFunc idproperties;
+
+       /* functions of this struct */
+       ListBase functions; 
 };
 
 /* Blender RNA