parameters.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Jon Evans <[email protected]>
 * Copyright (C) 2020-2021 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 _PARAMETERS_H
#define _PARAMETERS_H

#include <string>
#include <utility>
#include <math/util.h>

#include <core/optional.h>
#include <settings/json_settings.h>


class PARAM_BASE
{
public:
 PARAM_BASE( std::string aJsonPath, bool aReadOnly ) :
 m_path( std::move( aJsonPath ) ),
 m_readOnly( aReadOnly )
 {}

 virtual ~PARAM_BASE() = default;

 virtual void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const = 0;

 virtual void Store( JSON_SETTINGS* aSettings ) const = 0;

 virtual void SetDefault() = 0;

 virtual bool MatchesFile( JSON_SETTINGS* aSettings ) const = 0;

 const std::string& GetJsonPath() const { return m_path; }

protected:
 std::string m_path;

 bool m_readOnly;
};


template<typename ValueType>
class PARAM : public PARAM_BASE
{
public:
 PARAM( const std::string& aJsonPath, ValueType* aPtr, ValueType aDefault,
 bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_min(),
 m_max(),
 m_use_minmax( false ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 PARAM( const std::string& aJsonPath, ValueType* aPtr, ValueType aDefault, ValueType aMin,
 ValueType aMax, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_min( aMin ),
 m_max( aMax ),
 m_use_minmax( true ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override
 {
 if( m_readOnly )
 return;

 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 {
 ValueType val = *optval;

 if( m_use_minmax )
 {
 if( m_max < val || val < m_min )
 val = m_default;
 }

 *m_ptr = val;
 }
 else if( aResetIfMissing )
 *m_ptr = m_default;
 }

 void Store( JSON_SETTINGS* aSettings ) const override
 {
 aSettings->Set<ValueType>( m_path, *m_ptr );
 }

 ValueType GetDefault() const
 {
 return m_default;
 }

 void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override
 {
 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 return *optval == *m_ptr;

 return false;
 }

private:
 ValueType m_min;
 ValueType m_max;
 bool m_use_minmax;

protected:
 ValueType* m_ptr;
 ValueType m_default;
};

class PARAM_PATH : public PARAM<wxString>
{
public:
 PARAM_PATH( const std::string& aJsonPath, wxString* aPtr, const wxString& aDefault,
 bool aReadOnly = false ) :
 PARAM( aJsonPath, aPtr, aDefault, aReadOnly )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override
 {
 if( m_readOnly )
 return;

 PARAM::Load( aSettings, aResetIfMissing );

 *m_ptr = fromFileFormat( *m_ptr );
 }

 void Store( JSON_SETTINGS* aSettings ) const override
 {
 aSettings->Set<wxString>( m_path, toFileFormat( *m_ptr ) );
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override
 {
 if( OPT<wxString> optval = aSettings->Get<wxString>( m_path ) )
 return fromFileFormat( *optval ) == *m_ptr;

 return false;
 }

private:
 wxString toFileFormat( const wxString& aString ) const
 {
 wxString ret = aString;
 ret.Replace( wxT( "\\" ), wxT( "/" ) );
 return ret;
 }

 wxString fromFileFormat( const wxString& aString ) const
 {
 wxString ret = aString;
#ifdef __WINDOWS__
 ret.Replace( wxT( "/" ), wxT( "\\" ) );
#endif
 return ret;
 }
};

template<typename EnumType>
class PARAM_ENUM : public PARAM_BASE
{
public:
 PARAM_ENUM( const std::string& aJsonPath, EnumType* aPtr, EnumType aDefault,
 EnumType aMin, EnumType aMax, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_min( aMin ),
 m_max( aMax ),
 m_default( aDefault )
 {
 }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override
 {
 if( m_readOnly )
 return;

 if( OPT<int> val = aSettings->Get<int>( m_path ) )
 {
 if( *val >= static_cast<int>( m_min ) && *val <= static_cast<int>( m_max ) )
 *m_ptr = static_cast<EnumType>( *val );
 else if( aResetIfMissing )
 *m_ptr = m_default;

 }
 else if( aResetIfMissing )
 *m_ptr = m_default;
 }

 void Store( JSON_SETTINGS* aSettings ) const override
 {
 aSettings->Set<int>( m_path, static_cast<int>( *m_ptr ) );
 }

 EnumType GetDefault() const
 {
 return m_default;
 }

 void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override
 {
 if( OPT<int> val = aSettings->Get<int>( m_path ) )
 return *val == static_cast<int>( *m_ptr );

 return false;
 }

private:
 EnumType* m_ptr;
 EnumType m_min;
 EnumType m_max;
 EnumType m_default;
};

template<typename ValueType>
class PARAM_LAMBDA : public PARAM_BASE
{
public:
 PARAM_LAMBDA( const std::string& aJsonPath, std::function<ValueType()> aGetter,
 std::function<void( ValueType )> aSetter, ValueType aDefault,
 bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_default( aDefault ),
 m_getter( aGetter ),
 m_setter( aSetter )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override;

 void Store( JSON_SETTINGS* aSettings ) const override
 {
 try
 {
 aSettings->Set<ValueType>( m_path, m_getter() );
 }
 catch( ... )
 {
 }
 }

 ValueType GetDefault() const
 {
 return m_default;
 }

 void SetDefault() override
 {
 m_setter( m_default );
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override;

private:
 ValueType m_default;

 std::function<ValueType()> m_getter;

 std::function<void( ValueType )> m_setter;
};


template<typename ValueType>
class PARAM_SCALED: public PARAM_BASE
{
public:
 PARAM_SCALED( const std::string& aJsonPath, ValueType* aPtr, ValueType aDefault,
 double aScale = 1.0, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault ),
 m_min(),
 m_max(),
 m_use_minmax( false ),
 m_scale( aScale )
 { }

 PARAM_SCALED( const std::string& aJsonPath, ValueType* aPtr, ValueType aDefault,
 ValueType aMin, ValueType aMax, double aScale = 1.0, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault ),
 m_min( aMin ),
 m_max( aMax ),
 m_use_minmax( true ),
 m_scale( aScale )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override
 {
 if( m_readOnly )
 return;

 double dval = m_default * m_scale;

 if( OPT<double> optval = aSettings->Get<double>( m_path ) )
 dval = *optval;
 else if( !aResetIfMissing )
 return;

 ValueType val = KiROUND<ValueType>( dval / m_scale );

 if( m_use_minmax )
 {
 if( val > m_max || val < m_min )
 val = m_default;
 }

 *m_ptr = val;
 }

 void Store( JSON_SETTINGS* aSettings) const override
 {
 aSettings->Set<double>( m_path, *m_ptr * m_scale );
 }

 ValueType GetDefault() const
 {
 return m_default;
 }

 virtual void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override
 {
 if( OPT<double> optval = aSettings->Get<double>( m_path ) )
 return *optval == ( *m_ptr * m_scale );

 return false;
 }

private:
 ValueType* m_ptr;
 ValueType m_default;
 ValueType m_min;
 ValueType m_max;
 bool m_use_minmax;
 double m_scale;
};

template<typename Type>
class PARAM_LIST : public PARAM_BASE
{
public:
 PARAM_LIST( const std::string& aJsonPath, std::vector<Type>* aPtr,
 std::initializer_list<Type> aDefault, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 PARAM_LIST( const std::string& aJsonPath, std::vector<Type>* aPtr,
 std::vector<Type> aDefault, bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override;

 void Store( JSON_SETTINGS* aSettings) const override;

 void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override;

protected:
 std::vector<Type>* m_ptr;

 std::vector<Type> m_default;
};

class PARAM_PATH_LIST : public PARAM_LIST<wxString>
{
public:
 PARAM_PATH_LIST( const std::string& aJsonPath, std::vector<wxString>* aPtr,
 std::initializer_list<wxString> aDefault, bool aReadOnly = false ) :
 PARAM_LIST( aJsonPath, aPtr, aDefault, aReadOnly )
 { }

 PARAM_PATH_LIST( const std::string& aJsonPath, std::vector<wxString>* aPtr,
 std::vector<wxString> aDefault, bool aReadOnly = false ) :
 PARAM_LIST( aJsonPath, aPtr, aDefault, aReadOnly )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override
 {
 if( m_readOnly )
 return;

 PARAM_LIST::Load( aSettings, aResetIfMissing );

 for( size_t i = 0; i < m_ptr->size(); i++ )
 ( *m_ptr )[i] = fromFileFormat( ( *m_ptr )[i] );
 }

 void Store( JSON_SETTINGS* aSettings) const override;

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override;

private:
 wxString toFileFormat( const wxString& aString ) const
 {
 wxString ret = aString;
 ret.Replace( wxT( "\\" ), wxT( "/" ) );
 return ret;
 }

 wxString fromFileFormat( const wxString& aString ) const
 {
 wxString ret = aString;
#ifdef __WINDOWS__
 ret.Replace( wxT( "/" ), wxT( "\\" ) );
#endif
 return ret;
 }
};

template<typename Value>
class PARAM_MAP : public PARAM_BASE
{
public:
 PARAM_MAP( const std::string& aJsonPath, std::map<std::string, Value>* aPtr,
 std::initializer_list<std::pair<const std::string, Value>> aDefault,
 bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override;

 void Store( JSON_SETTINGS* aSettings) const override;

 virtual void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override;

private:
 std::map<std::string, Value>* m_ptr;

 std::map<std::string, Value> m_default;
};


class PARAM_WXSTRING_MAP : public PARAM_BASE
{
public:
 PARAM_WXSTRING_MAP( const std::string& aJsonPath, std::map<wxString, wxString>* aPtr,
 std::initializer_list<std::pair<const wxString, wxString>> aDefault,
 bool aReadOnly = false ) :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

 void Load( JSON_SETTINGS* aSettings, bool aResetIfMissing = true ) const override;

 void Store( JSON_SETTINGS* aSettings) const override;

 virtual void SetDefault() override
 {
 *m_ptr = m_default;
 }

 bool MatchesFile( JSON_SETTINGS* aSettings ) const override;

private:
 std::map<wxString, wxString>* m_ptr;

 std::map<wxString, wxString> m_default;
};

#endif