/usr/share/doc/gnat-gps/html/Code-Coverage.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2002-2010 AdaCore.

This document is free; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, see http://www.gnu.org/licenses/.

A copy of the license is included in the section entitled
"GNU General Public License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Using the GNAT Programming Studio: Code Coverage</title>

<meta name="description" content="Using the GNAT Programming Studio: Code Coverage">
<meta name="keywords" content="Using the GNAT Programming Studio: Code Coverage">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index-table.html#Index-table" rel="index" title="Index table">
<link href="Tools.html#Tools" rel="up" title="Tools">
<link href="Working-in-a-Cross-Environment.html#Working-in-a-Cross-Environment" rel="next" title="Working in a Cross Environment">
<link href="Metrics.html#Metrics" rel="previous" title="Metrics">
<style type="text/css">
<!--
   

a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
pre.smallexample {background-color:rgb(240,240,240);
                     font-family: courier new,courier,fixed;
                     font-size: 14px;
                     margin: 0px 40px 0px 40px;
                     border-width: 1px 2px 2px 1px;
                     border-top-style: dotted;
                     border-left-style: dotted;
                     border-right-style: solid;
                     border-bottom-style: solid;
                     border-color: black;}
   code             {color:black;
                     font-family: courier new,courier,fixed;
                     font-size: 14px;}
   body             {font-family: arial,helvetica,sans-serif;
                     font-size: 16px;
                     max-width: 800px;
                     text-align: justify}
   samp             {font-family: courier new,courier,fixed;
                     font-size: 14px}
                    

-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Code-Coverage"></a>
<div class="header">
<p>
Previous: <a href="Metrics.html#Metrics" accesskey="p" rel="previous">Metrics</a>, Up: <a href="Tools.html#Tools" accesskey="u" rel="up">Tools</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Code-Coverage-1"></a>
<h3 class="section">13.7 Code Coverage</h3>
<a name="index-Code-Coverage"></a>

<p>GPS is fitted with a strong integration of Gcov, the GNU code coverage
utility.
</p>
<p>Code coverage information can be computed from, loaded and visualized in GPS.
This can be done file by file, for each files of the current project,
project by project (in case of dependencies) or for the entire project hierarchy
currently used in GPS.
</p>
<p>Once computed then loaded, the coverage information is summarized in a
graphical report (shaped as a tree-view with percentage bars for each item)
and used to decorate source code through mechanisms such as line highlighting or
coverage annotations.
</p>
<p>All the coverage related operations are reachable via the
<code>Tools-&gt;Coverage</code> menu.
</p>
<p>In order to be loaded in GPS, the coverage information need to be computed
before, using the <code>Tools-&gt;Coverage-&gt;Gcov-&gt;Compute coverage files</code> menu
for instance.
</p>
<p>At each attempt, GPS automatically tries to load the needed information and
reports errors for missing or corrupted <code>.gcov</code> files.
</p>
<p>To be able to produce coverage information from Gcov, your project must have
been compiled with the <code>-fprofile-arcs</code> and <code>-ftest-coverage</code>&quot;
switches, respectively &quot;Instrument arcs&quot; and &quot;Code coverage&quot; entries in
<a href="The-Project-Properties-Editor.html#The-Project-Properties-Editor">The Project Properties Editor</a>, and run once.
</p>
<dl compact="compact">
<dt><b><a href="The-Tools-Menu.html#The-Tools-Menu">The Tools Menu</a></b></dt>
<dd>
<p>The <code>Tools-&gt;Coverage</code> menu have an incremental set of entries,
depending on the context.
</p>
<dl compact="compact">
<dt><code>Coverage-&gt;Gcov-&gt;Compute coverage files</code></dt>
<dd><p>Generates the <code>.gcov</code> files of current and properly compiled and run
projects.
</p>
</dd>
<dt><code>Coverage-&gt;Gcov-&gt;Remove coverage files</code></dt>
<dd><p>Deletes all the <code>.gcov</code> of current projects.
</p>

