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 namespace ARDOUR {
  26
  27         /**
  28          * @return the path to the directory used to store user specific ardour
  29          * configuration files.
  30          * @post user_config_directory() exists
  31          */
  32         std::string user_config_directory ();
  33
  34         /**
  35          * @return the path to the directory that contains the system wide ardour
  36          * modules.
  37          */
  38         std::string ardour_dll_directory ();
  39
  40         /**
  41          * @return the search path to be used when looking for per-system
  42          * configuration files. This may include user configuration files.
  43          */
  44         PBD::SearchPath ardour_config_search_path ();
  45
  46         /**
  47          * @return the search path to be used when looking for data files
  48          * that could be shared by systems (h/w and configuration independent
  49          * files, such as icons, XML files, etc)
  50          */
  51         PBD::SearchPath ardour_data_search_path ();
  52
  53 } // namespace ARDOUR
  54
  55 #endif