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-2021 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 <macros.h>
30 #include <string_utils.h>
31 #include <pcb_edit_frame.h>
32 #include <project.h>
34 #include <footprint.h>
35 #include <wx/listimpl.cpp>
36 #include <wx/filedlg.h>
37 
38 
39 /* creates a BOM list from board
40  * The format is:
41  * "Id";"Designator";"Package";"Number";"Designation";"Supplier and ref";
42  * 1;"P1";"DB25FC";1;"DB25FEMELLE";;;
43  * 2;"U9";"PGA120";1;"4003APG120";;;
44  * 3;"JP1";"pin_array_8x2";1;"CONN_8X2";;;
45  * 4;"RR1";"r_pack9";1;"9x1K";;;
46  * 5;"X1";"HC-18UH";1;"8MHz";;;
47  * 6;"U8";"24dip300";1;"EP600";;;
48  * 7;"U5";"32dip600";1;"628128";;;
49  * 8;"C2,C3";"C1";2;"47pF";;;
50  * 9;"U1";"20dip300";1;"74LS245";;;
51  * 10;"U3";"20dip300";1;"74LS541";;;
52  * 11;"U2";"20dip300";1;"74LS688";;;
53  * 12;"C1,C4,C5,C6";"CP6";4;"47uF";;;
54  */
55 
56 const wxString CsvFileExtension( wxT( "csv" ) ); // BOM file extension
57 
58 class BOM_ENTRY
59 {
60 public:
61  wxString m_Ref;
62  wxString m_Val;
64  int m_Id;
65  int m_Count;
66 };
67 
68 WX_DECLARE_LIST( BOM_ENTRY, BOM_ENTRY_LIST );
69 
70 WX_DEFINE_LIST( BOM_ENTRY_LIST )
71 
72 
73 void PCB_EDIT_FRAME::RecreateBOMFileFromBoard( wxCommandEvent& aEvent )
74 {
75  wxFileName fn;
76  FILE* fp_bom;
77  wxString msg;
78 
79  if( GetBoard()->Footprints().empty() )
80  {
81  ShowInfoBarError( _( "Cannot export BOM: there are no footprints on the PCB." ) );
82  return;
83  }
84 
85  /* Set the file extension: */
86  fn = GetBoard()->GetFileName();
87  fn.SetExt( CsvFileExtension );
88 
89  wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
90 
91  wxFileDialog dlg( this, _( "Save Bill of Materials" ), pro_dir, fn.GetFullName(),
92  CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
93 
94  if( dlg.ShowModal() == wxID_CANCEL )
95  return;
96 
97  fn = dlg.GetPath();
98 
99  fp_bom = wxFopen( fn.GetFullPath(), wxT( "wt" ) );
100 
101  if( fp_bom == nullptr )
102  {
103  msg.Printf( _( "Failed to create file '%s'." ), fn.GetFullPath() );
104  DisplayError( this, msg );
105  return;
106  }
107 
108  // Write header:
109  msg = wxT( "\"" );
110  msg << _( "Id" ) << wxT( "\";\"" );
111  msg << _( "Designator" ) << wxT( "\";\"" );
112  msg << _( "Package" ) << wxT( "\";\"" );
113  msg << _( "Quantity" ) << wxT( "\";\"" );
114  msg << _( "Designation" ) << wxT( "\";\"" );
115  msg << _( "Supplier and ref" ) << wxT( "\";\n" );
116  fprintf( fp_bom, "%s", TO_UTF8( msg ) );
117 
118  // Build list
119  BOM_ENTRY_LIST list;
120  int i = 1;
121 
122  for( FOOTPRINT* footprint : GetBoard()->Footprints() )
123  {
124  bool valExist = false;
125 
126  // try to find component in existing list
127  for( auto iter = list.begin(); iter != list.end(); ++iter )
128  {
129  BOM_ENTRY* curEntry = *iter;
130 
131  if( curEntry->m_Val == footprint->GetValue()
132  && curEntry->m_FPID == footprint->GetFPID() )
133  {
134  curEntry->m_Ref.Append( wxT( ", " ), 1 );
135  curEntry->m_Ref.Append( footprint->Reference().GetShownText() );
136  curEntry->m_Count++;
137 
138  valExist = true;
139  break;
140  }
141  }
142 
143  // If component does not exist yet, create new one and append it to the list.
144  if( valExist == false )
145  {
146  BOM_ENTRY* newEntry = new BOM_ENTRY();
147  newEntry->m_Id = i++;
148  newEntry->m_Val = footprint->Value().GetShownText();
149  newEntry->m_Ref = footprint->Reference().GetShownText();
150  newEntry->m_FPID = footprint->GetFPID();
151  newEntry->m_Count = 1;
152  list.Append( newEntry );
153  }
154  }
155 
156  // Print list. Also delete temporary created objects.
157  for( size_t ii = list.GetCount(); ii > 0; ii-- )
158  {
159  BOM_ENTRY* curEntry = *list.begin(); // Because the first object will be removed
160  // from list, all objects will be get here
161 
162  msg.Empty();
163 
164  msg << curEntry->m_Id << wxT( ";\"" );
165  msg << curEntry->m_Ref << wxT( "\";\"" );
166  msg << FROM_UTF8( curEntry->m_FPID.GetLibItemName().c_str() ) << wxT( "\";" );
167  msg << curEntry->m_Count << wxT( ";\"" );
168  msg << curEntry->m_Val << wxT( "\";;;\n" );
169  fprintf( fp_bom, "%s", TO_UTF8( msg ) );
170 
171  // We do not need this object, now: remove it from list and delete it
172  list.DeleteObject( curEntry );
173  delete curEntry;
174  }
175 
176  fclose( fp_bom );
177 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
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
This file is part of the common library.
PROJECT & Prj()
Definition: kicad.cpp:403
int m_Count
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:228
This file contains miscellaneous commonly used macros and functions.
const char * c_str() const
Definition: utf8.h:102
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
LIB_ID m_FPID
Definition of file extensions used in Kicad.
#define _(s)
BOARD * GetBoard()
int m_Id
The main frame for Pcbnew.
static bool empty(const wxTextEntryBase *aCtrl)
wxString m_Val
WX_DECLARE_LIST(BOM_ENTRY, BOM_ENTRY_LIST)
wxString m_Ref