package.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/package.hh
 *
 * @brief Abstract representation of a package.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <functional>
#include <optional>
#include <string>
#include <variant>
#include <vector>
 
#include <nlohmann/json_fwd.hpp>
 
#include <nix/eval-cache.hh>
#include <nix/fetchers.hh>
#include <nix/flake/flake.hh>
#include <nix/names.hh>
 
#include "flox/core/exceptions.hh"
#include "flox/core/types.hh"
#include "versions.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox {
 
/* -------------------------------------------------------------------------- */
 
class Package
{
 
public:
 
  virtual ~Package()         = default;
  Package()                  = default;
  Package( const Package & ) = default;
  Package( Package && )      = default;
 
  Package &
  operator=( const Package & )
    = default;
  Package &
  operator=( Package && )
    = default;
 
  [[nodiscard]] virtual AttrPath
  getPathStrs() const
    = 0;
 
  [[nodiscard]] virtual std::string
  getFullName() const
    = 0;
 
  [[nodiscard]] virtual std::string
  getPname() const
    = 0;
 
  [[nodiscard]] virtual std::optional<std::string>
  getVersion() const = 0;
 
  [[nodiscard]] virtual std::optional<std::string>
  getLicense() const = 0;
 
  [[nodiscard]] virtual std::vector<std::string>
  getOutputs() const = 0;
 
  [[nodiscard]] virtual std::vector<std::string>
  getOutputsToInstall() const = 0;
 
  [[nodiscard]] virtual std::optional<bool>
  isBroken() const = 0;
 
  [[nodiscard]] virtual std::optional<bool>
  isUnfree() const = 0;
 
  [[nodiscard]] virtual std::optional<std::string>
  getDescription() const = 0;
 
  [[nodiscard]] virtual Subtree
  getSubtreeType() const
  {
    return Subtree( this->getPathStrs().front() );
  }
 
  [[nodiscard]] virtual nix::DrvName
  getParsedDrvName() const
  {
    return { this->getFullName() };
  }
 
  [[nodiscard]] virtual std::optional<std::string>
  getSemver() const
  {
    std::optional<std::string> version = this->getVersion();
    if ( ! version.has_value() ) { return std::nullopt; }
    return versions::coerceSemver( *version );
  }
 
  [[nodiscard]] virtual std::string
  toURIString( const nix::FlakeRef & ref ) const;
 
  [[nodiscard]] virtual nlohmann::json
  getInfo( bool withDescription = false ) const;
 
 
}; /* End class `Package' */
 
 
/* -------------------------------------------------------------------------- */
 
}  // namespace flox
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */