44#include <wx/clipbrd.h>
45#include <wx/dcmemory.h>
51 wxASSERT( aSheet && aCurrentSheet );
59 if( destFilePath.IsEmpty() )
67 wxASSERT( wxFileName( destFilePath ).IsAbsolute() );
71 msg.Printf(
_(
"The sheet changes cannot be made because the destination sheet already "
72 "has the sheet '%s' or one of its subsheets as a parent somewhere in the "
73 "schematic hierarchy." ),
85 wxASSERT( aSheet && aSheet->
GetScreen() );
92 msg.Printf(
_(
"The schematic '%s' has not had its symbol library links remapped "
93 "to the symbol library table. The project this schematic belongs to "
94 "must first be remapped before it can be imported into the current "
165 const wxString& aFileName )
167 wxASSERT( aSheet && aCurrentSheet );
170 wxFileName currentSheetFileName;
171 bool libTableChanged =
false;
175 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
176 schFileType = SCH_IO_MGR::SCH_KICAD;
179 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &
Schematic() );
184 const_cast<KIID&
>( tmpSheet->m_Uuid ) = aSheet->
m_Uuid;
186 wxFileName fileName( aFileName );
188 if( !fileName.IsAbsolute() && !fileName.MakeAbsolute() )
190 wxFAIL_MSG( wxString::Format(
"Cannot make file name '%s' path absolute.", aFileName ) );
194 wxString fullFilename = fileName.GetFullPath();
200 tmpSheet.reset( pi->LoadSchematicFile( fullFilename, &
Schematic() ) );
204 tmpSheet->SetFileName( fullFilename );
205 pi->LoadSchematicFile( fullFilename, &
Schematic(), tmpSheet.get() );
208 if( !pi->GetError().IsEmpty() )
210 msg =
_(
"The entire schematic could not be loaded. Errors occurred attempting "
211 "to load hierarchical sheet schematics." );
213 wxMessageDialog msgDlg1(
this, msg,
_(
"Schematic Load Error" ),
214 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
215 wxCENTER | wxICON_QUESTION );
216 msgDlg1.SetOKLabel( wxMessageDialog::ButtonLabel(
_(
"Use partial schematic" ) ) );
217 msgDlg1.SetExtendedMessage( pi->GetError() );
219 if( msgDlg1.ShowModal() == wxID_CANCEL )
225 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFilename );
228 msg.Printf(
_(
"Failed to load '%s'." ), fullFilename );
236 if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() && tmpSheet->CountSheets() )
244 if( sheetPath.size() == 1 )
247 wxString lastSheetPath = fileName.GetPathWithSep();
249 for(
unsigned i = 1; i < sheetPath.size(); i++ )
252 wxCHECK2( sheet,
continue );
255 wxCHECK2( screen,
continue );
258 wxFileName loadedSheetFileName = screen->
GetFileName();
259 wxCHECK2( loadedSheetFileName.IsAbsolute(),
continue );
261 wxFileName tmp = loadedSheetFileName;
262 wxString sheetFileName;
264 if( tmp.MakeRelativeTo( lastSheetPath ) )
265 sheetFileName = tmp.GetFullPath();
267 sheetFileName = loadedSheetFileName.GetFullPath();
269 sheetFileName.Replace( wxT(
"\\" ), wxT(
"/" ) );
271 lastSheetPath = loadedSheetFileName.GetPath();
289 wxArrayString newLibNames;
295 wxMessageDialog::ButtonLabel okButtonLabel(
_(
"Continue Load" ) );
296 wxMessageDialog::ButtonLabel cancelButtonLabel(
_(
"Cancel Load" ) );
302 if( ( tmpSheet->GetScreen()->GetFileFormatVersionAtLoad() < 20221002 )
303 && tmpSheet->GetScreen()->GetSymbolInstances().empty() )
305 msg =
_(
"There are hierarchical sheets in the loaded schematic file from an older "
306 "file version resulting in missing symbol instance data. This will "
307 "result in all of the symbols in the loaded schematic to use either the "
308 "default instance setting or fall back to the library symbol settings. "
309 "Loading the project that uses this schematic file and saving to the "
310 "lastest file version will resolve this issue.\n\n"
311 "Do you wish to continue?" );
312 wxMessageDialog msgDlg7(
this, msg,
_(
"Continue Load Schematic" ),
313 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER | wxICON_QUESTION );
314 msgDlg7.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
316 if( msgDlg7.ShowModal() == wxID_CANCEL )
322 if( fileName.GetPathWithSep() ==
Prj().GetProjectPath() )
328 for(
const wxString&
name : names )
331 newLibNames.Add(
name );
334 if( !newLibNames.IsEmpty() )
336 msg =
_(
"There are library names in the selected schematic that are missing "
337 "from the current project library table. This may result in broken "
338 "symbol library references for the loaded schematic.\n\n"
339 "Do you wish to continue?" );
340 wxMessageDialog msgDlg3(
this, msg,
_(
"Continue Load Schematic" ),
341 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
342 wxCENTER | wxICON_QUESTION );
343 msgDlg3.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
345 if( msgDlg3.ShowModal() == wxID_CANCEL )
349 else if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() )
357 wxArrayString duplicateLibNames;
359 for(
const wxString&
name : names )
362 newLibNames.Add(
name );
364 duplicateLibNames.Add(
name );
368 wxFileName symLibTableFn( fileName.GetPath(),
373 if( !newLibNames.IsEmpty() || !duplicateLibNames.IsEmpty() )
375 if( !symLibTableFn.Exists() || !symLibTableFn.IsFileReadable() )
377 msg =
_(
"The selected file was created as part of a different project. "
378 "Linking the file to this project may result in missing or "
379 "incorrect symbol library references.\n\n"
380 "Do you wish to continue?" );
381 wxMessageDialog msgDlg4(
this, msg,
_(
"Continue Load Schematic" ),
382 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
383 wxCENTER | wxICON_QUESTION );
384 msgDlg4.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
386 if( msgDlg4.ShowModal() == wxID_CANCEL )
393 table.
Load( symLibTableFn.GetFullPath() );
397 msg.Printf(
_(
"Error loading the symbol library table '%s'." ),
398 symLibTableFn.GetFullPath() );
408 if( !newLibNames.IsEmpty() )
410 bool missingLibNames = table.
IsEmpty();
412 if( !missingLibNames )
414 for(
const wxString& newLibName : newLibNames )
418 missingLibNames =
true;
424 if( missingLibNames )
426 msg =
_(
"There are symbol library names in the selected schematic that "
427 "are missing from the selected schematic project library table. "
428 "This may result in broken symbol library references.\n\n"
429 "Do you wish to continue?" );
430 wxMessageDialog msgDlg5(
this, msg,
_(
"Continue Load Schematic" ),
431 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
432 wxCENTER | wxICON_QUESTION );
433 msgDlg5.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
435 if( msgDlg5.ShowModal() == wxID_CANCEL )
443 if( !duplicateLibNames.IsEmpty() && !table.
IsEmpty() )
445 bool libNameConflict =
false;
447 for(
const wxString& duplicateLibName : duplicateLibNames )
456 otherRow = table.
FindRow( duplicateLibName );
459 if( thisRow && !otherRow )
462 if( !thisRow || !otherRow )
465 wxFileName otherUriFileName;
466 wxString thisURI = thisRow->
GetFullURI(
true );
467 wxString otherURI = otherRow->
GetFullURI(
false);
469 if( otherURI.Contains(
"${KIPRJMOD}" ) || otherURI.Contains(
"$(KIPRJMOD)" ) )
473 otherUriFileName.SetPath( fileName.GetPath() );
474 otherUriFileName.SetFullName( otherURI.AfterLast(
'}' ) );
475 otherURI = otherUriFileName.GetFullPath();
478 if( thisURI != otherURI )
480 libNameConflict =
true;
485 if( libNameConflict )
487 msg =
_(
"A duplicate library name that references a different library exists "
488 "in the current library table. This conflict cannot be resolved and "
489 "may result in broken symbol library references.\n\n"
490 "Do you wish to continue?" );
491 wxMessageDialog msgDlg6(
this, msg,
_(
"Continue Load Schematic" ),
492 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
493 wxCENTER | wxICON_QUESTION );
494 msgDlg6.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
496 if( msgDlg6.ShowModal() == wxID_CANCEL )
504 if( !newLibNames.IsEmpty() && !table.
IsEmpty() )
506 for(
const wxString& libName : newLibNames )
516 wxString uri = table.
GetFullURI( libName,
false );
519 if( uri.Contains(
"${KIPRJMOD}" ) || uri.Contains(
"$(KIPRJMOD)" ) )
523 newLib.SetPath( fileName.GetPath() );
524 newLib.SetFullName( uri.AfterLast(
'}' ) );
525 uri = newLib.GetFullPath();
536 wxCHECK( row,
false );
544 libTableChanged =
true;
550 SCH_SCREEN* newScreen = tmpSheet->GetScreen();
551 wxCHECK_MSG( newScreen,
false,
"No screen defined for sheet." );
553 if( libTableChanged )
592 bool* aClearAnnotationNewItems,
593 bool* aUpdateHierarchyNavigator )
595 if( aSheet ==
nullptr || aHierarchy ==
nullptr )
600 aUpdateHierarchyNavigator );
602 if( dlg.ShowModal() == wxID_CANCEL )
623 double scale = ppi / inch2Iu;
625 wxSize dcsize = drawArea.GetSize();
627 int maxdim = std::max( dcsize.x, dcsize.y );
630 const int maxbitmapsize = 5600;
632 while(
int( maxdim *
scale ) > maxbitmapsize )
635 scale = ppi / inch2Iu;
649 wxBitmap
image( dcsize );
650 dc.SelectObject(
image );
669 dc.SelectObject( wxNullBitmap );
674 if( wxTheClipboard->Open() )
677 wxBitmapDataObject* clipbrd_data =
new wxBitmapDataObject(
image );
678 wxTheClipboard->SetData( clipbrd_data );
679 wxTheClipboard->Flush();
680 wxTheClipboard->Close();
695 wxFileName fn = aSchematicFileName;
697 wxCHECK( fn.IsAbsolute(),
false );
699 if(
eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog
702 msg.Printf(
_(
"The file name '%s' can cause issues with an existing file name\n"
703 "already defined in the schematic on systems that support case\n"
704 "insensitive file names. This will cause issues if you copy this\n"
705 "project to an operating system that supports case insensitive file\n"
706 "names.\n\nDo you wish to continue?" ),
709 wxRichMessageDialog dlg(
this, msg,
_(
"Warning" ),
710 wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
711 dlg.ShowCheckBox(
_(
"Do not show this message again." ) );
712 dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Create New Sheet" ) ),
713 wxMessageDialog::ButtonLabel(
_(
"Discard New Sheet" ) ) );
715 if( dlg.ShowModal() == wxID_NO )
719 !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)
Store schematic specific render settings.
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?
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
KIGFX::SCH_RENDER_SETTINGS * GetRenderSettings()
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 &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 CanCauseCaseSensitivityIssue(const wxString &aSchematicFileName) const
Check aSchematicFileName for a potential file name case sensitivity issue.
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.
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)
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath)
Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefix...
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.