Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / core / doc / html / core / typeinfo.html
blob: 4e10c2dd30934a4a9a4557bf0cc762f8eee705bd [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>typeinfo</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Core">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Core">
<link rel="prev" href="swap.html" title="swap">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="core.typeinfo"></a><a class="link" href="typeinfo.html" title="typeinfo">typeinfo</a>
</h2></div></div></div>
<div class="toc"><dl class="toc"><dt><span class="section"><a href="typeinfo.html#core.typeinfo.header_boost_core_typeinfo_hpp">Header
&lt;boost/core/typeinfo.hpp&gt;</a></span></dt></dl></div>
<div class="simplesect">
<div class="titlepage"><div><div><h3 class="title">
<a name="idp87685152"></a>Authors</h3></div></div></div>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
Peter Dimov
</li></ul></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="core.typeinfo.header_boost_core_typeinfo_hpp"></a><a class="link" href="typeinfo.html#core.typeinfo.header_boost_core_typeinfo_hpp" title="Header &lt;boost/core/typeinfo.hpp&gt;">Header
&lt;boost/core/typeinfo.hpp&gt;</a>
</h3></div></div></div>
<p>
The header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">core</span><span class="special">/</span><span class="identifier">typeinfo</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
defines a class <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">typeinfo</span></code>, which is an alias for <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span></code>
when RTTI is enabled, and is a reasonable substitute when RTTI is not supported.
</p>
<p>
The macro <code class="computeroutput"><span class="identifier">BOOST_CORE_TYPEID</span></code>,
when applied to a type <code class="computeroutput"><span class="identifier">T</span></code>,
is the equivalent of <code class="computeroutput"><span class="keyword">typeid</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span></code>
and produces a reference to a const <code class="computeroutput"><span class="identifier">typeinfo</span></code>
object.
</p>
<p>
The function <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">demangled_name</span></code> takes a <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">typeinfo</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">ti</span></code> and either returns <code class="computeroutput"><span class="identifier">ti</span><span class="special">.</span><span class="identifier">name</span><span class="special">()</span></code>,
when that string doesn't need to be demangled, or <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">demangle</span><span class="special">(</span><span class="identifier">ti</span><span class="special">.</span><span class="identifier">name</span><span class="special">())</span></code>,
when it does. The return type of <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">demangled_name</span></code>
is <code class="computeroutput"><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span></code> in the first case and <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span></code>
in the second.
</p>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="core.typeinfo.header_boost_core_typeinfo_hpp.synopsis"></a><a class="link" href="typeinfo.html#core.typeinfo.header_boost_core_typeinfo_hpp.synopsis" title="Synopsis">Synopsis</a>
</h4></div></div></div>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span>
<span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">core</span>
<span class="special">{</span>
<span class="keyword">class</span> <span class="identifier">typeinfo</span><span class="special">;</span>
<span class="comment">/* char const* or std::string */</span> <span class="identifier">demangled_name</span><span class="special">(</span> <span class="identifier">typeinfo</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">ti</span> <span class="special">);</span>
<span class="special">}</span>
<span class="special">}</span>
<span class="preprocessor">#define</span> <span class="identifier">BOOST_CORE_TYPEID</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span> <span class="comment">/*unspecified*/</span>
</pre>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="core.typeinfo.header_boost_core_typeinfo_hpp.example"></a><a class="link" href="typeinfo.html#core.typeinfo.header_boost_core_typeinfo_hpp.example" title="Example">Example</a>
</h4></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">core</span><span class="special">/</span><span class="identifier">typeinfo</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T2</span><span class="special">&gt;</span> <span class="keyword">struct</span> <span class="identifier">X</span>
<span class="special">{</span>
<span class="special">};</span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">X</span><span class="special">&lt;</span><span class="keyword">void</span> <span class="keyword">const</span><span class="special">*,</span> <span class="keyword">void</span><span class="special">(*)(</span><span class="keyword">float</span><span class="special">)&gt;</span> <span class="identifier">T</span><span class="special">;</span>
<span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">typeinfo</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">ti</span> <span class="special">=</span> <span class="identifier">BOOST_CORE_TYPEID</span><span class="special">(</span><span class="identifier">T</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">demangled_name</span><span class="special">(</span> <span class="identifier">ti</span> <span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="special">}</span>
</pre>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2014 Peter Dimov<br>Copyright &#169; 2014 Glen Fernandes<br>Copyright &#169; 2014 Andrey Semashev<p>
Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost
Software License, Version 1.0</a>.
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="swap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
</body>
</html>