rna_internal_types.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <optional>
#include <string>
 
#include "DNA_listBase.h"
 
#include "RNA_access.hh"
#include "RNA_define.hh"
#include "RNA_types.hh"
 
struct BlenderRNA;
struct CollectionPropertyIterator;
struct ContainerRNA;
struct FunctionRNA;
struct GHash;
struct IDOverrideLibrary;
struct IDOverrideLibraryPropertyOperation;
struct IDProperty;
struct Main;
struct PointerRNA;
struct PropertyRNA;
struct ReportList;
struct Scene;
struct StructRNA;
struct bContext;
 
/* Function Callbacks */
 
using UpdateFunc = void (*)(Main *bmain, Scene *active_scene, PointerRNA *ptr);
using ContextPropUpdateFunc = void (*)(bContext *C, PointerRNA *ptr, PropertyRNA *prop);
using ContextUpdateFunc = void (*)(bContext *C, PointerRNA *ptr);
 
using EditableFunc = int (*)(const PointerRNA *ptr, const char **r_info);
using ItemEditableFunc = int (*)(const PointerRNA *ptr, int index);
using IDPropertiesFunc = IDProperty **(*)(PointerRNA *ptr);
using StructRefineFunc = StructRNA *(*)(PointerRNA *ptr);
using StructPathFunc = std::optional<std::string> (*)(const PointerRNA *ptr);
 
using PropArrayLengthGetFunc = int (*)(const PointerRNA *ptr, int length[RNA_MAX_ARRAY_DIMENSION]);
using PropBooleanGetFunc = bool (*)(PointerRNA *ptr);
using PropBooleanSetFunc = void (*)(PointerRNA *ptr, bool value);
using PropBooleanArrayGetFunc = void (*)(PointerRNA *ptr, bool *values);
using PropBooleanArraySetFunc = void (*)(PointerRNA *ptr, const bool *values);
using PropIntGetFunc = int (*)(PointerRNA *ptr);
using PropIntSetFunc = void (*)(PointerRNA *ptr, int value);
using PropIntArrayGetFunc = void (*)(PointerRNA *ptr, int *values);
using PropIntArraySetFunc = void (*)(PointerRNA *ptr, const int *values);
using PropIntRangeFunc = void (*)(PointerRNA *ptr, int *min, int *max, int *softmin, int *softmax);
using PropFloatGetFunc = float (*)(PointerRNA *ptr);
using PropFloatSetFunc = void (*)(PointerRNA *ptr, float value);
using PropFloatArrayGetFunc = void (*)(PointerRNA *ptr, float *values);
using PropFloatArraySetFunc = void (*)(PointerRNA *ptr, const float *values);
using PropFloatRangeFunc =
    void (*)(PointerRNA *ptr, float *min, float *max, float *softmin, float *softmax);
using PropStringGetFunc = void (*)(PointerRNA *ptr, char *value);
using PropStringLengthFunc = int (*)(PointerRNA *ptr);
using PropStringSetFunc = void (*)(PointerRNA *ptr, const char *value);
using PropEnumGetFunc = int (*)(PointerRNA *ptr);
using PropEnumSetFunc = void (*)(PointerRNA *ptr, int value);
using PropEnumItemFunc = const EnumPropertyItem *(*)(bContext *C,
                                                     PointerRNA *ptr,
                                                     PropertyRNA *prop,
                                                     bool *r_free);
using PropPointerGetFunc = PointerRNA (*)(PointerRNA *ptr);
using PropPointerTypeFunc = StructRNA *(*)(PointerRNA *ptr);
using PropPointerSetFunc = void (*)(PointerRNA *ptr, const PointerRNA value, ReportList *reports);
using PropPointerPollFunc = bool (*)(PointerRNA *ptr, const PointerRNA value);
using PropPointerPollFuncPy = bool (*)(PointerRNA *ptr,
                                       const PointerRNA value,
                                       const PropertyRNA *prop);
using PropCollectionBeginFunc = void (*)(CollectionPropertyIterator *iter, PointerRNA *ptr);
using PropCollectionNextFunc = void (*)(CollectionPropertyIterator *iter);
using PropCollectionEndFunc = void (*)(CollectionPropertyIterator *iter);
using PropCollectionGetFunc = PointerRNA (*)(CollectionPropertyIterator *iter);
using PropCollectionLengthFunc = int (*)(PointerRNA *ptr);
using PropCollectionLookupIntFunc = bool (*)(PointerRNA *ptr, int key, PointerRNA *r_ptr);
using PropCollectionLookupStringFunc = bool (*)(PointerRNA *ptr,
                                                const char *key,
                                                PointerRNA *r_ptr);
using PropCollectionAssignIntFunc = bool (*)(PointerRNA *ptr,
                                             int key,
                                             const PointerRNA *assign_ptr);
 
