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