symbol_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) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2024 KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2017 CERN
 * @author Maciej Suminski <[email protected]>
 *
 * 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 SYMBOL_EDIT_FRAME_H
#define SYMBOL_EDIT_FRAME_H
 
#include <sch_base_frame.h>
#include <sch_screen.h>
#include <ee_collectors.h>
#include <optional>
 
class SCH_EDIT_FRAME;
class SYMBOL_LIB_TABLE;
class LIB_SYMBOL;
class SYMBOL_TREE_PANE;
class LIB_TREE_NODE;
class LIB_ID;
class LIB_SYMBOL_LIBRARY_MANAGER;
class SYMBOL_EDITOR_SETTINGS;
class EDA_LIST_DIALOG;
 
 
class SYMBOL_EDIT_FRAME : public SCH_BASE_FRAME
{
public:
 SYMBOL_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
 
 ~SYMBOL_EDIT_FRAME() override;
 
 void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
 
 bool IsContentModified() const override;
 
 bool HasLibModifications() const;
 
 bool CanCloseSymbolFromSchematic( bool doClose );
 
 wxString GetCurLib() const;
 
 wxString SetCurLib( const wxString& aLibNickname );
 
 LIB_TREE_NODE* GetCurrentTreeNode() const;
 
 LIB_ID GetTreeLIBID( int* aUnit = nullptr ) const;
 
 int GetTreeSelectionCount() const;
 
 int GetTreeLIBIDs( std::vector<LIB_ID>& aSelection ) const;
 
 LIB_SYMBOL* GetCurSymbol() const { return m_symbol; }
 
 void SetCurSymbol( LIB_SYMBOL* aSymbol, bool aUpdateZoom );
 
 LIB_SYMBOL_LIBRARY_MANAGER& GetLibManager();
 
 SELECTION& GetCurrentSelection() override;
 
 // See comments for m_SyncPinEdit.
 bool SynchronizePins();
 
 wxString AddLibraryFile( bool aCreateNew );
 
 void DdAddLibrary( wxString aLibFile );
 
 void CreateNewSymbol( const wxString& newName = wxEmptyString );
 
 void ImportSymbol();
 void ExportSymbol();
 
 void Save();
 
 void SaveSymbolCopyAs();
 
 void SaveLibraryAs();
 
 void SaveAll();
 
 void Revert( bool aConfirm = true );
 void RevertAll();
 
 void DeleteSymbolFromLibrary();
 
 void CopySymbolToClipboard();
 
 void LoadSymbol( const wxString& aLibrary, const wxString& aSymbol, int Unit );
 
 void DuplicateSymbol( bool aFromClipboard );
 
 void OnSelectUnit( wxCommandEvent& event );
 
 void OnToggleSymbolTree( wxCommandEvent& event );
 
 void ToggleProperties() override;
 
 bool IsSymbolTreeShown() const;
 void FreezeLibraryTree();
 void ThawLibraryTree();
 
 void OnUpdateUnitNumber( wxUpdateUIEvent& event );
 
 void UpdateAfterSymbolProperties( wxString* aOldName = nullptr );
 void RebuildSymbolUnitsList();
 
 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
 void doCloseWindow() override;
 void OnExitKiCad( wxCommandEvent& event );
 void ReCreateHToolbar() override;
 void ReCreateVToolbar() override;
 void ReCreateOptToolbar() override;
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 SYMBOL_EDITOR_SETTINGS* GetSettings() const
 {
 return m_settings;
 }
 
 APP_SETTINGS_BASE* config() const override;
 
 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
 void CloseWindow( wxCommandEvent& event )
 {
 // Generate a wxCloseEvent
 Close( false );
 }
 
 void OnModify() override;
 
 int GetUnit() const { return m_unit; }
 void SetUnit( int aUnit ) { m_unit = aUnit; }
 
 int GetBodyStyle() const { return m_bodyStyle; }
 void SetBodyStyle( int aBodyStyle ) { m_bodyStyle = aBodyStyle; }
 
 bool GetShowDeMorgan() const { return m_showDeMorgan; }
 void SetShowDeMorgan( bool show ) { m_showDeMorgan = show; }
 
 bool GetShowInvisibleFields();
 bool GetShowInvisiblePins();
 
 void ClearMsgPanel() override
 {
 UpdateSymbolMsgPanelInfo();
 }
 
 void UpdateMsgPanel() override
 {
 UpdateSymbolMsgPanelInfo();
 }
 
 void UpdateTitle();
 
 bool IsSymbolFromSchematic() const
 {
 // If we've already vetted closing this window, then we have no symbol anymore
 if( m_isClosing )
 return false;
 
 return m_isSymbolFromSchematic;
 }
 
 bool IsSymbolFromLegacyLibrary() const;
 
 void UpdateSymbolMsgPanelInfo();
 
