ToDo: long outstanding patch to allow access to system paths in background mode
[blender.git] / intern / ghost / intern / GHOST_SystemPathsX11.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): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef _GHOST_SYSTEM_PATHS_X11_H_
30 #define _GHOST_SYSTEM_PATHS_X11_H_
31
32 #include "GHOST_SystemPaths.h"
33 #include "../GHOST_Types.h"
34
35
36 class GHOST_SystemPathsX11 : public GHOST_SystemPaths {
37 public:
38
39         /**
40          * Constructor
41          * this class should only be instanciated by GHOST_ISystem.
42          */
43         GHOST_SystemPathsX11();
44         
45         /**
46          * Destructor.
47          */
48         virtual ~GHOST_SystemPathsX11();
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         const GHOST_TUns8* getSystemDir() const;
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         const GHOST_TUns8* getUserDir() const;
63
64         /**
65           * Determine the directory of the current binary
66           * @return Unsigned char string pointing to the binary dir
67           */
68          const GHOST_TUns8* getBinaryDir() const;
69
70 };
71
72 #endif
73