#include <cctype>
#include <cstdlib>
#include <cstring>
#include <array>
#include <stdexcept>
#include "MEM_guardedalloc.h"
#include "BLI_array.hh"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_string_utf8.h"
#include "BLI_string_utils.hh"
#include "BLI_utildefines.h"
#include "BLI_dynstr.h"
#include "DNA_listBase.h"
#include "BLI_strict_flags.h"

Functions
blender::StringRef	BLI_string_split_name_number (const blender::StringRef name_full, const char delim, int &r_number)
size_t	BLI_string_split_name_number (const char name, const char delim, char r_name_left, int *r_number)
bool	BLI_string_is_decimal (const char *string)
static bool	is_char_sep (const char c)
void	BLI_string_split_suffix (const char string, const size_t string_maxlen, char r_body, char *r_suf)
void	BLI_string_split_prefix (const char string, const size_t string_maxlen, char r_pre, char *r_body)
size_t	BLI_string_flip_side_name (char name_dst, const char name_src, const bool strip_number, const size_t name_dst_maxncpy)
void	BLI_uniquename_cb (blender::FunctionRef< bool(blender::StringRefNull)> unique_check, const char defname, char delim, char name, size_t name_maxncpy)
std::string	BLI_uniquename_cb (blender::FunctionRef< bool(blender::StringRef)> unique_check, const char delim, const blender::StringRef name)
void	BLI_uniquename (const ListBase list, void vlink, const char *defname, char delim, int name_offset, size_t name_maxncpy)
size_t	BLI_string_len_array (const char *strings[], uint strings_num)
String Replace
char *	BLI_string_replaceN (const char __restrict str, const char __restrict substr_old, const char *__restrict substr_new)
void	BLI_string_replace (std::string &haystack, const blender::StringRef needle, const blender::StringRef other)
void	BLI_string_replace_char (char *str, char src, char dst)
bool	BLI_string_replace_table_exact (char string, const size_t string_maxncpy, const char replace_table[][2], int replace_table_len)
size_t	BLI_string_replace_range (char string, size_t string_maxncpy, int src_beg, int src_end, const char dst)
Join Strings
For non array versions of these functions, use the macros: BLI_string_join BLI_string_joinN BLI_string_join_by_sep_charN BLI_string_join_by_sep_char_with_tableN
size_t	BLI_string_join_array (char result, size_t result_maxncpy, const char strings[], uint strings_num)
size_t	BLI_string_join_array_by_sep_char (char result, size_t result_maxncpy, char sep, const char strings[], uint strings_num)
char *	BLI_string_join_arrayN (const char *strings[], uint strings_num)
char *	BLI_string_join_array_by_sep_charN (char sep, const char *strings[], uint strings_num)
char *	BLI_string_join_array_by_sep_char_with_tableN (char sep, char table[], const char strings[], uint strings_num)

Function Documentation

◆ BLI_string_flip_side_name()

size_t BLI_string_flip_side_name	(	char *	name_dst,
		const char *	name_src,
		const bool	strip_number,
		const size_t	name_dst_maxncpy )

Definition at line 289 of file blenlib/intern/string_utils.cc.

References BLI_snprintf_utf8_rlen(), BLI_strcasestr(), BLI_string_debug_size, BLI_strncpy_utf8(), BLI_strncpy_utf8_rlen(), is_char_sep(), and len.

◆ BLI_string_is_decimal()

bool BLI_string_is_decimal ( const char * string )

Definition at line 220 of file blenlib/intern/string_utils.cc.

Referenced by BLI_string_split_name_number(), ED_text_is_syntax_highlight_supported(), and TEST().

◆ BLI_string_join_array()

size_t BLI_string_join_array	(	char *	result,
		size_t	result_maxncpy,
		const char *	strings[],
		uint	strings_num )

Join strings, return the length of the resulting string.

Definition at line 535 of file blenlib/intern/string_utils.cc.

References BLI_string_debug_size, i, result, and UNLIKELY.

Referenced by _BLI_string_join_10(), _BLI_string_join_11(), _BLI_string_join_12(), _BLI_string_join_3(), _BLI_string_join_4(), _BLI_string_join_5(), _BLI_string_join_6(), _BLI_string_join_7(), _BLI_string_join_8(), _BLI_string_join_9(), draw_selected_name(), blender::ed::vse::draw_seq_text_get_overlay_string(), blender::ed::vse::draw_strip_in_view(), draw_viewport_name(), make_renderinfo_string(), and string_join_array_test_truncate().

◆ BLI_string_join_array_by_sep_char()

size_t BLI_string_join_array_by_sep_char	(	char *	result,
		size_t	result_maxncpy,
		char	sep,
		const char *	strings[],
		uint	strings_num )

