#include <optional>
#include <string>
#include "RNA_types.hh"

Classes
struct	RNAPath

struct	PropertyElemRNA

Functions
bool	operator== (const RNAPath &left, const RNAPath &right)

char *	RNA_path_append (const char path, const PointerRNA ptr, PropertyRNA prop, int intkey, const char strkey)

const char *	RNA_path_array_index_token_find (const char rna_path, const PropertyRNA array_prop)

bool	RNA_path_resolve (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA *r_prop)

bool	RNA_path_resolve_full (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA r_prop, int r_index)

bool	RNA_path_resolve_full_maybe_null (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA r_prop, int r_index)

bool	RNA_path_resolve_property (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA *r_prop)

bool	RNA_path_resolve_property_full (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA r_prop, int r_index)

bool	RNA_path_resolve_property_and_item_pointer (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA r_prop, PointerRNA r_item_ptr)

bool	RNA_path_resolve_property_and_item_pointer_full (const PointerRNA ptr, const char path, PointerRNA r_ptr, PropertyRNA r_prop, int r_index, PointerRNA *r_item_ptr)

bool	RNA_path_resolve_elements (PointerRNA ptr, const char path, ListBase *r_elements)

std::optional< std::string >	RNA_path_from_struct_to_idproperty (PointerRNA ptr, const IDProperty needle)

ID *	RNA_find_real_ID_and_path (ID id, const char *r_path)

std::optional< std::string >	RNA_path_from_ID_to_struct (const PointerRNA *ptr)

std::optional< std::string >	RNA_path_from_real_ID_to_struct (Main bmain, const PointerRNA ptr, ID **r_real)

std::optional< std::string >	RNA_path_from_ID_to_property (const PointerRNA ptr, PropertyRNA prop)

std::string	RNA_path_from_ptr_to_property_index (const PointerRNA ptr, PropertyRNA prop, int index_dim, int index)

std::optional< std::string >	RNA_path_from_ID_to_property_index (const PointerRNA ptr, PropertyRNA prop, int index_dim, int index)

std::optional< std::string >	RNA_path_from_real_ID_to_property_index (Main bmain, const PointerRNA ptr, PropertyRNA prop, int index_dim, int index, ID *r_real_id)

std::optional< std::string >	RNA_path_resolve_from_type_to_property (const PointerRNA ptr, PropertyRNA prop, const StructRNA *type)

std::string	RNA_path_full_ID_py (ID *id)

std::optional< std::string >	RNA_path_full_struct_py (const PointerRNA *ptr)

std::optional< std::string >	RNA_path_full_property_py_ex (const PointerRNA ptr, PropertyRNA prop, int index, bool use_fallback)

std::optional< std::string >	RNA_path_full_property_py (const PointerRNA ptr, PropertyRNA prop, int index)

std::optional< std::string >	RNA_path_struct_property_py (PointerRNA ptr, PropertyRNA prop, int index)

std::string	RNA_path_property_py (const PointerRNA ptr, PropertyRNA prop, int index)

Detailed Description

RNA paths are a way to refer to pointers and properties with a string, using a syntax like: scenes[0].objects["Cube"].data.verts[7].co

This provides a way to refer to RNA data while being detached from any particular pointers, which is useful in a number of applications, like UI code or Actions, though efficiency is a concern.

Definition in file RNA_path.hh.

Function Documentation

◆ operator==()

bool operator==	(	const RNAPath &	left,
		const RNAPath &	right )

NOTE: equality is defined in a specific way here to reflect the semantic meaning of RNAPath. Since the key existing indicates a key-based array element, with the index then only serving as a fallback, the index only affects the equality result if neither RNAPath has a key specified. (See the main RNAPath documentation above for the specific semantics of key and index.)

Definition at line 37 of file rna_path.cc.

◆ RNA_find_real_ID_and_path()

ID * RNA_find_real_ID_and_path	(	ID *	id,
		const char **	r_path )

