Merge branch 'blender2.7'
[blender.git] / intern / ghost / intern / GHOST_SystemPathsUnix.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) 2010 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file ghost/intern/GHOST_SystemPathsUnix.h
28  *  \ingroup GHOST
29  */
30
31
32 #ifndef __GHOST_SYSTEMPATHSUNIX_H__
33 #define __GHOST_SYSTEMPATHSUNIX_H__
34
35 #include "GHOST_SystemPaths.h"
36 #include "../GHOST_Types.h"
37
38
39 class GHOST_SystemPathsUnix : public GHOST_SystemPaths {
40 public:
41
42         /**
43          * Constructor
44          * this class should only be instanciated by GHOST_ISystem.
45          */
46         GHOST_SystemPathsUnix();
47
48         /**
49          * Destructor.
50          */
51         ~GHOST_SystemPathsUnix();
52
53         /**
54          * Determine the base dir in which shared resources are located. It will first try to use
55          * "unpack and run" path, then look for properly installed path, including versioning.
56          * \return Unsigned char string pointing to system dir (eg `/usr/share/blender/`).
57          */
58         const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
59
60         /**
61          * Determine the base dir in which user configuration is stored, including versioning.
62          * If needed, it will create the base directory.
63          * \return Unsigned char string pointing to user dir (eg `~/.config/.blender/`).
64          */
65         const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
66
67         /**
68          * Determine the directory of the current binary
69          * \return Unsigned char string pointing to the binary dir
70          */
71         const GHOST_TUns8 *getBinaryDir() const;
72
73         /**
74          * Add the file to the operating system most recently used files
75          */
76         void addToSystemRecentFiles(const char *filename) const;
77 };
78
79 #endif  /* __GHOST_SYSTEMPATHSUNIX_H__ */