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

<meta name="description" content="Using the GNAT Programming Studio: Querying switches interactively">
<meta name="keywords" content="Using the GNAT Programming Studio: Querying switches interactively">
<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="Executing-external-tools.html#Executing-external-tools" rel="up" title="Executing external tools">
<link href="Redirecting-the-command-output.html#Redirecting-the-command-output" rel="next" title="Redirecting the command output">
<link href="Querying-project-switches.html#Querying-project-switches" rel="previous" title="Querying project switches">
<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="Querying-switches-interactively"></a>
<div class="header">
<p>
Next: <a href="Redirecting-the-command-output.html#Redirecting-the-command-output" accesskey="n" rel="next">Redirecting the command output</a>, Previous: <a href="Querying-project-switches.html#Querying-project-switches" accesskey="p" rel="previous">Querying project switches</a>, Up: <a href="Executing-external-tools.html#Executing-external-tools" accesskey="u" rel="up">Executing external tools</a> &nbsp; [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Querying-switches-interactively-1"></a>
<h4 class="subsubsection">16.6.4.4 Querying switches interactively</h4>
<a name="index-input_005fdialog"></a>
<a name="index-yes_005fno_005fdialog"></a>

<p>Another solution to query the arguments for the tool is to ask the user
interactively.
The scripting languages provides a number of solutions for these.
</p>
<p>They generally have their own native way to read input, possibly by creating
a dialog.
</p>
<p>In addition, the simplest solution is to use the predefined GPS commands for
this. These are the two functions:
</p>
<dl compact="compact">
<dt><code>yes_no_dialog</code></dt>
<dd><p>This function takes a single argument, which is a question to display. Two
buttons are then available to the user, &quot;Yes&quot; and &quot;No&quot;. The result of this
function is the button the user has selected, as a boolean value.
</p>
</dd>
<dt><code>input_dialog</code></dt>
<dd><p>This function is more general. It takes a minimum of two arguments, with no
upper limit. The first argument is a message describing what input is expected
from the user. The second, third and following arguments each correspond to
an entry line in the dialog, to query one specific value (as a string). The
result of this function is a list of strings, each corresponding to these
arguments.
</p>
<p>From the GPS shell, it is only convenient to query one value at a time, since
it doesn&rsquo;t have support for lists, and would return a concatenation of the
values. However, this function is especially useful with other scripting
languages.
</p></dd>
</dl>

<p>The following is a short example that queries the name of a directory and a
file name, and displays each in the Messages window.
</p>
<div class="smallexample">
<pre class="smallexample">&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;query_file&gt;
  &lt;action name=&quot;query file and dir&quot;&gt;
    &lt;shell lang=&quot;python&quot;&gt;list=GPS.MDI.input_dialog \
      (&quot;Please enter directory and file name&quot;, &quot;Directory&quot;, &quot;File&quot;)&lt;/shell&gt;
    &lt;shell lang=&quot;python&quot;&gt;print (&quot;Dir=&quot; + list[0], &quot;File=&quot; + list[1])&lt;/shell&gt;
    &lt;/shell&gt;
  &lt;/action&gt;
&lt;/query_file&gt;
</pre></div>

<hr>
<div class="header">
<p>
Next: <a href="Redirecting-the-command-output.html#Redirecting-the-command-output" accesskey="n" rel="next">Redirecting the command output</a>, Previous: <a href="Querying-project-switches.html#Querying-project-switches" accesskey="p" rel="previous">Querying project switches</a>, Up: <a href="Executing-external-tools.html#Executing-external-tools" accesskey="u" rel="up">Executing external tools</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 / Querying-switches-interactively.html
