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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
// -----------------------------------------------------------------------------
// 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
// -----------------------------------------------------------------------------
/*
BS_PackageManager
-------------
Dies ist das Package Manager Interface, dass alle Methoden enth�lt, die ein Package Manager
implementieren muss.
Beim Package Manager ist folgendes zu beachten:
1. es wird ein komplett neuer (virtueller) Verzeichnisbaum erstellt,
in den Packages und Verzeichnisse gemounted werden k�nnen.
2. zum Trennen von Elementen eines Verzeichnisspfades wird '/' statt '\' verwendet.
3. LoadDirectoryAsPackage sollte nur zum Testen benutzt werden. Im Final Release sollen sich
alle Dateien in echten Packages befinden.
Autor: Malte Thiesen, $author$
*/
#ifndef BS_PACKAGE_MANAGER_H
#define BS_PACKAGE_MANAGER_H
// Includes
#include "kernel/common.h"
#include "kernel/kernel.h"
#include "kernel/service.h"
// Klassendefinition
/**
@brief Das Package Manager Interface
Beim Package Manager ist folgendes zu beachten:<br>
1. es wird ein komplett neuer (virtueller) Verzeichnisbaum erstellt,
in den Packages und Verzeichnisse gemounted werden k�nnen.<br>
2. zum Trennen von Elementen eines Verzeichnisspfades wird '/' statt '\' verwendet.<br>
3. LoadDirectoryAsPackage sollte nur zum Testen benutzt werden. Im Final Release sollen sich
alle Dateien in echten Packages befinden.
*/
class BS_PackageManager : public BS_Service
{
public:
BS_PackageManager(BS_Kernel* pKernel);
virtual ~BS_PackageManager() {};
enum FILE_TYPES
{
FT_DIRECTORY = (1<<0),
FT_FILE = (1<<1)
};
/**
@brief Mit Instanzen dieses Objektes wird nach Dateien gesucht.
Objekte diesen Types wird mit BS_PackageManager::CreateSearch erzeugt.
*/
class FileSearch
{
public:
virtual ~FileSearch(){};
/**
@brief Gibt den Dateinamen der aktuellen Datei zur�ck.
@return Gibt den Dateinamen der aktuellen Datei zur�ck.
*/
virtual std::string GetCurFileName() = 0;
/**
@brief Gibt den Typ der aktuellen Datei zur�ck.
@return Gibt den Typ der aktuellen Datei zur�ck.<br>
Dieses ist entweder BS_PackageManager::FT_FILE oder BS_PackageManager::FT_DIRECTORY.
*/
virtual unsigned int GetCurFileType() = 0;
/**
@brief Gibt die Gr��e der aktuellen Datei zur�ck.
@return Gibt die Gr��e der aktuellen Datei zur�ck.<br>
Bei Verzeichnissen ist dieser Wert immer 0.
*/
virtual unsigned int GetCurFileSize() = 0;
// Sucht die n�chste Datei
// Gibt false zur�ck, falls keine weitere Datei gefunden wurde
/**
@brief Sucht die n�chste Datei.
@return Gibt false zur�ck, falls keine weitere Datei die Suchkriterien erf�llte.
*/
virtual bool NextFile() = 0;
};
/**
@brief Mounted den Inhalt eines Packages in das angegebene Verzeichnis im virtuellen Verzeichnisbaum.
@param FileName der Dateiname des zu mountenden Packages
@param MountPosition der Verzeichnisname, unter dem das Package gemounted werden soll
@return Gibt true zur�ck falls das mounten erfolgreich war, andernfalls false.
*/
virtual bool LoadPackage(const std::string& FileName, const std::string& MountPosition) = 0;
/**
@brief Mounted den Inhalt eines Verzeichnisses in das angegebene Verzeichnis im virtuellen Verzeichnisbaum.
@param DirectoryName der Name des zu mountenden Verzeichnisses
@param MountPosition der Verzeichnisname, unter dem das Verzeichnis gemounted werden soll
@return Gibt true zur�ck falls das mounten erfolgreich war, andernfalls false.
*/
virtual bool LoadDirectoryAsPackage(const std::string& DirectoryName, const std::string& MountPosition) = 0;
/**
@brief L�dt eine Datei aus dem virtuellen Verzeichnisbaum.
@param FileName der Dateiname der zu ladenden Datei
@param pFileSize Pointer auf die Variable, die die Gr��e der geladenen Datei enthalten soll<br>
Der Standardwert ist NULL.
@return Gibt einen Pointer auf die Dateidaten z�r�ck, oder NULL, wenn die Datei nicht geladen werden konnte.
@remark Es darf nicht vergessen werden, die Dateidaten nach Benutzung mit BE_DELETE_A freizugeben.
*/
virtual void* GetFile(const std::string& FileName, unsigned int* pFileSize = NULL) = 0;
/**
@brief Gibt den Pfad zum aktuellen Verzeichnis zur�ck.
@return Gibt einen String zur�ck, der den Pfad zum aktuellen Verzeichnis enth�lt.<br>
Falls der Pfad nicht bestimmt werden konnte wird ein leerer String zur�ckgegeben.
@remark Zum Trennen von Pfadelementen wird "/" und nicht "\" verwendet.
*/
virtual std::string GetCurrentDirectory() = 0;
/**
@brief Wechselt das aktuelle Verzeichnis.
@param Directory ein String der das Verzeichnis bezeichnet, in dass gewechselt werden soll.<br>
Die Pfadangabe darf relativ sein.
@return Gibt true zur�ck, falls der Vorgang erfolgreich war, ansonsten false.
@remark Zum Trennen von Pfadelementen wird "/" und nicht "\" verwendet.
*/
virtual bool ChangeDirectory(const std::string& Directory) = 0;
/**
@brief Gibt den absoluten Pfad zu einer Datei im virtuellen Verzeichnisbaum zur�ck.
@param FileName der Dateiname der Datei, deren absoluter Pfad bestimmt werden soll.<br>
Diese Parameter kann sowohl relative als auch absolute Pfadangaben beinhalten.
@return Gibt einen String zur�ck, der den absoluten Pfad zur �bergebenen Datei enth�lt.<br>
Falls der absolute Pfad nicht bestimmt werden konnte, wird ein leerer String zur�ckgegeben.
@remark Zum Trennen von Pfadelementen wird "/" und nicht "\" verwendet.
*/
virtual std::string GetAbsolutePath(const std::string& FileName) = 0;
/**
@brief Erstellt ein BS_PackageManager::FileSearch Objekt mit dem Nach Dateien gesucht werden kann.
@param Filter gibt den Suchstring an. Dieser darf die Wildcards '*' und '?' enthalten.
@param Path gibt das Verzeichnis an, welches durchsucht werden soll.
@param TypeFilter ist eine Kombination der Flags BS_PackageManager::FT_DIRECTORY und BS_PackageManager::FT_FILE.<br>
Diese Flags geben an, ob nach Dateien oder Verzeichnissen oder beiden gesucht werden soll.<br>
Der Standardwert ist BS_PackageManager::FT_DIRECTORY | BS_PackageManager::FT_FILE.
@return Gibt einen Pointer auf ein BS_PackageManager::FileSearch Objekt zur�ck, oder NULL wenn keine Datei gefunden wurde.
@remark Nicht vergessen, das Objekt nach Benutzung mit delete freizugeben.
*/
virtual FileSearch* CreateSearch(const std::string& Filter, const std::string& Path, unsigned int TypeFilter = FT_DIRECTORY | FT_FILE) = 0;
/**
* @brief Gibt die Dateigr��e zur�ck.
* @param FileName die Datei.
* @return die Dateigr��e. Im Falle eines Fehlers wird 0xffffffff zur�ckgegeben.
* @remarks Bei komprimierten Containern wird die unkomprimierte Gr��e zur�ckgegeben.
**/
virtual unsigned int GetFileSize(const std::string& FileName) = 0;
/**
@brief Gibt den Typ einer Datei zur�ck.
@param FileName der Dateiname
@return Gibt den Dateityp zur�ck (BS_PackageManager::FT_DIRECTORY oder BS_PackageManager::FT_FILE).<br>
Falls die Datei nicht gefunden wurde wird 0 zur�ckgegeben.
*/
virtual unsigned int GetFileType(const std::string & FileName) = 0;
/**
@brief Bestimmt, ob eine Datei existiert.
@param FileName der Dateiname
@return Gibt true zur�ck, wenn die Datei existiert, ansonsten false.
*/
virtual bool FileExists(const std::string & FileName) = 0;
private:
bool _RegisterScriptBindings();
};
#endif
|
