Blender V5.3
RNA_path.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
17
18#include <optional>
19#include <string>
20#include <variant>
21
22#include <utility>
23
24#include "DNA_listBase.h"
25
26#include "RNA_types.hh"
27
28#include "BLI_string_ref.hh"
29#include "BLI_ustring.hh"
30
31namespace blender {
32
33struct IDProperty;
34
67struct RNAPath {
68 std::string path;
74 std::optional<std::string> key = std::nullopt;
75 std::optional<int> index = std::nullopt;
76
77 int64_t hash() const;
78};
79
80namespace rna_path {
81
83struct Member {
85
86 bool operator==(const Member &other) const = default;
87};
88
95
96 bool operator==(const LookupIndex &other) const = default;
97};
98
100struct LookupKey {
102
103 bool operator==(const LookupKey &other) const = default;
104};
105
106using Item = std::variant<Member, LookupIndex, LookupKey>;
107
109std::string to_string(Span<Item> items);
110
111} // namespace rna_path
112
114
115template<> struct DefaultHash<rna_path::Item> {
117 {
118 return get_default_hash(uint64_t(value.index()),
119 std::visit(
120 []<typename T>(const T &value) -> uint64_t {
121 if constexpr (std::is_same_v<T, rna_path::Member>) {
122 return get_default_hash(value.identifier);
123 }
124 else if constexpr (std::is_same_v<T, rna_path::LookupIndex>) {
125 return get_default_hash(value.index);
126 }
127 else if constexpr (std::is_same_v<T, rna_path::LookupKey>) {
128 return get_default_hash(value.key);
129 }
130 },
131 value));
132 }
133};
134
142template<int64_t N = 4> class ParsedRNAPath {
143 public:
145
146 ParsedRNAPath() = default;
148
149 static std::optional<ParsedRNAPath> from_string(StringRefNull path);
150
151 std::string to_string() const;
152
153 operator ParsedRNAPathRef() const
154 {
155 return this->items;
156 }
157};
158
167bool operator==(const RNAPath &left, const RNAPath &right);
168
169char *RNA_path_append(
170 const char *path, const PointerRNA *ptr, PropertyRNA *prop, int intkey, const char *strkey);
171#if 0 /* UNUSED. */
172char *RNA_path_back(const char *path);
173#endif
174
185const char *RNA_path_array_index_token_find(const char *rna_path, const PropertyRNA *array_prop);
186
187/* RNA_path_resolve() variants only ensure that a valid pointer (and optionally property) exist. */
188
200bool RNA_path_resolve(const PointerRNA *ptr,
201 const char *path,
202 PointerRNA *r_ptr,
203 PropertyRNA **r_prop);
204
212bool RNA_path_resolve_full(const PointerRNA *ptr,
213 const char *path,
214 PointerRNA *r_ptr,
215 PropertyRNA **r_prop,
216 int *r_index);
223bool RNA_path_resolve_full_maybe_null(const PointerRNA *ptr,
224 const char *path,
225 PointerRNA *r_ptr,
226 PropertyRNA **r_prop,
227 int *r_index);
228
229/* RNA_path_resolve_property() variants ensure that pointer + property both exist. */
230
239bool RNA_path_resolve_property(const PointerRNA *ptr,
240 const char *path,
241 PointerRNA *r_ptr,
242 PropertyRNA **r_prop);
243bool RNA_path_resolve_property(const PointerRNA *ptr,
244 ParsedRNAPathRef path,
245 PointerRNA *r_ptr,
246 PropertyRNA **r_prop);
247
256bool RNA_path_resolve_property_full(const PointerRNA *ptr,
257 const char *path,
258 PointerRNA *r_ptr,
259 PropertyRNA **r_prop,
260 int *r_index);
261
262/* RNA_path_resolve_property_and_item_pointer() variants ensure that pointer + property both exist,
263 * and resolve last Pointer value if possible (Pointer prop or item of a Collection prop). */
264
277bool RNA_path_resolve_property_and_item_pointer(const PointerRNA *ptr,
278 const char *path,
279 PointerRNA *r_ptr,
280 PropertyRNA **r_prop,
281 PointerRNA *r_item_ptr);
282
296bool RNA_path_resolve_property_and_item_pointer_full(const PointerRNA *ptr,
297 const char *path,
298 PointerRNA *r_ptr,
299 PropertyRNA **r_prop,
300 int *r_index,
301 PointerRNA *r_item_ptr);
302
308
318 const char *path,
319 Vector<PropertyElemRNA> *r_elements);
320
331std::optional<std::string> RNA_path_from_struct_to_idproperty(PointerRNA *ptr,
332 const IDProperty *needle);
333
341ID *RNA_find_real_ID_and_path(ID *id, const char **r_path);
342
343std::optional<std::string> RNA_path_from_ID_to_struct(const PointerRNA *ptr);
344
345std::optional<std::string> RNA_path_from_real_ID_to_struct(Main *bmain,
346 const PointerRNA *ptr,
347 ID **r_real);
348
349std::optional<std::string> RNA_path_from_ID_to_property(const PointerRNA *ptr, PropertyRNA *prop);
350
352 PropertyRNA *prop,
353 int index_dim,
354 int index);
360std::optional<std::string> RNA_path_from_ID_to_property_index(const PointerRNA *ptr,
361 PropertyRNA *prop,
362 int index_dim,
363 int index);
364
365std::optional<std::string> RNA_path_from_real_ID_to_property_index(Main *bmain,
366 const PointerRNA *ptr,
367 PropertyRNA *prop,
368 int index_dim,
369 int index,
370 ID **r_real_id);
371
376std::optional<std::string> RNA_path_resolve_from_type_to_property(const PointerRNA *ptr,
377 PropertyRNA *prop,
378 const StructRNA *type);
379
384std::string RNA_path_full_ID_py(ID *id);
389std::optional<std::string> RNA_path_full_struct_py(const PointerRNA *ptr);
394std::optional<std::string> RNA_path_full_property_py_ex(const PointerRNA *ptr,
395 PropertyRNA *prop,
396 int index,
397 bool use_fallback);
398std::optional<std::string> RNA_path_full_property_py(const PointerRNA *ptr,
399 PropertyRNA *prop,
400 int index);
405std::optional<std::string> RNA_path_struct_property_py(PointerRNA *ptr,
406 PropertyRNA *prop,
407 int index);
412std::string RNA_path_property_py(const PointerRNA *ptr, PropertyRNA *prop, int index);
417std::string RNA_path_name_to_infix(StringRefNull string);
422std::string RNA_path_number_to_infix(int number);
438std::pair<std::string, std::string> RNA_generate_keys_for_path_rename(
439 const StringRefNull old_infix,
440 const StringRefNull new_infix,
441 int old_subscript,
442 int new_subscript,
443 bool infix_is_name);
444
445} // namespace blender
These structs are the foundation for all linked lists in the library system.
ParsedRNAPath(ParsedRNAPathRef path)
Definition RNA_path.hh:147
Vector< rna_path::Item, N > items
Definition RNA_path.hh:144
ccl_device_inline bool operator==(const float2 a, const float2 b)
#define T
const char * to_string(ShaderStage stage)
Definition mtl_shader.mm:52
std::variant< Member, LookupIndex, LookupKey > Item
Definition RNA_path.hh:106
std::string to_string(const Span< Item > items)
Definition rna_path.cc:246
BMesh Iterators.
unsigned __int64 uint64_t
Definition BKE_text.h:91
__int64 int64_t
Definition BKE_text.h:90
std::optional< std::string > RNA_path_struct_property_py(PointerRNA *ptr, PropertyRNA *prop, int index)
Definition rna_path.cc:1383
std::optional< std::string > RNA_path_from_ID_to_property(const PointerRNA *ptr, PropertyRNA *prop)
Definition rna_path.cc:1237
std::optional< std::string > RNA_path_full_struct_py(const PointerRNA *ptr)
Definition rna_path.cc:1325
std::string RNA_path_number_to_infix(const int number)
Definition rna_path.cc:1425
std::string RNA_path_name_to_infix(const StringRefNull string)
Definition rna_path.cc:1419
std::optional< std::string > RNA_path_from_ID_to_struct(const PointerRNA *ptr)
Definition rna_path.cc:1078
std::pair< std::string, std::string > RNA_generate_keys_for_path_rename(const StringRefNull old_infix, const StringRefNull new_infix, const int old_subscript, const int new_subscript, const bool infix_is_name)
Definition rna_path.cc:1430
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 rna_path.cc:1242
ID * RNA_find_real_ID_and_path(ID *id, const char **r_path)
Definition rna_path.cc:1018
Span< rna_path::Item > ParsedRNAPathRef
Definition RNA_path.hh:113
std::optional< std::string > RNA_path_from_real_ID_to_struct(Main *bmain, const PointerRNA *ptr, ID **r_real)
Definition rna_path.cc:1120
std::string RNA_path_from_ptr_to_property_index(const PointerRNA *ptr, PropertyRNA *prop, int index_dim, int index)
Definition rna_path.cc:1212
std::string RNA_path_full_ID_py(ID *id)
Definition rna_path.cc:1290
std::optional< std::string > RNA_path_resolve_from_type_to_property(const PointerRNA *ptr, PropertyRNA *prop, const StructRNA *type)
Definition rna_path.cc:1260
bool RNA_path_resolve_elements(PointerRNA *ptr, const char *path, Vector< PropertyElemRNA > *r_elements)
Definition rna_path.cc:666
std::string RNA_path_property_py(const PointerRNA *ptr, PropertyRNA *prop, int index)
Definition rna_path.cc:1410
std::optional< std::string > RNA_path_full_property_py(const PointerRNA *ptr, PropertyRNA *prop, int index)
Definition rna_path.cc:1376
std::optional< std::string > RNA_path_from_ID_to_property_index(const PointerRNA *ptr, PropertyRNA *prop, int index_dim, int index)
Definition rna_path.cc:1220
std::optional< std::string > RNA_path_full_property_py_ex(const PointerRNA *ptr, PropertyRNA *prop, int index, bool use_fallback)
Definition rna_path.cc:1341
constexpr uint64_t get_default_hash(const T &v, const Args &...args)
Definition BLI_hash.hh:252
std::optional< std::string > RNA_path_from_struct_to_idproperty(PointerRNA *ptr, const IDProperty *needle)
Definition rna_path.cc:984
uint64_t operator()(const rna_path::Item &value) const
Definition RNA_path.hh:116
std::optional< std::string > key
Definition RNA_path.hh:74
std::string path
Definition RNA_path.hh:68
std::optional< int > index
Definition RNA_path.hh:75
int64_t hash() const
Definition rna_path.cc:41
bool operator==(const LookupIndex &other) const =default
bool operator==(const LookupKey &other) const =default
bool operator==(const Member &other) const =default