sch_editor_control.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 CERN
 * 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_EDITOR_CONTROL_H
#define SCH_EDITOR_CONTROL_H
 
#include <sch_base_frame.h>
#include <tools/sch_tool_base.h>
#include <status_popup.h>
 
class SCH_EDIT_FRAME;
class SCH_SCREEN;
class LIB_SYMBOL;

class SCH_EDITOR_CONTROL : public wxEvtHandler, public SCH_TOOL_BASE<SCH_EDIT_FRAME>
{
public:
    SCH_EDITOR_CONTROL()  :
            SCH_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.EditorControl" ),
            m_probingPcbToSch( false ),
            m_pickerItem( nullptr ),
            m_duplicateIsHoverSelection( false ),
            m_highlightBusMembers( false )
    { }
 
    ~SCH_EDITOR_CONTROL() { }
 
    int New( const TOOL_EVENT& aEvent );
    int Open( const TOOL_EVENT& aEvent );
    int Save( const TOOL_EVENT& aEvent );
    int SaveAs( const TOOL_EVENT& aEvent );

    int SaveCurrSheetCopyAs( const TOOL_EVENT& aEvent );
 
    int Revert( const TOOL_EVENT& aEvent );
 
    int ShowSchematicSetup( const TOOL_EVENT& aEvent );
    int PageSetup( const TOOL_EVENT& aEvent );
    int Print( const TOOL_EVENT& aEvent );
    int Plot( const TOOL_EVENT& aEvent );
    int Quit( const TOOL_EVENT& aEvent );

    int RescueSymbols( const TOOL_EVENT& aEvent );
    int RemapSymbols( const TOOL_EVENT& aEvent );
 
    bool RescueLegacyProject( bool aRunningOnDemand );
    bool RescueSymbolLibTableProject( bool aRunningOnDemand );

    int CrossProbeToPcb( const TOOL_EVENT& aEvent );

    int ExplicitCrossProbeToPcb( const TOOL_EVENT& aEvent );
 
    int ExportSymbolsToLibrary( const TOOL_EVENT& aEvent );
 
    int SimProbe( const TOOL_EVENT& aEvent );
    int SimTune( const TOOL_EVENT& aEvent );

    int HighlightNet( const TOOL_EVENT& aEvent );

    int HighlightNetChain( const TOOL_EVENT& aEvent );
    int RemoveFromNetChain( const TOOL_EVENT& aEvent );

    int ClearHighlight( const TOOL_EVENT& aEvent );

    int UpdateNetHighlighting( const TOOL_EVENT& aEvent );

    int HighlightNetCursor( const TOOL_EVENT& aEvent );

    int ReplaceTerminalPin( const TOOL_EVENT& aEvent );
    int NameNetChain( const TOOL_EVENT& aEvent );
    int CreateNetChainBetweenPins( const TOOL_EVENT& aEvent );
 
    int ShowCreateNetChain( const TOOL_EVENT& aEvent );
 
    int AssignNetclass( const TOOL_EVENT& aEvent );
    int FindNetInInspector( const TOOL_EVENT& aEvent );
 
    int Undo( const TOOL_EVENT& aEvent );
    int Redo( const TOOL_EVENT& aEvent );

    int Cut( const TOOL_EVENT& aEvent );
    int Copy( const TOOL_EVENT& aEvent );
    int CopyAsText( const TOOL_EVENT& aEvent );
    int Paste( const TOOL_EVENT& aEvent );
    int Duplicate( const TOOL_EVENT& aEvent );

    static const LIB_SYMBOL* ChoosePasteLibSymbol( const SCH_SCREEN* aClipboardScreen,
                                                   const SCH_SCREEN* aDestScreen,
                                                   const wxString&   aLibSymbolName );
 
    int EditWithSymbolEditor( const TOOL_EVENT& aEvent );
    int ShowCvpcb( const TOOL_EVENT& aEvent );
    int Annotate( const TOOL_EVENT& aEvent );
    int IncrementAnnotations( const TOOL_EVENT& aEvent );
    int EditSymbolFields( const TOOL_EVENT& aEvent );
    int EditSymbolLibraryLinks( const TOOL_EVENT& aEvent );
    int ShowPcbNew( const TOOL_EVENT& aEvent );
    int UpdatePCB( const TOOL_EVENT& aEvent );
    int UpdateFromPCB( const TOOL_EVENT& aEvent );
    int ImportFPAssignments( const TOOL_EVENT& aEvent );
    int ImportNonKicadSchematic( const TOOL_EVENT& aEvent );
    int ExportNetlist( const TOOL_EVENT& aEvent );
    int GenerateBOM( const TOOL_EVENT& aEvent );
    int GenerateBOMLegacy( const TOOL_EVENT& aEvent );
    int DrawSheetOnClipboard( const TOOL_EVENT& aEvent );
 
