Merge branch 'master' into soc-2018-npr Fix errors
[blender.git] / source / blender / makesrna / RNA_access.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __RNA_ACCESS_H__
18 #define __RNA_ACCESS_H__
19
20 /** \file
21  * \ingroup RNA
22  */
23
24 #include <stdarg.h>
25
26 #include "RNA_types.h"
27
28 #include "BLI_compiler_attrs.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct ID;
35 struct IDOverrideStatic;
36 struct IDOverrideStaticProperty;
37 struct IDOverrideStaticPropertyOperation;
38 struct ListBase;
39 struct Main;
40 struct ReportList;
41 struct Scene;
42 struct bContext;
43
44 /* Types */
45 extern BlenderRNA BLENDER_RNA;
46
47 /* Keep sorted. */
48 extern StructRNA RNA_Action;
49 extern StructRNA RNA_ActionConstraint;
50 extern StructRNA RNA_ActionFCurves;
51 extern StructRNA RNA_ActionGroup;
52 extern StructRNA RNA_ActionGroups;
53 extern StructRNA RNA_ActionPoseMarkers;
54 extern StructRNA RNA_Actuator;
55 extern StructRNA RNA_ActuatorSensor;
56 extern StructRNA RNA_Addon;
57 extern StructRNA RNA_AddonPreferences;
58 extern StructRNA RNA_AdjustmentSequence;
59 extern StructRNA RNA_AlwaysSensor;
60 extern StructRNA RNA_AndController;
61 extern StructRNA RNA_AnimData;
62 extern StructRNA RNA_AnimViz;
63 extern StructRNA RNA_AnimVizMotionPaths;
64 extern StructRNA RNA_AnyType;
65 extern StructRNA RNA_Area;
66 extern StructRNA RNA_AreaLight;
67 extern StructRNA RNA_Armature;
68 extern StructRNA RNA_ArmatureGpencilModifier;
69 extern StructRNA RNA_ArmatureModifier;
70 extern StructRNA RNA_ArmatureSensor;
71 extern StructRNA RNA_ArrayGpencilModifier;
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_BoolProperty;
91 extern StructRNA RNA_BooleanModifier;
92 extern StructRNA RNA_Brush;
93 extern StructRNA RNA_BrushCapabilitiesImagePaint;
94 extern StructRNA RNA_BrushCapabilitiesVertexPaint;
95 extern StructRNA RNA_BrushTextureSlot;
96 extern StructRNA RNA_BuildGpencilModifier;
97 extern StructRNA RNA_BuildModifier;
98 extern StructRNA RNA_CacheFile;
99 extern StructRNA RNA_Camera;
100 extern StructRNA RNA_CastModifier;
101 extern StructRNA RNA_ChildOfConstraint;
102 extern StructRNA RNA_ChildParticle;
103 extern StructRNA RNA_ClampToConstraint;
104 extern StructRNA RNA_ClothCollisionSettings;
105 extern StructRNA RNA_ClothModifier;
106 extern StructRNA RNA_ClothSettings;
107 extern StructRNA RNA_CloudsTexture;
108 extern StructRNA RNA_Collection;
109 extern StructRNA RNA_CollectionEngineSettings;
110 extern StructRNA RNA_CollectionProperty;
111 extern StructRNA RNA_CollisionModifier;
112 extern StructRNA RNA_CollisionSensor;
113 extern StructRNA RNA_CollisionSettings;
114 extern StructRNA RNA_ColorGpencilModifier;
115 extern StructRNA RNA_ColorManagedDisplaySettings;
116 extern StructRNA RNA_ColorManagedInputColorspaceSettings;
117 extern StructRNA RNA_ColorManagedSequencerColorspaceSettings;
118 extern StructRNA RNA_ColorManagedViewSettings;
119 extern StructRNA RNA_ColorMixSequence;
120 extern StructRNA RNA_ColorRamp;
121 extern StructRNA RNA_ColorRampElement;
122 extern StructRNA RNA_ColorSequence;
123 extern StructRNA RNA_CompositorNode;
124 extern StructRNA RNA_CompositorNodeAlphaOver;
125 extern StructRNA RNA_CompositorNodeBilateralblur;
126 extern StructRNA RNA_CompositorNodeBlur;
127 extern StructRNA RNA_CompositorNodeBrightContrast;
128 extern StructRNA RNA_CompositorNodeChannelMatte;
129 extern StructRNA RNA_CompositorNodeChromaMatte;
130 extern StructRNA RNA_CompositorNodeColorMatte;
131 extern StructRNA RNA_CompositorNodeColorSpill;
132 extern StructRNA RNA_CompositorNodeCombHSVA;
133 extern StructRNA RNA_CompositorNodeCombRGBA;
134 extern StructRNA RNA_CompositorNodeCombYCCA;
135 extern StructRNA RNA_CompositorNodeCombYUVA;
136 extern StructRNA RNA_CompositorNodeComposite;
137 extern StructRNA RNA_CompositorNodeCornerPin;
138 extern StructRNA RNA_CompositorNodeCrop;
139 extern StructRNA RNA_CompositorNodeCurveRGB;
140 extern StructRNA RNA_CompositorNodeCurveVec;
141 extern StructRNA RNA_CompositorNodeDBlur;
142 extern StructRNA RNA_CompositorNodeDefocus;
143 extern StructRNA RNA_CompositorNodeDiffMatte;
144 extern StructRNA RNA_CompositorNodeDilateErode;
145 extern StructRNA RNA_CompositorNodeDisplace;
146 extern StructRNA RNA_CompositorNodeDistanceMatte;
147 extern StructRNA RNA_CompositorNodeDoubleEdgeMask;
148 extern StructRNA RNA_CompositorNodeFilter;
149 extern StructRNA RNA_CompositorNodeFlip;
150 extern StructRNA RNA_CompositorNodeGamma;
151 extern StructRNA RNA_CompositorNodeGlare;
152 extern StructRNA RNA_CompositorNodeHueSat;
153 extern StructRNA RNA_CompositorNodeIDMask;
154 extern StructRNA RNA_CompositorNodeImage;
155 extern StructRNA RNA_CompositorNodeInpaint;
156 extern StructRNA RNA_CompositorNodeInvert;
157 extern StructRNA RNA_CompositorNodeLensdist;
158 extern StructRNA RNA_CompositorNodeLevels;
159 extern StructRNA RNA_CompositorNodeLumaMatte;
160 extern StructRNA RNA_CompositorNodeMapRange;
161 extern StructRNA RNA_CompositorNodeMapUV;
162 extern StructRNA RNA_CompositorNodeMapValue;
163 extern StructRNA RNA_CompositorNodeMask;
164 extern StructRNA RNA_CompositorNodeMath;
165 extern StructRNA RNA_CompositorNodeMixRGB;
166 extern StructRNA RNA_CompositorNodeNormal;
167 extern StructRNA RNA_CompositorNodeNormalize;
168 extern StructRNA RNA_CompositorNodeOutputFile;
169 extern StructRNA RNA_CompositorNodePremulKey;
170 extern StructRNA RNA_CompositorNodeRGB;
171 extern StructRNA RNA_CompositorNodeRGBToBW;
172 extern StructRNA RNA_CompositorNodeRLayers;
173 extern StructRNA RNA_CompositorNodeRotate;
174 extern StructRNA RNA_CompositorNodeScale;
175 extern StructRNA RNA_CompositorNodeSepHSVA;
176 extern StructRNA RNA_CompositorNodeSepRGBA;
177 extern StructRNA RNA_CompositorNodeSepYCCA;
178 extern StructRNA RNA_CompositorNodeSepYUVA;
179 extern StructRNA RNA_CompositorNodeSetAlpha;
180 extern StructRNA RNA_CompositorNodeSplitViewer;
181 extern StructRNA RNA_CompositorNodeSunBeams;
182 extern StructRNA RNA_CompositorNodeSwitchView;
183 extern StructRNA RNA_CompositorNodeTexture;
184 extern StructRNA RNA_CompositorNodeTime;
185 extern StructRNA RNA_CompositorNodeTonemap;
186 extern StructRNA RNA_CompositorNodeTranslate;
187 extern StructRNA RNA_CompositorNodeTree;
188 extern StructRNA RNA_CompositorNodeValToRGB;
189 extern StructRNA RNA_CompositorNodeValue;
190 extern StructRNA RNA_CompositorNodeVecBlur;
191 extern StructRNA RNA_CompositorNodeViewer;
192 extern StructRNA RNA_CompositorNodeZcombine;
193 extern StructRNA RNA_ConsoleLine;
194 extern StructRNA RNA_Constraint;
195 extern StructRNA RNA_ConstraintTarget;
196 extern StructRNA RNA_ConstraintTargetBone;
197 extern StructRNA RNA_Context;
198 extern StructRNA RNA_ControlFluidSettings;
199 extern StructRNA RNA_Controller;
200 extern StructRNA RNA_CopyLocationConstraint;
201 extern StructRNA RNA_CopyRotationConstraint;
202 extern StructRNA RNA_CopyScaleConstraint;
203 extern StructRNA RNA_CopyTransformsConstraint;
204 extern StructRNA RNA_CorrectiveSmoothModifier;
205 extern StructRNA RNA_Curve;
206 extern StructRNA RNA_CurveMap;
207 extern StructRNA RNA_CurveMapPoint;
208 extern StructRNA RNA_CurveMapping;
209 extern StructRNA RNA_CurveModifier;
210 extern StructRNA RNA_CurvePoint;
211 extern StructRNA RNA_DampedTrackConstraint;
212 extern StructRNA RNA_DataTransferModifier;
213 extern StructRNA RNA_DecimateModifier;
214 extern StructRNA RNA_DelaySensor;
215 extern StructRNA RNA_Depsgraph;
216 extern StructRNA RNA_DepsgraphObjectInstance;
217 extern StructRNA RNA_DepsgraphUpdate;
218 extern StructRNA RNA_DisplaceModifier;
219 extern StructRNA RNA_DisplaySafeAreas;
220 extern StructRNA RNA_DistortedNoiseTexture;
221 extern StructRNA RNA_DomainFluidSettings;
222 extern StructRNA RNA_DopeSheet;
223 extern StructRNA RNA_Driver;
224 extern StructRNA RNA_DriverTarget;
225 extern StructRNA RNA_DriverVariable;
226 extern StructRNA RNA_DupliGpencilModifier;
227 extern StructRNA RNA_DynamicPaintBrushSettings;
228 extern StructRNA RNA_DynamicPaintCanvasSettings;
229 extern StructRNA RNA_DynamicPaintModifier;
230 extern StructRNA RNA_DynamicPaintSurface;
231 extern StructRNA RNA_EdgeSplitModifier;
232 extern StructRNA RNA_EditBone;
233 extern StructRNA RNA_EffectSequence;
234 extern StructRNA RNA_EffectorWeights;
235 extern StructRNA RNA_EnumProperty;
236 extern StructRNA RNA_EnumPropertyItem;
237 extern StructRNA RNA_Event;
238 extern StructRNA RNA_ExplodeModifier;
239 extern StructRNA RNA_ExpressionController;
240 extern StructRNA RNA_FCurve;
241 extern StructRNA RNA_FCurveSample;
242 extern StructRNA RNA_FFmpegSettings;
243 extern StructRNA RNA_FModifier;
244 extern StructRNA RNA_FModifierCycles;
245 extern StructRNA RNA_FModifierEnvelope;
246 extern StructRNA RNA_FModifierEnvelopeControlPoint;
247 extern StructRNA RNA_FModifierFunctionGenerator;
248 extern StructRNA RNA_FModifierGenerator;
249 extern StructRNA RNA_FModifierLimits;
250 extern StructRNA RNA_FModifierNoise;
251 extern StructRNA RNA_FModifierPython;
252 extern StructRNA RNA_FModifierStepped;
253 extern StructRNA RNA_FaceMap;
254 extern StructRNA RNA_FieldSettings;
255 extern StructRNA RNA_FileBrowserFSMenuEntry;
256 extern StructRNA RNA_FileSelectParams;
257 extern StructRNA RNA_FloatProperty;
258 extern StructRNA RNA_FloorConstraint;
259 extern StructRNA RNA_FluidFluidSettings;
260 extern StructRNA RNA_FluidSettings;
261 extern StructRNA RNA_FluidSimulationModifier;
262 extern StructRNA RNA_FollowPathConstraint;
263 extern StructRNA RNA_FreestyleLineSet;
264 extern StructRNA RNA_FreestyleLineStyle;
265 extern StructRNA RNA_FreestyleModuleSettings;
266 extern StructRNA RNA_FreestyleSettings;
267 extern StructRNA RNA_Function;
268 extern StructRNA RNA_GPencilFrame;
269 extern StructRNA RNA_GPencilInterpolateSettings;
270 extern StructRNA RNA_GPencilLayer;
271 extern StructRNA RNA_GPencilSculptBrush;
272 extern StructRNA RNA_GPencilSculptGuide;
273 extern StructRNA RNA_GPencilSculptSettings;
274 extern StructRNA RNA_GPencilStroke;
275 extern StructRNA RNA_GPencilStrokePoint;
276 extern StructRNA RNA_GaussianBlurSequence;
277 extern StructRNA RNA_Gizmo;
278 extern StructRNA RNA_GizmoGroupProperties;
279 extern StructRNA RNA_GizmoProperties;
280 extern StructRNA RNA_GlowSequence;
281 extern StructRNA RNA_GpencilModifier;
282 extern StructRNA RNA_GreasePencil;
283 extern StructRNA RNA_Header;
284 extern StructRNA RNA_HemiLight;
285 extern StructRNA RNA_Histogram;
286 extern StructRNA RNA_HookGpencilModifier;
287 extern StructRNA RNA_HookModifier;
288 extern StructRNA RNA_ID;
289 extern StructRNA RNA_IDOverrideStatic;
290 extern StructRNA RNA_IDOverrideStaticProperty;
291 extern StructRNA RNA_IKParam;
292 extern StructRNA RNA_Image;
293 extern StructRNA RNA_ImageFormatSettings;
294 extern StructRNA RNA_ImagePaint;
295 extern StructRNA RNA_ImagePreview;
296 extern StructRNA RNA_ImageSequence;
297 extern StructRNA RNA_ImageTexture;
298 extern StructRNA RNA_ImageUser;
299 extern StructRNA RNA_InflowFluidSettings;
300 extern StructRNA RNA_IntProperty;
301 extern StructRNA RNA_Itasc;
302 extern StructRNA RNA_JoystickSensor;
303 extern StructRNA RNA_Key;
304 extern StructRNA RNA_KeyConfig;
305 extern StructRNA RNA_KeyConfigPreferences;
306 extern StructRNA RNA_KeyMap;
307 extern StructRNA RNA_KeyMapItem;
308 extern StructRNA RNA_KeyMapItems;
309 extern StructRNA RNA_KeyboardSensor;
310 extern StructRNA RNA_Keyframe;
311 extern StructRNA RNA_KeyingSet;
312 extern StructRNA RNA_KeyingSetInfo;
313 extern StructRNA RNA_KeyingSetPath;
314 extern StructRNA RNA_KeyingSetsAll;
315 extern StructRNA RNA_KinematicConstraint;
316 extern StructRNA RNA_LaplacianDeformModifier;
317 extern StructRNA RNA_LaplacianSmoothModifier;
318 extern StructRNA RNA_Lattice;
319 extern StructRNA RNA_LatticeGpencilModifier;
320 extern StructRNA RNA_LatticeModifier;
321 extern StructRNA RNA_LatticePoint;
322 extern StructRNA RNA_LayerCollection;
323 extern StructRNA RNA_LayerObjects;
324 extern StructRNA RNA_Library;
325 extern StructRNA RNA_Light;
326 extern StructRNA RNA_LightProbe;
327 extern StructRNA RNA_LightSkySettings;
328 extern StructRNA RNA_LightTextureSlot;
329 extern StructRNA RNA_LimitDistanceConstraint;
330 extern StructRNA RNA_LimitLocationConstraint;
331 extern StructRNA RNA_LimitRotationConstraint;
332 extern StructRNA RNA_LimitScaleConstraint;
333 extern StructRNA RNA_LineStyleAlphaModifier;
334 extern StructRNA RNA_LineStyleAlphaModifier_AlongStroke;
335 extern StructRNA RNA_LineStyleAlphaModifier_CreaseAngle;
336 extern StructRNA RNA_LineStyleAlphaModifier_Curvature_3D;
337 extern StructRNA RNA_LineStyleAlphaModifier_DistanceFromCamera;
338 extern StructRNA RNA_LineStyleAlphaModifier_DistanceFromObject;
339 extern StructRNA RNA_LineStyleAlphaModifier_Material;
340 extern StructRNA RNA_LineStyleAlphaModifier_Noise;
341 extern StructRNA RNA_LineStyleAlphaModifier_Tangent;
342 extern StructRNA RNA_LineStyleColorModifier;
343 extern StructRNA RNA_LineStyleColorModifier_AlongStroke;
344 extern StructRNA RNA_LineStyleColorModifier_CreaseAngle;
345 extern StructRNA RNA_LineStyleColorModifier_Curvature_3D;
346 extern StructRNA RNA_LineStyleColorModifier_DistanceFromCamera;
347 extern StructRNA RNA_LineStyleColorModifier_DistanceFromObject;
348 extern StructRNA RNA_LineStyleColorModifier_Material;
349 extern StructRNA RNA_LineStyleColorModifier_Noise;
350 extern StructRNA RNA_LineStyleColorModifier_Tangent;
351 extern StructRNA RNA_LineStyleGeometryModifier;
352 extern StructRNA RNA_LineStyleGeometryModifier_2DOffset;
353 extern StructRNA RNA_LineStyleGeometryModifier_2DTransform;
354 extern StructRNA RNA_LineStyleGeometryModifier_BackboneStretcher;
355 extern StructRNA RNA_LineStyleGeometryModifier_BezierCurve;
356 extern StructRNA RNA_LineStyleGeometryModifier_Blueprint;
357 extern StructRNA RNA_LineStyleGeometryModifier_GuidingLines;
358 extern StructRNA RNA_LineStyleGeometryModifier_PerlinNoise1D;
359 extern StructRNA RNA_LineStyleGeometryModifier_PerlinNoise2D;
360 extern StructRNA RNA_LineStyleGeometryModifier_Polygonalization;
361 extern StructRNA RNA_LineStyleGeometryModifier_Sampling;
362 extern StructRNA RNA_LineStyleGeometryModifier_Simplification;
363 extern StructRNA RNA_LineStyleGeometryModifier_SinusDisplacement;
364 extern StructRNA RNA_LineStyleGeometryModifier_SpatialNoise;
365 extern StructRNA RNA_LineStyleGeometryModifier_TipRemover;
366 extern StructRNA RNA_LineStyleModifier;
367 extern StructRNA RNA_LineStyleTextureSlot;
368 extern StructRNA RNA_LineStyleThicknessModifier;
369 extern StructRNA RNA_LineStyleThicknessModifier_AlongStroke;
370 extern StructRNA RNA_LineStyleThicknessModifier_Calligraphy;
371 extern StructRNA RNA_LineStyleThicknessModifier_CreaseAngle;
372 extern StructRNA RNA_LineStyleThicknessModifier_Curvature_3D;
373 extern StructRNA RNA_LineStyleThicknessModifier_DistanceFromCamera;
374 extern StructRNA RNA_LineStyleThicknessModifier_DistanceFromObject;
375 extern StructRNA RNA_LineStyleThicknessModifier_Material;
376 extern StructRNA RNA_LineStyleThicknessModifier_Noise;
377 extern StructRNA RNA_LineStyleThicknessModifier_Tangent;
378 extern StructRNA RNA_LockedTrackConstraint;
379 extern StructRNA RNA_Macro;
380 extern StructRNA RNA_MagicTexture;
381 extern StructRNA RNA_MarbleTexture;
382 extern StructRNA RNA_Mask;
383 extern StructRNA RNA_MaskLayer;
384 extern StructRNA RNA_MaskModifier;
385 extern StructRNA RNA_MaskSequence;
386 extern StructRNA RNA_Material;
387 extern StructRNA RNA_MaterialRaytraceMirror;
388 extern StructRNA RNA_MaterialSlot;
389 extern StructRNA RNA_Menu;
390 extern StructRNA RNA_Mesh;
391 extern StructRNA RNA_MeshCacheModifier;
392 extern StructRNA RNA_MeshColor;
393 extern StructRNA RNA_MeshColorLayer;
394 extern StructRNA RNA_MeshDeformModifier;
395 extern StructRNA RNA_MeshEdge;
396 extern StructRNA RNA_MeshFloatProperty;
397 extern StructRNA RNA_MeshFloatPropertyLayer;
398 extern StructRNA RNA_MeshIntProperty;
399 extern StructRNA RNA_MeshIntPropertyLayer;
400 extern StructRNA RNA_MeshLoop;
401 extern StructRNA RNA_MeshLoopColorLayer;
402 extern StructRNA RNA_MeshLoopTriangle;
403 extern StructRNA RNA_MeshPolygon;
404 extern StructRNA RNA_MeshSequenceCacheModifier;
405 extern StructRNA RNA_MeshSkinVertex;
406 extern StructRNA RNA_MeshSkinVertexLayer;
407 extern StructRNA RNA_MeshSticky;
408 extern StructRNA RNA_MeshStringProperty;
409 extern StructRNA RNA_MeshStringPropertyLayer;
410 extern StructRNA RNA_MeshTextureFace;
411 extern StructRNA RNA_MeshTextureFaceLayer;
412 extern StructRNA RNA_MeshTexturePoly;
413 extern StructRNA RNA_MeshTexturePolyLayer;
414 extern StructRNA RNA_MeshVertex;
415 extern StructRNA RNA_MessageSensor;
416 extern StructRNA RNA_MetaBall;
417 extern StructRNA RNA_MetaElement;
418 extern StructRNA RNA_MetaSequence;
419 extern StructRNA RNA_MirrorGpencilModifier;
420 extern StructRNA RNA_MirrorModifier;
421 extern StructRNA RNA_Modifier;
422 extern StructRNA RNA_MotionPath;
423 extern StructRNA RNA_MotionPathVert;
424 extern StructRNA RNA_MouseSensor;
425 extern StructRNA RNA_MovieClipSequence;
426 extern StructRNA RNA_MovieSequence;
427 extern StructRNA RNA_MovieTracking;
428 extern StructRNA RNA_MovieTrackingObject;
429 extern StructRNA RNA_MovieTrackingStabilization;
430 extern StructRNA RNA_MovieTrackingTrack;
431 extern StructRNA RNA_MulticamSequence;
432 extern StructRNA RNA_MultiresModifier;
433 extern StructRNA RNA_MusgraveTexture;
434 extern StructRNA RNA_MyBMeshModifier;
435 extern StructRNA RNA_NandController;
436 extern StructRNA RNA_NearSensor;
437 extern StructRNA RNA_NlaStrip;
438 extern StructRNA RNA_NlaTrack;
439 extern StructRNA RNA_Node;
440 extern StructRNA RNA_NodeInstanceHash;
441 extern StructRNA RNA_NodeLink;
442 extern StructRNA RNA_NodeOutputFileSlotFile;
443 extern StructRNA RNA_NodeOutputFileSlotLayer;
444 extern StructRNA RNA_NodeSocket;
445 extern StructRNA RNA_NodeSocketInterface;
446 extern StructRNA RNA_NodeTree;
447 extern StructRNA RNA_NoiseGpencilModifier;
448 extern StructRNA RNA_NoiseTexture;
449 extern StructRNA RNA_NorController;
450 extern StructRNA RNA_NormalEditModifier;
451 extern StructRNA RNA_Object;
452 extern StructRNA RNA_ObjectBase;
453 extern StructRNA RNA_ObjectDisplay;
454 extern StructRNA RNA_ObstacleFluidSettings;
455 extern StructRNA RNA_OceanModifier;
456 extern StructRNA RNA_OceanTexData;
457 extern StructRNA RNA_OceanTexture;
458 extern StructRNA RNA_OffsetGpencilModifier;
459 extern StructRNA RNA_OpacityGpencilModifier;
460 extern StructRNA RNA_Operator;
461 extern StructRNA RNA_OperatorFileListElement;
462 extern StructRNA RNA_OperatorMacro;
463 extern StructRNA RNA_OperatorMousePath;
464 extern StructRNA RNA_OperatorProperties;
465 extern StructRNA RNA_OperatorStrokeElement;
466 extern StructRNA RNA_OrController;
467 extern StructRNA RNA_OutflowFluidSettings;
468 extern StructRNA RNA_PackedFile;
469 extern StructRNA RNA_Paint;
470 extern StructRNA RNA_PaintCurve;
471 extern StructRNA RNA_PaintToolSlot;
472 extern StructRNA RNA_Palette;
473 extern StructRNA RNA_PaletteColor;
474 extern StructRNA RNA_Panel;
475 extern StructRNA RNA_Particle;
476 extern StructRNA RNA_ParticleBrush;
477 extern StructRNA RNA_ParticleDupliWeight;
478 extern StructRNA RNA_ParticleEdit;
479 extern StructRNA RNA_ParticleFluidSettings;
480 extern StructRNA RNA_ParticleHairKey;
481 extern StructRNA RNA_ParticleInstanceModifier;
482 extern StructRNA RNA_ParticleKey;
483 extern StructRNA RNA_ParticleSettings;
484 extern StructRNA RNA_ParticleSettingsTextureSlot;
485 extern StructRNA RNA_ParticleSystem;
486 extern StructRNA RNA_ParticleSystemModifier;
487 extern StructRNA RNA_ParticleTarget;
488 extern StructRNA RNA_PivotConstraint;
489 extern StructRNA RNA_PointCache;
490 extern StructRNA RNA_PointLight;
491 extern StructRNA RNA_PointerProperty;
492 extern StructRNA RNA_Pose;
493 extern StructRNA RNA_PoseBone;
494 extern StructRNA RNA_Preferences;
495 extern StructRNA RNA_PreferencesEdit;
496 extern StructRNA RNA_PreferencesFilePaths;
497 extern StructRNA RNA_PreferencesInput;
498 extern StructRNA RNA_PreferencesKeymap;
499 extern StructRNA RNA_PreferencesSystem;
500 extern StructRNA RNA_PreferencesView;
501 extern StructRNA RNA_PreferencesWalkNavigation;
502 extern StructRNA RNA_Property;
503 extern StructRNA RNA_PropertyGroup;
504 extern StructRNA RNA_PropertyGroupItem;
505 extern StructRNA RNA_PropertySensor;
506 extern StructRNA RNA_PythonConstraint;
507 extern StructRNA RNA_PythonController;
508 extern StructRNA RNA_RadarSensor;
509 extern StructRNA RNA_RandomSensor;
510 extern StructRNA RNA_RaySensor;
511 extern StructRNA RNA_Region;
512 extern StructRNA RNA_RenderEngine;
513 extern StructRNA RNA_RenderEngineSettings;
514 extern StructRNA RNA_RenderEngineSettingsClay;
515 extern StructRNA RNA_RenderLayer;
516 extern StructRNA RNA_RenderPass;
517 extern StructRNA RNA_RenderResult;
518 extern StructRNA RNA_RenderSettings;
519 extern StructRNA RNA_RigidBodyJointConstraint;
520 extern StructRNA RNA_RigidBodyObject;
521 extern StructRNA RNA_RigidBodyWorld;
522 extern StructRNA RNA_SPHFluidSettings;
523 extern StructRNA RNA_Scene;
524 extern StructRNA RNA_SceneDisplay;
525 extern StructRNA RNA_SceneEEVEE;
526 extern StructRNA RNA_SceneLANPR;
527 extern StructRNA RNA_SceneObjects;
528 extern StructRNA RNA_SceneRenderLayer;
529 extern StructRNA RNA_SceneSequence;
530 extern StructRNA RNA_Scopes;
531 extern StructRNA RNA_Screen;
532 extern StructRNA RNA_ScrewModifier;
533 extern StructRNA RNA_Sculpt;
534 extern StructRNA RNA_SelectedUvElement;
535 extern StructRNA RNA_Sensor;
536 extern StructRNA RNA_Sequence;
537 extern StructRNA RNA_SequenceColorBalance;
538 extern StructRNA RNA_SequenceColorBalanceData;
539 extern StructRNA RNA_SequenceCrop;
540 extern StructRNA RNA_SequenceEditor;
541 extern StructRNA RNA_SequenceElement;
542 extern StructRNA RNA_SequenceModifier;
543 extern StructRNA RNA_SequenceProxy;
544 extern StructRNA RNA_SequenceTransform;
545 extern StructRNA RNA_ShaderFx;
546 extern StructRNA RNA_ShaderFxBlur;
547 extern StructRNA RNA_ShaderFxColorize;
548 extern StructRNA RNA_ShaderFxFlip;
549 extern StructRNA RNA_ShaderFxGlow;
550 extern StructRNA RNA_ShaderFxLight;
551 extern StructRNA RNA_ShaderFxPixel;
552 extern StructRNA RNA_ShaderFxRim;
553 extern StructRNA RNA_ShaderFxShadow;
554 extern StructRNA RNA_ShaderFxSwirl;
555 extern StructRNA RNA_ShaderFxWave;
556 extern StructRNA RNA_ShaderNode;
557 extern StructRNA RNA_ShaderNodeCameraData;
558 extern StructRNA RNA_ShaderNodeCombineRGB;
559 extern StructRNA RNA_ShaderNodeExtendedMaterial;
560 extern StructRNA RNA_ShaderNodeGamma;
561 extern StructRNA RNA_ShaderNodeGeometry;
562 extern StructRNA RNA_ShaderNodeHueSaturation;
563 extern StructRNA RNA_ShaderNodeIESLight;
564 extern StructRNA RNA_ShaderNodeInvert;
565 extern StructRNA RNA_ShaderNodeLightData;
566 extern StructRNA RNA_ShaderNodeMapping;
567 extern StructRNA RNA_ShaderNodeMaterial;
568 extern StructRNA RNA_ShaderNodeMath;
569 extern StructRNA RNA_ShaderNodeMixRGB;
570 extern StructRNA RNA_ShaderNodeNormal;
571 extern StructRNA RNA_ShaderNodeOutput;
572 extern StructRNA RNA_ShaderNodeRGB;
573 extern StructRNA RNA_ShaderNodeRGBCurve;
574 extern StructRNA RNA_ShaderNodeRGBToBW;
575 extern StructRNA RNA_ShaderNodeScript;
576 extern StructRNA RNA_ShaderNodeSeparateRGB;
577 extern StructRNA RNA_ShaderNodeSqueeze;
578 extern StructRNA RNA_ShaderNodeTexture;
579 extern StructRNA RNA_ShaderNodeTree;
580 extern StructRNA RNA_ShaderNodeValToRGB;
581 extern StructRNA RNA_ShaderNodeValue;
582 extern StructRNA RNA_ShaderNodeVectorCurve;
583 extern StructRNA RNA_ShaderNodeVectorMath;
584 extern StructRNA RNA_ShapeKey;
585 extern StructRNA RNA_ShapeKeyBezierPoint;
586 extern StructRNA RNA_ShapeKeyCurvePoint;
587 extern StructRNA RNA_ShapeKeyPoint;
588 extern StructRNA RNA_ShrinkwrapConstraint;
589 extern StructRNA RNA_ShrinkwrapModifier;
590 extern StructRNA RNA_SimpleDeformModifier;
591 extern StructRNA RNA_SimplifyGpencilModifier;
592 extern StructRNA RNA_SkinModifier;
593 extern StructRNA RNA_SmokeCollSettings;
594 extern StructRNA RNA_SmokeDomainSettings;
595 extern StructRNA RNA_SmokeFlowSettings;
596 extern StructRNA RNA_SmokeModifier;
597 extern StructRNA RNA_SmoothGpencilModifier;
598 extern StructRNA RNA_SmoothModifier;
599 extern StructRNA RNA_SoftBodyModifier;
600 extern StructRNA RNA_SoftBodySettings;
601 extern StructRNA RNA_SolidifyModifier;
602 extern StructRNA RNA_Sound;
603 extern StructRNA RNA_SoundSequence;
604 extern StructRNA RNA_Space;
605 extern StructRNA RNA_SpaceClipEditor;
606 extern StructRNA RNA_SpaceConsole;
607 extern StructRNA RNA_SpaceDopeSheetEditor;
608 extern StructRNA RNA_SpaceFileBrowser;
609 extern StructRNA RNA_SpaceGraphEditor;
610 extern StructRNA RNA_SpaceImageEditor;
611 extern StructRNA RNA_SpaceInfo;
612 extern StructRNA RNA_SpaceNLA;
613 extern StructRNA RNA_SpaceNodeEditor;
614 extern StructRNA RNA_SpaceOutliner;
615 extern StructRNA RNA_SpacePreferences;
616 extern StructRNA RNA_SpaceProperties;
617 extern StructRNA RNA_SpaceSequenceEditor;
618 extern StructRNA RNA_SpaceTextEditor;
619 extern StructRNA RNA_SpaceUVEditor;
620 extern StructRNA RNA_SpaceView3D;
621 extern StructRNA RNA_Speaker;
622 extern StructRNA RNA_SpeedControlSequence;
623 extern StructRNA RNA_Spline;
624 extern StructRNA RNA_SplineIKConstraint;
625 extern StructRNA RNA_SplinePoint;
626 extern StructRNA RNA_SpotLight;
627 extern StructRNA RNA_Stereo3dDisplay;
628 extern StructRNA RNA_StretchToConstraint;
629 extern StructRNA RNA_StringProperty;
630 extern StructRNA RNA_Struct;
631 extern StructRNA RNA_StucciTexture;
632 extern StructRNA RNA_StudioLight;
633 extern StructRNA RNA_SubdivGpencilModifier;
634 extern StructRNA RNA_SubsurfModifier;
635 extern StructRNA RNA_SunLight;
636 extern StructRNA RNA_SurfaceCurve;
637 extern StructRNA RNA_SurfaceDeformModifier;
638 extern StructRNA RNA_SurfaceModifier;
639 extern StructRNA RNA_TexMapping;
640 extern StructRNA RNA_Text;
641 extern StructRNA RNA_TextBox;
642 extern StructRNA RNA_TextCharacterFormat;
643 extern StructRNA RNA_TextCurve;
644 extern StructRNA RNA_TextLine;
645 extern StructRNA RNA_TextSequence;
646 extern StructRNA RNA_Texture;
647 extern StructRNA RNA_TextureNode;
648 extern StructRNA RNA_TextureNodeBricks;
649 extern StructRNA RNA_TextureNodeChecker;
650 extern StructRNA RNA_TextureNodeCompose;
651 extern StructRNA RNA_TextureNodeCoordinates;
652 extern StructRNA RNA_TextureNodeCurveRGB;
653 extern StructRNA RNA_TextureNodeCurveTime;
654 extern StructRNA RNA_TextureNodeDecompose;
655 extern StructRNA RNA_TextureNodeDistance;
656 extern StructRNA RNA_TextureNodeHueSaturation;
657 extern StructRNA RNA_TextureNodeImage;
658 extern StructRNA RNA_TextureNodeInvert;
659 extern StructRNA RNA_TextureNodeMath;
660 extern StructRNA RNA_TextureNodeMixRGB;
661 extern StructRNA RNA_TextureNodeOutput;
662 extern StructRNA RNA_TextureNodeRGBToBW;
663 extern StructRNA RNA_TextureNodeRotate;
664 extern StructRNA RNA_TextureNodeScale;
665 extern StructRNA RNA_TextureNodeTexture;
666 extern StructRNA RNA_TextureNodeTranslate;
667 extern StructRNA RNA_TextureNodeTree;
668 extern StructRNA RNA_TextureNodeValToNor;
669 extern StructRNA RNA_TextureNodeValToRGB;
670 extern StructRNA RNA_TextureNodeViewer;
671 extern StructRNA RNA_TextureSlot;
672 extern StructRNA RNA_Theme;
673 extern StructRNA RNA_ThemeAudioWindow;
674 extern StructRNA RNA_ThemeBoneColorSet;
675 extern StructRNA RNA_ThemeConsole;
676 extern StructRNA RNA_ThemeDopeSheet;
677 extern StructRNA RNA_ThemeFileBrowser;
678 extern StructRNA RNA_ThemeFontStyle;
679 extern StructRNA RNA_ThemeGraphEditor;
680 extern StructRNA RNA_ThemeImageEditor;
681 extern StructRNA RNA_ThemeInfo;
682 extern StructRNA RNA_ThemeLogicEditor;
683 extern StructRNA RNA_ThemeNLAEditor;
684 extern StructRNA RNA_ThemeNodeEditor;
685 extern StructRNA RNA_ThemeOutliner;
686 extern StructRNA RNA_ThemePreferences;
687 extern StructRNA RNA_ThemeProperties;
688 extern StructRNA RNA_ThemeSequenceEditor;
689 extern StructRNA RNA_ThemeSpaceGeneric;
690 extern StructRNA RNA_ThemeSpaceGradient;
691 extern StructRNA RNA_ThemeSpaceListGeneric;
692 extern StructRNA RNA_ThemeStyle;
693 extern StructRNA RNA_ThemeTextEditor;
694 extern StructRNA RNA_ThemeUserInterface;
695 extern StructRNA RNA_ThemeView3D;
696 extern StructRNA RNA_ThemeWidgetColors;
697 extern StructRNA RNA_ThemeWidgetStateColors;
698 extern StructRNA RNA_ThickGpencilModifier;
699 extern StructRNA RNA_TimeGpencilModifier;
700 extern StructRNA RNA_TimelineMarker;
701 extern StructRNA RNA_Timer;
702 extern StructRNA RNA_TintGpencilModifier;
703 extern StructRNA RNA_ToolSettings;
704 extern StructRNA RNA_TrackToConstraint;
705 extern StructRNA RNA_TransformConstraint;
706 extern StructRNA RNA_TransformOrientationSlot;
707 extern StructRNA RNA_TransformSequence;
708 extern StructRNA RNA_UILayout;
709 extern StructRNA RNA_UIList;
710 extern StructRNA RNA_UIPieMenu;
711 extern StructRNA RNA_UIPopupMenu;
712 extern StructRNA RNA_UVProjectModifier;
713 extern StructRNA RNA_UVProjector;
714 extern StructRNA RNA_UVWarpModifier;
715 extern StructRNA RNA_UnitSettings;
716 extern StructRNA RNA_UnknownType;
717 extern StructRNA RNA_UserSolidLight;
718 extern StructRNA RNA_VectorFont;
719 extern StructRNA RNA_VertexGroup;
720 extern StructRNA RNA_VertexGroupElement;
721 extern StructRNA RNA_VertexPaint;
722 extern StructRNA RNA_VertexWeightEditModifier;
723 extern StructRNA RNA_VertexWeightMixModifier;
724 extern StructRNA RNA_VertexWeightProximityModifier;
725 extern StructRNA RNA_View3DCursor;
726 extern StructRNA RNA_View3DOverlay;
727 extern StructRNA RNA_View3DShading;
728 extern StructRNA RNA_ViewLayer;
729 extern StructRNA RNA_VoronoiTexture;
730 extern StructRNA RNA_WarpModifier;
731 extern StructRNA RNA_WaveModifier;
732 extern StructRNA RNA_WeightedNormalModifier;
733 extern StructRNA RNA_Window;
734 extern StructRNA RNA_WindowManager;
735 extern StructRNA RNA_WipeSequence;
736 extern StructRNA RNA_WireframeModifier;
737 extern StructRNA RNA_WoodTexture;
738 extern StructRNA RNA_WorkSpace;
739 extern StructRNA RNA_World;
740 extern StructRNA RNA_WorldAmbientOcclusion;
741 extern StructRNA RNA_WorldLighting;
742 extern StructRNA RNA_WorldMistSettings;
743 extern StructRNA RNA_WorldTextureSlot;
744 extern StructRNA RNA_XnorController;
745 extern StructRNA RNA_XorController;
746 extern StructRNA RNA_uiPopover;
747 extern StructRNA RNA_wmOwnerIDs;
748
749 /* Pointer
750  *
751  * These functions will fill in RNA pointers, this can be done in three ways:
752  * - a pointer Main is created by just passing the data pointer
753  * - a pointer to a datablock can be created with the type and id data pointer
754  * - a pointer to data contained in a datablock can be created with the id type
755  *   and id data pointer, and the data type and pointer to the struct itself.
756  *
757  * There is also a way to get a pointer with the information about all structs.
758  */
759
760 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
761 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
762 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
763 bool RNA_pointer_is_null(const PointerRNA *ptr);
764
765 bool RNA_path_resolved_create(PointerRNA *ptr,
766                               struct PropertyRNA *prop,
767                               const int prop_index,
768                               PathResolvedRNA *r_anim_rna);
769
770 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
771 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr);
772
773 extern const PointerRNA PointerRNA_NULL;
774
775 /* Structs */
776
777 StructRNA *RNA_struct_find(const char *identifier);
778
779 const char *RNA_struct_identifier(const StructRNA *type);
780 const char *RNA_struct_ui_name(const StructRNA *type);
781 const char *RNA_struct_ui_name_raw(const StructRNA *type);
782 const char *RNA_struct_ui_description(const StructRNA *type);
783 const char *RNA_struct_ui_description_raw(const StructRNA *type);
784 const char *RNA_struct_translation_context(const StructRNA *type);
785 int RNA_struct_ui_icon(const StructRNA *type);
786
787 PropertyRNA *RNA_struct_name_property(const StructRNA *type);
788 const EnumPropertyItem *RNA_struct_property_tag_defines(const StructRNA *type);
789 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
790 StructRNA *RNA_struct_base(StructRNA *type);
791 const StructRNA *RNA_struct_base_child_of(const StructRNA *type, const StructRNA *parent_type);
792
793 bool RNA_struct_is_ID(const StructRNA *type);
794 bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna);
795
796 bool RNA_struct_undo_check(const StructRNA *type);
797
798 StructRegisterFunc RNA_struct_register(StructRNA *type);
799 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
800 void **RNA_struct_instance(PointerRNA *ptr);
801
802 void *RNA_struct_py_type_get(StructRNA *srna);
803 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
804
805 void *RNA_struct_blender_type_get(StructRNA *srna);
806 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
807
808 struct IDProperty *RNA_struct_idprops(PointerRNA *ptr, bool create);
809 bool RNA_struct_idprops_check(StructRNA *srna);
810 bool RNA_struct_idprops_register_check(const StructRNA *type);
811 bool RNA_struct_idprops_datablock_allowed(const StructRNA *type);
812 bool RNA_struct_idprops_contains_datablock(const StructRNA *type);
813 bool RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier);
814
815 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
816 bool RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test);
817 unsigned int RNA_struct_count_properties(StructRNA *srna);
818
819 /* lower level functions for access to type properties */
820 const struct ListBase *RNA_struct_type_properties(StructRNA *srna);
821 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier);
822
823 FunctionRNA *RNA_struct_find_function(StructRNA *srna, const char *identifier);
824 const struct ListBase *RNA_struct_type_functions(StructRNA *srna);
825
826 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, int *r_len);
827
828 bool RNA_struct_available_or_report(struct ReportList *reports, const char *identifier);
829 bool RNA_struct_bl_idname_ok_or_report(struct ReportList *reports,
830                                        const char *identifier,
831                                        const char *sep);
832
833 /* Properties
834  *
835  * Access to struct properties. All this works with RNA pointers rather than
836  * direct pointers to the data. */
837
838 /* Property Information */
839
840 const char *RNA_property_identifier(const PropertyRNA *prop);
841 const char *RNA_property_description(PropertyRNA *prop);
842
843 PropertyType RNA_property_type(PropertyRNA *prop);
844 PropertySubType RNA_property_subtype(PropertyRNA *prop);
845 PropertyUnit RNA_property_unit(PropertyRNA *prop);
846 int RNA_property_flag(PropertyRNA *prop);
847 int RNA_property_override_flag(PropertyRNA *prop);
848 int RNA_property_tags(PropertyRNA *prop);
849 bool RNA_property_builtin(PropertyRNA *prop);
850 void *RNA_property_py_data_get(PropertyRNA *prop);
851
852 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
853 bool RNA_property_array_check(PropertyRNA *prop);
854 int RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dimension);
855 int RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[]);
856 char RNA_property_array_item_char(PropertyRNA *prop, int index);
857 int RNA_property_array_item_index(PropertyRNA *prop, char name);
858
859 int RNA_property_string_maxlength(PropertyRNA *prop);
860
861 const char *RNA_property_ui_name(PropertyRNA *prop);
862 const char *RNA_property_ui_name_raw(PropertyRNA *prop);
863 const char *RNA_property_ui_description(PropertyRNA *prop);
864 const char *RNA_property_ui_description_raw(PropertyRNA *prop);
865 const char *RNA_property_translation_context(PropertyRNA *prop);
866 int RNA_property_ui_icon(PropertyRNA *prop);
867
868 /* Dynamic Property Information */
869
870 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
871 void RNA_property_int_ui_range(
872     PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
873
874 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
875 void RNA_property_float_ui_range(PointerRNA *ptr,
876                                  PropertyRNA *prop,
877                                  float *softmin,
878                                  float *softmax,
879                                  float *step,
880                                  float *precision);
881
882 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value);
883 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value);
884
885 bool RNA_enum_identifier(const EnumPropertyItem *item, const int value, const char **identifier);
886 int RNA_enum_bitflag_identifiers(const EnumPropertyItem *item,
887                                  const int value,
888                                  const char **identifier);
889 bool RNA_enum_name(const EnumPropertyItem *item, const int value, const char **r_name);
890 bool RNA_enum_description(const EnumPropertyItem *item, const int value, const char **description);
891 int RNA_enum_from_value(const EnumPropertyItem *item, const int value);
892 int RNA_enum_from_identifier(const EnumPropertyItem *item, const char *identifier);
893 int RNA_enum_from_name(const EnumPropertyItem *item, const char *name);
894 unsigned int RNA_enum_items_count(const EnumPropertyItem *item);
895
896 void RNA_property_enum_items_ex(struct bContext *C,
897                                 PointerRNA *ptr,
898                                 PropertyRNA *prop,
899                                 const bool use_static,
900                                 const EnumPropertyItem **r_item,
901                                 int *r_totitem,
902                                 bool *r_free);
903 void RNA_property_enum_items(struct bContext *C,
904                              PointerRNA *ptr,
905                              PropertyRNA *prop,
906                              const EnumPropertyItem **r_item,
907                              int *r_totitem,
908                              bool *r_free);
909 void RNA_property_enum_items_gettexted(struct bContext *C,
910                                        PointerRNA *ptr,
911                                        PropertyRNA *prop,
912                                        const EnumPropertyItem **r_item,
913                                        int *r_totitem,
914                                        bool *r_free);
915 void RNA_property_enum_items_gettexted_all(struct bContext *C,
916                                            PointerRNA *ptr,
917                                            PropertyRNA *prop,
918                                            const EnumPropertyItem **r_item,
919                                            int *r_totitem,
920                                            bool *r_free);
921 bool RNA_property_enum_value(
922     struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *r_value);
923 bool RNA_property_enum_identifier(struct bContext *C,
924                                   PointerRNA *ptr,
925                                   PropertyRNA *prop,
926                                   const int value,
927                                   const char **identifier);
928 bool RNA_property_enum_name(
929     struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
930 bool RNA_property_enum_name_gettexted(
931     struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
932
933 bool RNA_property_enum_item_from_value(struct bContext *C,
934                                        PointerRNA *ptr,
935                                        PropertyRNA *prop,
936                                        const int value,
937                                        EnumPropertyItem *r_item);
938 bool RNA_property_enum_item_from_value_gettexted(struct bContext *C,
939                                                  PointerRNA *ptr,
940                                                  PropertyRNA *prop,
941                                                  const int value,
942                                                  EnumPropertyItem *r_item);
943
944 int RNA_property_enum_bitflag_identifiers(struct bContext *C,
945                                           PointerRNA *ptr,
946                                           PropertyRNA *prop,
947                                           const int value,
948                                           const char **identifier);
949
950 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
951 bool RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value);
952
953 bool RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
954 bool RNA_property_editable_info(PointerRNA *ptr, PropertyRNA *prop, const char **r_info);
955 bool RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index);
956 bool RNA_property_editable_flag(PointerRNA *ptr,
957                                 PropertyRNA *prop); /* without lib check, only checks the flag */
958 bool RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
959 bool RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
960 bool RNA_property_overridable_get(PointerRNA *ptr, PropertyRNA *prop);
961 bool RNA_property_overridable_static_set(PointerRNA *ptr,
962                                          PropertyRNA *prop,
963                                          const bool is_overridable);
964 bool RNA_property_overridden(PointerRNA *ptr, PropertyRNA *prop);
965 bool RNA_property_comparable(PointerRNA *ptr, PropertyRNA *prop);
966 bool RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop); /* slow, use with care */
967
968 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
969 void RNA_property_update_main(struct Main *bmain,
970                               struct Scene *scene,
971                               PointerRNA *ptr,
972                               PropertyRNA *prop);
973 bool RNA_property_update_check(struct PropertyRNA *prop);
974
975 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop);
976 void RNA_property_update_cache_flush(struct Main *bmain, struct Scene *scene);
977 void RNA_property_update_cache_free(void);
978
979 /* Property Data */
980
981 bool RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
982 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, bool value);
983 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, bool *values);
984 bool RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
985 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const bool *values);
986 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, bool value);
987 bool RNA_property_boolean_get_default(PointerRNA *ptr, PropertyRNA *prop);
988 void RNA_property_boolean_get_default_array(PointerRNA *ptr, PropertyRNA *prop, bool *values);
989 bool RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
990
991 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
992 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
993 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
994 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2]);
995 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
996 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
997 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
998 int RNA_property_int_get_default(PointerRNA *ptr, PropertyRNA *prop);
999 bool RNA_property_int_set_default(PointerRNA *ptr, PropertyRNA *prop, int value);
1000 void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
1001 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
1002
1003 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
1004 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
1005 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
1006 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2]);
1007 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
1008 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
1009 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
1010 float RNA_property_float_get_default(PointerRNA *ptr, PropertyRNA *prop);
1011 bool RNA_property_float_set_default(PointerRNA *ptr, PropertyRNA *prop, float value);
1012 void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
1013 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
1014
1015 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
1016 char *RNA_property_string_get_alloc(
1017     PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen, int *r_len);
1018 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
1019 void RNA_property_string_set_bytes(PointerRNA *ptr, PropertyRNA *prop, const char *value, int len);
1020 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
1021 void RNA_property_string_get_default(PointerRNA *ptr, PropertyRNA *prop, char *value);
1022 char *RNA_property_string_get_default_alloc(PointerRNA *ptr,
1023                                             PropertyRNA *prop,
1024                                             char *fixedbuf,
1025                                             int fixedlen);
1026 int RNA_property_string_default_length(PointerRNA *ptr, PropertyRNA *prop);
1027
1028 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
1029 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
1030 int RNA_property_enum_get_default(PointerRNA *ptr, PropertyRNA *prop);
1031 void *RNA_property_enum_py_data_get(PropertyRNA *prop);
1032 int RNA_property_enum_step(
1033     const struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, int from_value, int step);
1034
1035 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
1036 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
1037 PointerRNA RNA_property_pointer_get_default(PointerRNA *ptr, PropertyRNA *prop);
1038
1039 void RNA_property_collection_begin(PointerRNA *ptr,
1040                                    PropertyRNA *prop,
1041                                    CollectionPropertyIterator *iter);
1042 void RNA_property_collection_next(CollectionPropertyIterator *iter);
1043 void RNA_property_collection_skip(CollectionPropertyIterator *iter, int num);
1044 void RNA_property_collection_end(CollectionPropertyIterator *iter);
1045 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
1046 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr);
1047 int RNA_property_collection_lookup_int(PointerRNA *ptr,
1048                                        PropertyRNA *prop,
1049                                        int key,
1050                                        PointerRNA *r_ptr);
1051 int RNA_property_collection_lookup_string(PointerRNA *ptr,
1052                                           PropertyRNA *prop,
1053                                           const char *key,
1054                                           PointerRNA *r_ptr);
1055 int RNA_property_collection_assign_int(PointerRNA *ptr,
1056                                        PropertyRNA *prop,
1057                                        const int key,
1058                                        const PointerRNA *assign_ptr);
1059 bool RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
1060
1061 /* efficient functions to set properties for arrays */
1062 int RNA_property_collection_raw_array(PointerRNA *ptr,
1063                                       PropertyRNA *prop,
1064                                       PropertyRNA *itemprop,
1065                                       RawArray *array);
1066 int RNA_property_collection_raw_get(struct ReportList *reports,
1067                                     PointerRNA *ptr,
1068                                     PropertyRNA *prop,
1069                                     const char *propname,
1070                                     void *array,
1071                                     RawPropertyType type,
1072                                     int len);
1073 int RNA_property_collection_raw_set(struct ReportList *reports,
1074                                     PointerRNA *ptr,
1075                                     PropertyRNA *prop,
1076                                     const char *propname,
1077                                     void *array,
1078                                     RawPropertyType type,
1079                                     int len);
1080 int RNA_raw_type_sizeof(RawPropertyType type);
1081 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
1082
1083 /* to create ID property groups */
1084 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
1085 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
1086 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
1087 bool RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
1088 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
1089 bool RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos);
1090
1091 /* copy/reset */
1092 bool RNA_property_copy(
1093     struct Main *bmain, PointerRNA *ptr, PointerRNA *fromptr, PropertyRNA *prop, int index);
1094 bool RNA_property_reset(PointerRNA *ptr, PropertyRNA *prop, int index);
1095 bool RNA_property_assign_default(PointerRNA *ptr, PropertyRNA *prop);
1096
1097 /* Path
1098  *
1099  * Experimental method to refer to structs and properties with a string,
1100  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
1101  *
1102  * This provides a way to refer to RNA data while being detached from any
1103  * particular pointers, which is useful in a number of applications, like
1104  * UI code or Actions, though efficiency is a concern. */
1105
1106 char *RNA_path_append(
1107     const char *path, PointerRNA *ptr, PropertyRNA *prop, int intkey, const char *strkey);
1108 char *RNA_path_back(const char *path);
1109
1110 /* path_resolve() variants only ensure that a valid pointer (and optionally property) exist */
1111 bool RNA_path_resolve(PointerRNA *ptr, const char *path, PointerRNA *r_ptr, PropertyRNA **r_prop);
1112
1113 bool RNA_path_resolve_full(
1114     PointerRNA *ptr, const char *path, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index);
1115
1116 /* path_resolve_property() variants ensure that pointer + property both exist */
1117 bool RNA_path_resolve_property(PointerRNA *ptr,
1118                                const char *path,
1119                                PointerRNA *r_ptr,
1120                                PropertyRNA **r_prop);
1121
1122 bool RNA_path_resolve_property_full(
1123     PointerRNA *ptr, const char *path, PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index);
1124
1125 /* path_resolve_property_and_item_pointer() variants ensure that pointer + property both exist,
1126  * and resolve last Pointer value if possible (Pointer prop or item of a Collection prop). */
1127 bool RNA_path_resolve_property_and_item_pointer(PointerRNA *ptr,
1128                                                 const char *path,
1129                                                 PointerRNA *r_ptr,
1130                                                 PropertyRNA **r_prop,
1131                                                 PointerRNA *r_item_ptr);
1132
1133 bool RNA_path_resolve_property_and_item_pointer_full(PointerRNA *ptr,
1134                                                      const char *path,
1135                                                      PointerRNA *r_ptr,
1136                                                      PropertyRNA **r_prop,
1137                                                      int *r_index,
1138                                                      PointerRNA *r_item_ptr);
1139
1140 typedef struct PropertyElemRNA PropertyElemRNA;
1141 struct PropertyElemRNA {
1142   PropertyElemRNA *next, *prev;
1143   PointerRNA ptr;
1144   PropertyRNA *prop;
1145   int index;
1146 };
1147 bool RNA_path_resolve_elements(PointerRNA *ptr, const char *path, struct ListBase *r_elements);
1148
1149 char *RNA_path_from_ID_to_struct(PointerRNA *ptr);
1150 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
1151 char *RNA_path_from_ID_to_property_index(PointerRNA *ptr,
1152                                          PropertyRNA *prop,
1153                                          int array_dim,
1154                                          int index);
1155
1156 char *RNA_path_resolve_from_type_to_property(struct PointerRNA *ptr,
1157                                              struct PropertyRNA *prop,
1158                                              const struct StructRNA *type);
1159
1160 char *RNA_path_full_ID_py(struct ID *id);
1161 char *RNA_path_full_struct_py(struct PointerRNA *ptr);
1162 char *RNA_path_full_property_py_ex(PointerRNA *ptr,
1163                                    PropertyRNA *prop,
1164                                    int index,
1165                                    bool use_fallback);
1166 char *RNA_path_full_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
1167 char *RNA_path_struct_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
1168 char *RNA_path_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
1169
1170 /* Quick name based property access
1171  *
1172  * These are just an easier way to access property values without having to
1173  * call RNA_struct_find_property. The names have to exist as RNA properties
1174  * for the type in the pointer, if they do not exist an error will be printed.
1175  *
1176  * There is no support for pointers and collections here yet, these can be
1177  * added when ID properties support them. */
1178
1179 bool RNA_boolean_get(PointerRNA *ptr, const char *name);
1180 void RNA_boolean_set(PointerRNA *ptr, const char *name, bool value);
1181 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, bool *values);
1182 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const bool *values);
1183
1184 int RNA_int_get(PointerRNA *ptr, const char *name);
1185 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
1186 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
1187 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
1188
1189 float RNA_float_get(PointerRNA *ptr, const char *name);
1190 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
1191 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
1192 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
1193
1194 int RNA_enum_get(PointerRNA *ptr, const char *name);
1195 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
1196 void RNA_enum_set_identifier(struct bContext *C,
1197                              PointerRNA *ptr,
1198                              const char *name,
1199                              const char *id);
1200 bool RNA_enum_is_equal(struct bContext *C,
1201                        PointerRNA *ptr,
1202                        const char *name,
1203                        const char *enumname);
1204
1205 /* lower level functions that don't use a PointerRNA */
1206 bool RNA_enum_value_from_id(const EnumPropertyItem *item, const char *identifier, int *r_value);
1207 bool RNA_enum_id_from_value(const EnumPropertyItem *item, int value, const char **r_identifier);
1208 bool RNA_enum_icon_from_value(const EnumPropertyItem *item, int value, int *r_icon);
1209 bool RNA_enum_name_from_value(const EnumPropertyItem *item, int value, const char **r_name);
1210
1211 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
1212 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
1213 int RNA_string_length(PointerRNA *ptr, const char *name);
1214 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
1215
1216 /**
1217  * Retrieve the named property from PointerRNA.
1218  */
1219 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
1220 /* Set the property name of PointerRNA ptr to ptr_value */
1221 void RNA_pointer_set(PointerRNA *ptr, const char *name, PointerRNA ptr_value);
1222 void RNA_pointer_add(PointerRNA *ptr, const char *name);
1223
1224 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
1225 int RNA_collection_length(PointerRNA *ptr, const char *name);
1226 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
1227 void RNA_collection_clear(PointerRNA *ptr, const char *name);
1228
1229 #define RNA_BEGIN(sptr, itemptr, propname) \
1230   { \
1231     CollectionPropertyIterator rna_macro_iter; \
1232     for (RNA_collection_begin(sptr, propname, &rna_macro_iter); rna_macro_iter.valid; \
1233          RNA_property_collection_next(&rna_macro_iter)) { \
1234       PointerRNA itemptr = rna_macro_iter.ptr;
1235
1236 #define RNA_END \
1237   } \
1238   RNA_property_collection_end(&rna_macro_iter); \
1239   } \
1240   ((void)0)
1241
1242 #define RNA_PROP_BEGIN(sptr, itemptr, prop) \
1243   { \
1244     CollectionPropertyIterator rna_macro_iter; \
1245     for (RNA_property_collection_begin(sptr, prop, &rna_macro_iter); rna_macro_iter.valid; \
1246          RNA_property_collection_next(&rna_macro_iter)) { \
1247       PointerRNA itemptr = rna_macro_iter.ptr;
1248
1249 #define RNA_PROP_END \
1250   } \
1251   RNA_property_collection_end(&rna_macro_iter); \
1252   } \
1253   ((void)0)
1254
1255 #define RNA_STRUCT_BEGIN(sptr, prop) \
1256   { \
1257     CollectionPropertyIterator rna_macro_iter; \
1258     for (RNA_property_collection_begin( \
1259              sptr, RNA_struct_iterator_property((sptr)->type), &rna_macro_iter); \
1260          rna_macro_iter.valid; \
1261          RNA_property_collection_next(&rna_macro_iter)) { \
1262       PropertyRNA *prop = (PropertyRNA *)rna_macro_iter.ptr.data;
1263
1264 #define RNA_STRUCT_END \
1265   } \
1266   RNA_property_collection_end(&rna_macro_iter); \
1267   } \
1268   ((void)0)
1269
1270 /* check if the idproperty exists, for operators */
1271 bool RNA_property_is_set_ex(PointerRNA *ptr, PropertyRNA *prop, bool use_ghost);
1272 bool RNA_property_is_set(PointerRNA *ptr, PropertyRNA *prop);
1273 void RNA_property_unset(PointerRNA *ptr, PropertyRNA *prop);
1274 bool RNA_struct_property_is_set_ex(PointerRNA *ptr, const char *identifier, bool use_ghost);
1275 bool RNA_struct_property_is_set(PointerRNA *ptr, const char *identifier);
1276 bool RNA_property_is_idprop(const PropertyRNA *prop);
1277 bool RNA_property_is_unlink(PropertyRNA *prop);
1278 void RNA_struct_property_unset(PointerRNA *ptr, const char *identifier);
1279
1280 /* python compatible string representation of this property, (must be freed!) */
1281 char *RNA_property_as_string(
1282     struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, int index, int max_prop_length);
1283 char *RNA_pointer_as_string_id(struct bContext *C, PointerRNA *ptr);
1284 char *RNA_pointer_as_string(struct bContext *C,
1285                             PointerRNA *ptr,
1286                             PropertyRNA *prop_ptr,
1287                             PointerRNA *ptr_prop);
1288 char *RNA_pointer_as_string_keywords_ex(struct bContext *C,
1289                                         PointerRNA *ptr,
1290                                         const bool skip_optional_value,
1291                                         const bool all_args,
1292                                         const bool nested_args,
1293                                         const int max_prop_length,
1294                                         PropertyRNA *iterprop);
1295 char *RNA_pointer_as_string_keywords(struct bContext *C,
1296                                      PointerRNA *ptr,
1297                                      const bool skip_optional_value,
1298                                      const bool all_args,
1299                                      const bool nested_args,
1300                                      const int max_prop_length);
1301 char *RNA_function_as_string_keywords(struct bContext *C,
1302                                       FunctionRNA *func,
1303                                       const bool as_function,
1304                                       const bool all_args,
1305                                       const int max_prop_length);
1306
1307 /* Function */
1308
1309 const char *RNA_function_identifier(FunctionRNA *func);
1310 const char *RNA_function_ui_description(FunctionRNA *func);
1311 const char *RNA_function_ui_description_raw(FunctionRNA *func);
1312 int RNA_function_flag(FunctionRNA *func);
1313 int RNA_function_defined(FunctionRNA *func);
1314
1315 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
1316 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr,
1317                                          FunctionRNA *func,
1318                                          const char *identifier);
1319 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
1320
1321 /* Utility */
1322
1323 int RNA_parameter_flag(PropertyRNA *prop);
1324
1325 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
1326 void RNA_parameter_list_free(ParameterList *parms);
1327 int RNA_parameter_list_size(ParameterList *parms);
1328 int RNA_parameter_list_arg_count(ParameterList *parms);
1329 int RNA_parameter_list_ret_count(ParameterList *parms);
1330
1331 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
1332 void RNA_parameter_list_next(ParameterIterator *iter);
1333 void RNA_parameter_list_end(ParameterIterator *iter);
1334
1335 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
1336 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
1337 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, const void *value);
1338 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value);
1339 /* Only for PROP_DYNAMIC properties! */
1340 int RNA_parameter_dynamic_length_get(ParameterList *parms, PropertyRNA *parm);
1341 int RNA_parameter_dynamic_length_get_data(ParameterList *parms, PropertyRNA *parm, void *data);
1342 void RNA_parameter_dynamic_length_set(ParameterList *parms, PropertyRNA *parm, int length);
1343 void RNA_parameter_dynamic_length_set_data(ParameterList *parms,
1344                                            PropertyRNA *parm,
1345                                            void *data,
1346                                            int length);
1347
1348 int RNA_function_call(struct bContext *C,
1349                       struct ReportList *reports,
1350                       PointerRNA *ptr,
1351                       FunctionRNA *func,
1352                       ParameterList *parms);
1353 int RNA_function_call_lookup(struct bContext *C,
1354                              struct ReportList *reports,
1355                              PointerRNA *ptr,
1356                              const char *identifier,
1357                              ParameterList *parms);
1358
1359 int RNA_function_call_direct(struct bContext *C,
1360                              struct ReportList *reports,
1361                              PointerRNA *ptr,
1362                              FunctionRNA *func,
1363                              const char *format,
1364                              ...) ATTR_PRINTF_FORMAT(5, 6);
1365 int RNA_function_call_direct_lookup(struct bContext *C,
1366                                     struct ReportList *reports,
1367                                     PointerRNA *ptr,
1368                                     const char *identifier,
1369                                     const char *format,
1370                                     ...) ATTR_PRINTF_FORMAT(5, 6);
1371 int RNA_function_call_direct_va(struct bContext *C,
1372                                 struct ReportList *reports,
1373                                 PointerRNA *ptr,
1374                                 FunctionRNA *func,
1375                                 const char *format,
1376                                 va_list args);
1377 int RNA_function_call_direct_va_lookup(struct bContext *C,
1378                                        struct ReportList *reports,
1379                                        PointerRNA *ptr,
1380                                        const char *identifier,
1381                                        const char *format,
1382                                        va_list args);
1383
1384 const char *RNA_translate_ui_text(const char *text,
1385                                   const char *text_ctxt,
1386                                   struct StructRNA *type,
1387                                   struct PropertyRNA *prop,
1388                                   int translate);
1389
1390 /* ID */
1391
1392 short RNA_type_to_ID_code(const StructRNA *type);
1393 StructRNA *ID_code_to_RNA_type(short idcode);
1394
1395 #define RNA_POINTER_INVALIDATE(ptr) \
1396   { \
1397     /* this is checked for validity */ \
1398     (ptr)->type = /* should not be needed but prevent bad pointer access, just in case */ \
1399         (ptr)->id.data = NULL; \
1400   } \
1401   (void)0
1402
1403 /* macro which inserts the function name */
1404 #if defined __GNUC__
1405 #  define RNA_warning(format, args...) _RNA_warning("%s: " format "\n", __func__, ##args)
1406 #else
1407 #  define RNA_warning(format, ...) _RNA_warning("%s: " format "\n", __FUNCTION__, __VA_ARGS__)
1408 #endif
1409
1410 void _RNA_warning(const char *format, ...) ATTR_PRINTF_FORMAT(1, 2);
1411
1412 /* Equals test. */
1413
1414 /* Note: In practice, EQ_STRICT and EQ_COMPARE have same behavior currently, and will yield same result. */
1415 typedef enum eRNACompareMode {
1416   /* Only care about equality, not full comparison. */
1417   RNA_EQ_STRICT,           /* set/unset ignored */
1418   RNA_EQ_UNSET_MATCH_ANY,  /* unset property matches anything */
1419   RNA_EQ_UNSET_MATCH_NONE, /* unset property never matches set property */
1420   /* Full comparison. */
1421   RNA_EQ_COMPARE,
1422 } eRNACompareMode;
1423
1424 bool RNA_property_equals(struct Main *bmain,
1425                          struct PointerRNA *ptr_a,
1426                          struct PointerRNA *ptr_b,
1427                          struct PropertyRNA *prop,
1428                          eRNACompareMode mode);
1429 bool RNA_struct_equals(struct Main *bmain,
1430                        struct PointerRNA *ptr_a,
1431                        struct PointerRNA *ptr_b,
1432                        eRNACompareMode mode);
1433
1434 /* Override. */
1435
1436 /* flags for RNA_struct_override_matches. */
1437 typedef enum eRNAOverrideMatch {
1438   /* Do not compare properties that are not overridable. */
1439   RNA_OVERRIDE_COMPARE_IGNORE_NON_OVERRIDABLE = 1 << 0,
1440   /* Do not compare properties that are already overridden. */
1441   RNA_OVERRIDE_COMPARE_IGNORE_OVERRIDDEN = 1 << 1,
1442
1443   /* Create new property override if needed and possible. */
1444   RNA_OVERRIDE_COMPARE_CREATE = 1 << 16,
1445   /* Restore property's value(s) to reference ones if needed and possible. */
1446   RNA_OVERRIDE_COMPARE_RESTORE = 1 << 17,
1447 } eRNAOverrideMatch;
1448
1449 typedef enum eRNAOverrideMatchResult {
1450   /* Some new property overrides were created to take into account differences between local and reference. */
1451   RNA_OVERRIDE_MATCH_RESULT_CREATED = 1 << 0,
1452   /* Some properties were reset to reference values. */
1453   RNA_OVERRIDE_MATCH_RESULT_RESTORED = 1 << 1,
1454 } eRNAOverrideMatchResult;
1455
1456 typedef enum eRNAOverrideStatus {
1457   RNA_OVERRIDE_STATUS_OVERRIDABLE = 1 << 0, /* The property is overridable. */
1458   RNA_OVERRIDE_STATUS_OVERRIDDEN = 1 << 1,  /* The property is overridden. */
1459   RNA_OVERRIDE_STATUS_MANDATORY =
1460       1 << 2, /* Overriding this property is mandatory when creating an override. */
1461   RNA_OVERRIDE_STATUS_LOCKED = 1 << 3, /* The override status of this property is locked. */
1462 } eRNAOverrideStatus;
1463
1464 bool RNA_struct_override_matches(struct Main *bmain,
1465                                  struct PointerRNA *ptr_local,
1466                                  struct PointerRNA *ptr_reference,
1467                                  const char *root_path,
1468                                  struct IDOverrideStatic *override,
1469                                  const eRNAOverrideMatch flags,
1470                                  eRNAOverrideMatchResult *r_report_flags);
1471
1472 bool RNA_struct_override_store(struct Main *bmain,
1473                                struct PointerRNA *ptr_local,
1474                                struct PointerRNA *ptr_reference,
1475                                PointerRNA *ptr_storage,
1476                                struct IDOverrideStatic *override);
1477
1478 void RNA_struct_override_apply(struct Main *bmain,
1479                                struct PointerRNA *ptr_local,
1480                                struct PointerRNA *ptr_override,
1481                                struct PointerRNA *ptr_storage,
1482                                struct IDOverrideStatic *override);
1483
1484 struct IDOverrideStaticProperty *RNA_property_override_property_find(PointerRNA *ptr,
1485                                                                      PropertyRNA *prop);
1486 struct IDOverrideStaticProperty *RNA_property_override_property_get(PointerRNA *ptr,
1487                                                                     PropertyRNA *prop,
1488                                                                     bool *r_created);
1489
1490 struct IDOverrideStaticPropertyOperation *RNA_property_override_property_operation_find(
1491     PointerRNA *ptr, PropertyRNA *prop, const int index, const bool strict, bool *r_strict);
1492 struct IDOverrideStaticPropertyOperation *RNA_property_override_property_operation_get(
1493     PointerRNA *ptr,
1494     PropertyRNA *prop,
1495     const short operation,
1496     const int index,
1497     const bool strict,
1498     bool *r_strict,
1499     bool *r_created);
1500
1501 eRNAOverrideStatus RNA_property_static_override_status(PointerRNA *ptr,
1502                                                        PropertyRNA *prop,
1503                                                        const int index);
1504
1505 void RNA_struct_state_owner_set(const char *name);
1506 const char *RNA_struct_state_owner_get(void);
1507
1508 #ifdef __cplusplus
1509 }
1510 #endif
1511
1512 #endif /* __RNA_ACCESS_H__ */