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

<meta name="description" content="Using the GNAT Programming Studio: Scripts">
<meta name="keywords" content="Using the GNAT Programming Studio: Scripts">
<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="Scripting-GPS.html#Scripting-GPS" rel="up" title="Scripting GPS">
<link href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" rel="next" title="Scripts and GPS actions">
<link href="Scripting-GPS.html#Scripting-GPS" rel="previous" title="Scripting GPS">
<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="Scripts"></a>
<div class="header">
<p>
Next: <a href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" accesskey="n" rel="next">Scripts and GPS actions</a>, Up: <a href="Scripting-GPS.html#Scripting-GPS" accesskey="u" rel="up">Scripting GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Scripts-1"></a>
<h4 class="subsection">16.8.1 Scripts</h4>

<p>Scripts are small programs that interact with GPS and allow you to
perform complex tasks repetitively and easily. GPS includes support
for two scripting languages currently, although additional languages
might be added in the future. These two languages are described in the
following section.
</p>
<p>Support for scripting is currently work in progress in GPS. As a
result, not many commands are currently exported by GPS, although
their number is increasing daily. These commands are similar to what
is available to people who extend GPS directly in Ada, but with a
strong advantage: they do not require any recompilation of the GPS
core, and can be tested and executed interactively.
</p>
<p>The goal of such scripts is to be able to help automate processes such
as builds, automatic generation of graphs, &hellip;
</p>
<p>These languages all have a separate console associated with them,
which you can open from the <code>Tools</code> menu. In each of these
console, GPS will display a prompt, at which you can type interactive
commands. These console provide completion of the command names
through the <tt class="key">tab</tt> key.
</p>
<p>For instance, in the GPS shell console you can start typing
</p><div class="smallexample">
<pre class="smallexample">GPS&gt; File
</pre></div>

<p>then press the <tt class="key">tab</tt> key, which will list all the functions whose
name starts with &quot;File&quot;.
</p>
<p>A similar feature is available in the python console, which also
provides completion for all the standard python commands and modules.
</p>
<p>All the scripting languages share the same set of commands exported by
GPS, thanks to a abstract interface defined in the GPS core. As a
result, GPS modules do not have to be modified when new scripting
languages are added.
</p>
<a name="index-_002d_002dload"></a>
<p>Scripts can be executed immediately upon startup of GPS by using the
command line switch <code>--load</code>. Specifying the following command
line:
</p>
<div class="smallexample">
<pre class="smallexample">gps --load=shell:mytest.gps
</pre></div>

<p>will force the gps script <samp>mytest.gps</samp> to be executed
immediately, before GPS starts reacting to user&rsquo;s requests. This is
useful if you want to do some special initializations of the
environment. It can also be used as a command line interface to GPS,
if you script&rsquo;s last command is to exit GPS.
</p>
<a name="index-_002d_002deval"></a>
<p>In-line commands can also be given directly on the command line through
<code>--eval</code> command line switch.
</p>
<p>For instance, if you want to analyze an entity in the entity browser
from the command line, you would pass the following command switches:
</p>
<div class="smallexample">
<pre class="smallexample">gps --eval=shell:'Entity entity_name file_name; Entity.show %1'
</pre></div>

<p>See the section <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files">Customizing through XML and Python files</a> on how to bind key
shortcuts to shell commands.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" accesskey="n" rel="next">Scripts and GPS actions</a>, Up: <a href="Scripting-GPS.html#Scripting-GPS" accesskey="u" rel="up">Scripting GPS</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>



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