 // General editing
 void SaveCopyInUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbol,
 UNDO_REDO aUndoType = UNDO_REDO::LIBEDIT );
 
 void PushSymbolToUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbolCopy,
 UNDO_REDO aUndoType = UNDO_REDO::LIBEDIT );
 
 void GetSymbolFromUndoList();
 void GetSymbolFromRedoList();
 
 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
 
 bool LoadSymbol( const LIB_ID& aLibId, int aUnit, int aBodyStyle );
 
 void PrintPage( const RENDER_SETTINGS* aSettings ) override;
 
 void SVGPlotSymbol( const wxString& aFullFileName, const VECTOR2I& aOffset );
 
 void SyncLibraries( bool aShowProgress, bool aPreloadCancelled = false,
 const wxString& aForceRefresh = wxEmptyString );
 
 void RegenerateLibraryTree();
 
 void RefreshLibraryTree();
 
 void UpdateLibraryTree( const wxDataViewItem& aTreeItem, LIB_SYMBOL* aSymbol );
 
 LIB_ID GetTargetLibId() const;
 
 std::vector<LIB_ID> GetSelectedLibIds() const;
 
 void FocusOnLibId( const LIB_ID& aLibID );
 
 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 
 void ShowChangedLanguage() override;
 
 void SetScreen( BASE_SCREEN* aScreen ) override;
 
 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
 
 void RebuildView();
 
 void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
 bool aUpdateRtree = false ) override;
 
 void HardRedraw() override;
 
 void KiwayMailIn( KIWAY_EXPRESS& mail ) override;
 
 void FocusOnItem( SCH_ITEM* aItem );
 
 void LoadSymbolFromSchematic( SCH_SYMBOL* aSymbol );
 
 bool IsSymbolEditable() const;
 
 bool IsSymbolAlias() const;
 
 bool IsCurrentSymbol( const LIB_ID& aLibId ) const;
 
 void emptyScreen();
 
protected:
 void setupUIConditions() override;
 
 void doReCreateMenuBar() override;
 
 void updateSelectionFilterVisbility() override;
 
private:
 // Set up the tool framework
 void setupTools();
 
 void saveSymbolCopyAs();
 
 bool saveLibrary( const wxString& aLibrary, bool aNewFile );
 
 void SelectActiveLibrary( const wxString& aLibrary = wxEmptyString );
 
 bool LoadSymbolFromCurrentLib( const wxString& aAliasName, int aUnit = 0, int aBodyStyle = 0 );
 
 bool LoadOneLibrarySymbolAux( LIB_SYMBOL* aLibEntry, const wxString& aLibrary, int aUnit,
 int aBodyStyle );
 
 bool backupFile( const wxFileName& aOriginalFile, const wxString& aBackupExt );
 
 LIB_SYMBOL* getTargetSymbol() const;
 
 wxString getTargetLib() const;
 
 void centerItemIdleHandler( wxIdleEvent& aEvent );
 
 /*
 * Return true when the operation has succeeded (all requested libraries have been saved
 * or none was selected and confirmed by OK).
 *
 * @param aRequireConfirmation when true, the user must be asked to confirm.
 */
 bool saveAllLibraries( bool aRequireConfirmation );
 
 bool saveCurrentSymbol();
 
 void storeCurrentSymbol();
 
 void ensureUniqueName( LIB_SYMBOL* aSymbol, const wxString& aLibrary );
 
 enum TABLE_SCOPE
 {
 GLOBAL_LIB_TABLE,
 PROJECT_LIB_TABLE
 };
 
 bool addLibTableEntry( const wxString& aLibFile, TABLE_SCOPE aScope = GLOBAL_LIB_TABLE );
 
 bool replaceLibTableEntry( const wxString& aLibNickname, const wxString& aLibFile );
 
 DECLARE_EVENT_TABLE()
 
public:
 bool m_SyncPinEdit;
 
private:
 SCH_SCREEN* m_dummyScreen;
 
 LIB_SYMBOL* m_symbol; // a symbol I own, it is not in any library, but a
 // copy could be.
 wxComboBox* m_unitSelectBox; // a ComboBox to select a unit to edit (if the
 // symbol has multiple units)
 SYMBOL_TREE_PANE* m_treePane; // symbol search tree widget
 LIB_SYMBOL_LIBRARY_MANAGER* m_libMgr; // manager taking care of temporary modifications
 SYMBOL_EDITOR_SETTINGS* m_settings; // Handle to the settings
 
 LIB_ID m_centerItemOnIdle;
 
 // The unit number to edit and show
 int m_unit;
 
 // Show the normal shape (m_bodyStyle <= 1) or the DeMorgan converted shape (m_bodyStyle > 1)
 int m_bodyStyle;
 
 bool m_isSymbolFromSchematic;
 KIID m_schematicSymbolUUID;
 
 wxString m_reference;
 
 // True to force DeMorgan/normal tools selection enabled.
 // They are enabled when the loaded symbol has graphic items for converted shape
 // But under some circumstances (New symbol created) these tools must left enabled
 static bool m_showDeMorgan;
};
 
#endif // SYMBOL_EDIT_FRAME_H