sch_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) 2015 Jean-Pierre Charras, jp.charras wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2021 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_EDIT_FRAME_H
#define SCH_EDIT_FRAME_H

#include <stddef.h>
#include <vector>
#include <wx/cmndata.h>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <wx/utils.h>

#include <config_params.h>
#include <core/typeinfo.h>
#include <eda_base_frame.h>
#include <eeschema_settings.h>
#include <math/box2.h>
#include <sch_base_frame.h>
#include <sch_text.h> // enum PINSHEETLABEL_SHAPE
#include <template_fieldnames.h>

class STATUS_TEXT_POPUP;

class SCH_ITEM;
class EDA_ITEM;
class SCH_LINE;
class SCH_TEXT;
class SCH_BITMAP;
class SCH_SHEET;
class SCH_SHEET_PATH;
class SCH_SHEET_PIN;
class SCH_SYMBOL;
class SCH_FIELD;
class SCH_JUNCTION;
class SCHEMATIC;
class DIALOG_SCH_FIND;
class wxFindReplaceData;
class RESCUER;
class HIERARCHY_NAVIG_DLG;

// @todo Move this to transform alone with all of the transform manipulation code.
enum SYMBOL_ORIENTATION_T
{
 SYM_NORMAL, // Normal orientation, no rotation or mirror
 SYM_ROTATE_CLOCKWISE, // Rotate -90
 SYM_ROTATE_COUNTERCLOCKWISE, // Rotate +90
 SYM_ORIENT_0, // No rotation and no mirror id SYM_NORMAL
 SYM_ORIENT_90, // Rotate 90, no mirror
 SYM_ORIENT_180, // Rotate 180, no mirror
 SYM_ORIENT_270, // Rotate -90, no mirror
 SYM_MIRROR_X = 0x100, // Mirror around X axis
 SYM_MIRROR_Y = 0x200 // Mirror around Y axis
};


enum ANNOTATE_SCOPE_T
{
 ANNOTATE_ALL, 
 ANNOTATE_CURRENT_SHEET, 
 ANNOTATE_SELECTION 
};


enum ANNOTATE_ORDER_T
{
 SORT_BY_X_POSITION, 
 SORT_BY_Y_POSITION, 
 UNSORTED, 
};


enum ANNOTATE_ALGO_T
{
 INCREMENTAL_BY_REF, 
 SHEET_NUMBER_X_100, 
 SHEET_NUMBER_X_1000, 
};


enum SCH_SEARCH_T
{
 HIGHLIGHT_PIN,
 HIGHLIGHT_SYMBOL
};


enum SCH_CLEANUP_FLAGS
{
 NO_CLEANUP,
 LOCAL_CLEANUP,
 GLOBAL_CLEANUP
};


class SCH_EDIT_FRAME : public SCH_BASE_FRAME
{
public:
 SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
 ~SCH_EDIT_FRAME() override;

 SCH_SCREEN* GetScreen() const override;

 SELECTION& GetCurrentSelection() override;

 SCHEMATIC& Schematic() const;

 bool GetShowAllPins() const override;

 void SaveProjectSettings() override;

 bool LoadProjectSettings();

