help: fix documentation for String-openDocument
[supercollider.git] / HelpSource / Guides / News-3_5.schelp
blob80353ce1c04b29c039d2615113852330425c8378
1 title:: News in 3.5
2 summary:: A summary of news in SC 3.5
3 categories:: News
5 SECTION:: Language-side news
7 subsection:: Qt GUI
8 A new cross-platform GUI kit intended to replace Cocoa and an alternative to SwingOSC.
9 See link::Guides/News-Qt-GUI:: for more.
11 subsection:: SCDoc
12 A new help-system provides consistent documentation with good introspection and easy link::Search##searching:: and link::Browse##browsing::.
14 The help-files are written in a markup language which is then parsed and used to generate HTML files, which are displayed with the new link::Classes/WebView:: widget inside the link::Classes/HelpBrowser::.
16 See link::Classes/SCDoc::, link::Reference/SCDocSyntax::, link::Guides/WritingHelp::.
18 Also a new method link::Classes/Help#*methodArgs:: returns a human-readable string of arguments and default values for a method. Example: code::Help.methodArgs("SinOsc.ar")::
20 In SuperCollider version 3.5.2, SCDoc has been rewritten and the parser is now implemented in C++ for speed and stability.
21 The syntax has gotten stricter, and it will throw errors or warnings if there are faults in the documentation. See link::Guides/WritingHelp#News in SC 3.5.2:: for some important changes to keep in mind.
23 subsection:: OSC and MIDI responders
24 The new link::Classes/OSCFunc:: and link::Classes/MIDIFunc:: provides better alternatives to the old link::Classes/OSCresponderNode:: and link::Classes/NoteOnResponder::, etc.
26 OSCFunc can receive on any port, not only the main code::NetAddr.langPort::.
28 subsection:: New Location of Startup file
30 The link::Reference/StartupFile##sclang startup file:: has moved to code::Platform.userConfigDir +/+ "startup.scd"::.
31 Old platform-specific startup file locations have been deprecated. The new startup file is plain-text, rtf is not supported.
33 subsection:: Language configuration files
35 The linux-only library configuration file has been deprecated. It is replaced by a cross-platform language configuration
36 file, which is located at code::Platform.userConfigDir +/+ "sclang_conf.yaml" :: . It can be configured via the
37 link::Classes/LanguageConfig:: class.
39 subsection:: Sced3
40 The GEdit plugin sced has been updated to support GEdit version 3.
42 subsection:: WiiMote
43 code::WiiMote.discover:: now returns the device object, or nil if it failed.
45 subsection:: Bus-asMap in patterns
46 Bus-asMap symbols are now allowed in code::\freq:: and friends in patterns.
48 subsection:: Warn on classlib overwrites
49 Warnings are posted when extensions overwrites methods in main class lib, unless the extensions are put in a subfolder named "SystemOverwrites".
51 subsection:: Filesystem utils
52 New cross-platform filesystem utilities: link::Classes/File#*copy::, link::Classes/File#*mtime::, link::Classes/File#*mkdir::, link::Classes/File#*realpath::, link::Classes/File#*type::, link::Classes/File#*fileSize::
54 subsection:: String-openTextFile
55 link::Classes/String#-openTextFile:: now works also on frontends without link::Classes/Document:: support. It falls back to link::Classes/String#-openOS:: to open the file with the default application for that file type.
57 subsection:: Optional trailing comma
58 It was already allowed to have a trailing comma in arrays: code::[1,2,3,]::,
59 but now it's also allowed in Event construction and message arguments:
60 code::
61 (a:1, b:2, c:3,);
63 Pbind(
64     \foo, 1,
65     \bar, 2,
68 myFunc.value(1, 2, 3,);
71 subsection:: Various bugfixes
72 A lot of bugs has been fixed, for example: String regexp primitives, multichannel wrappers of SequenceableCollection, CoinGate.ar, T2K, WiiMote, SynthDesc.
74 subsection:: Interpreter Performance Improvements
76 The sclang now uses token threading footnote::http://www.complang.tuwien.ac.at/forth/threaded-code.html:: instead of one huge switch statement for bytecode dispatching.
78 subsection:: PriorityQueue stable order
80 The link::Classes/PriorityQueue:: now provides a stable heap order: items of the same time value will have a FIFO order.
82 subsection:: plot improvements
84 link::Reference/plot:: has been changed to use the link::Classes/Plotter:: class, which was formerly used by the code::plot2:: methods. code::plot2:: has been deprecated, the old behavior is still available via the code::plotOld:: methods, which have also been deprecated.
86 subsection:: UI deprecated
88 The UI class has been deprecated. Its functionality is now provided by the link::Classes/ShutDown:: and
89 link::Classes/OnError:: classes.
91 subsection:: Panner and XFade classes deprecated
93 The Panner and XFade classes that been used internally are now deprecated. UGens are better off, implementing the
94 code::checkInputs:: explicitly.
96 subsection:: Quark files outside DIRECTORY
98 teletype::*.quark:: files are now allowed to be within the quark itself rather than in the DIRECTORY.
99 This allows manually installed quarks to be easily managed by link::Classes/Quarks#*gui::
101 subsection:: New error marker
102 Instead of the non-cross-platform bullet-character (•), the error token in error messages are now underlined with teletype::^^^:: characters instead.
104 For example, the code code::[a, %%&&**, b]:: results in:
105 teletype::
106   line 1 char 10:
108   [a, %%&&**, b]
109       ^^^^^^
112 SECTION:: Server-side news
114 subsection:: Bitwise ops
115 The bitwise operators code::&:: (and), code::|:: (or), code:: xor: :: (xor), code::<<:: (left shift) and code::>>:: (right shift) are now supported server-side on audio and control signals. Example:
116 code::
117 // 8-bit magic
119 play {
120     var t = PulseCount.ar(Impulse.ar(8e3));
121     HPF.ar(
122         (
123             ((t * 15) & (t >> 5)) |
124             ((t * 5)  & (t >> [3, 4])) |
125             ((t * 2)  & (t >> 9)) |
126             ((t * 8)  & (t >> 11))
127             - 3 % 256
128         ) / 127-1 * 3
129         , 20
130     ).tanh
135 subsection:: VarLag UGen
136 The new link::Classes/VarLag:: UGen provides the same functionality as Lag but with linear and other curves.
138 subsection:: DelTapWr/DelTapRd UGens
139 The new link::Classes/DelTapRd:: and link::Classes/DelTapWr:: UGen can be used to easily implement multitap delays.
141 subsection:: Node-onFree
142 A new method link::Classes/Node#-onFree:: runs a function when node finished playing.
144 subsection:: LocalIn initial value
145 link::Classes/LocalIn:: now has an input for initial value.
147 subsection:: Close buffers on free
148 teletype::/b_free:: also free's soundfile if open (like teletype::/b_close::)
150 subsection:: More done flags
151 link::Classes/Demand::, link::Classes/VDiskIn:: and link::Classes/DiskIn:: now sets done flag (to be used by link::Classes/Done:: or link::Classes/FreeSelfWhenDone::)
154 subsection:: Shared Memory Server Interface
156 A shared-memory interface to the server has been introduced. This allows scoping and synchronous control bus access
157 for local clients.
159 subsection:: HPF/RHPF internal precision
161 The recursive filter loop for link::Classes/HPF:: and link::Classes/RHPF:: has been changed to double-precision in
162 order to avoid quantization noise. Pieces that depend on the quantization noise can make use of the GlitchUGens provided in sc3-plugins, which implement the old behavior.
164 subsection:: Plugin entry point
166 Plugins should use the teletype::PluginLoad:: macro as entry point instead of implementing a teletype::load:: funcion.
167 This allows ABI version checks and ensures that the entry point function is correctly exported from the shared library.
168 See link::Guides/WritingUGens:: for details.
170 subsection:: New FFT Plugin API
172 A new FFT API for server plugins has been introduced: this simplifies writing FFT ugens in a cross-platform manner,
173 since no external FFT libraries are required.
175 subsection:: Supernova
177 A new multi-processor implementation of scsynth. Parallelism of the synthesis graph is exposed to the user via the
178 link::Classes/ParGroup:: class. Supernova is currently linux-only. It is not provided in the OSX/Windows binaries. In
179 order to play patterns inside a ParGroup, the link::Classes/PparGroup:: can be used. Scsynth emulates parallel groups
180 with groups.
182 Plugins have to be adapted by acquiring spinlocks when accessing busses or buffers. See link::Guides/WritingUGens:: for
183 details.