/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // non-member so it can be moved easily, and kept REALLY private. // Do NOT Clear() in here. static void add_search_paths( SEARCH_STACK* aDst, const SEARCH_STACK& aSrc, int aIndex ) { for( unsigned i=0; iAddPaths( aSrc[i], aIndex ); } //------------------------------------------------ SEARCH_STACK* PROJECT::SchSearchS() { SEARCH_STACK* ss = (SEARCH_STACK*) GetElem( PROJECT::ELEM_SCH_SEARCH_STACK ); wxASSERT( !ss || dynamic_cast( GetElem( PROJECT::ELEM_SCH_SEARCH_STACK ) ) ); if( !ss ) { ss = new SEARCH_STACK(); // Make PROJECT the new SEARCH_STACK owner. SetElem( PROJECT::ELEM_SCH_SEARCH_STACK, ss ); // to the empty SEARCH_STACK for SchSearchS(), add project dir as first ss->AddPaths( m_project_name.GetPath() ); // next add the paths found in *.pro, variable "LibDir" wxString libDir; try { PART_LIBS::LibNamesAndPaths( this, false, &libDir ); } catch( const IO_ERROR& ) { } if( !!libDir ) { wxArrayString paths; SEARCH_STACK::Split( &paths, libDir ); for( unsigned i =0; iAddPaths( path ); // at the end } } // append all paths from aSList add_search_paths( ss, Kiface().KifaceSearch(), -1 ); } return ss; } PART_LIBS* PROJECT::SchLibs() { PART_LIBS* libs = (PART_LIBS*) GetElem( PROJECT::ELEM_SCH_PART_LIBS ); wxASSERT( !libs || libs->Type() == PART_LIBS_T ); if( !libs ) { libs = new PART_LIBS(); // Make PROJECT the new PART_LIBS owner. SetElem( PROJECT::ELEM_SCH_PART_LIBS, libs ); try { libs->LoadAllLibraries( this ); } catch( const PARSE_ERROR& pe ) { wxString lib_list = UTF8( pe.inputLine ); wxWindow* parent = Pgm().App().GetTopWindow(); // parent of this dialog cannot be NULL since that breaks the Kiway() chain. HTML_MESSAGE_BOX dlg( parent, _( "Not Found" ) ); dlg.MessageSet( _( "The following libraries were not found:" ) ); dlg.ListSet( lib_list ); dlg.Layout(); dlg.ShowModal(); } catch( const IO_ERROR& ioe ) { wxWindow* parent = Pgm().App().GetTopWindow(); DisplayError( parent, ioe.What() ); } } return libs; } //----------------------------------------------- BEGIN_EVENT_TABLE( SCH_EDIT_FRAME, EDA_DRAW_FRAME ) EVT_SOCKET( ID_EDA_SOCKET_EVENT_SERV, EDA_DRAW_FRAME::OnSockRequestServer ) EVT_SOCKET( ID_EDA_SOCKET_EVENT, EDA_DRAW_FRAME::OnSockRequest ) EVT_SIZE( SCH_EDIT_FRAME::OnSize ) EVT_MENU_RANGE( ID_FILE1, ID_FILEMAX, SCH_EDIT_FRAME::OnLoadFile ) EVT_MENU( ID_FILE_LIST_CLEAR, SCH_EDIT_FRAME::OnClearFileHistory ) EVT_MENU( ID_APPEND_PROJECT, SCH_EDIT_FRAME::OnAppendProject ) EVT_MENU( ID_IMPORT_NON_KICAD_SCH, SCH_EDIT_FRAME::OnImportProject ) EVT_MENU( wxID_EXIT, SCH_EDIT_FRAME::OnExit ) EVT_MENU( wxID_CLOSE, SCH_EDIT_FRAME::OnExit ) EVT_MENU( ID_GRID_SETTINGS, SCH_BASE_FRAME::OnGridSettings ) END_EVENT_TABLE() SCH_EDIT_FRAME::SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ): SCH_BASE_FRAME( aKiway, aParent, FRAME_SCH, wxT( "Eeschema" ), wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE, SCH_EDIT_FRAME_NAME ), m_highlightedConn( nullptr ), m_item_to_repeat( nullptr ) { m_schematic = new SCHEMATIC( nullptr ); m_showBorderAndTitleBlock = true; // true to show sheet references m_hasAutoSave = true; m_AboutTitle = "Eeschema"; m_findReplaceDialog = nullptr; // Give an icon wxIcon icon; icon.CopyFromBitmap( KiBitmap( icon_eeschema_xpm ) ); SetIcon( icon ); LoadSettings( eeconfig() ); // Also links the schematic to the loaded project CreateScreens(); // After schematic has been linked to project, SCHEMATIC_SETTINGS works m_defaults = &m_schematic->Settings(); LoadProjectSettings(); setupTools(); setupUIConditions(); ReCreateMenuBar(); ReCreateHToolbar(); ReCreateVToolbar(); ReCreateOptToolbar(); // Create the infobar m_infoBar = new WX_INFOBAR( this, &m_auimgr ); // Initialize common print setup dialog settings. m_pageSetupData.GetPrintData().SetPrintMode( wxPRINT_MODE_PRINTER ); m_pageSetupData.GetPrintData().SetQuality( wxPRINT_QUALITY_MEDIUM ); m_pageSetupData.GetPrintData().SetBin( wxPRINTBIN_AUTO ); m_pageSetupData.GetPrintData().SetNoCopies( 1 ); m_auimgr.SetManagedWindow( this ); m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" ).Top().Layer(6) ); m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) ); m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" ).Right().Layer(2) ); m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) ); m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() ); m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) ); // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before // hidding it. m_auimgr.Update(); // We don't want the infobar displayed right away m_auimgr.GetPane( "InfoBar" ).Hide(); m_auimgr.Update(); GetToolManager()->RunAction( ACTIONS::zoomFitScreen, true ); // This is used temporarily to fix a client size issue on GTK that causes zoom to fit // to calculate the wrong zoom size. See SCH_EDIT_FRAME::onSize(). Bind( wxEVT_SIZE, &SCH_EDIT_FRAME::onSize, this ); if( GetCanvas() ) { GetCanvas()->GetGAL()->SetAxesEnabled( false ); if( auto p = dynamic_cast( GetCanvas()->GetView()->GetPainter() ) ) p->SetSchematic( m_schematic ); } InitExitKey(); // Net list generator DefaultExecFlags(); UpdateTitle(); // Default shutdown reason until a file is loaded KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New schematic file is unsaved" ) ); // Ensure the window is on top Raise(); } SCH_EDIT_FRAME::~SCH_EDIT_FRAME() { // Shutdown all running tools if( m_toolManager ) m_toolManager->ShutdownAllTools(); delete m_item_to_repeat; // we own the cloned object, see this->SaveCopyForRepeatItem() SetScreen( NULL ); delete m_schematic; // Close the project if we are standalone, so it gets cleaned up properly if( Kiface().IsSingle() ) GetSettingsManager()->UnloadProject( &Prj() ); } void SCH_EDIT_FRAME::setupTools() { // Create the manager and dispatcher & route draw panel events to the dispatcher m_toolManager = new TOOL_MANAGER; m_toolManager->SetEnvironment( &Schematic(), GetCanvas()->GetView(), GetCanvas()->GetViewControls(), config(), this ); m_actions = new EE_ACTIONS(); m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager, m_actions ); // Register tools m_toolManager->RegisterTool( new COMMON_CONTROL ); m_toolManager->RegisterTool( new COMMON_TOOLS ); m_toolManager->RegisterTool( new ZOOM_TOOL ); m_toolManager->RegisterTool( new EE_SELECTION_TOOL ); m_toolManager->RegisterTool( new PICKER_TOOL ); m_toolManager->RegisterTool( new SCH_DRAWING_TOOLS ); m_toolManager->RegisterTool( new SCH_LINE_WIRE_BUS_TOOL ); m_toolManager->RegisterTool( new SCH_MOVE_TOOL ); m_toolManager->RegisterTool( new SCH_EDIT_TOOL ); m_toolManager->RegisterTool( new EE_INSPECTION_TOOL ); m_toolManager->RegisterTool( new SCH_EDITOR_CONTROL ); m_toolManager->RegisterTool( new EE_POINT_EDITOR ); m_toolManager->RegisterTool( new SCH_NAVIGATE_TOOL ); m_toolManager->InitTools(); // Run the selection tool, it is supposed to be always active m_toolManager->RunAction( EE_ACTIONS::selectionActivate ); GetCanvas()->SetEventDispatcher( m_toolDispatcher ); } void SCH_EDIT_FRAME::setupUIConditions() { SCH_BASE_FRAME::setupUIConditions(); ACTION_MANAGER* mgr = m_toolManager->GetActionManager(); EDITOR_CONDITIONS cond( this ); wxASSERT( mgr ); auto hasElements = [ this ] ( const SELECTION& aSel ) { return !GetScreen()->Items().empty(); }; #define ENABLE( x ) ACTION_CONDITIONS().Enable( x ) #define CHECK( x ) ACTION_CONDITIONS().Check( x ) mgr->SetConditions( ACTIONS::save, ENABLE( cond.ContentModified() ) ); mgr->SetConditions( ACTIONS::undo, ENABLE( cond.UndoAvailable() ) ); mgr->SetConditions( ACTIONS::redo, ENABLE( cond.RedoAvailable() ) ); mgr->SetConditions( ACTIONS::toggleGrid, CHECK( cond.GridVisible() ) ); mgr->SetConditions( ACTIONS::toggleCursorStyle, CHECK( cond.FullscreenCursor() ) ); mgr->SetConditions( ACTIONS::metricUnits, CHECK( cond.Units( EDA_UNITS::MILLIMETRES ) ) ); mgr->SetConditions( ACTIONS::imperialUnits, CHECK( cond.Units( EDA_UNITS::INCHES ) ) ); mgr->SetConditions( ACTIONS::acceleratedGraphics, CHECK( cond.CanvasType( EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL ) ) ); mgr->SetConditions( ACTIONS::standardGraphics, CHECK( cond.CanvasType( EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO ) ) ); mgr->SetConditions( ACTIONS::cut, ENABLE( SELECTION_CONDITIONS::NotEmpty ) ); mgr->SetConditions( ACTIONS::copy, ENABLE( SELECTION_CONDITIONS::NotEmpty ) ); mgr->SetConditions( ACTIONS::paste, ENABLE( SELECTION_CONDITIONS::Idle ) ); mgr->SetConditions( ACTIONS::pasteSpecial, ENABLE( SELECTION_CONDITIONS::Idle ) ); mgr->SetConditions( ACTIONS::doDelete, ENABLE( SELECTION_CONDITIONS::NotEmpty ) ); mgr->SetConditions( ACTIONS::duplicate, ENABLE( SELECTION_CONDITIONS::NotEmpty ) ); mgr->SetConditions( ACTIONS::selectAll, ENABLE( hasElements ) ); mgr->SetConditions( ACTIONS::zoomTool, CHECK( cond.CurrentTool( ACTIONS::zoomTool ) ) ); mgr->SetConditions( ACTIONS::selectionTool, CHECK( cond.CurrentTool( ACTIONS::selectionTool ) ) ); auto showHiddenPinsCond = [this] ( const SELECTION& ) { return GetShowAllPins(); }; auto forceHVCond = [this] ( const SELECTION& ) { return eeconfig()->m_Drawing.hv_lines_only; }; auto remapSymbolsCondition = [&]( const SELECTION& aSel ) { SCH_SCREENS schematic( Schematic().Root() ); // The remapping can only be performed on legacy projects. return schematic.HasNoFullyDefinedLibIds(); }; auto belowRootSheetCondition = [this]( const SELECTION& aSel ) { return GetCurrentSheet().Last() != &Schematic().Root(); }; mgr->SetConditions( EE_ACTIONS::leaveSheet, ENABLE( belowRootSheetCondition ) ); mgr->SetConditions( EE_ACTIONS::remapSymbols, ENABLE( remapSymbolsCondition ) ); mgr->SetConditions( EE_ACTIONS::toggleHiddenPins, CHECK( showHiddenPinsCond ) ); mgr->SetConditions( EE_ACTIONS::toggleForceHV, CHECK( forceHVCond ) ); #define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) ) CURRENT_TOOL( ACTIONS::deleteTool ); CURRENT_TOOL( EE_ACTIONS::highlightNetTool ); CURRENT_TOOL( EE_ACTIONS::placeSymbol ); CURRENT_TOOL( EE_ACTIONS::placePower ); CURRENT_TOOL( EE_ACTIONS::drawWire ); CURRENT_TOOL( EE_ACTIONS::drawBus ); CURRENT_TOOL( EE_ACTIONS::placeBusWireEntry ); CURRENT_TOOL( EE_ACTIONS::placeNoConnect ); CURRENT_TOOL( EE_ACTIONS::placeJunction ); CURRENT_TOOL( EE_ACTIONS::placeLabel ); CURRENT_TOOL( EE_ACTIONS::placeGlobalLabel ); CURRENT_TOOL( EE_ACTIONS::placeHierLabel ); CURRENT_TOOL( EE_ACTIONS::drawSheet ); CURRENT_TOOL( EE_ACTIONS::importSheetPin ); CURRENT_TOOL( EE_ACTIONS::drawLines ); CURRENT_TOOL( EE_ACTIONS::placeSchematicText ); CURRENT_TOOL( EE_ACTIONS::placeImage ); #undef CURRENT_TOOL #undef CHECK #undef ENABLE } void SCH_EDIT_FRAME::SaveCopyForRepeatItem( SCH_ITEM* aItem ) { // we cannot store a pointer to an item in the display list here since // that item may be deleted, such as part of a line concatenation or other. // So simply always keep a copy of the object which is to be repeated. if( aItem ) { delete m_item_to_repeat; m_item_to_repeat = (SCH_ITEM*) aItem->Clone(); // Clone() preserves the flags, we want 'em cleared. m_item_to_repeat->ClearFlags(); } } EDA_ITEM* SCH_EDIT_FRAME::GetItem( const KIID& aId ) { return Schematic().GetSheets().GetItem( aId ); } void SCH_EDIT_FRAME::SetSheetNumberAndCount() { SCH_SCREEN* screen; SCH_SCREENS s_list( Schematic().Root() ); // Set the sheet count, and the sheet number (1 for root sheet) int sheet_count = Schematic().Root().CountSheets(); int sheet_number = 1; const KIID_PATH& current_sheetpath = GetCurrentSheet().Path(); // Examine all sheets path to find the current sheets path, // and count them from root to the current sheet path: for( const SCH_SHEET_PATH& sheet : Schematic().GetSheets() ) { if( sheet.Path() == current_sheetpath ) // Current sheet path found break; sheet_number++; // Not found, increment before this current path } GetCurrentSheet().SetPageNumber( sheet_number ); for( screen = s_list.GetFirst(); screen != NULL; screen = s_list.GetNext() ) screen->m_NumberOfScreens = sheet_count; GetScreen()->m_ScreenNumber = sheet_number; } SCH_SCREEN* SCH_EDIT_FRAME::GetScreen() const { return GetCurrentSheet().LastScreen(); } SCHEMATIC& SCH_EDIT_FRAME::Schematic() const { return *m_schematic; } wxString SCH_EDIT_FRAME::GetScreenDesc() const { wxString s = GetCurrentSheet().PathHumanReadable(); return s; } void SCH_EDIT_FRAME::CreateScreens() { m_schematic->Reset(); m_schematic->SetProject( &Prj() ); m_schematic->SetRoot( new SCH_SHEET( m_schematic ) ); m_defaults = &m_schematic->Settings(); SCH_SCREEN* rootScreen = new SCH_SCREEN( m_schematic ); m_schematic->Root().SetScreen( rootScreen ); SetScreen( Schematic().RootScreen() ); m_schematic->RootScreen()->SetFileName( wxEmptyString ); if( GetScreen() == NULL ) { SCH_SCREEN* screen = new SCH_SCREEN( m_schematic ); SetScreen( screen ); } } SCH_SHEET_PATH& SCH_EDIT_FRAME::GetCurrentSheet() const { return m_schematic->CurrentSheet(); } void SCH_EDIT_FRAME::SetCurrentSheet( const SCH_SHEET_PATH& aSheet ) { if( aSheet != GetCurrentSheet() ) { FocusOnItem( nullptr ); Schematic().SetCurrentSheet( aSheet ); GetCanvas()->DisplaySheet( aSheet.LastScreen() ); } } void SCH_EDIT_FRAME::HardRedraw() { RecalculateConnections( LOCAL_CLEANUP ); FocusOnItem( nullptr ); GetCanvas()->DisplaySheet( GetCurrentSheet().LastScreen() ); GetCanvas()->ForceRefresh(); } bool SCH_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent ) { // Shutdown blocks must be determined and vetoed as early as possible if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION && Schematic().GetSheets().IsModified() ) { return false; } if( Kiface().IsSingle() ) { LIB_EDIT_FRAME* libeditFrame = (LIB_EDIT_FRAME*) Kiway().Player( FRAME_SCH_LIB_EDITOR, false ); if( libeditFrame && !libeditFrame->Close() ) // Can close component editor? return false; LIB_VIEW_FRAME* viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER, false ); if( viewlibFrame && !viewlibFrame->Close() ) // Can close component viewer? return false; viewlibFrame = (LIB_VIEW_FRAME*) Kiway().Player( FRAME_SCH_VIEWER_MODAL, false ); if( viewlibFrame && !viewlibFrame->Close() ) // Can close modal component viewer? return false; } SIM_PLOT_FRAME* simFrame = (SIM_PLOT_FRAME*) Kiway().Player( FRAME_SIMULATOR, false ); if( simFrame && !simFrame->Close() ) // Can close the simulator? return false; // We may have gotten multiple events; don't clean up twice if( !Schematic().IsValid() ) return false; SCH_SHEET_LIST sheetlist = Schematic().GetSheets(); if( sheetlist.IsModified() ) { wxFileName fileName = Schematic().RootScreen()->GetFileName(); wxString msg = _( "Save changes to \"%s\" before closing?" ); if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ), [&]()->bool { return SaveProject(); } ) ) { return false; } } return true; } void SCH_EDIT_FRAME::doCloseWindow() { SCH_SHEET_LIST sheetlist = Schematic().GetSheets(); // Shutdown all running tools ( and commit any pending change ) if( m_toolManager ) m_toolManager->ShutdownAllTools(); // Close the find dialog and preserve it's setting if it is displayed. if( m_findReplaceDialog ) { m_findStringHistoryList = m_findReplaceDialog->GetFindEntries(); m_replaceStringHistoryList = m_findReplaceDialog->GetReplaceEntries(); m_findReplaceDialog->Destroy(); m_findReplaceDialog = nullptr; } if( FindHierarchyNavigator() ) FindHierarchyNavigator()->Close( true ); SCH_SCREENS screens( Schematic().Root() ); wxFileName fn; for( SCH_SCREEN* screen = screens.GetFirst(); screen != NULL; screen = screens.GetNext() ) { fn = Prj().AbsolutePath( screen->GetFileName() ); // Auto save file name is the normal file name prepended with GetAutoSaveFilePrefix(). fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() ); if( fn.FileExists() && fn.IsFileWritable() ) wxRemoveFile( fn.GetFullPath() ); } sheetlist.ClearModifyStatus(); wxString fileName = Prj().AbsolutePath( Schematic().RootScreen()->GetFileName() ); if( !Schematic().GetFileName().IsEmpty() && !Schematic().RootScreen()->IsEmpty() ) UpdateFileHistory( fileName ); Schematic().RootScreen()->Clear(); // all sub sheets are deleted, only the main sheet is usable GetCurrentSheet().clear(); // Clear view before destroying schematic as repaints depend on schematic being valid SetScreen( nullptr ); GetSettingsManager()->SaveProject(); Schematic().Reset(); Destroy(); } wxString SCH_EDIT_FRAME::GetUniqueFilenameForCurrentSheet() { // Filename is rootSheetName-sheetName-...-sheetName // Note that we need to fetch the rootSheetName out of its filename, as the root SCH_SHEET's // name is just a timestamp. wxFileName rootFn( GetCurrentSheet().at( 0 )->GetFileName() ); wxString filename = rootFn.GetName(); for( unsigned i = 1; i < GetCurrentSheet().size(); i++ ) filename += wxT( "-" ) + GetCurrentSheet().at( i )->GetName(); return filename; } void SCH_EDIT_FRAME::OnModify() { wxASSERT( GetScreen() ); if( !GetScreen() ) return; GetScreen()->SetModify(); GetScreen()->SetSave(); if( ADVANCED_CFG::GetCfg().m_realTimeConnectivity && CONNECTION_GRAPH::m_allowRealTime ) RecalculateConnections( NO_CLEANUP ); GetCanvas()->Refresh(); } void SCH_EDIT_FRAME::OnUpdatePCB( wxCommandEvent& event ) { if( Kiface().IsSingle() ) { DisplayError( this, _( "Cannot update the PCB, because the Schematic Editor is opened" " in stand-alone mode. In order to create/update PCBs from" " schematics, launch the Kicad shell and create a project." ) ); return; } KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_EDITOR, false ); if( !frame ) { wxFileName fn = Prj().GetProjectFullName(); fn.SetExt( PcbFileExtension ); frame = Kiway().Player( FRAME_PCB_EDITOR, true ); frame->OpenProjectFiles( std::vector( 1, fn.GetFullPath() ) ); } if( !frame->IsVisible() ) frame->Show( true ); // On Windows, Raise() does not bring the window on screen, when iconized if( frame->IsIconized() ) frame->Iconize( false ); frame->Raise(); std::string payload; Kiway().ExpressMail( FRAME_PCB_EDITOR, MAIL_PCB_UPDATE, payload, this ); } wxFindReplaceData* SCH_EDIT_FRAME::GetFindReplaceData() { if( m_findReplaceDialog && m_findReplaceDialog->IsVisible() && !m_findReplaceData->GetFindString().IsEmpty() ) { return m_findReplaceData; } return nullptr; } HIERARCHY_NAVIG_DLG* SCH_EDIT_FRAME::FindHierarchyNavigator() { wxWindow* navigator = wxWindow::FindWindowByName( HIERARCHY_NAVIG_DLG_WNAME ); return static_cast< HIERARCHY_NAVIG_DLG* >( navigator ); } void SCH_EDIT_FRAME::UpdateHierarchyNavigator( bool aForceUpdate ) { if( aForceUpdate ) { if( FindHierarchyNavigator() ) FindHierarchyNavigator()->Close(); HIERARCHY_NAVIG_DLG* hierarchyDialog = new HIERARCHY_NAVIG_DLG( this ); hierarchyDialog->Show( true ); } else { if( FindHierarchyNavigator() ) FindHierarchyNavigator()->UpdateHierarchyTree(); } } void SCH_EDIT_FRAME::ShowFindReplaceDialog( bool aReplace ) { if( m_findReplaceDialog ) m_findReplaceDialog->Destroy(); m_findReplaceDialog= new DIALOG_SCH_FIND( this, m_findReplaceData, wxDefaultPosition, wxDefaultSize, aReplace ? wxFR_REPLACEDIALOG : 0 ); m_findReplaceDialog->SetFindEntries( m_findStringHistoryList ); m_findReplaceDialog->SetReplaceEntries( m_replaceStringHistoryList ); m_findReplaceDialog->Show( true ); } void SCH_EDIT_FRAME::ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime ) { // Prepare the infobar, since we don't know its state m_infoBar->RemoveAllButtons(); m_infoBar->AddCloseButton(); m_infoBar->ShowMessageFor( aMsg, aStatusTime, wxICON_INFORMATION ); } void SCH_EDIT_FRAME::ClearFindReplaceStatus() { m_infoBar->Dismiss(); } void SCH_EDIT_FRAME::OnFindDialogClose() { m_findStringHistoryList = m_findReplaceDialog->GetFindEntries(); m_replaceStringHistoryList = m_findReplaceDialog->GetReplaceEntries(); m_findReplaceDialog->Destroy(); m_findReplaceDialog = nullptr; m_toolManager->RunAction( ACTIONS::updateFind, true ); } void SCH_EDIT_FRAME::OnLoadFile( wxCommandEvent& event ) { wxString fn = GetFileFromHistory( event.GetId(), _( "Schematic" ) ); if( fn.size() ) OpenProjectFiles( std::vector( 1, fn ) ); } void SCH_EDIT_FRAME::OnClearFileHistory( wxCommandEvent& aEvent ) { ClearFileHistory(); } void SCH_EDIT_FRAME::NewProject() { wxString pro_dir = m_mruPath; wxFileDialog dlg( this, _( "New Schematic" ), pro_dir, wxEmptyString, KiCadSchematicFileWildcard(), wxFD_SAVE ); if( dlg.ShowModal() != wxID_CANCEL ) { // Enforce the extension, wxFileDialog is inept. wxFileName create_me = dlg.GetPath(); create_me.SetExt( KiCadSchematicFileExtension ); if( create_me.FileExists() ) { wxString msg; msg.Printf( _( "Schematic file \"%s\" already exists." ), create_me.GetFullName() ); DisplayError( this, msg ); return ; } // OpenProjectFiles() requires absolute wxASSERT_MSG( create_me.IsAbsolute(), "wxFileDialog returned non-absolute path" ); OpenProjectFiles( std::vector( 1, create_me.GetFullPath() ), KICTL_CREATE ); m_mruPath = create_me.GetPath(); } } void SCH_EDIT_FRAME::LoadProject() { wxString pro_dir = m_mruPath; wxString wildcards = KiCadSchematicFileWildcard(); wildcards += "|" + LegacySchematicFileWildcard(); wxFileDialog dlg( this, _( "Open Schematic" ), pro_dir, wxEmptyString, wildcards, wxFD_OPEN | wxFD_FILE_MUST_EXIST ); if( dlg.ShowModal() != wxID_CANCEL ) { OpenProjectFiles( std::vector( 1, dlg.GetPath() ) ); m_mruPath = Prj().GetProjectPath(); } } void SCH_EDIT_FRAME::OnOpenPcbnew( wxCommandEvent& event ) { wxFileName kicad_board = Prj().AbsolutePath( Schematic().GetFileName() ); if( kicad_board.IsOk() ) { kicad_board.SetExt( PcbFileExtension ); wxFileName legacy_board( kicad_board ); legacy_board.SetExt( LegacyPcbFileExtension ); wxFileName& boardfn = legacy_board; if( !legacy_board.FileExists() || kicad_board.FileExists() ) boardfn = kicad_board; if( Kiface().IsSingle() ) { wxString filename = QuoteFullPath( boardfn ); ExecuteFile( this, PCBNEW_EXE, filename ); } else { KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_EDITOR, false ); if( !frame ) { frame = Kiway().Player( FRAME_PCB_EDITOR, true ); frame->OpenProjectFiles( std::vector( 1, boardfn.GetFullPath() ) ); } if( !frame->IsVisible() ) frame->Show( true ); // On Windows, Raise() does not bring the window on screen, when iconized if( frame->IsIconized() ) frame->Iconize( false ); frame->Raise(); } } else { ExecuteFile( this, PCBNEW_EXE ); } } void SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) { wxFileName fn = Prj().AbsolutePath( Schematic().GetFileName() ); fn.SetExt( NetlistFileExtension ); if( !ReadyToNetlist() ) return; try { KIWAY_PLAYER* player = Kiway().Player( FRAME_CVPCB, false ); // test open already. if( !player ) { player = Kiway().Player( FRAME_CVPCB, true ); player->Show( true ); } sendNetlistToCvpcb(); player->Raise(); } catch( const IO_ERROR& ) { DisplayError( this, _( "Could not open CvPcb" ) ); } } void SCH_EDIT_FRAME::OnExit( wxCommandEvent& event ) { if( event.GetId() == wxID_EXIT ) Kiway().OnKiCadExit(); if( event.GetId() == wxID_CLOSE || Kiface().IsSingle() ) Close( false ); } void SCH_EDIT_FRAME::PrintPage( RENDER_SETTINGS* aSettings ) { wxString fileName = Prj().AbsolutePath( GetScreen()->GetFileName() ); aSettings->GetPrintDC()->SetLogicalFunction( wxCOPY ); GetScreen()->Print( aSettings ); PrintWorkSheet( aSettings, GetScreen(), IU_PER_MILS, fileName ); } bool SCH_EDIT_FRAME::isAutoSaveRequired() const { // In case this event happens before g_RootSheet is initialized which does happen // on mingw64 builds. if( Schematic().IsValid() ) { SCH_SCREENS screenList( Schematic().Root() ); for( SCH_SCREEN* screen = screenList.GetFirst(); screen; screen = screenList.GetNext() ) { if( screen->IsSave() ) return true; } } return false; } void SCH_EDIT_FRAME::AddItemToScreenAndUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItem, bool aUndoAppend ) { wxCHECK_RET( aItem != NULL, wxT( "Cannot add null item to list." ) ); SCH_SHEET* parentSheet = nullptr; SCH_COMPONENT* parentComponent = nullptr; SCH_ITEM* undoItem = aItem; if( aItem->Type() == SCH_SHEET_PIN_T ) { parentSheet = (SCH_SHEET*) aItem->GetParent(); wxCHECK_RET( parentSheet && parentSheet->Type() == SCH_SHEET_T, wxT( "Cannot place sheet pin in invalid schematic sheet object." ) ); undoItem = parentSheet; } else if( aItem->Type() == SCH_FIELD_T ) { parentComponent = (SCH_COMPONENT*) aItem->GetParent(); wxCHECK_RET( parentComponent && parentComponent->Type() == SCH_COMPONENT_T, wxT( "Cannot place field in invalid schematic component object." ) ); undoItem = parentComponent; } if( aItem->IsNew() ) { if( aItem->Type() == SCH_SHEET_PIN_T ) { // Sheet pins are owned by their parent sheet. SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::CHANGED, aUndoAppend ); parentSheet->AddPin( (SCH_SHEET_PIN*) aItem ); } else if( aItem->Type() == SCH_FIELD_T ) { // Component fields are also owned by their parent, but new component fields // are handled elsewhere. wxLogMessage( wxT( "addCurrentItemToScreen: unexpected new SCH_FIELD" ) ); } else { if( !aScreen->CheckIfOnDrawList( aItem ) ) // don't want a loop! AddToScreen( aItem, aScreen ); SaveCopyForRepeatItem( aItem ); SaveCopyInUndoList( aScreen, undoItem, UNDO_REDO::NEWITEM, aUndoAppend ); } // Update connectivity info for new item if( !aItem->IsMoving() ) RecalculateConnections( LOCAL_CLEANUP ); } aItem->ClearFlags( IS_NEW ); aScreen->SetModify(); UpdateItem( aItem ); if( !aItem->IsMoving() && aItem->IsConnectable() ) { std::vector< wxPoint > pts = aItem->GetConnectionPoints(); for( auto i = pts.begin(); i != pts.end(); i++ ) { for( auto j = i + 1; j != pts.end(); j++ ) TrimWire( *i, *j ); if( aScreen->IsJunctionNeeded( *i, true ) ) AddJunction( aScreen, *i, true, false ); } TestDanglingEnds(); for( SCH_ITEM* item : aItem->ConnectedItems( GetCurrentSheet() ) ) UpdateItem( item ); } aItem->ClearEditFlags(); GetCanvas()->Refresh(); } void SCH_EDIT_FRAME::UpdateTitle() { wxString title; wxString nofile = _( "[no file]" ) + wxS(" "); wxString app = _( "Eeschema" ); if( GetScreen()->GetFileName().IsEmpty() ) { title = nofile + wxT( "\u2014 " ) + app; } else { wxFileName fn( Prj().AbsolutePath( GetScreen()->GetFileName() ) ); wxString append; if( fn.FileExists() ) { if( !fn.IsFileWritable() ) append = _( "[Read Only] " ); } else append = nofile; title.Printf( wxT( "%s [%s] %s\u2014 " ) + app, fn.GetName(), GetCurrentSheet().PathHumanReadable(), append ); } SetTitle( title ); } void SCH_EDIT_FRAME::RecalculateConnections( SCH_CLEANUP_FLAGS aCleanupFlags ) { SCHEMATIC_SETTINGS& settings = Schematic().Settings(); SCH_SHEET_LIST list = Schematic().GetSheets(); PROF_COUNTER timer; // Ensure schematic graph is accurate if( aCleanupFlags == LOCAL_CLEANUP ) { SchematicCleanUp( GetScreen() ); } else if( aCleanupFlags == GLOBAL_CLEANUP ) { for( const auto& sheet : list ) SchematicCleanUp( sheet.LastScreen() ); } timer.Stop(); wxLogTrace( "CONN_PROFILE", "SchematicCleanUp() %0.4f ms", timer.msecs() ); if( settings.m_IntersheetsRefShow == true ) RecomputeIntersheetsRefs(); Schematic().ConnectionGraph()->Recalculate( list, true ); } int SCH_EDIT_FRAME::RecomputeIntersheetsRefs() { SCHEMATIC_SETTINGS& settings = Schematic().Settings(); std::vector pagesNumbers; SCH_GLOBALLABEL* gLabel; SCH_IREF* iref; m_labelTable.clear(); SCH_SCREENS screens( Schematic().Root() ); /* Iterate over screens */ for( SCH_SCREEN* screen = screens.GetFirst(); screen != NULL; screen = screens.GetNext() ) { pagesNumbers.clear(); /* Find in which sheets this screen is used */ for( const SCH_SHEET_PATH& sheet : Schematic().GetSheets() ) { if( sheet.LastScreen() == screen ) pagesNumbers.push_back( sheet.GetPageNumber() ); } for( SCH_ITEM* item : screen->Items() ) { if( item->Type() == SCH_GLOBAL_LABEL_T ) { gLabel = static_cast( item ); m_labelTable.push_back( gLabel ); if( gLabel->GetIref() == nullptr ) { iref = new SCH_IREF(); gLabel->SetIref( iref ); iref->SetParent( gLabel ); iref->SetFlags( IS_NEW ); iref->SetScreen( screen ); if( gLabel->GetIrefSavedPosition() != wxDefaultPosition ) iref->SetPosition( gLabel->GetIrefSavedPosition() ); else iref->PlaceAtDefaultPosition(); iref->CopyParentStyle(); } else { iref = gLabel->GetIref(); } iref->GetRefTable()->clear(); iref->GetRefTable()->insert( iref->GetRefTable()->end(), pagesNumbers.begin(), pagesNumbers.end() ); } } } /* Fill intersheets references for each global label */ for( SCH_GLOBALLABEL* item : m_labelTable ) { for( SCH_GLOBALLABEL* iter : m_labelTable ) { if( iter->GetText().IsSameAs( item->GetText() ) && ( iter != item ) ) { iter->GetIref()->GetRefTable()->insert( iter->GetIref()->GetRefTable()->end(), item->GetIref()->GetRefTable()->begin(), item->GetIref()->GetRefTable()->end() ); } } } /* Refresh all global labels */ for( SCH_GLOBALLABEL* item : m_labelTable ) { wxString text, tmp; iref = item->GetIref(); sort( iref->GetRefTable()->begin(), iref->GetRefTable()->end() ); iref->GetRefTable()->erase( unique( iref->GetRefTable()->begin(), iref->GetRefTable()->end() ), iref->GetRefTable()->end() ); text.Printf( "%s", settings.m_IntersheetsRefPrefix ); if( ( settings.m_IntersheetsRefFormatShort ) && ( iref->GetRefTable()->size() > 2 ) ) { tmp.Printf( "%d..%d", iref->GetRefTable()->front(), iref->GetRefTable()->back() ); text.Append( tmp ); } else { for( int ref : *( iref->GetRefTable() ) ) { tmp.Printf( "%d,", ref ); text.Append( tmp ); } if( text.Last() == ',' ) text.RemoveLast(); } text.Append( settings.m_IntersheetsRefSuffix ); iref->SetText( text ); SCH_SCREEN* screen = iref->GetScreen(); if( !screen->CheckIfOnDrawList( iref ) ) AddToScreen( iref, screen ); iref->ClearFlags( IS_NEW ); screen->SetModify(); Refresh( iref ); iref->ClearEditFlags(); GetCanvas()->Refresh(); } return 0; } void SCH_EDIT_FRAME::RemoveAllIntersheetsRefs() { SCH_SHEET_LIST sheets = Schematic().GetSheets(); std::vector irefList; SCH_GLOBALLABEL* gLabel; SCH_SCREENS screens( Schematic().Root() ); for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() ) { for( SCH_ITEM* item : screen->Items() ) { if( item->Type() == SCH_GLOBAL_LABEL_T ) { gLabel = (SCH_GLOBALLABEL*)( item ); SCH_IREF* iref = gLabel->GetIref(); if( iref ) { gLabel->SetIref( nullptr ); gLabel->SetIrefSavedPosition( wxDefaultPosition ); irefList.push_back( iref ); } } } } for( SCH_IREF* iref : irefList ) RemoveFromScreen( iref, iref->GetScreen() ); } void SCH_EDIT_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) { SCHEMATIC_SETTINGS& settings = Schematic().Settings(); SCH_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged ); if( settings.m_IntersheetsRefShow == false ) RemoveAllIntersheetsRefs(); else RecomputeIntersheetsRefs(); GetCanvas()->GetView()->UpdateAllItems( KIGFX::ALL ); GetCanvas()->Refresh(); RecreateToolbars(); Layout(); SendSizeEvent(); } void SCH_EDIT_FRAME::OnPageSettingsChange() { // Rebuild the sheet view (draw area and any other items): DisplayCurrentSheet(); } void SCH_EDIT_FRAME::ShowChangedLanguage() { // call my base class SCH_BASE_FRAME::ShowChangedLanguage(); // tooltips in toolbars RecreateToolbars(); // status bar UpdateMsgPanel(); // This ugly hack is to fix an option(left) toolbar update bug that seems to only affect // windows. See https://bugs.launchpad.net/kicad/+bug/1816492. For some reason, calling // wxWindow::Refresh() does not resolve the issue. Only a resize event seems to force the // toolbar to update correctly. #if defined( __WXMSW__ ) PostSizeEvent(); #endif } void SCH_EDIT_FRAME::UpdateNetHighlightStatus() { if( const SCH_CONNECTION* conn = GetHighlightedConnection() ) { SetStatusText( wxString::Format( _( "Highlighted net: %s" ), UnescapeString( conn->Name() ) ) ); } else { SetStatusText( wxT( "" ) ); } } void SCH_EDIT_FRAME::SetScreen( BASE_SCREEN* aScreen ) { SCH_BASE_FRAME::SetScreen( aScreen ); GetCanvas()->DisplaySheet( static_cast( aScreen ) ); } const BOX2I SCH_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const { BOX2I bBoxDoc; if( aIncludeAllVisible ) { // Get the whole page size and return that int sizeX = GetScreen()->GetPageSettings().GetWidthIU(); int sizeY = GetScreen()->GetPageSettings().GetHeightIU(); bBoxDoc = BOX2I( VECTOR2I( 0, 0 ), VECTOR2I( sizeX, sizeY ) ); } else { // Get current worksheet in a form we can compare to an EDA_ITEM KIGFX::WS_PROXY_VIEW_ITEM* currWs = SCH_BASE_FRAME::GetCanvas()->GetView()->GetWorksheet(); EDA_ITEM* currWsAsItem = static_cast( currWs ); // Need an EDA_RECT so the first ".Merge" sees it's uninitialized EDA_RECT bBoxItems; // Calc the bounding box of all items on screen except the page border for( EDA_ITEM* item : GetScreen()->Items() ) { if( item != currWsAsItem ) // Ignore the worksheet itself { if( item->Type() == SCH_COMPONENT_T ) { // For components we need to get the bounding box without invisible text SCH_COMPONENT* comp = static_cast( item ); bBoxItems.Merge( comp->GetBoundingBox( false ) ); } else bBoxItems.Merge( item->GetBoundingBox() ); } bBoxDoc = bBoxItems; } } return bBoxDoc; } void SCH_EDIT_FRAME::FixupJunctions() { // Save the current sheet, to retrieve it later SCH_SHEET_PATH oldsheetpath = GetCurrentSheet(); bool modified = false; SCH_SHEET_LIST sheetList = Schematic().GetSheets(); for( const SCH_SHEET_PATH& sheet : sheetList ) { // We require a set here to avoid adding multiple junctions to the same spot std::set junctions; SetCurrentSheet( sheet ); GetCurrentSheet().UpdateAllScreenReferences(); SCH_SCREEN* screen = GetCurrentSheet().LastScreen(); for( auto aItem : screen->Items().OfType( SCH_COMPONENT_T ) ) { auto cmp = static_cast( aItem ); for( const SCH_PIN* pin : cmp->GetPins( &sheet ) ) { auto pos = pin->GetPosition(); // Test if a _new_ junction is needed, and add it if missing if( screen->IsJunctionNeeded( pos, true ) ) junctions.insert( pos ); } } for( const wxPoint& pos : junctions ) AddJunction( screen, pos, false, false ); if( junctions.size() ) modified = true; } if( modified ) OnModify(); // Reselect the initial sheet: SetCurrentSheet( oldsheetpath ); GetCurrentSheet().UpdateAllScreenReferences(); SetScreen( GetCurrentSheet().LastScreen() ); } bool SCH_EDIT_FRAME::IsContentModified() { return Schematic().GetSheets().IsModified(); } bool SCH_EDIT_FRAME::GetShowAllPins() const { EESCHEMA_SETTINGS* cfg = eeconfig(); return cfg->m_Appearance.show_hidden_pins; } void SCH_EDIT_FRAME::FocusOnItem( SCH_ITEM* aItem ) { static KIID lastBrightenedItemID( niluuid ); SCH_SHEET_LIST sheetList = Schematic().GetSheets(); SCH_SHEET_PATH dummy; SCH_ITEM* lastItem = sheetList.GetItem( lastBrightenedItemID, &dummy ); if( lastItem && lastItem != aItem ) { lastItem->ClearBrightened(); UpdateItem( lastItem ); lastBrightenedItemID = niluuid; } if( aItem ) { aItem->SetBrightened(); UpdateItem( aItem ); lastBrightenedItemID = aItem->m_Uuid; FocusOnLocation( aItem->GetFocusPosition() ); } } void SCH_EDIT_FRAME::ConvertTimeStampUuids() { // Remove this once this method is fully implemented. Otherwise, don't use it. wxCHECK( false, /* void */ ); // Replace sheet and symbol time stamps with real UUIDs and update symbol instance // sheet paths using the new UUID based sheet paths. // Save the time stamp sheet paths. SCH_SHEET_LIST timeStampSheetPaths = Schematic().GetSheets(); std::vector oldSheetPaths = timeStampSheetPaths.GetPaths(); // The root sheet now gets a permanent UUID. const_cast( Schematic().Root().m_Uuid ).ConvertTimestampToUuid(); SCH_SCREENS schematic( Schematic().Root() ); // Change the sheet and symbol time stamps to UUIDs. for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() ) { for( auto sheet : screen->Items().OfType( SCH_SHEET_T ) ) const_cast( sheet->m_Uuid ).ConvertTimestampToUuid(); for( auto symbol : screen->Items().OfType( SCH_COMPONENT_T ) ) const_cast( symbol->m_Uuid ).ConvertTimestampToUuid(); } timeStampSheetPaths.ReplaceLegacySheetPaths( oldSheetPaths ); } wxString SCH_EDIT_FRAME::GetCurrentFileName() const { return Schematic().GetFileName(); } SELECTION& SCH_EDIT_FRAME::GetCurrentSelection() { return m_toolManager->GetTool()->GetSelection(); } void SCH_EDIT_FRAME::onSize( wxSizeEvent& aEvent ) { if( IsShown() ) { // We only need this until the frame is done resizing and the final client size is // established. Unbind( wxEVT_SIZE, &SCH_EDIT_FRAME::onSize, this ); GetToolManager()->RunAction( ACTIONS::zoomFitScreen, true ); } // Skip() is called in the base class. EDA_DRAW_FRAME::OnSize( aEvent ); } void SCH_EDIT_FRAME::UpdateSymbolFromEditor( const LIB_PART& aSymbol ) { wxString msg; bool appendToUndo = false; wxCHECK( m_toolManager, /* void */ ); EE_SELECTION_TOOL* selectionTool = m_toolManager->GetTool(); wxCHECK( selectionTool, /* void */ ); EE_SELECTION& selection = selectionTool->RequestSelection( EE_COLLECTOR::ComponentsOnly ); if( selection.Empty() ) return; SCH_SCREEN* currentScreen = GetScreen(); wxCHECK( currentScreen, /* void */ ); // This should work for multiple selections of the same symbol even though the editor // only works for a single symbol selection. for( auto item : selection ) { SCH_COMPONENT* symbol = dynamic_cast( item ); wxCHECK( symbol, /* void */ ); // This needs to be done before the LIB_PART is changed to prevent stale library symbols in // the schematic file. currentScreen->Remove( symbol ); if( !symbol->IsNew() ) { SaveCopyInUndoList( currentScreen, symbol, UNDO_REDO::CHANGED, appendToUndo ); appendToUndo = true; } symbol->SetLibSymbol( aSymbol.Flatten().release() ); currentScreen->Append( symbol ); selectionTool->SelectHighlightItem( symbol ); GetCanvas()->GetView()->Update( symbol ); } if( selection.IsHover() ) m_toolManager->RunAction( EE_ACTIONS::clearSelection, true ); GetCanvas()->Refresh(); OnModify(); }