311ca3e6af
`UUID` generally stands for "universally unique identifier". The session identifier that we use is neither universally unique, nor does it follow the standard. Therefor, the term "session uuid" is confusing and should be replaced. In #116888 we briefly talked about a better name and ended up with "session uid". The reason for "uid" instead of "id" is that the latter is a very overloaded term in Blender already. This patch changes all uses of "uuid" to "uid" where it's used in the context of a "session uid". It's not always trivial to see whether a specific mention of "uuid" refers to an actual uuid or something else. Therefore, I might have missed some renames. I can't think of an automated way to differentiate the case. BMesh also uses the term "uuid" sometimes in a the wrong context (e.g. `UUIDFaceStepItem`) but there it also does not mean "session uid", so it's *not* changed by this patch. Pull Request: https://projects.blender.org/blender/blender/pulls/117350
98 lines
2.6 KiB
C++
98 lines
2.6 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* 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`.
|
|
*/
|
|
#include "DNA_uuid_types.h"
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* UUID generator for random (version 4) UUIDs. See RFC4122 section 4.4.
|
|
* This function is not thread-safe. */
|
|
bUUID BLI_uuid_generate_random(void);
|
|
|
|
/**
|
|
* Return the UUID nil value, consisting of all-zero fields.
|
|
*/
|
|
bUUID BLI_uuid_nil(void);
|
|
|
|
/** Return true only if this is the nil UUID. */
|
|
bool BLI_uuid_is_nil(bUUID uuid);
|
|
|
|
/** Compare two UUIDs, return true only if they are equal. */
|
|
bool BLI_uuid_equal(bUUID uuid1, bUUID uuid2);
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
void BLI_uuid_format(char *buffer, bUUID uuid) ATTR_NONNULL();
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
bool BLI_uuid_parse_string(bUUID *uuid, const char *buffer) ATTR_NONNULL();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
|
|
# include <initializer_list>
|
|
# include <iosfwd>
|
|
# include <string>
|
|
|
|
/** Output the UUID as formatted ASCII string, see #BLI_uuid_format(). */
|
|
std::ostream &operator<<(std::ostream &stream, bUUID uuid);
|
|
|
|
namespace blender {
|
|
|
|
class bUUID : public ::bUUID {
|
|
public:
|
|
/**
|
|
* Default constructor, used with `bUUID value{};`, will initialize to the nil UUID.
|
|
*/
|
|
bUUID() = default;
|
|
|
|
/** Initialize from the bUUID DNA struct. */
|
|
bUUID(const ::bUUID &struct_uuid);
|
|
|
|
/** Initialize from 11 integers, 5 for the regular fields and 6 for the `node` array. */
|
|
bUUID(std::initializer_list<uint32_t> field_values);
|
|
|
|
/** Initialize by parsing the string; undefined behavior when the string is invalid. */
|
|
explicit bUUID(const std::string &string_formatted_uuid);
|
|
|
|
uint64_t hash() const;
|
|
}; // namespace blender
|
|
|
|
bool operator==(bUUID uuid1, bUUID uuid2);
|
|
bool operator!=(bUUID uuid1, bUUID uuid2);
|
|
|
|
/**
|
|
* Lexicographic comparison of the UUIDs.
|
|
* Equivalent to string comparison on the formatted UUIDs. */
|
|
bool operator<(bUUID uuid1, bUUID uuid2);
|
|
|
|
} // namespace blender
|
|
|
|
#endif
|