A version of BLI_string_join_array that takes a separator which can be any character including '\0'.

Definition at line 558 of file blenlib/intern/string_utils.cc.

References BLI_string_debug_size, i, result, and UNLIKELY.

Referenced by _BLI_string_join_by_sep_char_10(), _BLI_string_join_by_sep_char_11(), _BLI_string_join_by_sep_char_12(), _BLI_string_join_by_sep_char_13(), _BLI_string_join_by_sep_char_4(), _BLI_string_join_by_sep_char_5(), _BLI_string_join_by_sep_char_6(), _BLI_string_join_by_sep_char_7(), _BLI_string_join_by_sep_char_8(), _BLI_string_join_by_sep_char_9(), BPy_BMElem_StringFromHType_ex(), RE_render_result_full_channel_name(), and string_join_array_with_sep_char_test_truncate().

◆ BLI_string_join_array_by_sep_char_with_tableN()

char * BLI_string_join_array_by_sep_char_with_tableN	(	char	sep,
		char *	table[],
		const char *	strings[],
		uint	strings_num )

Definition at line 622 of file blenlib/intern/string_utils.cc.

References BLI_assert, i, MEM_calloc_arrayN(), and result.

◆ BLI_string_join_array_by_sep_charN()

char * BLI_string_join_array_by_sep_charN	(	char	sep,
		const char *	strings[],
		uint	strings_num )

A version of BLI_string_join_by_sep_char that takes a separator which can be any character including '\0'.

Definition at line 601 of file blenlib/intern/string_utils.cc.

References BLI_assert, BLI_string_len_array(), i, MEM_calloc_arrayN(), and result.

Referenced by _BLI_string_join_by_sep_charN_10(), _BLI_string_join_by_sep_charN_11(), _BLI_string_join_by_sep_charN_2(), _BLI_string_join_by_sep_charN_3(), _BLI_string_join_by_sep_charN_4(), _BLI_string_join_by_sep_charN_5(), _BLI_string_join_by_sep_charN_6(), _BLI_string_join_by_sep_charN_7(), _BLI_string_join_by_sep_charN_8(), _BLI_string_join_by_sep_charN_9(), and string_join_array_with_sep_char_test_truncate().

◆ BLI_string_join_arrayN()

char * BLI_string_join_arrayN	(	const char *	strings[],
		uint	strings_num )

Join an array of strings into a newly allocated, null terminated string.

Definition at line 585 of file blenlib/intern/string_utils.cc.

References BLI_assert, BLI_string_len_array(), i, MEM_calloc_arrayN(), and result.

Referenced by _BLI_string_joinN_1(), _BLI_string_joinN_10(), _BLI_string_joinN_2(), _BLI_string_joinN_3(), _BLI_string_joinN_4(), _BLI_string_joinN_5(), _BLI_string_joinN_6(), _BLI_string_joinN_7(), _BLI_string_joinN_8(), _BLI_string_joinN_9(), and string_join_array_test_truncate().

◆ BLI_string_len_array()

size_t BLI_string_len_array	(	const char *	strings[],
		uint	strings_num )

Definition at line 515 of file blenlib/intern/string_utils.cc.

References i.

Referenced by BLI_string_join_array_by_sep_charN(), BLI_string_join_arrayN(), draw_selected_name(), and make_renderinfo_string().

◆ BLI_string_replace()

void BLI_string_replace	(	std::string &	haystack,
		blender::StringRef	needle,
		blender::StringRef	other )

In-place replacement all occurrences of needle in haystack with other.

Definition at line 91 of file blenlib/intern/string_utils.cc.

References i, and blender::StringRefBase::size().

Referenced by blender::TEST().

◆ BLI_string_replace_char()

void BLI_string_replace_char	(	char *	str,
		char	src,
		char	dst )

In-place replace every src to dst in str.

Parameters

str	The string to operate on.
src	The character to replace.
dst	The character to replace with.

Definition at line 103 of file blenlib/intern/string_utils.cc.

References str.

Referenced by BLI_path_abs(), BLI_path_rel(), BLI_path_slash_native(), BLI_path_to_display_name(), blender::gpu::create_gpu_name(), blender::gpu::create_key(), blender::io::stl::export_frame(), blender::io::usd::export_packed_texture(), blender::bke::bake::file_name_to_frame(), blender::bke::bake::frame_to_file_name(), blender::io::usd::get_relative_path(), blender::io::usd::get_tex_image_asset_filepath(), memiter_words10k_test(), str_replace_char_strdup(), str_replace_char_with_relative_exception(), uri_from_filepath(), view_layer_add_lightgroup_exec(), viewlayer_aov_make_name_unique(), viewlayer_lightgroup_make_name_unique(), and blender::io::usd::world_material_to_dome_light().

