43#include <wx/filedlg.h>
44#include <wx/wupdlock.h>
71 m_footprintTestsRun( false ),
72 m_markersTreeModel( nullptr ),
73 m_unconnectedTreeModel( nullptr ),
74 m_fpWarningsTreeModel( nullptr ),
75 m_centerMarkerOnIdle( nullptr ),
127 { wxID_CANCEL,
_(
"Close" ) } } );
169 catch(
const std::runtime_error& e )
171 wxFAIL_MSG( e.what() );
179 if( !
Kiface().IsSingle() )
197 SetReturnCode( wxID_CANCEL );
256 if( zoneFillerTool->IsBusy() )
276 m_messages->
Report(
_(
"DRC incomplete: could not compile custom design rules." )
277 + wxS(
" " )
278 + wxS(
"<a href='$CUSTOM_RULES'>" ) +
_(
"Show design rules." ) + wxT(
"</a>" ) );
294 for( std::reference_wrapper<RC_ITEM>& item : violations )
299 wxT(
" • " ) + item.get().GetErrorText() );
320 drcTool->
RunTests(
this, refillZones, reportAllTrackErrors, testFootprints );
364 auto getActiveLayers =
372 for(
int layer : aItem->GetLayerSet().Seq() )
374 if(
pad->FlashLayer( layer ) )
382 return aItem->GetLayerSet();
403 std::shared_ptr<RC_ITEM> rc_item = node->
m_RcItem;
426 LSET violationLayers;
452 if( a || b || c || d )
463 LSET layersList = getActiveLayers( it );
464 violationLayers &= layersList;
467 principalLayer = layersList.
Seq().front();
471 if( violationLayers.count() )
472 principalLayer = violationLayers.
Seq().front();
474 violationLayers.set( principalLayer );
506 m_frame->FocusOnLocation( edge.GetSourcePos() );
508 m_frame->FocusOnLocation( edge.GetTargetPos() );
524 std::vector<BOARD_ITEM*> items;
532 for(
const KIID&
id : rc_item->GetIDs() )
536 if( candidate && candidate->GetNetCode() == net )
537 items.push_back( candidate );
542 items.push_back( item );
558 if( aEvent.GetItem().IsOk() )
578 std::shared_ptr<RC_ITEM> rcItem = node->
m_RcItem;
589 default: listName =
_(
"appropriate" );
break;
592 if( rcItem->GetParent()->IsExcluded() )
594 menu.Append( 1,
_(
"Remove exclusion for this violation" ),
595 wxString::Format(
_(
"It will be placed back in the %s list" ), listName ) );
599 msg.Printf(
_(
"Remove all exclusions for violations of rule '%s'" ),
601 menu.Append( 11, msg );
606 menu.Append( 2,
_(
"Exclude this violation" ),
607 wxString::Format(
_(
"It will be excluded from the %s list" ), listName ) );
611 msg.Printf(
_(
"Exclude all violations of rule '%s'" ),
613 menu.Append( 21, msg );
622 menu.Append( 3,
_(
"Run Inspect > Clearance Resolution" ) );
635 menu.Append( 3,
_(
"Run Inspect > Constraints Resolution" ) );
639 menu.Append( 3,
_(
"Run Inspect > Diff Footprint with Library" ) );
642 menu.AppendSeparator();
646 msg.Printf(
_(
"Change severity to Error for all '%s' violations" ),
647 rcItem->GetErrorText(),
648 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
649 menu.Append( 4, msg );
653 msg.Printf(
_(
"Change severity to Warning for all '%s' violations" ),
654 rcItem->GetErrorText(),
655 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
656 menu.Append( 5, msg );
659 msg.Printf(
_(
"Ignore all '%s' violations" ),
660 rcItem->GetErrorText(),
661 _(
"Violations will not be checked or reported" ) );
662 menu.Append( 6, msg );
664 menu.AppendSeparator();
666 menu.Append( 7,
_(
"Edit violation severities..." ),
_(
"Open the Board Setup... dialog" ) );
668 bool modified =
false;
670 switch( GetPopupMenuSelectionFromUser( menu ) )
691 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
718 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
720 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->DeleteCurrentItem(
false );
732 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
735 marker->SetExcluded(
false );
748 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
751 marker->SetExcluded(
true );
774 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
788 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
802 wxT(
" • " ) + rcItem->GetErrorText() );
806 for(
unsigned i = 0; i < markers.size(); )
808 if( markers[i]->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
811 markers.erase( markers.begin() + i );
852 if( aEvent.GetEventObject() ==
m_showAll )
861 if( aEvent.IsChecked() )
863 else if( aEvent.GetEventObject() ==
m_showAll )
877 wxFileDialog dlg(
this,
_(
"Save Report File" ),
Prj().GetProjectPath(), fn.GetFullName(),
879 wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
881 if( dlg.ShowModal() != wxID_OK )
886 if( fn.GetExt().IsEmpty() )
889 if( !fn.IsAbsolute() )
892 fn.MakeAbsolute( prj_path );
898 bool success =
false;
907 fn.GetFullPath() ) );
911 DisplayError(
this, wxString::Format(
_(
"Failed to create file '%s'." ),
912 fn.GetFullPath() ) );
922 wxCommandEvent
dummy;
938 SetReturnCode( wxID_CANCEL );
950 if( aEvent.GetSelection() >= 0 )
951 m_Notebook->ChangeSelection( (
unsigned) aEvent.GetSelection() );
1086 static bool s_includeExclusions =
false;
1088 int numExcluded = 0;
1099 if( numExcluded > 0 )
1101 wxRichMessageDialog dlg(
this,
_(
"Do you wish to delete excluded markers as well?" ),
1102 _(
"Delete All Markers" ),
1103 wxOK | wxCANCEL | wxCENTER | wxICON_QUESTION );
1104 dlg.ShowCheckBox(
_(
"Delete exclusions" ), s_includeExclusions );
1106 int ret = dlg.ShowModal();
1108 if( ret == wxID_CANCEL )
1111 s_includeExclusions = dlg.IsCheckBoxChecked();
1130 int numUnconnected = 0;
1131 int numFootprints = 0;
1134 int numWarnings = 0;
1135 int numExcluded = 0;
1163 bool errorsOverflowed =
false;
1164 bool warningsOverflowed =
false;
1165 bool markersOverflowed =
false;
1166 bool unconnectedOverflowed =
false;
1167 bool footprintsOverflowed =
false;
1171 if( drcEngine->IsErrorLimitExceeded( ii ) )
1174 errorsOverflowed =
true;
1176 warningsOverflowed =
true;
1181 unconnectedOverflowed =
true;
1183 unconnectedOverflowed =
true;
1191 footprintsOverflowed =
true;
1193 footprintsOverflowed =
true;
1198 markersOverflowed =
true;
1200 markersOverflowed =
true;
1212 num.Printf( markersOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numMarkers );
1218 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1225 num.Printf( unconnectedOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numUnconnected );
1231 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1238 num.Printf( footprintsOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numFootprints );
1244 msg.Replace( wxT(
"%s" ),
_(
"not run" ) );
1249 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1262 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1272 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< int, SEVERITY > m_DRCSeverities
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 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 centerMarkerIdleHandler(wxIdleEvent &aEvent)
void OnDRCItemSelected(wxDataViewEvent &aEvent) override
wxString m_footprintsTitleTemplate
void UpdateData()
Rebuild the contents of the violation tabs based on the current markers and severties.
const PCB_MARKER * m_centerMarkerOnIdle
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 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)
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()
void FocusOnItems(std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
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.
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
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 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)
void ValueChanged(const RC_TREE_NODE *aNode)
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.
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_DRILL_OUT_OF_RANGE
@ DRCE_DRILLED_HOLES_TOO_CLOSE
@ DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG
@ DRCE_MICROVIA_DRILL_OUT_OF_RANGE
@ DRCE_MALFORMED_COURTYARD
@ DRCE_UNRESOLVED_VARIABLE
@ DRCE_DUPLICATE_FOOTPRINT
@ DRCE_LIB_FOOTPRINT_MISMATCH
#define MALFORMED_F_COURTYARD
#define MALFORMED_B_COURTYARD
static int DEFAULT_SINGLE_COL_WIDTH
const std::string JsonFileExtension
const std::string ReportFileExtension
wxString ReportFileWildcard()
wxString JsonFileWildcard()
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)
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