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