<!-- HTML header for doxygen 1.8.8--> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <!-- For Mobile Devices --> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta name="generator" content="Doxygen 1.8.15"/> <script type="text/javascript" src="jquery.min.js"></script> <title>rttr: argument.h Source File</title> <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>--> <script type="text/javascript" src="dynsections.js"></script> <link rel = "shortcut icon" type = "image/x-icon" href = "favicon.ico"> <link rel = "stylesheet" href = "fonts/ptsans_regular_macroman/stylesheet.css"> <link rel = "stylesheet" href = "fonts/source_code_pro_regular/stylesheet.css"> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="custom-doxygen.css" rel="stylesheet" type="text/css"/> <link rel="stylesheet" href="bootstrap/css/bootstrap.min.css"> <link rel="stylesheet" href="custom-bootstrap.css"> <script src="bootstrap/js/bootstrap.min.js"></script> <script type="text/javascript" src="doxy-boot.js"></script> </head> <body> <!-- <nav class="navbar navbar-default" role="navigation"> <div class="container"> <div class="navbar-header"> <a class="navbar-brand">rttr 0.9.6</a> </div> </div> </nav> --> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div class="content" id="content"> <div class="container"> <div class="row"> <div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;"> <div style="margin-bottom: 15px;"> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">argument.h</div> </div> </div><!--header--> <div class="contents"> <a href="argument_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/************************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (c) 2014 - 2018 Axel Menzel <info@rttr.org> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* This file is part of RTTR (Run Time Type Reflection) *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* License: MIT License *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* Permission is hereby granted, free of charge, to any person obtaining *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* a copy of this software and associated documentation files (the "Software"), *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* to deal in the Software without restriction, including without limitation *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* the rights to use, copy, modify, merge, publish, distribute, sublicense, *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* and/or sell copies of the Software, and to permit persons to whom the *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* Software is furnished to do so, subject to the following conditions: *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* The above copyright notice and this permission notice shall be included in *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* all copies or substantial portions of the Software. *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">* *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">* SOFTWARE. *</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">* *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">*************************************************************************************/</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef RTTR_ARGUMENT_H_</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define RTTR_ARGUMENT_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "rttr/detail/base/core_prerequisites.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "rttr/detail/misc/misc_type_traits.h"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "rttr/detail/misc/std_type_traits.h"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <type_traits></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span><a class="code" href="namespacerttr.html">rttr</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>type;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>variant;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>variant_array;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>instance;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classrttr_1_1argument.html"> 51</a></span> <span class="keyword">class </span>RTTR_API <a class="code" href="classrttr_1_1argument.html">argument</a></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">using</span> decay_arg_t = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<!std::is_same<argument, T>::value</a>, T>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">using</span> is_variant = std::is_same<detail::remove_cv_t<detail::remove_reference_t<T>>, <a class="code" href="classrttr_1_1variant.html">variant</a>>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">using</span> arg_value_t = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<!std::is_rvalue_reference<T>::value</a> && !is_variant<T>::value, T>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">using</span> arg_rvalue_t = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<std::is_rvalue_reference<T>::value</a> && !is_variant<T>::value, detail::remove_reference_t<T> >;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">using</span> ptr_type = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<std::is_pointer<T>::value</a>, <span class="keywordtype">bool</span>>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">using</span> non_ptr_type = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<!std::is_pointer<T>::value</a>, <span class="keywordtype">bool</span>>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">using</span> is_variant_t = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<is_variant<T>::value</a> && !<a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">std::is_rvalue_reference<T>::value</a>, T>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">using</span> is_variant_ref_t = <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">detail::enable_if_t<is_variant<T>::value</a> && <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">std::is_rvalue_reference<T>::value</a>, detail::remove_reference_t<T>>;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>() RTTR_NOEXCEPT;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(<a class="code" href="classrttr_1_1argument.html">argument</a>&& arg) RTTR_NOEXCEPT;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(<span class="keyword">const</span> <a class="code" href="classrttr_1_1argument.html">argument</a>& other) RTTR_NOEXCEPT;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(<a class="code" href="classrttr_1_1variant.html">variant</a>& var) RTTR_NOEXCEPT;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(<span class="keyword">const</span> <a class="code" href="classrttr_1_1variant.html">variant</a>& var) RTTR_NOEXCEPT;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> Tp = decay_arg_t<T>></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(<span class="keyword">const</span> T& data) RTTR_NOEXCEPT;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, <span class="keyword">typename</span> Tp = decay_arg_t<T>></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>(T& data) RTTR_NOEXCEPT;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  RTTR_INLINE <a class="code" href="classrttr_1_1argument.html">argument</a>& operator=(<span class="keyword">const</span> <a class="code" href="classrttr_1_1argument.html">argument</a>& other) RTTR_NOEXCEPT;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  RTTR_INLINE <a class="code" href="classrttr_1_1type.html">type</a> get_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#ifdef DOXYGEN</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  RTTR_INLINE <span class="keywordtype">bool</span> is_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  RTTR_INLINE T& get_value() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  RTTR_INLINE ptr_type<T> is_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  RTTR_INLINE non_ptr_type<T> is_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  RTTR_INLINE arg_value_t<T>& get_value() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  RTTR_INLINE arg_rvalue_t<T> && get_value() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  RTTR_INLINE is_variant_t<T>& get_value() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  RTTR_INLINE is_variant_ref_t<T> && get_value() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">const</span> <span class="keywordtype">void</span>* m_data;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">const</span> <a class="code" href="classrttr_1_1variant.html">variant</a>* m_variant;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">const</span> <a class="code" href="classrttr_1_1type.html">rttr::type</a> m_type;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> };</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// end namespace rttr</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#include "rttr/detail/impl/argument_impl.h"</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif // RTTR_ARGUMENT_H_</span></div><div class="ttc" id="namespacerttr_html"><div class="ttname"><a href="namespacerttr.html">rttr</a></div><div class="ttdef"><b>Definition:</b> access_levels.h:33</div></div> <div class="ttc" id="classrttr_1_1type_html"><div class="ttname"><a href="classrttr_1_1type.html">rttr::type</a></div><div class="ttdoc">The type class holds the type information for any arbitrary object.</div><div class="ttdef"><b>Definition:</b> type.h:170</div></div> <div class="ttc" id="namespacerttr_html_a54ecd8bad715cbc451e7aa8491667d4a"><div class="ttname"><a href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">rttr::value</a></div><div class="ttdeci">detail::enum_data< Enum_Type > value(string_view, Enum_Type value)</div><div class="ttdoc">The value function should be used to add a mapping from enum name to value during the registration pr...</div></div> <div class="ttc" id="classrttr_1_1argument_html"><div class="ttname"><a href="classrttr_1_1argument.html">rttr::argument</a></div><div class="ttdoc">The argument class is used for forwarding arguments to properties or methods.</div><div class="ttdef"><b>Definition:</b> argument.h:51</div></div> <div class="ttc" id="classrttr_1_1variant_html"><div class="ttname"><a href="classrttr_1_1variant.html">rttr::variant</a></div><div class="ttdoc">The variant class allows to store data of any type and convert between these types transparently.</div><div class="ttdef"><b>Definition:</b> variant.h:197</div></div> </div><!-- fragment --></div><!-- contents --> <!-- HTML footer for doxygen 1.8.9.1--> <!-- start footer part --> <hr class="footer"/> <address class="footer"> <small> Generated on Thu Apr 11 2019 20:05:56 for rttr - 0.9.6 by <a href="http://www.doxygen.org/index.html">doxygen</a>. </small> </address> </body> </html>