footprint_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 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 FOOTPRINT_EDIT_FRAME_H
#define FOOTPRINT_EDIT_FRAME_H
 
#include <functional>
#include <memory>
#include <vector>
 
#include <pcb_base_frame.h>
#include <pcb_base_edit_frame.h>
#include <pcb_io/pcb_io_mgr.h>
#include <widgets/lib_tree.h>
#include <footprint_tree_pane.h>
#include <fp_tree_synchronizing_adapter.h>
 
class PCB_LAYER_BOX_SELECTOR;
class FP_LIB_TABLE;
class FOOTPRINT_TREE_PANE;
class SYMBOL_LIBRARY_MANAGER;
class FOOTPRINT_EDITOR_SETTINGS;
class EDA_LIST_DIALOG;
class EDITOR_TABS_PANEL;
class FOOTPRINT_EDITOR_TAB_CONTEXT;
class UNDO_REDO_CONTAINER;
 
class API_HANDLER_FOOTPRINT;
class API_HANDLER_COMMON;
class API_HANDLER_LIBRARIES;
 
namespace PCB { struct IFACE; }     // A KIFACE coded in pcbnew.cpp
 
 
class FOOTPRINT_EDIT_FRAME : public PCB_BASE_EDIT_FRAME
{
public:
    ~FOOTPRINT_EDIT_FRAME();

    static const wxChar* GetFootprintEditorFrameName();

    static FOOTPRINT_EDITOR_TAB_CONTEXT* placeReusedTabContext(
            std::vector<std::unique_ptr<FOOTPRINT_EDITOR_TAB_CONTEXT>>& aContexts, int aSlot,
            std::unique_ptr<FOOTPRINT_EDITOR_TAB_CONTEXT> aNew,
            const std::function<void( const FOOTPRINT_EDITOR_TAB_CONTEXT& )>& aInstallSuccessor );

    static bool prepareFootprintTabHandoff( FOOTPRINT* aFootprint, bool aHasTabs );

    enum class EDIT_NOTICE
    {
        NONE,           
        FROM_BOARD,     
        READ_ONLY_LIB   
    };

    static EDIT_NOTICE editNoticeFor( const FOOTPRINT* aFootprint, bool aIsFromBoard,
                                      const std::function<bool( const wxString& )>& aIsLibWritable );

    BOARD_ITEM_CONTAINER* GetModel() const override;
    SELECTION&            GetCurrentSelection() override;

    bool IsContentModified() const override;
 
    bool IsCurrentFPFromBoard() const;

    bool HandleUnsavedChanges( bool aFromBoardOnly );
 
    FOOTPRINT_EDITOR_SETTINGS* GetSettings();

    EDA_ANGLE GetRotationAngle() const override;
 
    APP_SETTINGS_BASE* config() const override;
 
    BOARD_DESIGN_SETTINGS& GetDesignSettings() const override;
 
    const PCB_PLOT_PARAMS& GetPlotSettings() const override;
    void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings ) override;
 
    MAGNETIC_SETTINGS* GetMagneticItemsSettings() override;
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
    std::unique_ptr<GRID_HELPER> MakeGridHelper() override;
 
    const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
 
    bool canCloseWindow( wxCloseEvent& Event ) override;
    void doCloseWindow() override;
    void CloseFootprintEditor( wxCommandEvent& Event );
    void OnExitKiCad( wxCommandEvent& aEvent );

    void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;

    void UpdateUserInterface();

    void UpdateMsgPanel() override;

    void HardRedraw() override;

    void ReCreateLayerBox( bool aForceResizeToolbar = true );
 
    void configureToolbars() override;
 
    PLUGIN_ACTION_SCOPE PluginActionScope() const override
    {
        return PLUGIN_ACTION_SCOPE::FOOTPRINT;
    }
 
    // The Tool Framework initialization, for GAL mode
    void setupTools();
 
    void OnSaveFootprintAsPng( wxCommandEvent& event );
 
    bool IsLibraryTreeShown() const override;
    void ToggleLibraryTree() override;
    void FocusLibraryTreeInput() override;
 
    void ToggleLayersManager();

    bool SaveLibraryAs( const wxString& aLibraryPath );

    void OnEditItemRequest( BOARD_ITEM* aItem ) override;
 
    void LoadFootprintFromLibrary( LIB_ID aFPID );

    bool BeginNewFootprint( const wxString& aLibrary );

    void CloseFootprintTab( const LIB_ID& aFPID );

    FOOTPRINT_EDITOR_TAB_CONTEXT* CreateUnsavedFootprintTab();

    void RenameFootprintTab( const LIB_ID& aOldId, const LIB_ID& aNewId );

    bool HasModifiedFootprintTabs() const;

    void RefreshLibraryFootprintTab( const FOOTPRINT& aFootprint );

    wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& GetLibTreeAdapter() { return m_adapter; }

    bool SaveFootprint( FOOTPRINT* aFootprint );
    bool DuplicateFootprint( FOOTPRINT* aFootprint );
    bool SaveFootprintAs( FOOTPRINT* aFootprint );
    bool SaveFootprintToBoard( bool aAddNew );
    bool SaveFootprintInLibrary( FOOTPRINT* aFootprint, const wxString& aLibraryName );
    bool RevertFootprint( bool aSkipConfirmation = false );

    void OnModify() override;

    void Clear_Pcb();

    LIB_ID GetLoadedFPID() const;

    LIB_ID GetTargetFPID() const;
 
    void ClearModify();

    void ExportFootprint( FOOTPRINT* aFootprint );

    FOOTPRINT* ImportFootprint( const wxString& aName = wxT( "" ) );

    bool LoadFootprintFromBoard( FOOTPRINT* aFootprint );

    FOOTPRINT* SelectFootprintFromBoard( BOARD* aPcb );

    bool DeleteFootprintFromLibrary( const LIB_ID& aFPID, bool aConfirm );

    COLOR4D GetGridColor() override;

    void SetActiveLayer( PCB_LAYER_ID aLayer ) override;
 
    void OnDisplayOptionsChanged() override;
 
    void ActivateGalCanvas() override;

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

    void AddFootprintToBoard( FOOTPRINT* aFootprint ) override;

    void ReloadFootprint( FOOTPRINT* aFootprint ) override;

    void ShowChangedLanguage() override;

    void CommonSettingsChanged( int aFlags ) override;
 
    LIB_TREE* GetLibTree() const override
    {
        return m_treePane->GetLibTree();
    }

    void SyncLibraryTree( [[maybe_unused]] bool aProgress );

    void RefreshLibraryTree();

    void UpdateLibraryTree( const wxDataViewItem& treeItem, FOOTPRINT* aFootprint );

    void UpdateView();
 
    void UpdateTitle();
 
    void FocusOnLibID( const LIB_ID& aLibID );
 
    void KiwayMailIn( KIWAY_MAIL_EVENT& mail ) override;

    EDITOR_TABS_PANEL* GetTabsPanel() const { return m_tabsPanel; }

    void AdvanceFootprintTab( bool aForward );

    void CloseActiveFootprintTab();
 
    DECLARE_EVENT_TABLE()
 
