ScripterCallback.cpp File Reference

#include <wx/wx.h>
#include "ScripterCallback.h"
#include "commands/ScriptCommandRelay.h"
#include "ModuleConstants.h"

Include dependency graph for ScripterCallback.cpp:

Go to the source code of this file.

Typedefs
typedef DLL_IMPORT int(*	tpExecScriptServerFunc) (wxString *pIn, wxString *pOut)

Functions
void	PipeServer ()
int DLL_API	RegScriptServerFunc (tpExecScriptServerFunc pFn)
DEFINE_VERSION_CHECK DLL_API int	ModuleDispatch (ModuleDispatchTypes type)
int	DoSrv (char *pIn)
size_t	smin (size_t a, size_t b)
int	DoSrvMore (char *pOut, size_t nMax)

Variables
static tpExecScriptServerFunc	pScriptServerFn =NULL
wxString	Str2
wxArrayString	aStr
unsigned int	currentLine
size_t	currentPosition

Typedef Documentation

tpExecScriptServerFunc

typedef DLL_IMPORT int(* tpExecScriptServerFunc) (wxString *pIn, wxString *pOut)

Definition at line 28 of file ScripterCallback.cpp.

Function Documentation

DoSrv()

int DoSrv

(

char *

pIn

)

Definition at line 66 of file ScripterCallback.cpp.

{
   // Interpret string as unicode.
   // wxWidgets (now) uses unicode internally.
   // Scripts must send unicode strings (if going beyond 7-bit ASCII).
   // Important for filenames in commands.
   wxString Str1(pIn, wxConvUTF8); 
   Str1.Replace( wxT("\r"), wxT(""));
   Str1.Replace( wxT("\n"), wxT(""));
   Str2 = wxEmptyString;
   (*pScriptServerFn)( &Str1 , &Str2);
 
   Str2 += wxT('\n');
   size_t outputLength = Str2.Length();
   aStr.Clear();
   size_t iStart = 0;
   size_t i;
   for(i = 0; i < outputLength; ++i)
   {
      if( Str2[i] == wxT('\n') )
      {
         aStr.Add( Str2.Mid( iStart, i-iStart) + wxT("\n") );
         iStart = i+1;
      }
   }
 
   currentLine     = 0;
   currentPosition = 0;
 
   return 1;
}

References aStr, currentLine, currentPosition, Str2, and wxT().

Referenced by PipeServer().

Here is the call graph for this function:

Here is the caller graph for this function:

DoSrvMore()

int DoSrvMore	(	char *	pOut,
		size_t	nMax
	)

Definition at line 103 of file ScripterCallback.cpp.

{
   wxASSERT(currentLine >= 0);
   wxASSERT(currentPosition >= 0);
 
   size_t totalLines = aStr.GetCount();
   while (currentLine < totalLines)
   {
      wxCharBuffer lineString    = aStr[currentLine].ToUTF8();
      size_t lineLength      = lineString.length();
      size_t charsLeftInLine = lineLength - currentPosition;
 
      wxASSERT(charsLeftInLine >= 0);
 
      if (charsLeftInLine == 0)
      {
         // Move to next line
         ++currentLine;
         currentPosition = 0;
      }
      else
      {
         // Write as much of the rest of the line as will fit in the buffer
         size_t charsToWrite = smin(charsLeftInLine, nMax - 1);
         memcpy(pOut, 
                &(lineString.data()[currentPosition]),
                charsToWrite);
         pOut[charsToWrite] = '\0';
         currentPosition    += charsToWrite;
         // Need to cast to prevent compiler warnings
         int charsWritten = static_cast<int>(charsToWrite + 1);
         // (Check cast was safe)
         wxASSERT(static_cast<size_t>(charsWritten) == charsToWrite + 1);
         return charsWritten;
      }
   }
   return 0;
}

References aStr, currentLine, currentPosition, and smin().

Referenced by PipeServer().

Here is the call graph for this function:

Here is the caller graph for this function:

ModuleDispatch()

DEFINE_VERSION_CHECK DLL_API int ModuleDispatch

(

ModuleDispatchTypes

type

)

Definition at line 47 of file ScripterCallback.cpp.

