KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_find.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) 2012 Marco Mattila <[email protected]>
5 * Copyright (C) 2018 Jean-Pierre Charras jp.charras at wanadoo.fr
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <pcb_edit_frame.h> // Keep this include at top to avoid compil issue on MSYS2
27#include <board.h>
28#include <pcb_marker.h>
29#include <footprint.h>
30#include <pcb_text.h>
31#include <zone.h>
32#include <dialog_find.h>
33#include <string_utils.h>
34#include <hotkeys_basic.h>
35#include <string>
36#include <tool/tool_manager.h>
37#include <tools/pcb_actions.h>
38#include <wx/fdrepdlg.h>
39
40
42 DIALOG_FIND_BASE( aFrame, wxID_ANY, _( "Find" ) ),
43 m_frame( aFrame )
44{
45 GetSizer()->SetSizeHints( this );
46
48
49 while( m_searchCombo->GetCount() > 10 )
50 {
51 m_frame->GetFindHistoryList().pop_back();
52 m_searchCombo->Delete( 9 );
53 }
54
55 if( m_searchCombo->GetCount() )
56 {
57 m_searchCombo->SetSelection( 0 );
58 m_searchCombo->SelectAll();
59 }
60
61 m_status->SetLabel( wxEmptyString);
62 m_upToDate = false;
63
64 m_hitList.clear();
65 m_it = m_hitList.begin();
66
68
69 if( m_board )
70 m_board->AddListener( this );
71
72 m_frame->Bind( EDA_EVT_BOARD_CHANGED, &DIALOG_FIND::OnBoardChanged, this );
73
74 if( int hotkey = ACTIONS::showSearch.GetHotKey() )
75 {
76 wxString hotkeyHint = wxString::Format( wxT( " (%s)" ), KeyNameFromKeyCode( hotkey ) );
77 m_searchPanelLink->SetLabel( m_searchPanelLink->GetLabel() + hotkeyHint );
78 }
79
80 m_findNext->SetDefault();
82
83 Center();
84}
85
86
88{
89 if( m_board )
90 m_board->RemoveListener( this );
91
92 m_frame->Unbind( EDA_EVT_BOARD_CHANGED, &DIALOG_FIND::OnBoardChanged, this );
93}
94
95
96void DIALOG_FIND::Preload( const wxString& aFindString )
97{
98 if( !aFindString.IsEmpty() )
99 {
100 m_searchCombo->SetValue( aFindString );
101 m_searchCombo->SelectAll();
102 }
103}
104
105
106void DIALOG_FIND::onTextEnter( wxCommandEvent& aEvent )
107{
108 search( true );
109}
110
111
112void DIALOG_FIND::onFindNextClick( wxCommandEvent& aEvent )
113{
114 search( true );
115}
116
117
118void DIALOG_FIND::onFindPreviousClick( wxCommandEvent& aEvent )
119{
120 search( false );
121}
122
123
124void DIALOG_FIND::onSearchAgainClick( wxCommandEvent& aEvent )
125{
126 m_upToDate = false;
127 search( true );
128}
129
130
131void DIALOG_FIND::onShowSearchPanel( wxHyperlinkEvent& event )
132{
134 {
135 EndModal( wxID_CANCEL );
136
137 CallAfter(
138 []()
139 {
140 if( wxWindow* frame = wxWindow::FindWindowByName( PCB_EDIT_FRAME_NAME ) )
141 static_cast<PCB_EDIT_FRAME*>( frame )->FocusSearch();
142 } );
143 }
144 else
145 {
147 }
148}
149
150
151void DIALOG_FIND::search( bool aDirection )
152{
153 PCB_SCREEN* screen = m_frame->GetScreen();
154 int index;
155 wxString msg;
156 wxString searchString;
157 bool endIsReached = false;
158 bool isFirstSearch = false;
159
160 searchString = m_searchCombo->GetValue();
161
162 if( searchString.IsEmpty() )
163 {
164 Show();
165 return;
166 }
167
168 // Add/move the search string to the top of the list if it isn't already there
169 index = m_searchCombo->FindString( searchString, true );
170
171 if( index == wxNOT_FOUND )
172 {
173 m_searchCombo->Insert( searchString, 0 );
174 m_searchCombo->SetSelection( 0 );
175 m_upToDate = false;
176 m_frame->GetFindHistoryList().Insert( searchString, 0 );
177
178 if( m_searchCombo->GetCount() > 10 )
179 {
180 m_frame->GetFindHistoryList().pop_back();
181 m_searchCombo->Delete( 10 );
182 }
183 }
184 else if( index != 0 )
185 {
186 m_searchCombo->Delete( index );
187 m_searchCombo->Insert( searchString, 0 );
188 m_searchCombo->SetSelection( 0 );
189 m_upToDate = false;
190
191 if( m_frame->GetFindHistoryList().Index( searchString ) )
192 m_frame->GetFindHistoryList().Remove( searchString );
193
194 m_frame->GetFindHistoryList().Insert( searchString, 0 );
195 }
196
198
199 if( m_matchCase->GetValue() )
200 frd.matchCase = true;
201
202 if( m_matchWords->GetValue() )
203 frd.matchMode = EDA_SEARCH_MATCH_MODE::WHOLEWORD;
204 else if( m_wildcards->GetValue() )
205 frd.matchMode = EDA_SEARCH_MATCH_MODE::WILDCARD;
206 else
207 frd.matchMode = EDA_SEARCH_MATCH_MODE::PLAIN;
208
209 frd.searchAllFields = m_checkAllFields->GetValue();
210
211 // Search parameters
212 frd.findString = searchString;
213
215 m_frame->GetCanvas()->GetViewStart( &screen->m_StartVisu.x, &screen->m_StartVisu.y );
216
217 BOARD* board = m_frame->GetBoard();
218
219 // Refresh the list of results
220 if( !m_upToDate )
221 {
222 m_status->SetLabel( _( "Searching..." ) );
223 m_hitList.clear();
224
225 if( m_includeTexts->GetValue() || m_includeValues->GetValue() || m_includeReferences->GetValue() )
226 {
227 for( FOOTPRINT* fp : board->Footprints() )
228 {
229 bool found = false;
230
231 if( m_includeReferences->GetValue() && fp->Reference().Matches( frd, nullptr ) )
232 found = true;
233
234 if( !found && m_includeValues->GetValue() && fp->Value().Matches( frd, nullptr ) )
235 found = true;
236
237 if( !found && m_includeTexts->GetValue() )
238 {
239 for( BOARD_ITEM* item : fp->GraphicalItems() )
240 {
241 if( item->Type() == PCB_TEXT_T )
242 {
243 PCB_TEXT* text = static_cast<PCB_TEXT*>( item );
244
245 if( text->Matches( frd, nullptr ) )
246 {
247 found = true;
248 break;
249 }
250 }
251 }
252 }
253
254 if( !found && m_includeTexts->GetValue() )
255 {
256 for( PCB_FIELD* field : fp->GetFields() )
257 {
258 if( field->Matches( frd, nullptr ) )
259 {
260 found = true;
261 break;
262 }
263 }
264 }
265
266 if( found )
267 m_hitList.push_back( fp );
268 }
269
270 if( m_includeTexts->GetValue() )
271 {
272 for( BOARD_ITEM* item : board->Drawings() )
273 {
274 if( item->Type() == PCB_TEXT_T )
275 {
276 PCB_TEXT* text = static_cast<PCB_TEXT*>( item );
277
278 if( text && text->Matches( frd, nullptr ) )
279 m_hitList.push_back( text );
280 }
281 }
282
283 for( BOARD_ITEM* item : board->Zones() )
284 {
285 ZONE* zone = static_cast<ZONE*>( item );
286
287 if( zone->Matches( frd, nullptr ) )
288 m_hitList.push_back( zone );
289 }
290 }
291 }
292
293 if( m_includeMarkers->GetValue() )
294 {
295 for( PCB_MARKER* marker : board->Markers() )
296 {
297 if( marker->Matches( frd, nullptr ) )
298 m_hitList.push_back( marker );
299 }
300 }
301
302 if( m_includeNets->GetValue() )
303 {
304 for( NETINFO_ITEM* net : board->GetNetInfo() )
305 {
306 if( net && net->Matches( frd, nullptr ) )
307 m_hitList.push_back( net );
308 }
309 }
310
311 m_upToDate = true;
312 isFirstSearch = true;
313
314 if( aDirection )
315 m_it = m_hitList.begin();
316 else
317 m_it = m_hitList.end();
318 }
319
320 // Do we want a sorting algorithm ? If so, implement it here.
321
322 // Get the item to display
323 if( m_hitList.empty() )
324 {
325 m_frame->SetStatusText( wxEmptyString );
326 }
327 else
328 {
329 if( aDirection )
330 {
331 if( m_it != m_hitList.end() && !isFirstSearch )
332 m_it++;
333
334 if( m_it == m_hitList.end() )
335 {
336 if( m_wrap->GetValue() )
337 {
338 m_it = m_hitList.begin();
339 }
340 else
341 {
342 endIsReached = true;
343 m_it--; // point to the last REAL result
344 }
345 }
346 }
347 else
348 {
349 if( m_it == m_hitList.begin() )
350 {
351 if( m_wrap->GetValue() )
352 m_it = m_hitList.end();
353 else
354 endIsReached = true;
355 }
356
357 if( m_it != m_hitList.begin() )
358 m_it--;
359 }
360 }
361
362 // Display the item
363 if( m_hitList.empty() )
364 {
365 m_frame->SetStatusText( wxEmptyString );
366 msg.Printf( _( "'%s' not found" ), searchString );
367 m_frame->ShowInfoBarMsg( msg );
368
369 m_status->SetLabel( msg );
370 }
371 else if( endIsReached || m_it == m_hitList.end() )
372 {
373 m_frame->SetStatusText( wxEmptyString );
374 m_frame->ShowInfoBarMsg( _( "No more items to show" ) );
375
376 m_status->SetLabel( _( "No hits" ) );
377 }
378 else
379 {
381
382 msg.Printf( _( "'%s' found" ), searchString );
383 m_frame->SetStatusText( msg );
384
385 msg.Printf( _( "Hit(s): %d / %zu" ),
386 (int)std::distance( m_hitList.begin(), m_it ) + 1,
387 m_hitList.size() );
388 m_status->SetLabel( msg );
389 }
390
393}
394
395
396bool DIALOG_FIND::Show( bool show )
397{
398 bool ret = DIALOG_FIND_BASE::Show( show );
399
400 if( show )
401 m_searchCombo->SetFocus();
402
403 return ret;
404}
405
406
407void DIALOG_FIND::OnBoardChanged( wxCommandEvent& event )
408{
410
411 if( m_board )
412 m_board->AddListener( this );
413
414 m_upToDate = false;
415
416 event.Skip();
417}
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition: actions.h:224
static TOOL_ACTION showSearch
Definition: actions.h:115
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: actions.h:221
VECTOR2I m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
Definition: base_screen.h:93
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
const NETINFO_LIST & GetNetInfo() const
Definition: board.h:934
void AddListener(BOARD_LISTENER *aListener)
Add a listener to the board to receive calls whenever something on the board has been modified.
Definition: board.cpp:2781
const ZONES & Zones() const
Definition: board.h:362
const MARKERS & Markers() const
Definition: board.h:370
const FOOTPRINTS & Footprints() const
Definition: board.h:358
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition: board.cpp:2788
const DRAWINGS & Drawings() const
Definition: board.h:360
Class DIALOG_FIND_BASE.
wxCheckBox * m_checkAllFields
wxCheckBox * m_matchCase
wxCheckBox * m_includeTexts
wxCheckBox * m_includeValues
wxHyperlinkCtrl * m_searchPanelLink
wxButton * m_findNext
wxComboBox * m_searchCombo
wxCheckBox * m_includeReferences
wxCheckBox * m_matchWords
wxCheckBox * m_includeNets
wxStaticText * m_status
wxCheckBox * m_includeMarkers
wxCheckBox * m_wildcards
wxCheckBox * m_wrap
PCB_EDIT_FRAME * m_frame
Definition: dialog_find.h:133
~DIALOG_FIND() override
Definition: dialog_find.cpp:87
void onTextEnter(wxCommandEvent &event) override
DIALOG_FIND(PCB_EDIT_FRAME *aParent)
Definition: dialog_find.cpp:41
bool Show(bool show=true) override
The Show method is overridden to make the search combobox focused by default.
std::deque< BOARD_ITEM * >::iterator m_it
Definition: dialog_find.h:136
void Preload(const wxString &aFindString)
Definition: dialog_find.cpp:96
void onFindNextClick(wxCommandEvent &event) override
void search(bool direction)
bool m_upToDate
Definition: dialog_find.h:137
void onSearchAgainClick(wxCommandEvent &event) override
BOARD * m_board
Definition: dialog_find.h:134
BOARD_ITEM * GetItem() const
Return the currently found item or nullptr in the case of no items found.
Definition: dialog_find.h:52
void onShowSearchPanel(wxHyperlinkEvent &event) override
void onFindPreviousClick(wxCommandEvent &event) override
std::function< void(BOARD_ITEM *)> m_highlightCallback
Definition: dialog_find.h:139
std::deque< BOARD_ITEM * > m_hitList
Definition: dialog_find.h:135
void OnBoardChanged(wxCommandEvent &event)
bool Show(bool show) override
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:75
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
wxArrayString & GetFindHistoryList()
EDA_SEARCH_DATA & GetFindReplaceData()
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
Handle the data for a net.
Definition: netinfo.h:56
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
The main frame for Pcbnew.
bool IsSearchPaneShown()
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
Handle a list of polygons defining a copper zone.
Definition: zone.h:74
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: zone.h:166
#define _(s)
#define PCB_EDIT_FRAME_NAME
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
EDA_SEARCH_MATCH_MODE matchMode
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92