KiCad PCB EDA Suite
PROJECT_FILE Class Reference

PROJECT_FILE is the backing store for a PROJECT, in JSON format. More...

#include <project_file.h>

Inheritance diagram for PROJECT_FILE:
JSON_SETTINGS

Public Member Functions

 PROJECT_FILE (const wxString &aFullPath)
 Constructs the project file for a project. More...
 
virtual ~PROJECT_FILE ()=default
 
virtual bool MigrateFromLegacy (wxConfigBase *aCfg) override
 Migrates from wxConfig to JSON-based configuration. More...
 
bool SaveToFile (const wxString &aDirectory="", bool aForce=false) override
 
void SetProject (PROJECT *aProject)
 
std::vector< FILE_INFO_PAIR > & GetSheets ()
 
std::vector< FILE_INFO_PAIR > & GetBoards ()
 
NET_SETTINGSNetSettings ()
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
bool IsDefault (const std::string &aParamName)
 Checks if the current state of a parameter matches its default value. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present. More...
 

Public Attributes

std::vector< wxString > m_PinnedSymbolLibs
 Below are project-level settings that have not been moved to a dedicated file. More...
 
std::vector< wxString > m_PinnedFootprintLibs
 The list of pinned footprint libraries. More...
 
std::map< wxString, wxString > m_TextVars
 
ERC_SETTINGSm_ErcSettings
 Eeschema params. More...
 
SCHEMATIC_SETTINGSm_SchematicSettings
 
wxString m_LegacyLibDir
 
wxArrayString m_LegacyLibNames
 
std::vector< wxString > m_EquivalenceFiles
 CvPcb params. More...
 
wxString m_BoardPageLayoutDescrFile
 PcbNew params. More...
 
wxString m_PcbLastPath [LAST_PATH_SIZE]
 MRU path storage. More...
 
BOARD_DESIGN_SETTINGSm_BoardSettings
 Board design settings for this project's board. More...
 
std::shared_ptr< NET_SETTINGSm_NetSettings
 Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board. More...
 
std::vector< LAYER_PRESETm_LayerPresets
 List of stored layer presets. More...
 

Protected Member Functions

wxString getFileExt () const override
 
wxString getLegacyFileExt () const override
 
void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 

Private Attributes

std::vector< FILE_INFO_PAIRm_sheets
 An list of schematic sheets in this project. More...
 
std::vector< FILE_INFO_PAIRm_boards
 A list of board files in this project. More...
 
PROJECTm_project
 A link to the owning PROJECT. More...
 

Detailed Description

PROJECT_FILE is the backing store for a PROJECT, in JSON format.

There is either zero or one PROJECT_FILE for every PROJECT (you can have a dummy PROJECT that has no file)

Definition at line 62 of file project_file.h.

Constructor & Destructor Documentation

◆ PROJECT_FILE()

PROJECT_FILE::PROJECT_FILE ( const wxString &  aFullPath)

Constructs the project file for a project.

Parameters
aFullPathis the full disk path to the project

Definition at line 36 of file project_file.cpp.

36  :
38  m_sheets(),
39  m_boards(),
40  m_project( nullptr ),
41  m_ErcSettings( nullptr ),
42  m_SchematicSettings( nullptr ),
44 {
45  // Keep old files around
47 
48  m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "sheets", &m_sheets, {} ) );
49 
50  m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "boards", &m_boards, {} ) );
51 
52  m_params.emplace_back( new PARAM_WXSTRING_MAP( "text_variables", &m_TextVars, {} ) );
53 
54  m_params.emplace_back(
55  new PARAM_LIST<wxString>( "libraries.pinned_symbol_libs", &m_PinnedSymbolLibs, {} ) );
56 
57  m_params.emplace_back( new PARAM_LIST<wxString>(
58  "libraries.pinned_footprint_libs", &m_PinnedFootprintLibs, {} ) );
59 
60  m_params.emplace_back(
61  new PARAM_PATH_LIST( "cvpcb.equivalence_files", &m_EquivalenceFiles, {} ) );
62 
63  m_params.emplace_back(
64  new PARAM_PATH( "pcbnew.page_layout_descr_file", &m_BoardPageLayoutDescrFile, "" ) );
65 
66  m_params.emplace_back(
67  new PARAM_PATH( "pcbnew.last_paths.netlist", &m_PcbLastPath[LAST_PATH_NETLIST], "" ) );
68 
69  m_params.emplace_back(
70  new PARAM_PATH( "pcbnew.last_paths.step", &m_PcbLastPath[LAST_PATH_STEP], "" ) );
71 
72  m_params.emplace_back(
73  new PARAM_PATH( "pcbnew.last_paths.idf", &m_PcbLastPath[LAST_PATH_IDF], "" ) );
74 
75  m_params.emplace_back(
76  new PARAM_PATH( "pcbnew.last_paths.vrml", &m_PcbLastPath[LAST_PATH_VRML], "" ) );
77 
78  m_params.emplace_back( new PARAM_PATH(
79  "pcbnew.last_paths.specctra_dsn", &m_PcbLastPath[LAST_PATH_SPECCTRADSN], "" ) );
80 
81  m_params.emplace_back(
82  new PARAM_PATH( "pcbnew.last_paths.gencad", &m_PcbLastPath[LAST_PATH_GENCAD], "" ) );
83 
84  m_params.emplace_back( new PARAM<wxString>( "schematic.legacy_lib_dir", &m_LegacyLibDir, "" ) );
85 
86  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "schematic.legacy_lib_list",
87  [&]() -> nlohmann::json
88  {
89  nlohmann::json ret = nlohmann::json::array();
90 
91  for( const wxString& libName : m_LegacyLibNames )
92  ret.push_back( libName );
93 
94  return ret;
95  },
96  [&]( const nlohmann::json& aJson )
97  {
98  if( aJson.empty() || !aJson.is_array() )
99  return;
100 
101  m_LegacyLibNames.clear();
102 
103  for( const nlohmann::json& entry : aJson )
104  m_LegacyLibNames.push_back( entry.get<wxString>() );
105  }, {} ) );
106 
107  m_NetSettings = std::make_shared<NET_SETTINGS>( this, "net_settings" );
108 
109  m_params.emplace_back( new PARAM_LAYER_PRESET( "board.layer_presets", &m_LayerPresets ) );
110 }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111
std::map< wxString, wxString > m_TextVars
Definition: project_file.h:128
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:123
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:126
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
wxArrayString m_LegacyLibNames
Definition: project_file.h:143
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:105
const int projectFileSchemaVersion
! Update the schema version whenever a migration is required
wxString m_PcbLastPath[LAST_PATH_SIZE]
MRU path storage.
Definition: project_file.h:160
nlohmann::json json
Definition: gerbview.cpp:40
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
Stores a path as a string with directory separators normalized to unix-style.
Definition: parameters.h:173
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here) NOTE: If we go multi-board in the future,...
Definition: project_file.h:175
wxString m_BoardPageLayoutDescrFile
PcbNew params.
Definition: project_file.h:157
The settings directory inside a project folder.
std::vector< wxString > m_EquivalenceFiles
CvPcb params.
Definition: project_file.h:150
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:135
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:138
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56
A helper for <wxString, wxString> maps.
Definition: parameters.h:724
BOARD_DESIGN_SETTINGS * m_BoardSettings
Board design settings for this project's board.
Definition: project_file.h:167
wxString m_LegacyLibDir
Definition: project_file.h:141
std::vector< LAYER_PRESET > m_LayerPresets
List of stored layer presets.
Definition: project_file.h:178
Represents a list of strings holding directory paths.
Definition: parameters.h:560
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:108