{
   switch (type) {
   case ModuleInitialize:
      ScriptCommandRelay::StartScriptServer(RegScriptServerFunc);
      break;
   default:
      break;
   }
   return 1;
}

References ModuleInitialize, RegScriptServerFunc(), and ScriptCommandRelay::StartScriptServer().

Here is the call graph for this function:

PipeServer()

void PipeServer

(

)

Definition at line 124 of file PipeServer.cpp.

{
   FILE *fromFifo = NULL;
   FILE *toFifo = NULL;
   int rc;
   char buf[nBuff];
   char toFifoName[nBuff];
   char fromFifoName[nBuff];
 
   sprintf(toFifoName, fifotmpl, "to", getuid());
   sprintf(fromFifoName, fifotmpl, "from", getuid());
 
   unlink(toFifoName);
   unlink(fromFifoName);
 
   // TODO avoid symlink security issues?
 
   rc = mkfifo(fromFifoName, S_IRWXU) & mkfifo(toFifoName, S_IRWXU);
   if (rc < 0)
   {
      perror("Unable to create fifos");
      printf("Ignoring...");
//      return;
   }
 
   // open to (incoming) pipe first.  
   toFifo = fopen(toFifoName, "r");
   if (toFifo == NULL)
   {
      perror("Unable to open fifo to server from script");
      if (fromFifo != NULL)
         fclose(fromFifo);
      return;
   }
 
   // open from (outgoing) pipe second.  This could block if there is no reader.
   fromFifo = fopen(fromFifoName, "w");
   if (fromFifo == NULL)
   {
      perror("Unable to open fifo from server to script");
      return;
   }
 
   while (fgets(buf, sizeof(buf), toFifo) != NULL)
   {
      int len = strlen(buf);
      if (len <= 1)
      {
         continue;
      }
 
      buf[len - 1] = '\0';
 
      printf("Server received %s\n", buf);
      DoSrv(buf);
 
      while (true)
      {
         len = DoSrvMore(buf, nBuff);
         if (len <= 1)
         {
            break;
         }
         printf("Server sending %s",buf);
 
         // len - 1 because we do not send the null character
         fwrite(buf, 1, len - 1, fromFifo);
      }
      fflush(fromFifo);
   }
 
   printf("Read failed on fifo, quitting\n");
 
   if (toFifo != NULL)
      fclose(toFifo);
 
   if (fromFifo != NULL)
      fclose(fromFifo);
 
   unlink(toFifoName);
   unlink(fromFifoName);
}

References DoSrv(), DoSrvMore(), fifotmpl, and nBuff.

Referenced by RegScriptServerFunc().

Here is the call graph for this function:

Here is the caller graph for this function:

RegScriptServerFunc()

int DLL_API RegScriptServerFunc

(

tpExecScriptServerFunc

pFn

)

Definition at line 35 of file ScripterCallback.cpp.

{
   if( pFn )
   {
      pScriptServerFn = pFn;
      PipeServer();
   }
 
   return 4;
}

References PipeServer(), and pScriptServerFn.

Referenced by ModuleDispatch().

Here is the call graph for this function:

Here is the caller graph for this function:

smin()

size_t smin	(	size_t	a,
		size_t	b
	)

Definition at line 98 of file ScripterCallback.cpp.

{ return a < b ? a : b; }

Referenced by DoSrvMore().

Here is the caller graph for this function:

Variable Documentation

aStr

wxArrayString aStr

Definition at line 60 of file ScripterCallback.cpp.

Referenced by DoSrv(), and DoSrvMore().

currentLine

unsigned int currentLine

Definition at line 61 of file ScripterCallback.cpp.

Referenced by DoSrv(), and DoSrvMore().

currentPosition

size_t currentPosition

Definition at line 62 of file ScripterCallback.cpp.

Referenced by DoSrv(), DoSrvMore(), and AccessibleLinksFormatter::Populate().

pScriptServerFn

tpExecScriptServerFunc pScriptServerFn =NULL

static

Definition at line 29 of file ScripterCallback.cpp.

Referenced by RegScriptServerFunc().

Str2

wxString Str2

Definition at line 59 of file ScripterCallback.cpp.

Referenced by DoSrv(), and ExecForLisp().