48#include <wx/filedlg.h>
49#include <wx/hyperlink.h>
74 m_markerTreeModel( nullptr ),
77 m_centerMarkerOnIdle( nullptr ),
108 { wxID_CANCEL,
_(
"Close" ) } } );
142 wxASSERT( settings );
158 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl(
m_infoBar, wxID_ANY,
159 _(
"Show Annotation dialog" ),
162 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
163 [&]( wxHyperlinkEvent& aEvent )
165 wxHtmlLinkEvent htmlEvent( aEvent.GetId(),
166 wxHtmlLinkInfo( aEvent.GetURL() ) );
173 "ERC results will be incomplete." ) );
231 bool markersOverflowed =
false;
240 num.Printf( markersOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numMarkers );
246 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
259 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
295 bool includeExclusions =
false;
301 if( numExcluded > 0 )
303 wxMessageDialog dlg(
this,
_(
"Delete exclusions too?" ),
_(
"Delete All Markers" ),
304 wxYES_NO | wxCANCEL | wxCENTER | wxICON_QUESTION );
305 dlg.SetYesNoLabels(
_(
"Errors and Warnings Only" ),
306 _(
"Errors, Warnings and Exclusions" ) );
308 int ret = dlg.ShowModal();
310 if( ret == wxID_CANCEL )
312 else if( ret == wxID_NO )
313 includeExclusions =
true;
345 wxCommandEvent* evt =
new wxCommandEvent( EDA_EVT_CLOSE_ERC_DIALOG, wxID_ANY );
347 wxWindow* parent = GetParent();
350 wxQueueEvent( parent, evt );
371 wxCommandEvent
dummy;
390 for( std::reference_wrapper<RC_ITEM>& item : violations )
395 wxT(
" • " ) + item.get().GetErrorText() );
421 ercItem->SetErrorMessage( aMsg );
426 ercItem->SetItems( aItemA->
GetSymbol() );
434 if( itemsNotAnnotated )
521 else if( item && item->
GetClass() != wxT(
"DELETED_SHEET_ITEM" ) )
528 std::shared_ptr<ERC_ITEM> ercItem =
529 std::static_pointer_cast<ERC_ITEM>( node->
m_RcItem );
533 if( ercItem->IsSheetSpecific() )
534 sheet = ercItem->GetSpecificSheetPath();
537 if( ercItem->MainItemHasSheetPath() )
538 sheet = ercItem->GetMainItemSheetPath();
541 if( ercItem->AuxItemHasSheetPath() )
542 sheet = ercItem->GetAuxItemSheetPath();
571 if( aEvent.GetItem().IsOk() )
594 std::shared_ptr<RC_ITEM> rcItem = node->m_RcItem;
598 switch( settings.
GetSeverity( rcItem->GetErrorCode() ) )
602 default: listName =
_(
"appropriate" );
break;
607 ID_EDIT_EXCLUSION_COMMENT = 4467,
609 ID_REMOVE_EXCLUSION_ALL,
611 ID_ADD_EXCLUSION_ALL,
612 ID_INSPECT_VIOLATION,
613 ID_EDIT_PIN_CONFLICT_MAP,
614 ID_EDIT_CONNECTION_GRID,
615 ID_SET_SEVERITY_TO_ERROR,
616 ID_SET_SEVERITY_TO_WARNING,
617 ID_SET_SEVERITY_TO_IGNORE,
621 if( rcItem->GetParent()->IsExcluded() )
623 menu.Append( ID_EDIT_EXCLUSION_COMMENT,
624 _(
"Edit exclusion comment..." ) );
626 menu.Append( ID_REMOVE_EXCLUSION,
627 _(
"Remove exclusion for this violation" ),
628 wxString::Format(
_(
"It will be placed back in the %s list" ), listName ) );
632 menu.Append( ID_ADD_EXCLUSION,
633 _(
"Exclude this violation..." ),
634 wxString::Format(
_(
"It will be excluded from the %s list" ), listName ) );
639 if( !inspectERCErrorMenuText.IsEmpty() )
640 menu.Append( ID_INSPECT_VIOLATION, inspectERCErrorMenuText );
642 menu.AppendSeparator();
651 menu.Append( ID_SET_SEVERITY_TO_ERROR,
652 wxString::Format(
_(
"Change severity to Error for all '%s' violations" ),
653 rcItem->GetErrorText() ),
654 _(
"Violation severities can also be edited in the Schematic Setup... dialog" ) );
658 menu.Append( ID_SET_SEVERITY_TO_WARNING,
659 wxString::Format(
_(
"Change severity to Warning for all '%s' violations" ),
660 rcItem->GetErrorText() ),
661 _(
"Violation severities can also be edited in the Schematic Setup... dialog" ) );
664 menu.Append( ID_SET_SEVERITY_TO_IGNORE,
665 wxString::Format(
_(
"Ignore all '%s' violations" ), rcItem->GetErrorText() ),
666 _(
"Violations will not be checked or reported" ) );
668 menu.AppendSeparator();
673 menu.Append( ID_EDIT_PIN_CONFLICT_MAP,
674 _(
"Edit pin-to-pin conflict map..." ),
675 _(
"Open the Schematic Setup... dialog" ) );
679 menu.Append( ID_EDIT_SEVERITIES,
680 _(
"Edit violation severities..." ),
681 _(
"Open the Schematic Setup... dialog" ) );
686 menu.Append( ID_EDIT_CONNECTION_GRID,
687 _(
"Edit connection grid spacing..." ),
688 _(
"Open the Schematic Setup... dialog" ) );
691 bool modified =
false;
693 switch( GetPopupMenuSelectionFromUser( menu ) )
695 case ID_EDIT_EXCLUSION_COMMENT:
699 marker->GetComment(),
true );
701 if( dlg.ShowModal() == wxID_CANCEL )
704 marker->SetExcluded(
true, dlg.
GetValue() );
707 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
713 case ID_REMOVE_EXCLUSION:
716 marker->SetExcluded(
false );
720 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
726 case ID_ADD_EXCLUSION:
730 wxEmptyString,
true );
732 if( dlg.ShowModal() == wxID_CANCEL )
735 marker->SetExcluded(
true, dlg.
GetValue() );
741 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
743 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->DeleteCurrentItem(
false );
750 case ID_INSPECT_VIOLATION:
754 case ID_SET_SEVERITY_TO_ERROR:
761 if( marker->
GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
770 case ID_SET_SEVERITY_TO_WARNING:
777 if( marker->
GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
786 case ID_SET_SEVERITY_TO_IGNORE:
806 case ID_EDIT_PIN_CONFLICT_MAP:
810 case ID_EDIT_SEVERITIES:
814 case ID_EDIT_CONNECTION_GRID:
879 if( marker !=
nullptr )
918 if( aEvent.GetEventObject() ==
m_showAll )
927 if( aEvent.IsChecked() )
929 else if( aEvent.GetEventObject() ==
m_showAll )
957 wxFileDialog dlg(
this,
_(
"Save Report File" ),
Prj().GetProjectPath(), fn.GetFullName(),
959 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
961 if( dlg.ShowModal() != wxID_OK )
966 if( fn.GetExt().IsEmpty() )
969 if( !fn.IsAbsolute() )
972 fn.MakeAbsolute( prj_path );
977 bool success =
false;
986 fn.GetFullPath() ) );
990 DisplayError(
this, wxString::Format(
_(
"Failed to create file '%s'." ),
991 fn.GetFullPath() ) );
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static TOOL_ACTION cancelInteractive
VECTOR2D m_ScrollCenter
Current scroll center point in logical units.
wxButton * m_sdbSizer1Cancel
wxSimplebook * m_runningResultsBook
wxCheckBox * m_showExclusions
NUMBER_BADGE * m_errorsBadge
wxCheckBox * m_showErrors
NUMBER_BADGE * m_exclusionsBadge
wxListCtrl * m_ignoredList
WX_HTML_REPORT_BOX * m_messages
wxDataViewCtrl * m_markerDataView
wxButton * m_deleteAllMarkers
NUMBER_BADGE * m_warningsBadge
wxButton * m_deleteOneMarker
wxCheckBox * m_showWarnings
void ExcludeMarker(SCH_MARKER *aMarker=nullptr)
Exclude aMarker from the ERC list.
const SCH_MARKER * m_centerMarkerOnIdle
void OnERCItemDClick(wxDataViewEvent &aEvent) override
std::shared_ptr< RC_ITEMS_PROVIDER > m_markerProvider
DIALOG_ERC(SCH_EDIT_FRAME *parent)
void SelectMarker(const SCH_MARKER *aMarker)
SCH_EDIT_FRAME * m_parent
wxString m_violationsTitleTemplate
void OnERCItemRClick(wxDataViewEvent &aEvent) override
void centerMarkerIdleHandler(wxIdleEvent &aEvent)
void OnDeleteAllClick(wxCommandEvent &event) override
void OnLinkClicked(wxHtmlLinkEvent &event) override
void OnRunERCClick(wxCommandEvent &event) override
void deleteAllMarkers(bool aIncludeExclusions)
wxString m_ignoredTitleTemplate
void OnDeleteOneClick(wxCommandEvent &event) override
void OnSaveReport(wxCommandEvent &aEvent) override
SCHEMATIC * m_currentSchematic
void OnEditViolationSeverities(wxHyperlinkEvent &aEvent) override
void UpdateAnnotationWarning()
void Report(const wxString &aMessage) override
Display aMessage in the progress bar dialog.
void OnERCItemSelected(wxDataViewEvent &aEvent) override
RC_TREE_MODEL * m_markerTreeModel
void updateDisplayedCounts()
void OnSeverity(wxCommandEvent &aEvent) override
void OnCloseErcDialog(wxCloseEvent &event) override
void OnCancelClick(wxCommandEvent &event) override
bool Show(bool show) override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
bool IsQuasiModal() const
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
static TOOL_ACTION clearSelection
Clears the current selection.
EE_TYPE OfType(KICAD_T aType) const
static std::shared_ptr< ERC_ITEM > Create(int aErrorCode)
Constructs an ERC_ITEM for the given error code.
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
bool WriteJsonReport(const wxString &aFullFileName)
Writes a JSON formatted ERC Report to the given file path.
bool WriteTextReport(const wxString &aFullFileName)
Writes the text report also available via GetTextReport directly to a given file path.
Container for ERC settings.
SEVERITY GetSeverity(int aErrorCode) const
void SetSeverity(int aErrorCode, SEVERITY aSeverity)
void RunTests(DS_PROXY_VIEW_ITEM *aDrawingSheet, SCH_EDIT_FRAME *aEditFrame, KIFACE *aCvPcb, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter)
A specialisation of the RC_TREE_MODEL class to enable ERC errors / warnings to be resolved in a speci...
APP_SETTINGS_BASE * KifaceSettings() const
DS_PROXY_VIEW_ITEM * GetDrawingSheet() const
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
std::shared_ptr< RC_ITEM > GetRCItem() const
void SetExcluded(bool aExcluded, const wxString &aComment=wxEmptyString)
void SetMaximumNumber(int aMax)
Set the maximum number to be shown on the badge.
void UpdateNumber(int aNumber, SEVERITY aSeverity)
Update the number displayed on the badge.
This implements all the tricky bits for thread safety, but the GUI is left to derived classes.
virtual void AdvancePhase() override
Use the next available virtual zone of the dialog progress bar.
virtual void SetCurrentProgress(double aProgress) override
Set the progress value to aProgress (0..1).
std::atomic_bool m_cancelled
virtual void AdvancePhase()=0
Use the next available virtual zone of the dialog progress bar.
virtual const wxString GetProjectPath() const
Return the full path of the project.
void SelectMarker(const MARKER_BASE *aMarker)
static RC_TREE_NODE * ToNode(wxDataViewItem aItem)
void ValueChanged(RC_TREE_NODE *aNode)
void Update(std::shared_ptr< RC_ITEMS_PROVIDER > aProvider, int aSeverities)
void DeleteItems(bool aCurrentOnly, bool aIncludeExclusions, bool aDeep)
Deletes the current item or all items.
void DeleteCurrentItem(bool aDeep)
void CenterMarker(const MARKER_BASE *aMarker)
static KIID ToUUID(wxDataViewItem aItem)
std::shared_ptr< RC_ITEM > m_RcItem
virtual REPORTER & ReportHead(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the beginning of the list for objects that support ordering.
Holds all the data relating to one schematic.
void RecordERCExclusions()
Scan existing markers and record data from any that are Excluded.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
ERC_SETTINGS & ErcSettings() const
virtual void RedrawScreen(const VECTOR2I &aCenterPoint, bool aWarpPointer)
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Schematic editor (Eeschema) main window.
void ShowSchematicSetupDialog(const wxString &aInitialPage=wxEmptyString)
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void OnAnnotate(wxCommandEvent &event)
int CheckAnnotate(ANNOTATION_ERROR_HANDLER aErrorHandler, ANNOTATE_SCOPE_T aAnnotateScope=ANNOTATE_ALL, bool aRecursive=true)
Check for annotation errors.
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
void DisplayCurrentSheet()
Draw the current sheet on the display.
void FocusOnItem(SCH_ITEM *aItem)
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual wxString GetClass() const override
Return the class name.
A helper to define a symbol's reference designator in a schematic.
const SCH_SHEET_PATH & GetSheetPath() const
SCH_SYMBOL * GetSymbol() const
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
void DeleteMarkers(enum MARKER_BASE::MARKER_T aMarkerTyp, int aErrorCode, bool aIncludeExclusions=true)
Delete all markers of a particular type and error code.
void DeleteAllMarkers(enum MARKER_BASE::MARKER_T aMarkerType, bool aIncludeExclusions)
Delete all electronic rules check markers of aMarkerType from all the screens in the list.
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr) const
Fetch a SCH_ITEM by ID.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool empty() const
Forwarded method from std::vector.
SCH_SCREEN * LastScreen()
VECTOR2I GetPosition() const override
EDA_UNITS GetUserUnits() const
void Clear()
Delete the stored messages.
void SetImmediateMode()
In immediate mode, messages are flushed as they are added.
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
void AddButton(wxButton *aButton)
Add an already created button to the infobar.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...
wxString GetValue() const
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
This file is part of the common library.
static int RPT_SEVERITY_ALL
static std::vector< wxString > g_lastERCIgnored
static int DEFAULT_SINGLE_COL_WIDTH
wxDEFINE_EVENT(EDA_EVT_CLOSE_ERC_DIALOG, wxCommandEvent)
static SCHEMATIC * g_lastERCSchematic
#define DIALOG_ERC_WINDOW_NAME
static int DEFAULT_SINGLE_COL_WIDTH
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
@ ERCE_PIN_TO_PIN_WARNING
static const std::string ReportFileExtension
static const std::string JsonFileExtension
static wxString JsonFileWildcard()
static wxString ReportFileWildcard()
std::vector< FAB_LAYER_COLOR > dummy
Definition of file extensions used in Kicad.
static int RPT_SEVERITY_ALL