44#include <wx/clipbrd.h>
45#include <wx/dcmemory.h>
51 wxASSERT( aSheet && aHierarchy );
61 wxASSERT( destFile.IsAbsolute() );
65 msg.Printf(
_(
"The sheet changes cannot be made because the destination sheet already "
66 "has the sheet '%s' or one of its subsheets as a parent somewhere in the "
67 "schematic hierarchy." ),
68 destFile.GetFullPath() );
79 wxASSERT( aSheet && aSheet->
GetScreen() );
86 msg.Printf(
_(
"The schematic '%s' has not had its symbol library links remapped "
87 "to the symbol library table. The project this schematic belongs to "
88 "must first be remapped before it can be imported into the current "
108 const wxString& aFileName )
110 wxASSERT( aSheet && aHierarchy );
113 wxFileName currentSheetFileName;
114 bool libTableChanged =
false;
118 if( schFileType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
119 schFileType = SCH_IO_MGR::SCH_KICAD;
122 std::unique_ptr< SCH_SHEET> tmpSheet = std::make_unique<SCH_SHEET>( &
Schematic() );
127 const_cast<KIID&
>( tmpSheet->m_Uuid ) = aSheet->
m_Uuid;
129 wxFileName fileName( aFileName );
131 if( !fileName.IsAbsolute() && !fileName.MakeAbsolute() )
133 wxFAIL_MSG( wxString::Format(
"Cannot make file name '%s' path absolute.", aFileName ) );
137 wxString fullFilename = fileName.GetFullPath();
147 tmpSheet->SetFileName( fullFilename );
153 msg =
_(
"The entire schematic could not be loaded. Errors occurred attempting "
154 "to load hierarchical sheet schematics." );
156 wxMessageDialog msgDlg1(
this, msg,
_(
"Schematic Load Error" ),
157 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
158 wxCENTER | wxICON_QUESTION );
159 msgDlg1.SetOKLabel( wxMessageDialog::ButtonLabel(
_(
"Use partial schematic" ) ) );
160 msgDlg1.SetExtendedMessage( pi->
GetError() );
162 if( msgDlg1.ShowModal() == wxID_CANCEL )
168 msg.Printf(
_(
"Error loading schematic '%s'." ), fullFilename );
171 msg.Printf(
_(
"Failed to load '%s'." ), fullFilename );
179 if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() && tmpSheet->CountSheets() )
187 if( sheetPath.size() == 1 )
190 wxString lastSheetPath = fileName.GetPathWithSep();
192 for(
unsigned i = 1; i < sheetPath.size(); i++ )
195 wxCHECK2( sheet,
continue );
198 wxCHECK2( screen,
continue );
201 wxFileName loadedSheetFileName = screen->
GetFileName();
202 wxCHECK2( loadedSheetFileName.IsAbsolute(),
continue );
204 wxFileName tmp = loadedSheetFileName;
205 wxString sheetFileName;
207 if( tmp.MakeRelativeTo( lastSheetPath ) )
208 sheetFileName = tmp.GetFullPath();
210 sheetFileName = loadedSheetFileName.GetFullPath();
212 sheetFileName.Replace( wxT(
"\\" ), wxT(
"/" ) );
214 lastSheetPath = loadedSheetFileName.GetPath();
232 wxArrayString newLibNames;
238 wxMessageDialog::ButtonLabel okButtonLabel(
_(
"Continue Load" ) );
239 wxMessageDialog::ButtonLabel cancelButtonLabel(
_(
"Cancel Load" ) );
245 if( ( tmpSheet->GetScreen()->GetFileFormatVersionAtLoad() < 20221002 )
246 && tmpSheet->GetScreen()->GetSymbolInstances().empty() )
248 msg =
_(
"There are hierarchical sheets in the loaded schematic file from an older "
249 "file version resulting in missing symbol instance data. This will "
250 "result in all of the symbols in the loaded schematic to use either the "
251 "default instance setting or fall back to the library symbol settings. "
252 "Loading the project that uses this schematic file and saving to the "
253 "lastest file version will resolve this issue.\n\n"
254 "Do you wish to continue?" );
255 wxMessageDialog msgDlg7(
this, msg,
_(
"Continue Load Schematic" ),
256 wxOK | wxCANCEL | wxCANCEL_DEFAULT | wxCENTER | wxICON_QUESTION );
257 msgDlg7.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
259 if( msgDlg7.ShowModal() == wxID_CANCEL )
265 if( fileName.GetPathWithSep() ==
Prj().GetProjectPath() )
271 for(
const wxString&
name : names )
274 newLibNames.Add(
name );
277 if( !newLibNames.IsEmpty() )
279 msg =
_(
"There are library names in the selected schematic that are missing "
280 "from the current project library table. This may result in broken "
281 "symbol library references for the loaded schematic.\n\n"
282 "Do you wish to continue?" );
283 wxMessageDialog msgDlg3(
this, msg,
_(
"Continue Load Schematic" ),
284 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
285 wxCENTER | wxICON_QUESTION );
286 msgDlg3.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
288 if( msgDlg3.ShowModal() == wxID_CANCEL )
292 else if( fileName.GetPathWithSep() !=
Prj().GetProjectPath() )
300 wxArrayString duplicateLibNames;
302 for(
const wxString&
name : names )
305 newLibNames.Add(
name );
307 duplicateLibNames.Add(
name );
311 wxFileName symLibTableFn( fileName.GetPath(),
316 if( !newLibNames.IsEmpty() || !duplicateLibNames.IsEmpty() )
318 if( !symLibTableFn.Exists() || !symLibTableFn.IsFileReadable() )
320 msg =
_(
"The selected file was created as part of a different project. "
321 "Linking the file to this project may result in missing or "
322 "incorrect symbol library references.\n\n"
323 "Do you wish to continue?" );
324 wxMessageDialog msgDlg4(
this, msg,
_(
"Continue Load Schematic" ),
325 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
326 wxCENTER | wxICON_QUESTION );
327 msgDlg4.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
329 if( msgDlg4.ShowModal() == wxID_CANCEL )
336 table.
Load( symLibTableFn.GetFullPath() );
340 msg.Printf(
_(
"Error loading the symbol library table '%s'." ),
341 symLibTableFn.GetFullPath() );
351 if( !newLibNames.IsEmpty() )
353 bool missingLibNames = table.
IsEmpty();
355 if( !missingLibNames )
357 for(
const wxString& newLibName : newLibNames )
361 missingLibNames =
true;
367 if( missingLibNames )
369 msg =
_(
"There are symbol library names in the selected schematic that "
370 "are missing from the selected schematic project library table. "
371 "This may result in broken symbol library references.\n\n"
372 "Do you wish to continue?" );
373 wxMessageDialog msgDlg5(
this, msg,
_(
"Continue Load Schematic" ),
374 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
375 wxCENTER | wxICON_QUESTION );
376 msgDlg5.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
378 if( msgDlg5.ShowModal() == wxID_CANCEL )
386 if( !duplicateLibNames.IsEmpty() && !table.
IsEmpty() )
388 bool libNameConflict =
false;
390 for(
const wxString& duplicateLibName : duplicateLibNames )
399 otherRow = table.
FindRow( duplicateLibName );
402 if( thisRow && !otherRow )
405 if( !thisRow || !otherRow )
408 wxFileName otherUriFileName;
409 wxString thisURI = thisRow->
GetFullURI(
true );
410 wxString otherURI = otherRow->
GetFullURI(
false);
412 if( otherURI.Contains(
"${KIPRJMOD}" ) || otherURI.Contains(
"$(KIPRJMOD)" ) )
416 otherUriFileName.SetPath( fileName.GetPath() );
417 otherUriFileName.SetFullName( otherURI.AfterLast(
'}' ) );
418 otherURI = otherUriFileName.GetFullPath();
421 if( thisURI != otherURI )
423 libNameConflict =
true;
428 if( libNameConflict )
430 msg =
_(
"A duplicate library name that references a different library exists "
431 "in the current library table. This conflict cannot be resolved and "
432 "may result in broken symbol library references.\n\n"
433 "Do you wish to continue?" );
434 wxMessageDialog msgDlg6(
this, msg,
_(
"Continue Load Schematic" ),
435 wxOK | wxCANCEL | wxCANCEL_DEFAULT |
436 wxCENTER | wxICON_QUESTION );
437 msgDlg6.SetOKCancelLabels( okButtonLabel, cancelButtonLabel );
439 if( msgDlg6.ShowModal() == wxID_CANCEL )
447 if( !newLibNames.IsEmpty() && !table.
IsEmpty() )
449 for(
const wxString& libName : newLibNames )
459 wxString uri = table.
GetFullURI( libName,
false );
462 if( uri.Contains(
"${KIPRJMOD}" ) || uri.Contains(
"$(KIPRJMOD)" ) )
466 newLib.SetPath( fileName.GetPath() );
467 newLib.SetFullName( uri.AfterLast(
'}' ) );
468 uri = newLib.GetFullPath();
479 wxCHECK( row,
false );
487 libTableChanged =
true;
493 SCH_SCREEN* newScreen = tmpSheet->GetScreen();
494 wxCHECK_MSG( newScreen,
false,
"No screen defined for sheet." );
496 if( libTableChanged )
535 bool* aClearAnnotationNewItems )
537 if( aSheet ==
nullptr || aHierarchy ==
nullptr )
543 if( dlg.ShowModal() == wxID_CANCEL )
562 double scale = ppi / inch2Iu;
564 wxSize dcsize = drawArea.GetSize();
566 int maxdim = std::max( dcsize.x, dcsize.y );
569 const int maxbitmapsize = 5600;
571 while(
int( maxdim *
scale ) > maxbitmapsize )
574 scale = ppi / inch2Iu;
588 wxBitmap
image( dcsize );
589 dc.SelectObject(
image );
608 dc.SelectObject( wxNullBitmap );
613 if( wxTheClipboard->Open() )
616 wxBitmapDataObject* clipbrd_data =
new wxBitmapDataObject(
image );
617 wxTheClipboard->SetData( clipbrd_data );
618 wxTheClipboard->Flush();
619 wxTheClipboard->Close();
634 wxFileName fn = aSchematicFileName;
636 wxCHECK( fn.IsAbsolute(),
false );
638 if(
eeconfig()->m_Appearance.show_sheet_filename_case_sensitivity_dialog
641 msg.Printf(
_(
"The file name '%s' can cause issues with an existing file name\n"
642 "already defined in the schematic on systems that support case\n"
643 "insensitive file names. This will cause issues if you copy this\n"
644 "project to an operating system that supports case insensitive file\n"
645 "names.\n\nDo you wish to continue?" ),
648 wxRichMessageDialog dlg(
this, msg,
_(
"Warning" ),
649 wxYES_NO | wxNO_DEFAULT | wxICON_QUESTION );
650 dlg.ShowCheckBox(
_(
"Do not show this message again." ) );
651 dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel(
_(
"Create New Sheet" ) ),
652 wxMessageDialog::ButtonLabel(
_(
"Discard New Sheet" ) ) );
654 if( dlg.ShowModal() == wxID_NO )
658 !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.
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()
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, 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)
bool CheckSheetForRecursion(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy)
Verify that aSheet will not cause a recursion error in aHierarchy.
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 EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aClearAnnotationNewItems)
Edit an existing sheet or add a new sheet to the schematic.
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.
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
virtual const wxString & GetError() const
Return an error string to the caller.
virtual SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr)
Load information from some input file format that this SCH_PLUGIN implementation knows about,...
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 Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
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
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_PLUGIN obje...
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...
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)
@ 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.