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