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

Sim Model Editor: Don't use shared_ptr to hack around lifetimes

This commit is contained in:
Mikolaj Wielgus 2022-11-12 03:09:26 +01:00
parent d9987e9569
commit fef6eaa8ba
3 changed files with 66 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
eeschema/dialogs/dialog_sim_model.cpp
View File

@ -126,6 +126,18 @@ DIALOG_SIM_MODEL<T>::DIALOG_SIM_MODEL( wxWindow* aParent, SCH_SYMBOL& aSymbol,
template <typename T> template <typename T>
DIALOG_SIM_MODEL<T>::~DIALOG_SIM_MODEL() DIALOG_SIM_MODEL<T>::~DIALOG_SIM_MODEL()
{ {
// Disable all properties. This is necessary because some of their methods are called after
// destruction of DIALOG_SIM_MODEL, oddly. When disabled, they never access their models.
for( wxPropertyGridIterator it = m_paramGrid->GetIterator(); !it.AtEnd(); ++it )
{
SIM_PROPERTY* prop = dynamic_cast<SIM_PROPERTY*>( *it );
if( !prop )
continue;
prop->Disable();
}
// Delete the GRID_TRICKS. // Delete the GRID_TRICKS.
m_pinAssignmentsGrid->PopEventHandler( true ); m_pinAssignmentsGrid->PopEventHandler( true );
@ -775,19 +787,18 @@ wxPGProperty* DIALOG_SIM_MODEL<T>::newParamProperty( int aParamIndex ) const
{ {
case SIM_VALUE::TYPE_BOOL: case SIM_VALUE::TYPE_BOOL:
// TODO. // TODO.
prop = new SIM_BOOL_PROPERTY( paramDescription, param.info.name, m_library, prop = new SIM_BOOL_PROPERTY( paramDescription, param.info.name, curModel(), aParamIndex );
curModelSharedPtr(), aParamIndex );
prop->SetAttribute( wxPG_BOOL_USE_CHECKBOX, true ); prop->SetAttribute( wxPG_BOOL_USE_CHECKBOX, true );
break; break;
case SIM_VALUE::TYPE_INT: case SIM_VALUE::TYPE_INT:
prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, m_library, prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, curModel(),
curModelSharedPtr(), aParamIndex, SIM_VALUE::TYPE_INT ); aParamIndex, SIM_VALUE::TYPE_INT );
break; break;
case SIM_VALUE::TYPE_FLOAT: case SIM_VALUE::TYPE_FLOAT:
prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, m_library, prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, curModel(),
curModelSharedPtr(), aParamIndex, SIM_VALUE::TYPE_FLOAT ); aParamIndex, SIM_VALUE::TYPE_FLOAT );
break; break;
//case TYPE_COMPLEX: //case TYPE_COMPLEX:
@ -796,15 +807,13 @@ wxPGProperty* DIALOG_SIM_MODEL<T>::newParamProperty( int aParamIndex ) const
case SIM_VALUE::TYPE_STRING: case SIM_VALUE::TYPE_STRING:
if( param.info.enumValues.empty() ) if( param.info.enumValues.empty() )
{ {
prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, m_library, prop = new SIM_STRING_PROPERTY( paramDescription, param.info.name, curModel(),
curModelSharedPtr(), aParamIndex, aParamIndex, SIM_VALUE::TYPE_STRING );
SIM_VALUE::TYPE_STRING );
} }
else else
{ {
prop = new SIM_ENUM_PROPERTY( paramDescription, param.info.name, m_library, prop = new SIM_ENUM_PROPERTY( paramDescription, param.info.name, curModel(),
curModelSharedPtr(), aParamIndex, aParamIndex, SIM_VALUE::TYPE_STRING );
SIM_VALUE::TYPE_STRING );
} }
break; break;

62
eeschema/sim/sim_property.cpp
View File

