tool_action.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_ACTION_H
#define __TOOL_ACTION_H
 
#include <bitset>
#include <cassert>
#include <optional>
#include <string>
#include <string_view>
 
#include <ki_any.h>
#include <wx/string.h>
 
class TOOL_EVENT;
 
enum class BITMAPS : unsigned int;

enum TOOL_ACTION_SCOPE
{
    AS_CONTEXT = 1,  
    AS_ACTIVE,       
    AS_GLOBAL        
};

enum TOOL_ACTION_FLAGS
{
    AF_NONE     = 0,
    AF_ACTIVATE = 1,    
    AF_NOTIFY   = 2     
};

enum class TOOLBAR_STATE
{
    HIDDEN = 0,         
    TOGGLE = 1,         
    CANCEL = 2,         
 
    ENUM_LENGTH = 3
};
 
// The length of the TOOLBAR_STATE enum as a size_t (used for bitset creation)
const size_t gToolbarStateNumber = static_cast<size_t>( TOOLBAR_STATE::ENUM_LENGTH );
 
typedef std::bitset<gToolbarStateNumber> TOOLBAR_STATE_FLAGS;

class TOOL_ACTION_GROUP
{
public:
    TOOL_ACTION_GROUP( std::string aName ) :
        m_name( aName )
    {
        // Assign a unique group ID to each group
        static int groupIDs = 0;
        m_groupID = ++groupIDs;
    };
 
    TOOL_ACTION_GROUP( const TOOL_ACTION_GROUP& aOther )
    {
        // Ensure a copy of a group is exactly the same as this one to get
        // proper comparisons
        m_name    = aOther.GetName();
        m_groupID = aOther.GetGroupID();
    }
 
    int                GetGroupID() const { return m_groupID; }
    const std::string& GetName()    const { return m_name; }
 
    bool operator==( const TOOL_ACTION_GROUP& aOther ) const
    {
        return m_groupID == aOther.m_groupID;
    }
 
private:
    int         m_groupID;
    std::string m_name;
};

class TOOL_ACTION_ARGS
{
public:
    TOOL_ACTION_ARGS() = default;

    TOOL_ACTION_ARGS& Name( const std::string_view& aName )
    {
        m_name = aName;
        return *this;
    }
 
    TOOL_ACTION_ARGS& FriendlyName( const std::string_view& aName )
    {
        m_friendlyName = aName;
        return *this;
    }

    TOOL_ACTION_ARGS& Scope( TOOL_ACTION_SCOPE aScope )
    {
        m_scope = aScope;
        return *this;
    }

    TOOL_ACTION_ARGS& DefaultHotkey( int aDefaultHotkey )
    {
        m_defaultHotKey = aDefaultHotkey;
        return *this;
    }

    TOOL_ACTION_ARGS& DefaultHotkeyAlt( int aDefaultHotkeyAlt )
    {
        m_defaultHotKeyAlt = aDefaultHotkeyAlt;
        return *this;
    }

    TOOL_ACTION_ARGS& LegacyHotkeyName( const std::string_view& aLegacyName )
    {
        m_legacyName = aLegacyName;
        return *this;
    }

    TOOL_ACTION_ARGS& MenuText( const std::string_view& aMenuText )
    {
        m_menuText = aMenuText;
        return *this;
    }

    TOOL_ACTION_ARGS& Tooltip( const std::string_view& aTooltip )
    {
        m_tooltip = aTooltip;
        return *this;
    }

    TOOL_ACTION_ARGS& Description( const std::string_view& aDescription )
    {
        m_description = aDescription;
        return *this;
    }

    TOOL_ACTION_ARGS& Icon( BITMAPS aIcon )
    {
        m_icon = aIcon;
        return *this;
    }

    TOOL_ACTION_ARGS& Flags( TOOL_ACTION_FLAGS aFlags )
    {
        m_flags = aFlags;
        return *this;
    }

    template<typename T>
    TOOL_ACTION_ARGS& Parameter( T aParam )
    {
        m_param = aParam;
        return *this;
    }

    TOOL_ACTION_ARGS& UIId( int aUIId )
    {
        m_uiid = aUIId;
        return *this;
    }
 
    TOOL_ACTION_ARGS& Group( const TOOL_ACTION_GROUP& aGroup )
    {
        m_group = aGroup;
        return *this;
    }
 
    TOOL_ACTION_ARGS& ToolbarState( TOOLBAR_STATE aState )
    {
        m_toolbarState = TOOLBAR_STATE_FLAGS();
        m_toolbarState.value().set( static_cast<size_t>( aState ) );
        return *this;
    }
 
    TOOL_ACTION_ARGS& ToolbarState( std::initializer_list<TOOLBAR_STATE> aState )
    {
        m_toolbarState = TOOLBAR_STATE_FLAGS();
 
        for( auto flag : aState )
            m_toolbarState.value().set( static_cast<size_t>( flag ) );
 
        return *this;
    }
 
protected:
    // Let the TOOL_ACTION constructor have direct access to the members here
    friend class TOOL_ACTION;
 
    std::optional<std::string_view>     m_name;
    std::optional<std::string_view>     m_friendlyName;
    std::optional<TOOL_ACTION_SCOPE>    m_scope;
    std::optional<TOOL_ACTION_FLAGS>    m_flags;
 
