The hu.dwim.uri Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The hu.dwim.uri Reference Manual

This is the hu.dwim.uri Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:49:37 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

http://dwim.hu/project/hu.dwim.util


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 hu.dwim.uri

Authors

Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>

License

BSD or Bugroff

Defsystem Dependency

hu.dwim.asdf

Dependencies
Source

hu.dwim.uri.asd (file)

Component

source (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 hu.dwim.uri/source

Parent

hu.dwim.uri (system)

Location

source/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 hu.dwim.uri.asd

Location

hu.dwim.uri.asd

Systems

hu.dwim.uri (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 hu.dwim.uri/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

hu.dwim.uri


Previous: , Up: Lisp files   [Contents][Index]

4.1.3 hu.dwim.uri/source/uri.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/uri.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 hu.dwim.uri

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: add-query-parameter URI NAME VALUE
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: append-path URI PATH
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: append-to-last-path-element URI STRING
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: clone-uri URI &key SCHEME HOST PORT PATH QUERY FRAGMENT

Clone URI with any provided components fully overriding its components (e.g. no path merging).

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: copy-all-query-parameters FROM TO
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: copy-query-parameters FROM TO &rest PARAMETER-NAMES
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: delete-all-query-parameters URI
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: delete-query-parameters URI &rest NAMES
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: ensure-parsed-uri URI
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: make-uri &key SCHEME HOST PORT PATH PATH-HAD-LEADING-SLASH? QUERY FRAGMENT
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: parse-query-parameters PARAM-STRING &key INITIAL-PARAMETERS SIDEFFECT-INITIAL-PARAMETERS

Parse PARAM-STRING into an alist. The value part will be a list if the given parameter was found multiple times.

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: parse-uri URI-STRING &key LAZY

Parse a percent-encoded URI string into an object of type URI.

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: percent-encoding/decode INPUT

URI unescape based on http://www.ietf.org/rfc/rfc2396.txt

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: percent-encoding/encode STRING

Escapes all non alphanumeric characters in STRING following the URI convention. Returns a fresh string.

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: prepend-path URI PATH
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: print-uri-to-string URI &key ESCAPE EXTRA-PARAMETERS
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: query-parameter-value URI NAME
Function: (setf query-parameter-value) VALUE URI NAME
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: split-path PATH-STRING

Returns (values list-of-path-elements ends-with-slash?)

Package

hu.dwim.uri

Source

uri.lisp (file)

Function: uri-parse-error MESSAGE &rest ARGS
Package

hu.dwim.uri

Source

uri.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: fragment-of OBJECT
Generic Function: (setf fragment-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: fragment-of (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf fragment-of) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)

Generic Function: host-of OBJECT
Generic Function: (setf host-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: host-of (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf host-of) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)

Generic Function: path-had-leading-slash? OBJECT
Generic Function: (setf path-had-leading-slash?) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: path-had-leading-slash? (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf path-had-leading-slash?) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)

Generic Function: path-of OBJECT
Generic Function: (setf path-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: path-of (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf path-of) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)

Generic Function: port-of OBJECT
Generic Function: (setf port-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: port-of (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf port-of) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)

Generic Function: query-parameters-of OBJECT
Generic Function: (setf query-parameters-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: query-parameters-of (SELF uri) before
Source

uri.lisp (file)

Method: query-parameters-of (URI uri)
Method: (setf query-parameters-of) NEW-VALUE (URI uri)

A cache for PARSE-QUERY-PARAMETERS.

Source

uri.lisp (file)

Generic Function: scheme-of OBJECT
Generic Function: (setf scheme-of) NEW-VALUE OBJECT
Package

hu.dwim.uri

Methods
Method: scheme-of (URI uri)

automatically generated reader method

Source

uri.lisp (file)

Method: (setf scheme-of) NEW-VALUE (URI uri)

automatically generated writer method

Source

uri.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Conditions

Condition: uri-parse-error ()
Package

hu.dwim.uri

Source

uri.lisp (file)

Direct superclasses
  • nested-condition (condition)
  • simple-parse-error (condition)
Direct methods
Direct slots
Slot: uri-string
Initargs

:uri-string

Initform

(quote hu.dwim.uri::*uri-string*)

Readers

uri-string-of (generic function)

Writers

(setf uri-string-of) (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Classes

Class: uri ()
Package

hu.dwim.uri

Source

uri.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: scheme
Type

(or null string)

Initargs

:scheme

Readers

scheme-of (generic function)

Writers

(setf scheme-of) (generic function)

Slot: host
Type

(or null string)

Initargs

:host

Readers

host-of (generic function)

Writers

(setf host-of) (generic function)

Slot: port
Type

(or null string)

Initargs

:port

Readers

port-of (generic function)

Writers

(setf port-of) (generic function)

Slot: path
Type

(or null string)

Initargs

:path

Readers

path-of (generic function)

Writers

(setf path-of) (generic function)

Slot: path-had-leading-slash?
Type

boolean

Initargs

:path-had-leading-slash?

Readers

path-had-leading-slash? (generic function)

Writers

(setf path-had-leading-slash?) (generic function)

Slot: query
Type

(or null string)

Initargs

:query

Readers

query-of (generic function)

Writers

(setf query-of) (generic function)

Slot: query-parameters

A cache for PARSE-QUERY-PARAMETERS.

Type

list

Initargs

:query-parameters

Readers

query-parameters-of (generic function)

Writers

(setf query-parameters-of) (generic function)

Slot: fragment
Initargs

:fragment

Readers

fragment-of (generic function)

Writers

(setf fragment-of) (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: +allowed-characters+
Package

hu.dwim.uri

Source

uri.lisp (file)

Constant: +allowed-characters/scheme+
Package

hu.dwim.uri

Source

uri.lisp (file)

Constant: +alphanumeric-characters+
Package

hu.dwim.uri

Source

uri.lisp (file)

Constant: +character-ok-table+
Package

hu.dwim.uri

Source

uri.lisp (file)

Constant: +character-ok-table/scheme+
Package

hu.dwim.uri

Source

uri.lisp (file)

Constant: +delimiter-characters+
Package

hu.dwim.uri

Source

uri.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Special variables

Special Variable: *uri-string*

Holds the uri string currently being parsed.

Package

hu.dwim.uri

Source

uri.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Macros

Macro: record-query-parameter PARAM PARAMS
Package

hu.dwim.uri

Source

uri.lisp (file)

Macro: with-resignalled-errors &body BODY
Package

hu.dwim.uri

Source

uri.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Functions

Function: is-string-ok? STRING OK-TABLE
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: print-uri-to-string/sans-query URI &key ESCAPE
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: to-character-ok-table STRING &key INITIAL-ELEMENT
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: uri-parse-error/nested NESTED-ERROR MESSAGE &rest ARGS
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: write-in-percent-encoding STRING STREAM
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: write-query-parameters PARAMETERS STREAM &key ESCAPE
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: write-uri URI STREAM &key ESCAPE EXTRA-PARAMETERS
Package

hu.dwim.uri

Source

uri.lisp (file)

Function: write-uri/sans-query URI STREAM &key ESCAPE

Write URI to STREAM, only write scheme, host and path.

Package

hu.dwim.uri

Source

uri.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Generic functions

Generic Function: uri-string-of CONDITION
Generic Function: (setf uri-string-of) NEW-VALUE CONDITION
Package

hu.dwim.uri

Methods
Method: uri-string-of (CONDITION uri-parse-error)
Method: (setf uri-string-of) NEW-VALUE (CONDITION uri-parse-error)
Source

uri.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   H   L   M  
Index Entry  Section

F
File, Lisp, hu.dwim.uri.asd: The hu<dot>dwim<dot>uri<dot>asd file
File, Lisp, hu.dwim.uri/source/package.lisp: The hu<dot>dwim<dot>uri/source/package<dot>lisp file
File, Lisp, hu.dwim.uri/source/uri.lisp: The hu<dot>dwim<dot>uri/source/uri<dot>lisp file

H
hu.dwim.uri.asd: The hu<dot>dwim<dot>uri<dot>asd file
hu.dwim.uri/source: The hu<dot>dwim<dot>uri/source module
hu.dwim.uri/source/package.lisp: The hu<dot>dwim<dot>uri/source/package<dot>lisp file
hu.dwim.uri/source/uri.lisp: The hu<dot>dwim<dot>uri/source/uri<dot>lisp file

L
Lisp File, hu.dwim.uri.asd: The hu<dot>dwim<dot>uri<dot>asd file
Lisp File, hu.dwim.uri/source/package.lisp: The hu<dot>dwim<dot>uri/source/package<dot>lisp file
Lisp File, hu.dwim.uri/source/uri.lisp: The hu<dot>dwim<dot>uri/source/uri<dot>lisp file

M
Module, hu.dwim.uri/source: The hu<dot>dwim<dot>uri/source module

Jump to:   F   H   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   M   P   Q   R   S   T   U   W  
Index Entry  Section

(
(setf fragment-of): Exported generic functions
(setf fragment-of): Exported generic functions
(setf host-of): Exported generic functions
(setf host-of): Exported generic functions
(setf path-had-leading-slash?): Exported generic functions
(setf path-had-leading-slash?): Exported generic functions
(setf path-of): Exported generic functions
(setf path-of): Exported generic functions
(setf port-of): Exported generic functions
(setf port-of): Exported generic functions
(setf query-parameter-value): Exported functions
(setf query-parameters-of): Exported generic functions
(setf query-parameters-of): Exported generic functions
(setf scheme-of): Exported generic functions
(setf scheme-of): Exported generic functions
(setf uri-string-of): Internal generic functions
(setf uri-string-of): Internal generic functions

A
add-query-parameter: Exported functions
append-path: Exported functions
append-to-last-path-element: Exported functions

C
clone-uri: Exported functions
copy-all-query-parameters: Exported functions
copy-query-parameters: Exported functions

D
delete-all-query-parameters: Exported functions
delete-query-parameters: Exported functions

E
ensure-parsed-uri: Exported functions

F
fragment-of: Exported generic functions
fragment-of: Exported generic functions
Function, (setf query-parameter-value): Exported functions
Function, add-query-parameter: Exported functions
Function, append-path: Exported functions
Function, append-to-last-path-element: Exported functions
Function, clone-uri: Exported functions
Function, copy-all-query-parameters: Exported functions
Function, copy-query-parameters: Exported functions
Function, delete-all-query-parameters: Exported functions
Function, delete-query-parameters: Exported functions
Function, ensure-parsed-uri: Exported functions
Function, is-string-ok?: Internal functions
Function, make-uri: Exported functions
Function, parse-query-parameters: Exported functions
Function, parse-uri: Exported functions
Function, percent-encoding/decode: Exported functions
Function, percent-encoding/encode: Exported functions
Function, prepend-path: Exported functions
Function, print-uri-to-string: Exported functions
Function, print-uri-to-string/sans-query: Internal functions
Function, query-parameter-value: Exported functions
Function, split-path: Exported functions
Function, to-character-ok-table: Internal functions
Function, uri-parse-error: Exported functions
Function, uri-parse-error/nested: Internal functions
Function, write-in-percent-encoding: Internal functions
Function, write-query-parameters: Internal functions
Function, write-uri: Internal functions
Function, write-uri/sans-query: Internal functions

G
Generic Function, (setf fragment-of): Exported generic functions
Generic Function, (setf host-of): Exported generic functions
Generic Function, (setf path-had-leading-slash?): Exported generic functions
Generic Function, (setf path-of): Exported generic functions
Generic Function, (setf port-of): Exported generic functions
Generic Function, (setf query-parameters-of): Exported generic functions
Generic Function, (setf scheme-of): Exported generic functions
Generic Function, (setf uri-string-of): Internal generic functions
Generic Function, fragment-of: Exported generic functions
Generic Function, host-of: Exported generic functions
Generic Function, path-had-leading-slash?: Exported generic functions
Generic Function, path-of: Exported generic functions
Generic Function, port-of: Exported generic functions
Generic Function, query-parameters-of: Exported generic functions
Generic Function, scheme-of: Exported generic functions
Generic Function, uri-string-of: Internal generic functions

H
host-of: Exported generic functions
host-of: Exported generic functions

I
is-string-ok?: Internal functions

M
Macro, record-query-parameter: Internal macros
Macro, with-resignalled-errors: Internal macros
make-uri: Exported functions
Method, (setf fragment-of): Exported generic functions
Method, (setf host-of): Exported generic functions
Method, (setf path-had-leading-slash?): Exported generic functions
Method, (setf path-of): Exported generic functions
Method, (setf port-of): Exported generic functions
Method, (setf query-parameters-of): Exported generic functions
Method, (setf scheme-of): Exported generic functions
Method, (setf uri-string-of): Internal generic functions
Method, fragment-of: Exported generic functions
Method, host-of: Exported generic functions
Method, path-had-leading-slash?: Exported generic functions
Method, path-of: Exported generic functions
Method, port-of: Exported generic functions
Method, query-parameters-of: Exported generic functions
Method, query-parameters-of: Exported generic functions
Method, scheme-of: Exported generic functions
Method, uri-string-of: Internal generic functions

P
parse-query-parameters: Exported functions
parse-uri: Exported functions
path-had-leading-slash?: Exported generic functions
path-had-leading-slash?: Exported generic functions
path-of: Exported generic functions
path-of: Exported generic functions
percent-encoding/decode: Exported functions
percent-encoding/encode: Exported functions
port-of: Exported generic functions
port-of: Exported generic functions
prepend-path: Exported functions
print-uri-to-string: Exported functions
print-uri-to-string/sans-query: Internal functions

Q
query-parameter-value: Exported functions
query-parameters-of: Exported generic functions
query-parameters-of: Exported generic functions
query-parameters-of: Exported generic functions

R
record-query-parameter: Internal macros

S
scheme-of: Exported generic functions
scheme-of: Exported generic functions
split-path: Exported functions

T
to-character-ok-table: Internal functions

U
uri-parse-error: Exported functions
uri-parse-error/nested: Internal functions
uri-string-of: Internal generic functions
uri-string-of: Internal generic functions

W
with-resignalled-errors: Internal macros
write-in-percent-encoding: Internal functions
write-query-parameters: Internal functions
write-uri: Internal functions
write-uri/sans-query: Internal functions

Jump to:   (  
A   C   D   E   F   G   H   I   M   P   Q   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   F   H   P   Q   S   U  
Index Entry  Section

*
*uri-string*: Internal special variables

+
+allowed-characters+: Internal constants
+allowed-characters/scheme+: Internal constants
+alphanumeric-characters+: Internal constants
+character-ok-table+: Internal constants
+character-ok-table/scheme+: Internal constants
+delimiter-characters+: Internal constants

C
Constant, +allowed-characters+: Internal constants
Constant, +allowed-characters/scheme+: Internal constants
Constant, +alphanumeric-characters+: Internal constants
Constant, +character-ok-table+: Internal constants
Constant, +character-ok-table/scheme+: Internal constants
Constant, +delimiter-characters+: Internal constants

F
fragment: Exported classes

H
host: Exported classes

P
path: Exported classes
path-had-leading-slash?: Exported classes
port: Exported classes

Q
query: Exported classes
query-parameters: Exported classes

S
scheme: Exported classes
Slot, fragment: Exported classes
Slot, host: Exported classes
Slot, path: Exported classes
Slot, path-had-leading-slash?: Exported classes
Slot, port: Exported classes
Slot, query: Exported classes
Slot, query-parameters: Exported classes
Slot, scheme: Exported classes
Slot, uri-string: Exported conditions
Special Variable, *uri-string*: Internal special variables

U
uri-string: Exported conditions

Jump to:   *   +  
C   F   H   P   Q   S   U  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   H   P   S   U  
Index Entry  Section

C
Class, uri: Exported classes
Condition, uri-parse-error: Exported conditions

H
hu.dwim.uri: The hu<dot>dwim<dot>uri system
hu.dwim.uri: The hu<dot>dwim<dot>uri package

P
Package, hu.dwim.uri: The hu<dot>dwim<dot>uri package

S
System, hu.dwim.uri: The hu<dot>dwim<dot>uri system

U
uri: Exported classes
uri-parse-error: Exported conditions

Jump to:   C   H   P   S   U