@ -251,25 +251,28 @@ wxTextEntry* SIM_STRING_VALIDATOR::getTextEntry()
} }
SIM_PROPERTY::SIM_PROPERTY( std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_PROPERTY::SIM_PROPERTY( SIM_MODEL& aModel, int aParamIndex ) :
std::shared_ptr<SIM_MODEL> aModel, m_model( aModel ),
int aParamIndex ) m_paramIndex( aParamIndex ),
: m_library( std::move( aLibrary ) ), m_disabled( false )
m_model( std::move( aModel ) ),
m_paramIndex( aParamIndex )
{ {
} }
void SIM_PROPERTY::Disable()
{
m_disabled = true;
}
SIM_BOOL_PROPERTY::SIM_BOOL_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_BOOL_PROPERTY::SIM_BOOL_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex ) int aParamIndex )
: wxBoolProperty( aLabel, aName ), : wxBoolProperty( aLabel, aName ),
SIM_PROPERTY( aLibrary, aModel, aParamIndex ) SIM_PROPERTY( aModel, aParamIndex )
{ {
auto simValue = dynamic_cast<SIM_VALUE_INST<bool>*>( auto simValue = dynamic_cast<SIM_VALUE_INST<bool>*>(
m_model->GetParam( m_paramIndex ).value.get() ); m_model.GetParam( m_paramIndex ).value.get() );
wxCHECK( simValue, /*void*/ ); wxCHECK( simValue, /*void*/ );
@ -287,26 +290,28 @@ void SIM_BOOL_PROPERTY::OnSetValue()
{ {
wxPGProperty::OnSetValue(); wxPGProperty::OnSetValue();
if( m_disabled )
return;
auto simValue = dynamic_cast<SIM_VALUE_INST<bool>*>( auto simValue = dynamic_cast<SIM_VALUE_INST<bool>*>(
m_model->GetParam( m_paramIndex ).value.get() ); m_model.GetParam( m_paramIndex ).value.get() );
wxCHECK( simValue, /*void*/ ); wxCHECK( simValue, /*void*/ );
if( m_model->GetBaseModel() && *simValue == m_value.GetBool() ) if( m_model.GetBaseModel() && *simValue == m_value.GetBool() )
m_model->SetParamValue( m_paramIndex, "" ); m_model.SetParamValue( m_paramIndex, "" );
else else
m_model->SetParamValue( m_paramIndex, m_value.GetBool() ? "1" : "0" ); m_model.SetParamValue( m_paramIndex, m_value.GetBool() ? "1" : "0" );
} }
SIM_STRING_PROPERTY::SIM_STRING_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_STRING_PROPERTY::SIM_STRING_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex, int aParamIndex,
SIM_VALUE::TYPE aValueType, SIM_VALUE::TYPE aValueType,
SIM_VALUE_GRAMMAR::NOTATION aNotation ) SIM_VALUE_GRAMMAR::NOTATION aNotation )
: wxStringProperty( aLabel, aName ), : wxStringProperty( aLabel, aName ),
SIM_PROPERTY( aLibrary, aModel, aParamIndex ), SIM_PROPERTY( aModel, aParamIndex ),
m_valueType( aValueType ), m_valueType( aValueType ),
m_notation( aNotation ) m_notation( aNotation )
{ {
@ -323,15 +328,18 @@ wxValidator* SIM_STRING_PROPERTY::DoGetValidator() const
bool SIM_STRING_PROPERTY::StringToValue( wxVariant& aVariant, const wxString& aText, bool SIM_STRING_PROPERTY::StringToValue( wxVariant& aVariant, const wxString& aText,
int aArgFlags ) const int aArgFlags ) const
{ {
wxString baseParamValue = m_model->GetBaseParam( m_paramIndex ).value->ToString(); if( m_disabled )
return false;
wxString baseParamValue = m_model.GetBaseParam( m_paramIndex ).value->ToString();
aVariant = aText; aVariant = aText;
// TODO: Don't use string comparison. // TODO: Don't use string comparison.
if( m_model->GetBaseModel() && ( aText == "" || aText == baseParamValue ) ) if( m_model.GetBaseModel() && ( aText == "" || aText == baseParamValue ) )
{ {
try try
{ {
m_model->SetParamValue( m_paramIndex, "" ); // Nullify. m_model.SetParamValue( m_paramIndex, "" ); // Nullify.
} }
catch( const IO_ERROR& ) catch( const IO_ERROR& )
{ {
@ -342,7 +350,7 @@ bool SIM_STRING_PROPERTY::StringToValue( wxVariant& aVariant, const wxString& aT
} }
else else
{ {
m_model->SetParamValue( m_paramIndex, std::string( aText.ToUTF8() ) ); m_model.SetParamValue( m_paramIndex, std::string( aText.ToUTF8() ) );
aVariant = GetParam().value->ToString(); aVariant = GetParam().value->ToString();
} }
@ -362,14 +370,13 @@ static wxArrayString convertStringsToWx( const std::vector<std::string>& aString
SIM_ENUM_PROPERTY::SIM_ENUM_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_ENUM_PROPERTY::SIM_ENUM_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex, int aParamIndex,
SIM_VALUE::TYPE aValueType, SIM_VALUE::TYPE aValueType,
SIM_VALUE_GRAMMAR::NOTATION aNotation ) SIM_VALUE_GRAMMAR::NOTATION aNotation )
: wxEnumProperty( aLabel, aName, : wxEnumProperty( aLabel, aName,
convertStringsToWx( aModel->GetParam( aParamIndex ).info.enumValues ) ), convertStringsToWx( aModel.GetParam( aParamIndex ).info.enumValues ) ),
SIM_PROPERTY( aLibrary, aModel, aParamIndex ) SIM_PROPERTY( aModel, aParamIndex )
{ {
auto it = std::find( GetParam().info.enumValues.begin(), GetParam().info.enumValues.end(), auto it = std::find( GetParam().info.enumValues.begin(), GetParam().info.enumValues.end(),
GetParam().value->ToString() ); GetParam().value->ToString() );
@ -381,6 +388,9 @@ SIM_ENUM_PROPERTY::SIM_ENUM_PROPERTY( const wxString& aLabel, const wxString& aN
bool SIM_ENUM_PROPERTY::IntToValue( wxVariant& aVariant, int aNumber, int aArgFlags ) const bool SIM_ENUM_PROPERTY::IntToValue( wxVariant& aVariant, int aNumber, int aArgFlags ) const
{ {
m_model->SetParamValue( m_paramIndex, GetParam().info.enumValues.at( aNumber ) ); if( m_disabled )
return false;
m_model.SetParamValue( m_paramIndex, GetParam().info.enumValues.at( aNumber ) );
return wxEnumProperty::IntToValue( aVariant, aNumber, aArgFlags ); return wxEnumProperty::IntToValue( aVariant, aNumber, aArgFlags );
} }

21
eeschema/sim/sim_property.h
View File

@ -82,16 +82,16 @@ private:
class SIM_PROPERTY class SIM_PROPERTY
{ {
public: public:
SIM_PROPERTY( std::shared_ptr<SIM_LIBRARY> aLibrary, std::shared_ptr<SIM_MODEL> aModel, SIM_PROPERTY( SIM_MODEL& aModel, int aParamIndex );
int aParamIndex );
const SIM_MODEL::PARAM& GetParam() const { return m_model->GetParam( m_paramIndex ); } void Disable();
const SIM_MODEL::PARAM& GetParam() const { return m_model.GetParam( m_paramIndex ); }
protected: protected:
std::shared_ptr<SIM_LIBRARY> m_library; // We hold a shared_ptr to SIM_LIBRARY to prevent its SIM_MODEL& m_model;
// deallocation during this object's lifetime.
std::shared_ptr<SIM_MODEL> m_model;
int m_paramIndex; int m_paramIndex;
bool m_disabled; // If true, never access the models.
}; };
@ -99,8 +99,7 @@ class SIM_BOOL_PROPERTY : public wxBoolProperty, public SIM_PROPERTY
{ {
public: public:
SIM_BOOL_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_BOOL_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex ); int aParamIndex );
wxValidator* DoGetValidator() const override; wxValidator* DoGetValidator() const override;
@ -115,8 +114,7 @@ public:
// We pass shared_ptrs because we need to make sure they are destroyed only after the last time // We pass shared_ptrs because we need to make sure they are destroyed only after the last time
// SIM_PROPERTY uses them. // SIM_PROPERTY uses them.
SIM_STRING_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_STRING_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex, int aParamIndex,
SIM_VALUE::TYPE aValueType = SIM_VALUE::TYPE_FLOAT, SIM_VALUE::TYPE aValueType = SIM_VALUE::TYPE_FLOAT,
SIM_VALUE_GRAMMAR::NOTATION aNotation = SIM_VALUE_GRAMMAR::NOTATION::SI ); SIM_VALUE_GRAMMAR::NOTATION aNotation = SIM_VALUE_GRAMMAR::NOTATION::SI );
@ -136,8 +134,7 @@ class SIM_ENUM_PROPERTY : public wxEnumProperty, public SIM_PROPERTY
{ {
public: public:
SIM_ENUM_PROPERTY( const wxString& aLabel, const wxString& aName, SIM_ENUM_PROPERTY( const wxString& aLabel, const wxString& aName,
std::shared_ptr<SIM_LIBRARY> aLibrary, SIM_MODEL& aModel,
std::shared_ptr<SIM_MODEL> aModel,
int aParamIndex, int aParamIndex,
SIM_VALUE::TYPE aValueType = SIM_VALUE::TYPE_FLOAT, SIM_VALUE::TYPE aValueType = SIM_VALUE::TYPE_FLOAT,
SIM_VALUE_GRAMMAR::NOTATION aNotation = SIM_VALUE_GRAMMAR::NOTATION::SI ); SIM_VALUE_GRAMMAR::NOTATION aNotation = SIM_VALUE_GRAMMAR::NOTATION::SI );