paths.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 PATHS_H
#define PATHS_H
 
#include <kicommon.h>
#include <wx/filename.h>
#include <wx/string.h>

#define UNIX_STRING_DIR_SEP wxT( "/" )
#define WIN_STRING_DIR_SEP wxT( "\\" )
 
 
// lowercase or pretty case depending on platform
#if defined( __WXMAC__ ) || defined( __WXMSW__ )
#define KICAD_PATH_STR wxT( "KiCad" )
#else
#define KICAD_PATH_STR  wxT( "kicad" )
#endif

class KICOMMON_API PATHS
{
public:

    static wxString GetUserScriptingPath();

    static wxString GetUserTemplatesPath();

    static wxString GetUserPluginsPath();

    static wxString GetDefaultUserProjectsPath();

    static wxString GetDefaultUserSymbolsPath();

    static wxString GetDefaultUserFootprintsPath();

    static wxString GetDefaultUserDesignBlocksPath();

    static wxString GetDefaultUser3DModelsPath();

    static wxString GetStockDataPath( bool aRespectRunFromBuildDir = true );

    static wxString GetStockEDALibraryPath();

    static wxString GetDefault3rdPartyPath();

    static wxString GetStockSymbolsPath();

    static wxString GetStockFootprintsPath();

    static wxString GetStockDesignBlocksPath();

    static wxString GetStock3dmodelsPath();

    static wxString GetStockScriptingPath();

    static wxString GetStockPluginsPath();

    static wxString GetStockPlugins3DPath();

    static wxString GetStockDemosPath();

    static wxString GetStockTemplatesPath();

    static wxString GetLocaleDataPath();

    static wxString GetUserCachePath();

    static wxString GetDocumentationPath();

    static wxString GetLogsPath();

    static bool EnsurePathExists( const wxString& aPath, bool aPathToFile = false );

    static void EnsureUserPathsExist();
 
#ifdef __WXMAC__
    static wxString GetOSXKicadUserDataDir();

    static wxString GetOSXKicadMachineDataDir();

    static wxString GetOSXKicadDataDir();
#endif
 
#ifdef _WIN32
    static wxString GetWindowsFontConfigDir();
 

    static wxString GetWindowsBaseSharePath();
#endif

    static wxString GetUserSettingsPath();

    static wxString CalculateUserSettingsPath( bool aIncludeVer = true, bool aUseEnv = true );
 
    static const wxString& GetExecutablePath();

    static wxString ResolveSiblingExecutable( const wxString& aBaseName );

    static wxString FindKiCadBuildRoot( const wxString& aExecutablePath );

    static const wxString& GetBuildRoot();

    static bool RunningFromBuildDir();
 
private:
    // we are a static helper
    PATHS() {}

    static void getUserDocumentPath( wxFileName& aPath );
 
#ifdef _WIN32
    static wxString getWindowsKiCadRoot();
#endif
};
 
#endif