/usr/share/doc/gnat-gps/html/Metrics.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: Metrics</title>

<meta name="description" content="Using the GNAT Programming Studio: Metrics">
<meta name="keywords" content="Using the GNAT Programming Studio: Metrics">
<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="Code-Coverage.html#Code-Coverage" rel="next" title="Code Coverage">
<link href="Documentation-Generation.html#Documentation-Generation" rel="previous" title="Documentation Generation">
<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="Metrics"></a>
<div class="header">
<p>
Next: <a href="Code-Coverage.html#Code-Coverage" accesskey="n" rel="next">Code Coverage</a>, Previous: <a href="Documentation-Generation.html#Documentation-Generation" accesskey="p" rel="previous">Documentation Generation</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="Metrics-1"></a>
<h3 class="section">13.6 Metrics</h3>
<a name="index-Metrics"></a>

<p>GPS provides an interface with the GNAT software metrics generation tool
<code>gnatmetric</code>.
</p>
<p>The metrics can be computed for the entire project, one source file belonging to
the project, or (when applicable) a specific entity in the source file, e.g. a
subprogram.
</p>
<p>The metrics generator can be invoked from two places inside GPS:
</p>
<dl compact="compact">
<dt><b><a href="The-Tools-Menu.html#The-Tools-Menu">The Tools Menu</a></b></dt>
<dd>
<dl compact="compact">
<dt><code>Metrics-&gt;Compute metrics for root project</code></dt>
<dd><p>Generate metrics for all files from the root project.
</p>
</dd>
<dt><code>Metrics-&gt;Compute metrics for current file</code></dt>
<dd><p>Generate metrics for the current source file.
</p>
</dd>
</dl>

</dd>
<dt><b>The Contextual Menu</b></dt>
<dd>
<p>When relevant (depending on the context), right-clicking with your mouse
will show metrics-related contextual menu entries.
</p>
<p>From a source file contextual menu, you have an option called
<code>Metrics for file</code> that will generate the metrics for
the current file.
</p>
<p>From a project contextual menu (see <a href="The-Project-View.html#The-Project-View">The Project View</a>), you have an
option <code>Metrics for project</code> that will generate the metrics for
all files in the project.
</p>
</dd>
</dl>

<p>Each of these commands produces a new window in the left-side area,
which shows the computed metrics as a hierarchical tree view. The metrics
are arranged by files, and then by scopes inside the files in a nested fashion.
Double-clicking on any of the files or scopes displayed will open the
appropriate source location in the editor. Any errors encountered during
metrics computation will be displayed in the Locations Window.
</p>



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