help/info/regexp.html

   1 <!--
   2  Copyright (c) 2000-2014 Ericsson Telecom AB
   3
   4  All rights reserved. This program and the accompanying materials
   5  are made available under the terms of the Eclipse Public License v1.0
   6  which accompanies this distribution, and is available at
   7  http://www.eclipse.org/legal/epl-v10.html
   8  -->
   9 <html>
  10 <head>
  11 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12 <meta http-equiv="Content-Language" content="en-us">
  13 <title>regexp</title>
  14 </head>
  15 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  16 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  17   <tr>
  18     <td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
  19   </tr>
  20 </table>
  21 <table border="0" align="right" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  24     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  25     <td><a alt="previous" href="recursive.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a alt="next" href="rem.html"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  27   </tr>
  28 </table>
  29 <p><br clear="all">
  30 </p>
  31 <hr>
  32 <h1>regexp</h1>
  33 <hr align="left" width="75%">
  34 <p>This function returns the substring of the input character string <i>instr</i>, which is the content of n-th group matching to the <i>expression</i>. In input string <i>instr</i> may be of any
  35 character string type. The type of the character string returned is the root type of <i>instr</i>. The expression is a character pattern. The number of the group to be returned is specified by <i>groupno</i>,
  36 which shall be a non-negative integer. Group numbers are assigned by the order of occurrences of the opening parenthesis of a group and counted starting from 0 by step 1. If no substring fulfilling
  37 all conditions (i.e. pattern and group number) is found within the input string, an empty string is returned.
  38 <hr align="left" width="50%">
  39 <p>Related keyword:</p>
  40 <ul>
  41   <li><b><font face="Courier New" size="4" color="#003258"><a href="integer.html">integer</a></font></b></li>
  42   <li><b><a href="charstring.html"><font face="Courier New" size="4" color="#003258">charstring</font></a></b></li>
  43 </ul>
  44 <hr align="left" width="50%">
  45 <div align="center">
  46 <center>
  47 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  48   <tr>
  49     <td width="100%">
  50     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>regexp</b></font><font face="Courier New" color="#003258" size="5"><b>(</b></font><i>any_character_string_type
  51     instr, </i><b>charstring</b> <i>expression, </i><b>integer</b><i> groupno</i><font face="Courier New" color="#003258" size="5"><b>) return character_string_type</b></font></h3>
  52     </td>
  53   </tr>
  54 </table>
  55 </center>
  56 </div>
  57 <ul>
  58 </ul>
  59 <hr align="left" width="25%">
  60 <p>Example 1:</p>
  61 <p><font face="Courier New"> &nbsp;&nbsp;var charstring mypattern2 := ""<br>
  62 &nbsp;&nbsp;var charstring myinput :=" date: 2001-10-20; msgno: 17; exp "<br>
  63 &nbsp;&nbsp;var charstring mypattern := "[ \\t]#(,)date: [\\d\\-]#(,);[ \\t]#(,)msgno: (\\d#(1,3));[ \\t]#(,)(exp[ \\t]#(,))#(0,1)"<br>
  64 <br>
  65 <p>&nbsp;&nbsp;// Then the expression<br>
  66 &nbsp;&nbsp;var charstring mystring := regexp(myinput, mypattern, 0)<br>
  67 &nbsp;&nbsp;//will return the value '17'.
  68 </font></p>
  69 <hr align="left" width="25%">
  70 </body>
  71 </html>