constructor.h
Go to the documentation of this file.
1/************************************************************************************
2* *
3* Copyright (c) 2014 - 2018 Axel Menzel <info@rttr.org> *
4* *
5* This file is part of RTTR (Run Time Type Reflection) *
6* License: MIT License *
7* *
8* Permission is hereby granted, free of charge, to any person obtaining *
9* a copy of this software and associated documentation files (the "Software"), *
10* to deal in the Software without restriction, including without limitation *
11* the rights to use, copy, modify, merge, publish, distribute, sublicense, *
12* and/or sell copies of the Software, and to permit persons to whom the *
13* Software is furnished to do so, subject to the following conditions: *
14* *
15* The above copyright notice and this permission notice shall be included in *
16* all copies or substantial portions of the Software. *
17* *
18* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
19* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
20* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
21* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
22* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
23* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *
24* SOFTWARE. *
25* *
26*************************************************************************************/
27#ifndef RTTR_CONSTRUCTOR_H_
28#define RTTR_CONSTRUCTOR_H_
29
30#include "rttr/detail/base/core_prerequisites.h"
31#include "rttr/detail/misc/class_item_mapper.h"
32
33#include "rttr/parameter_info.h"
34#include "rttr/access_levels.h"
35#include "rttr/array_range.h"
36#include "rttr/string_view.h"
37
38#include <string>
39#include <vector>
40
41namespace rttr
42{
43
44class variant;
45class type;
46class argument;
47
48namespace detail
49{
50class constructor_wrapper_base;
51}
52
88class RTTR_API constructor
89{
90 public:
96 bool is_valid() const RTTR_NOEXCEPT;
97
103 explicit operator bool() const RTTR_NOEXCEPT;
104
113 access_levels get_access_level() const RTTR_NOEXCEPT;
114
120 type get_instantiated_type() const RTTR_NOEXCEPT;
121
130 type get_declaring_type() const RTTR_NOEXCEPT;
131
137 string_view get_signature() const RTTR_NOEXCEPT;
138
145
154 variant get_metadata(const variant& key) const;
155
168
182
195 variant invoke(argument arg1, argument arg2) const;
196
209 variant invoke(argument arg1, argument arg2, argument arg3) const;
210
223 variant invoke(argument arg1, argument arg2, argument arg3, argument arg4) const;
224
238 argument arg5) const;
239
253 argument arg5, argument arg6) const;
254
269 variant invoke_variadic(std::vector<argument> args) const;
270
276 bool operator==(const constructor& other) const RTTR_NOEXCEPT;
277
283 bool operator!=(const constructor& other) const RTTR_NOEXCEPT;
284
285 private:
286 constructor(const detail::constructor_wrapper_base* wrapper) RTTR_NOEXCEPT;
287
288 template<typename T>
289 friend T detail::create_item(const detail::class_item_to_wrapper_t<T>* wrapper);
290 template<typename T>
291 friend T detail::create_invalid_item();
292
293 private:
294 const detail::constructor_wrapper_base* m_wrapper;
295};
296
297} // end namespace rttr
298
299#endif // RTTR_CONSTRUCTOR_H_
The argument class is used for forwarding arguments to properties or methods.
Definition argument.h:52
The array_range class provides a view into an underlying data structure with lower and upper limits.
Definition array_range.h:64
variant invoke_variadic(std::vector< argument > args) const
Invokes the constructor of type returned by get_instantiated_type().
variant get_metadata(const variant &key) const
Returns the meta data for the given key key.
array_range< parameter_info > get_parameter_infos() const noexcept
Returns an ordered range of parameter_info objects, which matches the signature of the constructor.
variant invoke() const
Invokes the constructor of type returned by get_instantiated_type().
string_view get_signature() const noexcept
Returns the signature of this constructor as readable string.
type get_instantiated_type() const noexcept
Returns the type object of the instantiated type.
access_levels get_access_level() const noexcept
Returns access level with which this constructor was registered.
type get_declaring_type() const noexcept
Returns the type of the class or struct that declares this constructor.
bool is_valid() const noexcept
Returns true if this constructor is valid, otherwise false.
The parameter_info class provides several meta information about a parameter.
Definition parameter_info.h:109
The type class holds the type information for any arbitrary object.
Definition type.h:171
The variant class allows to store data of any type and convert between these types transparently.
Definition variant.h:198
Definition access_levels.h:34
access_levels
The access_levels enum represents the three access modifiers, which can be used in classes to encapsu...
Definition access_levels.h:46
basic_string_view< char > string_view
A class to hold a reference to a continuous sequence of char objects.
Definition string_view.h:493