eda_item.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-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2020 KiCad Developers, see change_log.txt for contributors.
 *
 * 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 EDA_ITEM_H
#define EDA_ITEM_H

#include <deque>

#include <core/typeinfo.h>
#include <eda_item_flags.h>
#include <view/view_item.h>
#include <kiid.h>


enum class BITMAPS : unsigned int;


enum class SEARCH_RESULT
{
 QUIT,
 CONTINUE
};


enum FIND_REPLACE_FLAGS
{
 // The last wxFindReplaceFlag enum is wxFR_MATCHCASE = 0x4.
 FR_CURRENT_SHEET_ONLY = 0x4 << 1, // Search the current sheet only.
 FR_SEARCH_ALL_FIELDS = 0x4 << 2, // Search hidden fields too.
 FR_SEARCH_ALL_PINS = 0x4 << 3, // Search pin name and number.
 FR_MATCH_WILDCARD = 0x4 << 4, // Use simple wild card matching (* & ?).
 FR_SEARCH_WRAP = 0x4 << 5, // Wrap around the start or end of search.
 FR_SEARCH_REPLACE = 0x4 << 7, // Search for a item that has replaceable text.
 FR_REPLACE_ITEM_FOUND = 0x4 << 8, // Indicates an item with replaceable text has been found.
 FR_REPLACE_REFERENCES = 0x4 << 9 // Don't replace in references.
};


class wxFindReplaceData;
class EDA_DRAW_FRAME;
class EDA_RECT;
class MSG_PANEL_ITEM;


typedef std::function< SEARCH_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC;

typedef const INSPECTOR_FUNC& INSPECTOR;


class EDA_ITEM : public KIGFX::VIEW_ITEM
{
public:
 virtual ~EDA_ITEM() { };

 inline KICAD_T Type() const { return m_structType; }

 EDA_ITEM* GetParent() const { return m_parent; }
 virtual void SetParent( EDA_ITEM* aParent ) { m_parent = aParent; }

 inline bool IsModified() const { return m_flags & IS_CHANGED; }
 inline bool IsNew() const { return m_flags & IS_NEW; }
 inline bool IsMoving() const { return m_flags & IS_MOVING; }
 inline bool IsDragging() const { return m_flags & IS_DRAGGING; }
 inline bool IsWireImage() const { return m_flags & IS_WIRE_IMAGE; }
 inline bool IsSelected() const { return m_flags & SELECTED; }
 inline bool IsEntered() const { return m_flags & ENTERED; }
 inline bool IsResized() const { return m_flags & IS_RESIZING; }
 inline bool IsBrightened() const { return m_flags & BRIGHTENED; }

 inline void SetWireImage() { SetFlags( IS_WIRE_IMAGE ); }
 inline void SetSelected() { SetFlags( SELECTED ); }
 inline void SetBrightened() { SetFlags( BRIGHTENED ); }

 inline void ClearSelected() { ClearFlags( SELECTED ); }
 inline void ClearBrightened() { ClearFlags( BRIGHTENED ); }

 void SetModified();

 int GetState( EDA_ITEM_FLAGS type ) const
 {
 return m_status & type;
 }

 void SetState( EDA_ITEM_FLAGS type, bool state )
 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

 EDA_ITEM_FLAGS GetStatus() const { return m_status; }
 void SetStatus( EDA_ITEM_FLAGS aStatus ) { m_status = aStatus; }

 void SetFlags( EDA_ITEM_FLAGS aMask ) { m_flags |= aMask; }
 void ClearFlags( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS ) { m_flags &= ~aMask; }
 EDA_ITEM_FLAGS GetFlags() const { return m_flags; }
 bool HasFlag( EDA_ITEM_FLAGS aFlag ) const { return ( m_flags & aFlag ) == aFlag; }

 EDA_ITEM_FLAGS GetEditFlags() const
 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_WIRE_IMAGE | STRUCT_DELETED );

 return m_flags & mask;
 }

 void ClearTempFlags()
 {
 ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
 DO_NOT_DRAW );
 }

 void ClearEditFlags()
 {
 ClearFlags( GetEditFlags() );
 }

 virtual bool IsType( const KICAD_T aScanTypes[] ) const
 {
 if( aScanTypes[0] == SCH_LOCATE_ANY_T )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( m_structType == *p )
 return true;
 }

 return false;
 }

 void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }

 bool IsForceVisible() const { return m_forceVisible; }

 virtual void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
 {
 }

 virtual bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const
 {
 return false; // derived classes should override this function
 }

 virtual bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const
 {
 return false; // derived classes should override this function
 }

 virtual const EDA_RECT GetBoundingBox() const;

 virtual wxPoint GetPosition() const { return wxPoint(); }
 virtual void SetPosition( const wxPoint& aPos ) {};

 virtual const wxPoint GetFocusPosition() const { return GetPosition(); }

 virtual EDA_ITEM* Clone() const; // should not be inline, to save the ~ 6 bytes per call site.

 virtual SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] );

 template< class T >
 static SEARCH_RESULT IterateForward( std::deque<T>& aList,
 INSPECTOR inspector,
 void* testData,
 const KICAD_T scanTypes[] )
 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

 template <class T>
 static SEARCH_RESULT IterateForward(
 std::vector<T>& aList, INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
 {
 for( auto it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
 == SEARCH_RESULT::QUIT )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
 }

 virtual wxString GetClass() const = 0;

 virtual wxString GetSelectMenuText( EDA_UNITS aUnits ) const;

 virtual BITMAPS GetMenuImage() const;

 virtual bool Matches( const wxFindReplaceData& aSearchData, void* aAuxData ) const
 {
 return false;
 }

 static bool Replace( const wxFindReplaceData& aSearchData, wxString& aText );

 virtual bool Replace( const wxFindReplaceData& aSearchData, void* aAuxData = nullptr )
 {
 return false;
 }

 virtual bool IsReplaceable() const { return false; }

 bool operator<( const EDA_ITEM& aItem ) const;

 static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }

 EDA_ITEM& operator=( const EDA_ITEM& aItem );

 virtual const BOX2I ViewBBox() const override;

 virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;

#if defined(DEBUG)

 virtual void Show( int nestLevel, std::ostream& os ) const = 0;

 void ShowDummy( std::ostream& os ) const; 

 static std::ostream& NestedSpace( int nestLevel, std::ostream& os );

#endif

protected:
 EDA_ITEM( EDA_ITEM* parent, KICAD_T idType );
 EDA_ITEM( KICAD_T idType );
 EDA_ITEM( const EDA_ITEM& base );

 bool Matches( const wxString& aText, const wxFindReplaceData& aSearchData ) const;

public:
 const KIID m_Uuid;

protected:
 EDA_ITEM_FLAGS m_status;
 EDA_ITEM* m_parent; 
 bool m_forceVisible;
 EDA_ITEM_FLAGS m_flags;

private:
 KICAD_T m_structType;
};


inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }


typedef std::vector< EDA_ITEM* > EDA_ITEMS;

#endif // EDA_ITEM_H