Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the purl Reference Manual, version 1.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:26:35 2018 GMT+0.
| • Introduction: | What purl is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Description:
Provides a parser and defines a type for URLs as specified in RFC1738.
Current version is 1.2.
Documentation:
Dependencies:
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The purl system: |
Max Rottenkolber <max@mr.gy>
GNU AGPL
Parse and print URLs as described in RFC 1738.
1.2
purl.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The purl.asd file: | ||
| • The purl/package.lisp file: | ||
| • The purl/grammar.lisp file: | ||
| • The purl/purl.lisp file: |
Next: The purl/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
Next: The purl/grammar<dot>lisp file, Previous: The purl<dot>asd file, Up: Lisp files [Contents][Index]
Next: The purl/purl<dot>lisp file, Previous: The purl/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
purl (system)
grammar.lisp
Previous: The purl/grammar<dot>lisp file, Up: Lisp files [Contents][Index]
purl (system)
purl.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The purl-asd package: | ||
| • The purl package: |
Next: The purl package, Previous: Packages, Up: Packages [Contents][Index]
System definition for PURL.
purl.asd
Previous: The purl-asd package, Up: Packages [Contents][Index]
Parse and print _Uniform Resource Locators_ as defined in
[RFC 1738](http://tools.ietf.org/html/rfc1738).
< URL Designators
A _url designator_ is a value accepted by the {url} _function_.
E.g. a _url_, a _string_ or a _pathname_.
>
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions: | ||
| • Exported structures: |
Next: Exported structures, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
*Arguments and Values:*
_scheme_—a _keyword_ denoting a URL scheme.
_address_—a _string_ denoting a URL address for _scheme_ or {nil}. The
default is {nil}.
_user_, _password_, _host_—_strings_ denoting a user name, password or
hostname respectively or {nil}. The default is {nil}.
_path_—a _string_ or a _pathname_.
_port_—a positive _integer_ denoting a port number or {nil} . The
default is {nil}.
*Description*:
{make-url} returns a fresh _url_ of _scheme_. _Address_ is used as the
URL’s address if supplied. Otherwise the URL’s address will use
_Common Internet Scheme Syntax_¹ and its address is composed of the
_user_, _password_, _host_, _port_ and _path_ components.
*See Also:*
+ 1. [Common Internet Scheme Syntax](http://tools.ietf.org/html/rfc1738#section-3.1)
*Arguments and Values:*
_urlspec_—a _string_, a _pathname_ or a _url_.
*Description*:
{url} returns the _url_ denoted by _urlspec_. When _urlspec_ is a
string, {url} will attempt to parse _urlspec_ as a URL. When _urlspec_
is a _pathname_, {url} will return an equivalent _url_ using the
{:file} scheme.
*Exceptional Situations:*
An error of _type_ {malformed-url} is signaled when _urlspec_ is a
_string_ and can not be parsed as a URL.
An error of _type_ {type-error} is signaled when _urlspec_ is a _pathname_ using a host component which is not a defined logical host.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-address} returns a _string_ denoting the address part of _url_.
*Arguments and Values:*
_string_—a _string.
*Description*:
{url-decode} decodes encoded _string_ using _Percent-Encoding_¹.
*See Also:*
+ 1. [Percent-Encoding](http://tools.ietf.org/html/rfc3986#section-2.1)
*Arguments and Values:*
_string_—a _string.
*Description*:
{url-encode} encodes _string_ using _Percent-Encoding_¹.
*See Also:*
+ 1. [Percent-Encoding](http://tools.ietf.org/html/rfc3986#section-2.1)
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-host} returns a _string_ denoting the host part of _url_.
*Arguments and Values:*
_object_—an _object_.
*Description*:
{url-p} returns _true_ if _object_ is of _type_ {url}; otherwise, returns _false_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-password} returns a _string_ denoting the password part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-path} returns a _string_ denoting the path part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-port} returns a non-negative _integer_ denoting the port part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-scheme} returns a _keyword_ denoting the scheme part of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-string} returns a _string_ representation of _url_.
*Arguments and Values:*
_url_—a _url_ designator.
*Description*:
{url-user} returns a _string_ denoting the user part of _url_.
*Arguments and Values:*
_url1_, _url2_—_urls_.
*Description*:
{url=} returns _true_ if _url1_ and _url2_ are equal; otherwise, returns _false_.
Previous: Exported functions, Up: Exported definitions [Contents][Index]
A _url_ is a structured _object_ which represents a _Uniform Resource Locator_ (URL).
purl.lisp (file)
structure-object (structure)
print-object (method)
keyword
url-scheme% (function)
(setf url-scheme%) (function)
(or string purl::common-address)
url-address% (function)
(setf url-address%) (function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: | ||
| • Internal conditions: | ||
| • Internal structures: |
Next: Internal conditions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Parser for common address.
grammar.lisp (file)
Parser for URI address type.
grammar.lisp (file)
Parser for user credentials.
grammar.lisp (file)
Parser for host.
grammar.lisp (file)
Parser for password.
grammar.lisp (file)
Parser for path.
grammar.lisp (file)
Parser for port.
grammar.lisp (file)
Parser for URL scheme.
grammar.lisp (file)
Parser for URL.
grammar.lisp (file)
Parser for user.
grammar.lisp (file)
Return string for COMMON-ADDRESS.
Parse COMMON-ADDRESS structure from URL-ADDRESS.
Return URL path part for PATH.
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Condition signaling a malformed URL string.
Previous: Internal conditions, Up: Internal definitions [Contents][Index]
Common address structure for IP-based protocols.
purl.lisp (file)
structure-object (structure)
(or string null)
common-address-user (function)
(setf common-address-user) (function)
(or string null)
common-address-password (function)
(setf common-address-password) (function)
(or string null)
common-address-host (function)
(setf common-address-host) (function)
(or unsigned-byte null)
common-address-port (function)
(setf common-address-port) (function)
(or string null)
common-address-path (function)
(setf common-address-path) (function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L P |
|---|
| Jump to: | F L P |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
=
C E F M P U |
|---|
| Jump to: | (
=
C E F M P U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | A H M P S U |
|---|
| Jump to: | A H M P S U |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C M P S U |
|---|
| Jump to: | C M P S U |
|---|