/usr/share/doc/gnat-gps/html/Defining-new-Target-Models.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: Defining new Target Models</title>

<meta name="description" content="Using the GNAT Programming Studio: Defining new Target Models">
<meta name="keywords" content="Using the GNAT Programming Studio: Defining new Target Models">
<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="Customizing-build-Targets-and-Models.html#Customizing-build-Targets-and-Models" rel="up" title="Customizing build Targets and Models">
<link href="Defining-new-Targets.html#Defining-new-Targets" rel="next" title="Defining new Targets">
<link href="Customizing-build-Targets-and-Models.html#Customizing-build-Targets-and-Models" rel="previous" title="Customizing build Targets and Models">
<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="Defining-new-Target-Models"></a>
<div class="header">
<p>
Next: <a href="Defining-new-Targets.html#Defining-new-Targets" accesskey="n" rel="next">Defining new Targets</a>, Up: <a href="Customizing-build-Targets-and-Models.html#Customizing-build-Targets-and-Models" accesskey="u" rel="up">Customizing build Targets and Models</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Defining-new-Target-Models-1"></a>
<h4 class="subsubsection">16.5.20.1 Defining new Target Models</h4>
<a name="index-Model"></a>

<p>Models are defined in a <code>target-model</code> node which has one attributes,
<code>name</code>, which contains the name of the model, and which supports the
following sub-nodes:
</p>
<dl compact="compact">
<dt><code>&lt;icon&gt;</code></dt>
<dd><p>The stock name of the icon to associate by default with targets of this
   model.
</p></dd>
<dt><code>&lt;description&gt;</code></dt>
<dd><p>A one-line description of what the Model supports
</p></dd>
<dt><code>&lt;server&gt;</code></dt>
<dd><p>Optional, defaulting to <code>Build_Server</code>. Indicates the server used for
   launching Targets of this model. See <a href="Remote-operations.html#Remote-operations">Remote operations</a>.
</p></dd>
<dt><code>&lt;is-run&gt;</code></dt>
<dd><p>Optional, defaulting to <code>False</code>. A boolean indicating whether this
   target corresponds to the launching of an executable rather than a build.
   Targets with such a model are launched through an interactive console in
   GPS, and their output is not parsed for errors.
</p></dd>
<dt><code>&lt;uses-shell&gt;</code></dt>
<dd><p>Optional, defaulting to <code>False</code>. A boolean indicating whether Targets
   of this model should be launched via the shell pointed to by the SHELL
   environment variable.
</p></dd>
<dt><code>&lt;command-line&gt;</code></dt>
<dd><p>Contains a number of <code>&lt;arg&gt;</code> nodes, each containing an argument of the
   default command line for this model, starting with the executable.
</p></dd>
<dt><code>&lt;switches command=&quot;executable_name&quot;&gt;</code></dt>
<dd><p>The graphical description of the switches.
   (see <a href="Defining-tool-switches.html#Defining-tool-switches">Defining tool switches</a>)
</p></dd>
</dl>

<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
   &lt;my_model&gt;
   &lt;target-model name=&quot;gprclean&quot; category=&quot;&quot;&gt;
      &lt;description&gt;Clean compilation artefacts with gprclean&lt;/description&gt;
      &lt;command-line&gt;
         &lt;arg&gt;gprclean&lt;/arg&gt;
         &lt;arg&gt;-P%PP&lt;/arg&gt;
         &lt;arg&gt;%X&lt;/arg&gt;
      &lt;/command-line&gt;
      &lt;icon&gt;gps-clean&lt;/icon&gt;
      &lt;switches command=&quot;%(tool_name)s&quot; columns=&quot;1&quot;&gt;
         &lt;check label=&quot;Clean recursively&quot; switch=&quot;-r&quot;
                tip=&quot;Clean all projects recursively&quot; /&gt;
      &lt;/switches&gt;
   &lt;/target-model&gt;
&lt;/my_model&gt;
</pre></div>




</body>
</html>
gnat-gps-doc 5.0-16 / usr / share / doc / gnat-gps / html / Defining-new-Target-Models.html
