This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to Locale::Codes 2.02.
[perl5.git] / lib / Locale / Country.pm
CommitLineData
6b14ceb7
JH
1#
2# Locale::Country - ISO codes for country identification (ISO 3166)
3#
917211f5 4# $Id: Country.pm,v 2.2 2002/03/06 10:45:38 neilb Exp $
6b14ceb7 5#
47a334e9
JH
6
7package Locale::Country;
8use strict;
9require 5.002;
10
47a334e9
JH
11require Exporter;
12use Carp;
13use Locale::Constants;
14
15
16#-----------------------------------------------------------------------
17# Public Global Variables
18#-----------------------------------------------------------------------
19use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
917211f5 20$VERSION = sprintf("%d.%02d", q$Revision: 2.2 $ =~ /(\d+)\.(\d+)/);
47a334e9
JH
21@ISA = qw(Exporter);
22@EXPORT = qw(code2country country2code
23 all_country_codes all_country_names
24 country_code2code
25 LOCALE_CODE_ALPHA_2 LOCALE_CODE_ALPHA_3 LOCALE_CODE_NUMERIC);
26
27#-----------------------------------------------------------------------
28# Private Global Variables
29#-----------------------------------------------------------------------
30my $CODES = [];
31my $COUNTRIES = [];
32
33
34#=======================================================================
6b14ceb7
JH
35#
36# code2country ( CODE [, CODESET ] )
37#
47a334e9
JH
38#=======================================================================
39sub code2country
40{
41 my $code = shift;
42 my $codeset = @_ > 0 ? shift : LOCALE_CODE_DEFAULT;
43
44
45 return undef unless defined $code;
46
47 #-------------------------------------------------------------------
48 # Make sure the code is in the right form before we use it
49 # to look up the corresponding country.
50 # We have to sprintf because the codes are given as 3-digits,
51 # with leading 0's. Eg 052 for Barbados.
52 #-------------------------------------------------------------------
53 if ($codeset == LOCALE_CODE_NUMERIC)
54 {
55 return undef if ($code =~ /\D/);
56 $code = sprintf("%.3d", $code);
57 }
58 else
59 {
60 $code = lc($code);
61 }
62
63 if (exists $CODES->[$codeset]->{$code})
64 {
65 return $CODES->[$codeset]->{$code};
66 }
67 else
68 {
69 #---------------------------------------------------------------
70 # no such country code!
71 #---------------------------------------------------------------
72 return undef;
73 }
74}
75
6b14ceb7
JH
76
77#=======================================================================
78#
79# country2code ( NAME [, CODESET ] )
80#
81#=======================================================================
47a334e9
JH
82sub country2code
83{
84 my $country = shift;
85 my $codeset = @_ > 0 ? shift : LOCALE_CODE_DEFAULT;
86
87
88 return undef unless defined $country;
89 $country = lc($country);
90 if (exists $COUNTRIES->[$codeset]->{$country})
91 {
92 return $COUNTRIES->[$codeset]->{$country};
93 }
94 else
95 {
96 #---------------------------------------------------------------
97 # no such country!
98 #---------------------------------------------------------------
99 return undef;
100 }
101}
102
6b14ceb7
JH
103
104#=======================================================================
105#
106# country_code2code ( NAME [, CODESET ] )
107#
108#=======================================================================
47a334e9
JH
109sub country_code2code
110{
111 (@_ == 3) or croak "country_code2code() takes 3 arguments!";
112
113 my $code = shift;
114 my $inset = shift;
115 my $outset = shift;
6b14ceb7 116 my $outcode;
47a334e9
JH
117 my $country;
118
119
120 return undef if $inset == $outset;
121 $country = code2country($code, $inset);
122 return undef if not defined $country;
123 $outcode = country2code($country, $outset);
124 return $outcode;
125}
126
47a334e9
JH
127
128#=======================================================================
6b14ceb7
JH
129#
130# all_country_codes ( [ CODESET ] )
131#
132#=======================================================================
47a334e9
JH
133sub all_country_codes
134{
135 my $codeset = @_ > 0 ? shift : LOCALE_CODE_DEFAULT;
136
137 return keys %{ $CODES->[$codeset] };
138}
139
6b14ceb7
JH
140
141#=======================================================================
142#
143# all_country_names ( [ CODESET ] )
144#
145#=======================================================================
47a334e9
JH
146sub all_country_names
147{
148 my $codeset = @_ > 0 ? shift : LOCALE_CODE_DEFAULT;
149
150 return values %{ $CODES->[$codeset] };
151}
152
47a334e9 153
6b14ceb7
JH
154#=======================================================================
155#
917211f5 156# alias_code ( ALIAS => CODE [ , CODESET ] )
6b14ceb7
JH
157#
158# Add an alias for an existing code. If the CODESET isn't specified,
159# then we use the default (currently the alpha-2 codeset).
160#
917211f5 161# Locale::Country::alias_code('uk' => 'gb');
6b14ceb7
JH
162#
163#=======================================================================
917211f5 164sub alias_code
47a334e9
JH
165{
166 my $alias = shift;
167 my $real = shift;
168 my $codeset = @_ > 0 ? shift : LOCALE_CODE_DEFAULT;
169
170 my $country;
171
172
173 if (not exists $CODES->[$codeset]->{$real})
174 {
175 carp "attempt to alias \"$alias\" to unknown country code \"$real\"\n";
176 return undef;
177 }
178 $country = $CODES->[$codeset]->{$real};
179 $CODES->[$codeset]->{$alias} = $country;
180 $COUNTRIES->[$codeset]->{"\L$country"} = $alias;
181
182 return $alias;
183}
184
917211f5
JH
185# old name of function for backwards compatibility
186*_alias_code = *alias_code;
187
188
189#=======================================================================
190#
191# rename_country
192#
193# change the official name for a country, eg:
194# gb => 'Great Britain'
195# rather than the standard 'United Kingdom'. The original is retained
196# as an alias, but the new name will be returned if you lookup the
197# name from code.
198#
199#=======================================================================
200sub rename_country
201{
202 my $code = shift;
203 my $new_name = shift;
204 my $codeset = @_ > 0 ? shift : _code2codeset($code);
205 my $country;
206 my $c;
207
208
209 if (not defined $codeset)
210 {
211 carp "rename_country(): unknown country code \"$code\"\n";
212 return 0;
213 }
214
215 $country = $CODES->[$codeset]->{$code};
216
217 foreach my $cset (LOCALE_CODE_ALPHA_2,
218 LOCALE_CODE_ALPHA_3,
219 LOCALE_CODE_NUMERIC)
220 {
221 if ($cset == $codeset)
222 {
223 $c = $code;
224 }
225 else
226 {
227 $c = country_code2code($code, $codeset, $cset);
228 }
229
230 $CODES->[$cset]->{$c} = $new_name;
231 $COUNTRIES->[$cset]->{"\L$new_name"} = $c;
232 }
233
234 return 1;
235}
236
237
238#=======================================================================
239#
240# _code2codeset
241#
242# given a country code in an unknown codeset, return the codeset
243# it is from, or undef.
244#
245#=======================================================================
246sub _code2codeset
247{
248 my $code = shift;
249
250
251 foreach my $codeset (LOCALE_CODE_ALPHA_2, LOCALE_CODE_ALPHA_3,
252 LOCALE_CODE_NUMERIC)
253 {
254 return $codeset if (exists $CODES->[$codeset]->{$code})
255 }
256
257 return undef;
258}
259
47a334e9
JH
260
261#=======================================================================
6b14ceb7 262#
47a334e9 263# initialisation code - stuff the DATA into the ALPHA2 hash
6b14ceb7 264#
47a334e9
JH
265#=======================================================================
266{
267 my ($alpha2, $alpha3, $numeric);
6b6e008c 268 my ($country, @countries);
47a334e9
JH
269
270
271 while (<DATA>)
272 {
273 next unless /\S/;
274 chop;
6b6e008c 275 ($alpha2, $alpha3, $numeric, @countries) = split(/:/, $_);
47a334e9 276
6b6e008c
JH
277 $CODES->[LOCALE_CODE_ALPHA_2]->{$alpha2} = $countries[0];
278 foreach $country (@countries)
279 {
280 $COUNTRIES->[LOCALE_CODE_ALPHA_2]->{"\L$country"} = $alpha2;
281 }
47a334e9
JH
282
283 if ($alpha3)
284 {
6b6e008c
JH
285 $CODES->[LOCALE_CODE_ALPHA_3]->{$alpha3} = $countries[0];
286 foreach $country (@countries)
287 {
288 $COUNTRIES->[LOCALE_CODE_ALPHA_3]->{"\L$country"} = $alpha3;
289 }
47a334e9
JH
290 }
291
292 if ($numeric)
293 {
6b6e008c
JH
294 $CODES->[LOCALE_CODE_NUMERIC]->{$numeric} = $countries[0];
295 foreach $country (@countries)
296 {
297 $COUNTRIES->[LOCALE_CODE_NUMERIC]->{"\L$country"} = $numeric;
298 }
47a334e9
JH
299 }
300
301 }
302}
303
3041;
305
306__DATA__
307ad:and:020:Andorra
308ae:are:784:United Arab Emirates
309af:afg:004:Afghanistan
310ag:atg:028:Antigua and Barbuda
311ai:aia:660:Anguilla
312al:alb:008:Albania
313am:arm:051:Armenia
314an:ant:530:Netherlands Antilles
315ao:ago:024:Angola
316aq:::Antarctica
317ar:arg:032:Argentina
318as:asm:016:American Samoa
319at:aut:040:Austria
320au:aus:036:Australia
321aw:abw:533:Aruba
322az:aze:031:Azerbaijan
323ba:bih:070:Bosnia and Herzegovina
324bb:brb:052:Barbados
325bd:bgd:050:Bangladesh
326be:bel:056:Belgium
327bf:bfa:854:Burkina Faso
328bg:bgr:100:Bulgaria
329bh:bhr:048:Bahrain
330bi:bdi:108:Burundi
331bj:ben:204:Benin
332bm:bmu:060:Bermuda
333bn:brn:096:Brunei Darussalam
334bo:bol:068:Bolivia
335br:bra:076:Brazil
336bs:bhs:044:Bahamas
337bt:btn:064:Bhutan
338bv:::Bouvet Island
339bw:bwa:072:Botswana
340by:blr:112:Belarus
341bz:blz:084:Belize
342ca:can:124:Canada
343cc:::Cocos (Keeling) Islands
6b6e008c 344cd:cod:180:Congo, The Democratic Republic of the:Congo, Democratic Republic of the
47a334e9
JH
345cf:caf:140:Central African Republic
346cg:cog:178:Congo
347ch:che:756:Switzerland
348ci:civ:384:Cote D'Ivoire
349ck:cok:184:Cook Islands
350cl:chl:152:Chile
351cm:cmr:120:Cameroon
352cn:chn:156:China
353co:col:170:Colombia
354cr:cri:188:Costa Rica
355cu:cub:192:Cuba
356cv:cpv:132:Cape Verde
357cx:::Christmas Island
358cy:cyp:196:Cyprus
359cz:cze:203:Czech Republic
360de:deu:276:Germany
361dj:dji:262:Djibouti
362dk:dnk:208:Denmark
363dm:dma:212:Dominica
364do:dom:214:Dominican Republic
365dz:dza:012:Algeria
366ec:ecu:218:Ecuador
367ee:est:233:Estonia
368eg:egy:818:Egypt
369eh:esh:732:Western Sahara
370er:eri:232:Eritrea
371es:esp:724:Spain
372et:eth:231:Ethiopia
373fi:fin:246:Finland
374fj:fji:242:Fiji
6b6e008c 375fk:flk:238:Falkland Islands (Malvinas):Falkland Islands (Islas Malvinas)
47a334e9
JH
376fm:fsm:583:Micronesia, Federated States of
377fo:fro:234:Faroe Islands
378fr:fra:250:France
379fx:::France, Metropolitan
380ga:gab:266:Gabon
6b6e008c 381gb:gbr:826:United Kingdom:Great Britain
47a334e9
JH
382gd:grd:308:Grenada
383ge:geo:268:Georgia
384gf:guf:254:French Guiana
385gh:gha:288:Ghana
386gi:gib:292:Gibraltar
387gl:grl:304:Greenland
388gm:gmb:270:Gambia
389gn:gin:324:Guinea
390gp:glp:312:Guadeloupe
391gq:gnq:226:Equatorial Guinea
392gr:grc:300:Greece
393gs:::South Georgia and the South Sandwich Islands
394gt:gtm:320:Guatemala
395gu:gum:316:Guam
396gw:gnb:624:Guinea-Bissau
397gy:guy:328:Guyana
398hk:hkg:344:Hong Kong
399hm:::Heard Island and McDonald Islands
400hn:hnd:340:Honduras
401hr:hrv:191:Croatia
402ht:hti:332:Haiti
403hu:hun:348:Hungary
404id:idn:360:Indonesia
405ie:irl:372:Ireland
406il:isr:376:Israel
407in:ind:356:India
408io:::British Indian Ocean Territory
409iq:irq:368:Iraq
6b6e008c 410ir:irn:364:Iran, Islamic Republic of:Iran
47a334e9
JH
411is:isl:352:Iceland
412it:ita:380:Italy
413jm:jam:388:Jamaica
414jo:jor:400:Jordan
415jp:jpn:392:Japan
416ke:ken:404:Kenya
417kg:kgz:417:Kyrgyzstan
418kh:khm:116:Cambodia
419ki:kir:296:Kiribati
420km:com:174:Comoros
421kn:kna:659:Saint Kitts and Nevis
6b6e008c
JH
422kp:prk:408:Korea, Democratic People's Republic of:Korea, North:North Korea
423kr:kor:410:Korea, Republic of:Korea, South:South Korea
47a334e9
JH
424kw:kwt:414:Kuwait
425ky:cym:136:Cayman Islands
426kz:kaz:398:Kazakstan
427la:lao:418:Lao People's Democratic Republic
428lb:lbn:422:Lebanon
429lc:lca:662:Saint Lucia
430li:lie:438:Liechtenstein
431lk:lka:144:Sri Lanka
432lr:lbr:430:Liberia
433ls:lso:426:Lesotho
434lt:ltu:440:Lithuania
435lu:lux:442:Luxembourg
436lv:lva:428:Latvia
6b6e008c 437ly:lby:434:Libyan Arab Jamahiriya:Libya
47a334e9
JH
438ma:mar:504:Morocco
439mc:mco:492:Monaco
440md:mda:498:Moldova, Republic of
441mg:mdg:450:Madagascar
442mh:mhl:584:Marshall Islands
6b6e008c 443mk:mkd:807:Macedonia, the Former Yugoslav Republic of:Macedonia, Former Yugoslav Republic of:Macedonia
47a334e9
JH
444ml:mli:466:Mali
445mm:mmr:104:Myanmar
446mn:mng:496:Mongolia
447mo:mac:446:Macau
448mp:mnp:580:Northern Mariana Islands
449mq:mtq:474:Martinique
450mr:mrt:478:Mauritania
451ms:msr:500:Montserrat
452mt:mlt:470:Malta
453mu:mus:480:Mauritius
454mv:mdv:462:Maldives
455mw:mwi:454:Malawi
456mx:mex:484:Mexico
457my:mys:458:Malaysia
458mz:moz:508:Mozambique
459na:nam:516:Namibia
460nc:ncl:540:New Caledonia
461ne:ner:562:Niger
462nf:nfk:574:Norfolk Island
463ng:nga:566:Nigeria
464ni:nic:558:Nicaragua
465nl:nld:528:Netherlands
466no:nor:578:Norway
467np:npl:524:Nepal
468nr:nru:520:Nauru
469nu:niu:570:Niue
470nz:nzl:554:New Zealand
471om:omn:512:Oman
472pa:pan:591:Panama
473pe:per:604:Peru
474pf:pyf:258:French Polynesia
475pg:png:598:Papua New Guinea
476ph:phl:608:Philippines
477pk:pak:586:Pakistan
478pl:pol:616:Poland
479pm:spm:666:Saint Pierre and Miquelon
6b6e008c 480pn:pcn:612:Pitcairn:Pitcairn Island
47a334e9
JH
481pr:pri:630:Puerto Rico
482ps:pse:275:Palestinian Territory, Occupied
483pt:prt:620:Portugal
484pw:plw:585:Palau
485py:pry:600:Paraguay
486qa:qat:634:Qatar
487re:reu:638:Reunion
488ro:rom:642:Romania
6b6e008c 489ru:rus:643:Russian Federation:Russia
47a334e9
JH
490rw:rwa:646:Rwanda
491sa:sau:682:Saudi Arabia
492sb:slb:090:Solomon Islands
493sc:syc:690:Seychelles
494sd:sdn:736:Sudan
495se:swe:752:Sweden
496sg:sgp:702:Singapore
497sh:shn:654:Saint Helena
498si:svn:705:Slovenia
6b6e008c 499sj:sjm:744:Svalbard and Jan Mayen:Jan Mayen:Svalbard
47a334e9
JH
500sk:svk:703:Slovakia
501sl:sle:694:Sierra Leone
502sm:smr:674:San Marino
503sn:sen:686:Senegal
504so:som:706:Somalia
505sr:sur:740:Suriname
506st:stp:678:Sao Tome and Principe
507sv:slv:222:El Salvador
6b6e008c 508sy:syr:760:Syrian Arab Republic:Syria
47a334e9
JH
509sz:swz:748:Swaziland
510tc:tca:796:Turks and Caicos Islands
511td:tcd:148:Chad
512tf:::French Southern Territories
513tg:tgo:768:Togo
514th:tha:764:Thailand
515tj:tjk:762:Tajikistan
516tk:tkl:772:Tokelau
517tm:tkm:795:Turkmenistan
518tn:tun:788:Tunisia
519to:ton:776:Tonga
520tp:tmp:626:East Timor
521tr:tur:792:Turkey
522tt:tto:780:Trinidad and Tobago
523tv:tuv:798:Tuvalu
6b6e008c
JH
524tw:twn:158:Taiwan, Province of China:Taiwan
525tz:tza:834:Tanzania, United Republic of:Tanzania
47a334e9
JH
526ua:ukr:804:Ukraine
527ug:uga:800:Uganda
528um:::United States Minor Outlying Islands
6b6e008c 529us:usa:840:United States:USA:United States of America
47a334e9
JH
530uy:ury:858:Uruguay
531uz:uzb:860:Uzbekistan
6b6e008c 532va:vat:336:Holy See (Vatican City State):Hole See (Vatican City)
47a334e9
JH
533vc:vct:670:Saint Vincent and the Grenadines
534ve:ven:862:Venezuela
6b6e008c 535vg:vgb:092:Virgin Islands, British:British Virgin Islands
47a334e9
JH
536vi:vir:850:Virgin Islands, U.S.
537vn:vnm:704:Vietnam
538vu:vut:548:Vanuatu
539wf:wlf:876:Wallis and Futuna
540ws:wsm:882:Samoa
541ye:yem:887:Yemen
542yt:::Mayotte
543yu:yug:891:Yugoslavia
544za:zaf:710:South Africa
545zm:zmb:894:Zambia
546zr:::Zaire
547zw:zwe:716:Zimbabwe