/* extended versions with PropertyRNA argument */
using PropBooleanGetFuncEx = bool (*)(PointerRNA *ptr, PropertyRNA *prop);
using PropBooleanSetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, bool value);
using PropBooleanArrayGetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, bool *values);
using PropBooleanArraySetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, const bool *values);
using PropIntGetFuncEx = int (*)(PointerRNA *ptr, PropertyRNA *prop);
using PropIntSetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, int value);
using PropIntArrayGetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, int *values);
using PropIntArraySetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, const int *values);
using PropIntRangeFuncEx =
    void (*)(PointerRNA *ptr, PropertyRNA *prop, int *min, int *max, int *softmin, int *softmax);
using PropFloatGetFuncEx = float (*)(PointerRNA *ptr, PropertyRNA *prop);
using PropFloatSetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, float value);
using PropFloatArrayGetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, float *values);
using PropFloatArraySetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, const float *values);
using PropFloatRangeFuncEx = void (*)(
    PointerRNA *ptr, PropertyRNA *prop, float *min, float *max, float *softmin, float *softmax);
using PropStringGetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, char *value);
using PropStringLengthFuncEx = int (*)(PointerRNA *ptr, PropertyRNA *prop);
using PropStringSetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, const char *value);
using PropEnumGetFuncEx = int (*)(PointerRNA *ptr, PropertyRNA *prop);
using PropEnumSetFuncEx = void (*)(PointerRNA *ptr, PropertyRNA *prop, int value);
 
/* Handling override operations, and also comparison. */
 
struct PropertyRNAOrID {
  PointerRNA ptr;
 
  PropertyRNA *rawprop;
  PropertyRNA *rnaprop;
  IDProperty *idprop;
  const char *identifier;
 
  bool is_idprop;
  bool is_rna_storage_idprop;
  bool is_set;
 
  bool is_array;
  uint array_len;
};
 
struct RNAPropertyOverrideDiffContext {
  /* Using #PropertyRNAOrID for properties info here allows to cover all three cases ('real' RNA
   * properties, 'runtime' RNA properties created from python and stored in IDPropertoies, and
   * 'pure' IDProperties).
   *
   * This is necessary, because we cannot perform 'set/unset' checks on resolved properties
   * (unset IDProperties would merely be nullptr then). */
  PropertyRNAOrID *prop_a = nullptr;
  PropertyRNAOrID *prop_b = nullptr;
 
  eRNACompareMode mode = RNA_EQ_COMPARE;
 
  IDOverrideLibrary *liboverride = nullptr;
  const char *rna_path = nullptr;
  size_t rna_path_len = 0;
  eRNAOverrideMatch liboverride_flags = eRNAOverrideMatch(0);
 
  int comparison = 0;
  eRNAOverrideMatchResult report_flag = eRNAOverrideMatchResult(0);
};
using RNAPropOverrideDiff = void (*)(Main *bmain, RNAPropertyOverrideDiffContext &rnadiff_ctx);
 
using RNAPropOverrideStore = bool (*)(Main *bmain,
                                      PointerRNA *ptr_local,
                                      PointerRNA *ptr_reference,
                                      PointerRNA *ptr_storage,
                                      PropertyRNA *prop_local,
                                      PropertyRNA *prop_reference,
                                      PropertyRNA *prop_storage,
                                      int len_local,
                                      int len_reference,
                                      int len_storage,
                                      IDOverrideLibraryPropertyOperation *opop);
 
struct RNAPropertyOverrideApplyContext {
  eRNAOverrideApplyFlag flag = RNA_OVERRIDE_APPLY_FLAG_NOP;
  bool do_insert = false;
 
  PointerRNA ptr_dst = {0};
  PointerRNA ptr_src = {0};
  PointerRNA ptr_storage = {0};
  PropertyRNA *prop_dst = nullptr;
  PropertyRNA *prop_src = nullptr;
  PropertyRNA *prop_storage = nullptr;
 
  int len_dst = 0;
  int len_src = 0;
  int len_storage = 0;
 
  PointerRNA ptr_item_dst = {0};
  PointerRNA ptr_item_src = {0};
  PointerRNA ptr_item_storage = {0};
 
  IDOverrideLibrary *liboverride = nullptr;
  IDOverrideLibraryProperty *liboverride_property = nullptr;
  IDOverrideLibraryPropertyOperation *liboverride_operation = nullptr;
 
  /* TODO: Add more refined/descriptive result report? */
};
using RNAPropOverrideApply = bool (*)(Main *bmain, RNAPropertyOverrideApplyContext &rnaapply_ctx);
 
/* Container - generic abstracted container of RNA properties */
struct ContainerRNA {
  void *next, *prev;
 
  struct GHash *prophash;
  ListBase properties;
};
 
