#pragma once

#include "envoy/common/pure.h"

#include "source/common/protobuf/protobuf.h"

#include "absl/types/span.h"

namespace Envoy {

namespace ProtobufMessage {

class ConstProtoVisitor {

public:

  // Invoked when a field is visited, with the message, and field descriptor.

  virtual void onField(const Protobuf::Message&, const Protobuf::FieldDescriptor&) PURE;

  // Invoked when a message is visited, with the message and visited parents.

  // @param was_any_or_top_level supplies whether the message was either the top level message or an

  //                             Any before being unpacked for further recursion. The latter can

  //                             only be achieved by using recurse_into_any.

  // @return a status indicating if the message was validated successfully.

  virtual absl::Status onMessage(const Protobuf::Message&,

                                 absl::Span<const Protobuf::Message* const>,

                                 bool was_any_or_top_level) PURE;

};

absl::Status traverseMessage(ConstProtoVisitor& visitor, const Protobuf::Message& message,

                             bool recurse_into_any);

} // namespace ProtobufMessage

} // namespace Envoy