kicad/common/settings/nested_settings.cpp

169 lines
4.7 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
* Copyright (C) 2020 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/>.
*/
#include <wx/log.h>
#include <settings/json_settings_internals.h>
#include <settings/nested_settings.h>
#include <locale_io.h>
NESTED_SETTINGS::NESTED_SETTINGS( const std::string& aName, int aVersion, JSON_SETTINGS* aParent,
const std::string& aPath ) :
JSON_SETTINGS( aName, SETTINGS_LOC::NESTED, aVersion ),
m_parent( aParent ), m_path( aPath )
{
SetParent( aParent );
}
NESTED_SETTINGS::~NESTED_SETTINGS()
{
if( m_parent )
m_parent->ReleaseNestedSettings( this );
}
bool NESTED_SETTINGS::LoadFromFile( const wxString& aDirectory )
{
m_internals->clear();
bool success = false;
if( m_parent )
{
nlohmann::json::json_pointer ptr = m_internals->PointerFromString( m_path );
if( m_parent->m_internals->contains( ptr ) )
{
try
{
2021-06-06 12:38:48 +00:00
m_internals->update( m_parent->m_internals->at( ptr ) );
wxLogTrace( traceSettings, wxT( "Loaded NESTED_SETTINGS %s" ), GetFilename() );
success = true;
}
catch( ... )
{
wxLogTrace( traceSettings, wxT( "NESTED_SETTINGS %s: Could not load from %s at %s" ),
2020-09-11 01:28:49 +00:00
m_filename, m_parent->GetFilename(), m_path );
}
}
}
2020-09-11 01:28:49 +00:00
if( success )
{
int filever = -1;
try
2020-09-11 01:28:49 +00:00
{
filever = m_internals->Get<int>( "meta.version" );
2020-09-11 01:28:49 +00:00
}
catch( ... )
2020-09-11 01:28:49 +00:00
{
wxLogTrace( traceSettings, wxT( "%s: nested settings version could not be read!" ),
m_filename );
2020-09-11 01:28:49 +00:00
success = false;
}
if( filever >= 0 && filever < m_schemaVersion )
{
wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
2020-09-11 01:28:49 +00:00
m_filename, filever, m_schemaVersion );
if( !Migrate() )
{
wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
2020-09-11 01:28:49 +00:00
success = false;
}
}
else if( filever > m_schemaVersion )
{
wxLogTrace( traceSettings,
wxT( "%s: warning: nested settings version %d is newer than latest (%d)" ),
2020-09-11 01:28:49 +00:00
m_filename, filever, m_schemaVersion );
}
else if( filever >= 0 )
{
wxLogTrace( traceSettings, wxT( "%s: schema version %d is current" ),
m_filename, filever );
}
2020-09-11 01:28:49 +00:00
}
Load();
return success;
}
bool NESTED_SETTINGS::SaveToFile( const wxString& aDirectory, bool aForce )
{
if( !m_parent )
return false;
LOCALE_IO dummy;
try
{
bool modified = Store();
auto jsonObjectInParent = m_parent->GetJson( m_path );
if( !jsonObjectInParent )
modified = true;
else if( !nlohmann::json::diff( *m_internals, jsonObjectInParent.value() ).empty() )
modified = true;
if( modified || aForce )
{
( *m_parent->m_internals )[m_path].update( *m_internals );
2023-01-17 12:42:30 +00:00
wxLogTrace( traceSettings, wxS( "Stored NESTED_SETTINGS %s with schema %d" ),
GetFilename(),
m_schemaVersion );
}
return modified;
}
catch( ... )
{
2023-01-17 12:42:30 +00:00
wxLogTrace( traceSettings, wxS( "NESTED_SETTINGS %s: Could not store to %s at %s" ),
m_filename,
m_parent->GetFilename(),
m_path );
return false;
}
}
void NESTED_SETTINGS::SetParent( JSON_SETTINGS* aParent, bool aLoadFromFile )
{
m_parent = aParent;
if( m_parent )
{
m_parent->AddNestedSettings( this );
// In case we were created after the parent's ctor
if( aLoadFromFile )
LoadFromFile();
}
}