method.h
Go to the documentation of this file.
1 /************************************************************************************
2 * *
3 * Copyright (c) 2014, 2015 - 2016 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/parameter_info.h"
33 #include "rttr/access_levels.h"
34 
35 #include <string>
36 #include <vector>
37 
38 namespace rttr
39 {
40 
41 class variant;
42 class type;
43 class instance;
44 class argument;
45 
46 namespace detail
47 {
48  class method_wrapper_base;
49 }
50 
116 class RTTR_API method
117 {
118  public:
124  bool is_valid() const;
125 
131  explicit operator bool() const;
132 
138  std::string get_name() const;
139 
148  access_levels get_access_level() const;
149 
158  bool is_static() const;
159 
165  type get_return_type() const;
166 
175  type get_declaring_type() const;
176 
182  std::vector<parameter_info> get_parameter_infos() const;
183 
189  std::string get_signature() const;
190 
199  variant get_metadata(const variant& key) const;
200 
208  variant invoke(instance object) const;
209 
217  variant invoke(instance object, argument arg1) const;
218 
226  variant invoke(instance object, argument arg1, argument arg2) const;
227 
235  variant invoke(instance object, argument arg1, argument arg2, argument arg3) const;
236 
244  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4) const;
245 
253  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4,
254  argument arg5) const;
255 
263  variant invoke(instance object, argument arg1, argument arg2, argument arg3, argument arg4,
264  argument arg5, argument arg6) const;
265 
275  variant invoke_variadic(instance object, std::vector<argument> args) const;
276 
282  bool operator==(const method& other) const;
283 
289  bool operator!=(const method& other) const;
290 
291  private:
292  friend class type; // to prevent creation of this class
293  method(const detail::method_wrapper_base* wrapper = nullptr);
294  private:
295  const detail::method_wrapper_base* m_wrapper;
296 };
297 
298 } // end namespace rttr
299 
300 #endif // RTTR_METHOD_H_
Definition: access_levels.h:33
The type class holds the type information for any arbitrary object.
Definition: type.h:153
The instance class is used for forwarding the instance of an object to invoke a property or method...
Definition: instance.h:46
The method class provides several meta information about a method and can be invoked.
Definition: method.h:116
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 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:192