include/photon/common/uuid.h

/*
Copyright 2022 The Photon Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

#pragma once

#include <photon/common/uuid4.h>
#include <photon/common/alog.h>

class UUID
{
public:

    struct String
    {
        enum { LEN = 37 };
        char data[LEN];

        String(){}
        String(const UUID &rhs)
        {
            rhs.to_string(data, LEN);
        }
        String(const String &rhs) = default;

        String& operator =(const UUID &rhs)
        {
            rhs.to_string(data, LEN);
            return *this;
        }
        String& operator =(const String &rhs) = default;

        const char* c_str() const
        {
            return (const char *)data;
        }
        // check uuid string is valid.
        static bool is_valid(const char *in = nullptr)
        {
            return invalid_uuid4(const_cast<char *>(in)) == 0;
        }
    }__attribute__((packed));

    // parse a UUID-Format string.
    int parse(const char *in, size_t n)
    {
        if (uuid4_parse(const_cast<char *>(in), (char *)this) != 0) {
            LOG_ERROR_RETURN(0, -1, "invalid UUID format.");
        }
        return 0;
    }

    int parse(const String &str_uuid)
    {
        return parse((char *)&str_uuid, String::LEN);
    }

    int reset(const char *in, size_t n)
    {
        if (n != 16) {
            LOG_ERRNO_RETURN(0, -1, "invalid UUID format");
        }
        uuid4_copy((char *)this, const_cast<char *>(in));
        return 0;
    }

    int to_string(char *out, size_t len) const
    {
        if (len < String::LEN) {
            int x = String::LEN;
            LOG_ERROR_RETURN(ENOBUFS, x - len,
                    "buffer size too slow, ` bytes required.", x);
        }
        uuid4_unparse_upper((char *)this, out);
        return 0;
    }

    void generate()
    {
        uuid4_generate((char *)this);
    }

    void clear()
    {
        uuid4_clear((char *)this);
    }

    bool is_null() const
    {
        return uuid4_is_null((char *)this);
    }

    bool operator ==(const UUID &rhs) const
    {
        return memcmp((char *)&rhs, (char *)this, LEN) == 0;
    }

    bool operator != (const UUID &rhs)
    {
        return !(*this == rhs);
    }

    UUID& operator =(const UUID &rhs)
    {
        uuid4_copy((char *)this, ((char *)&rhs));
        return *this;
    }

    uint32_t a;
    uint16_t b, c, d;;
    uint8_t  e[6];

    static const int LEN = 16;
 }__attribute__((packed));

inline LogBuffer& operator << (LogBuffer& log, const UUID::String& str_uuid)
{
    log << str_uuid.c_str();
    return log;
}

inline LogBuffer& operator << (LogBuffer& log, const UUID& uuid)
{
    UUID::String str_uuid = uuid;
    log << str_uuid.c_str();
    return log;
}