pcb_edit_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010 Jean-Pierre Charras, [email protected]
 * 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 3 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  __PCB_EDIT_FRAME_H__
#define  __PCB_EDIT_FRAME_H__
 
#include "pcb_base_edit_frame.h"
#include "zones.h"
#include <mail_type.h>
#include <settings/app_settings.h>
#include <variant>
 
class PCB_SCREEN;
class BOARD;
class BOARD_COMMIT;
class BOARD_ITEM_CONTAINER;
class DESIGN_BLOCK;
class DIALOG_BOOK_REPORTER;
class FOOTPRINT;
class PCB_TRACK;
class PCB_VIA;
class PAD;
class PCB_SELECTION;
class PCB_TARGET;
class PCB_GROUP;
class PCB_DIMENSION_BASE;
class DRC;
class DIALOG_FIND;
class DIALOG_FIND_BY_PROPERTIES;
class DIALOG_PLOT;
class ZONE;
class GENERAL_COLLECTOR;
class GENERAL_COLLECTORS_GUIDE;
class SELECTION;
class PCB_MARKER;
class BOARD_ITEM;
class NETLIST;
class REPORTER;
struct PARSE_ERROR;
class IO_ERROR;
class FP_LIB_TABLE;
class BOARD_NETLIST_UPDATER;
class ACTION_MENU;
class TOOL_ACTION;
class DIALOG_BOARD_SETUP;
class DIALOG_FOOTPRINT_FIELDS_TABLE;
class PCB_DESIGN_BLOCK_PANE;
class PANEL_CONSTRAINTS;
class WX_INFOBAR;
 
class KICAD_API_SERVER;
class API_HANDLER_PCB;
class API_HANDLER_COMMON;
class API_HANDLER_LIBRARIES;
 
enum LAST_PATH_TYPE : unsigned int;
 
namespace PCB { struct IFACE; }     // KIFACE is in pcbnew.cpp
 
wxDECLARE_EVENT( EDA_EVT_PCB_LAST_SCH_SHEET_CHANGED, wxCommandEvent );

class PCB_EDIT_FRAME : public PCB_BASE_EDIT_FRAME
{
public:
    virtual ~PCB_EDIT_FRAME();
 
    void OnQuit( wxCommandEvent& event );

    bool IsContentModified() const override;

    void UpdateUserInterface();
 
    void HardRedraw() override;

    void ExecuteRemoteCommand( const char* cmdline ) override;
 
    void HandleRemoteNetHighlight( const std::vector<wxString>& aNetNames );
 
    void KiwayMailIn( KIWAY_MAIL_EVENT& aEvent ) override;
 
    void      SetLastSchematicSheetPath( const KIID_PATH& aPath );
    KIID_PATH GetLastSchematicSheetPath() const { return m_lastSchematicSheetPath; }

    static const wxString SearchPaneName() { return wxT( "Search" ); }
    static const wxString ConstraintsPaneName() { return wxT( "Constraints" ); }

    void ToggleConstraintsPanel();

    PANEL_CONSTRAINTS* GetConstraintsPanel() const { return m_constraintsPanel; }

    void ShowFindDialog();

    void ShowFindByPropertiesDialog();

    void NotifyFindByPropertiesDialog();

    void FindNext( bool reverse = false );
 
    bool LayerManagerShown();
    bool PropertiesShown();
    bool NetInspectorShown();
 
    void OnUpdateSelectViaSize( wxUpdateUIEvent& aEvent );
    void OnUpdateSelectTrackWidth( wxUpdateUIEvent& aEvent );
 
    void UpdateTrackWidthSelectBox( wxChoice* aTrackWidthSelectBox, bool aShowNetclass,
                                    bool aShowEdit );
    void UpdateViaSizeSelectBox( wxChoice* aViaSizeSelectBox, bool aShowNetclass, bool aShowEdit );

    void UpdateViaStackSelectBox( wxChoice* aViaStackSelectBox );

    void UpdateVariantSelectionCtrl();

    void SetCurrentVariant( const wxString& aVariantName );

    void onVariantSelected( wxCommandEvent& aEvent );

    EDA_ANGLE GetRotationAngle() const override;

    COLOR4D GetGridColor() override;

    void SetGridColor( const COLOR4D& aColor ) override;

