property_mgr.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 CERN
 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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 PROPERTY_MGR_H
#define PROPERTY_MGR_H

#include <core/wx_stl_compat.h> // Needed for stl hash extensions

#include <wx/string.h>

#include <map>
#include <unordered_map>
#include <set>
#include <vector>
#include <memory>
#include <eda_units.h>

class PROPERTY_BASE;
class TYPE_CAST_BASE;

using TYPE_ID = size_t;

using PROPERTY_LIST = std::vector<PROPERTY_BASE*>;

using PROPERTY_SET = std::set<std::pair<size_t, wxString>>;

class PROPERTY_MANAGER
{
public:
    static PROPERTY_MANAGER& Instance()
    {
        static PROPERTY_MANAGER pm;
        return pm;
    }

    void RegisterType( TYPE_ID aType, const wxString& aName );

    const wxString& ResolveType( TYPE_ID aType ) const;

    PROPERTY_BASE* GetProperty( TYPE_ID aType, const wxString& aProperty ) const;

    const PROPERTY_LIST& GetProperties( TYPE_ID aType ) const;

    const void* TypeCast( const void* aSource, TYPE_ID aBase, TYPE_ID aTarget ) const;

    void* TypeCast( void* aSource, TYPE_ID aBase, TYPE_ID aTarget ) const
    {
        return const_cast<void*>( TypeCast( (const void*) aSource, aBase, aTarget ) );
    }

    void AddProperty( PROPERTY_BASE* aProperty );

    void ReplaceProperty( size_t aBase, const wxString& aName, PROPERTY_BASE* aNew );

    void AddTypeCast( TYPE_CAST_BASE* aCast );

    void InheritsAfter( TYPE_ID aDerived, TYPE_ID aBase );

    bool IsOfType( TYPE_ID aDerived, TYPE_ID aBase ) const;

    EDA_UNITS GetUnits() const
    {
        return m_units;
    }

    void SetUnits( EDA_UNITS aUnits )
    {
        m_units = aUnits;
    }

    void Rebuild();

    struct CLASS_INFO
    {
        wxString name;
        TYPE_ID type;
        std::vector<PROPERTY_BASE*> properties;
    };

    typedef std::vector<CLASS_INFO> CLASSES_INFO;

    CLASSES_INFO GetAllClasses();

    std::vector<TYPE_ID> GetMatchingClasses( PROPERTY_BASE* aProperty );

private:
    PROPERTY_MANAGER()
        : m_dirty( false ), m_units( EDA_UNITS::MILLIMETRES )
    {
    }

    struct CLASS_DESC
    {
        CLASS_DESC( TYPE_ID aId )
            : m_id( aId )
        {
        }

        const TYPE_ID m_id;

        std::vector<std::reference_wrapper<CLASS_DESC>> m_bases;

        std::map<wxString, std::unique_ptr<PROPERTY_BASE>> m_ownProperties;

        std::map<TYPE_ID, std::unique_ptr<TYPE_CAST_BASE>> m_typeCasts;

        std::vector<PROPERTY_BASE*> m_allProperties;

        PROPERTY_SET m_replaced;

        void rebuild();

        void collectPropsRecur( PROPERTY_LIST& aResult, PROPERTY_SET& aReplaced ) const;
    };

    CLASS_DESC& getClass( TYPE_ID aTypeId );

    std::unordered_map<TYPE_ID, wxString> m_classNames;

    std::unordered_map<TYPE_ID, CLASS_DESC> m_classes;

    bool m_dirty;

    EDA_UNITS m_units;
};


#define REGISTER_TYPE(x) PROPERTY_MANAGER::Instance().RegisterType(TYPE_HASH(x), TYPE_NAME(x))

#endif /* PROPERTY_MGR_H */