tool_manager.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-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 2
 * 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 TOOL_MANAGER_H
#define TOOL_MANAGER_H
 
#include <list>
#include <map>
#include <stack>
#include <vector>
#include <typeinfo>
#include <type_traits>
 
#include <tool/tool_base.h>
#include <tool/tool_event.h>
 
namespace KIGFX
{
class VIEW_CONTROLS;
struct VC_SETTINGS;
}
 
class COMMIT;
class TOOLS_HOLDER;
class TOOL_ACTION;
class ACTION_MANAGER;
class ACTION_MENU;
class APP_SETTINGS_BASE;
 

class TOOL_MANAGER
{
private:
    struct TOOL_STATE;
 
public:
    TOOL_MANAGER();
 
    ~TOOL_MANAGER();
 
    // Helper typedefs
    typedef std::map<TOOL_BASE*, TOOL_STATE*> TOOL_STATE_MAP;
    typedef std::map<std::string, TOOL_STATE*> NAME_STATE_MAP;
    typedef std::map<TOOL_ID, TOOL_STATE*> ID_STATE_MAP;
    typedef std::list<TOOL_ID> ID_LIST;

    static TOOL_ID MakeToolId( const std::string& aToolName );

    void RegisterTool( TOOL_BASE* aTool );

    bool InvokeTool( TOOL_ID aToolId );

    bool InvokeTool( const std::string& aToolName );

    void ShutdownAllTools();

    void ShutdownTool( TOOL_BASE* aTool );

    void ShutdownTool( TOOL_ID aToolId );

    void ShutdownTool( const std::string& aToolName );

    template<typename T, std::enable_if_t<!std::is_convertible_v<T*, COMMIT*>>* = nullptr>
    bool RunAction( const std::string& aActionName, T aParam )
    {
        // Use a cast to ensure the proper type is stored inside the parameter
        ki::any a( static_cast<T>( aParam ) );
 
        return doRunAction( aActionName, true, a, nullptr );
    }
 
    bool RunAction( const std::string& aActionName )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        return doRunAction( aActionName, true, a, nullptr );
    }

    template<typename T, std::enable_if_t<!std::is_convertible_v<T, COMMIT*>>* = nullptr>
    bool RunAction( const TOOL_ACTION& aAction, T aParam )
    {
        // Use a cast to ensure the proper type is stored inside the parameter
        ki::any a( static_cast<T>( aParam ) );
 
        return doRunAction( aAction, true, a, nullptr );
    }

    template<typename T>
    bool RunSynchronousAction( const TOOL_ACTION& aAction, COMMIT* aCommit, T aParam )
    {
        // Use a cast to ensure the proper type is stored inside the parameter
        ki::any a( static_cast<T>( aParam ) );
 
        return doRunAction( aAction, true, a, aCommit );
    }
 
    bool RunSynchronousAction( const TOOL_ACTION& aAction, COMMIT* aCommit )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        return doRunAction( aAction, true, a, aCommit );
    }
 
    bool RunAction( const TOOL_ACTION& aAction )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        return doRunAction( aAction, true, a, nullptr );
    }

    template<typename T>
    bool PostAction( const std::string& aActionName, T aParam )
    {
        // Use a cast to ensure the proper type is stored inside the parameter
        ki::any a( static_cast<T>( aParam ) );
 
        return doRunAction( aActionName, false, a, nullptr );
    }
 
    bool PostAction( const std::string& aActionName )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        return doRunAction( aActionName, false, a, nullptr );
    }

    template<typename T, std::enable_if_t<!std::is_convertible_v<T, COMMIT*>>* = nullptr>
    bool PostAction( const TOOL_ACTION& aAction, T aParam )
    {
        // Use a cast to ensure the proper type is stored inside the parameter
        ki::any a( static_cast<T>( aParam ) );
 
        return doRunAction( aAction, false, a, nullptr );
    }
 
    void PostAction( const TOOL_ACTION& aAction )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        doRunAction( aAction, false, a, nullptr );
    }
 
    // TODO: we need a way to guarantee that user events can't be processed in
    // between API actions.  Otherwise the COMMITs will get tangled up and we'll
    // crash on bad pointers.
    bool PostAPIAction( const TOOL_ACTION& aAction, COMMIT* aCommit )
    {
        // Default initialize the parameter argument to an empty ki_any
        ki::any a;
 
        return doRunAction( aAction, false, a, aCommit, true );
    }

    void CancelTool();

    void PrimeTool( const VECTOR2D& aPosition );

    int GetHotKey( const TOOL_ACTION& aAction ) const;
 
    ACTION_MANAGER* GetActionManager() const { return m_actionMgr; }

    TOOL_BASE* FindTool( int aId ) const;

    TOOL_BASE* FindTool( const std::string& aName ) const;
 
    /*
     * Return the tool of given type or nullptr if there is no such tool registered.
     */
    template<typename T>
    T* GetTool()
    {
        std::map<const char*, TOOL_BASE*>::iterator tool = m_toolTypes.find( typeid( T ).name() );
 
        if( tool != m_toolTypes.end() )
            return static_cast<T*>( tool->second );
 
        return nullptr;
    }
 
    /*
     * Return all registered tools.
     */
    std::vector<TOOL_BASE*> Tools() { return m_toolOrder; }

    void DeactivateTool();
 

     bool IsToolActive( TOOL_ID aId ) const;
 

    void ResetTools( TOOL_BASE::RESET_REASON aReason );

    void InitTools();

    bool ProcessEvent( const TOOL_EVENT& aEvent );

    void PostEvent( const TOOL_EVENT& aEvent );

    void SetEnvironment( EDA_ITEM* aModel, KIGFX::VIEW* aView,
                         KIGFX::VIEW_CONTROLS* aViewControls, APP_SETTINGS_BASE* aSettings,
                         TOOLS_HOLDER* aFrame );
 
    /*
     * Accessors for the environment objects (view, model, etc.)
     */
    KIGFX::VIEW* GetView() const { return m_view; }
 
    KIGFX::VIEW_CONTROLS* GetViewControls() const { return m_viewControls; }
 
    VECTOR2D GetMousePosition() const;
    VECTOR2D GetCursorPosition() const;
 
    EDA_ITEM* GetModel() const { return m_model; }
    void      ClearModel() { m_model = nullptr; }
 
    APP_SETTINGS_BASE* GetSettings() const { return m_settings; }
 
    TOOLS_HOLDER* GetToolHolder() const { return m_frame; }

    inline int GetCurrentToolId() const
    {
        return m_activeTools.empty() ? -1 : m_activeTools.front();
    }

    inline TOOL_BASE* GetCurrentTool() const
    {
        return FindTool( GetCurrentToolId() );
    }

    TOOL_STATE* GetCurrentToolState() const
    {
        auto it = m_toolIdIndex.find( GetCurrentToolId() );
        return ( it != m_toolIdIndex.end() ) ? it->second : nullptr;
    }

    int GetPriority( int aToolId ) const;

    void ScheduleNextState( TOOL_BASE* aTool, TOOL_STATE_FUNC& aHandler,
                            const TOOL_EVENT_LIST& aConditions );

    void ClearTransitions( TOOL_BASE* aTool );
 
    void RunMainStack( TOOL_BASE* aTool, std::function<void()> aFunc );

    void UpdateUI( const TOOL_EVENT& aEvent );

    TOOL_EVENT* ScheduleWait( TOOL_BASE* aTool, const TOOL_EVENT_LIST& aConditions );

    void ScheduleContextMenu( TOOL_BASE* aTool, ACTION_MENU* aMenu, CONTEXT_MENU_TRIGGER aTrigger );

    const KIGFX::VC_SETTINGS& GetCurrentToolVC() const;

    bool IsContextMenuActive() const
    {
        return m_menuActive;
    }

    void VetoContextMenuMouseWarp()
    {
        m_warpMouseAfterContextMenu = false;
    }

    void WarpAfterContextMenu();

    void DispatchContextMenu( const TOOL_EVENT& aEvent );

    bool DispatchHotKey( const TOOL_EVENT& aEvent );
 
    VECTOR2D GetMenuCursorPos() const
    {
        return m_menuCursor;
    }
 
