2 Copyright (C) 2007 Tim Mayberry
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef ARDOUR_FILESYSTEM_PATHS_INCLUDED
21 #define ARDOUR_FILESYSTEM_PATHS_INCLUDED
23 #include "pbd/search_path.h"
25 #include "ardour/libardour_visibility.h"
30 * @return the path to the directory used to store user specific
31 * configuration files for the given @param version of the program.
32 * If @param version is negative, the build-time string PROGRAM_VERSION
33 * will be used to determine the version number.
35 * @post user_config_directory() exists IF version was negative.
39 LIBARDOUR_API std::string user_config_directory (int version = -1);
42 * @return the path to the directory used to store user specific
43 * caches (e.g. plugin indices, blacklist/whitelist)
44 * it defaults to XDG_CACHE_HOME
46 LIBARDOUR_API std::string user_cache_directory (std::string cachename = "");
49 * @return the path used to store a persistent indication
50 * that the given version of the program has been used before.
52 * @param version is the version to check for. If unspecified,
53 * it defaults to the current (build-time) version of the program.
55 LIBARDOUR_API std::string been_here_before_path (int version = -1);
58 * @return the path to the directory that contains the system wide ardour
61 LIBARDOUR_API std::string ardour_dll_directory ();
64 * @return the search path to be used when looking for per-system
65 * configuration files. This may include user configuration files.
67 LIBARDOUR_API PBD::Searchpath ardour_config_search_path ();
70 * @return the search path to be used when looking for data files
71 * that could be shared by systems (h/w and configuration independent
72 * files, such as icons, XML files, etc)
74 LIBARDOUR_API PBD::Searchpath ardour_data_search_path ();
76 #ifdef PLATFORM_WINDOWS
78 * @return our 'Windows' search path ( corresponds to <install_dir>/share/ardour3 )
80 LIBARDOUR_API PBD::Searchpath windows_search_path ();
83 * @return Convenience function that calls
84 * g_win32_get_package_installation_directory_of_module but returns a
87 LIBARDOUR_API std::string windows_package_directory_path ();