haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/eeschema/dialogs/dialog_symbol_remap.cpp

519 lines
18 KiB
C++
Raw Normal View History

Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
/**
* @file dialog_symbol_remap.cpp
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Eeschema: use symbol nomenclature for object file naming.
2021-02-24 13:48:02 +00:00
* Copyright (C) 2017 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +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 3 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 <http://www.gnu.org/licenses/>.
*/
#include <macros.h>
#include <pgm_base.h>
KIFACE_I -> KIFACE_BASE.
2021-09-14 22:45:14 +00:00
#include <kiface_base.h>
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
#include <project.h>
#include <confirm.h>
#include <reporter.h>
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
#include <wildcards_and_files_ext.h>
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
#include <wx_html_report_panel.h>
Rename class_library.[h|cpp] to symbol_library.[h|cpp].
2021-06-15 13:24:55 +00:00
#include <symbol_library.h>
Use kicad_algo directly rather than common.h
2020-10-24 12:53:11 +00:00
#include <core/kicad_algo.h>
Update naming.
2020-12-25 23:37:01 +00:00
#include <symbol_viewer_frame.h>
Decouple SCH_EDIT_FRAME from symbol rescue and remap dialogs. Do not keep pointer to SCH_EDIT_FRAME in the rescuer object to prevent it from creating dialogs with itself as the parent when call from the rescue dialog which is itself a grandchild of the frame window.
2019-02-05 17:14:27 +00:00
#include <project_rescue.h>
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
#include <sch_io_mgr.h>
Eeschema: use symbol nomenclature for object file naming.
2021-02-24 13:48:02 +00:00
#include <sch_symbol.h>
Fix code after renaming files, and a bit of code cleanup (remove useless includes and multiple includes of the same files)
2018-01-30 08:56:43 +00:00
#include <sch_screen.h>
fix code after renamin files
2018-01-30 10:49:51 +00:00
#include <sch_edit_frame.h>
Move Eeschema globals to new SCHEMATIC object Set up a new lineage for SCH_ITEMS to get back to the SCHEMATIC they live on: Items will all be parented to the SCH_SCREEN that they are added to, and each SCH_SCREEN will point back to the SCHEMATIC that it is part of. Note that this hierarchy is not the same as the actual schematic hierarchy, which continues to be managed through SCH_SHEETs and SCH_SHEET_PATHS.
2020-05-13 02:00:37 +00:00
#include <schematic.h>
Port Eeschema to new project settings DRC/ERC error serialization changed to use explicit tokens Old stored severities and ignored errors are discarded
2020-06-08 02:19:46 +00:00
#include <settings/settings_manager.h>
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
#include <symbol_lib_table.h>
Moved path normalization functions to a separate file Normalizing paths to environmental variables might be useful in many places, therefore it is better to keep them accessible.
2017-11-14 10:17:16 +00:00
#include <env_paths.h>
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
#include <dialog_symbol_remap.h>
Final symbol library table changes before merge. Remove all symbol libraries from the project file after remapping to prevent symbols that should be loaded from the cache being loaded from a library further up the search order. Save the project file to clear all of the libraries so they never get reloaded again. Remove the symbol library management dialog and menu entries. Rename the symbol library table dialog menu entry. Remove all symbol libraries from default project file to prevent clashes with the cache library. Fix illegal symbol naming in Eagle plugin.
2017-11-01 00:57:57 +00:00
DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP( SCH_EDIT_FRAME* aParent ) :
Move Eeschema globals to new SCHEMATIC object Set up a new lineage for SCH_ITEMS to get back to the SCHEMATIC they live on: Items will all be parented to the SCH_SCREEN that they are added to, and each SCH_SCREEN will point back to the SCHEMATIC that it is part of. Note that this hierarchy is not the same as the actual schematic hierarchy, which continues to be managed through SCH_SHEETs and SCH_SHEET_PATHS.
2020-05-13 02:00:37 +00:00
DIALOG_SYMBOL_REMAP_BASE( aParent ),
m_frame( aParent )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
Minor symbol remapping fixes. The remapping utility would create a new project specific library when a symbolic link pointed to a library already defined in the symbol library table. Now the comparison checks to see if the library path and file name are actually a symbolic link if the file names are not the same when the symbol library table entry is a file name rather than a URL. URLs are simple string comparisons. Disable the remap button after the remapping completed. Remove some commented out code from the edit symbol in schematic dialog. Fixes lp:1738634 https://bugs.launchpad.net/kicad/+bug/1738634
2017-12-18 23:25:34 +00:00
m_remapped = false;
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
if( !wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
{
More error message regularization.
2021-06-28 23:44:07 +00:00
DisplayInfoMessage( this, _( "Remapping is not possible because you have insufficient "
"privileges to the project folder '%s'." ) );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
// Disable the remap button.
m_remapped = true;
}
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
wxString text;
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
text = _( "This schematic currently uses the project symbol library list look up method "
"for loading library symbols. KiCad will attempt to map the existing symbols "
"to use the new symbol library table. Remapping will change some project files "
"and schematics may not be compatible with older versions of KiCad. All files "
"that are changed will be backed up to the \"remap_backup\" folder in the project "
"folder should you need to revert any changes. If you choose to skip this step, "
"you will be responsible for manually remapping the symbols." );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
m_htmlCtrl->AppendToPage( text );
Make sure reporters have a better default path than /bin.
2021-02-25 15:05:26 +00:00
m_messagePanel->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
void DIALOG_SYMBOL_REMAP::OnRemapSymbols( wxCommandEvent& aEvent )
{
Eeschema: fix remapping bug on windows builds. The Windows drive specifier C: was being interpreted as a valid URL by wxURI which was performing a URL comparison instead of a file comparison which always failed in LIB_TABLE_BASE::FindRowByURI(). Change test for URI to search string for "://" to determine if the comparison should be a URI (string) comparison or a file (wxFileName) comparison. Don't run final rescue unless the user performs the remapping.
2018-01-03 13:37:54 +00:00
SCH_EDIT_FRAME* parent = dynamic_cast< SCH_EDIT_FRAME* >( GetParent() );
wxCHECK_RET( parent != nullptr, "Parent window is not type SCH_EDIT_FRAME." );
Fix more bugs in the schematic symbol rescuer. In the rare case when something goes wrong with the symbol library table remapping, do not attempt to rescue symbols that are neither in the cache nor in any of the libraries. The legacy rescue library code overwrote the existing library so previous rescues would get lost. If the rescue library exists, copy it's contents into the new rescue library before adding the new rescued symbols so no previously rescued symbols are lost. Fix a null pointer bug in the symbol library editor when no symbol is loaded. Set LIB_ID item name to name passed to LIB_PART ctor. Copy LIB_ID in LIB_PART copy ctor.
2017-11-10 02:24:43 +00:00
wxBusyCursor busy;
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
if( !backupProject( m_messagePanel->Reporter() ) )
return;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Eeschema: fix remapping bug on windows builds. The Windows drive specifier C: was being interpreted as a valid URL by wxURI which was performing a URL comparison instead of a file comparison which always failed in LIB_TABLE_BASE::FindRowByURI(). Change test for URI to search string for "://" to determine if the comparison should be a URI (string) comparison or a file (wxFileName) comparison. Don't run final rescue unless the user performs the remapping.
2018-01-03 13:37:54 +00:00
// Ignore the never show rescue setting for one last rescue of legacy symbol
// libraries before remapping to the symbol library table. This ensures the
// best remapping results.
Move Eeschema globals to new SCHEMATIC object Set up a new lineage for SCH_ITEMS to get back to the SCHEMATIC they live on: Items will all be parented to the SCH_SCREEN that they are added to, and each SCH_SCREEN will point back to the SCHEMATIC that it is part of. Note that this hierarchy is not the same as the actual schematic hierarchy, which continues to be managed through SCH_SHEETs and SCH_SHEET_PATHS.
2020-05-13 02:00:37 +00:00
LEGACY_RESCUER rescuer( Prj(), &parent->Schematic(), &parent->GetCurrentSheet(),
parent->GetCanvas()->GetBackend() );
Decouple SCH_EDIT_FRAME from symbol rescue and remap dialogs. Do not keep pointer to SCH_EDIT_FRAME in the rescuer object to prevent it from creating dialogs with itself as the parent when call from the rescue dialog which is itself a grandchild of the frame window.
2019-02-05 17:14:27 +00:00
if( RESCUER::RescueProject( this, rescuer, false ) )
{
Update naming.
2020-12-25 23:37:01 +00:00
auto viewer = (SYMBOL_VIEWER_FRAME*) parent->Kiway().Player( FRAME_SCH_VIEWER, false );
Decouple SCH_EDIT_FRAME from symbol rescue and remap dialogs. Do not keep pointer to SCH_EDIT_FRAME in the rescuer object to prevent it from creating dialogs with itself as the parent when call from the rescue dialog which is itself a grandchild of the frame window.
2019-02-05 17:14:27 +00:00
if( viewer )
Naming conventions.
2020-12-17 23:56:47 +00:00
viewer->ReCreateLibList();
Decouple SCH_EDIT_FRAME from symbol rescue and remap dialogs. Do not keep pointer to SCH_EDIT_FRAME in the rescuer object to prevent it from creating dialogs with itself as the parent when call from the rescue dialog which is itself a grandchild of the frame window.
2019-02-05 17:14:27 +00:00
Make undo/redo lists protected.
2020-07-13 13:50:35 +00:00
parent->ClearUndoORRedoList( EDA_BASE_FRAME::UNDO_LIST, 1 );
Decouple SCH_EDIT_FRAME from symbol rescue and remap dialogs. Do not keep pointer to SCH_EDIT_FRAME in the rescuer object to prevent it from creating dialogs with itself as the parent when call from the rescue dialog which is itself a grandchild of the frame window.
2019-02-05 17:14:27 +00:00
parent->SyncView();
parent->GetCanvas()->Refresh();
parent->OnModify();
}
Eeschema: fix remapping bug on windows builds. The Windows drive specifier C: was being interpreted as a valid URL by wxURI which was performing a URL comparison instead of a file comparison which always failed in LIB_TABLE_BASE::FindRowByURI(). Change test for URI to search string for "://" to determine if the comparison should be a URI (string) comparison or a file (wxFileName) comparison. Don't run final rescue unless the user performs the remapping.
2018-01-03 13:37:54 +00:00
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
// The schematic is fully loaded, any legacy library symbols have been rescued. Now
// check to see if the schematic has not been converted to the symbol library table
// method for looking up symbols.
wxFileName prjSymLibTableFileName( Prj().GetProjectPath(),
SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
// Delete the existing project symbol library table.
if( prjSymLibTableFileName.FileExists() )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
wxRemoveFile( prjSymLibTableFileName.GetFullPath() );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
createProjectSymbolLibTable( m_messagePanel->Reporter() );
More NULL expunging.
2021-07-16 20:13:26 +00:00
Prj().SetElem( PROJECT::ELEM_SYMBOL_LIB_TABLE, nullptr );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
Prj().SchSymbolLibTable();
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
remapSymbolsToLibTable( m_messagePanel->Reporter() );
Final symbol library table changes before merge. Remove all symbol libraries from the project file after remapping to prevent symbols that should be loaded from the cache being loaded from a library further up the search order. Save the project file to clear all of the libraries so they never get reloaded again. Remove the symbol library management dialog and menu entries. Rename the symbol library table dialog menu entry. Remove all symbol libraries from default project file to prevent clashes with the cache library. Fix illegal symbol naming in Eagle plugin.
2017-11-01 00:57:57 +00:00
// Remove all of the libraries from the legacy library list.
Clear symbol library list from project file after remapping. The old symbol library list save/load code does not get called in the schematic project file configuration code. Use the LibNamesAndPaths static function from the PART_LIBS object. Bump schematic file version from 3 to 4 which represents the switch to the library table symbol linking which is incompatible with all previous versions. Refresh the schematic after running remapping dialog manually.
2017-11-08 00:15:09 +00:00
wxString paths;
wxArrayString libNames;
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
SYMBOL_LIBS::LibNamesAndPaths( &Prj(), true, &paths, &libNames );
Clear symbol library list from project file after remapping. The old symbol library list save/load code does not get called in the schematic project file configuration code. Use the LibNamesAndPaths static function from the PART_LIBS object. Bump schematic file version from 3 to 4 which represents the switch to the library table symbol linking which is incompatible with all previous versions. Refresh the schematic after running remapping dialog manually.
2017-11-08 00:15:09 +00:00
Fix source comment / documentation typos
2021-06-09 19:32:58 +00:00
// Reload the cache symbol library.
More NULL expunging.
2021-07-16 20:13:26 +00:00
Prj().SetElem( PROJECT::ELEM_SCH_SYMBOL_LIBS, nullptr );
Final symbol library table changes before merge. Remove all symbol libraries from the project file after remapping to prevent symbols that should be loaded from the cache being loaded from a library further up the search order. Save the project file to clear all of the libraries so they never get reloaded again. Remove the symbol library management dialog and menu entries. Rename the symbol library table dialog menu entry. Remove all symbol libraries from default project file to prevent clashes with the cache library. Fix illegal symbol naming in Eagle plugin.
2017-11-01 00:57:57 +00:00
Prj().SchLibs();
Minor symbol remapping fixes. The remapping utility would create a new project specific library when a symbolic link pointed to a library already defined in the symbol library table. Now the comparison checks to see if the library path and file name are actually a symbolic link if the file names are not the same when the symbol library table entry is a file name rather than a URL. URLs are simple string comparisons. Disable the remap button after the remapping completed. Remove some commented out code from the edit symbol in schematic dialog. Fixes lp:1738634 https://bugs.launchpad.net/kicad/+bug/1738634
2017-12-18 23:25:34 +00:00
DIALOG_SYMBOL_REMAP: raise after remap is complete On macOS in particular, there is a tendency for this to fall behind other windows where the user has no clue it's still up.
2018-01-06 21:51:53 +00:00
Raise();
Minor symbol remapping fixes. The remapping utility would create a new project specific library when a symbolic link pointed to a library already defined in the symbol library table. Now the comparison checks to see if the library path and file name are actually a symbolic link if the file names are not the same when the symbol library table entry is a file name rather than a URL. URLs are simple string comparisons. Disable the remap button after the remapping completed. Remove some commented out code from the edit symbol in schematic dialog. Fixes lp:1738634 https://bugs.launchpad.net/kicad/+bug/1738634
2017-12-18 23:25:34 +00:00
m_remapped = true;
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
size_t DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable( std::vector< SYMBOL_LIB* >& aLibs )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
SYMBOL_LIBS* libs = Prj().SchLibs();
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
for( SYMBOL_LIBS_BASE::iterator it = libs->begin(); it != libs->end(); ++it )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
// Ignore the cache library.
if( it->IsCache() )
continue;
// Check for the obvious library name.
wxString libFileName = it->GetFullFileName();
if( !SYMBOL_LIB_TABLE::GetGlobalLibTable().FindRowByURI( libFileName ) )
aLibs.push_back( &(*it) );
}
return aLibs.size();
}
void DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable( REPORTER& aReporter )
{
wxString msg;
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
std::vector< SYMBOL_LIB* > libs;
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
if( getLibsNotInGlobalSymbolLibTable( libs ) )
{
SYMBOL_LIB_TABLE prjLibTable;
std::vector< wxString > libNames = SYMBOL_LIB_TABLE::GetGlobalLibTable().GetLogicalLibs();
for( auto lib : libs )
{
wxString libName = lib->GetName();
int libNameInc = 1;
int libNameLen = libName.Length();
Eeschema: fix library naming bugs in symbol rescuer and re-mapper. File names with spaces were causing invalid symbol names in both the rescue library and the cache which would cause both libraries to fail to load because library symbol names are not escaped so the spaces tripped up the library parser. Replace the spaces in the file names with hyphens and in both the rescuer and the remapping code so the library nickname in the symbol library table does not contain spaces. Update the symbol library table dialog to prevent users from defining library nicknames with spaces. This is different than the footprint library table which allows nicknames with spaces. This solution is a temporary fix until the new symbol library and schematic file formats are implemented. Fix off by one row in illegal nickname error message in the symbol library table editor.
2018-01-10 21:04:32 +00:00
// Spaces in the file name will break the symbol name because they are not
// quoted in the symbol library file format.
libName.Replace( " ", "-" );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
// Don't create duplicate table entries.
Move std::contains to alg::contains.
2020-09-26 13:42:40 +00:00
while( alg::contains( libNames, libName ) )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
libName = libName.Left( libNameLen );
libName << libNameInc;
libNameInc++;
}
wxString pluginType = SCH_IO_MGR::ShowType( SCH_IO_MGR::SCH_LEGACY );
wxFileName fn = lib->GetFullFileName();
// Use environment variable substitution where possible. This is based solely
// on the internal user environment variable list. Checking against all of the
// system wide environment variables is probably not a good idea.
Moved path normalization functions to a separate file Normalizing paths to environmental variables might be useful in many places, therefore it is better to keep them accessible.
2017-11-14 10:17:16 +00:00
wxString fullFileName = NormalizePath( fn, &Pgm().GetLocalEnvVariables(), &Prj() );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
// Fall back to the absolute library path.
if( fullFileName.IsEmpty() )
fullFileName = lib->GetFullFileName();
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
wxFileName tmpFn = fullFileName;
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
// Don't add symbol libraries that do not exist.
if( tmpFn.Normalize() && tmpFn.FileExists() )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
msg.Printf( _( "Adding library '%s', file '%s' to project symbol library table." ),
libName,
fullFileName );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( msg, RPT_SEVERITY_INFO );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
prjLibTable.InsertRow( new SYMBOL_LIB_TABLE_ROW( libName, fullFileName,
pluginType ) );
}
else
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
msg.Printf( _( "Library '%s' not found." ), fullFileName );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( msg, RPT_SEVERITY_WARNING );
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
}
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
// Don't save empty project symbol library table.
if( !prjLibTable.IsEmpty() )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
wxFileName fn( Prj().GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
try
{
FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
prjLibTable.Format( &formatter, 0 );
}
catch( const IO_ERROR& ioe )
{
msg.Printf( _( "Failed to write project symbol library table. Error:\n %s" ),
ioe.What() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.ReportTail( msg, RPT_SEVERITY_ERROR );
Symbol library table remapping fixes. Use GetPath() instead of GetFullPath() when initializing environment variable table entries KICAD_SYMBOL_DIR and KICAD_PTEMPALTE due to unexpected trailing path separator which was causing find libraries by URI to fail. Don't create a project symbol library table when there are no libraries not found in the global symbol library table. Don't add non-existent libraries to project symbol library table. Clear symbol library table when loading a new schematic. Minor remapping status message improvements.
2017-09-06 13:21:50 +00:00
}
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
aReporter.ReportTail( _( "Created project symbol library table.\n" ),
RPT_SEVERITY_INFO );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
}
}
void DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable( REPORTER& aReporter )
{
wxString msg;
Move Eeschema globals to new SCHEMATIC object Set up a new lineage for SCH_ITEMS to get back to the SCHEMATIC they live on: Items will all be parented to the SCH_SCREEN that they are added to, and each SCH_SCREEN will point back to the SCHEMATIC that it is part of. Note that this hierarchy is not the same as the actual schematic hierarchy, which continues to be managed through SCH_SHEETs and SCH_SHEET_PATHS.
2020-05-13 02:00:37 +00:00
SCH_SCREENS schematic( m_frame->Schematic().Root() );
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
SCH_SYMBOL* symbol;
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
SCH_SCREEN* screen;
for( screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
{
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
for( auto item : screen->Items().OfType( SCH_SYMBOL_T ) )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
symbol = dynamic_cast<SCH_SYMBOL*>( item );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
if( !remapSymbolToLibTable( symbol ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
msg.Printf( _( "No symbol %s found in symbol library table." ),
Add user-defined severities, exclusions and colors to DRC markers. Exclusions are currently persisted in the project file. Fixes https://gitlab.com/kicad/code/kicad/issues/1989
2020-02-28 00:05:40 +00:00
symbol->GetLibId().GetLibItemName().wx_str() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( msg, RPT_SEVERITY_WARNING );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
else
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
msg.Printf( _( "Symbol %s mapped to symbol library '%s'." ),
Add user-defined severities, exclusions and colors to DRC markers. Exclusions are currently persisted in the project file. Fixes https://gitlab.com/kicad/code/kicad/issues/1989
2020-02-28 00:05:40 +00:00
symbol->GetLibId().GetLibItemName().wx_str(),
symbol->GetLibId().GetLibNickname().wx_str() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( msg, RPT_SEVERITY_ACTION );
Rename modification flag routines Differentiates better between the EDA_ITEM IsModified(), referring to items themselves changing and the EDA_SCREEN IsContentModified(), referring to whether we have made any unsaved changes.
2021-05-28 19:07:04 +00:00
screen->SetContentModified();
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
}
}
Enable symbol library table remapping. Check the if the schematic being loaded has been remapped (no symbol library table nicknames defined) and remap accordingly. Fix issues when resolving the library symbol links in the schematic symbols. Add cache library fallback when resolving symbols that cannot be remapped. Add remap complete message to remap dialog. Add HasLibrary() helper to LIB_TABLE_BASE. Fix issues when loading library symbols using symbol library table. Add hashing function to symbol library table. Improve the symbol panel message to warn user when cache library is used to resolve symbol.
2017-09-01 20:42:20 +00:00
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( _( "Symbol library table mapping complete!" ), RPT_SEVERITY_INFO );
Make the new schematic and symbol library file formats the default. This is a very large and potentially disruptive change so this will be an unusually long and detailed commit message. The new file formats are now the default in both the schematic and symbol library editors. Existing symbol libraries will be saved in their current format until new features are added to library symbols. Once this happens, both the legacy schematic and symbol file formats will be no longer be savable and existing libraries will have to be converted. Saving to the legacy file formats is still available for round robin testing and should not be used for normal editing. When loading the legacy schematic file, it is imperative that the schematic library symbols are rescued and/or remapped to valid library identifiers. Otherwise, there will be no way to link to the original library symbol and the user will be required manually set the library identifier. The cached symbol will be saved in the schematic file so the last library symbol in the cache will still be used but there will be no way to update it from the original library. The next save after loading a legacy schematic file will be converted to the s-expression file format. Schematics with hierarchical sheets will automatically have all sheet file name extensions changed to .kicad_sym and saved to the new format as well. Appending schematics requires that the schematic to append has already been converted to the new file format. This is required to ensure that library symbols are guaranteed to be valid for the appended schematic. The schematic symbol library symbol link resolution has been moved out of the SCH_COMPONENT object and move into the SCH_SCREEN object that owns the symbol. This was done to ensure that there is a single place where the library symbol links get resolved rather than the dozen or so different code paths that previously existed. It also removes the necessity of the SCH_COMPONENT object of requiring any knowledge of the symbol library table and/or the cache library. When opening an s-expression schematic, the legacy cache library is not loaded so any library symbols not rescued cannot be loaded. Broken library symbol links will have to be manually resolved by adding the cache library to the symbol library table and changing the links in the schematic symbol. Now that the library symbols are embedded in the schematic file, the SCH_SCREEN object maintains the list of library symbols for the schematic automatically. No external manipulation of this library cache should ever occur. ADDED: S-expression schematic and symbol library file formats.
2020-04-16 16:43:50 +00:00
schematic.UpdateSymbolLinks();
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
}
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
bool DIALOG_SYMBOL_REMAP::remapSymbolToLibTable( SCH_SYMBOL* aSymbol )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
More NULL expunging.
2021-07-16 20:13:26 +00:00
wxCHECK_MSG( aSymbol != nullptr, false, "Null pointer passed to remapSymbolToLibTable." );
Fix debug build error in symbol remap dialog.
2017-04-05 12:43:05 +00:00
wxCHECK_MSG( aSymbol->GetLibId().GetLibNickname().empty(), false,
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
"Cannot remap symbol that is already mapped." );
Fix debug build error in symbol remap dialog.
2017-04-05 12:43:05 +00:00
wxCHECK_MSG( !aSymbol->GetLibId().GetLibItemName().empty(), false,
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
"The symbol LIB_ID name is empty." );
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
SYMBOL_LIBS* libs = Prj().SchLibs();
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
for( SYMBOL_LIBS_BASE::iterator it = libs->begin(); it != libs->end(); ++it )
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
{
// Ignore the cache library.
if( it->IsCache() )
continue;
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
LIB_SYMBOL* alias = it->FindSymbol( aSymbol->GetLibId().GetLibItemName().wx_str() );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
// Found in the same library as the old look up method assuming the user didn't
// change the libraries or library ordering since the last time the schematic was
// loaded.
if( alias )
{
// Find the same library in the symbol library table using the full path and file name.
wxString libFileName = it->GetFullFileName();
const LIB_TABLE_ROW* row = Prj().SchSymbolLibTable()->FindRowByURI( libFileName );
if( row )
{
LIB_ID id = aSymbol->GetLibId();
id.SetLibNickname( row->GetNickName() );
Enable symbol library table remapping. Check the if the schematic being loaded has been remapped (no symbol library table nicknames defined) and remap accordingly. Fix issues when resolving the library symbol links in the schematic symbols. Add cache library fallback when resolving symbols that cannot be remapped. Add remap complete message to remap dialog. Add HasLibrary() helper to LIB_TABLE_BASE. Fix issues when loading library symbols using symbol library table. Add hashing function to symbol library table. Improve the symbol panel message to warn user when cache library is used to resolve symbol.
2017-09-01 20:42:20 +00:00
// Don't resolve symbol library links now.
Make the new schematic and symbol library file formats the default. This is a very large and potentially disruptive change so this will be an unusually long and detailed commit message. The new file formats are now the default in both the schematic and symbol library editors. Existing symbol libraries will be saved in their current format until new features are added to library symbols. Once this happens, both the legacy schematic and symbol file formats will be no longer be savable and existing libraries will have to be converted. Saving to the legacy file formats is still available for round robin testing and should not be used for normal editing. When loading the legacy schematic file, it is imperative that the schematic library symbols are rescued and/or remapped to valid library identifiers. Otherwise, there will be no way to link to the original library symbol and the user will be required manually set the library identifier. The cached symbol will be saved in the schematic file so the last library symbol in the cache will still be used but there will be no way to update it from the original library. The next save after loading a legacy schematic file will be converted to the s-expression file format. Schematics with hierarchical sheets will automatically have all sheet file name extensions changed to .kicad_sym and saved to the new format as well. Appending schematics requires that the schematic to append has already been converted to the new file format. This is required to ensure that library symbols are guaranteed to be valid for the appended schematic. The schematic symbol library symbol link resolution has been moved out of the SCH_COMPONENT object and move into the SCH_SCREEN object that owns the symbol. This was done to ensure that there is a single place where the library symbol links get resolved rather than the dozen or so different code paths that previously existed. It also removes the necessity of the SCH_COMPONENT object of requiring any knowledge of the symbol library table and/or the cache library. When opening an s-expression schematic, the legacy cache library is not loaded so any library symbols not rescued cannot be loaded. Broken library symbol links will have to be manually resolved by adding the cache library to the symbol library table and changing the links in the schematic symbol. Now that the library symbols are embedded in the schematic file, the SCH_SCREEN object maintains the list of library symbols for the schematic automatically. No external manipulation of this library cache should ever occur. ADDED: S-expression schematic and symbol library file formats.
2020-04-16 16:43:50 +00:00
aSymbol->SetLibId( id );
Add symbol library table remapping dialog. Create dialog and code to allow legacy schematic symbols to be remapped from the old library path look up method to the new symbol library table method by using the following steps: 1) Create a project symbol library table containing all of the symbol libraries defined in the old library look up list not found in the global symbol library table. 2) Map each symbol to the correct symbol in the symbol library table if possible. Recreate library link to symbols so look up method can be converted to symbol library table properly. Add function to SCH_COMPONENT to link library symbols using the symbol library table.
2017-03-09 23:33:39 +00:00
return true;
}
}
}
return false;
}
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
bool DIALOG_SYMBOL_REMAP::backupProject( REPORTER& aReporter )
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
{
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
static wxString backupFolder = "rescue-backup";
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
wxString tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
wxString errorMsg;
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
wxFileName srcFileName;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
wxFileName destFileName;
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
wxFileName backupPath;
Move Eeschema globals to new SCHEMATIC object Set up a new lineage for SCH_ITEMS to get back to the SCHEMATIC they live on: Items will all be parented to the SCH_SCREEN that they are added to, and each SCH_SCREEN will point back to the SCHEMATIC that it is part of. Note that this hierarchy is not the same as the actual schematic hierarchy, which continues to be managed through SCH_SHEETs and SCH_SHEET_PATHS.
2020-05-13 02:00:37 +00:00
SCH_SCREENS schematic( m_frame->Schematic().Root() );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
// Copy backup files to different folder so as not to pollute the project folder.
destFileName.SetPath( Prj().GetProjectPath() );
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
destFileName.AppendDir( backupFolder );
backupPath = destFileName;
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
if( !destFileName.DirExists() )
{
if( !destFileName.Mkdir() )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
errorMsg.Printf( _( "Cannot create project remap back up folder '%s'." ),
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.GetPath() );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
wxMessageDialog dlg( this, errorMsg, _( "Backup Error" ),
wxYES_NO | wxCENTRE | wxRESIZE_BORDER | wxICON_QUESTION );
dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Continue with Rescue" ) ),
wxMessageDialog::ButtonLabel( _( "Abort Rescue" ) ) );
if( dlg.ShowModal() == wxID_NO )
return false;
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
}
}
// Time stamp to append to file name in case multiple remappings are performed.
wxString timeStamp = wxDateTime::Now().Format( "-%Y-%m-%d-%H-%M-%S" );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
// Back up symbol library table.
srcFileName.SetPath( Prj().GetProjectPath() );
srcFileName.SetName( SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );
destFileName = srcFileName;
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
destFileName.AppendDir( backupFolder );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
destFileName.SetName( destFileName.GetName() + timeStamp );
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
srcFileName.GetFullPath(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
if( wxFileName::Exists( srcFileName.GetFullPath() )
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ),
srcFileName.GetFullPath() );
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
errorMsg += tmp;
}
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
// Back up the schematic files.
for( SCH_SCREEN* screen = schematic.GetFirst(); screen; screen = schematic.GetNext() )
{
destFileName = screen->GetFileName();
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.SetName( destFileName.GetName() + timeStamp );
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
// Check for nest hierarchical schematic paths.
if( destFileName.GetPath() != backupPath.GetPath() )
{
destFileName.SetPath( backupPath.GetPath() );
wxArrayString srcDirs = wxFileName( screen->GetFileName() ).GetDirs();
wxArrayString destDirs = wxFileName( Prj().GetProjectPath() ).GetDirs();
for( size_t i = destDirs.GetCount(); i < srcDirs.GetCount(); i++ )
destFileName.AppendDir( srcDirs[i] );
}
else
{
destFileName.AppendDir( backupFolder );
}
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
screen->GetFileName(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
if( !destFileName.DirExists() && !destFileName.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to create backup folder '%s'.\n" ), destFileName.GetPath() );
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
errorMsg += tmp;
continue;
}
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
if( wxFileName::Exists( screen->GetFileName() )
&& !wxCopyFile( screen->GetFileName(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ), screen->GetFileName() );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
errorMsg += tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
}
// Back up the project file.
destFileName = Prj().GetProjectFullName();
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.SetName( destFileName.GetName() + timeStamp );
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
destFileName.AppendDir( backupFolder );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
Prj().GetProjectFullName(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
if( wxFileName::Exists( Prj().GetProjectFullName() )
&& !wxCopyFile( Prj().GetProjectFullName(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ), Prj().GetProjectFullName() );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
errorMsg += tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
// Back up the cache library.
srcFileName.SetPath( Prj().GetProjectPath() );
srcFileName.SetName( Prj().GetProjectName() + "-cache" );
Deprecate saving legacy schematic and symbol library file formats. REMOVED: The ability to save schematics in the legacy file format.
2020-05-15 13:25:11 +00:00
srcFileName.SetExt( LegacySymbolLibFileExtension );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
destFileName = srcFileName;
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.SetName( destFileName.GetName() + timeStamp );
Eeschema: fix remapping backup project with schematics in subfolders. The backup code was designed for a project with all of the schematics in the project folder which is not always the case. Fix the schematic backup to keep the schematic folder structure in tact during backups. Fixes lp:1751662 https://bugs.launchpad.net/kicad/+bug/1751662
2018-02-28 16:41:24 +00:00
destFileName.AppendDir( backupFolder );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
srcFileName.GetFullPath(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ), srcFileName.GetFullPath() );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
errorMsg += tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
// Back up the rescue symbol library if it exists.
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
srcFileName.SetName( Prj().GetProjectName() + "-rescue" );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.SetName( srcFileName.GetName() + timeStamp );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
Add user-defined severities, exclusions and colors to DRC markers. Exclusions are currently persisted in the project file. Fixes https://gitlab.com/kicad/code/kicad/issues/1989
2020-02-28 00:05:40 +00:00
srcFileName.GetFullPath(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ), srcFileName.GetFullPath() );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
errorMsg += tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
// Back up the rescue symbol library document file if it exists.
Don't hardcode the file extensions where possible
2021-03-03 01:06:25 +00:00
srcFileName.SetExt( LegacySymbolDocumentFileExtension );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
destFileName.SetExt( srcFileName.GetExt() );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Backing up file '%s' to '%s'." ),
Add user-defined severities, exclusions and colors to DRC markers. Exclusions are currently persisted in the project file. Fixes https://gitlab.com/kicad/code/kicad/issues/1989
2020-02-28 00:05:40 +00:00
srcFileName.GetFullPath(),
destFileName.GetFullPath() );
Fix compil issues, especially on Windows: Replace SEVERITY_ERROR by RPT_SEVERITY_ERROR to avoid collision with a system definition. Replace other SEVERITY_XXX by RPT_SEVERITY_XX for consistency. Fix compil warnings and some other compil issues.
2020-03-04 09:48:18 +00:00
aReporter.Report( tmp, RPT_SEVERITY_INFO );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
if( srcFileName.Exists()
&& !wxCopyFile( srcFileName.GetFullPath(), destFileName.GetFullPath() ) )
{
Consistent terminology and punctuation.
2021-06-16 22:35:00 +00:00
tmp.Printf( _( "Failed to back up file '%s'.\n" ), srcFileName.GetFullPath() );
Eeschema: minor remapping improvements. Create separate folder in project path to backup files changed during remapping. Add time stamp to backup file names in case multiple remappings are performed. Add backup file information to report panel instead of using debug trace messages. Disable the remap button if the user does not have write privileges to the current project path.
2018-01-03 16:25:19 +00:00
errorMsg += tmp;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
if( !errorMsg.IsEmpty() )
{
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
wxMessageDialog dlg( this, _( "Some of the project files could not be backed up." ),
_( "Backup Error" ),
wxYES_NO | wxCENTRE | wxRESIZE_BORDER | wxICON_QUESTION );
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
errorMsg.Trim();
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
dlg.SetExtendedMessage( errorMsg );
dlg.SetYesNoLabels( wxMessageDialog::ButtonLabel( _( "Continue with Rescue" ) ),
wxMessageDialog::ButtonLabel( _( "Abort Rescue" ) ) );
if( dlg.ShowModal() == wxID_NO )
return false;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
Eeschema: allow remapping if a project symbol library table exists. Change the behavior of the remapping algorithm to remap even if a project symbol library table exists in the project file in case a previous attempt to remap failed. The existing symbol library table is backed up to the back folder and rebuilt. Fixes lp:1741983 https://bugs.launchpad.net/kicad/+bug/1741983
2018-01-12 15:13:41 +00:00
return true;
Symbol library table remapping improvements. Don't back up schematic files unless the user requests a remap. Back up all files that could be changed by a remap including the schematic file(s), cache library, project file, and rescue library files. Use an HTML control instead of a static text control for improved layout of the user remap prompt. Improve the user prompt in the remap dialog to make it clear that changes will be made to project files.
2017-11-24 16:43:16 +00:00
}
Minor symbol remapping fixes. The remapping utility would create a new project specific library when a symbolic link pointed to a library already defined in the symbol library table. Now the comparison checks to see if the library path and file name are actually a symbolic link if the file names are not the same when the symbol library table entry is a file name rather than a URL. URLs are simple string comparisons. Disable the remap button after the remapping completed. Remove some commented out code from the edit symbol in schematic dialog. Fixes lp:1738634 https://bugs.launchpad.net/kicad/+bug/1738634
2017-12-18 23:25:34 +00:00
void DIALOG_SYMBOL_REMAP::OnUpdateUIRemapButton( wxUpdateUIEvent& aEvent )
{
aEvent.Enable( !m_remapped );
}