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 (C) 2010-2023 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 <http://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>
 
class ACTION_PLUGIN;
class PCB_SCREEN;
class BOARD;
class BOARD_COMMIT;
class BOARD_ITEM_CONTAINER;
class DIALOG_BOOK_REPORTER;
class FOOTPRINT;
class PCB_TRACK;
class PCB_VIA;
class PAD;
class PCB_TARGET;
class PCB_GROUP;
class PCB_DIMENSION_BASE;
class DRC;
class DIALOG_FIND;
class DIALOG_PLOT;
class ZONE;
class GENERAL_COLLECTOR;
class GENERAL_COLLECTORS_GUIDE;
class SELECTION;
class PCB_MARKER;
class BOARD_ITEM;
class PCB_LAYER_BOX_SELECTOR;
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;
 
#ifdef KICAD_IPC_API
class KICAD_API_SERVER;
class API_HANDLER_PCB;
class API_HANDLER_COMMON;
#endif
 
enum LAST_PATH_TYPE : unsigned int;
 
namespace PCB { struct IFACE; }     // KIFACE is in pcbnew.cpp
 
class PCB_EDIT_FRAME : public PCB_BASE_EDIT_FRAME
{
public:
    virtual ~PCB_EDIT_FRAME();
 
    void LoadFootprints( NETLIST& aNetlist, REPORTER& aReporter );
 
    void OnQuit( wxCommandEvent& event );
 
    bool IsContentModified() const override;
 
    void PythonSyncEnvironmentVariables();
 
    void PythonSyncProjectName();
 
    void UpdateUserInterface();
 
    void HardRedraw() override;
 
    void RebuildAndRefresh();
 
    void ExecuteRemoteCommand( const char* cmdline ) override;
 
    void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
 
    std::vector<BOARD_ITEM*> FindItemsFromSyncSelection( std::string syncStr );
 
    static const wxString SearchPaneName() { return wxT( "Search" ); }
 
    void ShowFindDialog();
 
    void FindNext( bool reverse = false );
 
    void ToPlotter( int aID );
 
    void ExportSVG( wxCommandEvent& event );
 
    // User interface update command event handlers.
    void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
 
    bool LayerManagerShown();
    bool PropertiesShown();
    bool NetInspectorShown();
 
    void OnUpdateSelectViaSize( wxUpdateUIEvent& aEvent );
    void OnUpdateSelectTrackWidth( wxUpdateUIEvent& aEvent );
    void OnUpdateSelectAutoWidth( wxUpdateUIEvent& aEvent );
 
    void RunEeschema();
 
    void UpdateTrackWidthSelectBox( wxChoice* aTrackWidthSelectBox, bool aShowNetclass,
                                    bool aShowEdit );
    void UpdateViaSizeSelectBox( wxChoice* aViaSizeSelectBox, bool aShowNetclass, bool aShowEdit );
 
    EDA_ANGLE GetRotationAngle() const override;
 
    COLOR4D GetGridColor() override;
 
    void SetGridColor( const COLOR4D& aColor ) override;
 
    static bool GetActionPluginButtonVisible( const wxString& aPluginPath, bool aPluginDefault );
 
    static std::vector<ACTION_PLUGIN*> GetOrderedActionPlugins();
 
    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 ReCreateHToolbar() override;
    void ReCreateAuxiliaryToolbar() override;
    void ReCreateVToolbar() override;
    void ReCreateOptToolbar() override;
    void UpdateToolbarControlSizes() override;
 
    void ReCreateLayerBox( bool aForceResizeToolbar = true );
 
 
    void OnModify() override;
 
    void SetActiveLayer( PCB_LAYER_ID aLayer ) override;
 
    void OnDisplayOptionsChanged() override;
 
    bool IsElementVisible( GAL_LAYER_ID aElement ) const;
 
    void SetElementVisibility( GAL_LAYER_ID aElement, bool aNewState );
 
    void ActivateGalCanvas() override;
 
    void ShowBoardSetupDialog( const wxString& aInitialPage = wxEmptyString );
 
    void PrepareLayerIndicator( bool aForceRebuild = false );
 
    void ToggleLayersManager();
 
    void ToggleNetInspector();
 
    void ToggleSearch();
 
    int DoGenFootprintsPositionFile( const wxString& aFullFileName, bool aUnitsMM, bool aOnlySMD,
                                     bool aNoTHItems, bool aExcludeDNP, bool aTopSide, bool aBottomSide,
                                     bool aFormatCSV, bool aUseAuxOrigin, bool aNegateBottomX );
 
    void GenFootprintsReport( wxCommandEvent& event );
 
