forked from bartvdbraak/blender
104 lines
2.8 KiB
C++
104 lines
2.8 KiB
C++
/*
|
|
* $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 *****
|
|
*/
|
|
|
|
/** \file ghost/GHOST_ISystemPaths.h
|
|
* \ingroup GHOST
|
|
*/
|
|
|
|
#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;
|
|
|
|
/**
|
|
* Add the file to the operating system most recently used files
|
|
*/
|
|
virtual void addToSystemRecentFiles(const char* filename) const = 0;
|
|
|
|
private:
|
|
/** The one and only system paths*/
|
|
static GHOST_ISystemPaths* m_systemPaths;
|
|
};
|
|
|
|
#endif
|