Find the actual ID pointer and path from it to the given ID.

Parameters

	id	ID reference to search the global owner for.
[out]	r_path	Path from the real ID to the initial ID.

Returns: The ID pointer, or NULL in case of failure.

Definition at line 947 of file rna_path.cc.

References BKE_id_owner_get(), BLI_assert_msg, GS, ID_FLAG_EMBEDDED_DATA, ID_GR, and ID_NT.

Referenced by RNA_path_full_ID_py(), rna_prepend_real_ID_path(), and rna_property_override_property_real_id_owner().

◆ RNA_path_append()

char * RNA_path_append	(	const char *	path,
		const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	intkey,
		const char *	strkey )

Definition at line 606 of file rna_path.cc.

References BLI_array_alloca, BLI_dynstr_append(), BLI_dynstr_free(), BLI_dynstr_get_cstring(), BLI_dynstr_new(), BLI_str_escape(), PROP_COLLECTION, result, RNA_property_identifier(), RNA_property_type(), and SNPRINTF.

Referenced by blender::ed::outliner::OverrideRNAPathTreeBuilder::build_path(), and blender::ed::outliner::tree_element_to_path().

◆ RNA_path_array_index_token_find()

const char * RNA_path_array_index_token_find	(	const char *	rna_path,
		const PropertyRNA *	array_prop )

Search for the start of the 'rna array index' part of the given rna_path.

Given the root RNA pointer and resolved RNA property, and the RNA path, return the first character in rna_path that is part of the array index for the given property. Return NULL if none can be found, e.g. because the property is not an RNA array.

Parameters

array_prop if not NULL, the PropertyRNA assumed to be the last one from the RNA path. Only used to ensure it is a valid array property.

Definition at line 715 of file rna_path.cc.

References PropertyRNA::arraydimension, BLI_assert, ELEM, PROP_BOOLEAN, PROP_FLOAT, PROP_INT, PropertyRNA::type, and UNLIKELY.

Referenced by BKE_lib_override_library_property_is_animated().

◆ RNA_path_from_ID_to_property()

std::optional< std::string > RNA_path_from_ID_to_property	(	const PointerRNA *	ptr,
		PropertyRNA *	prop )

Definition at line 1166 of file rna_path.cc.

References ptr, and RNA_path_from_ID_to_property_index().

Referenced by add_driver_button_invoke(), add_driver_button_none(), add_keyingset_button_exec(), ANIM_channel_draw_widgets(), blender::animrig::autokeyframe_property(), BKE_fcurve_find_by_rna_context_ui(), BKE_keyblock_curval_rnapath_get(), clear_key_button_exec(), copy_as_driver_button_poll(), copy_data_path_button_poll(), copy_driver_button_exec(), delete_key_button_exec(), draw_grease_pencil_layer_widgets(), driverdropper_sample(), blender::ed::object::followpath_path_animate_exec(), get_fcurves_of_property(), blender::interface::internal::get_property_drivers(), id_data_find_fcurve(), insert_key_button_exec(), blender::animrig::insert_key_layered_action(), blender::animrig::insert_keyframes(), paste_driver_button_exec(), blender::interface::internal::paste_property_drivers(), pyrna_prop_path_from_id(), pyrna_struct_anim_args_parse_ex(), pyrna_struct_getattro(), pyrna_struct_path_from_id(), remove_driver_button_exec(), remove_keyingset_button_exec(), RNA_path_full_property_py_ex(), RNA_path_resolve_from_type_to_property(), RNA_path_struct_property_py(), RNA_property_overridden(), rna_property_override_property_real_id_owner(), RNA_property_path_from_ID_check(), RNA_struct_override_matches(), ui_but_anim_expression_create(), and UI_context_copy_to_selected_list().

◆ RNA_path_from_ID_to_property_index()

std::optional< std::string > RNA_path_from_ID_to_property_index	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index_dim,
		int	index )

Parameters