struct FunctionRNA {
  /* structs are containers of properties */
  ContainerRNA cont;
 
  /* unique identifier, keep after 'cont' */
  const char *identifier;
  /* various options */
  int flag;
 
  /* single line description, displayed in the tooltip for example */
  const char *description;
 
  /* callback to execute the function */
  CallFunc call;
 
  /* parameter for the return value
   * NOTE: this is only the C return value, rna functions can have multiple return values. */
  PropertyRNA *c_ret;
};
 
struct PropertyRNA {
  PropertyRNA *next, *prev;
 
  /* magic bytes to distinguish with IDProperty */
  int magic;
 
  /* unique identifier */
  const char *identifier;
  /* various options */
  int flag;
  /* various override options */
  int flag_override;
  /* Function parameters flags. */
  short flag_parameter;
  /* Internal ("private") flags. */
  short flag_internal;
  /* The subset of StructRNA.prop_tag_defines values that applies to this property. */
  short tags;
 
  /* user readable name */
  const char *name;
  /* single line description, displayed in the tooltip for example */
  const char *description;
  /* icon ID */
  int icon;
  /* context for translation */
  const char *translation_context;
 
  /* property type as it appears to the outside */
  PropertyType type;
  /* subtype, 'interpretation' of the property */
  PropertySubType subtype;
  /* if non-NULL, overrides arraylength. Must not return 0? */
  PropArrayLengthGetFunc getlength;
  /* dimension of array */
  unsigned int arraydimension;
  /* Array lengths for all dimensions (when `arraydimension > 0`). */
  unsigned int arraylength[RNA_MAX_ARRAY_DIMENSION];
  unsigned int totarraylength;
 
  /* callback for updates on change */
  UpdateFunc update;
  int noteflag;
 
  /* Callback for testing if editable. Its r_info parameter can be used to
   * return info on editable state that might be shown to user. E.g. tooltips
   * of disabled buttons can show reason why button is disabled using this. */
  EditableFunc editable;
  /* callback for testing if array-item editable (if applicable) */
  ItemEditableFunc itemeditable;
 
  /* Override handling callbacks (diff is also used for comparison). */
  RNAPropOverrideDiff override_diff;
  RNAPropOverrideStore override_store;
  RNAPropOverrideApply override_apply;
 
  /* raw access */
  int rawoffset;
  RawPropertyType rawtype;
 
  /* This is used for accessing props/functions of this property
   * any property can have this but should only be used for collections and arrays
   * since python will convert int/bool/pointer's */
  StructRNA *srna; /* attributes attached directly to this collection */
 
  /* python handle to hold all callbacks
   * (in a pointer array at the moment, may later be a tuple) */
  void *py_data;
};
 
/* internal flags WARNING! 16bits only! */
enum PropertyFlagIntern {
  PROP_INTERN_BUILTIN = (1 << 0),
  PROP_INTERN_RUNTIME = (1 << 1),
  PROP_INTERN_RAW_ACCESS = (1 << 2),
  PROP_INTERN_RAW_ARRAY = (1 << 3),
  PROP_INTERN_FREE_POINTERS = (1 << 4),
  /* Negative mirror of PROP_PTR_NO_OWNERSHIP, used to prevent automatically setting that one in
   * makesrna when pointer is an ID... */
  PROP_INTERN_PTR_OWNERSHIP_FORCED = (1 << 5),
};
 
/* Property Types */
 
struct BoolPropertyRNA {
  PropertyRNA property;
 
  PropBooleanGetFunc get;
  PropBooleanSetFunc set;
  PropBooleanArrayGetFunc getarray;
  PropBooleanArraySetFunc setarray;
 
  PropBooleanGetFuncEx get_ex;
  PropBooleanSetFuncEx set_ex;
  PropBooleanArrayGetFuncEx getarray_ex;
  PropBooleanArraySetFuncEx setarray_ex;
 
  PropBooleanGetFuncEx get_default;
  PropBooleanArrayGetFuncEx get_default_array;
  bool defaultvalue;
  const bool *defaultarray;
};
 
struct IntPropertyRNA {
  PropertyRNA property;
 
  PropIntGetFunc get;
  PropIntSetFunc set;
  PropIntArrayGetFunc getarray;
  PropIntArraySetFunc setarray;
  PropIntRangeFunc range;
 
  PropIntGetFuncEx get_ex;
  PropIntSetFuncEx set_ex;
  PropIntArrayGetFuncEx getarray_ex;
  PropIntArraySetFuncEx setarray_ex;
  PropIntRangeFuncEx range_ex;
 
  PropertyScaleType ui_scale_type;
  int softmin, softmax;
  int hardmin, hardmax;
  int step;
 
