The percent-encoding Reference Manual

Table of Contents

The percent-encoding Reference Manual

This is the percent-encoding Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:20:41 2021 GMT+0.

1 Introduction

PERCENT-ENCODING

What is this?

Percent-encoding is a library for percent-encoding defined in RFC 3986 and varieties.

RFC 3986で定義されている パーセントエンコーディングとそ の亜種を処理するためのライブラリです。

License

It's licensed under the MIT license.

Requirements

• Anaphora
• Babel

API

Encoding And Decoding

Function: encode string &key test www-form encoding

Encodes string according to percent-encoding and returns it as a string.

stringをパーセントエンコーディングに従ってエンコードし、文字列として返します。

test is a function of one argument that returns a generalized boolean. It's used for determining whether each octet requires encoding. If it returns false, the octet is encoded. The default value is #'unreservedp.

testはひとつの引数を持ち、真偽値を返す関数です。それぞれのオクテットにエンコー ディングが必要かどうかを決めるために使われます。偽を返した場合、そのオクテッ トはエンコードされます。標準の値は#'unreservedpです。

If www-form is true, returns an application/x-www-form-urlencoded string instead of an RFC 3986 percent-encoded string.

www-formが真の場合、RFC 3986のパーセントエンコーディングの代わりに application/x-www-form-urlencodedを使ってエンコードした文字列を返します。

encoding is a character encoding scheme (CES). string is encoded using the CES before percent-encoding. This argument is passed to babel:string-to-octets without any change.

encodingは文字符号化方式（CES）です。stringはパーセントエンコーディングの前 にそのCESを使ってエンコードされます。この引数はbabel:string-to-octetsにそのま ま渡されます。

Function: decode string &key test www-form encoding

Decodes string according to percent-encoding and returns it as a string.

stringをパーセントエンコーディングに従ってデコードし、文字列として返します。

test is a function of one argument that returns a generalized boolean. It's used for determining whether each octet requires decoding. If it returns true, the octet is decoded. The default value is (constantly t).

testはひとつの引数を持ち、真偽値を返す関数です。それぞれのオクテットにデコー ディングが必要かどうかを決めるために使われます。真を返した場合、そのオクテットは デコードされます。標準の値は(constantly t)です。

If www-form is true, assumes that string is an application/x-www-form-urlencoded string.

www-formが真の場合、stringをapplication/x-www-form-urlencodedでエンコードさ れた文字列とみなします。

encoding is a character encoding scheme (CES). string is decoded according to the CES after percent-decoding. This argument is passed to babel:octets-to-string without any change.

encodingは文字符号化方式（CES）です。stringはパーセントエンコーディングをデ コードした後に、そのCESに従ってデコードされます。この引数は babel:octets-to-stringにそのまま渡されます。

Predicates

Function: gen-delims-p x

Function: sub-delims-p x

Function: reservedp x

Function: alphap x

Function: digitp x

Function: unreservedp x

Function: userinfop x

Function: reg-name-p x

Function: pcharp x

Function: queryp x

Function: fragmentp x

Returns true if the octet x is a member of each character set. See RFC 3986.

オクテットxがそれぞれの文字集合に属する場合に真を返します。RFC 3986を見てくだ さい。

Acknowledgements

The API of percent-encoding was inspired by Daniel Oliveira's do-urlencode and Franz's uri.

percent-encodingのAPIはDaniel Oliveiraさんの do-urlencodeとFranzの uriを参考にしています。

sile's url gave some important hints for speed to me.

sileさんのurlから速度面でのヒ ントをもらいました。

2 Systems

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

2.1 percent-encoding

Author

Manabu Takayama <learn.libra@gmail.com>

License

MIT License

Version

0.1

Dependencies

• anaphora
• babel

Source

percent-encoding.asd (file)

Component

src (module)

3 Modules

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

3.1 percent-encoding/src

Parent

percent-encoding (system)

Location

src/

Components

• package.lisp (file)
• type.lisp (file)
• var.lisp (file)
• util.lisp (file)
• condition.lisp (file)
• ascii.lisp (file)
• pred.lisp (file)
• encode.lisp (file)
• decode.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 percent-encoding.asd

Location

percent-encoding.asd

Systems

percent-encoding (system)

Packages

percent.asd

4.1.2 percent-encoding/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

percent-encoding

4.1.3 percent-encoding/src/type.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/type.lisp

Internal Definitions

• octet (type)
• octets (type)

4.1.4 percent-encoding/src/var.lisp

Dependency

type.lisp (file)

Parent

src (module)

Location

src/var.lisp

Exported Definitions

*default-character-encoding* (special variable)

Internal Definitions

*optimize-qualities* (special variable)

4.1.5 percent-encoding/src/util.lisp

Dependency

var.lisp (file)

Parent

src (module)

Location

src/util.lisp

Internal Definitions

• char-pair-octet (function)
• shrink-vector (function)

4.1.6 percent-encoding/src/condition.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

src/condition.lisp

Exported Definitions

• decode-error (condition)
• invalid-% (condition)
• invalid-hexdig (condition)

Internal Definitions

• decode-error-position (method)
• invalid-hexdig-c1 (method)
• invalid-hexdig-c2 (method)

4.1.7 percent-encoding/src/ascii.lisp

Dependency

condition.lisp (file)

Parent

src (module)

Location

src/ascii.lisp

Internal Definitions

• *ascii-char-table* (special variable)
• *char-ascii-table* (special variable)
• ascii-char (function)
• char-ascii (function)

