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-2018 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 
32 #ifndef BASE_STRUCT_H_
33 #define BASE_STRUCT_H_
34 
35 #include <core/typeinfo.h>
36 #include "common.h"
37 
38 #include <bitmap_types.h>
39 #include <view/view_item.h>
40 
41 #if defined(DEBUG)
42 #include <iostream> // needed for Show()
43 
44 extern std::ostream& operator <<( std::ostream& out, const wxSize& size );
45 
46 extern std::ostream& operator <<( std::ostream& out, const wxPoint& pt );
47 #endif
48 
49 
54 enum FILL_T {
55  NO_FILL, // Poly, Square, Circle, Arc = option No Fill
56  FILLED_SHAPE, /* Poly, Square, Circle, Arc = option Fill
57  * with current color ("Solid shape") */
58  FILLED_WITH_BG_BODYCOLOR /* Poly, Square, Circle, Arc = option Fill
59  * with background body color, translucent
60  * (texts inside this shape can be seen)
61  * not filled in B&W mode when plotting or
62  * printing */
63 };
64 
65 
69 };
70 
71 
72 class wxFindReplaceData;
73 class EDA_ITEM;
74 class EDA_DRAW_FRAME;
75 class EDA_RECT;
76 class DHEAD;
78 
79 
100 typedef std::function< SEARCH_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC;
101 
102 typedef const INSPECTOR_FUNC& INSPECTOR;
103 
104 
105 // These define are used for the .m_Flags and .m_UndoRedoStatus member of the
106 // class EDA_ITEM
107 //
108 // NB: DO NOT ADD FLAGS ANYWHERE BUT AT THE END: THE FLAG-SET IS STORED AS AN INTEGER IN FILES.
109 //
110 #define IS_CHANGED (1 << 0)
111 #define IS_LINKED (1 << 1)
112 #define IN_EDIT (1 << 2)
113 #define IS_MOVED (1 << 3)
114 #define IS_NEW (1 << 4)
115 #define IS_RESIZED (1 << 5)
116 #define IS_DRAGGED (1 << 6)
117 #define IS_DELETED (1 << 7)
118 #define IS_WIRE_IMAGE (1 << 8)
119 #define STARTPOINT (1 << 9)
120 #define ENDPOINT (1 << 10)
121 #define SELECTED (1 << 11)
122 #define SELECTEDNODE (1 << 12)
123 #define STRUCT_DELETED (1 << 13)
124 #define CANDIDATE (1 << 14)
125 #define SKIP_STRUCT (1 << 15)
126 #define DO_NOT_DRAW (1 << 16)
127 #define IS_CANCELLED (1 << 17)
128 #define TRACK_LOCKED (1 << 18)
130 #define TRACK_AR (1 << 19)
131 #define FLAG1 (1 << 20)
132 #define FLAG0 (1 << 21)
133 #define BEGIN_ONPAD (1 << 22)
134 #define END_ONPAD (1 << 23)
135 #define BUSY (1 << 24)
136 #define HIGHLIGHTED (1 << 25)
138 #define BRIGHTENED (1 << 26)
139 
140 #define DP_COUPLED (1 << 27)
141 #define UR_TRANSIENT (1 << 28)
143 
144 
145 #define EDA_ITEM_ALL_FLAGS -1
146 
147 typedef unsigned STATUS_FLAGS;
148 
155 {
156 private:
157 
165 
166 protected:
170 
173 
176 
179 
180 private:
181 
182  void initVars();
183 
184 protected:
185 
186  EDA_ITEM( EDA_ITEM* parent, KICAD_T idType );
187  EDA_ITEM( KICAD_T idType );
188  EDA_ITEM( const EDA_ITEM& base );
189 
190 public:
191 
192  virtual ~EDA_ITEM() { };
193 
201  inline KICAD_T Type() const
202  {
203  return m_StructType;
204  }
205 
206  void SetTimeStamp( timestamp_t aNewTimeStamp ) { m_TimeStamp = aNewTimeStamp; }
208 
209  EDA_ITEM* Next() const { return Pnext; }
210  EDA_ITEM* Back() const { return Pback; }
211  EDA_ITEM* GetParent() const { return m_Parent; }
212  DHEAD* GetList() const { return m_List; }
213 
214  void SetNext( EDA_ITEM* aNext ) { Pnext = aNext; }
215  void SetBack( EDA_ITEM* aBack ) { Pback = aBack; }
216  void SetParent( EDA_ITEM* aParent ) { m_Parent = aParent; }
217  void SetList( DHEAD* aList ) { m_List = aList; }
218 
219  inline bool IsNew() const { return m_Flags & IS_NEW; }
220  inline bool IsModified() const { return m_Flags & IS_CHANGED; }
221  inline bool IsMoving() const { return m_Flags & IS_MOVED; }
222  inline bool IsDragging() const { return m_Flags & IS_DRAGGED; }
223  inline bool IsWireImage() const { return m_Flags & IS_WIRE_IMAGE; }
224  inline bool IsSelected() const { return m_Flags & SELECTED; }
225  inline bool IsResized() const { return m_Flags & IS_RESIZED; }
226  inline bool IsHighlighted() const { return m_Flags & HIGHLIGHTED; }
227  inline bool IsBrightened() const { return m_Flags & BRIGHTENED; }
228 
229  inline void SetWireImage() { SetFlags( IS_WIRE_IMAGE ); }
230  inline void SetSelected() { SetFlags( SELECTED ); }
231  inline void SetHighlighted() { SetFlags( HIGHLIGHTED ); }
232  inline void SetBrightened() { SetFlags( BRIGHTENED ); }
233 
234  inline void ClearSelected() { ClearFlags( SELECTED ); }
236  inline void ClearBrightened() { ClearFlags( BRIGHTENED ); }
237 
238  void SetModified();
239 
240  int GetState( int type ) const
241  {
242  return m_Status & type;
243  }
244 
245  void SetState( int type, int state )
246  {
247  if( state )
248  m_Status |= type; // state = ON or OFF
249  else
250  m_Status &= ~type;
251  }
252 
253  STATUS_FLAGS GetStatus() const { return m_Status; }
254  void SetStatus( STATUS_FLAGS aStatus ) { m_Status = aStatus; }
255 
256  void SetFlags( STATUS_FLAGS aMask ) { m_Flags |= aMask; }
257  void ClearFlags( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS ) { m_Flags &= ~aMask; }
258  STATUS_FLAGS GetFlags() const { return m_Flags; }
259 
266  bool IsType( const KICAD_T aScanTypes[] )
267  {
268  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
269  {
270  if( m_StructType == *p )
271  return true;
272  }
273 
274  return false;
275  }
276 
285  void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }
286 
297  virtual void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList )
298  {
299  }
300 
308  virtual bool HitTest( const wxPoint& aPosition ) const
309  {
310  return false; // derived classes should override this function
311  }
312 
313 
323  virtual const EDA_RECT GetBoundingBox() const;
324 
338  virtual EDA_ITEM* Clone() const; // should not be inline, to save the ~ 6 bytes per call site.
339 
357  static SEARCH_RESULT IterateForward( EDA_ITEM* listStart,
358  INSPECTOR inspector,
359  void* testData,
360  const KICAD_T scanTypes[] );
361 
376  virtual SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] );
377 
383  virtual wxString GetClass() const = 0;
384 
394  virtual wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const;
395 
403  virtual BITMAP_DEF GetMenuImage() const;
404 
420  virtual bool Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation )
421  {
422  return false;
423  }
424 
437  bool Replace( wxFindReplaceData& aSearchData, wxString& aText );
438 
452  virtual bool Replace( wxFindReplaceData& aSearchData, void* aAuxData = NULL ) { return false; }
453 
464  virtual bool IsReplaceable() const { return false; }
465 
472  bool operator<( const EDA_ITEM& aItem ) const;
473 
483  static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }
484 
489  EDA_ITEM& operator=( const EDA_ITEM& aItem );
490 
491  virtual const BOX2I ViewBBox() const override;
492 
493  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
494 
495 #if defined(DEBUG)
496 
504  virtual void Show( int nestLevel, std::ostream& os ) const = 0;
505  // pure virtual so compiler warns if somebody mucks up a derived declaration
506 
507  void ShowDummy( std::ostream& os ) const;
508 
516  static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
517 
518 #endif
519 
520 protected:
530  bool Matches( const wxString& aText, wxFindReplaceData& aSearchData );
531 };
532 
533 
541 inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }
542 
543 
550 typedef std::vector< EDA_ITEM* > EDA_ITEMS;
551 
552 
553 #endif // BASE_STRUCT_H_
DHEAD * GetList() const
Definition: base_struct.h:212
bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:266
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
void SetModified()
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 GetFlags() const
Definition: base_struct.h:258
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
static SEARCH_RESULT IterateForward(EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function IterateForward walks through the object tree calling the inspector() on each object type req...
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
bool IsMoving() const
Definition: base_struct.h:221
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
bool IsResized() const
Definition: base_struct.h:225
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
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:77
PNG memory record (file in memory).
Definition: bitmap_types.h:43
void SetBack(EDA_ITEM *aBack)
Definition: base_struct.h:215
bool IsBrightened() const
Definition: base_struct.h:227
long timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:52
bool operator<(const EDA_ITEM &aItem) const
Test if another item is less than this object.
Class DHEAD is only for use by template class DLIST, use that instead.
Definition: dlist.h:40
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
bool IsNew() const
Definition: base_struct.h:219
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:234
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
EDA_ITEM * Back() const
Definition: base_struct.h:210
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:420
bool IsModified() const
Definition: base_struct.h:220
void SetBrightened()
Definition: base_struct.h:232
bool IsSelected() const
Definition: base_struct.h:224
EDA_ITEM * GetParent() const
Definition: base_struct.h:211
virtual ~EDA_ITEM()
Definition: base_struct.h:192
bool IsHighlighted() const
Definition: base_struct.h:226
void SetList(DHEAD *aList)
Definition: base_struct.h:217
EDA_ITEM * Next() const
Definition: base_struct.h:209
virtual wxString GetSelectMenuText(EDA_UNITS_T aUnits) const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Class VIEW_ITEM - is an abstract base class for deriving all objects that can be added to a VIEW...
Definition: view_item.h:84
STATUS_FLAGS GetStatus() const
Definition: base_struct.h:253
The base class for create windows for drawing purpose.
Definition: draw_frame.h:78
int GetState(int type) const
Definition: base_struct.h:240
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:145
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
void ClearBrightened()
Definition: base_struct.h:236
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:102
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:116
#define SELECTED
Definition: base_struct.h:121
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
VIEW_ITEM class definition.
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void ClearHighlighted()
Definition: base_struct.h:235
void SetSelected()
Definition: base_struct.h:230
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
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:550
STATUS_FLAGS m_Status
Definition: base_struct.h:164
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:285
void SetWireImage()
Definition: base_struct.h:229
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:541
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
unsigned STATUS_FLAGS
Definition: base_struct.h:147
virtual bool HitTest(const wxPoint &aPosition) const
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
Definition: base_struct.h:308
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:483
virtual void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList)
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it&#39;s internal state for displ...
Definition: base_struct.h:297
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:278
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:64
void SetHighlighted()
Definition: base_struct.h:231
void SetNext(EDA_ITEM *aNext)
Definition: base_struct.h:214
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:137
void SetState(int type, int state)
Definition: base_struct.h:245
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:452
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
The common library.
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
void SetStatus(STATUS_FLAGS aStatus)
Definition: base_struct.h:254
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:54
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
bool IsWireImage() const
Definition: base_struct.h:223
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
SEARCH_RESULT
Definition: base_struct.h:66
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers. ...
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:175
void initVars()
Definition: base_struct.cpp:86
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:169
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
EDA_UNITS_T
Definition: common.h:159
virtual BITMAP_DEF GetMenuImage() const
Function GetMenuImage returns a pointer to an image to be used in menus.
timestamp_t GetTimeStamp() const
Definition: base_struct.h:207
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:206
bool IsDragging() const
Definition: base_struct.h:222
#define IS_MOVED
Item being moved.
Definition: base_struct.h:113