field_codec_message_stack.h

// Copyright 2014-2023:
//   GobySoft, LLC (2013-)
//   Massachusetts Institute of Technology (2007-2014)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//
//
// This file is part of the Dynamic Compact Control Language Library
// ("DCCL").
//
// DCCL is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// DCCL is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DCCL.  If not, see <http://www.gnu.org/licenses/>.
#ifndef DCCLFIELDCODECHELPERS20110825H
#define DCCLFIELDCODECHELPERS20110825H
 
#include "../common.h"
 
namespace dccl
{
class FieldCodecBase;
enum MessagePart
{
    HEAD,
    BODY,
    UNKNOWN
};
 
namespace internal
{
struct MessageStackData
{
    const google::protobuf::Descriptor* top_descriptor() const
    {
        return !desc.empty() ? desc.back() : nullptr;
    }
    const google::protobuf::Message* top_message() const
    {
        return !messages.empty() ? messages.back().msg : nullptr;
    }
    const google::protobuf::FieldDescriptor* top_field() const
    {
        return !field.empty() ? field.back() : nullptr;
    }
    MessagePart current_part() const { return parts.empty() ? UNKNOWN : parts.back(); }
 
    std::vector<const google::protobuf::Descriptor*> desc;
    std::vector<const google::protobuf::FieldDescriptor*> field;
    std::vector<MessagePart> parts;
    struct MessageAndField
    {
        // latest depth of message
        const google::protobuf::Message* msg;
        // field corresponding to this message (or nullptr for the first)
        const google::protobuf::FieldDescriptor* field{nullptr};
    };
    std::vector<MessageAndField> messages;
};
 
bool has_head_field(const google::protobuf::Descriptor* desc);
 
//RAII handler for the current Message recursion stack
class MessageStack
{
  public:
    MessageStack(const google::protobuf::Message* root_message, MessageStackData& data,
                 const google::protobuf::FieldDescriptor* field = nullptr);
 
    ~MessageStack();
 
    bool first() const { return data_.desc.empty(); }
    int count() const { return data_.desc.size(); }
 
    void push(const google::protobuf::Descriptor* desc);
    void push(const google::protobuf::FieldDescriptor* field);
    void push(MessagePart part);
 
    void update_index(const google::protobuf::Message* root_message,
                      const google::protobuf::FieldDescriptor* field, int index);
    void push_message(const google::protobuf::Message* root_message,
                      const google::protobuf::FieldDescriptor* field, int index = -1);
 
    std::size_t field_size() const { return data_.field.size(); }
    MessagePart current_part() const { return data_.current_part(); }
 
  private:
    void __pop_desc();
    void __pop_field();
    void __pop_parts();
    void __pop_messages();
 
    MessageStackData& data_;
 
    int descriptors_pushed_;
    int fields_pushed_;
    int parts_pushed_;
    int messages_pushed_;
};
} // namespace internal
} // namespace dccl
 
#endif