convert_reference.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467
  1. <?xml version="1.0" standalone="yes"?>
  2. <library-reference id="boost_convert_c___reference"><title>Boost.Convert C++ Reference</title><header name="boost/convert.hpp">
  3. <namespace name="boost">
  4. <namespace name="cnv">
  5. <struct name="reference"><template>
  6. <template-type-parameter name="Converter"/>
  7. <template-type-parameter name="TypeOut"/>
  8. <template-type-parameter name="TypeIn"/>
  9. </template><typedef name="this_type"><type><classname>reference</classname></type></typedef>
  10. <method-group name="public member functions">
  11. <method name="value_or"><type><classname>this_type</classname> &amp;</type><parameter name="fallback"><paramtype>TypeOut const &amp;</paramtype></parameter></method>
  12. <method name="operator()"><type>TypeOut</type><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter></method>
  13. </method-group>
  14. <constructor><parameter name="cnv"><paramtype>Converter const &amp;</paramtype></parameter></constructor>
  15. </struct><struct-specialization name="reference"><template>
  16. <template-type-parameter name="Converter"/>
  17. <template-type-parameter name="TypeOut"/>
  18. </template><specialization><template-arg>Converter</template-arg><template-arg>TypeOut</template-arg><template-arg>void</template-arg></specialization><typedef name="this_type"><type><classname>reference</classname></type></typedef>
  19. <method-group name="public member functions">
  20. <method name="value_or"><type><classname>this_type</classname> &amp;</type><parameter name="fallback"><paramtype>TypeOut const &amp;</paramtype></parameter></method>
  21. <method name="operator()"><type>TypeOut</type><template>
  22. <template-type-parameter name="TypeIn"/>
  23. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter></method>
  24. </method-group>
  25. <constructor><parameter name="cnv"><paramtype>Converter const &amp;</paramtype></parameter></constructor>
  26. </struct-specialization><function name="apply"><type><classname>reference</classname>&lt; Converter, TypeOut, TypeIn &gt;</type><template>
  27. <template-type-parameter name="TypeOut"/>
  28. <template-type-parameter name="TypeIn"/>
  29. <template-type-parameter name="Converter"/>
  30. </template><parameter name="cnv"><paramtype>Converter const &amp;</paramtype></parameter><purpose>Boost.Convert deployment interface with algorithms. </purpose><description><para>For example, <programlisting language="c++">boost::array&lt;char const*, 3&gt; strs = {{ " 5", "0XF", "not an int" }};
  31. std::vector&lt;int&gt; ints;
  32. boost::cnv::cstream cnv;
  33. cnv(std::hex)(std::skipws);
  34. std::transform(
  35. strs.begin(),
  36. strs.end(),
  37. std::back_inserter(ints),
  38. boost::cnv::apply&lt;int&gt;(boost::cref(cnv)).value_or(-1));
  39. </programlisting> </para></description></function>
  40. <function name="apply"><type><classname>reference</classname>&lt; Converter, TypeOut, void &gt;</type><template>
  41. <template-type-parameter name="TypeOut"/>
  42. <template-type-parameter name="Converter"/>
  43. </template><parameter name="cnv"><paramtype>Converter const &amp;</paramtype></parameter></function>
  44. </namespace>
  45. <data-member name="throw_on_failure"><type><emphasis>unspecified</emphasis></type><description><para>boost::throw_on_failure is the 'tag' object to request the exception-throwing behavior. </para></description></data-member>
  46. <function name="convert"><type>boost::optional&lt; TypeOut &gt;</type><template>
  47. <template-type-parameter name="TypeOut"/>
  48. <template-type-parameter name="TypeIn"/>
  49. <template-type-parameter name="Converter"/>
  50. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype><description><para>Value of the TypeIn type to be converted to the TypeOut type </para></description></parameter><parameter name="converter"><paramtype>Converter const &amp;</paramtype><description><para>Converter to be used for conversion </para></description></parameter><purpose>Boost.Convert main deployment interface. </purpose><description><para>
  51. For example, <programlisting language="c++">boost::cnv::cstream cnv;
  52. boost::optional&lt;int&gt; i = boost::convert&lt;int&gt;("12", cnv);
  53. boost::optional&lt;string&gt; s = boost::convert&lt;string&gt;(123.456, cnv);
  54. </programlisting> </para></description><returns><para>boost::optional&lt;TypeOut&gt; result of conversion together with the indication of success or failure of the conversion request.</para>
  55. </returns></function>
  56. <function name="convert"><type>boost::optional&lt; TypeOut &gt;</type><template>
  57. <template-type-parameter name="TypeOut"/>
  58. <template-type-parameter name="TypeIn"/>
  59. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter><purpose>Boost.Convert deployment interface with the default converter. </purpose><description><para>For example, <programlisting language="c++">struct boost::cnv::by_default : boost::cnv::cstream {};
  60. // boost::cnv::cstream (through boost::cnv::by_default) is deployed
  61. // as the default converter when no converter is provided explicitly.
  62. boost::optional&lt;int&gt; i = boost::convert&lt;int&gt;("12");
  63. boost::optional&lt;string&gt; s = boost::convert&lt;string&gt;(123.456);
  64. </programlisting> </para></description></function>
  65. <function name="convert"><type>TypeOut</type><template>
  66. <template-type-parameter name="TypeOut"/>
  67. <template-type-parameter name="TypeIn"/>
  68. <template-type-parameter name="Converter"/>
  69. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter><parameter name="converter"><paramtype>Converter const &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter><purpose>Boost.Convert non-optional deployment interface. </purpose></function>
  70. <function name="convert"><type>enable_if&lt; is_convertible&lt; Fallback, TypeOut &gt;, TypeOut &gt;::type</type><template>
  71. <template-type-parameter name="TypeOut"/>
  72. <template-type-parameter name="TypeIn"/>
  73. <template-type-parameter name="Converter"/>
  74. <template-type-parameter name="Fallback"/>
  75. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter><parameter name="converter"><paramtype>Converter const &amp;</paramtype></parameter><parameter name="fallback"><paramtype>Fallback const &amp;</paramtype></parameter></function>
  76. <function name="convert"><type>enable_if&lt; cnv::is_fun&lt; Fallback, TypeOut &gt;, TypeOut &gt;::type</type><template>
  77. <template-type-parameter name="TypeOut"/>
  78. <template-type-parameter name="TypeIn"/>
  79. <template-type-parameter name="Converter"/>
  80. <template-type-parameter name="Fallback"/>
  81. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter><parameter name="converter"><paramtype>Converter const &amp;</paramtype></parameter><parameter name="fallback"><paramtype>Fallback</paramtype></parameter></function>
  82. </namespace>
  83. </header>
  84. <header name="boost/convert/base.hpp">
  85. <namespace name="boost">
  86. <namespace name="cnv">
  87. <struct name="cnvbase"><template>
  88. <template-type-parameter name="derived_type"/>
  89. </template><typedef name="this_type"><type><classname>cnvbase</classname></type></typedef>
  90. <typedef name="int_type"><type>int</type></typedef>
  91. <typedef name="uint_type"><type>unsigned int</type></typedef>
  92. <typedef name="lint_type"><type>long int</type></typedef>
  93. <typedef name="ulint_type"><type>unsigned long int</type></typedef>
  94. <typedef name="sint_type"><type>short int</type></typedef>
  95. <typedef name="usint_type"><type>unsigned short int</type></typedef>
  96. <typedef name="llint_type"><type>long long int</type></typedef>
  97. <typedef name="ullint_type"><type>unsigned long long int</type></typedef>
  98. <typedef name="flt_type"><type>float</type></typedef>
  99. <typedef name="dbl_type"><type>double</type></typedef>
  100. <typedef name="ldbl_type"><type>long double</type></typedef>
  101. <method-group name="public member functions">
  102. <method name="operator()" cv="const"><type>void</type><template>
  103. <template-type-parameter name="type_in"/>
  104. <template-type-parameter name="type_out"/>
  105. </template><parameter name="in"><paramtype>type_in const &amp;</paramtype></parameter><parameter name="out"><paramtype>boost::optional&lt; type_out &gt; &amp;</paramtype></parameter></method>
  106. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>int_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  107. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>uint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  108. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>lint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  109. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>llint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  110. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>ulint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  111. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>ullint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  112. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>sint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  113. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>usint_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  114. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>flt_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  115. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>dbl_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  116. <method name="BOOST_CNV_TO_STRING" cv="const"><type/><parameter name="v"><paramtype>ldbl_type</paramtype></parameter><parameter name="r"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  117. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; int_type &gt; &amp;</paramtype></parameter></method>
  118. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; uint_type &gt; &amp;</paramtype></parameter></method>
  119. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; lint_type &gt; &amp;</paramtype></parameter></method>
  120. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; llint_type &gt; &amp;</paramtype></parameter></method>
  121. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ulint_type &gt; &amp;</paramtype></parameter></method>
  122. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ullint_type &gt; &amp;</paramtype></parameter></method>
  123. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; sint_type &gt; &amp;</paramtype></parameter></method>
  124. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; usint_type &gt; &amp;</paramtype></parameter></method>
  125. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; flt_type &gt; &amp;</paramtype></parameter></method>
  126. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; dbl_type &gt; &amp;</paramtype></parameter></method>
  127. <method name="BOOST_CNV_STRING_TO" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ldbl_type &gt; &amp;</paramtype></parameter></method>
  128. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>base</paramtype></parameter><parameter name=""><paramtype>cnv::base</paramtype></parameter></method>
  129. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>adjust</paramtype></parameter><parameter name=""><paramtype>cnv::adjust</paramtype></parameter></method>
  130. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>precision</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
  131. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>uppercase</paramtype></parameter><parameter name=""><paramtype>bool</paramtype></parameter></method>
  132. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>skipws</paramtype></parameter><parameter name=""><paramtype>bool</paramtype></parameter></method>
  133. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>width</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
  134. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>fill</paramtype></parameter><parameter name=""><paramtype>char</paramtype></parameter></method>
  135. </method-group>
  136. <method-group name="protected member functions">
  137. <method name="str_to_" cv="const"><type>void</type><template>
  138. <template-type-parameter name="string_type"/>
  139. <template-type-parameter name="out_type"/>
  140. </template><parameter name="str"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="result_out"><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  141. <method name="to_str_" cv="const"><type>void</type><template>
  142. <template-type-parameter name="in_type"/>
  143. <template-type-parameter name="string_type"/>
  144. </template><parameter name="value_in"><paramtype>in_type</paramtype></parameter><parameter name="result_out"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  145. <method name="dncast" cv="const"><type>derived_type const &amp;</type></method>
  146. <method name="dncast"><type>derived_type &amp;</type></method>
  147. </method-group>
  148. <constructor/>
  149. </struct>
  150. </namespace>
  151. </namespace>
  152. <macro name="BOOST_CNV_TO_STRING"/>
  153. <macro name="BOOST_CNV_STRING_TO"/>
  154. <macro name="BOOST_CNV_PARAM" kind="functionlike"><macro-parameter name="param_name"/><macro-parameter name="param_type"/></macro>
  155. </header>
  156. <header name="boost/convert/lexical_cast.hpp">
  157. <namespace name="boost">
  158. <namespace name="cnv">
  159. <struct name="lexical_cast"><purpose>boost::lexical_cast-based converter </purpose><description><para>The purpose of the converter is to<itemizedlist>
  160. <listitem><para>Make use of the boost::lexical_cast functionality and performance that many people have become accustomed to and comfortable with;</para>
  161. </listitem><listitem><para>Demonstrate how existing independent conversion/transformation-related facilities might be The converter can easily replace boost::lexical_cast, adding flexibility and convenience. </para>
  162. </listitem></itemizedlist>
  163. </para></description><method-group name="public member functions">
  164. <method name="operator()" cv="const"><type>void</type><template>
  165. <template-type-parameter name="TypeOut"/>
  166. <template-type-parameter name="TypeIn"/>
  167. </template><parameter name="value_in"><paramtype>TypeIn const &amp;</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional&lt; TypeOut &gt; &amp;</paramtype></parameter></method>
  168. </method-group>
  169. </struct>
  170. </namespace>
  171. </namespace>
  172. </header>
  173. <header name="boost/convert/parameters.hpp">
  174. <namespace name="boost">
  175. <namespace name="cnv">
  176. <namespace name="parameter">
  177. </namespace>
  178. <enum name="adjust"><enumvalue name="left"/><enumvalue name="right"/><enumvalue name="center"/></enum>
  179. <enum name="base"><enumvalue name="bin"><default>=2</default></enumvalue><enumvalue name="oct"><default>=8</default></enumvalue><enumvalue name="dec"><default>=10</default></enumvalue><enumvalue name="hex"><default>=16</default></enumvalue></enum>
  180. <enum name="notation"><enumvalue name="fixed"/><enumvalue name="scientific"/></enum>
  181. </namespace>
  182. </namespace>
  183. </header>
  184. <header name="boost/convert/printf.hpp">
  185. <namespace name="boost">
  186. <namespace name="cnv">
  187. <struct name="printf"><inherit access="public">boost::cnv::cnvbase&lt; boost::cnv::printf &gt;</inherit><typedef name="this_type"><type><classname>boost::cnv::printf</classname></type></typedef>
  188. <typedef name="base_type"><type><classname>boost::cnv::cnvbase</classname>&lt; <classname>this_type</classname> &gt;</type></typedef>
  189. <method-group name="public member functions">
  190. <method name="to_str" cv="const"><type>cnv::range&lt; char * &gt;</type><template>
  191. <template-type-parameter name="in_type"/>
  192. </template><parameter name="value_in"><paramtype>in_type</paramtype></parameter><parameter name="buf"><paramtype>char *</paramtype></parameter></method>
  193. <method name="str_to" cv="const"><type>void</type><template>
  194. <template-type-parameter name="string_type"/>
  195. <template-type-parameter name="out_type"/>
  196. </template><parameter name="range"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="result_out"><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  197. </method-group>
  198. <method-group name="private member functions">
  199. <method name="pos" cv="const"><type>int</type><template>
  200. <template-type-parameter name="Type"/>
  201. </template></method>
  202. <method name="pformat" cv="const"><type>char const *</type><parameter name="pos"><paramtype>int</paramtype></parameter></method>
  203. <method name="format" cv="const"><type>char const *</type><parameter name="pos"><paramtype>int</paramtype></parameter></method>
  204. </method-group>
  205. </struct>
  206. </namespace>
  207. </namespace>
  208. </header>
  209. <header name="boost/convert/spirit.hpp">
  210. <namespace name="boost">
  211. <namespace name="cnv">
  212. <struct name="spirit"><inherit access="public">boost::cnv::cnvbase&lt; boost::cnv::spirit &gt;</inherit><typedef name="this_type"><type><classname>boost::cnv::spirit</classname></type></typedef>
  213. <typedef name="base_type"><type><classname>boost::cnv::cnvbase</classname>&lt; <classname>this_type</classname> &gt;</type></typedef>
  214. <method-group name="public member functions">
  215. <method name="str_to" cv="const"><type>void</type><template>
  216. <template-type-parameter name="string_type"/>
  217. <template-type-parameter name="out_type"/>
  218. </template><parameter name="range"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="result_out"><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  219. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  220. <template-type-parameter name="in_type"/>
  221. <template-type-parameter name="char_type"/>
  222. </template><parameter name="value_in"><paramtype>in_type</paramtype></parameter><parameter name="beg"><paramtype>char_type *</paramtype></parameter></method>
  223. </method-group>
  224. </struct>
  225. </namespace>
  226. </namespace>
  227. </header>
  228. <header name="boost/convert/stream.hpp">
  229. <namespace name="boost">
  230. <namespace name="cnv">
  231. <struct name="basic_stream"><template>
  232. <template-type-parameter name="Char"/>
  233. </template><inherit access="public">noncopyable</inherit><struct name="ibuffer_type"><inherit access="public">buffer_type</inherit><method-group name="public member functions">
  234. </method-group>
  235. <constructor><parameter name="beg"><paramtype>char_type const *</paramtype></parameter><parameter name="sz"><paramtype>std::size_t</paramtype></parameter></constructor>
  236. </struct><struct name="obuffer_type"><inherit access="public">buffer_type</inherit></struct><typedef name="char_type"><type>Char</type></typedef>
  237. <typedef name="this_type"><type><classname>boost::cnv::basic_stream</classname>&lt; char_type &gt;</type></typedef>
  238. <typedef name="stream_type"><type>std::basic_stringstream&lt; char_type &gt;</type></typedef>
  239. <typedef name="istream_type"><type>std::basic_istream&lt; char_type &gt;</type></typedef>
  240. <typedef name="buffer_type"><type>std::basic_streambuf&lt; char_type &gt;</type></typedef>
  241. <typedef name="stdstr_type"><type>std::basic_string&lt; char_type &gt;</type></typedef>
  242. <typedef name="manipulator_type"><type>std::ios_base &amp;(*)(std::ios_base &amp;)</type></typedef>
  243. <method-group name="public member functions">
  244. <method name="BOOST_CNV_STRING_ENABLE" cv="const"><type/><parameter name="v"><paramtype>type const &amp;</paramtype></parameter><parameter name="s"><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  245. <method name="BOOST_CNV_STRING_ENABLE" cv="const"><type/><parameter name="s"><paramtype>string_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; type &gt; &amp;</paramtype></parameter></method>
  246. <method name="operator()" cv="const"><type>void</type><template>
  247. <template-type-parameter name="type"/>
  248. </template><parameter name="s"><paramtype>char_type const *</paramtype></parameter><parameter name="r"><paramtype>optional&lt; type &gt; &amp;</paramtype></parameter></method>
  249. <method name="operator()" cv="const"><type>void</type><template>
  250. <template-type-parameter name="type"/>
  251. </template><parameter name="s"><paramtype>stdstr_type const &amp;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; type &gt; &amp;</paramtype></parameter></method>
  252. <method name="operator()"><type><classname>this_type</classname> &amp;</type><template>
  253. <template-type-parameter name="manipulator"/>
  254. </template><parameter name="m"><paramtype>manipulator</paramtype></parameter></method>
  255. <method name="operator()"><type><classname>this_type</classname> &amp;</type><parameter name="m"><paramtype>manipulator_type</paramtype></parameter></method>
  256. <method name="operator()"><type><classname>this_type</classname> &amp;</type><parameter name="l"><paramtype>std::locale const &amp;</paramtype></parameter></method>
  257. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>locale</paramtype></parameter><parameter name=""><paramtype>std::locale</paramtype></parameter></method>
  258. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>precision</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
  259. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>width</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
  260. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>fill</paramtype></parameter><parameter name=""><paramtype>char</paramtype></parameter></method>
  261. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>uppercase</paramtype></parameter><parameter name=""><paramtype>bool</paramtype></parameter></method>
  262. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>skipws</paramtype></parameter><parameter name=""><paramtype>bool</paramtype></parameter></method>
  263. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>adjust</paramtype></parameter><parameter name=""><paramtype>boost::cnv::adjust</paramtype></parameter></method>
  264. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>base</paramtype></parameter><parameter name=""><paramtype>boost::cnv::base</paramtype></parameter></method>
  265. <method name="BOOST_CNV_PARAM"><type/><parameter name=""><paramtype>notation</paramtype></parameter><parameter name=""><paramtype>boost::cnv::notation</paramtype></parameter></method>
  266. <method name="to_str" cv="const"><type>void</type><template>
  267. <template-type-parameter name="string_type"/>
  268. <template-type-parameter name="in_type"/>
  269. </template><parameter name="value_in"><paramtype>in_type const &amp;</paramtype></parameter><parameter name="string_out"><paramtype>boost::optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  270. <method name="str_to" cv="const"><type>void</type><template>
  271. <template-type-parameter name="string_type"/>
  272. <template-type-parameter name="out_type"/>
  273. </template><parameter name="string_in"><paramtype>boost::cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  274. </method-group>
  275. <constructor/>
  276. <constructor><parameter name="other"><paramtype><classname>this_type</classname> &amp;&amp;</paramtype></parameter></constructor>
  277. <method-group name="private member functions">
  278. <method name="str_to" cv="const"><type>void</type><template>
  279. <template-type-parameter name="string_type"/>
  280. <template-type-parameter name="out_type"/>
  281. </template><parameter name=""><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name=""><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  282. <method name="to_str" cv="const"><type>void</type><template>
  283. <template-type-parameter name="string_type"/>
  284. <template-type-parameter name="in_type"/>
  285. </template><parameter name=""><paramtype>in_type const &amp;</paramtype></parameter><parameter name=""><paramtype>optional&lt; string_type &gt; &amp;</paramtype></parameter></method>
  286. </method-group>
  287. </struct><typedef name="cstream"><type><classname>boost::cnv::basic_stream</classname>&lt; char &gt;</type></typedef>
  288. <typedef name="wstream"><type><classname>boost::cnv::basic_stream</classname>&lt; wchar_t &gt;</type></typedef>
  289. </namespace>
  290. </namespace>
  291. <macro name="BOOST_CNV_STRING_ENABLE"/>
  292. <macro name="BOOST_CNV_PARAM" kind="functionlike"><macro-parameter name="PARAM_NAME"/><macro-parameter name="PARAM_TYPE"/></macro>
  293. </header>
  294. <header name="boost/convert/strtol.hpp">
  295. <namespace name="boost">
  296. <namespace name="cnv">
  297. <struct name="strtol"><inherit access="public">boost::cnv::cnvbase&lt; boost::cnv::strtol &gt;</inherit><purpose>std::strtol-based extended converter </purpose><description><para>The converter offers a fairly decent overall performance and moderate formatting facilities. </para></description><typedef name="this_type"><type><classname>boost::cnv::strtol</classname></type></typedef>
  298. <typedef name="base_type"><type><classname>boost::cnv::cnvbase</classname>&lt; <classname>this_type</classname> &gt;</type></typedef>
  299. <method-group name="private member functions">
  300. <method name="str_to" cv="const"><type>void</type><template>
  301. <template-type-parameter name="string_type"/>
  302. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; int_type &gt; &amp;</paramtype></parameter></method>
  303. <method name="str_to" cv="const"><type>void</type><template>
  304. <template-type-parameter name="string_type"/>
  305. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; sint_type &gt; &amp;</paramtype></parameter></method>
  306. <method name="str_to" cv="const"><type>void</type><template>
  307. <template-type-parameter name="string_type"/>
  308. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; lint_type &gt; &amp;</paramtype></parameter></method>
  309. <method name="str_to" cv="const"><type>void</type><template>
  310. <template-type-parameter name="string_type"/>
  311. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; llint_type &gt; &amp;</paramtype></parameter></method>
  312. <method name="str_to" cv="const"><type>void</type><template>
  313. <template-type-parameter name="string_type"/>
  314. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; uint_type &gt; &amp;</paramtype></parameter></method>
  315. <method name="str_to" cv="const"><type>void</type><template>
  316. <template-type-parameter name="string_type"/>
  317. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; usint_type &gt; &amp;</paramtype></parameter></method>
  318. <method name="str_to" cv="const"><type>void</type><template>
  319. <template-type-parameter name="string_type"/>
  320. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ulint_type &gt; &amp;</paramtype></parameter></method>
  321. <method name="str_to" cv="const"><type>void</type><template>
  322. <template-type-parameter name="string_type"/>
  323. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ullint_type &gt; &amp;</paramtype></parameter></method>
  324. <method name="str_to" cv="const"><type>void</type><template>
  325. <template-type-parameter name="string_type"/>
  326. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; flt_type &gt; &amp;</paramtype></parameter></method>
  327. <method name="str_to" cv="const"><type>void</type><template>
  328. <template-type-parameter name="string_type"/>
  329. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; dbl_type &gt; &amp;</paramtype></parameter></method>
  330. <method name="str_to" cv="const"><type>void</type><template>
  331. <template-type-parameter name="string_type"/>
  332. </template><parameter name="v"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="r"><paramtype>optional&lt; ldbl_type &gt; &amp;</paramtype></parameter></method>
  333. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  334. <template-type-parameter name="char_type"/>
  335. </template><parameter name="v"><paramtype>int_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  336. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  337. <template-type-parameter name="char_type"/>
  338. </template><parameter name="v"><paramtype>uint_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  339. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  340. <template-type-parameter name="char_type"/>
  341. </template><parameter name="v"><paramtype>lint_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  342. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  343. <template-type-parameter name="char_type"/>
  344. </template><parameter name="v"><paramtype>ulint_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  345. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  346. <template-type-parameter name="char_type"/>
  347. </template><parameter name="v"><paramtype>llint_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  348. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  349. <template-type-parameter name="char_type"/>
  350. </template><parameter name="v"><paramtype>ullint_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  351. <method name="to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  352. <template-type-parameter name="char_type"/>
  353. </template><parameter name="v"><paramtype>dbl_type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  354. <method name="i_to_str" cv="const"><type>cnv::range&lt; char_type * &gt;</type><template>
  355. <template-type-parameter name="char_type"/>
  356. <template-type-parameter name="in_type"/>
  357. </template><parameter name=""><paramtype>in_type</paramtype></parameter><parameter name=""><paramtype>char_type *</paramtype></parameter></method>
  358. <method name="str_to_i" cv="const"><type>void</type><template>
  359. <template-type-parameter name="string_type"/>
  360. <template-type-parameter name="out_type"/>
  361. </template><parameter name=""><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name=""><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  362. <method name="str_to_d" cv="const"><type>void</type><template>
  363. <template-type-parameter name="string_type"/>
  364. <template-type-parameter name="out_type"/>
  365. </template><parameter name=""><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name=""><paramtype>optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  366. </method-group>
  367. <method-group name="private static functions">
  368. <method name="adjust_fraction" specifiers="static"><type>double</type><parameter name=""><paramtype>double</paramtype></parameter><parameter name=""><paramtype>int</paramtype></parameter></method>
  369. <method name="get_char" specifiers="static"><type>int</type><parameter name="v"><paramtype>int</paramtype></parameter></method>
  370. </method-group>
  371. <method-group name="public member functions">
  372. <method name="i_to_str" cv="const"><type>boost::cnv::range&lt; char_type * &gt;</type><template>
  373. <template-type-parameter name="char_type"/>
  374. <template-type-parameter name="Type"/>
  375. </template><parameter name="in_value"><paramtype>Type</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  376. <method name="to_str" cv="const"><type>boost::cnv::range&lt; char_type * &gt;</type><template>
  377. <template-type-parameter name="char_type"/>
  378. </template><parameter name="value"><paramtype>double</paramtype></parameter><parameter name="buf"><paramtype>char_type *</paramtype></parameter></method>
  379. <method name="str_to_i" cv="const"><type>void</type><template>
  380. <template-type-parameter name="string_type"/>
  381. <template-type-parameter name="out_type"/>
  382. </template><parameter name="range"><paramtype>cnv::range&lt; string_type &gt;</paramtype></parameter><parameter name="result_out"><paramtype>boost::optional&lt; out_type &gt; &amp;</paramtype></parameter></method>
  383. </method-group>
  384. </struct>
  385. </namespace>
  386. </namespace>
  387. </header>
  388. <header name="boost/make_default.hpp">
  389. <namespace name="boost">
  390. <function name="make_default"><type>T</type><template>
  391. <template-type-parameter name="T"/>
  392. </template><description><para>A considerable number of libraries require an instance of a class provided (storage created and initialized). For example, <programlisting language="c++">Type result;
  393. ...
  394. istream &gt;&gt; result;
  395. </programlisting> In generic code that results in the Default Constructibility requirement imposed on every type 'Type' to be used with the respective code. Inevitably, that requirement a) either excludes all the classes that for various reasons do not meet that requirement or b) imposes certain (not necessarily desirable) design/implementation onto respective classes.</para><para>Deployment of boost::make_default() eliminates the Default Constructibility requirement with <programlisting language="c++">Type result = boost::make_default&lt;Type&gt;();
  396. ...
  397. istream &gt;&gt; result;
  398. </programlisting> Classes with no default constructor can now be included via a boost::make_default() specialization: <programlisting language="c++">namespace boost
  399. {
  400. template&lt;&gt; inline Type make_default&lt;Type&gt;() { return Type(parameters); }
  401. }
  402. </programlisting> </para></description></function>
  403. </namespace>
  404. </header>
  405. </library-reference>