The idna Reference Manual

This is the idna Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 06:18:21 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 idna

IDNA (international domain names) string encoding and decoding routines

Dependency

split-sequence (system).

Source

idna.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 idna/idna.asd

Source

idna.asd.

Parent Component

idna (system).

ASDF Systems

idna.


3.1.2 idna/package.lisp

Source

idna.asd.

Parent Component

idna (system).

Packages

idna.


3.1.3 idna/encode.lisp

Dependency

package.lisp (file).

Source

idna.asd.

Parent Component

idna (system).

Public Interface
Internals

3.1.4 idna/decode.lisp

Dependency

encode.lisp (file).

Source

idna.asd.

Parent Component

idna (system).

Public Interface
Internals

decode-digit (function).


4 Packages

Packages are listed by definition order.


4.1 idna

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: punycode-decode (input &key preserve-case)
Package

idna.

Source

decode.lisp.

Function: punycode-encode (string &key preserve-case)

Encode STRING with the punycode algorithm documented in RFC3492.

When PRESERVE-CASE is true, emit case annotations and do not perform case folding (to downcase), as required for ToASCII.

Package

idna.

Source

encode.lisp.

Function: to-ascii (string)

Encode string to IDNA punycode format using the ToASCII algorithm.

Package

idna.

Source

encode.lisp.

Function: to-unicode (string)

Encode string from IDNA punycode format using the ToUnicode algorithm.

Package

idna.

Source

decode.lisp.


5.2 Internals


5.2.1 Constants

Constant: +base+
Package

idna.

Source

encode.lisp.

Constant: +damp+
Package

idna.

Source

encode.lisp.

Constant: +delimiter+
Package

idna.

Source

encode.lisp.

Constant: +initial-bias+
Package

idna.

Source

encode.lisp.

Constant: +initial-n+
Package

idna.

Source

encode.lisp.

Constant: +maxint+
Package

idna.

Source

encode.lisp.

Constant: +skew+
Package

idna.

Source

encode.lisp.

Constant: +tmax+
Package

idna.

Source

encode.lisp.

Constant: +tmin+
Package

idna.

Source

encode.lisp.


5.2.2 Ordinary functions

Function: adapt (delta numpoints first-time)
Package

idna.

Source

encode.lisp.

Function: decode-digit (cp)
Package

idna.

Source

decode.lisp.

Function: encode-basic (c flag)
Package

idna.

Source

encode.lisp.

Function: encode-digit (d flag)
Package

idna.

Source

encode.lisp.


Appendix A Indexes


A.1 Concepts