tool_base.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 CERN
 * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[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_BASE_H
#define __TOOL_BASE_H

#include <cassert>
#include <functional>
#include <string>
#include <wx/debug.h>

class EDA_ITEM;
class TOOL_EVENT;
class TOOL_MANAGER;
class TOOLS_HOLDER;

namespace KIGFX
{
class VIEW;
class VIEW_CONTROLS;
}

enum TOOL_TYPE
{
 INTERACTIVE = 0x01,

 BATCH = 0x02
};

typedef int TOOL_ID;

using TOOL_STATE_FUNC = std::function<int(const TOOL_EVENT&)>;


class TOOL_BASE
{
public:
 TOOL_BASE( TOOL_TYPE aType, TOOL_ID aId, const std::string& aName = std::string( "" ) ) :
 m_type( aType ),
 m_toolId( aId ),
 m_toolName( aName ),
 m_toolMgr( nullptr ) {};

 virtual ~TOOL_BASE() {};

 enum RESET_REASON
 {
 RUN, 
 MODEL_RELOAD, 
 GAL_SWITCH 
 };

 virtual bool Init()
 {
 return true;
 }

 virtual void Reset( RESET_REASON aReason ) = 0;

 TOOL_TYPE GetType() const
 {
 return m_type;
 }

 TOOL_ID GetId() const
 {
 return m_toolId;
 }

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

 TOOL_MANAGER* GetManager() const
 {
 return m_toolMgr;
 }

 //TOOL_SETTINGS& GetAdapter();

 bool IsToolActive() const;

protected:
 friend class TOOL_MANAGER;
 friend class TOOL_SETTINGS;

 void attachManager( TOOL_MANAGER* aManager );

 KIGFX::VIEW* getView() const;

 KIGFX::VIEW_CONTROLS* getViewControls() const;

 template <typename T>
 T* getEditFrame() const
 {
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( getToolHolderInt() ) );
#endif
 return static_cast<T*>( getToolHolderInt() );
 }

 template <typename T>
 T* getModel() const
 {
 EDA_ITEM* m = getModelInt();
#if !defined( QA_TEST ) // Dynamic casts give the linker a seizure in the test framework
 wxASSERT( dynamic_cast<T*>( m ) );
#endif
 return static_cast<T*>( m );
 }

 TOOL_TYPE m_type;

 TOOL_ID m_toolId;

 std::string m_toolName;
 TOOL_MANAGER* m_toolMgr;
 //TOOL_SETTINGS m_toolSettings;

private:
 // hide the implementation to avoid spreading half of
 // kicad and wxWidgets headers to the tools that may not need them at all!
 EDA_ITEM* getModelInt() const;
 TOOLS_HOLDER* getToolHolderInt() const;
};

#endif