HelpSource/Classes/Main.schelp

   1 class::Main
   2 categories::Core>Kernel
   3 summary:: The concrete instance of Process
   4 related:: Classes/StartUp
   5
   6 description::
   7
   8 Main is the concrete instance of link::Classes/Process:: (the runtime environment for the virtual machine and interpreter).
   9 Main overrides some methods of Process. There are two methods of interest. One is named startup and is
  10 called after the class library has been compiled. The other is called shutdown which gets called when the library gets re-compiled.
  11
  12 method:: thisProcess
  13 The singleton instance of Main is available through the special keyword thisProcess.
  14 For example, to find out what platform you're on:
  15
  16 code::
  17 thisProcess.platform;   // --> e.g. "an OSXPlatform", "a LinuxPlatform", ...
  18 ::
  19
  20 classMethods::
  21
  22 subsection:: SuperCollider version
  23 These class methods tell you which version of SuperCollider you are running and whether that version complies to your required minimum / maximum settings:
  24
  25 method::version
  26
  27 returns:: the current version as a human readable string
  28
  29 method::versionAtLeast
  30 check if we are running at least version maj.min
  31 code::
  32 Main.versionAtLeast( 3, 1 );
  33 ::
  34 returns:: true or false
  35
  36 method::versionAtMost
  37 check if we are running version maj.min or older
  38 code::
  39 Main.versionAtMost( 3, 1 );
  40 ::
  41 returns:: true or false
  42
  43 instanceMethods::
  44
  45 private::prArgv, prOpenUDPPort
  46
  47 method::startup
  48
  49 Called after the class library has been compiled.
  50
  51 discussion::
  52 This calls the superclass' startup, which among other things initializes the link::Classes/AppClock:: and the top-level link::Classes/Environment::.
  53
  54 Main's startup then stores Server.default in the interpreter variable s, sets the platform default's link::Classes/GUI:: kit, initializes the link::Classes/GeneralHID:: system, calls a link::Classes/Platform:: specific startup method (for example OSXPlatform's startup opens the server windows), and finally invokes StartUp.run.
  55
  56 To add your own startup functionalities, you could either edit the special startup-file (discussed in link::Reference/StartupFile::), or use StartUp.add as discussed in the link::Classes/StartUp:: help file.
  57
  58 method::shutdown
  59
  60 Called after SuperCollider is quit or the class library is about to be re-compiled.
  61
  62 discussion::
  63 This will quit all audio link::Classes/Server:: instances, perform a platform specific shutdown (e.g. on Mac OS X, the HID service is released), finally Process' shutdown method is called, resulting in successive calls to UI.shutdown, NetAddr.disconnectAll, File.closeAll, and Archive.write. To register your own shutdown code, use a call like this:
  64
  65 code::
  66 ShutDown.add({ "Good bye!!".postln });
  67 ::
  68
  69 method::run
  70
  71 Override this to do whatever you want, e. g. add a class extension file like this to the class library:
  72
  73 code::
  74 + Main {
  75         run { "myPatch.rtf".load }
  76 }
  77 ::
  78
  79 method::recvOSCfunc
  80
  81 Get or set a custom link::Classes/Function:: in this field that gets called whenever SuperCollider language (the client) receives an OSC message.
  82
  83 warning::This method has been deprecated as of SC 3.5, and users should instead should use link::#-addOSCFunc:: and link::#-removeOSCFunc:: to avoid overwriting any other functions added here by system objects.::
  84
  85 argument::newFunc
  86 A link::Classes/Function:: or similar object to be set. When evaluated, this function will be passed the arguments time, replyAddr, and message, corresponding to the time the message was sent, the link::Classes/NetAddr:: of the sender, and the message itself as an link::Classes/Array::.
  87
  88 method::addOSCRecvFunc
  89
  90 Register a link::Classes/Function:: to be evaluated whenever SuperCollider language (the client) receives an OSC message. This will not overwrite any previously registered functions.
  91
  92 argument::func
  93 A link::Classes/Function:: or similar object to be added. When evaluated, this function will be passed the arguments msg, time, replyAddr, and recvPort, corresponding to the message itself as an link::Classes/Array::, the time the message was sent, the link::Classes/NetAddr:: of the sender, and the port on which the message was received. Note that this order differs from that used by the deprecated method link::#-recvOSCfunc::.
  94
  95 code::
  96 // post all incoming traffic except the server status messages
  97 // basically the same as OSCFunc.trace
  98 (
  99 f = { |msg, time, replyAddr, recvPort|
 100         if(msg[0] != '/status.reply') {
 101                 "At time %s received message % from % on port%\n".postf( time, msg, replyAddr, recvPort )
 102         }
 103 };
 104 thisProcess.addOSCRecvFunc(f);
 105 );
 106
 107 // stop posting.
 108 thisProcess.removeOSCRecvFunc(f);
 109 ::
 110
 111 method::removeOSCRecvFunc
 112
 113 Remove a link::Classes/Function:: from the list of those evaluated whenever SuperCollider language (the client) receives an OSC message. This will leave any other registered functions in place.
 114
 115 argument::func
 116 A link::Classes/Function:: or similar object to be removed.
 117
 118 method::replaceOSCRecvFunc
 119
 120 Replace a link::Classes/Function:: in the list of those evaluated whenever SuperCollider language (the client) receives an OSC message with a different one. This will leave any other registered functions in place.
 121
 122 argument::func
 123 The link::Classes/Function:: or similar object to be replaced.
 124
 125 argument::newFunc
 126 A link::Classes/Function:: or similar object to be replace the one being removed. When evaluated, this function will be passed the arguments time, replyAddr, recvPort, and message, corresponding to the time the message was sent, the link::Classes/NetAddr:: of the sender, the port on which the message was received, and the message itself as an link::Classes/Array::.
 127
 128 method::openUDPPort
 129 Attempt to open a new UDP port for receiving OSC traffic. If another application has already bound to the requested port this will fail. Once opened, ports remain bound until SC is recompiled.
 130
 131 If the port was already opened by SC it will return true directly without trying to open the port again.
 132
 133 argument::portNum
 134 An link::Classes/Integer:: indicating the port to attempt to bind.
 135
 136 returns::A link::Classes/Boolean:: indicating whether the attempt was successful.
 137
 138 code::
 139 thisProcess.openUDPPort(3000); // will return true or false.
 140 thisProcess.openPorts; // returns all open ports
 141 ::
 142
 143 method::openPorts
 144 Get a collection of all active UDP ports, including the main sclang port code::NetAddr.langPort::.
 145
 146 returns::A link::Classes/Set::.
 147
 148 method::pid
 149
 150 Returns:: The operating system's pid (process ID) for the process.
 151
 152 method::preferencesAction
 153
 154 A function to evaluate when the SuperCollider preferences menu is selected.
 155
 156 code::
 157 thisProcess.preferencesAction = { arg process; SCWindow.new.front; }
 158 ::
 159
 160 method::recompile
 161
 162 Recompiles the class library. This is equivalent to restarting SC. Currently OSX (SuperCollider.app) only.
 163
 164 method::platform
 165 Get the current link::Classes/Platform::
 166
 167 method::argv
 168 Get the command-line arguments passed to sclang.
 169