output_trace.h

#ifndef SOURCEMETA_BLAZE_OUTPUT_TRACE_H_
#define SOURCEMETA_BLAZE_OUTPUT_TRACE_H_
 
#ifndef SOURCEMETA_BLAZE_OUTPUT_EXPORT
#include <sourcemeta/blaze/output_export.h>
#endif
 
#include <sourcemeta/blaze/evaluator.h>
#include <sourcemeta/core/jsonschema.h>
 
#include <sourcemeta/core/json.h>
#include <sourcemeta/core/jsonpointer.h>
 
#include <cstdint>     // std::uint8_t
#include <functional>  // std::function, std::reference_wrapper
#include <optional>    // std::optional, std::nullopt
#include <string_view> // std::string_view
#include <utility>     // std::pair
 
namespace sourcemeta::blaze {

class SOURCEMETA_BLAZE_OUTPUT_EXPORT TraceOutput {
public:
  enum class EntryType : std::uint8_t { Push, Pass, Fail, Annotation };
 
  // NOLINTNEXTLINE(bugprone-exception-escape)
  struct Entry {
    // NOLINTBEGIN(cppcoreguidelines-avoid-const-or-ref-data-members)
    const EntryType type;
    const std::string_view name;
    const Instruction &step;
    const sourcemeta::core::WeakPointer &instance_location;
    const sourcemeta::core::WeakPointer &evaluate_path;
    const std::string_view keyword_location;
    const sourcemeta::core::JSON &annotation;
    const std::optional<std::string_view> vocabulary;
    // NOLINTEND(cppcoreguidelines-avoid-const-or-ref-data-members)
  };
 
  // TODO(C++23): Use std::move_only_function when available in libc++
  using Callback = std::function<void(const Entry &)>;
 
  TraceOutput(const Template &schema_template, Callback callback,
              sourcemeta::core::WeakPointer base =
                  sourcemeta::core::EMPTY_WEAK_POINTER);
 
  // Prevent accidental copies
  TraceOutput(const TraceOutput &) = delete;
  auto operator=(const TraceOutput &) -> TraceOutput & = delete;
 
  auto operator()(const EvaluationType type, const bool result,
                  const Instruction &step,
                  const InstructionExtra &step_metadata,
                  const sourcemeta::core::WeakPointer &evaluate_path,
                  const sourcemeta::core::WeakPointer &instance_location,
                  const sourcemeta::core::JSON &annotation) -> void;
 
private:
// Exporting symbols that depends on the standard C++ library is considered
// safe.
// https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-2-c4275?view=msvc-170&redirectedfrom=MSDN
#if defined(_MSC_VER)
#pragma warning(disable : 4251)
#endif
  const Template &schema_template_;
  const sourcemeta::core::WeakPointer base_;
  Callback callback_;
#if defined(_MSC_VER)
#pragma warning(default : 4251)
#endif
};
 
} // namespace sourcemeta::blaze
 
#endif