params.hh

Go to the documentation of this file.

/* ========================================================================== *
 *
 * @file flox/search/params.hh
 *
 * @brief A set of user inputs used to set input preferences and query
 *        parameters during search.
 *
 *
 * -------------------------------------------------------------------------- */
 
#pragma once
 
#include <filesystem>
#include <nlohmann/json_fwd.hpp>
#include <optional>
#include <string>
#include <string_view>
#include <variant>
 
#include "flox/core/exceptions.hh"
#include "flox/core/types.hh"
#include "flox/core/util.hh"
#include "flox/pkgdb/pkg-query.hh"
#include "flox/registry.hh"
#include "flox/resolver/environment.hh"
#include "flox/resolver/lockfile.hh"
#include "flox/resolver/manifest.hh"
 
 
/* -------------------------------------------------------------------------- */
 
namespace flox::search {
 
/* -------------------------------------------------------------------------- */
 
struct SearchQuery
{
 
  std::optional<std::string> name;    
  std::optional<std::string> pname;   
  std::optional<std::string> version; 
  std::optional<std::string> semver;  
  std::optional<std::string> partialMatch;
 
  std::optional<std::string> partialNameMatch;
 
  void
  clear();
 
  void
  check() const;
 
  pkgdb::PkgQueryArgs &
  fillPkgQueryArgs( pkgdb::PkgQueryArgs & pqa ) const;
 
 
}; /* End struct "SearchQuery' */
 
 
/* -------------------------------------------------------------------------- */
 
FLOX_DEFINE_EXCEPTION( ParseSearchQueryException,
                       EC_PARSE_SEARCH_QUERY,
                       "error parsing search query" )
/* -------------------------------------------------------------------------- */
 
 
void
from_json( const nlohmann::json & jfrom, SearchQuery & qry );
 
void
to_json( nlohmann::json & jto, const SearchQuery & qry );
 
 
/* -------------------------------------------------------------------------- */
 
struct SearchParams
{
 
  std::optional<
    std::variant<std::filesystem::path, resolver::GlobalManifestRaw>>
    globalManifest;
 
  std::optional<std::variant<std::filesystem::path, resolver::ManifestRaw>>
    manifest;
 
  std::optional<std::variant<std::filesystem::path, resolver::LockfileRaw>>
    lockfile;
 
  SearchQuery query;
 
 
  [[nodiscard]] std::optional<std::filesystem::path>
  getGlobalManifestPath();
 
  [[nodiscard]] std::optional<flox::resolver::GlobalManifestRaw>
  getGlobalManifestRaw();
 
  [[nodiscard]] std::optional<std::filesystem::path>
  getManifestPath();
 
  [[nodiscard]] flox::resolver::ManifestRaw
  getManifestRaw();
 
  [[nodiscard]] std::optional<std::filesystem::path>
  getLockfilePath();
 
  [[nodiscard]] std::optional<flox::resolver::LockfileRaw>
  getLockfileRaw();
 
 
}; /* End struct `SearchParams' */
 
 
/* -------------------------------------------------------------------------- */
 
void
from_json( const nlohmann::json & jfrom, SearchParams & params );
 
void
to_json( nlohmann::json & jto, const SearchParams & params );
 
 
/* -------------------------------------------------------------------------- */
 
}  // namespace flox::search
 
 
/* -------------------------------------------------------------------------- *
 *
 *
 *
 * ========================================================================== */