Next: , Previous: Invoking idn, Up: Top


11 Emacs API

Included in Libidn are punycode.el and idna.el that provides an Emacs Lisp API to (a limited set of) the Libidn API. This section describes the API. Currently the IDNA API always set the UseSTD3ASCIIRules flag and clear the AllowUnassigned flag, in the future there may be functionality to specify these flags via the API.

11.1 Punycode Emacs API

— Variable: punycode-program

Name of the GNU Libidn idn application. The default is ‘idn’. This variable can be customized.

— Variable: punycode-environment

List of environment variable definitions prepended to ‘process-environment’. The default is ‘("CHARSET=UTF-8")’. This variable can be customized.

— Variable: punycode-encode-parameters

List of parameters passed to punycode-program to invoke punycode encoding mode. The default is ‘("--quiet" "--punycode-encode")’. This variable can be customized.

— Variable: punycode-decode-parameters

Parameters passed to punycode-program to invoke punycode decoding mode. The default is ‘("--quiet" "--punycode-decode")’. This variable can be customized.

— Function: punycode-encode string

Returns a Punycode encoding of the string, after converting the input into UTF-8.

— Function: punycode-decode string

Returns a possibly multibyte string which is the decoding of the string which is a punycode encoded string.

11.2 IDNA Emacs API

— Variable: idna-program

Name of the GNU Libidn idn application. The default is ‘idn’. This variable can be customized.

— Variable: idna-environment

List of environment variable definitions prepended to ‘process-environment’. The default is ‘("CHARSET=UTF-8")’. This variable can be customized.

— Variable: idna-to-ascii-parameters

List of parameters passed to idna-program to invoke IDNA ToASCII mode. The default is ‘("--quiet" "--idna-to-ascii" "--usestd3asciirules")’. This variable can be customized.

— Variable: idna-to-unicode-parameters

Parameters passed idna-program to invoke IDNA ToUnicode mode. The default is ‘("--quiet" "--idna-to-unicode" "--usestd3asciirules")’. This variable can be customized.

— Function: idna-to-ascii string

Returns an ASCII Compatible Encoding (ACE) of the string computed by the IDNA ToASCII operation on the input string, after converting the input to UTF-8.

— Function: idna-to-unicode string

Returns a possibly multibyte string which is the output of the IDNA ToUnicode operation computed on the input string.