1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*
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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef ARDOUR_FILESYSTEM_PATHS_INCLUDED
#define ARDOUR_FILESYSTEM_PATHS_INCLUDED
#include "pbd/search_path.h"
#include "ardour/libardour_visibility.h"
namespace ARDOUR {
/**
* @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 that contains the system wide ardour
* modules.
*/
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.
*/
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)
*/
LIBARDOUR_API PBD::Searchpath ardour_data_search_path ();
#ifdef PLATFORM_WINDOWS
/**
* @return our 'Windows' search path ( corresponds to <install_dir>/share/ardour3 )
*/
LIBARDOUR_API PBD::Searchpath windows_search_path ();
#endif
} // namespace ARDOUR
#endif
|
