Merge pull request #47 from woshilaiceshide/master

add 2 features: "ctrl+u" and "asynchronous completion"

Author: chrisdone

.gitignore

@@ -18,3 +18,4 @@
 ehthumbs.db
 Icon?
 Thumbs.db
+/.project

README.md

@@ -80,6 +80,7 @@ Here are options which can be passed to `console`:
 | commandValidate       | function | When user hits return, validate whether to trigger commandHandle and re-prompt.
 | commandHandle         | function | Handle the command line, return a string, boolean, or list of `{msg:"foo",className:"my-css-class"}`. `commandHandle(line,report)` is called. Report function is for you to report a result of the command asynchronously.
 | completeHandle        | function | Handle the command completion when the tab key is pressed. It returns a list of string completion suffixes.
+| completeIssuer        | function | Handle the command completion when the tab key is pressed. It differs from `'completeHandle'`. `'completeIssuer'` will just trigger the calculation for completion, and the result is returned asynchronously, after which the controller's `'showCompletion(promptText, completions)'` can be invoked with the result. `'completeHandle'` will retrieve the result synchronously, and show the result. If `'completeHandle'` exists, `'completeIssuer'` is ignored. A typical usage of `'completeIssuer'` is that the completion is retrieved from the server using ajax or WebSocket asynchronously. 
 | animateScroll         | bool     | Whether to animate the scroll to top. Currently disabled.
 | charInsertTrigger     | function | Predicate for whether to allow character insertion. `charInsertTrigger(char,line)` is called.
 | cancelHandle          | function | Handle a user-signaled interrupt.

jquery.console.js

@@ -84,7 +84,9 @@
       // C-f
       70: moveForward,
       // C-k
-      75: deleteUntilEnd
+      75: deleteUntilEnd,
+      // C-u
+      85 : clearCurrentPrompt
     };
     if(config.ctrlCodes) {
       $.extend(ctrlCodes, config.ctrlCodes);
@@ -161,6 +163,7 @@
       extern.typer = typer;
       extern.scrollToBottom = scrollToBottom;
       extern.report = report;
+      extern.showCompletion = showCompletion;
     })();
 
     ////////////////////////////////////////////////////////////////////////
@@ -420,6 +423,10 @@
 	updatePromptDisplay();
       }
     };
+    
+    function clearCurrentPrompt() {
+    	extern.promptText("");
+    };
 
     function deleteNextWord() {
       // A word is defined within this context as a series of alphanumeric
@@ -667,6 +674,14 @@
     };
 
     function doComplete() {
+    	if(typeof config.completeHandle == 'function') {
+    		doCompleteDirectly();
+    	} else {
+    		issueComplete();
+    	}
+    };
+    
+    function doCompleteDirectly() {
       if(typeof config.completeHandle == 'function') {
 	var completions = config.completeHandle(promptText);
 	var len = completions.length;
@@ -699,6 +714,44 @@
 	}
       }
     };
+    
+	function issueComplete() {
+		if (typeof config.completeIssuer == 'function') {
+			config.completeIssuer(promptText);
+		}
+	};
+	
+	function showCompletion(promptText, completions) {
+
+		var len = completions.length;
+		if (len === 1) {
+			extern.promptText(promptText + completions[0]);
+		} else if (len > 1 && config.cols) {
+			var prompt = promptText;
+			// Compute the number of rows that will fit in the width
+			var max = 0;
+			for (var i = 0; i < len; i++) {
+				max = Math.max(max, completions[i].length);
+			}
+			max += 2;
+			var n = Math.floor(config.cols / max);
+			var buffer = "";
+			var col = 0;
+			for (i = 0; i < len; i++) {
+				var completion = completions[i];
+				buffer += completions[i];
+				for (var j = completion.length; j < max; j++) {
+					buffer += " ";
+				}
+				if (++col >= n) {
+					buffer += "\n";
+					col = 0;
+				}
+			}
+			commandResult(buffer, "jquery-console-message-value");
+			extern.promptText(prompt);
+		}
+	};
 
     function doNothing() {};