index_dim	The dimension to show, 0 disables. 1 for 1d array, 2 for 2d. etc.
index	The flattened index to use when `index_dim > 0`, this is expanded when used with multi-dimensional arrays.

Definition at line 1149 of file rna_path.cc.

References PointerRNA::data, PointerRNA::owner_id, ptr, RNA_path_from_ID_to_struct(), rna_path_from_ptr_to_property_index_ex(), RNA_struct_is_ID(), and PointerRNA::type.

Referenced by copy_data_path_button_exec(), RNA_path_from_ID_to_property(), and RNA_path_from_real_ID_to_property_index().

◆ RNA_path_from_ID_to_struct()

std::optional< std::string > RNA_path_from_ID_to_struct ( const PointerRNA * ptr )

Definition at line 1007 of file rna_path.cc.

References PointerRNA::data, StructRNA::nested, PointerRNA::owner_id, StructRNA::path, ptr, RNA_id_pointer_create(), rna_path_from_ID_to_idpgroup(), RNA_property_identifier(), RNA_PropertyGroup, rna_struct_find_nested(), RNA_struct_is_a(), RNA_struct_is_ID(), and PointerRNA::type.

Referenced by DEG_get_evaluated_rna_pointer(), fcurves_to_pchan_links_get(), get_item_transform_flags_and_fcurves(), blender::ed::space_node::node_group_make_insert_selected(), blender::ed::space_node::node_group_separate_selected(), blender::ed::space_node::node_group_ungroup(), pyrna_struct_anim_args_parse_no_resolve(), pyrna_struct_path_from_id(), RNA_path_from_ID_to_property_index(), RNA_path_from_real_ID_to_struct(), RNA_path_full_struct_py(), RNA_path_resolve_from_type_to_property(), WM_context_path_resolve_property_full(), and WM_msg_subscribe_rna_params().

◆ RNA_path_from_ptr_to_property_index()

std::string RNA_path_from_ptr_to_property_index	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index_dim,
		int	index )

Definition at line 1141 of file rna_path.cc.

References ptr, and rna_path_from_ptr_to_property_index_ex().

Referenced by pyrna_struct_getattro(), RNA_path_property_py(), and UI_context_copy_to_selected_list().

◆ RNA_path_from_real_ID_to_property_index()

std::optional< std::string > RNA_path_from_real_ID_to_property_index	(	Main *	bmain,
		const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index_dim,
		int	index,
		ID **	r_real_id )

Definition at line 1171 of file rna_path.cc.

References PointerRNA::owner_id, ptr, RNA_path_from_ID_to_property_index(), and rna_prepend_real_ID_path().

Referenced by copy_as_driver_button_exec(), copy_data_path_button_exec(), and pyrna_prop_repr_ex().

◆ RNA_path_from_real_ID_to_struct()

std::optional< std::string > RNA_path_from_real_ID_to_struct	(	Main *	bmain,
		const PointerRNA *	ptr,
		ID **	r_real )

Definition at line 1049 of file rna_path.cc.

References PointerRNA::owner_id, ptr, RNA_path_from_ID_to_struct(), and rna_prepend_real_ID_path().

Referenced by pyrna_struct_repr().

◆ RNA_path_from_struct_to_idproperty()

std::optional< std::string > RNA_path_from_struct_to_idproperty	(	PointerRNA *	ptr,
		const IDProperty *	needle )

Find the path from the structure referenced by the pointer to the runtime RNA-defined IDProperty object.

Note: Does not handle pure user-defined IDProperties (a.k.a. custom properties).

Parameters

ptr	Reference to the object owning the custom property storage.
needle	Custom property object to find.

Returns: Relative path or NULL.

Definition at line 913 of file rna_path.cc.

References MEM_freeN(), ptr, rna_idp_path(), and RNA_struct_idprops().

Referenced by rna_path_from_ID_to_idpgroup(), and UI_context_copy_to_selected_list().

◆ RNA_path_full_ID_py()

