eldritch horrors
14de5fa627
these ended up referring to different directories and would break during source reorganization (or even just including them in different places). Change-Id: I91e8db04e3d3565efd5920982ed5bc59d2c27058
104 lines
2.8 KiB
C++
104 lines
2.8 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include "lix/libutil/error.hh"
|
|
#include "lix/libutil/json-fwd.hh"
|
|
#include "lix/libutil/types.hh"
|
|
#include <type_traits>
|
|
|
|
namespace nix {
|
|
|
|
/**
|
|
* The list of available deprecated features.
|
|
*
|
|
* Reminder: New deprecated features should start out with a warning without throwing an error.
|
|
* See the developer documentation for details.
|
|
*/
|
|
enum struct DeprecatedFeature {
|
|
#include "lix/libutil/deprecated-features.gen.inc"
|
|
NumDepFeatures, // number of available deprecated features, do not use
|
|
};
|
|
|
|
template<>
|
|
struct json::avoids_null<DeprecatedFeature> : std::true_type
|
|
{};
|
|
|
|
enum struct DeprecatedFeatures {};
|
|
|
|
inline DeprecatedFeatures operator| (DeprecatedFeatures a, DeprecatedFeatures b) {
|
|
return static_cast<DeprecatedFeatures>(static_cast<size_t>(a) | static_cast<size_t>(b));
|
|
}
|
|
|
|
inline DeprecatedFeatures operator| (DeprecatedFeatures a, DeprecatedFeature b) {
|
|
return a | static_cast<DeprecatedFeatures>(1 << static_cast<size_t>(b));
|
|
}
|
|
|
|
inline DeprecatedFeatures operator& (DeprecatedFeatures a, DeprecatedFeature b) {
|
|
return static_cast<DeprecatedFeatures>(static_cast<size_t>(a) & (1 << static_cast<size_t>(b)));
|
|
}
|
|
|
|
/**
|
|
* Just because writing `DeprecatedFeature::UrlLiterals` is way too long
|
|
*/
|
|
using Dep = DeprecatedFeature;
|
|
|
|
/**
|
|
* Parse a deprecated feature (enum value) from its name. Deprecated
|
|
* feature flag names are hyphenated and do not contain spaces.
|
|
*/
|
|
const std::optional<DeprecatedFeature> parseDeprecatedFeature(
|
|
const std::string_view & name);
|
|
|
|
/**
|
|
* Show the name of a deprecated feature. This is the opposite of
|
|
* parseDeprecatedFeature().
|
|
*/
|
|
std::string_view showDeprecatedFeature(const DeprecatedFeature);
|
|
|
|
/**
|
|
* Shorthand for `str << showDeprecatedFeature(feature)`.
|
|
*/
|
|
std::ostream & operator<<(
|
|
std::ostream & str,
|
|
const DeprecatedFeature & feature);
|
|
|
|
/**
|
|
* Parse a set of strings to the corresponding set of deprecated
|
|
* features, ignoring (but warning for) any unknown feature.
|
|
*/
|
|
DeprecatedFeatures parseDeprecatedFeatures(const std::set<std::string> &);
|
|
|
|
/**
|
|
* Compute the documentation of all deprecated features.
|
|
*
|
|
* See `doc/manual` for how this information is used.
|
|
*/
|
|
JSON documentDeprecatedFeatures();
|
|
|
|
/**
|
|
* Semi-magic conversion to and from json.
|
|
* See the nlohmann/json readme for more details.
|
|
*/
|
|
void to_json(JSON &, const DeprecatedFeature &);
|
|
void from_json(const JSON &, DeprecatedFeature &);
|
|
|
|
void to_json(JSON &, const DeprecatedFeatures &);
|
|
void from_json(const JSON &, DeprecatedFeatures &);
|
|
|
|
/**
|
|
* A deprecated feature used for some
|
|
* operation, but was not enabled.
|
|
*/
|
|
class MissingDeprecatedFeature : public Error
|
|
{
|
|
public:
|
|
/**
|
|
* The deprecated feature that was required but not enabled.
|
|
*/
|
|
DeprecatedFeature missingFeature;
|
|
|
|
MissingDeprecatedFeature(DeprecatedFeature missingFeature);
|
|
};
|
|
|
|
}
|