4.1.8 percent-encoding/src/pred.lisp

Dependency

ascii.lisp (file)

Parent

src (module)

Location

src/pred.lisp

Exported Definitions

• alphap (function)
• digitp (function)
• fragmentp (function)
• gen-delims-p (function)
• pcharp (function)
• queryp (function)
• reg-name-p (function)
• reservedp (function)
• sub-delims-p (function)
• unreservedp (function)
• userinfop (function)

4.1.9 percent-encoding/src/encode.lisp

Dependency

pred.lisp (file)

Parent

src (module)

Location

src/encode.lisp

Exported Definitions

encode (function)

4.1.10 percent-encoding/src/decode.lisp

Dependency

encode.lisp (file)

Parent

src (module)

Location

src/decode.lisp

Exported Definitions

decode (function)

5 Packages

Packages are listed by definition order.

5.1 percent.asd

Source

percent-encoding.asd

Use List

• asdf/interface
• common-lisp

5.2 percent-encoding

Source

package.lisp (file)

Nickname

percent

Use List

• anaphora
• common-lisp

Exported Definitions

• *default-character-encoding* (special variable)
• alphap (function)
• decode (function)
• decode-error (condition)
• digitp (function)
• encode (function)
• fragmentp (function)
• gen-delims-p (function)
• invalid-% (condition)
• invalid-hexdig (condition)
• pcharp (function)
• queryp (function)
• reg-name-p (function)
• reservedp (function)
• sub-delims-p (function)
• unreservedp (function)
• userinfop (function)

Internal Definitions

• *ascii-char-table* (special variable)
• *char-ascii-table* (special variable)
• *optimize-qualities* (special variable)
• ascii-char (function)
• char-ascii (function)
• char-pair-octet (function)
• decode-error-position (generic function)
• decode-error-position (method)
• invalid-hexdig-c1 (generic function)
• invalid-hexdig-c1 (method)
• invalid-hexdig-c2 (generic function)
• invalid-hexdig-c2 (method)
• octet (type)
• octets (type)
• shrink-vector (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *default-character-encoding*

Package

percent-encoding

Source

var.lisp (file)

6.1.2 Functions

Function: alphap X

Package

percent-encoding

Source

pred.lisp (file)

Function: decode ()

Package

percent-encoding

Source

decode.lisp (file)

Function: digitp X

Package

percent-encoding

Source

pred.lisp (file)

Function: encode ()

Package

percent-encoding

Source

encode.lisp (file)

Function: fragmentp X

Package

percent-encoding

Source

pred.lisp (file)

Function: gen-delims-p X

Package

percent-encoding

Source

pred.lisp (file)

Function: pcharp X

Package

percent-encoding

Source

pred.lisp (file)

Function: queryp X

Package

percent-encoding

Source

pred.lisp (file)

Function: reg-name-p X

Package

percent-encoding

Source

pred.lisp (file)

Function: reservedp X

Package

percent-encoding

Source

pred.lisp (file)

Function: sub-delims-p X

Package

percent-encoding

Source

pred.lisp (file)

Function: unreservedp X

Package

percent-encoding

Source

pred.lisp (file)

Function: userinfop X

Package

percent-encoding

Source

pred.lisp (file)

6.1.3 Conditions

Condition: decode-error ()

Package

percent-encoding

Source

condition.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• invalid-% (condition)
• invalid-hexdig (condition)

Direct methods

decode-error-position (method)

Direct slots

Slot: position

Initargs

:position

Readers

decode-error-position (generic function)

Condition: invalid-% ()

Package

percent-encoding

Source

condition.lisp (file)

Direct superclasses

decode-error (condition)

Condition: invalid-hexdig ()

Package

percent-encoding

Source

condition.lisp (file)

Direct superclasses

decode-error (condition)

Direct methods

• invalid-hexdig-c2 (method)
• invalid-hexdig-c1 (method)

Direct slots

Slot: c1

Initargs

:c1

Readers

invalid-hexdig-c1 (generic function)

Slot: c2

Initargs

:c2

Readers

invalid-hexdig-c2 (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *ascii-char-table*

Package

percent-encoding

Source

ascii.lisp (file)

Special Variable: *char-ascii-table*

Package

percent-encoding

Source

ascii.lisp (file)

Special Variable: *optimize-qualities*

Package

percent-encoding

Source

var.lisp (file)

6.2.2 Functions

Function: ascii-char X

Package

percent-encoding

Source

ascii.lisp (file)

Function: char-ascii X

Package

percent-encoding

Source

ascii.lisp (file)

Function: char-pair-octet C1 C2

Package

percent-encoding

Source

util.lisp (file)

Function: shrink-vector VECTOR SIZE

Package

percent-encoding

Source

util.lisp (file)

6.2.3 Generic functions

Generic Function: decode-error-position CONDITION

Package

percent-encoding

Methods

Method: decode-error-position (CONDITION decode-error)

Source

condition.lisp (file)

Generic Function: invalid-hexdig-c1 CONDITION

Package

percent-encoding

Methods

Method: invalid-hexdig-c1 (CONDITION invalid-hexdig)

Source

condition.lisp (file)

Generic Function: invalid-hexdig-c2 CONDITION

Package

percent-encoding

Methods

Method: invalid-hexdig-c2 (CONDITION invalid-hexdig)

Source

condition.lisp (file)

6.2.4 Types

Type: octet ()

Package

percent-encoding

Source

type.lisp (file)

Type: octets &optional SIZE

Package

percent-encoding

Source

type.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types