KiCad PCB EDA Suite
base_struct.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 2004-2019 KiCad Developers, see change_log.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
27 #ifndef BASE_STRUCT_H_
28 #define BASE_STRUCT_H_
29 
30 #include <deque>
31 
32 #include <core/typeinfo.h>
33 #include "common.h"
34 #include <wx/fdrepdlg.h>
35 #include <bitmap_types.h>
36 #include <view/view_item.h>
37 
42 enum FILL_T {
43  NO_FILL, // Poly, Square, Circle, Arc = option No Fill
44  FILLED_SHAPE, /* Poly, Square, Circle, Arc = option Fill
45  * with current color ("Solid shape") */
46  FILLED_WITH_BG_BODYCOLOR /* Poly, Square, Circle, Arc = option Fill
47  * with background body color, translucent
48  * (texts inside this shape can be seen)
49  * not filled in B&W mode when plotting or
50  * printing */
51 };
52 
53 
54 enum class SEARCH_RESULT
55 {
56  QUIT,
57  CONTINUE
58 };
59 
60 
65 {
66  // The last wxFindReplaceFlag enum is wxFR_MATCHCASE = 0x4.
67  FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1, // Search the current sheet only.
68  FR_SEARCH_ALL_FIELDS = wxFR_MATCHCASE << 2, // Search user fields as well as ref and value.
69  FR_SEARCH_ALL_PINS = wxFR_MATCHCASE << 3, // Search pin name and number.
70  FR_MATCH_WILDCARD = wxFR_MATCHCASE << 4, // Use simple wild card matching (* & ?).
71  FR_SEARCH_WRAP = wxFR_MATCHCASE << 5, // Wrap around the start or end of search.
72  FR_SEARCH_REPLACE = wxFR_MATCHCASE << 7, // Search for a item that has replaceable text.
73  FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8, // Indicates an item with replaceable text has
74  // been found.
75  FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9 // Don't replace in references.
76 };
77 
78 
79 class wxFindReplaceData;
80 class EDA_ITEM;
81 class EDA_DRAW_FRAME;
82 class EDA_RECT;
84 
85 
106 typedef std::function< SEARCH_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC;
107 
108 typedef const INSPECTOR_FUNC& INSPECTOR;
109 
110 
111 // These define are used for the .m_Flags and .m_UndoRedoStatus member of the
112 // class EDA_ITEM
113 //
114 // NB: DO NOT ADD FLAGS ANYWHERE BUT AT THE END: THE FLAG-SET IS STORED AS AN INTEGER IN FILES.
115 //
116 #define IS_CHANGED (1 << 0)
117 #define IS_LINKED (1 << 1)
118 #define IN_EDIT (1 << 2)
119 #define IS_MOVED (1 << 3)
120 #define IS_NEW (1 << 4)
121 #define IS_RESIZED (1 << 5)
122 #define IS_DRAGGED (1 << 6)
123 #define IS_DELETED (1 << 7)
124 #define IS_WIRE_IMAGE (1 << 8)
125 #define STARTPOINT (1 << 9)
126 #define ENDPOINT (1 << 10)
127 #define SELECTED (1 << 11)
128 #define TEMP_SELECTED (1 << 12)
129 #define STRUCT_DELETED (1 << 13)
130 #define CANDIDATE (1 << 14)
131 #define SKIP_STRUCT (1 << 15)
132 #define DO_NOT_DRAW (1 << 16)
133 #define IS_PASTED (1 << 17)
134 #define TRACK_LOCKED (1 << 18)
135 #define TRACK_AR (1 << 19)
136 #define FLAG1 (1 << 20)
137 #define FLAG0 (1 << 21)
138 #define BEGIN_ONPAD (1 << 22)
139 #define END_ONPAD (1 << 23)
140 #define BUSY (1 << 24)
141 #define HIGHLIGHTED (1 << 25)
143 #define BRIGHTENED (1 << 26)
144 
145 #define DP_COUPLED (1 << 27)
146 #define UR_TRANSIENT (1 << 28)
148 
149 #define IS_DANGLING (1 << 29)
150 
151 // WARNING: if you add flags, you'll probably need to adjust the masks in GetEditFlags() and
152 // ClearTempFlags().
153 
154 // NOTE: The HIGHLIGHTED flag is basically deprecated, it was used for cross-probing before eeschema
155 // supported real object selection.
156 
157 #define EDA_ITEM_ALL_FLAGS -1
158 
159 typedef unsigned STATUS_FLAGS;
160 
167 {
168 public:
169  const KIID m_Uuid;
170 
171 private:
172 
180 
181 protected:
182 
184 
187 
190 
191 private:
192 
193  void initVars();
194 
195 protected:
196 
197  EDA_ITEM( EDA_ITEM* parent, KICAD_T idType );
198  EDA_ITEM( KICAD_T idType );
199  EDA_ITEM( const EDA_ITEM& base );
200 
201 public:
202 
203  virtual ~EDA_ITEM() { };
204 
212  inline KICAD_T Type() const
213  {
214  return m_StructType;
215  }
216 
217  EDA_ITEM* GetParent() const { return m_Parent; }
218  void SetParent( EDA_ITEM* aParent ) { m_Parent = aParent; }
219 
220  inline bool IsNew() const { return m_Flags & IS_NEW; }
221  inline bool IsModified() const { return m_Flags & IS_CHANGED; }
222  inline bool IsMoving() const { return m_Flags & IS_MOVED; }
223  inline bool IsDragging() const { return m_Flags & IS_DRAGGED; }
224  inline bool IsWireImage() const { return m_Flags & IS_WIRE_IMAGE; }
225  inline bool IsSelected() const { return m_Flags & SELECTED; }
226  inline bool IsResized() const { return m_Flags & IS_RESIZED; }
227  inline bool IsHighlighted() const { return m_Flags & HIGHLIGHTED; }
228  inline bool IsBrightened() const { return m_Flags & BRIGHTENED; }
229 
230  inline void SetWireImage() { SetFlags( IS_WIRE_IMAGE ); }
231  inline void SetSelected() { SetFlags( SELECTED ); }
232  inline void SetHighlighted() { SetFlags( HIGHLIGHTED ); }
233  inline void SetBrightened() { SetFlags( BRIGHTENED ); }
234 
235  inline void ClearSelected() { ClearFlags( SELECTED ); }
237  inline void ClearBrightened() { ClearFlags( BRIGHTENED ); }
238 
239  void SetModified();
240 
241  int GetState( int type ) const
242  {
243  return m_Status & type;
244  }
245 
246  void SetState( int type, int state )
247  {
248  if( state )
249  m_Status |= type; // state = ON or OFF
250  else
251  m_Status &= ~type;
252  }
253 
254  STATUS_FLAGS GetStatus() const { return m_Status; }
255  void SetStatus( STATUS_FLAGS aStatus ) { m_Status = aStatus; }
256 
257  void SetFlags( STATUS_FLAGS aMask ) { m_Flags |= aMask; }
258  void ClearFlags( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS ) { m_Flags &= ~aMask; }
259  STATUS_FLAGS GetFlags() const { return m_Flags; }
260  bool HasFlag( STATUS_FLAGS aFlag ) { return ( m_Flags & aFlag ) == aFlag; }
261 
263  {
267  return m_Flags & mask;
268  }
269 
271  {
273  }
274 
276  {
278  }
279 
286  virtual bool IsType( const KICAD_T aScanTypes[] ) const
287  {
288  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
289  return true;
290 
291  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
292  {
293  if( m_StructType == *p )
294  return true;
295  }
296 
297  return false;
298  }
299 
308  void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }
309 
320  virtual void GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList )
321  {
322  }
323 
332  virtual bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const
333  {
334  return false; // derived classes should override this function
335  }
336 
346  virtual bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const
347  {
348  return false; // derived classes should override this function
349  }
350 
360  virtual const EDA_RECT GetBoundingBox() const;
361 
375  virtual EDA_ITEM* Clone() const; // should not be inline, to save the ~ 6 bytes per call site.
376 
391  virtual SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] );
392 
398  template< class T >
399  static SEARCH_RESULT IterateForward( std::deque<T>& aList,
400  INSPECTOR inspector,
401  void* testData,
402  const KICAD_T scanTypes[] )
403  {
404  for( auto it : aList )
405  {
406  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
408  return SEARCH_RESULT::QUIT;
409  }
410 
412  }
413 
419  template <class T>
421  std::vector<T>& aList, INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
422  {
423  for( auto it : aList )
424  {
425  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
427  return SEARCH_RESULT::QUIT;
428  }
429 
431  }
432 
438  virtual wxString GetClass() const = 0;
439 
449  virtual wxString GetSelectMenuText( EDA_UNITS aUnits ) const;
450 
458  virtual BITMAP_DEF GetMenuImage() const;
459 
473  virtual bool Matches( wxFindReplaceData& aSearchData, void* aAuxData )
474  {
475  return false;
476  }
477 
490  static bool Replace( wxFindReplaceData& aSearchData, wxString& aText );
491 
505  virtual bool Replace( wxFindReplaceData& aSearchData, void* aAuxData = NULL ) { return false; }
506 
517  virtual bool IsReplaceable() const { return false; }
518 
525  bool operator<( const EDA_ITEM& aItem ) const;
526 
536  static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }
537 
542  EDA_ITEM& operator=( const EDA_ITEM& aItem );
543 
544  virtual const BOX2I ViewBBox() const override;
545 
546  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
547 
548 #if defined(DEBUG)
549 
557  virtual void Show( int nestLevel, std::ostream& os ) const = 0;
558  // pure virtual so compiler warns if somebody mucks up a derived declaration
559 
560  void ShowDummy( std::ostream& os ) const;
561 
569  static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
570 
571 #endif
572 
573 protected:
583  bool Matches( const wxString& aText, wxFindReplaceData& aSearchData );
584 };
585 
586 
594 inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }
595 
596 
603 typedef std::vector< EDA_ITEM* > EDA_ITEMS;
604 
605 
606 #endif // BASE_STRUCT_H_
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
EDA_UNITS
Definition: common.h:184
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
void SetModified()
Definition: base_struct.cpp:94
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
STATUS_FLAGS GetStatus() const
Definition: base_struct.h:254
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:183
bool operator<(const EDA_ITEM &aItem) const
Test if another item is less than this object.
std::function< SEARCH_RESULT(EDA_ITEM *aItem, void *aTestData) > INSPECTOR_FUNC
Typedef INSPECTOR is used to inspect and possibly collect the (search) results of iterating over a li...
Definition: base_struct.h:83
PNG memory record (file in memory).
Definition: bitmap_def.h:29
void ClearTempFlags()
Definition: base_struct.h:270
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
bool IsModified() const
Definition: base_struct.h:221
bool IsSelected() const
Definition: base_struct.h:225
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:178
static bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
void ClearSelected()
Definition: base_struct.h:235
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
bool IsMoving() const
Definition: base_struct.h:222
void SetBrightened()
Definition: base_struct.h:233
virtual ~EDA_ITEM()
Definition: base_struct.h:203
bool IsBrightened() const
Definition: base_struct.h:228
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:130
VIEW_ITEM - is an abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:84
The base class for create windows for drawing purpose.
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:157
bool IsHighlighted() const
Definition: base_struct.h:227
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool IsDragging() const
Definition: base_struct.h:223
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
bool IsNew() const
Definition: base_struct.h:220
void ClearBrightened()
Definition: base_struct.h:237
#define IS_NEW
New item, just created.
Definition: base_struct.h:120
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:332
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:108
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:122
#define SELECTED
Definition: base_struct.h:127
Definition: common.h:65
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
VIEW_ITEM class definition.
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
void ClearHighlighted()
Definition: base_struct.h:236
#define NULL
void SetSelected()
Definition: base_struct.h:231
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:218
STATUS_FLAGS GetEditFlags() const
Definition: base_struct.h:262
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:603
STATUS_FLAGS m_Status
Definition: base_struct.h:179
void SetForceVisible(bool aEnable)
Function SetForceVisible is used to set and cleag force visible flag used to force the item to be dra...
Definition: base_struct.h:308
bool IsResized() const
Definition: base_struct.h:226
void SetWireImage()
Definition: base_struct.h:230
EDA_ITEM * new_clone(const EDA_ITEM &aItem)
Function new_clone provides cloning capabilities for all Boost pointer containers of EDA_ITEM pointer...
Definition: base_struct.h:594
bool IsWireImage() const
Definition: base_struct.h:224
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
unsigned STATUS_FLAGS
Definition: base_struct.h:159
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:286
static bool Sort(const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL contain...
Definition: base_struct.h:536
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:62
const KIID m_Uuid
Definition: base_struct.h:169
void SetHighlighted()
Definition: base_struct.h:232
virtual wxString GetClass() const =0
Function GetClass returns the class name.
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
void SetState(int type, int state)
Definition: base_struct.h:246
virtual bool Replace(wxFindReplaceData &aSearchData, void *aAuxData=NULL)
Function Replace performs a text replace using the find and replace criteria in aSearchData on items ...
Definition: base_struct.h:505
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
virtual wxString GetSelectMenuText(EDA_UNITS aUnits) const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:517
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual bool HitTest(const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
Function HitTest tests if aRect intersects or is contained within the bounding box of an item.
Definition: base_struct.h:346
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
The common library.
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:121
void SetStatus(STATUS_FLAGS aStatus)
Definition: base_struct.h:255
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:42
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258
virtual void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList)
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: base_struct.h:320
static SEARCH_RESULT IterateForward(std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )
Definition: base_struct.h:399
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
bool HasFlag(STATUS_FLAGS aFlag)
Definition: base_struct.h:260
SEARCH_RESULT
Definition: base_struct.h:54
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
void ClearEditFlags()
Definition: base_struct.h:275
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:259
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:186
virtual BITMAP_DEF GetMenuImage() const
Function GetMenuImage returns a pointer to an image to be used in menus.
void initVars()
Definition: base_struct.cpp:84
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:473
int GetState(int type) const
Definition: base_struct.h:241
static SEARCH_RESULT IterateForward(std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )
Definition: base_struct.h:420
FIND_REPLACE_FLAGS
Additional flag values wxFindReplaceData::m_Flags.
Definition: base_struct.h:64
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:132
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125
#define IS_MOVED
Item being moved.
Definition: base_struct.h:119