Merged Engine::go() and ::init() into a new run() method (currently implemented by calling the existing init&go methods; to be cleaned up by engine authors

svn-id: r39002

base/main.cpp

@@ -188,16 +188,8 @@ static Common::Error runGame(const EnginePlugin *plugin, OSystem &system, const
 	// Inform backend that the engine is about to be run
 	system.engineInit();
 
-	// Init the engine (this might change the screen parameters)
-	// TODO: We should specify what return values
-	Common::Error result = engine->init();
-
-	// Run the game engine if the initialization was successful.
-	if (result == Common::kNoError) {
-		result = engine->go();
-	} else {
-		// TODO: Set an error flag, notify user about the problem
-	}
+	// Run the engine
+	Common::Error result = engine->run();
 
 	// Inform backend that the engine finished
 	system.engineDone();

engines/agi/agi.h

@@ -696,7 +696,15 @@ struct StringData {
 class AgiBase : public ::Engine {
 protected:
 	// Engine API
-	virtual Common::Error init();
+	Common::Error init();
+	virtual Common::Error go() = 0;
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 
 	virtual void initialize() = 0;

engines/agos/agos.h

@@ -166,8 +166,15 @@ class AGOSEngine : public Engine {
 	friend class MoviePlayerSMK;
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();

engines/cine/cine.h

@@ -71,8 +71,15 @@ class CineEngine : public Engine {
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 
 	void shutdown();

engines/cruise/cruise.h

@@ -61,8 +61,15 @@ private:
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 	void shutdown();
 

engines/drascula/drascula.h

@@ -276,8 +276,15 @@ static const int interf_y[] ={ 51, 51, 51, 51, 83, 83, 83 };
 class DrasculaEngine : public ::Engine {
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 public:
 	DrasculaEngine(OSystem *syst, const DrasculaGameDescription *gameDesc);

engines/engine.h

@@ -144,18 +144,10 @@ public:
 	virtual ~Engine();
 
 	/**
-	 * Init the engine.
+	 * Init the engine and start its main loop.
 	 * @return returns kNoError on success, else an error code.
 	 */
-	virtual Common::Error init() = 0;
-
-	/**
-	 * Start the main engine loop.
-	 * The return value is not yet used, but could indicate whether the user
-	 * wants to return to the launch or to fully quit ScummVM.
-	 * @return returns kNoError on success, else an error code.
-	 */
-	virtual Common::Error go() = 0;
+	virtual Common::Error run() = 0;
 
 	/**
 	 * Prepare an error string, which is printed by the error() function.

engines/gob/gob.h

@@ -191,8 +191,15 @@ private:
 	uint32 _pauseStart;
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void pauseEngineIntern(bool pause);
 

engines/groovie/groovie.h

@@ -74,20 +74,29 @@ public:
 	~GroovieEngine();
 
 protected:
+
+	// Engine APIs
 	Common::Error init();
 	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
-	void errorString(const char *buf_input, char *buf_output, int buf_output_size);
+	virtual void errorString(const char *buf_input, char *buf_output, int buf_output_size);
+
+	virtual bool hasFeature(EngineFeature f) const;
+
+	virtual bool canLoadGameStateCurrently();
+	virtual Common::Error loadGameState(int slot);
+	virtual void syncSoundSettings();
+
+	virtual Debugger *getDebugger() { return _debugger; }
 
 public:
-	bool hasFeature(EngineFeature f) const;
-
-	bool canLoadGameStateCurrently();
-	Common::Error loadGameState(int slot);
-	void syncSoundSettings();
-
-	Debugger *getDebugger() { return _debugger; }
-
 	void waitForInput();
 
 	Script _script;

engines/igor/igor.h

@@ -312,8 +312,15 @@ public:
 	IgorEngine(OSystem *system, const DetectedGameVersion *dgv);
 	virtual ~IgorEngine();
 
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 	void handleOptionsMenu_paintSave();
 	bool handleOptionsMenu_handleKeyDownSave(int key);

engines/kyra/kyra_hof.cpp

@@ -1550,7 +1550,7 @@ void KyraEngine_HoF::snd_playSoundEffect(int track, int volume) {
 
 #pragma mark -
 
-void KyraEngine_HoF::loadInvWsa(const char *filename, int run, int delayTime, int page, int sfx, int sFrame, int flags) {
+void KyraEngine_HoF::loadInvWsa(const char *filename, int run_, int delayTime, int page, int sfx, int sFrame, int flags) {
 	int wsaFlags = 1;
 	if (flags)
 		wsaFlags |= 2;
@@ -1583,7 +1583,7 @@ void KyraEngine_HoF::loadInvWsa(const char *filename, int run, int delayTime, in
 	_invWsa.running = true;
 	_invWsa.timer = _system->getMillis();
 
-	if (run) {
+	if (run_) {
 		while (_invWsa.running && !skipFlag() && !shouldQuit()) {
 			update();
 			_system->delayMillis(10);

engines/kyra/kyra_v1.h

@@ -176,6 +176,14 @@ public:
 protected:
 	// Engine APIs
 	virtual Common::Error init();
+	virtual Common::Error go() = 0;
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual ::GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void pauseEngineIntern(bool pause);

engines/lure/lure.h

@@ -71,8 +71,15 @@ public:
 	bool _saveLoadAllowed;
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();
 	virtual void pauseEngineIntern(bool pause);

engines/m4/m4.h

@@ -112,8 +112,15 @@ private:
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 	void shutdown();
 

engines/made/made.h

@@ -80,8 +80,15 @@ class MadeEngine : public ::Engine {
 protected:
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 public:
 	MadeEngine(OSystem *syst, const MadeGameDescription *gameDesc);

engines/parallaction/parallaction.h

@@ -242,6 +242,15 @@ public:
 
 	// Engine APIs
 	virtual Common::Error init();
+	virtual Common::Error go() = 0;
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
+
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void pauseEngineIntern(bool pause);
 	virtual GUI::Debugger *getDebugger();
@@ -469,8 +478,8 @@ public:
 	Parallaction_br(OSystem* syst, const PARALLACTIONGameDescription *gameDesc);
 	~Parallaction_br();
 
-	Common::Error init();
-	Common::Error go();
+	virtual Common::Error init();
+	virtual Common::Error go();
 
 public:
 	virtual void parseLocation(const char* name);

engines/queen/queen.h

@@ -129,8 +129,15 @@ public:
 protected:
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();

engines/saga/saga.h

@@ -445,6 +445,13 @@ public:
 	// Engine APIs
 	Common::Error init();
 	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	bool hasFeature(EngineFeature f) const;
 	void syncSoundSettings();
 	void pauseEngineIntern(bool pause);

engines/sci/sci.h

@@ -76,8 +76,15 @@ public:
 	SciEngine(OSystem *syst, const SciGameDescription *desc);
 	~SciEngine();
 
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 
 	GUI::Debugger *getDebugger() { return _console; }
 

engines/scumm/he/intern_he.h

@@ -669,8 +669,7 @@ public:
 	ScummEngine_vCUPhe(OSystem *syst, const DetectorResult &dr);
 	~ScummEngine_vCUPhe();
 
-	Common::Error init();
-	Common::Error go();
+	virtual Common::Error run();
 
 	void parseEvents();
 

engines/scumm/scumm.cpp

@@ -824,13 +824,9 @@ ScummEngine_vCUPhe::~ScummEngine_vCUPhe() {
 	delete _cupPlayer;
 }
 
-Common::Error ScummEngine_vCUPhe::init() {
+Common::Error ScummEngine_vCUPhe::run() {
 	initGraphics(CUP_Player::kDefaultVideoWidth, CUP_Player::kDefaultVideoHeight, true);
 
-	return Common::kNoError;
-}
-
-Common::Error ScummEngine_vCUPhe::go() {
 	if (_cupPlayer->open(_filenamePattern.pattern)) {
 		_cupPlayer->play();
 		_cupPlayer->close();

engines/scumm/scumm.h

@@ -447,8 +447,15 @@ public:
 	virtual ~ScummEngine();
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual void errorString(const char *buf_input, char *buf_output, int buf_output_size);
 	virtual GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;

engines/sky/sky.h

@@ -91,8 +91,15 @@ public:
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;
 

engines/sword1/sword1.h

@@ -85,8 +85,15 @@ public:
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();
 	// FIXME: Loading a game through the GMM crashes the game

engines/sword2/sword2.h

@@ -124,8 +124,15 @@ private:
 
 protected:
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual GUI::Debugger *getDebugger();
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();

engines/tinsel/tinsel.h

@@ -141,8 +141,15 @@ class TinselEngine : public Engine {
 protected:
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	Common::Error loadGameState(int slot);
 #if 0

engines/touche/touche.h

@@ -370,8 +370,15 @@ public:
 	virtual ~ToucheEngine();
 
 	// Engine APIs
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();
 

engines/tucker/tucker.h

@@ -240,8 +240,15 @@ public:
 	TuckerEngine(OSystem *system, Common::Language language, uint32 flags);
 	virtual ~TuckerEngine();
 
-	virtual Common::Error init();
-	virtual Common::Error go();
+	Common::Error init();
+	Common::Error go();
+	virtual Common::Error run() {
+		Common::Error err;
+		err = init();
+		if (err != Common::kNoError)
+			return err;
+		return go();
+	}
 	virtual bool hasFeature(EngineFeature f) const;
 	virtual void syncSoundSettings();