The punycode Reference Manual

This is the punycode Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:35:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 punycode

Punycode encoding/decoding

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/punycode/

Source Control

(GIT https://github.com/shinmera/punycode.git)

Bug Tracker

https://github.com/shinmera/punycode/issues

License

zlib

Version

1.0.0

Source

punycode.asd.

Child Component

punycode.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 punycode/punycode.asd

Source

punycode.asd.

Parent Component

punycode (system).

ASDF Systems

punycode.


3.1.2 punycode/punycode.lisp

Source

punycode.asd.

Parent Component

punycode (system).

Packages

org.shirakumo.punycode.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.punycode

Source

punycode.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: decode (string &optional out)
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Function: decode-domain (string &optional out)
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Function: encode (string &optional out)
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Function: encode-domain (string &optional out)
Package

org.shirakumo.punycode.

Source

punycode.lisp.


5.2 Internals


5.2.1 Constants

Constant: base
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: damp
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: initial-bias
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: initial-n
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: skew
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: tmax
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Constant: tmin
Package

org.shirakumo.punycode.

Source

punycode.lisp.


5.2.2 Macros

Macro: with-stream (stream-ish &body body)
Package

org.shirakumo.punycode.

Source

punycode.lisp.


5.2.3 Ordinary functions

Function: adapt (delta num-points first-time-p)
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Function: decode-digit (char)
Package

org.shirakumo.punycode.

Source

punycode.lisp.

Function: encode-digit (code)
Package

org.shirakumo.punycode.

Source

punycode.lisp.


Appendix A Indexes


A.1 Concepts