env_paths.h File Reference

Helper functions to substitute paths with environmental variables. More...

#include <wx/string.h>
#include <settings/environment.h>

Go to the source code of this file.

Functions
wxString	NormalizePath (const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const PROJECT *aProject)
	Normalize a file path to an environmental variable, if possible.
wxString	NormalizePath (const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
	Normalize a file path to an environmental variable, if possible.
wxString	ResolveFile (const wxString &aFileName, const ENV_VAR_MAP *aEnvVars, const PROJECT *aProject)
	Search the default paths trying to find one with the requested file.

Detailed Description

Helper functions to substitute paths with environmental variables.

Definition in file env_paths.h.

Function Documentation

NormalizePath() [1/2]

wxString NormalizePath	(	const wxFileName &	aFilePath,
		const ENV_VAR_MAP *	aEnvVars,
		const PROJECT *	aProject
	)

Normalize a file path to an environmental variable, if possible.

Parameters

aFilePath	is the full file path (path and file name) to be normalized.
aEnvVars	is an optional map of environmental variables to try substitution with.
aProject	is an optional project, to normalize the file path to the project path.

Returns

Normalized full file path (path and file name) if succeeded or the input path if the path could not be normalized.

Definition at line 142 of file env_paths.cpp.

References PROJECT::GetProjectPath(), and NormalizePath().

NormalizePath() [2/2]

wxString NormalizePath	(	const wxFileName &	aFilePath,
		const ENV_VAR_MAP *	aEnvVars,
		const wxString &	aProjectPath
	)

Normalize a file path to an environmental variable, if possible.

Parameters

aFilePath	is the full file path (path and file name) to be normalized.
aEnvVars	is an optional map of environmental variables to try substitution with.
aProjectPath	is an optional string to normalize the file path to the project path.

Returns

Normalized full file path (path and file name) if succeeded or the input path if the path could not be normalized.

Definition at line 73 of file env_paths.cpp.

References normalizeAbsolutePaths(), and PROJECT_VAR_NAME.

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PANEL_DESIGN_BLOCK_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), NormalizePath(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), and SYMBOL_EDIT_FRAME::replaceLibTableEntry().

ResolveFile()

wxString ResolveFile	(	const wxString &	aFileName,
		const ENV_VAR_MAP *	aEnvVars,
		const PROJECT *	aProject
	)

Search the default paths trying to find one with the requested file.

Parameters

aFileName	is the name of the searched file. It might be a relative path.
aEnvVars	is an optional map of environmental variables that can contain paths.
aProject	is an optional project, to check the project path.

Returns

Full path (path and file name) if the file was found in one of the paths, otherwise an empty string.

Definition at line 166 of file env_paths.cpp.

References createFilePath(), and PROJECT::GetProjectPath().

Referenced by NETLIST_EXPORTER_SPICE::writeInclude().