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

<meta name="description" content="Using the GNAT Programming Studio: Macro arguments">
<meta name="keywords" content="Using the GNAT Programming Studio: Macro arguments">
<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-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" rel="up" title="Customizing through XML and Python files">
<link href="Filtering-actions.html#Filtering-actions" rel="next" title="Filtering actions">
<link href="Defining-Actions.html#Defining-Actions" rel="previous" title="Defining 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="Macro-arguments"></a>
<div class="header">
<p>
Next: <a href="Filtering-actions.html#Filtering-actions" accesskey="n" rel="next">Filtering actions</a>, Previous: <a href="Defining-Actions.html#Defining-Actions" accesskey="p" rel="previous">Defining Actions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Macro-arguments-1"></a>
<h4 class="subsection">16.5.3 Macro arguments</h4>
<a name="index-menu-16"></a>
<a name="index-argument"></a>
<a name="index-substitution"></a>

<p>When an action is defined, you can use macro arguments to pass to your
shell or external commands. Macro arguments
are special parameters that are transformed every time the command is executed.
The following macro arguments are provided.
</p>
<p>The equivalent python command is given for all tests. These commands are useful
when you are writing a full python script, and want to test for yourself
whether the context is properly defined.
</p>
<dl compact="compact">
<dt><code>%a</code></dt>
<dd><p>If the user clicked within the Locations Window, this is the name of the
category to which the current line belongs
</p>
</dd>
<dt><code>%builder</code></dt>
<dd><p>Replaced by the default builder configured in GPS.
This can be e.g. <code>gnatmake</code> if your project contains only Ada code,
or <code>gprbuild</code> for non Ada or multi-language projects, or <code>gprmake</code>
if you have set the multi language builder preference accordingly.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%c</code></dt>
<dd><p>This is the column number on which the user clicked.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().column()
</pre></div>

</dd>
<dt><code>%d</code></dt>
<dd><p>The current directory.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().directory()
</pre></div>

</dd>
<dt><code>%dk</code></dt>
<dd><p>The krunched name of the current directory.
</p>
</dd>
<dt><code>%e</code></dt>
<dd><p>Name of the entity the user clicked on.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().entity().name()
</pre></div>

</dd>
<dt><code>%E</code></dt>
<dd><p>The full path to the executable name corresponding to the target.
</p>
</dd>
<dt><code>%ek</code></dt>
<dd><p>Krunched name of the entity the user clicked on.
This is the same as <code>%e</code>, except long names are shorted as in <code>%fk</code>.
</p>
</dd>
<dt><code>%eL</code></dt>
<dd><p>Replaced by either an empty string, or <code>-eL</code>, depending on whether the
<code>Fast Project Loading</code> preference if set or not.
<code>-eL</code> is used by GNAT tools to specify whether symbolink links
should be followed or not when parsing projects.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%external</code></dt>
<dd><p>Replaced by the command line specified in the preference
  <i>External Commands-&gt;Execute command</i>.
</p>
</dd>
<dt><code>%f</code></dt>
<dd><p>Base name of the currently selected file.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">import os.path
os.path.basename (GPS.current_context().file().name())
</pre></div>

</dd>
<dt><code>%F</code></dt>
<dd><p>Absolute name of the currently opened file.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().file().name()
</pre></div>

</dd>
<dt><code>%fk</code></dt>
<dd><p>Krunched base name of the currently selected file.
This is the same as %f, except that long names are shortened, and their middle
letters are replaced by &quot;[...]&quot;. This should be used in particular in menu
labels, to keep the menus narrow.
</p>
</dd>
<dt><code>%fp</code></dt>
<dd><p>Base name of the currently selected file. If the file is not part of the project
tree, or no file is selected, generate an error on the Messages window.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%gnatmake</code></dt>
<dd><p>Replaced by the gnatmake executable configured in your project file.
</p>
</dd>
<dt><code>%gprbuild</code></dt>
<dd><p>Replaced by the gprbuild or gprmake command line configured in your project
file.
</p>
</dd>
<dt><code>%gprclean</code></dt>
<dd><p>Replaced by the default cleaner configured in GPS.
This can be e.g. <code>gnat clean</code>, or <code>gprclean</code>.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%i</code></dt>
<dd><p>If the user clicked within the Project View, this is the name of the parent
project, ie the one that is importing the one the user clicked on. Note that
with this definition of parent project, a given project might have multiple
parents. The one that is returned is read from the Project View itself.
</p>
</dd>
<dt><code>%l</code></dt>
<dd><p>This is the line number on which the user clicked.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().line()
</pre></div>

