44#include <wx/clipbrd.h>
45#include <wx/dcmemory.h>
48#include <wx/richmsgdlg.h>
53 wxASSERT( aSheet && aCurrentSheet );
61 if( destFilePath.IsEmpty() )
69 wxASSERT( wxFileName( destFilePath ).IsAbsolute() );
73 msg.Printf(
_(
"The sheet changes cannot be made because the destination sheet already "
74 "has the sheet '%s' or one of its subsheets as a parent somewhere in the "
75 "schematic hierarchy." ),
87 wxASSERT( aSheet && aSheet->
GetScreen() );
94 msg.Printf(
_(
"The schematic '%s' has not had its symbol library links remapped "
95 "to the symbol library table. The project this schematic belongs to "
96 "must first be remapped before it can be imported into the current "
167 const wxString& aFileName )
169 wxASSERT( aSheet && aCurrentSheet );
172 wxFileName currentSheetFileName;
173 bool libTableChanged =
false;
177 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
178 schFileType = SCH_IO_MGR::SCH_KICAD;
181 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &
Schematic() );
186 const_cast<KIID&
>( tmpSheet->m_Uuid ) = aSheet->
m_Uuid;
188 wxFileName fileName( aFileName );
190 if( !fileName.IsAbsolute() && !fileName.MakeAbsolute() )
192 wxFAIL_MSG( wxString::Format(
"Cannot make file name '%s' path absolute.", aFileName ) );
196 wxString fullFilename = fileName.GetFullPath();
202 tmpSheet.reset( pi->LoadSchematicFile( fullFilename, &
Schematic() ) );
206 tmpSheet->SetFileName( fullFilename );
207 pi->LoadSchematicFile( fullFilename, &
Schematic(), tmpSheet.get() );
210 if( !pi->GetError().IsEmpty() )
212 msg =
_(
"The entire schematic could not be loaded. Errors occurred attempting "
213 "to load hierarchical sheet schematics." );
215 wxMessageDialog msgDlg1(
this, msg,
_(
"Schematic Load Error" ),
216 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
217 wxCENTER | wxICON_QUESTION );
218 msgDlg1.SetOKLabel( wxMessageDialog::ButtonLabel(
_(
"Use partial schematic" ) ) );
219 msgDlg1.SetExtendedMessage( pi->GetError() );
221 if( msgDlg1.ShowModal() == wxID_CANCEL )
227 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFilename );
230 msg.Printf(
_(
"Failed to load '%s'." ), fullFilename );
238 if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() && tmpSheet->CountSheets() )
246 if( sheetPath.size() == 1 )
249 wxString lastSheetPath = fileName.GetPathWithSep();
251 for(
unsigned i = 1; i < sheetPath.size(); i++ )
254 wxCHECK2( sheet,
continue );
257 wxCHECK2( screen,
continue );
260 wxFileName loadedSheetFileName = screen->
GetFileName();
261 wxCHECK2( loadedSheetFileName.IsAbsolute(),
continue );
263 wxFileName tmp = loadedSheetFileName;
264 wxString sheetFileName;
266 if( tmp.MakeRelativeTo( lastSheetPath ) )
267 sheetFileName = tmp.GetFullPath();
269 sheetFileName = loadedSheetFileName.GetFullPath();
271 sheetFileName.Replace( wxT(
"\\" ), wxT(
"/" ) );
273 lastSheetPath = loadedSheetFileName.GetPath();
291 wxArrayString newLibNames;
297 wxMessageDialog::ButtonLabel okButtonLabel(
_(
"Continue Load" ) );
298 wxMessageDialog::ButtonLabel cancelButtonLabel(
_(
"Cancel Load" ) );
304 if( ( tmpSheet->GetScreen()->GetFileFormatVersionAtLoad() < 20221002 )
305 && tmpSheet->GetScreen()->GetSymbolInstances().empty() )
307 msg =
_(
"There are hierarchical sheets in the loaded schematic file from an older "
308 "file version resulting in missing symbol instance data. This will "
309 "result in all of the symbols in the loaded schematic to use either the "
310 "default instance setting or fall back to the library symbol settings. "
311 "Loading the project that uses this schematic file and saving to the "
312 "lastest file version will resolve this issue.\n\n"
313 "Do you wish to continue?" );
314 wxMessageDialog msgDlg7(
this, msg,
_(
"Continue Load Schematic" ),
315 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER | wxICON_QUESTION );
316 msgDlg7.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
318 if( msgDlg7.ShowModal() == wxID_CANCEL )
324 if( fileName.GetPathWithSep() ==
Prj().GetProjectPath() )
330 for(
const wxString&
name : names )
333 newLibNames.Add(
name );
336 if( !newLibNames.IsEmpty() )
338 msg =
_(
"There are library names in the selected schematic that are missing "
339 "from the current project library table. This may result in broken "
340 "symbol library references for the loaded schematic.\n\n"
341 "Do you wish to continue?" );
342 wxMessageDialog msgDlg3(
this, msg,
_(
"Continue Load Schematic" ),
343 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
344 wxCENTER | wxICON_QUESTION );
345 msgDlg3.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
347 if( msgDlg3.ShowModal() == wxID_CANCEL )
351 else if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() )
359 wxArrayString duplicateLibNames;
361 for(
const wxString&
name : names )
364 newLibNames.Add(
name );
366 duplicateLibNames.Add(
name );
370 wxFileName symLibTableFn( fileName.GetPath(),
375 if( !newLibNames.IsEmpty() || !duplicateLibNames.IsEmpty() )
377 if( !symLibTableFn.Exists() || !symLibTableFn.IsFileReadable() )
379 msg =
_(
"The selected file was created as part of a different project. "
380 "Linking the file to this project may result in missing or "
381 "incorrect symbol library references.\n\n"
382 "Do you wish to continue?" );
383 wxMessageDialog msgDlg4(
this, msg,
_(
"Continue Load Schematic" ),
384 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
385 wxCENTER | wxICON_QUESTION );
386 msgDlg4.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
388 if( msgDlg4.ShowModal() == wxID_CANCEL )
395 table.
Load( symLibTableFn.GetFullPath() );
399 msg.Printf(
_(
"Error loading the symbol library table '%s'." ),
400 symLibTableFn.GetFullPath() );
410 if( !newLibNames.IsEmpty() )
412 bool missingLibNames = table.
IsEmpty();
414 if( !missingLibNames )
416 for(
const wxString& newLibName : newLibNames )
420 missingLibNames =
true;
426 if( missingLibNames )
428 msg =
_(
"There are symbol library names in the selected schematic that "
429 "are missing from the selected schematic project library table. "
430 "This may result in broken symbol library references.\n\n"
431 "Do you wish to continue?" );
432 wxMessageDialog msgDlg5(
this, msg,
_(
"Continue Load Schematic" ),
433 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
434 wxCENTER | wxICON_QUESTION );
435 msgDlg5.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
437 if( msgDlg5.ShowModal() == wxID_CANCEL )
445 if( !duplicateLibNames.IsEmpty() && !table.
IsEmpty() )
447 bool libNameConflict =
false;
449 for(
const wxString& duplicateLibName : duplicateLibNames )
458 otherRow = table.
FindRow( duplicateLibName );
461 if( thisRow && !otherRow )
464 if( !thisRow || !otherRow )
467 wxFileName otherUriFileName;
468 wxString thisURI = thisRow->
GetFullURI(
true );
469 wxString otherURI = otherRow->
GetFullURI(
false);
471 if( otherURI.Contains(
"${KIPRJMOD}" ) || otherURI.Contains(
"$(KIPRJMOD)" ) )
475 otherUriFileName.SetPath( fileName.GetPath() );
476 otherUriFileName.SetFullName( otherURI.AfterLast(
'}' ) );
477 otherURI = otherUriFileName.GetFullPath();
480 if( thisURI != otherURI )
482 libNameConflict =
true;
487 if( libNameConflict )
489 msg =
_(
"A duplicate library name that references a different library exists "
490 "in the current library table. This conflict cannot be resolved and "
491 "may result in broken symbol library references.\n\n"
492 "Do you wish to continue?" );
493 wxMessageDialog msgDlg6(
this, msg,
_(
"Continue Load Schematic" ),
494 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
495 wxCENTER | wxICON_QUESTION );
496 msgDlg6.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
498 if( msgDlg6.ShowModal() == wxID_CANCEL )
506 if( !newLibNames.IsEmpty() && !table.
IsEmpty() )
508 for(
const wxString& libName : newLibNames )
518 wxString uri = table.
GetFullURI( libName,
false );
521 if( uri.Contains(
"${KIPRJMOD}" ) || uri.Contains(
"$(KIPRJMOD)" ) )
525 newLib.SetPath( fileName.GetPath() );
526 newLib.SetFullName( uri.AfterLast(
'}' ) );
527 uri = newLib.GetFullPath();
538 wxCHECK( row,
false );
546 libTableChanged =
true;
552 SCH_SCREEN* newScreen = tmpSheet->GetScreen();
553 wxCHECK_MSG( newScreen,
false,
"No screen defined for sheet." );
555 if( libTableChanged )
594 bool* aClearAnnotationNewItems,
595 bool* aUpdateHierarchyNavigator )
597 if( aSheet ==
nullptr || aHierarchy ==
nullptr )
602 aUpdateHierarchyNavigator );
604 if( dlg.ShowModal() == wxID_CANCEL )
625 double scale = ppi / inch2Iu;
627 wxSize dcsize = drawArea.GetSize();
629 int maxdim = std::max( dcsize.x, dcsize.y );
632 const int maxbitmapsize = 5600;
634 while(
int( maxdim *
scale ) > maxbitmapsize )
637 scale = ppi / inch2Iu;
651 wxBitmap
image( dcsize );
652 dc.SelectObject(
image );
671 dc.SelectObject( wxNullBitmap );
676 if( wxTheClipboard->Open() )
679 wxBitmapDataObject* clipbrd_data =
new wxBitmapDataObject(
image );
680 wxTheClipboard->SetData( clipbrd_data );
681 wxTheClipboard->Flush();
682 wxTheClipboard->Close();
697 wxFileName fn = aSchematicFileName;
699 wxCHECK( fn.IsAbsolute(),
false );
701 auto can_cause_issues = [&]() ->
bool
704 wxFileName rhs = aSchematicFileName;
705 wxFileName old = aOldName;
706 wxString oldLower = old.GetFullName().Lower();
707 wxString rhsLower = rhs.GetFullName().Lower();
712 wxCHECK( rhs.IsAbsolute(),
false );
716 lhs = sheet.LastScreen()->GetFileName();
718 if( lhs.GetPath() != rhs.GetPath() )
721 lhsLower = lhs.GetFullName().Lower();
723 if( lhsLower == rhsLower && lhs.GetFullName() != rhs.GetFullName() )
729 if( oldLower == rhsLower )
735 if(
eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog && can_cause_issues() )
737 msg.Printf(
_(
"The file name '%s' can cause issues with an existing file name\n"
738 "already defined in the schematic on systems that support case\n"
739 "insensitive file names. This will cause issues if you copy this\n"
740 "project to an operating system that supports case insensitive file\n"
741 "names.\n\nDo you wish to continue?" ),
744 wxRichMessageDialog dlg(
this, msg,
_(
"Warning" ),
745 wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
746 dlg.ShowCheckBox(
_(
"Do not show this message again." ) );
747 dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Create New Sheet" ) ),
748 wxMessageDialog::ButtonLabel(
_(
"Cancel" ) ) );
750 if( dlg.ShowModal() == wxID_NO )
754 !dlg.IsCheckBoxChecked();
constexpr EDA_IU_SCALE schIUScale
Handles how to draw a screen (a board, a schematic ...)
VECTOR2I m_DrawOrg
offsets for drawing the circuit on the screen
VECTOR2I m_StartVisu
Coordinates in drawing units of the current view position (upper left corner of device)
void SetContentModified(bool aModified=true)
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
PAGE_SETTINGS m_PageSettings
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Change the color used to draw a layer.
void SetDefaultFont(const wxString &aFont)
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
void SetPrintDC(wxDC *aDC)
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
const wxString & GetDescr() const
Return the description of the library referenced by this row.
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
bool IsEmpty(bool aIncludeFallback=true)
Return true if the table is empty.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
SCH_RENDER_SETTINGS * GetRenderSettings()
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
EESCHEMA_SETTINGS * eeconfig() const
const PAGE_INFO & GetPageSettings() const override
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName)
Load a the KiCad schematic file aFileName into the sheet aSheet.
bool AllowCaseSensitiveFileNameClashes(const wxString &aOldName, const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void InitSheet(SCH_SHEET *aSheet, const wxString &aNewFilename)
SCHEMATIC & Schematic() const
void DrawCurrentSheetToClipboard()
Use the wxWidgets print code to draw an image of the current sheet onto the clipboard.
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aClearAnnotationNewItems, bool *aUpdateHierarchyNavigator=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
bool checkForNoFullyDefinedLibIds(SCH_SHEET *aSheet)
Verify that the symbol library links aSheet and all of its child sheets have been remapped to the sym...
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet)
Verify that aSheet will not cause a recursion error in aCurrentSheet.
virtual void PrintPage(const RENDER_SETTINGS *aSettings) override
Plot or print the current sheet to the clipboard.
static SCH_FILE_T GuessPluginTypeFromSchPath(const wxString &aSchematicPath, int aCtl=0)
Return a plugin type given a schematic using the file extension of aSchematicPath.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
bool HasNoFullyDefinedLibIds()
Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set.
int ReplaceDuplicateTimeStamps()
Test all sheet and symbol objects in the schematic for duplicate time stamps and replaces them as nec...
bool HasSchematic(const wxString &aSchematicFileName)
Check if one of the schematics in the list of screens is aSchematicFileName.
size_t GetLibNicknames(wxArrayString &aLibNicknames)
Fetch all of the symbol library nicknames into aLibNicknames.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
void SetPageSettings(const PAGE_INFO &aPageSettings)
const wxString & GetFileName() const
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
const std::vector< SCH_SYMBOL_INSTANCE > & GetSymbolInstances() const
int GetFileFormatVersionAtLoad() const
const TITLE_BLOCK & GetTitleBlock() const
void MigrateSimModels()
Migrate any symbols having V6 simulation models to their V7 equivalents.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefix...
int GetLastVirtualPageNumber() const
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
void AddNewSheetInstances(const SCH_SHEET_PATH &aPrefixSheetPath, int aLastVirtualPageNumber)
bool TestForRecursion(const SCH_SHEET_LIST &aSrcSheetHierarchy, const wxString &aDestFileName)
Test every SCH_SHEET_PATH in this SCH_SHEET_LIST to verify if adding the sheets stored in aSrcSheetHi...
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SCREEN * LastScreen()
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetFileName(const wxString &aFilename)
SCH_SCREEN * GetScreen() const
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_IO object i...
const wxString GetType() const override
Return the type of symbol library table represented by this row.
static const wxString & GetSymbolLibTableFileName()
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold the information shown in the lower right corner of a plot, printout, or editing view.
const wxString & GetCompany() const
void SetRevision(const wxString &aRevision)
void SetComment(int aIdx, const wxString &aComment)
const wxString & GetRevision() const
void SetTitle(const wxString &aTitle)
const wxString & GetDate() const
const wxString & GetComment(int aIdx) const
void SetCompany(const wxString &aCompany)
const wxString & GetTitle() const
void SetDate(const wxString &aDate)
Set the date field, and defaults to the current time and date.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
void GRForceBlackPen(bool flagforce)
void GRResetPenAndBrush(wxDC *DC)
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
@ LAYER_SCHEMATIC_DRAWINGSHEET
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
bool show_sheet_filename_case_sensitivity_dialog
wxSize ToWxSize(const VECTOR2I &aSize)
Definition of file extensions used in Kicad.