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