KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema/widgets/search_handlers.cpp
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) 2022-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <ee_actions.h>
21#include <sch_edit_frame.h>
22#include <sch_painter.h>
23#include <sch_symbol.h>
24#include <sch_label.h>
25#include <sch_text.h>
26#include <sch_textbox.h>
27#include <schematic.h>
28#include <string_utils.h>
29#include <tool/tool_manager.h>
30#include "search_handlers.h"
31
32
34{
35 std::vector<long> item = { aItemRow };
36 SelectItems( item );
37
39}
40
41
42void SCH_SEARCH_HANDLER::FindAll( const std::function<bool( SCH_ITEM*, SCH_SHEET_PATH* )>& aCollector )
43{
44 SCH_SCREENS screens( m_frame->Schematic().Root() );
45 std::vector<SCH_SHEET_PATH*> paths;
46
47 m_hitlist.clear();
48
50
51 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
52 {
53 for( SCH_SHEET_PATH& sheet : screen->GetClientSheetPaths() )
54 paths.push_back( &sheet );
55 }
56
57 for( SCH_SHEET_PATH* sheet : paths )
58 {
59 for( SCH_ITEM* item : sheet->LastScreen()->Items() )
60 {
61 if( aCollector( item, sheet ) )
62 m_hitlist.push_back( { item, sheet } );
63 }
64 }
65}
66
67
68void SCH_SEARCH_HANDLER::Sort( int aCol, bool aAscending, std::vector<long>* aSelection )
69{
70 std::vector<SCH_ITEM*> selection;
71
72 for( long i = 0; i < (long) m_hitlist.size(); ++i )
73 {
74 if( alg::contains( *aSelection, i ) )
75 selection.push_back( m_hitlist[i].item );
76 }
77
78 int col = std::max( 0, aCol ); // Provide a stable order by sorting on first column if no
79 // sort column provided.
80
81 std::sort( m_hitlist.begin(), m_hitlist.end(),
82 [&]( const SCH_SEARCH_HIT& a, const SCH_SEARCH_HIT& b ) -> bool
83 {
84 // N.B. To meet the iterator sort conditions, we cannot simply invert the truth
85 // to get the opposite sort. i.e. ~(a<b) != (a>b)
86 if( aAscending )
87 return StrNumCmp( getResultCell( a, col ), getResultCell( b, col ), true ) < 0;
88 else
89 return StrNumCmp( getResultCell( b, col ), getResultCell( a, col ), true ) < 0;
90 } );
91
92 aSelection->clear();
93
94 for( long i = 0; i < (long) m_hitlist.size(); ++i )
95 {
96 if( alg::contains( selection, m_hitlist[i].item ) )
97 aSelection->push_back( i );
98 }
99}
100
101
102void SCH_SEARCH_HANDLER::SelectItems( std::vector<long>& aItemRows )
103{
104 EDA_ITEMS selectedItems;
105 std::vector<SCH_SEARCH_HIT> selectedHits;
106
108
109 for( long row : aItemRows )
110 {
111 if( row >= 0 && row < (long) m_hitlist.size() )
112 {
113 selectedHits.emplace_back( m_hitlist[row] );
114 selectedItems.emplace_back( m_hitlist[row].item );
115 }
116 }
117
118 if( selectedHits.empty() )
119 return;
120
121 bool allHitsOnSamePage = std::all_of( selectedHits.begin() + 1, selectedHits.end(),
122 [&]( const SCH_SEARCH_HIT& r )
123 {
124 return r.sheetPath == selectedHits.front().sheetPath;
125 } );
126
127 if( allHitsOnSamePage && !selectedHits.empty() )
128 {
129 if( m_frame->GetCurrentSheet() != *selectedHits.front().sheetPath )
130 {
131 m_frame->SetCurrentSheet( *selectedHits.front().sheetPath );
133 }
134
135 if( selectedItems.size() )
137
138 m_frame->GetCanvas()->Refresh( false );
139 }
140}
141
142
144 SCH_SEARCH_HANDLER( _HKI( "Symbols" ), aFrame )
145{
146 m_columns.emplace_back( _HKI( "Reference" ), 2, wxLIST_FORMAT_LEFT );
147 m_columns.emplace_back( _HKI( "Value" ), 6, wxLIST_FORMAT_LEFT );
148 m_columns.emplace_back( _HKI( "Footprint" ), 10, wxLIST_FORMAT_LEFT );
149 m_columns.emplace_back( _HKI( "Page" ), 1, wxLIST_FORMAT_CENTER );
150 m_columns.emplace_back( wxT( "X" ), 3, wxLIST_FORMAT_CENTER );
151 m_columns.emplace_back( wxT( "Y" ), 3, wxLIST_FORMAT_CENTER );
152 m_columns.emplace_back( _HKI( "Excl. sim" ), 2, wxLIST_FORMAT_CENTER );
153 m_columns.emplace_back( _HKI( "Excl. BOM" ), 2, wxLIST_FORMAT_CENTER );
154 m_columns.emplace_back( _HKI( "Excl. board" ), 2, wxLIST_FORMAT_CENTER );
155 m_columns.emplace_back( _HKI( "DNP" ), 2, wxLIST_FORMAT_CENTER );
156}
157
158
159int SYMBOL_SEARCH_HANDLER::Search( const wxString& aQuery )
160{
161 m_hitlist.clear();
162
163 SCH_SEARCH_DATA frp;
164 frp.findString = aQuery;
165
166 // Try to handle whatever the user throws at us (substring, wildcards, regex, etc.)
167 frp.matchMode = EDA_SEARCH_MATCH_MODE::PERMISSIVE;
168 frp.searchCurrentSheetOnly = false;
169
170 auto search =
171 [frp]( SCH_ITEM* item, SCH_SHEET_PATH* sheet )
172 {
173 if( item && item->Type() == SCH_SYMBOL_T )
174 {
175 SCH_SYMBOL* sym = static_cast<SCH_SYMBOL*>( item );
176
177 if( sym->IsPower() )
178 return false;
179
180 for( SCH_FIELD& field : sym->GetFields() )
181 {
182 if( frp.findString.IsEmpty() || field.Matches( frp, sheet ) )
183 return true;
184 }
185 }
186
187 return false;
188 };
189
190 FindAll( search );
191
192 return (int) m_hitlist.size();
193}
194
195
197{
198 SCH_SYMBOL*sym = dynamic_cast<SCH_SYMBOL*>( aHit.item );
199
200 if( !sym )
201 return wxEmptyString;
202
203 if( aCol == 0 )
204 return sym->GetRef( aHit.sheetPath, true );
205 else if( aCol == 1 )
206 return sym->GetField( VALUE_FIELD )->GetShownText( aHit.sheetPath, false );
207 else if( aCol == 2 )
208 return sym->GetField( FOOTPRINT_FIELD )->GetShownText( aHit.sheetPath, false );
209 else if( aCol == 3 )
210 return aHit.sheetPath->GetPageNumber();
211 else if( aCol == 4 )
212 return m_frame->MessageTextFromValue( sym->GetPosition().x );
213 else if( aCol == 5 )
214 return m_frame->MessageTextFromValue( sym->GetPosition().y );
215 else if( aCol == 6 )
216 return sym->GetExcludedFromSim() ? wxS( "X" ) : wxS( " " );
217 else if( aCol == 7 )
218 return sym->GetExcludedFromBOM() ? wxS( "X" ) : wxS( " " );
219 else if( aCol == 8 )
220 return sym->GetExcludedFromBoard() ? wxS( "X" ) : wxS( " " );
221 else if( aCol == 9 )
222 return sym->GetDNP() ? wxS( "X" ) : wxS( " " );
223
224 return wxEmptyString;
225}
226
227
229 SCH_SEARCH_HANDLER( _HKI( "Power" ), aFrame )
230{
231 m_columns.emplace_back( _HKI( "Reference" ), 2, wxLIST_FORMAT_LEFT );
232 m_columns.emplace_back( _HKI( "Value" ), 6, wxLIST_FORMAT_LEFT );
233 m_columns.emplace_back( _HKI( "Page" ), 1, wxLIST_FORMAT_CENTER );
234 m_columns.emplace_back( wxT( "X" ), 3, wxLIST_FORMAT_CENTER );
235 m_columns.emplace_back( wxT( "Y" ), 3, wxLIST_FORMAT_CENTER );
236}
237
238
239int POWER_SEARCH_HANDLER::Search( const wxString& aQuery )
240{
241 m_hitlist.clear();
242
243 SCH_SEARCH_DATA frp;
244 frp.findString = aQuery;
245
246 // Try to handle whatever the user throws at us (substring, wildcards, regex, etc.)
247 frp.matchMode = EDA_SEARCH_MATCH_MODE::PERMISSIVE;
248 frp.searchCurrentSheetOnly = false;
249
250 auto search =
251 [frp]( SCH_ITEM* item, SCH_SHEET_PATH* sheet )
252 {
253 if( item && item->Type() == SCH_SYMBOL_T )
254 {
255 SCH_SYMBOL* sym = static_cast<SCH_SYMBOL*>( item );
256
257 return sym->IsPower();
258 }
259
260 return false;
261 };
262
263 FindAll( search );
264
265 return (int) m_hitlist.size();
266}
267
268
270{
271 SCH_SYMBOL* sym = dynamic_cast<SCH_SYMBOL*>( aHit.item );
272
273 if( !sym )
274 return wxEmptyString;
275
276 if( aCol == 0 )
277 return sym->GetRef( aHit.sheetPath, true );
278 else if( aCol == 1 )
279 return sym->GetField( VALUE_FIELD )->GetShownText( aHit.sheetPath, false );
280 else if( aCol == 2 )
281 return aHit.sheetPath->GetPageNumber();
282 else if( aCol == 3 )
283 return m_frame->MessageTextFromValue( sym->GetPosition().x );
284 else if( aCol == 4 )
285 return m_frame->MessageTextFromValue( sym->GetPosition().y );
286
287 return wxEmptyString;
288}
289
290
292 SCH_SEARCH_HANDLER( _HKI( "Text" ), aFrame )
293{
294 m_columns.emplace_back( _HKI( "Type" ), 2, wxLIST_FORMAT_LEFT );
295 m_columns.emplace_back( _HKI( "Text" ), 12, wxLIST_FORMAT_LEFT );
296 m_columns.emplace_back( _HKI( "Page" ), 1, wxLIST_FORMAT_CENTER );
297 m_columns.emplace_back( wxT( "X" ), 3, wxLIST_FORMAT_CENTER );
298 m_columns.emplace_back( wxT( "Y" ), 3, wxLIST_FORMAT_CENTER );
299}
300
301
302int TEXT_SEARCH_HANDLER::Search( const wxString& aQuery )
303{
304 m_hitlist.clear();
305
306 SCH_SEARCH_DATA frp;
307 frp.findString = aQuery;
308
309 // Try to handle whatever the user throws at us (substring, wildcards, regex, etc.)
310 frp.matchMode = EDA_SEARCH_MATCH_MODE::PERMISSIVE;
311 frp.searchCurrentSheetOnly = false;
312
313 auto search =
314 [frp]( SCH_ITEM* item, SCH_SHEET_PATH* sheet )
315 {
316 if( item->Type() == SCH_TEXT_T || item->Type() == SCH_TEXTBOX_T )
317 {
318 if( frp.findString.IsEmpty() || item->Matches( frp, sheet ) )
319 return true;
320 }
321
322 return false;
323 };
324
325 FindAll( search );
326
327 return (int) m_hitlist.size();
328}
329
330
331wxString TEXT_SEARCH_HANDLER::getResultCell( const SCH_SEARCH_HIT& aHit, int aCol )
332{
333 if( aHit.item->Type() == SCH_TEXT_T )
334 {
335 SCH_TEXT* txt = dynamic_cast<SCH_TEXT*>( aHit.item );
336
337 if( !txt )
338 return wxEmptyString;
339
340 if( aCol == 0 )
341 return _( "Text" );
342 else if( aCol == 1 )
343 return txt->GetShownText( false );
344 else if( aCol == 2 )
345 return aHit.sheetPath->GetPageNumber();
346 else if( aCol == 3 )
347 return m_frame->MessageTextFromValue( txt->GetPosition().x );
348 else if( aCol == 4 )
349 return m_frame->MessageTextFromValue( txt->GetPosition().y );
350 }
351 else if( aHit.item->Type() == SCH_TEXTBOX_T )
352 {
353 SCH_TEXTBOX* txt = dynamic_cast<SCH_TEXTBOX*>( aHit.item );
354
355 if( !txt )
356 return wxEmptyString;
357
358 if( aCol == 0 )
359 return _( "Text Box" );
360 else if( aCol == 1 )
361 return txt->GetShownText( false );
362 else if( aCol == 2 )
363 return aHit.sheetPath->GetPageNumber();
364 else if( aCol == 3 )
365 return m_frame->MessageTextFromValue( txt->GetPosition().x );
366 else if( aCol == 4 )
367 return m_frame->MessageTextFromValue( txt->GetPosition().y );
368 }
369
370
371 return wxEmptyString;
372}
373
374
376 SCH_SEARCH_HANDLER( _HKI( "Labels" ), aFrame )
377{
378 m_columns.emplace_back( _HKI( "Type" ), 2, wxLIST_FORMAT_LEFT );
379 m_columns.emplace_back( _HKI( "Name" ), 6, wxLIST_FORMAT_LEFT );
380 m_columns.emplace_back( _HKI( "Page" ), 2, wxLIST_FORMAT_CENTER );
381 m_columns.emplace_back( wxT( "X" ), 3, wxLIST_FORMAT_CENTER );
382 m_columns.emplace_back( wxT( "Y" ), 3 , wxLIST_FORMAT_CENTER);
383}
384
385
386int LABEL_SEARCH_HANDLER::Search( const wxString& aQuery )
387{
388 m_hitlist.clear();
389
390 SCH_SEARCH_DATA frp;
391 frp.findString = aQuery;
392
393 // Try to handle whatever the user throws at us (substring, wildcards, regex, etc.)
394 frp.matchMode = EDA_SEARCH_MATCH_MODE::PERMISSIVE;
395 frp.searchCurrentSheetOnly = false;
396
397 auto search =
398 [frp]( SCH_ITEM* item, SCH_SHEET_PATH* sheet )
399 {
400 if( item->IsType( { SCH_LABEL_LOCATE_ANY_T } ) )
401 {
402 SCH_LABEL_BASE* lbl = dynamic_cast<SCH_LABEL_BASE*>( item );
403
404 wxCHECK( lbl, false );
405
406 if( frp.findString.IsEmpty() || lbl->Matches( frp, sheet ) )
407 return true;
408 }
409
410 return false;
411 };
412
413 FindAll( search );
414
415 return (int) m_hitlist.size();
416}
417
418
420{
421 SCH_LABEL_BASE* lbl = dynamic_cast<SCH_LABEL_BASE*>( aHit.item );
422
423 if( !lbl )
424 return wxEmptyString;
425
426 if (aCol == 0)
427 {
428 if(lbl->Type() == SCH_LABEL_T)
429 return _HKI( "Local" );
430 else if( lbl->Type() == SCH_GLOBAL_LABEL_T )
431 return _HKI( "Global" );
432 else if( lbl->Type() == SCH_HIER_LABEL_T )
433 return _HKI( "Hierarchical" );
434 else if( lbl->Type() == SCH_DIRECTIVE_LABEL_T )
435 return _HKI( "Directive" );
436 }
437 else if( aCol == 1 )
438 return lbl->GetShownText( false );
439 else if( aCol == 2 )
440 return aHit.sheetPath->GetPageNumber();
441 else if( aCol == 3 )
442 return m_frame->MessageTextFromValue( lbl->GetPosition().x );
443 else if( aCol == 4 )
444 return m_frame->MessageTextFromValue( lbl->GetPosition().y );
445
446 return wxEmptyString;
447}
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:375
static TOOL_ACTION properties
Definition: ee_actions.h:129
static TOOL_ACTION addItemsToSel
Selects a list of items (specified as the event parameter)
Definition: ee_actions.h:63
static TOOL_ACTION clearSelection
Clears the current selection.
Definition: ee_actions.h:56
LABEL_SEARCH_HANDLER(SCH_EDIT_FRAME *aFrame)
int Search(const wxString &aQuery) override
wxString getResultCell(const SCH_SEARCH_HIT &hit, int aCol) override
int Search(const wxString &aQuery) override
POWER_SEARCH_HANDLER(SCH_EDIT_FRAME *aFrame)
wxString getResultCell(const SCH_SEARCH_HIT &aHit, int aCol) override
SCH_SHEET & Root() const
Definition: schematic.h:112
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Schematic editor (Eeschema) main window.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
void DisplayCurrentSheet()
Draw the current sheet on the display.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Definition: sch_field.cpp:197
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: sch_item.h:181
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override
Definition: sch_label.cpp:892
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: sch_label.cpp:924
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:703
SCH_SCREEN * GetNext()
SCH_SCREEN * GetFirst()
void BuildClientSheetPathList()
built the list of sheet paths sharing a screen for each screen in use
std::vector< SCH_SEARCH_HIT > m_hitlist
void SelectItems(std::vector< long > &aItemRows) override
void FindAll(const std::function< bool(SCH_ITEM *, SCH_SHEET_PATH *)> &aCollector)
void Sort(int aCol, bool aAscending, std::vector< long > *aSelection) override
void ActivateItem(long aItemRow) override
VECTOR2I GetPosition() const override
Definition: sch_shape.h:70
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
wxString GetPageNumber() const
Schematic symbol object.
Definition: sch_symbol.h:105
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:850
VECTOR2I GetPosition() const override
Definition: sch_symbol.h:779
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:898
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition: sch_symbol.cpp:651
bool IsPower() const override
virtual wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
VECTOR2I GetPosition() const override
Definition: sch_text.h:141
virtual wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Definition: sch_text.cpp:405
std::vector< std::tuple< wxString, int, wxListColumnFormat > > m_columns
Definition: search_pane.h:53
wxString getResultCell(const SCH_SEARCH_HIT &aHit, int aCol) override
SYMBOL_SEARCH_HANDLER(SCH_EDIT_FRAME *aFrame)
int Search(const wxString &aQuery) override
bool GetExcludedFromBoard() const
Definition: symbol.h:148
bool GetExcludedFromBOM() const
Definition: symbol.h:142
bool GetDNP() const
Set or clear the 'Do Not Populate' flaga.
Definition: symbol.h:153
bool GetExcludedFromSim() const override
Definition: symbol.h:136
TEXT_SEARCH_HANDLER(SCH_EDIT_FRAME *aFrame)
int Search(const wxString &aQuery) override
wxString getResultCell(const SCH_SEARCH_HIT &hit, int aCol) override
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
#define _HKI(x)
#define _(s)
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: eda_item.h:532
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
EDA_SEARCH_MATCH_MODE matchMode
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ SCH_SYMBOL_T
Definition: typeinfo.h:172
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:171
@ SCH_LABEL_T
Definition: typeinfo.h:167
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:169
@ SCH_TEXT_T
Definition: typeinfo.h:151
@ SCH_TEXTBOX_T
Definition: typeinfo.h:152
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:168