use getDoc from EvalState to retrieve docs generally.

Author: inclyc

nixd/include/nixd/Eval/AttrSetProvider.h

@@ -66,14 +66,6 @@ class AttrSetProvider : public lspserver::LSPServer {
   /// FIXME: suppport list names. i.e.    `foo.*.submodule`
   void onOptionComplete(const AttrPathCompleteParams &Params,
                         lspserver::Callback<OptionCompleteResponse> Reply);
-
-  /// \brief Provide information on builtin values.
-  void onBuiltinInfo(const AttrPathInfoParams &AttrPath,
-                     lspserver::Callback<BuiltinInfoResponse> Reply);
-
-  /// \brief Complete builtin values.
-  void onBuiltinComplete(const AttrPathCompleteParams &Params,
-                         lspserver::Callback<BuiltinCompleteResponse> Reply);
 };
 
 } // namespace nixd

nixd/include/nixd/Protocol/AttrSet.h

@@ -33,12 +33,6 @@ constexpr inline std::string_view AttrPathComplete = "attrset/attrpathComplete";
 constexpr inline std::string_view OptionInfo = "attrset/optionInfo";
 constexpr inline std::string_view OptionComplete = "attrset/optionComplete";
 
-/// \brief ↩︎ Request information
-constexpr inline std::string_view BuiltinInfo = "attrset/builtinInfo";
-
-/// \brief ↩︎ Request completion of builtins.
-constexpr inline std::string_view BuiltinComplete = "attrset/builtinComplete";
-
 constexpr inline std::string_view Exit = "exit";
 
 } // namespace rpcMethod
@@ -86,12 +80,24 @@ llvm::json::Value toJSON(const ValueMeta &Params);
 bool fromJSON(const llvm::json::Value &Params, ValueMeta &R,
               llvm::json::Path P);
 
+/// \brief Using nix's ":doc" method to retrive value's additional information.
+struct ValueDescription {
+  std::string Doc;
+  std::int64_t Arity;
+};
+
+llvm::json::Value toJSON(const ValueDescription &Params);
+bool fromJSON(const llvm::json::Value &Params, ValueDescription &R,
+              llvm::json::Path P);
+
 struct AttrPathInfoResponse {
   /// \brief General value description
   ValueMeta Meta;
 
   /// \brief Package description of the attribute path, if available.
   PackageDescription PackageDesc;
+
+  std::optional<ValueDescription> ValueDesc;
 };
 
 llvm::json::Value toJSON(const AttrPathInfoResponse &Params);
@@ -144,16 +150,4 @@ using OptionInfoResponse = OptionDescription;
 
 using OptionCompleteResponse = std::vector<OptionField>;
 
-struct BuiltinDescription {
-  std::string Doc;
-  std::int64_t Arity;
-};
-
-llvm::json::Value toJSON(const BuiltinDescription &Params);
-bool fromJSON(const llvm::json::Value &Params, BuiltinDescription &R,
-              llvm::json::Path P);
-
-using BuiltinInfoResponse = BuiltinDescription;
-using BuiltinCompleteResponse = std::vector<std::string>;
-
 } // namespace nixd

nixd/lib/Eval/AttrSetProvider.cpp

@@ -184,6 +184,19 @@ std::vector<std::string> completeNames(nix::Value &Scope,
   return Names;
 }
 
