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

95 lines
3.3 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.h
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2017 Wayne Stambaugh <stambaughw@verizon.net>
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
* 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 <dialog_symbol_remap_base.h>
#ifndef _DIALOG_SYMBOL_REMAP_H_
#define _DIALOG_SYMBOL_REMAP_H_
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
class SYMBOL_LIB;
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
class SCH_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
class REPORTER;
class DIALOG_SYMBOL_REMAP : public DIALOG_SYMBOL_REMAP_BASE
{
public:
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( SCH_EDIT_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
void OnRemapSymbols( wxCommandEvent& aEvent ) override;
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
protected:
void OnUpdateUIRemapButton( wxUpdateUIEvent& aEvent ) override;
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
private:
/**
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
* Add libraries found in the legacy library list to \a aLibs that are not found in
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 global symbol library table.
*
* This function is used to create a project symbol library table when converting
* legacy projects over to the new symbol library table implementation. This only
* needs to be called the first time a legacy project is opened. The cache library
* is ignored.
*
* @param aLibs is a vector container to add all of the libraries not found in the
* global symbol library table that were found in the legacy library
* list.
* @return the number of libraries found.
*/
Expunge the use of the word part from Eeschema code.
2021-06-15 12:31:28 +00:00
size_t 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
void createProjectSymbolLibTable( REPORTER& aReporter );
void remapSymbolsToLibTable( REPORTER& aReporter );
Rename SCH_COMPONENT to SCH_SYMBOL.
2021-06-10 14:10:55 +00:00
bool remapSymbolToLibTable( SCH_SYMBOL* aSymbol );
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
* Backup all of the files that could be modified by the remapping with a time stamp
* appended to the file name into the "remap_backup" folder in case something goes wrong.
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
*
* Backup the following:
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
* - All schematic (prj-name.sch -> remap_backup/prj-name-time-stamp.sch ) files.
* - The project (prj-name.pro) -> remap_backup/prj-name-time-stamp.pro) file.
* - The cache library (prj-name-cache.lib -> remap_backup/prj-name.-cache-time-stamp.lib)
* file.
* - The rescue library (prj-name-rescue.lib -> remap_backup/prj-name.rescue-time-stamp.lib)
* file.
* - The rescue library (prj-name-rescue.dcm -> remap_backup/prj-name.rescue-time-stamp.dcm)
* file.
*
* @param aReporter is the #REPORTER object in which to write information messages.
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 to continue rescue or false to abort rescue.
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 backupProject( REPORTER& aReporter );
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
bool m_remapped;
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_EDIT_FRAME* m_frame;
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
};
#endif // _DIALOG_SYMBOL_REMAP_H_