Ticket #3646: 3646-paren-matching-all.patch

3646/sage/server/notebook/js.py

@@ -1113 +1113 @@
-
-/////////////////////////////////////////////////////////////////// 
-// 
+// Paren Matching
+// 
+///////////////////////////////////////////////////////////////////
+
+function paren_jump(cell,i,c,eat) {
+    /*
+    INPUT:
+        cell: a textarea object
+        i:    the index of where to insert/replace a paren
+        c:    the character to insert (may be empty)
+        eat:  whether or not to eat the character at i
+
+    OUTPUT:
+        Replaces / inserts the desired paren, and moves the
+        cursor to immediately after the paren.
+    */
+    var j = i;
+    if(eat)
+        j++;
+    cell.value = cell.value.substring(0,i) + c + cell.value.substring(j);
+    set_cursor_position(cell, i+c.length);
+}
+
+function paren_match(cell) {
+    /*
+    Fix parentheses / braces / brackets.  If mis-matched parentheses
+    are found, fix them.  If an unmatched paren is found, insert it 
+    at the cursor.  This is implemented via a character-by-character
+    lexer, so quotes and comments are handled appropriately.  Perhaps
+    in the future this lexer will be generalized so it can be used
+    for other stuff.
+
+    EXAMPLES:  (the pipe character indicates cursor position)
+        IN:
+            this = some(sample.code(
+                        "foo))",
+            #           bar)),
+                        baz|
+        OUT:
+            this = some.code(
+                        "foo)",
+            #           bar),
+                        baz)|
+
+        IN:
+            foo = bar(baz(],a,b,c)|
+        OUT:
+            foo = bar(baz()|,a,b,c)
+
+        IN:
+            foo = bar()|
+        OUT:
+            foo = bar()|
+
+        IN:
+            foo = bar]bar()|
+        OUT:
+            foo = bar|bar()
+
+    INPUT:
+        a cell object (textarea)
+
+    OUTPUT:
+        the text in the cell is possibly changed, and the cursor may move.
+    */
+    var quote = '';
+    var comment = false;
+    var escape = false;
+    var txt = cell.value.substring(0,get_cursor_position(cell))
+    var n = txt.length;
+    var pstack = [];
+    var squo = "'", dquo = '"', hash = "#", cr   = '\n', esc  = '\\', empty = '',
+        lpar = '(', rpar = ')', lbrk = '[', rbrk = ']', lbrc = '{', rbrc = '}';
+    var deparen = Array();
+    deparen[lpar] = rpar;
+    deparen[lbrc] = rbrc;
+    deparen[lbrk] = rbrk;
+
+    for(i=0;i<n;i++) {
+        c = txt[i];
+        if(quote != empty) {
+            if(escape)
+                escape = false;
+            else if(c == quote)
+                quote=empty;
+            else if(c == esc)
+                escape=true;
+        } else if(comment) {
+            if(c == cr)
+                comment = false;
+        } else switch(c) {
+          case lpar:
+          case lbrc:
+          case lbrk:
+            pstack.push(c);
+            break;
+          case rpar:
+          case rbrc:
+          case rbrk:
+            if(pstack.length < 0) {
+                paren_jump(cell,i,'',true);
+                return;
+            }
+            p = pstack.pop();
+            if(deparen[p] != c) {
+                paren_jump(cell,i,deparen[p],true);
+                return;
+            }
+            break;
+          case squo:
+            quote = squo;
+            break;
+          case dquo:
+            quote = dquo;
+            break;
+          case hash:
+            comment=true
+            break;
+        }
+    }
+    p = pstack.pop();
+    i = txt.length;
+    if(quote == empty && !comment && p != undefined)
+        paren_jump(cell,i,deparen[p],false);
+}
+
+
+
+/////////////////////////////////////////////////////////////////// 
+// 
-// WORKSHEET functions -- for switching between and managing worksheets 
-// 
-///////////////////////////////////////////////////////////////////
@@ -2053 +2183 @@
-       history_window();
-    } else if (key_request_log(e)) {
-       text_log_window(worksheet_filename);
+    } else if (key_fix_paren(e)) {
+       paren_match(cell_input);
-    }
-    
-    // An actual non-controlling character was sent, which means this cell has changed.

3646/sage/server/notebook/config.py

@@ -41 +41 @@
-js.keyhandler.add('uncomment',              key = "KEY_COMMA", ctrl=True)
-js.keyhandler.add('comment',                key = "KEY_3",     ctrl=True)
-js.keyhandler.add('uncomment',              key = "KEY_4",     ctrl=True)
+js.keyhandler.add('fix_paren',              key = "KEY_0",     ctrl=True)
+js.keyhandler.add('fix_paren',              key = "KEY_RBRACK",     ctrl=True)
-
-js.keyhandler.add('control',                key = "KEY_CTRL")
-js.keyhandler.add('backspace',              key = "KEY_BKSPC")

3646/sage/server/notebook/tutorial.py

@@ -384 +384 @@
-#                ('Emacs Keybindings', 'If you are using GNU/Linux, you can change (or create) a <tt>.gtkrc-2.0</tt> file.  Add the line <tt>gtk-key-theme-name = "Emacs"</tt> to it.  See <a target="_blank" href="http://kb.mozillazine.org/Emacs_Keybindings_(Firefox)">this page</a> [mozillazine.org] for more details.'),
- #               ('More Help', 'Type "help(sage.server.notebook.notebook)" for a detailed discussion of the architecture of the SAGE notebook and a tutorial (or see the SAGE reference manual).'),
-#                ('Javascript Debugger', 'Type ?debug at the end of a worksheet url to enable the javascript debugger.  A pair of textareas will appear at the top of the worksheet -- the upper of which is for output, the lower is a direct interface to the page\'s javascript environment.  Type any eval()-able javascript into the input box and press shift+enter to execute it.  Type debug_append(str) to print to, and debug_clear() to clear the debug output window.'),
+            ('Paren matching', 'To fix unmatched or mis-matched parentheses, braces or brackets, press ctrl-0 or ctrl-].  Parentheses / brackets / braces to the left of / above the cursor will be matched, minding strings and comments.  Note, only python comments are recogized, so this won\'t work for c-style multiline comments, etc.')
-                ]
-
-notebook_help.sort()