KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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 <board.h>
33#include <project.h>
35#include <footprint.h>
37#include <wx/filedlg.h>
38#include <vector>
39
40
41/* creates a BOM list from board
42 * The format is:
43 * "Id";"Designator";"Footprint";"Number";"Designation";"Supplier and ref";
44 * 1;"P1";"DB25FC";1;"DB25FEMELLE";;;
45 * 2;"U9";"PGA120";1;"4003APG120";;;
46 * 3;"JP1";"pin_array_8x2";1;"CONN_8X2";;;
47 * 4;"RR1";"r_pack9";1;"9x1K";;;
48 * 5;"X1";"HC-18UH";1;"8MHz";;;
49 * 6;"U8";"24dip300";1;"EP600";;;
50 * 7;"U5";"32dip600";1;"628128";;;
51 * 8;"C2,C3";"C1";2;"47pF";;;
52 * 9;"U1";"20dip300";1;"74LS245";;;
53 * 10;"U3";"20dip300";1;"74LS541";;;
54 * 11;"U2";"20dip300";1;"74LS688";;;
55 * 12;"C1,C4,C5,C6";"CP6";4;"47uF";;;
56 */
57
59{
60public:
61 wxString m_Ref;
62 wxString m_Val;
64 int m_Id;
66};
67
68using BOM_ENTRY_LIST = std::vector<BOM_ENTRY>;
69
70
72{
74 wxFileName fn;
75 FILE* fp_bom;
76
77 if( board->Footprints().empty() )
78 {
79 m_frame->ShowInfoBarError( _( "Cannot export BOM: there are no footprints on the PCB." ) );
80 return 0;
81 }
82
83 /* Set the file extension: */
84 fn = board->GetFileName();
85 fn.SetExt( FILEEXT::CsvFileExtension );
86
87 wxString pro_dir = wxPathOnly( m_frame->Prj().GetProjectFullName() );
88
89 wxFileDialog dlg( m_frame, _( "Save Bill of Materials" ), pro_dir, fn.GetFullName(),
90 FILEEXT::CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
91
92 if( dlg.ShowModal() == wxID_CANCEL )
93 return 0;
94
95 fn = dlg.GetPath();
96
97 fp_bom = wxFopen( fn.GetFullPath(), wxT( "wt" ) );
98
99 if( fp_bom == nullptr )
100 {
101 DisplayError( m_frame, wxString::Format( _( "Failed to create file '%s'." ), fn.GetFullPath() ) );
102 return 0;
103 }
104
105 // Write header:
106 wxString msg = wxT( "\"" );
107 msg << _( "Id" ) << wxT( "\";\"" );
108 msg << _( "Designator" ) << wxT( "\";\"" );
109 msg << _( "Footprint" ) << wxT( "\";\"" );
110 msg << _( "Quantity" ) << wxT( "\";\"" );
111 msg << _( "Designation" ) << wxT( "\";\"" );
112 msg << _( "Supplier and ref" ) << wxT( "\";\n" );
113 fprintf( fp_bom, "%s", TO_UTF8( msg ) );
114
115 // Build list
116 BOM_ENTRY_LIST list;
117 int i = 1;
118
120 {
122 continue;
123
124 bool valExist = false;
125
126 // try to find component in existing list
127 for( BOM_ENTRY& curEntry : list )
128 {
129 if( curEntry.m_Val == footprint->GetValue() && curEntry.m_FPID == footprint->GetFPID() )
130 {
131 curEntry.m_Ref.Append( wxT( ", " ), 1 );
132 curEntry.m_Ref.Append( footprint->Reference().GetShownText( false ) );
133 curEntry.m_Count++;
134
135 valExist = true;
136 break;
137 }
138 }
139
140 // If component does not exist yet, create new one and append it to the list.
141 if( !valExist )
142 {
143 list.emplace_back();
144 BOM_ENTRY& newEntry = list.back();
145 newEntry.m_Id = i++;
146 newEntry.m_Val = footprint->Value().GetShownText( false );
147 newEntry.m_Ref = footprint->Reference().GetShownText( false );
148 newEntry.m_FPID = footprint->GetFPID();
149 newEntry.m_Count = 1;
150 }
151 }
152
153 // Print list.
154 for( const BOM_ENTRY& curEntry : list )
155 {
156 msg.Empty();
157
158 msg << curEntry.m_Id << wxT( ";\"" );
159 msg << curEntry.m_Ref << wxT( "\";\"" );
160 msg << From_UTF8( curEntry.m_FPID.GetLibItemName().c_str() ) << wxT( "\";" );
161 msg << curEntry.m_Count << wxT( ";\"" );
162 msg << curEntry.m_Val << wxT( "\";;;\n" );
163 fprintf( fp_bom, "%s", TO_UTF8( msg ) );
164 }
165
166 fclose( fp_bom );
167
168 return 0;
169}
std::vector< BOM_ENTRY > BOM_ENTRY_LIST
int GenBOMFileFromBoard(const TOOL_EVENT &aEvent)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
const FOOTPRINTS & Footprints() const
Definition: board.h:358
const wxString & GetFileName() const
Definition: board.h:354
wxString m_Val
int m_Id
wxString m_Ref
LIB_ID m_FPID
int m_Count
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
PCB_FIELD & Value()
read/write accessors:
Definition: footprint.h:663
int GetAttributes() const
Definition: footprint.h:293
const LIB_ID & GetFPID() const
Definition: footprint.h:251
PCB_FIELD & Reference()
Definition: footprint.h:664
const wxString & GetValue() const
Definition: footprint.h:649
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
BOARD * GetBoard() const
wxString GetShownText(bool aAllowExtraText, int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:139
BOARD * board() const
FOOTPRINT * footprint() const
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
Definition: project.cpp:143
Generic, UI-independent tool event.
Definition: tool_event.h:168
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:169
This file is part of the common library.
#define _(s)
@ FP_EXCLUDE_FROM_BOM
Definition: footprint.h:83
static const std::string CsvFileExtension
static wxString CsvFileWildcard()
This file contains miscellaneous commonly used macros and functions.
wxString From_UTF8(const char *cstring)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:429
Definition of file extensions used in Kicad.