(svn r23358) -Codechange: move AI_FatalError to Script_FatalError (and to its own file)

projects/openttd_vs100.vcxproj

@@ -788,6 +788,7 @@
     <ClInclude Include="..\src\table\water_land.h" />
     <ClCompile Include="..\src\3rdparty\md5\md5.cpp" />
     <ClInclude Include="..\src\3rdparty\md5\md5.h" />
+    <ClInclude Include="..\src\script\script_fatalerror.hpp" />
     <ClCompile Include="..\src\script\script_info.cpp" />
     <ClInclude Include="..\src\script\script_info.hpp" />
     <ClCompile Include="..\src\script\script_scanner.cpp" />

projects/openttd_vs100.vcxproj.filters

@@ -1587,6 +1587,9 @@
     <ClInclude Include="..\src\3rdparty\md5\md5.h">
       <Filter>MD5</Filter>
     </ClInclude>
+    <ClInclude Include="..\src\script\script_fatalerror.hpp">
+      <Filter>Script</Filter>
+    </ClInclude>
     <ClCompile Include="..\src\script\script_info.cpp">
       <Filter>Script</Filter>
     </ClCompile>

projects/openttd_vs80.vcproj

@@ -2458,6 +2458,10 @@
 		<Filter
 			Name="Script"
 			>
+			<File
+				RelativePath=".\..\src\script\script_fatalerror.hpp"
+				>
+			</File>
 			<File
 				RelativePath=".\..\src\script\script_info.cpp"
 				>

projects/openttd_vs90.vcproj

@@ -2455,6 +2455,10 @@
 		<Filter
 			Name="Script"
 			>
+			<File
+				RelativePath=".\..\src\script\script_fatalerror.hpp"
+				>
+			</File>
 			<File
 				RelativePath=".\..\src\script\script_info.cpp"
 				>

source.list

@@ -553,6 +553,7 @@ table/water_land.h
 
 #if AI
 # Script
+script/script_fatalerror.hpp
 script/script_info.cpp
 script/script_info.hpp
 script/script_scanner.cpp

src/ai/ai_instance.cpp

@@ -18,6 +18,7 @@
 
 #include "ai_config.hpp"
 #include "ai_gui.hpp"
+#include "../script/script_fatalerror.hpp"
 
 #include "../script/script_storage.hpp"
 #include "ai_instance.hpp"
@@ -154,7 +155,7 @@ void AIInstance::Initialize(AIInfo *info)
 			return;
 		}
 		ScriptObject::SetAllowDoCommand(true);
-	} catch (AI_FatalError e) {
+	} catch (Script_FatalError e) {
 		this->is_dead = true;
 		this->engine->ThrowError(e.GetErrorMessage());
 		this->engine->ResumeError();
@@ -375,7 +376,7 @@ void AIInstance::GameLoop()
 		} catch (AI_VMSuspend e) {
 			this->suspend  = e.GetSuspendTime();
 			this->callback = e.GetSuspendCallback();
-		} catch (AI_FatalError e) {
+		} catch (Script_FatalError e) {
 			this->is_dead = true;
 			this->engine->ThrowError(e.GetErrorMessage());
 			this->engine->ResumeError();
@@ -396,7 +397,7 @@ void AIInstance::GameLoop()
 	} catch (AI_VMSuspend e) {
 		this->suspend  = e.GetSuspendTime();
 		this->callback = e.GetSuspendCallback();
-	} catch (AI_FatalError e) {
+	} catch (Script_FatalError e) {
 		this->is_dead = true;
 		this->engine->ThrowError(e.GetErrorMessage());
 		this->engine->ResumeError();
@@ -640,9 +641,9 @@ void AIInstance::Save()
 				this->engine->CrashOccurred();
 				return;
 			}
-		} catch (AI_FatalError e) {
+		} catch (Script_FatalError e) {
 			/* If we don't mark the AI as dead here cleaning up the squirrel
-			 * stack could throw AI_FatalError again. */
+			 * stack could throw Script_FatalError again. */
 			this->is_dead = true;
 			this->engine->ThrowError(e.GetErrorMessage());
 			this->engine->ResumeError();

src/ai/ai_instance.hpp

@@ -51,29 +51,6 @@ private:
 	AISuspendCallbackProc *callback; ///< Callback function to call when the AI can run again.
 };
 
