include/lang/SC_TerminalClient.h

   1 /*  -*- c++ -*-
   2         Commandline interpreter interface.
   3         Copyright (c) 2003 2004 stefan kersten.
   4
   5         ====================================================================
   6
   7         SuperCollider real time audio synthesis system
   8     Copyright (c) 2002 James McCartney. All rights reserved.
   9         http://www.audiosynth.com
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19     GNU General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with this program; if not, write to the Free Software
  23     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  24 */
  25
  26 #ifndef SC_TERMINALCLIENT_H_INCLUDED
  27 #define SC_TERMINALCLIENT_H_INCLUDED
  28
  29 #include "SC_LanguageClient.h"
  30 #include "SC_StringBuffer.h"
  31
  32 // =====================================================================
  33 // SC_TerminalClient - command line sclang client.
  34 // =====================================================================
  35
  36 class SC_DLLEXPORT SC_TerminalClient : public SC_LanguageClient
  37 {
  38 public:
  39         enum
  40         {
  41                 kInterpretCmdLine = 0x1b,
  42                 kInterpretPrintCmdLine = 0x0c,
  43                 kRecompileLibrary = 0x18 // ctrl+x
  44         };
  45
  46         enum Signal
  47         {
  48                 sig_input = 0x01, // there is new input
  49                 sig_sched = 0x02, // something has been scheduled
  50                 sig_recompile = 0x04, // class lib recompilation requested
  51                 sig_stop = 0x08 // call Main:-stop
  52         };
  53
  54         struct Options : public SC_LanguageClient::Options
  55         {
  56                 Options()
  57                         : mLibraryConfigFile(0),
  58                           mDaemon(false),
  59                           mCallRun(false),
  60                           mCallStop(false),
  61                           mArgc(0), mArgv(0)
  62                 { }
  63
  64                 const char*             mLibraryConfigFile;
  65                 bool                    mDaemon;
  66                 bool                    mCallRun;
  67                 bool                    mCallStop;
  68                 int                             mArgc;
  69                 char**                  mArgv;
  70         };
  71
  72         SC_TerminalClient(const char* name);
  73         virtual ~SC_TerminalClient();
  74
  75         const Options& options() const { return mOptions; }
  76         bool shouldBeRunning() const { return mShouldBeRunning; }
  77
  78         int run(int argc, char** argv);
  79         void quit(int code);
  80
  81         virtual void postText(const char* str, size_t len);
  82         virtual void postFlush(const char* str, size_t len);
  83         virtual void postError(const char* str, size_t len);
  84         virtual void flush();
  85
  86         // Requests an action to be taken on the main thread.
  87         // NOTE: It may be called from any thread, and with interpreter locked.
  88         virtual void sendSignal( Signal code );
  89
  90 protected:
  91         bool parseOptions(int& argc, char**& argv, Options& opt);
  92         void printUsage();
  93
  94         void interpretCmdLine(PyrSymbol* method, SC_StringBuffer& cmdLine);
  95         void interpretCmdLine(PyrSymbol* method, const char* cmdLine);
  96         void interpretCmdLine(PyrSymbol* method, const char *buf, size_t size);
  97
  98         void lockInput() { pthread_mutex_lock(&mInputMutex); }
  99         void unlockInput() { pthread_mutex_unlock(&mInputMutex); }
 100
 101         // --------------------------------------------------------------
 102
 103         // NOTE: Subclasses should call from main thread
 104         // after receiving sig_input, and with input locked:
 105         void interpretInput();
 106
 107         // --------------------------------------------------------------
 108
 109         // Language requested the application to quit
 110         // NOTE: It may be called from any thread, and with interpreter locked.
 111         virtual void onQuit( int exitCode );
 112
 113         // See super class
 114         virtual void onLibraryStartup();
 115
 116         // --------------------------------------------------------------
 117
 118         // NOTE: Subclasses should override:
 119         virtual void commandLoop();
 120         virtual void daemonLoop();
 121
 122         // --------------------------------------------------------------
 123
 124         static int prArgv(struct VMGlobals* g, int);
 125         static int prExit(struct VMGlobals* g, int);
 126         static int prScheduleChanged( struct VMGlobals *, int);
 127         static int prRecompile(struct VMGlobals *, int);
 128
 129 private:
 130         // NOTE: called from input thread:
 131 #ifdef HAVE_READLINE
 132         static void readlineInit();
 133         static void *readlineFunc(void *);
 134         static int readlineRecompile(int, int);
 135         static void readlineCmdLine(char *cmdLine);
 136 #endif
 137         static void *pipeFunc( void * );
 138         void pushCmdLine( SC_StringBuffer &buf, const char *newData, size_t size );
 139
 140         void initInput();
 141         void startInput();
 142         void endInput();
 143         void cleanupInput();
 144
 145         // helpers
 146         void lockSignal() { pthread_mutex_lock(&mSignalMutex); }
 147         void unlockSignal() { pthread_mutex_unlock(&mSignalMutex); }
 148
 149         bool                            mShouldBeRunning;
 150         int                                     mReturnCode;
 151         Options                         mOptions;
 152
 153         // signals to main thread
 154         pthread_mutex_t mSignalMutex;
 155         pthread_cond_t mCond;
 156         int mSignals;
 157
 158         // command input
 159         bool mUseReadline;
 160         bool mInputShouldBeRunning;
 161         SC_StringBuffer mInputBuf;
 162 #ifndef _WIN32
 163         int mInputCtlPipe[2];
 164 #else
 165         HANDLE mQuitInputEvent;
 166 #endif
 167         pthread_t mInputThread;
 168         pthread_mutex_t mInputMutex;
 169         pthread_cond_t mInputCond;
 170 };
 171
 172 #endif // SC_TERMINALCLIENT_H_INCLUDED