haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sim: Move SIM_LIBRARY_SPICE parsing facilities to a new class 

This leaves SIM_LIBRARY_SPICE very small, but it will grow larger later.
This commit is contained in:
Mikolaj Wielgus 2022-09-20 08:16:40 +02:00
parent 7e089182b8
commit 2bf6791352
5 changed files with 158 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
eeschema/CMakeLists.txt
View File

@ -340,6 +340,7 @@ if( KICAD_SPICE )
sim/sim_plot_panel.cpp sim/sim_plot_panel.cpp
sim/sim_property.cpp sim/sim_property.cpp
sim/sim_workbook.cpp sim/sim_workbook.cpp
sim/spice_library_parser.cpp
sim/spice_model_parser.cpp sim/spice_model_parser.cpp
sim/spice_simulator.cpp sim/spice_simulator.cpp
sim/spice_value.cpp sim/spice_value.cpp

74
eeschema/sim/sim_library_spice.cpp
View File

@ -24,81 +24,19 @@
#include <sim/sim_library_spice.h> #include <sim/sim_library_spice.h>
#include <sim/sim_model_spice.h> #include <sim/sim_model_spice.h>
#include <sim/spice_grammar.h>
#include <ki_exception.h>
#include <locale_io.h>
#include <pegtl.hpp>
#include <pegtl/contrib/parse_tree.hpp>
namespace SIM_LIBRARY_SPICE_PARSER SIM_LIBRARY_SPICE::SIM_LIBRARY_SPICE() :
SIM_LIBRARY(),
m_spiceLibraryParser( std::make_unique<SPICE_LIBRARY_PARSER>( *this ) )
{ {
using namespace SPICE_GRAMMAR; }
// TODO: unknownLine is already handled in spiceUnit.
struct libraryGrammar : spiceSourceGrammar {};
template <typename Rule> struct librarySelector : std::false_type {};
template <> struct librarySelector<modelUnit> : std::true_type {};
template <> struct librarySelector<modelName> : std::true_type {};
// For debugging.
template <> struct librarySelector<unknownLine> : std::true_type {};
};
void SIM_LIBRARY_SPICE::ReadFile( const wxString& aFilePath ) void SIM_LIBRARY_SPICE::ReadFile( const wxString& aFilePath )
{ {
LOCALE_IO toggle; SIM_LIBRARY::ReadFile( aFilePath );
m_spiceLibraryParser->ReadFile( aFilePath );
try
{
tao::pegtl::file_input in( aFilePath.ToStdString() );
auto root = tao::pegtl::parse_tree::parse<SIM_LIBRARY_SPICE_PARSER::libraryGrammar,
SIM_LIBRARY_SPICE_PARSER::librarySelector,
tao::pegtl::nothing,
SIM_LIBRARY_SPICE_PARSER::control>
( in );
SIM_LIBRARY::ReadFile( aFilePath );
m_models.clear();
m_modelNames.clear();
for( const auto& node : root->children )
{
if( node->is_type<SIM_LIBRARY_SPICE_PARSER::modelUnit>() )
{
m_models.push_back( SIM_MODEL_SPICE::Create( node->string() ) );
if( node->children.size() < 1
|| !node->children.at( 0 )->is_type<SIM_LIBRARY_SPICE_PARSER::modelName>() )
{
THROW_IO_ERROR( wxString::Format( "Model name token not found" ) );
}
m_modelNames.emplace_back( node->children.at( 0 )->string() );
}
else if( node->is_type<SIM_LIBRARY_SPICE_PARSER::unknownLine>() )
{
// Do nothing.
}
else
{
wxFAIL_MSG( "Unhandled parse tree node" );
}
}
}
catch( const std::filesystem::filesystem_error& e )
{
THROW_IO_ERROR( e.what() );
}
catch( const tao::pegtl::parse_error& e )
{
THROW_IO_ERROR( e.what() );
}
} }

10
eeschema/sim/sim_library_spice.h
View File

