enumeration.h

Go to the documentation of this file.

/************************************************************************************
*                                                                                   *
*   Copyright (c) 2014 Axel Menzel <info@axelmenzel.de>                             *
*                                                                                   *
*   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_ENUMERATION_H__
#define __RTTR_ENUMERATION_H__

#include "rttr/base/core_prerequisites.h"
#include "rttr/type.h"

#include <memory>
#include <string>

namespace rttr
{
class type;
class Variant;

namespace detail
{
class enumeration_container_base;
class argument;
}
class RTTR_API enumeration
{
    public:
        bool is_valid() const;

        operator bool() const;

        std::string get_name() const;

        type get_underlying_type() const;

        type get_type() const;

        type get_declaring_type() const;

        variant get_metadata(int key) const;

        variant get_metadata(const std::string& key) const;

        std::vector<std::string> get_keys() const;


        std::vector<variant> get_values() const;

        std::string value_to_key(detail::argument value) const;
        
        variant key_to_value(const std::string& key) const;

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

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

    private:
        friend class type; // to prevent creation of this class
        enumeration(const detail::enumeration_container_base* container = nullptr);
    private:
        const detail::enumeration_container_base* _container;
};

} // end namespace rttr

#endif // __RTTR_ENUMERATION_H__