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

The idna Reference Manual

This is the idna Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:27:22 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The idna Reference Manual, Up: The idna Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The idna Reference Manual [Contents][Index]

2 Systems

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

idna

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

2.1 `idna`

IDNA (international domain names) string encoding and decoding routines

Dependency

split-sequence (system).

Source

Child Components

package.lisp (file).
encode.lisp (file).
decode.lisp (file).

Next: Packages, Previous: Systems, Up: The idna Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

idna/idna.asd
idna/package.lisp
idna/encode.lisp
idna/decode.lisp

Next: idna/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `idna/idna.asd`

Source: idna.asd.
Parent Component: idna (system).
ASDF Systems: idna.

Next: idna/encode.lisp, Previous: idna/idna.asd, Up: Lisp [Contents][Index]

3.1.2 `idna/package.lisp`

Source: idna.asd.
Parent Component: idna (system).
Packages: idna.

Next: idna/decode.lisp, Previous: idna/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `idna/encode.lisp`

Dependency

package.lisp (file).

Source

Parent Component

idna (system).

Public Interface

punycode-encode (function).
to-ascii (function).

Internals

+base+ (constant).
+damp+ (constant).
+delimiter+ (constant).
+initial-bias+ (constant).
+initial-n+ (constant).
+maxint+ (constant).
+skew+ (constant).
+tmax+ (constant).
+tmin+ (constant).
adapt (function).
encode-basic (function).
encode-digit (function).

Previous: idna/encode.lisp, Up: Lisp [Contents][Index]

3.1.4 `idna/decode.lisp`

Dependency

encode.lisp (file).

Source

Parent Component

idna (system).

Public Interface

punycode-decode (function).
to-unicode (function).

Internals

decode-digit (function).

Next: Definitions, Previous: Files, Up: The idna Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

idna

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

4.1 `idna`

Source

package.lisp.

Use List

common-lisp.

Public Interface

punycode-decode (function).
punycode-encode (function).
to-ascii (function).
to-unicode (function).

Internals

+base+ (constant).
+damp+ (constant).
+delimiter+ (constant).
+initial-bias+ (constant).
+initial-n+ (constant).
+maxint+ (constant).
+skew+ (constant).
+tmax+ (constant).
+tmin+ (constant).
adapt (function).
decode-digit (function).
encode-basic (function).
encode-digit (function).

Next: Indexes, Previous: Packages, Up: The idna Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Constants
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Constants, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The idna Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	A D E F P T

	Index Entry		Section

A
	`adapt`:		Private ordinary functions

D
	`decode-digit`:		Private ordinary functions

E
	`encode-basic`:		Private ordinary functions
	`encode-digit`:		Private ordinary functions

F
	`Function, adapt`:		Private ordinary functions
	`Function, decode-digit`:		Private ordinary functions
	`Function, encode-basic`:		Private ordinary functions
	`Function, encode-digit`:		Private ordinary functions
	`Function, punycode-decode`:		Public ordinary functions
	`Function, punycode-encode`:		Public ordinary functions
	`Function, to-ascii`:		Public ordinary functions
	`Function, to-unicode`:		Public ordinary functions

P
	`punycode-decode`:		Public ordinary functions
	`punycode-encode`:		Public ordinary functions

T
	`to-ascii`:		Public ordinary functions
	`to-unicode`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ C

	Index Entry		Section

+
	`+base+`:		Private constants
	`+damp+`:		Private constants
	`+delimiter+`:		Private constants
	`+initial-bias+`:		Private constants
	`+initial-n+`:		Private constants
	`+maxint+`:		Private constants
	`+skew+`:		Private constants
	`+tmax+`:		Private constants
	`+tmin+`:		Private constants

C
	`Constant, +base+`:		Private constants
	`Constant, +damp+`:		Private constants
	`Constant, +delimiter+`:		Private constants
	`Constant, +initial-bias+`:		Private constants
	`Constant, +initial-n+`:		Private constants
	`Constant, +maxint+`:		Private constants
	`Constant, +skew+`:		Private constants
	`Constant, +tmax+`:		Private constants
	`Constant, +tmin+`:		Private constants

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

A.4 Data types

Jump to:	D E F I P S

	Index Entry		Section

D
	`decode.lisp`:		The idna/decode․lisp file

E
	`encode.lisp`:		The idna/encode․lisp file

F
	`File, decode.lisp`:		The idna/decode․lisp file
	`File, encode.lisp`:		The idna/encode․lisp file
	`File, idna.asd`:		The idna/idna․asd file
	`File, package.lisp`:		The idna/package․lisp file

I
	`idna`:		The idna system
	`idna`:		The idna package
	`idna.asd`:		The idna/idna․asd file

P
	`Package, idna`:		The idna package
	`package.lisp`:		The idna/package․lisp file

S
	`System, idna`:		The idna system