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