env_paths.h File Reference

#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. More...
wxString	NormalizePath (const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
	Normalize a file path to an environmental variable, if possible. More...
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. More...

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 132 of file env_paths.cpp.

{
    if( aProject )
        return NormalizePath( aFilePath, aEnvVars, aProject->GetProjectPath() );
    else
        return NormalizePath( aFilePath, aEnvVars, "" );
}

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 69 of file env_paths.cpp.

{
    wxFileName envPath;
    wxString   varName;
    wxString   remainingPath;
    wxString   normalizedFullPath;
    int        pathDepth = 0;

    if( aEnvVars )
    {
        for( auto& entry : *aEnvVars )
        {
            // Don't bother normalizing paths that don't exist or the user cannot read.
            if( !wxFileName::DirExists( entry.second.GetValue() )
                || !wxFileName::IsDirReadable( entry.second.GetValue() ) )
                continue;

            envPath.SetPath( entry.second.GetValue() );

            wxString tmp;
            if( normalizeAbsolutePaths( envPath, aFilePath, &tmp ) )
            {
                int newDepth = envPath.GetDirs().GetCount();

                // Only use the variable if it removes more directories than the previous ones
                if( newDepth > pathDepth )
                {
                    pathDepth     = newDepth;
                    varName       = entry.first;
                    remainingPath = tmp;
                }
            }
        }
    }

    if( varName.IsEmpty() && !aProjectPath.IsEmpty()
        && wxFileName( aProjectPath ).IsAbsolute() && wxFileName( aFilePath ).IsAbsolute() )
    {
        envPath.SetPath( aProjectPath );

        if( normalizeAbsolutePaths( envPath, aFilePath, &remainingPath ) )
            varName = PROJECT_VAR_NAME;
    }

    if( varName.IsEmpty() )
    {
        normalizedFullPath = aFilePath.GetFullPath();
    }
    else
    {
        normalizedFullPath = wxString::Format( "${%s}/", varName );

        if( !remainingPath.IsEmpty() )
            normalizedFullPath += remainingPath;

        normalizedFullPath += aFilePath.GetFullName();
    }

    return normalizedFullPath;
}

References Format(), normalizeAbsolutePaths(), and PROJECT_VAR_NAME.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), NormalizePath(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), 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 (apth and file name) if the file was found in one of the paths, otherwise an empty string.

Definition at line 156 of file env_paths.cpp.

{
    wxFileName full( aFileName );

    if( full.IsAbsolute() )
        return full.GetFullPath();

    if( aProject )
    {
        wxFileName fn( createFilePath( aProject->GetProjectPath(), aFileName ) );

        if( fn.Exists() )
            return fn.GetFullPath();
    }

    if( aEnvVars )
    {
        for( auto& entry : *aEnvVars )
        {
            wxFileName fn( createFilePath( entry.second.GetValue(), aFileName ) );

            if( fn.Exists() )
                return fn.GetFullPath();
        }
    }

    return wxEmptyString;
}

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

Referenced by NETLIST_EXPORTER_PSPICE::Format().