42#include <wx/filedlg.h>
43#include <wx/wupdlock.h>
70 m_footprintTestsRun( false ),
71 m_markersTreeModel( nullptr ),
72 m_unconnectedTreeModel( nullptr ),
73 m_fpWarningsTreeModel( nullptr ),
74 m_centerMarkerOnIdle( nullptr ),
126 { wxID_CANCEL,
_(
"Close" ) } } );
166 if( !
Kiface().IsSingle() )
183 SetReturnCode( wxID_CANCEL );
197 cur = std::max( 0.0, std::min( cur, 1.0 ) );
243 if( zoneFillerTool->IsBusy() )
263 m_messages->
Report(
_(
"DRC incomplete: could not compile custom design rules." )
264 + wxS(
" " )
265 + wxS(
"<a href='$CUSTOM_RULES'>" ) +
_(
"Show design rules." ) + wxT(
"</a>" ) );
281 for( std::reference_wrapper<RC_ITEM>& item : violations )
286 wxT(
" • " ) + item.get().GetErrorText() );
305 drcTool->
RunTests(
this, refillZones, reportAllTrackErrors, testFootprints );
349 auto getActiveLayers =
357 for(
int layer : aItem->GetLayerSet().Seq() )
359 if(
pad->FlashLayer( layer ) )
367 return aItem->GetLayerSet();
388 std::shared_ptr<RC_ITEM> rc_item = node->
m_RcItem;
411 LSET violationLayers;
437 if( a || b || c || d )
448 LSET layersList = getActiveLayers( it );
449 violationLayers &= layersList;
452 principalLayer = layersList.
Seq().front();
456 if( violationLayers.count() )
457 principalLayer = violationLayers.
Seq().front();
459 violationLayers.set( principalLayer );
483 m_frame->FocusOnLocation( edge.GetSourcePos() );
485 m_frame->FocusOnLocation( edge.GetTargetPos() );
501 std::vector<BOARD_ITEM*> items;
509 for(
const KIID&
id : rc_item->GetIDs() )
513 if( candidate && candidate->GetNetCode() == net )
514 items.push_back( candidate );
519 items.push_back( item );
535 if( aEvent.GetItem().IsOk() )
555 std::shared_ptr<RC_ITEM> rcItem = node->
m_RcItem;
566 default: listName =
_(
"appropriate" );
break;
569 if( rcItem->GetParent()->IsExcluded() )
571 menu.Append( 1,
_(
"Remove exclusion for this violation" ),
572 wxString::Format(
_(
"It will be placed back in the %s list" ), listName ) );
576 msg.Printf(
_(
"Remove all exclusions for violations of rule '%s'" ),
578 menu.Append( 11, msg );
583 menu.Append( 2,
_(
"Exclude this violation" ),
584 wxString::Format(
_(
"It will be excluded from the %s list" ), listName ) );
588 msg.Printf(
_(
"Exclude all violations of rule '%s'" ),
590 menu.Append( 21, msg );
599 menu.Append( 3,
_(
"Run Inspect > Clearance Resolution" ) );
612 menu.Append( 3,
_(
"Run Inspect > Constraints Resolution" ) );
616 menu.Append( 3,
_(
"Run Inspect > Diff Footprint with Library" ) );
619 menu.AppendSeparator();
623 msg.Printf(
_(
"Change severity to Error for all '%s' violations" ),
624 rcItem->GetErrorText(),
625 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
626 menu.Append( 4, msg );
630 msg.Printf(
_(
"Change severity to Warning for all '%s' violations" ),
631 rcItem->GetErrorText(),
632 _(
"Violation severities can also be edited in the Board Setup... dialog" ) );
633 menu.Append( 5, msg );
636 msg.Printf(
_(
"Ignore all '%s' violations" ),
637 rcItem->GetErrorText(),
638 _(
"Violations will not be checked or reported" ) );
639 menu.Append( 6, msg );
641 menu.AppendSeparator();
643 menu.Append( 7,
_(
"Edit violation severities..." ),
_(
"Open the Board Setup... dialog" ) );
645 bool modified =
false;
647 switch( GetPopupMenuSelectionFromUser( menu ) )
668 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
695 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->ValueChanged( node );
697 static_cast<RC_TREE_MODEL*
>( aEvent.GetModel() )->DeleteCurrentItem(
false );
709 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
712 marker->SetExcluded(
false );
725 DRC_ITEM* candidateDrcItem =
static_cast<DRC_ITEM*
>( marker->GetRCItem().get() );
728 marker->SetExcluded(
true );
751 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
765 if( marker->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
779 wxT(
" • " ) + rcItem->GetErrorText() );
783 for(
unsigned i = 0; i < markers.size(); )
785 if( markers[i]->GetRCItem()->GetErrorCode() == rcItem->GetErrorCode() )
788 markers.erase( markers.begin() + i );
829 if( aEvent.GetEventObject() ==
m_showAll )
838 if( aEvent.IsChecked() )
840 else if( aEvent.GetEventObject() ==
m_showAll )
854 wxFileDialog dlg(
this,
_(
"Save Report to File" ),
Prj().GetProjectPath(), fn.GetFullName(),
857 if( dlg.ShowModal() != wxID_OK )
862 if( fn.GetExt().IsEmpty() )
865 if( !fn.IsAbsolute() )
868 fn.MakeAbsolute( prj_path );
874 fn.GetFullPath() ) );
878 DisplayError(
this, wxString::Format(
_(
"Failed to create file '%s'." ),
879 fn.GetFullPath() ) );
889 wxCommandEvent
dummy;
905 SetReturnCode( wxID_CANCEL );
917 if( aEvent.GetSelection() >= 0 )
918 m_Notebook->ChangeSelection( (
unsigned) aEvent.GetSelection() );
1028 FILE* fp = wxFopen( aFullFileName, wxT(
"w" ) );
1033 std::map<KIID, EDA_ITEM*> itemMap;
1042 wxDateTime now = wxDateTime::Now();
1044 fprintf( fp,
"** Created on %s **\n",
TO_UTF8( now.Format( wxT(
"%F %T" ) ) ) );
1048 fprintf( fp,
"\n** Found %d DRC violations **\n", count );
1050 for(
int i = 0; i < count; ++i )
1053 SEVERITY severity = item->GetParent()->GetSeverity();
1058 fprintf( fp,
"%s",
TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
1063 fprintf( fp,
"\n** Found %d unconnected pads **\n", count );
1065 for(
int i = 0; i < count; ++i )
1070 fprintf( fp,
"%s",
TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
1075 fprintf( fp,
"\n** Found %d Footprint errors **\n", count );
1077 for(
int i = 0; i < count; ++i )
1082 fprintf( fp,
"%s",
TO_UTF8( item->ShowReport( &unitsProvider, severity, itemMap ) ) );
1086 fprintf( fp,
"\n** End of Report **\n" );
1121 static bool s_includeExclusions =
false;
1123 int numExcluded = 0;
1134 if( numExcluded > 0 )
1136 wxRichMessageDialog dlg(
this,
_(
"Do you wish to delete excluded markers as well?" ),
1137 _(
"Delete All Markers" ),
1138 wxOK | wxCANCEL | wxCENTER | wxICON_QUESTION );
1139 dlg.ShowCheckBox(
_(
"Delete exclusions" ), s_includeExclusions );
1141 int ret = dlg.ShowModal();
1143 if( ret == wxID_CANCEL )
1146 s_includeExclusions = dlg.IsCheckBoxChecked();
1165 int numUnconnected = 0;
1166 int numFootprints = 0;
1169 int numWarnings = 0;
1170 int numExcluded = 0;
1198 bool errorsOverflowed =
false;
1199 bool warningsOverflowed =
false;
1200 bool markersOverflowed =
false;
1201 bool unconnectedOverflowed =
false;
1202 bool footprintsOverflowed =
false;
1206 if( drcEngine->IsErrorLimitExceeded( ii ) )
1209 errorsOverflowed =
true;
1211 warningsOverflowed =
true;
1216 unconnectedOverflowed =
true;
1218 unconnectedOverflowed =
true;
1226 footprintsOverflowed =
true;
1228 footprintsOverflowed =
true;
1233 markersOverflowed =
true;
1235 markersOverflowed =
true;
1247 num.Printf( markersOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numMarkers );
1253 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1260 num.Printf( unconnectedOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numUnconnected );
1266 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1273 num.Printf( footprintsOverflowed ? wxT(
"%d+" ) : wxT(
"%d" ), numFootprints );
1279 msg.Replace( wxT(
"%s" ),
_(
"not run" ) );
1284 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1297 msg.Replace( wxT(
"(%s)" ), wxEmptyString );
1307 if( !
m_drcRun && numWarnings == 0 )
constexpr EDA_IU_SCALE pcbIUScale
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
const wxString & GetFileName() const
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
BOARD_DESIGN_SETTINGS & GetDesignSettings() 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
bool writeReport(const wxString &aFullFileName)
Function writeReport outputs the MARKER items with commentary to an open text file.
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
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 ReportFileExtension
wxString ReportFileWildcard()
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
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