 void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );

 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;

 void CreateScreens();
 void ReCreateHToolbar() override;
 void ReCreateVToolbar() override;
 void ReCreateOptToolbar() override;
 void ReCreateMenuBar() override;

 void setupUIConditions() override;

 bool IsContentModified() const override;

 void OnModify() override;

 void RecordERCExclusions();

 void ResolveERCExclusions();

 SEVERITY GetSeverity( int aErrorCode ) const override;

 wxString GetScreenDesc() const override;

 void ExecuteRemoteCommand( const char* cmdline ) override;

 void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;

 void AddItemToScreenAndUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItem, bool aUndoAppend );

 void ShowFindReplaceDialog( bool aReplace );

 void UpdateHierarchyNavigator( bool aForceUpdate = false );

 HIERARCHY_NAVIG_DLG* FindHierarchyNavigator();

 void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
 void ClearFindReplaceStatus();

 void OnFindDialogClose();

 bool BreakSegment( SCH_LINE* aSegment, const wxPoint& aPoint,
 SCH_LINE** aNewSegment = nullptr, SCH_SCREEN* aScreen = nullptr );

 bool BreakSegments( const wxPoint& aPoint, SCH_SCREEN* aScreen = nullptr );

 bool BreakSegmentsOnJunctions( SCH_SCREEN* aScreen = nullptr );

 void TestDanglingEnds();

 void SendMessageToPCBNEW( EDA_ITEM* aObjectToSync, SCH_SYMBOL* aPart );

 void SendCrossProbeNetName( const wxString& aNetName );

 void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );

 void SendCrossProbeClearHighlight();

 const SCH_CONNECTION* GetHighlightedConnection() const
 {
 return m_highlightedConn;
 }

 void SetHighlightedConnection( const SCH_CONNECTION* aConnection )
 {
 m_highlightedConn = aConnection;
 }

 bool ReadyToNetlist( const wxString& aAnnotateMessage );

 bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
 REPORTER* aReporter = nullptr );

 void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool* appendUndo );

 void AnnotateSymbols( ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption,
 ANNOTATE_ALGO_T aAlgoOption, int aStartNumber, bool aResetAnnotation,
 bool aRepairTimestamps, REPORTER& aReporter );

 int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
 ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL );

 int ModalAnnotate( const wxString& aMessage );

 // Functions used for hierarchy handling
 SCH_SHEET_PATH& GetCurrentSheet() const;

 void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );

 void HardRedraw() override;

 void DisplayCurrentSheet();

 void DrawCurrentSheetToClipboard();

 void OnPageSettingsChange() override;

 wxString GetUniqueFilenameForCurrentSheet();

 void SetSheetNumberAndCount();

 wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }

 void NewProject();
 void LoadProject();

 bool SaveProject( bool aSaveAs = false );

 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;

 wxString GetCurrentFileName() const override;

 bool AppendSchematic();

 bool AskToSaveChanges();

 SCH_JUNCTION* AddJunction( SCH_SCREEN* aScreen, const wxPoint& aPos, bool aAppendToUndo,
 bool aFinal = true );

 bool SchematicCleanUp( SCH_SCREEN* aScreen = nullptr );

 bool TrimWire( const wxPoint& aStart, const wxPoint& aEnd );

 std::vector<wxPoint> GetSchematicConnections();

 void OnOpenPcbnew( wxCommandEvent& event );
 void OnOpenCvpcb( wxCommandEvent& event );
 void OnUpdatePCB( wxCommandEvent& event );
 void OnAnnotate( wxCommandEvent& event );

 bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy );

 bool AllowCaseSensitiveFileNameClashes( const wxString& aSchematicFileName );

 bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
 bool* aClearAnnotationNewItems );

 void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );

 bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
 const wxString& aFileName );

 void DeleteJunction( SCH_ITEM* aItem, bool aAppend = false );

 void ConvertPart( SCH_SYMBOL* aSymbol );

 void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );

 /* Undo - redo */

 void StartNewUndo();

 void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
 bool aAppend );

 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
 bool aAppend );

 void PutDataInPreviousState( PICKED_ITEMS_LIST* aList );

 void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;

 void SaveCopyForRepeatItem( const SCH_ITEM* aItem );

 SCH_ITEM* GetRepeatItem() const { return m_item_to_repeat; }

 EDA_ITEM* GetItem( const KIID& aId ) const override;

 void RollbackSchematicFromUndo();

 bool CreateArchiveLibraryCacheFile( bool aUseCurrentSheetFilename = false );

 bool CreateArchiveLibrary( const wxString& aFileName );

 virtual void PrintPage( const RENDER_SETTINGS* aSettings ) override;

 void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }

 void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }

 void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }

 void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }

 wxString GetNetListerCommand() const { return m_netListerCommand; }

 void RecalculateConnections( SCH_CLEANUP_FLAGS aCleanupFlags );

 void InstallPreferences( PAGED_DIALOG* aParent, PANEL_HOTKEYS_EDITOR* aHotkeysPanel ) override;

 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;

 void UpdateNetHighlightStatus();

 void ShowChangedLanguage() override;

 void SetScreen( BASE_SCREEN* aScreen ) override;

 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;

 void FixupJunctions();

 int GetSchematicJunctionSize();

 void FocusOnItem( SCH_ITEM* aItem );

 void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );

 void RecomputeIntersheetRefs();

 void ShowAllIntersheetRefs( bool aShow );

 virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;

 DECLARE_EVENT_TABLE()

protected:
 bool doAutoSave() override;

 bool isAutoSaveRequired() const override;

 void sendNetlistToCvpcb();

 void onSize( wxSizeEvent& aEvent );

private:
 // Sets up the tool framework
 void setupTools();

 void OnExit( wxCommandEvent& event );

 void OnLoadFile( wxCommandEvent& event );
 void OnAppendProject( wxCommandEvent& event );
 void OnImportProject( wxCommandEvent& event );

 void OnClearFileHistory( wxCommandEvent& aEvent );

 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
 void doCloseWindow() override;

 void UpdateTitle();

 void initScreenZoom();

 bool checkForNoFullyDefinedLibIds( SCH_SHEET* aSheet );

 bool importFile( const wxString& aFileName, int aFileType );

 bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );

 void mapExistingAnnotation( std::map<wxString, wxString>& aMap );

 bool updateAutoSaveFile();

 const wxString& getAutoSaveFileName() const;

private:
 // The schematic editor control class should be able to access some internal
 // functions of the editor frame.
 friend class SCH_EDITOR_CONTROL;

 SCHEMATIC* m_schematic; 
 const SCH_CONNECTION* m_highlightedConn; 

 wxPageSetupDialogData m_pageSetupData;
 SCH_ITEM* m_item_to_repeat; 
 wxString m_netListerCommand; 
 int m_exec_flags; 

 DIALOG_SCH_FIND* m_findReplaceDialog;
};


#endif // SCH_EDIT_FRAME_H