hdocs.py

import sublime
import json
import time

if int(sublime.version()) < 3000:
    from sublime_haskell_common import *
else:
    from SublimeHaskell.sublime_haskell_common import *

def call_hdocs_and_wait(args, filename = None, cabal = None):
    if not hdocs_enabled():
        return None

    ghc_opts_args = get_ghc_opts_args(filename, cabal = cabal)
    source_dir = get_source_dir(filename)
    
    try:
        command = ['hdocs'] + args + ghc_opts_args
        log(command)

        exit_code, out, err = call_and_wait(command, cwd = source_dir)

        if exit_code != 0:
            raise Exception("hdocs exited with status %d and stderr: %s" % (exit_code, err))

        return crlf2lf(out)

    except OSError as e:
        if e.errno == errno.ENOENT:
            sublime.set_timeout(lambda: output_error(sublime.active_window(), "SublimeHaskell: hdocs was not found!\n'enable_hdocs' is set to False"), 0)
            set_setting_async('enable_hdocs', False)

        return None

    except Exception as e:
        log('hdocs fails with {0}'.format(e))
        return None

def module_docs(module_name, cabal = None):
    if not hdocs_enabled():
        return None

    try:
        contents = call_hdocs_and_wait(['docs', module_name], cabal = cabal)
        if contents:
            return json.loads(contents)
        else:
            return None
    except Exception as e:
        log('hdocs fails with {0}'.format(e))
        return None

def symbol_docs(module_name, symbol_name, cabal = None):
    if not hdocs_enabled():
        return None

    return call_hdocs_and_wait(['docs', module_name, symbol_name], cabal = cabal)

def load_module_docs(module):
    if not hdocs_enabled():
        return False

    if module.location:
        return False
    if 'hdocs' in module.tags:
        return False

    docs = module_docs(module.name, module.cabal)
    if docs:
        module.tags['hdocs'] = time.clock()
        for decl in module.declarations.values():
            if decl.name in docs:
                decl.docs = docs[decl.name]
        return True

    return False

def hdocs_enabled():
    return get_setting_async('enable_hdocs') == True