/usr/share/doc/gnat-gps/html/Processing-the-tool-output.html is in gnat-gps-doc 5.0-16.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | <!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: Processing the tool output</title>
<meta name="description" content="Using the GNAT Programming Studio: Processing the tool output">
<meta name="keywords" content="Using the GNAT Programming Studio: Processing the tool output">
<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="Executing-external-tools.html#Executing-external-tools" rel="up" title="Executing external tools">
<link href="Customization-examples.html#Customization-examples" rel="next" title="Customization examples">
<link href="Redirecting-the-command-output.html#Redirecting-the-command-output" rel="previous" title="Redirecting the command output">
<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="Processing-the-tool-output"></a>
<div class="header">
<p>
Previous: <a href="Redirecting-the-command-output.html#Redirecting-the-command-output" accesskey="p" rel="previous">Redirecting the command output</a>, Up: <a href="Executing-external-tools.html#Executing-external-tools" accesskey="u" rel="up">Executing external tools</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Processing-the-tool-output-1"></a>
<h4 class="subsubsection">16.6.4.6 Processing the tool output</h4>
<p>The output of the tool has now either been hidden or made visible to the user
in one or more windows.
</p>
<p>There are several additional things that can be done with this output, for
further integration of the tool in GPS.
</p>
<ol>
<li> Parsing error messages
<a name="index-Locations_002eparse"></a>
<p>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>
<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:
</p>
<div class="smallexample">
<pre class="smallexample">file:line: message
file:line:column: message
</pre></div>
<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>
<p>Here is a small example on how to run a make command and send the errors to the
location window afterward.
</p>
<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,
…) 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.
</p>
<div class="smallexample">
<pre class="smallexample"><?xml version="1.0" ?>
<make>
<action name="make example" >
<external>make</external>
<on-failure>
<shell>Locations.parse """%1 """ make_example</shell>
</on-failure>
</action>
</make>
</pre></div>
</li><li> Auto-correcting errors
<a name="index-Codefix_002eparse"></a>
<p>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>
<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>
<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"></a>
<a name="index-CodefixError_002efix"></a>
<a name="index-CodefixError_002epossible_005ffixes"></a>
<p>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>
<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>.
</p>
<div class="smallexample">
<pre class="smallexample">print GPS.Codefix.sessions ()
session = GPS.Codefix ("category")
errors = session.errors ()
print errors [0].possible_fixes ()
errors [0].fix ()
</pre></div>
</li></ol>
<hr>
<div class="header">
<p>
Previous: <a href="Redirecting-the-command-output.html#Redirecting-the-command-output" accesskey="p" rel="previous">Redirecting the command output</a>, Up: <a href="Executing-external-tools.html#Executing-external-tools" accesskey="u" rel="up">Executing external tools</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|