Blender V5.3
blender::UString Class Reference

#include <BLI_ustring.hh>

Public Member Functions

 UString ()=default
 UString (const StringRef str)
StringRefNull ref () const
const std::string & string () const
const char * c_str () const
uint64_t hash () const
int64_t size () const
bool is_empty () const
char operator[] (const int64_t i) const

Static Public Attributes

static constexpr blender::detail::UStringEntry EMPTY_ENTRY = {"", hash_string("")}

Friends

template<FixedString FStr>
UString operator""_ustr ()
bool operator== (const UString &a, const UString &b)
bool operator== (const UString &a, const StringRef b)

Detailed Description

This class is inspired by OpenImageIO's ustring class.

See the OpenImageIO documentation for more details: https://openimageio.readthedocs.io/en/stable/imageioapi.html#efficient-unique-strings-ustring

Definition at line 51 of file BLI_ustring.hh.

Constructor & Destructor Documentation

◆ UString() [1/2]

blender::UString::UString ( )
default

Referenced by blender::ed::space_node::add_existing_group_input_fn(), blender::ed::space_node::add_group_input_node_fn(), blender::fn::multi_function::registry::add_new(), blender::nodes::GeoNodeExecParams::anonymous_attribute_output_is_required(), blender::io::usd::append_node(), blender::io::obj::copy_property_from_node(), blender::nodes::node_composite_image_cc::declare_existing_output(), blender::nodes::node_composite_render_layer_cc::declare_pass_callback(), blender::default_paint_slot_color_get(), blender::bke::direct_link_node_socket(), blender::nodes::do_forward_compat_versioning(), blender::do_versions_nodetree_customnodes(), blender::nodes::BundleKey::from_str(), blender::ParsedRNAPath< N >::from_string(), blender::nodes::GeoNodeExecParams::get_attribute_filter(), blender::get_input_socket(), blender::ed::space_node::get_internal_group_links(), blender::nodes::GeoNodeExecParams::get_output_anonymous_attribute_id_if_needed(), blender::GPU_node_get_input(), blender::GPU_node_get_output(), blender::ed::space_node::hide_unselected_sockets(), blender::link_nodes(), blender::io::fbx::link_sockets(), blender::io::obj::link_sockets(), blender::io::obj::linked_sockets_to_dest_id(), blender::bke::make_socket(), blender::ed::space_node::map_socket(), blender::bke::node_blend_read_data_storage(), blender::nodes::node_composite_file_output_cc::node_declare(), blender::nodes::node_composite_switch_view_cc::node_declare(), blender::nodes::node_fn_format_string_cc::node_declare(), blender::nodes::node_geo_closure_cc::input_node::node_declare(), blender::nodes::node_geo_closure_cc::output_node::node_declare(), blender::nodes::node_geo_combine_list_cc::node_declare(), blender::nodes::node_geo_field_to_list_cc::node_declare(), blender::nodes::node_geo_foreach_geometry_element_cc::input_node::node_declare(), blender::nodes::node_geo_foreach_geometry_element_cc::output_node::node_declare(), blender::nodes::node_geo_index_switch_cc::node_declare(), blender::nodes::node_geo_rasterize_points::node_declare(), blender::nodes::node_geo_repeat_cc::repeat_input_node::node_declare(), blender::nodes::node_geo_repeat_cc::repeat_output_node::node_declare(), blender::nodes::node_geo_separate_bundle_cc::node_declare(), blender::nodes::node_geo_viewer_cc::node_declare(), blender::nodes::node_geo_closure_to_list_cc::node_gather_link_search_ops(), blender::nodes::node_geo_field_to_grid_cc::node_gather_link_search_ops(), blender::nodes::node_geo_field_to_list_cc::node_gather_link_search_ops(), blender::nodes::node_composite_file_output_cc::node_gather_link_searches(), blender::nodes::node_geo_attribute_capture_cc::node_gather_link_searches(), blender::nodes::node_geo_bake_cc::node_gather_link_searches(), blender::nodes::node_geo_combine_bundle_cc::node_gather_link_searches(), blender::nodes::node_geo_repeat_cc::repeat_output_node::node_gather_link_searches(), blender::nodes::node_geo_separate_bundle_cc::node_gather_link_searches(), blender::nodes::node_geo_viewer_cc::node_gather_link_searches(), blender::nodes::node_geo_attribute_capture_cc::node_geo_exec(), blender::nodes::node_geo_combine_list_cc::node_geo_exec(), blender::nodes::node_geo_field_to_grid_cc::node_geo_exec(), blender::nodes::node_geo_field_to_list_cc::node_geo_exec(), blender::nodes::node_geo_rasterize_points::node_geo_exec(), blender::nodes::node_group_declare_panel_recursive(), blender::bke::node_socket_copy(), blender::bke::node_socket_type_find(), blender::node_tree_relink_with_socket_id_map(), blender::bke::node_tree_set_type(), blender::bke::node_tree_type_find(), blender::bke::node_type_base_custom(), operator""_ustr, blender::proj_paint_add_slot(), blender::pyrna_struct_bl_rna_get_subclass(), blender::pyrna_struct_meta_idprop_setattro(), blender::nodes::refresh_node_socket(), blender::ed::space_node::replace_interface_socket(), blender::RNA_def_struct(), blender::RNA_def_struct_nested(), blender::RNA_def_struct_ptr(), blender::rna_property_rna_or_id_get(), blender::RNA_struct_find(), blender::RNA_struct_find_property(), blender::io::usd::USDMaterialReader::set_displacement_node_inputs(), blender::io::usd::USDMaterialReader::set_node_input(), blender::io::obj::set_property_of_socket(), blender::io::fbx::set_socket_float(), blender::io::fbx::set_socket_rgb(), blender::io::fbx::set_socket_vector(), blender::tests::TEST(), blender::tests::TEST(), blender::nodes::socket_items::try_add_item_via_extend_socket(), blender::version_node_add_empty(), blender::version_node_add_socket(), blender::version_node_add_socket_if_not_exist(), blender::version_node_add_unknown(), blender::version_node_socket_duplicate(), blender::version_node_socket_id_delim(), blender::version_node_socket_identifier_set(), blender::version_update_node_input(), and blender::versioning_eevee_material_shadow_none().

