migrated NDOF code from soc-2010-merwin, SpaceNavigator now works on Mac blender
[blender.git] / intern / ghost / intern / GHOST_SystemPathsCarbon.h
1 /*
2  * $Id$
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 /** \file ghost/intern/GHOST_SystemPathsCarbon.h
30  *  \ingroup GHOST
31  */
32
33
34 #ifndef _GHOST_SYSTEM_PATHS_CARBON_H_
35 #define _GHOST_SYSTEM_PATHS_CARBON_H_
36
37 #ifndef __APPLE__
38 #error Apple OSX only!
39 #endif // __APPLE__
40
41 #include <Carbon/Carbon.h>
42
43 #include "GHOST_SystemPaths.h"
44
45 /**
46  * OSX/Carbon Implementation of GHOST_SystemPaths class.
47  * @see GHOST_System.
48  * @author      Andrea Weikert
49  * @date        Aug 1, 2010
50  */
51 class GHOST_SystemPathsCarbon : public GHOST_SystemPaths {
52 public:
53     /**
54      * Constructor.
55      */
56     GHOST_SystemPathsCarbon();
57     
58     /** 
59      * Destructor.
60      */
61     ~GHOST_SystemPathsCarbon();
62     
63         /**
64          * Determine the base dir in which shared resources are located. It will first try to use
65          * "unpack and run" path, then look for properly installed path, not including versioning.
66          * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
67          */
68         virtual const GHOST_TUns8* getSystemDir() const;
69
70         /**
71          * Determine the base dir in which user configuration is stored, not including versioning.
72          * If needed, it will create the base directory.
73          * @return Unsigned char string pointing to user dir (eg ~/.blender/).
74          */
75         virtual const GHOST_TUns8* getUserDir() const;
76
77         /**
78           * Determine the directory of the current binary
79           * @return Unsigned char string pointing to the binary dir
80           */
81          virtual const GHOST_TUns8* getBinaryDir() const;
82
83         /**
84           * Add the file to the operating system most recently used files
85           */
86          void addToSystemRecentFiles(const char* filename) const;
87 };
88
89 #endif // _GHOST_SYSTEM_CARBON_H_
90
91
92