240 lines
7.7 KiB
C++
240 lines
7.7 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
|
|
*/
|
|
|
|
#ifndef SIM_VALUE_H
|
|
#define SIM_VALUE_H
|
|
|
|
#include <wx/string.h>
|
|
#include <optional>
|
|
#include <complex>
|
|
#include <memory>
|
|
#include <pegtl.hpp>
|
|
|
|
// Undef some annoying defines in windows headers added by pegtl.hpp
|
|
// that can create issues in .cpp files, mainly on msys2
|
|
#if defined (__MINGW32__)
|
|
#if defined ( LoadLibrary )
|
|
#undef LoadLibrary
|
|
#endif
|
|
#if defined ( GetClassInfo )
|
|
#undef GetClassInfo
|
|
#endif
|
|
#endif
|
|
|
|
|
|
namespace SIM_VALUE_GRAMMAR
|
|
{
|
|
using namespace tao::pegtl;
|
|
|
|
enum class NOTATION
|
|
{
|
|
SI,
|
|
SPICE
|
|
};
|
|
}
|
|
|
|
|
|
class SIM_VALUE
|
|
{
|
|
public:
|
|
using NOTATION = SIM_VALUE_GRAMMAR::NOTATION;
|
|
|
|
// Names like BOOL, INT, FLOAT need to be prefixed or MS Windows compilers will complain (enum
|
|
// class doesn't help).
|
|
enum TYPE
|
|
{
|
|
TYPE_BOOL,
|
|
TYPE_INT,
|
|
TYPE_FLOAT,
|
|
TYPE_COMPLEX,
|
|
TYPE_STRING,
|
|
|
|
TYPE_BOOL_VECTOR,
|
|
TYPE_INT_VECTOR,
|
|
TYPE_FLOAT_VECTOR,
|
|
TYPE_COMPLEX_VECTOR
|
|
};
|
|
|
|
static std::unique_ptr<SIM_VALUE> Create( TYPE aType, const std::string& aString,
|
|
NOTATION aNotation = NOTATION::SI );
|
|
static std::unique_ptr<SIM_VALUE> Create( TYPE aType );
|
|
|
|
virtual ~SIM_VALUE() = default;
|
|
SIM_VALUE() = default;
|
|
|
|
virtual TYPE GetType() const = 0;
|
|
|
|
virtual bool HasValue() const = 0;
|
|
|
|
SIM_VALUE& operator=( const std::string& aString );
|
|
virtual SIM_VALUE& operator=( const SIM_VALUE& aValue ) = 0;
|
|
virtual bool operator==( const SIM_VALUE& aOther ) const = 0;
|
|
bool operator!=( const SIM_VALUE& aOther ) const;
|
|
|
|
virtual bool FromString( const std::string& aString, NOTATION aNotation = NOTATION::SI ) = 0;
|
|
virtual std::string ToString( NOTATION aNotation = NOTATION::SI ) const = 0;
|
|
std::string ToSpiceString() const { return ToString( NOTATION::SPICE ); }
|
|
|
|
// For parsers that don't accept strings with our suffixes.
|
|
virtual std::string ToSimpleString() const = 0;
|
|
};
|
|
|
|
|
|
template <typename T>
|
|
class SIM_VALUE_INST : public SIM_VALUE
|
|
{
|
|
public:
|
|
SIM_VALUE_INST() = default;
|
|
SIM_VALUE_INST( const T& aValue );
|
|
|
|
TYPE GetType() const override;
|
|
bool HasValue() const override;
|
|
|
|
// TODO: Don't pass aNotation. Make a FromSpiceString() function instead.
|
|
// TODO: Don't use FromString(). Use assignment. Values should be immutable.
|
|
bool FromString( const std::string& aString, NOTATION aNotation = NOTATION::SI ) override;
|
|
std::string ToString( NOTATION aNotation = NOTATION::SI ) const override;
|
|
std::string ToSimpleString() const override;
|
|
|
|
SIM_VALUE_INST& operator=( const SIM_VALUE& aOther ) override;
|
|
bool operator==( const T& aOther ) const;
|
|
bool operator==( const SIM_VALUE& aOther ) const override;
|
|
|
|
template <typename Type>
|
|
friend SIM_VALUE_INST<Type> operator+( const SIM_VALUE_INST<Type>& aLeft,
|
|
const SIM_VALUE_INST<Type>& aRight );
|
|
|
|
template <typename Type>
|
|
friend SIM_VALUE_INST<Type> operator-( const SIM_VALUE_INST<Type>& aLeft,
|
|
const SIM_VALUE_INST<Type>& aRight );
|
|
|
|
template <typename Type>
|
|
friend SIM_VALUE_INST<Type> operator*( const SIM_VALUE_INST<Type>& aLeft,
|
|
const SIM_VALUE_INST<Type>& aRight );
|
|
|
|
template <typename Type>
|
|
friend SIM_VALUE_INST<Type> operator/( const SIM_VALUE_INST<Type>& aLeft,
|
|
const SIM_VALUE_INST<Type>& aRight );
|
|
|
|
std::optional<T> Get() { return m_value; };
|
|
|
|
private:
|
|
std::string getMetricSuffix();
|
|
|
|
std::optional<T> m_value = std::nullopt;
|
|
};
|
|
|
|
typedef SIM_VALUE_INST<bool> SIM_VALUE_BOOL;
|
|
typedef SIM_VALUE_INST<int> SIM_VALUE_INT;
|
|
typedef SIM_VALUE_INST<double> SIM_VALUE_FLOAT;
|
|
typedef SIM_VALUE_INST<std::complex<double>> SIM_VALUE_COMPLEX;
|
|
typedef SIM_VALUE_INST<std::string> SIM_VALUE_STRING;
|
|
|
|
|
|
namespace SIM_VALUE_GRAMMAR
|
|
{
|
|
template <NOTATION Notation>
|
|
std::string allowedIntChars;
|
|
|
|
|
|
struct digits : plus<tao::pegtl::digit> {}; // For some reason it fails on just "digit".
|
|
|
|
struct sign : one<'+', '-'> {};
|
|
|
|
struct intPart : seq<opt<sign>, digits> {};
|
|
|
|
//struct fracPartPrefix : one<'.'> {};
|
|
struct fracPart : digits {};
|
|
//struct fracPartWithPrefix : seq<fracPartPrefix, fracPart> {};
|
|
|
|
|
|
template <SIM_VALUE::TYPE ValueType>
|
|
struct significand;
|
|
|
|
template <> struct significand<SIM_VALUE::TYPE_FLOAT> :
|
|
sor<seq<intPart, one<'.'>, fracPart>,
|
|
seq<intPart, one<'.'>>,
|
|
intPart,
|
|
seq<one<'.'>, fracPart>,
|
|
one<'.'>,
|
|
one<'-'>> {};
|
|
|
|
template <> struct significand<SIM_VALUE::TYPE_INT> : intPart {};
|
|
|
|
|
|
struct exponentPrefix : one<'e', 'E'> {};
|
|
struct exponent : seq<opt<sign>, opt<digits>> {};
|
|
struct exponentWithPrefix : seq<exponentPrefix, exponent> {};
|
|
|
|
|
|
template <SIM_VALUE::TYPE ValueType, NOTATION Notation>
|
|
struct metricSuffix;
|
|
|
|
template <> struct metricSuffix<SIM_VALUE::TYPE_INT, NOTATION::SI>
|
|
: one<'k', 'K', 'M', 'G', 'T', 'P', 'E'> {};
|
|
template <> struct metricSuffix<SIM_VALUE::TYPE_INT, NOTATION::SPICE>
|
|
: sor<TAO_PEGTL_ISTRING( "k" ),
|
|
TAO_PEGTL_ISTRING( "Meg" ),
|
|
TAO_PEGTL_ISTRING( "G" ),
|
|
TAO_PEGTL_ISTRING( "T" )> {};
|
|
|
|
template <> struct metricSuffix<SIM_VALUE::TYPE_FLOAT, NOTATION::SI>
|
|
: one<'a', 'f', 'p', 'n', 'u', 'm', 'k', 'K', 'M', 'G', 'T', 'P', 'E'> {};
|
|
template <> struct metricSuffix<SIM_VALUE::TYPE_FLOAT, NOTATION::SPICE>
|
|
: sor<TAO_PEGTL_ISTRING( "f" ),
|
|
TAO_PEGTL_ISTRING( "p" ),
|
|
TAO_PEGTL_ISTRING( "n" ),
|
|
TAO_PEGTL_ISTRING( "u" ),
|
|
TAO_PEGTL_ISTRING( "Meg" ), // "Meg" must be before "m".
|
|
TAO_PEGTL_ISTRING( "m" ),
|
|
//TAO_PEGTL_ISTRING( "mil" ),
|
|
TAO_PEGTL_ISTRING( "k" ),
|
|
TAO_PEGTL_ISTRING( "G" ),
|
|
TAO_PEGTL_ISTRING( "T" )> {};
|
|
|
|
|
|
template <NOTATION Notation>
|
|
struct garbageSuffix;
|
|
|
|
template <> struct garbageSuffix<NOTATION::SI> : seq<> {};
|
|
template <> struct garbageSuffix<NOTATION::SPICE> : star<alpha> {};
|
|
|
|
|
|
template <SIM_VALUE::TYPE ValueType, NOTATION Notation>
|
|
struct number : seq<opt<significand<ValueType>>,
|
|
opt<exponentWithPrefix>,
|
|
opt<metricSuffix<ValueType, Notation>>,
|
|
garbageSuffix<Notation>> {};
|
|
|
|
template <SIM_VALUE::TYPE ValueType, NOTATION Notation>
|
|
struct numberGrammar : must<number<ValueType, Notation>, tao::pegtl::eof> {};
|
|
|
|
|
|
bool IsValid( const std::string& aString,
|
|
SIM_VALUE::TYPE aValueType = SIM_VALUE::TYPE_FLOAT,
|
|
NOTATION aNotation = NOTATION::SI );
|
|
}
|
|
|
|
#endif // SIM_VALUE_H
|