Haddock experiment (WIP)

lib/ghc-mod/ghc-modi-process.coffee

@@ -1,4 +1,5 @@
 {Range, Point, Emitter, CompositeDisposable} = require 'atom'
+Haddock = require '../haddock'
 Util = require '../util'
 {extname} = require('path')
 Queue = require 'promise-queue'
@@ -187,6 +188,45 @@ class GhcModiProcess
   onQueueIdle: (callback) =>
     @emitter.on 'queue-idle', callback
 
+  docsCmd: (symbol_to_lookup, runArgs) =>
+
+    unless runArgs.buffer? or runArgs.dir?
+      throw new Error ("Neither dir nor buffer is set in docsCmd invocation")
+    runArgs.dir ?= @getRootDir(runArgs.buffer) if runArgs.buffer?
+
+    rd = runArgs.dir or Util.getRootDir(runArgs.options.cwd)
+    package_name = rd.getBaseName()
+    console.log "Package name: " + package_name
+
+    # TODO Use the "stack path --local-doc-root" command to obtain this string
+    filepath = '../.stack-work/install/x86_64-linux/lts-5.9/7.10.3/doc/' + package_name + '-0.1.0.0/' + package_name + '.txt'
+
+    console.log "Haddock file path: " + filepath
+
+    my_promise = new Promise (resolve, reject) ->
+      file = rd.getFile(filepath)
+      file.exists()
+      .then (ex) ->
+        if ex
+          file.read().then (contents) ->
+            try
+              docs_by_module = Haddock.parseHoogleTextDoc(contents)
+              found_doc = Haddock.findDocsForSymbol(docs_by_module, symbol_to_lookup)
+              # TODO Get current module name!
+              resolve found_doc
+            catch err
+              atom.notifications.addError 'Failed to parse haddock-hoogle text file',
+                detail: err
+                dismissable: true
+              reject err
+        else
+          reject new Error('haddock-hoogle text file does not exist')
+    .catch (error) ->
+      Util.warn error
+      return {}
+
+    return my_promise
+
   queueCmd: (queueName, runArgs, backend) =>
     unless runArgs.buffer? or runArgs.dir?
       throw new Error ("Neither dir nor buffer is set in queueCmd invocation")
@@ -380,6 +420,21 @@ class GhcModiProcess
       else
         return {range, info}
 
+
+  getDocInBuffer: (editor, crange) =>
+    buffer = editor.getBuffer()
+    return Promise.resolve null unless buffer.getUri()?
+    {symbol, range} = Util.getSymbolInRange(editor, crange)
+
+    @docsCmd symbol,
+      buffer: buffer
+    .then (found_doc) ->
+      if found_doc == null
+        throw new Error "No docs"
+      else
+        console.log "Symbol documentation: " + found_doc
+        return {range, found_doc}
+
   findSymbolProvidersInBuffer: (editor, crange) =>
     buffer = editor.getBuffer()
     {symbol} = Util.getSymbolInRange(editor, crange)

lib/haddock.js

@@ -0,0 +1,75 @@
+COMMENT_PREFIX = "-- ";
+DOCSTRING_PREFIX = COMMENT_PREFIX + "| ";
+
+
+function setdefault(dict, key, value) {
+    if (!(key in dict))
+        dict[key] = value;
+    return dict[key];
+}
+
+
+function findDocsForSymbol(docs_by_module, symbol) {
+
+  var module_qualification_chunks = symbol.split(".");
+  var last_chunk = module_qualification_chunks[module_qualification_chunks.length - 1]
+
+  for (var mkey in docs_by_module) {
+    var module_dict = docs_by_module[mkey];
+
+    for (var skey in module_dict) {
+      if (skey == last_chunk) {
+        return module_dict[skey];
+      }
+    }
+  }
+  return "-- <no documentation>";
+}
+
+function parseHoogleTextDoc(file_contents) {
+    lines = file_contents.trim().split('\n');
+
+    var current_module = null;
+    var docstring_lines = [];
+
+    // Nested dict; outer key is module name.
+    // inner key is function/variable name.
+    var entity_docs_map = {};
+
+    for (var i=0; i<lines.length; i++) {
+      var line = lines[i];
+
+      if (line.startsWith(COMMENT_PREFIX)) {
+        docstring_lines.push(line);
+      } else {
+
+        var tokens = line.split(/\s+/);
+
+        if (tokens.length > 0) {
+          if (tokens[0] == "module") {
+            current_module = tokens[1];
+          } else {
+
+            if (current_module != null) {
+              if (tokens.length > 1) {
+                if (tokens[1] == "::") {
+                  var entity_name = tokens[0];
+                  if (docstring_lines.length > 0) {
+                    var sub_dict = setdefault(entity_docs_map, current_module, {});
+                    sub_dict[entity_name] = docstring_lines.join("\n");
+                  }
+                }
+              }
+            }
+          }
+        }
+
+        docstring_lines = [];
+      }
+    }
+
+    return entity_docs_map;
+}
+
+exports.parseHoogleTextDoc = parseHoogleTextDoc;
+exports.findDocsForSymbol = findDocsForSymbol;

lib/upi-consumer.coffee

@@ -179,6 +179,9 @@ class UPIConsumer
     @upi.withEventRange {editor, detail}, ({crange}) =>
       @process.getInfoInBuffer(editor, crange)
       .then ({range, info}) =>
+
+        console.log "KARL - GHC-MOD: range: " + range
+
         res = /.*-- Defined at (.+):(\d+):(\d+)/.exec info
         return unless res?
         [_, fn, line, col] = res
@@ -233,6 +236,17 @@ class UPIConsumer
           if atom.config.get('haskell-ghc-mod.highlightTooltips')
             'source.haskell'
 
+  docTooltip: (e, p) =>
+    @process.getDocInBuffer(e, p)
+    .then ({range, dox}) ->
+      range: range
+      text:
+        text: dox
+        highlighter:
+          if atom.config.get('haskell-ghc-mod.highlightTooltips')
+            'source.haskell'
+
+
   infoTypeTooltip: (e, p) =>
     args = arguments
     @infoTooltip(e, p)
@@ -251,8 +265,10 @@ class UPIConsumer
       @typeTooltip(e, p).catch -> return null
     infoP =
       @infoTooltip(e, p).catch -> return null
-    Promise.all [typeP, infoP]
-    .then ([type, info]) ->
+    docP =
+      @docTooltip(e, p).catch -> return null
+    Promise.all [typeP, infoP, docP]
+    .then ([type, info, doc]) ->
       range:
         if type? and info?
           type.range.union(info.range)
@@ -263,7 +279,7 @@ class UPIConsumer
         else
           throw new Error('Got neither type nor info')
       text:
-        text: "#{if type?.text?.text then ':: '+type.text.text+'\n' else ''}#{info?.text?.text ? ''}"
+        text: (Object.keys(doc).join(", ") + "\nBLERG 0: " + doc[Object.keys(doc)[0]] + "\nBLERG 1: " + doc[Object.keys(doc)[1]] + "\nBLERG 1 keys: " + Object.keys(doc[Object.keys(doc)[1]]) + "\nBLERG 1[0]: " + doc[Object.keys(doc)[1]]["text"] + "--(Karl was here)\n") + "#{if type?.text?.text then ':: '+type.text.text+'\n' else ''}#{info?.text?.text ? ''}"
         highlighter:
           if atom.config.get('haskell-ghc-mod.highlightTooltips')
             'source.haskell'