env_paths.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * Copyright (C) 2017 CERN
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 <https://www.gnu.org/licenses/>.
 */

 
#ifndef ENV_PATHS_H
#define ENV_PATHS_H
 
#include <wx/string.h>
#include <settings/environment.h>
#include <kicommon.h>
 
class wxFileName;
class PROJECT;

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

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

wxString KICOMMON_API MakeRelativePath( const wxString& aPath, const wxString& aBaseDir );

wxString KICOMMON_API NormalizePathForProject( const wxString& aPath, const ENV_VAR_MAP* aEnvVars,
                                               const wxString& aProjectPath, bool aAllowParentDirs );

wxString KICOMMON_API ResolveFile( const wxString& aFileName, const ENV_VAR_MAP* aEnvVars,
                      const PROJECT* aProject );
 
#endif /* ENV_PATHS_H */