Merge branch 'blender2.7'
[blender.git] / intern / ghost / intern / GHOST_SystemPathsCocoa.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 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Damien Plisson 2010
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ghost/intern/GHOST_SystemPathsCocoa.h
28  *  \ingroup GHOST
29  */
30
31
32 #ifndef __GHOST_SYSTEMPATHSCOCOA_H__
33 #define __GHOST_SYSTEMPATHSCOCOA_H__
34
35 #ifndef __APPLE__
36 #error Apple OSX only!
37 #endif // __APPLE__
38
39
40 #include "GHOST_SystemPaths.h"
41
42
43 class GHOST_SystemPathsCocoa : public GHOST_SystemPaths {
44 public:
45         /**
46          * Constructor.
47          */
48         GHOST_SystemPathsCocoa();
49
50         /**
51          * Destructor.
52          */
53         ~GHOST_SystemPathsCocoa();
54
55         /**
56          * Determine the base dir in which shared resources are located. It will first try to use
57          * "unpack and run" path, then look for properly installed path, including versioning.
58          * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
59          */
60         const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
61
62         /**
63          * Determine the base dir in which user configuration is stored, including versioning.
64          * If needed, it will create the base directory.
65          * \return Unsigned char string pointing to user dir (eg ~/.blender/).
66          */
67         const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
68
69         /**
70          * Determine the directory of the current binary
71          * \return Unsigned char string pointing to the binary dir
72          */
73         const GHOST_TUns8 *getBinaryDir() const;
74
75         /**
76          * Add the file to the operating system most recently used files
77          */
78         void addToSystemRecentFiles(const char *filename) const;
79 };
80
81 #endif // __GHOST_SYSTEMPATHSCOCOA_H__