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