aboutsummaryrefslogtreecommitdiff
path: root/backends/factories/abstract-fs-factory.h
blob: b06ad632282bbe3ed4e68837418e2f06585360ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef ABSTRACT_FILESYSTEM_FACTORY_H
#define ABSTRACT_FILESYSTEM_FACTORY_H

#include "common/str.h"
#include "backends/fs/abstract-fs.h"
#include "backends/file/base-file.h"

/**
 * Creates concrete FilesystemNode objects depending on the current architecture.
 */
class AbstractFilesystemFactory {
public:
	typedef Common::String String;
	
	/**
	 * Destructor.
	 */
	virtual ~AbstractFilesystemFactory() {}
	
	/**
	 * 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 AbstractFilesystemNode *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 FilesystemNode for.
	 */
	virtual AbstractFilesystemNode *makeFileNodePath(const 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 AbstractFilesystemNode *makeRootFileNode() const = 0;
	
	/**
	 * Creates a base file usable by the Common::File wrapper to implement several
	 * methods.
	 */
	virtual BaseFile *makeBaseFile() const = 0;
};

#endif /*ABSTRACT_FILESYSTEM_FACTORY_H*/