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
21  * \ingroup GHOST
22  */
23
24
25 #ifndef __GHOST_PATH_API_H__
26 #define __GHOST_PATH_API_H__
27
28 #include "GHOST_Types.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
35
36 /**
37  * Creates the one and only instance of the system path access.
38  * \return An indication of success.
39  */
40 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
41
42 /**
43  * Disposes the one and only system.
44  * \return An indication of success.
45  */
46 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
47
48 /**
49  * Determine the base dir in which shared resources are located. It will first try to use
50  * "unpack and run" path, then look for properly installed path, including versioning.
51  * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
52  */
53 extern const GHOST_TUns8 *GHOST_getSystemDir(int version, const char *versionstr);
54
55 /**
56  * Determine the base dir in which user configuration is stored, including versioning.
57  * \return Unsigned char string pointing to user dir (eg ~).
58  */
59 extern const GHOST_TUns8 *GHOST_getUserDir(int version, const char *versionstr);
60
61
62 /**
63  * Determine the dir in which the binary file is found.
64  * \return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
65  */
66 extern const GHOST_TUns8 *GHOST_getBinaryDir(void);
67
68 /**
69  * Add the file to the operating system most recently used files
70  */
71 extern void GHOST_addToSystemRecentFiles(const char *filename);
72
73 #ifdef __cplusplus
74 }
75 #endif
76
77 #endif