</dd>
<dt><code>Coverage-&gt;Show report</code></dt>
<dd><p>Open a new window summarizing the coverage information currently loaded in GPS.
</p>

</dd>
<dt><code>Coverage-&gt;Load data for all projects</code></dt>
<dd><p>Load or re-load the coverage information of every projects and subprojects.
</p>
</dd>
<dt><code>Coverage-&gt;Load data for project <code>XXX</code></code></dt>
<dd><p>Load or re-load the coverage information of the project <code>XXX</code>.
</p>
</dd>
<dt><code>Coverage-&gt;Load data for <samp>xxxxxxxx.xxx</samp></code></dt>
<dd><p>Load or re-load the coverage information of the specified source file.
</p>

</dd>
<dt><code>Coverage-&gt;Clear coverage from memory</code></dt>
<dd><p>Drop every coverage information loaded in GPS.
</p>
</dd>
</dl>

</dd>
<dt><b>The Contextual Menu</b></dt>
<dd>
<p>When clicking on a project, file or subprogram entity (including the entities
listed in the coverage report), you have access to a <code>Coverage</code> submenu.
</p>
<p>These submenus contain the following entries, adapted to the context related
element. For instance, if you click on a file, you will have:
</p>
<dl compact="compact">
<dt><code>Coverage-&gt;Show coverage information</code></dt>
<dd><p>Append an annotation column to the left side of the current source editor.
This column indicates which lines are covered and which aren&rsquo;t. Unexecuted lines
are also listed in the <a href="The-Locations-View.html#The-Locations-View">The Locations View</a>.
</p>
</dd>
<dt><code>Coverage-&gt;Hide coverage information</code></dt>
<dd><p>Withdraw from the current source editor a previously set coverage annotation
column and clear <a href="The-Locations-View.html#The-Locations-View">The Locations View</a> from the eventually listed uncovered
lines.
</p>
</dd>
<dt><code>Coverage-&gt;Load data for <samp>xxxxxxxx.xxx</samp></code></dt>
<dd><p>Load or re-load the coverage information of the specified source file.
</p>
</dd>
<dt><code>Coverage-&gt;Remove data of <samp>xxxxxxxx.xxx</samp></code></dt>
<dd><p>Remove the coverage information of the specified source file from GPS memory.
</p>
</dd>
<dt><code>Coverage-&gt;Show Coverage report</code></dt>
<dd><p>Open a new window summarizing the coverage information. (This entry appears
only if the contextual menu has been created from outside of the Coverage
Report.)
</p></dd>
</dl>

</dd>
<dt><b>The Coverage Report</b></dt>
<dd><a name="Coverage-Report"></a>
<p>When coverage information are loaded into GPS, a graphical report of coverage
is displayed.
</p>
<p>This report contains a tree of Projects, Files and Subprograms with
corresponding coverage information for each node in sided columns.
</p>

<a name="index-screen-shot-48"></a>
<img src="report-of-analysis_tree.jpg" alt="report-of-analysis_tree">

<p>The contextual menus generated on this widget contain, in addition to the
regular entries, some specific Coverage Report entries.
</p>
<p>These entries allow you to expand or fold the tree, and also to display flat
lists of files or subprograms instead of the tree. A flat list of file will
look like:
</p>

<a name="index-screen-shot-49"></a>
<img src="report-of-analysis_flat.jpg" alt="report-of-analysis_flat">

</dd>
</dl>

<p>GPS and Gcov both support many different programming languages, and so code
coverage features are available in GPS for many languages. But, note that
subprogram coverage details are not available for every supported languages.
</p>
<p>To finish, note that if you change the current main project in GPS, using the
<code>Project-&gt;Open</code> menu for instance, you will also drop every loaded
coverage information as they are related to the working project.
</p>
<hr>
<div class="header">
<p>
Previous: <a href="Metrics.html#Metrics" accesskey="p" rel="previous">Metrics</a>, Up: <a href="Tools.html#Tools" accesskey="u" rel="up">Tools</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Code-Coverage.html
