kernel.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/>.
 *
 */

#ifndef ULTIMA8_KERNEL_KERNEL_H
#define ULTIMA8_KERNEL_KERNEL_H

#include "common/str.h"
#include "ultima/ultima8/misc/common_types.h"
#include "ultima/ultima8/usecode/intrinsics.h"

namespace Common {
class ReadStream;
}

namespace Ultima {
namespace Ultima8 {

class Debugger;
class Process;
class idMan;

typedef Process *(*ProcessLoadFunc)(Common::ReadStream *rs, uint32 version);
typedef Common::List<Process *>::const_iterator ProcessIter;
typedef Common::List<Process *>::iterator ProcessIterator;


class Kernel {
    friend class Debugger;
public:
    Kernel();
    ~Kernel();

    static Kernel *get_instance() {
        return _kernel;
    }

    void reset();

    // returns pid of new process
    ProcId addProcess(Process *proc, bool dispose = true);

    ProcId addProcessExec(Process *proc, bool dispose = true);

    void runProcesses();
    Process *getProcess(ProcId pid);

    ProcId assignPID(Process *proc);

    void setNextProcess(Process *proc);
    Process *getRunningProcess() const {
        return _runningProcess;
    }

    // objid = 0 means any object, type = 6 means any type
    uint32 getNumProcesses(ObjId objid, uint16 processtype);

    Process *findProcess(ObjId objid, uint16 processtype);

    void killProcesses(ObjId objid, uint16 processtype, bool fail);

    void killProcessesNotOfType(ObjId objid, uint16 processtype, bool fail);

    void killAllProcessesNotOfTypeExcludeCurrent(uint16 processtype, bool fail);

    const Common::List<Process *> &getProcesses() const { return  _processes; }

    void kernelStats();
    void processTypes();

    bool canSave();
    void save(Common::WriteStream *ws);
    bool load(Common::ReadStream *rs, uint32 version);

    void pause() {
        _paused++;
    }
    void unpause() {
        if (_paused > 0)
            _paused--;
    }
    bool isPaused() const {
        return _paused > 0;
    }

    void setFrameByFrame(bool fbf) {
        _frameByFrame = fbf;
    }
    bool isFrameByFrame() const {
        return _frameByFrame;
    }

    void addProcessLoader(Common::String classname, ProcessLoadFunc func) {
        _processLoaders[classname] = func;
    }

    uint32 getFrameNum() const {
        return _tickNum / TICKS_PER_FRAME;
    };
    uint32 getTickNum() const {
        return _tickNum;
    };

    static constexpr uint32 TICKS_PER_FRAME = 2;
    static constexpr uint32 TICKS_PER_SECOND = 60;
    static constexpr uint32 FRAMES_PER_SECOND = TICKS_PER_SECOND / TICKS_PER_FRAME;

    // A special process type which means kill all the processes.
    static const uint16 PROC_TYPE_ALL;

    INTRINSIC(I_getNumProcesses);
    INTRINSIC(I_resetRef);
private:
    Process *loadProcess(Common::ReadStream *rs, uint32 version);

    Common::List<Process *> _processes;
    idMan   *_pIDs;

    Common::List<Process *>::iterator _currentProcess;

    Common::HashMap<Common::String, ProcessLoadFunc> _processLoaders;

    bool _loading;

    uint32 _tickNum;
    unsigned int _paused;
    bool _frameByFrame;

    Process *_runningProcess;

    static Kernel *_kernel;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif