script_scanner.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_SCANNER_HPP
#define SCRIPT_SCANNER_HPP
 
#include "../fileio_func.h"
#include "../string_func.h"
 
typedef std::map<std::string, class ScriptInfo *, CaseInsensitiveComparator> ScriptInfoList; 
 
class ScriptScanner : public FileScanner {
public:
  ScriptScanner();
  virtual ~ScriptScanner();
 
  virtual void Initialize() = 0;
 
  class Squirrel *GetEngine() { return this->engine; }
 
  std::string GetMainScript() { return this->main_script; }
 
  std::string GetTarFile() { return this->tar_file; }
 
  const ScriptInfoList *GetInfoList() { return &this->info_list; }
 
  const ScriptInfoList *GetUniqueInfoList() { return &this->info_single_list; }
 
  void RegisterScript(class ScriptInfo *info);
 
  void GetConsoleList(std::back_insert_iterator<std::string> &output_iterator, bool newest_only) const;
 
  bool HasScript(const struct ContentInfo *ci, bool md5sum);
 
  const char *FindMainScript(const ContentInfo *ci, bool md5sum);
 
  bool AddFile(const std::string &filename, size_t basepath_length, const std::string &tar_filename) override;
 
  void RescanDir();
 
protected:
  class Squirrel *engine;  
  std::string main_script; 
  std::string tar_file;    
 
  ScriptInfoList info_list;        
  ScriptInfoList info_single_list; 
 
  void Initialize(const char *name);
 
  virtual std::string GetScriptName(ScriptInfo *info) = 0;
 
  virtual const char *GetFileName() const = 0;
 
  virtual Subdirectory GetDirectory() const = 0;
 
  virtual void RegisterAPI(class Squirrel *engine) = 0;
 
  virtual const char *GetScannerName() const = 0;
 
  void Reset();
 
  void ResetEngine();
};
 
#endif /* SCRIPT_SCANNER_HPP */