References LAST_PATH_GENCAD, LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_SPECCTRADSN, LAST_PATH_STEP, LAST_PATH_VRML, m_BoardPageLayoutDescrFile, m_boards, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_sheets, and m_TextVars.

◆ ~PROJECT_FILE()

virtual PROJECT_FILE::~PROJECT_FILE ( )
virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 675 of file json_settings.cpp.

676 {
677  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
678  m_nested_settings.push_back( aSettings );
679 }
wxString GetFilename() const
Definition: json_settings.h:64
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 587 of file json_settings.cpp.

589 {
590  ValueType val;
591 
592  if( aConfig->Read( aKey, &val ) )
593  {
594  try
595  {
596  ( *this )[PointerFromString( aDest )] = val;
597  }
598  catch( ... )
599  {
600  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
601  return false;
602  }
603 
604  return true;
605  }
606 
607  return false;
608 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 647 of file json_settings.cpp.

649 {
650  wxString str;
651 
652  if( aConfig->Read( aKey, &str ) )
653  {
655  color.SetFromWxString( str );
656 
657  try
658  {
659  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
660  ( *this )[PointerFromString( aDest )] = js;
661  }
662  catch( ... )
663  {
664  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
665  return false;
666  }
667 
668  return true;
669  }
670 
671  return false;
672 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 623 of file json_settings.cpp.

625 {
626  wxString str;
627 
628  if( aConfig->Read( aKey, &str ) )
629  {
630  try
631  {
632  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
633  }
634  catch( ... )
635  {
636  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
637  return false;
638  }
639 
640  return true;
641  }
642 
643  return false;
644 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( const std::string &  aPath) const
inlineinherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 131 of file json_settings.h.

132  {
133  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
134  {
135  try
136  {
137  return ret->get<ValueType>();
138  }
139  catch( ... )
140  {
141  }
142  }
143 
144  return NULLOPT;
145  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

OPT< wxString > JSON_SETTINGS::Get ( const std::string &  aPath) const
inherited

Definition at line 705 of file json_settings.cpp.

706 {
707  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
708  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
709 
710  return NULLOPT;
711 }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ GetBoards()

std::vector<FILE_INFO_PAIR>& PROJECT_FILE::GetBoards ( )
inline

Definition at line 87 of file project_file.h.

88  {
89  return m_boards;
90  }
std::vector< FILE_INFO_PAIR > m_boards
A list of board files in this project.
Definition: project_file.h:108

References m_boards.

◆ getFileExt()

wxString PROJECT_FILE::getFileExt ( ) const
overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 553 of file project_file.cpp.

554 {
555  return ProjectFileExtension;
556 }
const std::string ProjectFileExtension

References ProjectFileExtension.

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 81 of file json_settings.cpp.

82 {
83  return wxString( m_filename + "." + getFileExt() );
84 }
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual wxString getFileExt() const

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetJson()

OPT< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string &  aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 436 of file json_settings.cpp.

437 {
438  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
439 
440  if( contains( ptr ) )
441  {
442  try
443  {
444  return OPT<nlohmann::json>{ at( ptr ) };
445  }
446  catch( ... )
447  {
448  }
449  }
450 
451  return OPT<nlohmann::json>{};
452 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References alg::contains(), and JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

wxString PROJECT_FILE::getLegacyFileExt ( ) const
overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 559 of file project_file.cpp.

560 {
562 }
const std::string LegacyProjectFileExtension

References LegacyProjectFileExtension.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

70 { return m_location; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetSheets()

std::vector<FILE_INFO_PAIR>& PROJECT_FILE::GetSheets ( )
inline

Definition at line 82 of file project_file.h.

83  {
84  return m_sheets;
85  }
std::vector< FILE_INFO_PAIR > m_sheets
An list of schematic sheets in this project.
Definition: project_file.h:105

References m_sheets.

Referenced by PROJECT::GetSheetName(), and SCH_EDIT_FRAME::SaveProject().

◆ IsDefault()

bool JSON_SETTINGS::IsDefault ( const std::string &  aParamName)
inherited

Checks if the current state of a parameter matches its default value.

Parameters
aParamNameis the JSON path to the parameter
Returns
true if the given parameter is at its default value

Definition at line 324 of file json_settings.cpp.

325 {
326  for( const PARAM_BASE* param : m_params )
327  {
328  if( param->GetJsonPath() == aParamName )
329  return param->IsDefault();
330  }
331 
332  return false;
333 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 87 of file json_settings.cpp.

88 {
89  for( auto param : m_params )
90  {
91  try
92  {
93  param->Load( this, m_resetParamsIfMissing );
94  }
95  catch( ... )
96  {
97  // Skip unreadable parameters in file
98  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
99  }
100  }
101 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString &  aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 104 of file json_settings.cpp.

105 {
106  // First, load all params to default values
107  clear();
108  Load();
109 
110  bool success = true;
111  bool migrated = false;
112  bool legacy_migrated = false;
113 
114  LOCALE_IO locale;
115 
116  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
117  // Backup and restore during migration so that the original can be mutated if convenient
118  bool backed_up = false;
119  wxFileName temp;
120 
121  if( aPath.IsDirWritable() )
122  {
123  temp.AssignTempFileName( aPath.GetFullPath() );
124 
125  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
126  {
127  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
128  GetFullFilename() );
129  }
130  else
131  backed_up = true;
132  }
133 
134  // Silence popups if legacy file is read-only
135  wxLogNull doNotLog;
136 
137  wxConfigBase::DontCreateOnDemand();
138  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
139 
140  // If migrate fails or is not implemented, fall back to built-in defaults that were
141  // already loaded above
142  if( !MigrateFromLegacy( cfg.get() ) )
143  {
144  wxLogTrace( traceSettings,
145  "%s: migrated; not all settings were found in legacy file",
146  GetFullFilename() );
147  }
148  else
149  {
150  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
151  }
152 
153  if( backed_up )
154  {
155  cfg.reset();
156 
157  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
158  {
159  wxLogTrace( traceSettings,
160  "migrate; copy temp file %s to %s failed",
161  temp.GetFullPath(), aPath.GetFullPath() );
162  }
163 
164  if( !wxRemoveFile( temp.GetFullPath() ) )
165  {
166  wxLogTrace( traceSettings,
167  "migrate; failed to remove temp file %s",
168  temp.GetFullPath() );
169  }
170  }
171 
172  // Either way, we want to clean up the old file afterwards
173  legacy_migrated = true;
174  };
175 
176  wxFileName path;
177 
178  if( aDirectory.empty() )
179  {
180  path.Assign( m_filename );
181  path.SetExt( getFileExt() );
182  }
183  else
184  {
185  wxString dir( aDirectory );
186  path.Assign( dir, m_filename, getFileExt() );
187  }
188 
189  if( !path.Exists() )
190  {
191  // Case 1: legacy migration, no .json extension yet
192  path.SetExt( getLegacyFileExt() );
193 
194  if( path.Exists() )
195  {
196  migrateFromLegacy( path );
197  }
198  // Case 2: legacy filename is different from new one
199  else if( !m_legacy_filename.empty() )
200  {
201  path.SetName( m_legacy_filename );
202 
203  if( path.Exists() )
204  migrateFromLegacy( path );
205  }
206  else
207  {
208  success = false;
209  }
210  }
211  else
212  {
213  if( !path.IsFileWritable() )
214  m_writeFile = false;
215 
216  try
217  {
218  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
219 
220  if( fp )
221  {
222  *static_cast<nlohmann::json*>( this ) = nlohmann::json::parse( fp, nullptr,
223  /* allow_exceptions = */ true,
224  /* ignore_comments = */ true );
225 
226  // If parse succeeds, check if schema migration is required
227  int filever = -1;
228 
229  try
230  {
231  filever = at( PointerFromString( "meta.version" ) ).get<int>();
232  }
233  catch( ... )
234  {
235  wxLogTrace( traceSettings, "%s: file version could not be read!",
236  GetFullFilename() );
237  success = false;
238  }
239 
240  if( filever >= 0 && filever < m_schemaVersion )
241  {
242  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
243  GetFullFilename(), filever, m_schemaVersion );
244 
245  if( Migrate() )
246  {
247  migrated = true;
248  }
249  else
250  {
251  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
252  }
253  }
254  else if( filever > m_schemaVersion )
255  {
256  wxLogTrace( traceSettings,
257  "%s: warning: file version %d is newer than latest (%d)",
258  GetFullFilename(), filever, m_schemaVersion );
259  }
260  }
261  else
262  {
263  wxLogTrace( traceSettings, "%s exists but can't be opened for read",
264  GetFullFilename() );
265  }
266  }
267  catch( nlohmann::json::parse_error& error )
268  {
269  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
270  path.GetFullPath(), error.what() );
271  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
272  migrateFromLegacy( path );
273  }
274  }
275 
276  // Now that we have new data in the JSON structure, load the params again
277  Load();
278 
279  // And finally load any nested settings
280  for( auto settings : m_nested_settings )
281  settings->LoadFromFile();
282 
283  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
284 
285  // If we migrated, clean up the legacy file (with no extension)
286  if( legacy_migrated || migrated )
287  {
288  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
289  {
290  wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
291  path.GetFullPath() );
292  }
293 
294  // And write-out immediately so that we don't lose data if the program later crashes.
296  SaveToFile( aDirectory, true );
297  }
298 
299  return success;
300 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
virtual wxString getLegacyFileExt() const
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.
wxString GetFullFilename() const
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
wxString m_filename
The filename (not including path) of this settings file (inicode)
bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
virtual wxString getFileExt() const
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Definition at line 464 of file json_settings.cpp.

465 {
466  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
467 
468  while( filever < m_schemaVersion )
469  {
470  if( !m_migrators.count( filever ) )
471  {
472  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
473  typeid( *this ).name(), filever );
474  return false;
475  }
476 
477  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
478 
479  if( pair.second() )
480  {
481  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
482  filever, pair.first );
483  filever = pair.first;
484  ( *this )[PointerFromString( "meta.version" )] = filever;
485  }
486  else
487  {
488  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
489  typeid( *this ).name(), filever, pair.first );
490  return false;
491  }
492  }
493 
494  return true;
495 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by NESTED_SETTINGS::LoadFromFile(), and JSON_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool PROJECT_FILE::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented from JSON_SETTINGS.

Definition at line 113 of file project_file.cpp.

114 {
115  bool ret = true;
116  wxString str;
117  long index = 0;
118 
119  std::set<wxString> group_blacklist;
120 
121  // Legacy files don't store board info; they assume board matches project name
122  // We will leave m_boards empty here so it can be populated with other code
123 
124  // First handle migration of data that will be stored locally in this object
125 
126  auto loadPinnedLibs =
127  [&]( const std::string& aDest )
128  {
129  int libIndex = 1;
130  wxString libKey = wxT( "PinnedItems" );
131  libKey << libIndex;
132 
133  nlohmann::json libs = nlohmann::json::array();
134 
135  while( aCfg->Read( libKey, &str ) )
136  {
137  libs.push_back( str );
138 
139  aCfg->DeleteEntry( libKey, true );
140 
141  libKey = wxT( "PinnedItems" );
142  libKey << ++libIndex;
143  }
144 
145  ( *this )[PointerFromString( aDest )] = libs;
146  };
147 
148  aCfg->SetPath( wxT( "/LibeditFrame" ) );
149  loadPinnedLibs( "libraries.pinned_symbol_libs" );
150 
151  aCfg->SetPath( wxT( "/ModEditFrame" ) );
152  loadPinnedLibs( "libraries.pinned_footprint_libs" );
153 
154  aCfg->SetPath( wxT( "/cvpcb/equfiles" ) );
155 
156  {
157  int eqIdx = 1;
158  wxString eqKey = wxT( "EquName" );
159  eqKey << eqIdx;
160 
161  nlohmann::json eqs = nlohmann::json::array();
162 
163  while( aCfg->Read( eqKey, &str ) )
164  {
165  eqs.push_back( str );
166 
167  eqKey = wxT( "EquName" );
168  eqKey << ++eqIdx;
169  }
170 
171  ( *this )[PointerFromString( "cvpcb.equivalence_files" )] = eqs;
172  }
173 
174  // All CvPcb params that we want to keep have been migrated above
175  group_blacklist.insert( wxT( "/cvpcb" ) );
176 
177  aCfg->SetPath( wxT( "/eeschema" ) );
178  fromLegacyString( aCfg, "LibDir", "schematic.legacy_lib_dir" );
179 
180  aCfg->SetPath( wxT( "/eeschema/libraries" ) );
181 
182  {
183  int libIdx = 1;
184  wxString libKey = wxT( "LibName" );
185  libKey << libIdx;
186 
187  nlohmann::json libs = nlohmann::json::array();
188 
189  while( aCfg->Read( libKey, &str ) )
190  {
191  libs.push_back( str );
192 
193  libKey = wxT( "LibName" );
194  libKey << ++libIdx;
195  }
196 
197  ( *this )[PointerFromString( "schematic.legacy_lib_list" )] = libs;
198  }
199 
200  group_blacklist.insert( wxT( "/eeschema" ) );
201 
202  aCfg->SetPath( wxT( "/text_variables" ) );
203 
204  {
205  int txtIdx = 1;
206  wxString txtKey;
207  txtKey << txtIdx;
208 
210 
211  while( aCfg->Read( txtKey, &str ) )
212  {
213  wxArrayString tokens = wxSplit( str, ':' );
214 
215  if( tokens.size() == 2 )
216  vars[ tokens[0].ToStdString() ] = tokens[1];
217 
218  txtKey.clear();
219  txtKey << ++txtIdx;
220  }
221 
222  ( *this )[PointerFromString( "text_variables" )] = vars;
223  }
224 
225  group_blacklist.insert( wxT( "/text_variables" ) );
226 
227  aCfg->SetPath( wxT( "/schematic_editor" ) );
228 
229  fromLegacyString( aCfg, "PageLayoutDescrFile", "schematic.page_layout_descr_file" );
230  fromLegacyString( aCfg, "PlotDirectoryName", "schematic.plot_directory" );
231  fromLegacyString( aCfg, "NetFmtName", "schematic.net_format_name" );
232  fromLegacy<bool>( aCfg, "SpiceAjustPassiveValues", "schematic.spice_adjust_passive_values" );
233  fromLegacy<int>( aCfg, "SubpartIdSeparator", "schematic.subpart_id_separator" );
234  fromLegacy<int>( aCfg, "SubpartFirstId", "schematic.subpart_first_id" );
235 
236  fromLegacy<int>( aCfg, "LineThickness", "schematic.drawing.default_line_thickness" );
237  fromLegacy<int>( aCfg, "WireThickness", "schematic.drawing.default_wire_thickness" );
238  fromLegacy<int>( aCfg, "BusThickness", "schematic.drawing.default_bus_thickness" );
239  fromLegacy<int>( aCfg, "LabSize", "schematic.drawing.default_text_size" );
240  fromLegacy<int>( aCfg, "PinSymbolSize", "schematic.drawing.pin_symbol_size" );
241  fromLegacy<int>( aCfg, "JunctionSize", "schematic.drawing.default_junction_size" );
242 
243  fromLegacyString( aCfg, "FieldNameTemplates", "schematic.drawing.field_names" );
244  fromLegacy<double>( aCfg, "TextOffsetRatio", "schematic.drawing.text_offset_ratio" );
245 
246  // All schematic_editor keys we keep are migrated above
247  group_blacklist.insert( wxT( "/schematic_editor" ) );
248 
249  aCfg->SetPath( wxT( "/pcbnew" ) );
250 
251  fromLegacyString( aCfg, "PageLayoutDescrFile", "pcbnew.page_layout_descr_file" );
252  fromLegacyString( aCfg, "LastNetListRead", "pcbnew.last_paths.netlist" );
253  fromLegacyString( aCfg, "LastSTEPExportPath", "pcbnew.last_paths.step" );
254  fromLegacyString( aCfg, "LastIDFExportPath", "pcbnew.last_paths.idf" );
255  fromLegacyString( aCfg, "LastVRMLExportPath", "pcbnew.last_paths.vmrl" );
256  fromLegacyString( aCfg, "LastSpecctraDSNExportPath", "pcbnew.last_paths.specctra_dsn" );
257  fromLegacyString( aCfg, "LastGenCADExportPath", "pcbnew.last_paths.gencad" );
258 
259  std::string bp = "board.design_settings.";
260 
261  {
262  int idx = 1;
263  wxString key = wxT( "DRCExclusion" );
264  key << idx;
265 
266  nlohmann::json exclusions = nlohmann::json::array();
267 
268  while( aCfg->Read( key, &str ) )
269  {
270  exclusions.push_back( str );
271 
272  key = wxT( "DRCExclusion" );
273  key << ++idx;
274  }
275 
276  ( *this )[PointerFromString( bp + "drc_exclusions" )] = exclusions;
277  }
278 
279  fromLegacy<bool>( aCfg, "AllowMicroVias", bp + "rules.allow_microvias" );
280  fromLegacy<bool>( aCfg, "AllowBlindVias", bp + "rules.allow_blind_buried_vias" );
281  fromLegacy<double>( aCfg, "MinClearance", bp + "rules.min_clearance" );
282  fromLegacy<double>( aCfg, "MinTrackWidth", bp + "rules.min_track_width" );
283  fromLegacy<double>( aCfg, "MinViaAnnulus", bp + "rules.min_via_annulus" );
284  fromLegacy<double>( aCfg, "MinViaDiameter", bp + "rules.min_via_diameter" );
285 
286  if( !fromLegacy<double>( aCfg, "MinThroughDrill", bp + "rules.min_through_hole_diameter" ) )
287  fromLegacy<double>( aCfg, "MinViaDrill", bp + "rules.min_through_hole_diameter" );
288 
289  fromLegacy<double>( aCfg, "MinMicroViaDiameter", bp + "rules.min_microvia_diameter" );
290  fromLegacy<double>( aCfg, "MinMicroViaDrill", bp + "rules.min_microvia_drill" );
291  fromLegacy<double>( aCfg, "MinHoleToHole", bp + "rules.min_hole_to_hole" );
292  fromLegacy<double>( aCfg, "CopperEdgeClearance", bp + "rules.min_copper_edge_clearance" );
293  fromLegacy<double>( aCfg, "SolderMaskClearance", bp + "rules.solder_mask_clearance" );
294  fromLegacy<double>( aCfg, "SolderMaskMinWidth", bp + "rules.solder_mask_min_width" );
295  fromLegacy<double>( aCfg, "SolderPasteClearance", bp + "rules.solder_paste_clearance" );
296  fromLegacy<double>( aCfg, "SolderPasteRatio", bp + "rules.solder_paste_margin_ratio" );
297 
298  if( !fromLegacy<double>( aCfg, "SilkLineWidth", bp + "defaults.silk_line_width" ) )
299  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.silk_line_width" );
300 
301  if( !fromLegacy<double>( aCfg, "SilkTextSizeV", bp + "defaults.silk_text_size_v" ) )
302  fromLegacy<double>( aCfg, "ModuleTextSizeV", bp + "defaults.silk_text_size_v" );
303 
304  if( !fromLegacy<double>( aCfg, "SilkTextSizeH", bp + "defaults.silk_text_size_h" ) )
305  fromLegacy<double>( aCfg, "ModuleTextSizeH", bp + "defaults.silk_text_size_h" );
306 
307  if( !fromLegacy<double>( aCfg, "SilkTextSizeThickness", bp + "defaults.silk_text_thickness" ) )
308  fromLegacy<double>( aCfg, "ModuleTextSizeThickness", bp + "defaults.silk_text_thickness" );
309 
310  fromLegacy<bool>( aCfg, "SilkTextItalic", bp + "defaults.silk_text_italic" );
311  fromLegacy<bool>( aCfg, "SilkTextUpright", bp + "defaults.silk_text_upright" );
312 
313  if( !fromLegacy<double>( aCfg, "CopperLineWidth", bp + "defaults.copper_line_width" ) )
314  fromLegacy<double>( aCfg, "DrawSegmentWidth", bp + "defaults.copper_line_width" );
315 
316  if( !fromLegacy<double>( aCfg, "CopperTextSizeV", bp + "defaults.copper_text_size_v" ) )
317  fromLegacy<double>( aCfg, "PcbTextSizeV", bp + "defaults.copper_text_size_v" );
318 
319  if( !fromLegacy<double>( aCfg, "CopperTextSizeH", bp + "defaults.copper_text_size_h" ) )
320  fromLegacy<double>( aCfg, "PcbTextSizeH", bp + "defaults.copper_text_size_h" );
321 
322  if( !fromLegacy<double>( aCfg, "CopperTextThickness", bp + "defaults.copper_text_thickness" ) )
323  fromLegacy<double>( aCfg, "PcbTextThickness", bp + "defaults.copper_text_thickness" );
324 
325  fromLegacy<bool>( aCfg, "CopperTextItalic", bp + "defaults.copper_text_italic" );
326  fromLegacy<bool>( aCfg, "CopperTextUpright", bp + "defaults.copper_text_upright" );
327 
328  if( !fromLegacy<double>( aCfg, "EdgeCutLineWidth", bp + "defaults.board_outline_line_width" ) )
329  fromLegacy<double>( aCfg, "BoardOutlineThickness", bp + "defaults.board_outline_line_width" );
330 
331  fromLegacy<double>( aCfg, "CourtyardLineWidth", bp + "defaults.courtyard_line_width" );
332 
333  fromLegacy<double>( aCfg, "FabLineWidth", bp + "defaults.fab_line_width" );
334  fromLegacy<double>( aCfg, "FabTextSizeV", bp + "defaults.fab_text_size_v" );
335  fromLegacy<double>( aCfg, "FabTextSizeH", bp + "defaults.fab_text_size_h" );
336  fromLegacy<double>( aCfg, "FabTextSizeThickness", bp + "defaults.fab_text_thickness" );
337  fromLegacy<bool>( aCfg, "FabTextItalic", bp + "defaults.fab_text_italic" );
338  fromLegacy<bool>( aCfg, "FabTextUpright", bp + "defaults.fab_text_upright" );
339 
340  if( !fromLegacy<double>( aCfg, "OthersLineWidth", bp + "defaults.other_line_width" ) )
341  fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.other_line_width" );
342 
343  fromLegacy<double>( aCfg, "OthersTextSizeV", bp + "defaults.other_text_size_v" );
344  fromLegacy<double>( aCfg, "OthersTextSizeH", bp + "defaults.other_text_size_h" );
345  fromLegacy<double>( aCfg, "OthersTextSizeThickness", bp + "defaults.other_text_thickness" );
346  fromLegacy<bool>( aCfg, "OthersTextItalic", bp + "defaults.other_text_italic" );
347  fromLegacy<bool>( aCfg, "OthersTextUpright", bp + "defaults.other_text_upright" );
348 
349  fromLegacy<int>( aCfg, "DimensionUnits", bp + "defaults.dimension_units" );
350  fromLegacy<int>( aCfg, "DimensionPrecision", bp + "defaults.dimension_precision" );
351 
352  std::string sev = bp + "rule_severities";
353 
354  fromLegacy<bool>( aCfg, "RequireCourtyardDefinitions", sev + "legacy_no_courtyard_defined" );
355 
356  fromLegacy<bool>( aCfg, "ProhibitOverlappingCourtyards", sev + "legacy_courtyards_overlap" );
357 
358  {
359  int idx = 1;
360  wxString keyBase = "TrackWidth";
361  wxString key = keyBase;
362  double val;
363 
364  nlohmann::json widths = nlohmann::json::array();
365 
366  key << idx;
367 
368  while( aCfg->Read( key, &val ) )
369  {
370  widths.push_back( val );
371  key = keyBase;
372  key << ++idx;
373  }
374 
375  ( *this )[PointerFromString( bp + "track_widths" )] = widths;
376  }
377 
378  {
379  int idx = 1;
380  wxString keyBase = "ViaDiameter";
381  wxString key = keyBase;
382  double diameter;
383  double drill = 1.0;
384 
385  nlohmann::json vias = nlohmann::json::array();
386 
387  key << idx;
388 
389  while( aCfg->Read( key, &diameter ) )
390  {
391  key = "ViaDrill";
392  aCfg->Read( key << idx, &drill );
393 
394  nlohmann::json via = { { "diameter", diameter }, { "drill", drill } };
395  vias.push_back( via );
396 
397  key = keyBase;
398  key << ++idx;
399  }
400 
401  ( *this )[PointerFromString( bp + "via_dimensions" )] = vias;
402  }
403 
404  {
405  int idx = 1;
406  wxString keyBase = "dPairWidth";
407  wxString key = keyBase;
408  double width;
409  double gap = 1.0;
410  double via_gap = 1.0;
411 
412  nlohmann::json pairs = nlohmann::json::array();
413 
414  key << idx;
415 
416  while( aCfg->Read( key, &width ) )
417  {
418  key = "dPairGap";
419  aCfg->Read( key << idx, &gap );
420 
421  key = "dPairViaGap";
422  aCfg->Read( key << idx, &via_gap );
423 
424  nlohmann::json pair = { { "width", width }, { "gap", gap }, { "via_gap", via_gap } };
425  pairs.push_back( pair );
426 
427  key = keyBase;
428  key << ++idx;
429  }
430 
431  ( *this )[PointerFromString( bp + "diff_pair_dimensions" )] = pairs;
432  }
433 
434  group_blacklist.insert( wxT( "/pcbnew" ) );
435 
436  // General group is unused these days, we can throw it away
437  group_blacklist.insert( wxT( "/general" ) );
438 
439  // Next load sheet names and put all other legacy data in the legacy dict
440  aCfg->SetPath( wxT( "/" ) );
441 
442  auto loadSheetNames =
443  [&]() -> bool
444  {
445  int sheet = 1;
446  wxString entry;
447  nlohmann::json arr = nlohmann::json::array();
448 
449  wxLogTrace( traceSettings, "Migrating sheet names" );
450 
451  aCfg->SetPath( wxT( "/sheetnames" ) );
452 
453  while( aCfg->Read( wxString::Format( "%d", sheet++ ), &entry ) )
454  {
455  wxArrayString tokens = wxSplit( entry, ':' );
456 
457  if( tokens.size() == 2 )
458  {
459  wxLogTrace( traceSettings, "%d: %s = %s", sheet, tokens[0], tokens[1] );
460  arr.push_back( nlohmann::json::array( { tokens[0], tokens[1] } ) );
461  }
462  }
463 
464  ( *this )[PointerFromString( "sheets" )] = arr;
465 
466  aCfg->SetPath( "/" );
467 
468  // TODO: any reason we want to fail on this?
469  return true;
470  };
471 
472  std::vector<wxString> groups;
473 
474  groups.emplace_back( "" );
475 
476  auto loadLegacyPairs =
477  [&]( const std::string& aGroup ) -> bool
478  {
479  wxLogTrace( traceSettings, "Migrating group %s", aGroup );
480  bool success = true;
481  wxString keyStr;
482  wxString val;
483 
484  index = 0;
485 
486  while( aCfg->GetNextEntry( keyStr, index ) )
487  {
488  if( !aCfg->Read( keyStr, &val ) )
489  continue;
490 
491  std::string key( keyStr.ToUTF8() );
492 
493  wxLogTrace( traceSettings, " %s = %s", key, val );
494 
495  try
496  {
497  nlohmann::json::json_pointer ptr( "/legacy" + aGroup + "/" + key );
498  ( *this )[ptr] = val;
499  }
500  catch( ... )
501  {
502  success = false;
503  }
504  }
505 
506  return success;
507  };
508 
509  for( size_t i = 0; i < groups.size(); i++ )
510  {
511  aCfg->SetPath( groups[i] );
512 
513  if( groups[i] == wxT( "/sheetnames" ) )
514  {
515  ret |= loadSheetNames();
516  continue;
517  }
518 
519  aCfg->DeleteEntry( wxT( "last_client" ), true );
520  aCfg->DeleteEntry( wxT( "update" ), true );
521  aCfg->DeleteEntry( wxT( "version" ), true );
522 
523  ret &= loadLegacyPairs( groups[i].ToStdString() );
524 
525  index = 0;
526 
527  while( aCfg->GetNextGroup( str, index ) )
528  {
529  wxString group = groups[i] + "/" + str;
530 
531  if( !group_blacklist.count( group ) )
532  groups.emplace_back( group );
533  }
534 
535  aCfg->SetPath( "/" );
536  }
537 
538  return ret;
539 }
nlohmann::json json
Definition: gerbview.cpp:40
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References Format(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::PointerFromString(), and traceSettings.

◆ NetSettings()

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 506 of file json_settings.cpp.

507 {
508  std::replace( aPath.begin(), aPath.end(), '.', '/' );
509  aPath.insert( 0, "/" );
510 
511  nlohmann::json::json_pointer p;
512 
513  try
514  {
515  p = nlohmann::json::json_pointer( aPath );
516  }
517  catch( ... )
518  {
519  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
520  }
521 
522  return p;
523 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), EESCHEMA_SETTINGS::migrateBomSettings(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 455 of file json_settings.cpp.

457 {
458  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
459  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
460  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
461 }
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 682 of file json_settings.cpp.

683 {
684  if( !aSettings )
685  return;
686 
687  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
688  [&aSettings]( const JSON_SETTINGS* aPtr ) {
689  return aPtr == aSettings;
690  } );
691 
692  if( it != m_nested_settings.end() )
693  {
694  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
695  ( *it )->SaveToFile();
696  m_nested_settings.erase( it );
697  }
698 
699  aSettings->SetParent( nullptr );
700 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOARD::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 317 of file json_settings.cpp.

318 {
319  for( auto param : m_params )
320  param->SetDefault();
321 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveToFile()

bool PROJECT_FILE::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
overridevirtual
   Calls Store() and then writes the contents of the JSON document to a file
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns
true if the file was saved

Reimplemented from JSON_SETTINGS.

Definition at line 542 of file project_file.cpp.

543 {
544  wxASSERT( m_project );
545 
546  ( *this )[PointerFromString( "meta.filename" )] =
548 
549  return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
550 }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111
const std::string ProjectFileExtension
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
virtual const wxString GetProjectName() const
Return the short name of the project.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References PROJECT::GetProjectName(), m_project, JSON_SETTINGS::PointerFromString(), ProjectFileExtension, and JSON_SETTINGS::SaveToFile().

Referenced by SETTINGS_MANAGER::SaveProject(), and SETTINGS_MANAGER::SaveProjectAs().

◆ Set() [1/3]

template<typename ValueType >
void JSON_SETTINGS::Set ( const std::string &  aPath,
ValueType  aVal 
)
inlineinherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 155 of file json_settings.h.

156  {
157  ( *this )[PointerFromString( aPath ) ] = aVal;
158  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

◆ Set() [3/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

Definition at line 714 of file json_settings.cpp.

715 {
716  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
717 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 68 of file json_settings.h.

68 { m_filename = aFilename; }
wxString m_filename
The filename (not including path) of this settings file (inicode)

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
wxString &  aTarget 
)
staticinherited

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 526 of file json_settings.cpp.

528 {
529  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
530 
531  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
532  {
533  aTarget = aObj.at( ptr ).get<wxString>();
534  return true;
535  }
536 
537  return false;
538 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
bool &  aTarget 
)
staticinherited

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 541 of file json_settings.cpp.

543 {
544  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
545 
546  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
547  {
548  aTarget = aObj.at( ptr ).get<bool>();
549  return true;
550  }
551 
552  return false;
553 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
int &  aTarget 
)
staticinherited

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 556 of file json_settings.cpp.

558 {
559  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
560 
561  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
562  {
563  aTarget = aObj.at( ptr ).get<int>();
564  return true;
565  }
566 
567  return false;
568 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
unsigned int &  aTarget 
)
staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 571 of file json_settings.cpp.

573 {
574  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
575 
576  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
577  {
578  aTarget = aObj.at( ptr ).get<unsigned int>();
579  return true;
580  }
581 
582  return false;
583 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 72 of file json_settings.h.

72 { m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 195 of file json_settings.h.

196  {
197  m_manager = aManager;
198  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_FILE::SetProject ( PROJECT aProject)
inline

Definition at line 77 of file project_file.h.

78  {
79  m_project = aProject;
80  }
PROJECT * m_project
A link to the owning PROJECT.
Definition: project_file.h:111

References m_project.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 75 of file json_settings.h.

75 { m_writeFile = !aReadOnly; }
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document was updated

Definition at line 303 of file json_settings.cpp.

304 {
305  bool modified = false;
306 
307  for( auto param : m_params )
308  {
309  modified |= !param->MatchesFile( this );
310  param->Store( this );
311  }
312 
313  return modified;
314 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_BoardPageLayoutDescrFile

wxString PROJECT_FILE::m_BoardPageLayoutDescrFile

PcbNew params.

Page layout description file

Definition at line 157 of file project_file.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_boards

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_boards
private

A list of board files in this project.

Definition at line 108 of file project_file.h.

Referenced by GetBoards(), and PROJECT_FILE().

◆ m_BoardSettings

BOARD_DESIGN_SETTINGS* PROJECT_FILE::m_BoardSettings

Board design settings for this project's board.

This will be initialized by PcbNew after loading a board so that BOARD_DESIGN_SETTINGS doesn't need to live in common for now. Owned by the BOARD; may be null if a board isn't loaded: be careful

Definition at line 167 of file project_file.h.

Referenced by BOARD::ClearProject(), and BOARD::SetProject().

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 313 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 307 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 319 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and PROJECT_FILE().

◆ m_EquivalenceFiles

std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles

CvPcb params.

List of equivalence (equ) files used in the project

Definition at line 150 of file project_file.h.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DIALOG_CONFIG_EQUFILES::Init(), DIALOG_CONFIG_EQUFILES::OnOkClick(), and PROJECT_FILE().

◆ m_ErcSettings

ERC_SETTINGS* PROJECT_FILE::m_ErcSettings

◆ m_filename

◆ m_LayerPresets

std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets

List of stored layer presets.

Definition at line 178 of file project_file.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 295 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SetLegacyFilename().

◆ m_LegacyLibDir

wxString PROJECT_FILE::m_LegacyLibDir

Definition at line 141 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_LegacyLibNames

wxArrayString PROJECT_FILE::m_LegacyLibNames

Definition at line 143 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 298 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 328 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::SetManager().

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 334 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 304 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

◆ m_NetSettings

std::shared_ptr<NET_SETTINGS> PROJECT_FILE::m_NetSettings

Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board.

Right now I think global makes more sense (one set of schematics, one netlist partitioned into multiple boards)

Definition at line 175 of file project_file.h.

Referenced by NetSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PROJECT_FILE(), and BOARD::SynchronizeNetsAndNetClasses().

◆ m_params

◆ m_PcbLastPath

wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE]

MRU path storage.

Definition at line 160 of file project_file.h.

Referenced by PCB_EDIT_FRAME::GetLastPath(), PROJECT_FILE(), and PCB_EDIT_FRAME::SetLastPath().

◆ m_PinnedFootprintLibs

std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs

The list of pinned footprint libraries.

Definition at line 126 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ m_PinnedSymbolLibs

std::vector<wxString> PROJECT_FILE::m_PinnedSymbolLibs

Below are project-level settings that have not been moved to a dedicated file.

Shared params, used by more than one applicationThe list of pinned symbol libraries

Definition at line 123 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 331 of file json_settings.h.

◆ m_project

PROJECT* PROJECT_FILE::m_project
private

A link to the owning PROJECT.

Definition at line 111 of file project_file.h.

Referenced by SaveToFile(), and SetProject().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 322 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_SchematicSettings

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_sheets

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_sheets
private

An list of schematic sheets in this project.

Definition at line 105 of file project_file.h.

Referenced by GetSheets(), and PROJECT_FILE().

◆ m_TextVars

std::map<wxString, wxString> PROJECT_FILE::m_TextVars

Definition at line 128 of file project_file.h.

Referenced by PROJECT::GetTextVars(), and PROJECT_FILE().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

The documentation for this class was generated from the following files: