From bbd9facb44dc09ded5500918319b770c63c0a981 Mon Sep 17 00:00:00 2001 From: truebrain Date: Tue, 29 Nov 2011 23:21:13 +0000 Subject: (svn r23358) -Codechange: move AI_FatalError to Script_FatalError (and to its own file) --- projects/openttd_vs100.vcxproj | 1 + projects/openttd_vs100.vcxproj.filters | 3 +++ projects/openttd_vs80.vcproj | 4 ++++ projects/openttd_vs90.vcproj | 4 ++++ source.list | 1 + src/ai/ai_instance.cpp | 11 +++++----- src/ai/ai_instance.hpp | 23 -------------------- src/script/api/script_controller.cpp | 3 ++- src/script/api/script_execmode.cpp | 3 ++- src/script/api/script_object.cpp | 3 ++- src/script/api/script_testmode.cpp | 3 ++- src/script/script_fatalerror.hpp | 38 ++++++++++++++++++++++++++++++++++ 12 files changed, 65 insertions(+), 32 deletions(-) create mode 100644 src/script/script_fatalerror.hpp diff --git a/projects/openttd_vs100.vcxproj b/projects/openttd_vs100.vcxproj index bb88f7d78..d35f165ff 100644 --- a/projects/openttd_vs100.vcxproj +++ b/projects/openttd_vs100.vcxproj @@ -788,6 +788,7 @@ + diff --git a/projects/openttd_vs100.vcxproj.filters b/projects/openttd_vs100.vcxproj.filters index dedbcc439..e569fa6b5 100644 --- a/projects/openttd_vs100.vcxproj.filters +++ b/projects/openttd_vs100.vcxproj.filters @@ -1587,6 +1587,9 @@ MD5 + + Script + Script diff --git a/projects/openttd_vs80.vcproj b/projects/openttd_vs80.vcproj index d9f62e525..aaaf0522d 100644 --- a/projects/openttd_vs80.vcproj +++ b/projects/openttd_vs80.vcproj @@ -2458,6 +2458,10 @@ + + diff --git a/projects/openttd_vs90.vcproj b/projects/openttd_vs90.vcproj index 6b3a58598..9c21119b8 100644 --- a/projects/openttd_vs90.vcproj +++ b/projects/openttd_vs90.vcproj @@ -2455,6 +2455,10 @@ + + diff --git a/source.list b/source.list index 61bbf52e7..77f98ed13 100644 --- a/source.list +++ b/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 diff --git a/src/ai/ai_instance.cpp b/src/ai/ai_instance.cpp index 729344fce..324242957 100644 --- a/src/ai/ai_instance.cpp +++ b/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(); diff --git a/src/ai/ai_instance.hpp b/src/ai/ai_instance.hpp index 3f120a385..63da6f967 100644 --- a/src/ai/ai_instance.hpp +++ b/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: diff --git a/src/script/api/script_controller.cpp b/src/script/api/script_controller.cpp index 163335f3d..bc6d060fd 100644 --- a/src/script/api/script_controller.cpp +++ b/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) { diff --git a/src/script/api/script_execmode.cpp b/src/script/api/script_execmode.cpp index 23f4c683d..e0481b25b 100644 --- a/src/script/api/script_execmode.cpp +++ b/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); diff --git a/src/script/api/script_object.cpp b/src/script/api/script_object.cpp index 0be85a745..cb01d3ee3 100644 --- a/src/script/api/script_object.cpp +++ b/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 */ diff --git a/src/script/api/script_testmode.cpp b/src/script/api/script_testmode.cpp index 87b4aea57..184a8795c 100644 --- a/src/script/api/script_testmode.cpp +++ b/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); diff --git a/src/script/script_fatalerror.hpp b/src/script/script_fatalerror.hpp new file mode 100644 index 000000000..fc7e05402 --- /dev/null +++ b/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 . + */ + +/** @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 */ -- cgit v1.2.3-70-g09d2