Merge pull request #2686 from ldoblies/master

Added quickfix framework

Author: lennartcl

plugins-client/ext.jslanguage/JSResolver.js

@@ -0,0 +1,84 @@
+define(function(require, exports, module) {
+  "use strict";
+
+  var markerResolution = require('ext/language/MarkerResolution').MarkerResolution;
+  var Range = require("ace/range").Range;
+
+  var JSResolver = function(value, ast){
+    this.addResolutions = function(markers){
+      var _self = this;
+      markers.forEach(function(curMarker) {
+        curMarker.resolutions = _self.getResolutions(curMarker);
+      });
+    };
+    
+    this.getResolutions = function(marker){
+      var type = this.getType(marker);
+      if (type){
+        if (typeof this[type] === 'function'){
+          return this[type](marker);
+        }
+      }
+      return [];
+    }; 
+
+    this.getType = function(marker){
+        var msg = marker.message;
+        if (msg.indexOf("Missing semicolon") !== -1){
+            return "missingSemicolon";
+        } else if (msg.indexOf("Unnecessary semicolon") !== -1){
+            return "unnecessarySemicolon";
+        }
+    }; 
+    
+    this.missingSemicolon = function(marker){
+        console.log(marker.pos);
+        var label = "Add semicolon";
+        var image = "";
+        var row = marker.pos.sl;
+        var column = marker.pos.sc;
+        
+        var lines = value.split("\n");
+        var before = lines[row].substring(0, column);
+        var after = lines[row].substring(column);
+        var preview = "<b>Add semicolon</b><p>" + before + "<b>; </b>" + after + "</p>";
+        
+        var insert = ";";
+        if (after.length){
+            insert += " ";
+        }
+
+        var delta = {
+            action: "insertText",
+            range: new Range(row, column, row, column + insert.length),
+            text: insert
+        };
+        
+        return [markerResolution(label, image, preview, [delta])];
+    };
+    
+    this.unnecessarySemicolon = function(marker){
+        console.log(marker.pos);
+        var label = "Remove semicolon";
+        var image = "";
+        var row = marker.pos.sl;
+        var column = marker.pos.sc;
+        
+        var lines = value.split("\n");
+        var before = lines[row].substring(0, column);
+        var after = lines[row].substring(column + 1);
+        var preview = "<b>Remove semicolon</b><p>" + before + "<del>;</del>" + after + "</p>";
+
+        var delta = {
+            action: "removeText",
+            range: new Range(row, column, row, column + 1)
+        };
+        
+        return [markerResolution(label, image, preview, [delta])];
+    };
+
+  };
+
+  exports.JSResolver = JSResolver;
+
+});

plugins-client/ext.jslanguage/jshint.js

@@ -74,7 +74,7 @@ handler.analyzeSync = function(value, ast) {
             if(disabledJSHintWarnings[i].test(warning.reason))
                 return;
         markers.push({
-            pos: {
+            pos: { // TODO quickfix framework needs el/ec in order to be able to select the issue in the editor
                 sl: warning.line-1,
                 sc: warning.character-1
             },
@@ -83,9 +83,11 @@ handler.analyzeSync = function(value, ast) {
             message: warning.reason
         });
     });
+
     return markers;
 };
 
