Property keys and codec threaded through IMPORT_PROJ_HELPER::m_properties to coordinate a non-KiCad project import across the schematic and PCB editors. More...

Functions
wxString	ManagedCacheOption ()
	Options string identifying a library-table row as a generated import cache.

wxString	JoinList (const wxArrayString &aItems)
	Encode library nicknames into a single list-property value.

std::vector< wxString >	SplitList (const wxString &aValue)
	Decode a list-property value back into nicknames, dropping empties.

wxString	JoinNetNameMap (const std::map< wxString, wxString > &aNames)
	Encode source-to-imported net names as a single property value.

std::optional< std::map< wxString, wxString > >	SplitNetNameMap (const wxString &aValue)
	Decode a net-name map property value, or nothing when the value is not one.

void	ReadFootprintProps (const std::map< std::string, UTF8 > *aProps, wxString &aCacheNickname, std::vector< wxString > &aSourceFpLibs)
	Read the footprint-import coordination properties out of a properties map.

void	ReadSymbolProps (const std::map< std::string, UTF8 > *aProps, wxString &aCacheNickname, std::vector< wxString > &aSourceSymLibs)
	Read the symbol-import coordination properties out of a properties map.

wxString	MakeCacheNickname (const wxString &aStem)
	Derive the generated footprint-cache nickname from a project or file stem.

wxString	MakeSymbolCacheNickname (const wxString &aStem)
	Derive the generated symbol-cache nickname from a project or file stem.

Variables
constexpr char	FP_CACHE_NICKNAME [] = "import_fp_cache_nickname"

constexpr char	SOURCE_FP_LIBS [] = "import_source_fp_libs"

constexpr char	SYM_CACHE_NICKNAME [] = "import_sym_cache_nickname"

constexpr char	SOURCE_SYM_LIBS [] = "import_source_sym_libs"

constexpr char	NET_NAME_MAP [] = "import_net_name_map"

constexpr char	LIST_SEPARATOR = '\x1f'
	Separator joining a list value within a single property.

constexpr char	MANAGED_CACHE_KEY [] = "kicad_import_cache"
	Library-table row option key marking a row as a generated import cache.

constexpr char	NET_NAME_MAP_TAG [] = "netmap"
	Leading field marking a value as an encoded net-name map, so a design that maps no nets is still distinguishable from an import that never ran.

Detailed Description

Property keys and codec threaded through IMPORT_PROJ_HELPER::m_properties to coordinate a non-KiCad project import across the schematic and PCB editors.

Values ride the MAIL_IMPORT_FILE payload, whose framing forbids '
' inside a value, so list values join with the unit-separator control character (a library nickname cannot contain it). The codec lives here next to the contract so the manager (encode) and both editor frames (decode) cannot drift.

Function Documentation

◆ JoinList()

wxString IMPORT_PROJ_PROPS::JoinList ( const wxArrayString & aItems )

inline

Encode library nicknames into a single list-property value.

Definition at line 61 of file import_proj_properties.h.

References LIST_SEPARATOR.

Referenced by IMPORT_PROJ_HELPER::EasyEDAProProjectHandler(), JoinNetNameMap(), and IMPORT_PROJ_HELPER::joinSourceLibNicknames().

◆ JoinNetNameMap()

wxString IMPORT_PROJ_PROPS::JoinNetNameMap ( const std::map< wxString, wxString > & aNames )

inline

Encode source-to-imported net names as a single property value.

Definition at line 85 of file import_proj_properties.h.

References JoinList(), and NET_NAME_MAP_TAG.

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_EDIT_FRAME::KiwayMailIn().

◆ MakeCacheNickname()

wxString IMPORT_PROJ_PROPS::MakeCacheNickname ( const wxString & aStem )

inline

Derive the generated footprint-cache nickname from a project or file stem.

Definition at line 144 of file import_proj_properties.h.

References LIB_ID::FixIllegalChars(), and UTF8::wx_str().

Referenced by ReconcileImportedFootprints(), and IMPORT_PROJ_HELPER::setImportCacheNickname().

◆ MakeSymbolCacheNickname()

wxString IMPORT_PROJ_PROPS::MakeSymbolCacheNickname ( const wxString & aStem )

inline

Derive the generated symbol-cache nickname from a project or file stem.

Definition at line 150 of file import_proj_properties.h.

References LIB_ID::FixIllegalChars(), and UTF8::wx_str().

Referenced by ReconcileImportedSymbols().

◆ ManagedCacheOption()

wxString IMPORT_PROJ_PROPS::ManagedCacheOption ( )

inline

Options string identifying a library-table row as a generated import cache.

Definition at line 55 of file import_proj_properties.h.

References MANAGED_CACHE_KEY.

Referenced by FOOTPRINT_IMPORT_RECONCILER::registerCacheRow(), and SYMBOL_IMPORT_RECONCILER::registerCacheRow().

◆ ReadFootprintProps()

void IMPORT_PROJ_PROPS::ReadFootprintProps	(	const std::map< std::string, UTF8 > *	aProps,
		wxString &	aCacheNickname,
		std::vector< wxString > &	aSourceFpLibs )

inline

Read the footprint-import coordination properties out of a properties map.

Definition at line 116 of file import_proj_properties.h.

References FP_CACHE_NICKNAME, SOURCE_FP_LIBS, and SplitList().

Referenced by SCH_EDIT_FRAME::importFile(), and ReconcileImportedFootprints().

◆ ReadSymbolProps()

void IMPORT_PROJ_PROPS::ReadSymbolProps	(	const std::map< std::string, UTF8 > *	aProps,
		wxString &	aCacheNickname,
		std::vector< wxString > &	aSourceSymLibs )