/* * 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 * Copyright (C) 2004-2017 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2017 CERN * @author Maciej Suminski * * 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 */ /** * @file libeditframe.h * @brief Definition of class LIB_EDIT_FRAME */ #ifndef LIBEDITFRM_H_ #define LIBEDITFRM_H_ #include #include #include #include #include class SCH_EDIT_FRAME; class SYMBOL_LIB_TABLE; class LIB_PART; class LIB_ALIAS; class LIB_FIELD; class DIALOG_LIB_EDIT_TEXT; class CMP_TREE_PANE; class LIB_ID; class LIB_MANAGER; /** * The symbol library editor main window. */ class LIB_EDIT_FRAME : public SCH_BASE_FRAME { LIB_PART* m_my_part; ///< a part I own, it is not in any library, but a copy could be. LIB_PART* m_tempCopyComponent; ///< temp copy of a part during edit, I own it here. LIB_COLLECTOR m_collectedItems; ///< Used for hit testing. wxComboBox* m_partSelectBox; ///< a Box to select a part to edit (if any) wxComboBox* m_aliasSelectBox; ///< a box to select the alias to edit (if any) CMP_TREE_PANE* m_treePane; ///< component search tree widget LIB_MANAGER* m_libMgr; ///< manager taking care of temporary modificatoins /** Convert of the item currently being drawn. */ bool m_drawSpecificConvert; /** * Specify which component parts the current draw item applies to. * * If true, the item being drawn or edited applies only to the selected * part. Otherwise it applies to all parts in the component. */ bool m_drawSpecificUnit; /** * Set to true to not synchronize pins at the same position when editing * components with multiple parts or multiple body styles. Setting this * to false allows editing each pin per part or body style individually. * This requires the user to open each part or body style to make changes * to the pin at the same location. */ bool m_editPinsPerPartOrConvert; /** * the option to show the pin electrical name in the component editor */ bool m_showPinElectricalTypeName; /** The current draw or edit graphic item fill style. */ static FILL_T m_drawFillStyle; /** Default line width for drawing or editing graphic items. */ static int m_drawLineWidth; static LIB_ITEM* m_lastDrawItem; static LIB_ITEM* m_drawItem; static wxString m_aliasName; // The unit number to edit and show static int m_unit; // Show the normal shape ( m_convert <= 1 ) or the converted shape // ( m_convert > 1 ) static int m_convert; // true to force DeMorgan/normal tools selection enabled. // They are enabled when the loaded component has // Graphic items for converted shape // But under some circumstances (New component created) // these tools must left enabled static bool m_showDeMorgan; /// The current text size setting. static int m_textSize; /// Current text angle setting. static double m_current_text_angle; /// The default pin num text size setting. static int m_textPinNumDefaultSize; /// The default pin name text size setting. static int m_textPinNameDefaultSize; /// Default pin length static int m_defaultPinLength; /// Default repeat offset for pins in repeat place pin int m_repeatPinStep; static wxSize m_clientSize; friend class DIALOG_LIB_EDIT_TEXT; LIB_ITEM* locateItem( const wxPoint& aPosition, const KICAD_T aFilterList[] ); public: LIB_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ); ~LIB_EDIT_FRAME(); /** The nickname of the current library being edited and empty string if none. */ wxString GetCurLib() const; /** Sets the current library nickname and returns the old library nickname. */ wxString SetCurLib( const wxString& aLibNickname ); /** * Return the current part being edited or NULL if none selected. * * This is a LIB_PART that I own, it is at best a copy of one in a library. */ LIB_PART* GetCurPart() const { return m_my_part; } /** * Take ownership of aPart and notes that it is the one currently being edited. */ void SetCurPart( LIB_PART* aPart ); /** @return the default pin num text size. */ static int GetPinNumDefaultSize() { return m_textPinNumDefaultSize; } /** @return The default pin name text size setting. */ static int GetPinNameDefaultSize() { return m_textPinNameDefaultSize; } /** @return The default pin len setting. */ static int GetDefaultPinLength() { return m_defaultPinLength; } /** Set the default pin len. */ static void SetDefaultPinLength( int aLength ) { m_defaultPinLength = aLength; } /** * @return the increment value of the position of a pin * for the pin repeat command */ int GetRepeatPinStep() const { return m_repeatPinStep; } /** * Sets the repeat step value for pins repeat command * @param aStep the increment value of the position of an item * for the repeat command */ void SetRepeatPinStep( int aStep) { m_repeatPinStep = aStep; } void ReCreateMenuBar() override; void InstallConfigFrame( wxCommandEvent& event ); void OnPreferencesOptions( wxCommandEvent& event ); void Process_Config( wxCommandEvent& event ); /** * @return True if the edit pins per part or convert is false and the current * component has multiple parts or body styles. Otherwise false is * returned. */ bool SynchronizePins(); /** * Plot the current symbol in SVG or PNG format. */ void OnPlotCurrentComponent( wxCommandEvent& event ); void Process_Special_Functions( wxCommandEvent& event ); void OnSelectTool( wxCommandEvent& aEvent ); /** * Creates a new library. The library is added to the project libraries table. */ void OnCreateNewLibrary( wxCommandEvent& aEvent ) { addLibraryFile( true ); } /** * Adds an existing library. The library is added to the project libraries table. */ void OnAddLibrary( wxCommandEvent& aEvent ) { addLibraryFile( false ); } /** * The command event handler to save the changes to the current library. * * A backup file of the current library is saved with the .bak extension before the * changes made to the library are saved. */ void OnSaveLibrary( wxCommandEvent& event ); /** * Saves all changes in modified libraries. */ void OnSaveAllLibraries( wxCommandEvent& event ); /** * Reverts unsaved changes in a library. */ void OnRevertLibrary( wxCommandEvent& aEvent ); /** * Creates a new part in the selected library. */ void OnCreateNewPart( wxCommandEvent& aEvent ); /** * Opens the selected part for editing. */ void OnEditPart( wxCommandEvent& aEvent ); /** * Routine to read one part. * The format is that of libraries, but it loads only 1 component. * Or 1 component if there are several. * If the first component is an alias, it will load the corresponding root. */ void OnImportPart( wxCommandEvent& event ); /** * Creates a new library and backup the current component in this library or exports * the component of the current library. */ void OnExportPart( wxCommandEvent& event ); /** * Saves a single part in the selected library. The library file is updated without including * the remaining unsaved changes. */ void OnSavePart( wxCommandEvent& aEvent ); /** * Reverts unsaved changes in a part, restoring to the last saved state. */ void OnRevertPart( wxCommandEvent& aEvent ); /** * Removes a part from the working copy of a library. */ void OnRemovePart( wxCommandEvent& aEvent ); void OnCopyCutPart( wxCommandEvent& aEvent ); void OnPasteDuplicatePart( wxCommandEvent& aEvent ); void OnSelectAlias( wxCommandEvent& event ); void OnSelectPart( wxCommandEvent& event ); /** * From Option toolbar: option to show the electrical pin type name */ void OnShowElectricalType( wxCommandEvent& event ); void OnToggleSearchTree( wxCommandEvent& event ); void OnEditSymbolLibTable( wxCommandEvent& aEvent ) override; bool IsSearchTreeShown(); void OnEditComponentProperties( wxCommandEvent& event ); void InstallFieldsEditorDialog( wxCommandEvent& event ); void OnViewEntryDoc( wxCommandEvent& event ); void OnCheckComponent( wxCommandEvent& event ); void OnSelectBodyStyle( wxCommandEvent& event ); void OnEditPin( wxCommandEvent& event ); void OnSelectItem( wxCommandEvent& aEvent ); void OnOpenPinTable( wxCommandEvent& aEvent ); void OnUpdatePaste( wxUpdateUIEvent& event ); void OnUpdateSelectTool( wxUpdateUIEvent& aEvent ); void OnUpdateEditingPart( wxUpdateUIEvent& event ); void OnUpdatePartModified( wxUpdateUIEvent& aEvent ); void OnUpdateLibModified( wxUpdateUIEvent& aEvent ); void OnUpdateClipboardNotEmpty( wxUpdateUIEvent& aEvent ); void OnUpdateUndo( wxUpdateUIEvent& event ); void OnUpdateRedo( wxUpdateUIEvent& event ); void OnUpdateSaveLib( wxUpdateUIEvent& event ); void OnUpdateSaveLibAs( wxUpdateUIEvent& event ); void OnUpdateViewDoc( wxUpdateUIEvent& event ); void OnUpdatePinByPin( wxUpdateUIEvent& event ); void OnUpdatePinTable( wxUpdateUIEvent& event ); void OnUpdatePartNumber( wxUpdateUIEvent& event ); void OnUpdateDeMorganNormal( wxUpdateUIEvent& event ); void OnUpdateDeMorganConvert( wxUpdateUIEvent& event ); void OnUpdateSelectAlias( wxUpdateUIEvent& event ); void OnUpdateElectricalType( wxUpdateUIEvent& aEvent ); void UpdateAliasSelectList(); void UpdatePartSelectList(); /** * Updates the main window title bar with the current library name and read only status * of the library. */ void DisplayLibInfos(); /** * Redraw the current component loaded in library editor * Display reference like in schematic (a reference U is shown U? or U?A) * accordint to the current selected unit and De Morgan selection * although it is stored without ? and part id. * @param aDC = the current device context * @param aOffset = a draw offset. usually 0,0 to draw on the screen, but * can be set to page size / 2 to draw or print in SVG format. */ void RedrawComponent( wxDC* aDC, wxPoint aOffset ); /** * Redraw the current component loaded in library editor, an axes * Display reference like in schematic (a reference U is shown U? or U?A) * update status bar and info shown in the bottom of the window */ void RedrawActiveWindow( wxDC* DC, bool EraseBg ) override; void OnCloseWindow( wxCloseEvent& Event ); void ReCreateHToolbar() override; void ReCreateVToolbar() override; void CreateOptionToolbar(); void OnLeftClick( wxDC* DC, const wxPoint& MousePos ) override; bool OnRightClick( const wxPoint& MousePos, wxMenu* PopMenu ) override; double BestZoom() override; // Returns the best zoom void OnLeftDClick( wxDC* DC, const wxPoint& MousePos ) override; ///> @copydoc EDA_DRAW_FRAME::GetHotKeyDescription() EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override; bool OnHotKey( wxDC* aDC, int aHotKey, const wxPoint& aPosition, EDA_ITEM* aItem = NULL ) override; bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, EDA_KEY aHotKey = 0 ) override; void LoadSettings( wxConfigBase* aCfg ) override; void SaveSettings( wxConfigBase* aCfg ) override; /** * Trigger the wxCloseEvent, which is handled by the function given to EVT_CLOSE() macro: *