+
 /**
  * Gets an object like { foo: true } for JSHint global comments
  * like / * global foo: true * /

plugins-client/ext.jslanguage/scope_analyzer.js

@@ -19,6 +19,8 @@ var completeUtil = require("ext/codecomplete/complete_util");
 var handler = module.exports = Object.create(baseLanguageHandler);
 var outline = require("ext/jslanguage/outline");
 var jshint = require("ext/jslanguage/jshint");
+var JSResolver = require('ext/jslanguage/JSResolver').JSResolver;
+
 require("treehugger/traverse"); // add traversal functions to trees
 
 var CALLBACK_METHODS = ["forEach", "map", "reduce", "filter", "every", "some"];
@@ -260,6 +262,21 @@ handler.handlesLanguage = function(language) {
     return language === 'javascript';
 };
 
+handler.getResolutions = function(value, ast, markers, callback){
+    var resolver = new JSResolver(value, ast);
+    resolver.addResolutions(markers);
+    callback(markers);
+};
+
+handler.hasResolution = function(value, ast, marker) {
+    if (marker.resolutions && marker.resolutions.length){
+        return true;
+    }
+    var resolver = new JSResolver(value, ast);
+    return resolver.getType(marker);
+};
+
+
 var scopeId = 0;
 
 var Variable = module.exports.Variable = function Variable(declaration) {

plugins-client/ext.language/MarkerResolution.js

@@ -0,0 +1,25 @@
+
+define(function(require, exports, module) {
+"use strict";
+
+/**
+* data structure for resolutions, containing 
+* a label (short description, to be displayed in the list of resolutions), 
+* an image (to be displayed in the list of resolutions), 
+* a preview,
+* an array of deltas (containing the changes to be applied),
+* the position where the cursor should be after applying
+*/
+var MarkerResolution = function(label, image, preview, deltas, cursorTarget){
+    return {
+        label: label,
+        image: image,
+        preview: preview,
+        deltas: deltas,
+        cursorTarget: cursorTarget
+    };
+}; 
+
+exports.MarkerResolution = MarkerResolution;
+
+});

plugins-client/ext.language/base_handler.js

@@ -229,6 +229,22 @@ module.exports = {
      */
     jumpToDefinition: function(doc, fullAst, pos, currentNode, callback) {
         callback();
+    },
+    
+    /**
+     * Invoked after markers were generated in analyze()
+     * @return marker array with attached resolutions
+     */
+    getResolutions: function(doc, fullAst, markers, callback) {
+        callback();
+    },
+    
+    /**
+     * @return true iff the resolver for this marker could generate
+     * at least one resolution for it
+     */
+    hasResolution: function(doc, fullAst, marker, callback) {
+        callback();
     }
 };
 

plugins-client/ext.language/language.js

@@ -17,6 +17,7 @@ var UIWorkerClient = require("ace/worker/worker_client").UIWorkerClient;
 var useUIWorker = window.location && /[?&]noworker=1/.test(window.location.search);
 
 var complete = require("ext/language/complete");
+var quickfix = require("ext/language/quickfix");
 var marker = require("ext/language/marker");
 var refactor = require("ext/language/refactor");
 var outline = require("ext/language/outline");
@@ -92,6 +93,7 @@ module.exports = ext.register("ext/language/language", {
             outline.hook(_self, worker);
             keyhandler.hook(_self, worker);
             jumptodef.hook(_self, worker);
+            quickfix.hook(_self);
 
             ide.dispatchEvent("language.worker", {worker: worker});
             ide.addEventListener("$event.language.worker", function(callback){

plugins-client/ext.language/language.xml

@@ -124,4 +124,27 @@
         </a:hbox>
     </a:bar>
 
+    <a:bar id="barQuickfixCont" skinset="language_skin" skin="codecomplete" width="600" visible="false">
+        <a:hbox id="txtQuickfixHolder" class="code_complete_text_holder" anchors="0 0 0 0" edge="5" width="290">
+            <a:text id="txtQuickfix" skin="codecomplete_text" flex="1" />
+            <a:scrollbar
+              for      = "txtQuickfix"
+              id       = "sbQuickfix"
+              margin   = "2"
+              skin     = "sbios"
+              width    = "7"
+              overflow2 = "auto"/>
+        </a:hbox>
+        <a:hbox class="code_complete_text_holder" anchors="0 0 0 330" edge="5" minheight="100">
+            <a:text id="txtQuickfixDoc" skin="codecompletedoc_text" flex="1" />
+            <a:scrollbar
+              for      = "txtQuickfixDoc"
+              id       = "sbQuickfixDoc"
+              margin   = "2"
+              skin     = "sbios"
+              width    = "7"
+              overflow2 = "auto"/>
+        </a:hbox>
+    </a:bar>
+    
 </a:application>

plugins-client/ext.language/marker.js

@@ -83,7 +83,9 @@ module.exports = {
             var gutterAnno = {
                 guttertext: anno.message,
                 type: anno.level || "warning",
-                text: anno.message
+                text: anno.message,
+                pos: anno.pos,
+                resolutions: anno.resolutions
                 // row will be filled in updateFloat()
             };