variant_associative_view.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014 - 2018 Axel Menzel <info@rttr.org>                           *
*                                                                                   *
*   This file is part of RTTR (Run Time Type Reflection)                            *
*   License: MIT License                                                            *
*                                                                                   *
*   Permission is hereby granted, free of charge, to any person obtaining           *
*   a copy of this software and associated documentation files (the "Software"),    *
*   to deal in the Software without restriction, including without limitation       *
*   the rights to use, copy, modify, merge, publish, distribute, sublicense,        *
*   and/or sell copies of the Software, and to permit persons to whom the           *
*   Software is furnished to do so, subject to the following conditions:            *
*                                                                                   *
*   The above copyright notice and this permission notice shall be included in      *
*   all copies or substantial portions of the Software.                             *
*                                                                                   *
*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR      *
*   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,        *
*   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE     *
*   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER          *
*   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,   *
*   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE   *
*   SOFTWARE.                                                                       *
*                                                                                   *
*************************************************************************************/

#ifndef RTTR_VARIANT_ASSOCIATIVE_VIEW_H_
#define RTTR_VARIANT_ASSOCIATIVE_VIEW_H_

#include "rttr/detail/base/core_prerequisites.h"
#include "rttr/detail/misc/misc_type_traits.h"
#include "rttr/variant.h"
#include "rttr/detail/variant_associative_view/variant_associative_view_private.h"

#include <cstddef>
#include <vector>
#include <memory>

namespace rttr
{
    class type;
    class instance;
    class argument;

class RTTR_API variant_associative_view
{
    public:
        class const_iterator;

        variant_associative_view();

        variant_associative_view(const variant_associative_view& other);

        ~variant_associative_view() RTTR_NOEXCEPT;

        variant_associative_view& operator=(const variant_associative_view& other) RTTR_NOEXCEPT;

        bool is_valid() const RTTR_NOEXCEPT;

        explicit operator bool() const RTTR_NOEXCEPT;

        void swap(variant_associative_view& other) RTTR_NOEXCEPT;


        type get_type() const RTTR_NOEXCEPT;

        type get_key_type() const RTTR_NOEXCEPT;

        type get_value_type() const RTTR_NOEXCEPT;

        bool is_key_only_type() const RTTR_NOEXCEPT;

        bool is_empty() const RTTR_NOEXCEPT;

        std::size_t get_size() const RTTR_NOEXCEPT;

        std::pair<const_iterator, bool> insert(argument key);

        std::pair<const_iterator, bool> insert(argument key, argument value);

        const_iterator find(argument key);

        std::size_t erase(argument key);

        void clear();

        std::pair<const_iterator, const_iterator> equal_range(argument key);

        const_iterator begin() const;

        const_iterator end() const;

        class RTTR_API const_iterator
        {
            public:
                using self_type = const_iterator;
                using value_type = variant;

                ~const_iterator();

                const_iterator(const const_iterator& other);

                const_iterator& operator=(const_iterator other);

                const std::pair<variant, variant> operator*() const;

                const variant get_key() const;

                const variant get_value() const;

                const_iterator &operator++();

                const_iterator operator++(int);

                const_iterator &operator--();

                const_iterator operator--(int);

                const_iterator &operator+=(int i);

                const_iterator &operator-=(int i);

                const_iterator operator+(int i) const;

                const_iterator operator-(int i) const;

                bool operator==(const const_iterator& other) const;

                bool operator!=(const const_iterator& other) const;

            private:
                const_iterator(const detail::variant_associative_view_private* view) RTTR_NOEXCEPT;
                void swap(const_iterator& other);

                friend class variant_associative_view;

                const detail::variant_associative_view_private* m_view;
                detail::iterator_data m_itr;
        };
    private:
        friend class variant;
        friend class argument;

        detail::variant_associative_view_private m_view;
};

} // end namespace rttr

#endif // RTTR_VARIANT_ASSOCIATIVE_VIEW_H_