Merge pull request #338 from nickspoons/support-wsl-cygwin

Translate Windows<->Unix paths in WSL and Cygwin

Author: thinca

autoload/OmniSharp.vim

@@ -29,7 +29,7 @@ function! OmniSharp#Complete(findstart, base) abort
 
     return start
   else
-    let omnisharp_last_completion_result =  pyeval('Completion().get_completions("s:column", "a:base")')
+    let omnisharp_last_completion_result =  pyeval('getCompletions("s:column", "a:base")')
     let s:omnisharp_last_completion_dictionary = {}
     for completion in omnisharp_last_completion_result
         let s:omnisharp_last_completion_dictionary[get(completion, 'word')] = completion

autoload/OmniSharp/util.vim

@@ -18,6 +18,14 @@ function! s:resolve_local_config(solution_path) abort
   return ''
 endfunction
 
+function! s:is_cygwin() abort
+  return has('win32unix')
+endfunction
+
+function! s:is_wsl() abort
+  return strlen(system('grep Microsoft /proc/version')) > 0
+endfunction
+
 function! OmniSharp#util#path_join(parts) abort
   if type(a:parts) == type('')
     let parts = [a:parts]
@@ -34,6 +42,16 @@ function! OmniSharp#util#get_start_cmd(solution_path) abort
   if fnamemodify(solution_path, ':t') ==? s:roslyn_server_files
     let solution_path = fnamemodify(solution_path, ':h')
   endif
+
+  if g:OmniSharp_translate_cygwin_wsl == 1 && (s:is_cygwin() || s:is_wsl())
+    " Future releases of WSL will have a wslpath tool, similar to cygpath - when
+    " this becomes standard then this block can be replaced with a call to
+    " wslpath/cygpath
+    let prefix = s:is_cygwin() ? '^/cygdrive/' : '^/mnt/'
+    let solution_path = substitute(solution_path, prefix.'\([a-zA-Z]\)/', '\u\1:\\', '')
+    let solution_path = substitute(solution_path, '/', '\\', 'g')
+  endif
+
   let g:OmniSharp_running_slns += [solution_path]
   let port = exists('b:OmniSharp_port') ? b:OmniSharp_port : g:OmniSharp_port
 

doc/omnisharp-vim.txt

@@ -44,7 +44,9 @@ OPTIONS                                                     *omnisharp-options*
 
                                                     *'g:syntastic_cs_checkers'*
 Use this option to enable syntastic integration >
-    let g:syntastic_cs_checkers=['syntax', 'semantic', 'issues']
+    let g:syntastic_cs_checkers=['syntax', 'semantic', 'issues'] " v1 server
+    OR
+    let g:syntastic_cs_checkers=['code_checker']                 " roslyn
 <
 
                                                     *'g:OmniSharp_selector_ui'*
@@ -83,6 +85,12 @@ Default: 'v1' >
     let g:OmniSharp_server_type='roslyn'
 <
 
+                                                    *'g:OmniSharp_server_path'*
+Use this option to give the full path to the roslyn or v1 omnisharp server
+executable. >
+    let g:OmniSharp_server_path='/home/username/omnisharp/omnisharp.http-linux-x64/omnisharp/OmniSharp.exe'
+<
+
                                                            *'g:OmniSharp_host'*
 Use this option to specify the host address of the OmniSharp server.
 Default: 'http://localhost:2000' >
@@ -101,7 +109,7 @@ server. Default: 1 >
     let g:OmniSharp_timeout=1
 <
 
-                                         *'g:omnicomplete_fetch_full_documentation'*
+                                    *'g:omnicomplete_fetch_full_documentation'*
 Use this option to specify whether OmniSharp will fetch full documentation on
 completion suggestions. By default, only type/method signatures are fetched for
 performance reasons. Full documentation can still be fetched when needed using
@@ -115,6 +123,15 @@ Default: 0 >
     let g:OmniSharp_want_snippet=0
 <
 
+                                           *'g:OmniSharp_translate_cygwin_wsl'*
+Use this option when vim is running in a Cygwin or Windows Subsystem for Linux
+environment on Windows, but the omnisharp server is a Windows binary. When set
+to 1, omnisharp-vim will translate the cygwin/WSL unix paths into Windows paths
+and back.
+Default: 0 >
+    let g:OmniSharp_translate_cygwin_wsl=1
+<
+
 ===============================================================================
 COMMANDS                                                   *omnisharp-commands*
 

plugin/OmniSharp.vim

@@ -9,10 +9,12 @@ if !has('python')
   finish
 endif
 
+" Set default for translating cygwin/WSL unix paths to Windows paths
+let g:OmniSharp_translate_cygwin_wsl = get(g:, 'OmniSharp_translate_cygwin_wsl', 0)
+
 "Load python/OmniSharp.py
 let s:py_path = OmniSharp#util#path_join('python')
 exec "python sys.path.append(r'" . s:py_path . "')"
