mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 10:13:19 +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
114 lines
3.8 KiB
C++
114 lines
3.8 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/>.
|
|
*/
|
|
|
|
#ifndef _BOM_SETTINGS_H
|
|
#define _BOM_SETTINGS_H
|
|
|
|
|
|
#include <settings/json_settings.h>
|
|
#include <settings/parameters.h>
|
|
#include <i18n_utility.h>
|
|
|
|
// A single field within a BOM, e.g. Reference, Value, Footprint
|
|
struct KICOMMON_API BOM_FIELD
|
|
{
|
|
wxString name;
|
|
wxString label;
|
|
bool show = false;
|
|
bool groupBy = false;
|
|
|
|
bool operator==( const BOM_FIELD& rhs ) const;
|
|
};
|
|
|
|
KICOMMON_API bool operator!=( const BOM_FIELD& lhs, const BOM_FIELD& rhs );
|
|
KICOMMON_API bool operator<( const BOM_FIELD& lhs, const BOM_FIELD& rhs );
|
|
|
|
KICOMMON_API void to_json( nlohmann::json& j, const BOM_FIELD& f );
|
|
KICOMMON_API void from_json( const nlohmann::json& j, BOM_FIELD& f );
|
|
|
|
|
|
// A complete preset defining a BOM "View" with a list of all the fields to show,
|
|
// group by, order, filtering settings, etc.
|
|
struct KICOMMON_API BOM_PRESET
|
|
{
|
|
wxString name;
|
|
bool readOnly = false;
|
|
std::vector<BOM_FIELD> fieldsOrdered;
|
|
wxString sortField;
|
|
bool sortAsc = true;
|
|
wxString filterString;
|
|
bool groupSymbols = false;
|
|
bool excludeDNP = false;
|
|
bool includeExcludedFromBOM = false;
|
|
|
|
bool operator==( const BOM_PRESET& rhs ) const;
|
|
|
|
static BOM_PRESET DefaultEditing();
|
|
static BOM_PRESET GroupedByValue();
|
|
static BOM_PRESET GroupedByValueFootprint();
|
|
static BOM_PRESET Attributes();
|
|
|
|
static std::vector<BOM_PRESET> BuiltInPresets();
|
|
};
|
|
|
|
KICOMMON_API bool operator!=( const BOM_PRESET& lhs, const BOM_PRESET& rhs );
|
|
KICOMMON_API bool operator<( const BOM_PRESET& lhs, const BOM_PRESET& rhs );
|
|
|
|
KICOMMON_API void to_json( nlohmann::json& j, const BOM_PRESET& f );
|
|
KICOMMON_API void from_json( const nlohmann::json& j, BOM_PRESET& f );
|
|
|
|
|
|
// A formatting preset, like CSV (Comma Separated Values)
|
|
struct KICOMMON_API BOM_FMT_PRESET
|
|
{
|
|
wxString name;
|
|
bool readOnly = false;
|
|
wxString fieldDelimiter;
|
|
wxString stringDelimiter;
|
|
wxString refDelimiter;
|
|
wxString refRangeDelimiter;
|
|
bool keepTabs = false;
|
|
bool keepLineBreaks = false;
|
|
|
|
bool operator==( const BOM_FMT_PRESET& rhs ) const;
|
|
|
|
static BOM_FMT_PRESET CSV();
|
|
static BOM_FMT_PRESET TSV();
|
|
static BOM_FMT_PRESET Semicolons();
|
|
|
|
static std::vector<BOM_FMT_PRESET> BuiltInPresets();
|
|
};
|
|
|
|
KICOMMON_API bool operator!=( const BOM_FMT_PRESET& lhs, const BOM_FMT_PRESET& rhs );
|
|
KICOMMON_API bool operator<( const BOM_FMT_PRESET& lhs, const BOM_FMT_PRESET& rhs );
|
|
|
|
KICOMMON_API void to_json( nlohmann::json& j, const BOM_FMT_PRESET& f );
|
|
KICOMMON_API void from_json( const nlohmann::json& j, BOM_FMT_PRESET& f );
|
|
|
|
#if defined( __MINGW32__ )
|
|
template class KICOMMON_API PARAM_LIST<struct BOM_PRESET>;
|
|
template class KICOMMON_API PARAM_LIST<struct BOM_FMT_PRESET>;
|
|
#else
|
|
extern template class APIVISIBLE PARAM_LIST<BOM_PRESET>;
|
|
extern template class APIVISIBLE PARAM_LIST<BOM_FMT_PRESET>;
|
|
#endif
|
|
|
|
#endif
|