board_inspection_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef BOARD_INSPECTION_TOOL_H
#define BOARD_INSPECTION_TOOL_H
 
#include <dialogs/dialog_book_reporter.h>
#include <pcb_edit_frame.h>
#include <rc_item.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_tool_base.h>
 
class CONNECTIVITY_DATA;
class DRC_ENGINE;
class FOOTPRINT_DIFF_WIDGET;
 

class BOARD_INSPECTION_TOOL : public wxEvtHandler, public PCB_TOOL_BASE
{
public:
    BOARD_INSPECTION_TOOL();

    bool Init() override;

    void Reset( RESET_REASON aReason ) override;

    int ShowBoardStatistics( const TOOL_EVENT& aEvent );

    int HighlightNet( const TOOL_EVENT& aEvent );
    int HighlightNetChain( const TOOL_EVENT& aEvent );
    int ReplaceTerminalPad( const TOOL_EVENT& aEvent );

    int ClearHighlight( const TOOL_EVENT& aEvent );

    int HighlightItem( const TOOL_EVENT& aEvent );

    int UpdateLocalRatsnest( const TOOL_EVENT& aEvent );

    int HideLocalRatsnest( const TOOL_EVENT& aEvent );

    int LocalRatsnestTool( const TOOL_EVENT& aEvent );

    int HideNetInRatsnest( const TOOL_EVENT& aEvent );

    int ShowNetInRatsnest( const TOOL_EVENT& aEvent );
 
    wxString InspectDRCErrorMenuText( const std::shared_ptr<RC_ITEM>& aDRCItem );
    void InspectDRCError( const std::shared_ptr<RC_ITEM>& aDRCItem );

    int InspectClearance( const TOOL_EVENT& aEvent );
 
    int InspectConstraints( const TOOL_EVENT& aEvent );
 
    int ShowFootprintLinks( const TOOL_EVENT& aEvent );
 
    int DiffFootprint( const TOOL_EVENT& aEvent );
    void DiffFootprint( FOOTPRINT* aFootprint, wxTopLevelWindow* aReparentTo = nullptr );

    int CompareBoardWithFile( const TOOL_EVENT& aEvent );

    int CompareBoardWithHistory( const TOOL_EVENT& aEvent );

    bool IsNetHighlightSet() const
    {
        return !m_currentlyHighlighted.empty();
    }
 
private:
    int showBoardComparison( const wxString& aOtherPath, const wxString& aProjectPath,
                             const wxString& aComparisonLabel );

    void calculateSelectionRatsnest( const VECTOR2I& aDelta );

    bool highlightNet( const VECTOR2D& aPosition, bool aUseSelection );
 
    void doHideRatsnestNet( int aNetCode, bool aHide );

    void setTransitions() override;
 
    std::unique_ptr<DRC_ENGINE> makeDRCEngine( bool* aCompileError, bool* aCourtyardError );
 
    wxString getItemDescription( const BOARD_ITEM* aItem );
 
    void reportCompileError( REPORTER* r );
    void reportHeader( const wxString& aTitle, const BOARD_ITEM* a, REPORTER* r );
    void reportHeader( const wxString& aTitle, const BOARD_ITEM* a, const BOARD_ITEM* b, REPORTER* r );
    void reportHeader( const wxString& aTitle, const BOARD_ITEM* a, const BOARD_ITEM* b, PCB_LAYER_ID aLayer,
                       REPORTER* r );
 
    FOOTPRINT_DIFF_WIDGET* constructDiffPanel( wxPanel* aParentPanel );
 
    void reportClearance( const BOARD_ITEM* aItemA, const BOARD_ITEM* aItemB );
 
    void filterCollectorForInspection( GENERAL_COLLECTOR& aCollector, const VECTOR2I& aPos );
 
    BOARD_ITEM* pickItemForInspection( const TOOL_EVENT& aEvent, const wxString& aPrompt,
                                       const std::vector<KICAD_T>& aTypes, BOARD_ITEM* aLockedHighlight );
 
public:
    wxString            m_HighlightedNetChain;
 
private:
    PCB_EDIT_FRAME*     m_frame;    // Pointer to the currently used edit frame.
 
    std::set<int>       m_currentlyHighlighted; // Active net being highlighted, or -1 when off
    std::set<int>       m_lastHighlighted;      // For toggling between last two highlighted nets
 
    CONNECTIVITY_DATA*  m_dynamicData;      // Cached connectivity data from the selection
};
 
#endif //BOARD_INSPECTION_TOOL_H