engineprobe.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_ENGINEPROBE_H
#define ENGINES_ENGINEPROBE_H

#include <boost/noncopyable.hpp>

#include "src/aurora/types.h"

namespace Common {
    class UString;
    class SeekableReadStream;
    class FileList;
}

namespace Engines {

class Engine;

class EngineProbe : boost::noncopyable {
public:
    virtual ~EngineProbe() {}

    virtual Aurora::GameID getGameID() const = 0;
    virtual Aurora::Platform getPlatform() const = 0;

    virtual const Common::UString &getGameName() const = 0;

    virtual bool probe(const Common::UString &directory, const Common::FileList &rootFiles) const = 0;

    virtual bool probe(Common::SeekableReadStream &stream) const = 0;

    virtual Engine *createEngine() const = 0;
};

} // End of namespace Engines

#endif // ENGINES_ENGINEPROBE_H