The idna Reference Manual

Table of Contents

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

The idna Reference Manual

This is the idna Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:50:48 2018 GMT+0.


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

1 Introduction

IDNA - International Domain Name functions for Common Lisp.

Usage (unicode -> punycode only at the moment):

Loading:

    (asdf:load-system :idna)

Encoding strings as IDNA:

    (idna:to-ascii "中央大学.tw")
    ;; => "xn--fiq80yua78t.tw"

    (idna:to-ascii "müller.example.com")
    ;; => "xn--mller-kva.example.com"

Decoding strings from IDNA notation to unicode text:

    (idna:to-unicode "xn--fiq80yua78t.tw")
    ;; => "中央大学.tw"

Known bugs

The functions punycode-encode accept a :preserve-case keyword argument that currently doesn't work: punycode-encode returns wrong results, and punycode-decode doesn't impl


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 idna

Description

IDNA (international domain names) string encoding and decoding routines

Dependency

split-sequence

Source

idna.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 idna.asd

Location

idna.asd

Systems

idna (system)


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

3.1.2 idna/package.lisp

Parent

idna (system)

Location

package.lisp

Packages

idna


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

3.1.3 idna/encode.lisp

Dependency

package.lisp (file)

Parent

idna (system)

Location

encode.lisp

Exported Definitions
Internal Definitions

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

3.1.4 idna/decode.lisp

Dependency

encode.lisp (file)

Parent

idna (system)

Location

decode.lisp

Exported Definitions
Internal Definitions

decode-digit (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 idna

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: punycode-decode INPUT &key PRESERVE-CASE
Package

idna

Source

decode.lisp (file)

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 (file)

Function: to-ascii STRING

Encode string to IDNA punycode format using the ToASCII algorithm.

Package

idna

Source

encode.lisp (file)

Function: to-unicode STRING

Encode string from IDNA punycode format using the ToUnicode algorithm.

Package

idna

Source

decode.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +base+
Package

idna

Source

encode.lisp (file)

Constant: +damp+
Package

idna

Source

encode.lisp (file)

Constant: +delimiter+
Package

idna

Source

encode.lisp (file)

Constant: +initial-bias+
Package

idna

Source

encode.lisp (file)

Constant: +initial-n+
Package

idna

Source

encode.lisp (file)

Constant: +maxint+
Package

idna

Source

encode.lisp (file)

Constant: +skew+
Package

idna

Source

encode.lisp (file)

Constant: +tmax+
Package

idna

Source

encode.lisp (file)

Constant: +tmin+
Package

idna

Source

encode.lisp (file)


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

5.2.2 Functions

Function: adapt DELTA NUMPOINTS FIRST-TIME
Package

idna

Source

encode.lisp (file)

Function: decode-digit CP
Package

idna

Source

decode.lisp (file)

Function: encode-basic C FLAG
Package

idna

Source

encode.lisp (file)

Function: encode-digit D FLAG
Package

idna

Source

encode.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L  
Index Entry  Section

F
File, Lisp, idna.asd: The idna<dot>asd file
File, Lisp, idna/decode.lisp: The idna/decode<dot>lisp file
File, Lisp, idna/encode.lisp: The idna/encode<dot>lisp file
File, Lisp, idna/package.lisp: The idna/package<dot>lisp file

I
idna.asd: The idna<dot>asd file
idna/decode.lisp: The idna/decode<dot>lisp file
idna/encode.lisp: The idna/encode<dot>lisp file
idna/package.lisp: The idna/package<dot>lisp file

L
Lisp File, idna.asd: The idna<dot>asd file
Lisp File, idna/decode.lisp: The idna/decode<dot>lisp file
Lisp File, idna/encode.lisp: The idna/encode<dot>lisp file
Lisp File, idna/package.lisp: The idna/package<dot>lisp file

Jump to:   F   I   L  

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

A.2 Functions

Jump to:   A   D   E   F   P   T  
Index Entry  Section

A
adapt: Internal functions

D
decode-digit: Internal functions

E
encode-basic: Internal functions
encode-digit: Internal functions

F
Function, adapt: Internal functions
Function, decode-digit: Internal functions
Function, encode-basic: Internal functions
Function, encode-digit: Internal functions
Function, punycode-decode: Exported functions
Function, punycode-encode: Exported functions
Function, to-ascii: Exported functions
Function, to-unicode: Exported functions

P
punycode-decode: Exported functions
punycode-encode: Exported functions

T
to-ascii: Exported functions
to-unicode: Exported functions

Jump to:   A   D   E   F   P   T  

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

A.3 Variables

Jump to:   +  
C  
Index Entry  Section

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

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

Jump to:   +  
C  

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

A.4 Data types

Jump to:   I   P   S  
Index Entry  Section

I
idna: The idna system
idna: The idna package

P
Package, idna: The idna package

S
System, idna: The idna system

Jump to:   I   P   S