diff options
author | Andrea Weikert <elubie@gmx.net> | 2011-01-05 17:00:14 +0300 |
---|---|---|
committer | Andrea Weikert <elubie@gmx.net> | 2011-01-05 17:00:14 +0300 |
commit | 195cc9c6a647a98cf0f8c760867233dfa2479357 (patch) | |
tree | 443d8897353f6ac55912169c2307574d6d169942 /intern/ghost/GHOST_ISystemPaths.h | |
parent | 8e29c7b76f23028e679e7dc97c90eba795604b5d (diff) |
ToDo: long outstanding patch to allow access to system paths in background mode
Thanks Damien Plisson for contributing the Carbon and Cocoa implementation
Diffstat (limited to 'intern/ghost/GHOST_ISystemPaths.h')
-rw-r--r-- | intern/ghost/GHOST_ISystemPaths.h | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/intern/ghost/GHOST_ISystemPaths.h b/intern/ghost/GHOST_ISystemPaths.h new file mode 100644 index 00000000000..a4bb94229e0 --- /dev/null +++ b/intern/ghost/GHOST_ISystemPaths.h @@ -0,0 +1,93 @@ +/** + * $Id: $ + * + * ***** BEGIN GPL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * The Original Code is Copyright (C) 2009 Blender Foundation. + * All rights reserved. + * + * + * Contributor(s): Blender Foundation + * + * ***** END GPL LICENSE BLOCK ***** + */ +#ifndef _GHOST_ISYSTEMPATHS_H_ +#define _GHOST_ISYSTEMPATHS_H_ + +#include "GHOST_Types.h" + +class GHOST_ISystemPaths +{ +public: + /** + * Creates the one and only system. + * @return An indication of success. + */ + static GHOST_TSuccess create(); + + /** + * Disposes the one and only system. + * @return An indication of success. + */ + static GHOST_TSuccess dispose(); + + /** + * Returns a pointer to the one and only system (nil if it hasn't been created). + * @return A pointer to the system. + */ + static GHOST_ISystemPaths* get(); + +protected: + /** + * Constructor. + * Protected default constructor to force use of static createSystem member. + */ + GHOST_ISystemPaths() {} + + /** + * Destructor. + * Protected default constructor to force use of static dispose member. + */ + virtual ~GHOST_ISystemPaths() {} + +public: + /** + * Determine the base dir in which shared resources are located. It will first try to use + * "unpack and run" path, then look for properly installed path, not including versioning. + * @return Unsigned char string pointing to system dir (eg /usr/share/blender/). + */ + virtual const GHOST_TUns8* getSystemDir() const = 0; + + /** + * Determine the base dir in which user configuration is stored, not including versioning. + * If needed, it will create the base directory. + * @return Unsigned char string pointing to user dir (eg ~/.blender/). + */ + virtual const GHOST_TUns8* getUserDir() const = 0; + + /** + * Determine the directory of the current binary + * @return Unsigned char string pointing to the binary dir + */ + virtual const GHOST_TUns8* getBinaryDir() const = 0; + +private: + /** The one and only system paths*/ + static GHOST_ISystemPaths* m_systemPaths; +}; + +#endif |