std::string RNA_path_full_ID_py ( ID * id )

Get the ID as a python representation, eg: bpy.data.foo["bar"]

Definition at line 1225 of file rna_path.cc.

References BKE_idtype_idcode_to_name_plural(), BLI_str_escape(), GS, ID_IS_LINKED, and RNA_find_real_ID_and_path().

Referenced by console_drop_id_copy(), RNA_path_full_property_py_ex(), RNA_path_full_struct_py(), rna_pointer_as_string__bldata(), and text_drop_id_copy().

◆ RNA_path_full_property_py()

std::optional< std::string > RNA_path_full_property_py	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Definition at line 1311 of file rna_path.cc.

References ptr, and RNA_path_full_property_py_ex().

Referenced by WM_prop_pystring_assign().

◆ RNA_path_full_property_py_ex()

std::optional< std::string > RNA_path_full_property_py_ex	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index,
		bool	use_fallback )

Get the ID.struct.property as a python representation, eg: bpy.data.foo["bar"].some_struct.some_prop[10]

Definition at line 1276 of file rna_path.cc.

References PointerRNA::owner_id, ptr, RNA_path_from_ID_to_property(), RNA_path_full_ID_py(), RNA_property_array_check(), and RNA_property_identifier().

Referenced by copy_data_path_button_exec(), RNA_path_full_property_py(), and ui_tooltip_data_from_button_or_extra_icon().

◆ RNA_path_full_struct_py()

std::optional< std::string > RNA_path_full_struct_py ( const PointerRNA * ptr )

Get the ID.struct as a python representation, eg: bpy.data.foo["bar"].some_struct

Definition at line 1260 of file rna_path.cc.

References PointerRNA::owner_id, ptr, RNA_path_from_ID_to_struct(), and RNA_path_full_ID_py().

Referenced by copy_data_path_button_exec(), rna_pointer_as_string__bldata(), and ui_tooltip_data_from_button_or_extra_icon().

◆ RNA_path_property_py()

std::string RNA_path_property_py	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Get the struct.property as a python representation, eg: some_prop[10]

Definition at line 1345 of file rna_path.cc.

References ptr, RNA_path_from_ptr_to_property_index(), and RNA_property_array_check().

Referenced by ui_but_user_menu_add(), ui_but_user_menu_find(), and WM_context_path_resolve_property_full().

◆ RNA_path_resolve()

bool RNA_path_resolve	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop )

Resolve the given RNA Path to find the pointer and/or property indicated by fully resolving the path.

Warning: Unlike RNA_path_resolve_property(), that one will try to follow RNAPointers, e.g. the path 'parent' applied to a RNAObject ptr will return the object.parent in r_ptr, and a NULL r_prop...

Note: Assumes all pointers provided are valid

Returns: True if path can be resolved to a valid "pointer + property" OR "pointer only"

Definition at line 525 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

Referenced by DEG_get_evaluated_rna_pointer(), depthdropper_get_path(), eyedropper_init(), find_rna_property_rgba(), radial_control_get_path(), RNA_property_path_from_ID_check(), UI_pie_menu_invoke_from_rna_enum(), and wm_msg_rna_update_by_id().

◆ RNA_path_resolve_elements()

bool RNA_path_resolve_elements	(	PointerRNA *	ptr,
		const char *	path,
		ListBase *	r_elements )

Resolve the given RNA Path into a linked list of PropertyElemRNA's.

To be used when complex operations over path are needed, like e.g. get relative paths, to avoid too much string operations.

Returns: True if there was no error while resolving the path

Note: Assumes all pointers provided are valid

Definition at line 601 of file rna_path.cc.

References ptr, and rna_path_parse().

Referenced by blender::ed::outliner::OverrideRNAPathTreeBuilder::build_path(), and RNA_path_resolve_from_type_to_property().

◆ RNA_path_resolve_from_type_to_property()

