KiCad PCB EDA Suite
sch_editor_control.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) 2019 CERN
5 * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#ifndef SCH_EDITOR_CONTROL_H
27#define SCH_EDITOR_CONTROL_H
28
29#include <sch_base_frame.h>
30#include <tools/ee_tool_base.h>
31#include <status_popup.h>
32
33class SCH_EDIT_FRAME;
34
38class SCH_EDITOR_CONTROL : public wxEvtHandler, public EE_TOOL_BASE<SCH_EDIT_FRAME>
39{
40public:
42 EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.EditorControl" ),
43 m_probingPcbToSch( false ),
44 m_pickerItem( nullptr )
45 { }
46
48
49 int New( const TOOL_EVENT& aEvent );
50 int Open( const TOOL_EVENT& aEvent );
51 int Save( const TOOL_EVENT& aEvent );
52 int SaveAs( const TOOL_EVENT& aEvent );
53
55 int SaveCurrSheetCopyAs( const TOOL_EVENT& aEvent );
56
57 int Revert( const TOOL_EVENT& aEvent );
58
59 int ShowSchematicSetup( const TOOL_EVENT& aEvent );
60 int PageSetup( const TOOL_EVENT& aEvent );
61 int Print( const TOOL_EVENT& aEvent );
62 int Plot( const TOOL_EVENT& aEvent );
63 int Quit( const TOOL_EVENT& aEvent );
64
72 int RescueSymbols( const TOOL_EVENT& aEvent );
73 int RemapSymbols( const TOOL_EVENT& aEvent );
74
75 bool RescueLegacyProject( bool aRunningOnDemand );
76 bool RescueSymbolLibTableProject( bool aRunningOnDemand );
77
78 int FindAndReplace( const TOOL_EVENT& aEvent );
79
80 int FindNext( const TOOL_EVENT& aEvent );
81 bool HasMatch();
82 int ReplaceAndFindNext( const TOOL_EVENT& aEvent );
83 int ReplaceAll( const TOOL_EVENT& aEvent );
84
85 int UpdateFind( const TOOL_EVENT& aEvent );
86
88 int CrossProbeToPcb( const TOOL_EVENT& aEvent );
89
91 int ExplicitCrossProbeToPcb( const TOOL_EVENT& aEvent );
92
93 int ExportSymbolsToLibrary( const TOOL_EVENT& aEvent );
94
95#ifdef KICAD_SPICE
96 int SimProbe( const TOOL_EVENT& aEvent );
97 int SimTune( const TOOL_EVENT& aEvent );
98#endif /* KICAD_SPICE */
99
101 int HighlightNet( const TOOL_EVENT& aEvent );
102
104 int ClearHighlight( const TOOL_EVENT& aEvent );
105
107 int UpdateNetHighlighting( const TOOL_EVENT& aEvent );
108
110 int HighlightNetCursor( const TOOL_EVENT& aEvent );
111
112 int AssignNetclass( const TOOL_EVENT& aEvent );
113
114 int Undo( const TOOL_EVENT& aEvent );
115 int Redo( const TOOL_EVENT& aEvent );
116
118 int Cut( const TOOL_EVENT& aEvent );
119 int Copy( const TOOL_EVENT& aEvent );
120 int Paste( const TOOL_EVENT& aEvent );
121 int Duplicate( const TOOL_EVENT& aEvent );
122
123 int EditWithSymbolEditor( const TOOL_EVENT& aEvent );
124 int ShowCvpcb( const TOOL_EVENT& aEvent );
125 int Annotate( const TOOL_EVENT& aEvent );
126 int EditSymbolFields( const TOOL_EVENT& aEvent );
127 int EditSymbolLibraryLinks( const TOOL_EVENT& aEvent );
128 int ShowPcbNew( const TOOL_EVENT& aEvent );
129 int UpdatePCB( const TOOL_EVENT& aEvent );
130 int UpdateFromPCB( const TOOL_EVENT& aEvent );
131 int ImportFPAssignments( const TOOL_EVENT& aEvent );
132 int ExportNetlist( const TOOL_EVENT& aEvent );
133 int GenerateBOM( const TOOL_EVENT& aEvent );
134 int DrawSheetOnClipboard( const TOOL_EVENT& aEvent );
135
136 int ShowHierarchy( const TOOL_EVENT& aEvent );
137
138 int ToggleHiddenPins( const TOOL_EVENT& aEvent );
139 int ToggleHiddenFields( const TOOL_EVENT& aEvent );
140 int ToggleERCWarnings( const TOOL_EVENT& aEvent );
141 int ToggleERCErrors( const TOOL_EVENT& aEvent );
142 int ToggleERCExclusions( const TOOL_EVENT& aEvent );
143 int ChangeLineMode( const TOOL_EVENT& aEvent );
144 int NextLineMode( const TOOL_EVENT& aEvent );
145 int ToggleAnnotateAuto( const TOOL_EVENT& aEvent );
146 int ToggleAnnotateRecursive( const TOOL_EVENT& aEvent );
147 int TogglePythonConsole( const TOOL_EVENT& aEvent );
148
149 int RepairSchematic( const TOOL_EVENT& aEvent );
150
151 void AssignFootprints( const std::string& aChangedSetOfReferences );
152
164 SCH_ITEM* FindSymbolAndItem( const wxString* aPath, const wxString* aReference,
165 bool aSearchHierarchy, SCH_SEARCH_T aSearchType,
166 const wxString& aSearchText );
167
168private:
170 bool doCopy( bool aUseLocalClipboard = false );
171
172 bool rescueProject( RESCUER& aRescuer, bool aRunningOnDemand );
173
174 bool searchSupplementaryClipboard( const wxString& aSheetFilename, SCH_SCREEN** aScreen );
175
176 void doCrossProbeSchToPcb( const TOOL_EVENT& aEvent, bool aForce );
177
178 void updatePastedSymbol( SCH_SYMBOL* aSymbol, SCH_SCREEN* aPasteScreen,
179 const SCH_SHEET_PATH& aPastePath, const KIID_PATH& aClipPath,
180 bool aForceKeepAnnotations );
181
182 SCH_SHEET_PATH updatePastedSheet( const SCH_SHEET_PATH& aPastePath, const KIID_PATH& aClipPath,
183 SCH_SHEET* aSheet, bool aForceKeepAnnotations,
184 SCH_SHEET_LIST* aPastedSheetsSoFar,
185 SCH_REFERENCE_LIST* aPastedSymbolsSoFar );
186
187 void setClipboardInstances( const SCH_SCREEN* aPastedScreen );
188
209 bool processCmpToFootprintLinkFile( const wxString& aFullFilename, bool aForceVisibilityState,
210 bool aVisibilityState );
211
213 void setTransitions() override;
214
223 SCH_ITEM* nextMatch( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aSheet, SCH_ITEM* aAfter,
224 EDA_SEARCH_DATA& aData );
225
226private:
227 bool m_probingPcbToSch; // Recursion guard when cross-probing to schematic editor
228 EDA_ITEM* m_pickerItem; // Current item for picker highlighting.
229
230 // Temporary storage location for Duplicate action
231 std::string m_localClipboard;
232
233 // A map of sheet filename --> screens for the clipboard contents. We use these to hook up
234 // cut/paste operations for unsaved sheet content.
235 std::map<wxString, SCH_SCREEN*> m_supplementaryClipboard;
236
237 // A map of KIID_PATH --> symbol instances for the clipboard contents.
238 std::map<KIID_PATH, SYMBOL_INSTANCE_REFERENCE> m_clipboardSymbolInstances;
239
240 // A map of KIID_PATH --> sheet instances for the clipboard contents.
241 std::map<KIID_PATH, SCH_SHEET_INSTANCE> m_clipboardSheetInstances;
242};
243
244
245#endif // SCH_EDITOR_CONTROL_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:50
Handle actions specific to the schematic editor.
int PageSetup(const TOOL_EVENT &aEvent)
bool RescueLegacyProject(bool aRunningOnDemand)
int SaveAs(const TOOL_EVENT &aEvent)
int Annotate(const TOOL_EVENT &aEvent)
int ToggleAnnotateRecursive(const TOOL_EVENT &aEvent)
int ShowSchematicSetup(const TOOL_EVENT &aEvent)
int HighlightNet(const TOOL_EVENT &aEvent)
< Highlight net under the cursor.
int ClearHighlight(const TOOL_EVENT &aEvent)
Update net highlighting after an edit.
int EditSymbolFields(const TOOL_EVENT &aEvent)
int HighlightNetCursor(const TOOL_EVENT &aEvent)
void AssignFootprints(const std::string &aChangedSetOfReferences)
int ImportFPAssignments(const TOOL_EVENT &aEvent)
int ChangeLineMode(const TOOL_EVENT &aEvent)
void setClipboardInstances(const SCH_SCREEN *aPastedScreen)
void doCrossProbeSchToPcb(const TOOL_EVENT &aEvent, bool aForce)
int ExportSymbolsToLibrary(const TOOL_EVENT &aEvent)
int SaveCurrSheetCopyAs(const TOOL_EVENT &aEvent)
Saves the currently-open schematic sheet to an other name.
bool rescueProject(RESCUER &aRescuer, bool aRunningOnDemand)
int CrossProbeToPcb(const TOOL_EVENT &aEvent)
Equivalent to the above, but initiated by the user.
SCH_ITEM * nextMatch(SCH_SCREEN *aScreen, SCH_SHEET_PATH *aSheet, SCH_ITEM *aAfter, EDA_SEARCH_DATA &aData)
Advance the search and returns the next matching item after aAfter.
int Quit(const TOOL_EVENT &aEvent)
int RemapSymbols(const TOOL_EVENT &aEvent)
int FindAndReplace(const TOOL_EVENT &aEvent)
int DrawSheetOnClipboard(const TOOL_EVENT &aEvent)
int RescueSymbols(const TOOL_EVENT &aEvent)
Perform rescue operations to recover old projects from before certain changes were made.
std::string m_localClipboard
std::map< KIID_PATH, SCH_SHEET_INSTANCE > m_clipboardSheetInstances
int AssignNetclass(const TOOL_EVENT &aEvent)
int ExportNetlist(const TOOL_EVENT &aEvent)
int Open(const TOOL_EVENT &aEvent)
int Paste(const TOOL_EVENT &aEvent)
int Copy(const TOOL_EVENT &aEvent)
int ToggleERCWarnings(const TOOL_EVENT &aEvent)
int NextLineMode(const TOOL_EVENT &aEvent)
SCH_ITEM * FindSymbolAndItem(const wxString *aPath, const wxString *aReference, bool aSearchHierarchy, SCH_SEARCH_T aSearchType, const wxString &aSearchText)
Find a symbol in the schematic and an item in this symbol and select it.
int Redo(const TOOL_EVENT &aEvent)
Clipboard support.
int UpdatePCB(const TOOL_EVENT &aEvent)
int UpdateFromPCB(const TOOL_EVENT &aEvent)
int ToggleAnnotateAuto(const TOOL_EVENT &aEvent)
int ToggleHiddenPins(const TOOL_EVENT &aEvent)
int Duplicate(const TOOL_EVENT &aEvent)
bool doCopy(bool aUseLocalClipboard=false)
< copy selection to clipboard or to m_localClipboard if aUseLocalClipboard is true
bool searchSupplementaryClipboard(const wxString &aSheetFilename, SCH_SCREEN **aScreen)
int EditWithSymbolEditor(const TOOL_EVENT &aEvent)
int EditSymbolLibraryLinks(const TOOL_EVENT &aEvent)
int New(const TOOL_EVENT &aEvent)
std::map< wxString, SCH_SCREEN * > m_supplementaryClipboard
int ExplicitCrossProbeToPcb(const TOOL_EVENT &aEvent)
int ShowPcbNew(const TOOL_EVENT &aEvent)
int ReplaceAll(const TOOL_EVENT &aEvent)
std::map< KIID_PATH, SYMBOL_INSTANCE_REFERENCE > m_clipboardSymbolInstances
int UpdateNetHighlighting(const TOOL_EVENT &aEvent)
Launch a tool to highlight nets.
int ToggleERCErrors(const TOOL_EVENT &aEvent)
int TogglePythonConsole(const TOOL_EVENT &aEvent)
int ShowHierarchy(const TOOL_EVENT &aEvent)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int ReplaceAndFindNext(const TOOL_EVENT &aEvent)
void updatePastedSymbol(SCH_SYMBOL *aSymbol, SCH_SCREEN *aPasteScreen, const SCH_SHEET_PATH &aPastePath, const KIID_PATH &aClipPath, bool aForceKeepAnnotations)
int ShowCvpcb(const TOOL_EVENT &aEvent)
SCH_SHEET_PATH updatePastedSheet(const SCH_SHEET_PATH &aPastePath, const KIID_PATH &aClipPath, SCH_SHEET *aSheet, bool aForceKeepAnnotations, SCH_SHEET_LIST *aPastedSheetsSoFar, SCH_REFERENCE_LIST *aPastedSymbolsSoFar)
int RepairSchematic(const TOOL_EVENT &aEvent)
int Cut(const TOOL_EVENT &aEvent)
int UpdateFind(const TOOL_EVENT &aEvent)
Notifies pcbnew about the selected item.
int Save(const TOOL_EVENT &aEvent)
bool RescueSymbolLibTableProject(bool aRunningOnDemand)
int Undo(const TOOL_EVENT &aEvent)
int ToggleERCExclusions(const TOOL_EVENT &aEvent)
int Plot(const TOOL_EVENT &aEvent)
int Print(const TOOL_EVENT &aEvent)
bool processCmpToFootprintLinkFile(const wxString &aFullFilename, bool aForceVisibilityState, bool aVisibilityState)
Read the footprint info from each line in the stuff file by reference designator.
int Revert(const TOOL_EVENT &aEvent)
int FindNext(const TOOL_EVENT &aEvent)
int GenerateBOM(const TOOL_EVENT &aEvent)
int ToggleHiddenFields(const TOOL_EVENT &aEvent)
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:55
Schematic symbol object.
Definition: sch_symbol.h:80
Generic, UI-independent tool event.
Definition: tool_event.h:156
SCH_SEARCH_T
Schematic search type used by the socket link with Pcbnew.