/usr/share/doc/gnat-gps/html/Defining-new-search-patterns.html

<html lang="en">
<head>
<title>Defining new search patterns - 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="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files" title="Customizing through XML and Python files">
<link rel="prev" href="Creating-themes.html#Creating-themes" title="Creating themes">
<link rel="next" href="Adding-support-for-new-languages.html#Adding-support-for-new-languages" title="Adding support for new languages">
<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="Defining-new-search-patterns"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="Adding-support-for-new-languages.html#Adding-support-for-new-languages">Adding support for new languages</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Creating-themes.html#Creating-themes">Creating themes</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Customizing-through-XML-and-Python-files.html#Customizing-through-XML-and-Python-files">Customizing through XML and Python files</a>
<hr>
</div>

<h4 class="subsection">16.5.11 Defining new search patterns</h4>

<p><a name="index-g_t_003cvsearch_002dpattern_003e-821"></a><a name="index-predefined-patterns-822"></a><!--  -->

<p class="noindent">The search dialog contains a number of predefined search patterns for Ada, C
and C++. These are generally complex regular expressions, presented in the
dialog with a more descriptive name. This includes for instance
"Ada assignment", which will match all such assignments.

   <p>You can define your own search patterns in the customization files. This is
done through the <code>&lt;vsearch-pattern&gt;</code> tag. This tag can have a number of
children tags:

     <dl>
<dt><code>&lt;name&gt;</code><dd>
This tag is the string that is displayed in the search dialog to
represent the new pattern. This is the text that the user will
effectively see, instead of the often hard to understand regular
expression.

     <br><dt><code>&lt;regexp&gt;</code><dd>
This tag provides the regular expression to use when the pattern has
been selected by the user. Be careful that you must protect reserved
XML characters such as '&lt;' and replace them by their equivalent
expansion ("&amp;lt;" for this character).

     <p>This accepts one optional attribute, named <code>case-sensitive</code>. This
attribute accepts one of two possible values ("true" or "false") which
indicates whether the search should distinguish lower case and upper
case letters. Its default value is "false".

     <br><dt><code>&lt;string&gt;</code><dd>
This tag provides a constant string that should be searched. 
Only one of <code>&lt;regexp&gt;</code> and <code>&lt;string&gt;</code> should be provided. If
both exists, the first <code>&lt;regexp&gt;</code> child found is used. If there is
none, the first <code>&lt;string&gt;</code> child is used.

     <p>The tag accepts the same optional attribute <code>case-sensitive</code> as
above
</dl>

   <p>Here is a small example on how the "Ada assignment" pattern was
defined.

<pre class="smallexample">     &lt;?xml version="1.0" ?&gt;
     &lt;search&gt;
       &lt;vsearch-pattern&gt;
         &lt;name&gt;Ada: assignment&lt;/name&gt;
         &lt;regexp case-sensitive="false"&gt;\b(\w+)\s*:=&lt;/regexp&gt;
       &lt;/vsearch-pattern&gt;
     &lt;/search&gt;
</pre>
   <!--  -->
   </body></html>
gnat-gps-doc 5.0-6 / usr / share / doc / gnat-gps / html / Defining-new-search-patterns.html
