#pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include namespace mbgl { class GeometryTileFeature; namespace style { namespace expression { class EvaluationError { public: std::string message; }; class EvaluationContext { public: EvaluationContext() = default; explicit EvaluationContext(float zoom_) noexcept : zoom(zoom_) {} explicit EvaluationContext(GeometryTileFeature const* feature_) noexcept : feature(feature_) {} EvaluationContext(float zoom_, GeometryTileFeature const* feature_) noexcept : zoom(zoom_), feature(feature_) {} EvaluationContext(std::optional accumulated_, GeometryTileFeature const* feature_) noexcept(false) : accumulated(std::move(accumulated_)), feature(feature_) {} EvaluationContext(float zoom_, GeometryTileFeature const* feature_, const FeatureState* state_) noexcept : zoom(zoom_), feature(feature_), featureState(state_) {} EvaluationContext(std::optional zoom_, GeometryTileFeature const* feature_, std::optional colorRampParameter_) noexcept : zoom(std::move(zoom_)), feature(feature_), colorRampParameter(std::move(colorRampParameter_)) {} EvaluationContext& withFormattedSection(const Value* formattedSection_) noexcept { formattedSection = formattedSection_; return *this; }; EvaluationContext& withFeatureState(const FeatureState* featureState_) noexcept { featureState = featureState_; return *this; }; EvaluationContext& withAvailableImages(const std::set* availableImages_) noexcept { availableImages = availableImages_; return *this; }; EvaluationContext& withCanonicalTileID(const mbgl::CanonicalTileID* canonical_) noexcept { canonical = canonical_; return *this; }; std::optional zoom; std::optional accumulated; GeometryTileFeature const* feature = nullptr; std::optional colorRampParameter; // Contains formatted section object, std::unordered_map. const Value* formattedSection = nullptr; const FeatureState* featureState = nullptr; const std::set* availableImages = nullptr; const mbgl::CanonicalTileID* canonical = nullptr; }; template class Result : private variant { public: using variant::variant; using Value = T; using Variant = variant; Result() = default; static_assert(std::is_nothrow_constructible_v); template VARIANT_INLINE Result(U&& val) : Variant(std::forward(val)) {} template VARIANT_INLINE Result(const U& val) : Variant(val) {} explicit operator bool() const noexcept { return this->template is(); } // optional does some type trait magic for this one, so this might // be problematic as is. const T* operator->() const noexcept { assert(this->template is()); return std::addressof(this->template get()); } T* operator->() noexcept { assert(this->template is()); return std::addressof(this->template get()); } T& operator*() noexcept { assert(this->template is()); return this->template get(); } const T& operator*() const noexcept { assert(this->template is()); return this->template get(); } const EvaluationError& error() const noexcept { assert(this->template is()); return this->template get(); } }; class EvaluationResult : public Result { public: using Result::Result; // NOLINT EvaluationResult() = default; EvaluationResult(const std::array& arr) : Result(toExpressionValue(arr)) {} // used only for the special (private) "error" expression EvaluationResult(const type::ErrorType&) noexcept { assert(false); } }; /** Expression is an abstract class that serves as an interface and base class for particular expression implementations. CompoundExpression implements the majority of expressions in the spec by inferring the argument and output from a simple function (const T0& arg0, const T1& arg1, ...) -> Result where T0, T1, ..., U are member types of mbgl::style::expression::Value. The other Expression subclasses (Let, Curve, Match, etc.) exist in order to implement expressions that need specialized parsing, type checking, or evaluation logic that can't be handled by CompoundExpression's inference mechanism. Each Expression subclass also provides a static ParseResult ExpressionClass::parse(const V&, ParsingContext), which handles parsing a style-spec JSON representation of the expression. */ enum class Kind : int32_t { Coalesce, CompoundExpression, Literal, At, Interpolate, Assertion, Length, Step, Let, Var, CollatorExpression, Coercion, Match, Error, Case, Any, All, Comparison, FormatExpression, FormatSectionOverride, NumberFormat, ImageExpression, In, Within, Distance, IndexOf, Slice }; enum class Dependency : uint32_t { None = 0, Feature = 1 << 0, // Data reference Image = 1 << 1, // Image reference (equivalent to not "runtime constant") Zoom = 1 << 2, // Zoom level Location = 1 << 3, // Not used yet, "distance-from-center" not supported Bind = 1 << 4, // Create variable binding ("let") Var = 1 << 5, // Use variable binding Override = 1 << 6, // Property override MaskCount = 7, All = (1 << MaskCount) - 1, }; class Interpolate; class Step; using ZoomCurveOrError = std::optional>; using ZoomCurvePtr = variant; class Expression { public: Expression(Kind kind_, type::Type type_, Dependency dependencies_) : dependencies(dependencies_), kind(kind_), type(std::move(type_)) {} virtual ~Expression() = default; virtual EvaluationResult evaluate(const EvaluationContext& params) const = 0; virtual void eachChild(const std::function&) const = 0; virtual bool operator==(const Expression&) const = 0; bool operator!=(const Expression&) const = default; Kind getKind() const noexcept { return kind; }; const type::Type& getType() const noexcept { return type; }; EvaluationResult evaluate(std::optional zoom, const Feature& feature, std::optional colorRampParameter) const; EvaluationResult evaluate(std::optional zoom, const Feature& feature, std::optional colorRampParameter, const std::set& availableImages) const; EvaluationResult evaluate(std::optional zoom, const Feature& feature, std::optional colorRampParameter, const std::set& availableImages, const CanonicalTileID& canonical) const; EvaluationResult evaluate(std::optional accumulated, const Feature& feature) const; /** * Statically analyze the expression, attempting to enumerate possible * outputs. Returns an array of values plus the sentinel null optional * value, used to indicate that the complete set of outputs is statically * undecidable. */ virtual std::vector> possibleOutputs() const = 0; virtual mbgl::Value serialize() const { std::vector serialized; serialized.emplace_back(getOperator()); eachChild([&](const Expression& child) { serialized.emplace_back(child.serialize()); }); return serialized; }; virtual std::string getOperator() const = 0; const Dependency dependencies; /// Test the expression's dependencies for any of one or more values bool has(Dependency dep) const { return (dependencies & dep); } protected: template static bool childrenEqual(const T& lhs, const T& rhs) noexcept { if (lhs.size() != rhs.size()) return false; for (auto leftChild = lhs.begin(), rightChild = rhs.begin(); leftChild != lhs.end(); leftChild++, rightChild++) { if (!Expression::childEqual(*leftChild, *rightChild)) { return false; } } return true; } static bool childEqual(const std::unique_ptr& lhs, const std::unique_ptr& rhs) noexcept { return *lhs == *rhs; } template static bool childEqual(const std::pair>& lhs, const std::pair>& rhs) noexcept requires(std::is_scalar_v) { return lhs.first == rhs.first && *(lhs.second) == *(rhs.second); } template >, typename = void> static bool childEqual(const std::pair>& lhs, const std::pair>& rhs) noexcept { return lhs.first == rhs.first && *(lhs.second) == *(rhs.second); } template static bool childEqual(const std::pair>& lhs, const std::pair>& rhs) noexcept requires(!std::is_scalar_v) { #if __clang_major__ > 16 // On older compilers, this assignment doesn't do overload resolution // in the same way that `lhs==rhs` does and produces ambiguity errors. bool (*equality_method)(const T&, const T&) noexcept = &std::operator==; static_assert(std::is_nothrow_invocable_v); #endif return lhs.first == rhs.first && *(lhs.second) == *(rhs.second); } static bool childEqual(const std::pair, std::unique_ptr>& lhs, const std::pair, std::unique_ptr>& rhs) noexcept { return *(lhs.first) == *(rhs.first) && *(lhs.second) == *(rhs.second); } static Dependency depsOf(const std::shared_ptr& ex) { return ex ? ex->dependencies : Dependency::None; } static Dependency depsOf(const std::unique_ptr& ex) { return ex ? ex->dependencies : Dependency::None; } template static Dependency depsOf(const std::optional& ex) { return ex ? depsOf(*ex) : Dependency::None; } /// Combine the dependencies of all the expressions in a container of shared- or unique-pointers to expressions template static constexpr Dependency collectDependencies(const std::vector& container) { return std::accumulate(container.begin(), container.end(), Dependency::None, [](auto a, const auto& ex) { return a | depsOf(ex); }); } template static constexpr Dependency collectDependencies(const std::vector& container, F op) { return std::accumulate(container.begin(), container.end(), Dependency::None, [&](auto a, const auto& item) { return a | op(item); }); } template static constexpr Dependency collectDependencies(const std::map& container) { return std::accumulate(container.begin(), container.end(), Dependency::None, [](auto a, const auto& v) { return a | depsOf(v.second); }); } template static constexpr Dependency collectDependencies(const std::unordered_map& container) { return std::accumulate(container.begin(), container.end(), Dependency::None, [](auto a, const auto& kv) { return a | depsOf(kv.second); }); } private: Kind kind; type::Type type; }; } // namespace expression } // namespace style namespace util { std::string toString(style::expression::Dependency); } // namespace util std::ostream& operator<<(std::ostream&, style::expression::Dependency); } // namespace mbgl