/usr/share/doc/gnat-gps/html/Output-parsers.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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 | <!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: Output parsers</title>
<meta name="description" content="Using the GNAT Programming Studio: Output parsers">
<meta name="keywords" content="Using the GNAT Programming Studio: Output parsers">
<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="Describing-a-VCS.html#Describing-a-VCS" rel="up" title="Describing a VCS">
<link href="Implementing-VCS-actions.html#Implementing-VCS-actions" rel="next" title="Implementing VCS actions">
<link href="Defining-status.html#Defining-status" rel="previous" title="Defining status">
<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="Output-parsers"></a>
<div class="header">
<p>
Previous: <a href="Defining-status.html#Defining-status" accesskey="p" rel="previous">Defining status</a>, Up: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="u" rel="up">Describing a VCS</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Output-parsers-1"></a>
<h4 class="subsubsection">16.9.2.5 Output parsers</h4>
<p>There are cases in which GPS needs to parse the output of the VCS
commands: when querying the status, or when “annotating” a
file.
</p>
<p>The following parsers can be implemented in the <code>vcs</code> node.
</p>
<dl compact="compact">
<dt><b><code><status_parser></code>, <code><local_status_parser></code> and <code><update_parser></code></b></dt>
<dd><p>These parsers are used by the command VCS.status_parse, to parse a string for
the status of files controlled by a VCS.
</p>
<p>They accept the following child nodes:
</p>
<dl compact="compact">
<dt><b><code><regexp></code> (mandatory)</b></dt>
<dd><p>Indicates the regular expression to match.
</p></dd>
<dt><b><code><file_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the name
of a file.
</p></dd>
<dt><b><code><status_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the file
status. This status is passed through the regular expressions defined in the
<code>status_matcher</code> nodes, see below.
</p></dd>
<dt><b><code><local_revision_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the name
of the local revision (the version of the file that was checked out).
</p></dd>
<dt><b><code><repository_revision_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the name
of the repository revision (the latest version of the file in the VCS).
</p>
</dd>
<dt><b><code><status_matcher></code></b></dt>
<dd><p>A regular expression which, when matching an expressions, identifies the status
passed in the node attribute <code>label</code>.
</p></dd>
</dl>
</dd>
<dt><b><code><annotations_parser></code></b></dt>
<dd><p>This parser is used by the command VCS.annotations_parse, to parse a string for
annotations in a file controlled by a VCS.
</p>
<p>It accepts the following child nodes:
</p>
<dl compact="compact">
<dt><b><code><regexp></code> (mandatory)</b></dt>
<dd><p>Indicates the regular expression to match.
</p>
</dd>
<dt><b><code><repository_revision_index></code> (mandatory)</b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
repository revision of the line.
</p>
</dd>
<dt><b><code><author_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
author of the line.
</p>
</dd>
<dt><b><code><date_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
date of the line.
</p>
</dd>
<dt><b><code><file_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that indicates the
part of the line that belongs to the file.
</p>
</dd>
<dt><b><code><tooltip_pattern></code></b></dt>
<dd><p>A template pattern that will be used to format the tooltip information.
It can contain text and reference parenthesized expressions in
<code>regexp</code> using \<code>n</code> (where <code>n</code> represents the nth
expression in <code>regexp</code>).
</p>
</dd>
</dl>
</dd>
<dt><b><code><log_parser></code></b></dt>
<dd><p>This parser is used by the command VCS.log_parse, to parse a string for
revision histories in a file controlled by a VCS.
</p>
<p>It accepts the following child nodes:
</p>
<dl compact="compact">
<dt><b><code><regexp></code> (mandatory)</b></dt>
<dd><p>Indicates the regular expression to match.
</p>
</dd>
<dt><b><code><repository_revision_index></code> (mandatory)</b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
repository revision of the log.
</p>
</dd>
<dt><b><code><author_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
author of the log.
</p>
</dd>
<dt><b><code><date_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
date of the log.
</p>
</dd>
<dt><b><code><log_index></code></b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
actual text of the log.
</p></dd>
</dl>
</dd>
<dt><b><code><revision_parser></code></b></dt>
<dd><p>This parser is used by the command VCS.revision_parse, to parse a string for
revision tags and branches in a file controlled by a VCS.
</p>
<p>It accepts the following child nodes:
</p>
<dl compact="compact">
<dt><b><code><regexp></code> (mandatory)</b></dt>
<dd><p>Indicates the regular expression to match.
</p>
</dd>
<dt><b><code><sym_index></code> (mandatory)</b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
tags or branches symbolic name of the revision.
</p>
</dd>
<dt><b><code><repository_revision_index></code> (mandatory)</b></dt>
<dd><p>An index of a parenthesized expression in <code>regexp</code> that contains the
repository revision number of the revision.
</p>
</dd>
</dl>
</dd>
</dl>
<hr>
<div class="header">
<p>
Previous: <a href="Defining-status.html#Defining-status" accesskey="p" rel="previous">Defining status</a>, Up: <a href="Describing-a-VCS.html#Describing-a-VCS" accesskey="u" rel="up">Describing a VCS</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|