294 lines
9.3 KiB
C++
294 lines
9.3 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2022 Mikolaj Wielgus
|
|
* Copyright (C) 2022 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, you may find one here:
|
|
* https://www.gnu.org/licenses/gpl-3.0.html
|
|
* or you may search the http://www.gnu.org website for the version 3 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include <sim/sim_model_raw_spice.h>
|
|
#include <sim/sim_serde.h>
|
|
|
|
#include <boost/algorithm/string/predicate.hpp>
|
|
#include <fmt/core.h>
|
|
#include <pegtl.hpp>
|
|
#include <pegtl/contrib/parse_tree.hpp>
|
|
|
|
|
|
namespace SIM_MODEL_RAW_SPICE_PARSER
|
|
{
|
|
using namespace SIM_SERDE_GRAMMAR;
|
|
|
|
template <typename Rule> struct legacyPinSequenceSelector : std::false_type {};
|
|
template <> struct legacyPinSequenceSelector<legacyPinNumber> : std::true_type {};
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::ModelLine( const SPICE_ITEM& aItem ) const
|
|
{
|
|
return "";
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::ItemName( const SPICE_ITEM& aItem ) const
|
|
{
|
|
std::string elementType = m_model.GetParam(
|
|
static_cast<int>( SIM_MODEL_RAW_SPICE::SPICE_PARAM::TYPE ) ).value->ToString();
|
|
|
|
if( aItem.refName != "" && boost::starts_with( aItem.refName, elementType ) )
|
|
return aItem.refName;
|
|
else
|
|
return fmt::format( "{}{}", elementType, aItem.refName );
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::ItemPins( const SPICE_ITEM& aItem ) const
|
|
{
|
|
std::string result;
|
|
|
|
for( const SIM_MODEL::PIN& pin : GetPins() )
|
|
{
|
|
auto it = std::find( aItem.pinNumbers.begin(), aItem.pinNumbers.end(),
|
|
pin.symbolPinNumber );
|
|
|
|
if( it != aItem.pinNumbers.end() )
|
|
{
|
|
long symbolPinIndex = std::distance( aItem.pinNumbers.begin(), it );
|
|
result.append( fmt::format( " {}", aItem.pinNetNames.at( symbolPinIndex ) ) );
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::ItemModelName( const SPICE_ITEM& aItem ) const
|
|
{
|
|
return "";
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::ItemParams() const
|
|
{
|
|
std::string result;
|
|
|
|
for( const SIM_MODEL::PARAM& param : GetInstanceParams() )
|
|
{
|
|
if( param.info.name == "model" )
|
|
result.append( " " + param.value->ToString() );
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
std::string SPICE_GENERATOR_RAW_SPICE::Preview( const SPICE_ITEM& aItem ) const
|
|
{
|
|
SPICE_ITEM item = aItem;
|
|
item.refName = "";
|
|
|
|
for( int i = 0; i < m_model.GetPinCount(); ++i )
|
|
{
|
|
item.pinNumbers.push_back( fmt::format( "{}", i + 1 ) );
|
|
item.pinNetNames.push_back( fmt::format( "{}", i + 1 ) );
|
|
}
|
|
|
|
return ItemLine( item );
|
|
}
|
|
|
|
|
|
SIM_MODEL_RAW_SPICE::SIM_MODEL_RAW_SPICE() :
|
|
SIM_MODEL( TYPE::RAWSPICE, std::make_unique<SPICE_GENERATOR_RAW_SPICE>( *this ) )
|
|
{
|
|
static std::vector<PARAM::INFO> paramInfos = makeParamInfos();
|
|
|
|
for( const PARAM::INFO& paramInfo : paramInfos )
|
|
AddParam( paramInfo );
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::ReadDataSchFields( unsigned aSymbolPinCount,
|
|
const std::vector<SCH_FIELD>* aFields )
|
|
{
|
|
SIM_MODEL::ReadDataSchFields( aSymbolPinCount, aFields );
|
|
readLegacyDataFields( aSymbolPinCount, aFields );
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::ReadDataLibFields( unsigned aSymbolPinCount,
|
|
const std::vector<LIB_FIELD>* aFields )
|
|
{
|
|
SIM_MODEL::ReadDataLibFields( aSymbolPinCount, aFields );
|
|
readLegacyDataFields( aSymbolPinCount, aFields );
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::WriteDataSchFields( std::vector<SCH_FIELD>& aFields ) const
|
|
{
|
|
SIM_MODEL::WriteDataSchFields( aFields );
|
|
|
|
// Erase the legacy fields.
|
|
SetFieldValue( aFields, LEGACY_TYPE_FIELD, "" );
|
|
SetFieldValue( aFields, LEGACY_PINS_FIELD, "" );
|
|
SetFieldValue( aFields, LEGACY_MODEL_FIELD, "" );
|
|
SetFieldValue( aFields, LEGACY_ENABLED_FIELD, "" );
|
|
SetFieldValue( aFields, LEGACY_LIB_FIELD, "" );
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::WriteDataLibFields( std::vector<LIB_FIELD>& aFields ) const
|
|
{
|
|
SIM_MODEL::WriteDataLibFields( aFields );
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::CreatePins( unsigned aSymbolPinCount )
|
|
{
|
|
for( unsigned symbolPinIndex = 0; symbolPinIndex < aSymbolPinCount; ++symbolPinIndex )
|
|
AddPin( { "", fmt::format( "{}", symbolPinIndex + 1 ) } );
|
|
}
|
|
|
|
|
|
std::vector<SIM_MODEL::PARAM::INFO> SIM_MODEL_RAW_SPICE::makeParamInfos()
|
|
{
|
|
std::vector<PARAM::INFO> paramInfos;
|
|
|
|
for( SPICE_PARAM spiceParam : SPICE_PARAM_ITERATOR() )
|
|
{
|
|
PARAM::INFO paramInfo;
|
|
|
|
switch( spiceParam )
|
|
{
|
|
case SPICE_PARAM::TYPE:
|
|
paramInfo.name = "type";
|
|
paramInfo.type = SIM_VALUE::TYPE_STRING;
|
|
paramInfo.unit = "";
|
|
paramInfo.category = SIM_MODEL::PARAM::CATEGORY::PRINCIPAL;
|
|
paramInfo.defaultValue = "";
|
|
paramInfo.description = "Spice element type";
|
|
paramInfo.isSpiceInstanceParam = true;
|
|
|
|
paramInfos.push_back( paramInfo );
|
|
break;
|
|
|
|
case SPICE_PARAM::MODEL:
|
|
paramInfo.name = "model";
|
|
paramInfo.type = SIM_VALUE::TYPE_STRING;
|
|
paramInfo.unit = "";
|
|
paramInfo.category = SIM_MODEL::PARAM::CATEGORY::PRINCIPAL;
|
|
paramInfo.defaultValue = "";
|
|
paramInfo.description = "Model name or value";
|
|
paramInfo.isSpiceInstanceParam = true;
|
|
|
|
paramInfos.push_back( paramInfo );
|
|
break;
|
|
|
|
case SPICE_PARAM::LIB:
|
|
paramInfo.name = "lib";
|
|
paramInfo.type = SIM_VALUE::TYPE_STRING;
|
|
paramInfo.unit = "";
|
|
paramInfo.category = SIM_MODEL::PARAM::CATEGORY::PRINCIPAL;
|
|
paramInfo.defaultValue = "";
|
|
paramInfo.description = "Library path to include";
|
|
paramInfo.isSpiceInstanceParam = true;
|
|
|
|
paramInfos.push_back( paramInfo );
|
|
break;
|
|
|
|
case SPICE_PARAM::_ENUM_END:
|
|
break;
|
|
}
|
|
}
|
|
|
|
return paramInfos;
|
|
}
|
|
|
|
|
|
template <typename T>
|
|
void SIM_MODEL_RAW_SPICE::readLegacyDataFields( unsigned aSymbolPinCount,
|
|
const std::vector<T>* aFields )
|
|
{
|
|
// Fill in the blanks with the legacy parameters.
|
|
|
|
if( GetParam( static_cast<int>( SPICE_PARAM::TYPE ) ).value->ToString() == "" )
|
|
{
|
|
SetParamValue( static_cast<int>( SPICE_PARAM::TYPE ),
|
|
GetFieldValue( aFields, LEGACY_TYPE_FIELD ) );
|
|
}
|
|
|
|
if( GetFieldValue( aFields, PINS_FIELD ) == "" )
|
|
parseLegacyPinsField( aSymbolPinCount, GetFieldValue( aFields, LEGACY_PINS_FIELD ) );
|
|
|
|
if( GetParam( static_cast<int>( SPICE_PARAM::MODEL ) ).value->ToString() == "" )
|
|
{
|
|
SetParamValue( static_cast<int>( SPICE_PARAM::MODEL ),
|
|
GetFieldValue( aFields, LEGACY_MODEL_FIELD ) );
|
|
}
|
|
|
|
// If model param is still empty, then use Value field.
|
|
if( GetParam( static_cast<int>( SPICE_PARAM::MODEL ) ).value->ToString() == "" )
|
|
{
|
|
SetParamValue( static_cast<int>( SPICE_PARAM::MODEL ),
|
|
GetFieldValue( aFields, SIM_MODEL::VALUE_FIELD ) );
|
|
}
|
|
|
|
if( GetParam( static_cast<int>( SPICE_PARAM::LIB ) ).value->ToString() == "" )
|
|
{
|
|
SetParamValue( static_cast<int>( SPICE_PARAM::LIB ),
|
|
GetFieldValue( aFields, LEGACY_LIB_FIELD ) );
|
|
}
|
|
}
|
|
|
|
|
|
void SIM_MODEL_RAW_SPICE::parseLegacyPinsField( unsigned aSymbolPinCount,
|
|
const std::string& aLegacyPinsField )
|
|
{
|
|
if( aLegacyPinsField == "" )
|
|
return;
|
|
|
|
// Initially set all pins to Not Connected to match the legacy behavior.
|
|
for( int modelPinIndex = 0; modelPinIndex < GetPinCount(); ++modelPinIndex )
|
|
SetPinSymbolPinNumber( static_cast<int>( modelPinIndex ), "" );
|
|
|
|
tao::pegtl::string_input<> in( aLegacyPinsField, PINS_FIELD );
|
|
std::unique_ptr<tao::pegtl::parse_tree::node> root;
|
|
|
|
try
|
|
{
|
|
root = tao::pegtl::parse_tree::parse<SIM_MODEL_RAW_SPICE_PARSER::legacyPinSequenceGrammar,
|
|
SIM_MODEL_RAW_SPICE_PARSER::legacyPinSequenceSelector>
|
|
( in );
|
|
}
|
|
catch( const tao::pegtl::parse_error& e )
|
|
{
|
|
THROW_IO_ERROR( e.what() );
|
|
}
|
|
|
|
for( int pinIndex = 0; pinIndex < static_cast<int>( root->children.size() ); ++pinIndex )
|
|
{
|
|
std::string symbolPinStr = root->children.at( pinIndex )->string();
|
|
int symbolPinIndex = std::stoi( symbolPinStr ) - 1;
|
|
|
|
if( symbolPinIndex < 0 || symbolPinIndex >= static_cast<int>( aSymbolPinCount ) )
|
|
THROW_IO_ERROR( wxString::Format( _( "Invalid symbol pin index: '%s'" ), symbolPinStr ) );
|
|
|
|
SetPinSymbolPinNumber( pinIndex, root->children.at( pinIndex )->string() );
|
|
}
|
|
}
|