HelpSource/Classes/Platform.schelp

   1 class:: Platform
   2 summary:: handle cross-platform differencies
   3 categories:: Platform
   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/UsingExtensions::)
  55
  56 method:: userExtensionDir
  57 user extension directory (see link::Guides/UsingExtensions::)
  58
  59 method:: platformDir
  60 platform specific directory for class files (see link::Guides/UsingExtensions::)
  61
  62 method:: pathSeparator
  63 platform specific path separator
  64
  65 method:: resourceDir
  66 platform specific resource directory
  67
  68 method:: defaultTempDir
  69 default directory for temporary files
  70
  71 subsection:: Features
  72
  73 method:: when
  74 Evaluate ifFunction if all features are present, otherwise evaluate elseFunction.
  75 code::
  76 Platform.when(#[\Document, \SCWindow], { "yeehah!".postln });
  77 ::
  78
  79 instancemethods::
  80
  81 private:: shutdown, startup
  82
  83 method:: name
  84 returns the platform name
  85
  86 method:: recompile
  87 recompile class library
  88
  89
  90 subsection:: Directories and filesystem stuff
  91 method:: classLibraryDir
  92 location of the bundled class library
  93
  94 method:: helpDir
  95 location of the bundled help files
  96
  97 method:: systemAppSupportDir
  98 system application support directory
  99
 100 method:: userAppSupportDir
 101 user application support directory
 102
 103 method:: userConfigDir
 104 directory for configuration files
 105
 106 method:: systemExtensionDir
 107 system extension directory (see link::Guides/UsingExtensions::)
 108
 109 method:: userExtensionDir
 110 user extension directory (see link::Guides/UsingExtensions::)
 111
 112 method:: platformDir
 113 platform specific directory for class files (see link::Guides/UsingExtensions::)
 114
 115 method:: pathSeparator
 116 platform specific path separator
 117
 118 method:: resourceDir
 119 platform specific resource directory
 120
 121 method:: recordingsDir
 122 recording directory
 123
 124 method:: defaultTempDir
 125 default directory for temporary files
 126
 127
 128
 129 subsection:: Startup files
 130
 131 method:: startupFiles
 132 files to be loaded on startup
 133
 134 method:: loadStartupFiles
 135 (re)load startup files
 136
 137 subsection:: Features
 138
 139 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.
 140
 141 method:: declareFeature
 142 Declare aSymbol to be a feature present in the runtime. Class names and primitive names cannot be declared as features.
 143
 144 method:: hasFeature
 145 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.
 146 code::
 147 thisProcess.platform.hasFeature(\Object);
 148 thisProcess.platform.hasFeature('_SCWindow_BeginFullScreen');
 149 thisProcess.platform.hasFeature('_myFuncyPrimitive');
 150
 151 thisProcess.platform.declareFeature('superCrazyCompositionSystem');
 152 thisProcess.platform.hasFeature('superCrazyCompositionSystem');
 153 ::
 154
 155 method:: when
 156 Evaluate ifFunction if all features are present, otherwise evaluate elseFunction.
 157 code::
 158 thisProcess.platform.when(#[\Document, \SCWindow], { "yeehah!".postln });
 159 ::