  PropIntGetFuncEx get_default;
  PropIntArrayGetFuncEx get_default_array;
  int defaultvalue;
  const int *defaultarray;
};
 
struct FloatPropertyRNA {
  PropertyRNA property;
 
  PropFloatGetFunc get;
  PropFloatSetFunc set;
  PropFloatArrayGetFunc getarray;
  PropFloatArraySetFunc setarray;
  PropFloatRangeFunc range;
 
  PropFloatGetFuncEx get_ex;
  PropFloatSetFuncEx set_ex;
  PropFloatArrayGetFuncEx getarray_ex;
  PropFloatArraySetFuncEx setarray_ex;
  PropFloatRangeFuncEx range_ex;
 
  PropertyScaleType ui_scale_type;
  float softmin, softmax;
  float hardmin, hardmax;
  float step;
  int precision;
 
  PropFloatGetFuncEx get_default;
  PropFloatArrayGetFuncEx get_default_array;
 
  float defaultvalue;
  const float *defaultarray;
};
 
struct StringPropertyRNA {
  PropertyRNA property;
 
  PropStringGetFunc get;
  PropStringLengthFunc length;
  PropStringSetFunc set;
 
  PropStringGetFuncEx get_ex;
  PropStringLengthFuncEx length_ex;
  PropStringSetFuncEx set_ex;
 
  StringPropertySearchFunc search;
  eStringPropertySearchFlag search_flag;
 
  int maxlength; /* includes string terminator! */
 
  const char *defaultvalue;
};
 
struct EnumPropertyRNA {
  PropertyRNA property;
 
  PropEnumGetFunc get;
  PropEnumSetFunc set;
  PropEnumItemFunc item_fn;
 
  PropEnumGetFuncEx get_ex;
  PropEnumSetFuncEx set_ex;
 
  const EnumPropertyItem *item;
  int totitem;
 
  int defaultvalue;
  const char *native_enum_type;
};
 
struct PointerPropertyRNA {
  PropertyRNA property;
 
  PropPointerGetFunc get;
  PropPointerSetFunc set;
  PropPointerTypeFunc type_fn;
  PropPointerPollFunc poll;
 
  StructRNA *type;
};
 
struct CollectionPropertyRNA {
  PropertyRNA property;
 
  PropCollectionBeginFunc begin;
  PropCollectionNextFunc next;
  PropCollectionEndFunc end; /* optional */
  PropCollectionGetFunc get;
  PropCollectionLengthFunc length;             /* optional */
  PropCollectionLookupIntFunc lookupint;       /* optional */
  PropCollectionLookupStringFunc lookupstring; /* optional */
  PropCollectionAssignIntFunc assignint;       /* optional */
 
  StructRNA *item_type; /* the type of this item */
};
 
/* changes to this struct require updating rna_generate_struct in makesrna.cc */
struct StructRNA {
  /* structs are containers of properties */
  ContainerRNA cont;
 
  /* unique identifier, keep after 'cont' */
  const char *identifier;
 
  void *py_type;
  void *blender_type;
 
  /* various options */
  int flag;
  /* Each StructRNA type can define its own tags which properties can set
   * (PropertyRNA.tags) for changed behavior based on struct-type. */
  const EnumPropertyItem *prop_tag_defines;
 
  /* user readable name */
  const char *name;
  /* single line description, displayed in the tooltip for example */
  const char *description;
  /* context for translation */
  const char *translation_context;
  /* icon ID */
  int icon;
 
  /* property that defines the name */
  PropertyRNA *nameproperty;
 
  /* property to iterate over properties */
  PropertyRNA *iteratorproperty;
 
  StructRNA *base;
 
  /* only use for nested structs, where both the parent and child access
   * the same C Struct but nesting is used for grouping properties.
   * The parent property is used so we know NULL checks are not needed,
   * and that this struct will never exist without its parent */
  StructRNA *nested;
 
  /* function to give the more specific type */
  StructRefineFunc refine;
 
  /* function to find path to this struct in an ID */
  StructPathFunc path;
 
  /* function to register/unregister subclasses */
  StructRegisterFunc reg;
  StructUnregisterFunc unreg;
  StructInstanceFunc instance;
 
  IDPropertiesFunc idproperties;
 
  /* functions of this struct */
  ListBase functions;
};
 
/* Blender RNA
 *
 * Root RNA data structure that lists all struct types. */
 
struct BlenderRNA {
  ListBase structs;
  /* A map of structs: {StructRNA.identifier -> StructRNA}
   * These are ensured to have unique names (with STRUCT_PUBLIC_NAMESPACE enabled). */
  GHash *structs_map;
  /* Needed because types with an empty identifier aren't included in 'structs_map'. */
  unsigned int structs_len;
};
 
#define CONTAINER_RNA_ID(cont) (*(const char **)(((ContainerRNA *)(cont)) + 1))