<!-- 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: Building & Installation</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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Building & Installation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This short guide will help you to build and install RTTR.</p>
<h2>Building </h2>
<p>RTTR can be built with any modern C++11 compiler (MSVC, MinGW, g++, clang). The build files are generated using <a href="http://www.cmake.org/" target="_blank">CMake</a> (2.8.12 or later). Because the library itself does not depend on any other 3rd party libraries, you can perform a build with just the usage of CMake.</p>
<p>e.g. for Visual Studio: </p><pre class="fragment">cmake -G "Visual Studio 12 2013" <Path to RTTR src code>
</pre><p>or gcc: </p><pre class="fragment">cmake -DCMAKE_BUILD_TYPE=Release <Path to RTTR src code>
</pre><p>However, in order to build a complete installation, <a href="http://www.boost.org/" target="_blank">Boost</a> and <a href="http://www.doxygen.org/" target="_blank">Doxygen</a> are as external dependency necessary.</p>
<ul>
<li><code>Documentation</code> : <a href="http://www.doxygen.org/" target="_blank">Doxygen</a> is used for generating the documentation (the target is called: <code>doc</code>); the config file was generated from v. 2.8.10<br />
On windows and linux you may have to put the path to the doxygen binary in the system path environment variable (<code>PATH</code>), or set it to the environment variable <code>DOXYGEN_EXECUTABLE</code> so that CMake can find it.</li>
<li><code>Benchmarks</code>: RTTR uses <a href="http://flamingdangerzone.com/nonius/" target="_blank">Nonius</a> (which is bundled with RTTR) for benchmarking and this library depends on <a href="http://flamingdangerzone.com/nonius/#main_content" target="_blank">Boost</a>.<br />
You may have to set the <code>BOOST_ROOT</code> environment variable to the Boost installation directory.</li>
</ul>
<h3>Config CMake Build</h3>
<p>The build of RTTR can be configured at CMake configuration time with following variables:</p>
<ul>
<li><code>BUILD_STATIC</code>: Build RTTR as static library; Default: <code>FALSE</code></li>
<li><code>BUILD_WITH_STATIC_RUNTIME_LIBS</code>: Link against the static runtime libraries; Default: <code>FALSE</code></li>
<li><code>BUILD_WITH_RTTI</code>: Enable the C++ language feature for runtime type information (RTTI); Default: <code>TRUE</code></li>
<li><code>BUILD_BENCHMARKS</code>: Enable this to build the benchmarks; Default: <code>TRUE</code></li>
<li><code>USE_PCH</code>: Use precompiled header files for compilation; Default: <code>TRUE</code>*</li>
<li><code>CUSTOM_DOXYGEN_STYLE</code>: Enable this option to use a custom doxygen style for HTML documentation; Otherwise the default will be used; Default: <code>TRUE</code></li>
</ul>
<p>*Precompiled headers are only supported with MSVC based build</p>
<p>After running CMake, you can start the compilation, depending on the generator: MSVC: <code>nmake</code> or <code>jom</code>, Unix based: <code>make</code>, MinGW: <code>mingw32-make</code>.</p>
<h2>Installation </h2>
<p>In order to install RTTR, you have to build the target <code>install</code>. This will create a directory called <code>install</code> in the specified build directory of RTTR. Inside this folder, you will find following folder structure:</p>
<ul>
<li><code>bin</code>: The binaries (rttr_core library (win only); benchmark executables)</li>
<li><code>cmake</code>: cmake files for finding the library in client code</li>
<li><code>doc</code>: the html documentation</li>
<li><code>include</code>: all necessary header files</li>
<li><code>lib</code>: the library files</li>
</ul>
<p>It is also possible to create a package of the installer. Therefore <a href="http://www.cmake.org/Wiki/CMake:Packaging_With_CPack" target="_blank">CPack</a> is used. Execute following command in the build directory of RTTR: </p><pre class="fragment">cpack
</pre><p>and in the root directory of the build dir will be an install package placed (e.g. <code>rttr-1.0.0-win64-vs2013.7z</code>)</p>
<h2>Using Installation of RTTR </h2>
<p>The last step is to use RTTR in your own application. During the install process also some CMake config files were created to find RTTR. For this reason, you have to set up an environment variable called: <code>RTTR_DIR</code>, which should contains the path to the installation directory.</p>
<p>e.g for windows: </p><pre class="fragment">set RTTR_DIR=c:/rttr-1.0.0-win64-vs2013
</pre><p>Then add following to your CMake script file: </p><pre class="fragment">find_package(RTTR CONFIG REQUIRED Core)
</pre><p>and final step is to link against the library: </p><pre class="fragment">target_link_libraries(MyApp RTTR::Core)
</pre><p>Following link targets are available, depending on the build config: </p><pre class="fragment">target_link_libraries(MyApp RTTR::Core) # rttr as dynamic library
target_link_libraries(MyApp RTTR::Core_STL) # rttr as dynamic library but with static runtime library
target_link_libraries(MyApp RTTR::Core_Lib) # rttr as static library
target_link_libraries(MyApp RTTR::Core_Lib_STL) # rttr as static library and static runtime library
</pre><p>That's it, you can use RTTR in your own library now. Congrats! </p>
</div></div><!-- PageDoc -->
</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:57 for rttr - 0.9.6 by
<a href="http://www.doxygen.org/index.html">doxygen</a>.
</small>
</address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
d8d30ad953f2dbe7e871721325480315
>
files
>
176
