WireReader.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_IDL_WIREREADER_H
#define YARP_OS_IDL_WIREREADER_H
 
#include <yarp/conf/numeric.h>
 
#include <yarp/os/Bottle.h>
#include <yarp/os/NullConnectionReader.h>
#include <yarp/os/NullConnectionWriter.h>
#include <yarp/os/Vocab.h>
#include <yarp/os/idl/WirePortable.h>
#include <yarp/os/idl/WireState.h>
 
#include <string>
 
namespace yarp::os::idl {
 
class YARP_os_API WireReader
{
public:
    WireReader(ConnectionReader& reader);
 
    ~WireReader();
 
    void expectAccept();
 
    void accept();
 
    void allowGetMode();
 
    bool clear();
 
    void fail();
 
    bool read(WirePortable& obj);
 
    bool read(yarp::os::PortReader& obj);
 
    bool readNested(WirePortable& obj);
 
    bool readNested(yarp::os::PortReader& obj);
 
    bool readBool(bool& x);
 
    bool readI8(std::int8_t& x);
 
    bool readI16(std::int16_t& x);
 
    bool readI32(std::int32_t& x);
 
    bool readI64(std::int64_t& x);
 
    bool readFloat32(yarp::conf::float32_t& x);
 
    bool readFloat64(yarp::conf::float64_t& x);
 
    bool readUI8(std::uint8_t& x);
 
    bool readUI16(std::uint16_t& x);
 
    bool readUI32(std::uint32_t& x);
 
    bool readUI64(std::uint64_t& x);
 
    bool readVocab32(yarp::conf::vocab32_t& x);
 
    bool readVocab64(yarp::conf::vocab64_t& x);
 
    bool readSizeT(std::size_t& x);
 
    std::int8_t expectInt8()
    {
        std::int8_t x;
        readI8(x);
        return x;
    }
    std::int16_t expectInt16()
    {
        std::int16_t x;
        readI16(x);
        return x;
    }
    std::int32_t expectInt32()
    {
        std::int32_t x;
        readI32(x);
        return x;
    }
 
    std::int64_t expectInt64()
    {
        std::int64_t x;
        readI64(x);
        return x;
    }
 
    yarp::conf::float32_t expectFloat32()
    {
        yarp::conf::float32_t x;
        readFloat32(x);
        return x;
    }
 
    yarp::conf::float64_t expectFloat64()
    {
        yarp::conf::float64_t x;
        readFloat64(x);
        return x;
    }
 
    bool readString(std::string& str, bool* is_vocab = nullptr);
 
    bool readBlock(char* const data, size_t len);
 
    bool readBinary(std::string& str);
 
    template <typename EnumBase, typename ConverterType>
    bool readEnum(EnumBase& x)
    {
        std::int32_t tag = state->code;
        if (tag < 0) {
            if (noMore()) {
                return false;
            }
            tag = reader.expectInt32();
        }
        if (noMore()) {
            return false;
        }
        switch(tag) {
        case BOTTLE_TAG_INT8:
            x = static_cast<EnumBase>(reader.expectInt8());
            state->len--;
            return !reader.isError();
        case BOTTLE_TAG_INT16:
            x = static_cast<EnumBase>(reader.expectInt16());
            state->len--;
            return !reader.isError();
        case BOTTLE_TAG_INT32: [[fallthrough]];
        case BOTTLE_TAG_VOCAB32:
            x = static_cast<EnumBase>(reader.expectInt32());
            state->len--;
            return !reader.isError();
        case BOTTLE_TAG_INT64: [[fallthrough]];
        case BOTTLE_TAG_VOCAB64:
            x = static_cast<EnumBase>(reader.expectInt64());
            state->len--;
            return !reader.isError();
        case BOTTLE_TAG_STRING: {
            std::int32_t len = reader.expectInt32();
            if (reader.isError() || len < 1 || noMore()) {
                return false;
            }
            std::string str;
            str.resize(len);
            reader.expectBlock(const_cast<char*>(str.data()), len);
            str.resize(len - 1);
            state->len--;
            if (reader.isError()) {
                return false;
            }
            x = ConverterType::fromString(str);
            return (x >= 0);
        }}
        return false;
    }
 
    bool readListHeader();
 
    bool readListHeader(int len);
 
    bool readListReturn();
 
    int getLength() const
    {
        return state->len;
    }
 
    ConnectionReader& getReader();
 
    ConnectionWriter& getWriter();
 
    bool isValid();
 
    bool isError();
 
    std::string readTag(size_t len = static_cast<size_t>(-1));
 
    void readListBegin(yarp::os::idl::WireState& nstate, size_t& len);
 
    void readSetBegin(yarp::os::idl::WireState& nstate, size_t& len);
 
    void readMapBegin(yarp::os::idl::WireState& nstate, yarp::os::idl::WireState& nstate2, size_t& len);
 
    void readListEnd();
 
    void readSetEnd();
 
    void readMapEnd();
 
    bool noMore();
 
    bool getMode() const;
 
    bool getIsVocab32() const;
 
    const std::string& getString() const;
 
private:
    NullConnectionWriter null_writer;
    ConnectionReader& reader;
    WireState baseState;
    WireState* state {&baseState};
    bool flush_if_needed {false};
    bool support_get_mode {false};
    bool expecting {false};
    bool get_is_vocab32 {false};
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) get_string;
    bool get_mode {false};
 
 
    void scanString(std::string& str, bool is_vocab);
};
 
} // namespace yarp::os::idl
 
 
#endif // YARP_OS_IDL_WIREREADER_H