44#include <wx/filedlg.h>
45#include <wx/wupdlock.h>
73 m_footprintTestsRun( false ),
74 m_markersTreeModel( nullptr ),
75 m_unconnectedTreeModel( nullptr ),
76 m_fpWarningsTreeModel( nullptr ),
128 { wxID_CANCEL,
_(
"Close" ) } } );
170 catch(
const std::runtime_error& e )
172 wxFAIL_MSG( e.what() );
180 if( !
Kiface().IsSingle() )
198 SetReturnCode( wxID_CANCEL );
214 Pgm().App().SafeYieldFor(
this, wxEVT_CATEGORY_NATIVE_EVENTS );
257 if( zoneFillerTool->IsBusy() )
277 m_messages->
Report(
_(
"DRC incomplete: could not compile custom design rules." )
278 + wxS(
" " )
279 + wxS(
"<a href='$CUSTOM_RULES'>" ) +
_(
"Show design rules." ) + wxT(
"</a>" ) );
295 for( std::reference_wrapper<RC_ITEM>& item : violations )
300 wxT(
" • " ) + item.get().GetErrorText() );
321 drcTool->
RunTests(
this, refillZones, reportAllTrackErrors, testFootprints );
372 auto getActiveLayers =
380 for(
int layer : aItem->GetLayerSet().Seq() )
382 if(
pad->FlashLayer( layer ) )
390 return aItem->GetLayerSet();
402 std::shared_ptr<RC_ITEM> rc_item = node->
m_RcItem;
425 LSET violationLayers;
451 if( a || b || c || d )
462 LSET layersList = getActiveLayers( it );
463 violationLayers &= layersList;
466 principalLayer = layersList.
Seq().front();
470 if( violationLayers.count() )
471 principalLayer = violationLayers.
Seq().front();
473 violationLayers.set( principalLayer );
508 if( item == a && item == b )
510 focusPos = ( node->m_Type == RC_TREE_NODE::MAIN_ITEM )
511 ? edge.GetSourcePos()
512 : edge.GetTargetPos();
516 focusPos = ( item == edge.GetSourceNode()->Parent() )
517 ? edge.GetSourcePos()
518 : edge.GetTargetPos();
538 std::vector<BOARD_ITEM*> items;
546 for(
const KIID&
id : rc_item->GetIDs() )
550 if( candidate && candidate->GetNetCode() == net )
551 items.push_back( candidate );
556 items.push_back( item );
559 m_frame->FocusOnItems( items, principalLayer );
563 m_frame->FocusOnItem( item, principalLayer );
572 if( aEvent.GetItem().IsOk() )
594 std::shared_ptr<RC_ITEM> rcItem = node->m_RcItem;
604 default: listName =
_(
"appropriate" );
break;
609 ID_EDIT_EXCLUSION_COMMENT = 4467,
611 ID_REMOVE_EXCLUSION_ALL,
613 ID_ADD_EXCLUSION_ALL,
614 ID_INSPECT_VIOLATION,
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_REMOVE_EXCLUSION_ALL,
633 wxString::Format(
_(
"Remove all exclusions for violations of rule '%s'" ),
635 wxString::Format(
_(
"They will be placed back in the %s list" ), listName ) );
640 menu.Append( ID_ADD_EXCLUSION,
641 _(
"Exclude this violation..." ),
642 wxString::Format(
_(
"It will be excluded from the %s list" ), listName ) );
646 menu.Append( ID_ADD_EXCLUSION_ALL,
647 wxString::Format(
_(
"Exclude all violations of rule '%s'..." ),
649 wxString::Format(
_(
"They will be excluded from the %s list" ), listName ) );
655 if( !inspectDRCErrorMenuText.IsEmpty() )
656 menu.Append( ID_INSPECT_VIOLATION, inspectDRCErrorMenuText );
658 menu.AppendSeparator();
662 menu.Append( ID_SET_SEVERITY_TO_ERROR,
663 wxString::Format(
_(
"Change severity to Error for all '%s' violations" ),
664 rcItem->GetErrorText() ),
665 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
669 menu.Append( ID_SET_SEVERITY_TO_WARNING,
670 wxString::Format(
_(
"Change severity to Warning for all '%s' violations" ),
671 rcItem->GetErrorText() ),
672 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
675 menu.Append( ID_SET_SEVERITY_TO_IGNORE,
676 wxString::Format(
_(
"Ignore all '%s' violations" ), rcItem->GetErrorText() ),
677 _(
"Violations will not be checked or reported" ) );
679 menu.AppendSeparator();
681 menu.Append( ID_EDIT_SEVERITIES,
682 _(
"Edit violation severities..." ),
683 _(
"Open the Board Setup... dialog" ) );
685 bool modified =
false;
687 switch( GetPopupMenuSelectionFromUser( menu ) )
689 case ID_EDIT_EXCLUSION_COMMENT:
693 marker->GetComment(),
true );
695 if( dlg.ShowModal() == wxID_CANCEL )
698 marker->SetExcluded(
true, dlg.
GetValue() );
700 wxString serialized = marker->Serialize();
705 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
711 case ID_REMOVE_EXCLUSION:
714 marker->SetExcluded(
false );
716 wxString serialized = marker->Serialize();
731 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
737 case ID_ADD_EXCLUSION:
741 wxEmptyString,
true );
743 if( dlg.ShowModal() == wxID_CANCEL )
746 marker->SetExcluded(
true, dlg.
GetValue() );
748 wxString serialized = marker->Serialize();
764 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
766 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->DeleteCurrentItem(
false );
773 case ID_REMOVE_EXCLUSION_ALL:
776 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
780 marker->SetExcluded(
false );
782 wxString serialized = marker->Serialize();
793 case ID_ADD_EXCLUSION_ALL:
796 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
800 marker->SetExcluded(
true );
802 wxString serialized = marker->Serialize();
812 case ID_INSPECT_VIOLATION:
816 case ID_SET_SEVERITY_TO_ERROR:
821 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
830 case ID_SET_SEVERITY_TO_WARNING:
835 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
844 case ID_SET_SEVERITY_TO_IGNORE:
849 wxT(
" • " ) + rcItem->GetErrorText() );
853 for(
unsigned i = 0; i < markers.size(); )
855 if( markers[i]->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
858 markers.erase( markers.begin() + i );
875 case ID_EDIT_SEVERITIES:
899 if( aEvent.GetEventObject() ==
m_showAll )
908 if( aEvent.IsChecked() )
910 else if( aEvent.GetEventObject() ==
m_showAll )
924 wxFileDialog dlg(
this,
_(
"Save Report File" ),
Prj().GetProjectPath(), fn.GetFullName(),
926 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
928 if( dlg.ShowModal() != wxID_OK )
933 if( fn.GetExt().IsEmpty() )
936 if( !fn.IsAbsolute() )
939 fn.MakeAbsolute( prj_path );
945 bool success =
false;
954 fn.GetFullPath() ) );
958 DisplayError(
this, wxString::Format(
_(
"Failed to create file '%s'." ),
959 fn.GetFullPath() ) );
969 wxCommandEvent
dummy;
985 SetReturnCode( wxID_CANCEL );
1125 static bool s_includeExclusions =
false;
1127 int numExcluded = 0;
1138 if( numExcluded > 0 )
1140 wxMessageDialog dlg(
this,
_(
"Delete exclusions too?" ),
_(
"Delete All Markers" ),
1141 wxYES_NO | wxCANCEL | wxCENTER | wxICON_QUESTION );
1142 dlg.SetYesNoLabels(
_(
"Errors and Warnings Only" ),
1143 _(
"Errors, Warnings and Exclusions" ) );
1145 int ret = dlg.ShowModal();
1147 if( ret == wxID_CANCEL )
1149 else if( ret == wxID_NO )
1150 s_includeExclusions =
true;
1169 int numUnconnected = 0;
1170 int numFootprints = 0;
1173 int numWarnings = 0;
1174 int numExcluded = 0;
1202 bool errorsOverflowed =
false;
1203 bool warningsOverflowed =
false;
1204 bool markersOverflowed =
false;
1205 bool unconnectedOverflowed =
false;
1206 bool footprintsOverflowed =
false;
1210 if( drcEngine->IsErrorLimitExceeded( ii ) )
1213 errorsOverflowed =
true;
1215 warningsOverflowed =
true;
1220 unconnectedOverflowed =
true;
1222 unconnectedOverflowed =
true;
1231 footprintsOverflowed =
true;
1233 footprintsOverflowed =
true;
1238 markersOverflowed =
true;
1240 markersOverflowed =
true;
1252 num.Printf( markersOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numMarkers );
1258 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1265 num.Printf( unconnectedOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numUnconnected );
1271 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1278 num.Printf( footprintsOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numFootprints );
1284 msg.Replace( wxT(
"%s" ),
_(
"not run" ) );
1289 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1302 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1312 if( !
m_drcRun && numWarnings == 0 )
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
void SetLayerVisible(int aLayer, bool isVisible)
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
std::map< wxString, wxString > m_DrcExclusionComments
std::map< int, SEVERITY > m_DRCSeverities
std::set< wxString > m_DrcExclusions
SEVERITY GetSeverity(int aDRCErrorCode)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Information pertinent to a Pcbnew printed circuit board.
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
BOARD_ITEM * GetItem(const KIID &aID) const
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
void DeleteMARKERs()
Delete all MARKERS from the board.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
std::shared_ptr< const CN_ANCHOR > GetSourceNode() const
std::shared_ptr< const CN_ANCHOR > GetTargetNode() const
static DELETED_BOARD_ITEM * GetInstance()
wxCheckBox * m_cbRefillZones
wxButton * m_DeleteAllMarkersButton
wxCheckBox * m_showExclusions
wxCheckBox * m_showErrors
wxDataViewCtrl * m_unconnectedDataView
wxDataViewCtrl * m_footprintsDataView
NUMBER_BADGE * m_warningsBadge
wxCheckBox * m_cbReportAllTrackErrors
NUMBER_BADGE * m_exclusionsBadge
wxSimplebook * m_runningResultsBook
wxButton * m_DeleteCurrentMarkerButton
wxButton * m_sdbSizerCancel
wxCheckBox * m_cbTestFootprints
wxCheckBox * m_showWarnings
wxListCtrl * m_ignoredList
NUMBER_BADGE * m_errorsBadge
WX_HTML_REPORT_BOX * m_messages
wxDataViewCtrl * m_markerDataView
void OnDRCItemSelected(wxDataViewEvent &aEvent) override
wxString m_footprintsTitleTemplate
void UpdateData()
Rebuild the contents of the violation tabs based on the current markers and severties.
std::shared_ptr< RC_ITEMS_PROVIDER > m_ratsnestProvider
wxString m_markersTitleTemplate
DIALOG_DRC(PCB_EDIT_FRAME *aEditorFrame, wxWindow *aParent)
Constructors.
void OnEditViolationSeverities(wxHyperlinkEvent &aEvent) override
void OnDeleteOneClick(wxCommandEvent &aEvent) override
RC_TREE_MODEL * m_fpWarningsTreeModel
void OnDeleteAllClick(wxCommandEvent &aEvent) override
void OnErrorLinkClicked(wxHtmlLinkEvent &event) override
BOARD_DESIGN_SETTINGS & bds()
void SelectMarker(const PCB_MARKER *aMarker)
void OnClose(wxCloseEvent &event) override
void OnDRCItemRClick(wxDataViewEvent &aEvent) override
void OnRunDRCClick(wxCommandEvent &aEvent) override
wxString m_ignoredTitleTemplate
void OnDRCItemDClick(wxDataViewEvent &aEvent) override
void deleteAllMarkers(bool aIncludeExclusions)
void updateDisplayedCounts()
RC_TREE_MODEL * m_unconnectedTreeModel
wxString m_unconnectedTitleTemplate
std::shared_ptr< RC_ITEMS_PROVIDER > m_fpWarningsProvider
std::shared_ptr< RC_ITEMS_PROVIDER > m_markersProvider
void OnSeverity(wxCommandEvent &aEvent) override
void OnCancelClick(wxCommandEvent &aEvent) override
void OnActivateDlg(wxActivateEvent &aEvent) override
void OnChangingNotebookPage(wxNotebookEvent &aEvent) override
void OnSaveReport(wxCommandEvent &aEvent) override
RC_TREE_MODEL * m_markersTreeModel
bool Show(bool show) override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
EDA_UNITS GetUserUnits() const
Design Rule Checker object that performs all the DRC tests.
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
DRC_RULE * GetViolatingRule() const
bool WriteJsonReport(const wxString &aFullFileName)
bool WriteTextReport(const wxString &aFullFileName)
void RefreshCanvas() override
void FocusOnLocation(const VECTOR2I &aPos)
Useful to focus on a particular location, in find functions.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KICAD_T Type() const
Returns the type of object.
EDA_ITEM_FLAGS GetFlags() const
bool IsSingle() const
Is this KIFACE running under single_top?
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
LSET is a set of PCB_LAYER_IDs.
static LSET AllLayersMask()
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
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.
DISPLAY_OPTIONS m_Display
static TOOL_ACTION showRatsnest
static TOOL_ACTION selectionClear
Clear the current selection.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
APPEARANCE_CONTROLS * GetAppearancePanel()
PCBNEW_SETTINGS * GetPcbNewSettings() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
void FocusOnItem(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void RedrawRatsnest()
Return the bounding box of the view that should be used if model is not valid.
The main frame for Pcbnew.
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void SetActiveLayer(PCB_LAYER_ID aLayer) override
Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.
void OnModify() override
Must be called after a board change to set the modified flag.
wxString Serialize() const
SEVERITY GetSeverity() const override
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
std::atomic_int m_progress
std::atomic_int m_maxProgress
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
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 Flush()
Build the HTML messages page.
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 std::vector< wxString > g_lastIgnored
static int RPT_SEVERITY_ALL
static int DEFAULT_SINGLE_COL_WIDTH
static BOARD * g_lastDRCBoard
static bool g_lastFootprintTestsRun
#define DIALOG_DRC_WINDOW_NAME
@ DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG
@ DRCE_MALFORMED_COURTYARD
@ DRCE_UNRESOLVED_VARIABLE
@ DRCE_DUPLICATE_FOOTPRINT
@ DRCE_SCHEMATIC_PARITY_ISSUES
#define MALFORMED_F_COURTYARD
#define MALFORMED_B_COURTYARD
static int DEFAULT_SINGLE_COL_WIDTH
static const std::string ReportFileExtension
static const std::string JsonFileExtension
static wxString JsonFileWildcard()
static wxString ReportFileWildcard()
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
T clamp(T min, T value, T max)
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
std::vector< FAB_LAYER_COLOR > dummy
A filename or source description, a problem input line, a line number, a byte offset,...
bool test_all_track_errors
bool m_ShowGlobalRatsnest
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_PAD_T
class PAD, a pad in a footprint
Functions to provide common constants and other functions to assist in making a consistent UI.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition of file extensions used in Kicad.
static int RPT_SEVERITY_ALL