protected:
    FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );

    void resolveCanvasType() override;

    void initLibraryTree();
 
    void restoreLastFootprint();
    void retainLastFootprint();
 
    void updateEnabledLayers();

    void updateInfoBar();

    void doReCreateMenuBar() override;

    void editFootprintProperties( FOOTPRINT* aFootprint );
 
    void setupUIConditions() override;
 
    void onPluginAvailabilityChanged( wxCommandEvent& aEvt );
 
    void centerItemIdleHandler( wxIdleEvent& aEvent );

    void OnTabCharHook( wxKeyEvent& aEvent );
 
protected:
    FOOTPRINT_EDITOR_SETTINGS*  m_editorSettings;
 
private:
    friend struct PCB::IFACE;

    FOOTPRINT_EDITOR_TAB_CONTEXT* findOrCreateFootprintTab( const LIB_ID& aLibId, bool aAsPreview );

    FOOTPRINT_EDITOR_TAB_CONTEXT* findOrCreateFootprintInstanceTab( FOOTPRINT* aBoardFootprint );

    void installFootprintOnActiveBoard( FOOTPRINT* aFootprint );

    void activateFootprintTab( FOOTPRINT_EDITOR_TAB_CONTEXT* aCtx );

    void installFootprintTabBoard( FOOTPRINT_EDITOR_TAB_CONTEXT* aCtx, BOARD* aBoard );

    void detachActiveFootprintTab();

    void borrowBoardNonDestructive( BOARD* aBoard );

    bool promptAndCloseFootprintTab( int aIdx );

    bool hasDirtyInactiveTabs() const;

    void freeFootprintTabUndoRedo( FOOTPRINT_EDITOR_TAB_CONTEXT& aCtx );

    void freeUndoRedoCommandsWithItems( UNDO_REDO_CONTAINER& aUndo, UNDO_REDO_CONTAINER& aRedo );

    void refreshFootprintTabState();

    void detachTabsForFullClear( BOARD* aReplacement );

    bool activeBoardOwnedByTab() const;
 
    FOOTPRINT_TREE_PANE*        m_treePane;
    LIB_ID                      m_centerItemOnIdle;
 
    wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> m_adapter;
 
    bool                        m_show_layer_manager_tools;
 
    std::unique_ptr<FOOTPRINT>  m_originalFootprintCopy;
    wxString                    m_footprintNameWhenLoaded;
    std::map<KIID, KIID>        m_boardFootprintUuids;
 
    EDITOR_TABS_PANEL*          m_tabsPanel;
    FOOTPRINT_EDITOR_TAB_CONTEXT* m_activeTab;
    std::vector<std::unique_ptr<FOOTPRINT_EDITOR_TAB_CONTEXT>> m_tabContexts;

    bool                        m_suppressTabActivation;

    BOARD*                      m_protectedBorrowedBoard;

    bool m_silentFootprintTabClose;
 
    std::unique_ptr<API_HANDLER_FOOTPRINT> m_apiHandler;
    std::unique_ptr<API_HANDLER_COMMON>    m_apiHandlerCommon;
    std::unique_ptr<API_HANDLER_LIBRARIES> m_apiHandlerFpLibs;
};
 
#endif      // FOOTPRINT_EDIT_FRAME_H