tool: LSP support

compiler/ast/reports.nim

@@ -18,7 +18,7 @@
 ## `compilerDebugCompilerReportStatistics`: output stats of counts for various
 ##                                          report kinds
 
-import std/[options]
+import std/[options, hashes]
 
 import
   compiler/ast/[
@@ -312,3 +312,8 @@ func actualType*(r: SemReport): PType = r.typeMismatch[0].actualType
 func formalType*(r: SemReport): PType = r.typeMismatch[0].formalType
 func formalTypeKind*(r: SemReport): set[TTypeKind] = r.typeMismatch[0].formalTypeKind
 func symstr*(r: SemReport | VMReport): string = r.sym.name.s
+func hash*(x: Report): Hash =
+  var h: Hash = 0
+  h = h !& hash(x.location().get(unknownLineInfo))
+  h = h !& x.kind.int
+  result = !$h

compiler/sem/semexprs.nim

@@ -3784,6 +3784,8 @@ proc semExpr(c: PContext, n: PNode, flags: TExprFlags = {}): PNode =
           skProc
       result[namePos] = semRoutineName(c, n[namePos], kind, allowAnon = true)
       result = semProcAux(c, result, lambdaPragmas, flags)
+      if result.kind != nkError:
+        suggestSym(c.graph, result[namePos].info, result[namePos].sym, c.graph.usageSym)
   of nkDerefExpr: result = semDeref(c, n)
   of nkAddr:
     result = n

compiler/sem/semstmts.nim

@@ -374,7 +374,8 @@ proc semIdentDef(c: PContext, n: PNode, kind: TSymKind): PSym =
   result.options = c.config.options
 
   let info = getIdentLineInfo(n)
-  suggestSym(c.graph, info, result, c.graph.usageSym)
+  if kind != skType:
+    suggestSym(c.graph, info, result, c.graph.usageSym)
 
 proc checkNilableOrError(c: PContext; def: PNode): PNode =
   ## checks if a symbol node is nilable, on success returns def, else nkError
@@ -2114,6 +2115,9 @@ proc typeSectionFinalPass(c: PContext, n: PNode) =
         # fix bug #5170, bug #17162, bug #15526: ensure locally scoped types get a unique name:
         if s.typ.kind in {tyEnum, tyRef, tyObject} and not isTopLevel(c):
           incl(s.flags, sfGenSym)
+    when defined(nimsuggest):
+      if c.config.cmd == cmdIdeTools:
+        suggestSym(c.graph, s.info, s, c.graph.usageSym)
 
 proc semTypeSection(c: PContext, n: PNode): PNode =
   ## Processes a type section. This must be done in separate passes, in order
@@ -2523,7 +2527,6 @@ proc semRoutineName(c: PContext, n: PNode, kind: TSymKind; allowAnon = true): PN
     if c.isTopLevel:
       incl(s.flags, sfGlobal)
 
-    suggestSym(c.graph, getIdentLineInfo(n), s, c.graph.usageSym)
     styleCheckDef(c.config, s)
   else:
     # XXX: this should be the resonsibility of the macro sanitizer instead
@@ -3119,6 +3122,8 @@ proc semRoutineDef(c: PContext, n: PNode): PNode =
     of skTemplate:  semTemplateDef(c, result)
     of skMacro:     semMacroDef(c, result)
     else:           unreachable(kind)
+  if result.kind != nkError:
+    suggestSym(c.graph, result[namePos].info, result[namePos].sym, c.graph.usageSym)
 
 proc evalInclude(c: PContext, n: PNode): PNode =
   proc incMod(c: PContext, n, it, includeStmtResult: PNode) {.nimcall.} =

compiler/tools/suggest.nim

@@ -160,6 +160,14 @@ proc symToSuggest(g: ModuleGraph; s: PSym, isLocal: bool, section: IdeCmd, info:
   result.name = s.name.s
   if isGenericRoutineStrict(s):
     result.name.add renderTree(s.ast[genericParamsPos])
+  elif s.kind == skType and s.typ.isMetaType:
+    let len = s.typ.sons.len - 1
+    var genericParams = if len > 0: "[" else: ""
+    for i in 0 ..< len:
+      genericParams.add typeToString(s.typ.sons[i])
+      if i < len - 1: genericParams.add(", ")
+    if len > 0: genericParams.add "]"
+    result.name.add genericParams
   when defined(nimsuggest):
     if section in {ideSug, ideCon}:
       result.globalUsages = s.allUsages.len
@@ -260,10 +268,10 @@ proc suggestField(c: PContext, s: PSym; f: PNode; info: TLineInfo; outputs: var
     outputs.add(symToSuggest(c.graph, s, isLocal=true, ideSug, info,
                               s.getQuality, pm, c.inTypeContext > 0, 0))
 
-template wholeSymTab(cond, section: untyped) {.dirty.} =
+template wholeSymTab(cond, section: untyped) =
   for (item, scopeN, isLocal) in allSyms(c):
-    let it = item
-    var pm: PrefixMatch
+    let it {.inject.} = item
+    var pm {.inject.}: PrefixMatch
     if cond:
       outputs.add(symToSuggest(c.graph, it, isLocal = isLocal, section, info, getQuality(it),
                                 pm, c.inTypeContext > 0, scopeN))
@@ -285,9 +293,9 @@ proc suggestObject(c: PContext, n, f: PNode; info: TLineInfo, outputs: var Sugge
   else: discard
 
 proc nameFits(c: PContext, s: PSym, n: PNode): bool =
-  var op = if n.kind in nkCallKinds: n[0] else: n
+  var op = if n.kind in nkCallKinds and n.len > 0: n[0] else: n
   if op.kind in {nkOpenSymChoice, nkClosedSymChoice}: op = op[0]
-  if op.kind == nkDotExpr: op = op[1]
+  if op.kind == nkDotExpr and op.len > 1: op = op[1]
   var opr: PIdent
   case op.kind
   of nkSym: opr = op.sym.name

nimlsp/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 PMunch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nimlsp/README.rst

@@ -0,0 +1,37 @@
+==========
+Nimskull Language Server Protocol
+==========
+
+This is a `Language Server Protocol
+<https://microsoft.github.io/language-server-protocol/>`_ implementation in
+Nimskull, for Nimskull.
+It is based on nimsuggest, which means that every editor that
+supports LSP will now have the same quality of suggestions that has previously
+only been available in supported editors.
+
+Supported Protocol features
+=======
+
+======  ================================
+Status  LSP Command
+======  ================================
+☑ DONE  textDocument/didChange
+☑ DONE  textDocument/didClose
+☑ DONE  textDocument/didOpen
+☑ DONE  textDocument/didSave
+☐ TODO  textDocument/codeAction
+☑ DONE  textDocument/completion
+☑ DONE  textDocument/definition
+☐ TODO  textDocument/documentHighlight
+☑ DONE  textDocument/documentSymbol
+☐ TODO  textDocument/executeCommand
+☐ TODO  textDocument/format
+☑ DONE  textDocument/hover
+☑ DONE  textDocument/rename
+☑ DONE  textDocument/references
+☑ DONE  textDocument/signatureHelp
+☑ DONE  textDocument/publishDiagnostics
+☐ TODO  workspace/symbol
+☐ TODO  `$/progress<https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workDoneProgress>`
+☐ TODO  `textDocument/codeAction<https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction>`
+======  ================================

nimlsp/config.nims

@@ -0,0 +1,4 @@
+import std/os
+
+const explicitSourcePath {.strdefine.} = getCurrentCompilerExe().parentDir.parentDir
+switch "path", explicitSourcePath