raw-package.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/raw-package.hh
 *
 * @brief The simplest `Package' implementation comprised of raw values.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include <nlohmann/json.hpp>
 
#include "flox/core/types.hh"
#include "flox/package.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox {
 
/* -------------------------------------------------------------------------- */
 
class RawPackage : public Package
{
 
public:
 
  AttrPath                   path;
  std::string                name;
  std::string                pname;
  std::optional<std::string> version;
  std::optional<std::string> semver;
  std::optional<std::string> license;
  std::vector<std::string>   outputs;
  std::vector<std::string>   outputsToInstall;
  std::optional<bool>        broken;
  std::optional<bool>        unfree;
  std::optional<std::string> description;
 
  RawPackage( const AttrPath &                 path             = {},
              std::string_view                 name             = {},
              std::string_view                 pname            = {},
              std::optional<std::string>       version          = std::nullopt,
              std::optional<std::string>       semver           = std::nullopt,
              std::optional<std::string>       license          = std::nullopt,
              const std::vector<std::string> & outputs          = { "out" },
              const std::vector<std::string> & outputsToInstall = { "out" },
              std::optional<bool>              broken           = std::nullopt,
              std::optional<bool>              unfree           = std::nullopt,
              std::optional<std::string>       description      = std::nullopt )
    : path( path )
    , name( name )
    , pname( pname )
    , version( version )
    , semver( semver )
    , license( license )
    , outputs( outputs )
    , outputsToInstall( outputsToInstall )
    , broken( broken )
    , unfree( unfree )
    , description( description )
  {}
 
 
  /* --------------------------------------------------------------------------
   */
 
  AttrPath
  getPathStrs() const override
  {
    return this->path;
  }
 
  std::string
  getFullName() const override
  {
    return this->name;
  }
 
  std::string
  getPname() const override
  {
    return this->pname;
  }
 
  std::optional<std::string>
  getVersion() const override
  {
    return this->version;
  }
 
  std::optional<std::string>
  getSemver() const override
  {
    return this->semver;
  }
 
  std::optional<std::string>
  getLicense() const override
  {
    return this->license;
  }
 
  std::vector<std::string>
  getOutputs() const override
  {
    return this->outputs;
  }
 
  std::vector<std::string>
  getOutputsToInstall() const override
  {
    return this->outputsToInstall;
  }
 
  std::optional<bool>
  isBroken() const override
  {
    return this->broken;
  }
 
  std::optional<bool>
  isUnfree() const override
  {
    return this->unfree;
  }
 
  std::optional<std::string>
  getDescription() const override
  {
    return this->description;
  }
 
 
}; /* End class `RawPackage' */
 
 
/* -------------------------------------------------------------------------- */
 
void
from_json( const nlohmann::json & jfrom, RawPackage & pkg );
 
void
to_json( nlohmann::json & jto, const flox::RawPackage & pkg );
 
 
/* -------------------------------------------------------------------------- */
 
}  // namespace flox
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */