colobot/colobot-base/script/script.h

132 lines
4.0 KiB
C++

/*
* This file is part of the Colobot: Gold Edition source code
* Copyright (C) 2001-2023, Daniel Roux, EPSITEC SA & TerranovaTeam
* http://epsitec.ch; http://colobot.info; http://github.com/colobot
*
* This program 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, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see http://gnu.org/licenses
*/
/**
* \file script/script.h
* \brief CBot script runner
*/
#pragma once
#include "CBot/CBot.h"
#include <limits>
#include <memory>
#include <optional>
#include <string>
class COldObject;
class CTaskExecutorObject;
class CRobotMain;
class CScriptFunctions;
namespace Ui
{
class CEdit;
class CInterface;
class CList;
} /* Ui */
namespace Gfx
{
class CEngine;
class CTerrain;
class CWater;
} /* Gfx */
const int ERM_CONT = 0; // if error -> continue
const int ERM_STOP = 1; // if error -> stop
class CScript
{
friend class CScriptFunctions;
public:
CScript(COldObject* object);
~CScript();
void PutScript(Ui::CEdit* edit, const char* name);
bool GetScript(Ui::CEdit* edit);
bool GetCompile();
const std::string& GetTitle();
void SetStepMode(bool bStep);
bool GetStepMode();
bool Run();
bool Continue();
bool Step();
void Stop();
bool IsRunning();
bool IsContinue();
bool GetCursor(int &cursor1, int &cursor2);
void UpdateList(Ui::CList* list);
static void ColorizeScript(Ui::CEdit* edit, int rangeStart = 0, int rangeEnd = std::numeric_limits<int>::max());
bool IntroduceVirus();
int GetError();
void GetError(std::string& error);
void New(Ui::CEdit* edit, const char* name);
bool SendScript(const char* text);
bool ReadScript(const char* filename);
bool WriteScript(const char* filename);
bool ReadStack(std::istream &istr);
bool WriteStack(std::ostream &ostr);
bool Compare(CScript* other);
void SetFilename(const std::string &filename);
const std::string& GetFilename();
protected:
bool IsEmpty();
bool CheckToken();
bool Compile();
protected:
COldObject* m_object = nullptr;
CTaskExecutorObject* m_taskExecutor = nullptr;
Gfx::CEngine* m_engine = nullptr;
Ui::CInterface* m_interface = nullptr;
std::unique_ptr<CBot::CBotProgram> m_botProg;
CRobotMain* m_main = nullptr;
Gfx::CTerrain* m_terrain = nullptr;
Gfx::CWater* m_water = nullptr;
int m_ipf = 0; // number of instructions/second
int m_errMode = 0; // what to do in case of error
int m_len = 0; // length of the script (without <0>)
std::unique_ptr<char[]> m_script; // script ends with <0>
bool m_bRun = false; // program during execution?
bool m_bStepMode = false; // step by step
bool m_bContinue = false; // external function to continue
bool m_bCompile = false; // compilation ok?
std::string m_title = ""; // script title
std::string m_mainFunction = "";
std::string m_filename = ""; // file name
std::string m_token = ""; // missing instruction
int m_tokenUsed = 0, m_tokenAllowed = 0;
CBot::CBotError m_error = CBot::CBotNoErr; // error (0=ok)
int m_cursor1 = 0;
int m_cursor2 = 0;
std::optional<float> m_returnValue = std::nullopt;
};