help/info/regexp.html

   1 <!--
   2  Copyright (c) 2000-2016 Ericsson Telecom AB
   3  All rights reserved. This program and the accompanying materials
   4  are made available under the terms of the Eclipse Public License v1.0
   5  which accompanies this distribution, and is available at
   6  http://www.eclipse.org/legal/epl-v10.html
   7
   8  Contributors:
   9   Baji, Laszlo
  10   Balasko, Jeno
  11   Csorba, Mate
  12   Forstner, Matyas
  13   Szabados, Kristof
  14 -->
  15 <html>
  16 <head>
  17 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  18 <meta http-equiv="Content-Language" content="en-us">
  19 <title>regexp</title>
  20 </head>
  21 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  22 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  23   <tr>
  24     <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>
  25   </tr>
  26 </table>
  27 <table border="0" align="right" cellpadding="0" cellspacing="0">
  28   <tr>
  29     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  30     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  31     <td><a alt="previous" href="refers.html"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  32     <td><a alt="next" href="rem.html"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  33   </tr>
  34 </table>
  35 <p><br clear="all">
  36 </p>
  37 <hr>
  38 <h1>regexp</h1>
  39 <hr align="left" width="75%">
  40 <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
  41 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>,
  42 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
  43 all conditions (i.e. pattern and group number) is found within the input string, an empty string is returned.
  44 <hr align="left" width="50%">
  45 <p>Related keyword:</p>
  46 <ul>
  47   <li><b><font face="Courier New" size="4" color="#003258"><a href="integer.html">integer</a></font></b></li>
  48   <li><b><a href="charstring.html"><font face="Courier New" size="4" color="#003258">charstring</font></a></b></li>
  49 </ul>
  50 <hr align="left" width="50%">
  51 <div align="center">
  52 <center>
  53 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  54   <tr>
  55     <td width="100%">
  56     <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
  57     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>
  58     </td>
  59   </tr>
  60 </table>
  61 </center>
  62 </div>
  63 <ul>
  64 </ul>
  65 <hr align="left" width="25%">
  66 <p>Example 1:</p>
  67 <p><font face="Courier New"> &nbsp;&nbsp;var charstring mypattern2 := ""<br>
  68 &nbsp;&nbsp;var charstring myinput :=" date: 2001-10-20; msgno: 17; exp "<br>
  69 &nbsp;&nbsp;var charstring mypattern := "[ \\t]#(,)date: [\\d\\-]#(,);[ \\t]#(,)msgno: (\\d#(1,3));[ \\t]#(,)(exp[ \\t]#(,))#(0,1)"<br>
  70 <br>
  71 <p>&nbsp;&nbsp;// Then the expression<br>
  72 &nbsp;&nbsp;var charstring mystring := regexp(myinput, mypattern, 0)<br>
  73 &nbsp;&nbsp;//will return the value '17'.
  74 </font></p>
  75 <hr align="left" width="25%">
  76 </body>
  77 </html>