variantiterator.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later OR BSD-3-Clause
/***************************************************************************
 *   Copyright (C) 2020 by Robert Middleton                                *
 *   robert.middleton@rm5248.com                                           *
 *                                                                         *
 *   This file is part of the dbus-cxx library.                            *
 ***************************************************************************/
#ifndef DBUSCXX_VARIANT_ITERATOR_H
#define DBUSCXX_VARIANT_ITERATOR_H
 
#include <string>
#include <memory>
#include <dbus-cxx/types.h>
#include <dbus-cxx/error.h>
#include <dbus-cxx/signatureiterator.h>
 
namespace DBus {
 
class Variant;
class Demarshaling;
 
namespace priv {
 
class VariantIterator {
private:
    VariantIterator( DataType d,
        SignatureIterator sig,
        const Variant* variant,
        std::shared_ptr<Demarshaling> demarshal );
 
public:
 
    VariantIterator();
 
    VariantIterator( const Variant* variant );
 
    VariantIterator& operator>>( Variant& v );
 
    template <typename T>
    VariantIterator& operator>>( T& v ) {
        v = static_cast<T>( *this );
        this->next();
        return *this;
    }
 
    operator bool();
    operator uint8_t();
    operator uint16_t();
    operator int16_t();
    operator uint32_t();
    operator int32_t();
    operator uint64_t();
    operator int64_t();
    operator double();
    operator std::string();
    operator DBus::Variant();
 
    template <typename T>
    operator std::vector<T>() {
        if( !is_array() ) {
            throw ErrorInvalidTypecast( "VariantIterator: Extracting non array into std::vector" );
        }
 
        std::vector<T> retval;
        VariantIterator subiter = this->recurse();
 
        while( subiter.is_valid() ) {
            //NOTE: we don't need to do subiter.next() here, because
            //operator>> does that for us
            T val;
            subiter >> val;
            retval.push_back( val );
        }
 
        return retval;
    }
 
    template <typename Key, typename Data>
    operator std::map<Key, Data>() {
        if( !this->is_dict() ) {
            throw ErrorInvalidTypecast( "VariantIterator: Extracting non dict into std::map" );
        }
 
        std::map<Key, Data> dict;
        Key val_key;
        Data val_data;
 
        VariantIterator subiter = this->recurse();
 
        while( subiter.is_valid() ) {
            VariantIterator subSubiter = subiter.recurse();
 
            while( subSubiter.is_valid() ) {
                subSubiter >> val_key;
                subSubiter >> val_data;
                dict[ val_key ] = val_data;
                subSubiter.next();
            }
 
            subiter.next();
        }
 
        return dict;
    }
 
    template <typename ...T>
    operator std::tuple<T...>() {
        std::tuple<T...> tup;
 
        VariantIterator subiter = this->recurse();
        std::apply( [subiter]( auto&& ...arg ) mutable {
            ( subiter >> ... >> arg );
        },
        tup );
 
        return tup;
    }
 
    bool        get_bool();
    uint8_t     get_uint8();
    uint16_t    get_uint16();
    int16_t     get_int16();
    uint32_t    get_uint32();
    int32_t     get_int32();
    uint64_t    get_uint64();
    int64_t     get_int64();
    double      get_double();
    std::string get_string();
    Variant get_variant();
    Signature get_signature();
 
    void invalidate();
 
    bool is_valid() const;
 
    bool has_next() const;
 
    bool next();
 
    DataType arg_type() const;
 
    DataType element_type() const;
 
    VariantIterator& operator ++();
 
    VariantIterator operator ++( int );
 
    VariantIterator recurse();
 
    bool is_fixed() const;
 
    bool is_container() const;
 
    bool is_array() const;
 
    bool is_dict() const;
 
private:
    class priv_data;
 
    std::shared_ptr<priv_data> m_priv;
};
 
} /* namespace priv */
 
} /* namespace DBus */
 
#endif /* DBUS_CXX_VARIANT_ITERATOR_H */