libs/ardour/ardour/filesystem_paths.h

   1 /*
   2     Copyright (C) 2007 Tim Mayberry
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef ARDOUR_FILESYSTEM_PATHS_INCLUDED
  21 #define ARDOUR_FILESYSTEM_PATHS_INCLUDED
  22
  23 #include "pbd/search_path.h"
  24
  25 #include "ardour/libardour_visibility.h"
  26
  27 namespace ARDOUR {
  28
  29         /**
  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.
  34          *
  35          * @post user_config_directory() exists IF version was negative.
  36          *
  37          *
  38          */
  39         LIBARDOUR_API std::string user_config_directory (int version = -1);
  40
  41         /**
  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
  45          */
  46         LIBARDOUR_API std::string user_cache_directory ();
  47
  48         /**
  49          * @return the path used to store a persistent indication
  50          * that the given version of the program has been used before.
  51          *
  52          * @param version is the version to check for. If unspecified,
  53          * it defaults to the current (build-time) version of the program.
  54          */
  55         LIBARDOUR_API std::string been_here_before_path (int version = -1);
  56
  57         /**
  58          * @return the path to the directory that contains the system wide ardour
  59          * modules.
  60          */
  61         LIBARDOUR_API std::string ardour_dll_directory ();
  62
  63         /**
  64          * @return the search path to be used when looking for per-system
  65          * configuration files. This may include user configuration files.
  66          */
  67         LIBARDOUR_API PBD::Searchpath ardour_config_search_path ();
  68
  69         /**
  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)
  73          */
  74         LIBARDOUR_API PBD::Searchpath ardour_data_search_path ();
  75
  76 #ifdef PLATFORM_WINDOWS
  77         /**
  78          * @return our 'Windows' search path ( corresponds to <install_dir>/share/ardour3 )
  79          */
  80         LIBARDOUR_API PBD::Searchpath windows_search_path ();
  81
  82         /**
  83          * @return Convenience function that calls
  84          * g_win32_get_package_installation_directory_of_module but returns a
  85          * std::string
  86          */
  87         LIBARDOUR_API std::string windows_package_directory_path ();
  88 #endif
  89 } // namespace ARDOUR
  90
  91 #endif