variant_array_view.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014, 2015 - 2016 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_ARRAY_H_
#define RTTR_VARIANT_ARRAY_H_

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

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

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

namespace detail
{
    class array_wrapper_base;
}

class RTTR_API variant_array_view
{
    public:
        variant_array_view();

        variant_array_view(const variant_array_view& other);

        variant_array_view(variant_array_view&& other);

        ~variant_array_view();

        variant_array_view& operator=(const variant_array_view& other);

        bool is_valid() const;

        explicit operator bool() const;

        void swap(variant_array_view& other);
       

        bool is_dynamic() const;

        std::size_t get_rank() const;

        type get_rank_type(std::size_t index) const;
        
        type get_type() const;

        std::size_t get_size() const;

        std::size_t get_size(std::size_t index_1) const;

        std::size_t get_size(std::size_t index_1, std::size_t index_2) const;

        std::size_t get_size_variadic(const std::vector<std::size_t>& index_list) const;
        
        bool set_size(std::size_t new_size);

        bool set_size(std::size_t new_size, std::size_t index_1);

        bool set_size(std::size_t new_size, std::size_t index_1, std::size_t index_2);

        bool set_size_variadic(std::size_t new_size, const std::vector<std::size_t>& index_list);

        bool set_value(argument arg);
        
        bool set_value(std::size_t index_1, argument arg);

        bool set_value(std::size_t index_1, std::size_t index_2, argument arg);

        bool set_value(std::size_t index_1, std::size_t index_2, std::size_t index_3, argument arg);

        bool set_value_variadic(const std::vector<std::size_t>& index_list, argument arg);


        variant get_value(std::size_t index_1) const;

        variant get_value(std::size_t index_1, std::size_t index_2) const;

        variant get_value(std::size_t index_1, std::size_t index_2, std::size_t index_3) const;

        variant get_value_variadic(const std::vector<std::size_t>& index_list) const;

        bool insert_value(std::size_t index_1, argument arg);

        bool insert_value(std::size_t index_1, std::size_t index_2, argument arg);

        bool insert_value(std::size_t index_1, std::size_t index_2, std::size_t index_3, argument arg);

        bool insert_value_variadic(const std::vector<std::size_t>& index_list, argument arg);

        bool remove_value(std::size_t index_1);

        bool remove_value(std::size_t index_1, std::size_t index_2);

        bool remove_value(std::size_t index_1, std::size_t index_2, std::size_t index_3);

        bool remove_value_variadic(const std::vector<std::size_t>& index_list);

    private:
        friend class variant;
        friend class argument;

        std::unique_ptr<detail::array_wrapper_base> m_array_wrapper;
};

} // end namespace rttr

#include "rttr/detail/variant_array_view/variant_array_view_impl.h"

#endif // RTTR_VARIANT_ARRAY_H_