◆ BLI_string_replace_range()

size_t BLI_string_replace_range	(	char *	string,
		size_t	string_maxncpy,
		int	src_beg,
		int	src_end,
		const char *	dst )

Write dst into the range between src_beg & src_end, resize within string_maxncpy limits, ensure null terminated.

Returns: the length of string.

Definition at line 129 of file blenlib/intern/string_utils.cc.

References BLI_assert, and UNLIKELY.

Referenced by BLI_path_frame(), BLI_path_frame_range(), eval_template(), and version_escape_curly_braces().

◆ BLI_string_replace_table_exact()

bool BLI_string_replace_table_exact	(	char *	string,
		size_t	string_maxncpy,
		const char *	replace_table[][2],
		int	replace_table_len )

Simple exact-match string replacement.

Parameters

replace_table Array of source, destination pairs.

Note: Larger tables should use a hash table.

Definition at line 113 of file blenlib/intern/string_utils.cc.

References BLI_string_debug_size_after_nil, BLI_strncpy(), i, and STREQ.

Referenced by BKE_workspace_tool_id_replace_table(), and blo_do_versions_userdef().

◆ BLI_string_replaceN()

char * BLI_string_replaceN	(	const char *__restrict	str,
		const char *__restrict	substr_old,
		const char *__restrict	substr_new )

Definition at line 36 of file blenlib/intern/string_utils.cc.

References BLI_assert, BLI_dynstr_append(), BLI_dynstr_free(), BLI_dynstr_get_cstring(), BLI_dynstr_nappend(), BLI_dynstr_new(), BLI_strdup(), and str.

◆ BLI_string_split_name_number() [1/2]

blender::StringRef BLI_string_split_name_number	(	const blender::StringRef	name_full,
		const char	delim,
		int &	r_number )

Definition at line 180 of file blenlib/intern/string_utils.cc.

References blender::StringRefBase::begin(), blender::StringRefBase::end(), blender::StringRefBase::not_found, blender::StringRefBase::rfind(), blender::StringRefBase::size(), and blender::StringRefBase::substr().

Referenced by BLI_string_split_name_number(), BLI_uniquename_cb(), and BLI_uniquename_cb().

◆ BLI_string_split_name_number() [2/2]

size_t BLI_string_split_name_number	(	const char *	name,
		const char	delim,
		char *	r_name_left,
		int *	r_number )

Definition at line 210 of file blenlib/intern/string_utils.cc.

References BLI_string_split_name_number(), BLI_strncpy(), and name.

◆ BLI_string_split_prefix()

void BLI_string_split_prefix	(	const char *	string,
		const size_t	string_maxlen,
		char *	r_pre,
		char *	r_body )

Definition at line 264 of file blenlib/intern/string_utils.cc.

References BLI_string_debug_size, BLI_strncpy(), BLI_strnlen(), i, is_char_sep(), and len.

◆ BLI_string_split_suffix()

void BLI_string_split_suffix	(	const char *	string,
		const size_t	string_maxlen,
		char *	r_body,
		char *	r_suf )

Definition at line 240 of file blenlib/intern/string_utils.cc.

References BLI_string_debug_size, BLI_strncpy(), BLI_strnlen(), i, is_char_sep(), and len.

◆ BLI_uniquename()

void BLI_uniquename	(	const ListBase *	list,
		void *	vlink,
		const char *	defname,
		char	delim,
		int	name_offset,
		size_t	name_maxncpy )

Definition at line 483 of file blenlib/intern/string_utils.cc.

References BLI_assert, BLI_uniquename_cb(), ELEM, LISTBASE_FOREACH, name, and POINTER_OFFSET.

◆ BLI_uniquename_cb() [1/2]

std::string BLI_uniquename_cb	(	blender::FunctionRef< bool(blender::StringRef)>	unique_check,
		char	delim,
		blender::StringRef	name )

Return a name that is unique (according to criteria specified by caller in unique_check callback), incrementing its numeric suffix as necessary.

Parameters

unique_check	Return true if name is not unique
delim	Delimits numeric suffix in name
name	Name to be made unique

Returns: name that can be assigned by the caller to make it unique.

Note: Contrary to the other functions with the same name, this function does not directly set the unique name. That is the responsibility of the caller.

Definition at line 451 of file blenlib/intern/string_utils.cc.

References BLI_snprintf(), BLI_string_split_name_number(), blender::Array< T, InlineBufferCapacity, Allocator >::data(), left, len, and name.

◆ BLI_uniquename_cb() [2/2]

void BLI_uniquename_cb	(	blender::FunctionRef< bool(blender::StringRefNull)>	unique_check,
		const char *	defname,
		char	delim,
		char *	name,
		size_t	name_maxncpy )