Merge branch 'blender2.7'
[blender.git] / intern / ghost / GHOST_Path-api.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2010 by Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup GHOST
21  */
22
23
24 #ifndef __GHOST_PATH_API_H__
25 #define __GHOST_PATH_API_H__
26
27 #include "GHOST_Types.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
34
35 /**
36  * Creates the one and only instance of the system path access.
37  * \return An indication of success.
38  */
39 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
40
41 /**
42  * Disposes the one and only system.
43  * \return An indication of success.
44  */
45 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
46
47 /**
48  * Determine the base dir in which shared resources are located. It will first try to use
49  * "unpack and run" path, then look for properly installed path, including versioning.
50  * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
51  */
52 extern const GHOST_TUns8 *GHOST_getSystemDir(int version, const char *versionstr);
53
54 /**
55  * Determine the base dir in which user configuration is stored, including versioning.
56  * \return Unsigned char string pointing to user dir (eg ~).
57  */
58 extern const GHOST_TUns8 *GHOST_getUserDir(int version, const char *versionstr);
59
60
61 /**
62  * Determine the dir in which the binary file is found.
63  * \return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
64  */
65 extern const GHOST_TUns8 *GHOST_getBinaryDir(void);
66
67 /**
68  * Add the file to the operating system most recently used files
69  */
70 extern void GHOST_addToSystemRecentFiles(const char *filename);
71
72 #ifdef __cplusplus
73 }
74 #endif
75
76 #endif