evaluator_instruction.h

#ifndef SOURCEMETA_BLAZE_EVALUATOR_TEMPLATE_H
#define SOURCEMETA_BLAZE_EVALUATOR_TEMPLATE_H
 
#ifndef SOURCEMETA_BLAZE_EVALUATOR_EXPORT
#include <sourcemeta/blaze/evaluator_export.h>
#endif
 
#include <sourcemeta/blaze/evaluator_value.h>
 
#include <sourcemeta/core/jsonpointer.h>
 
#include <cstdint>     // std::uint8_t
#include <string>      // std::string
#include <string_view> // std::string_view
#include <vector>      // std::vector
 
namespace sourcemeta::blaze {
 
// For fast internal instruction dispatching. It must stay
// in sync with the variant ordering above
enum class InstructionIndex : std::uint8_t {
  AssertionFail = 0,
  AssertionDefines,
  AssertionDefinesStrict,
  AssertionDefinesAll,
  AssertionDefinesAllStrict,
  AssertionDefinesExactly,
  AssertionDefinesExactlyStrict,
  AssertionDefinesExactlyStrictHash3,
  AssertionPropertyDependencies,
  AssertionType,
  AssertionTypeAny,
  AssertionTypeStrict,
  AssertionTypeStrictAny,
  AssertionNotTypeStrictAny,
  AssertionTypeStringBounded,
  AssertionTypeStringUpper,
  AssertionTypeArrayBounded,
  AssertionTypeArrayUpper,
  AssertionTypeObjectBounded,
  AssertionTypeObjectUpper,
  AssertionRegex,
  AssertionStringSizeLess,
  AssertionStringSizeGreater,
  AssertionArraySizeLess,
  AssertionArraySizeGreater,
  AssertionObjectSizeLess,
  AssertionObjectSizeGreater,
  AssertionEqual,
  AssertionEqualsAny,
  AssertionEqualsAnyStringHash,
  AssertionGreaterEqual,
  AssertionLessEqual,
  AssertionGreater,
  AssertionLess,
  AssertionUnique,
  AssertionDivisible,
  AssertionTypeIntegerBounded,
  AssertionTypeIntegerBoundedStrict,
  AssertionTypeIntegerLowerBound,
  AssertionTypeIntegerLowerBoundStrict,
  AssertionNumberIntegerBounded,
  AssertionNumberType,
  AssertionStringType,
  AssertionPropertyType,
  AssertionPropertyTypeEvaluate,
  AssertionPropertyTypeStrict,
  AssertionPropertyTypeStrictEvaluate,
  AssertionPropertyTypeStrictAny,
  AssertionPropertyTypeStrictAnyEvaluate,
  AssertionPropertyEqual,
  AssertionArrayPrefix,
  AssertionArrayPrefixEvaluate,
  AssertionObjectPropertiesSimple,
  AnnotationEmit,
  AnnotationEmitWrapped,
  AnnotationToParent,
  AnnotationBasenameToParent,
  Evaluate,
  LogicalNot,
  LogicalNotEvaluate,
  LogicalOr,
  LogicalAnd,
  LogicalXor,
  LogicalCondition,
  LogicalWhenType,
  LogicalWhenDefines,
  LogicalWhenArraySizeGreater,
  LoopPropertiesUnevaluated,
  LoopPropertiesUnevaluatedExcept,
  LoopPropertiesMatch,
  LoopPropertiesMatchClosed,
  LoopProperties,
  LoopPropertiesEvaluate,
  LoopPropertiesRegex,
  LoopPropertiesRegexClosed,
  LoopPropertiesStartsWith,
  LoopPropertiesExcept,
  LoopPropertiesType,
  LoopPropertiesTypeEvaluate,
  LoopPropertiesExactlyTypeStrict,
  LoopPropertiesExactlyTypeStrictHash,
  LoopPropertiesTypeStrict,
  LoopPropertiesTypeStrictEvaluate,
  LoopPropertiesTypeStrictAny,
  LoopPropertiesTypeStrictAnyEvaluate,
  LoopKeys,
  LoopItems,
  LoopItemsFrom,
  LoopItemsUnevaluated,
  LoopItemsType,
  LoopItemsTypeStrict,
  LoopItemsTypeStrictAny,
  LoopItemsPropertiesExactlyTypeStrictHash,
  LoopItemsPropertiesExactlyTypeStrictHash3,
  LoopItemsIntegerBounded,
  LoopItemsIntegerBoundedSized,
  LoopItemsArrayBoundedTypeStrictAny,
  LoopContains,
  ControlGroup,
  ControlGroupWhenDefines,
  ControlGroupWhenDefinesDirect,
  ControlGroupWhenType,
  ControlEvaluate,
  ControlDynamicAnchorJump,
  ControlJump
};

// NOLINTNEXTLINE(modernize-avoid-c-arrays)
constexpr std::string_view INSTRUCTION_NAMES[] = {
    "AssertionFail",
    "AssertionDefines",
    "AssertionDefinesStrict",
    "AssertionDefinesAll",
    "AssertionDefinesAllStrict",
    "AssertionDefinesExactly",
    "AssertionDefinesExactlyStrict",
    "AssertionDefinesExactlyStrictHash3",
    "AssertionPropertyDependencies",
    "AssertionType",
    "AssertionTypeAny",
    "AssertionTypeStrict",
    "AssertionTypeStrictAny",
    "AssertionNotTypeStrictAny",
    "AssertionTypeStringBounded",
    "AssertionTypeStringUpper",
    "AssertionTypeArrayBounded",
    "AssertionTypeArrayUpper",
    "AssertionTypeObjectBounded",
    "AssertionTypeObjectUpper",
    "AssertionRegex",
    "AssertionStringSizeLess",
    "AssertionStringSizeGreater",
    "AssertionArraySizeLess",
    "AssertionArraySizeGreater",
    "AssertionObjectSizeLess",
    "AssertionObjectSizeGreater",
    "AssertionEqual",
    "AssertionEqualsAny",
    "AssertionEqualsAnyStringHash",
    "AssertionGreaterEqual",
    "AssertionLessEqual",
    "AssertionGreater",
    "AssertionLess",
    "AssertionUnique",
    "AssertionDivisible",
    "AssertionTypeIntegerBounded",
    "AssertionTypeIntegerBoundedStrict",
    "AssertionTypeIntegerLowerBound",
    "AssertionTypeIntegerLowerBoundStrict",
    "AssertionNumberIntegerBounded",
    "AssertionNumberType",
    "AssertionStringType",
    "AssertionPropertyType",
    "AssertionPropertyTypeEvaluate",
    "AssertionPropertyTypeStrict",
    "AssertionPropertyTypeStrictEvaluate",
    "AssertionPropertyTypeStrictAny",
    "AssertionPropertyTypeStrictAnyEvaluate",
    "AssertionPropertyEqual",
    "AssertionArrayPrefix",
    "AssertionArrayPrefixEvaluate",
    "AssertionObjectPropertiesSimple",
    "AnnotationEmit",
    "AnnotationEmitWrapped",
    "AnnotationToParent",
    "AnnotationBasenameToParent",
    "Evaluate",
    "LogicalNot",
    "LogicalNotEvaluate",
    "LogicalOr",
    "LogicalAnd",
    "LogicalXor",
    "LogicalCondition",
    "LogicalWhenType",
    "LogicalWhenDefines",
    "LogicalWhenArraySizeGreater",
    "LoopPropertiesUnevaluated",
    "LoopPropertiesUnevaluatedExcept",
    "LoopPropertiesMatch",
    "LoopPropertiesMatchClosed",
    "LoopProperties",
    "LoopPropertiesEvaluate",
    "LoopPropertiesRegex",
    "LoopPropertiesRegexClosed",
    "LoopPropertiesStartsWith",
    "LoopPropertiesExcept",
    "LoopPropertiesType",
    "LoopPropertiesTypeEvaluate",
    "LoopPropertiesExactlyTypeStrict",
    "LoopPropertiesExactlyTypeStrictHash",
    "LoopPropertiesTypeStrict",
    "LoopPropertiesTypeStrictEvaluate",
    "LoopPropertiesTypeStrictAny",
    "LoopPropertiesTypeStrictAnyEvaluate",
    "LoopKeys",
    "LoopItems",
    "LoopItemsFrom",
    "LoopItemsUnevaluated",
    "LoopItemsType",
    "LoopItemsTypeStrict",
    "LoopItemsTypeStrictAny",
    "LoopItemsPropertiesExactlyTypeStrictHash",
    "LoopItemsPropertiesExactlyTypeStrictHash3",
    "LoopItemsIntegerBounded",
    "LoopItemsIntegerBoundedSized",
    "LoopItemsArrayBoundedTypeStrictAny",
    "LoopContains",
    "ControlGroup",
    "ControlGroupWhenDefines",
    "ControlGroupWhenDefinesDirect",
    "ControlGroupWhenType",
    "ControlEvaluate",
    "ControlDynamicAnchorJump",
    "ControlJump"};

inline auto is_annotation(const InstructionIndex type) noexcept -> bool {
  switch (type) {
    // NOLINTNEXTLINE(bugprone-branch-clone)
    case InstructionIndex::AnnotationBasenameToParent:
      return true;
    case InstructionIndex::AnnotationToParent:
      return true;
    case InstructionIndex::AnnotationEmit:
      return true;
    case InstructionIndex::AnnotationEmitWrapped:
      return true;
    default:
      return false;
  }
}

inline auto is_wrapped_annotation(const InstructionIndex type) noexcept
    -> bool {
  switch (type) {
    case InstructionIndex::AnnotationBasenameToParent:
    case InstructionIndex::AnnotationEmitWrapped:
      return true;
    default:
      return false;
  }
}
 
// Forward declaration for defining a circular structure
#ifndef DOXYGEN
struct Instruction;
#endif
 
// Forward declaration, as the template is defined in terms of this header
#ifndef DOXYGEN
struct Template;
#endif

using Instructions = std::vector<Instruction>;

struct InstructionExtra {
  sourcemeta::core::Pointer relative_schema_location;
  std::string keyword_location;
  std::size_t schema_resource;
  std::size_t vocabulary;
  std::size_t message;
  std::size_t message_detail;
};

// NOLINTNEXTLINE(bugprone-exception-escape)
struct Instruction {
  InstructionIndex type;
  sourcemeta::core::Pointer relative_instance_location;
  Value value;
  Instructions children;
  std::size_t extra_index;
};

auto SOURCEMETA_BLAZE_EVALUATOR_EXPORT describe(
    const Template &schema_template, const bool valid, const Instruction &step,
    const sourcemeta::core::WeakPointer &evaluate_path,
    const sourcemeta::core::WeakPointer &instance_location,
    const sourcemeta::core::JSON &instance,
    const sourcemeta::core::JSON &annotation) -> std::string;
 
} // namespace sourcemeta::blaze
 
#endif