script_engine.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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://www.gnu.org/licenses/>.
 *
 */

/*
 * This file is based on WME Lite.
 * http://dead-code.org/redir.php?target=wmelite
 * Copyright (c) 2011 Jan Nedoma
 */

#ifndef WINTERMUTE_SCENGINE_H
#define WINTERMUTE_SCENGINE_H

#include "engines/wintermute/persistent.h"
#include "engines/wintermute/coll_templ.h"
#include "engines/wintermute/base/base.h"
#include "engines/wintermute/platform_osystem.h"

namespace Wintermute {

#define MAX_CACHED_SCRIPTS 20
class ScScript;
class ScValue;
class BaseObject;
class BaseScriptHolder;
class ScEngine : public BaseClass {
public:
    class CScCachedScript {
    public:
        CScCachedScript(const char *filename, byte *buffer, uint32 size) {
            _timestamp = BasePlatform::getTime();
            _buffer = new byte[size];
            if (_buffer) {
                memcpy(_buffer, buffer, size);
            }
            _size = size;
            size_t filenameSize = strlen(filename) + 1;
            _filename = new char[filenameSize];
            Common::strcpy_s(_filename, filenameSize, filename);
        };

        ~CScCachedScript() {
            if (_buffer) {
                delete[] _buffer;
            }
            if (_filename)
                delete[] _filename;
        };

        uint32 _timestamp;
        byte *_buffer;
        uint32 _size;
        char *_filename;
    };

public:
    bool clearGlobals(bool includingNatives = false);
    bool tickUnbreakable();
    bool removeFinishedScripts();
    bool isValidScript(ScScript *script);

    ScScript *_currentScript;
    bool resumeAll();
    bool pauseAll();
    void editorCleanup();
    bool resetObject(BaseObject *object);
    bool resetScript(ScScript *script);
    bool emptyScriptCache();
    byte *getCompiledScript(const char *filename, uint32 *outSize, bool ignoreCache = false);
    DECLARE_PERSISTENT(ScEngine, BaseClass)
    bool cleanup();
    int getNumScripts(int *running = nullptr, int *waiting = nullptr, int *persistent = nullptr);
    bool tick();
    ScValue *_globals;
    ScScript *runScript(const char *filename, BaseScriptHolder *owner = nullptr);
    bool isRunningScript(const char *filename);
    static const bool _compilerAvailable = false;

    ScEngine(BaseGame *inGame);
    ~ScEngine() override;
    static byte *loadFile(void *data, char *filename, uint32 *size);
    static void closeFile(void *data, byte *buffer);
    static void parseElement(void *data, int line, int type, void *elementData);

    BaseArray<ScScript *> _scripts;

    void enableProfiling();
    void disableProfiling();
    bool isProfiling() {
        return _isProfiling;
    }

    void addScriptTime(const char *filename, uint32 time);
    void dumpStats();

private:

    CScCachedScript *_cachedScripts[MAX_CACHED_SCRIPTS];
    bool _isProfiling;
    uint32 _profilingStartTime;

    typedef Common::HashMap<Common::String, uint32> ScriptTimes;
    ScriptTimes _scriptTimes;

};

} // End of namespace Wintermute

#endif