Patch [#22339] File/installation paths changes
[blender.git] / intern / ghost / GHOST_Path-api.h
1 /**
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2010 by Blender Foundation.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef GHOST_PATH_API_H
30 #define GHOST_PATH_API_H
31
32 #include "GHOST_Types.h"
33
34 #ifdef __cplusplus
35 extern "C" { 
36 #endif
37
38 /**
39  * Determine the base dir in which shared resources are located. It will first try to use
40  * "unpack and run" path, then look for properly installed path, not including versioning.
41  * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
42  */
43 extern const GHOST_TUns8* GHOST_getSystemDir();
44
45 /**
46  * Determine the base dir in which user configuration is stored, not including versioning.
47  * If needed, it will create the base directory.
48  * @return Unsigned char string pointing to user dir (eg ~/.blender/).
49  */
50 extern const GHOST_TUns8* GHOST_getUserDir();
51
52
53 /**
54  * Determine the dir in which the binary file is found.
55  * @return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
56  */
57 extern const GHOST_TUns8* GHOST_getBinaryDir();
58
59 #ifdef __cplusplus
60
61 #endif
62
63 #endif