X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Ffilesystem_paths.h;h=83f50fd1691609d719221dc15d8fa80e39ff8017;hb=8fce08610a55a9fb04afdfbefa69e9e4f18034cc;hp=12995bd81852c7d651eb53a7db817e27fc60ddb2;hpb=e6986c036059c9f9d5608f0b33f8c6d6ca1664ad;p=ardour.git

diff --git a/libs/ardour/ardour/filesystem_paths.h b/libs/ardour/ardour/filesystem_paths.h
index 12995bd818..83f50fd169 100644
--- a/libs/ardour/ardour/filesystem_paths.h
+++ b/libs/ardour/ardour/filesystem_paths.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2007 Tim Mayberry 
+    Copyright (C) 2007 Tim Mayberry
 
     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
@@ -20,31 +20,72 @@
 #ifndef ARDOUR_FILESYSTEM_PATHS_INCLUDED
 #define ARDOUR_FILESYSTEM_PATHS_INCLUDED
 
-#include <pbd/filesystem.h>
-#include <pbd/search_path.h>
+#include "pbd/search_path.h"
+
+#include "ardour/libardour_visibility.h"
 
 namespace ARDOUR {
 
-	using namespace PBD;
+	/**
+	 * @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 ();
 
 	/**
-	 * @return the path to the directory used to store user specific ardour
-	 * configuration files.
+	 * @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.
 	 */
-	sys::path 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.
 	 */
-	sys::path ardour_module_directory ();
+	LIBARDOUR_API std::string ardour_dll_directory ();
 
-	SearchPath ardour_search_path ();
+	/**
+	 * @return the search path to be used when looking for per-system
+	 * configuration files. This may include user configuration files.
+	 */
+	LIBARDOUR_API PBD::Searchpath ardour_config_search_path ();
 
-	SearchPath system_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)
+	 */
+	LIBARDOUR_API PBD::Searchpath ardour_data_search_path ();
 
-	SearchPath system_data_search_path ();
+#ifdef PLATFORM_WINDOWS
+	/**
+	 * @return our 'Windows' search path ( corresponds to <install_dir>/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