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, [email protected]
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";"Footprint";"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
57{
58public:
59 wxString m_Ref;
60 wxString m_Val;
62 int m_Id;
64};
65
66WX_DECLARE_LIST( BOM_ENTRY, BOM_ENTRY_LIST );
67
68WX_DEFINE_LIST( BOM_ENTRY_LIST )
69
70
71void 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 == nullptr )
100 {
101 msg.Printf( _( "Failed 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 << _( "Footprint" ) << 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 BOM_ENTRY_LIST list;
118 int i = 1;
119
120 for( FOOTPRINT* footprint : GetBoard()->Footprints() )
121 {
122 if( footprint->GetAttributes() & FP_EXCLUDE_FROM_BOM )
123 continue;
124
125 bool valExist = false;
126
127 // try to find component in existing list
128 for( auto iter = list.begin(); iter != list.end(); ++iter )
129 {
130 BOM_ENTRY* curEntry = *iter;
131
132 if( curEntry->m_Val == footprint->GetValue()
133 && curEntry->m_FPID == footprint->GetFPID() )
134 {
135 curEntry->m_Ref.Append( wxT( ", " ), 1 );
136 curEntry->m_Ref.Append( footprint->Reference().GetShownText() );
137 curEntry->m_Count++;
138
139 valExist = true;
140 break;
141 }
142 }
143
144 // If component does not exist yet, create new one and append it to the list.
145 if( valExist == false )
146 {
147 BOM_ENTRY* newEntry = new BOM_ENTRY();
148 newEntry->m_Id = i++;
149 newEntry->m_Val = footprint->Value().GetShownText();
150 newEntry->m_Ref = footprint->Reference().GetShownText();
151 newEntry->m_FPID = footprint->GetFPID();
152 newEntry->m_Count = 1;
153 list.Append( newEntry );
154 }
155 }
156
157 // Print list. Also delete temporary created objects.
158 for( size_t ii = list.GetCount(); ii > 0; ii-- )
159 {
160 BOM_ENTRY* curEntry = *list.begin(); // Because the first object will be removed
161 // from list, all objects will be get here
162
163 msg.Empty();
164
165 msg << curEntry->m_Id << wxT( ";\"" );
166 msg << curEntry->m_Ref << wxT( "\";\"" );
167 msg << FROM_UTF8( curEntry->m_FPID.GetLibItemName().c_str() ) << wxT( "\";" );
168 msg << curEntry->m_Count << wxT( ";\"" );
169 msg << curEntry->m_Val << wxT( "\";;;\n" );
170 fprintf( fp_bom, "%s", TO_UTF8( msg ) );
171
172 // We do not need this object, now: remove it from list and delete it
173 list.DeleteObject( curEntry );
174 delete curEntry;
175 }
176
177 fclose( fp_bom );
178}
WX_DECLARE_LIST(BOM_ENTRY, BOM_ENTRY_LIST)
const wxString & GetFileName() const
Definition: board.h:302
wxString m_Val
int m_Id
wxString m_Ref
LIB_ID m_FPID
int m_Count
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
The main frame for Pcbnew.
const char * c_str() const
Definition: utf8.h:102
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:300
This file is part of the common library.
static bool empty(const wxTextEntryBase *aCtrl)
#define _(s)
@ FP_EXCLUDE_FROM_BOM
Definition: footprint.h:71
const std::string CsvFileExtension
wxString CsvFileWildcard()
PROJECT & Prj()
Definition: kicad.cpp:573
This file contains miscellaneous commonly used macros and functions.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
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
BOARD * GetBoard()
Definition of file extensions used in Kicad.