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