Merged changes in the trunk up to revision 44221.
[blender.git] / intern / ghost / GHOST_Path-api.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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 Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2010 by Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/GHOST_Path-api.h
29  *  \ingroup GHOST
30  */
31
32
33 #ifndef __GHOST_PATH_API_H__
34 #define __GHOST_PATH_API_H__
35
36 #include "GHOST_Types.h"
37
38 #ifdef __cplusplus
39 extern "C" { 
40 #endif
41
42 GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
43
44 /**
45  * Creates the one and only instance of the system path access.
46  * @return An indication of success.
47  */
48 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
49
50 /**
51  * Disposes the one and only system.
52  * @return An indication of success.
53  */
54 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
55
56 /**
57  * Determine the base dir in which shared resources are located. It will first try to use
58  * "unpack and run" path, then look for properly installed path, not including versioning.
59  * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
60  */
61 extern const GHOST_TUns8* GHOST_getSystemDir(void);
62
63 /**
64  * Determine the base dir in which user configuration is stored, not including versioning.
65  * @return Unsigned char string pointing to user dir (eg ~).
66  */
67 extern const GHOST_TUns8* GHOST_getUserDir(void);
68
69
70 /**
71  * Determine the dir in which the binary file is found.
72  * @return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
73  */
74 extern const GHOST_TUns8* GHOST_getBinaryDir(void);
75
76 /**
77 * Add the file to the operating system most recently used files
78 */
79 extern void GHOST_addToSystemRecentFiles(const char* filename);
80
81 #ifdef __cplusplus
82
83 #endif
84
85 #endif