script_info.hpp

Go to the documentation of this file.

/*
 * 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/>.
 */
 
#ifndef SCRIPT_INFO_HPP
#define SCRIPT_INFO_HPP
 
#include <squirrel.h>
#include "../misc/countedptr.hpp"
 
#include "script_config.hpp"
 
static const int MAX_SL_OPS             = 100000;
static const int MAX_CONSTRUCTOR_OPS    = 100000;
static const int MAX_CREATEINSTANCE_OPS = 100000;
static const int MAX_GET_OPS            =   1000;
static const int MAX_GET_SETTING_OPS    = 100000;
 
class ScriptInfo : public SimpleCountedObject {
public:
  ScriptInfo() :
    engine(nullptr),
    version(0),
    scanner(nullptr)
  {}
 
  const std::string &GetAuthor() const { return this->author; }
 
  const std::string &GetName() const { return this->name; }
 
  const std::string &GetShortName() const { return this->short_name; }
 
  const std::string &GetDescription() const { return this->description; }
 
  int GetVersion() const { return this->version; }
 
  const std::string &GetDate() const { return this->date; }
 
  const std::string &GetInstanceName() const { return this->instance_name; }
 
  const std::string &GetURL() const { return this->url; }
 
  const std::string &GetMainScript() const { return this->main_script; }
 
  const std::string &GetTarFile() const { return this->tar_file; }
 
  bool CheckMethod(const char *name) const;
 
  static SQInteger Constructor(HSQUIRRELVM vm, ScriptInfo *info);
 
  virtual class ScriptScanner *GetScanner() { return this->scanner; }
 
  bool GetSettings();
 
  const ScriptConfigItemList *GetConfigList() const;
 
  const ScriptConfigItem *GetConfigItem(const std::string_view name) const;
 
  SQInteger AddSetting(HSQUIRRELVM vm);
 
  SQInteger AddLabels(HSQUIRRELVM vm);
 
  int GetSettingDefaultValue(const std::string &name) const;
 
  virtual bool IsDeveloperOnly() const { return false; }
 
protected:
  class Squirrel *engine;           
  HSQOBJECT SQ_instance;            
  ScriptConfigItemList config_list; 
 
private:
  std::string main_script;      
  std::string tar_file;         
  std::string author;           
  std::string name;             
  std::string short_name;       
  std::string description;      
  std::string date;             
  std::string instance_name;    
  int version;                  
  std::string url;              
 
  class ScriptScanner *scanner; 
};
 
void Script_CreateDummyInfo(HSQUIRRELVM vm, const char *type, const char *dir);
void Script_CreateDummy(HSQUIRRELVM vm, StringID string, const char *type);
 
#endif /* SCRIPT_INFO_HPP */