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