library.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_LIBRARY_H_
#define RTTR_LIBRARY_H_

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

#include "rttr/type.h"

#include <memory>

namespace rttr
{
namespace detail
{
class library_private;
} // end namespace detail

class RTTR_API library
{
public:

    library(string_view file_name, string_view version = string_view());

    ~library();

    library(const library&) = delete;
    library& operator=(const library&) = delete;

     bool load();

     bool unload();

     bool is_loaded() const RTTR_NOEXCEPT;

     string_view get_file_name() const RTTR_NOEXCEPT;

     string_view get_error_string() const RTTR_NOEXCEPT;

     array_range<type> get_types() const RTTR_NOEXCEPT;

     array_range<property> get_global_properties() const RTTR_NOEXCEPT;

     array_range<method> get_global_methods() const RTTR_NOEXCEPT;

private:
    std::shared_ptr<detail::library_private> m_pimpl;
    bool                                     m_is_loaded;
};

} // end namespace rttr

#endif  // RTTR_LIBRARY_H_