KiCad PCB EDA Suite
lib_export.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
6  * Copyright (C) 2004-2019 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <confirm.h>
27 #include <symbol_lib_table.h>
28 #include <lib_edit_frame.h>
29 #include <class_libentry.h>
30 #include <class_library.h>
32 #include <lib_manager.h>
33 #include <wx/filename.h>
34 
35 
37 {
38  wxString msg;
39  wxString libName = getTargetLib();
40 
41  if( !m_libMgr->LibraryExists( libName ) )
42  {
43  libName = SelectLibraryFromList();
44 
45  if( !m_libMgr->LibraryExists( libName ) )
46  return;
47  }
48 
49  wxString wildcards = KiCadSymbolLibFileWildcard();
50 
51  wildcards += "|" + LegacySymbolLibFileWildcard();
52 
53  wxFileDialog dlg( this, _( "Import Symbol" ), m_mruPath, wxEmptyString,
54  wildcards, wxFD_OPEN | wxFD_FILE_MUST_EXIST );
55 
56  if( dlg.ShowModal() == wxID_CANCEL )
57  return;
58 
59  wxFileName fn = dlg.GetPath();
60 
61  if( fn.GetExt().IsEmpty() )
62  fn.SetExt( (dlg.GetFilterIndex() == 0) ?
64 
65  m_mruPath = fn.GetPath();
66 
67  wxArrayString symbols;
68  SCH_IO_MGR::SCH_FILE_T piType = SCH_IO_MGR::GuessPluginTypeFromLibPath( fn.GetFullPath() );
69  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( piType ) );
70 
71  // TODO dialog to select the part to be imported if there is more than one
72  try
73  {
74  pi->EnumerateSymbolLib( symbols, fn.GetFullPath() );
75  }
76  catch( const IO_ERROR& ioe )
77  {
78  msg.Printf( _( "Cannot import symbol library \"%s\"." ), fn.GetFullPath() );
79  DisplayErrorMessage( this, msg, ioe.What() );
80  return;
81  }
82 
83  if( symbols.empty() )
84  {
85  msg.Printf( _( "Symbol library file \"%s\" is empty." ), fn.GetFullPath() );
86  DisplayError( this, msg );
87  return;
88  }
89 
90  wxString symbolName = symbols[0];
91  LIB_PART* entry = pi->LoadSymbol( fn.GetFullPath(), symbolName );
92 
93  if( m_libMgr->PartExists( symbols[0], libName ) )
94  {
95  msg.Printf( _( "Symbol \"%s\" already exists in library \"%s\"." ), symbolName, libName );
96  DisplayError( this, msg );
97  return;
98  }
99 
100  m_libMgr->UpdatePart( entry, libName );
101  SyncLibraries( false );
102  LoadPart( symbolName, libName, 1 );
103 }
104 
105 
107 {
108  wxString msg, title;
109  LIB_PART* part = getTargetPart();
110 
111  if( !part )
112  {
113  ShowInfoBarError( _( "There is no symbol selected to save." ) );
114  return;
115  }
116 
117  wxFileName fn;
118 
119  fn.SetName( part->GetName().Lower() );
120  fn.SetExt( KiCadSymbolLibFileExtension );
121 
122  wxFileDialog dlg( this, _( "Export Symbol" ), m_mruPath, fn.GetFullName(),
123  KiCadSymbolLibFileWildcard(), wxFD_SAVE );
124 
125  if( dlg.ShowModal() == wxID_CANCEL )
126  return;
127 
128  fn = dlg.GetPath();
129  fn.MakeAbsolute();
130 
131  LIB_PART* old_part = NULL;
132 
133  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
134 
135  if( fn.FileExists() )
136  {
137  try
138  {
139  old_part = pi->LoadSymbol( fn.GetFullPath(), part->GetName() );
140  }
141  catch( const IO_ERROR& ioe )
142  {
143  msg.Printf( _( "Error occurred attempting to load symbol library file \"%s\"" ),
144  fn.GetFullPath() );
145  DisplayErrorMessage( this, msg, ioe.What() );
146  return;
147  }
148 
149  if( old_part )
150  {
151  msg.Printf( _( "Symbol \"%s\" already exists in \"%s\"." ),
152  part->GetName(),
153  fn.GetFullName() );
154 
155  KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
156  errorDlg.SetOKLabel( _( "Overwrite" ) );
157  errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
158 
159  if( errorDlg.ShowModal() == wxID_CANCEL )
160  return;
161  }
162  }
163 
164  if( fn.Exists() && !fn.IsDirWritable() )
165  {
166  msg.Printf( _( "Write permissions are required to save library \"%s\"." ),
167  fn.GetFullPath() );
168  DisplayError( this, msg );
169  return;
170  }
171 
172  try
173  {
174  if( !fn.FileExists() )
175  pi->CreateSymbolLib( fn.GetFullPath() );
176 
177  // The flattened symbol is most likely what the user would want. As some point in
178  // the future as more of the symbol library inheritance is implemented, this may have
179  // to be changes to save parts of inherited symbols.
180  pi->SaveSymbol( fn.GetFullPath(), part->Flatten().release() );
181  }
182  catch( const IO_ERROR& ioe )
183  {
184  msg.Printf( _( "Failed to create symbol library file \"%s\"" ), fn.GetFullPath() );
185  DisplayErrorMessage( this, msg, ioe.What() );
186  msg.Printf( _( "Error creating symbol library \"%s\"" ), fn.GetFullName() );
187  SetStatusText( msg );
188  return;
189  }
190 
191  m_mruPath = fn.GetPath();
192 
193  msg.Printf( _( "Symbol \"%s\" saved in library \"%s\"" ), part->GetName(), fn.GetFullPath() );
194  SetStatusText( msg );
195 
196  // See if the user wants it added to a library table (global or project)
197  SYMBOL_LIB_TABLE* libTable = selectSymLibTable( true );
198 
199  if( libTable )
200  {
201  if( !m_libMgr->AddLibrary( fn.GetFullPath(), libTable ) )
202  {
203  DisplayError( this, _( "Could not open the library file." ) );
204  return;
205  }
206 
207  bool globalTable = ( libTable == &SYMBOL_LIB_TABLE::GetGlobalLibTable() );
208  saveSymbolLibTables( globalTable, !globalTable );
209  }
210 }
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a symbol library using the file extension of aLibPath.
Definition: sch_io_mgr.cpp:169
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox
Definition: confirm.cpp:54
wxString m_mruPath
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:253
wxString GetName() const override
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:44
This file is part of the common library.
const std::string LegacySymbolLibFileExtension
void LoadPart(const wxString &aLibrary, const wxString &aPart, int Unit)
LIB_MANAGER * m_libMgr
wxString SelectLibraryFromList()
Display a list of loaded libraries in the symbol library and allows the user to select a library.
bool AddLibrary(const wxString &aFilePath, SYMBOL_LIB_TABLE *aTable)
Adds an existing library.
Definition: lib_manager.h:146
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
Define a library symbol object.
Definition of file extensions used in Kicad.
bool saveSymbolLibTables(bool aGlobal, bool aProject)
Saves Symbol Library Tables to disk.
wxString KiCadSymbolLibFileWildcard()
std::unique_ptr< LIB_PART > Flatten() const
Return a flattened symbol inheritance to the caller.
void ShowInfoBarError(const wxString &aErrorMsg)
bool PartExists(const wxString &aAlias, const wxString &aLibrary) const
Returns true if part with a specific alias exists in library (either original one or buffered).
wxString LegacySymbolLibFileWildcard()
bool UpdatePart(LIB_PART *aPart, const wxString &aLibrary)
Updates the part buffer with a new version of the part.
void ImportPart()
Definition: lib_export.cpp:36
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:470
void SyncLibraries(bool aShowProgress)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
#define _(s)
Definition: 3d_actions.cpp:33
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Returns true if library exists.
LIB_PART * getTargetPart() const
Returns currently edited part.
int ShowModal() override
Definition: confirm.cpp:96
SYMBOL_LIB_TABLE * selectSymLibTable(bool aOptional=false)
Displays a dialog asking the user to select a symbol library table.
Definition for part library class.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
wxString getTargetLib() const
Returns either the library selected in the component tree, if context menu is active or the library t...
const std::string KiCadSymbolLibFileExtension