std::optional< std::string > RNA_path_resolve_from_type_to_property	(	const PointerRNA *	ptr,
		PropertyRNA *	prop,
		const StructRNA *	type )

Returns: the path to given ptr/prop from the closest ancestor of given type, if any (else return NULL).

Definition at line 1189 of file rna_path.cc.

References BLI_listbase_clear(), blender::StringRef::drop_prefix(), LISTBASE_FOREACH_BACKWARD, LISTBASE_FOREACH_MUTABLE, PointerRNA::owner_id, ptr, RNA_id_pointer_create(), RNA_path_from_ID_to_property(), RNA_path_from_ID_to_struct(), RNA_path_resolve_elements(), and RNA_struct_is_a().

Referenced by UI_context_copy_to_selected_list().

◆ RNA_path_resolve_full()

bool RNA_path_resolve_full	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop,
		int *	r_index )

Resolve the given RNA Path to find the pointer and/or property + array index indicated by fully resolving the path.

Note: Assumes all pointers provided are valid.

Returns: True if path can be resolved to a valid "pointer + property" OR "pointer only"

Definition at line 537 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

Referenced by BCAnimationCurve::add_value_from_rna(), blender::deg::DepsgraphRelationBuilder::build_animdata_fcurve_target(), blender::deg::DepsgraphRelationBuilder::build_driver_data(), blender::deg::DepsgraphNodeBuilder::build_driver_id_property(), blender::deg::DepsgraphRelationBuilder::build_driver_id_property(), driver_get_variable_property(), blender::deg::RNAPathKey::RNAPathKey(), blender::deg::RNAPathKey::RNAPathKey(), and screen_user_menu_draw().

◆ RNA_path_resolve_full_maybe_null()

bool RNA_path_resolve_full_maybe_null	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop,
		int *	r_index )

A version of RNA_path_resolve_full doesn't check the value of PointerRNA.data.

Note: While it's correct to ignore the value of PointerRNA.data most callers need to know if the resulting pointer was found and not null.

Definition at line 547 of file rna_path.cc.

References ptr, and rna_path_parse().

Referenced by pyrna_struct_path_resolve().

◆ RNA_path_resolve_property()

bool RNA_path_resolve_property	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop )

Resolve the given RNA Path to find both the pointer AND property indicated by fully resolving the path.

This is a convenience method to avoid logic errors and ugly syntax.

Note: Assumes all pointers provided are valid

Returns: True only if both a valid pointer and property are found after resolving the path

Definition at line 553 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

Referenced by achannel_setting_slider_cb(), blender::animrig::action_fcurve_ensure(), ANIM_add_driver(), ANIM_add_driver_with_target(), ANIM_channel_draw_widgets(), ANIM_copy_driver(), ANIM_list_elem_update(), ANIM_paste_driver(), ANIM_unit_mapping_get_factor(), BKE_animsys_rna_path_resolve(), blend_to_default_fcurve(), calculate_selection_fcurve_bounds(), check_rna_path_is_valid(), clean_fcurve(), blender::animrig::clear_keyframe(), construct_rna_paths(), blender::animrig::delete_keyframe(), draw_grease_pencil_layer_widgets(), getname_anim_fcurve(), graph_panel_key_properties(), blender::deg::AnimatedPropertyStorage::initializeFromID(), blender::animrig::insert_key_layered_action(), insert_key_to_keying_set_path(), blender::animrig::insert_keyframe_direct(), blender::animrig::insert_keyframes(), lib_override_library_id_reset_do(), nlaevalchan_verify(), override_remove_button_exec(), pastebuf_match_path_property(), blender::animrig::reevaluate_fcurve_errors(), RNA_struct_find_property(), RNA_struct_override_apply(), RNA_struct_override_store(), UI_context_copy_to_selected_check(), UI_context_copy_to_selected_list(), and update_autoflags_fcurve().

◆ RNA_path_resolve_property_and_item_pointer()

bool RNA_path_resolve_property_and_item_pointer	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop,
		PointerRNA *	r_item_ptr )

