process.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_USECODE_PROCESS_H
#define ULTIMA8_KERNEL_USECODE_PROCESS_H

#include "ultima/ultima8/misc/classtype.h"
#include "ultima/ultima8/misc/common_types.h"
#include "ultima/ultima8/misc/debugger.h"

namespace Common {
class ReadStream;
}

namespace Ultima {
namespace Ultima8 {

class Debugger;

class Process {
    friend class Kernel;
    friend class Debugger;
public:
    virtual void run() = 0;

    Process(ObjId _itemNum = 0, uint16 type = 0);
    virtual ~Process() { }

    ENABLE_RUNTIME_CLASSTYPE_BASE()

    uint32 getProcessFlags() const {
        return _flags;
    }
    bool is_active() const {
        return (_flags & PROC_ACTIVE);
    }
    bool is_terminated() const {
        return (_flags & (PROC_TERMINATED |
                         PROC_TERM_DEFERRED)) != 0;
    }
    bool is_suspended() const {
        return (_flags & PROC_SUSPENDED) != 0;
    }

    void fail();

    virtual void terminate();

    void terminateDeferred() {
        _flags |= PROC_TERM_DEFERRED;
    }

    void setRunPaused() {
        _flags |= PROC_RUNPAUSED;
    };

    void waitFor(ProcId pid);

    void waitFor(Process *proc);

    void suspend();

    void wakeUp(uint32 result);

    virtual void onWakeUp() {};

    void setItemNum(ObjId it) {
        _itemNum = it;
    }
    void setType(uint16 ty) {
        _type = ty;
    }
    void setTicksPerRun(uint32 val) {
        _ticksPerRun = val;
    }

    ProcId getPid() const {
        return _pid;
    }
    ObjId getItemNum() const {
        return _itemNum;
    }
    uint16 getType() const {
        return _type;
    }
    uint32 getTicksPerRun() const {
        return _ticksPerRun;
    }

    virtual Common::String dumpInfo() const;

    bool loadData(Common::ReadStream *rs, uint32 version);

    virtual void saveData(Common::WriteStream *ws);

    bool validateWaiters() const;

protected:
    ProcId _pid;

    uint32 _flags;

    uint32 _ticksPerRun;

    ObjId _itemNum;
    uint16 _type;

    uint32 _result;

    Common::Array<ProcId> _waiting;

public:

    enum processflags {
        PROC_ACTIVE      = 0x0001,   
        PROC_SUSPENDED   = 0x0002,   
        PROC_TERMINATED  = 0x0004,
        PROC_TERM_DEFERRED = 0x0008, 
        PROC_FAILED      = 0x0010,
        PROC_RUNPAUSED   = 0x0020,    
        PROC_TERM_DISPOSE = 0x0040,  
        PROC_PREVENT_SAVE = 0x0080   
    };

};

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

#endif