sdk/lib/fidl/cpp/encoder.h

// Copyright 2018 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIB_FIDL_CPP_ENCODER_H_
#define LIB_FIDL_CPP_ENCODER_H_

#include <lib/fidl/cpp/message.h>
#include <lib/fidl/cpp/transaction_header.h>
#include <lib/fidl/internal.h>

#ifdef __Fuchsia__
#include <lib/zx/object.h>
#endif

#include <zircon/fidl.h>

#include <atomic>
#include <vector>

namespace fidl {

class Encoder {
 public:
  Encoder() = default;
  explicit Encoder(internal::WireFormatVersion wire_format);

  Encoder(Encoder&&) noexcept = default;
  Encoder& operator=(Encoder&&) noexcept = default;

  ~Encoder() = default;

  size_t Alloc(size_t size);

  template <typename T>
  T* GetPtr(size_t offset) {
    return reinterpret_cast<T*>(bytes_.data() + offset);
  }

  template <typename T>
  const T* GetPtr(size_t offset) const {
    return reinterpret_cast<const T*>(bytes_.data() + offset);
  }

#ifdef __Fuchsia__
  void EncodeHandle(zx::object_base* value, zx_obj_type_t obj_type, zx_rights_t rights,
                    size_t offset);

  // Add a handle to the encoder's handles without encoding it into the bytes.
  // This is used to re-encode unknown handles, since their "encoded form" is
  // already in the unknown bytes somewhere.
  void EncodeUnknownHandle(zx::object_base* value);
#endif

  size_t CurrentLength() const { return bytes_.size(); }

  size_t CurrentHandleCount() const { return handles_.size(); }

  std::vector<uint8_t> TakeBytes() { return std::move(bytes_); }

  internal::WireFormatVersion wire_format() { return wire_format_; }

 protected:
  std::vector<uint8_t> bytes_;
  std::vector<zx_handle_disposition_t> handles_;
  internal::WireFormatVersion wire_format_ = internal::WireFormatVersion::kV2;
};

// The MessageEncoder produces an |HLCPPOutgoingMessage|, representing a transactional message.
class MessageEncoder final : public Encoder {
 public:
  explicit MessageEncoder(uint64_t ordinal, MessageDynamicFlags dynamic_flags);
  MessageEncoder(uint64_t ordinal, MessageDynamicFlags dynamic_flags,
                 internal::WireFormatVersion wire_format);

  MessageEncoder(MessageEncoder&&) noexcept = default;
  MessageEncoder& operator=(MessageEncoder&&) noexcept = default;

  ~MessageEncoder() = default;

  HLCPPOutgoingMessage GetMessage();
  void Reset(uint64_t ordinal, MessageDynamicFlags dynamic_flags);

 private:
  void EncodeMessageHeader(uint64_t ordinal, MessageDynamicFlags dynamic_flags);
};

// The BodyEncoder produces an |HLCPPOutgoingBody|, representing a transactional message body.
class BodyEncoder final : public Encoder {
 public:
  explicit BodyEncoder(internal::WireFormatVersion wire_format) : Encoder(wire_format) {}

  BodyEncoder(BodyEncoder&&) noexcept = default;
  BodyEncoder& operator=(BodyEncoder&&) noexcept = default;

  ~BodyEncoder() = default;

  HLCPPOutgoingBody GetBody();
  void Reset();
};

}  // namespace fidl

#endif  // LIB_FIDL_CPP_ENCODER_H_