property.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_PROPERTY_H_
#define RTTR_PROPERTY_H_

#include "rttr/detail/base/core_prerequisites.h"
#include "rttr/detail/misc/class_item_mapper.h"
#include "rttr/parameter_info.h"
#include "rttr/access_levels.h"
#include "rttr/string_view.h"

#include <string>

namespace rttr
{
class variant;
class type;
class enumeration;
class instance;
class argument;
class property;

namespace detail
{
    class property_wrapper_base;
}

class RTTR_API property
{
    public:
        bool is_valid() const RTTR_NOEXCEPT;

        explicit operator bool() const RTTR_NOEXCEPT;

        access_levels get_access_level() const RTTR_NOEXCEPT;

        bool is_readonly() const RTTR_NOEXCEPT;

        bool is_static() const RTTR_NOEXCEPT;

        bool is_enumeration() const RTTR_NOEXCEPT;

        enumeration get_enumeration() const RTTR_NOEXCEPT;

        string_view get_name() const RTTR_NOEXCEPT;

        type get_type() const RTTR_NOEXCEPT;

        type get_declaring_type() const RTTR_NOEXCEPT;

        bool set_value(instance object, argument arg) const;

        variant get_value(instance object) const;

        variant get_metadata(const variant& key) const;

        bool operator==(const property& other) const RTTR_NOEXCEPT;

        bool operator!=(const property& other) const RTTR_NOEXCEPT;

    private:
        property(const detail::property_wrapper_base* wrapper) RTTR_NOEXCEPT;

        template<typename T>
        friend T detail::create_item(const detail::class_item_to_wrapper_t<T>* wrapper);
        template<typename T>
        friend T detail::create_invalid_item();

    private:
        const detail::property_wrapper_base* m_wrapper;
};

} // end namespace rttr

#endif // RTTR_PROPERTY_H_