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-2023 CERN
 * Copyright (C) 2021-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * 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 <functional>
#include <list>
#include <map>
#include <unordered_map>
#include <set>
#include <vector>
#include <memory>
#include <eda_units.h>
 
class PROPERTY_BASE;
class TYPE_CAST_BASE;
class ORIGIN_TRANSFORMS;
class INSPECTABLE;
class COMMIT;
 
using TYPE_ID = size_t;
 
using PROPERTY_LIST = std::vector<PROPERTY_BASE*>;
 
using PROPERTY_SET = std::set<std::pair<size_t, wxString>>;
 
template<typename ValueType>
using PROPERTY_MAP = std::map<std::pair<size_t, wxString>, ValueType>;
 
using PROPERTY_FUNCTOR_MAP = PROPERTY_MAP<std::function<bool( INSPECTABLE* )>>;
 
using PROPERTY_DISPLAY_ORDER = std::map<PROPERTY_BASE*, int>;
 
using PROPERTY_LISTENER = std::function<void( INSPECTABLE*, PROPERTY_BASE*, COMMIT* )>;
 
class PROPERTY_COMMIT_HANDLER
{
public:
 PROPERTY_COMMIT_HANDLER( COMMIT* aCommit );
 
 ~PROPERTY_COMMIT_HANDLER();
};
 
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 PROPERTY_DISPLAY_ORDER& GetDisplayOrder( TYPE_ID aType ) const;
 
 const std::vector<wxString>& GetGroupDisplayOrder( 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 ) );
 }
 
 PROPERTY_BASE& AddProperty( PROPERTY_BASE* aProperty, const wxString& aGroup = wxEmptyString );
 
 PROPERTY_BASE& ReplaceProperty( size_t aBase, const wxString& aName, PROPERTY_BASE* aNew,
 const wxString& aGroup = wxEmptyString );
 
 void AddTypeCast( TYPE_CAST_BASE* aCast );
 
 void InheritsAfter( TYPE_ID aDerived, TYPE_ID aBase );
 
 void Mask( TYPE_ID aDerived, TYPE_ID aBase, const wxString& aName );
 
 void OverrideAvailability( TYPE_ID aDerived, TYPE_ID aBase, const wxString& aName,
 std::function<bool( INSPECTABLE* )> aFunc );
 
 void OverrideWriteability( TYPE_ID aDerived, TYPE_ID aBase, const wxString& aName,
 std::function<bool( INSPECTABLE* )> aFunc );
 
 bool IsAvailableFor( TYPE_ID aItemClass, PROPERTY_BASE* aProp, INSPECTABLE* aItem );
 
 bool IsWriteableFor( TYPE_ID aItemClass, PROPERTY_BASE* aProp, INSPECTABLE* aItem );
 
 bool IsOfType( TYPE_ID aDerived, TYPE_ID aBase ) const;
 
 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 );
 
 void PropertyChanged( INSPECTABLE* aObject, PROPERTY_BASE* aProperty );
 
 void RegisterListener( TYPE_ID aType, PROPERTY_LISTENER aListenerFunc )
 {
 m_listeners[aType].emplace_back( aListenerFunc );
 }
 
private:
 PROPERTY_MANAGER() :
 m_dirty( false ),
 m_managedCommit( nullptr )
 {
 }
 
 friend class PROPERTY_COMMIT_HANDLER;
 
 struct CLASS_DESC
 {
 CLASS_DESC( TYPE_ID aId )
 : m_id( aId )
 {
 m_groupDisplayOrder.emplace_back( wxEmptyString );
 m_groups.insert( wxEmptyString );
 }
 
 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;
 
 PROPERTY_SET m_maskedBaseProperties;
 
 PROPERTY_FUNCTOR_MAP m_availabilityOverrides;
 
 PROPERTY_FUNCTOR_MAP m_writeabilityOverrides;
 
 std::vector<PROPERTY_BASE*> m_allProperties;
 
 PROPERTY_DISPLAY_ORDER m_displayOrder;
 
 std::vector<wxString> m_groupDisplayOrder;
 
 std::vector<PROPERTY_BASE*> m_ownDisplayOrder;
 
 std::set<wxString> m_groups;
 
 PROPERTY_SET m_replaced;
 
 void rebuild();
 
 void collectPropsRecur( PROPERTY_LIST& aResult, PROPERTY_SET& aReplaced,
 PROPERTY_DISPLAY_ORDER& aDisplayOrder,
 PROPERTY_SET& aMasked ) 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;
 
 std::map<TYPE_ID, std::vector<PROPERTY_LISTENER>> m_listeners;
 
 COMMIT* m_managedCommit;
};
 
 
#define REGISTER_TYPE(x) PROPERTY_MANAGER::Instance().RegisterType(TYPE_HASH(x), TYPE_NAME(x))
 
#endif /* PROPERTY_MGR_H */