    std::optional<int>                  m_uiid;
 
    std::optional<int>                  m_defaultHotKey;
    std::optional<int>                  m_defaultHotKeyAlt;
    std::optional<std::string_view>     m_legacyName;
 
    std::optional<std::string_view>     m_menuText;
    std::optional<std::string_view>     m_tooltip;
    std::optional<std::string_view>     m_description;
 
    std::optional<BITMAPS>              m_icon;
 
    std::optional<TOOL_ACTION_GROUP>    m_group;
 
    std::optional<TOOLBAR_STATE_FLAGS>  m_toolbarState;
 
    ki::any                             m_param;
};

class TOOL_ACTION
{
public:
    TOOL_ACTION( const TOOL_ACTION_ARGS& aArgs );
    TOOL_ACTION( const std::string& aName, TOOL_ACTION_SCOPE aScope = AS_CONTEXT,
                 int aDefaultHotKey = 0, const std::string& aLegacyHotKeyName = "",
                 const wxString& aMenuText = wxEmptyString,
                 const wxString& aTooltip = wxEmptyString,
                 BITMAPS aIcon = static_cast<BITMAPS>( 0 ), TOOL_ACTION_FLAGS aFlags = AF_NONE );
 
    ~TOOL_ACTION();
 
    // TOOL_ACTIONS are singletons; don't be copying them around....
    TOOL_ACTION( const TOOL_ACTION& ) = delete;
    TOOL_ACTION& operator= ( const TOOL_ACTION& ) = delete;
 
    bool operator==( const TOOL_ACTION& aRhs ) const
    {
        return m_id == aRhs.m_id;
    }
 
    bool operator!=( const TOOL_ACTION& aRhs ) const
    {
        return m_id != aRhs.m_id;
    }

    const std::string& GetName() const { return m_name; }

    int GetDefaultHotKey() const { return m_defaultHotKey; }
    int GetDefaultHotKeyAlt() const { return m_defaultHotKeyAlt; }

    int GetHotKey() const { return m_hotKey; }
    int GetHotKeyAlt() const { return m_hotKeyAlt; }
    void SetHotKey( int aKeycode, int aKeycodeAlt = 0 );

    bool IsHotKeyUserBound( int aMatchedHotKey ) const;

    int GetId() const { return m_id; }

    bool HasCustomUIId() const { return m_uiid.has_value(); }

    int GetUIId() const { return m_uiid.value_or( m_id + ACTION_BASE_UI_ID ); }

    static int GetBaseUIId() { return ACTION_BASE_UI_ID; }

    TOOL_EVENT MakeEvent() const;

    wxString GetMenuLabel() const;
    wxString GetMenuItem() const;
    wxString GetTooltip( bool aIncludeHotkey = true ) const;
    wxString GetButtonTooltip() const;
    wxString GetDescription() const;

    wxString GetFriendlyName() const;
 
    TOOL_ACTION_SCOPE GetScope() const { return m_scope; }

    template<typename T>
    T GetParam() const
    {
        wxASSERT_MSG( m_param.has_value(),
                      "Attempted to get a parameter from an action with no parameter." );
 
        T param;
 
        try
        {
            param = ki::any_cast<T>( m_param );
        }
        catch( const ki::bad_any_cast& e )
        {
            wxASSERT_MSG( false,
                          wxString::Format( "Requested parameter type %s from action with "
                                            "parameter type %s.",
                                            typeid(T).name(), m_param.type().name() ) );
        }
 
        return param;
    }
 
    const std::optional<TOOL_ACTION_GROUP> GetActionGroup() const { return m_group; }

    std::string GetToolName() const;

    bool IsActivation() const
    {
        return m_flags & AF_ACTIVATE;
    }

    bool IsNotification() const
    {
        return m_flags & AF_NOTIFY;
    }

    BITMAPS GetIcon() const
    {
        // The value of 0 corresponds to BITMAPS::INVALID_BITMAP, but is just
        // used here to make it so we don't need to include the full list in this
        // header.
        return m_icon.value_or( static_cast<BITMAPS>( 0 ) );
    }

    bool CheckToolbarState( TOOLBAR_STATE aState ) const
    {
        return m_toolbarState[static_cast<std::size_t>( aState )];
    }
 
 
protected:
    TOOL_ACTION();
 
    friend class ACTION_MANAGER;

    static constexpr int ACTION_BASE_UI_ID = 20000;

    std::string          m_name;
    TOOL_ACTION_SCOPE    m_scope;
 
    std::optional<TOOL_ACTION_GROUP> m_group; 
 
    const int         m_defaultHotKey;    
    const int         m_defaultHotKeyAlt; 
    int               m_hotKey;           

    int               m_hotKeyAlt;
    const std::string m_legacyName;       
 
    wxString                m_friendlyName; 
    std::optional<wxString> m_menuLabel;    
    wxString                m_tooltip;      
    std::optional<wxString> m_description;  
 
    std::optional<BITMAPS> m_icon; 
 
    int                m_id;   
    std::optional<int> m_uiid; 
 
    TOOLBAR_STATE_FLAGS m_toolbarState;    
 
    TOOL_ACTION_FLAGS m_flags;
    ki::any           m_param; 
};
 
#endif