File: string-equal-i.htm

package info (click to toggle)
nyquist 3.12%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 58,036 kB
  • sloc: ansic: 74,355; lisp: 20,485; java: 9,390; cpp: 6,695; sh: 207; xml: 58; makefile: 39
file content (111 lines) | stat: -rw-r--r-- 4,416 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<html><head><title>XLISP tring-equal</title>

<link rel="stylesheet" type="text/css" href="reference.css">

</head>

<body>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

<hr>

<h1>string-equal</h1>

<hr>

<p><table cellpadding="0" cellspacing="0" style="margin-left:10px"><tbody>
<tr valign="top">
  <td><nobr>Type:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>function (subr)</nobr></td>
</tr>
<tr valign="top">
  <td><nobr>Source:</nobr></td>
  <td><nobr>&nbsp;&nbsp;-&nbsp;&nbsp;</nobr></td>
  <td width="100%"><nobr>xlstr.c</nobr></td>
</tr>
</tbody></table></p>

<h2>Syntax</h2>

<dl>
<dt>(string-equal <i>string1 string2</i> [<i>key offset</i>] ... )</dt>
<dd><i>stringN</i> - a string expression<br>
<i>key</i> - a keyword [one of :start1 :start2 :end1 :end2]<br>
<i>offset</i> - an optional integer expression for a keyword<br>
returns - <a href="t.htm">&nbsp;T&nbsp;</a> if <i>string1</i>
equal to <i>string2</i>,
<a href="nil.htm">NIL</a> otherwise<br>
<b>Note:</b> case is not significant with this function</dd>
</dl>

<h2>Description</h2>

<p>The 'string-equal' function takes two string arguments. It checks to see
if the string arguments have the same values.
<a href="t.htm">&nbsp;T&nbsp;</a> is returned if 'string1' is
equal to 'string2', <a href="nil.htm">NIL</a> is returned
otherwise. This test is not case sensitive, the character '#\a' is
considered to be the same as '#\A'.</p>

<p>The keyword arguments allow for accessing substrings within 'string1' and
'string2'. The keyword arguments each require a keyword ':start1', ':end1',
':start2' or ':end2' and a single integer expression as a pair with the
keyword first and the integer second. The pairs may be in any order. The
':startN' keywords specify the starting offset of the substring. A value of
0 starts the string at the beginning [no offset]. The ':endN' keywords
specify the ending offset of the substring. A value of 3 ends the string
after the 3rd character [an offset of 3 characters].</p>

<h2>Examples</h2>

<pre class="example">
(string-equal "a" "b")            <font color="#008844">; returns NIL</font>
(string-equal "a" "a")            <font color="#008844">; returns T</font>
(string-equal "a" "A")            <font color="#008844">; returns T</font>
(string-equal "A" "a")            <font color="#008844">; returns T</font>
(string-equal "abc" "abc ")       <font color="#008844">; returns NIL</font>

(string-equal "J Smith" "K Smith" :start1 1 :start2 1)  <font color="#008844">; strip off the first chars</font>
                                                        <font color="#008844">; returns T</font>

(string-equal "abc" "123456789" :end2 3 :end1 3)        <font color="#008844">; leave just the first 3 chars</font>
                                                        <font color="#008844">; returns NIL</font>
</pre>

<p><b>Bug:</b> The 'string-equal' function is listed in the original XLISP
documentation as 'string-equalp'. In the XLISP interpreter a call to
'string-equalp' causes an error:</p>

<pre class="example">
<font color="#AA0000">error: unbound function - STRING-EQUALP</font>
</pre>

<p>The 'string-equal' function works exactly as the 'string-equalp' function
described in the XLISP manual. This bug had obviously been corrected in
the manual only but never in the interpreter. As the bug still exists with
<nobr>Nyquist 2.36</nobr> in <nobr>July 2007</nobr> as well as all other
<nobr>XLISP 2.x</nobr> implementations I know, I have changed both manuals
to 'string-equal' even if I myself whould consider 'string-equalp' as the
better name.</p>

<p>See the
<a href="../manual/xlisp-man-025.htm#string-equalp">string-equal</a>
function in the <nobr>XLISP 2.0</nobr> manual.</p>

<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</nobr></a></p>

<hr>

<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
<a href="../manual/contents.htm">Contents</a> |
<a href="../tutorials/tutorials.htm">Tutorials</a> |
<a href="../examples/examples.htm">Examples</a> |
<a href="reference-index.htm">Reference</a>

</body></html>