-exec 'pyfile ' . fnameescape(OmniSharp#util#path_join(['python', 'Completion.py']))
 exec 'pyfile ' . fnameescape(OmniSharp#util#path_join(['python', 'OmniSharp.py']))
 
 let g:OmniSharp_port = get(g:, 'OmniSharp_port', 2000)

python/Completion.py

@@ -1,5 +1,4 @@
-import vim, urllib2, urllib, urlparse, logging, json, os, os.path, cgi, types, threading
-import asyncrequest
+import json, logging, os.path, platform, re, urllib2, urlparse, vim
 
 logger = logging.getLogger('omnisharp')
 logger.setLevel(logging.WARNING)
@@ -13,13 +12,34 @@
 formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
 hdlr.setFormatter(formatter)
 
+translate_unix_win = bool(int(vim.eval('g:OmniSharp_translate_cygwin_wsl')))
+is_cygwin = 'cygwin' in platform.system().lower()
+is_wsl = 'linux' in platform.system().lower() and 'microsoft' in platform.release().lower()
+
+# When working in Windows Subsystem for Linux (WSL) or Cygwin, vim uses
+# unix-style paths but OmniSharp (with a Windows binary) uses Windows
+# paths. This means that filenames returned FROM OmniSharp must be
+# translated from e.g. "C:\path\to\file" to "/mnt/c/path/to/file", and
+# filenames sent TO OmniSharp must be translated in the other direction.
+def formatPathForServer(filepath):
+    if translate_unix_win and (is_cygwin or is_wsl):
+        pattern = r'^/cygdrive/([a-zA-Z])/' if is_cygwin else r'^/mnt/([a-zA-Z])/'
+        return re.sub(pattern, r'\1:\\', filepath).replace('/', '\\')
+    return filepath
+def formatPathForClient(filepath):
+    if translate_unix_win and (is_cygwin or is_wsl):
+        def path_replace(matchobj):
+            prefix = '/cygdrive/{0}/' if is_cygwin else '/mnt/{0}/'
+            return prefix.format(matchobj.group(1).lower())
+        return re.sub(r'^([a-zA-Z]):\\', path_replace, filepath).replace('\\', '/')
+    return filepath
 
 def getResponse(endPoint, additional_parameters=None, timeout=None):
     parameters = {}
     parameters['line'] = vim.eval('line(".")')
     parameters['column'] = vim.eval('col(".")')
     parameters['buffer'] = '\r\n'.join(vim.eval("getline(1,'$')")[:])
-    parameters['filename'] = vim.current.buffer.name
+    parameters['filename'] = formatPathForServer(vim.current.buffer.name)
     if additional_parameters != None:
         parameters.update(additional_parameters)
 
@@ -67,14 +87,47 @@ def findImplementations():
     js = getResponse('/findimplementations', parameters)
     return get_quickfix_list(js, 'QuickFixes')
 
+def getCompletions(column, partialWord):
+    parameters = {}
+    parameters['column'] = vim.eval(column)
+    parameters['wordToComplete'] = vim.eval(partialWord)
+
+    parameters['WantDocumentationForEveryCompletionResult'] = \
+        bool(int(vim.eval('g:omnicomplete_fetch_full_documentation')))
+
+    want_snippet = \
+        bool(int(vim.eval('g:OmniSharp_want_snippet')))
+
+    parameters['WantSnippet'] = want_snippet
+    parameters['WantMethodHeader'] = want_snippet
+    parameters['WantReturnType'] = want_snippet
+
+    parameters['buffer'] = '\r\n'.join(vim.eval('s:textBuffer')[:])
+
+    response = json.loads(getResponse('/autocomplete', parameters))
+
+    vim_completions = []
+    if response != None:
+        for completion in response:
+            vim_completions.append({
+                'snip': completion['Snippet'] or '',
+                'word': completion['MethodHeader'] or completion['CompletionText'],
+                'menu': completion['ReturnType'] or completion['DisplayText'],
+                'info': (completion['Description'] or '').replace('\r\n', '\n'),
+                'icase': 1,
+                'dup': 1
+            })
+    return vim_completions
+
 def gotoDefinition():
     js = getResponse('/gotodefinition');
-    if(js != ''):
+    if js != '':
         definition = json.loads(js)
         if(definition['FileName'] != None):
-            openFile(definition['FileName'].replace("'","''"), definition['Line'], definition['Column'])
+            filename = formatPathForClient(definition['FileName'].replace("'","''"))
+            openFile(filename, definition['Line'], definition['Column'])
         else:
-            print "Not found"
+            print("Not found")
 
 def openFile(filename, line, column):
     vim.command("call OmniSharp#JumpToLocation('%(filename)s', %(line)s, %(column)s)" % locals())
@@ -159,9 +212,9 @@ def build():
 
     success = js["Success"]
     if success:
-        print "Build succeeded"
+        print("Build succeeded")
     else:
-        print "Build failed"
+        print("Build failed")
 
     return quickfixes_from_js(js, 'QuickFixes')
 
@@ -194,7 +247,7 @@ def addReference():
     js = getResponse("/addreference", parameters)
     if js != '':
         message = json.loads(js)['Message']
-        print message
+        print(message)
 
 def findSyntaxErrors():
     js = getResponse('/syntaxerrors')
@@ -235,6 +288,8 @@ def quickfixes_from_response(response):
         filename = quickfix['FileName']
         if filename == None:
             filename = vim.current.buffer.name
+        else:
+            filename = formatPathForClient(filename)
 
         item = {
             'filename': filename,