HelpSource/Classes/Platform.schelp

   1 class:: Platform
   2 summary:: handle cross-platform differencies
   3 categories:: CrossPlatform
   4
   5 description::
   6 The Platform class (along with its subclasses) handles things which differ between operating systems (mac/linux/windows/...), to simplify cross-platform aspects of SuperCollider.
   7
   8 Platform is an abstract class encapsulating various platform dependent constants and properties, such as directories, primitive features and startup files. The platform object is accessible through the code::platform:: method of the main process instance:
   9 code::
  10 thisProcess.platform
  11 ::
  12
  13 Currently implemented platforms include: OSXPlatform, LinuxPlatform, WindowsPlatform, UnixPlatform.
  14
  15 classmethods::
  16 Most of Platforms class methods are simply wrappers to code::thisProcess.platform.method::.
  17
  18 subsection:: Platform name and platform dependent actions
  19
  20 method:: case
  21 Perform actions depending on the current platform (name), just like Object:switch:
  22 code::
  23 Platform.case(
  24     \osx,       { "OSX".postln },
  25     \linux,     { "Linux".postln },
  26     \windows,   { "Windows".postln }
  27 );
  28 ::
  29
  30 method:: ideName
  31 returns a String indicating which IDE the language believes it is running in. (Often this is determined via the "-i" option to the sclang executable.) This is determined when sclang starts and cannot be changed dynamically.
  32
  33 The main purpose of this is to include/exclude folders from the class search patch depending on which IDE is in use: for example, if the value of ideName is "scapp" then folders named "scide_scapp" are included and all other folders beginning with "scide_" are excluded. The default value of this is "none".
  34
  35 Known IDE names in use are "scapp" (SuperCollider.app on Mac), "scvim" (vim), "scel" (emacs). Others may be used.
  36
  37 subsection:: Directories and filesystem stuff
  38 method:: classLibraryDir
  39 location of the bundled class library
  40
  41 method:: helpDir
  42 location of the bundled help files
  43
  44 method:: systemAppSupportDir
  45 system application support directory
  46
  47 method:: userAppSupportDir
  48 user application support directory
  49
  50 method:: userConfigDir
  51 directory for configuration files
  52
  53 method:: systemExtensionDir
  54 system extension directory (see link::Guides/Using-Extensions::)
  55
  56 method:: userExtensionDir
  57 user extension directory (see link::Guides/Using-Extensions::)
  58
  59 method:: platformDir
  60 platform specific directory for class files (see link::Guides/Using-Extensions::)
  61
  62 method:: pathSeparator
  63 platform specific path separator
  64
  65 subsection:: Features
  66
  67 method:: when
  68 Evaluate ifFunction if all features are present, otherwise evaluate elseFunction.
  69 code::
  70 Platform.when(#[\Document, \SCWindow], { "yeehah!".postln });
  71 ::
  72
  73 instancemethods::
  74
  75 method:: name
  76 returns the platform name
  77
  78 subsection:: Directories and filesystem stuff
  79 method:: classLibraryDir
  80 location of the bundled class library
  81
  82 method:: helpDir
  83 location of the bundled help files
  84
  85 method:: systemAppSupportDir
  86 system application support directory
  87
  88 method:: userAppSupportDir
  89 user application support directory
  90
  91 method:: userConfigDir
  92 directory for configuration files
  93
  94 method:: systemExtensionDir
  95 system extension directory (see link::Guides/Using-Extensions::)
  96
  97 method:: userExtensionDir
  98 user extension directory (see link::Guides/Using-Extensions::)
  99
 100 method:: platformDir
 101 platform specific directory for class files (see link::Guides/Using-Extensions::)
 102
 103 method:: pathSeparator
 104 platform specific path separator
 105
 106 subsection:: Startup files
 107
 108 method:: startupFiles
 109 files to be loaded on startup
 110
 111 method:: loadStartupFiles
 112 (re)load startup files
 113
 114 subsection:: Features
 115
 116 Features are abstract symbols that can be declared by extension authors and be checked during runtime in user code. Apart from explicitly declared features, class and primitive names are implicitly declared.
 117
 118 method:: declareFeature
 119 Declare aSymbol to be a feature present in the runtime. Class names and primitive names cannot be declared as features.
 120
 121 method:: hasFeature
 122 Return true if the feature aSymbol is present in the runtime system. aSymbol can refer to explicitly declared features as well as class and primitive names.
 123 code::
 124 thisProcess.platform.hasFeature(\Object);
 125 thisProcess.platform.hasFeature('_SCWindow_BeginFullScreen');
 126 thisProcess.platform.hasFeature('_myFuncyPrimitive');
 127
 128 thisProcess.platform.declareFeature('superCrazyCompositionSystem');
 129 thisProcess.platform.hasFeature('superCrazyCompositionSystem');
 130 ::
 131
 132 method:: when
 133 Evaluate ifFunction if all features are present, otherwise evaluate elseFunction.
 134 code::
 135 thisProcess.platform.when(#[\Document, \SCWindow], { "yeehah!".postln });
 136 ::