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 ardour
  31          * configuration files.
  32          * @post user_config_directory() exists
  33          */
  34         LIBARDOUR_API std::string user_config_directory ();
  35
  36         /**
  37          * @return the path to the directory used to store user specific
  38          * caches (e.g. plugin indices, blacklist/whitelist)
  39          * it defaults to XDG_CACHE_HOME
  40          */
  41         LIBARDOUR_API std::string user_cache_directory ();
  42
  43
  44         /**
  45          * @return the path to the directory that contains the system wide ardour
  46          * modules.
  47          */
  48         LIBARDOUR_API std::string ardour_dll_directory ();
  49
  50         /**
  51          * @return the search path to be used when looking for per-system
  52          * configuration files. This may include user configuration files.
  53          */
  54         LIBARDOUR_API PBD::Searchpath ardour_config_search_path ();
  55
  56         /**
  57          * @return the search path to be used when looking for data files
  58          * that could be shared by systems (h/w and configuration independent
  59          * files, such as icons, XML files, etc)
  60          */
  61         LIBARDOUR_API PBD::Searchpath ardour_data_search_path ();
  62
  63 #ifdef PLATFORM_WINDOWS
  64         /**
  65          * @return our 'Windows' search path ( corresponds to <install_dir>/share/ardour3 )
  66          */
  67         LIBARDOUR_API PBD::Searchpath windows_search_path ();
  68 #endif
  69 } // namespace ARDOUR
  70
  71 #endif