source: project/url/url.html @ 4086

Last change on this file since 4086 was 4086, checked in by Kon Lovett, 14 years ago

Fixes for split up uri/url egg. Rmvd older versions.

File size: 4.8 KB
Line 
1<html lang="en">
2<head>
3<title>Eggs Unlimited - url</title>
4<meta http-equiv="Content-Type" content="text/html">
5<meta http-equiv="Content-Style-Type" content="text/css">
6<style type="text/css"><!--
7  pre.display { font-family:inherit }
8  pre.format  { font-family:inherit }
9  pre.smalldisplay { font-family:inherit; font-size:smaller }
10  pre.smallformat  { font-family:inherit; font-size:smaller }
11  pre.smallexample { font-size:smaller }
12  pre.smalllisp    { font-size:smaller }
13  span.sc    { font-variant:small-caps }
14  span.roman { font-family:serif; font-weight:normal; }
15  span.sansserif { font-family:sans-serif; font-weight:normal; }
16--></style>
17</head>
18<body>
19
20<center><img src="egg.jpg"></center>
21<center><a href="index.html">back</a></center>
22
23<h2>url</h2>
24
25<h3>Description:</h3>
26Basic facilities for parsing RFC 1739 Uniform Resource Locators
27
28<h3>Author:</h3>
29<a href="mailto:felix@call-with-current-continuation.org">felix</a>
30
31<h3>Version:</h3>
32<ul>
33<li>1.8 Version is a wrapper around 'uri' egg, with version 1.7 functionality</li>
34</ul>
35
36<h3>Usage:</h3>
37<pre>
38(require-extension url)
39</pre>
40
41<h3>Download:</h3>
42<a href="url.egg">url.egg</a>
43
44<h3>Requires:</h3>
45<a href="uri.html">uri</a>
46
47<h3>Documentation:</h3>
48
49<div class="defun">
50[procedure] (<b>url?</b> <var>X</var>)<br/>
51<blockquote>
52<p>Returns <code>#t</code> if <code>X</code> is an URL object, or <code>#f</code> otherwise.</p>
53</blockquote>
54</div>
55
56<div class="defun">
57[procedure] (<b>url</b> <var>STRING</var>)<br/>
58<blockquote>
59<p>Parses the Uniform Resource Locator (RFC1738) <code>STRING</code> and returns an URL object.
60Encodings of the form <code>%NN</code> and occurrences of <code>+</code> are properly handled.</p>
61</blockquote>
62</div>
63
64<div class="defun">
65[procedure] (<b>make-url</b> <var>#!key scheme user password host port path typecode</var>)<br/>
66<blockquote>
67<p>Creates an URL object from its components. Any of the keyword parameters may be <code>#f</code>.</p>
68</blockquote>
69</div>
70
71<div class="defun">
72[procedure] (<b>url-scheme</b> <var>URL</var>)<br/>
73[procedure] (<b>url-user</b> <var>URL</var>)<br/>
74[procedure] (<b>url-password</b> <var>URL</var>)<br/>
75[procedure] (<b>url-host</b> <var>URL</var>)<br/>
76[procedure] (<b>url-port</b> <var>URL</var>)<br/>
77[procedure] (<b>url-path</b> <var>URL</var>)<br/>
78[procedure] (<b>url-typecode</b> <var>URL</var>)<br/>
79<blockquote>
80<p>Accessor procedures for <code>URL</code> objects that return the components of a parsed URL. All components are
81strings, with the exception of the port (an integer) and the typecode (a character).</p>
82</blockquote>
83</div>
84
85<div class="defun">
86[procedure] (<b>url->string</b> <var>URL</var>)<br/>
87<blockquote>
88<p>Returns a string-representation if the URL object <code>URL</code>.</p>
89</blockquote>
90</div>
91
92<div class="defun">
93[procedure] (<b>url-decode</b> <var>STRING</var>)<br/>
94<blockquote>
95<p>Replaces occurrences of <code>%XX</code> sequences in <code>STRING</code> with the respective characters.</p>
96</blockquote>
97</div>
98
99<div class="defun">
100[procedure] (<b>url-encode</b> <var>STRING [CHARLIST]</var>)<br/>
101<blockquote>
102<p>Replaces occurrences of characters which are non-alphanumeric and do not appear in the list of characters given in
103the optional argument <code>CHARLIST</code> by their character code in <code>%XX</code> format.</p>
104</blockquote>
105</div>
106
107
108<h3>License:</h3>
109<pre>
110Portions Copyright (c) 2003-2005, Felix L. Winkelmann
111All rights reserved.
112
113Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
114conditions are met:
115
116  Redistributions of source code must retain the above copyright notice, this list of conditions and the following
117    disclaimer.
118  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
119    disclaimer in the documentation and/or other materials provided with the distribution.
120  Neither the name of the author nor the names of its contributors may be used to endorse or promote
121    products derived from this software without specific prior written permission.
122
123THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
124OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
125AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
126CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
127CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
128SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
129THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
130OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
131POSSIBILITY OF SUCH DAMAGE.
132</pre>
133
134<hr><a href="index.html">back</a>
135
136</body>
137</html>
Note: See TracBrowser for help on using the repository browser.