-/**
- * A throw-class that is given when the AI made a fatal error.
- */
-class AI_FatalError {
-public:
-	/**
-	 * Creates a "fatal error" exception.
-	 * @param msg The message describing the cause of the fatal error.
-	 */
-	AI_FatalError(const char *msg) :
-		msg(msg)
-	{}
-
-	/**
-	 * The error message associated with the fatal error.
-	 * @return The error message.
-	 */
-	const char *GetErrorMessage() { return msg; }
-
-private:
-	const char *msg; ///< The error message.
-};
-
 /** Runtime information about an AI like a pointer to the squirrel vm and the current state. */
 class AIInstance {
 public:

src/script/api/script_controller.cpp

@@ -20,6 +20,7 @@
 #include "../../ai/ai_instance.hpp"
 #include "../../ai/ai_config.hpp"
 #include "../../ai/ai.hpp"
+#include "../script_fatalerror.hpp"
 #include "script_log.hpp"
 
 /* static */ void ScriptController::SetCommandDelay(int ticks)
@@ -31,7 +32,7 @@
 /* static */ void ScriptController::Sleep(int ticks)
 {
 	if (!ScriptObject::CanSuspend()) {
-		throw AI_FatalError("You are not allowed to call Sleep in your constructor, Save(), Load(), and any valuator.");
+		throw Script_FatalError("You are not allowed to call Sleep in your constructor, Save(), Load(), and any valuator.");
 	}
 
 	if (ticks <= 0) {

src/script/api/script_execmode.cpp

@@ -14,6 +14,7 @@
 #include "../../company_base.h"
 #include "../../company_func.h"
 #include "../../ai/ai_instance.hpp"
+#include "../script_fatalerror.hpp"
 
 bool ScriptExecMode::ModeProc()
 {
@@ -34,7 +35,7 @@ ScriptExecMode::~ScriptExecMode()
 	if (this->GetDoCommandModeInstance() != this) {
 		/* Ignore this error if the AI already died. */
 		if (!ScriptObject::GetActiveInstance()->IsDead()) {
-			throw AI_FatalError("ScriptExecMode object was removed while it was not the latest AI*Mode object created.");
+			throw Script_FatalError("ScriptExecMode object was removed while it was not the latest AI*Mode object created.");
 		}
 	}
 	this->SetDoCommandMode(this->last_mode, this->last_instance);

src/script/api/script_object.cpp

@@ -17,6 +17,7 @@
 
 #include "../script_storage.hpp"
 #include "../../ai/ai_instance.hpp"
+#include "../script_fatalerror.hpp"
 #include "script_error.hpp"
 
 /**
@@ -226,7 +227,7 @@ ScriptObject::ActiveInstance::~ActiveInstance()
 /* static */ bool ScriptObject::DoCommand(TileIndex tile, uint32 p1, uint32 p2, uint cmd, const char *text, AISuspendCallbackProc *callback)
 {
 	if (!ScriptObject::CanSuspend()) {
-		throw AI_FatalError("You are not allowed to execute any DoCommand (even indirect) in your constructor, Save(), Load(), and any valuator.");
+		throw Script_FatalError("You are not allowed to execute any DoCommand (even indirect) in your constructor, Save(), Load(), and any valuator.");
 	}
 
 	/* Set the default callback to return a true/false result of the DoCommand */

src/script/api/script_testmode.cpp

@@ -14,6 +14,7 @@
 #include "../../company_base.h"
 #include "../../company_func.h"
 #include "../../ai/ai_instance.hpp"
+#include "../script_fatalerror.hpp"
 
 bool ScriptTestMode::ModeProc()
 {
@@ -34,7 +35,7 @@ ScriptTestMode::~ScriptTestMode()
 	if (this->GetDoCommandModeInstance() != this) {
 		/* Ignore this error if the AI already died. */
 		if (!ScriptObject::GetActiveInstance()->IsDead()) {
-			throw AI_FatalError("AITestmode object was removed while it was not the latest AI*Mode object created.");
+			throw Script_FatalError("AITestmode object was removed while it was not the latest AI*Mode object created.");
 		}
 	}
 	this->SetDoCommandMode(this->last_mode, this->last_instance);

src/script/script_fatalerror.hpp

@@ -0,0 +1,38 @@
+/* $Id$ */
+
+/*
+ * This file is part of OpenTTD.
+ * OpenTTD 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, version 2.
+ * OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file script_fatalerror.hpp The definition of Script_FatalError. */
+
+#ifndef SCRIPT_FATALERROR_HPP
+#define SCRIPT_FATALERROR_HPP
+
+/**
+ * A throw-class that is given when the script made a fatal error.
+ */
+class Script_FatalError {
+public:
+	/**
+	 * Creates a "fatal error" exception.
+	 * @param msg The message describing the cause of the fatal error.
+	 */
+	Script_FatalError(const char *msg) :
+		msg(msg)
+	{}
+
+	/**
+	 * The error message associated with the fatal error.
+	 * @return The error message.
+	 */
+	const char *GetErrorMessage() { return msg; }
+
+private:
+	const char *msg; ///< The error message.
+};
+
+#endif /* SCRIPT_FATALERROR_HPP */