Merge branch '3.10' into develop

jamshark70 · Jan 6, 2019 · f5e5f18 · f5e5f18
2 parents 1342ac1 + 34c4486
commit f5e5f18
Show file tree

Hide file tree

Showing 29 changed files with 524 additions and 238 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -27,6 +27,8 @@ Error message (for bugs)
 // Please paste any error messages here **in their entirety**.
 // If this is a SuperCollider error message, include the full stack trace.
 // Link to a Gist (https://gist.github.com) if the message is long.
+// If your issue involves a crash, add a crash report.
+// See CONTRIBUTING.md in the root folder of the repository for instructions.
 ```
 
 Expected Behavior

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,7 +42,8 @@ Try to follow these guidelines:
 - **Investigate the issue**: What is the minimum effort or code required to produce the issue? Does it happen every time? Can you get it to happen on someone else's computer? Someone else's operating system?
 - **See if a ticket already exists**: Search SuperCollider's [open issues](https://github.com/supercollider/supercollider/issues). If an issue for your problem already exists, leave your comments in the issue's thread. Make sure you give your version and system info plus any information that you don't see already noted in the ticket.
 - **Ask the community**: If you're unsure about how to investigate or recreate an issue, it may help to ask the [sc-dev](http://new-supercollider-mailing-lists-forums-use-these.2681727.n2.nabble.com/mailing_list/MailingListOptions.jtp?forum=2681767) or [sc-users](http://new-supercollider-mailing-lists-forums-use-these.2681727.n2.nabble.com/mailing_list/MailingListOptions.jtp?forum=2676391) mailing lists. You can also try asking on [Slack](https://scsynth.slack.com) or on the [Facebook group](https://www.facebook.com/groups/supercollider/).
-- **Proceed in creating your issue** Be sure to create your issue in the appropriate repository. Note that [sc3-plugins](https://github.com/supercollider/sc3-plugins) are maintained in their own repository separate from SuperCollider.
+- **Proceed in creating your issue**: Be sure to create your issue in the appropriate repository. Note that [sc3-plugins](https://github.com/supercollider/sc3-plugins) are maintained in their own repository separate from SuperCollider.
+- **One ticket at a time**: If you have multiple issues to report, please open separate tickets for each one.
 
 ### Creating an issue
 
@@ -53,6 +54,8 @@ Please be as descriptive as possible when creating an issue. In order for us to
 - **extensions, plugins, helpers, etc.** (if applicable): List any extensions or modifications you are using
 - **error messages**: Paste all error messages *in their entirety* into the issue, or use a [gist](https://gist.github.com/) if the messages are very long.
 
+When an issue involves a crashing or unresponsive executable and you don't know why, providing a crash report can give developers a very helpful first step toward resolving the problem. See "Generating a crash report" below for instructions for your platform.
+
 ## Pull Requests
 
 ### Before making changes
@@ -138,6 +141,34 @@ Rebasing is one way to integrate changes from one branch onto another, in this c
 - don't rebase, but instead `git checkout topic/branch-description`, then `git pull`, followed by `git push origin`
 	- The result will be that your pull request will include your commits in addition to all other commits to `develop` since your branch was created (without changing the commit history).
 
+## Generating a crash report
+
+### macOS
+
+Crash logs are in `~/Library/Logs/DiagnosticReports`. The following command will list the crash reports for a SuperCollider program with the most recent first:
+
+    ls -lt ~/Library/Logs/DiagnosticReports | grep -E 'SuperCollider|sclang|scsynth|supernova'
+
+If the app is hanging, and you think you know which one it is, you can force it to crash and produce a log by sending it a segfault signal:
+
+    pkill -SIGSEGV <sc-executable> # may need to execute twice to force a crash
+
+The crash log will be placed in `~/Library/Logs/DiagnosticReports` with the others.
+
+### Linux
+
+A core dump file is generated when an application crashes. See [this helpful article](https://linux-audit.com/understand-and-configure-core-dumps-work-on-linux/) for information on core dumps and how to enable them on your machine. You don't need to send us the full core dump (it will probably be quite large), but you can generate a helpful backgrace with gdb:
+
+    gdb <sc-executable> <core-file> -ex where -ex quit
+
+See `man gdb` for more information on using core files.
+
+For a hanging process, you can use the command `pkill -SIGSEGV <sc-executable>` to force a crash, which will then produce a core dump.
+
+### Windows
+
+We don't currently have an easy way to get good crash log information on Windows. You can view logs in Event Viewer, but there's not enough information there that would be helpful for us. If you know of an easy way to get a high-quality crash report on Windows, let us know!
+
 ## Additional resources
 
 More information can be found on the [git workflow wiki page](https://github.com/supercollider/supercollider/wiki/git-workflow-and-guidelines).

diff --git a/HelpSource/BrokenLink.html b/HelpSource/BrokenLink.html
@@ -5,6 +5,7 @@
     <title>Broken link</title>
     <link rel='stylesheet' href='./scdoc.css' type='text/css' />
     <link rel='stylesheet' href='./custom.css' type='text/css' />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <noscript>
         <p>Sorry, that link was broken..

diff --git a/HelpSource/Browse.html b/HelpSource/Browse.html
@@ -3,10 +3,11 @@
 
 <head>
     <title>Document Browser | SuperCollider Help</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <link rel='stylesheet' href='./scdoc.css' type='text/css' />
     <link rel='stylesheet' href='./custom.css' type='text/css' />
     <link rel='stylesheet' href='./browse.css' type='text/css' />
-    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="lib/jquery.min.js"></script>
     <script>
         var scdoc_title = "Document Browser";

diff --git a/HelpSource/Classes/QtGUI.schelp b/HelpSource/Classes/QtGUI.schelp
@@ -0,0 +1,67 @@
+class:: QtGUI
+summary:: Top-level controls for Qt GUI
+categories:: GUI
+
+description::
+
+QtGUI provides top-level control for the Qt GUI bindings and some platform-level functionality.
+
+classmethods::
+
+private:: prStringBounds, prSetStyle, view, compositeView, hLayoutView, vLayoutView, window
+private:: scrollView, staticText, button, checkBox, textField, numberBox, slider, multiSliderView
+private:: rangeSlider, slider2D, knob, listView, treeView, popUpMenu, textView, freqScope, freqScopeView
+private:: scopeView, stethoscope1, stethoscope, soundFileView, envelopeView, levelIndicator, webView
+private:: userView, dragSource, dragSink, dragBoth, dialog, ezScroller, ezSlider, ezListView, ezPopUpMenu
+private:: ezNumber, ezRanger, hLayout, vLayout, gridLayout, stackLayout, pen, font, image, qcView
+private:: notImplemented, stop, id
+
+method:: availableStyles
+
+Returns an array of all available styles on this platform. For use with link::#-style::.
+
+method:: cursorPosition
+
+Gets the current position of the cursor as a link::Classes/Point::.
+
+method:: debugLevel
+
+Gets or sets the verbosity level for debug output from "QtCollider" code. SuperCollider must have
+been built in debug mode for messages to appear. Valid values are -1 (none), 0 (warnings only,
+default), 1 (most messages), and 2 (verbose). Values outside this range are effectively clipped.
+
+method:: focusView
+
+Gets the currently focused view.
+
+method:: palette
+
+Gets or sets the link::Classes/QPalette:: used for GUI display.
+
+method:: selectedText
+
+Gets the selected text in the currently focused view. If there is no such string then return
+empty string.
+
+Internally, first calls code::selectedText:: if that method is available; otherwise, calls
+code::selectedString:: if that method is available. Otherwise, returns empty string.
+
+method:: stringBounds
+
+Returns a link::Classes/Rect:: representing the size of the smallest rectangle that could contain a
+given string rendered with the given font.
+
+code::
+QtGUI.stringBounds("hellooo", Font(Font.defaultSansFace, 100))
+::
+
+argument:: aString
+A link::Classes/String:: to render.
+
+argument:: aFont
+An instance of link::Classes/Font::.
+
+method:: style
+
+Gets or sets the current GUI style. The given style must be a link::Classes/String:: or
+link::Classes/Symbol:: that names one of the styles returned by link::#-availableStyles::.
diff --git a/HelpSource/OldHelpWrapper.html b/HelpSource/OldHelpWrapper.html
@@ -4,6 +4,7 @@
     <title>Old Help</title>
     <link rel='stylesheet' href='./scdoc.css' type='text/css' />
     <link rel='stylesheet' href='./custom.css' type='text/css' />
+    <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="lib/jquery.min.js"></script>
     <script src="scdoc.js" type="text/javascript"></script>

diff --git a/HelpSource/Other/HelpDocsLicensing.html b/HelpSource/Other/HelpDocsLicensing.html
@@ -1,6 +1,7 @@
 <html>
 <head>
 <title>SuperCollider documentation licensing</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
 <style type="text/css">
 body {padding: 50px; font: 12.0px Helvetica;}
 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 19.0px Helvetica}

diff --git a/HelpSource/Other/Licensing.html b/HelpSource/Other/Licensing.html
@@ -1,6 +1,7 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
 <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta http-equiv="Content-Style-Type" content="text/css">
 <title></title>

diff --git a/HelpSource/Overviews/Classes.html b/HelpSource/Overviews/Classes.html
@@ -2,9 +2,10 @@
 <html lang="en">
 <head>
     <title>Classes | SuperCollider Help</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <link rel='stylesheet' href='../scdoc.css' type='text/css' />
     <link rel='stylesheet' href='../custom.css' type='text/css' />
-    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="../lib/jquery.min.js"></script>
     <script>
         var scdoc_title = "Classes";

diff --git a/HelpSource/Overviews/Documents.html b/HelpSource/Overviews/Documents.html
@@ -2,9 +2,10 @@
 <html lang="en">
 <head>
     <title>Documents | SuperCollider Help</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <link rel='stylesheet' href='../scdoc.css' type='text/css' />
     <link rel='stylesheet' href='../custom.css' type='text/css' />
-    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="../lib/jquery.min.js"></script>
     <script>
         var scdoc_title = "Documents";

diff --git a/HelpSource/Overviews/Methods.html b/HelpSource/Overviews/Methods.html
@@ -2,9 +2,10 @@
 <html lang="en">
 <head>
     <title>Methods | SuperCollider Help</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <link rel='stylesheet' href='../scdoc.css' type='text/css' />
     <link rel='stylesheet' href='../custom.css' type='text/css' />
-    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="../lib/jquery.min.js"></script>
     <script>
         var scdoc_title = "Methods";

diff --git a/HelpSource/Search.html b/HelpSource/Search.html
@@ -3,9 +3,10 @@
 
 <head>
     <title>Search | SuperCollider Help</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <link rel='stylesheet' href='./scdoc.css' type='text/css' />
     <link rel='stylesheet' href='./custom.css' type='text/css' />
-    <meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
     <script src="lib/jquery.min.js"></script>
     <script>
         var scdoc_title = "Search";

diff --git a/HelpSource/editor.js b/HelpSource/editor.js
@@ -8,7 +8,7 @@ const init = () => {
             { regex: /^\b\d+r[0-9a-zA-Z]*(\.[0-9A-Z]*)?/, token: 'number radix-float' },
             { regex: /^\b\d+(s+|b+|[sb]\d+)\b/, token: 'number scale-degree' },
             { regex: /^\b((\d+(\.\d+)?([eE][-+]?\d+)?(pi)?)|pi)\b/, token: 'number float' },
-            { regex: /^\b0(x|X)(\d|[a-f]|[A-F])+/, token: 'number hex-int' },
+            { regex: /^\b0x(\d|[a-f]|[A-F])+/, token: 'number hex-int' },
             { regex: /^\b[A-Za-z_]\w*\:/, token: 'symbol symbol-arg' },
             { regex: /^[a-z]\w*/, token: 'text name' },
             { regex: /^\b[A-Z]\w*/, token: 'class' },