Restore hovering to globals

src/fennel-ls/docs.fnl

@@ -1 +1,21 @@
-{:lua54 (require :fennel-ls.docs.lua54)}
+(local {:metadata METADATA
+        :scopes {:global {:specials SPECIALS
+                          :macros MACROS}}}
+  (require :fennel.compiler))
+
+(local specials-metadata
+  (collect [name value (pairs SPECIALS)]
+    name {:binding name :metadata (. METADATA value)}))
+
+(local macros-metadata
+  (collect [name value (pairs MACROS)]
+    name {:binding name :metadata (. METADATA value)}))
+
+(local lua54-metadata (require :fennel-ls.docs.lua54))
+
+(fn get-global-metadata [global-name]
+  (or (. specials-metadata global-name)
+      (. macros-metadata global-name)
+      (. lua54-metadata global-name)))
+
+{: get-global-metadata}

src/fennel-ls/language.fnl

@@ -40,6 +40,7 @@ a user-written file.
 (local {: sym? : list? : sequence? : varg? : sym} (require :fennel))
 (local utils (require :fennel-ls.utils))
 (local state (require :fennel-ls.state))
+(local docs (require :fennel-ls.docs))
 
 (local get-ast-info utils.get-ast-info)
 
@@ -62,6 +63,12 @@ a user-written file.
   "add the multisy values to the end of the stack in reverse order"
   (stack-add-split! stack (utils.multi-sym-split symbol)))
 
+(λ search-document [self document stack opts]
+  (if (= 0 (length stack))
+    document
+    (. document.fields (. stack (length stack)))
+    (search-document self (. document.fields (table.remove stack)) stack opts)))
+
 (λ search-val [self file ast stack opts]
   "searches for the definition of the ast, adjusted to 1 value"
   (search-multival self file ast stack 1 opts))
@@ -87,9 +94,12 @@ a user-written file.
     (if (= 0 (length stack))
       {:definition symbol : file}
       nil)
-    ;; TODO globals
-    (case (. file.references symbol)
-      to (search-assignment self file to (stack-add-multisym! stack symbol) opts))))
+    (if (. file.references symbol)
+      (search-assignment self file (. file.references symbol) (stack-add-multisym! stack symbol) opts)
+      (let [parts (utils.multi-sym-split symbol)]
+        (case (docs.get-global-metadata (. parts 1))
+          document (search-document self document (stack-add-split! stack parts) opts)
+          _ nil)))))
 
 (λ search-table [self file tbl stack opts]
   (if (. tbl (. stack (length stack)))
@@ -144,10 +154,6 @@ a user-written file.
             (= 0 (length stack))  {:definition ast : file}) ;; BASE CASE !!
         nil)))
 
-(local {:metadata METADATA
-        :scopes {:global {:specials SPECIALS
-                          :macros MACROS}}}
-  (require :fennel.compiler))
 
 (λ search-main [self file symbol opts ?byte]
   "Find the definition of a symbol"
@@ -157,8 +163,9 @@ a user-written file.
   (if (sym? symbol)
     (let [split (utils.multi-sym-split symbol (if ?byte (+ 1 (- ?byte symbol.bytestart))))
           stack (stack-add-split! [] split)]
-      (case (. METADATA (or (. MACROS (tostring symbol)) (. SPECIALS (tostring symbol))))
-        metadata {:binding symbol : metadata}
+
+      (case (docs.get-global-metadata (. split 1))
+        document (search-document self document (stack-add-split! stack split) opts)
         _ (case (. file.references symbol)
             ref (search-assignment self file ref stack opts)
             _ (case (. file.definitions symbol)
@@ -166,25 +173,19 @@ a user-written file.
 
 (λ find-local-definition [file name ?scope]
   (when ?scope
-    (or (. file.definitions-by-scope ?scope name)
-        (find-local-definition file name ?scope.parent))))
-
-(λ global-info [self name]
-  (. (require :fennel-ls.docs)
-     self.configuration.version
-     name))
+    (case (. file.definitions-by-scope ?scope name)
+      definition definition
+      _ (find-local-definition file name ?scope.parent))))
 
 (λ search-name-and-scope [self file name scope ?opts]
   "find a definition just from the name of the item, and the scope it is in"
   (assert (= (type name) :string))
-  (let [stack (stack-add-multisym! [] name)]
-    (or
-      (case (. METADATA (or (. MACROS name) (. SPECIALS name)))
-        metadata {:binding (sym name) : metadata})
-      (case (global-info self name)
-       global-item global-item)
-      (case (find-local-definition file name scope)
-        def (search-val self file def.definition (stack-add-keys! stack def.keys) (or ?opts {}))))))
+  (let [split (utils.multi-sym-split name)
+        stack (stack-add-split! [] split)]
+    (case (docs.get-global-metadata (. split 1))
+      metadata (search-document self metadata stack (or ?opts {}))
+      _ (case (find-local-definition file name scope)
+          def (search-val self file def.definition (stack-add-keys! stack def.keys) (or ?opts {}))))))
 
 (λ _past? [?ast byte]
   ;; check if a byte is past an ast object

src/fennel-ls/utils.fnl

@@ -148,6 +148,7 @@ WARNING: this is only used in the test code, not in the real language server"
   (if (or (= symbol ".")
           (= symbol "..")
           (= symbol "...")
+          (= symbol ":")
           (= symbol "?."))
     [symbol]
     (let [offset (or ?offset (length symbol))

test/hover.fnl

@@ -33,9 +33,31 @@
   nil)
 
 (fn test-globals []
-;; TODO fix globals
-;   (check "(pri|nt :hello :world)" "```fnl\n(print ...)\n```\nHi its me! I'm the print docs")
-;   (check "(xpca|ll io.open debug.traceback :filename.txt)" "```fnl\n(xpcall ...)\n```\nHi its me! I'm the xpcall docs"))
+  (check "(pri|nt :hello :world)" "```fnl\n(print ...)\n```
+Receives any number of arguments and prints their values to `stdout`,
+converting each argument to a string following the same rules of
+[`tostring`](https://lua.org/manual/5.4/manual.html#pdf-tostring).
+
+The function `print` is not intended for formatted output, but only as
+a quick way to show a value, for instance for debugging. For complete
+control over the output, use
+[`string.format`](https://lua.org/manual/5.4/manual.html#pdf-string.format)
+and [`io.write`](https://lua.org/manual/5.4/manual.html#pdf-io.write).")
+  (check "(local x print) (x| :hello :world)" "```fnl\n(print ...)\n```
+Receives any number of arguments and prints their values to `stdout`,
+converting each argument to a string following the same rules of
+[`tostring`](https://lua.org/manual/5.4/manual.html#pdf-tostring).
+
+The function `print` is not intended for formatted output, but only as
+a quick way to show a value, for instance for debugging. For complete
+control over the output, use
+[`string.format`](https://lua.org/manual/5.4/manual.html#pdf-string.format)
+and [`io.write`](https://lua.org/manual/5.4/manual.html#pdf-io.write).")
+  (check "(xpca|ll io.open debug.traceback :filename.txt)" "```fnl
+(xpcall f msgh ...)
+```
+This function is similar to [`pcall`](https://lua.org/manual/5.4/manual.html#pdf-pcall), except that it sets a
+new message handler `msgh`.")
   nil)
 
 (fn test-functions []