    void GenIPC2581File( wxCommandEvent& event );
 
    void GenODBPPFiles( wxCommandEvent& event );
 
    bool DoGenFootprintsReport( const wxString& aFullFilename, bool aUnitsMM );
 
    void GenD356File( wxCommandEvent& event );
 
    void OnFileHistory( wxCommandEvent& event );
    void OnClearFileHistory( wxCommandEvent& aEvent );
 
    void Files_io( wxCommandEvent& event );
 
    bool Files_io_from_id( int aId );
 
    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 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;
 
    void RecreateCmpFileFromBoard( wxCommandEvent& aEvent );
 
    void ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName = wxEmptyString,
                                    wxString* aLibPath = nullptr );
 
    void RecreateBOMFileFromBoard( wxCommandEvent& aEvent );
 
    void ExportToGenCAD( wxCommandEvent& event );
 
    void OnExportVRML( wxCommandEvent& event );
 
    bool ExportVRML_File( const wxString& aFullFileName, double aMMtoWRMLunit,
                          bool aIncludeUnspecified, bool aIncludeDNP,
                          bool aExport3DFiles, bool aUseRelativePaths,
                          const wxString& a3D_Subdir, double aXRef, double aYRef );
 
    void OnExportIDF3( wxCommandEvent& event );
 
    void OnExportHyperlynx( wxCommandEvent& event );
 
    bool Export_IDF3( BOARD* aPcb, const wxString& aFullFileName,
                      bool aUseThou, double aXRef, double aYRef,
                      bool aIncludeUnspecified, bool aIncludeDNP );
 
    void OnExportSTEP( wxCommandEvent& event );
 
    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 ExchangeFootprint( FOOTPRINT* aExisting, FOOTPRINT* aNew, BOARD_COMMIT& aCommit,
                            bool deleteExtraTexts = true, bool resetTextLayers = true,
                            bool resetTextEffects = true, bool resetFabricationAttrs = true,
                            bool resetTextContent = true, bool reset3DModels = true,
                            bool* aUpdated = nullptr );
 
    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 UpdateTitle();
 
    void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) 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();
 
    DECLARE_EVENT_TABLE()
 
protected:
    struct LAYER_TOOLBAR_ICON_VALUES
    {
        int     previous_requested_scale;
        COLOR4D previous_Route_Layer_TOP_color;
        COLOR4D previous_Route_Layer_BOTTOM_color;
        COLOR4D previous_background_color;
 
        LAYER_TOOLBAR_ICON_VALUES()
                : previous_requested_scale( 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;
 
    // The Tool Framework initialization
    void setupTools();
    void setupUIConditions() override;
 
    void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
 
    void buildActionPluginMenus( ACTION_MENU* aActionMenu );
 
    void AddActionPluginTools();
 
    void RunActionPlugin( ACTION_PLUGIN* aActionPlugin );
 
    void OnActionPluginMenu( wxCommandEvent& aEvent);
 
    void OnActionPluginButton( wxCommandEvent& aEvent );
 
    PLUGIN_ACTION_SCOPE PluginActionScope() const override { return PLUGIN_ACTION_SCOPE::PCB; }
 
    void onBoardLoaded();
 
    bool doAutoSave() override;
 
    bool importFile( const wxString& aFileName, int aFileType,
                     const std::map<std::string, UTF8>* aProperties = nullptr );
 
    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 );
 
#ifdef KICAD_IPC_API
    void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
#endif
 
public:
    PCB_LAYER_BOX_SELECTOR* m_SelLayerBox; // a combo box to display and select active layer
 
    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
 
    bool m_show_layer_manager_tools;
    bool m_show_search;
    bool m_show_net_inspector;
 
    bool m_ZoneFillsDirty;          // Board has been modified since last zone fill.
 
    bool m_probingSchToPcb;         // Recursion guard when synchronizing selection from schematic
 
private:
    friend struct PCB::IFACE;
    friend class APPEARANCE_CONTROLS;
 
    TOOL_ACTION* m_exportNetlistAction;
 
    DIALOG_FIND* m_findDialog;
    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;
 
    const std::map<std::string, UTF8>* m_importProperties; // Properties used for non-KiCad import.
 
    BOX2D        m_lastNetnamesViewport;
 
    wxTimer*     m_eventCounterTimer;
 
#ifdef KICAD_IPC_API
    std::unique_ptr<API_HANDLER_PCB> m_apiHandler;
    std::unique_ptr<API_HANDLER_COMMON> m_apiHandlerCommon;
#endif
};
 
#endif  // __PCB_EDIT_FRAME_H__