Resolve the given RNA Path to find both the pointer AND property indicated by fully resolving the path, and get the value of the Pointer property (or item of the collection).

This is a convenience method to avoid logic errors and ugly syntax, it combines both RNA_path_resolve and RNA_path_resolve_property in a single call.

Note: Assumes all pointers provided are valid.

Parameters

r_item_ptr The final Pointer or Collection item value. You must check for its validity before use!

Returns: True only if both a valid pointer and property are found after resolving the path

Definition at line 575 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

Referenced by RNA_struct_override_apply().

◆ RNA_path_resolve_property_and_item_pointer_full()

bool RNA_path_resolve_property_and_item_pointer_full	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop,
		int *	r_index,
		PointerRNA *	r_item_ptr )

Resolve the given RNA Path to find both the pointer AND property (as well as the array index) indicated by fully resolving the path, and get the value of the Pointer property (or item of the collection).

This is a convenience method to avoid logic errors and ugly syntax, it combines both RNA_path_resolve_full and RNA_path_resolve_property_full in a single call.

Note: Assumes all pointers provided are valid.

Parameters

r_item_ptr The final Pointer or Collection item value. You must check for its validity before use!

Returns: True only if both a valid pointer and property are found after resolving the path

Definition at line 588 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

◆ RNA_path_resolve_property_full()

bool RNA_path_resolve_property_full	(	const PointerRNA *	ptr,
		const char *	path,
		PointerRNA *	r_ptr,
		PropertyRNA **	r_prop,
		int *	r_index )

Resolve the given RNA Path to find the pointer AND property (as well as the array index) indicated by fully resolving the path.

This is a convenience method to avoid logic errors and ugly syntax.

Note: Assumes all pointers provided are valid

Returns: True only if both a valid pointer and property are found after resolving the path

Definition at line 565 of file rna_path.cc.

References PointerRNA::data, ptr, and rna_path_parse().

Referenced by BKE_lib_override_rna_property_find(), dtar_get_prop_val(), pyrna_struct_anim_args_parse_ex(), and blender::nodes::inverse_eval::set_rna_property().

◆ RNA_path_struct_property_py()

std::optional< std::string > RNA_path_struct_property_py	(	PointerRNA *	ptr,
		PropertyRNA *	prop,
		int	index )

Get the struct.property as a python representation, eg: some_struct.some_prop[10]

Definition at line 1318 of file rna_path.cc.

References PointerRNA::owner_id, ptr, RNA_path_from_ID_to_property(), RNA_property_array_check(), RNA_property_identifier(), RNA_struct_find_property(), RNA_struct_is_ID(), and PointerRNA::type.

Classes

Functions

Detailed Description

Function Documentation

◆ operator==()

◆ RNA_find_real_ID_and_path()

◆ RNA_path_append()

◆ RNA_path_array_index_token_find()

◆ RNA_path_from_ID_to_property()

◆ RNA_path_from_ID_to_property_index()

◆ RNA_path_from_ID_to_struct()

◆ RNA_path_from_ptr_to_property_index()

◆ RNA_path_from_real_ID_to_property_index()

◆ RNA_path_from_real_ID_to_struct()

◆ RNA_path_from_struct_to_idproperty()

◆ RNA_path_full_ID_py()

◆ RNA_path_full_property_py()

◆ RNA_path_full_property_py_ex()

◆ RNA_path_full_struct_py()

◆ RNA_path_property_py()

◆ RNA_path_resolve()

◆ RNA_path_resolve_elements()

◆ RNA_path_resolve_from_type_to_property()

◆ RNA_path_resolve_full()

◆ RNA_path_resolve_full_maybe_null()

◆ RNA_path_resolve_property()

◆ RNA_path_resolve_property_and_item_pointer()

◆ RNA_path_resolve_property_and_item_pointer_full()

◆ RNA_path_resolve_property_full()

◆ RNA_path_struct_property_py()