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 // empty spot (1 << 17)
128 #define TRACK_LOCKED (1 << 18)
129 #define TRACK_AR (1 << 19)
130 #define FLAG1 (1 << 20)
131 #define FLAG0 (1 << 21)
132 #define BEGIN_ONPAD (1 << 22)
133 #define END_ONPAD (1 << 23)
134 #define BUSY (1 << 24)
135 #define HIGHLIGHTED (1 << 25)
137 #define BRIGHTENED (1 << 26)
138 
139 #define DP_COUPLED (1 << 27)
140 #define UR_TRANSIENT (1 << 28)
142 
143 #define IS_DANGLING (1 << 29)
144 
145 // WARNING: if you add flags, you'll probably need to adjust the masks in GetEditFlags() and
146 // ClearTempFlags().
147 
148 #define EDA_ITEM_ALL_FLAGS -1
149 
150 typedef unsigned STATUS_FLAGS;
151 
158 {
159 private:
160 
168 
169 protected:
173 
176 
179 
182 
183 private:
184 
185  void initVars();
186 
187 protected:
188 
189  EDA_ITEM( EDA_ITEM* parent, KICAD_T idType );
190  EDA_ITEM( KICAD_T idType );
191  EDA_ITEM( const EDA_ITEM& base );
192 
193 public:
194 
195  virtual ~EDA_ITEM() { };
196 
204  inline KICAD_T Type() const
205  {
206  return m_StructType;
207  }
208 
209  void SetTimeStamp( timestamp_t aNewTimeStamp ) { m_TimeStamp = aNewTimeStamp; }
211 
212  EDA_ITEM* Next() const { return Pnext; }
213  EDA_ITEM* Back() const { return Pback; }
214  EDA_ITEM* GetParent() const { return m_Parent; }
215  DHEAD* GetList() const { return m_List; }
216 
217  void SetNext( EDA_ITEM* aNext ) { Pnext = aNext; }
218  void SetBack( EDA_ITEM* aBack ) { Pback = aBack; }
219  void SetParent( EDA_ITEM* aParent ) { m_Parent = aParent; }
220  void SetList( DHEAD* aList ) { m_List = aList; }
221 
222  inline bool IsNew() const { return m_Flags & IS_NEW; }
223  inline bool IsModified() const { return m_Flags & IS_CHANGED; }
224  inline bool IsMoving() const { return m_Flags & IS_MOVED; }
225  inline bool IsDragging() const { return m_Flags & IS_DRAGGED; }
226  inline bool IsWireImage() const { return m_Flags & IS_WIRE_IMAGE; }
227  inline bool IsSelected() const { return m_Flags & SELECTED; }
228  inline bool IsResized() const { return m_Flags & IS_RESIZED; }
229  inline bool IsHighlighted() const { return m_Flags & HIGHLIGHTED; }
230  inline bool IsBrightened() const { return m_Flags & BRIGHTENED; }
231 
232  inline void SetWireImage() { SetFlags( IS_WIRE_IMAGE ); }
233  inline void SetSelected() { SetFlags( SELECTED ); }
234  inline void SetHighlighted() { SetFlags( HIGHLIGHTED ); }
235  inline void SetBrightened() { SetFlags( BRIGHTENED ); }
236 
237  inline void ClearSelected() { ClearFlags( SELECTED ); }
239  inline void ClearBrightened() { ClearFlags( BRIGHTENED ); }
240 
241  void SetModified();
242 
243  int GetState( int type ) const
244  {
245  return m_Status & type;
246  }
247 
248  void SetState( int type, int state )
249  {
250  if( state )
251  m_Status |= type; // state = ON or OFF
252  else
253  m_Status &= ~type;
254  }
255 
256  STATUS_FLAGS GetStatus() const { return m_Status; }
257  void SetStatus( STATUS_FLAGS aStatus ) { m_Status = aStatus; }
258 
259  void SetFlags( STATUS_FLAGS aMask ) { m_Flags |= aMask; }
260  void ClearFlags( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS ) { m_Flags &= ~aMask; }
261  STATUS_FLAGS GetFlags() const { return m_Flags; }
262 
264  {
268  return m_Flags & mask;
269  }
270 
272  {
274  }
275 
277  {
279  }
280 
287  virtual bool IsType( const KICAD_T aScanTypes[] )
288  {
289  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
290  return true;
291 
292  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
293  {
294  if( m_StructType == *p )
295  return true;
296  }
297 
298  return false;
299  }
300 
309  void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }
310 
321  virtual void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList )
322  {
323  }
324 
333  virtual bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const
334  {
335  return false; // derived classes should override this function
336  }
337 
347  virtual bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const
348  {
349  return false; // derived classes should override this function
350  }
351 
361  virtual const EDA_RECT GetBoundingBox() const;
362 
376  virtual EDA_ITEM* Clone() const; // should not be inline, to save the ~ 6 bytes per call site.
377 
395  static SEARCH_RESULT IterateForward( EDA_ITEM* listStart,
396  INSPECTOR inspector,
397  void* testData,
398  const KICAD_T scanTypes[] );
399 
414  virtual SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] );
415 
421  virtual wxString GetClass() const = 0;
422 
432  virtual wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const;
433 
441  virtual BITMAP_DEF GetMenuImage() const;
442 
458  virtual bool Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint* aFindLocation )
459  {
460  return false;
461  }
462 
475  bool Replace( wxFindReplaceData& aSearchData, wxString& aText );
476 
490  virtual bool Replace( wxFindReplaceData& aSearchData, void* aAuxData = NULL ) { return false; }
491 
502  virtual bool IsReplaceable() const { return false; }
503 
510  bool operator<( const EDA_ITEM& aItem ) const;
511 
521  static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }
522 
527  EDA_ITEM& operator=( const EDA_ITEM& aItem );
528 
529  virtual const BOX2I ViewBBox() const override;
530 
531  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
532 
533 #if defined(DEBUG)
534 
542  virtual void Show( int nestLevel, std::ostream& os ) const = 0;
543  // pure virtual so compiler warns if somebody mucks up a derived declaration
544 
545  void ShowDummy( std::ostream& os ) const;
546 
554  static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
555 
556 #endif
557 
558 protected:
568  bool Matches( const wxString& aText, wxFindReplaceData& aSearchData );
569 };
570 
571 
579 inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }
580 
581 
588 typedef std::vector< EDA_ITEM* > EDA_ITEMS;
589 
590 
591 #endif // BASE_STRUCT_H_
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:111
DHEAD * GetList() const
Definition: base_struct.h:215
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 GetStatus() const
Definition: base_struct.h:256
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:171
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
bool operator<(const EDA_ITEM &aItem) const
Test if another item is less than this object.
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:175
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
void ClearTempFlags()
Definition: base_struct.h:271
void SetBack(EDA_ITEM *aBack)
Definition: base_struct.h:218
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:133
bool IsModified() const
Definition: base_struct.h:223
bool IsSelected() const
Definition: base_struct.h:227
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:166
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:237
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
bool IsMoving() const
Definition: base_struct.h:224
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:458
void SetBrightened()
Definition: base_struct.h:235
virtual ~EDA_ITEM()
Definition: base_struct.h:195
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:287
bool IsBrightened() const
Definition: base_struct.h:230
void SetList(DHEAD *aList)
Definition: base_struct.h:220
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:124
Class 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.
Definition: draw_frame.h:82
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:132
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:148
bool IsHighlighted() const
Definition: base_struct.h:229
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:225
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:222
EDA_ITEM * Next() const
Definition: base_struct.h:212
void ClearBrightened()
Definition: base_struct.h:239
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
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:333
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:259
void ClearHighlighted()
Definition: base_struct.h:238
void SetSelected()
Definition: base_struct.h:233
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:219
STATUS_FLAGS GetEditFlags() const
Definition: base_struct.h:263
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:588
STATUS_FLAGS m_Status
Definition: base_struct.h:167
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:309
bool IsResized() const
Definition: base_struct.h:228
void SetWireImage()
Definition: base_struct.h:232
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:579
timestamp_t GetTimeStamp() const
Definition: base_struct.h:210
bool IsWireImage() const
Definition: base_struct.h:226
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
unsigned STATUS_FLAGS
Definition: base_struct.h:150
EDA_ITEM * GetParent() const
Definition: base_struct.h:214
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:139
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:521
virtual void GetMsgPanelInfo(EDA_UNITS_T 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:321
#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:234
void SetNext(EDA_ITEM *aNext)
Definition: base_struct.h:217
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:136
void SetState(int type, int state)
Definition: base_struct.h:248
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:490
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:143
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:120
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502
Class 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:347
virtual wxString GetSelectMenuText(EDA_UNITS_T aUnits) const
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
The common library.
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
void SetStatus(STATUS_FLAGS aStatus)
Definition: base_struct.h:257
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:260
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:53
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
EDA_ITEM * Back() const
Definition: base_struct.h:213
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.
void ClearEditFlags()
Definition: base_struct.h:276
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:261
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:178
virtual BITMAP_DEF GetMenuImage() const
Function GetMenuImage returns a pointer to an image to be used in menus.
void initVars()
Definition: base_struct.cpp:86
int GetState(int type) const
Definition: base_struct.h:243
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:172
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:170
EDA_UNITS_T
Definition: common.h:157
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:126
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:209
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:119
#define IS_MOVED
Item being moved.
Definition: base_struct.h:113