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 The 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 <https://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 <algorithm>
#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_LISTENER = std::function<void( INSPECTABLE*, PROPERTY_BASE*, COMMIT* )>;

using PROPERTY_LISTENER_HANDLE = std::size_t;
 
class PROPERTY_COMMIT_HANDLER
{
public:
    PROPERTY_COMMIT_HANDLER( COMMIT* aCommit );
 
    ~PROPERTY_COMMIT_HANDLER();
 
private:
    bool m_ownsCommit = false;
};

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

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

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

    PROPERTY_BASE* GetProperty( const INSPECTABLE* aObject, const wxString& aProperty ) const;

    const std::vector<PROPERTY_BASE*>& GetProperties( TYPE_ID aType ) const;

    std::vector<PROPERTY_BASE*> GetProperties( const INSPECTABLE* aObject ) const;
 
    const std::map<PROPERTY_BASE*, int>& 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();

    void PropertyChanged( INSPECTABLE* aObject, PROPERTY_BASE* aProperty );

    [[nodiscard]] class PROPERTY_LISTENER_SUBSCRIPTION
            RegisterListener( TYPE_ID aType, PROPERTY_LISTENER aListenerFunc );

    void UnregisterListener( TYPE_ID aType, PROPERTY_LISTENER_HANDLE aHandle );
 
private:
    PROPERTY_MANAGER() :
            m_dirty( false ),
            m_managedCommit( nullptr )
    {
    }
 
    // Explicit noexcept on this user-declared destructor short-circuits the
    // implicit noexcept computation the compiler would otherwise perform by
    // walking every member's destructor. That walk reaches the
    // `std::map<wxString, std::unique_ptr<PROPERTY_BASE>>` member inside
    // CLASS_DESC and, since this header only forward-declares PROPERTY_BASE
    // / TYPE_CAST_BASE, fails with an "incomplete type" diagnostic at every
    // TU that includes property_mgr.h. The destructor body in
    // property_mgr.cpp sees the complete types via the property.h include
    // there.
    ~PROPERTY_MANAGER() noexcept;
 
    friend class PROPERTY_COMMIT_HANDLER;

    struct CLASS_DESC
    {
        // Constructor body lives in property_mgr.cpp so it doesn't force
        // every TU including this header to instantiate the destructors of
        // `std::map<X, std::unique_ptr<PROPERTY_BASE>>` and
        // `std::map<X, std::unique_ptr<TYPE_CAST_BASE>>` (which require
        // complete PROPERTY_BASE / TYPE_CAST_BASE — only forward-declared
        // here). Same applies to the destructor and the defaulted move
        // operations.
        CLASS_DESC( TYPE_ID aId );
        ~CLASS_DESC() noexcept;
        CLASS_DESC( CLASS_DESC&& ) noexcept;

        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::set<std::pair<size_t, wxString>> m_maskedBaseProperties;

        std::map<std::pair<size_t, wxString>, std::function<bool( INSPECTABLE* )>> m_availabilityOverrides;

        std::map<std::pair<size_t, wxString>, std::function<bool( INSPECTABLE* )>> m_writeabilityOverrides;

        std::vector<PROPERTY_BASE*> m_allProperties;

        std::map<PROPERTY_BASE*, int> m_displayOrder;

        std::vector<wxString> m_groupDisplayOrder;

        std::vector<PROPERTY_BASE*> m_ownDisplayOrder;

        std::set<wxString> m_groups;

        std::set<std::pair<size_t, wxString>> m_replaced;

        void rebuild();

        void collectPropsRecur( std::vector<PROPERTY_BASE*>& aResult,
                                std::set<std::pair<size_t, wxString>>& aReplaced,
                                std::map<PROPERTY_BASE*, int>& aDisplayOrder,
                                std::set<std::pair<size_t, wxString>>& 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<std::pair<PROPERTY_LISTENER_HANDLE, PROPERTY_LISTENER>>> m_listeners;
 
    PROPERTY_LISTENER_HANDLE m_nextListenerHandle = 0;
 
    COMMIT* m_managedCommit;
};
 

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

class PROPERTY_LISTENER_SUBSCRIPTION
{
public:
    PROPERTY_LISTENER_SUBSCRIPTION() = default;
 
    PROPERTY_LISTENER_SUBSCRIPTION( TYPE_ID aType, PROPERTY_LISTENER_HANDLE aHandle ) :
            m_type( aType ),
            m_handle( aHandle )
    {
    }
 
    // Destructor + reset() are out-of-line so the chain reset() ->
    // PROPERTY_MANAGER::UnregisterListener doesn't force consumers of this
    // header to fully instantiate PROPERTY_MANAGER (which would require
    // complete PROPERTY_BASE / TYPE_CAST_BASE for the unique_ptr members
    // inside CLASS_DESC). Holders of this subscription as a class member
    // (e.g. SCHEMATIC) therefore only see the declarations here, not the
    // implicit PROPERTY_MANAGER destructor instantiation.
    ~PROPERTY_LISTENER_SUBSCRIPTION();
 
    PROPERTY_LISTENER_SUBSCRIPTION( const PROPERTY_LISTENER_SUBSCRIPTION& ) = delete;
    PROPERTY_LISTENER_SUBSCRIPTION& operator=( const PROPERTY_LISTENER_SUBSCRIPTION& ) = delete;
 
    PROPERTY_LISTENER_SUBSCRIPTION( PROPERTY_LISTENER_SUBSCRIPTION&& aOther ) noexcept :
            m_type( aOther.m_type ),
            m_handle( aOther.m_handle )
    {
        aOther.m_handle = 0;
    }
 
    PROPERTY_LISTENER_SUBSCRIPTION& operator=( PROPERTY_LISTENER_SUBSCRIPTION&& aOther ) noexcept;
 
    void reset();
 
private:
    TYPE_ID                  m_type   = 0;
    PROPERTY_LISTENER_HANDLE m_handle = 0;
};
 
 
#endif /* PROPERTY_MGR_H */