BLI_uuid.h File Reference

#include "DNA_uuid_types.h"
#include "BLI_compiler_attrs.h"

Go to the source code of this file.

Functions
bUUID	BLI_uuid_generate_random (void)
bUUID	BLI_uuid_nil (void)
bool	BLI_uuid_is_nil (bUUID uuid)
bool	BLI_uuid_equal (bUUID uuid1, bUUID uuid2)
void	BLI_uuid_format (char *buffer, bUUID uuid) ATTR_NONNULL()
bool	BLI_uuid_parse_string (bUUID *uuid, const char *buffer) ATTR_NONNULL()

Detailed Description

Functions for generating and handling UUID structs according to RFC4122.

Note that these are true UUIDs, not to be confused with the "session uuid" defined in BLI_session_uid.h.

Definition in file BLI_uuid.h.

Function Documentation

BLI_uuid_equal()

bool BLI_uuid_equal	(	bUUID	uuid1,
		bUUID	uuid2 )

Compare two UUIDs, return true only if they are equal.

Definition at line 84 of file uuid.cc.

Referenced by BLI_uuid_is_nil(), blender::ed::asset_browser::file_set_asset_catalog_filter_settings(), blender::operator==(), and blender::bke::tests::TEST().

BLI_uuid_format()

void BLI_uuid_format	(	char *	buffer,
		bUUID	uuid )

Format UUID as string. The buffer must be at least 37 bytes (36 bytes for the UUID + terminating 0). Use UUID_STRING_SIZE from DNA_uuid_types.h if you want to use a constant for this.

Definition at line 89 of file uuid.cc.

References BLI_assert, BLI_snprintf(), bUUID::clock_seq_hi_and_reserved, bUUID::clock_seq_low, bUUID::node, bUUID::time_hi_and_version, bUUID::time_low, bUUID::time_mid, UNUSED_VARS_NDEBUG, and UUID_STRING_SIZE.

Referenced by operator<<(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), and blender::tests::TEST().

BLI_uuid_generate_random()

bUUID BLI_uuid_generate_random

(

void

)

UUID generator for random (version 4) UUIDs. See RFC4122 section 4.4. This function is not thread-safe.

Definition at line 24 of file uuid.cc.

References bUUID::clock_seq_hi_and_reserved, LL, seed, and bUUID::time_hi_and_version.

Referenced by blender::asset_system::AssetCatalog::from_path(), blender::bke::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), blender::asset_system::tests::TEST_F(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

BLI_uuid_is_nil()

bool BLI_uuid_is_nil

(

bUUID

uuid

)

Return true only if this is the nil UUID.

Definition at line 79 of file uuid.cc.

References BLI_uuid_equal(), and BLI_uuid_nil().

Referenced by blender::ed::asset::build_filtered_all_catalog_tree(), blender::ed::asset::build_filtered_catalog_tree(), blender::asset_system::AssetCatalogTree::insert_item(), blender::asset_system::AssetCatalogFilter::is_known(), blender::asset_system::AssetLibrary::refresh_catalog_simplename(), blender::bke::tests::TEST(), blender::tests::TEST(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

BLI_uuid_nil()

bUUID BLI_uuid_nil

(

void

)

Return the UUID nil value, consisting of all-zero fields.

Definition at line 73 of file uuid.cc.

Referenced by BKE_asset_metadata_catalog_id_clear(), BLI_uuid_is_nil(), blender::tests::TEST(), blender::asset_system::tests::TEST_F(), blender::asset_system::tests::TEST_F(), and blender::asset_system::tests::TEST_F().

BLI_uuid_parse_string()

bool BLI_uuid_parse_string	(	bUUID *	uuid,
		const char *	buffer )

Parse a string as UUID. The string MUST be in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, as produced by BLI_uuid_format().

Return true if the string could be parsed, and false otherwise. In the latter case, the UUID may have been partially updated.

Definition at line 112 of file uuid.cc.

References bUUID::clock_seq_hi_and_reserved, bUUID::clock_seq_low, bUUID::node, bUUID::time_hi_and_version, bUUID::time_low, and bUUID::time_mid.

Referenced by blender::ed::asset::asset_catalog_delete_exec(), blender::asset_system::AssetCatalogDefinitionFile::parse_catalog_line(), blender::tests::TEST(), blender::tests::TEST(), and blender::tests::TEST().