    static bool GetPluginActionButtonVisible( const wxString& aPluginPath, bool aPluginDefault );

    static std::vector<const PLUGIN_ACTION*> GetOrderedPluginActions();
 
    void SaveProjectLocalSettings() override;

    bool LoadProjectSettings();
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;

    void LoadDrawingSheet();

    wxString GetLastPath( LAST_PATH_TYPE aType );

    void SetLastPath( LAST_PATH_TYPE aType, const wxString& aLastPath );

    void ResolveDRCExclusions( bool aCreateMarkers );
 
    void Process_Special_Functions( wxCommandEvent& event );
    void Tracks_and_Vias_Size_Event( wxCommandEvent& event );

    void SelectViaStack_Event( wxCommandEvent& event );
 

    void ReCreateLayerBox( bool aForceResizeToolbar = true );
 

    void OnModify() override;

    void SetActiveLayer( PCB_LAYER_ID aLayer ) override
    {
        SetActiveLayer( aLayer, false );
    }

    void SetActiveLayer( PCB_LAYER_ID aLayer, bool aForceRedraw );
 
    void OnDisplayOptionsChanged() override;

    bool IsElementVisible( GAL_LAYER_ID aElement ) const;

    void SetElementVisibility( GAL_LAYER_ID aElement, bool aNewState );

    void ActivateGalCanvas() override;

    void RefreshDrillSymbols( int aUpdateFlags ) override;
 
    void ShowBoardSetupDialog( const wxString& aInitialPage = wxEmptyString, wxWindow* aParent = nullptr );
 
    void PrepareLayerIndicator( bool aForceRebuild = false );
 
    void ToggleLayersManager();
 
    void ToggleNetInspector();
 
    void ToggleSearch();
 
    bool IsSearchPaneShown() { return m_auimgr.GetPane( SearchPaneName() ).IsShown(); }
    void FocusSearch();
 
    void ToggleLibraryTree() override;

    int DoGenFootprintsPositionFile( const wxString& aFullFileName, bool aUnitsMM, bool aOnlySMD,
                                     bool aNoTHItems, bool aExcludeDNP, bool aExcludeBOM, bool aTopSide,
                                     bool aBottomSide, bool aFormatCSV, bool aUseAuxOrigin,
                                     bool aNegateBottomX );
 
    void OnFileHistory( wxCommandEvent& event );
    void OnClearFileHistory( wxCommandEvent& aEvent );
 
    bool SaveBoard( bool aSaveAs = false, bool aSaveCopy = false );

    bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;

    bool SavePcbFile( const wxString& aFileName, bool addToHistory = true,
                      bool aChangeProject = true );

    bool SavePcbCopy( const wxString& aFileName, bool aCreateProject = false,
                      bool aHeadless = false );

    bool Clear_Pcb( bool doAskAboutUnsavedChanges, bool aFinal = false );

