Cleanup: remove contributors for CMake files
[blender.git] / intern / ghost / intern / GHOST_SystemPathsCocoa.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 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file ghost/intern/GHOST_SystemPathsCocoa.h
21  *  \ingroup GHOST
22  */
23
24
25 #ifndef __GHOST_SYSTEMPATHSCOCOA_H__
26 #define __GHOST_SYSTEMPATHSCOCOA_H__
27
28 #ifndef __APPLE__
29 #error Apple OSX only!
30 #endif // __APPLE__
31
32
33 #include "GHOST_SystemPaths.h"
34
35
36 class GHOST_SystemPathsCocoa : public GHOST_SystemPaths {
37 public:
38         /**
39          * Constructor.
40          */
41         GHOST_SystemPathsCocoa();
42
43         /**
44          * Destructor.
45          */
46         ~GHOST_SystemPathsCocoa();
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         const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
54
55         /**
56          * Determine the base dir in which user configuration is stored, including versioning.
57          * If needed, it will create the base directory.
58          * \return Unsigned char string pointing to user dir (eg ~/.blender/).
59          */
60         const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
61
62         /**
63          * Determine the directory of the current binary
64          * \return Unsigned char string pointing to the binary dir
65          */
66         const GHOST_TUns8 *getBinaryDir() const;
67
68         /**
69          * Add the file to the operating system most recently used files
70          */
71         void addToSystemRecentFiles(const char *filename) const;
72 };
73
74 #endif // __GHOST_SYSTEMPATHSCOCOA_H__