xoreos  0.0.5
engineprobe.h
Go to the documentation of this file.
1 /* xoreos - A reimplementation of BioWare's Aurora engine
2  *
3  * xoreos is the legal property of its developers, whose names
4  * can be found in the AUTHORS file distributed with this source
5  * distribution.
6  *
7  * xoreos is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * xoreos is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
26 #ifndef ENGINES_ENGINEPROBE_H
27 #define ENGINES_ENGINEPROBE_H
28 
29 #include <boost/noncopyable.hpp>
30 
31 #include "src/aurora/types.h"
32 
33 namespace Common {
34  class UString;
35  class SeekableReadStream;
36  class FileList;
37 }
38 
39 namespace Engines {
40 
41 class Engine;
42 
44 class EngineProbe : boost::noncopyable {
45 public:
46  virtual ~EngineProbe() {}
47 
49  virtual Aurora::GameID getGameID() const = 0;
51  virtual Aurora::Platform getPlatform() const = 0;
52 
54  virtual const Common::UString &getGameName() const = 0;
55 
57  virtual bool probe(const Common::UString &directory, const Common::FileList &rootFiles) const = 0;
58 
60  virtual bool probe(Common::SeekableReadStream &stream) const = 0;
61 
63  virtual Engine *createEngine() const = 0;
64 };
65 
66 } // End of namespace Engines
67 
68 #endif // ENGINES_ENGINEPROBE_H
GameID
Definition: types.h:393
Definition: 2dafile.h:39
virtual const Common::UString & getGameName() const =0
Return a string of the full game name.
A class holding an UTF-8 string.
Definition: ustring.h:48
virtual Aurora::GameID getGameID() const =0
Get the GameID that the probe is able to detect.
virtual Aurora::Platform getPlatform() const =0
Get the Platform that the probe is able to detect.
virtual ~EngineProbe()
Definition: engineprobe.h:46
virtual bool probe(const Common::UString &directory, const Common::FileList &rootFiles) const =0
Check for the game in that directory, containing these files.
Basic type definitions to handle files used in BioWare&#39;s Aurora engine.
The base class for an engine within BioWare&#39;s Aurora family.
Definition: engine.h:49
A probe able to detect one specific game.
Definition: engineprobe.h:44
A list of files.
Definition: filelist.h:35
Interface for a seekable & readable data stream.
Definition: readstream.h:265
Platform
Definition: types.h:429
virtual Engine * createEngine() const =0
Create the respective engine for the GameID.