add a collection function slot for assignment (not used yet).
[blender.git] / source / blender / makesrna / RNA_access.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_ACCESS_H
26 #define RNA_ACCESS_H
27
28 /** \file RNA_access.h
29  *  \ingroup RNA
30  */
31
32 #include <stdarg.h>
33
34 #include "RNA_types.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct bContext;
41 struct ID;
42 struct ListBase;
43 struct Main;
44 struct ReportList;
45 struct Scene;
46
47 /* Types */
48
49 extern BlenderRNA BLENDER_RNA;
50 extern StructRNA RNA_Action;
51 extern StructRNA RNA_ActionConstraint;
52 extern StructRNA RNA_ActionFCurves;
53 extern StructRNA RNA_ActionGroup;
54 extern StructRNA RNA_ActionGroups;
55 extern StructRNA RNA_ActionPoseMarkers;
56 extern StructRNA RNA_Actuator;
57 extern StructRNA RNA_ActuatorSensor;
58 extern StructRNA RNA_Addon;
59 extern StructRNA RNA_AdjustmentSequence;
60 extern StructRNA RNA_AlwaysSensor;
61 extern StructRNA RNA_AndController;
62 extern StructRNA RNA_AnimData;
63 extern StructRNA RNA_AnimViz;
64 extern StructRNA RNA_AnimVizMotionPaths;
65 extern StructRNA RNA_AnimVizOnionSkinning;
66 extern StructRNA RNA_AnyType;
67 extern StructRNA RNA_Area;
68 extern StructRNA RNA_AreaLamp;
69 extern StructRNA RNA_Armature;
70 extern StructRNA RNA_ArmatureModifier;
71 extern StructRNA RNA_ArmatureSensor;
72 extern StructRNA RNA_ArrayModifier;
73 extern StructRNA RNA_BackgroundImage;
74 extern StructRNA RNA_BevelModifier;
75 extern StructRNA RNA_BezierSplinePoint;
76 extern StructRNA RNA_BlendData;
77 extern StructRNA RNA_BlendTexture;
78 extern StructRNA RNA_BlenderRNA;
79 extern StructRNA RNA_BoidRule;
80 extern StructRNA RNA_BoidRuleAverageSpeed;
81 extern StructRNA RNA_BoidRuleAvoid;
82 extern StructRNA RNA_BoidRuleAvoidCollision;
83 extern StructRNA RNA_BoidRuleFight;
84 extern StructRNA RNA_BoidRuleFollowLeader;
85 extern StructRNA RNA_BoidRuleGoal;
86 extern StructRNA RNA_BoidSettings;
87 extern StructRNA RNA_BoidState;
88 extern StructRNA RNA_Bone;
89 extern StructRNA RNA_BoneGroup;
90 extern StructRNA RNA_BooleanModifier;
91 extern StructRNA RNA_BooleanProperty;
92 extern StructRNA RNA_Brush;
93 extern StructRNA RNA_BrushTextureSlot;
94 extern StructRNA RNA_BuildModifier;
95 extern StructRNA RNA_Camera;
96 extern StructRNA RNA_CastModifier;
97 extern StructRNA RNA_ChildOfConstraint;
98 extern StructRNA RNA_ChildParticle;
99 extern StructRNA RNA_ClampToConstraint;
100 extern StructRNA RNA_ClothCollisionSettings;
101 extern StructRNA RNA_ClothModifier;
102 extern StructRNA RNA_ClothSettings;
103 extern StructRNA RNA_CloudsTexture;
104 extern StructRNA RNA_CollectionProperty;
105 extern StructRNA RNA_CollisionModifier;
106 extern StructRNA RNA_CollisionSensor;
107 extern StructRNA RNA_CollisionSettings;
108 extern StructRNA RNA_ColorRamp;
109 extern StructRNA RNA_ColorRampElement;
110 extern StructRNA RNA_ColorSequence;
111 extern StructRNA RNA_CompositorNode;
112 extern StructRNA RNA_CompositorNodeAlphaOver;
113 extern StructRNA RNA_CompositorNodeBilateralblur;
114 extern StructRNA RNA_CompositorNodeBlur;
115 extern StructRNA RNA_CompositorNodeBrightContrast;
116 extern StructRNA RNA_CompositorNodeChannelMatte;
117 extern StructRNA RNA_CompositorNodeChromaMatte;
118 extern StructRNA RNA_CompositorNodeColorMatte;
119 extern StructRNA RNA_CompositorNodeColorSpill;
120 extern StructRNA RNA_CompositorNodeCombHSVA;
121 extern StructRNA RNA_CompositorNodeCombRGBA;
122 extern StructRNA RNA_CompositorNodeCombYCCA;
123 extern StructRNA RNA_CompositorNodeCombYUVA;
124 extern StructRNA RNA_CompositorNodeComposite;
125 extern StructRNA RNA_CompositorNodeCrop;
126 extern StructRNA RNA_CompositorNodeCurveRGB;
127 extern StructRNA RNA_CompositorNodeCurveVec;
128 extern StructRNA RNA_CompositorNodeDBlur;
129 extern StructRNA RNA_CompositorNodeDefocus;
130 extern StructRNA RNA_CompositorNodeDiffMatte;
131 extern StructRNA RNA_CompositorNodeDilateErode;
132 extern StructRNA RNA_CompositorNodeDisplace;
133 extern StructRNA RNA_CompositorNodeDistanceMatte;
134 extern StructRNA RNA_CompositorNodeFilter;
135 extern StructRNA RNA_CompositorNodeFlip;
136 extern StructRNA RNA_CompositorNodeGamma;
137 extern StructRNA RNA_CompositorNodeGlare;
138 extern StructRNA RNA_CompositorNodeHueSat;
139 extern StructRNA RNA_CompositorNodeIDMask;
140 extern StructRNA RNA_CompositorNodeImage;
141 extern StructRNA RNA_CompositorNodeInvert;
142 extern StructRNA RNA_CompositorNodeLensdist;
143 extern StructRNA RNA_CompositorNodeLevels;
144 extern StructRNA RNA_CompositorNodeLumaMatte;
145 extern StructRNA RNA_CompositorNodeMapUV;
146 extern StructRNA RNA_CompositorNodeMapValue;
147 extern StructRNA RNA_CompositorNodeMath;
148 extern StructRNA RNA_CompositorNodeMixRGB;
149 extern StructRNA RNA_CompositorNodeNormal;
150 extern StructRNA RNA_CompositorNodeNormalize;
151 extern StructRNA RNA_CompositorNodeOutputFile;
152 extern StructRNA RNA_CompositorNodePremulKey;
153 extern StructRNA RNA_CompositorNodeRGB;
154 extern StructRNA RNA_CompositorNodeRGBToBW;
155 extern StructRNA RNA_CompositorNodeRLayers;
156 extern StructRNA RNA_CompositorNodeRotate;
157 extern StructRNA RNA_CompositorNodeScale;
158 extern StructRNA RNA_CompositorNodeSepHSVA;
159 extern StructRNA RNA_CompositorNodeSepRGBA;
160 extern StructRNA RNA_CompositorNodeSepYCCA;
161 extern StructRNA RNA_CompositorNodeSepYUVA;
162 extern StructRNA RNA_CompositorNodeSetAlpha;
163 extern StructRNA RNA_CompositorNodeSplitViewer;
164 extern StructRNA RNA_CompositorNodeTexture;
165 extern StructRNA RNA_CompositorNodeTime;
166 extern StructRNA RNA_CompositorNodeTonemap;
167 extern StructRNA RNA_CompositorNodeTranslate;
168 extern StructRNA RNA_CompositorNodeTree;
169 extern StructRNA RNA_CompositorNodeValToRGB;
170 extern StructRNA RNA_CompositorNodeValue;
171 extern StructRNA RNA_CompositorNodeVecBlur;
172 extern StructRNA RNA_CompositorNodeViewer;
173 extern StructRNA RNA_CompositorNodeZcombine;
174 extern StructRNA RNA_ConsoleLine;
175 extern StructRNA RNA_Constraint;
176 extern StructRNA RNA_ConstraintTarget;
177 extern StructRNA RNA_Context;
178 extern StructRNA RNA_ControlFluidSettings;
179 extern StructRNA RNA_Controller;
180 extern StructRNA RNA_CopyLocationConstraint;
181 extern StructRNA RNA_CopyRotationConstraint;
182 extern StructRNA RNA_CopyScaleConstraint;
183 extern StructRNA RNA_CopyTransformsConstraint;
184 extern StructRNA RNA_Curve;
185 extern StructRNA RNA_CurveMap;
186 extern StructRNA RNA_CurveMapPoint;
187 extern StructRNA RNA_CurveMapping;
188 extern StructRNA RNA_CurveModifier;
189 extern StructRNA RNA_CurvePoint;
190 extern StructRNA RNA_DampedTrackConstraint;
191 extern StructRNA RNA_DecimateModifier;
192 extern StructRNA RNA_DelaySensor;
193 extern StructRNA RNA_DisplaceModifier;
194 extern StructRNA RNA_DistortedNoiseTexture;
195 extern StructRNA RNA_DomainFluidSettings;
196 extern StructRNA RNA_DopeSheet;
197 extern StructRNA RNA_Driver;
198 extern StructRNA RNA_DriverTarget;
199 extern StructRNA RNA_DriverVariable;
200 extern StructRNA RNA_DupliObject;
201 extern StructRNA RNA_EdgeSplitModifier;
202 extern StructRNA RNA_EditBone;
203 extern StructRNA RNA_EffectSequence;
204 extern StructRNA RNA_EffectorWeights;
205 extern StructRNA RNA_EnumProperty;
206 extern StructRNA RNA_EnumPropertyItem;
207 extern StructRNA RNA_EnvironmentMap;
208 extern StructRNA RNA_EnvironmentMapTexture;
209 extern StructRNA RNA_Event;
210 extern StructRNA RNA_ExplodeModifier;
211 extern StructRNA RNA_ExpressionController;
212 extern StructRNA RNA_FCurve;
213 extern StructRNA RNA_FCurveSample;
214 extern StructRNA RNA_FModifier;
215 extern StructRNA RNA_FModifierCycles;
216 extern StructRNA RNA_FModifierEnvelope;
217 extern StructRNA RNA_FModifierEnvelopeControlPoint;
218 extern StructRNA RNA_FModifierFunctionGenerator;
219 extern StructRNA RNA_FModifierGenerator;
220 extern StructRNA RNA_FModifierLimits;
221 extern StructRNA RNA_FModifierNoise;
222 extern StructRNA RNA_FModifierPython;
223 extern StructRNA RNA_FModifierStepped;
224 extern StructRNA RNA_FieldSettings;
225 extern StructRNA RNA_FileSelectParams;
226 extern StructRNA RNA_FloatProperty;
227 extern StructRNA RNA_FloorConstraint;
228 extern StructRNA RNA_FluidFluidSettings;
229 extern StructRNA RNA_FluidSettings;
230 extern StructRNA RNA_FluidSimulationModifier;
231 extern StructRNA RNA_FollowPathConstraint;
232 extern StructRNA RNA_Function;
233 extern StructRNA RNA_GPencilFrame;
234 extern StructRNA RNA_GPencilLayer;
235 extern StructRNA RNA_GPencilStroke;
236 extern StructRNA RNA_GPencilStrokePoint;
237 extern StructRNA RNA_GameBooleanProperty;
238 extern StructRNA RNA_GameFloatProperty;
239 extern StructRNA RNA_GameIntProperty;
240 extern StructRNA RNA_GameObjectSettings;
241 extern StructRNA RNA_GameProperty;
242 extern StructRNA RNA_GameSoftBodySettings;
243 extern StructRNA RNA_GameStringProperty;
244 extern StructRNA RNA_GameTimerProperty;
245 extern StructRNA RNA_GlowSequence;
246 extern StructRNA RNA_GreasePencil;
247 extern StructRNA RNA_Group;
248 extern StructRNA RNA_Header;
249 extern StructRNA RNA_HemiLamp;
250 extern StructRNA RNA_Histogram;
251 extern StructRNA RNA_HookModifier;
252 extern StructRNA RNA_ID;
253 extern StructRNA RNA_IKParam;
254 extern StructRNA RNA_Image;
255 extern StructRNA RNA_ImagePaint;
256 extern StructRNA RNA_ImageSequence;
257 extern StructRNA RNA_ImageTexture;
258 extern StructRNA RNA_ImageUser;
259 extern StructRNA RNA_InflowFluidSettings;
260 extern StructRNA RNA_IntProperty;
261 extern StructRNA RNA_Itasc;
262 extern StructRNA RNA_JoystickSensor;
263 extern StructRNA RNA_Key;
264 extern StructRNA RNA_KeyConfig;
265 extern StructRNA RNA_KeyMap;
266 extern StructRNA RNA_KeyMapItem;
267 extern StructRNA RNA_KeyMapItems;
268 extern StructRNA RNA_KeyboardSensor;
269 extern StructRNA RNA_Keyframe;
270 extern StructRNA RNA_KeyingSet;
271 extern StructRNA RNA_KeyingSetInfo;
272 extern StructRNA RNA_KeyingSetPath;
273 extern StructRNA RNA_KeyingSetsAll;
274 extern StructRNA RNA_KinematicConstraint;
275 extern StructRNA RNA_Lamp;
276 extern StructRNA RNA_LampSkySettings;
277 extern StructRNA RNA_LampTextureSlot;
278 extern StructRNA RNA_Lattice;
279 extern StructRNA RNA_LatticeModifier;
280 extern StructRNA RNA_LatticePoint;
281 extern StructRNA RNA_Library;
282 extern StructRNA RNA_LimitDistanceConstraint;
283 extern StructRNA RNA_LimitLocationConstraint;
284 extern StructRNA RNA_LimitRotationConstraint;
285 extern StructRNA RNA_LimitScaleConstraint;
286 extern StructRNA RNA_LockedTrackConstraint;
287 extern StructRNA RNA_Macro;
288 extern StructRNA RNA_MagicTexture;
289 extern StructRNA RNA_MarbleTexture;
290 extern StructRNA RNA_MaskModifier;
291 extern StructRNA RNA_Material;
292 extern StructRNA RNA_MaterialHalo;
293 extern StructRNA RNA_MaterialPhysics;
294 extern StructRNA RNA_MaterialRaytraceMirror;
295 extern StructRNA RNA_MaterialRaytraceTransparency;
296 extern StructRNA RNA_MaterialSlot;
297 extern StructRNA RNA_MaterialStrand;
298 extern StructRNA RNA_MaterialSubsurfaceScattering;
299 extern StructRNA RNA_MaterialTextureSlot;
300 extern StructRNA RNA_MaterialVolume;
301 extern StructRNA RNA_Menu;
302 extern StructRNA RNA_Mesh;
303 extern StructRNA RNA_MeshColor;
304 extern StructRNA RNA_MeshColorLayer;
305 extern StructRNA RNA_MeshDeformModifier;
306 extern StructRNA RNA_MeshEdge;
307 extern StructRNA RNA_MeshFace;
308 extern StructRNA RNA_MeshFloatProperty;
309 extern StructRNA RNA_MeshFloatPropertyLayer;
310 extern StructRNA RNA_MeshIntProperty;
311 extern StructRNA RNA_MeshIntPropertyLayer;
312 extern StructRNA RNA_MeshSticky;
313 extern StructRNA RNA_MeshStringProperty;
314 extern StructRNA RNA_MeshStringPropertyLayer;
315 extern StructRNA RNA_MeshTextureFace;
316 extern StructRNA RNA_MeshTextureFaceLayer;
317 extern StructRNA RNA_MeshVertex;
318 extern StructRNA RNA_MessageSensor;
319 extern StructRNA RNA_MetaBall;
320 extern StructRNA RNA_MetaElement;
321 extern StructRNA RNA_MetaSequence;
322 extern StructRNA RNA_MirrorModifier;
323 extern StructRNA RNA_Modifier;
324 extern StructRNA RNA_MotionPath;
325 extern StructRNA RNA_MotionPathVert;
326 extern StructRNA RNA_MouseSensor;
327 extern StructRNA RNA_MovieSequence;
328 extern StructRNA RNA_MulticamSequence;
329 extern StructRNA RNA_MultiresModifier;
330 extern StructRNA RNA_MusgraveTexture;
331 extern StructRNA RNA_NandController;
332 extern StructRNA RNA_NearSensor;
333 extern StructRNA RNA_NlaStrip;
334 extern StructRNA RNA_NlaTrack;
335 extern StructRNA RNA_Node;
336 extern StructRNA RNA_NodeForLoop;
337 extern StructRNA RNA_NodeGroup;
338 extern StructRNA RNA_NodeLink;
339 extern StructRNA RNA_NodeSocket;
340 extern StructRNA RNA_NodeSocketPanel;
341 extern StructRNA RNA_NodeTree;
342 extern StructRNA RNA_NodeWhileLoop;
343 extern StructRNA RNA_NoiseTexture;
344 extern StructRNA RNA_NorController;
345 extern StructRNA RNA_Object;
346 extern StructRNA RNA_ObjectBase;
347 extern StructRNA RNA_ObstacleFluidSettings;
348 extern StructRNA RNA_Operator;
349 extern StructRNA RNA_OperatorFileListElement;
350 extern StructRNA RNA_OperatorMousePath;
351 extern StructRNA RNA_OperatorProperties;
352 extern StructRNA RNA_OperatorStrokeElement;
353 extern StructRNA RNA_OperatorTypeMacro;
354 extern StructRNA RNA_OrController;
355 extern StructRNA RNA_OutflowFluidSettings;
356 extern StructRNA RNA_PackedFile;
357 extern StructRNA RNA_Paint;
358 extern StructRNA RNA_Panel;
359 extern StructRNA RNA_Particle;
360 extern StructRNA RNA_ParticleBrush;
361 extern StructRNA RNA_ParticleDupliWeight;
362 extern StructRNA RNA_ParticleEdit;
363 extern StructRNA RNA_ParticleFluidSettings;
364 extern StructRNA RNA_ParticleHairKey;
365 extern StructRNA RNA_ParticleInstanceModifier;
366 extern StructRNA RNA_ParticleKey;
367 extern StructRNA RNA_ParticleSettings;
368 extern StructRNA RNA_ParticleSettingsTextureSlot;
369 extern StructRNA RNA_ParticleSystem;
370 extern StructRNA RNA_ParticleSystemModifier;
371 extern StructRNA RNA_ParticleTarget;
372 extern StructRNA RNA_PivotConstraint;
373 extern StructRNA RNA_PluginSequence;
374 extern StructRNA RNA_PluginTexture;
375 extern StructRNA RNA_PointCache;
376 extern StructRNA RNA_PointDensity;
377 extern StructRNA RNA_PointDensityTexture;
378 extern StructRNA RNA_PointLamp;
379 extern StructRNA RNA_PointerProperty;
380 extern StructRNA RNA_Pose;
381 extern StructRNA RNA_PoseBone;
382 extern StructRNA RNA_Property;
383 extern StructRNA RNA_PropertyGroup;
384 extern StructRNA RNA_PropertyGroupItem;
385 extern StructRNA RNA_PropertySensor;
386 extern StructRNA RNA_PythonConstraint;
387 extern StructRNA RNA_PythonController;
388 extern StructRNA RNA_RadarSensor;
389 extern StructRNA RNA_RandomSensor;
390 extern StructRNA RNA_RaySensor;
391 extern StructRNA RNA_Region;
392 extern StructRNA RNA_RenderEngine;
393 extern StructRNA RNA_RenderLayer;
394 extern StructRNA RNA_RenderPass;
395 extern StructRNA RNA_RenderResult;
396 extern StructRNA RNA_RenderSettings;
397 extern StructRNA RNA_RigidBodyJointConstraint;
398 extern StructRNA RNA_SPHFluidSettings;
399 extern StructRNA RNA_Scene;
400 extern StructRNA RNA_SceneGameData;
401 extern StructRNA RNA_SceneRenderLayer;
402 extern StructRNA RNA_SceneSequence;
403 extern StructRNA RNA_SceneObjects;
404 extern StructRNA RNA_Scopes;
405 extern StructRNA RNA_Screen;
406 extern StructRNA RNA_ScrewModifier;
407 extern StructRNA RNA_Sculpt;
408 extern StructRNA RNA_Sensor;
409 extern StructRNA RNA_Sequence;
410 extern StructRNA RNA_SequenceColorBalance;
411 extern StructRNA RNA_SequenceCrop;
412 extern StructRNA RNA_SequenceEditor;
413 extern StructRNA RNA_SequenceElement;
414 extern StructRNA RNA_SequenceProxy;
415 extern StructRNA RNA_SequenceTransform;
416 extern StructRNA RNA_ShaderNode;
417 extern StructRNA RNA_ShaderNodeCameraData;
418 extern StructRNA RNA_ShaderNodeCombineRGB;
419 extern StructRNA RNA_ShaderNodeExtendedMaterial;
420 extern StructRNA RNA_ShaderNodeGeometry;
421 extern StructRNA RNA_ShaderNodeHueSaturation;
422 extern StructRNA RNA_ShaderNodeInvert;
423 extern StructRNA RNA_ShaderNodeMapping;
424 extern StructRNA RNA_ShaderNodeMaterial;
425 extern StructRNA RNA_ShaderNodeMath;
426 extern StructRNA RNA_ShaderNodeMixRGB;
427 extern StructRNA RNA_ShaderNodeNormal;
428 extern StructRNA RNA_ShaderNodeOutput;
429 extern StructRNA RNA_ShaderNodeRGB;
430 extern StructRNA RNA_ShaderNodeRGBCurve;
431 extern StructRNA RNA_ShaderNodeRGBToBW;
432 extern StructRNA RNA_ShaderNodeSeparateRGB;
433 extern StructRNA RNA_ShaderNodeSqueeze;
434 extern StructRNA RNA_ShaderNodeTexture;
435 extern StructRNA RNA_ShaderNodeTree;
436 extern StructRNA RNA_ShaderNodeValToRGB;
437 extern StructRNA RNA_ShaderNodeValue;
438 extern StructRNA RNA_ShaderNodeVectorCurve;
439 extern StructRNA RNA_ShaderNodeVectorMath;
440 extern StructRNA RNA_ShapeKey;
441 extern StructRNA RNA_ShapeKeyBezierPoint;
442 extern StructRNA RNA_ShapeKeyCurvePoint;
443 extern StructRNA RNA_ShapeKeyPoint;
444 extern StructRNA RNA_ShrinkwrapConstraint;
445 extern StructRNA RNA_ShrinkwrapModifier;
446 extern StructRNA RNA_SimpleDeformModifier;
447 extern StructRNA RNA_SmokeCollSettings;
448 extern StructRNA RNA_SmokeDomainSettings;
449 extern StructRNA RNA_SmokeFlowSettings;
450 extern StructRNA RNA_SmokeModifier;
451 extern StructRNA RNA_SmoothModifier;
452 extern StructRNA RNA_SoftBodyModifier;
453 extern StructRNA RNA_SoftBodySettings;
454 extern StructRNA RNA_SolidifyModifier;
455 extern StructRNA RNA_Sound;
456 extern StructRNA RNA_SoundSequence;
457 extern StructRNA RNA_Space;
458 extern StructRNA RNA_SpaceConsole;
459 extern StructRNA RNA_SpaceDopeSheetEditor;
460 extern StructRNA RNA_SpaceFileBrowser;
461 extern StructRNA RNA_SpaceGraphEditor;
462 extern StructRNA RNA_SpaceImageEditor;
463 extern StructRNA RNA_SpaceInfo;
464 extern StructRNA RNA_SpaceLogicEditor;
465 extern StructRNA RNA_SpaceNLA;
466 extern StructRNA RNA_SpaceNodeEditor;
467 extern StructRNA RNA_SpaceOutliner;
468 extern StructRNA RNA_SpaceProperties;
469 extern StructRNA RNA_SpaceSequenceEditor;
470 extern StructRNA RNA_SpaceTextEditor;
471 extern StructRNA RNA_SpaceTimeline;
472 extern StructRNA RNA_SpaceUVEditor;
473 extern StructRNA RNA_SpaceUserPreferences;
474 extern StructRNA RNA_SpaceView3D;
475 extern StructRNA RNA_Speaker;
476 extern StructRNA RNA_SpeedControlSequence;
477 extern StructRNA RNA_Spline;
478 extern StructRNA RNA_SplineIKConstraint;
479 extern StructRNA RNA_SpotLamp;
480 extern StructRNA RNA_StretchToConstraint;
481 extern StructRNA RNA_StringProperty;
482 extern StructRNA RNA_Struct;
483 extern StructRNA RNA_StucciTexture;
484 extern StructRNA RNA_SubsurfModifier;
485 extern StructRNA RNA_SunLamp;
486 extern StructRNA RNA_SurfaceCurve;
487 extern StructRNA RNA_SurfaceModifier;
488 extern StructRNA RNA_TexMapping;
489 extern StructRNA RNA_Text;
490 extern StructRNA RNA_TextBox;
491 extern StructRNA RNA_TextCharacterFormat;
492 extern StructRNA RNA_TextCurve;
493 extern StructRNA RNA_TextLine;
494 extern StructRNA RNA_TextMarker;
495 extern StructRNA RNA_Texture;
496 extern StructRNA RNA_TextureNode;
497 extern StructRNA RNA_TextureNodeBricks;
498 extern StructRNA RNA_TextureNodeChecker;
499 extern StructRNA RNA_TextureNodeCompose;
500 extern StructRNA RNA_TextureNodeCoordinates;
501 extern StructRNA RNA_TextureNodeCurveRGB;
502 extern StructRNA RNA_TextureNodeCurveTime;
503 extern StructRNA RNA_TextureNodeDecompose;
504 extern StructRNA RNA_TextureNodeDistance;
505 extern StructRNA RNA_TextureNodeHueSaturation;
506 extern StructRNA RNA_TextureNodeImage;
507 extern StructRNA RNA_TextureNodeInvert;
508 extern StructRNA RNA_TextureNodeMath;
509 extern StructRNA RNA_TextureNodeMixRGB;
510 extern StructRNA RNA_TextureNodeOutput;
511 extern StructRNA RNA_TextureNodeRGBToBW;
512 extern StructRNA RNA_TextureNodeRotate;
513 extern StructRNA RNA_TextureNodeScale;
514 extern StructRNA RNA_TextureNodeTexture;
515 extern StructRNA RNA_TextureNodeTranslate;
516 extern StructRNA RNA_TextureNodeTree;
517 extern StructRNA RNA_TextureNodeValToNor;
518 extern StructRNA RNA_TextureNodeValToRGB;
519 extern StructRNA RNA_TextureNodeViewer;
520 extern StructRNA RNA_TextureSlot;
521 extern StructRNA RNA_Theme;
522 extern StructRNA RNA_ThemeAudioWindow;
523 extern StructRNA RNA_ThemeBoneColorSet;
524 extern StructRNA RNA_ThemeConsole;
525 extern StructRNA RNA_ThemeDopeSheet;
526 extern StructRNA RNA_ThemeFileBrowser;
527 extern StructRNA RNA_ThemeFontStyle;
528 extern StructRNA RNA_ThemeGraphEditor;
529 extern StructRNA RNA_ThemeImageEditor;
530 extern StructRNA RNA_ThemeInfo;
531 extern StructRNA RNA_ThemeLogicEditor;
532 extern StructRNA RNA_ThemeNLAEditor;
533 extern StructRNA RNA_ThemeNodeEditor;
534 extern StructRNA RNA_ThemeOutliner;
535 extern StructRNA RNA_ThemeProperties;
536 extern StructRNA RNA_ThemeSequenceEditor;
537 extern StructRNA RNA_ThemeStyle;
538 extern StructRNA RNA_ThemeTextEditor;
539 extern StructRNA RNA_ThemeTimeline;
540 extern StructRNA RNA_ThemeUserInterface;
541 extern StructRNA RNA_ThemeUserPreferences;
542 extern StructRNA RNA_ThemeView3D;
543 extern StructRNA RNA_ThemeWidgetColors;
544 extern StructRNA RNA_ThemeWidgetStateColors;
545 extern StructRNA RNA_TimelineMarker;
546 extern StructRNA RNA_Timer;
547 extern StructRNA RNA_ToolSettings;
548 extern StructRNA RNA_TouchSensor;
549 extern StructRNA RNA_TrackToConstraint;
550 extern StructRNA RNA_TransformConstraint;
551 extern StructRNA RNA_TransformSequence;
552 extern StructRNA RNA_UILayout;
553 extern StructRNA RNA_UIListItem;
554 extern StructRNA RNA_UVProjectModifier;
555 extern StructRNA RNA_UVProjector;
556 extern StructRNA RNA_UnitSettings;
557 extern StructRNA RNA_UnknownType;
558 extern StructRNA RNA_UserPreferences;
559 extern StructRNA RNA_UserPreferencesEdit;
560 extern StructRNA RNA_UserPreferencesFilePaths;
561 extern StructRNA RNA_UserPreferencesInput;
562 extern StructRNA RNA_UserPreferencesSystem;
563 extern StructRNA RNA_UserPreferencesView;
564 extern StructRNA RNA_UserSolidLight;
565 extern StructRNA RNA_VectorFont;
566 extern StructRNA RNA_VertexGroup;
567 extern StructRNA RNA_VertexGroupElement;
568 extern StructRNA RNA_VertexPaint;
569 extern StructRNA RNA_VoronoiTexture;
570 extern StructRNA RNA_VoxelData;
571 extern StructRNA RNA_VoxelDataTexture;
572 extern StructRNA RNA_WarpModifier;
573 extern StructRNA RNA_WaveModifier;
574 extern StructRNA RNA_WeightVGEditModifier;
575 extern StructRNA RNA_WeightVGMixModifier;
576 extern StructRNA RNA_WeightVGProximityModifier;
577 extern StructRNA RNA_Window;
578 extern StructRNA RNA_WindowManager;
579 extern StructRNA RNA_WipeSequence;
580 extern StructRNA RNA_WoodTexture;
581 extern StructRNA RNA_World;
582 extern StructRNA RNA_WorldAmbientOcclusion;
583 extern StructRNA RNA_WorldLighting;
584 extern StructRNA RNA_WorldMistSettings;
585 extern StructRNA RNA_WorldStarsSettings;
586 extern StructRNA RNA_WorldTextureSlot;
587 extern StructRNA RNA_XnorController;
588 extern StructRNA RNA_XorController;
589
590 /* Pointer
591  *
592  * These functions will fill in RNA pointers, this can be done in three ways:
593  * - a pointer Main is created by just passing the data pointer
594  * - a pointer to a datablock can be created with the type and id data pointer
595  * - a pointer to data contained in a datablock can be created with the id type
596  *   and id data pointer, and the data type and pointer to the struct itself.
597  *
598  * There is also a way to get a pointer with the information about all structs.
599  */
600
601 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
602 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
603 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
604
605 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
606 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr);
607
608 extern const PointerRNA PointerRNA_NULL;
609
610 /* Structs */
611
612 StructRNA *RNA_struct_find(const char *identifier);
613
614 const char *RNA_struct_identifier(StructRNA *type);
615 const char *RNA_struct_ui_name(StructRNA *type);
616 const char *RNA_struct_ui_description(StructRNA *type);
617 int RNA_struct_ui_icon(StructRNA *type);
618
619 PropertyRNA *RNA_struct_name_property(StructRNA *type);
620 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
621 StructRNA *RNA_struct_base(StructRNA *type);
622
623 int RNA_struct_is_ID(StructRNA *type);
624 int RNA_struct_is_a(StructRNA *type, StructRNA *srna);
625
626 StructRegisterFunc RNA_struct_register(StructRNA *type);
627 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
628 void **RNA_struct_instance(PointerRNA *ptr);
629
630 void *RNA_struct_py_type_get(StructRNA *srna);
631 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
632
633 void *RNA_struct_blender_type_get(StructRNA *srna);
634 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
635
636 struct IDProperty *RNA_struct_idprops(PointerRNA *ptr, int create);
637 int RNA_struct_idprops_check(StructRNA *srna);
638 int RNA_struct_idprops_register_check(StructRNA *type);
639 int RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier);
640
641 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
642 int RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test);
643
644 /* lower level functions for access to type properties */
645 const struct ListBase *RNA_struct_type_properties(StructRNA *srna);
646 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier);
647
648 FunctionRNA *RNA_struct_find_function(PointerRNA *ptr, const char *identifier);
649 const struct ListBase *RNA_struct_type_functions(StructRNA *srna);
650
651 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen);
652
653 /* Properties
654  *
655  * Access to struct properties. All this works with RNA pointers rather than
656  * direct pointers to the data. */
657
658 /* Property Information */
659
660 const char *RNA_property_identifier(PropertyRNA *prop);
661 const char *RNA_property_description(PropertyRNA *prop);
662
663 PropertyType RNA_property_type(PropertyRNA *prop);
664 PropertySubType RNA_property_subtype(PropertyRNA *prop);
665 PropertyUnit RNA_property_unit(PropertyRNA *prop);
666 int RNA_property_flag(PropertyRNA *prop);
667 void *RNA_property_py_data_get(PropertyRNA *prop);
668
669 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
670 int RNA_property_array_check(PropertyRNA *prop);
671 int RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dimension);
672 int RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[]);
673 char RNA_property_array_item_char(PropertyRNA *prop, int index);
674 int RNA_property_array_item_index(PropertyRNA *prop, char name);
675
676 int RNA_property_string_maxlength(PropertyRNA *prop);
677
678 const char *RNA_property_ui_name(PropertyRNA *prop);
679 const char *RNA_property_ui_description(PropertyRNA *prop);
680 int RNA_property_ui_icon(PropertyRNA *prop);
681
682 /* Dynamic Property Information */
683
684 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
685 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
686
687 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
688 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
689
690 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value);
691 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value);
692
693 int RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier);
694 int RNA_enum_bitflag_identifiers(EnumPropertyItem *item, const int value, const char **identifier);
695 int RNA_enum_name(EnumPropertyItem *item, const int value, const char **name);
696 int RNA_enum_description(EnumPropertyItem *item, const int value, const char **description);
697
698 void RNA_property_enum_items(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
699 void RNA_property_enum_items_gettexted(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
700 int RNA_property_enum_value(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
701 int RNA_property_enum_identifier(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
702 int RNA_property_enum_name(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
703 int RNA_property_enum_bitflag_identifiers(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
704
705 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
706 int RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value);
707
708 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
709 int RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index);
710 int RNA_property_editable_flag(PointerRNA *ptr, PropertyRNA *prop); /* without lib check, only checks the flag */
711 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
712 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
713 int RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop); /* slow, use with care */
714
715 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
716 void RNA_property_update_main(struct Main *bmain, struct Scene *scene, PointerRNA *ptr, PropertyRNA *prop);
717 int RNA_property_update_check(struct PropertyRNA *prop);
718
719 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop);
720 void RNA_property_update_cache_flush(struct Main *bmain, struct Scene *scene);
721 void RNA_property_update_cache_free(void);
722
723 /* Property Data */
724
725 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
726 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
727 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
728 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
729 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
730 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
731 int RNA_property_boolean_get_default(PointerRNA *ptr, PropertyRNA *prop);
732 void RNA_property_boolean_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
733 int RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
734
735 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
736 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
737 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
738 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2]);
739 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
740 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
741 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
742 int RNA_property_int_get_default(PointerRNA *ptr, PropertyRNA *prop);
743 void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
744 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
745
746 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
747 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
748 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
749 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2]);
750 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
751 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
752 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
753 float RNA_property_float_get_default(PointerRNA *ptr, PropertyRNA *prop);
754 void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
755 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
756
757 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
758 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
759 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
760 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
761 void RNA_property_string_get_default(PointerRNA *ptr, PropertyRNA *prop, char *value);
762 char *RNA_property_string_get_default_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
763 int RNA_property_string_default_length(PointerRNA *ptr, PropertyRNA *prop);
764
765 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
766 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
767 int RNA_property_enum_get_default(PointerRNA *ptr, PropertyRNA *prop);
768 void *RNA_property_enum_py_data_get(PropertyRNA *prop);
769
770 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
771 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
772 PointerRNA RNA_property_pointer_get_default(PointerRNA *ptr, PropertyRNA *prop);
773
774 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
775 void RNA_property_collection_next(CollectionPropertyIterator *iter);
776 void RNA_property_collection_end(CollectionPropertyIterator *iter);
777 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
778 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr);
779 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
780 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
781 int RNA_property_collection_assign_int(PointerRNA *ptr, PropertyRNA *prop, const int key, PointerRNA *assign_ptr);
782 int RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
783
784 /* efficient functions to set properties for arrays */
785 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array);
786 int RNA_property_collection_raw_get(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
787 int RNA_property_collection_raw_set(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
788 int RNA_raw_type_sizeof(RawPropertyType type);
789 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
790
791
792 /* to create ID property groups */
793 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
794 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
795 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
796 int RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
797 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
798 int RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos);
799
800 /* copy/reset */
801 int RNA_property_copy(PointerRNA *ptr, PointerRNA *fromptr, PropertyRNA *prop, int index);
802 int RNA_property_reset(PointerRNA *ptr, PropertyRNA *prop, int index);
803
804 /* Path
805  *
806  * Experimental method to refer to structs and properties with a string,
807  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
808  *
809  * This provides a way to refer to RNA data while being detached from any
810  * particular pointers, which is useful in a number of applications, like
811  * UI code or Actions, though efficiency is a concern. */
812
813 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
814         int intkey, const char *strkey);
815 char *RNA_path_back(const char *path);
816
817 int RNA_path_resolve(PointerRNA *ptr, const char *path,
818                 PointerRNA *r_ptr, PropertyRNA **r_prop);
819
820 int RNA_path_resolve_full(PointerRNA *ptr, const char *path,
821                 PointerRNA *r_ptr, PropertyRNA **r_prop, int *index);
822
823 char *RNA_path_from_ID_to_struct(PointerRNA *ptr);
824 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
825
826 #if 0
827 /* Dependency
828  *
829  * Experimental code that will generate callbacks for each dependency
830  * between ID types. This may end up being useful for UI
831  * and evaluation code that needs to know such dependencies for correct
832  * redraws and re-evaluations. */
833
834 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
835 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
836
837 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
838 #endif
839
840 /* Quick name based property access
841  *
842  * These are just an easier way to access property values without having to
843  * call RNA_struct_find_property. The names have to exist as RNA properties
844  * for the type in the pointer, if they do not exist an error will be printed.
845  *
846  * There is no support for pointers and collections here yet, these can be 
847  * added when ID properties support them. */
848
849 int RNA_boolean_get(PointerRNA *ptr, const char *name);
850 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
851 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
852 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
853
854 int RNA_int_get(PointerRNA *ptr, const char *name);
855 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
856 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
857 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
858
859 float RNA_float_get(PointerRNA *ptr, const char *name);
860 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
861 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
862 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
863
864 int RNA_enum_get(PointerRNA *ptr, const char *name);
865 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
866 void RNA_enum_set_identifier(PointerRNA *ptr, const char *name, const char *id);
867 int RNA_enum_is_equal(struct bContext *C, PointerRNA *ptr, const char *name, const char *enumname);
868
869 /* lower level functions that don't use a PointerRNA */
870 int RNA_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value);
871 int RNA_enum_id_from_value(EnumPropertyItem *item, int value, const char **identifier);
872 int RNA_enum_icon_from_value(EnumPropertyItem *item, int value, int *icon);
873
874 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
875 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
876 int RNA_string_length(PointerRNA *ptr, const char *name);
877 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
878
879 /**
880  * Retrieve the named property from PointerRNA.
881  */
882 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
883 /* Set the property name of PointerRNA ptr to ptr_value */
884 void RNA_pointer_set(PointerRNA *ptr, const char *name, PointerRNA ptr_value);
885 void RNA_pointer_add(PointerRNA *ptr, const char *name);
886
887 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
888 int RNA_collection_length(PointerRNA *ptr, const char *name);
889 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
890 void RNA_collection_clear(PointerRNA *ptr, const char *name);
891
892 #define RNA_BEGIN(sptr, itemptr, propname) \
893         { \
894                 CollectionPropertyIterator rna_macro_iter; \
895                 for(RNA_collection_begin(sptr, propname, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
896                         PointerRNA itemptr= rna_macro_iter.ptr;
897
898 #define RNA_END \
899                 } \
900                 RNA_property_collection_end(&rna_macro_iter); \
901         }
902
903 #define RNA_PROP_BEGIN(sptr, itemptr, prop) \
904         { \
905                 CollectionPropertyIterator rna_macro_iter; \
906                 for(RNA_property_collection_begin(sptr, prop, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
907                         PointerRNA itemptr= rna_macro_iter.ptr;
908
909 #define RNA_PROP_END \
910                 } \
911                 RNA_property_collection_end(&rna_macro_iter); \
912         }
913
914 #define RNA_STRUCT_BEGIN(sptr, prop) \
915         { \
916                 CollectionPropertyIterator rna_macro_iter; \
917                 for(RNA_property_collection_begin(sptr, RNA_struct_iterator_property(sptr->type), &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
918                         PropertyRNA *prop= rna_macro_iter.ptr.data;
919
920 #define RNA_STRUCT_END \
921                 } \
922                 RNA_property_collection_end(&rna_macro_iter); \
923         }
924
925 /* check if the idproperty exists, for operators */
926 int RNA_property_is_set(PointerRNA *ptr, const char *name);
927 int RNA_property_is_idprop(PropertyRNA *prop);
928
929 /* python compatible string representation of this property, (must be freed!) */
930 char *RNA_property_as_string(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
931 char *RNA_pointer_as_string(struct bContext *C, PointerRNA *ptr);
932
933 /* Function */
934
935 const char *RNA_function_identifier(FunctionRNA *func);
936 const char *RNA_function_ui_description(FunctionRNA *func);
937 int RNA_function_flag(FunctionRNA *func);
938 int RNA_function_defined(FunctionRNA *func);
939
940 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
941 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier);
942 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
943
944 /* Utility */
945
946 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
947 void RNA_parameter_list_free(ParameterList *parms);
948 int  RNA_parameter_list_size(ParameterList *parms);
949 int  RNA_parameter_list_arg_count(ParameterList *parms);
950 int  RNA_parameter_list_ret_count(ParameterList *parms);
951
952 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
953 void RNA_parameter_list_next(ParameterIterator *iter);
954 void RNA_parameter_list_end(ParameterIterator *iter);
955
956 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
957 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
958 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, const void *value);
959 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value);
960 int RNA_parameter_length_get(ParameterList *parms, PropertyRNA *parm);
961 int RNA_parameter_length_get_data(ParameterList *parms, PropertyRNA *parm, void *data);
962 void RNA_parameter_length_set(ParameterList *parms, PropertyRNA *parm, int length);
963 void RNA_parameter_length_set_data(ParameterList *parms, PropertyRNA *parm, void *data, int length);
964
965 int RNA_function_call(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms);
966 int RNA_function_call_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms);
967
968 int RNA_function_call_direct(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...)
969 #ifdef __GNUC__
970 __attribute__ ((format (printf, 5, 6)))
971 #endif
972 ;
973 int RNA_function_call_direct_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...)
974 #ifdef __GNUC__
975 __attribute__ ((format (printf, 5, 6)))
976 #endif
977 ;
978 int RNA_function_call_direct_va(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args);
979 int RNA_function_call_direct_va_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args);
980
981 /* ID */
982
983 short RNA_type_to_ID_code(StructRNA *type);
984 StructRNA *ID_code_to_RNA_type(short idcode);
985
986
987 /* macro which inserts the function name */
988 #ifdef __GNUC__
989 #  define RNA_warning(format, args...) _RNA_warning("%s: " format "\n", __func__, ##args)
990 #else /* MSVC doesnt support variable length args in macros */
991 #  define RNA_warning _RNA_warning
992 #endif
993
994 void _RNA_warning(const char *format, ...)
995 #ifdef __GNUC__
996 __attribute__ ((format (printf, 1, 2)))
997 #endif
998 ;
999
1000 #ifdef __cplusplus
1001 }
1002 #endif
1003
1004 #endif /* RNA_ACCESS_H */