xoreos  0.0.5
probes.cpp
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 
25 #include "src/common/ustring.h"
26 #include "src/common/filelist.h"
27 #include "src/common/filepath.h"
28 
30 
33 
34 namespace Engines {
35 
36 namespace Witcher {
37 
39 private:
40  static const Common::UString kGameName;
41 
42 public:
45 
48  }
49 
50  const Common::UString &getGameName() const {
51  return kGameName;
52  }
53 
56  }
57 
59  return new WitcherEngine;
60  }
61 
62  bool probe(Common::SeekableReadStream &UNUSED(stream)) const {
63  return false;
64  }
65 
66  bool probe(const Common::UString &directory, const Common::FileList &UNUSED(rootFiles)) const {
67 
68  // There should be a system directory
69  Common::UString systemDir = Common::FilePath::findSubDirectory(directory, "system", true);
70  if (systemDir.empty())
71  return false;
72 
73  // The system directory has to be readable
74  Common::FileList systemFiles;
75  if (!systemFiles.addDirectory(systemDir))
76  return false;
77 
78  // If either witcher.ini or witcher.exe exists, this should be a valid path
79  return systemFiles.containsGlob(".*/witcher.(exe|ini)", true);
80  }
81 
82 };
83 
84 const Common::UString EngineProbe::kGameName = "The Witcher";
85 
86 
87 void createEngineProbes(std::list<const ::Engines::EngineProbe *> &probes) {
88  probes.push_back(new EngineProbe);
89 }
90 
91 } // End of namespace Witcher
92 
93 } // End of namespace Engines
GameID
Definition: types.h:393
A class holding an UTF-8 string.
Definition: ustring.h:48
bool probe(const Common::UString &directory, const Common::FileList &rootFiles) const
Check for the game in that directory, containing these files.
Definition: probes.cpp:66
A probe that checks if an engine can handle game data found in a specific directory and creates an in...
#define UNUSED(x)
Definition: system.h:170
Aurora::GameID getGameID() const
Get the GameID that the probe is able to detect.
Definition: probes.cpp:46
Probing for an installation of The Witcher.
bool empty() const
Is the string empty?
Definition: ustring.cpp:245
Engines::Engine * createEngine() const
Create the respective engine for the GameID.
Definition: probes.cpp:58
static const Common::UString kGameName
Definition: probes.cpp:40
The Witcher.
Definition: types.h:400
const Common::UString & getGameName() const
Return a string of the full game name.
Definition: probes.cpp:50
Unicode string handling.
bool probe(Common::SeekableReadStream &stream) const
Check for the game in that file.
Definition: probes.cpp:62
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
Microsoft Windows.
Definition: types.h:430
void createEngineProbes(std::list< const ::Engines::EngineProbe *> &probes)
Definition: probes.cpp:87
bool addDirectory(const UString &directory, int recurseDepth=0)
Add a directory to the list.
Definition: filelist.cpp:102
A list of files.
Engine class handling The Witcher.
Aurora::Platform getPlatform() const
Get the Platform that the probe is able to detect.
Definition: probes.cpp:54
bool containsGlob(const UString &glob, bool caseInsensitive) const
Does the list contain at least one file matching the given regex?
Definition: filelist.cpp:189
Interface for a seekable & readable data stream.
Definition: readstream.h:265
Platform
Definition: types.h:429
Utility class for manipulating file paths.
static UString findSubDirectory(const UString &directory, const UString &subDirectory, bool caseInsensitive=false)
Find a directory&#39;s subdirectory.
Definition: filepath.cpp:318