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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�rfer
//
// Broken Sword 2.5 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.
//
// Broken Sword 2.5 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 Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------
/*
Die Klasse BS_FileSystemUtil stellt einen Wrapper f�r dateisystemspezifische Operationen dar, die nicht �ber die C/C++ Bibliotheken
abgedeckt werden.
Jede unterst�tzte Plattform muss dieses Interface implementieren und die Singleton-Methode BS_FileSystemUtil::GetInstance()
implementieren.
*/
#ifndef SWORD25_FILESYSTEMUTIL_H
#define SWORD25_FILESYSTEMUTIL_H
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
#include "sword25/kernel/common.h"
#include "sword25/kernel/bs_stdint.h"
#include "sword25/kernel/memlog_off.h"
#include <string>
#include <vector>
#include <ctime>
#include "sword25/kernel/memlog_on.h"
// -----------------------------------------------------------------------------
// Klassendefinition
// -----------------------------------------------------------------------------
class BS_FileSystemUtil
{
public:
static BS_FileSystemUtil & GetInstance();
virtual ~BS_FileSystemUtil() {};
/*
Diese Funktion gibt den Namen des Verzeichnisses zur�ck, in dem s�mtliche Benutzerdaten gespeichert werden sollen.
Dieses sind z.B. Screenshots, Spielst�nde, Konfigurationsdateien, Logdateien, ...
Unter Windows Vista ist dieses beispielsweise: C:\Users\Malte\Documents\Broken Sword 2.5
Falls dieses Verzeichnis noch nicht existiert, wird es automatisch erstellt.
@return Gibt den Namen des Verzeichnisses f�r Benutzerdaten zur�ck.
*/
virtual std::string GetUserdataDirectory() = 0;
/*
@return Gibt den Pfadtrenner zur�ck (z.B. \ unter Windows und / unter Linux).
*/
virtual std::string GetPathSeparator() = 0;
/*
@param Filename der Pfad zu einer Datei.
@return Gibt die Gr��e der angegebenen Datei zur�ck. Falls die Gr��e nicht bestimmt werden konnte, oder die Datei nicht existiert wird -1 zur�ckgegeben.
*/
virtual uint64_t GetFileSize(const std::string & Filename) = 0;
/*
@param Filename der Pfad zu einer Datei.
@return Gibt den Zeitstempel des Zeitpunktes zur�ck an dem die Datei zuletzt ver�ndert wurde. Bei einem Fehler wird 0 zur�ckgegeben.
*/
virtual time_t GetFileTime(const std::string & Filename) = 0;
/*
@param Filename der Pfad zu einer Datei.
@return Gibt true zur�ck, wenn die Datei existiert.
*/
virtual bool FileExists(const std::string & Filename) = 0;
/*
Diese Funktion erstellt einen Verzeichnis mit s�mtlichen Unterverzeichnissen.
Wenn des Parameter "\b\c\d\e" ist und der Pfad "\b\c" bereits existiert, werden die Verzeichnisse
"d" und "e" erstellt.
@param DirectoryName der Name des zu erstellenden Verzeichnisses.
@return Gibt true zur�ck, wenn die Verzeichnisse erstellt werden konnten, ansonsten false.
*/
virtual bool CreateDirectory(const std::string & DirectoryName) = 0;
/*
Erstellt eine Liste aller Dateinamen in einem Verzeichnis.
@param Directory das zu durchsuchende Verzeichnis.
@return Gibt einen vector mit allen gefundenen Dateinamen zur�ck.
*/
virtual std::vector<std::string> GetFilesInDirectory(const std::string & Path) = 0;
};
#endif
|
