KiCad PCB EDA Suite
build_BOM_from_board.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) 2009-2014 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
5  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 /* build_BOM_from_board.cpp */
26 
27 
28 #include <confirm.h>
29 #include <kicad_string.h>
30 #include <pcb_edit_frame.h>
31 #include <project.h>
33 #include <board.h>
34 #include <footprint.h>
35 #include <wx/listimpl.cpp>
36 
37 /* creates a BOM list rom board
38  * The format is:
39  * "Id";"Designator";"Package";"Number";"Designation";"Supplier and ref";
40  * 1;"P1";"DB25FC";1;"DB25FEMELLE";;;
41  * 2;"U9";"PGA120";1;"4003APG120";;;
42  * 3;"JP1";"pin_array_8x2";1;"CONN_8X2";;;
43  * 4;"RR1";"r_pack9";1;"9x1K";;;
44  * 5;"X1";"HC-18UH";1;"8MHz";;;
45  * 6;"U8";"24dip300";1;"EP600";;;
46  * 7;"U5";"32dip600";1;"628128";;;
47  * 8;"C2,C3";"C1";2;"47pF";;;
48  * 9;"U1";"20dip300";1;"74LS245";;;
49  * 10;"U3";"20dip300";1;"74LS541";;;
50  * 11;"U2";"20dip300";1;"74LS688";;;
51  * 12;"C1,C4,C5,C6";"CP6";4;"47uF";;;
52  */
53 
54 const wxString CsvFileExtension( wxT( "csv" ) ); // BOM file extension
55 
56 
57 class cmp
58 {
59 public:
60  wxString m_Ref;
61  wxString m_Val;
63  int m_Id;
65 };
66 WX_DECLARE_LIST( cmp, CmpList );
67 
68 WX_DEFINE_LIST( CmpList )
69 
70 
71 void PCB_EDIT_FRAME::RecreateBOMFileFromBoard( wxCommandEvent& aEvent )
72 {
73  wxFileName fn;
74  FILE* fp_bom;
75  wxString msg;
76 
77  if( GetBoard()->Footprints().empty() )
78  {
79  ShowInfoBarError( _( "Cannot export BOM: there are no footprints on the PCB." ) );
80  return;
81  }
82 
83  /* Set the file extension: */
84  fn = GetBoard()->GetFileName();
85  fn.SetExt( CsvFileExtension );
86 
87  wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
88 
89  wxFileDialog dlg( this, _( "Save Bill of Materials" ), pro_dir, fn.GetFullName(),
90  CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
91 
92  if( dlg.ShowModal() == wxID_CANCEL )
93  return;
94 
95  fn = dlg.GetPath();
96 
97  fp_bom = wxFopen( fn.GetFullPath(), wxT( "wt" ) );
98 
99  if( fp_bom == NULL )
100  {
101  msg.Printf( _( "Unable to create file \"%s\"" ), fn.GetFullPath() );
102  DisplayError( this, msg );
103  return;
104  }
105 
106  // Write header:
107  msg = wxT( "\"" );
108  msg << _( "Id" ) << wxT( "\";\"" );
109  msg << _( "Designator" ) << wxT( "\";\"" );
110  msg << _( "Package" ) << wxT( "\";\"" );
111  msg << _( "Quantity" ) << wxT( "\";\"" );
112  msg << _( "Designation" ) << wxT( "\";\"" );
113  msg << _( "Supplier and ref" ) << wxT( "\";\n" );
114  fprintf( fp_bom, "%s", TO_UTF8( msg ) );
115 
116  // Build list
117  CmpList list;
118  cmp* comp = NULL;
119  CmpList::iterator iter;
120  int i = 1;
121 
122  for( FOOTPRINT* fp : GetBoard()->Footprints() )
123  {
124  bool valExist = false;
125 
126  // try to find component in existing list
127  for( iter = list.begin(); iter != list.end(); ++iter )
128  {
129  cmp* current = *iter;
130 
131  if( current->m_Val == fp->GetValue() && current->m_fpid == fp->GetFPID() )
132  {
133  current->m_Ref.Append( wxT( ", " ), 1 );
134  current->m_Ref.Append( fp->Reference().GetShownText() );
135  current->m_CmpCount++;
136 
137  valExist = true;
138  break;
139  }
140  }
141 
142  // If component does not exist yet, create new one and append it to the list.
143  if( valExist == false )
144  {
145  comp = new cmp();
146  comp->m_Id = i++;
147  comp->m_Val = fp->Value().GetShownText();
148  comp->m_Ref = fp->Reference().GetShownText();
149  comp->m_fpid = fp->GetFPID();
150  comp->m_CmpCount = 1;
151  list.Append( comp );
152  }
153  }
154 
155  // Print list. Also delete temporary created objects.
156  for( size_t ii = list.GetCount(); ii > 0; ii-- )
157  {
158  cmp* current = *list.begin(); // Because the first object will be removed
159  // from list, all objects will be get here
160 
161  msg.Empty();
162 
163  msg << current->m_Id << wxT( ";\"" );
164  msg << current->m_Ref << wxT( "\";\"" );
165  msg << FROM_UTF8( current->m_fpid.GetLibItemName().c_str() ) << wxT( "\";" );
166  msg << current->m_CmpCount << wxT( ";\"" );
167  msg << current->m_Val << wxT( "\";;;\n" );
168  fprintf( fp_bom, "%s", TO_UTF8( msg ) );
169 
170  // We do not need this object, now: remove it from list and delete it
171  list.DeleteObject( current );
172  delete (current);
173  }
174 
175  fclose( fp_bom );
176 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:109
This file is part of the common library.
PROJECT & Prj()
Definition: kicad.cpp:342
WX_DECLARE_LIST(cmp, CmpList)
wxString CsvFileWildcard()
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const wxString CsvFileExtension(wxT("csv"))
const wxString & GetFileName() const
Definition: board.h:278
const char * c_str() const
Definition: utf8.h:107
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
wxString m_Ref
#define NULL
Definition of file extensions used in Kicad.
BOARD * GetBoard()
wxString m_Val
#define _(s)
Definition: 3d_actions.cpp:33
PCB_EDIT_FRAME is the main frame for Pcbnew.
static bool empty(const wxTextEntryBase *aCtrl)