private:
    typedef std::pair<TOOL_EVENT_LIST, TOOL_STATE_FUNC> TRANSITION;

    bool doRunAction( const TOOL_ACTION& aAction, bool aNow, const ki::any& aParam,
                      COMMIT* aCommit, bool aFromAPI = false );
    bool doRunAction( const std::string& aActionName, bool aNow, const ki::any& aParam,
                      COMMIT* aCommit );

    bool dispatchInternal( TOOL_EVENT& aEvent );

    bool dispatchActivation( const TOOL_EVENT& aEvent );

    bool invokeTool( TOOL_BASE* aTool );

    bool runTool( TOOL_BASE* aTool );

    ID_LIST::iterator finishTool( TOOL_STATE* aState );

    bool isRegistered( TOOL_BASE* aTool ) const
    {
        return m_toolState.count( aTool ) > 0;
    }

    bool isActive( TOOL_BASE* aTool ) const;

    void saveViewControls( TOOL_STATE* aState );

    void applyViewControls( const TOOL_STATE* aState );

    bool processEvent( const TOOL_EVENT& aEvent );

    void setActiveState( TOOL_STATE* aState );
 
private:
    std::vector<TOOL_BASE*> m_toolOrder;

    TOOL_STATE_MAP m_toolState;

    NAME_STATE_MAP m_toolNameIndex;

    ID_STATE_MAP m_toolIdIndex;

    std::map<const char*, TOOL_BASE*> m_toolTypes;

    ID_LIST m_activeTools;

    ACTION_MANAGER* m_actionMgr;

    std::map<TOOL_ID, std::optional<VECTOR2D>> m_cursorSettings;
 
    EDA_ITEM*             m_model;
    KIGFX::VIEW*          m_view;
    KIGFX::VIEW_CONTROLS* m_viewControls;
    TOOLS_HOLDER*         m_frame;
    APP_SETTINGS_BASE*    m_settings;

    std::list<TOOL_EVENT> m_eventQueue;

    VECTOR2D m_menuCursor;

    std::optional<VECTOR2D> m_hotKeyPos;
 
    bool m_warpMouseAfterContextMenu;

    bool m_menuActive;

    TOOL_ID m_menuOwner;

    TOOL_STATE* m_activeState;

    bool m_shuttingDown;
};
 
#endif // TOOL_MANAGER_H