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