@ -26,18 +26,24 @@
#define SIM_LIBRARY_SPICE_H #define SIM_LIBRARY_SPICE_H
#include <sim/sim_library.h> #include <sim/sim_library.h>
#include <sim/spice_library_parser.h>
class SIM_LIBRARY_SPICE : public SIM_LIBRARY class SIM_LIBRARY_SPICE : public SIM_LIBRARY
{ {
// We'll make SIM_LIBRARY have no subclasses probably.
public: public:
friend class SPICE_LIBRARY_PARSER;
SIM_LIBRARY_SPICE();
// @copydoc SIM_LIBRARY::ReadFile() // @copydoc SIM_LIBRARY::ReadFile()
void ReadFile( const wxString& aFilePath ) override; void ReadFile( const wxString& aFilePath ) override;
// @copydoc SIM_LIBRARY::WriteFile() // @copydoc SIM_LIBRARY::WriteFile()
void WriteFile( const wxString& aFilePath ) override; void WriteFile( const wxString& aFilePath ) override;
private:
std::unique_ptr<SPICE_LIBRARY_PARSER> m_spiceLibraryParser;
}; };
#endif // SIM_LIBRARY_SPICE_H #endif // SIM_LIBRARY_SPICE_H

99
eeschema/sim/spice_library_parser.cpp Normal file
View File

@ -0,0 +1,99 @@
/*
* 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/spice_library_parser.h>
#include <sim/spice_grammar.h>
#include <sim/sim_library_spice.h>
#include <sim/sim_model_spice.h>
#include <ki_exception.h>
#include <pegtl.hpp>
#include <pegtl/contrib/parse_tree.hpp>
namespace SIM_LIBRARY_SPICE_PARSER
{
using namespace SPICE_GRAMMAR;
// TODO: unknownLine is already handled in spiceUnit.
struct libraryGrammar : spiceSourceGrammar {};
template <typename Rule> struct librarySelector : std::false_type {};
template <> struct librarySelector<modelUnit> : std::true_type {};
template <> struct librarySelector<modelName> : std::true_type {};
// For debugging.
template <> struct librarySelector<unknownLine> : std::true_type {};
};
void SPICE_LIBRARY_PARSER::ReadFile( const wxString& aFilePath )
{
try
{
tao::pegtl::file_input in( aFilePath.ToStdString() );
auto root = tao::pegtl::parse_tree::parse<SIM_LIBRARY_SPICE_PARSER::libraryGrammar,
SIM_LIBRARY_SPICE_PARSER::librarySelector,
tao::pegtl::nothing,
SIM_LIBRARY_SPICE_PARSER::control>
( in );
m_library.m_models.clear();
m_library.m_modelNames.clear();
for( const auto& node : root->children )
{
if( node->is_type<SIM_LIBRARY_SPICE_PARSER::modelUnit>() )
{
m_library.m_models.push_back( SIM_MODEL_SPICE::Create( node->string() ) );
if( node->children.size() < 1
|| !node->children.at( 0 )->is_type<SIM_LIBRARY_SPICE_PARSER::modelName>() )
{
THROW_IO_ERROR( wxString::Format( "Model name token not found" ) );
}
m_library.m_modelNames.emplace_back( node->children.at( 0 )->string() );
}
else if( node->is_type<SIM_LIBRARY_SPICE_PARSER::unknownLine>() )
{
// Do nothing.
}
else
{
wxFAIL_MSG( "Unhandled parse tree node" );
}
}
}
catch( const std::filesystem::filesystem_error& e )
{
THROW_IO_ERROR( e.what() );
}
catch( const tao::pegtl::parse_error& e )
{
THROW_IO_ERROR( e.what() );
}
}

44
eeschema/sim/spice_library_parser.h Normal file
View File

@ -0,0 +1,44 @@
/*
* 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
*/
#ifndef SPICE_LIBRARY_PARSER_H
#define SPICE_LIBRARY_PARSER_H
#include <wx/string.h>
class SIM_LIBRARY_SPICE;
class SPICE_LIBRARY_PARSER
{
public:
SPICE_LIBRARY_PARSER( SIM_LIBRARY_SPICE& aLibrary ) : m_library( aLibrary ) {}
virtual void ReadFile( const wxString& aFilePath );
private:
SIM_LIBRARY_SPICE& m_library;
};
#endif // SPICE_LIBRARY_PARSER_H