/ 
Locale-Codes-3.00
River stage three • 67 direct dependents • 139 total dependents
/ Locale::Script

NAME

Locale::Script - standard codes for script identification

SYNOPSIS

use Locale::Script;

$script  = code2script('phnx');                     # 'Phoenician'
$code    = script2code('Phoenician');               # 'Phnx'
$code    = script2code('Phoenician',
                       LOCALE_CODE_NUMERIC);        # 115

@codes   = all_script_codes();
@scripts = all_script_names();

DESCRIPTION

The Locale::Script module provides access to standards codes used for identifying scripts, such as those defined in ISO 15924.

You can either access the codes via the conversion routines (described below), or with the two functions which return lists of all script codes or all script names.

SCRIPT NAMES

Locale::Script supports variant names for countries.

Script names come from the standards, but common aliases are included (and others may be added). If you have a common alias for a script, let me know and I'll add it, with some restrictions.

SUPPORTED CODE SETS

There are many different code sets you can use for identifying scripts. The ones currently supported are:

alpha

This is a set of four-letter (capitalized) codes from ISO 15924 such as 'Phnx' for Phoenician.

This code set is identified with the symbol LOCALE_SCRIPT_ALPHA and is the default code set.

The Zxxx, Zyyy, and Zzzz codes are not used.

numeric

This is a set of numeric codes from ISO 15924 such as 115 for Phoenician.

This code set is identified with the symbol LOCALE_SCRIPT_NUMERIC.

CONVERSION ROUTINES

There are three conversion routines: code2script(), script2code(), and script_code2code().

code2script( CODE, [ CODESET ] )

This function takes a script code and returns a string which contains the name of the script identified. If the code is not a valid script code, as defined by ISO 15924, then undef will be returned:

$script = code2script('Phnx');
script2code( STRING, [ CODESET ] )

This function takes a script name and returns the corresponding script code, if such exists. If the argument could not be identified as a script name, then undef will be returned:

$code = script2code('Phoenician', LOCALE_SCRIPT_NUMERIC);

The case of the script name is not important.

script_code2code( CODE, CODESET, CODESET )

This function takes a script code from one code set, and returns the corresponding code from another code set.

    $alpha2 = script_code2code('Phnx',
		 LOCALE_SCRIPT_ALPHA, LOCALE_SCRIPT_NUMERICAL);

If the code passed is not a valid script code in the first code set, or if there isn't a code for the corresponding script in the second code set, then undef will be returned.

QUERY ROUTINES

There are two function which can be used to obtain a list of all codes, or all script names:

all_script_codes ( [ CODESET ] )

Returns a list of all codes in the code set.

all_script_names ( [ CODESET ] )

Returns a list of all script names for which there is a corresponding script code in the specified code set.

EXAMPLES

The following example illustrates use of the code2script() function. The user is prompted for a script code, and then told the corresponding script name:

$| = 1;   # turn off buffering

print "Enter script code: ";
chop($code = <STDIN>);
$script = code2script($code, LOCALE_SCRIPT_ALPHA);
if (defined $script) {
    print "$code = $script\n";
} else {
    print "'$code' is not a valid script code!\n";
}

KNOWN BUGS AND LIMITATIONS

  • Currently, script names are in pure ASCII. I plan to relax that in the future.

SEE ALSO

Locale::Codes
Locale::Constants
http://www.unicode.org/iso15924/

Home page for ISO 15924.

AUTHOR

See Locale::Codes for full author history.

Currently maintained by Sullivan Beck (sbeck@cpan.org).

COPYRIGHT

Copyright (c) 1997-2001 Canon Research Centre Europe (CRE).
Copyright (c) 2001-2010 Neil Bowers
Copyright (c) 2010-2010 Sullivan Beck

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.