AttrSet.h

Go to the documentation of this file.

/// \file
/// \brief Types used in nixpkgs provider.
 
#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <vector>
 
#include <llvm/Support/JSON.h>
#include <lspserver/Protocol.h>
 
// https://github.com/NixOS/nix/issues/11136
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
#endif
 
#include <nix/expr/value.hh>
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
namespace nixd {
 
namespace rpcMethod {
 
constexpr inline std::string_view EvalExpr = "attrset/evalExpr";
constexpr inline std::string_view AttrPathInfo = "attrset/attrpathInfo";
constexpr inline std::string_view AttrPathComplete = "attrset/attrpathComplete";
constexpr inline std::string_view OptionInfo = "attrset/optionInfo";
constexpr inline std::string_view OptionComplete = "attrset/optionComplete";
constexpr inline std::string_view Exit = "exit";
 
} // namespace rpcMethod
 
using EvalExprParams = std::string;
using EvalExprResponse = std::optional<std::string>;
 
/// \brief A list of strings that "select"s into a attribute set.
using Selector = std::vector<std::string>;
 
using PackageInfoParams = Selector;
using OptionInfoParams = Selector;
 
using AttrPathInfoParams = Selector;
 
struct PackageDescription {
  std::optional<std::string> Name;
  std::optional<std::string> PName;
  std::optional<std::string> Version;
  std::optional<std::string> Description;
  std::optional<std::string> LongDescription;
  std::optional<std::string> Position;
  std::optional<std::string> Homepage;
};
 
llvm::json::Value toJSON(const PackageDescription &Params);
bool fromJSON(const llvm::json::Value &Params, PackageDescription &R,
              llvm::json::Path P);
 
/// \brief General metadata of all `nix::Value`s
struct ValueMeta {
  /// \brief Type of this value.
  int Type;
 
  /// \brief Location of the value.
  ///
  /// This presence of this value is determined by the nix evaluator.
  /// In nix 2.19.x and later:
  ///   1. It is available only for attribute sets and lambdas.
  ///   2. There is no practical "range" information, only the starting point.
  std::optional<lspserver::Location> Location;
};
 
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 retrieve value's additional information.
struct ValueDescription {
  std::string Doc;
  std::int64_t Arity;
  std::vector<std::string> Args;
};
 
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);
bool fromJSON(const llvm::json::Value &Params, AttrPathInfoResponse &R,
              llvm::json::Path P);
 
struct AttrPathCompleteParams {
  Selector Scope;
  /// \brief Search for packages prefixed with this "prefix"
  std::string Prefix;
};
 
llvm::json::Value toJSON(const AttrPathCompleteParams &Params);
bool fromJSON(const llvm::json::Value &Params, AttrPathCompleteParams &R,
              llvm::json::Path P);
 
struct AttrPathCompleteResponse {
  std::vector<std::string> Items;
  bool IsIncomplete = false;
};
 
llvm::json::Value toJSON(const AttrPathCompleteResponse &Params);
bool fromJSON(const llvm::json::Value &Params, AttrPathCompleteResponse &R,
              llvm::json::Path P);
 
struct OptionType {
  std::optional<std::string> Description;
  std::optional<std::string> Name;
};
 
llvm::json::Value toJSON(const OptionType &Params);
bool fromJSON(const llvm::json::Value &Params, OptionType &R,
              llvm::json::Path P);
 
struct OptionDescription {
  std::optional<std::string> Description;
  std::vector<lspserver::Location> Declarations;
  std::vector<lspserver::Location> Definitions;
  std::optional<std::string> Example;
  std::optional<std::string> Default;
  std::optional<OptionType> Type;
};
 
llvm::json::Value toJSON(const OptionDescription &Params);
bool fromJSON(const llvm::json::Value &Params, OptionDescription &R,
              llvm::json::Path P);
 
struct OptionField {
  std::string Name;
  std::optional<OptionDescription> Description;
};
 
llvm::json::Value toJSON(const OptionField &Params);
bool fromJSON(const llvm::json::Value &Params, OptionField &R,
              llvm::json::Path P);
 
using OptionInfoResponse = OptionDescription;
 
struct OptionCompleteResponse {
  std::vector<OptionField> Items;
  bool IsIncomplete = false;
};
 
llvm::json::Value toJSON(const OptionCompleteResponse &Params);
bool fromJSON(const llvm::json::Value &Params, OptionCompleteResponse &R,
              llvm::json::Path P);
 
} // namespace nixd