</dd>
<dt><code>%o</code></dt>
<dd><p>The object directory of the current project.
</p>
</dd>
<dt><code>%O</code></dt>
<dd><p>The object directory of the root project.
</p>
</dd>
<dt><code>%p</code></dt>
<dd><p>The current project. This is the name of the project, not the project file, ie
the <samp>.gpr</samp> extension is not included in this name, and the casing is the
one found inside the project file, not the one of the file name itself.
If the current context is an editor, this is the name of the project to which
the source file belongs.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().project().name()
</pre></div>

</dd>
<dt><code>%P</code></dt>
<dd><p>The root project. This is the name of the project, not the project file.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.Project.root().name()
</pre></div>

</dd>
<dt><code>%Pb</code></dt>
<dd><p>The basename of the root project file.
</p>
</dd>
<dt><code>%Pl</code></dt>
<dd><p>The name of the root project, all lower case.
</p>
</dd>
<dt><code>%pp</code></dt>
<dd><p>The current project file pathname. If a file is selected, this is the project
file to which the source file belongs.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().project().file().name()
</pre></div>

</dd>
<dt><code>%PP</code></dt>
<dd><p>The root project pathname.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.Project.root().file().name()
</pre></div>

</dd>
<dt><code>%pps</code></dt>
<dd><p>This is similar to <code>%pp</code>, except it returns the project name prepended
with <code>-P</code>, or an empty string if there is no project file selected and the
current source file doesn&rsquo;t belong to any project. This is mostly for use with
the GNAT command line tools. The project name is quoted if it contains spaces.
Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">if GPS.current_context().project():
   return &quot;-P&quot; &amp; GPS.current_context().project().file().name()
</pre></div>

</dd>
<dt><code>%PPs</code></dt>
<dd><p>This is similar to <code>%PP</code>, except it returns the project name prepended
with <code>-P</code>, or an empty string if the root project is the default project.
This is mostly for use with the GNAT command line tools.
</p>
</dd>
<dt><code>%(p|P)[r](d|s)[f]</code></dt>
<dd><p>Substituted by the list of sources or directories of a given project. This list
is a list of space-separated, quoted names (all names are surrounded by double
quotes, for proper handling of spaces in directories or file names).
</p>
<dl compact="compact">
<dt><code>P</code></dt>
<dd><p>the root project.
</p>
</dd>
<dt><code>p</code></dt>
<dd><p>the selected project, or the root project if there is no project selected.
</p>
</dd>
<dt><code>r</code></dt>
<dd><p>recurse through the projects: sub projects will be listed as well as their
sub projects, etc&hellip;
</p>
</dd>
<dt><code>d</code></dt>
<dd><p>list the source directories.
</p>
<p>Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().project().source_dirs()
</pre></div>

</dd>
<dt><code>s</code></dt>
<dd><p>list the source files.
</p>
<p>Python equivalent:
</p><div class="smallexample">
<pre class="smallexample">GPS.current_context().project().sources()
</pre></div>

</dd>
<dt><code>f</code></dt>
<dd><p>output the list into a file and substitute the parameter with the
name of that file. This file is never deleted by GPS, it is your responsibility
to do so.
</p></dd>
</dl>

