X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Ffilesystem_paths.h;h=8e291dce97d8168c697fdb85eaa5b04bebc73de7;hb=8a4518d76fe78e5fb99900ff5ff71a22e5912395;hp=cfeb633597cb2fac5c34c22d704e9d791cb3728c;hpb=01db45859d395b30859a97ce2737b461df65f8e7;p=ardour.git diff --git a/libs/ardour/ardour/filesystem_paths.h b/libs/ardour/ardour/filesystem_paths.h index cfeb633597..8e291dce97 100644 --- a/libs/ardour/ardour/filesystem_paths.h +++ b/libs/ardour/ardour/filesystem_paths.h @@ -22,34 +22,70 @@ #include "pbd/search_path.h" +#include "ardour/libardour_visibility.h" + namespace ARDOUR { /** - * @return the path to the directory used to store user specific ardour - * configuration files. - * @post user_config_directory() exists + * @return the path to the directory used to store user specific + * configuration files for the given @param version of the program. + * If @param version is negative, the build-time string PROGRAM_VERSION + * will be used to determine the version number. + * + * @post user_config_directory() exists IF version was negative. + * + * + */ + LIBARDOUR_API std::string user_config_directory (int version = -1); + + /** + * @return the path to the directory used to store user specific + * caches (e.g. plugin indices, blacklist/whitelist) + * it defaults to XDG_CACHE_HOME + */ + LIBARDOUR_API std::string user_cache_directory (std::string cachename = ""); + + /** + * @return the path used to store a persistent indication + * that the given version of the program has been used before. + * + * @param version is the version to check for. If unspecified, + * it defaults to the current (build-time) version of the program. */ - std::string user_config_directory (); + LIBARDOUR_API std::string been_here_before_path (int version = -1); /** * @return the path to the directory that contains the system wide ardour * modules. */ - std::string ardour_dll_directory (); + LIBARDOUR_API std::string ardour_dll_directory (); /** * @return the search path to be used when looking for per-system * configuration files. This may include user configuration files. */ - PBD::SearchPath ardour_config_search_path (); + LIBARDOUR_API PBD::Searchpath ardour_config_search_path (); /** * @return the search path to be used when looking for data files * that could be shared by systems (h/w and configuration independent * files, such as icons, XML files, etc) */ - PBD::SearchPath ardour_data_search_path (); + LIBARDOUR_API PBD::Searchpath ardour_data_search_path (); +#ifdef PLATFORM_WINDOWS + /** + * @return our 'Windows' search path ( corresponds to /share/ardour3 ) + */ + LIBARDOUR_API PBD::Searchpath windows_search_path (); + + /** + * @return Convenience function that calls + * g_win32_get_package_installation_directory_of_module but returns a + * std::string + */ + LIBARDOUR_API std::string windows_package_directory_path (); +#endif } // namespace ARDOUR #endif