xref: /aosp_15_r20/external/swiftshader/src/Vulkan/Debug/ID.hpp (revision 03ce13f70fcc45d86ee91b7ee4cab1936a95046e)

// Copyright 2019 The SwiftShader Authors. All Rights Reserved.
//
// 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.

#ifndef VK_DEBUG_ID_HPP_
#define VK_DEBUG_ID_HPP_

#include <functional>  // std::hash

namespace vk {
namespace dbg {

// ID is a strongly-typed identifier backed by a int.
// The template parameter T is not actually used by the implementation of
// ID; instead it is used to prevent implicit casts between identifiers of
// different T types.
// IDs are typically used as a map key to value of type T.
template<typename T>
class ID
{
public:
	ID() = default;

	inline ID(int id);
	inline bool operator==(const ID<T> &rhs) const;
	inline bool operator!=(const ID<T> &rhs) const;
	inline bool operator<(const ID<T> &rhs) const;
	inline ID operator++();
	inline ID operator++(int);

	// value returns the numerical value of the identifier.
	inline int value() const;

private:
	int id = 0;
};

template<typename T>
ID<T>::ID(int id)
    : id(id)
{}

template<typename T>
bool ID<T>::operator==(const ID<T> &rhs) const
{
	return id == rhs.id;
}

template<typename T>
bool ID<T>::operator!=(const ID<T> &rhs) const
{
	return id != rhs.id;
}

template<typename T>
bool ID<T>::operator<(const ID<T> &rhs) const
{
	return id < rhs.id;
}

template<typename T>
ID<T> ID<T>::operator++()
{
	return ID(++id);
}

template<typename T>
ID<T> ID<T>::operator++(int)
{
	return ID(id++);
}

template<typename T>
int ID<T>::value() const
{
	return id;
}

}  // namespace dbg
}  // namespace vk

namespace std {

// std::hash implementation for vk::dbg::ID<T>
template<typename T>
struct hash<vk::dbg::ID<T> >
{
	std::size_t operator()(const vk::dbg::ID<T> &id) const noexcept
	{
		return std::hash<int>()(id.value());
	}
};

}  // namespace std

#endif  // VK_DEBUG_ID_HPP_