</dd>
<dt><code>%s</code></dt>
<dd><p>This is the text selected by the user, if a single line was selected. When
multiple lines were selected, this returns the empty string
</p>
</dd>
<dt><code>%S</code></dt>
<dd><p>This is either the text selected by the user, of the current entity if there
is no selection. If the entity is part of an expression (&quot;A.B.C&quot;), then the
whole expression is used instead of the entity name.
</p>
</dd>
<dt><code>%switches(tool)</code></dt>
<dd><p>Replaced by <code>IDE'Default_Switches (tool)</code>, in other words, if you
have a tool whose switches are defined via an xml file in GPS, they
are stored as <code>Default_Switches (xxx)</code> in the <code>IDE</code> package
and can be retrieved using this macro. The value returned is a list of
switches, or an empty list if not set.
</p>
<p>Note: This macro is only available in the commands defined in the Build
Manager and Build Launcher dialogs.
</p>
</dd>
<dt><code>%T</code></dt>
<dd><p>Replaced by the subtarget being considered for building.
Depending on the context, this can correspond to e.g. the base filename of a
Main source, or makefile targets.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%TT</code></dt>
<dd><p>Same as <code>%TT</code>, but returns the full path to main sources rather than
the base filename.
</p>
</dd>
<dt><code>%attr(Package'Name[,default])</code></dt>
<dd><p>Replaced by the project attribute <code>Package'Name</code>, in other words, the
attribute <code>Name</code> from the package <code>Package</code>. <code>Package'</code> is
optional if <code>Name</code> is a top level attribute (e.g. <code>Object_Dir</code>).
</p>
<p>If the attribute is not defined in the project, an optional <code>default</code>
value is returned, or an empty string if not.
</p>
<p>Note: This macro is only available in the commands defined in the Build
Manager and Build Launcher dialogs, and only supports single string attributes,
not lists.
</p>
</dd>
<dt><code>%dirattr(Package'Name[,default])</code></dt>
<dd><p>Replaced by the directory part of an attribute. The attribute is specified
as in <code>%attr</code> above.
</p>
</dd>
<dt><code>%baseattr(Package'Name[,default])</code></dt>
<dd><p>Replaced by the base name of an attribute. The attribute is specified
as in <code>%attr</code> above.
</p>
</dd>
<dt><code>%vars</code></dt>
<dd><p>Replaced by a list of switches of the form <code>&lt;variable&gt;=&lt;value&gt;</code>, where
&lt;variable&gt; is the name of a scenario variable and &lt;value&gt; its current
value, as configured in the Scenario View. All the scenario variables
defined in the current project tree will be listed.
Alternatively, you can also use <code>%vars(-D)</code> to generate a list of
switches of the form <code>-D&lt;variable&gt;=&lt;value&gt;</code>.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%X</code></dt>
<dd><p>Replaced by a list of switches of the form <code>-X&lt;variable&gt;=&lt;value&gt;</code>, where
&lt;variable&gt; is the name of a scenario variable and &lt;value&gt; its current
value, as configured in the Scenario View. All the scenario variables
defined in the current project tree will be listed.
Note: this macro is only available in the commands defined in the Build
Manager and the Build Launcher dialogs.
</p>
</dd>
<dt><code>%%</code></dt>
<dd><p>Replaced by the % sign.
</p></dd>
</dl>

<a name="index-example-14"></a>
<p>Examples:
</p>
<dl compact="compact">
<dt><code>%Ps</code></dt>
<dd><p>Replaced by a list of source files in the root project.
</p>
</dd>
<dt><code>%prs</code></dt>
<dd><p>Replaced by a list of files in the current project, and all imported
sub projects, recursively.
</p>
</dd>
<dt><code>%prdf</code></dt>
<dd><p>Replaced by the name of a file that contains a list of source
directories in the current project, and all imported sub projects,
recursively.
</p></dd>
</dl>

<p>Another type of macros are expanded before commands are executed: These
all start with the <code>$</code> character, and represent parameters passed to
the action by its caller. Depending on the context, GPS will give zero, one
or more arguments to the action. This is in particular used when you define
your own VCS system. See also the shell function <code>execute_action</code>, which
you can use yourself to execute an action and pass it some arguments.
</p>
<p>These arguments are the following
</p><dl compact="compact">
<dt><code>$1, $2, ... $n</code></dt>
<dd><p>Where n is a number. These are each argument passed to the action
</p>
</dd>
<dt><code>$1-, $2-, ... $n-</code></dt>
<dd><p>This represents a string concatenating the specified argument and all
arguments after it
</p>
</dd>
<dt><code>$*</code></dt>
<dd><p>This represents a string concatenating all arguments passed to the action
</p>
</dd>
<dt><code>$repeat</code></dt>
<dd><p>This is the number of times the action has been repeated in a row. It will in
general be 1 (ie this is the first execution of the action), unless the user
has first executed the action <code>&quot;Repeat Next&quot;</code>, which allows automatic
repetition of an action.
</p>
<p>By default, when the action &quot;Repeat Next&quot; is invoked by the user, it will repeat
the following action as many times as the user specified. However, in some cases,
either for efficiency reasons or simply for technical reasons, you might want to
handle yourself the repear. This can be done with the following action
declaration:
</p>
<div class="smallexample">
<pre class="smallexample">&lt;action name=&quot;my_action&quot;&gt;
   &lt;shell lang=&quot;python&quot;&gt;if $repeat==1: my_function($remaining + 1)&lt;/shell&gt;
&lt;/action&gt;

def my_function (count):
   &quot;&quot;&quot;Perform an action count times&quot;&quot;&quot;
   ...
</pre></div>

<p>Basically, the technics here is to only perform something the first time the
action is called (hence the if statement), but pass your shell function the
number of times that it should repeat (hence the <code>$remaining</code> parameter).
</p>
</dd>
<dt><code>$remaining</code></dt>
<dd><p>This is similar to $repeat, and indicates the number of times that the action
remains to be executed. This will generally be 0, unless the user has chosen
to automatically repeat the action a number of times.
</p>
</dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="Filtering-actions.html#Filtering-actions" accesskey="n" rel="next">Filtering actions</a>, Previous: <a href="Defining-Actions.html#Defining-Actions" accesskey="p" rel="previous">Defining Actions</a>, Up: <a href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" accesskey="u" rel="up">Customizing through XML and Python files</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 / Macro-arguments.html
