src/ai/ai_instance.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file ai_instance.cpp Implementation of AIInstance. */
  11
  12 #include "../stdafx.h"
  13 #include "../debug.h"
  14 #include "../error.h"
  15
  16 #include "../script/convert.hpp"
  17
  18 #include "ai_config.hpp"
  19 #include "ai_gui.hpp"
  20 #include "ai.hpp"
  21
  22 #include "ai_info.hpp"
  23 #include "ai_instance.hpp"
  24
  25 /* Manually include the Text glue. */
  26 #include "../script/api/script_text.hpp"
  27 #include "../script/api/script_controller.hpp"
  28
  29 #include "../script/api/ai/ai.hpp.sq"
  30
  31 #include "../company_base.h"
  32 #include "../company_func.h"
  33
  34 AIInstance::AIInstance() :
  35         ScriptInstance("AI")
  36 {}
  37
  38 static void LoadDummyScript (HSQUIRRELVM vm);
  39
  40 void AIInstance::Initialize (const AIInfo *info)
  41 {
  42         this->versionAPI = info->GetAPIVersion();
  43
  44         /* Register the AIController (including the "import" command) */
  45         SQAIController_Register (this);
  46
  47         ScriptInstance::Initialize (info, _current_company,
  48                         info->use == AIInfo::USE_DUMMY ? &LoadDummyScript : NULL);
  49 }
  50
  51 void AIInstance::RegisterAPI()
  52 {
  53         ScriptInstance::RegisterAPI();
  54
  55         /* Register all classes */
  56         SQAI_Register (this);
  57
  58         if (!this->LoadCompatibilityScripts(this->versionAPI, AI_DIR)) this->Died();
  59 }
  60
  61 void AIInstance::Died()
  62 {
  63         ScriptInstance::Died();
  64
  65         ShowAIDebugWindow(_current_company);
  66
  67         const AIInfo *info = AIConfig::GetConfig(_current_company, AIConfig::SSS_FORCE_GAME)->GetInfo();
  68         if (info != NULL) {
  69                 ShowErrorMessage(STR_ERROR_AI_PLEASE_REPORT_CRASH, INVALID_STRING_ID, WL_WARNING);
  70
  71                 if (info->GetURL() != NULL) {
  72                         ScriptLog::Info("Please report the error to the following URL:");
  73                         ScriptLog::Info(info->GetURL());
  74                 }
  75         }
  76 }
  77
  78 static const char dummy_script_head[] =
  79         "class DummyAI extends AIController { function Start() { AILog.Error (\"";
  80 static const char dummy_script_newline[] = "\"); AILog.Error (\"";
  81 static const char dummy_script_tail[]    = "\"); } }";
  82
  83 struct DummyScriptHelper {
  84         const char *literal;
  85         const char *message;
  86 };
  87
  88 static WChar dummy_script_reader (SQUserPointer userdata)
  89 {
  90         DummyScriptHelper *data = (DummyScriptHelper*) userdata;
  91
  92         if (data->literal != NULL) {
  93                 unsigned char c = *data->literal;
  94                 if (c != 0) {
  95                         assert (c < '\x7f');
  96                         data->literal++;
  97                         return c;
  98                 }
  99                 if (data->message == NULL) return 0;
 100                 data->literal = NULL;
 101         }
 102
 103         assert (data->message != NULL);
 104
 105         WChar c = Utf8Consume (&data->message);
 106
 107         switch (c) {
 108                 case '\0': /* switch to tail literal string */
 109                         data->message = NULL;
 110                         data->literal = dummy_script_tail;
 111                         break;
 112
 113                 case '\n': /* switch to newline literal string */
 114                         data->literal = dummy_script_newline;
 115                         break;
 116
 117                 case '"':  /* escape special chars */
 118                         data->literal = "\\\"";
 119                         break;
 120
 121                 case '\\': /* escape special chars */
 122                         data->literal = "\\\\";
 123                         break;
 124
 125                 default: return c;
 126         }
 127
 128         return *data->literal++;
 129 }
 130
 131 static void LoadDummyScript (HSQUIRRELVM vm)
 132 {
 133         /* Get the (translated) error message. */
 134         char error_message[1024];
 135         GetString (error_message, STR_ERROR_AI_NO_AI_FOUND);
 136
 137         /* Load and run a dummy script. */
 138         DummyScriptHelper data = { dummy_script_head, error_message };
 139
 140         SQRESULT res;
 141
 142         sq_pushroottable (vm);
 143         res = sq_compile (vm, dummy_script_reader, &data, "dummy", SQTrue);
 144         assert (SQ_SUCCEEDED(res));
 145
 146         sq_push (vm, -2);
 147         res = sq_call (vm, 1, SQFalse, SQTrue);
 148         assert (SQ_SUCCEEDED(res));
 149
 150         sq_pop (vm, 1);
 151 }
 152
 153 int AIInstance::GetSetting(const char *name)
 154 {
 155         return AIConfig::GetConfig(_current_company)->GetSetting(name);
 156 }
 157
 158 ScriptInfo *AIInstance::FindLibrary(const char *library, int version)
 159 {
 160         return (ScriptInfo *)AI::FindLibrary(library, version);
 161 }
 162
 163 /**
 164  * DoCommand callback function for all commands executed by AIs.
 165  * @param result The result of the command.
 166  */
 167 void CcAI (const CommandCost &result)
 168 {
 169         /*
 170          * The company might not exist anymore. Check for this.
 171          * The command checks are not useful since this callback
 172          * is also called when the command fails, which is does
 173          * when the company does not exist anymore.
 174          */
 175         const Company *c = Company::GetIfValid(_current_company);
 176         if (c == NULL || c->ai_instance == NULL) return;
 177
 178         c->ai_instance->DoCommandCallback (result);
 179         c->ai_instance->Continue();
 180 }
 181
 182 CommandSource AIInstance::GetCommandSource()
 183 {
 184         return CMDSRC_AI;
 185 }