    void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr ) override
    {
        SetBoard( aBoard, true, aReporter );
    }
 
    void SetBoard( BOARD* aBoard, bool aBuildConnectivity, PROGRESS_REPORTER* aReporter = nullptr );

    BOARD_ITEM_CONTAINER* GetModel() const override;
 
    std::unique_ptr<GRID_HELPER> MakeGridHelper() override;

    void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
 
    bool SaveBoardAsDesignBlock( const wxString& aLibraryName );
 
    bool SaveSelectionAsDesignBlock( const wxString& aLibraryName );
 
    bool UpdateDesignBlockFromBoard( const LIB_ID& aLibId );
 
    bool UpdateDesignBlockFromSelection( const LIB_ID& aLibId );
 
    PCB_DESIGN_BLOCK_PANE* GetDesignBlockPane() const { return m_designBlocksPane; }

    void ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName = wxEmptyString,
                                    wxString* aLibPath = nullptr );

    bool ExportVRML_File( const wxString& aFullFileName, double aMMtoWRMLunit,
                          bool aIncludeUnspecified, bool aIncludeDNP,
                          bool aExport3DFiles, bool aUseRelativePaths,
                          const wxString& a3D_Subdir, double aXRef, double aYRef );

    bool Export_IDF3( BOARD* aPcb, const wxString& aFullFileName,
                      bool aUseThou, double aXRef, double aYRef,
                      bool aIncludeUnspecified, bool aIncludeDNP );

    bool ExportSpecctraFile( const wxString& aFullFilename );

    bool ImportSpecctraSession( const wxString& aFullFilename );
 
    // Footprint editing (see also PCB_BASE_FRAME)
    void ShowFootprintPropertiesDialog( FOOTPRINT* aFootprint );
 
    int ShowExchangeFootprintsDialog( FOOTPRINT* aFootprint, bool aUpdateMode, bool aSelectedMode );

    void OnEditItemRequest( BOARD_ITEM* aItem ) override;

    void SwitchLayer( PCB_LAYER_ID layer ) override;

    void SetTrackSegmentWidth( PCB_TRACK* aItem, PICKED_ITEMS_LIST* aItemsListPicker,
                               bool aUseDesignRules );
 

    void Edit_Zone_Params( ZONE* zone_container );
 
    // Properties dialogs
    void ShowTargetOptionsDialog( PCB_TARGET* aTarget );
    void InstallNetlistFrame();

    bool FetchNetlistFromSchematic( NETLIST& aNetlist, const wxString& aAnnotateMessage );

    int TestStandalone();

    bool ReadNetlistFromFile( const wxString& aFilename, NETLIST& aNetlist, REPORTER& aReporter );

    void OnNetlistChanged( BOARD_NETLIST_UPDATER& aUpdater, bool* aRunDragCommand );

    void SendSelectItemsToSch( const std::deque<EDA_ITEM*>& aItems, EDA_ITEM* aFocusItem,
                               bool aForce );

    void SendCrossProbeItem( BOARD_ITEM* aSyncItem );

    void SendCrossProbeNetName( const wxString& aNetName );
 
    void ShowChangedLanguage() override;

    void OnBoardLoaded();

    void UpdateTitle();

    void CommonSettingsChanged( int aFlags ) override;

    void ThemeChanged() override;
 
    void ProjectChanged() override;
 
    bool CanAcceptApiCommands() override;
 
    wxString GetCurrentFileName() const override;
 
    SELECTION& GetCurrentSelection() override;
 
    TOOL_ACTION* GetExportNetlistAction() { return m_exportNetlistAction; }
 
    DIALOG_BOOK_REPORTER* GetInspectDrcErrorDialog();
 
    DIALOG_BOOK_REPORTER* GetInspectConstraintsDialog();
 
    DIALOG_BOOK_REPORTER* GetInspectClearanceDialog();
 
    DIALOG_BOOK_REPORTER* GetFootprintDiffDialog();
 
    DIALOG_FOOTPRINT_FIELDS_TABLE* GetFootprintFieldsTableDialog();
    bool                           CloseFootprintFieldsTableDialog();

    bool DoAutoSave();
 
    void ClearToolbarControl( int aId ) override;
 
    DECLARE_EVENT_TABLE()
 
protected:
    struct LAYER_TOOLBAR_ICON_VALUES
    {
        int     previous_icon_size;
        COLOR4D previous_Route_Layer_TOP_color;
        COLOR4D previous_Route_Layer_BOTTOM_color;
        COLOR4D previous_background_color;
 
        LAYER_TOOLBAR_ICON_VALUES()
                : previous_icon_size( 0 ),
                  previous_Route_Layer_TOP_color( COLOR4D::UNSPECIFIED ),
                  previous_Route_Layer_BOTTOM_color( COLOR4D::UNSPECIFIED ),
                  previous_background_color( COLOR4D::UNSPECIFIED )
        {
        }
    };
 
    LAYER_TOOLBAR_ICON_VALUES m_prevIconVal;
 
    void doReCreateMenuBar() override;
 
    void configureToolbars() override;
 
    void ReCreateAuxiliaryToolbar() override;
 
    // The Tool Framework initialization
    void setupTools();
    void setupUIConditions() override;

    void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
 
    PLUGIN_ACTION_SCOPE PluginActionScope() const override { return PLUGIN_ACTION_SCOPE::PCB; }

    bool doAutoSave() override { return DoAutoSave(); }
 
    bool canRunAutoSave() const override;

    bool interactiveOperationInProgress() const;

    bool importFile( const wxString& aFileName, int aFileType,
                     const std::map<std::string, UTF8>* aProperties = nullptr );

    void reconcileImportedFootprintLibraries(
            std::vector<std::unique_ptr<FOOTPRINT>> aDefinitions, const wxString& aBoardPath );

    bool saveBoardAsFile( BOARD& aBoard, const wxString& aFileName, bool aHeadless = false );
 
    bool saveSelectionToDesignBlock( const wxString& aNickname, PCB_SELECTION& aSelection, DESIGN_BLOCK& aBlock );
 
 
    bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
    void doCloseWindow() override;
 
    // protected so that PCB::IFACE::CreateWindow() is the only factory.
    PCB_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
 
    void onSize( wxSizeEvent& aEvent );
 
    int inferLegacyEdgeClearance( BOARD* aBoard, bool aShowUserMsg = true );
 
    void redrawNetnames();
 
    void saveProjectSettings() override;
 
    void onCloseModelessBookReporterDialogs( wxCommandEvent& aEvent );
    void onCloseFootprintFieldsTableDialog( wxCommandEvent& aEvent );
 
    void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
 
