method.h Source File - 0.9.7 |RTTR
method.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 
28 #ifndef RTTR_METHOD_H_
29 #define RTTR_METHOD_H_
30 
31 #include "rttr/detail/base/core_prerequisites.h"
32 #include "rttr/detail/misc/class_item_mapper.h"
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 
41 namespace rttr
42 {
43 
44 class variant;
45 class type;
46 class instance;
47 class argument;
48 class method;
49 class visitor;
50 
51 namespace detail
52 {
53  class method_wrapper_base;
54 }
55 
121 class RTTR_API method
122 {
123  public:
129  bool is_valid() const RTTR_NOEXCEPT;
130 
136  explicit operator bool() const RTTR_NOEXCEPT;
137 
143  string_view get_name() const RTTR_NOEXCEPT;
144 
153  access_levels get_access_level() const RTTR_NOEXCEPT;
154 
163  bool is_static() const RTTR_NOEXCEPT;
164 
170  type get_return_type() const RTTR_NOEXCEPT;
171 
180  type get_declaring_type() const RTTR_NOEXCEPT;
181 
187  array_range<parameter_info> get_parameter_infos() const RTTR_NOEXCEPT;
188 
194  string_view get_signature() const RTTR_NOEXCEPT;
195 
204  variant get_metadata(const variant& key) const;
205 
215  variant invoke(instance object) const;
216 
230  variant invoke(instance object, argument arg1) const;
231 
245  variant invoke(instance object, argument arg1, argument arg2) const;
246 
260  variant invoke(instance object, argument arg1, argument arg2, argument arg3) const;
261 
275  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4) const;
276 
290  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4,
291  argument arg5) const;
292 
306  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4,
307  argument arg5, argument arg6) const;
308 
324  variant invoke_variadic(instance object, std::vector<argument> args) const;
325 
331  bool operator==(const method& other) const RTTR_NOEXCEPT;
332 
338  bool operator!=(const method& other) const RTTR_NOEXCEPT;
339 
340  private:
341  method(const detail::method_wrapper_base* wrapper) RTTR_NOEXCEPT;
342 
343  void visit(visitor& visitor) const RTTR_NOEXCEPT;
344 
345  template<typename T>
346  friend T detail::create_item(const detail::class_item_to_wrapper_t<T>* wrapper);
347  template<typename T>
348  friend T detail::create_invalid_item();
349  friend class visitor;
350 
351  private:
352  const detail::method_wrapper_base* m_wrapper;
353 };
354 
355 } // end namespace rttr
356 
357 #endif // RTTR_METHOD_H_
Definition: access_levels.h:33
The type class holds the type information for any arbitrary object.
Definition: type.h:177
constexpr bool operator==(basic_string_view< CharT, Traits > lhs, basic_string_view< CharT, Traits > rhs) noexcept
Compares the two views lhs and rhs.
The array_range class provides a view into an underlying data structure with lower and upper limits...
Definition: array_range.h:63
The instance class is used for forwarding the instance of an object to invoke a property or method...
Definition: instance.h:47
The method class provides several meta information about a method and can be invoked.
Definition: method.h:121
access_levels
The access_levels enum represents the three access modifiers, which can be used in classes to encapsu...
Definition: access_levels.h:45
The class visitor, is used for visiting your registered accessors of a type at compile time...
Definition: visitor.h:98
constexpr bool operator!=(basic_string_view< CharT, Traits > lhs, basic_string_view< CharT, Traits > rhs) noexcept
Compares the two views lhs and rhs.
The class template basic_string_view describes an non-owning reference to a constant contiguous seque...
Definition: string_view.h:48
The argument class is used for forwarding arguments to properties or methods.
Definition: argument.h:51
The variant class allows to store data of any type and convert between these types transparently...
Definition: variant.h:197