    int ShowSearch( const TOOL_EVENT& aEvent );
    int ShowHierarchy( const TOOL_EVENT& aEvent );
    int ShowNetNavigator( const TOOL_EVENT& aEvent );
    int ToggleProperties( const TOOL_EVENT& aEvent );
    int ToggleLibraryTree( const TOOL_EVENT& aEvent );
    int ToggleRemoteSymbolPanel( const TOOL_EVENT& aEvent );
 
    int ToggleHiddenPins( const TOOL_EVENT& aEvent );
    int ToggleHiddenFields( const TOOL_EVENT& aEvent );
    int ToggleDirectiveLabels( const TOOL_EVENT& aEvent );
    int ToggleERCWarnings( const TOOL_EVENT& aEvent );
    int ToggleERCErrors( const TOOL_EVENT& aEvent );
    int ToggleERCExclusions( const TOOL_EVENT& aEvent );
    int MarkSimExclusions( const TOOL_EVENT& aEvent );
    int ToggleOPVoltages( const TOOL_EVENT& aEvent );
    int ToggleOPCurrents( const TOOL_EVENT& aEvent );
    int TogglePinAltIcons( const TOOL_EVENT& aEvent );
    int ChangeLineMode( const TOOL_EVENT& aEvent );
    int NextLineMode( const TOOL_EVENT& aEvent );
    int OnAngleSnapModeChanged( const TOOL_EVENT& aEvent );
    int ToggleAnnotateAuto( const TOOL_EVENT& aEvent );
 
    int GridFeedback( const TOOL_EVENT& aEvent );
 
    void AssignFootprints( const std::string& aChangedSetOfReferences );

    SCH_ITEM* FindSymbolAndItem( const wxString* aPath, const wxString* aReference,
                                 bool aSearchHierarchy, SCH_SEARCH_T aSearchType,
                                 const wxString& aSearchText );
 
    void SetHighlightBusMembers( bool aHighlightBusMembers )
    {
        m_highlightBusMembers = aHighlightBusMembers;
    }
 
    bool GetHighlightBusMembers() const { return m_highlightBusMembers; }
 
    int PlaceLinkedDesignBlock( const TOOL_EVENT& aEvent );
    int SaveToLinkedDesignBlock( const TOOL_EVENT& aEvent );
 
    int AddVariant( const TOOL_EVENT& aEvent );
    int RemoveVariant( const TOOL_EVENT& aEvent );
    int EditVariantDescription( const TOOL_EVENT& aEvent );
    int RenameVariant( const TOOL_EVENT& aEvent );
    int CopyVariant( const TOOL_EVENT& aEvent );
 
private:
    bool doCopy( bool aUseDuplicateClipboard = false );
 
    bool rescueProject( RESCUER& aRescuer, bool aRunningOnDemand );
 
    bool searchSupplementaryClipboard( const wxString& aSheetFilename, SCH_SCREEN** aScreen );
 
    void doCrossProbeSchToPcb( const TOOL_EVENT& aEvent, bool aForce );
 
    void updatePastedSymbol( SCH_SYMBOL* aSymbol, const SCH_SHEET_PATH& aPastePath,
                             const KIID_PATH& aClipPath, bool aForceKeepAnnotations );
 
    SCH_SHEET_PATH updatePastedSheet( SCH_SHEET* aSheet, const SCH_SHEET_PATH& aPastePath,
                                      const KIID_PATH& aClipPath, bool aForceKeepAnnotations,
                                      SCH_SHEET_LIST* aPastedSheets,
                                      std::map<SCH_SHEET_PATH, SCH_REFERENCE_LIST>& aPastedSymbols );
 
    void setPastedSymbolInstances( const SCH_SCREEN* aScreen );

    void prunePastedSymbolInstances();

    bool processCmpToFootprintLinkFile( const wxString& aFullFilename, bool aForceVisibilityState,
                                        bool aVisibilityState );

    void setTransitions() override;
 
private:
    bool        m_probingPcbToSch;          // Recursion guard for PCB to schematic cross-probing
    EDA_ITEM*   m_pickerItem;               // Current item for picker highlighting.
 
    std::string m_duplicateClipboard;       // Temporary storage for Duplicate action
    bool        m_duplicateIsHoverSelection;
 
    bool        m_highlightBusMembers;
 
    // A map of sheet filename --> screens for the clipboard contents.  We use these to hook up
    // cut/paste operations for unsaved sheet content.
    std::map<wxString, SCH_SCREEN*>          m_supplementaryClipboard;
 
    // A map of KIID_PATH --> symbol instances for the clipboard contents.
    std::map<KIID_PATH, SCH_SYMBOL_INSTANCE> m_clipboardSymbolInstances;
 
    std::set<SCH_SYMBOL*>                    m_pastedSymbols;
};
 
 
#endif // SCH_EDITOR_CONTROL_H