VRUT::JSHandler Class Reference

#include <jshandler.h>

List of all members.

Public Member Functions
	JSHandler (JSScriptingModule *_module)
	Constructor.
	~JSHandler ()
	Destructor.
bool	Sleep (unsigned long milis)
	The method for script sleeping.
wxCommandEvent *	WaitForEvent (Event::EVENT_TYPE type, unsigned long milis, bool waitFromNow)
	The method for waiting for event.
void	PostEvent (wxCommandEvent &evt)
	Posts event to modules.
void	PostToKernel (wxCommandEvent &evt)
	Posts event to kernel.
void	ProcessEvent (wxCommandEvent &evt)
	Event's processing.
bool	RunScript ()
	Executing the script.
bool	IsEnd ()
	Test the script demand for exiting.
Private Attributes
std::queue< RunData >	executions
	The queue with all executions.
JSScriptingModule *	module
	The pointer to class JSScriptingModule.
JSEnvironment *	jsEnv
	The pointer to class JSEnvironment.
Static Private Attributes
static const unsigned long	TIMEOUT_WAITING = 50
	Number of miliseconds for sleeping in the method WaitingForEvent.
static const unsigned long	TIMEOUT_SLEEP = 50
	Number of miliseconds for sleeping in the method Sleep.
Friends
class	JSEnvironment
Classes
struct	RunData
	The structure with saved data for starting script. More...

---

Detailed Description

Definition at line 25 of file jshandler.h.

---

Constructor & Destructor Documentation

JSHandler::JSHandler

(

JSScriptingModule *

_module

)

Constructor.

Definition at line 20 of file jshandler.cpp.

{
       module = _module;
       jsEnv = new JSEnvironment(this);
}

JSHandler::~JSHandler

(

)

Destructor.

Definition at line 26 of file jshandler.cpp.

{
       delete jsEnv;
}

---

Member Function Documentation

bool JSHandler::Sleep

(

unsigned long

milis

)

The method for script sleeping.

Definition at line 31 of file jshandler.cpp.

{
       unsigned long t;
       if (milis > TIMEOUT_SLEEP)
       {
              t = milis % TIMEOUT_SLEEP;
              int steps = milis / TIMEOUT_SLEEP;
              for (int i = 0; i < steps; i++)
              {
                     wxThread::Sleep(TIMEOUT_SLEEP);
                     if (IsEnd())
                            return false;
              }
       }
       else
              t = milis;

       if (t)
              wxThread::Sleep(t);

       return true;
}

wxCommandEvent * JSHandler::WaitForEvent	(	Event::EVENT_TYPE	type,
		unsigned long	milis,
		bool	waitFromNow
	)

The method for waiting for event.

events before calling method for waiting

Definition at line 54 of file jshandler.cpp.

{
       wxCommandEvent *pevt = NULL;
       MessageQueueError err;
       size_t size;

       if (waitFromNow)
       {
              size = module->evtQueue.GetSize();
              for (unsigned i = 0; i < size; i++)
              {
                     wxCommandEvent evt1 = module->evtQueue.ReceiveTimeout(0, err);
                     if (err)
                            return NULL;
                     ProcessEvent(evt1);
              }
       }

       bool unlimited = (milis == 0);
       while (unlimited || milis > 0)
       {
              size = module->evtQueue.GetSize();
              for (unsigned i = 0; i < size; i++)
              {
                     wxCommandEvent evt2 = module->evtQueue.ReceiveTimeout(0, err);
                     //cout << "event: " << int(evt2.GetEventType()) << endl;
                     if (err)
                            return NULL;
                     if (evt2.GetEventType() == type)
                            return new wxCommandEvent(evt2);
                     ProcessEvent(evt2);
              }

              wxThread::Sleep(TIMEOUT_WAITING);
              if (IsEnd())
                     return NULL;

              if (!unlimited)
                     milis -= TIMEOUT_WAITING;
       }

       return NULL;
}

void JSHandler::PostEvent

(

wxCommandEvent &

evt

)

Posts event to modules.

Definition at line 99 of file jshandler.cpp.

{
       module->PostEvent(evt);
}

void JSHandler::PostToKernel

(

wxCommandEvent &

evt

)

Posts event to kernel.

Definition at line 104 of file jshandler.cpp.

{
       module->PostToKernel(evt);
}

void JSHandler::ProcessEvent

(

wxCommandEvent &

evt

)

Event's processing.

Definition at line 109 of file jshandler.cpp.

{
       if (evt.GetEventType() == Event::EVT_PARAM_SET)
       {
              if (IS_PARAM(evt, module->sceneParamID))
              {
                     long val;
                     if (((wxString *) evt.GetClientData())->AfterFirst('=').ToLong(&val) && val >= 0)
                            module->sceneID = (SCENE_ID) val;
                     else
                            module->sceneID = SCENE_ID_NONE;
              }
              else if (IS_PARAM(evt, module->runParamID))
                     executions.push(RunData(module->scriptPath, module->sceneID));
              else
                     UPDATE_PARAM_FROM_EVENT_STRING(module->pathParamID, module->scriptPath, evt);
       }
}

bool JSHandler::RunScript

(

)

Executing the script.

Definition at line 128 of file jshandler.cpp.

{
       if (executions.empty())
              return false;
       RunData data = executions.front();
       executions.pop();
       jsEnv->RunScript(module->kernel, data.scriptPath.ToAscii(), data.sceneID);
       return true;
}

bool JSHandler::IsEnd

(

)

Test the script demand for exiting.

Definition at line 139 of file jshandler.cpp.

{
       return module->TestExit();
}

---

Friends And Related Function Documentation

friend class JSEnvironment [friend]

Definition at line 73 of file jshandler.h.

---

Member Data Documentation

const unsigned long VRUT::JSHandler::TIMEOUT_WAITING = 50 [static, private]

Number of miliseconds for sleeping in the method WaitingForEvent.

Definition at line 29 of file jshandler.h.

const unsigned long VRUT::JSHandler::TIMEOUT_SLEEP = 50 [static, private]

Number of miliseconds for sleeping in the method Sleep.

Definition at line 31 of file jshandler.h.

std::queue<RunData> VRUT::JSHandler::executions [private]

The queue with all executions.

Definition at line 44 of file jshandler.h.

JSScriptingModule* VRUT::JSHandler::module [private]

The pointer to class JSScriptingModule.

Definition at line 47 of file jshandler.h.

JSEnvironment* VRUT::JSHandler::jsEnv [private]

The pointer to class JSEnvironment.

Definition at line 49 of file jshandler.h.

---

The documentation for this class was generated from the following files:

• /cygdrive/d/src/svn/vrut/trunk/modules/scripting/jshandler.h
• /cygdrive/d/src/svn/vrut/trunk/modules/scripting/jshandler.cpp