d32d787f5f
For example
```
OIIOOutputDriver::~OIIOOutputDriver()
{
}
```
becomes
```
OIIOOutputDriver::~OIIOOutputDriver() {}
```
Saves quite some vertical space, which is especially handy for
constructors.
Pull Request: https://projects.blender.org/blender/blender/pulls/105594
85 lines
2.3 KiB
C++
85 lines
2.3 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2009 Blender Foundation. All rights reserved. */
|
|
|
|
/** \file
|
|
* \ingroup GHOST
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#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, including versioning.
|
|
* \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
|
|
*/
|
|
virtual const char *getSystemDir(int version, const char *versionstr) const = 0;
|
|
|
|
/**
|
|
* Determine the base dir in which user configuration is stored, including versioning.
|
|
* If needed, it will create the base directory.
|
|
* \return Unsigned char string pointing to user dir (eg ~/.blender/).
|
|
*/
|
|
virtual const char *getUserDir(int version, const char *versionstr) const = 0;
|
|
|
|
/**
|
|
* Determine a special ("well known") and easy to reach user directory.
|
|
* \return Unsigned char string pointing to user dir (eg `~/Documents/`).
|
|
*/
|
|
virtual const char *getUserSpecialDir(GHOST_TUserSpecialDirTypes type) const = 0;
|
|
|
|
/**
|
|
* Determine the directory of the current binary
|
|
* \return Unsigned char string pointing to the binary dir
|
|
*/
|
|
virtual const char *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;
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystemPaths")
|
|
#endif
|
|
};
|