uuid.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_UUID_H
#define LIBREPCB_CORE_UUID_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../qtcompat.h"
 
#include <QtCore>
 
#include <optional.hpp>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
/*******************************************************************************
 *  Class Uuid
 ******************************************************************************/
 
class Uuid final {
  Q_DECLARE_TR_FUNCTIONS(Uuid)
 
public:
  // Constructors / Destructor
 
  Uuid() = delete;
 
  Uuid(const Uuid& other) noexcept : mUuid(other.mUuid) {}
 
  ~Uuid() noexcept = default;
 
  // Getters
 
  QString toStr() const noexcept { return mUuid; }
 
 
  Uuid& operator=(const Uuid& rhs) noexcept {
    mUuid = rhs.mUuid;
    return *this;
  }
  bool operator==(const Uuid& rhs) const noexcept { return mUuid == rhs.mUuid; }
  bool operator!=(const Uuid& rhs) const noexcept { return mUuid != rhs.mUuid; }
  bool operator<(const Uuid& rhs) const noexcept { return mUuid < rhs.mUuid; }
  bool operator>(const Uuid& rhs) const noexcept { return mUuid > rhs.mUuid; }
  bool operator<=(const Uuid& rhs) const noexcept { return mUuid <= rhs.mUuid; }
  bool operator>=(const Uuid& rhs) const noexcept { return mUuid >= rhs.mUuid; }
 
  // Static Methods
 
  static bool isValid(const QString& str) noexcept;
 
  static Uuid createRandom() noexcept;
 
  static Uuid fromString(const QString& str);
 
  static tl::optional<Uuid> tryFromString(const QString& str) noexcept;
 
private:  // Methods
  explicit Uuid(const QString& str) noexcept : mUuid(str) {}
 
private:  // Data
  QString mUuid;  
};
 
/*******************************************************************************
 *  Non-Member Functions
 ******************************************************************************/
 
inline QDataStream& operator<<(QDataStream& stream, const Uuid& uuid) noexcept {
  stream << uuid.toStr();
  return stream;
}
 
inline QDebug operator<<(QDebug stream, const Uuid& uuid) noexcept {
  stream << QString("Uuid(%1)").arg(uuid.toStr());
  return stream;
}
 
inline QtCompat::Hash qHash(const Uuid& key, QtCompat::Hash seed = 0) noexcept {
  return ::qHash(key.toStr(), seed);
}
 
}  // namespace librepcb
 
namespace tl {
inline ::librepcb::QtCompat::Hash qHash(
    const optional<librepcb::Uuid>& key,
    ::librepcb::QtCompat::Hash seed = 0) noexcept {
  return ::qHash(key ? key->toStr() : QString(), seed);
}
}  // namespace tl
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
#endif