301 lines
10 KiB
C++
301 lines
10 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2015-2022 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, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef SCH_BASE_FRAME_H_
|
|
#define SCH_BASE_FRAME_H_
|
|
|
|
#include <eda_draw_frame.h>
|
|
#include <frame_type.h>
|
|
#include <sch_draw_panel.h>
|
|
#include <sch_screen.h>
|
|
#include <schematic_settings.h>
|
|
|
|
#include <stddef.h>
|
|
#include <utility>
|
|
#include <vector>
|
|
#include <wx/event.h>
|
|
#include <wx/fswatcher.h>
|
|
#include <wx/datetime.h>
|
|
#include <wx/gdicmn.h>
|
|
#include <wx/string.h>
|
|
#include <wx/timer.h>
|
|
|
|
#include <template_fieldnames.h>
|
|
|
|
|
|
namespace KIGFX
|
|
{
|
|
class SCH_RENDER_SETTINGS;
|
|
}
|
|
|
|
class PAGE_INFO;
|
|
class TITLE_BLOCK;
|
|
class SYMBOL_VIEWER_FRAME;
|
|
class SYMBOL_EDIT_FRAME;
|
|
class LIB_SYMBOL;
|
|
class SYMBOL_LIB;
|
|
class SYMBOL_LIBRARY_FILTER;
|
|
class LIB_ID;
|
|
class SYMBOL_LIB_TABLE;
|
|
class EESCHEMA_SETTINGS;
|
|
class SYMBOL_EDITOR_SETTINGS;
|
|
class NL_SCHEMATIC_PLUGIN;
|
|
class PANEL_SCH_SELECTION_FILTER;
|
|
|
|
/**
|
|
* Load symbol from symbol library table.
|
|
*
|
|
* Check the symbol library table for the part defined by \a aLibId and optionally
|
|
* check the optional cache library.
|
|
*
|
|
* @param aLibId is the symbol library identifier to load.
|
|
* @param aLibTable is the #SYMBOL_LIBRARY_TABLE to load the alias from.
|
|
* @param aCacheLib is an optional cache library.
|
|
* @param aParent is an optional parent window when displaying an error message.
|
|
* @param aShowErrorMessage set to true to show any error messages.
|
|
*
|
|
* @return The symbol found in the library or NULL if the symbol was not found.
|
|
*/
|
|
LIB_SYMBOL* SchGetLibSymbol( const LIB_ID& aLibId, SYMBOL_LIB_TABLE* aLibTable,
|
|
SYMBOL_LIB* aCacheLib = nullptr, wxWindow* aParent = nullptr,
|
|
bool aShowErrorMsg = false );
|
|
|
|
/**
|
|
* A shim class between EDA_DRAW_FRAME and several derived classes:
|
|
* SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, and SCH_EDIT_FRAME, and it brings in a
|
|
* common way of handling the provided virtual functions for the derived classes.
|
|
*
|
|
* The motivation here is to switch onto GetScreen() for the underlying data model.
|
|
*
|
|
* @author Dick Hollenbeck
|
|
*/
|
|
class SCH_BASE_FRAME : public EDA_DRAW_FRAME
|
|
{
|
|
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;
|
|
|
|
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
KIGFX::SCH_RENDER_SETTINGS* GetRenderSettings();
|
|
|
|
COLOR4D GetDrawBgColor() const override;
|
|
|
|
/**
|
|
* Allow some frames to show/hide hidden pins. The default impl shows all pins.
|
|
*/
|
|
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;
|
|
|
|
/**
|
|
* Call the library viewer to select symbol to import into schematic.
|
|
* If the library viewer is currently running, it is closed and reopened in modal mode.
|
|
*
|
|
* aAllowFields chooses whether or not features that permit the user to edit fields
|
|
* (e.g. footprint selection) should be enabled. This should be false when they would
|
|
* have no effect, for example loading a part into symbol_editor.
|
|
*
|
|
* @param aFilter is an optional #SYMBOL_LIBRARY_FILTER filter to pass the allowed library names
|
|
* and/or the library name to load the symbol from and/or some other filter
|
|
* @param aHistoryList is the list of previously loaded symbols - will be edited
|
|
* @param aHighlight is the name of symbol to highlight in the list.
|
|
* highlights none if there isn't one by that name.
|
|
* @param aShowFootprints is the whether to show footprints in the dialog.
|
|
* @param aAllowFields is whether to allow field editing in the dialog.
|
|
*
|
|
* @return the selected symbol
|
|
*/
|
|
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 );
|
|
|
|
/**
|
|
* Load symbol from symbol library table.
|
|
*
|
|
* @param aLibId is the symbol library identifier to load.
|
|
* @param aUseCacheLib set to true to fall back to cache library if symbol is not found in
|
|
* symbol library table.
|
|
* @param aShowErrorMessage set to true to show any error messages.
|
|
* @return The symbol found in the library or NULL if the symbol was not found.
|
|
*/
|
|
LIB_SYMBOL* GetLibSymbol( const LIB_ID& aLibId, bool aUseCacheLib = false,
|
|
bool aShowErrorMsg = false );
|
|
|
|
/**
|
|
* Display a list of loaded libraries and allows the user to select a library.
|
|
*
|
|
* This list is sorted, with the library cache always at end of the list
|
|
*
|
|
* @return the library nickname used in the symbol library table.
|
|
*/
|
|
wxString SelectLibraryFromList();
|
|
|
|
/**
|
|
* Display a dialog asking the user to select a symbol library table.
|
|
*
|
|
* @param aOptional if set the Cancel button will be relabelled "Skip".
|
|
* @return Pointer to the selected symbol library table or nullptr if canceled.
|
|
*/
|
|
SYMBOL_LIB_TABLE* SelectSymLibTable( bool aOptional = false );
|
|
|
|
virtual void RedrawScreen( const VECTOR2I& aCenterPoint, bool aWarpPointer );
|
|
|
|
void HardRedraw() override;
|
|
|
|
/**
|
|
* Add an item to the screen (and view)
|
|
* aScreen is the screen the item is located on, if not the current screen
|
|
*/
|
|
void AddToScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen = nullptr );
|
|
|
|
/**
|
|
* Remove an item from the screen (and view)
|
|
* aScreen is the screen the item is located on, if not the current screen
|
|
*/
|
|
void RemoveFromScreen( EDA_ITEM* aItem, SCH_SCREEN* aScreen );
|
|
|
|
/**
|
|
* Mark an item for refresh.
|
|
*/
|
|
virtual void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
|
|
bool aUpdateRtree = false );
|
|
|
|
/**
|
|
* Mark selected items for refresh.
|
|
*/
|
|
void RefreshZoomDependentItems();
|
|
|
|
/**
|
|
* Mark all items for refresh.
|
|
*/
|
|
void SyncView();
|
|
|
|
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
|
|
|
|
/**
|
|
* Helper to retrieve a layer color from the global color settings
|
|
*/
|
|
COLOR4D GetLayerColor( SCH_LAYER_ID aLayer );
|
|
|
|
COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
|
|
|
|
void ActivateGalCanvas() override;
|
|
|
|
/**
|
|
* Handler for Symbol change events. Responds to the filesystem watcher set in #setSymWatcher.
|
|
*/
|
|
void OnSymChange( wxFileSystemWatcherEvent& aEvent );
|
|
|
|
/**
|
|
* Handler for the filesystem watcher debounce timer.
|
|
*/
|
|
void OnSymChangeDebounceTimer( wxTimerEvent& aEvent );
|
|
|
|
/**
|
|
* Set the modification time of the symbol library table file.
|
|
*
|
|
* This is used to detect changes to the symbol library table file.
|
|
*
|
|
* @param aTime is the modification time of the symbol library table file.
|
|
*/
|
|
void SetSymModificationTime( const wxDateTime& aTime )
|
|
{
|
|
m_watcherLastModified = aTime;
|
|
}
|
|
|
|
protected:
|
|
void handleActivateEvent( wxActivateEvent& aEvent ) override;
|
|
|
|
void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
|
|
|
|
/**
|
|
* Save Symbol Library Tables to disk.
|
|
*
|
|
* @param aGlobal when true, the Global Table is saved.
|
|
* @param aProject when true, the Project Table is saved.
|
|
* @return True when all requested actions succeeded.
|
|
*/
|
|
bool saveSymbolLibTables( bool aGlobal, bool aProject );
|
|
|
|
/**
|
|
* Creates (or removes) a watcher on the specified symbol library
|
|
* @param aSymbol If nullptr, the watcher is removed. Otherwise, set a change watcher
|
|
*/
|
|
void setSymWatcher( const LIB_ID* aSymbol );
|
|
|
|
/**
|
|
* Selection filter panel doesn't have a dedicated visibility control, so show it if any
|
|
* other AUI panel is shown and docked
|
|
*/
|
|
virtual void updateSelectionFilterVisbility() {}
|
|
|
|
/// These are only used by symbol_editor. Eeschema should be using the one inside
|
|
/// the SCHEMATIC.
|
|
SCHEMATIC_SETTINGS m_base_frame_defaults;
|
|
|
|
PANEL_SCH_SELECTION_FILTER* m_selectionFilterPanel;
|
|
|
|
private:
|
|
|
|
/// These are file watchers for the symbol library tables.
|
|
std::unique_ptr<wxFileSystemWatcher> m_watcher;
|
|
wxFileName m_watcherFileName;
|
|
wxDateTime m_watcherLastModified;
|
|
wxTimer m_watcherDebounceTimer;
|
|
|
|
NL_SCHEMATIC_PLUGIN* m_spaceMouse;
|
|
};
|
|
|
|
#endif // SCH_BASE_FRAME_H_
|