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