Update of /project/cl-unification/cvsroot/cl-unification/docs/html In directory tiger.common-lisp.net:/tmp/cvs-serv14742
Added Files: regular-expression-template-class.html Log Message: Added documentation for REGULAR-EXPRESSION-TEMPLATE.
--- /project/cl-unification/cvsroot/cl-unification/docs/html/regular-expression-template-class.html 2012/12/29 23:23:47 NONE +++ /project/cl-unification/cvsroot/cl-unification/docs/html/regular-expression-template-class.html 2012/12/29 23:23:47 1.1 <html> <head> <title>CL Unification: Class REGULAR-EXPRESSION-TEMPLATE</title> <link rel="stylesheet" href="main.css"> </head> <body marginheight="0" marginwidth="0" leftmargin="0" topmargin="0" bgcolor="#ffffff">
<table border="0" cellpadding="0" cellspacing="0" width="100%" height="100%" vspace="0" hspace="0"> <tr> <td colspan="3"> <div class="header" style="font-family:=Verdana,Arial,Helvetica; font-size: 18px; color: #41286f;"> <strong><i>CL Unification: Class REGULAR-EXPRESSION-TEMPLATE</title></i></strong> <div class="navigation"> <a href="index.html" class="navigation-link">Home</a> | <a href="unification-dictionary.html" class="navigation-link">Dictionary</a> | <a href="structure-object-template-class.html" class="navigation-link">Previous</a> | <a href="template-p-function.html" class="navigation-link">Next</a> | <a href="downloads.html" class="navigation-link">Downloads</a> | <a href="links.html" class="navigation-link">Links</a> </div> </div> <div class="black-line"><img src="images/shim.gif" height="1" width="1"></div> <div class="middle-bar"><img src="images/shim.gif" height="5" width="1"></div> <div class="black-line"><img src="images/shim.gif" height="1" width="1"></div> </td> </tr>
<tr height="100%"> <td height="100%"> </td> <td valign="top" width="80%" height="100%">
<div class="content"> <div class="text" style="padding-top: 10px;"> <h1><i>Class</i> <strong>REGULAR-EXPRESSION-TEMPLATE</strong></h1>
<h2>Package:</h2>
<p><code>COMMON-LISP.EXTENSIONS.DATA-AND-CONTROL-FLOW.UNIFICATION</code></p>
<h2>Class Precedence List:</h2>
<p> REGULAR-EXPRESSION-TEMPLATE, STRING-TEMPLATE, VECTOR-TEMPLATE, SEQUENCE-TEMPLATE, ARRAY-TEMPLATE, TYPE-TEMPLATE, TEMPLATE, STANDARD-OBJECT, T. </p>
<h2>Known Subclasses:</h2>
<p> None. </p>
<h2>Slots:</h2>
<p>None documented.</p>
<h2>Description:</h2>
<p>The REGULAR-EXPRESSION-TEMPLATE class denotes <em>regular expressions</em> (the <a href="http://weitz.de/cl-ppcre/">CL-PPCRE</a> regular expressions) that are used to unify against a STRING.</p>
<h3>Template Syntax:</h3>
<p>The spec syntax for a REGULAR-EXPRESSION-TEMPLATE is the following:</p>
<p> <pre> #T(<b>regular-expression</b> <i>REGEXP</i> &optional <i>unification-vars</i> &rest <i>keys</i>) #T(<b>regexp</b> <i>REGEXP</i> &optional <i>unification-vars</i> &rest <i>keys</i>) </pre> where <pre> <i>REGEXP</i> ::= <a <a href="http://weitz.de/cl-ppcre/">CL-PPCRE</a> regexp string or tree> <i>unification-vars</i> ::= '(' <i>variable</i>* ')' <i>keys</i> ::= <<a href="http://weitz.de/cl-ppcre/">CL-PPCRE</a> (constant) keys to be passed to CL-PPCRE:CREATE-SCANNER> </pre> </p>
<p><b><code>regular-expression</code></b> and <b><code>regexp</code></b> are interchangeable. The <code><i>unification-vars</i></code>, if present, are unified (i.e., associated) with each group returned by the scanner created by CL-PPCRE:CREATE-SCANNER. The scanner is called by the appropriate <a href="unify-function.html">UNIFY</a> method. </p>
<h2>Examples:</h2>
<p> <pre> cl-prompt> (unify "abcbca" #T(<b>regexp</b> "a(bc)*a")) #<ENVIRONMENT xxx>
cl-prompt> (unify #T(regexp "a(cb)*a" (?foo)) "acbcba") #<ENVIRONMENT xyz>
cl-prompt> (find-variable-value '?foo *) "cb" T </pre> </p>
<h2>Affected By:</h2>
<p>None.</p>
<h2>Exceptional Situations:</h2>
<p>Unifying an REGULAR-EXPRESSION-TEMPLATE against a non-STRING object results in an UNIFICATION-FAILURE error being signaled.</p>
<h2>See Also:</h2>
<p><a href="unify-function.html">UNIFY</a></p>
<h2>Notes:</h2>
<p>The underlying implementation uses <a href="http://weitz.de/cl-ppcre/">CL-PPCRE</a>. If CL-PPCRE is not available in the system, CL-UNIFICATION will not have REGULAR-EXPRESSION-TEMPLATE working.</p>
</td>
<!-- <td height="100%"> </td> --> </tr>
<tr height="100%"> <td height="100%"> </td> <td valign="top" width="80%" height="100%">
<div class="content"> <div class="text" style="padding-top: 10px;">
<!-- <h1>News</h1>
<p>News in chronological order, most recent on top. </p>
<ul> <li><strong>2004-10-30</strong><br> Completed description. </li>
</ul> --> </div> </div> </td>
<td height="100%"> </td> </tr>
<tr> <td colspan="3" valign="bottom" align="right"> <div class="copyright"> © 2003-2013, Marco Antoniotti, all rights reserved. </div> </td> </tr>
</table> </body> </html>
<!-- end of file -- expression-template-class.html -->
cl-unification-cvs@common-lisp.net
-
CVS User mantoniotti