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 (C) 2020 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef __TOOL_ACTION_H
#define __TOOL_ACTION_H
 
#include <any>
#include <cassert>
#include <optional>
#include <string>
#include <string_view>
 
#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 
};
 
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;
 }
 
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::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 );
 
 int GetId() const { return m_id; }
 
 bool HasCustomUIId() const { return m_uiid.has_value(); }
 
 /*
 * Get the unique ID for this action in the user interface system.
 *
 * This can be either set to a specific ID during creation or computed
 * by offsetting the action ID by @c ACTION_BASE_UI_ID.
 *
 * @return The unique ID number for use in the user interface system.
 */
 int GetUIId() const { return m_uiid.value_or( m_id + ACTION_BASE_UI_ID ); }
 
 /*
 * Get the base value used to offset the user interface IDs for the actions.
 */
 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 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 = std::any_cast<T>( m_param );
 }
 catch( const std::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
 {
 return m_icon;
 }
 
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; // Optional group for the action to belong to
 
 const int m_defaultHotKey; // Default hot key
 const int m_defaultHotKeyAlt; // Default hot key alternate
 int m_hotKey; // The current hotkey (post-user-settings-application)
 int m_hotKeyAlt; // The alternate hotkey (post-user-settings-application)
 const std::string m_legacyName; // Name for reading legacy hotkey settings
 
 wxString m_friendlyName; // User-friendly name
 std::optional<wxString> m_menuLabel; // Menu label
 wxString m_tooltip; // User-facing tooltip help text
 std::optional<wxString> m_description; // Description of the action
 
 BITMAPS m_icon; // Icon for the menu entry
 
 int m_id; // Unique ID for maps. Assigned by ACTION_MANAGER.
 std::optional<int> m_uiid; // ID to use when interacting with the UI (if empty, generate one)
 
 TOOL_ACTION_FLAGS m_flags;
 std::any m_param; // Generic parameter
};
 
#endif