ScriptCommandRelay.cpp File Reference

Contains definitions for ScriptCommandRelay. More...

#include "ScriptCommandRelay.h"
#include "CommandTargets.h"
#include "CommandBuilder.h"
#include "ActiveProject.h"
#include "AppCommandEvent.h"
#include "Project.h"
#include <wx/app.h>
#include <thread>

Include dependency graph for ScriptCommandRelay.cpp:

Go to the source code of this file.

Functions
static int	ExecCommand (wxString *pIn, wxString *pOut, bool fromMain)
	This is the function which actually obeys one command. More...
static int	ExecFromWorker (wxString *pIn, wxString *pOut)
	Executes a command in the worker (script) thread. More...
int	ExecFromMain (wxString *pIn, wxString *pOut)
	Executes a command on the main (GUI) thread. More...

Detailed Description

Contains definitions for ScriptCommandRelay.

Definition in file ScriptCommandRelay.cpp.

Function Documentation

ExecCommand()

static int ExecCommand ( wxString *  pIn, wxString *  pOut, bool  fromMain  )

static

This is the function which actually obeys one command.

Definition at line 33 of file ScriptCommandRelay.cpp.

{
   if (auto pProject = ::GetActiveProject().lock()) {
      CommandBuilder builder(*pProject, *pIn);
      if (builder.WasValid())
      {
         OldStyleCommandPointer cmd = builder.GetCommand();
 
         AppCommandEvent ev;
         ev.SetCommand(cmd);
 
         if (fromMain)
         {
            // Use SafelyProcessEvent, which stops exceptions, because this is
            // expected to be reached from within the XLisp runtime
            wxTheApp->SafelyProcessEvent(ev);
         }
         else
         {
            // Send the event to the main thread
            wxTheApp->AddPendingEvent(ev);
         }
      }
 
      // Wait for and retrieve the response
      *pOut = builder.GetResponse();
   }
   else
      *pOut = wxString{};
 
   return 0;
}

References GetActiveProject(), CommandBuilder::GetCommand(), CommandBuilder::GetResponse(), AppCommandEvent::SetCommand(), and CommandBuilder::WasValid().

Referenced by ExecFromMain(), and ExecFromWorker().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecFromMain()

int ExecFromMain	(	wxString *	pIn,
		wxString *	pOut
	)

Executes a command on the main (GUI) thread.

Definition at line 73 of file ScriptCommandRelay.cpp.

{
   return ExecCommand(pIn, pOut, true);
}

References ExecCommand().

Here is the call graph for this function:

ExecFromWorker()

static int ExecFromWorker ( wxString *  pIn, wxString *  pOut  )

static

Executes a command in the worker (script) thread.

Definition at line 67 of file ScriptCommandRelay.cpp.

{
   return ExecCommand(pIn, pOut, false);
}

References ExecCommand().

Referenced by ScriptCommandRelay::StartScriptServer().

Here is the call graph for this function:

Here is the caller graph for this function: