access past array bounds in layerInterp_mdisps, also make some vars const.
[blender.git] / intern / ghost / GHOST_ISystemPaths.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) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 #ifndef _GHOST_ISYSTEMPATHS_H_
29 #define _GHOST_ISYSTEMPATHS_H_
30
31 #include "GHOST_Types.h"
32
33 class GHOST_ISystemPaths
34 {
35 public:
36         /**
37          * Creates the one and only system.
38          * @return An indication of success.
39          */
40         static GHOST_TSuccess create();
41
42         /**
43          * Disposes the one and only system.
44          * @return An indication of success.
45          */
46         static GHOST_TSuccess dispose();
47
48         /**
49          * Returns a pointer to the one and only system (nil if it hasn't been created).
50          * @return A pointer to the system.
51          */
52         static GHOST_ISystemPaths* get();
53
54 protected:
55         /**
56          * Constructor.
57          * Protected default constructor to force use of static createSystem member.
58          */
59         GHOST_ISystemPaths() {}
60
61         /**
62          * Destructor.
63          * Protected default constructor to force use of static dispose member.
64          */
65         virtual ~GHOST_ISystemPaths() {}
66
67 public:
68         /**
69          * Determine the base dir in which shared resources are located. It will first try to use
70          * "unpack and run" path, then look for properly installed path, not including versioning.
71          * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
72          */
73         virtual const GHOST_TUns8* getSystemDir() const = 0;
74
75         /**
76          * Determine the base dir in which user configuration is stored, not including versioning.
77          * If needed, it will create the base directory.
78          * @return Unsigned char string pointing to user dir (eg ~/.blender/).
79          */
80         virtual const GHOST_TUns8* getUserDir() const = 0;
81
82         /**
83           * Determine the directory of the current binary
84           * @return Unsigned char string pointing to the binary dir
85           */
86          virtual const GHOST_TUns8* getBinaryDir() const = 0;
87
88          /**
89           * Add the file to the operating system most recently used files
90           */
91          virtual void addToSystemRecentFiles(const char* filename) const = 0;
92
93 private:
94         /** The one and only system paths*/
95         static GHOST_ISystemPaths* m_systemPaths;
96 };
97
98 #endif