+std::optional<ValueDescription> describeValue(nix::EvalState &State,
+                                              nix::Value &V) {
+  const auto Doc = State.getDoc(V);
+  if (!Doc) {
+    return std::nullopt;
+  } else {
+    return ValueDescription{
+        .Doc = Doc->doc,
+        .Arity = static_cast<int64_t>(Doc->arity),
+    };
+  }
+}
+
 } // namespace
 
 AttrSetProvider::AttrSetProvider(std::unique_ptr<InboundPort> In,
@@ -200,10 +213,6 @@ AttrSetProvider::AttrSetProvider(std::unique_ptr<InboundPort> In,
                      &AttrSetProvider::onOptionInfo);
   Registry.addMethod(rpcMethod::OptionComplete, this,
                      &AttrSetProvider::onOptionComplete);
-  Registry.addMethod(rpcMethod::BuiltinInfo, this,
-                     &AttrSetProvider::onBuiltinInfo);
-  Registry.addMethod(rpcMethod::BuiltinComplete, this,
-                     &AttrSetProvider::onBuiltinComplete);
 }
 
 void AttrSetProvider::onEvalExpr(
@@ -234,9 +243,11 @@ void AttrSetProvider::onAttrPathInfo(
 
       nix::Value &V = nixt::selectStrings(state(), Nixpkgs, AttrPath);
       state().forceValue(V, nix::noPos);
+
       return RespT{
           .Meta = metadataOf(state(), V),
           .PackageDesc = describePackage(state(), V),
+          .ValueDesc = describeValue(state(), V),
       };
     } catch (const nix::BaseError &Err) {
       return error(Err.info().msg.str());
@@ -349,33 +360,3 @@ void AttrSetProvider::onOptionComplete(
     return;
   }
 }
-void nixd::AttrSetProvider::onBuiltinInfo(
-    const AttrPathInfoParams &AttrPath,
-    lspserver::Callback<BuiltinDescription> Reply) {
-  return Reply([&]() -> llvm::Expected<BuiltinDescription> {
-    auto &Builtins = nixt::getBuiltins(state());
-    if (AttrPath.empty())
-      return error("attrpath is empty!");
-
-    auto &TheBuiltin = nixt::selectStrings(state(), Builtins, AttrPath);
-    const auto &Doc = state().getDoc(TheBuiltin);
-    if (!Doc) {
-      return error("No documentation available");
-    } else {
-      return BuiltinDescription{
-          .Doc = Doc->doc,
-          .Arity = static_cast<int64_t>(Doc->arity),
-      };
-    }
-  }());
-}
-
-void nixd::AttrSetProvider::onBuiltinComplete(
-    const AttrPathCompleteParams &Params,
-    lspserver::Callback<BuiltinCompleteResponse> Reply) {
-  return Reply([&]() -> llvm::Expected<BuiltinCompleteResponse> {
-    auto &Builtins = nixt::getBuiltins(state());
-    auto &Scope = nixt::selectStrings(state(), Builtins, Params.Scope);
-    return completeNames(Scope, state(), Params.Prefix);
-  }());
-}

nixd/lib/Protocol/AttrSet.cpp

@@ -97,6 +97,7 @@ Value nixd::toJSON(const AttrPathInfoResponse &Params) {
   return Object{
       {"Meta", Params.Meta},
       {"PackageDesc", Params.PackageDesc},
+      {"ValueDesc", Params.ValueDesc},
   };
 }
 
@@ -106,6 +107,7 @@ bool nixd::fromJSON(const llvm::json::Value &Params, AttrPathInfoResponse &R,
   return O                                              //
          && O.map("Meta", R.Meta)                       //
          && O.mapOptional("PackageDesc", R.PackageDesc) //
+         && O.mapOptional("ValueDesc", R.ValueDesc)     //
       ;
 }
 
@@ -121,13 +123,13 @@ bool nixd::fromJSON(const llvm::json::Value &Params, AttrPathCompleteParams &R,
       ;
 }
 
-llvm::json::Value nixd::toJSON(const BuiltinDescription &Params) {
+llvm::json::Value nixd::toJSON(const ValueDescription &Params) {
   return Object{
       {"arity", Params.Arity},
       {"doc", Params.Doc},
   };
 }
-bool nixd::fromJSON(const llvm::json::Value &Params, BuiltinDescription &R,
+bool nixd::fromJSON(const llvm::json::Value &Params, ValueDescription &R,
                     llvm::json::Path P) {
 
   ObjectMapper O(Params, P);

nixd/tools/nixd-attrset-eval/test/attrs-info-doc.md

@@ -0,0 +1,50 @@
+# RUN: nixd-attrset-eval --lit-test < %s | FileCheck %s
+
+
+```json
+{
+   "jsonrpc":"2.0",
+   "id":0,
+   "method":"attrset/evalExpr",
+   "params": "{ hello = /** some markdown docs */x: y: x; }"
+}
+```
+
+
+```json
+{
+   "jsonrpc":"2.0",
+   "id":1,
+   "method":"attrset/attrpathInfo",
+   "params": [ "hello" ]
+}
+```
+
+```
+     CHECK: "id": 1,
+CHECK-NEXT: "jsonrpc": "2.0",
+CHECK-NEXT: "result": {
+CHECK-NEXT:   "Meta": {
+CHECK-NEXT:     "Location": null,
+CHECK-NEXT:     "Type": 9
+CHECK-NEXT:   },
+CHECK-NEXT:   "PackageDesc": {
+CHECK-NEXT:     "Description": null,
+CHECK-NEXT:     "Homepage": null,
+CHECK-NEXT:     "LongDescription": null,
+CHECK-NEXT:     "Name": null,
+CHECK-NEXT:     "PName": null,
+CHECK-NEXT:     "Position": null,
+CHECK-NEXT:     "Version": null
+CHECK-NEXT:   },
+CHECK-NEXT:   "ValueDesc": {
+CHECK-NEXT:     "arity": 0,
+CHECK-NEXT:     "doc": "Function `hello`\\\n  … defined at «string»:1:36\n\nsome markdown docs \n"
+CHECK-NEXT:   }
+CHECK-NEXT: }
+```
+
+```json
+{"jsonrpc":"2.0","method":"exit"}
+```
+