mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 18:23:15 +02:00
0b2d4d4879
Recommendation is to avoid using the year nomenclature as this information is already encoded in the git repo. Avoids needing to repeatly update. Also updates AUTHORS.txt from current repo with contributor names
188 lines
7.0 KiB
C++
188 lines
7.0 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2023 Mike Williams <mike@mikebwilliams.com>
|
|
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation, either version 3 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "command_sch_export_bom.h"
|
|
#include <cli/exit_codes.h>
|
|
#include "jobs/job_export_sch_bom.h"
|
|
#include <kiface_base.h>
|
|
#include <layer_ids.h>
|
|
#include <string_utils.h>
|
|
#include <wx/crt.h>
|
|
#include <wx/tokenzr.h>
|
|
#include <schematic_settings.h>
|
|
|
|
#include <macros.h>
|
|
|
|
|
|
CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND() : COMMAND( "bom" )
|
|
{
|
|
m_argParser.add_description( UTF8STDSTR( _( "Generate a Bill of Materials (BOM)" ) ) );
|
|
addCommonArgs( true, true, false, false );
|
|
|
|
// Preset options
|
|
m_argParser.add_argument( ARG_PRESET )
|
|
.help( UTF8STDSTR( _( ARG_PRESET_DESC ) ) )
|
|
.default_value( std::string( "" ) )
|
|
.metavar( "PRESET" );
|
|
|
|
m_argParser.add_argument( ARG_FMT_PRESET )
|
|
.help( UTF8STDSTR( _( ARG_FMT_PRESET_DESC ) ) )
|
|
.default_value( std::string( "" ) )
|
|
.metavar( "FMT_PRESET" );
|
|
|
|
// Field output options
|
|
m_argParser.add_argument( ARG_FIELDS )
|
|
.help( UTF8STDSTR( _( ARG_FIELDS_DESC ) ) )
|
|
.default_value( std::string( "Reference,Value,Footprint,${QUANTITY},${DNP}" ) )
|
|
.metavar( "FIELDS" );
|
|
|
|
m_argParser.add_argument( ARG_LABELS )
|
|
.help( UTF8STDSTR( _( ARG_LABELS_DESC ) ) )
|
|
.default_value( std::string( "Refs,Value,Footprint,Qty,DNP" ) )
|
|
.metavar( "LABELS" );
|
|
|
|
m_argParser.add_argument( ARG_GROUP_BY )
|
|
.help( UTF8STDSTR( _( ARG_GROUP_BY_DESC ) ) )
|
|
.default_value( std::string( "" ) )
|
|
.metavar( "GROUP_BY" );
|
|
|
|
m_argParser.add_argument( ARG_SORT_FIELD )
|
|
.help( UTF8STDSTR( _( ARG_SORT_FIELD_DESC ) ) )
|
|
.default_value( std::string( "Reference" ) )
|
|
.metavar( "SORT_BY" );
|
|
|
|
m_argParser.add_argument( ARG_SORT_ASC )
|
|
.help( UTF8STDSTR( _( ARG_SORT_ASC_DESC ) ) )
|
|
.implicit_value( true )
|
|
.default_value( true );
|
|
|
|
m_argParser.add_argument( ARG_FILTER )
|
|
.help( UTF8STDSTR( _( ARG_FILTER_DESC ) ) )
|
|
.default_value( std::string( "" ) )
|
|
.metavar( "FILTER" );
|
|
|
|
m_argParser.add_argument( ARG_EXCLUDE_DNP )
|
|
.help( UTF8STDSTR( _( ARG_EXCLUDE_DNP_DESC ) ) )
|
|
.flag();
|
|
|
|
m_argParser.add_argument( ARG_INCLUDE_EXCLUDED_FROM_BOM )
|
|
.help( UTF8STDSTR( _( ARG_INCLUDE_EXCLUDED_FROM_BOM_DESC ) ) )
|
|
.flag();
|
|
|
|
// Output formatting options
|
|
m_argParser.add_argument( ARG_FIELD_DELIMITER )
|
|
.help( UTF8STDSTR( _( ARG_FIELD_DELIMITER_DESC ) ) )
|
|
.default_value( std::string( "," ) )
|
|
.metavar( "FIELD_DELIM" );
|
|
|
|
m_argParser.add_argument( ARG_STRING_DELIMITER )
|
|
.help( UTF8STDSTR( _( ARG_STRING_DELIMITER_DESC ) ) )
|
|
.default_value( std::string( "\"" ) )
|
|
.metavar( "STR_DELIM" );
|
|
|
|
m_argParser.add_argument( ARG_REF_DELIMITER )
|
|
.help( UTF8STDSTR( _( ARG_REF_DELIMITER_DESC ) ) )
|
|
.default_value( std::string( "," ) )
|
|
.metavar( "REF_DELIM" );
|
|
|
|
m_argParser.add_argument( ARG_REF_RANGE_DELIMITER )
|
|
.help( UTF8STDSTR( _( ARG_REF_RANGE_DELIMITER_DESC ) ) )
|
|
.default_value( std::string( "-" ) )
|
|
.metavar( "REF_RANGE_DELIM" );
|
|
|
|
m_argParser.add_argument( ARG_KEEP_TABS )
|
|
.help( UTF8STDSTR( _( ARG_KEEP_TABS_DESC ) ) )
|
|
.flag();
|
|
|
|
m_argParser.add_argument( ARG_KEEP_LINE_BREAKS )
|
|
.help( UTF8STDSTR( _( ARG_KEEP_LINE_BREAKS_DESC ) ) )
|
|
.flag();
|
|
}
|
|
|
|
|
|
std::vector<wxString> CLI::SCH_EXPORT_BOM_COMMAND::convertStringList( const wxString& aList )
|
|
{
|
|
std::vector<wxString> v;
|
|
|
|
if( !aList.IsEmpty() )
|
|
{
|
|
wxStringTokenizer layerTokens( aList, "," );
|
|
|
|
while( layerTokens.HasMoreTokens() )
|
|
v.emplace_back( layerTokens.GetNextToken() );
|
|
}
|
|
|
|
return v;
|
|
}
|
|
|
|
int CLI::SCH_EXPORT_BOM_COMMAND::doPerform( KIWAY& aKiway )
|
|
{
|
|
std::unique_ptr<JOB_EXPORT_SCH_BOM> bomJob = std::make_unique<JOB_EXPORT_SCH_BOM>();
|
|
|
|
// Basic options
|
|
bomJob->m_filename = m_argInput;
|
|
bomJob->SetOutputPath( m_argOutput );
|
|
|
|
bomJob->m_bomPresetName = From_UTF8( m_argParser.get<std::string>( ARG_PRESET ).c_str() );
|
|
bomJob->m_bomFmtPresetName =
|
|
From_UTF8( m_argParser.get<std::string>( ARG_FMT_PRESET ).c_str() );
|
|
|
|
// Format options
|
|
bomJob->m_fieldDelimiter =
|
|
From_UTF8( m_argParser.get<std::string>( ARG_FIELD_DELIMITER ).c_str() );
|
|
bomJob->m_stringDelimiter =
|
|
From_UTF8( m_argParser.get<std::string>( ARG_STRING_DELIMITER ).c_str() );
|
|
bomJob->m_refDelimiter = From_UTF8( m_argParser.get<std::string>( ARG_REF_DELIMITER ).c_str() );
|
|
bomJob->m_refRangeDelimiter =
|
|
From_UTF8( m_argParser.get<std::string>( ARG_REF_RANGE_DELIMITER ).c_str() );
|
|
bomJob->m_keepTabs = m_argParser.get<bool>( ARG_KEEP_TABS );
|
|
bomJob->m_keepLineBreaks = m_argParser.get<bool>( ARG_KEEP_LINE_BREAKS );
|
|
|
|
// Output fields options
|
|
bomJob->m_fieldsOrdered =
|
|
convertStringList( From_UTF8( m_argParser.get<std::string>( ARG_FIELDS ).c_str() ) );
|
|
bomJob->m_fieldsLabels =
|
|
convertStringList( From_UTF8( m_argParser.get<std::string>( ARG_LABELS ).c_str() ) );
|
|
|
|
// We only apply the default labels if the default fields are used
|
|
if( m_argParser.is_used( ARG_FIELDS ) && !m_argParser.is_used( ARG_LABELS ) )
|
|
{
|
|
bomJob->m_fieldsLabels.clear();
|
|
}
|
|
|
|
bomJob->m_fieldsGroupBy =
|
|
convertStringList( From_UTF8( m_argParser.get<std::string>( ARG_GROUP_BY ).c_str() ) );
|
|
bomJob->m_sortField = From_UTF8( m_argParser.get<std::string>( ARG_SORT_FIELD ).c_str() );
|
|
bomJob->m_sortAsc = m_argParser.get<bool>( ARG_SORT_ASC );
|
|
bomJob->m_filterString = From_UTF8( m_argParser.get<std::string>( ARG_FILTER ).c_str() );
|
|
bomJob->m_excludeDNP = m_argParser.get<bool>( ARG_EXCLUDE_DNP );
|
|
bomJob->m_includeExcludedFromBOM = m_argParser.get<bool>( ARG_INCLUDE_EXCLUDED_FROM_BOM );
|
|
|
|
if( !wxFile::Exists( bomJob->m_filename ) )
|
|
{
|
|
wxFprintf( stderr, _( "Schematic file does not exist or is not accessible\n" ) );
|
|
return EXIT_CODES::ERR_INVALID_INPUT_FILE;
|
|
}
|
|
|
|
int exitCode = aKiway.ProcessJob( KIWAY::FACE_SCH, bomJob.get() );
|
|
|
|
return exitCode;
|
|
}
|