1017 lines
37 KiB
C++
1017 lines
37 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2004-2018 KiCad Developers, see change_log.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
|
|
*/
|
|
|
|
/**
|
|
* @file sheet.cpp
|
|
*/
|
|
|
|
#include <fctsys.h>
|
|
#include <sch_draw_panel.h>
|
|
#include <confirm.h>
|
|
#include <kiface_i.h>
|
|
#include <project.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
|
|
#include <sch_edit_frame.h>
|
|
#include <sch_legacy_plugin.h>
|
|
#include <sch_sheet.h>
|
|
#include <sch_sheet_path.h>
|
|
#include <sch_view.h>
|
|
#include <symbol_lib_table.h>
|
|
#include <dialogs/dialog_sch_sheet_props.h>
|
|
#include <dialogs/dialog_sch_edit_sheet_pin.h>
|
|
#include <tool/actions.h>
|
|
|
|
|
|
bool SCH_EDIT_FRAME::checkSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy )
|
|
{
|
|
wxASSERT( aSheet && aHierarchy );
|
|
|
|
wxString msg;
|
|
SCH_SHEET_LIST hierarchy( g_RootSheet ); // This is the full schematic sheet hierarchy.
|
|
SCH_SHEET_LIST sheetHierarchy( aSheet ); // This is the hierarchy of the loaded file.
|
|
|
|
wxFileName destFile = aHierarchy->LastScreen()->GetFileName();
|
|
|
|
// SCH_SCREEN object file paths are expected to be absolute. If this assert fires,
|
|
// something is seriously broken.
|
|
wxASSERT( destFile.IsAbsolute() );
|
|
|
|
if( hierarchy.TestForRecursion( sheetHierarchy, destFile.GetFullPath() ) )
|
|
{
|
|
msg.Printf( _( "The sheet changes cannot be made because the destination sheet already "
|
|
"has the sheet \"%s\" or one of it's subsheets as a parent somewhere in "
|
|
"the schematic hierarchy." ),
|
|
destFile.GetFullPath() );
|
|
DisplayError( this, msg );
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds( SCH_SHEET* aSheet )
|
|
{
|
|
wxASSERT( aSheet && aSheet->GetScreen() );
|
|
|
|
wxString msg;
|
|
SCH_SCREENS newScreens( aSheet );
|
|
|
|
if( newScreens.HasNoFullyDefinedLibIds() )
|
|
{
|
|
msg.Printf( _( "The schematic \"%s\" has not had it's symbol library links remapped "
|
|
"to the symbol library table. The project this schematic belongs to "
|
|
"must first be remapped before it can be imported into the current "
|
|
"project." ), aSheet->GetScreen()->GetFileName() );
|
|
DisplayInfoMessage( this, msg );
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
void SCH_EDIT_FRAME::InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename )
|
|
{
|
|
aSheet->SetScreen( new SCH_SCREEN( &Kiway() ) );
|
|
aSheet->GetScreen()->SetModify();
|
|
aSheet->GetScreen()->SetMaxUndoItems( m_UndoRedoCountMax );
|
|
aSheet->GetScreen()->SetFileName( aNewFilename );
|
|
}
|
|
|
|
|
|
bool SCH_EDIT_FRAME::LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
|
|
const wxString& aFileName )
|
|
{
|
|
wxASSERT( aSheet && aHierarchy );
|
|
|
|
int i;
|
|
wxString msg;
|
|
wxString topLevelSheetPath;
|
|
wxFileName tmp;
|
|
wxFileName currentSheetFileName;
|
|
bool libTableChanged = false;
|
|
SCH_SCREEN* currentScreen = aHierarchy->LastScreen();
|
|
SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
|
|
std::unique_ptr< SCH_SHEET> newSheet( new SCH_SHEET );
|
|
|
|
wxFileName fileName( aFileName );
|
|
|
|
if( !fileName.IsAbsolute() )
|
|
{
|
|
wxCHECK_MSG( fileName.MakeAbsolute(), false,
|
|
wxString::Format( "Cannot make file name \"%s\" path absolute.",
|
|
aFileName ) );
|
|
}
|
|
|
|
wxString fullFilename = fileName.GetFullPath();
|
|
|
|
try
|
|
{
|
|
if( aSheet->GetScreen() != nullptr )
|
|
{
|
|
newSheet.reset( pi->Load( fullFilename, &Kiway() ) );
|
|
}
|
|
else
|
|
{
|
|
newSheet->SetFileName( fullFilename );
|
|
pi->Load( fullFilename, &Kiway(), newSheet.get() );
|
|
}
|
|
|
|
if( !pi->GetError().IsEmpty() )
|
|
{
|
|
msg = _( "The entire schematic could not be loaded. Errors occurred attempting "
|
|
"to load hierarchical sheet schematics." );
|
|
|
|
wxMessageDialog msgDlg1( this, msg, _( "Schematic Load Error" ),
|
|
wxOK | wxCANCEL | wxCANCEL_DEFAULT |
|
|
wxCENTER | wxICON_QUESTION );
|
|
msgDlg1.SetOKLabel( wxMessageDialog::ButtonLabel( _( "Use partial schematic" ) ) );
|
|
msgDlg1.SetExtendedMessage( pi->GetError() );
|
|
|
|
if( msgDlg1.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
}
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
msg.Printf( _( "Error occurred loading schematic file \"%s\"." ), fullFilename );
|
|
DisplayErrorMessage( this, msg, ioe.What() );
|
|
|
|
msg.Printf( _( "Failed to load schematic \"%s\"" ), fullFilename );
|
|
AppendMsgPanel( wxEmptyString, msg, CYAN );
|
|
|
|
return false;
|
|
}
|
|
|
|
tmp = fileName;
|
|
|
|
// If the loaded schematic is in a different folder from the current project and
|
|
// it contains hierarchical sheets, the hierarchical sheet paths need to be updated.
|
|
if( fileName.GetPath( wxPATH_GET_SEPARATOR ) != Prj().GetProjectPath()
|
|
&& newSheet->CountSheets() )
|
|
{
|
|
// Give the user the option to choose relative path if possible.
|
|
if( tmp.MakeRelativeTo( Prj().GetProjectPath() ) )
|
|
{
|
|
wxMessageDialog msgDlg2(
|
|
this,
|
|
"Do you want to use a relative path to the loaded "
|
|
"schematic?", "Select Path Type",
|
|
wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION | wxCENTER );
|
|
msgDlg2.SetYesNoLabels( wxMessageDialog::ButtonLabel( "Use Relative Path" ),
|
|
wxMessageDialog::ButtonLabel( "Use Absolute Path" ) );
|
|
int rsp = msgDlg2.ShowModal();
|
|
|
|
if( rsp == wxID_CANCEL )
|
|
{
|
|
return false;
|
|
}
|
|
else if( rsp == wxID_NO )
|
|
{
|
|
topLevelSheetPath = fileName.GetPathWithSep();
|
|
}
|
|
else
|
|
{
|
|
topLevelSheetPath = tmp.GetPathWithSep();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
topLevelSheetPath = tmp.GetPathWithSep();
|
|
}
|
|
|
|
if( wxFileName::GetPathSeparator() == '\\' )
|
|
topLevelSheetPath.Replace( "\\", "/" );
|
|
}
|
|
|
|
// Make sure any new sheet changes do not cause any recursion issues.
|
|
SCH_SHEET_LIST hierarchy( g_RootSheet ); // This is the schematic sheet hierarchy.
|
|
SCH_SHEET_LIST sheetHierarchy( newSheet.get() ); // This is the hierarchy of the loaded file.
|
|
|
|
if( checkSheetForRecursion( newSheet.get(), aHierarchy )
|
|
|| checkForNoFullyDefinedLibIds( newSheet.get() ) )
|
|
return false;
|
|
|
|
// Make a valiant attempt to warn the user of all possible scenarios where there could
|
|
// be broken symbol library links.
|
|
wxArrayString names;
|
|
wxArrayString newLibNames;
|
|
SCH_SCREENS newScreens( newSheet.get() ); // All screens associated with the import.
|
|
SCH_SCREENS prjScreens( g_RootSheet );
|
|
|
|
newScreens.GetLibNicknames( names );
|
|
|
|
wxMessageDialog::ButtonLabel okButtonLabel( _( "Continue Load" ) );
|
|
wxMessageDialog::ButtonLabel cancelButtonLabel( _( "Cancel Load" ) );
|
|
|
|
if( fileName.GetPath( wxPATH_GET_SEPARATOR ) == Prj().GetProjectPath()
|
|
&& !prjScreens.HasSchematic( fullFilename ) )
|
|
{
|
|
// A schematic in the current project path that isn't part of the current project.
|
|
// It's possible the user copied this schematic from another project so the library
|
|
// links may not be avaible. Even this is check is no guarantee that all symbol
|
|
// library links are valid but it's better than nothing.
|
|
for( const auto& name : names )
|
|
{
|
|
if( !Prj().SchSymbolLibTable()->HasLibrary( name ) )
|
|
newLibNames.Add( name );
|
|
}
|
|
|
|
if( !newLibNames.IsEmpty() )
|
|
{
|
|
msg = _( "There are library names in the loaded schematic that are missing "
|
|
"from the project library table. This may result in broken symbol "
|
|
"library links for the loaded schematic. Do you wish to continue?" );
|
|
wxMessageDialog msgDlg3( this, msg, _( "Continue Load Schematic" ),
|
|
wxOK | wxCANCEL | wxCANCEL_DEFAULT |
|
|
wxCENTER | wxICON_QUESTION );
|
|
msgDlg3.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
|
|
|
|
if( msgDlg3.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
}
|
|
}
|
|
else if( fileName.GetPath( wxPATH_GET_SEPARATOR ) != Prj().GetProjectPath() )
|
|
{
|
|
// A schematic loaded from a path other than the current project path.
|
|
|
|
// If there are symbol libraries in the imported schematic that are not in the
|
|
// symbol library table of this project, there could be a lot of broken symbol
|
|
// library links. Attempt to add the missing libraries to the project symbol
|
|
// library table.
|
|
wxArrayString duplicateLibNames;
|
|
|
|
for( const auto& name : names )
|
|
{
|
|
if( !Prj().SchSymbolLibTable()->HasLibrary( name ) )
|
|
newLibNames.Add( name );
|
|
else
|
|
duplicateLibNames.Add( name );
|
|
}
|
|
|
|
SYMBOL_LIB_TABLE table;
|
|
wxFileName symLibTableFn( fileName.GetPath(),
|
|
SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
|
|
|
|
// If there are any new or duplicate libraries, check to see if it's possible that
|
|
// there could be any missing libraries that would cause broken symbol library links.
|
|
if( !newLibNames.IsEmpty() || !duplicateLibNames.IsEmpty() )
|
|
{
|
|
if( !symLibTableFn.Exists() || !symLibTableFn.IsFileReadable() )
|
|
{
|
|
msg.Printf( _( "The project library table \"%s\" does not exist or cannot "
|
|
"be read. This may result in broken symbol links for the "
|
|
"schematic. Do you wish to continue?" ),
|
|
fileName.GetFullPath() );
|
|
wxMessageDialog msgDlg4( this, msg, _( "Continue Load Schematic" ),
|
|
wxOK | wxCANCEL | wxCANCEL_DEFAULT |
|
|
wxCENTER | wxICON_QUESTION );
|
|
msgDlg4.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
|
|
|
|
if( msgDlg4.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
try
|
|
{
|
|
table.Load( symLibTableFn.GetFullPath() );
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
msg.Printf( _( "An error occurred loading the symbol library table "
|
|
"\"%s\"." ),
|
|
symLibTableFn.GetFullPath() );
|
|
DisplayErrorMessage( NULL, msg, ioe.What() );
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check to see if any of the symbol libraries found in the appended schematic do
|
|
// not exist in the current project are missing from the appended project symbol
|
|
// library table.
|
|
if( !newLibNames.IsEmpty() )
|
|
{
|
|
bool missingLibNames = table.IsEmpty();
|
|
|
|
if( !missingLibNames )
|
|
{
|
|
for( const auto& newLibName : newLibNames )
|
|
{
|
|
if( !table.HasLibrary( newLibName ) )
|
|
{
|
|
missingLibNames = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if( missingLibNames )
|
|
{
|
|
msg = _( "There are library names in the loaded schematic that are missing "
|
|
"from the loaded schematic project library table. This may result "
|
|
"in broken symbol library links for the schematic. "
|
|
"Do you wish to continue?" );
|
|
wxMessageDialog msgDlg5( this, msg, _( "Continue Load Schematic" ),
|
|
wxOK | wxCANCEL | wxCANCEL_DEFAULT |
|
|
wxCENTER | wxICON_QUESTION );
|
|
msgDlg5.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
|
|
|
|
if( msgDlg5.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// The library name already exists in the current project. Check to see if the
|
|
// duplicate name is the same library in the current project. If it's not, it's
|
|
// most likely that the symbol library links will be broken.
|
|
if( !duplicateLibNames.IsEmpty() && !table.IsEmpty() )
|
|
{
|
|
bool libNameConflict = false;
|
|
|
|
for( const auto& duplicateLibName : duplicateLibNames )
|
|
{
|
|
const SYMBOL_LIB_TABLE_ROW* thisRow = nullptr;
|
|
const SYMBOL_LIB_TABLE_ROW* otherRow = nullptr;
|
|
|
|
if( Prj().SchSymbolLibTable()->HasLibrary( duplicateLibName ) )
|
|
thisRow = Prj().SchSymbolLibTable()->FindRow( duplicateLibName );
|
|
|
|
if( table.HasLibrary( duplicateLibName ) )
|
|
otherRow = table.FindRow( duplicateLibName );
|
|
|
|
// It's in the global library table so there is no conflict.
|
|
if( thisRow && !otherRow )
|
|
continue;
|
|
|
|
if( !thisRow || !otherRow )
|
|
continue;
|
|
|
|
wxFileName otherUriFileName;
|
|
wxString thisURI = thisRow->GetFullURI( true );
|
|
wxString otherURI = otherRow->GetFullURI( false);
|
|
|
|
if( otherURI.Contains( "${KIPRJMOD}" ) || otherURI.Contains( "$(KIPRJMOD)" ) )
|
|
{
|
|
// Cannot use relative paths here, "${KIPRJMOD}../path-to-cache-lib" does
|
|
// not expand to a valid symbol library path.
|
|
otherUriFileName.SetPath( fileName.GetPath() );
|
|
otherUriFileName.SetFullName( otherURI.AfterLast( '}' ) );
|
|
otherURI = otherUriFileName.GetFullPath();
|
|
}
|
|
|
|
if( thisURI != otherURI )
|
|
{
|
|
libNameConflict = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( libNameConflict )
|
|
{
|
|
msg = _( "A duplicate library name that references a different library exists "
|
|
"in the current library table. This conflict cannot be resolved and "
|
|
"may result in broken symbol library links for the schematic. "
|
|
"Do you wish to continue?" );
|
|
wxMessageDialog msgDlg6( this, msg, _( "Continue Load Schematic" ),
|
|
wxOK | wxCANCEL | wxCANCEL_DEFAULT |
|
|
wxCENTER | wxICON_QUESTION );
|
|
msgDlg6.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
|
|
|
|
if( msgDlg6.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// All (most?) of the possible broken symbol library link cases are covered. Map the
|
|
// new appended schematic project symbol library table entries to the current project
|
|
// symbol library table.
|
|
if( !newLibNames.IsEmpty() && !table.IsEmpty() )
|
|
{
|
|
for( const auto& libName : newLibNames )
|
|
{
|
|
if( !table.HasLibrary( libName )
|
|
|| Prj().SchSymbolLibTable()->HasLibrary( libName ) )
|
|
continue;
|
|
|
|
// Don't expand environment variable because KIPRJMOD will not be correct
|
|
// for a different project.
|
|
wxString uri = table.GetFullURI( libName, false );
|
|
wxFileName newLib;
|
|
|
|
if( uri.Contains( "${KIPRJMOD}" ) || uri.Contains( "$(KIPRJMOD)" ) )
|
|
{
|
|
// Cannot use relative paths here, "${KIPRJMOD}../path-to-cache-lib" does
|
|
// not expand to a valid symbol library path.
|
|
newLib.SetPath( fileName.GetPath() );
|
|
newLib.SetFullName( uri.AfterLast( '}' ) );
|
|
uri = newLib.GetFullPath();
|
|
}
|
|
else
|
|
{
|
|
uri = table.GetFullURI( libName );
|
|
}
|
|
|
|
// Add the library from the imported project to the current project
|
|
// symbol library table.
|
|
const SYMBOL_LIB_TABLE_ROW* row = table.FindRow( libName );
|
|
|
|
auto newRow = new SYMBOL_LIB_TABLE_ROW( libName, uri, row->GetType(),
|
|
row->GetOptions(), row->GetDescr() );
|
|
|
|
Prj().SchSymbolLibTable()->InsertRow( newRow );
|
|
libTableChanged = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Check for duplicate sheet names in the current page.
|
|
wxArrayString duplicateSheetNames;
|
|
SCH_TYPE_COLLECTOR sheets;
|
|
|
|
sheets.Collect( currentScreen->GetDrawItems(), SCH_COLLECTOR::SheetsOnly );
|
|
|
|
for( i = 0; i < sheets.GetCount(); ++i )
|
|
{
|
|
if( newSheet->GetScreen()->GetSheet( ( ( SCH_SHEET* ) sheets[i] )->GetName() ) )
|
|
duplicateSheetNames.Add( ( ( SCH_SHEET* ) sheets[i] )->GetName() );
|
|
}
|
|
|
|
if( !duplicateSheetNames.IsEmpty() )
|
|
{
|
|
msg.Printf( "Duplicate sheet names exist on the current page. Do you want to "
|
|
"automatically rename the duplicate sheet names?" );
|
|
|
|
if( !IsOK( this, msg ) )
|
|
return false;
|
|
}
|
|
|
|
// Rename all duplicate sheet names.
|
|
SCH_SCREEN* newScreen = newSheet->GetScreen();
|
|
wxCHECK_MSG( newScreen, false, "No screen defined for sheet." );
|
|
|
|
for( const auto& duplicateName : duplicateSheetNames )
|
|
{
|
|
SCH_SHEET* renamedSheet = newScreen->GetSheet( duplicateName );
|
|
|
|
wxCHECK2_MSG( renamedSheet, continue,
|
|
"Sheet " + duplicateName + " not found in imported schematic." );
|
|
|
|
timestamp_t newtimestamp = GetNewTimeStamp();
|
|
renamedSheet->SetTimeStamp( newtimestamp );
|
|
renamedSheet->SetName( wxString::Format( "Sheet%8.8lX", (unsigned long) newtimestamp ) );
|
|
}
|
|
|
|
// Set all sheets loaded into the correct sheet file paths.
|
|
SCH_TYPE_COLLECTOR newTopLevelSheets;
|
|
|
|
newTopLevelSheets.Collect( newSheet->GetScreen()->GetDrawItems(), SCH_COLLECTOR::SheetsOnly );
|
|
|
|
for( i = 0; i < newTopLevelSheets.GetCount(); ++i )
|
|
{
|
|
SCH_SHEET* tmpSheet = dynamic_cast< SCH_SHEET* >( newTopLevelSheets[i] );
|
|
wxCHECK2( tmpSheet != nullptr, continue );
|
|
tmpSheet->SetFileName( topLevelSheetPath + tmpSheet->GetFileName() );
|
|
}
|
|
|
|
if( libTableChanged )
|
|
Prj().SchSymbolLibTable()->Save( Prj().GetProjectPath() +
|
|
SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
|
|
|
|
// It is finally safe to add or append the imported schematic.
|
|
if( aSheet->GetScreen() == nullptr )
|
|
aSheet->SetScreen( newScreen );
|
|
else
|
|
aSheet->GetScreen()->Append( newScreen );
|
|
|
|
SCH_SCREENS allScreens;
|
|
allScreens.ReplaceDuplicateTimeStamps();
|
|
|
|
SCH_SCREENS screens( aSheet );
|
|
screens.UpdateSymbolLinks( true );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool SCH_EDIT_FRAME::EditSheet( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
|
|
bool* aClearAnnotationNewItems )
|
|
{
|
|
if( aSheet == NULL || aHierarchy == NULL )
|
|
return false;
|
|
|
|
// Get the new texts
|
|
DIALOG_SCH_SHEET_PROPS dlg( this, aSheet );
|
|
|
|
if( dlg.ShowModal() == wxID_CANCEL )
|
|
return false;
|
|
|
|
wxFileName fileName = dlg.GetFileName();
|
|
fileName.SetExt( SchematicFileExtension );
|
|
|
|
wxString msg;
|
|
bool renameFile = false;
|
|
bool loadFromFile = false;
|
|
bool clearAnnotation = false;
|
|
bool restoreSheet = false;
|
|
bool isExistingSheet = false;
|
|
SCH_SCREEN* useScreen = NULL;
|
|
|
|
// Relative file names are relative to the path of the current sheet. This allows for
|
|
// nesting of schematic files in subfolders.
|
|
if( !fileName.IsAbsolute() )
|
|
{
|
|
const SCH_SCREEN* currentScreen = aHierarchy->LastScreen();
|
|
|
|
wxCHECK_MSG( currentScreen, false, "Invalid sheet path object." );
|
|
|
|
wxFileName currentSheetFileName = currentScreen->GetFileName();
|
|
|
|
wxCHECK_MSG( fileName.Normalize( wxPATH_NORM_ALL, currentSheetFileName.GetPath() ), false,
|
|
"Cannot normalize new sheet schematic file path." );
|
|
}
|
|
|
|
wxString newFilename = fileName.GetFullPath();
|
|
|
|
// Search for a schematic file having the same filename
|
|
// already in use in the hierarchy or on disk, in order to reuse it.
|
|
if( !g_RootSheet->SearchHierarchy( newFilename, &useScreen ) )
|
|
{
|
|
loadFromFile = wxFileExists( newFilename );
|
|
wxLogDebug( "Sheet requested file \"%s\", %s",
|
|
newFilename,
|
|
( loadFromFile ) ? "found" : "not found" );
|
|
}
|
|
|
|
// Inside Eeschema, filenames are stored using unix notation
|
|
newFilename.Replace( wxT( "\\" ), wxT( "/" ) );
|
|
|
|
SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_LEGACY ) );
|
|
|
|
if( aSheet->GetScreen() == NULL ) // New sheet.
|
|
{
|
|
if( !allowCaseSensitiveFileNameClashes( newFilename ) )
|
|
return false;
|
|
|
|
if( useScreen || loadFromFile ) // Load from existing file.
|
|
{
|
|
clearAnnotation = true;
|
|
|
|
wxString existsMsg;
|
|
wxString linkMsg;
|
|
existsMsg.Printf( _( "\"%s\" already exists." ), fileName.GetFullName() );
|
|
linkMsg.Printf( _( "Link \"%s\" to this file?" ), dlg.GetSheetName() );
|
|
msg.Printf( wxT( "%s\n\n%s" ), existsMsg, linkMsg );
|
|
|
|
if( !IsOK( this, msg ) )
|
|
return false;
|
|
|
|
}
|
|
else // New file.
|
|
{
|
|
aSheet->SetScreen( new SCH_SCREEN( &Kiway() ) );
|
|
aSheet->GetScreen()->SetModify();
|
|
aSheet->GetScreen()->SetMaxUndoItems( m_UndoRedoCountMax );
|
|
aSheet->GetScreen()->SetFileName( newFilename );
|
|
}
|
|
}
|
|
else // Existing sheet.
|
|
{
|
|
bool isUndoable = true;
|
|
wxString replaceMsg;
|
|
wxString newMsg;
|
|
wxString noUndoMsg;
|
|
|
|
isExistingSheet = true;
|
|
|
|
if( !allowCaseSensitiveFileNameClashes( newFilename ) )
|
|
return false;
|
|
|
|
// Changing the filename of a sheet can modify the full hierarchy structure
|
|
// and can be not always undoable.
|
|
// So prepare messages for user notifications:
|
|
replaceMsg.Printf( _( "Change \"%s\" link from \"%s\" to \"%s\"?" ),
|
|
dlg.GetSheetName(), aSheet->GetFileName(), fileName.GetFullName() );
|
|
newMsg.Printf( _( "Create new file \"%s\" with contents of \"%s\"?" ),
|
|
fileName.GetFullName(), aSheet->GetFileName() );
|
|
noUndoMsg = _( "This action cannot be undone." );
|
|
|
|
// We are always using here a case insensitive comparison
|
|
// to avoid issues under Windows, although under Unix
|
|
// filenames are case sensitive.
|
|
// But many users create schematic under both Unix and Windows
|
|
// **
|
|
// N.B. 1: aSheet->GetFileName() will return a relative path
|
|
// aSheet->GetScreen()->GetFileName() returns a full path
|
|
//
|
|
// N.B. 2: newFilename uses the unix notation for separator.
|
|
// so we must use it also to compare the old filename to the new filename
|
|
wxString oldFilename = aSheet->GetScreen()->GetFileName();
|
|
oldFilename.Replace( wxT( "\\" ), wxT( "/" ) );
|
|
|
|
if( newFilename.Cmp( oldFilename ) != 0 )
|
|
{
|
|
// Sheet file name changes cannot be undone.
|
|
isUndoable = false;
|
|
|
|
if( useScreen || loadFromFile ) // Load from existing file.
|
|
{
|
|
clearAnnotation = true;
|
|
|
|
msg.Printf( wxT( "%s\n\n%s" ), replaceMsg, noUndoMsg );
|
|
|
|
if( !IsOK( this, msg ) )
|
|
return false;
|
|
|
|
if( loadFromFile )
|
|
aSheet->SetScreen( NULL );
|
|
}
|
|
else // Save to new file name.
|
|
{
|
|
if( aSheet->GetScreenCount() > 1 )
|
|
{
|
|
msg.Printf( wxT( "%s\n\n%s" ), newMsg, noUndoMsg );
|
|
|
|
if( !IsOK( this, msg ) )
|
|
return false;
|
|
}
|
|
|
|
renameFile = true;
|
|
}
|
|
}
|
|
|
|
m_canvas->SetIgnoreMouseEvents( true );
|
|
|
|
if( isUndoable )
|
|
SaveCopyInUndoList( aSheet, UR_CHANGED );
|
|
|
|
if( renameFile )
|
|
{
|
|
// If the the associated screen is shared by more than one sheet, do not
|
|
// change the filename of the corresponding screen here.
|
|
// (a new screen will be created later)
|
|
// if it is not shared, update the filename
|
|
if( aSheet->GetScreenCount() <= 1 )
|
|
aSheet->GetScreen()->SetFileName( newFilename );
|
|
|
|
try
|
|
{
|
|
pi->Save( newFilename, aSheet->GetScreen(), &Kiway() );
|
|
}
|
|
catch( const IO_ERROR& ioe )
|
|
{
|
|
msg.Printf( _( "Error occurred saving schematic file \"%s\"." ), newFilename );
|
|
DisplayErrorMessage( this, msg, ioe.What() );
|
|
|
|
msg.Printf( _( "Failed to save schematic \"%s\"" ), newFilename );
|
|
AppendMsgPanel( wxEmptyString, msg, CYAN );
|
|
|
|
return false;
|
|
}
|
|
|
|
// If the the associated screen is shared by more than one sheet, remove the
|
|
// screen and reload the file to a new screen. Failure to do this will trash
|
|
// the screen reference counting in complex hierarchies.
|
|
if( aSheet->GetScreenCount() > 1 )
|
|
{
|
|
aSheet->SetScreen( NULL );
|
|
loadFromFile = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
wxFileName userFileName = dlg.GetFileName();
|
|
userFileName.SetExt( SchematicFileExtension );
|
|
|
|
if( useScreen )
|
|
{
|
|
// Create a temporary sheet for recursion testing to prevent a possible recursion error.
|
|
std::unique_ptr< SCH_SHEET> tmpSheet( new SCH_SHEET );
|
|
tmpSheet->SetName( dlg.GetSheetName() );
|
|
tmpSheet->SetFileName( userFileName.GetFullPath() );
|
|
tmpSheet->SetScreen( useScreen );
|
|
|
|
// No need to check for valid library IDs if we are using an existing screen.
|
|
if( checkSheetForRecursion( tmpSheet.get(), aHierarchy ) )
|
|
{
|
|
if( restoreSheet )
|
|
aHierarchy->LastScreen()->Append( aSheet );
|
|
|
|
return false;
|
|
}
|
|
|
|
// It's safe to set the sheet screen now.
|
|
aSheet->SetScreen( useScreen );
|
|
}
|
|
else if( loadFromFile )
|
|
{
|
|
if( isExistingSheet )
|
|
{
|
|
// Temporarily remove the sheet from the current schematic page so that recursion
|
|
// and symbol library link tests can be performed with the modified sheet settings.
|
|
restoreSheet = true;
|
|
aHierarchy->LastScreen()->Remove( aSheet );
|
|
}
|
|
|
|
if( !LoadSheetFromFile( aSheet, aHierarchy, newFilename ) )
|
|
{
|
|
if( restoreSheet )
|
|
aHierarchy->LastScreen()->Append( aSheet );
|
|
|
|
return false;
|
|
}
|
|
|
|
if( restoreSheet )
|
|
aHierarchy->LastScreen()->Append( aSheet );
|
|
}
|
|
|
|
wxString tmpFn = userFileName.GetFullPath();
|
|
|
|
if( wxFileName::GetPathSeparator() == '\\' )
|
|
tmpFn.Replace( "\\", "/" );
|
|
|
|
aSheet->SetFileName( tmpFn );
|
|
aSheet->SetFileNameSize( dlg.GetFileNameTextSize() );
|
|
aSheet->SetName( dlg.GetSheetName() );
|
|
aSheet->SetSheetNameSize( dlg.GetSheetNameTextSize() );
|
|
|
|
if( aSheet->GetName().IsEmpty() )
|
|
aSheet->SetName( wxString::Format( wxT( "Sheet%8.8lX" ),
|
|
(long unsigned) aSheet->GetTimeStamp() ) );
|
|
|
|
if( aClearAnnotationNewItems )
|
|
*aClearAnnotationNewItems = clearAnnotation;
|
|
|
|
m_canvas->MoveCursorToCrossHair();
|
|
m_canvas->SetIgnoreMouseEvents( false );
|
|
|
|
GetCanvas()->GetView()->Update( aSheet );
|
|
|
|
OnModify();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/* Move selected sheet with the cursor.
|
|
* Callback function used by m_mouseCaptureCallback.
|
|
* Note also now this function is called only when resizing the sheet
|
|
* But the (very small code) relative to sheet move is still present here
|
|
*/
|
|
static void resizeSheetWithMouseCursor( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
|
|
bool aErase )
|
|
{
|
|
BASE_SCREEN* screen = aPanel->GetScreen();
|
|
SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( screen->GetCurItem() );
|
|
|
|
if( sheet == nullptr ) // Be sure we are using the right object
|
|
return;
|
|
|
|
wxPoint pos = sheet->GetPosition();
|
|
|
|
int width = aPanel->GetParent()->GetCrossHairPosition().x - pos.x;
|
|
int height = aPanel->GetParent()->GetCrossHairPosition().y - pos.y;
|
|
|
|
// If the sheet doesn't have any pins, clamp the minimum size to the default values.
|
|
width = ( width < MIN_SHEET_WIDTH ) ? MIN_SHEET_WIDTH : width;
|
|
height = ( height < MIN_SHEET_HEIGHT ) ? MIN_SHEET_HEIGHT : height;
|
|
|
|
if( sheet->HasPins() )
|
|
{
|
|
int gridSizeX = KiROUND( screen->GetGridSize().x );
|
|
int gridSizeY = KiROUND( screen->GetGridSize().y );
|
|
|
|
// If the sheet has pins, use the pin positions to clamp the minimum width and height.
|
|
height = ( height < sheet->GetMinHeight() + gridSizeY ) ?
|
|
sheet->GetMinHeight() + gridSizeY : height;
|
|
width = ( width < sheet->GetMinWidth() + gridSizeX ) ?
|
|
sheet->GetMinWidth() + gridSizeX : width;
|
|
}
|
|
|
|
wxPoint grid = aPanel->GetParent()->GetNearestGridPosition(
|
|
wxPoint( pos.x + width, pos.y + height ) );
|
|
sheet->Resize( wxSize( grid.x - pos.x, grid.y - pos.y ) );
|
|
|
|
auto panel = static_cast<SCH_DRAW_PANEL*>( aPanel );
|
|
auto view = panel->GetView();
|
|
|
|
view->Hide( sheet );
|
|
view->ClearPreview();
|
|
view->AddToPreview( sheet->Clone() );
|
|
}
|
|
|
|
|
|
// Complete sheet move.
|
|
static void ExitSheet( EDA_DRAW_PANEL* aPanel, wxDC* aDC )
|
|
{
|
|
SCH_SCREEN* screen = (SCH_SCREEN*) aPanel->GetScreen();
|
|
SCH_ITEM* item = screen->GetCurItem();
|
|
|
|
SCH_EDIT_FRAME* parent = (SCH_EDIT_FRAME*) aPanel->GetParent();
|
|
|
|
if( (item == NULL) || (item->Type() != SCH_SHEET_T) || (parent == NULL) )
|
|
return;
|
|
|
|
parent->SetRepeatItem( NULL );
|
|
|
|
if( item->IsNew() )
|
|
{
|
|
delete item;
|
|
}
|
|
else if( item->IsMoving() || item->IsResized() )
|
|
{
|
|
parent->RemoveFromScreen( item );
|
|
delete item;
|
|
|
|
item = parent->GetUndoItem();
|
|
|
|
wxCHECK_RET( item != NULL, wxT( "Cannot restore undefined last sheet item." ) );
|
|
|
|
parent->AddToScreen( item );
|
|
|
|
// the owner of item is no more parent, this is the draw list of screen:
|
|
parent->SetUndoItem( NULL );
|
|
|
|
item->ClearFlags();
|
|
}
|
|
else
|
|
{
|
|
item->ClearFlags();
|
|
}
|
|
|
|
auto panel = static_cast<SCH_DRAW_PANEL*>( aPanel );
|
|
auto view = panel->GetView();
|
|
view->ClearPreview();
|
|
|
|
screen->SetCurItem( NULL );
|
|
}
|
|
|
|
|
|
// Create hierarchy sheet.
|
|
SCH_SHEET* SCH_EDIT_FRAME::CreateSheet( wxDC* aDC )
|
|
{
|
|
SetRepeatItem( NULL );
|
|
|
|
SCH_SHEET* sheet = new SCH_SHEET( GetCrossHairPosition() );
|
|
|
|
sheet->SetFlags( IS_NEW | IS_RESIZED );
|
|
sheet->SetTimeStamp( GetNewTimeStamp() );
|
|
sheet->SetParent( GetScreen() );
|
|
sheet->SetScreen( NULL );
|
|
|
|
// need to check if this is being added to the GetDrawItems().
|
|
// also need to update the hierarchy, if we are adding
|
|
// a sheet to a screen that already has multiple instances (!)
|
|
GetScreen()->SetCurItem( sheet );
|
|
m_canvas->SetMouseCapture( resizeSheetWithMouseCursor, ExitSheet );
|
|
m_canvas->CallMouseCapture( aDC, wxDefaultPosition, false );
|
|
m_canvas->CrossHairOff( aDC );
|
|
|
|
SetCrossHairPosition( sheet->GetResizePosition() );
|
|
|
|
m_canvas->MoveCursorToCrossHair();
|
|
m_canvas->CrossHairOn( aDC );
|
|
|
|
return sheet;
|
|
}
|
|
|
|
|
|
void SCH_EDIT_FRAME::ReSizeSheet( SCH_SHEET* aSheet, wxDC* aDC )
|
|
{
|
|
if( aSheet == NULL || aSheet->IsNew() )
|
|
return;
|
|
|
|
wxCHECK_RET( aSheet->Type() == SCH_SHEET_T,
|
|
wxString::Format( wxT( "Cannot perform sheet resize on %s object." ),
|
|
GetChars( aSheet->GetClass() ) ) );
|
|
|
|
m_canvas->CrossHairOff( aDC );
|
|
SetCrossHairPosition( aSheet->GetResizePosition() );
|
|
m_canvas->MoveCursorToCrossHair();
|
|
m_canvas->CrossHairOn( aDC );
|
|
|
|
SetUndoItem( aSheet );
|
|
aSheet->SetFlags( IS_RESIZED );
|
|
|
|
std::vector<DANGLING_END_ITEM> emptySet;
|
|
aSheet->UpdateDanglingState( emptySet );
|
|
|
|
m_canvas->SetMouseCapture( resizeSheetWithMouseCursor, ExitSheet );
|
|
m_canvas->CallMouseCapture( aDC, wxDefaultPosition, true );
|
|
|
|
if( aSheet->IsNew() ) // not already in edit, save a copy for undo/redo
|
|
SetUndoItem( aSheet );
|
|
}
|
|
|
|
|
|
void SCH_EDIT_FRAME::RotateHierarchicalSheet( SCH_SHEET* aSheet, bool aRotCCW )
|
|
{
|
|
if( aSheet == NULL )
|
|
return;
|
|
|
|
// Save old sheet in undo list if not already in edit, or moving.
|
|
if( aSheet->GetFlags() == 0 )
|
|
SaveCopyInUndoList( aSheet, UR_CHANGED );
|
|
|
|
// Rotate the sheet on itself. Sheets do not have a anchor point.
|
|
// Rotation is made around it center
|
|
wxPoint rotPoint = aSheet->GetBoundingBox().Centre();
|
|
|
|
// Keep this rotation point on the grid, otherwise all items of this sheet
|
|
// will be moved off grid
|
|
rotPoint = GetNearestGridPosition( rotPoint );
|
|
|
|
// rotate CCW, or CW. to rotate CW, rotate 3 times
|
|
aSheet->Rotate( rotPoint );
|
|
|
|
if( !aRotCCW )
|
|
{
|
|
aSheet->Rotate( rotPoint );
|
|
aSheet->Rotate( rotPoint );
|
|
}
|
|
|
|
GetCanvas()->GetView()->Update( aSheet );
|
|
OnModify();
|
|
}
|
|
|
|
|
|
void SCH_EDIT_FRAME::MirrorSheet( SCH_SHEET* aSheet, bool aFromXaxis )
|
|
{
|
|
if( aSheet == NULL )
|
|
return;
|
|
|
|
// Save old sheet in undo list if not already in edit, or moving.
|
|
if( aSheet->GetFlags() == 0 )
|
|
SaveCopyInUndoList( aSheet, UR_CHANGED );
|
|
|
|
// Mirror the sheet on itself. Sheets do not have a anchor point.
|
|
// Mirroring is made around it center
|
|
wxPoint mirrorPoint = aSheet->GetBoundingBox().Centre();
|
|
|
|
if( aFromXaxis ) // mirror relative to Horizontal axis
|
|
aSheet->MirrorX( mirrorPoint.y );
|
|
else // Mirror relative to vertical axis
|
|
aSheet->MirrorY( mirrorPoint.x );
|
|
|
|
GetCanvas()->GetView()->Update( aSheet );
|
|
OnModify();
|
|
}
|
|
|
|
|
|
bool SCH_EDIT_FRAME::allowCaseSensitiveFileNameClashes( const wxString& aSchematicFileName )
|
|
{
|
|
wxString msg;
|
|
SCH_SCREENS screens;
|
|
wxFileName fn = aSchematicFileName;
|
|
|
|
wxCHECK( fn.IsAbsolute(), false );
|
|
|
|
if( m_showSheetFileNameCaseSensitivityDlg
|
|
&& screens.CanCauseCaseSensitivityIssue( aSchematicFileName ) )
|
|
{
|
|
msg.Printf( _( "The file name \"%s\" can cause issues with an existing file name\n"
|
|
"already defined in the schematic on systems that support case\n"
|
|
"insensitive file names. This will cause issues if you copy this\n"
|
|
"project to an operating system that supports case insensitive file\n"
|
|
"names.\n\nDo you wish to continue?" ),
|
|
fn.GetName() );
|
|
|
|
wxRichMessageDialog dlg( this, msg, _( "Warning" ),
|
|
wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
|
|
dlg.ShowCheckBox( _( "Do not show this message again." ) );
|
|
dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Create New Sheet" ) ),
|
|
wxMessageDialog::ButtonLabel( _( "Discard New Sheet" ) ) );
|
|
|
|
if( dlg.ShowModal() == wxID_NO )
|
|
return false;
|
|
|
|
m_showSheetFileNameCaseSensitivityDlg = !dlg.IsCheckBoxChecked();
|
|
}
|
|
|
|
return true;
|
|
}
|