public:
    wxChoice* m_SelTrackWidthBox;        // a choice box to display and select current track width
    wxChoice* m_SelViaSizeBox;           // a choice box to display and select current via diameter
    wxChoice* m_SelViaStackBox;          // a choice box to display and select current via stack preset
    wxChoice* m_CurrentVariantCtrl;      // a choice box to display and select current variant
 
    bool      m_ShowLayerManagerTools;
    bool      m_ShowSearch;
    bool      m_ShowNetInspector;
 
    bool      m_ZoneFillsDirty;          // Board has been modified since last zone fill.
 
    bool      m_ProbingSchToPcb;         // Recursion guard when synchronizing selection from schematic

    std::size_t             m_textVarListenerHandle = 0;
    class TEXT_VAR_TRACKER* m_textVarListenerTracker = nullptr;

    void detachTextVarTracker();
 
    void StartCrossProbeFlash( const std::vector<BOARD_ITEM*>& aItems );
    void OnCrossProbeFlashTimer( wxTimerEvent& aEvent );
    void UpdateProperties() override;
 
private:
    friend struct PCB::IFACE;
    friend class APPEARANCE_CONTROLS;

    TOOL_ACTION* m_exportNetlistAction;
 
    DIALOG_FIND*               m_findDialog;
    DIALOG_FIND_BY_PROPERTIES* m_findByPropertiesDialog;
    DIALOG_BOOK_REPORTER*      m_inspectDrcErrorDlg;
    DIALOG_BOOK_REPORTER*      m_inspectClearanceDlg;
    DIALOG_BOOK_REPORTER*      m_inspectConstraintsDlg;
    DIALOG_BOOK_REPORTER*      m_footprintDiffDlg;
    DIALOG_BOARD_SETUP*        m_boardSetupDlg;
    DIALOG_FOOTPRINT_FIELDS_TABLE* m_footprintFieldsTableDialog;
 
    std::vector<LIB_ID>    m_designBlockHistoryList;
    PCB_DESIGN_BLOCK_PANE* m_designBlocksPane;
    // Tool Reset() reads this before the ctor creates the panel.
    PANEL_CONSTRAINTS* m_constraintsPanel = nullptr; 

    WX_INFOBAR*            m_loadNoticeInfoBar = nullptr;
 
    const std::map<std::string, UTF8>* m_importProperties; // Properties used for non-KiCad import.

    BOX2D             m_lastNetnamesViewport;
 
    wxTimer*          m_eventCounterTimer;
 
    // Cross-probe flashing support
    wxTimer           m_crossProbeFlashTimer;          
    int               m_crossProbeFlashPhase = 0;      
    std::vector<KIID> m_crossProbeFlashItems;          
    bool              m_crossProbeFlashing = false;    
 
    // Most recent schematic path (default to root), used in the footprint fields
    // table to enable the same schematic scope limiting as the symbol fields table
    KIID_PATH         m_lastSchematicSheetPath;
 
    std::unique_ptr<API_HANDLER_PCB>    m_apiHandler;
    std::unique_ptr<API_HANDLER_COMMON> m_apiHandlerCommon;
    std::unique_ptr<API_HANDLER_LIBRARIES> m_apiLibrariesHandler;
};
 
#endif  // __PCB_EDIT_FRAME_H__