blender-archive/source/blender/blenlib/BLI_uuid.h

/* 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_uuid.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_LEN` 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 <ostream>

/** 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