4 * ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
20 * The Original Code is Copyright (C) 2010 by Blender Foundation.
21 * All rights reserved.
23 * The Original Code is: all of this file.
25 * Contributor(s): none yet.
27 * ***** END GPL LICENSE BLOCK *****
30 #ifndef GHOST_PATH_API_H
31 #define GHOST_PATH_API_H
33 #include "GHOST_Types.h"
39 GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
42 * Creates the one and only instance of the system path access.
43 * @return An indication of success.
45 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
48 * Disposes the one and only system.
49 * @return An indication of success.
51 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
54 * Determine the base dir in which shared resources are located. It will first try to use
55 * "unpack and run" path, then look for properly installed path, not including versioning.
56 * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
58 extern const GHOST_TUns8* GHOST_getSystemDir(void);
61 * Determine the base dir in which user configuration is stored, not including versioning.
62 * @return Unsigned char string pointing to user dir (eg ~).
64 extern const GHOST_TUns8* GHOST_getUserDir(void);
68 * Determine the dir in which the binary file is found.
69 * @return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
71 extern const GHOST_TUns8* GHOST_getBinaryDir(void);
74 * Add the file to the operating system most recently used files
76 extern void GHOST_addToSystemRecentFiles(const char* filename);