◆ UString() [2/2]

blender::UString::UString ( const StringRef str)
inlineexplicit

Definition at line 69 of file BLI_ustring.hh.

References str.

Member Function Documentation

◆ c_str()

const char * blender::UString::c_str ( ) const
inline

Definition at line 88 of file BLI_ustring.hh.

Referenced by blender::ED_node_set_tree_type(), blender::ed::space_node::node_clipboard_copy_exec(), blender::nodes::node_shader_raycast_cc::node_declare(), blender::nodes::node_geo_repeat_cc::repeat_output_node::node_gather_link_searches(), blender::nodes::node_geo_simulation_cc::sim_output_node::node_gather_link_searches(), blender::bke::node_register_type(), blender::ed::space_node::node_swap_group_asset_invoke(), blender::bke::node_type_base(), blender::ed::space_node::node_update_basis_from_declaration(), blender::print_default_info(), blender::nodes::refresh_node_socket(), blender::RNA_boolean_get(), blender::RNA_boolean_get_array(), blender::RNA_boolean_set(), blender::RNA_boolean_set_array(), blender::RNA_collection_add(), blender::RNA_collection_begin(), blender::RNA_collection_clear(), blender::RNA_collection_is_empty(), blender::RNA_collection_length(), blender::RNA_def_function(), blender::rna_def_function(), blender::rna_def_function_funcs(), blender::RNA_def_function_return(), blender::rna_def_function_wrapper_funcs(), blender::RNA_def_property(), blender::RNA_def_property_array(), blender::rna_def_property_begin_func(), blender::RNA_def_property_boolean_array_default(), blender::RNA_def_property_boolean_default(), blender::RNA_def_property_boolean_default_func(), blender::RNA_def_property_boolean_funcs(), blender::rna_def_property_boolean_sdna(), blender::RNA_def_property_collection_funcs(), blender::RNA_def_property_collection_sdna(), blender::RNA_def_property_deprecated(), blender::rna_def_property_end_func(), blender::RNA_def_property_enum_default(), blender::RNA_def_property_enum_default_func(), blender::RNA_def_property_enum_funcs(), blender::RNA_def_property_enum_items(), blender::RNA_def_property_enum_native_type(), blender::RNA_def_property_enum_sdna(), blender::RNA_def_property_flag(), blender::RNA_def_property_float_array_default(), blender::RNA_def_property_float_default(), blender::RNA_def_property_float_default_func(), blender::RNA_def_property_float_funcs(), blender::RNA_def_property_float_sdna(), blender::rna_def_property_funcs(), blender::rna_def_property_get_func(), blender::RNA_def_property_int_array_default(), blender::RNA_def_property_int_default(), blender::RNA_def_property_int_default_func(), blender::RNA_def_property_int_funcs(), blender::RNA_def_property_int_sdna(), blender::rna_def_property_length_func(), blender::rna_def_property_lookup_int_func(), blender::rna_def_property_lookup_string_func(), blender::RNA_def_property_multi_array(), blender::rna_def_property_next_func(), blender::RNA_def_property_pointer_funcs(), blender::RNA_def_property_pointer_sdna(), blender::RNA_def_property_poll_runtime(), blender::RNA_def_property_range(), blender::rna_def_property_sdna(), blender::rna_def_property_search_func(), blender::rna_def_property_set_func(), blender::RNA_def_property_string_default(), blender::RNA_def_property_string_default_func(), blender::RNA_def_property_string_filepath_filter_func(), blender::RNA_def_property_string_funcs(), blender::RNA_def_property_string_maxlength(), blender::RNA_def_property_string_sdna(), blender::RNA_def_property_string_search_func(), blender::RNA_def_property_struct_type(), blender::RNA_def_property_ui_range(), blender::RNA_def_property_ui_scale_type(), blender::rna_def_property_wrapper_funcs(), blender::RNA_def_struct_name_property(), blender::RNA_def_struct_nested(), blender::RNA_def_struct_ptr(), blender::rna_ensure_property_identifier(), blender::RNA_enum_get(), blender::RNA_enum_is_equal(), blender::RNA_enum_set(), blender::RNA_enum_set_identifier(), blender::rna_find_type(), blender::RNA_float_get(), blender::RNA_float_get_array(), blender::RNA_float_set(), blender::RNA_float_set_array(), blender::RNA_function_identifier(), blender::rna_generate_external_property_prototypes(), blender::rna_generate_function_prototypes(), blender::rna_generate_internal_property_prototypes(), blender::rna_generate_parameter_prototypes(), blender::rna_generate_property(), blender::rna_generate_property_decl(), blender::rna_generate_static_parameter_prototypes(), blender::rna_generate_struct_register_func(), blender::RNA_int_get(), blender::RNA_int_get_array(), blender::RNA_int_set(), blender::RNA_int_set_array(), blender::RNA_pointer_add(), blender::RNA_pointer_get(), blender::RNA_pointer_set(), blender::RNA_property_is_set(), blender::RNA_property_is_set_ex(), blender::rna_property_override_diff(), blender::RNA_property_pointer_add(), blender::RNA_property_pointer_poll(), blender::RNA_property_pointer_remove(), blender::RNA_property_pointer_set(), blender::rna_property_rna_or_id_get(), blender::RNA_property_unset(), blender::RNA_string_get(), blender::RNA_string_get(), blender::RNA_string_get_alloc(), blender::RNA_string_length(), blender::RNA_string_set(), blender::RNA_struct_available_or_report(), blender::RNA_struct_free(), blender::RNA_struct_identifier(), blender::RNA_struct_override_matches(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::ed::space_node::ui_node_draw_recursive(), and blender::ed::space_node::ui_node_link_items().

◆ hash()

uint64_t blender::UString::hash ( ) const
inline

◆ is_empty()

◆ operator[]()

char blender::UString::operator[] ( const int64_t i) const
inline

Definition at line 118 of file BLI_ustring.hh.

References blender::BLI_assert(), and size().

◆ ref()

StringRefNull blender::UString::ref ( ) const
inline

Access the underlying string as a StringRefNull.

Note: This is not an implicit conversion to work around ambiguous function calls.

Definition at line 78 of file BLI_ustring.hh.

References blender::StringRefNull::StringRefNull().

Referenced by blender::bke::node_interface::add_interface_socket_from_node(), blender::nodes::decl::Bool::build(), blender::nodes::decl::Bundle::build(), blender::nodes::decl::Closure::build(), blender::nodes::decl::Color::build(), blender::nodes::decl::Custom::build(), blender::nodes::decl::Extend::build(), blender::nodes::decl::Float::build(), blender::nodes::decl::Geometry::build(), blender::nodes::decl::IDSocketDeclaration::build(), blender::nodes::decl::Int::build(), blender::nodes::decl::IntVector::build(), blender::nodes::decl::Matrix::build(), blender::nodes::decl::Menu::build(), blender::nodes::decl::Rotation::build(), blender::nodes::decl::Shader::build(), blender::nodes::decl::String::build(), blender::nodes::decl::Vector::build(), blender::ed::spreadsheet::BundleViewerTreeItem::BundleViewerTreeItem(), blender::nodes::LinkSearchOpParams::connect_available_socket(), blender::default_paint_slot_color_get(), blender::ui::nodes::draw_node_inputs_recursive(), blender::ED_node_texture_default(), blender::ed::space_node::NodeSetInterfaceBuilder::expose_panel(), blender::nodes::format_as(), blender::nodes::BundleKey::from_ustr(), blender::bke::node_add_node(), blender::ed::space_node::node_draw_panels(), blender::nodes::node_shader_raycast_cc::node_shader_gpu(), blender::bke::node_socket_short_label(), blender::nodes::node_tree_shader_default(), blender::ntree_update_reroute_nodes(), operator==, blender::RNA_property_boolean_set(), blender::RNA_property_boolean_set_array(), blender::RNA_property_collection_add(), blender::RNA_property_enum_set(), blender::RNA_property_float_set(), blender::RNA_property_float_set_array(), blender::RNA_property_int_set(), blender::RNA_property_int_set_array(), blender::RNA_property_pointer_add(), blender::RNA_property_pointer_set(), blender::RNA_property_string_set(), blender::RNA_property_string_set_bytes(), blender::nodes::search_link_ops_for_declarations(), blender::ed::space_node::ui_node_draw_recursive(), blender::nodes::BaseSocketDeclarationBuilder::usage_by_menu(), and blender::world_init_data().

◆ size()

◆ string()

const std::string & blender::UString::string ( ) const
inline

◆ operator""_ustr

template<FixedString FStr>
UString operator""_ustr ( )
friend

Create a UString from a string literal. This is a template function so that each string is only made unique once and not every time the literal is used.

Note: OpenImageIO defines a similar _us string literal operator. However, it newly constructs the ustring in each invocation instead of caching it in a static variable. Caching it like here likely only works in C++20.

Definition at line 171 of file BLI_ustring.hh.

References UString(), and blender::detail::ustring_ensure_entry().

◆ operator== [1/2]

bool operator== ( const UString & a,
const StringRef b )
friend

Definition at line 98 of file BLI_ustring.hh.

References b, and ref().

◆ operator== [2/2]

bool operator== ( const UString & a,
const UString & b )
friend

Definition at line 93 of file BLI_ustring.hh.

References b.

Member Data Documentation

◆ EMPTY_ENTRY

blender::detail::UStringEntry blender::UString::EMPTY_ENTRY = {"", hash_string("")}
staticconstexpr

Definition at line 59 of file BLI_ustring.hh.

Referenced by blender::detail::ustring_ensure_entry().


The documentation for this class was generated from the following file: