mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-15 02:33:15 +02:00
0b2d4d4879
Recommendation is to avoid using the year nomenclature as this information is already encoded in the git repo. Avoids needing to repeatly update. Also updates AUTHORS.txt from current repo with contributor names
72 lines
2.9 KiB
C++
72 lines
2.9 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2017 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
|
|
* Copyright (C) 2017 CERN
|
|
*
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
///< Helper functions to substitute paths with environmental variables.
|
|
|
|
#ifndef ENV_PATHS_H
|
|
#define ENV_PATHS_H
|
|
|
|
#include <wx/string.h>
|
|
#include <settings/environment.h>
|
|
|
|
class wxFileName;
|
|
class PROJECT;
|
|
|
|
/**
|
|
* Normalize a file path to an environmental variable, if possible.
|
|
*
|
|
* @param aFilePath is the full file path (path and file name) to be normalized.
|
|
* @param aEnvVars is an optional map of environmental variables to try substitution with.
|
|
* @param aProject is an optional project, to normalize the file path to the project path.
|
|
* @return Normalized full file path (path and file name) if succeeded or the input path if
|
|
* the path could not be normalized.
|
|
*/
|
|
wxString NormalizePath( const wxFileName& aFilePath, const ENV_VAR_MAP* aEnvVars,
|
|
const PROJECT* aProject );
|
|
|
|
/**
|
|
* Normalize a file path to an environmental variable, if possible.
|
|
*
|
|
* @param aFilePath is the full file path (path and file name) to be normalized.
|
|
* @param aEnvVars is an optional map of environmental variables to try substitution with.
|
|
* @param aProjectPath is an optional string to normalize the file path to the project path.
|
|
* @return Normalized full file path (path and file name) if succeeded or the input path if
|
|
* the path could not be normalized.
|
|
*/
|
|
wxString NormalizePath( const wxFileName& aFilePath, const ENV_VAR_MAP* aEnvVars,
|
|
const wxString& aProjectPath );
|
|
|
|
/**
|
|
* Search the default paths trying to find one with the requested file.
|
|
*
|
|
* @param aFileName is the name of the searched file. It might be a relative path.
|
|
* @param aEnvVars is an optional map of environmental variables that can contain paths.
|
|
* @param aProject is an optional project, to check the project path.
|
|
* @return Full path (apth and file name) if the file was found in one of the paths, otherwise
|
|
* an empty string.
|
|
*/
|
|
wxString ResolveFile( const wxString& aFileName, const ENV_VAR_MAP* aEnvVars,
|
|
const PROJECT* aProject );
|
|
|
|
#endif /* ENV_PATHS_H */
|