libidn  1.29
Macros | Enumerations | Functions
punycode.c File Reference
#include <config.h>
#include <string.h>
#include "punycode.h"

Go to the source code of this file.

Macros

#define basic(cp)   ((punycode_uint)(cp) < 0x80)
#define delim(cp)   ((cp) == delimiter)
#define flagged(bcp)   ((punycode_uint)(bcp) - 65 < 26)

Enumerations

enum  {
  base = 36, tmin = 1, tmax = 26, skew = 38,
  damp = 700, initial_bias = 72, initial_n = 0x80, delimiter = 0x2D
}

Functions

int punycode_encode (size_t input_length, const punycode_uint input[], const unsigned char case_flags[], size_t *output_length, char output[])
int punycode_decode (size_t input_length, const char input[], size_t *output_length, punycode_uint output[], unsigned char case_flags[])

Macro Definition Documentation

#define basic (   cp)    ((punycode_uint)(cp) < 0x80)

Definition at line 83 of file punycode.c.

#define delim (   cp)    ((cp) == delimiter)

Definition at line 86 of file punycode.c.

#define flagged (   bcp)    ((punycode_uint)(bcp) - 65 < 26)

Definition at line 117 of file punycode.c.

Enumeration Type Documentation

anonymous enum
Enumerator:
base 
tmin 
tmax 
skew 
damp 
initial_bias 
initial_n 
delimiter 

Definition at line 77 of file punycode.c.

Function Documentation

int punycode_decode ( size_t  input_length,
const char  input[],
size_t *  output_length,
punycode_uint  output[],
unsigned char  case_flags[] 
)

punycode_decode:

Parameters
input_lengthThe number of ASCII code points in the array.
inputAn array of ASCII code points (0..7F).
output_lengthThe caller passes in the maximum number of code points that it can receive into the array (which is also the maximum number of flags that it can receive into the array, if is not a NULL pointer). On successful return it will contain the number of code points actually output (which is also the number of flags actually output, if case_flags is not a null pointer). The decoder will never need to output more code points than the number of ASCII code points in the input, because of the way the encoding is defined. The number of code points output cannot exceed the maximum possible value of a punycode_uint, even if the supplied is greater than that.
outputAn array of code points like the input argument of punycode_encode() (see above).
case_flagsA NULL pointer (if the flags are not needed by the caller) or an array of boolean values parallel to the array. Nonzero (true, flagged) suggests that the corresponding Unicode character be forced to uppercase by the caller (if possible), and zero (false, unflagged) suggests that it be forced to lowercase (if possible). ASCII code points (0..7F) are output already in the proper case, but their flags will be set appropriately so that applying the flags would be harmless.

Converts Punycode to a sequence of code points (presumed to be Unicode code points).

Return value: The return value can be any of the Punycode_status values defined above. If not PUNYCODE_SUCCESS, then , , and might contain garbage.

Definition at line 346 of file punycode.c.

int punycode_encode ( size_t  input_length,
const punycode_uint  input[],
const unsigned char  case_flags[],
size_t *  output_length,
char  output[] 
)

punycode_encode:

Parameters
input_lengthThe number of code points in the array and the number of flags in the array.
inputAn array of code points. They are presumed to be Unicode code points, but that is not strictly REQUIRED. The array contains code points, not code units. UTF-16 uses code units D800 through DFFF to refer to code points 10000..10FFFF. The code points D800..DFFF do not occur in any valid Unicode string. The code points that can occur in Unicode strings (0..D7FF and E000..10FFFF) are also called Unicode scalar values.
case_flagsA NULL pointer or an array of boolean values parallel to the array. Nonzero (true, flagged) suggests that the corresponding Unicode character be forced to uppercase after being decoded (if possible), and zero (false, unflagged) suggests that it be forced to lowercase (if possible). ASCII code points (0..7F) are encoded literally, except that ASCII letters are forced to uppercase or lowercase according to the corresponding case flags. If is a NULL pointer then ASCII letters are left as they are, and other code points are treated as unflagged.
output_lengthThe caller passes in the maximum number of ASCII code points that it can receive. On successful return it will contain the number of ASCII code points actually output.
outputAn array of ASCII code points. It is not null-terminated; it will contain zeros if and only if the contains zeros. (Of course the caller can leave room for a terminator and add one if needed.)

Converts a sequence of code points (presumed to be Unicode code points) to Punycode.

Return value: The return value can be any of the Punycode_status values defined above except PUNYCODE_BAD_INPUT. If not PUNYCODE_SUCCESS, then and might contain garbage.

Definition at line 197 of file punycode.c.