KiCad PCB EDA Suite
env_paths.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2017 Wayne Stambaugh <[email protected]>
5  * Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  * Copyright (C) 2017 CERN
7  *
8  * @author Maciej Suminski <[email protected]>
9  *
10  * This program is free software: you can redistribute it and/or modify it
11  * under the terms of the GNU General Public License as published by the
12  * Free Software Foundation, either version 3 of the License, or (at your
13  * option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program. If not, see <http://www.gnu.org/licenses/>.
22  */
23 
25 
26 #ifndef ENV_PATHS_H
27 #define ENV_PATHS_H
28 
29 #include <wx/string.h>
30 #include <settings/environment.h>
31 
32 class wxFileName;
33 class PROJECT;
34 
44 wxString NormalizePath( const wxFileName& aFilePath, const ENV_VAR_MAP* aEnvVars,
45  const PROJECT* aProject );
46 
56 wxString NormalizePath( const wxFileName& aFilePath, const ENV_VAR_MAP* aEnvVars,
57  const wxString& aProjectPath );
58 
68 wxString ResolveFile( const wxString& aFileName, const ENV_VAR_MAP* aEnvVars,
69  const PROJECT* aProject );
70 
71 #endif /* ENV_PATHS_H */
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.
Definition: env_paths.cpp:156
Container for project specific data.
Definition: project.h:62
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const PROJECT *aProject)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:132
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP