KiCad PCB EDA Suite
readwrite_dlgs.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) 2018 Jean-Pierre Charras, jean-pierre.charras
5  * Copyright (C) 2011-2016 Wayne Stambaugh <stambaughw@verizon.net>
6  * Copyright (C) 1992-2020 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 <fp_lib_table.h>
29 #include <kiway.h>
30 #include <lib_id.h>
31 
32 #include <cvpcb_mainframe.h>
33 #include <listboxes.h>
35 
36 
40 static int guessNickname( FP_LIB_TABLE* aTbl, LIB_ID* aFootprintId )
41 {
42  if( aFootprintId->GetLibNickname().size() )
43  return 0;
44 
45  wxString nick;
46  wxString fpname = aFootprintId->GetLibItemName();
47 
48  std::vector<wxString> nicks = aTbl->GetLogicalLibs();
49 
50  // Search each library going through libraries alphabetically.
51  for( unsigned libNdx = 0; libNdx<nicks.size(); ++libNdx )
52  {
53  wxArrayString fpnames;
54 
55  aTbl->FootprintEnumerate( fpnames, nicks[libNdx], true );
56 
57  for( unsigned nameNdx = 0; nameNdx<fpnames.size(); ++nameNdx )
58  {
59  if( fpname == fpnames[nameNdx] )
60  {
61  if( !nick )
62  nick = nicks[libNdx];
63  else
64  return 2; // duplicate, the guess would not be certain
65  }
66  }
67  }
68 
69  if( nick.size() )
70  {
71  aFootprintId->SetLibNickname( nick );
72  return 0;
73  }
74 
75  return 1;
76 }
77 
78 
79 bool CVPCB_MAINFRAME::ReadNetListAndFpFiles( const std::string& aNetlist )
80 {
81  wxString msg;
82  bool hasMissingNicks = false;
83 
84  ReadSchematicNetlist( aNetlist );
85 
86  if( m_compListBox == NULL )
87  return false;
88 
89  wxSafeYield();
90 
92 
95 
97 
99  {
100  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
101  {
102  COMPONENT* component = m_netlist.GetComponent( i );
103 
104  if( component->GetFPID().empty() )
105  continue;
106 
107  if( component->GetFPID().IsLegacy() )
108  hasMissingNicks = true;
109  }
110  }
111 
112  // Check if footprint links were generated before the footprint library table was implemented.
113  if( hasMissingNicks )
114  {
115  msg = _( "Some of the assigned footprints are legacy entries with no library names. Would "
116  "you like KiCad to attempt to convert them to the new required LIB_ID format? "
117  "(If you answer no, then these assignments will be cleared and you will need to "
118  "re-assign them manually.)" );
119 
120  if( IsOK( this, msg ) )
121  {
122  msg.Clear();
123 
124  try
125  {
126  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
127  {
128  COMPONENT* component = m_netlist.GetComponent( i );
129 
130  if( component->GetFPID().IsLegacy() )
131  {
132  // get this first here, it's possibly obsoleted if we get it too soon.
133  FP_LIB_TABLE* tbl = Prj().PcbFootprintLibs( Kiway() );
134 
135  int guess = guessNickname( tbl, (LIB_ID*) &component->GetFPID() );
136 
137  switch( guess )
138  {
139  case 0:
140  m_modified = true;
141  break;
142 
143  case 1:
144  msg += wxString::Format( _(
145  "Component \"%s\" footprint \"%s\" was <b>not found</b> in any library.\n" ),
146  component->GetReference(),
147  component->GetFPID().GetLibItemName().wx_str()
148  );
149  break;
150 
151  case 2:
152  msg += wxString::Format( _(
153  "Component \"%s\" footprint \"%s\" was found in <b>multiple</b> libraries.\n" ),
154  component->GetReference(),
155  component->GetFPID().GetLibItemName().wx_str()
156  );
157  break;
158  }
159  }
160  }
161  }
162  catch( const IO_ERROR& ioe )
163  {
164  msg = ioe.What();
165  msg += wxT( "\n\n" );
166  msg += _( "First check your footprint library table entries." );
167 
168  wxMessageBox( msg, _( "Problematic Footprint Library Tables" ) );
169  return false;
170  }
171 
172  if( msg.size() )
173  {
174  HTML_MESSAGE_BOX dlg( this, wxEmptyString );
175 
176  dlg.MessageSet( _( "The following errors occurred attempting to convert the "
177  "footprint assignments:\n\n" ) );
178  dlg.ListSet( msg );
179  dlg.MessageSet( _( "\nYou will need to reassign them manually if you want them "
180  "to be updated correctly the next time you import the "
181  "netlist in Pcbnew." ) );
182 
183 #if 1
184  dlg.ShowModal();
185 #else
186  dlg.Fit();
187  dlg.Show( true ); // modeless lets user watch while fixing the problems, but its not working.
188 #endif
189  }
190  }
191  else
192  {
193  // Clear the legacy footprint assignments.
194  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
195  {
196  COMPONENT* component = m_netlist.GetComponent( i );
197 
198  if( component->GetFPID().IsLegacy() )
199  {
200  component->SetFPID( LIB_ID() /* empty */ );
201  m_modified = true;
202  }
203  }
204  }
205  }
206 
207 
208  // Display a dialog to select footprint selection, if the netlist
209  // and the .cmp file give 2 different valid footprints
210  std::vector <int > m_indexes; // indexes of footprints in netlist
211 
212  for( unsigned ii = 0; ii < m_netlist.GetCount(); ii++ )
213  {
214  COMPONENT* component = m_netlist.GetComponent( ii );
215 
216  if( component->GetAltFPID().empty() )
217  continue;
218 
219  if( component->GetFPID().IsLegacy() || component->GetAltFPID().IsLegacy() )
220  continue;
221 
222  m_indexes.push_back( ii );
223  }
224 
225  // If a n assignment conflict is found,
226  // open a dialog to chose between schematic assignment
227  // and .cmp file assignment:
228  if( m_indexes.size() > 0 )
229  {
231 
232  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
233  {
234  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
235 
236  wxString cmpfpid = component->GetFPID().Format();
237  wxString schfpid = component->GetAltFPID().Format();
238 
239  dlg.Add( component->GetReference(), schfpid, cmpfpid );
240  }
241 
242  if( dlg.ShowModal() == wxID_OK )
243  {
244 
245  // Update the fp selection:
246  for( unsigned ii = 0; ii < m_indexes.size(); ii++ )
247  {
248  COMPONENT* component = m_netlist.GetComponent( m_indexes[ii] );
249 
250  int choice = dlg.GetSelection( component->GetReference() );
251 
252  if( choice == 0 ) // the schematic (alt fpid) is chosen:
253  component->SetFPID( component->GetAltFPID() );
254  }
255  }
256  }
257 
258  // Populates the component list box:
259  for( unsigned i = 0; i < m_netlist.GetCount(); i++ )
260  {
261  COMPONENT* component = m_netlist.GetComponent( i );
262 
263  msg.Printf( CMP_FORMAT, m_compListBox->GetCount() + 1,
264  component->GetReference(),
265  component->GetValue(),
266  FROM_UTF8( component->GetFPID().Format().c_str() ) );
267 
268  m_compListBox->AppendLine( msg );
269  }
270 
271  if( !m_netlist.IsEmpty() )
272  m_compListBox->SetSelection( 0, true );
273 
274  DisplayStatus();
275 
276  return true;
277 }
278 
279 
280 bool CVPCB_MAINFRAME::SaveFootprintAssociation( bool doSaveSchematic )
281 {
282  std::string payload;
283  STRING_FORMATTER sf;
284 
286 
287  payload = sf.GetString();
289 
290  if( doSaveSchematic )
291  {
292  payload = "";
293  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_SAVE, payload );
294 
295  if( payload == "success" )
296  SetStatusText( _( "Schematic saved" ), 1 );
297  }
298 
299  // Changes are saved, so reset the flag
300  m_modified = false;
301 
302  return true;
303 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
void FormatCvpcbNetlist(OUTPUTFORMATTER *aOut)
Definition: pcb_netlist.h:300
#define CMP_FORMAT
The print format to display a schematic component line.
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:167
This file is part of the common library.
bool AnyFootprintsLinked() const
Function AnyFootprintsLinked.
COMPONENTS_LISTBOX * m_compListBox
void SetSelection(int index, bool State=true)
int ReadSchematicNetlist(const std::string &aNetlist)
Function ReadSchematicNetlist read the netlist (.net) file built on the fly by Eeschema.
unsigned GetCount() const
Function GetCount.
Definition: pcb_netlist.h:237
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:439
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool LoadFootprintFiles()
Function LoadFootprintFiles reads the list of footprint (*.mod files) and generate the list of footpr...
static int guessNickname(FP_LIB_TABLE *aTbl, LIB_ID *aFootprintId)
Return true if the resultant LIB_ID has a certain nickname.
bool empty() const
Definition: lib_id.h:189
void AppendLine(const wxString &text)
const char * c_str() const
Definition: utf8.h:102
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:168
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aNickname, bool aBestEfforts)
Return a list of footprint names contained within the library given by aNickname.
#define NULL
const LIB_ID & GetAltFPID() const
Definition: pcb_netlist.h:171
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void Add(const wxString &aRef, const wxString &aFpSchName, const wxString &aFpCmpName)
Add a line to the selection list.
void ListSet(const wxString &aList)
Add a list of items.
const wxString & GetReference() const
Definition: pcb_netlist.h:158
void SetStatusText(const wxString &aText, int aNumber=0) override
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:92
const std::string & GetString()
Definition: richio.h:435
void BuildFOOTPRINTS_LISTBOX()
HTML_MESSAGE_BOX.
void MessageSet(const wxString &message)
Add a message (in bold) to message list.
UTF8 Format() const
Definition: lib_id.cpp:233
bool Show(bool show) override
COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:85
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
COMPONENT * GetComponent(unsigned aIndex)
Function GetComponent returns the COMPONENT at aIndex.
Definition: pcb_netlist.h:246
bool ReadNetListAndFpFiles(const std::string &aNetlist)
Function ReadNetListAndFpFiles loads the netlist file built on the fly by Eeschema and loads footprin...
#define _(s)
Definition: 3d_actions.cpp:33
wxString wx_str() const
Definition: utf8.cpp:51
bool IsEmpty() const
Function IsEmpty()
Definition: pcb_netlist.h:225
const wxString & GetValue() const
Definition: pcb_netlist.h:159
bool IsLegacy() const
Definition: lib_id.h:176
std::string::size_type size() const
Definition: utf8.h:110
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:411
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:297
void DisplayStatus()
Function DisplayStatus updates the information displayed on the status bar at bottom of the main fram...
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
bool SaveFootprintAssociation(bool doSaveSchematic)
Function SaveFootprintAssociation saves the edits that the user has done by sending them back to eesc...