/usr/share/doc/gnat-gps/html/Querying-project-switches.html is in gnat-gps-doc 5.0-16.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | <!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 project switches</title>
<meta name="description" content="Using the GNAT Programming Studio: Querying project switches">
<meta name="keywords" content="Using the GNAT Programming Studio: Querying project switches">
<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="Querying-switches-interactively.html#Querying-switches-interactively" rel="next" title="Querying switches interactively">
<link href="Saving-open-windows.html#Saving-open-windows" rel="previous" title="Saving open windows">
<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-project-switches"></a>
<div class="header">
<p>
Next: <a href="Querying-switches-interactively.html#Querying-switches-interactively" accesskey="n" rel="next">Querying switches interactively</a>, Previous: <a href="Saving-open-windows.html#Saving-open-windows" accesskey="p" rel="previous">Saving open windows</a>, Up: <a href="Executing-external-tools.html#Executing-external-tools" accesskey="u" rel="up">Executing external tools</a> [<a href="Index-table.html#Index-table" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Querying-project-switches-1"></a>
<h4 class="subsubsection">16.6.4.3 Querying project switches</h4>
<a name="index-get_005ftool_005fswitches_005fas_005fstring"></a>
<a name="index-get_005ftool_005fswitches_005fas_005flist"></a>
<a name="index-get_005fattribute_005fas_005fstring"></a>
<a name="index-get_005fattribute_005fas_005flist"></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><tool></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:
</p>
<div class="smallexample">
<pre class="smallexample">help Project.get_attribute_as_string
help Project.get_attribute_as_list
</pre></div>
<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
</p>
<div class="smallexample">
<pre class="smallexample"><?xml version="1.0" ?>
<find_switches>
<action name="Get switches for Find">
<shell>Project %p</shell>
<shell>Project.get_tool_switches_as_string %1 Find </shell>
<external>echo %1</external>
</action>
</find_switches>
</pre></div>
<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
</p>
<div class="smallexample">
<pre class="smallexample"><?xml version="1.0" ?>
<query_switches>
<action name="Query compiler switches">
<shell lang="python">GPS.Project("%p").get_attribute_as_list
(package="compiler",
attribute="default_switches",
index="ada")</shell>
<external>echo compiler switches= %1</external>
</action>
</query_switches>
</pre></div>
</body>
</html>
|