/usr/share/doc/gnat-gps/html/Querying-project-switches.html

<html lang="en">
<head>
<title>Querying project switches - Using the GNAT Programming Studio</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Using the GNAT Programming Studio">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Executing-external-tools.html#Executing-external-tools" title="Executing external tools">
<link rel="prev" href="Saving-open-windows.html#Saving-open-windows" title="Saving open windows">
<link rel="next" href="Querying-switches-interactively.html#Querying-switches-interactively" title="Querying switches interactively">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
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 3 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/'.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
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>
<div class="node">
<a name="Querying-project-switches"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Querying-switches-interactively.html#Querying-switches-interactively">Querying switches interactively</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Saving-open-windows.html#Saving-open-windows">Saving open windows</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Executing-external-tools.html#Executing-external-tools">Executing external tools</a>
<hr>
</div>

<h5 class="subsubsection">16.6.4.3 Querying project switches</h5>

<p><a name="index-get_005ftool_005fswitches_005fas_005fstring-877"></a><a name="index-get_005ftool_005fswitches_005fas_005flist-878"></a><a name="index-get_005fattribute_005fas_005fstring-879"></a><a name="index-get_005fattribute_005fas_005flist-880"></a><!--  -->

   <p>Some GPS shell commands can be used to query the default switches set by the
user in the project file. These are <code>get_tool_switches_as_string</code>,
<code>get_tool_switches_as_list</code>, or, more generally,
<code>get_attribute_as_string</code> and <code>get_attribute_as_list</code>. The first
two require a unique parameter which is the name of the tool as specified in
the <code>&lt;tool&gt;</code> tag. This name is case-sensitive. The last two commands are
more general and can be used to query the status of any attribute from the
project. See their description by typing the following in the GPS shell
console window:

<pre class="smallexample">     help Project.get_attribute_as_string
     help Project.get_attribute_as_list
</pre>
   <p>The following is a short example on how to query the switches for the tool
"Find" from the project, See <a href="Tool-example.html#Tool-example">Tool example</a>. It first creates an object
representing the current project, then passes this object as the first
argument of the <code>get_tool_switches_as_string</code> command. The last external
command is a simple output of these switches

<pre class="smallexample">     &lt;?xml version="1.0" ?&gt;
     &lt;find_switches&gt;
       &lt;action name="Get switches for Find"&gt;
         &lt;shell&gt;Project %p&lt;/shell&gt;
         &lt;shell&gt;Project.get_tool_switches_as_string %1 Find &lt;/shell&gt;
         &lt;external&gt;echo %1&lt;/external&gt;
       &lt;/action&gt;
     &lt;/find_switches&gt;
</pre>
   <p>The following example shows how something similar can be done from Python, in
a simpler manner. For a change, this function queries the Ada compiler
switches for the current project, and prints them out in the messages
window. The

<pre class="smallexample">     &lt;?xml version="1.0" ?&gt;
     &lt;query_switches&gt;
       &lt;action name="Query compiler switches"&gt;
         &lt;shell lang="python"&gt;GPS.Project("%p").get_attribute_as_list
           (package="compiler",
            attribute="default_switches",
            index="ada")&lt;/shell&gt;
         &lt;external&gt;echo compiler switches= %1&lt;/external&gt;
       &lt;/action&gt;
     &lt;/query_switches&gt;
</pre>
   <!--  -->
   </body></html>
gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Querying-project-switches.html
