mirror of
https://github.com/libretro/scummvm.git
synced 2025-01-06 01:31:39 +00:00
ab13d18e58
In most cases they are the same, but in the case of a sandboxed filesystem, they may be different. Mapping to the full system path allows using the path with system functions, such as fopen() or third party libraries (for example to pass a soundfont path to the fluidsynth library).
78 lines
2.7 KiB
C++
78 lines
2.7 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* 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 3 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, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef FILESYSTEM_FACTORY_H
|
|
#define FILESYSTEM_FACTORY_H
|
|
|
|
#include "common/str.h"
|
|
#include "backends/fs/abstract-fs.h"
|
|
|
|
/**
|
|
* Creates concrete FSNode objects depending on the current architecture.
|
|
*/
|
|
class FilesystemFactory {
|
|
public:
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~FilesystemFactory() {}
|
|
|
|
/**
|
|
* Returns a node representing the "current directory".
|
|
* If your system does not support this concept, you can either try to
|
|
* emulate it or simply return some "sensible" default directory node,
|
|
* e.g. the same value as getRoot() returns.
|
|
*/
|
|
virtual AbstractFSNode *makeCurrentDirectoryFileNode() const = 0;
|
|
|
|
/**
|
|
* Construct a node based on a path; the path is in the same format as it
|
|
* would be for calls to fopen().
|
|
*
|
|
* Furthermore getNodeForPath(oldNode.path()) should create a new node
|
|
* identical to oldNode. Hence, we can use the "path" value for persistent
|
|
* storage e.g. in the config file.
|
|
*
|
|
* @param path The path string to create a FSNode for.
|
|
*/
|
|
virtual AbstractFSNode *makeFileNodePath(const Common::String &path) const = 0;
|
|
|
|
/**
|
|
* Returns a special node representing the filesystem root.
|
|
* The starting point for any file system browsing.
|
|
*
|
|
* On Unix, this will be simply the node for / (the root directory).
|
|
* On Windows, it will be a special node which "contains" all drives (C:, D:, E:).
|
|
*/
|
|
virtual AbstractFSNode *makeRootFileNode() const = 0;
|
|
|
|
/**
|
|
* Returns a path suitable for systen functions such as fopen() for the given ScummVM path,
|
|
*
|
|
* In most cases the returned path is the same as the given path, but it may be different, for
|
|
* example when the application is sandboxed and ScummVM path are relative to the saandbox
|
|
* root.
|
|
*/
|
|
virtual Common::String getSystemFullPath(const Common::String& path) const { return path; }
|
|
};
|
|
|
|
#endif /*FILESYSTEM_FACTORY_H*/
|