/usr/share/doc/gnat-gps/html/Processing-the-tool-output.html

<html lang="en">
<head>
<title>Processing the tool output - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Executing-external-tools.html#Executing-external-tools" title="Executing external tools">
<link rel="prev" href="Redirecting-the-command-output.html#Redirecting-the-command-output" title="Redirecting the command output">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
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 3 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/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
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>
<div class="node">
<a name="Processing-the-tool-output"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="Redirecting-the-command-output.html#Redirecting-the-command-output">Redirecting the command output</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Executing-external-tools.html#Executing-external-tools">Executing external tools</a>
<hr>
</div>

<h5 class="subsubsection">16.6.4.6 Processing the tool output</h5>

<!--  -->
<p class="noindent">The output of the tool has now either been hidden or made visible to the user
in one or more windows.

   <p>There are several additional things that can be done with this output, for
further integration of the tool in GPS.

     <ol type=1 start=1>
<li>Parsing error messages
<a name="index-Locations_002eparse-884"></a>
External tools can usually display error messages for the user that
are associated with specific files and locations in these files. This is for
instance the way the GPS builder itself analyzes the output of <code>make</code>.

     <p>This can be done for your own tools using the shell command
<code>Locations.parse</code>. This command takes several arguments, so that you
can specify your own regular expression to find the file name, line number and
so on in the error message. By default, it is configured to work
seamlessly with error message of the forms:

     <pre class="smallexample">          file:line: message
          file:line:column: message
</pre>
     <p>Please refer to the online help for this command to get more information
(by e.g. typing <code>help Locations.parse</code> in the GPS Shell).

     <p>Here is a small example on how to run a make command and send the errors to the
location window afterward.

     <p>For languages that support it, it is also recommended that you quote the
argument with triple quotes, so that any special character (newlines, quotes,
<small class="dots">...</small>) in the output of the tool are not specially interpreted by GPS. Note
also that you should leave a space at the end, in case the output itself ends
with a quote.

     <pre class="smallexample">          &lt;?xml version="1.0" ?&gt;
          &lt;make&gt;
            &lt;action name="make example" &gt;
               &lt;external&gt;make&lt;/external&gt;
               &lt;on-failure&gt;
                  &lt;shell&gt;Locations.parse """%1 """ make_example&lt;/shell&gt;
               &lt;/on-failure&gt;
            &lt;/action&gt;
          &lt;/make&gt;
</pre>
     <li>Auto-correcting errors
<a name="index-Codefix_002eparse-885"></a>
GPS has support for automatically correcting errors for some of the languages. 
You can get access to this auto-fixing feature through the <code>Codefix.parse</code>
shell command, which takes the same arguments as for <code>Locations.parse</code>.

     <p>This will automatically add pixmaps to the relevant entries in the location
window, and therefore <code>Locations.parse</code> should be called first prior to
calling this command.

     <p>Errors can also be fixed automatically by calling the methods of the
<code>Codefix</code> class. Several codefix sessions can be active at the same time,
each of which is associated with a specific category. The list of currently
active sessions can be retrieved through the <code>Codefix.sessions()</code> command.

     <p><a name="index-Codefix_002eerrors-886"></a><a name="index-CodefixError_002efix-887"></a><a name="index-CodefixError_002epossible_005ffixes-888"></a>If support for python is enabled, you can also manipulate the fixable errors
for a given session. 
To do so, you must first get a handle on that section, as shown in the example
below. You can then get the list of fixable errors through the <code>errors</code>
command.

     <p>Each error is of the class <code>CodefixError</code>, which has one important
method <code>fix</code> which allows you to perform an automatic fixing for that
error. The list of possible fixes is retrieved through <code>possible_fixes</code>.

     <pre class="smallexample">          print GPS.Codefix.sessions ()
          session = GPS.Codefix ("category")
          errors  = session.errors ()
          print errors [0].possible_fixes ()
          errors [0].fix ()
</pre>
        </ol>

<!--  -->
   </body></html>
gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Processing-the-tool-output.html
