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,
bool aSkipRecursionCheck,
170 wxASSERT( aSheet && aCurrentSheet );
173 wxFileName currentSheetFileName;
174 bool libTableChanged =
false;
178 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
179 schFileType = SCH_IO_MGR::SCH_KICAD;
182 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &
Schematic() );
187 const_cast<KIID&
>( tmpSheet->m_Uuid ) = aSheet->
m_Uuid;
189 wxFileName fileName( aFileName );
191 if( !fileName.IsAbsolute() && !fileName.MakeAbsolute() )
193 wxFAIL_MSG( wxString::Format(
"Cannot make file name '%s' path absolute.", aFileName ) );
197 wxString fullFilename = fileName.GetFullPath();
203 tmpSheet.reset( pi->LoadSchematicFile( fullFilename, &
Schematic() ) );
207 tmpSheet->SetFileName( fullFilename );
208 pi->LoadSchematicFile( fullFilename, &
Schematic(), tmpSheet.get() );
211 if( !pi->GetError().IsEmpty() )
213 msg =
_(
"The entire schematic could not be loaded. Errors occurred attempting "
214 "to load hierarchical sheet schematics." );
216 wxMessageDialog msgDlg1(
this, msg,
_(
"Schematic Load Error" ),
217 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
218 wxCENTER | wxICON_QUESTION );
219 msgDlg1.SetOKLabel( wxMessageDialog::ButtonLabel(
_(
"Use partial schematic" ) ) );
220 msgDlg1.SetExtendedMessage( pi->GetError() );
222 if( msgDlg1.ShowModal() == wxID_CANCEL )
228 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFilename );
231 msg.Printf(
_(
"Failed to load '%s'." ), fullFilename );
242 if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() )
250 for(
unsigned i = 0; i < sheetPath.size(); i++ )
253 wxCHECK2( sheet,
continue );
256 wxCHECK2( screen,
continue );
262 screenFileName.MakeRelativeTo( fileName.GetPath() );
263 screenFileName.MakeAbsolute(
Prj().GetProjectPath() );
264 screen->
SetFileName( screenFileName.GetFullPath() );
267 wxFileName loadedSheetFileName = screen->
GetFileName();
268 wxCHECK2( loadedSheetFileName.IsAbsolute(),
continue );
270 wxFileName tmp = loadedSheetFileName;
271 wxString sheetFileName;
273 if( tmp.MakeRelativeTo( lastSheetPath ) )
274 sheetFileName = tmp.GetFullPath();
276 sheetFileName = loadedSheetFileName.GetFullPath();
279 lastSheetPath = loadedSheetFileName.GetPath();
297 wxArrayString newLibNames;
303 wxMessageDialog::ButtonLabel okButtonLabel(
_(
"Continue Load" ) );
304 wxMessageDialog::ButtonLabel cancelButtonLabel(
_(
"Cancel Load" ) );
310 if( ( tmpSheet->GetScreen()->GetFileFormatVersionAtLoad() < 20221002 )
311 && tmpSheet->GetScreen()->GetSymbolInstances().empty() )
313 msg =
_(
"There are hierarchical sheets in the loaded schematic file from an older "
314 "file version resulting in missing symbol instance data. This will "
315 "result in all of the symbols in the loaded schematic to use either the "
316 "default instance setting or fall back to the library symbol settings. "
317 "Loading the project that uses this schematic file and saving to the "
318 "lastest file version will resolve this issue.\n\n"
319 "Do you wish to continue?" );
320 wxMessageDialog msgDlg7(
this, msg,
_(
"Continue Load Schematic" ),
321 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER | wxICON_QUESTION );
322 msgDlg7.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
324 if( msgDlg7.ShowModal() == wxID_CANCEL )
330 if( fileName.GetPathWithSep() ==
Prj().GetProjectPath() )
336 for(
const wxString&
name : names )
339 newLibNames.Add(
name );
342 if( !newLibNames.IsEmpty() )
344 msg =
_(
"There are library names in the selected schematic that are missing "
345 "from the current project library table. This may result in broken "
346 "symbol library references for the loaded schematic.\n\n"
347 "Do you wish to continue?" );
348 wxMessageDialog msgDlg3(
this, msg,
_(
"Continue Load Schematic" ),
349 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
350 wxCENTER | wxICON_QUESTION );
351 msgDlg3.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
353 if( msgDlg3.ShowModal() == wxID_CANCEL )
357 else if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() )
365 wxArrayString duplicateLibNames;
367 for(
const wxString&
name : names )
370 newLibNames.Add(
name );
372 duplicateLibNames.Add(
name );
376 wxFileName symLibTableFn( fileName.GetPath(),
381 if( !aSkipLibCheck && ( !newLibNames.IsEmpty() || !duplicateLibNames.IsEmpty() ) )
383 if( !symLibTableFn.Exists() || !symLibTableFn.IsFileReadable() )
385 msg =
_(
"The selected file was created as part of a different project. "
386 "Linking the file to this project may result in missing or "
387 "incorrect symbol library references.\n\n"
388 "Do you wish to continue?" );
389 wxMessageDialog msgDlg4(
this, msg,
_(
"Continue Load Schematic" ),
390 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER
392 msgDlg4.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
394 if( msgDlg4.ShowModal() == wxID_CANCEL )
401 table.
Load( symLibTableFn.GetFullPath() );
405 msg.Printf(
_(
"Error loading the symbol library table '%s'." ),
406 symLibTableFn.GetFullPath() );
416 if( !newLibNames.IsEmpty() )
418 bool missingLibNames = table.
IsEmpty();
420 if( !missingLibNames )
422 for(
const wxString& newLibName : newLibNames )
426 missingLibNames =
true;
432 if( missingLibNames )
434 msg =
_(
"There are symbol library names in the selected schematic that "
435 "are missing from the selected schematic project library table. "
436 "This may result in broken symbol library references.\n\n"
437 "Do you wish to continue?" );
438 wxMessageDialog msgDlg5(
this, msg,
_(
"Continue Load Schematic" ),
439 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
440 wxCENTER | wxICON_QUESTION );
441 msgDlg5.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
443 if( msgDlg5.ShowModal() == wxID_CANCEL )
451 if( !duplicateLibNames.IsEmpty() && !table.
IsEmpty() )
453 bool libNameConflict =
false;
455 for(
const wxString& duplicateLibName : duplicateLibNames )
464 otherRow = table.
FindRow( duplicateLibName );
467 if( thisRow && !otherRow )
470 if( !thisRow || !otherRow )
473 wxFileName otherUriFileName;
474 wxString thisURI = thisRow->
GetFullURI(
true );
475 wxString otherURI = otherRow->
GetFullURI(
false);
477 if( otherURI.Contains(
"${KIPRJMOD}" ) || otherURI.Contains(
"$(KIPRJMOD)" ) )
481 otherUriFileName.SetPath( fileName.GetPath() );
482 otherUriFileName.SetFullName( otherURI.AfterLast(
'}' ) );
483 otherURI = otherUriFileName.GetFullPath();
486 if( thisURI != otherURI )
488 libNameConflict =
true;
493 if( libNameConflict )
495 msg =
_(
"A duplicate library name that references a different library exists "
496 "in the current library table. This conflict cannot be resolved and "
497 "may result in broken symbol library references.\n\n"
498 "Do you wish to continue?" );
499 wxMessageDialog msgDlg6(
this, msg,
_(
"Continue Load Schematic" ),
500 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
501 wxCENTER | wxICON_QUESTION );
502 msgDlg6.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
504 if( msgDlg6.ShowModal() == wxID_CANCEL )
512 if( !newLibNames.IsEmpty() && !table.
IsEmpty() )
514 for(
const wxString& libName : newLibNames )
524 wxString uri = table.
GetFullURI( libName,
false );
527 if( uri.Contains(
"${KIPRJMOD}" ) || uri.Contains(
"$(KIPRJMOD)" ) )
531 newLib.SetPath( fileName.GetPath() );
532 newLib.SetFullName( uri.AfterLast(
'}' ) );
533 uri = newLib.GetFullPath();
544 wxCHECK( row,
false );
552 libTableChanged =
true;
558 SCH_SCREEN* newScreen = tmpSheet->GetScreen();
559 wxCHECK_MSG( newScreen,
false,
"No screen defined for sheet." );
561 if( libTableChanged )
600 bool* aIsUndoable,
bool* aClearAnnotationNewItems,
601 bool* aUpdateHierarchyNavigator )
603 if( aSheet ==
nullptr || aHierarchy ==
nullptr )
608 aUpdateHierarchyNavigator );
610 if( dlg.ShowModal() == wxID_CANCEL )
631 double scale = ppi / inch2Iu;
633 wxSize dcsize = drawArea.GetSize();
635 int maxdim = std::max( dcsize.x, dcsize.y );
638 const int maxbitmapsize = 5600;
640 while(
int( maxdim *
scale ) > maxbitmapsize )
643 scale = ppi / inch2Iu;
657 wxBitmap
image( dcsize );
658 dc.SelectObject(
image );
677 dc.SelectObject( wxNullBitmap );
682 if( wxTheClipboard->Open() )
685 wxBitmapDataObject* clipbrd_data =
new wxBitmapDataObject(
image );
686 wxTheClipboard->SetData( clipbrd_data );
687 wxTheClipboard->Flush();
688 wxTheClipboard->Close();
703 wxFileName fn = aSchematicFileName;
705 wxCHECK( fn.IsAbsolute(),
false );
707 auto can_cause_issues = [&]() ->
bool
710 wxFileName rhs = aSchematicFileName;
711 wxFileName old = aOldName;
712 wxString oldLower = old.GetFullName().Lower();
713 wxString rhsLower = rhs.GetFullName().Lower();
718 wxCHECK( rhs.IsAbsolute(),
false );
722 lhs = sheet.LastScreen()->GetFileName();
724 if( lhs.GetPath() != rhs.GetPath() )
727 lhsLower = lhs.GetFullName().Lower();
729 if( lhsLower == rhsLower && lhs.GetFullName() != rhs.GetFullName() )
735 if( oldLower == rhsLower )
741 if(
eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog && can_cause_issues() )
743 msg.Printf(
_(
"The file name '%s' can cause issues with an existing file name\n"
744 "already defined in the schematic on systems that support case\n"
745 "insensitive file names. This will cause issues if you copy this\n"
746 "project to an operating system that supports case insensitive file\n"
747 "names.\n\nDo you wish to continue?" ),
750 wxRichMessageDialog dlg(
this, msg,
_(
"Warning" ),
751 wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
752 dlg.ShowCheckBox(
_(
"Do not show this message again." ) );
753 dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Create New Sheet" ) ),
754 wxMessageDialog::ButtonLabel(
_(
"Cancel" ) ) );
756 if( dlg.ShowModal() == wxID_NO )
760 !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.
virtual const wxString GetProjectPath() const
Return the full path of the project.
SCH_SHEET_LIST BuildUnorderedSheetList() const
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 AllowCaseSensitiveFileNameClashes(const wxString &aOldName, const wxString &aSchematicFileName)
Check aSchematicFileName for a potential file name case sensitivity clashes.
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aIsUndoable=nullptr, bool *aClearAnnotationNewItems=nullptr, bool *aUpdateHierarchyNavigator=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
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)
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName, bool aSkipRecursionCheck=false, bool aSkipLibCheck=false)
Load a the KiCad schematic file aFileName into the sheet aSheet.
SCHEMATIC & Schematic() const
void DrawCurrentSheetToClipboard()
Use the wxWidgets print code to draw an image of the current sheet onto the clipboard.
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.