IDTable.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef IDTable_h
#define IDTable_h
 
#include "SerializableObject.h"
#include <type_traits>
 
class IDTable
{
public:
 
    typedef std::map<uintptr_t, SerializableObject*, std::less<uintptr_t> > forwardType;
 
    typedef std::map<SerializableObject*, uintptr_t, std::less<SerializableObject*> > reverseType;
 
    typename forwardType::const_iterator begin()
    { return m_forwardMap.begin(); }
 
    typename forwardType::const_iterator end()
    { return m_forwardMap.end(); }
 
public:
    IDTable()
    : m_nextID(1)
    {
        emplace(0, nullptr);
    }
 
    uintptr_t emplace(SerializableObject* p)
    {
        if(HasID(p))
            return m_reverseMap[p];
 
        uint32_t id = m_nextID ++;
        m_forwardMap[id] = p;
        m_reverseMap[p] = id;
        return id;
    }
 
    void emplace(uintptr_t id, SerializableObject* p)
    {
        ReserveID(id);
        m_forwardMap[id] = p;
        m_reverseMap[p] = id;
    }
 
    bool HasID(SerializableObject* p)
    { return (m_reverseMap.find(p) != m_reverseMap.end()); }
 
    bool HasID(uintptr_t id)
    { return (m_forwardMap.find(id) != m_forwardMap.end()); }
 
    void ReserveID(uintptr_t id)
    { m_nextID = std::max(m_nextID, id+1); }
 
    template<class T>
    T* Lookup(uintptr_t id)
    {
        static_assert(std::is_base_of_v<SerializableObject, T> == true);
        return dynamic_cast<T*>(m_forwardMap[id]);
    }
 
    uintptr_t operator[](SerializableObject* key)
    { return m_reverseMap[key]; }
 
    void clear()
    {
        m_forwardMap.clear();
        m_reverseMap.clear();
        m_nextID = 1;
    }
 
    void erase(uintptr_t key)
    {
        auto value = m_forwardMap[key];
        m_forwardMap.erase(key);
        m_reverseMap.erase(value);
    }
 
    void erase(SerializableObject* key)
    {
        auto value = m_reverseMap[key];
        m_reverseMap.erase(key);
        m_forwardMap.erase(value);
    }
 
    void replace(SerializableObject* oldval, SerializableObject* newval)
    {
        uintptr_t key = m_reverseMap[oldval];
        m_reverseMap.erase(oldval);
        m_forwardMap[key] = newval;
        m_reverseMap[newval] = key;
    }
 
    size_t size() const
    { return m_forwardMap.size(); }
 
protected:
 
    uintptr_t m_nextID;
 
    forwardType m_forwardMap;
 
    reverseType m_reverseMap;
};
 
#endif