* EVT_CLOSE( LIB_EDIT_FRAME::OnCloseWindow ) *

*/ void CloseWindow( wxCommandEvent& event ) { // Generate a wxCloseEvent Close( false ); } /** * Must be called after a schematic change in order to set the "modify" flag of the * current screen. */ void OnModify(); const wxString& GetAliasName() { return m_aliasName; } int GetUnit() { return m_unit; } void SetUnit( int unit ) { wxASSERT( unit >= 1 ); m_unit = unit; } int GetConvert() { return m_convert; } void SetConvert( int convert ) { wxASSERT( convert >= 0 ); m_convert = convert; } LIB_ITEM* GetLastDrawItem() { return m_lastDrawItem; } void SetLastDrawItem( LIB_ITEM* drawItem ) { m_lastDrawItem = drawItem; } LIB_ITEM* GetDrawItem() { return m_drawItem; } void SetDrawItem( LIB_ITEM* drawItem ); bool GetShowDeMorgan() { return m_showDeMorgan; } void SetShowDeMorgan( bool show ) { m_showDeMorgan = show; } bool GetShowElectricalType() { return m_showPinElectricalTypeName; } void SetShowElectricalType( bool aShow ) { m_showPinElectricalTypeName = aShow; } FILL_T GetFillStyle() { return m_drawFillStyle; } /** * Create a temporary copy of the current edited component. * * Used to prepare an undo and/or abort command before editing the symbol. */ void TempCopyComponent(); /** * Restore the current edited component from its temporary copy. * Used to abort a command */ void RestoreComponent(); /** * @return the temporary copy of the current component. */ LIB_PART* GetTempCopyComponent() { return m_tempCopyComponent; } /** * Delete temporary copy of the current component and clear pointer */ void ClearTempCopyComponent(); bool IsEditingDrawItem() { return m_drawItem && m_drawItem->InEditMode(); } private: void loadPart( const wxString& aLibrary, const wxString& aPart, int Unit ); /** * Saves the changes to the current library. * * A backup file of the current library is saved with the .bak extension before the * changes made to the library are saved. * @param aLibrary is the library name. * @param aNewFile Ask for a new file name to save the library. * @return True if the library was successfully saved. */ bool saveLibrary( const wxString& aLibrary, bool aNewFile ); /** * Called when the frame is activated. Tests if the current library exists. * The library list can be changed by the schematic editor after reloading a new schematic * and the current library can point a non existent lib. */ virtual void OnActivate( wxActivateEvent& event ) override; // General: /** * Set the current active library to \a aLibrary. * * @param aLibrary the nickname of the library in the symbol library table. If wxEmptyString, * then display list of available libraries to select from. */ void SelectActiveLibrary( const wxString& aLibrary = wxEmptyString ); /** * Loads a symbol from the current active library, optionally setting the selected * unit and convert. * * @param aAliasName The symbol alias name to load from the current library. * @param aUnit Unit to be selected * @param aConvert Convert to be selected * @return true if the symbol loaded correctly. */ bool LoadComponentFromCurrentLib( const wxString& aAliasName, int aUnit = 0, int aConvert = 0 ); /** * Create a copy of \a aLibEntry into memory. * * @param aLibEntry A pointer to the LIB_ALIAS object to an already loaded. * @param aLibrary the path to the library file that \a aLibEntry was loaded from. This is * for error messaging purposes only. * @return True if a copy of \a aLibEntry was successfully copied. */ bool LoadOneLibraryPartAux( LIB_ALIAS* aLibEntry, const wxString& aLibrary ); /** * Display the documentation of the selected component. */ void DisplayCmpDoc(); /** * Rotates the current item. */ void OnRotateItem( wxCommandEvent& aEvent ); /** * Handles the ID_LIBEDIT_MIRROR_X and ID_LIBEDIT_MIRROR_Y events. */ void OnOrient( wxCommandEvent& aEvent ); /** * Deletes the currently selected draw item. * * @param aDC The device context to draw upon when removing item. */ void deleteItem( wxDC* aDC ); // General editing public: /** * Create a copy of the current component, and save it in the undo list. * * Because a component in library editor does not a lot of primitives, * the full data is duplicated. It is not worth to try to optimize this save funtion */ void SaveCopyInUndoList( EDA_ITEM* ItemToCopy ); private: void GetComponentFromUndoList( wxCommandEvent& event ); void GetComponentFromRedoList( wxCommandEvent& event ); // Editing pins void CreatePin( wxDC* DC ); void StartMovePin( wxDC* DC ); /** * Adds copies of \a aPin for \a aUnit in components with multiple parts and * \a aConvert for components that have multiple body styles. * * @param aPin The pin to copy. * @param aUnit The unit to add a copy of \a aPin to. * @param aConvert The alternate body style to add a copy of \a aPin to. * @param aDeMorgan Flag to indicate if \a aPin should be created for the * alternate body style. */ void CreateImagePins( LIB_PIN* aPin, int aUnit, int aConvert, bool aDeMorgan ); /** * Places an anchor reference coordinate for the current component. *

* All object coordinates are offset to the current cursor position. *

*/ void PlaceAnchor(); // Editing graphic items LIB_ITEM* CreateGraphicItem( LIB_PART* LibEntry, wxDC* DC ); void GraphicItemBeginDraw( wxDC* DC ); void StartMoveDrawSymbol( wxDC* DC ); void StartModifyDrawSymbol( wxDC* DC ); // Helper screen used when no part is loaded SCH_SCREEN* m_dummyScreen; /** * Displays a dialog asking the user to select a symbol library table. * @return Pointer to the selected symbol library table or nullptr if cancelled. */ SYMBOL_LIB_TABLE* selectSymLibTable(); ///> Creates a backup copy of a file with requested extension bool backupFile( const wxFileName& aOriginalFile, const wxString& aBackupExt ); ///> Returns currently edited part. LIB_PART* getTargetPart() const; ///> Returns either the part selected in the component tree, if context menu is active ///> or the currently modified part. LIB_ID getTargetLibId() const; ///> Returns either the library selected in the component tree, if context menu is active ///> or the library that is currently modified. wxString getTargetLib() const; ///> Returns true when the operation has succeded (all requested libraries have been saved or ///> none was selected and confirmed by OK). bool saveAllLibraries(); ///> Creates or adds an existing library to the symbol library table. bool addLibraryFile( bool aCreateNew ); ///> Displays a file browser dialog to select a library file. wxFileName getLibraryFileName( bool aExisting ); ///> Stores the currently modified part in the library manager buffer. void storeCurrentPart(); ///> Returns true if currently modified part has the same LIB_ID. bool isCurrentPart( const LIB_ID& aLibId ) const; ///> Restores the empty editor screen, without any part or library selected. void emptyScreen(); ///> Renames LIB_PART aliases to avoid conflicts before adding a component to a library void fixDuplicateAliases( LIB_PART* aPart, const wxString& aLibrary ); void InitBlockPasteInfos() override; /** * Copies items selected in the current part to the internal clipboard. */ void copySelectedItems(); /** * Pastes items from the internal clipboard to the current part. * @param aOffset is the offset where the pasted items should be located. */ void pasteClipboard( const wxPoint& aOffset ); ///> Clipboard buffer storing LIB_ITEMs BLOCK_SELECTOR m_clipboard; // Copy/cut/paste buffer to move parts between libraries std::unique_ptr m_copiedPart; DECLARE_EVENT_TABLE() }; #endif // LIBEDITFRM_H_