sch_base_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) 2015 SoftPLC Corporation, Dick Hollenbeck <[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 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 SCH_BASE_FRAME_H_
#define SCH_BASE_FRAME_H_
 
#include <eda_draw_frame.h>
#include <frame_type.h>
#include <libraries/library_table.h>
#include <sch_draw_panel.h>
#include <sch_screen.h>
#include <schematic_settings.h>
#include <variant_symbol_utils.h>
 
#include <stddef.h>
#include <utility>
#include <future>
#include <vector>
#include <wx/event.h>
#include <wx/datetime.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <wx/timer.h>
 
#include <template_fieldnames.h>
 
 
class SCH_RENDER_SETTINGS;
class PAGE_INFO;
class TITLE_BLOCK;
class SYMBOL_VIEWER_FRAME;
class SYMBOL_EDIT_FRAME;
class LIB_SYMBOL;
class LEGACY_SYMBOL_LIB;
class SYMBOL_LIBRARY_FILTER;
class LIB_ID;
class SYMBOL_LIBRARY_ADAPTER;
class EESCHEMA_SETTINGS;
class SYMBOL_EDITOR_SETTINGS;
struct SCH_SELECTION_FILTER_OPTIONS;
 
#if defined(__linux__) || defined(__FreeBSD__)
class SPNAV_2D_PLUGIN;
#else
class NL_SCHEMATIC_PLUGIN;
#endif
 
class PANEL_SCH_SELECTION_FILTER;
class DIALOG_SCH_FIND;
struct BACKGROUND_JOB;
 
#ifdef wxHAS_INOTIFY
#define wxFileSystemWatcher wxInotifyFileSystemWatcher
#elif defined( wxHAS_KQUEUE ) && defined( wxHAVE_FSEVENTS_FILE_NOTIFICATIONS )
#define wxFileSystemWatcher wxFsEventsFileSystemWatcher
#elif defined( wxHAS_KQUEUE )
#define wxFileSystemWatcher wxKqueueFileSystemWatcher
#elif defined( __WINDOWS__ )
#define wxFileSystemWatcher wxMSWFileSystemWatcher
#else
#define wxFileSystemWatcher wxPollingFileSystemWatcher
#endif
 
class wxFileSystemWatcher;
class wxFileSystemWatcherEvent;

LIB_SYMBOL* SchGetLibSymbol( const LIB_ID& aLibId, SYMBOL_LIBRARY_ADAPTER* aLibMgr,
                             LEGACY_SYMBOL_LIB* aCacheLib = nullptr, wxWindow* aParent = nullptr,
                             bool aShowErrorMsg = false );

class SCH_BASE_FRAME : public EDA_DRAW_FRAME, public SCHEMATIC_HOLDER
{
public:
    SCH_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aWindowType, const wxString& aTitle,
                    const wxPoint& aPosition, const wxSize& aSize, long aStyle,
                    const wxString & aFrameName );
 
    virtual ~SCH_BASE_FRAME();
 
    void createCanvas();
 
    SCH_DRAW_PANEL* GetCanvas() const override;
    SCH_SCREEN* GetScreen() const override;
 
    EESCHEMA_SETTINGS* eeconfig() const;
 
    SYMBOL_EDITOR_SETTINGS* libeditconfig() const;
 
    APP_SETTINGS_BASE* GetViewerSettingsBase() const;
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    SCH_RENDER_SETTINGS* GetRenderSettings();
 
    COLOR4D GetDrawBgColor() const override;

    virtual bool GetShowAllPins() const { return true; }
 
    void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
    const PAGE_INFO& GetPageSettings () const override;
    const VECTOR2I   GetPageSizeIU() const override;
 
    const VECTOR2I& GetGridOrigin() const override
    {
        static VECTOR2I zero;
        return zero;
    }
    void SetGridOrigin( const VECTOR2I& aPoint ) override {}
 
    const TITLE_BLOCK& GetTitleBlock() const override;
    void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
 
    void UpdateStatusBar() override;

    PICKED_SYMBOL PickSymbolFromLibrary( const SYMBOL_LIBRARY_FILTER* aFilter,
                                         std::vector<PICKED_SYMBOL>&  aHistoryList,
                                         std::vector<PICKED_SYMBOL>&  aAlreadyPlaced,
                                         bool aShowFootprints, const LIB_ID* aHighlight = nullptr,
                                         bool aAllowFields = true,
                                         SYMBOL_COMPAT_FUNC aCompatFunc = nullptr );

    LIB_SYMBOL* GetLibSymbol( const LIB_ID& aLibId, bool aUseCacheLib = false,
                              bool aShowErrorMsg = false );

    wxString SelectLibrary( const wxString& aDialogTitle, const wxString& aListLabel,
                            const std::vector<std::pair<wxString, bool*>>& aExtraCheckboxes = {} );
 
    virtual void RedrawScreen( const VECTOR2I& aCenterPoint, bool aWarpPointer );
 
    void HardRedraw() override;

    void AddToScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen = nullptr ) override;

    void RemoveFromScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen ) override;

    virtual void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
                             bool aUpdateRtree = false );

    void RefreshZoomDependentItems();

    void SyncView();

    void ShowFindReplaceDialog( bool aReplace );
 
    DIALOG_SCH_FIND* GetFindReplaceDialog() const { return m_findReplaceDialog; }
 
    void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
    void ClearFindReplaceStatus();

    void OnFindDialogClose();
 
    void CommonSettingsChanged( int aFlags ) override;

    COLOR4D GetLayerColor( SCH_LAYER_ID aLayer );
 
    COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
    void ActivateGalCanvas() override;

    void OnSymChange( wxFileSystemWatcherEvent& aEvent );

    void OnSymChangeDebounceTimer( wxTimerEvent& aEvent );

    void SetSymModificationTime( long long aTimestamp )
    {
        m_watcherTimestamp = aTimestamp;
    }
 
    SCH_SELECTION_TOOL* GetSelectionTool() override;
 
    void GetLibraryItemsForListDialog( wxArrayString& aHeaders, std::vector<wxArrayString>& aItemsToDisplay );
 
    void HighlightSelectionFilter( const SCH_SELECTION_FILTER_OPTIONS& aOptions );
 
protected:
    void handleActivateEvent( wxActivateEvent& aEvent ) override;
 
    void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
 
    void doCloseWindow() override;

    void setSymWatcher( const LIB_ID* aSymbol );

    virtual void updateSelectionFilterVisbility() {}
 
protected:
    PANEL_SCH_SELECTION_FILTER* m_selectionFilterPanel;
    DIALOG_SCH_FIND*            m_findReplaceDialog;

    SCHEMATIC_SETTINGS          m_base_frame_defaults;
 
private:

    std::unique_ptr<wxFileSystemWatcher>    m_watcher;
    wxFileName                              m_watcherFileName;
    long long                               m_watcherTimestamp;
    bool                                    m_watcherIsDir;
    wxTimer                                 m_watcherDebounceTimer;
    bool                                    m_inSymChangeTimerEvent;
 
#if defined(__linux__) || defined(__FreeBSD__)
    std::unique_ptr<SPNAV_2D_PLUGIN>        m_spaceMouse;
#else
    std::unique_ptr<NL_SCHEMATIC_PLUGIN>    m_spaceMouse;
#endif
};
 
#endif // SCH_BASE_FRAME_H_