BottleImpl.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-FileCopyrightText: 2006, 2008 Arjan Gijsberts
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_IMPL_BOTTLEIMPL_H
#define YARP_OS_IMPL_BOTTLEIMPL_H
 
#include <yarp/os/Bytes.h>
#include <yarp/os/impl/Storable.h>
 
#include <vector>
 
namespace yarp::os {
 
class Bottle;
class Property;
class ConnectionReader;
class ConnectionWriter;
 
} // namespace yarp::os
 
namespace yarp::os::impl {
 
 
class YARP_os_impl_API BottleImpl
{
public:
    using size_type = size_t;
    static constexpr size_type npos = static_cast<size_type>(-1);
 
    BottleImpl();
    BottleImpl(Searchable* parent);
    virtual ~BottleImpl();
 
    Searchable* parent;
 
    bool isInt8(int index);
    bool isInt16(int index);
    bool isInt32(int index);
    bool isInt64(int index);
    bool isFloat32(int index);
    bool isFloat64(int index);
    bool isString(int index);
    bool isList(int index);
 
    Storable* pop();
 
    Storable& get(size_type index) const;
 
    void addInt8(std::int8_t x)
    {
        add(new StoreInt8(x));
    }
 
    void addInt16(std::int16_t x)
    {
        add(new StoreInt16(x));
    }
 
    void addInt32(std::int32_t x)
    {
        add(new StoreInt32(x));
    }
 
    void addInt64(std::int64_t x)
    {
        add(new StoreInt64(x));
    }
 
    void addFloat32(yarp::conf::float32_t x)
    {
        add(new StoreFloat32(x));
    }
 
    void addFloat64(yarp::conf::float64_t x)
    {
        add(new StoreFloat64(x));
    }
 
    void addVocab32(yarp::conf::vocab32_t x)
    {
        add(new StoreVocab32(x));
    }
 
    void addVocab64(yarp::conf::vocab64_t x)
    {
        add(new StoreVocab64(x));
    }
 
    void addString(const std::string& text)
    {
        add(new StoreString(text));
    }
 
    yarp::os::Bottle& addList();
 
    yarp::os::Property& addDict();
 
    void clear();
 
    void fromString(const std::string& line);
    std::string toString() const;
    size_type size() const;
 
    bool read(ConnectionReader& reader);
    bool write(ConnectionWriter& writer) const;
 
    void onCommencement();
 
    const char* getBytes() const;
    size_t byteCount() const;
 
    void copyRange(const BottleImpl* alt, size_type first = 0, size_type len = npos);
 
    bool fromBytes(const yarp::os::Bytes& data);
    void toBytes(yarp::os::Bytes& data);
 
    bool fromBytes(yarp::os::ConnectionReader& reader);
 
    void fromBinary(const char* text, size_t len);
 
    void specialize(std::int32_t subCode);
    int getSpecialization();
    void setNested(bool nested);
 
    std::int32_t subCode();
 
    void addBit(yarp::os::Value* bit)
    {
        // all Values are Storables -- important invariant!
        add((Storable*)(bit));
    }
 
    void addBit(const yarp::os::Value& bit)
    {
        // all Values are Storables -- important invariant!
        if (!bit.isNull()) {
            add((Storable*)(bit.clone()));
        }
    }
 
    yarp::os::Value& addBit(const char* str)
    {
        size_type len = size();
        std::string x(str);
        smartAdd(x);
        if (size() > len) {
            return get((int)size() - 1);
        }
        return get(-1);
    }
 
    static StoreNull& getNull()
    {
        static StoreNull storeNull;
        return storeNull;
    }
 
    // check if a piece of text is a completed bottle
    static bool isComplete(const char* txt);
 
    void hasChanged()
    {
        dirty = true;
    }
 
    bool checkIndex(size_type index) const;
 
    bool invalid;
    bool ro;
 
    void edit();
 
    Value& findGroupBit(const std::string& key) const;
    Value& findBit(const std::string& key) const;
 
private:
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::vector<Storable*>) content;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::vector<char>) data;
    int speciality;
    bool nested;
    bool dirty;
 
    void add(Storable* s);
    void smartAdd(const std::string& str);
 
    /*
     * Bottle is using a lazy synchronization method. Whenever some operation
     * is performed, a dirty flag is set, and when it is used, the synch()
     * method is called.
     *
     * The const version of the synch() method performs a const_cast, and
     * calls the non-const version. This allows to call it in const methods.
     * Conceptually this is not completely wrong because it does not modify
     * the external state of the class, but just some internal representation.
     */
    void synch();
    void synch() const;
};
 
} // namespace yarp::os::impl
 
 
#endif // YARP_OS_IMPL_BOTTLEIMPL_H