1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>demangle</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../index.html" title="Chapter 1. Boost.Core"> 8<link rel="up" href="../index.html" title="Chapter 1. Boost.Core"> 9<link rel="prev" href="default_allocator.html" title="default_allocator"> 10<link rel="next" href="empty_value.html" title="empty_value"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="default_allocator.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><a accesskey="n" href="empty_value.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 27<a name="core.demangle"></a><a class="link" href="demangle.html" title="demangle">demangle</a> 28</h2></div></div></div> 29<div class="toc"><dl class="toc"> 30<dt><span class="section"><a href="demangle.html#core.demangle.header_boost_core_demangle_hpp">Header 31 <boost/core/demangle.hpp></a></span></dt> 32<dt><span class="section"><a href="demangle.html#core.demangle.acknowledgments">Acknowledgments</a></span></dt> 33</dl></div> 34<div class="simplesect"> 35<div class="titlepage"><div><div><h3 class="title"> 36<a name="idm45312829853072"></a>Authors</h3></div></div></div> 37<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 38<li class="listitem"> 39 Peter Dimov 40 </li> 41<li class="listitem"> 42 Andrey Semashev 43 </li> 44</ul></div> 45</div> 46<div class="section"> 47<div class="titlepage"><div><div><h3 class="title"> 48<a name="core.demangle.header_boost_core_demangle_hpp"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp" title="Header <boost/core/demangle.hpp>">Header 49 <boost/core/demangle.hpp></a> 50</h3></div></div></div> 51<p> 52 The header <code class="computeroutput"><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">demangle</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> 53 defines several tools for undecorating symbol names. 54 </p> 55<div class="section"> 56<div class="titlepage"><div><div><h4 class="title"> 57<a name="core.demangle.header_boost_core_demangle_hpp.synopsis"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp.synopsis" title="Synopsis">Synopsis</a> 58</h4></div></div></div> 59<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> 60<span class="special">{</span> 61 62<span class="keyword">namespace</span> <span class="identifier">core</span> 63<span class="special">{</span> 64 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">demangle</span><span class="special">(</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">);</span> 65 66 <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">demangle_alloc</span><span class="special">(</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 67 <span class="keyword">void</span> <span class="identifier">demangle_free</span><span class="special">(</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">demangled_name</span> <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 68 69 <span class="keyword">class</span> <span class="identifier">scoped_demangled_name</span> 70 <span class="special">{</span> 71 <span class="keyword">public</span><span class="special">:</span> 72 <span class="keyword">explicit</span> <span class="identifier">scoped_demangled_name</span><span class="special">(</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 73 <span class="special">~</span><span class="identifier">scoped_demangled_name</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> 74 <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 75 76 <span class="identifier">scoped_demangled_name</span><span class="special">(</span> <span class="identifier">scoped_demangled_name</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> 77 <span class="identifier">scoped_demangled_name</span><span class="special">&</span> <span class="keyword">operator</span><span class="special">=</span> <span class="special">(</span> <span class="identifier">scoped_demangled_name</span> <span class="keyword">const</span><span class="special">&</span> <span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> 78 <span class="special">};</span> 79<span class="special">}</span> 80 81<span class="special">}</span> 82</pre> 83</div> 84<div class="section"> 85<div class="titlepage"><div><div><h4 class="title"> 86<a name="core.demangle.header_boost_core_demangle_hpp.conventional_interface"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp.conventional_interface" title="Conventional interface">Conventional 87 interface</a> 88</h4></div></div></div> 89<p> 90 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">demangle</span></code> is the conventional way to obtain 91 demangled symbol name. It takes a mangled string such as those returned 92 by <code class="computeroutput"><span class="keyword">typeid</span><span class="special">(</span><span class="identifier">T</span><span class="special">).</span><span class="identifier">name</span><span class="special">()</span></code> on certain implementations such as <code class="computeroutput"><span class="identifier">g</span><span class="special">++</span></code>, 93 and returns its demangled, human-readable, form. In case if demangling 94 fails (e.g. if <code class="computeroutput"><span class="identifier">name</span></code> cannot 95 be interpreted as a mangled name) the function returns <code class="computeroutput"><span class="identifier">name</span></code>. 96 </p> 97<div class="section"> 98<div class="titlepage"><div><div><h5 class="title"> 99<a name="core.demangle.header_boost_core_demangle_hpp.conventional_interface.example"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp.conventional_interface.example" title="Example">Example</a> 100</h5></div></div></div> 101<pre class="programlisting"><span class="preprocessor">#include</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">demangle</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 102<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">typeinfo</span><span class="special">></span> 103<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 104 105<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">X</span> 106<span class="special">{</span> 107<span class="special">};</span> 108 109<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 110<span class="special">{</span> 111 <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">=</span> <span class="keyword">typeid</span><span class="special">(</span> <span class="identifier">X</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="special">).</span><span class="identifier">name</span><span class="special">();</span> 112 113 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">name</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// prints 1XIiE</span> 114 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</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">demangle</span><span class="special">(</span> <span class="identifier">name</span> <span class="special">)</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// prints X<int></span> 115<span class="special">}</span> 116</pre> 117</div> 118</div> 119<div class="section"> 120<div class="titlepage"><div><div><h4 class="title"> 121<a name="core.demangle.header_boost_core_demangle_hpp.low_level_interface"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp.low_level_interface" title="Low level interface">Low 122 level interface</a> 123</h4></div></div></div> 124<p> 125 In some cases more low level interface may be desirable. For example: 126 </p> 127<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 128<li class="listitem"> 129 Assuming that symbol demangling may fail, the user wants to be able 130 to handle such errors. 131 </li> 132<li class="listitem"> 133 The user needs to post-process the demangled name (e.g. remove common 134 namespaces), and allocating a temporary string with the complete demangled 135 name is significant overhead. 136 </li> 137</ul></div> 138<p> 139 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">demangle_alloc</span></code> performs name demangling 140 and returns a pointer to a string with the demangled name, if succeeded, 141 or <code class="computeroutput"><span class="keyword">nullptr</span></code> otherwise. The 142 returned pointer must be passed to <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_free</span></code> 143 to reclaim resources. Note that on some platforms the pointer returned 144 by <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_alloc</span></code> may refer to the string 145 denoted by <code class="computeroutput"><span class="identifier">name</span></code>, so this 146 string must be kept immutable for the whole life time of the returned pointer. 147 </p> 148<p> 149 The <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">scoped_demangled_name</span></code> class is a scope 150 guard that automates the calls to <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_alloc</span></code> 151 (on its construction) and <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_free</span></code> 152 (on destruction). The string with the demangled name can be obtained with 153 its <code class="computeroutput"><span class="identifier">get</span></code> method. Note that 154 this method may return <code class="computeroutput"><span class="keyword">nullptr</span></code> 155 if demangling failed. 156 </p> 157<div class="section"> 158<div class="titlepage"><div><div><h5 class="title"> 159<a name="core.demangle.header_boost_core_demangle_hpp.low_level_interface.example"></a><a class="link" href="demangle.html#core.demangle.header_boost_core_demangle_hpp.low_level_interface.example" title="Example">Example</a> 160</h5></div></div></div> 161<pre class="programlisting"><span class="preprocessor">#include</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">demangle</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 162<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">typeinfo</span><span class="special">></span> 163<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 164 165<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">X</span> 166<span class="special">{</span> 167<span class="special">};</span> 168 169<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 170<span class="special">{</span> 171 <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">name</span> <span class="special">=</span> <span class="keyword">typeid</span><span class="special">(</span> <span class="identifier">X</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="special">).</span><span class="identifier">name</span><span class="special">();</span> 172 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">core</span><span class="special">::</span><span class="identifier">scoped_demangled_name</span> <span class="identifier">demangled</span><span class="special">(</span> <span class="identifier">name</span> <span class="special">);</span> 173 174 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">name</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// prints 1XIiE</span> 175 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="special">(</span><span class="identifier">demangled</span><span class="special">.</span><span class="identifier">get</span><span class="special">()</span> <span class="special">?</span> <span class="identifier">demangled</span><span class="special">.</span><span class="identifier">get</span><span class="special">()</span> <span class="special">:</span> <span class="string">"[unknown]"</span><span class="special">)</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">// prints X<int></span> 176<span class="special">}</span> 177</pre> 178</div> 179</div> 180</div> 181<div class="section"> 182<div class="titlepage"><div><div><h3 class="title"> 183<a name="core.demangle.acknowledgments"></a><a class="link" href="demangle.html#core.demangle.acknowledgments" title="Acknowledgments">Acknowledgments</a> 184</h3></div></div></div> 185<p> 186 The implementation of <code class="computeroutput"><span class="identifier">core</span><span class="special">::</span><span class="identifier">demangle</span></code> 187 was taken from <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">exception</span><span class="special">/</span><span class="identifier">detail</span><span class="special">/</span><span class="identifier">type_info</span><span class="special">.</span><span class="identifier">hpp</span></code>, which in turn was adapted from <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">units</span><span class="special">/</span><span class="identifier">detail</span><span class="special">/</span><span class="identifier">utility</span><span class="special">.</span><span class="identifier">hpp</span></code> and <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">log</span><span class="special">/</span><span class="identifier">utility</span><span class="special">/</span><span class="identifier">type_info_wrapper</span><span class="special">.</span><span class="identifier">hpp</span></code>. 188 </p> 189</div> 190</div> 191<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 192<td align="left"></td> 193<td align="right"><div class="copyright-footer">Copyright © 2014 Peter Dimov<br>Copyright © 2014 Glen Fernandes<br>Copyright © 2014 Andrey Semashev<p> 194 Distributed under the <a href="http://boost.org/LICENSE_1_0.txt" target="_top">Boost 195 Software License, Version 1.0</a>. 196 </p> 197</div></td> 198</tr></table> 199<hr> 200<div class="spirit-nav"> 201<a accesskey="p" href="default_allocator.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><a accesskey="n" href="empty_value.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 202</div> 203</body> 204</html> 205
