KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_editor_import_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 <[email protected]>
6 * Copyright The 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 <kidialog.h>
28#include <common.h>
30#include <sch_io/sch_io.h>
31#include <symbol_edit_frame.h>
34#include <wx/filename.h>
35#include <wx/filedlg.h>
36#include <string_utils.h>
37
38
40{
41 wxString msg;
42 wxString libName = getTargetLib();
43
44 if( !m_libMgr->LibraryExists( libName ) )
45 libName = SelectLibrary( _( "Import Symbol" ), _( "Import symbol to library:" ) );
46
47 if( !m_libMgr->LibraryExists( libName ) )
48 return;
49
50 wxString fileFiltersStr;
51 wxString allWildcardsStr;
52
53 for( const SCH_IO_MGR::SCH_FILE_T& fileType : SCH_IO_MGR::SCH_FILE_T_vector )
54 {
55 IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( fileType ) );
56
57 if( !pi )
58 continue;
59
60 const IO_BASE::IO_FILE_DESC& desc = pi->GetLibraryFileDesc();
61
62 if( desc.m_FileExtensions.empty() )
63 continue;
64
65 if( !fileFiltersStr.IsEmpty() )
66 fileFiltersStr += wxChar( '|' );
67
68 fileFiltersStr += desc.FileFilter();
69
70 for( const std::string& ext : desc.m_FileExtensions )
71 allWildcardsStr << wxT( "*." ) << formatWildcardExt( ext ) << wxT( ";" );
72 }
73
74 fileFiltersStr = _( "All supported formats" ) + wxT( "|" ) + allWildcardsStr + wxT( "|" )
75 + fileFiltersStr;
76
77 wxFileDialog dlg( this, _( "Import Symbol" ), m_mruPath, wxEmptyString, fileFiltersStr,
78 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
79
80 if( dlg.ShowModal() == wxID_CANCEL )
81 return;
82
83 wxFileName fn( dlg.GetPath() );
84
85 m_mruPath = fn.GetPath();
86
87 wxArrayString symbols;
88 SCH_IO_MGR::SCH_FILE_T piType = SCH_IO_MGR::GuessPluginTypeFromLibPath( fn.GetFullPath() );
89
90 if( piType == SCH_IO_MGR::SCH_FILE_UNKNOWN )
91 {
92 msg.Printf( _( "Unable to find a reader for '%s'." ), fn.GetFullPath() );
93 DisplayError( this, msg );
94 return;
95 }
96
97 IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( piType ) );
98
99 // TODO dialog to select the symbol to be imported if there is more than one
100 try
101 {
102 pi->EnumerateSymbolLib( symbols, fn.GetFullPath() );
103 }
104 catch( const IO_ERROR& ioe )
105 {
106 msg.Printf( _( "Cannot import symbol library '%s'." ), fn.GetFullPath() );
107 DisplayErrorMessage( this, msg, ioe.What() );
108 return;
109 }
110 catch( const XML_PARSER_ERROR& ioe )
111 {
112 msg.Printf( _( "Cannot import symbol library '%s'." ), fn.GetFullPath() );
113 DisplayErrorMessage( this, msg, ioe.what() );
114 return;
115 }
116
117 if( symbols.empty() )
118 {
119 msg.Printf( _( "Symbol library file '%s' is empty." ), fn.GetFullPath() );
120 DisplayError( this, msg );
121 return;
122 }
123
124 wxString symbolName = symbols[0];
125 LIB_SYMBOL* entry = pi->LoadSymbol( fn.GetFullPath(), symbolName );
126
127 entry->SetName( EscapeString( entry->GetName(), CTX_LIBID ) );
128
129 if( m_libMgr->SymbolNameInUse( entry->GetName(), libName ) )
130 {
131 msg.Printf( _( "Symbol %s already exists in library '%s'." ),
132 UnescapeString( symbolName ),
133 libName );
134
135 KIDIALOG errorDlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
136 errorDlg.SetOKLabel( _( "Overwrite" ) );
137 errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
138
139 if( errorDlg.ShowModal() == wxID_CANCEL )
140 return;
141 }
142
143 m_libMgr->UpdateSymbol( entry, libName );
144 SyncLibraries( false );
145 LoadSymbol( entry->GetName(), libName, 1 );
146}
147
148
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition kidialog.h:42
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox.
Definition kidialog.cpp:55
int ShowModal() override
Definition kidialog.cpp:93
Define a library symbol object.
Definition lib_symbol.h:85
wxString GetName() const override
Definition lib_symbol.h:148
virtual void SetName(const wxString &aName)
wxString SelectLibrary(const wxString &aDialogTitle, const wxString &aListLabel, const std::vector< std::pair< wxString, bool * > > &aExtraCheckboxes={})
Display a list of loaded libraries and allows the user to select a library.
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a symbol library using the file extension of aLibPath.
wxString getTargetLib() const
LIB_SYMBOL_LIBRARY_MANAGER * m_libMgr
void LoadSymbol(const wxString &aLibrary, const wxString &aSymbol, int Unit)
void SyncLibraries(bool aShowProgress, bool aPreloadCancelled=false, const wxString &aForceRefresh=wxEmptyString)
Synchronize the library manager to the symbol library table, and then the symbol tree to the library ...
The common library.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition confirm.cpp:202
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition confirm.cpp:177
This file is part of the common library.
#define _(s)
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
Definition io_mgr.h:33
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
@ CTX_LIBID
Container that describes file type info.
Definition io_base.h:45
std::vector< std::string > m_FileExtensions
Filter used for file pickers if m_IsFile is true.
Definition io_base.h:49
wxString FileFilter() const
Definition io_base.cpp:40
Implement a simple wrapper around runtime_error to isolate the errors thrown by the Eagle XML parser.
wxString formatWildcardExt(const wxString &aWildcard)
Format wildcard extension to support case sensitive file dialogs.
Definition of file extensions used in Kicad.