Merge branch 'master' into blender2.8
[blender.git] / intern / ghost / GHOST_ISystemPaths.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ghost/GHOST_ISystemPaths.h
28  *  \ingroup GHOST
29  */
30
31 #ifndef __GHOST_ISYSTEMPATHS_H__
32 #define __GHOST_ISYSTEMPATHS_H__
33
34 #include "GHOST_Types.h"
35
36 class GHOST_ISystemPaths
37 {
38 public:
39         /**
40          * Creates the one and only system.
41          * \return An indication of success.
42          */
43         static GHOST_TSuccess create();
44
45         /**
46          * Disposes the one and only system.
47          * \return An indication of success.
48          */
49         static GHOST_TSuccess dispose();
50
51         /**
52          * Returns a pointer to the one and only system (nil if it hasn't been created).
53          * \return A pointer to the system.
54          */
55         static GHOST_ISystemPaths *get();
56
57 protected:
58         /**
59          * Constructor.
60          * Protected default constructor to force use of static createSystem member.
61          */
62         GHOST_ISystemPaths() {
63         }
64
65         /**
66          * Destructor.
67          * Protected default constructor to force use of static dispose member.
68          */
69         virtual ~GHOST_ISystemPaths() {
70         }
71
72 public:
73         /**
74          * Determine the base dir in which shared resources are located. It will first try to use
75          * "unpack and run" path, then look for properly installed path, including versioning.
76          * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
77          */
78         virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const = 0;
79
80         /**
81          * Determine the base dir in which user configuration is stored, including versioning.
82          * If needed, it will create the base directory.
83          * \return Unsigned char string pointing to user dir (eg ~/.blender/).
84          */
85         virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const = 0;
86
87         /**
88          * Determine the directory of the current binary
89          * \return Unsigned char string pointing to the binary dir
90          */
91         virtual const GHOST_TUns8 *getBinaryDir() const = 0;
92
93         /**
94          * Add the file to the operating system most recently used files
95          */
96         virtual void addToSystemRecentFiles(const char *filename) const = 0;
97
98 private:
99         /** The one and only system paths*/
100         static GHOST_ISystemPaths *m_systemPaths;
101
102
103 #ifdef WITH_CXX_GUARDEDALLOC
104         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystemPaths")
105 #endif
106 };
107
108 #endif