sim_model_serializer.h

Go to the documentation of this file.

/*
 * 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 SIM_MODEL_SERIALIZER_H
#define SIM_MODEL_SERIALIZER_H
 
#include <sim/sim_model.h>
 
 
namespace SIM_MODEL_SERIALIZER_GRAMMAR
{
 using namespace SIM_VALUE_GRAMMAR;
 
 struct sep : plus<space> {};
 
 
 struct legacyPinNumber : digits {};
 struct legacyPinSequence : list<legacyPinNumber, sep> {};
 
 struct legacyPinSequenceGrammar : must<legacyPinSequence,
 tao::pegtl::eof> {};
 
 
 struct pinSymbolPinNumber : plus<not_at<sep>, not_one<'='>> {};
 struct pinName : plus<not_at<sep>, any> {};
 struct pinAssignment : seq<pinSymbolPinNumber,
 one<'='>,
 pinName> {};
 struct pinSequence : list<pinAssignment,
 sep> {};
 struct pinSequenceGrammar : must<opt<sep>,
 opt<pinSequence>,
 opt<sep>,
 tao::pegtl::eof> {};
 
 struct param : identifier {};
 
 struct unquotedString : plus<not_at<sep>, any> {};
 struct quotedStringContent : star<not_at<one<'"'>>, any> {}; // TODO: Allow escaping '"'.
 struct quotedString : seq<one<'"'>,
 quotedStringContent,
 one<'"'>> {};
 
 struct flagParam : sor<TAO_PEGTL_ISTRING( "off" ), // VDMOS
 TAO_PEGTL_ISTRING( "thermal" ), // VDMOS
 TAO_PEGTL_ISTRING( "xpart" )> {}; // BSIM1
 
 struct fieldParamValuePair : sor<flagParam,
 if_must<param,
 opt<sep>,
 one<'='>,
 opt<sep>,
 sor<quotedString,
 unquotedString>>> {};
 struct fieldParamValuePairs : list<fieldParamValuePair, sep> {};
 struct fieldParamValuePairsGrammar : must<opt<sep>,
 opt<fieldParamValuePairs>,
 opt<sep>,
 tao::pegtl::eof> {};
 
 struct fieldInferValue : sor<one<'R', 'C', 'L', 'V', 'I'>,
 number<SIM_VALUE::TYPE_FLOAT, NOTATION::SI>> {};
 struct fieldInferValueGrammar : must<opt<sep>,
 fieldInferValue,
 opt<sep>,
 tao::pegtl::eof> {};
 
 
 template <typename> inline constexpr const char* errorMessage = nullptr;
 template <> inline constexpr auto errorMessage<opt<sep>> = "";
 template <> inline constexpr auto errorMessage<opt<pinSequence>> = "";
 template <> inline constexpr auto errorMessage<one<'='>> =
 "expected '='";
 template <> inline constexpr auto errorMessage<sor<quotedString,
 unquotedString>> =
 "expected quoted or unquoted string";
 template <> inline constexpr auto errorMessage<fieldParamValuePairs> =
 "expected parameter=value pairs";
 template <> inline constexpr auto errorMessage<opt<fieldParamValuePairs>> = "";
 template <> inline constexpr auto errorMessage<fieldInferValue> =
 "expected 'R', 'C', 'L', 'V', 'I' or a number";
 template <> inline constexpr auto errorMessage<tao::pegtl::eof> =
 "expected end of string";
 
 struct error
 {
 template <typename Rule> static constexpr bool raise_on_failure = false;
 template <typename Rule> static constexpr auto message = errorMessage<Rule>;
 };
 
 template <typename Rule> using control = must_if<error>::control<Rule>;
}
 
 
class SIM_MODEL_SERIALIZER
{
public:
 static constexpr auto REFERENCE_FIELD = "Reference";
 static constexpr auto VALUE_FIELD = "Value";
 
 virtual ~SIM_MODEL_SERIALIZER() = default;
 SIM_MODEL_SERIALIZER( SIM_MODEL& aModel ) : m_model( aModel ) {}
 
 std::string GenerateDevice() const;
 std::string GenerateDeviceSubtype() const;
 std::string GenerateValue() const;
 std::string GenerateParams() const;
 std::string GeneratePins() const;
 std::string GenerateEnable() const;
 
 void ParseValue( const std::string& aValue );
 bool ParseParams( const std::string& aParams );
 void ParsePins( const std::string& aPins );
 void ParseEnable( const std::string& aEnable );
 
protected:
 std::string generateParamValuePair( const SIM_MODEL::PARAM& aParam ) const;
 
private:
 SIM_MODEL& m_model;
};
 
#endif // SIM_MODEL_SERIALIZER_H