descriptor.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/resolver/descriptor.hh
 *
 * @brief A set of user inputs used to set input preferences and query
 *        parameters during resolution.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <functional>
#include <string>
#include <vector>
 
#include <nlohmann/json.hpp>
 
#include "flox/core/types.hh"
#include "flox/pkgdb/pkg-query.hh"
#include "flox/registry.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox::resolver {
 
/* -------------------------------------------------------------------------- */
 
using GroupName = std::string;
 
 
/* -------------------------------------------------------------------------- */
 
struct ManifestDescriptorRaw
{
 
public:
 
  static const auto inputSigil = ':';
 
  static const auto versionSigil = '@';
 
  static const auto exactVersionSigil = '=';
 
  std::optional<std::string> name;
 
  std::optional<std::string> version;
 
  using Path = std::variant<std::string, flox::AttrPath>;
  std::optional<Path> path;
 
  using AbsPath = std::variant<std::string, AttrPathGlob>;
  std::optional<AbsPath> absPath;
 
  std::optional<std::vector<System>> systems;
 
  std::optional<bool> optional;
 
  // TODO: Not implemented.
  std::optional<GroupName> packageGroup;
 
  // TODO: Not implemented.
  std::optional<std::variant<std::string, nix::fetchers::Attrs>>
    packageRepository;
 
 
  std::optional<unsigned> priority;
 
  void
  check( const std::string iid = "*" ) const;
 
  void
  clear();
 
  ManifestDescriptorRaw() = default;
 
  explicit ManifestDescriptorRaw( const std::string_view & descriptor );
 
}; /* End struct `ManifestDescriptorRaw' */
 
 
/* -------------------------------------------------------------------------- */
 
// TODO: support `packageRepository' field
void
from_json( const nlohmann::json & jfrom, ManifestDescriptorRaw & descriptor );
 
void
to_json( nlohmann::json & jto, const ManifestDescriptorRaw & descriptor );
 
 
/* -------------------------------------------------------------------------- */
 
FLOX_DEFINE_EXCEPTION( ParseManifestDescriptorRawException,
                       EC_PARSE_MANIFEST_DESCRIPTOR_RAW,
                       "error parsing manifest descriptor" )
/* -------------------------------------------------------------------------- */
 
 
std::optional<std::string>
validatedSingleAttr( const AttrPathGlob & attrs );
 
bool
globInAttrName( const AttrPathGlob & attrs );
 
std::vector<std::string>
validatedRelativePath( const AttrPathGlob &             attrs,
                       const std::vector<std::string> & strings );
 
AttrPathGlob
validatedAbsolutePath( const AttrPathGlob & attrs );
 
bool
isAbsolutePath( const AttrPathGlob & attrs );
 
/* -------------------------------------------------------------------------- */
 
struct ManifestDescriptor
{
 
public:
 
  std::optional<std::string> name;
 
  bool optional = false;
 
  std::optional<GroupName> group;
 
  std::optional<std::string> version;
 
  std::optional<std::string> semver;
 
  std::optional<Subtree> subtree;
 
  std::optional<std::vector<System>> systems;
 
  std::optional<flox::AttrPath> path;
 
  std::optional<nix::FlakeRef> input;
 
  unsigned priority = 5;
 
 
  ManifestDescriptor() = default;
 
  explicit ManifestDescriptor( const std::string_view & descriptor )
    : ManifestDescriptor( ManifestDescriptorRaw( descriptor ) ) {};
 
  explicit ManifestDescriptor( const ManifestDescriptorRaw & raw );
 
  explicit ManifestDescriptor( std::string_view              installID,
                               const ManifestDescriptorRaw & raw )
    : ManifestDescriptor( raw )
  {
    if ( ! this->name.has_value() ) { this->name = installID; }
  }
 
  void
  check() const;
 
  void
  clear();
 
  pkgdb::PkgQueryArgs &
  fillPkgQueryArgs( pkgdb::PkgQueryArgs & pqa ) const;
 
 
}; /* End struct `ManifestDescriptor' */
 
 
/* -------------------------------------------------------------------------- */
 
void
to_json( nlohmann::json & jto, const ManifestDescriptor & descriptor );
 
/* -------------------------------------------------------------------------- */
 
FLOX_DEFINE_EXCEPTION( InvalidManifestDescriptorException,
                       EC_INVALID_MANIFEST_DESCRIPTOR,
                       "invalid manifest descriptor" )
/* -------------------------------------------------------------------------- */
 
}  // namespace flox::resolver
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */