2011-10-19 20:32:21 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2015-02-20 08:17:54 +00:00
|
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras wanadoo.fr
|
2017-10-22 00:48:25 +00:00
|
|
|
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
|
2022-06-09 17:39:35 +00:00
|
|
|
* Copyright (C) 2004-2022 KiCad Developers, see AUTHORS.txt for contributors.
|
2011-10-19 20:32:21 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
|
|
|
|
2018-01-30 10:49:51 +00:00
|
|
|
#ifndef SCH_EDIT_FRAME_H
|
|
|
|
#define SCH_EDIT_FRAME_H
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2019-06-25 23:39:58 +00:00
|
|
|
#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>
|
|
|
|
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
#include <config_params.h>
|
2019-06-25 23:39:58 +00:00
|
|
|
#include <core/typeinfo.h>
|
|
|
|
#include <eda_base_frame.h>
|
2020-05-20 03:34:55 +00:00
|
|
|
#include <eeschema_settings.h>
|
2019-06-25 23:39:58 +00:00
|
|
|
#include <math/box2.h>
|
|
|
|
#include <sch_base_frame.h>
|
|
|
|
#include <template_fieldnames.h>
|
|
|
|
|
2008-04-14 19:22:48 +00:00
|
|
|
class SCH_ITEM;
|
2010-12-08 20:12:46 +00:00
|
|
|
class EDA_ITEM;
|
2019-06-25 23:39:58 +00:00
|
|
|
class SCH_LINE;
|
2008-09-17 17:26:25 +00:00
|
|
|
class SCH_TEXT;
|
2011-08-31 14:59:20 +00:00
|
|
|
class SCH_BITMAP;
|
2009-11-04 20:46:53 +00:00
|
|
|
class SCH_SHEET;
|
2009-12-02 21:44:03 +00:00
|
|
|
class SCH_SHEET_PATH;
|
2009-11-04 20:46:53 +00:00
|
|
|
class SCH_SHEET_PIN;
|
2021-06-10 14:10:55 +00:00
|
|
|
class SCH_SYMBOL;
|
2009-12-02 21:44:03 +00:00
|
|
|
class SCH_FIELD;
|
|
|
|
class SCH_JUNCTION;
|
2020-05-13 02:00:37 +00:00
|
|
|
class SCHEMATIC;
|
2010-03-16 18:22:59 +00:00
|
|
|
class DIALOG_SCH_FIND;
|
|
|
|
class wxFindReplaceData;
|
2017-10-22 00:48:25 +00:00
|
|
|
class RESCUER;
|
2022-06-02 21:56:17 +00:00
|
|
|
class HIERARCHY_NAVIG_PANEL;
|
2009-07-26 17:16:42 +00:00
|
|
|
|
2020-04-16 16:43:50 +00:00
|
|
|
// @todo Move this to transform alone with all of the transform manipulation code.
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
/// enum used in RotationMiroir()
|
2021-06-10 14:10:55 +00:00
|
|
|
enum SYMBOL_ORIENTATION_T
|
2021-04-26 14:19:11 +00:00
|
|
|
{
|
2021-06-10 14:10:55 +00:00
|
|
|
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
|
2008-04-14 19:22:48 +00:00
|
|
|
};
|
|
|
|
|
2010-06-17 16:30:10 +00:00
|
|
|
|
2011-11-17 01:06:08 +00:00
|
|
|
/// Schematic search type used by the socket link with Pcbnew
|
2021-04-26 14:19:11 +00:00
|
|
|
enum SCH_SEARCH_T
|
|
|
|
{
|
2019-07-16 19:15:07 +00:00
|
|
|
HIGHLIGHT_PIN,
|
2021-06-10 14:10:55 +00:00
|
|
|
HIGHLIGHT_SYMBOL
|
2011-11-17 01:06:08 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2021-04-26 14:19:11 +00:00
|
|
|
enum SCH_CLEANUP_FLAGS
|
|
|
|
{
|
2019-11-10 23:24:27 +00:00
|
|
|
NO_CLEANUP,
|
|
|
|
LOCAL_CLEANUP,
|
|
|
|
GLOBAL_CLEANUP
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2009-09-22 12:27:57 +00:00
|
|
|
/**
|
2011-09-30 18:15:37 +00:00
|
|
|
* Schematic editor (Eeschema) main window.
|
2009-09-22 12:27:57 +00:00
|
|
|
*/
|
2012-01-09 17:24:01 +00:00
|
|
|
class SCH_EDIT_FRAME : public SCH_BASE_FRAME
|
2008-04-14 19:22:48 +00:00
|
|
|
{
|
|
|
|
public:
|
* KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
|
|
|
SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
|
2019-07-02 20:09:23 +00:00
|
|
|
~SCH_EDIT_FRAME() override;
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
SCH_SCREEN* GetScreen() const override;
|
2012-01-09 17:24:01 +00:00
|
|
|
|
2020-08-06 23:03:58 +00:00
|
|
|
SELECTION& GetCurrentSelection() override;
|
|
|
|
|
2020-05-13 02:00:37 +00:00
|
|
|
SCHEMATIC& Schematic() const;
|
|
|
|
|
2020-04-18 07:57:04 +00:00
|
|
|
/**
|
|
|
|
* Allow edit frame to show/hide hidden pins.
|
|
|
|
*/
|
|
|
|
bool GetShowAllPins() const override;
|
|
|
|
|
2011-08-18 19:25:12 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Save changes to the project settings to the project (.pro) file.
|
2011-08-18 19:25:12 +00:00
|
|
|
*/
|
2020-02-28 00:05:40 +00:00
|
|
|
void SaveProjectSettings() override;
|
2011-08-18 19:25:12 +00:00
|
|
|
|
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Load the KiCad project file (*.pro) settings specific to Eeschema.
|
2011-08-18 19:25:12 +00:00
|
|
|
*
|
|
|
|
* @return True if the project file was loaded correctly.
|
|
|
|
*/
|
2020-06-08 02:19:46 +00:00
|
|
|
bool LoadProjectSettings();
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2020-05-24 14:54:26 +00:00
|
|
|
void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
|
2019-03-11 21:32:05 +00:00
|
|
|
|
2020-01-13 01:44:19 +00:00
|
|
|
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
|
2009-04-05 20:49:15 +00:00
|
|
|
|
2011-10-15 13:25:57 +00:00
|
|
|
void CreateScreens();
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateHToolbar() override;
|
|
|
|
void ReCreateVToolbar() override;
|
2019-07-20 15:52:30 +00:00
|
|
|
void ReCreateOptToolbar() override;
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateMenuBar() override;
|
2015-05-05 18:39:42 +00:00
|
|
|
|
2020-08-06 23:03:58 +00:00
|
|
|
void setupUIConditions() override;
|
|
|
|
|
2019-12-19 15:34:01 +00:00
|
|
|
/**
|
|
|
|
* Get if the current schematic has been modified but not saved.
|
|
|
|
*
|
|
|
|
* @return true if the any changes have not been saved
|
|
|
|
*/
|
2021-05-27 23:07:48 +00:00
|
|
|
bool IsContentModified() const override;
|
2019-12-19 15:34:01 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2022-10-10 13:03:10 +00:00
|
|
|
* Must be called after a schematic change in order to set the "modify" flag and update other
|
|
|
|
* data structures and GUI elements.
|
2010-02-18 20:07:29 +00:00
|
|
|
*/
|
2019-05-08 18:56:03 +00:00
|
|
|
void OnModify() override;
|
2008-04-17 16:25:29 +00:00
|
|
|
|
2020-11-18 22:55:38 +00:00
|
|
|
/**
|
|
|
|
* Scan existing markers and record data from any that are Excluded.
|
|
|
|
*/
|
|
|
|
void RecordERCExclusions();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update markers to match recorded exclusions.
|
|
|
|
*/
|
|
|
|
void ResolveERCExclusions();
|
|
|
|
|
2021-11-29 13:41:02 +00:00
|
|
|
SEVERITY GetSeverity( int aErrorCode ) const override;
|
|
|
|
|
2019-07-02 20:09:23 +00:00
|
|
|
/**
|
|
|
|
* Return a human-readable description of the current screen.
|
|
|
|
*/
|
2019-06-01 15:28:39 +00:00
|
|
|
wxString GetScreenDesc() const override;
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2014-01-08 14:18:51 +00:00
|
|
|
/**
|
2020-06-09 16:50:05 +00:00
|
|
|
* Execute a remote command sent by Pcbnew via a socket connection.
|
2021-06-10 14:10:55 +00:00
|
|
|
*
|
2020-11-14 22:00:12 +00:00
|
|
|
* When user selects a footprint or pin in Pcbnew, Eeschema shows that same
|
2021-06-10 14:10:55 +00:00
|
|
|
* symbol or pin and moves cursor on the item. The socket port used
|
2020-06-09 16:50:05 +00:00
|
|
|
* is #KICAD_SCH_PORT_SERVICE_NUMBER which defaults to 4243.
|
|
|
|
*
|
|
|
|
* Valid commands are:
|
2021-06-10 14:10:55 +00:00
|
|
|
* \li \c \$PART: \c "reference" Put cursor on symbol.
|
|
|
|
* \li \c \$PART: \c "reference" \c \$REF: \c "ref" Put cursor on symbol reference.
|
|
|
|
* \li \c \$PART: \c "reference" \c \$VAL: \c "value" Put cursor on symbol value.
|
|
|
|
* \li \c \$PART: \c "reference" \c \$PAD: \c "pin name" Put cursor on the symbol pin.
|
2020-06-09 16:50:05 +00:00
|
|
|
* \li \c \$NET: \c "netname" Highlight a specified net
|
2021-06-10 14:10:55 +00:00
|
|
|
* \li \c \$CLEAR: \c "HIGHLIGHTED" Clear symbols highlight
|
2020-06-09 16:50:05 +00:00
|
|
|
* <p>
|
|
|
|
* They are a keyword followed by a quoted string.
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param cmdline is the command received from Pcbnew.
|
2014-01-08 14:18:51 +00:00
|
|
|
*/
|
2019-06-01 15:28:39 +00:00
|
|
|
void ExecuteRemoteCommand( const char* cmdline ) override;
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
|
2014-04-21 06:51:33 +00:00
|
|
|
|
2022-08-30 13:01:48 +00:00
|
|
|
/**
|
|
|
|
* Automatically set the rotation of an item (if the item supports it)
|
|
|
|
*/
|
|
|
|
void AutoRotateItem( SCH_SCREEN* aScreen, SCH_ITEM* aItem );
|
|
|
|
|
2019-04-15 14:34:58 +00:00
|
|
|
/**
|
2019-04-28 16:36:31 +00:00
|
|
|
* Add an item to the schematic and adds the changes to the undo/redo container.
|
|
|
|
* @param aUndoAppend True if the action should be appended to the current undo record.
|
2019-04-15 14:34:58 +00:00
|
|
|
*/
|
2020-07-13 11:21:40 +00:00
|
|
|
void AddItemToScreenAndUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItem, bool aUndoAppend );
|
2019-04-15 14:34:58 +00:00
|
|
|
|
2019-05-15 22:49:48 +00:00
|
|
|
/**
|
|
|
|
* Run the Find or Find & Replace dialog.
|
|
|
|
*/
|
2019-05-19 21:04:04 +00:00
|
|
|
void ShowFindReplaceDialog( bool aReplace );
|
|
|
|
|
2019-10-24 17:07:01 +00:00
|
|
|
/**
|
2022-06-02 21:56:17 +00:00
|
|
|
* Update the hierarchy navigation tree and history
|
2019-10-24 17:07:01 +00:00
|
|
|
*/
|
2022-06-02 21:56:17 +00:00
|
|
|
void UpdateHierarchyNavigator();
|
2020-01-08 14:01:22 +00:00
|
|
|
|
2022-10-24 22:00:10 +00:00
|
|
|
/**
|
|
|
|
* Update the hierarchy navigation tree selection (cross-probe from schematic to hierarchy
|
|
|
|
* pane).
|
|
|
|
*/
|
|
|
|
void UpdateHierarchySelection();
|
|
|
|
|
2020-05-20 01:31:47 +00:00
|
|
|
void ShowFindReplaceStatus( const wxString& aMsg, int aStatusTime );
|
2019-05-19 21:04:04 +00:00
|
|
|
void ClearFindReplaceStatus();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Notification that the Find dialog has closed.
|
|
|
|
*/
|
|
|
|
void OnFindDialogClose();
|
2019-05-15 22:49:48 +00:00
|
|
|
|
2017-10-26 15:25:47 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Break a single segment into two at the specified point.
|
2019-05-11 10:06:28 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @note This always appends to the existing undo state.
|
2017-10-26 15:25:47 +00:00
|
|
|
*
|
|
|
|
* @param aSegment Line segment to break
|
|
|
|
* @param aPoint Point at which to break the segment
|
2017-12-01 22:53:23 +00:00
|
|
|
* @param aNewSegment Pointer to the newly created segment (if given and created)
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aScreen is the screen to examine, or nullptr to examine the current screen.
|
2017-10-26 15:25:47 +00:00
|
|
|
* @return True if any wires or buses were broken.
|
|
|
|
*/
|
2022-01-01 06:04:08 +00:00
|
|
|
bool BreakSegment( SCH_LINE* aSegment, const VECTOR2I& aPoint,
|
2021-03-25 14:07:16 +00:00
|
|
|
SCH_LINE** aNewSegment = nullptr, SCH_SCREEN* aScreen = nullptr );
|
2017-10-26 15:25:47 +00:00
|
|
|
|
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Check every wire and bus for a intersection at \a aPoint and break into two segments
|
2017-10-26 15:25:47 +00:00
|
|
|
* at \a aPoint if an intersection is found.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @note This always appends to the existing undo state.
|
2019-05-11 10:06:28 +00:00
|
|
|
*
|
2017-10-26 15:25:47 +00:00
|
|
|
* @param aPoint Test this point for an intersection.
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aScreen is the screen to examine, or nullptr to examine the current screen.
|
2017-10-26 15:25:47 +00:00
|
|
|
* @return True if any wires or buses were broken.
|
|
|
|
*/
|
2022-01-01 06:04:08 +00:00
|
|
|
bool BreakSegments( const VECTOR2I& aPoint, SCH_SCREEN* aScreen = nullptr );
|
2017-10-26 15:25:47 +00:00
|
|
|
|
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Test all junctions and bus entries in the schematic for intersections with wires and
|
2017-10-26 15:25:47 +00:00
|
|
|
* buses and breaks any intersections into multiple segments.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @note This always appends to the existing undo state.
|
2019-05-11 10:06:28 +00:00
|
|
|
*
|
2019-03-11 21:32:05 +00:00
|
|
|
* @param aScreen is the screen to examine, or nullptr to examine the current screen
|
2017-10-26 15:25:47 +00:00
|
|
|
* @return True if any wires or buses were broken.
|
|
|
|
*/
|
2019-05-11 10:06:28 +00:00
|
|
|
bool BreakSegmentsOnJunctions( SCH_SCREEN* aScreen = nullptr );
|
2017-10-26 15:25:47 +00:00
|
|
|
|
2018-10-16 13:11:33 +00:00
|
|
|
/**
|
|
|
|
* Test all of the connectable objects in the schematic for unused connection points.
|
|
|
|
* @return True if any connection state changes were made.
|
|
|
|
*/
|
2020-12-06 21:23:16 +00:00
|
|
|
void TestDanglingEnds();
|
2018-10-16 13:11:33 +00:00
|
|
|
|
2022-01-16 20:29:03 +00:00
|
|
|
/**
|
|
|
|
* Sends items to Pcbnew for selection
|
|
|
|
*
|
2022-09-20 19:06:11 +00:00
|
|
|
* @param aItems are the items to select
|
2022-07-01 23:45:19 +00:00
|
|
|
* @param aForce select the element in pcbnew whether or not the user has the select option chosen
|
|
|
|
* This is used for when the eeschema user is using the cross-probe tool
|
2022-01-16 20:29:03 +00:00
|
|
|
*/
|
2022-09-20 19:06:11 +00:00
|
|
|
void SendSelectItemsToPcb( const std::vector<EDA_ITEM*>& aItems, bool aForce );
|
2022-01-16 20:29:03 +00:00
|
|
|
|
2018-01-06 20:50:49 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Sends a net name to Pcbnew for highlighting
|
2018-01-06 20:50:49 +00:00
|
|
|
*
|
|
|
|
* @param aNetName is the name of a net, or empty string to clear highlight
|
|
|
|
*/
|
|
|
|
void SendCrossProbeNetName( const wxString& aNetName );
|
|
|
|
|
2020-05-24 17:30:23 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Send a connection (net or bus) to Pcbnew for highlighting.
|
|
|
|
*
|
2020-05-24 17:30:23 +00:00
|
|
|
* @param aConnection is the connection to highlight
|
|
|
|
*/
|
|
|
|
void SetCrossProbeConnection( const SCH_CONNECTION* aConnection );
|
|
|
|
|
2019-05-04 20:18:41 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Tell Pcbnew to clear the existing highlighted net, if one exists
|
2019-05-04 20:18:41 +00:00
|
|
|
*/
|
|
|
|
void SendCrossProbeClearHighlight();
|
|
|
|
|
2020-05-24 14:46:05 +00:00
|
|
|
const SCH_CONNECTION* GetHighlightedConnection() const
|
|
|
|
{
|
|
|
|
return m_highlightedConn;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetHighlightedConnection( const SCH_CONNECTION* aConnection )
|
|
|
|
{
|
|
|
|
m_highlightedConn = aConnection;
|
|
|
|
}
|
2019-04-14 00:44:05 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Check if we are ready to write a netlist file for the current schematic.
|
2017-11-17 17:00:04 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* Test for some issues (missing or duplicate references and sheet names).
|
2017-11-17 17:00:04 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aAnnotateMessage a message to put up in case annotation needs to be performed.
|
|
|
|
* @return true if all is well (i.e. you can call WriteNetListFile next).
|
2010-07-14 13:24:36 +00:00
|
|
|
*/
|
2021-01-30 16:30:35 +00:00
|
|
|
bool ReadyToNetlist( const wxString& aAnnotateMessage );
|
2010-07-14 13:24:36 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Create a netlist file.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aFormat is the netlist format (NET_TYPE_PCBNEW ...).
|
|
|
|
* @param aFullFileName is the full netlist file name.
|
|
|
|
* @param aNetlistOptions is the netlist options using OR'ed bits.
|
2012-01-26 09:37:36 +00:00
|
|
|
* <p>
|
|
|
|
* For SPICE netlist only:
|
|
|
|
* if NET_USE_NETNAMES is set, use net names from labels in schematic
|
|
|
|
* else use net numbers (net codes)
|
2017-11-17 17:00:04 +00:00
|
|
|
* if NET_USE_X_PREFIX is set : change "U" and "IC" reference prefix to "X"
|
2012-01-26 09:37:36 +00:00
|
|
|
* </p>
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aReporter is a #REPORTER to report error messages, can be a nullptr.
|
2010-07-14 13:24:36 +00:00
|
|
|
* @return true if success.
|
|
|
|
*/
|
2021-03-25 14:07:16 +00:00
|
|
|
bool WriteNetListFile( int aFormat, const wxString& aFullFileName, unsigned aNetlistOptions,
|
|
|
|
REPORTER* aReporter = nullptr );
|
2008-11-24 06:53:43 +00:00
|
|
|
|
|
|
|
/**
|
2021-06-10 14:10:55 +00:00
|
|
|
* Clear the current symbol annotation.
|
2017-11-17 17:00:04 +00:00
|
|
|
*
|
2021-04-11 15:24:11 +00:00
|
|
|
* @param aCurrentSheetOnly Where to clear the annotation. See #ANNOTATE_SCOPE_T
|
|
|
|
* @param appendUndo true to add the action to the previous undo list
|
2009-04-10 14:53:24 +00:00
|
|
|
*/
|
2022-04-25 17:10:33 +00:00
|
|
|
void DeleteAnnotation( ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, bool* appendUndo );
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2011-01-01 17:28:21 +00:00
|
|
|
/**
|
2021-04-27 14:52:32 +00:00
|
|
|
* Annotate the symbols in the schematic that are not currently annotated. Multi-unit symbols
|
2021-06-10 14:10:55 +00:00
|
|
|
* are annotated together. E.g. if two symbols were R8A and R8B, they may become R3A and
|
2021-04-27 14:52:32 +00:00
|
|
|
* R3B, but not R3A and R3C or R3C and R4D.
|
2011-05-20 19:21:09 +00:00
|
|
|
*
|
2021-04-11 15:24:11 +00:00
|
|
|
* @param aAnnotateScope See #ANNOTATE_SCOPE_T
|
2011-05-20 19:21:09 +00:00
|
|
|
* @param aSortOption Define the annotation order. See #ANNOTATE_ORDER_T.
|
2021-04-26 14:19:11 +00:00
|
|
|
* @param aAlgoOption Define the annotation style. See #ANNOTATE_ALGO_T.
|
2022-04-25 17:10:33 +00:00
|
|
|
* @param aRecursive Annotation should descend into and annotate subsheets
|
2018-02-18 20:44:33 +00:00
|
|
|
* @param aStartNumber The start number for non-sheet-based annotation styles.
|
2011-05-20 19:21:09 +00:00
|
|
|
* @param aResetAnnotation Clear any previous annotation if true. Otherwise, keep the
|
2021-06-10 14:10:55 +00:00
|
|
|
* existing symbol annotation.
|
2011-05-20 19:21:09 +00:00
|
|
|
* @param aRepairTimestamps Test for and repair any duplicate time stamps if true.
|
|
|
|
* Otherwise, keep the existing time stamps. This option
|
|
|
|
* could change previous annotation because time stamps are
|
|
|
|
* used to handle annotation in complex hierarchies.
|
2018-02-17 11:43:56 +00:00
|
|
|
* @param aReporter A sink for error messages. Use NULL_REPORTER if you don't need errors.
|
2011-05-20 19:21:09 +00:00
|
|
|
*
|
2022-03-30 17:41:40 +00:00
|
|
|
* @param appendUndo True if the annotation operation should be added to an existing undo,
|
|
|
|
* false if it should be separately undo-able.
|
|
|
|
*
|
2011-05-20 19:21:09 +00:00
|
|
|
* When the sheet number is used in annotation, each sheet annotation starts from sheet
|
|
|
|
* number * 100. In other words the first sheet uses 100 to 199, the second sheet uses
|
|
|
|
* 200 to 299, and so on.
|
|
|
|
*/
|
2021-04-11 15:24:11 +00:00
|
|
|
void AnnotateSymbols( ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption,
|
2022-04-25 17:10:33 +00:00
|
|
|
ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber,
|
|
|
|
bool aResetAnnotation, bool aRepairTimestamps, REPORTER& aReporter,
|
|
|
|
bool appendUndo = false );
|
2011-05-20 19:21:09 +00:00
|
|
|
|
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Check for annotation errors.
|
2011-05-20 19:21:09 +00:00
|
|
|
*
|
|
|
|
* The following list of items are checked:
|
2021-03-29 10:46:05 +00:00
|
|
|
* - Symbols that are not annotated.
|
|
|
|
* - Duplicate symbol references.
|
|
|
|
* - Multiple part per package symbols where the part number is greater number of parts in
|
|
|
|
* the package.
|
|
|
|
* - Multiple part per package symbols where the reference designator is different between
|
|
|
|
* parts.
|
2011-05-20 19:21:09 +00:00
|
|
|
*
|
|
|
|
* @return Number of annotation errors found.
|
2021-01-24 22:25:32 +00:00
|
|
|
* @param aReporter A handler for error reporting.
|
2021-10-13 18:48:28 +00:00
|
|
|
* @param aAnnotateScope See #ANNOTATE_SCOPE_T Check the current sheet only if true.
|
|
|
|
* Otherwise check the entire schematic.
|
2011-05-20 19:21:09 +00:00
|
|
|
*/
|
2021-04-11 15:24:11 +00:00
|
|
|
int CheckAnnotate( ANNOTATION_ERROR_HANDLER aErrorHandler,
|
2022-04-25 17:10:33 +00:00
|
|
|
ANNOTATE_SCOPE_T aAnnotateScope = ANNOTATE_ALL,
|
|
|
|
bool aRecursive = true );
|
2011-02-05 02:21:11 +00:00
|
|
|
|
2018-02-18 20:44:33 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Run a modal version of the annotate dialog for a specific purpose.
|
|
|
|
*
|
2018-02-18 20:44:33 +00:00
|
|
|
* @param aMessage A user message indicating the purpose.
|
|
|
|
* @return the result of ShowModal()
|
|
|
|
*/
|
|
|
|
int ModalAnnotate( const wxString& aMessage );
|
|
|
|
|
2009-01-08 20:29:07 +00:00
|
|
|
// Functions used for hierarchy handling
|
2020-05-13 02:00:37 +00:00
|
|
|
SCH_SHEET_PATH& GetCurrentSheet() const;
|
2011-12-08 21:05:43 +00:00
|
|
|
|
|
|
|
void SetCurrentSheet( const SCH_SHEET_PATH& aSheet );
|
|
|
|
|
2022-01-07 17:42:43 +00:00
|
|
|
void UpdateItem( EDA_ITEM* aItem, bool isAddOrDelete = false,
|
|
|
|
bool aUpdateRtree = false ) override;
|
|
|
|
|
2018-10-17 11:14:09 +00:00
|
|
|
/**
|
|
|
|
* Rebuild the GAL and redraw the screen. Call when something went wrong.
|
|
|
|
*/
|
|
|
|
void HardRedraw() override;
|
|
|
|
|
2011-02-05 02:21:11 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Draw the current sheet on the display.
|
2011-02-05 02:21:11 +00:00
|
|
|
*/
|
2011-10-15 13:25:57 +00:00
|
|
|
void DisplayCurrentSheet();
|
2009-04-10 14:53:24 +00:00
|
|
|
|
2019-05-28 18:44:14 +00:00
|
|
|
/**
|
2021-01-24 22:25:32 +00:00
|
|
|
* Use the wxWidgets print code to draw an image of the current sheet onto the clipboard.
|
2019-05-28 18:44:14 +00:00
|
|
|
*/
|
2019-06-16 13:42:40 +00:00
|
|
|
void DrawCurrentSheetToClipboard();
|
2019-05-28 18:44:14 +00:00
|
|
|
|
2018-11-20 14:11:22 +00:00
|
|
|
/**
|
|
|
|
* Called when modifying the page settings.
|
2021-03-25 14:07:16 +00:00
|
|
|
*
|
2021-01-24 22:25:32 +00:00
|
|
|
* In derived classes it can be used to modify parameters like draw area size, and any other
|
|
|
|
* local parameter related to the page settings.
|
2018-11-20 14:11:22 +00:00
|
|
|
*/
|
|
|
|
void OnPageSettingsChange() override;
|
|
|
|
|
2008-11-24 06:53:43 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Set the m_ScreenNumber and m_NumberOfScreens members for screens.
|
|
|
|
*
|
|
|
|
* @note This must be called after deleting or adding a sheet and when entering a sheet.
|
2008-04-30 17:04:22 +00:00
|
|
|
*/
|
2011-10-15 13:25:57 +00:00
|
|
|
void SetSheetNumberAndCount();
|
2008-04-30 17:04:22 +00:00
|
|
|
|
2010-02-02 15:01:09 +00:00
|
|
|
wxPageSetupDialogData& GetPageSetupData() { return m_pageSetupData; }
|
|
|
|
|
2019-05-24 23:36:31 +00:00
|
|
|
void NewProject();
|
|
|
|
void LoadProject();
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2021-08-24 03:01:08 +00:00
|
|
|
/**
|
2021-10-13 18:48:28 +00:00
|
|
|
* Save the currently-open schematic (including its hierarchy) and associated project.
|
|
|
|
*
|
2021-08-24 03:01:08 +00:00
|
|
|
* @param aSaveAs is true to perform a Save As operation (rename the schematic and project).
|
|
|
|
* This may only be done in standalone mode.
|
|
|
|
* @return true if the schematic was saved
|
|
|
|
*/
|
|
|
|
bool SaveProject( bool aSaveAs = false );
|
2011-08-18 19:25:12 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
|
2011-08-18 19:25:12 +00:00
|
|
|
|
2020-05-16 23:08:01 +00:00
|
|
|
wxString GetCurrentFileName() const override;
|
|
|
|
|
2013-01-24 17:46:37 +00:00
|
|
|
/**
|
2019-07-29 19:59:31 +00:00
|
|
|
* Import a KiCad schematic into the current sheet.
|
2017-11-17 17:00:04 +00:00
|
|
|
*
|
2019-07-29 19:59:31 +00:00
|
|
|
* @return True if the schematic was imported properly.
|
2013-01-24 17:46:37 +00:00
|
|
|
*/
|
2017-11-17 17:00:04 +00:00
|
|
|
bool AppendSchematic();
|
2013-01-24 17:46:37 +00:00
|
|
|
|
2022-09-14 22:28:09 +00:00
|
|
|
/**
|
|
|
|
* Add a sheet file into the current sheet and updates display
|
|
|
|
*
|
|
|
|
* @note Used in AppendSchematic() and SCH_EDIT_TOOL::ddAppendFile() (so it is public)
|
|
|
|
*
|
|
|
|
* @param aFullFileName Path and name of sheet
|
|
|
|
* @return True if the sheet was properly added
|
|
|
|
*/
|
|
|
|
bool AddSheetAndUpdateDisplay( const wxString aFullFileName );
|
|
|
|
|
2017-09-20 14:20:38 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Check if any of the screens has unsaved changes and asks the user whether to save or
|
2017-11-17 17:00:04 +00:00
|
|
|
* drop them.
|
|
|
|
*
|
2019-07-02 20:09:23 +00:00
|
|
|
* @return True if user decided to save or drop changes, false if the operation should be
|
|
|
|
* canceled.
|
2017-09-20 14:20:38 +00:00
|
|
|
*/
|
|
|
|
bool AskToSaveChanges();
|
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
SCH_JUNCTION* AddJunction( SCH_SCREEN* aScreen, const VECTOR2I& aPos, bool aAppendToUndo,
|
2019-04-15 23:56:41 +00:00
|
|
|
bool aFinal = true );
|
|
|
|
|
2019-04-17 19:09:48 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Perform routine schematic cleaning including breaking wire and buses and deleting
|
2019-07-02 20:09:23 +00:00
|
|
|
* identical objects superimposed on top of each other.
|
2019-04-17 19:09:48 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @note This always appends to the existing undo state.
|
2019-05-11 10:06:28 +00:00
|
|
|
*
|
2019-04-17 19:09:48 +00:00
|
|
|
* @param aScreen is the screen to examine, or nullptr to examine the current screen
|
|
|
|
* @return True if any schematic clean up was performed.
|
|
|
|
*/
|
2019-05-11 10:06:28 +00:00
|
|
|
bool SchematicCleanUp( SCH_SCREEN* aScreen = nullptr );
|
2019-04-17 19:09:48 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* If any single wire passes through _both points_, remove the portion between the two points,
|
|
|
|
* potentially splitting the wire into two.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @note This always appends to the existing undo state.
|
2019-05-11 10:06:28 +00:00
|
|
|
*
|
2019-04-17 19:09:48 +00:00
|
|
|
* @param aStart The starting point for trimmming
|
|
|
|
* @param aEnd The ending point for trimming
|
|
|
|
* @return True if any wires were changed by this operation
|
|
|
|
*/
|
2022-01-01 06:04:08 +00:00
|
|
|
bool TrimWire( const VECTOR2I& aStart, const VECTOR2I& aEnd );
|
2019-04-17 19:09:48 +00:00
|
|
|
|
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Collect a unique list of all possible connection points in the schematic.
|
2019-04-17 19:09:48 +00:00
|
|
|
*
|
2020-09-08 13:27:13 +00:00
|
|
|
* @return vector of connections
|
2019-04-17 19:09:48 +00:00
|
|
|
*/
|
2022-01-01 06:04:08 +00:00
|
|
|
std::vector<VECTOR2I> GetSchematicConnections();
|
2019-04-17 19:09:48 +00:00
|
|
|
|
2019-06-01 15:28:39 +00:00
|
|
|
void OnOpenPcbnew( wxCommandEvent& event );
|
|
|
|
void OnOpenCvpcb( wxCommandEvent& event );
|
|
|
|
void OnUpdatePCB( wxCommandEvent& event );
|
|
|
|
void OnAnnotate( wxCommandEvent& event );
|
|
|
|
|
2020-03-06 20:02:58 +00:00
|
|
|
/**
|
|
|
|
* Verify that \a aSheet will not cause a recursion error in \a aHierarchy.
|
|
|
|
*
|
|
|
|
* @param aSheet is the #SCH_SHEET object to test.
|
|
|
|
* @param aHierarchy is the #SCH_SHEET_PATH where \a aSheet is going to reside.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @return true if \a aSheet will cause a recursion error in \a aHierarchy.
|
2020-03-06 20:02:58 +00:00
|
|
|
*/
|
|
|
|
bool CheckSheetForRecursion( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy );
|
|
|
|
|
2019-11-17 16:43:05 +00:00
|
|
|
/**
|
|
|
|
* Check \a aSchematicFileName for a potential file name case sensitivity clashes.
|
|
|
|
*
|
|
|
|
* On platforms where file names are case sensitive, it is possible to schematic sheet
|
|
|
|
* file names that would cause issues on platforms where file name are case insensitive.
|
|
|
|
* File names foo.sch and Foo.sch are unique files on Linux and MacOS but on Windows
|
|
|
|
* this would result in a broken schematic.
|
|
|
|
*
|
|
|
|
* @param aSchematicFileName is the absolute path and file name of the file to test.
|
2021-03-25 14:07:16 +00:00
|
|
|
* @return true if the user accepts the potential file name clash risk.
|
2019-11-17 16:43:05 +00:00
|
|
|
*/
|
2020-03-06 20:02:58 +00:00
|
|
|
bool AllowCaseSensitiveFileNameClashes( const wxString& aSchematicFileName );
|
2019-11-17 16:43:05 +00:00
|
|
|
|
2011-06-07 15:29:01 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Edit an existing sheet or add a new sheet to the schematic.
|
|
|
|
*
|
2011-06-07 15:29:01 +00:00
|
|
|
* When \a aSheet is a new sheet:
|
2017-11-17 17:00:04 +00:00
|
|
|
* - and the file name already exists in the schematic hierarchy, the screen associated
|
|
|
|
* with the sheet found in the hierarchy is associated with \a aSheet.
|
|
|
|
* - and the file name already exists on the system, then \a aSheet is loaded with the
|
|
|
|
* existing file.
|
|
|
|
* - and the file name does not exist in the schematic hierarchy or on the file system,
|
|
|
|
* then a new screen is created and associated with \a aSheet.
|
|
|
|
*
|
2011-06-07 15:29:01 +00:00
|
|
|
* When \a aSheet is an existing sheet:
|
2017-11-17 17:00:04 +00:00
|
|
|
* - and the file name already exists in the schematic hierarchy, the current associated
|
|
|
|
* screen is replace by the one found in the hierarchy.
|
|
|
|
* - and the file name already exists on the system, the current associated screen file
|
|
|
|
* name is changed and the file is loaded.
|
|
|
|
* - and the file name does not exist in the schematic hierarchy or on the file system,
|
|
|
|
* the current associated screen file name is changed and saved to disk.
|
2015-06-28 16:45:05 +00:00
|
|
|
*
|
|
|
|
* Note: the screen is not refresh. The caller is responsible to do that
|
2018-09-03 10:11:39 +00:00
|
|
|
*
|
|
|
|
* @param aSheet is the sheet to edit
|
|
|
|
* @param aHierarchy is the current hierarchy containing aSheet
|
|
|
|
* @param aClearAnnotationNewItems is a reference to a bool to know if the items managed by
|
|
|
|
* this sheet need to have their annotation cleared i.e. when an existing item list is used.
|
2021-03-25 14:07:16 +00:00
|
|
|
* it can happens when the edited sheet used an existing file, or becomes a new instance
|
2018-09-03 10:11:39 +00:00
|
|
|
* of a already existing sheet.
|
|
|
|
*/
|
2020-07-06 10:51:04 +00:00
|
|
|
bool EditSheetProperties( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
|
|
|
|
bool* aClearAnnotationNewItems );
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2019-05-31 22:03:27 +00:00
|
|
|
void InitSheet( SCH_SHEET* aSheet, const wxString& aNewFilename );
|
|
|
|
|
2018-02-26 10:34:36 +00:00
|
|
|
/**
|
2019-07-29 19:59:31 +00:00
|
|
|
* Load a the KiCad schematic file \a aFileName into the sheet \a aSheet.
|
2018-02-26 10:34:36 +00:00
|
|
|
*
|
2019-07-29 19:59:31 +00:00
|
|
|
* If \a aSheet does not have a valid #SCH_SCREEN object, the schematic is loaded into
|
|
|
|
* \a Sheet. Otherwise, it is appended to the current #SCH_SCREEN object.
|
|
|
|
*
|
|
|
|
* In order to import a schematic a lot of things have to happen to before the contents
|
|
|
|
* of the imported schematic can be appended to the current page. The following list
|
|
|
|
* describes this process:
|
|
|
|
*
|
|
|
|
* - Load the schematic into a temporary #SCH_SHEET object.
|
|
|
|
* - Make sure the imported schematic does not cause any hierarchy recursion issues.
|
|
|
|
* - Verify the imported schematic uses fully qualified #LIB_ID objects (symbol library table).
|
|
|
|
* - Check all of the possible combinations that could cause broken symbol library links
|
|
|
|
* and give the user the option to cancel the append process. The following conditions
|
|
|
|
* are check but they still do not guarantee that there will not be any broken symbol
|
|
|
|
* library links:
|
|
|
|
* - The source schematic is in the current project path and contains symbol library
|
|
|
|
* nicknames not found in the project symbol library table. This can happen if the
|
|
|
|
* schematic is copied to the current project path from another project.
|
|
|
|
* - The source schematic is in a different path and there are symbol library link nicknames
|
|
|
|
* that do not exist in either the current symbol library table or the source project
|
|
|
|
* symbol library table if it exists in the source path.
|
|
|
|
* - The source schematic is in a different path and contains duplicate symbol library
|
|
|
|
* nicknames that point to different libraries.
|
|
|
|
* - Check to see if any symbol libraries need to be added to the current project's symbol
|
|
|
|
* library table. This includes:
|
|
|
|
* - Check if the symbol library already exists in the project or global symbol library
|
|
|
|
* table.
|
|
|
|
* - Convert symbol library URLS that use the ${KIPRJMOD} environment variable to absolute
|
|
|
|
* paths. ${KIPRJMOD} will not be the same for this project.
|
|
|
|
* - Clear all of the annotation in the imported schematic to prevent clashes.
|
|
|
|
* - Append the objects from the temporary sheet to the current page.
|
|
|
|
* - Replace any duplicate time stamps.
|
|
|
|
* - Refresh the symbol library links.
|
|
|
|
*
|
|
|
|
* @param aSheet is the sheet to either append or load the schematic.
|
|
|
|
* @param aHierarchy is the current position in the schematic hierarchy used to test for
|
|
|
|
* possible file recursion issues.
|
|
|
|
* @param aFileName is the file name to load. The file name is expected to have an absolute
|
|
|
|
* path.
|
|
|
|
*
|
|
|
|
* @return True if the schematic was imported properly.
|
2018-02-26 10:34:36 +00:00
|
|
|
*/
|
2019-07-29 19:59:31 +00:00
|
|
|
bool LoadSheetFromFile( SCH_SHEET* aSheet, SCH_SHEET_PATH* aHierarchy,
|
|
|
|
const wxString& aFileName );
|
2018-02-26 10:34:36 +00:00
|
|
|
|
2018-02-02 20:04:36 +00:00
|
|
|
/**
|
|
|
|
* Removes a given junction and heals any wire segments under the junction
|
|
|
|
*
|
|
|
|
* @param aItem The junction to delete
|
|
|
|
* @param aAppend True if we are updating an ongoing commit
|
|
|
|
*/
|
|
|
|
void DeleteJunction( SCH_ITEM* aItem, bool aAppend = false );
|
|
|
|
|
2021-06-10 14:10:55 +00:00
|
|
|
void ConvertPart( SCH_SYMBOL* aSymbol );
|
2019-05-01 21:50:11 +00:00
|
|
|
|
2021-06-10 14:10:55 +00:00
|
|
|
void SelectUnit( SCH_SYMBOL* aSymbol, int aUnit );
|
2019-04-27 23:50:35 +00:00
|
|
|
|
2008-04-14 19:22:48 +00:00
|
|
|
/* Undo - redo */
|
2009-07-26 17:16:42 +00:00
|
|
|
|
2021-02-13 01:15:45 +00:00
|
|
|
/**
|
|
|
|
* Create a new, blank stack for future Undo commands to be pushed to
|
|
|
|
*/
|
|
|
|
void StartNewUndo();
|
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2010-12-14 21:39:31 +00:00
|
|
|
* Create a copy of the current schematic item, and put it in the undo list.
|
|
|
|
*
|
2020-07-13 11:21:40 +00:00
|
|
|
* aTypeCommand =
|
2020-08-26 18:04:32 +00:00
|
|
|
* CHANGED
|
|
|
|
* NEWITEM
|
|
|
|
* DELETED
|
2010-12-14 21:39:31 +00:00
|
|
|
*
|
|
|
|
* If it is a delete command, items are put on list with the .Flags member
|
2020-08-26 18:04:32 +00:00
|
|
|
* set to DELETED.
|
2010-12-14 21:39:31 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aItemToCopy is the schematic item modified by the command to undo.
|
|
|
|
* @param aTypeCommand is the command type (see enum UNDO_REDO).
|
|
|
|
* @param aAppend set to true to add the item to the previous undo list.
|
2022-03-16 13:43:19 +00:00
|
|
|
* @param aDirtyConnectivity set to true if the change can affect connectivity.
|
2009-07-26 17:16:42 +00:00
|
|
|
*/
|
2021-03-25 14:07:16 +00:00
|
|
|
void SaveCopyInUndoList( SCH_SCREEN* aScreen, SCH_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
|
2022-03-16 13:43:19 +00:00
|
|
|
bool aAppend, bool aDirtyConnectivity = true );
|
2009-07-26 17:16:42 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Create a new entry in undo list of commands.
|
|
|
|
*
|
2021-06-09 19:32:58 +00:00
|
|
|
* @param aItemsList is the list of items modified by the command to undo/
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aTypeCommand is the command type (see enum UNDO_REDO).
|
|
|
|
* @param aAppend set to true to add the item to the previous undo list.
|
2022-03-16 13:43:19 +00:00
|
|
|
* @param aDirtyConnectivity set to true if the change can affect connectivity.
|
2009-07-26 17:16:42 +00:00
|
|
|
*/
|
2021-03-25 14:07:16 +00:00
|
|
|
void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
|
2022-03-16 13:43:19 +00:00
|
|
|
bool aAppend, bool aDirtyConnectivity = true );
|
2008-04-14 19:22:48 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Restore an undo or redo command to put data pointed by \a aList in the previous state.
|
|
|
|
*
|
2010-12-14 21:39:31 +00:00
|
|
|
* @param aList a PICKED_ITEMS_LIST pointer to the list of items to undo/redo
|
2009-08-01 19:26:05 +00:00
|
|
|
*/
|
2021-02-15 14:02:41 +00:00
|
|
|
void PutDataInPreviousState( PICKED_ITEMS_LIST* aList );
|
2009-09-22 12:27:57 +00:00
|
|
|
|
2020-07-13 11:21:40 +00:00
|
|
|
/**
|
|
|
|
* Free the undo or redo list from \a aList element.
|
|
|
|
*
|
|
|
|
* - Wrappers are deleted.
|
|
|
|
* - data pointed by wrappers are deleted if not in use in schematic
|
|
|
|
* i.e. when they are copy of a schematic item or they are no more in use (DELETED)
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param whichList is the UNDO_REDO_CONTAINER to clear
|
|
|
|
* @param aItemCount is the count of items to remove. Use < 0 to remove all items from
|
|
|
|
* the beginning of the list.
|
2020-07-13 11:21:40 +00:00
|
|
|
*/
|
2020-07-13 13:50:35 +00:00
|
|
|
void ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount = -1 ) override;
|
2020-07-13 11:21:40 +00:00
|
|
|
|
2013-08-05 21:02:41 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Clone \a aItem and owns that clone in this container.
|
2013-08-05 21:02:41 +00:00
|
|
|
*/
|
2021-03-06 09:27:41 +00:00
|
|
|
void SaveCopyForRepeatItem( const SCH_ITEM* aItem );
|
2022-09-09 17:08:18 +00:00
|
|
|
void AddCopyForRepeatItem( const SCH_ITEM* aItem );
|
2013-08-05 21:02:41 +00:00
|
|
|
|
|
|
|
/**
|
2022-09-09 17:08:18 +00:00
|
|
|
* Return the items which are to be repeated with the insert key. Such objects are owned by
|
|
|
|
* this container, and must be cloned.
|
2013-08-05 21:02:41 +00:00
|
|
|
*/
|
2022-09-09 17:08:18 +00:00
|
|
|
const std::vector<std::unique_ptr<SCH_ITEM>>& GetRepeatItems() const
|
|
|
|
{
|
|
|
|
return m_items_to_repeat;
|
|
|
|
}
|
2011-01-12 21:47:54 +00:00
|
|
|
|
2021-03-06 09:27:41 +00:00
|
|
|
EDA_ITEM* GetItem( const KIID& aId ) const override;
|
2020-04-24 13:36:10 +00:00
|
|
|
|
2019-04-23 17:40:29 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Perform an undo of the last edit WITHOUT logging a corresponding redo. Used to cancel
|
2019-04-23 17:40:29 +00:00
|
|
|
* an in-progress operation.
|
|
|
|
*/
|
|
|
|
void RollbackSchematicFromUndo();
|
|
|
|
|
2013-01-21 19:58:02 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Create a symbol library file with the name of the root document plus the '-cache' suffix,
|
2013-01-21 19:58:02 +00:00
|
|
|
*
|
2021-06-10 14:10:55 +00:00
|
|
|
* This file will contain all symbols used in the current schematic.
|
2017-11-17 17:00:04 +00:00
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aUseCurrentSheetFilename set to false to use the root sheet filename
|
|
|
|
* (default) or true to use the currently opened sheet.
|
2013-05-07 18:32:06 +00:00
|
|
|
* @return true if the file was written successfully.
|
2013-01-21 19:58:02 +00:00
|
|
|
*/
|
2013-05-07 18:32:06 +00:00
|
|
|
bool CreateArchiveLibraryCacheFile( bool aUseCurrentSheetFilename = false );
|
2013-01-21 19:58:02 +00:00
|
|
|
|
2011-11-11 20:10:24 +00:00
|
|
|
/**
|
2021-06-10 14:10:55 +00:00
|
|
|
* Create a library \a aFileName that contains all symbols used in the current schematic.
|
2011-11-11 20:10:24 +00:00
|
|
|
*
|
|
|
|
* @param aFileName The full path and file name of the archive library.
|
|
|
|
* @return True if \a aFileName was written successfully.
|
|
|
|
*/
|
|
|
|
bool CreateArchiveLibrary( const wxString& aFileName );
|
|
|
|
|
2011-03-29 15:21:35 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Plot or print the current sheet to the clipboard.
|
2011-03-28 19:26:31 +00:00
|
|
|
*/
|
2020-12-20 18:18:54 +00:00
|
|
|
virtual void PrintPage( const RENDER_SETTINGS* aSettings ) override;
|
2011-03-28 19:26:31 +00:00
|
|
|
|
2011-06-15 18:44:24 +00:00
|
|
|
void SetNetListerCommand( const wxString& aCommand ) { m_netListerCommand = aCommand; }
|
|
|
|
|
2016-03-31 06:28:16 +00:00
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Reset the execution flags to defaults for external netlist and bom generators.
|
2016-03-31 06:28:16 +00:00
|
|
|
*/
|
|
|
|
void DefaultExecFlags() { m_exec_flags = wxEXEC_SYNC; }
|
|
|
|
|
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Set (adds) specified flags for next execution of external generator of the netlist or bom.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aFlags is the wxEXEC_* flags, see wxExecute documentation.
|
2016-03-31 06:28:16 +00:00
|
|
|
*/
|
|
|
|
void SetExecFlags( const int aFlags ) { m_exec_flags |= aFlags; }
|
|
|
|
|
|
|
|
/**
|
2017-11-17 17:00:04 +00:00
|
|
|
* Clear (removes) specified flags that not needed for next execution of external generator
|
|
|
|
* of the netlist or bom.
|
|
|
|
*
|
2021-03-25 14:07:16 +00:00
|
|
|
* @param aFlags is the wxEXEC_* flags, see wxExecute documentation.
|
2016-03-31 06:28:16 +00:00
|
|
|
*/
|
|
|
|
void ClearExecFlags( const int aFlags ) { m_exec_flags &= ~( aFlags ); }
|
|
|
|
|
2011-06-15 18:44:24 +00:00
|
|
|
wxString GetNetListerCommand() const { return m_netListerCommand; }
|
|
|
|
|
2019-03-11 21:32:05 +00:00
|
|
|
/**
|
2021-03-25 14:07:16 +00:00
|
|
|
* Generate the connection data for the entire schematic hierarchy.
|
2019-03-11 21:32:05 +00:00
|
|
|
*/
|
2019-11-10 23:24:27 +00:00
|
|
|
void RecalculateConnections( SCH_CLEANUP_FLAGS aCleanupFlags );
|
2019-03-11 21:32:05 +00:00
|
|
|
|
2018-05-14 17:34:18 +00:00
|
|
|
/**
|
|
|
|
* Called after the preferences dialog is run.
|
|
|
|
*/
|
2020-07-17 20:04:14 +00:00
|
|
|
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
|
2018-01-08 04:05:03 +00:00
|
|
|
|
2020-08-13 21:30:30 +00:00
|
|
|
void UpdateNetHighlightStatus();
|
|
|
|
|
2018-06-30 22:38:04 +00:00
|
|
|
void ShowChangedLanguage() override;
|
|
|
|
|
2019-06-01 15:28:39 +00:00
|
|
|
void SetScreen( BASE_SCREEN* aScreen ) override;
|
2018-08-03 12:18:26 +00:00
|
|
|
|
2020-09-25 07:31:56 +00:00
|
|
|
const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
|
2018-06-30 22:38:04 +00:00
|
|
|
|
2021-05-28 19:35:38 +00:00
|
|
|
void FixupJunctions();
|
2019-06-23 15:12:25 +00:00
|
|
|
|
2021-09-02 11:40:45 +00:00
|
|
|
int GetSchematicJunctionSize();
|
|
|
|
|
2020-05-13 02:00:37 +00:00
|
|
|
void FocusOnItem( SCH_ITEM* aItem );
|
|
|
|
|
2022-07-19 15:00:35 +00:00
|
|
|
bool IsSyncingSelection() { return m_syncingPcbToSchSelection; }
|
|
|
|
|
2020-08-31 15:06:23 +00:00
|
|
|
/**
|
2021-11-11 16:42:25 +00:00
|
|
|
* Update a schematic symbol from a LIB_SYMBOL.
|
2020-08-31 15:06:23 +00:00
|
|
|
*
|
|
|
|
* This is typically called from the symbol editor when editing symbols in place.
|
|
|
|
*
|
2021-11-11 16:42:25 +00:00
|
|
|
* @param aSymbol is the new symbol data.
|
|
|
|
* @param aSchematicSymbolUUID refers to the schematic symbol to update.
|
2020-08-31 15:06:23 +00:00
|
|
|
*/
|
2021-11-11 16:42:25 +00:00
|
|
|
void SaveSymbolToSchematic( const LIB_SYMBOL& aSymbol, const KIID& aSchematicSymbolUUID );
|
2020-08-31 15:06:23 +00:00
|
|
|
|
2020-11-29 16:31:43 +00:00
|
|
|
/**
|
|
|
|
* Update the schematic's page reference map for all global labels, and refresh the labels
|
|
|
|
* so that they are redrawn with up-to-date references.
|
|
|
|
*/
|
2022-12-03 13:25:20 +00:00
|
|
|
void RecomputeIntersheetRefs();
|
2020-08-31 14:11:54 +00:00
|
|
|
|
2020-11-17 16:02:47 +00:00
|
|
|
void ShowAllIntersheetRefs( bool aShow );
|
2020-08-31 14:11:54 +00:00
|
|
|
|
2021-10-13 18:48:28 +00:00
|
|
|
/**
|
|
|
|
* This overloaded version checks if the auto save master file "#auto_saved_files#" exists
|
|
|
|
* and recovers all of the schematic files listed in it.
|
|
|
|
*
|
|
|
|
* @param aFileName is the project auto save master file name.
|
|
|
|
*/
|
|
|
|
virtual void CheckForAutoSaveFile( const wxFileName& aFileName ) override;
|
|
|
|
|
2022-06-02 21:56:17 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Toggle the show/hide state of the left side schematic navigation panel
|
|
|
|
*/
|
|
|
|
void ToggleSchematicHierarchy();
|
|
|
|
|
2022-06-07 09:00:13 +00:00
|
|
|
/**
|
|
|
|
* @return the name of the wxAuiPaneInfo managing the Hierarchy Navigator panel
|
|
|
|
*/
|
|
|
|
static const wxString SchematicHierarchyPaneName()
|
|
|
|
{
|
|
|
|
return wxT( "SchematicHierarchy" );
|
|
|
|
}
|
|
|
|
|
2008-04-14 19:22:48 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
2021-03-25 14:07:16 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
/**
|
|
|
|
* Save the schematic files that have been modified and not yet saved.
|
|
|
|
*
|
|
|
|
* @return true if the auto save was successful otherwise false.
|
|
|
|
*/
|
|
|
|
bool doAutoSave() override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Send the KiCad netlist over to CVPCB.
|
|
|
|
*/
|
|
|
|
void sendNetlistToCvpcb();
|
|
|
|
|
|
|
|
void onSize( wxSizeEvent& aEvent );
|
|
|
|
|
|
|
|
private:
|
2022-06-09 17:39:35 +00:00
|
|
|
// Called when resizing the Hierarchy Navigator panel
|
|
|
|
void OnResizeHierarchyNavigator( wxSizeEvent& aEvent );
|
|
|
|
|
2021-03-25 14:07:16 +00:00
|
|
|
// 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;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the main window title bar text.
|
|
|
|
*
|
|
|
|
* If file name defined by SCH_SCREEN::m_FileName is not set, the title is set to the
|
|
|
|
* application name appended with no file.
|
|
|
|
* Otherwise, the title is set to the hierarchical sheet path and the full file name, and
|
|
|
|
* read only is appended to the title if the user does not have write access to the file.
|
|
|
|
*/
|
|
|
|
void UpdateTitle();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initialize the zoom value of the current screen and mark the screen as zoom-initialized.
|
|
|
|
*/
|
|
|
|
void initScreenZoom();
|
|
|
|
|
|
|
|
/**
|
Fix source comment/doc typos (follow-up)
Found via `codespell -q 3 -S *.po,./thirdparty -L aactual,acount,aline,alocation,alog,anormal,anumber,aother,apoints,aparent,aray,dout,einstance,modul,ot,overide,serie,te,,tesselate,tesselator,tht`
2021-07-03 22:37:31 +00:00
|
|
|
* Verify that the symbol library links \a aSheet and all of its child sheets have
|
2021-03-25 14:07:16 +00:00
|
|
|
* been remapped to the symbol library table.
|
|
|
|
*
|
|
|
|
* @param aSheet is the #SCH_SHEET object to test.
|
|
|
|
*
|
Fix source comment/doc typos (follow-up)
Found via `codespell -q 3 -S *.po,./thirdparty -L aactual,acount,aline,alocation,alog,anormal,anumber,aother,apoints,aparent,aray,dout,einstance,modul,ot,overide,serie,te,,tesselate,tesselator,tht`
2021-07-03 22:37:31 +00:00
|
|
|
* @return true if \a aSheet and its child sheets have not been remapped.
|
2021-03-25 14:07:16 +00:00
|
|
|
*/
|
|
|
|
bool checkForNoFullyDefinedLibIds( SCH_SHEET* aSheet );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Load the given filename but sets the path to the current project path.
|
|
|
|
*
|
|
|
|
* @param full filepath of file to be imported.
|
|
|
|
* @param aFileType SCH_FILE_T value for file type
|
|
|
|
*/
|
|
|
|
bool importFile( const wxString& aFileName, int aFileType );
|
|
|
|
|
2021-08-24 03:01:08 +00:00
|
|
|
/**
|
|
|
|
* Save \a aSheet to a schematic file.
|
|
|
|
*
|
|
|
|
* @param aSheet is the #SCH_SHEET object to save.
|
|
|
|
* @param aSavePath is the full path of the destination file
|
|
|
|
* @return True if the file has been saved.
|
|
|
|
*/
|
|
|
|
bool saveSchematicFile( SCH_SHEET* aSheet, const wxString& aSavePath );
|
|
|
|
|
2021-03-25 14:07:16 +00:00
|
|
|
/**
|
|
|
|
* Fill a map of uuid -> reference from the currently loaded schematic.
|
|
|
|
*
|
|
|
|
* @param aMap is a map to fill
|
|
|
|
*/
|
|
|
|
void mapExistingAnnotation( std::map<wxString, wxString>& aMap );
|
|
|
|
|
2021-10-13 18:48:28 +00:00
|
|
|
bool updateAutoSaveFile();
|
|
|
|
|
|
|
|
const wxString& getAutoSaveFileName() const;
|
|
|
|
|
2021-03-25 14:07:16 +00:00
|
|
|
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; ///< The currently loaded schematic
|
|
|
|
const SCH_CONNECTION* m_highlightedConn; ///< The highlighted net or bus, or nullptr
|
|
|
|
|
|
|
|
wxPageSetupDialogData m_pageSetupData;
|
2022-09-09 17:08:18 +00:00
|
|
|
std::vector<std::unique_ptr<SCH_ITEM>> m_items_to_repeat; ///< For the repeat-last-item cmd
|
|
|
|
|
2021-03-25 14:07:16 +00:00
|
|
|
wxString m_netListerCommand; ///< Command line to call a custom net list
|
|
|
|
///< generator.
|
|
|
|
int m_exec_flags; ///< Flags of the wxExecute() function
|
|
|
|
///< to call a custom net list generator.
|
|
|
|
|
|
|
|
DIALOG_SCH_FIND* m_findReplaceDialog;
|
2022-06-02 21:56:17 +00:00
|
|
|
|
|
|
|
HIERARCHY_NAVIG_PANEL* m_hierarchy;
|
2022-07-19 15:00:35 +00:00
|
|
|
|
|
|
|
bool m_syncingPcbToSchSelection; // Recursion guard when synchronizing selection from PCB
|
2008-04-14 19:22:48 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2018-01-30 10:49:51 +00:00
|
|
|
#endif // SCH_EDIT_FRAME_H
|