blob: e50313d6e7e52e0c0baf1b271a14c06035f3dfcf [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Working with Qt Creator &mdash; OpenPASS Documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/tabs.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="../../_static/openPASS.ico"/>
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Working with Visual Studio Code" href="30_vscode.html" />
<link rel="prev" title="IDE Support" href="../10_ide_support.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> openPASS
<img src="../../_static/openPASS.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.8.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Installation Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/10_getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/30_install_openpass.html">Installing OpenPASS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/50_further_guidance.html">Further Guidance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation_guide/60_conan.html">Building with Conan</a></li>
</ul>
<p class="caption"><span class="caption-text">User Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/10_overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/20_tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/30_gui_plugins.html">GUI Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/40_configs_in_depth.html">Configs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_guide/60_scenario_simulation.html">Simulator</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/20_simulator_advanced.html">Simulator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../advanced_topics/30_testing.html">EndToEnd Test Framework</a></li>
</ul>
<p class="caption"><span class="caption-text">Developer Information</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../10_ide_support.html">IDE Support</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Working with Qt Creator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#settings-msys2">Settings (MSYS2)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#setup-cmake-kit">Setup CMake-Kit</a></li>
<li class="toctree-l4"><a class="reference internal" href="#setup-project">Setup Project</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#settings-linux">Settings (Linux)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#setup-kit">Setup Kit</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">Setup Project</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#alternative-method">Alternative Method</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="30_vscode.html">Working with Visual Studio Code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../20_documentation.html">Documentation Concept</a></li>
</ul>
<p class="caption"><span class="caption-text">Other Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../other_information/10_external_dependencies.html">External Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other_information/20_glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other_information/30_license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">openPASS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../10_ide_support.html">IDE Support</a> &raquo;</li>
<li>Working with Qt Creator</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/developer_information/ide_support/20_qt_creator.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="working-with-qt-creator">
<span id="qtcreator"></span><h1>Working with Qt Creator<a class="headerlink" href="#working-with-qt-creator" title="Permalink to this headline"></a></h1>
<div class="section" id="settings-msys2">
<h2>Settings (MSYS2)<a class="headerlink" href="#settings-msys2" title="Permalink to this headline"></a></h2>
<div class="section" id="setup-cmake-kit">
<h3>Setup CMake-Kit<a class="headerlink" href="#setup-cmake-kit" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p>Add CMake under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span> <span class="pre">-&gt;</span> <span class="pre">CMake</span></code></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_cmake.png"><img alt="../../_images/qtcreator_settings_cmake.png" src="../../_images/qtcreator_settings_cmake.png" style="width: 573.0px; height: 442.8px;" /></a>
</div>
</li>
<li><p>Add C and C++ Compilers under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span> <span class="pre">-&gt;</span> <span class="pre">Compilers</span></code></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_g++.png"><img alt="../../_images/qtcreator_settings_g++.png" src="../../_images/qtcreator_settings_g++.png" style="width: 573.0px; height: 442.8px;" /></a>
</div>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_gcc.png"><img alt="../../_images/qtcreator_settings_gcc.png" src="../../_images/qtcreator_settings_gcc.png" style="width: 573.0px; height: 442.8px;" /></a>
</div>
</li>
<li><p>Add Debugger under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span> <span class="pre">-&gt;</span> <span class="pre">Debuggers</span></code></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_gdb.png"><img alt="../../_images/qtcreator_settings_gdb.png" src="../../_images/qtcreator_settings_gdb.png" style="width: 573.0px; height: 442.8px;" /></a>
</div>
</li>
<li><p>Add Kit under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span></code></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_kit.png"><img alt="../../_images/qtcreator_settings_kit.png" src="../../_images/qtcreator_settings_kit.png" style="width: 573.0px; height: 442.8px;" /></a>
</div>
</li>
<li><p>Adjust <code class="docutils literal notranslate"><span class="pre">CMake</span> <span class="pre">Generator</span></code> under <code class="docutils literal notranslate"><span class="pre">Tools</span> <span class="pre">-&gt;</span> <span class="pre">Options</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span> <span class="pre">-&gt;</span> <span class="pre">Kits</span></code> to <code class="docutils literal notranslate"><span class="pre">MSYS</span> <span class="pre">Makefiles</span></code></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_settings_cmake_generator.png"><img alt="../../_images/qtcreator_settings_cmake_generator.png" src="../../_images/qtcreator_settings_cmake_generator.png" style="width: 169.2px; height: 123.6px;" /></a>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Change the environment variable to <code class="docutils literal notranslate"><span class="pre">MAKEFLAGS=-j4</span></code> (or similar) to enable parallel building on the kit level.</p>
</div>
</li>
</ol>
</div>
<div class="section" id="setup-project">
<h3>Setup Project<a class="headerlink" href="#setup-project" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p>Load the project by opening a <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> file and configure it to use the new kit.</p></li>
<li><p>Setup missing CMake flags (c.f. :ref:’CMake’)</p>
<div class="admonition-todo admonition" id="id1">
<p class="admonition-title">Todo</p>
<p>The configuration is still “itchy”, as Qt creator changes the interface with every version</p>
</div>
</li>
</ol>
</div>
</div>
<div class="section" id="settings-linux">
<h2>Settings (Linux)<a class="headerlink" href="#settings-linux" title="Permalink to this headline"></a></h2>
<div class="section" id="setup-kit">
<h3>Setup Kit<a class="headerlink" href="#setup-kit" title="Permalink to this headline"></a></h3>
<p>Qt Creator should be able to come up with a suiteable kit for developing <strong>openPASS</strong> on its own.
If not, check if all <a class="reference internal" href="../../installation_guide/20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a> are met. Also, the steps above should be a good indicator, where to look for potential troubles.</p>
</div>
<div class="section" id="id2">
<h3>Setup Project<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ol class="arabic">
<li><p>Load the project by opening a <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> file and configure it to use a proper kit.</p></li>
<li><p>Setup missing CMake flags (c.f. :ref:’CMake’)</p>
<div class="admonition-todo admonition" id="id3">
<p class="admonition-title">Todo</p>
<p>The configuration is still “itchy”, as Qt creator changes the interface with every version</p>
</div>
</li>
</ol>
</div>
</div>
<div class="section" id="alternative-method">
<h2>Alternative Method<a class="headerlink" href="#alternative-method" title="Permalink to this headline"></a></h2>
<div class="admonition-version-issues admonition">
<p class="admonition-title">Version Issues</p>
<p>Qt Creator is constantly improving the CMake integration.
Unfortunatly, some versions seem to be <strong>buggy</strong>.</p>
<p>Tested Versions: 4.13.2 | 4.12.2</p>
</div>
<ol class="arabic">
<li><p>Follow the install instructions to invoke cmake from within your own build directory.
- Execute the step for <code class="docutils literal notranslate"><span class="pre">build-release</span></code>
- Execute the step for <code class="docutils literal notranslate"><span class="pre">build-debug</span></code></p></li>
<li><p>Open Qt Creator</p></li>
<li><p>Open <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code></p></li>
<li><p>Qt Creator should find the configured build directories and create a temporary kit</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_project_cmake.png"><img alt="../../_images/qtcreator_project_cmake.png" src="../../_images/qtcreator_project_cmake.png" style="width: 603.6px; height: 414.59999999999997px;" /></a>
</div>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_project_loaded.png"><img alt="../../_images/qtcreator_project_loaded.png" src="../../_images/qtcreator_project_loaded.png" style="width: 603.6px; height: 414.59999999999997px;" /></a>
</div>
<div class="figure align-center">
<a class="reference internal image-reference" href="../../_images/qtcreator_project_cmake_settings.png"><img alt="../../_images/qtcreator_project_cmake_settings.png" src="../../_images/qtcreator_project_cmake_settings.png" style="width: 603.6px; height: 414.59999999999997px;" /></a>
</div>
</li>
</ol>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="30_vscode.html" class="btn btn-neutral float-right" title="Working with Visual Studio Code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../10_ide_support.html" class="btn btn-neutral float-left" title="IDE Support" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021 OpenPASS Working Group.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>