File: regexp.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (750 lines) | stat: -rw-r--r-- 13,659 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>regexp</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>regexp</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
regexp
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Regular Expression Functions for Strings

</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>This module contains functions for regular expression
matching and substitution.

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="match/2"><STRONG><CODE>match(String, RegExp) -&#62; MatchRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>MatchRes = {match,Start,Length} | nomatch | {error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>Start = Length = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Finds the first, longest match of the regular expression <CODE>RegExp</CODE> in <CODE>String</CODE>. This function searches for the longest possible match and returns the first one found if there are several expressions of the same length. It returns as follows:

<P>
<DL>

<DT>
<CODE>{match,Start,Length}</CODE> 
</DT>

<DD>
if the match succeeded. <CODE>Start</CODE> is the starting
position of the match, and <CODE>Length</CODE> is the length of
the matching string.<BR>

</DD>

<DT>
<CODE>nomatch</CODE> 
</DT>

<DD>
if there were no matching characters.<BR>

</DD>

<DT>
<CODE>{error,Error}</CODE> 
</DT>

<DD>
if there was an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="first_match/2"><STRONG><CODE>first_match(String, RegExp) -&#62; MatchRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>MatchRes = {match,Start,Length} | nomatch |
{error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>Start = Length = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Finds the first match of the regular expression <CODE>RegExp</CODE> in <CODE>String</CODE>. This call is
usually faster than <CODE>match</CODE> and it is also a useful way to ascertain that a match exists. It returns as follows:

<P>
<DL>

<DT>
<CODE>{match,Start,Length}</CODE>
</DT>

<DD>
 if the match succeeded. <CODE>Start</CODE> is the starting
position of the match and <CODE>Length</CODE> is the length of
the matching string.<BR>

</DD>

<DT>
<CODE>nomatch</CODE> 
</DT>

<DD>
if there were no matching characters.<BR>

</DD>

<DT>
<CODE>{error,Error}</CODE>
</DT>

<DD>
 if there was an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="matches/2"><STRONG><CODE>matches(String, RegExp) -&#62; MatchRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>MatchRes = {match, Matches} | {error, errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>Matches = list()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Finds all non-overlapping matches of the
expression <CODE>RegExp</CODE> in <CODE>String</CODE>.
         It returns as follows:

<P>
<DL>

<DT>
<CODE>{match, Matches}</CODE>
</DT>

<DD>
 if the regular expression was correct.
The list will be empty if there was no match. Each element in the list looks like <CODE>{Start, Length}</CODE>, where <CODE>Start</CODE> is the starting position of the match, and <CODE>Length</CODE> is the length of the matching string.<BR>

</DD>

<DT>
<CODE>{error,Error}</CODE> 
</DT>

<DD>
if there was an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="sub/3"><STRONG><CODE>sub(String, RegExp, New) -&#62; SubRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = New = string()</CODE></STRONG><BR>
<STRONG><CODE>SubRes = {ok,NewString,RepCount} | {error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>RepCount = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Substitutes the first occurrence of a substring matching <CODE>RegExp</CODE> in <CODE>String</CODE> with the string <CODE>New</CODE>. A <CODE>&#38;</CODE> in the string <CODE>New</CODE> is replaced by the matched substring of <CODE>String</CODE>. <CODE>\&#38;</CODE> puts a literal <CODE>&#38;</CODE> into the replacement string. It returns as follows:

<P>
<DL>

<DT>
<CODE>{ok,NewString,RepCount}</CODE>
</DT>

<DD>
 if <CODE>RegExp</CODE> is correct. <CODE>RepCount</CODE> is the number of replacements which have been made
         (this will be either 0 or 1).<BR>

</DD>

<DT>
<CODE>{error, Error}</CODE>
</DT>

<DD>
 if there is an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="gsub/3"><STRONG><CODE>gsub(String, RegExp, New) -&#62; SubRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = New = string()</CODE></STRONG><BR>
<STRONG><CODE>SubRes = {ok,NewString,RepCount} | {error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>RepCount = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>The same as <CODE>sub</CODE>, except that all non-overlapping
occurrences of a substring matching
<CODE>RegExp</CODE> in <CODE>String</CODE> are replaced by the string <CODE>New</CODE>. It returns:

<P>
<DL>

<DT>
<CODE>{ok,NewString,RepCount}</CODE> 
</DT>

<DD>
if <CODE>RegExp</CODE> is correct. <CODE>RepCount</CODE> is the number of replacements which have been made.<BR>

</DD>

<DT>
<CODE>{error, Error}</CODE> 
</DT>

<DD>
if there is an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="split/2"><STRONG><CODE>split(String, RegExp) -&#62; SplitRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>String = RegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>SubRes = {ok,FieldList} | {error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>Fieldlist = [string()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P><CODE>String</CODE> is split into fields (sub-strings) by the
regular expression <CODE>RegExp</CODE>.

<P>If the separator expression is <CODE>&#34; &#34;</CODE> (a single space),
then the fields are separated by blanks and/or tabs and
leading and trailing blanks and tabs are discarded. For all
other values of the separator, leading and trailing blanks
and tabs are not discarded. It returns:

<P>
<DL>

<DT>
<CODE>{ok, FieldList}</CODE> 
</DT>

<DD>
to indicate that the string has been split up into the fields of
<CODE>FieldList</CODE>.<BR>

</DD>

<DT>
<CODE>{error, Error}</CODE>
</DT>

<DD>
 if there is an error in <CODE>RegExp</CODE>.<BR>

</DD>

</DL>

</DIV>

<P><A NAME="sh_to_awk/1"><STRONG><CODE>sh_to_awk(ShRegExp) -&#62; AwkRegExp</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ShRegExp AwkRegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>SubRes = {ok,NewString,RepCount} | {error,errordesc()}</CODE></STRONG><BR>
<STRONG><CODE>RepCount = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Converts the <CODE>sh</CODE> type regular expression
<CODE>ShRegExp</CODE> into a full <CODE>AWK</CODE> regular
expression. Returns the converted regular expression
string. <CODE>sh</CODE> expressions are used in the shell for
matching file names and have the following special
characters:

<P>
<DL>

<DT>
<CODE>*</CODE>
</DT>

<DD>
matches any string including the null string.
<BR>

</DD>

<DT>
<CODE>?</CODE>
</DT>

<DD>
matches any single character.
<BR>

</DD>

<DT>
<CODE>[...]</CODE>
</DT>

<DD>
 matches any of the enclosed characters. Character
ranges are specified by a pair of characters separated
by a <CODE>-</CODE>. If the first character after <CODE>[</CODE> is a
<CODE>!</CODE>, then any character not enclosed is matched.
<BR>

</DD>

</DL>

<P>It may sometimes be more practical to use <CODE>sh</CODE> type
expansions as they are simpler and easier to use, even though they are not as powerful.

</DIV>

<P><A NAME="parse/1"><STRONG><CODE>parse(RegExp) -&#62; ParseRes</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>RegExp = string()</CODE></STRONG><BR>
<STRONG><CODE>ParseRes = {ok,RE} | {error,errordesc()}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Parses the regular expression <CODE>RegExp</CODE> and builds the
internal representation used in the other regular expression
functions. Such representations can be used in all of the
other functions instead of a regular expression string. This
is more efficient when the same regular expression is used
in many strings. It returns:

<P>
<DL>

<DT>
<CODE>{ok, RE}</CODE> if <CODE>RegExp</CODE> is correct and <CODE>RE</CODE> is the internal
representation.
</DT>

<DD>
<BR>

</DD>

<DT>
<CODE>{error, Error}</CODE> if there is an error in <CODE>RegExpString</CODE>.
</DT>

<DD>
<BR>

</DD>

</DL>

</DIV>

<P><A NAME="format_error/1"><STRONG><CODE>format_error(ErrorDescriptor) -&#62; Chars</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ErrorDescriptor = errordesc()</CODE></STRONG><BR>
<STRONG><CODE>Chars = [char() | Chars]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns a string which describes the error <CODE>ErrorDescriptor</CODE>
returned when there is an error in a regular expression.

</DIV>

<H3>Regular Expressions</H3>
<DIV CLASS=REFBODY>

<P>The regular expressions allowed here is a subset of the set found
in <CODE>egrep</CODE> and in the <CODE>AWK</CODE> programming language, as
defined in the book, <CODE>The AWK Programming Language, by
A. V. Aho, B. W. Kernighan, P. J. Weinberger</CODE>. They are
composed of the following characters:

<P>
<DL>

<DT>
c
</DT>

<DD>
matches the non-metacharacter <CODE>c</CODE>.
<BR>

</DD>

<DT>
\c
</DT>

<DD>
matches the escape sequence or literal character <CODE>c</CODE>.
<BR>

</DD>

<DT>
.
</DT>

<DD>
matches any character.
<BR>

</DD>

<DT>
^
</DT>

<DD>
matches the beginning of a string.
<BR>

</DD>

<DT>
$
</DT>

<DD>
matches the end of a string.
<BR>

</DD>

<DT>
[abc...]
</DT>

<DD>
character class, which matches any of the characters
<CODE>abc...</CODE> Character ranges are specified by a pair of
characters separated by a <CODE>-</CODE>.
<BR>

</DD>

<DT>
[^abc...]
</DT>

<DD>
negated character class, which matches any character except
<CODE>abc...</CODE>.
<BR>

</DD>

<DT>
r1 | r2
</DT>

<DD>
alternation. It matches either <CODE>r1</CODE> or <CODE>r2</CODE>.
<BR>

</DD>

<DT>
r1r2
</DT>

<DD>
concatenation. It matches <CODE>r1</CODE> and then <CODE>r2</CODE>.
<BR>

</DD>

<DT>
r+
</DT>

<DD>
matches one or more <CODE>r</CODE>s.
<BR>

</DD>

<DT>
r*
</DT>

<DD>
matches zero or more <CODE>r</CODE>s.
<BR>

</DD>

<DT>
r?
</DT>

<DD>
matches zero or one <CODE>r</CODE>s.
<BR>

</DD>

<DT>
(r)
</DT>

<DD>
grouping. It matches <CODE>r</CODE>.
<BR>

</DD>

</DL>

<P>The escape sequences allowed are the same as for Erlang
strings:

<P>
<DL>

<DT>
<CODE>\b</CODE>
</DT>

<DD>
backspace<BR>

</DD>

<DT>
<CODE>\f</CODE>
</DT>

<DD>
form feed <BR>

</DD>

<DT>
<CODE>\n</CODE>
</DT>

<DD>
newline (line feed) <BR>

</DD>

<DT>
<CODE>\r</CODE>
</DT>

<DD>
carriage return <BR>

</DD>

<DT>
<CODE>\t</CODE>
</DT>

<DD>
tab <BR>

</DD>

<DT>
<CODE>\e</CODE>
</DT>

<DD>
escape <BR>

</DD>

<DT>
<CODE>\v</CODE>
</DT>

<DD>
vertical tab <BR>

</DD>

<DT>
<CODE>\s</CODE>
</DT>

<DD>
space <BR>

</DD>

<DT>
<CODE>\d</CODE>
</DT>

<DD>
delete <BR>

</DD>

<DT>
<CODE>\ddd</CODE>
</DT>

<DD>
the octal value ddd <BR>

</DD>

<DT>
<CODE>\c</CODE>
</DT>

<DD>
any other character literally, for example <CODE>\\</CODE> for backslash,
<CODE>\&#34;</CODE> for &#34;)
<BR>

</DD>

</DL>

<P>To make these functions easier to use, in combination with the
function <CODE>io:get_line</CODE> which terminates the input line with
a new line, the <CODE>$</CODE> characters also matches a string ending
with <CODE>&#34;...\n&#34;</CODE>. The following examples
define Erlang data types:

<PRE>
Atoms     [a-z][0-9a-zA-Z_]*

Variables [A-Z_][0-9a-zA-Z_]*

Floats    (\+|-)?[0-9]+\.[0-9]+((E|e)(\+|-)?[0-9]+)?
    
</PRE>

<P>Regular expressions are written as Erlang strings when used with the functions in this module. This means that any <CODE>\</CODE> or <CODE>&#34;</CODE> characters in a regular expression
string must be written with <CODE>\</CODE> as they are also escape characters for the string. For example, the regular expression string for Erlang floats is:
<CODE>&#34;(\\+|-)?[0-9]+\\.[0-9]+((E|e)(\\+|-)?[0-9]+)?&#34;</CODE>.

<P>It is not really necessary to have the escape sequences as part of the regular expression syntax as they can always be generated directly in the string. They are included for completeness and can they can also be useful when generating regular expressions, or when they are entered other than with Erlang strings.

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Robert Virding - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>stdlib 1.14.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>