1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/*
* ***** 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 *****
*/
/** \file blender/makesrna/intern/rna_internal_types.h
* \ingroup RNA
*/
#ifndef __RNA_INTERNAL_TYPES_H__
#define __RNA_INTERNAL_TYPES_H__
#include "DNA_listBase.h"
#include "RNA_types.h"
struct BlenderRNA;
struct ContainerRNA;
struct StructRNA;
struct PropertyRNA;
struct PointerRNA;
struct FunctionRNA;
struct ReportList;
struct CollectionPropertyIterator;
struct bContext;
struct EnumProperty;
struct IDProperty;
struct GHash;
struct Main;
struct Scene;
#ifdef UNIT_TEST
#define RNA_MAX_ARRAY_LENGTH 64
#else
#define RNA_MAX_ARRAY_LENGTH 32
#endif
#define RNA_MAX_ARRAY_DIMENSION 3
/* store local properties here */
#define RNA_IDP_UI "_RNA_UI"
/* Function Callbacks */
typedef void (*UpdateFunc)(struct Main *main, struct Scene *scene, struct PointerRNA *ptr);
typedef void (*ContextPropUpdateFunc)(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*ContextUpdateFunc)(struct bContext *C, struct PointerRNA *ptr);
typedef int (*EditableFunc)(struct PointerRNA *ptr);
typedef int (*ItemEditableFunc)(struct PointerRNA *ptr, int index);
typedef struct IDProperty* (*IDPropertiesFunc)(struct PointerRNA *ptr, int create);
typedef struct StructRNA *(*StructRefineFunc)(struct PointerRNA *ptr);
typedef char *(*StructPathFunc)(struct PointerRNA *ptr);
typedef int (*PropArrayLengthGetFunc)(struct PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION]);
typedef int (*PropBooleanGetFunc)(struct PointerRNA *ptr);
typedef void (*PropBooleanSetFunc)(struct PointerRNA *ptr, int value);
typedef void (*PropBooleanArrayGetFunc)(struct PointerRNA *ptr, int *values);
typedef void (*PropBooleanArraySetFunc)(struct PointerRNA *ptr, const int *values);
typedef int (*PropIntGetFunc)(struct PointerRNA *ptr);
typedef void (*PropIntSetFunc)(struct PointerRNA *ptr, int value);
typedef void (*PropIntArrayGetFunc)(struct PointerRNA *ptr, int *values);
typedef void (*PropIntArraySetFunc)(struct PointerRNA *ptr, const int *values);
typedef void (*PropIntRangeFunc)(struct PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax);
typedef float (*PropFloatGetFunc)(struct PointerRNA *ptr);
typedef void (*PropFloatSetFunc)(struct PointerRNA *ptr, float value);
typedef void (*PropFloatArrayGetFunc)(struct PointerRNA *ptr, float *values);
typedef void (*PropFloatArraySetFunc)(struct PointerRNA *ptr, const float *values);
typedef void (*PropFloatRangeFunc)(struct PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax);
typedef void (*PropStringGetFunc)(struct PointerRNA *ptr, char *value);
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 bContext *C, struct PointerRNA *ptr,
struct PropertyRNA *prop, int *free);
typedef PointerRNA (*PropPointerGetFunc)(struct PointerRNA *ptr);
typedef StructRNA* (*PropPointerTypeFunc)(struct PointerRNA *ptr);
typedef void (*PropPointerSetFunc)(struct PointerRNA *ptr, const PointerRNA value);
typedef int (*PropPointerPollFunc)(struct PointerRNA *ptr, const PointerRNA value);
typedef void (*PropCollectionBeginFunc)(struct CollectionPropertyIterator *iter, struct PointerRNA *ptr);
typedef void (*PropCollectionNextFunc)(struct CollectionPropertyIterator *iter);
typedef void (*PropCollectionEndFunc)(struct CollectionPropertyIterator *iter);
typedef PointerRNA (*PropCollectionGetFunc)(struct CollectionPropertyIterator *iter);
typedef int (*PropCollectionLengthFunc)(struct PointerRNA *ptr);
typedef int (*PropCollectionLookupIntFunc)(struct PointerRNA *ptr, int key, struct PointerRNA *r_ptr);
typedef int (*PropCollectionLookupStringFunc)(struct PointerRNA *ptr, const char *key, struct PointerRNA *r_ptr);
typedef int (*PropCollectionAssignIntFunc)(struct PointerRNA *ptr, int key, const struct PointerRNA *assign_ptr);
/* extended versions with PropertyRNA argument */
typedef int (*PropBooleanGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*PropBooleanSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
typedef void (*PropBooleanArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
typedef void (*PropBooleanArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
typedef int (*PropIntGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*PropIntSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
typedef void (*PropIntArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values);
typedef void (*PropIntArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values);
typedef void (*PropIntRangeFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
typedef float (*PropFloatGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*PropFloatSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float value);
typedef void (*PropFloatArrayGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values);
typedef void (*PropFloatArraySetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values);
typedef void (*PropFloatRangeFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
typedef void (*PropStringGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value);
typedef int (*PropStringLengthFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*PropStringSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value);
typedef int (*PropEnumGetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop);
typedef void (*PropEnumSetFuncEx)(struct PointerRNA *ptr, struct PropertyRNA *prop, int value);
/* Container - generic abstracted container of RNA properties */
typedef struct ContainerRNA {
void *next, *prev;
struct GHash *prophash;
ListBase properties;
} ContainerRNA;
struct FunctionRNA {
/* structs are containers of properties */
ContainerRNA cont;
/* unique identifier, keep after 'cont' */
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
* note: this is only the C return value, rna functions can have multiple return values */
PropertyRNA *c_ret;
};
struct PropertyRNA {
struct PropertyRNA *next, *prev;
/* magic bytes to distinguish with IDProperty */
int magic;
/* unique identifier */
const char *identifier;
/* various options */
int flag;
/* user readable name */
const char *name;
/* single line description, displayed in the tooltip for example */
const char *description;
/* icon ID */
int icon;
/* context for translation */
const char *translation_context;
/* property type as it appears to the outside */
PropertyType type;
/* subtype, 'interpretation' of the property */
PropertySubType subtype;
/* if non-NULL, overrides arraylength. Must not return 0? */
PropArrayLengthGetFunc getlength;
/* dimension of array */
unsigned int arraydimension;
/* array lengths lengths for all dimensions (when arraydimension > 0) */
unsigned int arraylength[RNA_MAX_ARRAY_DIMENSION];
unsigned int totarraylength;
/* callback for updates on change */
UpdateFunc update;
int noteflag;
/* callback for testing if editable */
EditableFunc editable;
/* callback for testing if array-item editable (if applicable) */
ItemEditableFunc itemeditable;
/* raw access */
int rawoffset;
RawPropertyType rawtype;
/* This is used for accessing props/functions of this property
* any property can have this but should only be used for collections and arrays
* since python will convert int/bool/pointer's */
struct StructRNA *srna; /* attributes attached directly to this collection */
/* python handle to hold all callbacks
* (in a pointer array at the moment, may later be a tuple) */
void *py_data;
};
/* Property Types */
typedef struct BoolPropertyRNA {
PropertyRNA property;
PropBooleanGetFunc get;
PropBooleanSetFunc set;
PropBooleanArrayGetFunc getarray;
PropBooleanArraySetFunc setarray;
PropBooleanGetFuncEx get_ex;
PropBooleanSetFuncEx set_ex;
PropBooleanArrayGetFuncEx getarray_ex;
PropBooleanArraySetFuncEx setarray_ex;
int defaultvalue;
const int *defaultarray;
} BoolPropertyRNA;
typedef struct IntPropertyRNA {
PropertyRNA property;
PropIntGetFunc get;
PropIntSetFunc set;
PropIntArrayGetFunc getarray;
PropIntArraySetFunc setarray;
PropIntRangeFunc range;
PropIntGetFuncEx get_ex;
PropIntSetFuncEx set_ex;
PropIntArrayGetFuncEx getarray_ex;
PropIntArraySetFuncEx setarray_ex;
PropIntRangeFuncEx range_ex;
int softmin, softmax;
int hardmin, hardmax;
int step;
int defaultvalue;
const int *defaultarray;
} IntPropertyRNA;
typedef struct FloatPropertyRNA {
PropertyRNA property;
PropFloatGetFunc get;
PropFloatSetFunc set;
PropFloatArrayGetFunc getarray;
PropFloatArraySetFunc setarray;
PropFloatRangeFunc range;
PropFloatGetFuncEx get_ex;
PropFloatSetFuncEx set_ex;
PropFloatArrayGetFuncEx getarray_ex;
PropFloatArraySetFuncEx setarray_ex;
PropFloatRangeFuncEx range_ex;
float softmin, softmax;
float hardmin, hardmax;
float step;
int precision;
float defaultvalue;
const float *defaultarray;
} FloatPropertyRNA;
typedef struct StringPropertyRNA {
PropertyRNA property;
PropStringGetFunc get;
PropStringLengthFunc length;
PropStringSetFunc set;
PropStringGetFuncEx get_ex;
PropStringLengthFuncEx length_ex;
PropStringSetFuncEx set_ex;
int maxlength; /* includes string terminator! */
const char *defaultvalue;
} StringPropertyRNA;
typedef struct EnumPropertyRNA {
PropertyRNA property;
PropEnumGetFunc get;
PropEnumSetFunc set;
PropEnumItemFunc itemf;
PropEnumGetFuncEx get_ex;
PropEnumSetFuncEx set_ex;
void *py_data; /* store py callback here */
EnumPropertyItem *item;
int totitem;
int defaultvalue;
} EnumPropertyRNA;
typedef struct PointerPropertyRNA {
PropertyRNA property;
PropPointerGetFunc get;
PropPointerSetFunc set;
PropPointerTypeFunc typef;
PropPointerPollFunc poll; /* unlike operators, 'set' can still run if poll fails, used for filtering display */
struct StructRNA *type;
} PointerPropertyRNA;
typedef struct CollectionPropertyRNA {
PropertyRNA property;
PropCollectionBeginFunc begin;
PropCollectionNextFunc next;
PropCollectionEndFunc end; /* optional */
PropCollectionGetFunc get;
PropCollectionLengthFunc length; /* optional */
PropCollectionLookupIntFunc lookupint; /* optional */
PropCollectionLookupStringFunc lookupstring; /* optional */
PropCollectionAssignIntFunc assignint; /* optional */
struct StructRNA *item_type; /* the type of this item */
} CollectionPropertyRNA;
/* changes to this struct require updating rna_generate_struct in makesrna.c */
struct StructRNA {
/* structs are containers of properties */
ContainerRNA cont;
/* unique identifier, keep after 'cont' */
const char *identifier;
/* 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;
/* various options */
int flag;
/* user readable name */
const char *name;
/* single line description, displayed in the tooltip for example */
const char *description;
/* context for translation */
const char *translation_context;
/* icon ID */
int icon;
/* property that defines the name */
PropertyRNA *nameproperty;
/* property to iterate over properties */
PropertyRNA *iteratorproperty;
/* struct this is derivedfrom */
struct StructRNA *base;
/* only use for nested structs, where both the parent and child access
* the same C Struct but nesting is used for grouping properties.
* The parent property is used so we know NULL checks are not needed,
* and that this struct will never exist without its parent */
struct StructRNA *nested;
/* function to give the more specific type */
StructRefineFunc refine;
/* function to find path to this struct in an ID */
StructPathFunc path;
/* function to register/unregister subclasses */
StructRegisterFunc reg;
StructUnregisterFunc unreg;
StructInstanceFunc instance;
/* callback to get id properties */
IDPropertiesFunc idproperties;
/* functions of this struct */
ListBase functions;
};
/* Blender RNA
*
* Root RNA data structure that lists all struct types. */
struct BlenderRNA {
ListBase structs;
};
#define CONTAINER_RNA_ID(cont) (*(const char **)(((ContainerRNA *)(cont))+1))
#endif /* __RNA_INTERNAL_TYPES_H__ */
|