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

<meta name="description" content="Using the GNAT Programming Studio: The GPS Shell">
<meta name="keywords" content="Using the GNAT Programming Studio: The GPS Shell">
<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="The-Python-Interpreter.html#The-Python-Interpreter" rel="next" title="The Python Interpreter">
<link href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" rel="previous" title="Scripts and GPS actions">
<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="The-GPS-Shell"></a>
<div class="header">
<p>
Next: <a href="The-Python-Interpreter.html#The-Python-Interpreter" accesskey="n" rel="next">The Python Interpreter</a>, Previous: <a href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" accesskey="p" rel="previous">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="The-GPS-Shell-1"></a>
<h4 class="subsection">16.8.3 The GPS Shell</h4>
<a name="index-gps-shell"></a>

<p>The GPS shell is a very simple-minded, line-oriented language. It is
accessible through the <code>Shell</code> window at the bottom of the GPS
window. It is similar to a Unix shell, or a command window on Windows
systems.
</p>
<p>Type <code>help</code> at the prompt to get the list of available commands,
or <code>help</code> followed by the name of a command to get more
information on that specific command.
</p>
<p>The following example shows how to get some information on a source
entity, and find all references to this entity in the application. It
searches for the entity &quot;entity_name&quot;, which has at least one
reference anywhere in the file &quot;file_name.adb&quot;. After the first
command, GPS returns an identifier for this entity, which can be used
for all commands that need an entity as a parameter, as is the case
for the second command. When run, the second command will
automatically display all matching references in the location window.
</p>
<div class="smallexample">
<pre class="smallexample">GPS&gt; Entity my_entity file_name.adb
&lt;Entity_0x09055790&gt;
GPS&gt; Entity.find_all_refs &lt;Entity_0x09055790&gt;
</pre></div>

<p>Since the GPS shell is very simple, it doesn&rsquo;t provide any reference
counting for the result types. As a result, all the values returned by
a command, such as <code>&lt;Entity_0x09055790&gt;</code> in the example above,
are kept in memory.
</p>
<a name="index-clear_005fcache-command"></a>
<p>The GPS shell provides the command <code>clear_cache</code> which removes
all such values from the memory. After this command is run, you can no
longer use references obtained from previous commands, although of
course you can run these commands again to get a new reference.
</p>
<p>The return value of the 9 previous commands can easily be recalled by
passing <code>%1</code>, <code>%2</code>, &hellip; on the command line. For instance,
the previous example could be rewritten as
</p>
<div class="smallexample">
<pre class="smallexample">GPS&gt; Entity my_entity file_name.adb
&lt;Entity_0x09055790&gt;
GPS&gt; Entity.find_all_refs %1
</pre></div>

<p>These return values will be modified also for internal commands sent
by GPS, so you should really only use this when you emit multiple
commands at the same time, and don&rsquo;t do any other action in GPS. This
is mostly useful when used for command-line scripts (see <code>--eval</code>
and <code>--load</code>), or for custom files, See <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files">Customizing through XML and Python files</a>.
</p>
<p>Arguments to commands can, but need not, be quoted. If they don&rsquo;t contain
any space, double-quote (&rsquo;&quot;&rsquo;) or newline characters, you do not need to quote
them. Otherwise, you should surround them with double-quotes, and protect
any double-quote part of the argument by preceding it with a backslash.
</p>
<p>There is another way to quote a command: use three double-quotes characters in
a row. Any character loses its special meaning until the next three
double-quotes characters set. This is useful if you do not know in advance
the contents of the string you are quoting.
</p>
<div class="smallexample">
<pre class="smallexample">Locations.parse &quot;&quot;&quot;%1 &quot;&quot;&quot; category_name
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="The-Python-Interpreter.html#The-Python-Interpreter" accesskey="n" rel="next">The Python Interpreter</a>, Previous: <a href="Scripts-and-GPS-actions.html#Scripts-and-GPS-actions" accesskey="p" rel="previous">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 / The-GPS-Shell.html
