0053d91a3881b36c3d2b4803c7fbc7ed0642aebe
[p5sagit/p5-mst-13.2.git] / pod / perlebcdic.pod
1 =head1 NAME
2
3 perlebcdic - Considerations for running Perl on EBCDIC platforms
4
5 =head1 DESCRIPTION
6
7 An exploration of some of the issues facing Perl programmers
8 on EBCDIC based computers.  We do not cover localization, 
9 internationalization, or multi byte character set issues other
10 than some discussion of UTF-8 and UTF-EBCDIC.
11
12 Portions that are still incomplete are marked with XXX.
13
14 =head1 COMMON CHARACTER CODE SETS
15
16 =head2 ASCII
17
18 The American Standard Code for Information Interchange is a set of
19 integers running from 0 to 127 (decimal) that imply character 
20 interpretation by the display and other system(s) of computers.  
21 The range 0..127 can be covered by setting the bits in a 7-bit binary 
22 digit, hence the set is sometimes referred to as a "7-bit ASCII".  
23 ASCII was described by the American National Standards Institute 
24 document ANSI X3.4-1986.  It was also described by ISO 646:1991 
25 (with localization for currency symbols).  The full ASCII set is 
26 given in the table below as the first 128 elements.  Languages that 
27 can be written adequately with the characters in ASCII include 
28 English, Hawaiian, Indonesian, Swahili and some Native American 
29 languages.
30
31 There are many character sets that extend the range of integers
32 from 0..2**7-1 up to 2**8-1, or 8 bit bytes (octets if you prefer).
33 One common one is the ISO 8859-1 character set.
34
35 =head2 ISO 8859
36
37 The ISO 8859-$n are a collection of character code sets from the 
38 International Organization for Standardization (ISO) each of which 
39 adds characters to the ASCII set that are typically found in European 
40 languages many of which are based on the Roman, or Latin, alphabet.
41
42 =head2 Latin 1 (ISO 8859-1)
43
44 A particular 8-bit extension to ASCII that includes grave and acute 
45 accented Latin characters.  Languages that can employ ISO 8859-1 
46 include all the languages covered by ASCII as well as Afrikaans, 
47 Albanian, Basque, Catalan, Danish, Faroese, Finnish, Norwegian, 
48 Portuguese, Spanish, and Swedish.  Dutch is covered albeit without 
49 the ij ligature.  French is covered too but without the oe ligature. 
50 German can use ISO 8859-1 but must do so without German-style
51 quotation marks.  This set is based on Western European extensions 
52 to ASCII and is commonly encountered in world wide web work.
53 In IBM character code set identification terminology ISO 8859-1 is
54 also known as CCSID 819 (or sometimes 0819 or even 00819).
55
56 =head2 EBCDIC
57
58 The Extended Binary Coded Decimal Interchange Code refers to a 
59 large collection of slightly different single and multi byte 
60 coded character sets that are different from ASCII or ISO 8859-1 
61 and typically run on host computers.  The EBCDIC encodings derive 
62 from 8 bit byte extensions of Hollerith punched card encodings.
63 The layout on the cards was such that high bits were set for the
64 upper and lower case alphabet characters [a-z] and [A-Z], but there
65 were gaps within each latin alphabet range.
66
67 Some IBM EBCDIC character sets may be known by character code set 
68 identification numbers (CCSID numbers) or code page numbers.  Leading
69 zero digits in CCSID numbers within this document are insignificant.
70 E.g. CCSID 0037 may be referred to as 37 in places.
71
72 =head2 13 variant characters
73
74 Among IBM EBCDIC character code sets there are 13 characters that
75 are often mapped to different integer values.  Those characters
76 are known as the 13 "variant" characters and are:
77
78     \ [ ] { } ^ ~ ! # | $ @ ` 
79
80 =head2 0037
81
82 Character code set ID 0037 is a mapping of the ASCII plus Latin-1 
83 characters (i.e. ISO 8859-1) to an EBCDIC set.  0037 is used 
84 in North American English locales on the OS/400 operating system 
85 that runs on AS/400 computers.  CCSID 37 differs from ISO 8859-1 
86 in 237 places, in other words they agree on only 19 code point values.
87
88 =head2 1047
89
90 Character code set ID 1047 is also a mapping of the ASCII plus 
91 Latin-1 characters (i.e. ISO 8859-1) to an EBCDIC set.  1047 is 
92 used under Unix System Services for OS/390 or z/OS, and OpenEdition 
93 for VM/ESA.  CCSID 1047 differs from CCSID 0037 in eight places.
94
95 =head2 POSIX-BC
96
97 The EBCDIC code page in use on Siemens' BS2000 system is distinct from
98 1047 and 0037.  It is identified below as the POSIX-BC set.
99
100 =head2 Unicode code points versus EBCDIC code points
101
102 In Unicode terminology a I<code point> is the number assigned to a
103 character: for example, in EBCDIC the character "A" is usually assigned
104 the number 193.  In Unicode the character "A" is assigned the number 65.
105 This causes a problem with the semantics of the pack/unpack "U", which
106 are supposed to pack Unicode code points to characters and back to numbers.
107 The problem is: which code points to use for code points less than 256?
108 (for 256 and over there's no problem: Unicode code points are used)
109 In EBCDIC, for the low 256 the EBCDIC code points are used.  This
110 means that the equivalences
111
112         pack("U", ord($character)) eq $character
113         unpack("U", $character) == ord $character
114
115 will hold.  (If Unicode code points were applied consistently over
116 all the possible code points, pack("U",ord("A")) would in EBCDIC
117 equal I<A with acute> or chr(101), and unpack("U", "A") would equal
118 65, or I<non-breaking space>, not 193, or ord "A".)
119
120 =head2 Unicode and UTF
121
122 UTF is a Unicode Transformation Format.  UTF-8 is a Unicode conforming
123 representation of the Unicode standard that looks very much like ASCII.
124 UTF-EBCDIC is an attempt to represent Unicode characters in an EBCDIC
125 transparent manner.
126
127 =head2 Using Encode
128
129 Starting from Perl 5.8 you can use the standard new module Encode
130 to translate from EBCDIC to Latin-1 code points
131
132         use Encode 'from_to';
133
134         my %ebcdic = ( 176 => 'cp37', 95 => 'cp1047', 106 => 'posix-bc' );
135
136         # $a is in EBCDIC code points
137         from_to($a, $ebcdic{ord '^'}, 'latin1');
138         # $a is ISO 8859-1 code points
139
140 and from Latin-1 code points to EBCDIC code points
141
142         use Encode 'from_to';
143
144         my %ebcdic = ( 176 => 'cp37', 95 => 'cp1047', 106 => 'posix-bc' );
145
146         # $a is ISO 8859-1 code points
147         from_to($a, 'latin1', $ebcdic{ord '^'});
148         # $a is in EBCDIC code points
149
150 For doing I/O it is suggested that you use the autotranslating features
151 of PerlIO, see L<perluniintro>.
152
153 =head1 SINGLE OCTET TABLES
154
155 The following tables list the ASCII and Latin 1 ordered sets including
156 the subsets: C0 controls (0..31), ASCII graphics (32..7e), delete (7f),
157 C1 controls (80..9f), and Latin-1 (a.k.a. ISO 8859-1) (a0..ff).  In the 
158 table non-printing control character names as well as the Latin 1 
159 extensions to ASCII have been labelled with character names roughly 
160 corresponding to I<The Unicode Standard, Version 3.0> albeit with 
161 substitutions such as s/LATIN// and s/VULGAR// in all cases, 
162 s/CAPITAL LETTER// in some cases, and s/SMALL LETTER ([A-Z])/\l$1/ 
163 in some other cases (the C<charnames> pragma names unfortunately do 
164 not list explicit names for the C0 or C1 control characters).  The 
165 "names" of the C1 control set (128..159 in ISO 8859-1) listed here are 
166 somewhat arbitrary.  The differences between the 0037 and 1047 sets are 
167 flagged with ***.  The differences between the 1047 and POSIX-BC sets 
168 are flagged with ###.  All ord() numbers listed are decimal.  If you 
169 would rather see this table listing octal values then run the table 
170 (that is, the pod version of this document since this recipe may not 
171 work with a pod2_other_format translation) through:
172
173 =over 4
174
175 =item recipe 0
176
177 =back
178
179     perl -ne 'if(/(.{33})(\d+)\s+(\d+)\s+(\d+)\s+(\d+)/)' \
180      -e '{printf("%s%-9o%-9o%-9o%o\n",$1,$2,$3,$4,$5)}' perlebcdic.pod
181
182 If you want to retain the UTF-x code points then in script form you
183 might want to write:
184
185 =over 4
186
187 =item recipe 1
188
189 =back
190
191     open(FH,"<perlebcdic.pod") or die "Could not open perlebcdic.pod: $!";
192     while (<FH>) {
193         if (/(.{33})(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\.?(\d*)\s+(\d+)\.?(\d*)/)  {
194             if ($7 ne '' && $9 ne '') {
195                 printf("%s%-9o%-9o%-9o%-9o%-3o.%-5o%-3o.%o\n",$1,$2,$3,$4,$5,$6,$7,$8,$9);
196             }
197             elsif ($7 ne '') {
198                 printf("%s%-9o%-9o%-9o%-9o%-3o.%-5o%o\n",$1,$2,$3,$4,$5,$6,$7,$8);
199             }
200             else {
201                 printf("%s%-9o%-9o%-9o%-9o%-9o%o\n",$1,$2,$3,$4,$5,$6,$8);
202             }
203         }
204     }
205
206 If you would rather see this table listing hexadecimal values then
207 run the table through:
208
209 =over 4
210
211 =item recipe 2
212
213 =back
214
215     perl -ne 'if(/(.{33})(\d+)\s+(\d+)\s+(\d+)\s+(\d+)/)' \
216      -e '{printf("%s%-9X%-9X%-9X%X\n",$1,$2,$3,$4,$5)}' perlebcdic.pod
217
218 Or, in order to retain the UTF-x code points in hexadecimal:
219
220 =over 4
221
222 =item recipe 3
223
224 =back
225
226     open(FH,"<perlebcdic.pod") or die "Could not open perlebcdic.pod: $!";
227     while (<FH>) {
228         if (/(.{33})(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\.?(\d*)\s+(\d+)\.?(\d*)/)  {
229             if ($7 ne '' && $9 ne '') {
230                 printf("%s%-9X%-9X%-9X%-9X%-2X.%-6X%-2X.%X\n",$1,$2,$3,$4,$5,$6,$7,$8,$9);
231             }
232             elsif ($7 ne '') {
233                 printf("%s%-9X%-9X%-9X%-9X%-2X.%-6X%X\n",$1,$2,$3,$4,$5,$6,$7,$8);
234             }
235             else {
236                 printf("%s%-9X%-9X%-9X%-9X%-9X%X\n",$1,$2,$3,$4,$5,$6,$8);
237             }
238         }
239     }
240
241
242                                                                      incomp-  incomp-
243                                  8859-1                              lete     lete
244     chr                          0819     0037     1047     POSIX-BC UTF-8    UTF-EBCDIC
245     ------------------------------------------------------------------------------------
246     <NULL>                       0        0        0        0        0        0 
247     <START OF HEADING>           1        1        1        1        1        1
248     <START OF TEXT>              2        2        2        2        2        2
249     <END OF TEXT>                3        3        3        3        3        3
250     <END OF TRANSMISSION>        4        55       55       55       4        55 
251     <ENQUIRY>                    5        45       45       45       5        45 
252     <ACKNOWLEDGE>                6        46       46       46       6        46 
253     <BELL>                       7        47       47       47       7        47 
254     <BACKSPACE>                  8        22       22       22       8        22 
255     <HORIZONTAL TABULATION>      9        5        5        5        9        5 
256     <LINE FEED>                  10       37       21       21       10       21       ***
257     <VERTICAL TABULATION>        11       11       11       11       11       11
258     <FORM FEED>                  12       12       12       12       12       12
259     <CARRIAGE RETURN>            13       13       13       13       13       13
260     <SHIFT OUT>                  14       14       14       14       14       14
261     <SHIFT IN>                   15       15       15       15       15       15
262     <DATA LINK ESCAPE>           16       16       16       16       16       16
263     <DEVICE CONTROL ONE>         17       17       17       17       17       17
264     <DEVICE CONTROL TWO>         18       18       18       18       18       18
265     <DEVICE CONTROL THREE>       19       19       19       19       19       19
266     <DEVICE CONTROL FOUR>        20       60       60       60       20       60
267     <NEGATIVE ACKNOWLEDGE>       21       61       61       61       21       61
268     <SYNCHRONOUS IDLE>           22       50       50       50       22       50
269     <END OF TRANSMISSION BLOCK>  23       38       38       38       23       38
270     <CANCEL>                     24       24       24       24       24       24
271     <END OF MEDIUM>              25       25       25       25       25       25
272     <SUBSTITUTE>                 26       63       63       63       26       63
273     <ESCAPE>                     27       39       39       39       27       39
274     <FILE SEPARATOR>             28       28       28       28       28       28
275     <GROUP SEPARATOR>            29       29       29       29       29       29
276     <RECORD SEPARATOR>           30       30       30       30       30       30
277     <UNIT SEPARATOR>             31       31       31       31       31       31
278     <SPACE>                      32       64       64       64       32       64
279     !                            33       90       90       90       33       90
280     "                            34       127      127      127      34       127
281     #                            35       123      123      123      35       123
282     $                            36       91       91       91       36       91
283     %                            37       108      108      108      37       108
284     &                            38       80       80       80       38       80
285     '                            39       125      125      125      39       125
286     (                            40       77       77       77       40       77
287     )                            41       93       93       93       41       93
288     *                            42       92       92       92       42       92
289     +                            43       78       78       78       43       78
290     ,                            44       107      107      107      44       107
291     -                            45       96       96       96       45       96
292     .                            46       75       75       75       46       75
293     /                            47       97       97       97       47       97
294     0                            48       240      240      240      48       240
295     1                            49       241      241      241      49       241
296     2                            50       242      242      242      50       242
297     3                            51       243      243      243      51       243
298     4                            52       244      244      244      52       244
299     5                            53       245      245      245      53       245
300     6                            54       246      246      246      54       246
301     7                            55       247      247      247      55       247
302     8                            56       248      248      248      56       248
303     9                            57       249      249      249      57       249
304     :                            58       122      122      122      58       122
305     ;                            59       94       94       94       59       94
306     <                            60       76       76       76       60       76
307     =                            61       126      126      126      61       126
308     >                            62       110      110      110      62       110
309     ?                            63       111      111      111      63       111
310     @                            64       124      124      124      64       124
311     A                            65       193      193      193      65       193
312     B                            66       194      194      194      66       194
313     C                            67       195      195      195      67       195
314     D                            68       196      196      196      68       196
315     E                            69       197      197      197      69       197
316     F                            70       198      198      198      70       198
317     G                            71       199      199      199      71       199
318     H                            72       200      200      200      72       200
319     I                            73       201      201      201      73       201
320     J                            74       209      209      209      74       209
321     K                            75       210      210      210      75       210
322     L                            76       211      211      211      76       211
323     M                            77       212      212      212      77       212
324     N                            78       213      213      213      78       213
325     O                            79       214      214      214      79       214
326     P                            80       215      215      215      80       215
327     Q                            81       216      216      216      81       216
328     R                            82       217      217      217      82       217
329     S                            83       226      226      226      83       226
330     T                            84       227      227      227      84       227
331     U                            85       228      228      228      85       228
332     V                            86       229      229      229      86       229
333     W                            87       230      230      230      87       230
334     X                            88       231      231      231      88       231
335     Y                            89       232      232      232      89       232
336     Z                            90       233      233      233      90       233
337     [                            91       186      173      187      91       173      *** ###
338     \                            92       224      224      188      92       224      ### 
339     ]                            93       187      189      189      93       189      ***
340     ^                            94       176      95       106      94       95       *** ###
341     _                            95       109      109      109      95       109
342     `                            96       121      121      74       96       121      ###
343     a                            97       129      129      129      97       129
344     b                            98       130      130      130      98       130
345     c                            99       131      131      131      99       131
346     d                            100      132      132      132      100      132
347     e                            101      133      133      133      101      133
348     f                            102      134      134      134      102      134
349     g                            103      135      135      135      103      135
350     h                            104      136      136      136      104      136
351     i                            105      137      137      137      105      137
352     j                            106      145      145      145      106      145
353     k                            107      146      146      146      107      146
354     l                            108      147      147      147      108      147
355     m                            109      148      148      148      109      148
356     n                            110      149      149      149      110      149
357     o                            111      150      150      150      111      150
358     p                            112      151      151      151      112      151
359     q                            113      152      152      152      113      152
360     r                            114      153      153      153      114      153
361     s                            115      162      162      162      115      162
362     t                            116      163      163      163      116      163
363     u                            117      164      164      164      117      164
364     v                            118      165      165      165      118      165
365     w                            119      166      166      166      119      166
366     x                            120      167      167      167      120      167
367     y                            121      168      168      168      121      168
368     z                            122      169      169      169      122      169
369     {                            123      192      192      251      123      192      ###
370     |                            124      79       79       79       124      79
371     }                            125      208      208      253      125      208      ###
372     ~                            126      161      161      255      126      161      ###
373     <DELETE>                     127      7        7        7        127      7
374     <C1 0>                       128      32       32       32       194.128  32
375     <C1 1>                       129      33       33       33       194.129  33
376     <C1 2>                       130      34       34       34       194.130  34
377     <C1 3>                       131      35       35       35       194.131  35
378     <C1 4>                       132      36       36       36       194.132  36
379     <C1 5>                       133      21       37       37       194.133  37       ***
380     <C1 6>                       134      6        6        6        194.134  6
381     <C1 7>                       135      23       23       23       194.135  23
382     <C1 8>                       136      40       40       40       194.136  40
383     <C1 9>                       137      41       41       41       194.137  41
384     <C1 10>                      138      42       42       42       194.138  42
385     <C1 11>                      139      43       43       43       194.139  43
386     <C1 12>                      140      44       44       44       194.140  44
387     <C1 13>                      141      9        9        9        194.141  9
388     <C1 14>                      142      10       10       10       194.142  10
389     <C1 15>                      143      27       27       27       194.143  27
390     <C1 16>                      144      48       48       48       194.144  48
391     <C1 17>                      145      49       49       49       194.145  49
392     <C1 18>                      146      26       26       26       194.146  26
393     <C1 19>                      147      51       51       51       194.147  51
394     <C1 20>                      148      52       52       52       194.148  52
395     <C1 21>                      149      53       53       53       194.149  53
396     <C1 22>                      150      54       54       54       194.150  54
397     <C1 23>                      151      8        8        8        194.151  8
398     <C1 24>                      152      56       56       56       194.152  56
399     <C1 25>                      153      57       57       57       194.153  57
400     <C1 26>                      154      58       58       58       194.154  58
401     <C1 27>                      155      59       59       59       194.155  59
402     <C1 28>                      156      4        4        4        194.156  4
403     <C1 29>                      157      20       20       20       194.157  20
404     <C1 30>                      158      62       62       62       194.158  62
405     <C1 31>                      159      255      255      95       194.159  255      ###
406     <NON-BREAKING SPACE>         160      65       65       65       194.160  128.65
407     <INVERTED EXCLAMATION MARK>  161      170      170      170      194.161  128.66
408     <CENT SIGN>                  162      74       74       176      194.162  128.67   ###
409     <POUND SIGN>                 163      177      177      177      194.163  128.68
410     <CURRENCY SIGN>              164      159      159      159      194.164  128.69
411     <YEN SIGN>                   165      178      178      178      194.165  128.70
412     <BROKEN BAR>                 166      106      106      208      194.166  128.71   ###
413     <SECTION SIGN>               167      181      181      181      194.167  128.72
414     <DIAERESIS>                  168      189      187      121      194.168  128.73   *** ###
415     <COPYRIGHT SIGN>             169      180      180      180      194.169  128.74
416     <FEMININE ORDINAL INDICATOR> 170      154      154      154      194.170  128.81
417     <LEFT POINTING GUILLEMET>    171      138      138      138      194.171  128.82
418     <NOT SIGN>                   172      95       176      186      194.172  128.83   *** ###
419     <SOFT HYPHEN>                173      202      202      202      194.173  128.84
420     <REGISTERED TRADE MARK SIGN> 174      175      175      175      194.174  128.85
421     <MACRON>                     175      188      188      161      194.175  128.86   ###
422     <DEGREE SIGN>                176      144      144      144      194.176  128.87
423     <PLUS-OR-MINUS SIGN>         177      143      143      143      194.177  128.88
424     <SUPERSCRIPT TWO>            178      234      234      234      194.178  128.89
425     <SUPERSCRIPT THREE>          179      250      250      250      194.179  128.98
426     <ACUTE ACCENT>               180      190      190      190      194.180  128.99
427     <MICRO SIGN>                 181      160      160      160      194.181  128.100
428     <PARAGRAPH SIGN>             182      182      182      182      194.182  128.101
429     <MIDDLE DOT>                 183      179      179      179      194.183  128.102
430     <CEDILLA>                    184      157      157      157      194.184  128.103
431     <SUPERSCRIPT ONE>            185      218      218      218      194.185  128.104
432     <MASC. ORDINAL INDICATOR>    186      155      155      155      194.186  128.105
433     <RIGHT POINTING GUILLEMET>   187      139      139      139      194.187  128.106
434     <FRACTION ONE QUARTER>       188      183      183      183      194.188  128.112
435     <FRACTION ONE HALF>          189      184      184      184      194.189  128.113
436     <FRACTION THREE QUARTERS>    190      185      185      185      194.190  128.114
437     <INVERTED QUESTION MARK>     191      171      171      171      194.191  128.115
438     <A WITH GRAVE>               192      100      100      100      195.128  138.65
439     <A WITH ACUTE>               193      101      101      101      195.129  138.66
440     <A WITH CIRCUMFLEX>          194      98       98       98       195.130  138.67
441     <A WITH TILDE>               195      102      102      102      195.131  138.68
442     <A WITH DIAERESIS>           196      99       99       99       195.132  138.69
443     <A WITH RING ABOVE>          197      103      103      103      195.133  138.70
444     <CAPITAL LIGATURE AE>        198      158      158      158      195.134  138.71
445     <C WITH CEDILLA>             199      104      104      104      195.135  138.72
446     <E WITH GRAVE>               200      116      116      116      195.136  138.73
447     <E WITH ACUTE>               201      113      113      113      195.137  138.74
448     <E WITH CIRCUMFLEX>          202      114      114      114      195.138  138.81
449     <E WITH DIAERESIS>           203      115      115      115      195.139  138.82
450     <I WITH GRAVE>               204      120      120      120      195.140  138.83
451     <I WITH ACUTE>               205      117      117      117      195.141  138.84
452     <I WITH CIRCUMFLEX>          206      118      118      118      195.142  138.85
453     <I WITH DIAERESIS>           207      119      119      119      195.143  138.86
454     <CAPITAL LETTER ETH>         208      172      172      172      195.144  138.87
455     <N WITH TILDE>               209      105      105      105      195.145  138.88
456     <O WITH GRAVE>               210      237      237      237      195.146  138.89
457     <O WITH ACUTE>               211      238      238      238      195.147  138.98
458     <O WITH CIRCUMFLEX>          212      235      235      235      195.148  138.99
459     <O WITH TILDE>               213      239      239      239      195.149  138.100
460     <O WITH DIAERESIS>           214      236      236      236      195.150  138.101
461     <MULTIPLICATION SIGN>        215      191      191      191      195.151  138.102
462     <O WITH STROKE>              216      128      128      128      195.152  138.103
463     <U WITH GRAVE>               217      253      253      224      195.153  138.104  ###
464     <U WITH ACUTE>               218      254      254      254      195.154  138.105
465     <U WITH CIRCUMFLEX>          219      251      251      221      195.155  138.106  ###
466     <U WITH DIAERESIS>           220      252      252      252      195.156  138.112
467     <Y WITH ACUTE>               221      173      186      173      195.157  138.113  *** ###
468     <CAPITAL LETTER THORN>       222      174      174      174      195.158  138.114
469     <SMALL LETTER SHARP S>       223      89       89       89       195.159  138.115
470     <a WITH GRAVE>               224      68       68       68       195.160  139.65
471     <a WITH ACUTE>               225      69       69       69       195.161  139.66
472     <a WITH CIRCUMFLEX>          226      66       66       66       195.162  139.67
473     <a WITH TILDE>               227      70       70       70       195.163  139.68
474     <a WITH DIAERESIS>           228      67       67       67       195.164  139.69
475     <a WITH RING ABOVE>          229      71       71       71       195.165  139.70
476     <SMALL LIGATURE ae>          230      156      156      156      195.166  139.71
477     <c WITH CEDILLA>             231      72       72       72       195.167  139.72
478     <e WITH GRAVE>               232      84       84       84       195.168  139.73
479     <e WITH ACUTE>               233      81       81       81       195.169  139.74
480     <e WITH CIRCUMFLEX>          234      82       82       82       195.170  139.81
481     <e WITH DIAERESIS>           235      83       83       83       195.171  139.82
482     <i WITH GRAVE>               236      88       88       88       195.172  139.83
483     <i WITH ACUTE>               237      85       85       85       195.173  139.84
484     <i WITH CIRCUMFLEX>          238      86       86       86       195.174  139.85
485     <i WITH DIAERESIS>           239      87       87       87       195.175  139.86
486     <SMALL LETTER eth>           240      140      140      140      195.176  139.87
487     <n WITH TILDE>               241      73       73       73       195.177  139.88
488     <o WITH GRAVE>               242      205      205      205      195.178  139.89
489     <o WITH ACUTE>               243      206      206      206      195.179  139.98
490     <o WITH CIRCUMFLEX>          244      203      203      203      195.180  139.99
491     <o WITH TILDE>               245      207      207      207      195.181  139.100
492     <o WITH DIAERESIS>           246      204      204      204      195.182  139.101
493     <DIVISION SIGN>              247      225      225      225      195.183  139.102
494     <o WITH STROKE>              248      112      112      112      195.184  139.103
495     <u WITH GRAVE>               249      221      221      192      195.185  139.104  ###
496     <u WITH ACUTE>               250      222      222      222      195.186  139.105
497     <u WITH CIRCUMFLEX>          251      219      219      219      195.187  139.106
498     <u WITH DIAERESIS>           252      220      220      220      195.188  139.112
499     <y WITH ACUTE>               253      141      141      141      195.189  139.113
500     <SMALL LETTER thorn>         254      142      142      142      195.190  139.114
501     <y WITH DIAERESIS>           255      223      223      223      195.191  139.115
502
503 If you would rather see the above table in CCSID 0037 order rather than
504 ASCII + Latin-1 order then run the table through:
505
506 =over 4
507
508 =item recipe 4
509
510 =back
511
512     perl -ne 'if(/.{33}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}/)'\
513      -e '{push(@l,$_)}' \
514      -e 'END{print map{$_->[0]}' \
515      -e '          sort{$a->[1] <=> $b->[1]}' \
516      -e '          map{[$_,substr($_,42,3)]}@l;}' perlebcdic.pod
517
518 If you would rather see it in CCSID 1047 order then change the digit
519 42 in the last line to 51, like this:
520
521 =over 4
522
523 =item recipe 5
524
525 =back
526
527     perl -ne 'if(/.{33}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}/)'\
528      -e '{push(@l,$_)}' \
529      -e 'END{print map{$_->[0]}' \
530      -e '          sort{$a->[1] <=> $b->[1]}' \
531      -e '          map{[$_,substr($_,51,3)]}@l;}' perlebcdic.pod
532
533 If you would rather see it in POSIX-BC order then change the digit
534 51 in the last line to 60, like this:
535
536 =over 4
537
538 =item recipe 6
539
540 =back
541
542     perl -ne 'if(/.{33}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}\s{6,8}\d{1,3}/)'\
543      -e '{push(@l,$_)}' \
544      -e 'END{print map{$_->[0]}' \
545      -e '          sort{$a->[1] <=> $b->[1]}' \
546      -e '          map{[$_,substr($_,60,3)]}@l;}' perlebcdic.pod
547
548
549 =head1 IDENTIFYING CHARACTER CODE SETS
550
551 To determine the character set you are running under from perl one 
552 could use the return value of ord() or chr() to test one or more 
553 character values.  For example:
554
555     $is_ascii  = "A" eq chr(65);
556     $is_ebcdic = "A" eq chr(193);
557
558 Also, "\t" is a C<HORIZONTAL TABULATION> character so that:
559
560     $is_ascii  = ord("\t") == 9;
561     $is_ebcdic = ord("\t") == 5;
562
563 To distinguish EBCDIC code pages try looking at one or more of
564 the characters that differ between them.  For example:
565
566     $is_ebcdic_37   = "\n" eq chr(37);
567     $is_ebcdic_1047 = "\n" eq chr(21);
568
569 Or better still choose a character that is uniquely encoded in any
570 of the code sets, e.g.:
571
572     $is_ascii           = ord('[') == 91;
573     $is_ebcdic_37       = ord('[') == 186;
574     $is_ebcdic_1047     = ord('[') == 173;
575     $is_ebcdic_POSIX_BC = ord('[') == 187;
576
577 However, it would be unwise to write tests such as:
578
579     $is_ascii = "\r" ne chr(13);  #  WRONG
580     $is_ascii = "\n" ne chr(10);  #  ILL ADVISED
581
582 Obviously the first of these will fail to distinguish most ASCII machines
583 from either a CCSID 0037, a 1047, or a POSIX-BC EBCDIC machine since "\r" eq 
584 chr(13) under all of those coded character sets.  But note too that 
585 because "\n" is chr(13) and "\r" is chr(10) on the MacIntosh (which is an 
586 ASCII machine) the second C<$is_ascii> test will lead to trouble there.
587
588 To determine whether or not perl was built under an EBCDIC 
589 code page you can use the Config module like so:
590
591     use Config;
592     $is_ebcdic = $Config{'ebcdic'} eq 'define';
593
594 =head1 CONVERSIONS
595
596 =head2 tr///
597
598 In order to convert a string of characters from one character set to 
599 another a simple list of numbers, such as in the right columns in the
600 above table, along with perl's tr/// operator is all that is needed.  
601 The data in the table are in ASCII order hence the EBCDIC columns 
602 provide easy to use ASCII to EBCDIC operations that are also easily 
603 reversed.
604
605 For example, to convert ASCII to code page 037 take the output of the second 
606 column from the output of recipe 0 (modified to add \\ characters) and use 
607 it in tr/// like so:
608
609     $cp_037 = 
610     '\000\001\002\003\234\011\206\177\227\215\216\013\014\015\016\017' .
611     '\020\021\022\023\235\205\010\207\030\031\222\217\034\035\036\037' .
612     '\200\201\202\203\204\012\027\033\210\211\212\213\214\005\006\007' .
613     '\220\221\026\223\224\225\226\004\230\231\232\233\024\025\236\032' .
614     '\040\240\342\344\340\341\343\345\347\361\242\056\074\050\053\174' .
615     '\046\351\352\353\350\355\356\357\354\337\041\044\052\051\073\254' .
616     '\055\057\302\304\300\301\303\305\307\321\246\054\045\137\076\077' .
617     '\370\311\312\313\310\315\316\317\314\140\072\043\100\047\075\042' .
618     '\330\141\142\143\144\145\146\147\150\151\253\273\360\375\376\261' .
619     '\260\152\153\154\155\156\157\160\161\162\252\272\346\270\306\244' .
620     '\265\176\163\164\165\166\167\170\171\172\241\277\320\335\336\256' .
621     '\136\243\245\267\251\247\266\274\275\276\133\135\257\250\264\327' .
622     '\173\101\102\103\104\105\106\107\110\111\255\364\366\362\363\365' .
623     '\175\112\113\114\115\116\117\120\121\122\271\373\374\371\372\377' .
624     '\134\367\123\124\125\126\127\130\131\132\262\324\326\322\323\325' .
625     '\060\061\062\063\064\065\066\067\070\071\263\333\334\331\332\237' ;
626
627     my $ebcdic_string = $ascii_string;
628     eval '$ebcdic_string =~ tr/\000-\377/' . $cp_037 . '/';
629
630 To convert from EBCDIC 037 to ASCII just reverse the order of the tr/// 
631 arguments like so:
632
633     my $ascii_string = $ebcdic_string;
634     eval '$ascii_string = tr/' . $cp_037 . '/\000-\377/';
635
636 Similarly one could take the output of the third column from recipe 0 to
637 obtain a C<$cp_1047> table.  The fourth column of the output from recipe
638 0 could provide a C<$cp_posix_bc> table suitable for transcoding as well.
639
640 =head2 iconv
641
642 XPG operability often implies the presence of an I<iconv> utility
643 available from the shell or from the C library.  Consult your system's
644 documentation for information on iconv.
645
646 On OS/390 or z/OS see the iconv(1) manpage.  One way to invoke the iconv 
647 shell utility from within perl would be to:
648
649     # OS/390 or z/OS example
650     $ascii_data = `echo '$ebcdic_data'| iconv -f IBM-1047 -t ISO8859-1`
651
652 or the inverse map:
653
654     # OS/390 or z/OS example
655     $ebcdic_data = `echo '$ascii_data'| iconv -f ISO8859-1 -t IBM-1047`
656
657 For other perl based conversion options see the Convert::* modules on CPAN.
658
659 =head2 C RTL
660
661 The OS/390 and z/OS C run time libraries provide _atoe() and _etoa() functions.
662
663 =head1 OPERATOR DIFFERENCES
664
665 The C<..> range operator treats certain character ranges with 
666 care on EBCDIC machines.  For example the following array
667 will have twenty six elements on either an EBCDIC machine
668 or an ASCII machine:
669
670     @alphabet = ('A'..'Z');   #  $#alphabet == 25
671
672 The bitwise operators such as & ^ | may return different results
673 when operating on string or character data in a perl program running 
674 on an EBCDIC machine than when run on an ASCII machine.  Here is
675 an example adapted from the one in L<perlop>:
676
677     # EBCDIC-based examples
678     print "j p \n" ^ " a h";                      # prints "JAPH\n"
679     print "JA" | "  ph\n";                        # prints "japh\n" 
680     print "JAPH\nJunk" & "\277\277\277\277\277";  # prints "japh\n";
681     print 'p N$' ^ " E<H\n";                      # prints "Perl\n";
682
683 An interesting property of the 32 C0 control characters
684 in the ASCII table is that they can "literally" be constructed
685 as control characters in perl, e.g. C<(chr(0) eq "\c@")> 
686 C<(chr(1) eq "\cA")>, and so on.  Perl on EBCDIC machines has been 
687 ported to take "\c@" to chr(0) and "\cA" to chr(1) as well, but the
688 thirty three characters that result depend on which code page you are
689 using.  The table below uses the character names from the previous table 
690 but with substitutions such as s/START OF/S.O./; s/END OF /E.O./; 
691 s/TRANSMISSION/TRANS./; s/TABULATION/TAB./; s/VERTICAL/VERT./; 
692 s/HORIZONTAL/HORIZ./; s/DEVICE CONTROL/D.C./; s/SEPARATOR/SEP./; 
693 s/NEGATIVE ACKNOWLEDGE/NEG. ACK./;.  The POSIX-BC and 1047 sets are
694 identical throughout this range and differ from the 0037 set at only 
695 one spot (21 decimal).  Note that the C<LINE FEED> character
696 may be generated by "\cJ" on ASCII machines but by "\cU" on 1047 or POSIX-BC 
697 machines and cannot be generated as a C<"\c.letter."> control character on 
698 0037 machines.  Note also that "\c\\" maps to two characters
699 not one.
700
701     chr   ord  8859-1               0037                1047 && POSIX-BC     
702     ------------------------------------------------------------------------
703     "\c?" 127  <DELETE>             "                   "              ***><
704     "\c@"   0  <NULL>               <NULL>              <NULL>         ***><
705     "\cA"   1  <S.O. HEADING>       <S.O. HEADING>      <S.O. HEADING> 
706     "\cB"   2  <S.O. TEXT>          <S.O. TEXT>         <S.O. TEXT>
707     "\cC"   3  <E.O. TEXT>          <E.O. TEXT>         <E.O. TEXT>
708     "\cD"   4  <E.O. TRANS.>        <C1 28>             <C1 28> 
709     "\cE"   5  <ENQUIRY>            <HORIZ. TAB.>       <HORIZ. TAB.>    
710     "\cF"   6  <ACKNOWLEDGE>        <C1 6>              <C1 6>   
711     "\cG"   7  <BELL>               <DELETE>            <DELETE>   
712     "\cH"   8  <BACKSPACE>          <C1 23>             <C1 23>
713     "\cI"   9  <HORIZ. TAB.>        <C1 13>             <C1 13>
714     "\cJ"  10  <LINE FEED>          <C1 14>             <C1 14>
715     "\cK"  11  <VERT. TAB.>         <VERT. TAB.>        <VERT. TAB.>
716     "\cL"  12  <FORM FEED>          <FORM FEED>         <FORM FEED>    
717     "\cM"  13  <CARRIAGE RETURN>    <CARRIAGE RETURN>   <CARRIAGE RETURN> 
718     "\cN"  14  <SHIFT OUT>          <SHIFT OUT>         <SHIFT OUT>
719     "\cO"  15  <SHIFT IN>           <SHIFT IN>          <SHIFT IN>
720     "\cP"  16  <DATA LINK ESCAPE>   <DATA LINK ESCAPE>  <DATA LINK ESCAPE> 
721     "\cQ"  17  <D.C. ONE>           <D.C. ONE>          <D.C. ONE>
722     "\cR"  18  <D.C. TWO>           <D.C. TWO>          <D.C. TWO>
723     "\cS"  19  <D.C. THREE>         <D.C. THREE>        <D.C. THREE> 
724     "\cT"  20  <D.C. FOUR>          <C1 29>             <C1 29> 
725     "\cU"  21  <NEG. ACK.>          <C1 5>              <LINE FEED>    ***
726     "\cV"  22  <SYNCHRONOUS IDLE>   <BACKSPACE>         <BACKSPACE>
727     "\cW"  23  <E.O. TRANS. BLOCK>  <C1 7>              <C1 7>
728     "\cX"  24  <CANCEL>             <CANCEL>            <CANCEL>
729     "\cY"  25  <E.O. MEDIUM>        <E.O. MEDIUM>       <E.O. MEDIUM>
730     "\cZ"  26  <SUBSTITUTE>         <C1 18>             <C1 18>
731     "\c["  27  <ESCAPE>             <C1 15>             <C1 15>
732     "\c\\" 28  <FILE SEP.>\         <FILE SEP.>\        <FILE SEP.>\
733     "\c]"  29  <GROUP SEP.>         <GROUP SEP.>        <GROUP SEP.>
734     "\c^"  30  <RECORD SEP.>        <RECORD SEP.>       <RECORD SEP.>  ***><
735     "\c_"  31  <UNIT SEP.>          <UNIT SEP.>         <UNIT SEP.>    ***><
736
737
738 =head1 FUNCTION DIFFERENCES
739
740 =over 8
741
742 =item chr()
743
744 chr() must be given an EBCDIC code number argument to yield a desired 
745 character return value on an EBCDIC machine.  For example:
746
747     $CAPITAL_LETTER_A = chr(193);
748
749 =item ord()
750
751 ord() will return EBCDIC code number values on an EBCDIC machine.
752 For example:
753
754     $the_number_193 = ord("A");
755
756 =item pack()
757
758 The c and C templates for pack() are dependent upon character set 
759 encoding.  Examples of usage on EBCDIC include:
760
761     $foo = pack("CCCC",193,194,195,196);
762     # $foo eq "ABCD"
763     $foo = pack("C4",193,194,195,196);
764     # same thing
765
766     $foo = pack("ccxxcc",193,194,195,196);
767     # $foo eq "AB\0\0CD"
768
769 =item print()
770
771 One must be careful with scalars and strings that are passed to
772 print that contain ASCII encodings.  One common place
773 for this to occur is in the output of the MIME type header for
774 CGI script writing.  For example, many perl programming guides 
775 recommend something similar to:
776
777     print "Content-type:\ttext/html\015\012\015\012"; 
778     # this may be wrong on EBCDIC
779
780 Under the IBM OS/390 USS Web Server or WebSphere on z/OS for example 
781 you should instead write that as:
782
783     print "Content-type:\ttext/html\r\n\r\n"; # OK for DGW et alia
784
785 That is because the translation from EBCDIC to ASCII is done
786 by the web server in this case (such code will not be appropriate for
787 the Macintosh however).  Consult your web server's documentation for 
788 further details.
789
790 =item printf()
791
792 The formats that can convert characters to numbers and vice versa
793 will be different from their ASCII counterparts when executed
794 on an EBCDIC machine.  Examples include:
795
796     printf("%c%c%c",193,194,195);  # prints ABC
797
798 =item sort()
799
800 EBCDIC sort results may differ from ASCII sort results especially for 
801 mixed case strings.  This is discussed in more detail below.
802
803 =item sprintf()
804
805 See the discussion of printf() above.  An example of the use
806 of sprintf would be:
807
808     $CAPITAL_LETTER_A = sprintf("%c",193);
809
810 =item unpack()
811
812 See the discussion of pack() above.
813
814 =back
815
816 =head1 REGULAR EXPRESSION DIFFERENCES
817
818 As of perl 5.005_03 the letter range regular expression such as 
819 [A-Z] and [a-z] have been especially coded to not pick up gap 
820 characters.  For example, characters such as E<ocirc> C<o WITH CIRCUMFLEX> 
821 that lie between I and J would not be matched by the 
822 regular expression range C</[H-K]/>.  
823
824 If you do want to match the alphabet gap characters in a single octet 
825 regular expression try matching the hex or octal code such 
826 as C</\313/> on EBCDIC or C</\364/> on ASCII machines to 
827 have your regular expression match C<o WITH CIRCUMFLEX>.
828
829 Another construct to be wary of is the inappropriate use of hex or
830 octal constants in regular expressions.  Consider the following
831 set of subs:
832
833     sub is_c0 {
834         my $char = substr(shift,0,1);
835         $char =~ /[\000-\037]/;
836     }
837
838     sub is_print_ascii {
839         my $char = substr(shift,0,1);
840         $char =~ /[\040-\176]/;
841     }
842
843     sub is_delete {
844         my $char = substr(shift,0,1);
845         $char eq "\177";
846     }
847
848     sub is_c1 {
849         my $char = substr(shift,0,1);
850         $char =~ /[\200-\237]/;
851     }
852
853     sub is_latin_1 {
854         my $char = substr(shift,0,1);
855         $char =~ /[\240-\377]/;
856     }
857
858 The above would be adequate if the concern was only with numeric code points.
859 However, the concern may be with characters rather than code points 
860 and on an EBCDIC machine it may be desirable for constructs such as 
861 C<if (is_print_ascii("A")) {print "A is a printable character\n";}> to print
862 out the expected message.  One way to represent the above collection
863 of character classification subs that is capable of working across the
864 four coded character sets discussed in this document is as follows:
865
866     sub Is_c0 {
867         my $char = substr(shift,0,1);
868         if (ord('^')==94)  { # ascii
869             return $char =~ /[\000-\037]/;
870         } 
871         if (ord('^')==176) { # 37
872             return $char =~ /[\000-\003\067\055-\057\026\005\045\013-\023\074\075\062\046\030\031\077\047\034-\037]/;
873         }
874         if (ord('^')==95 || ord('^')==106) { # 1047 || posix-bc
875             return $char =~ /[\000-\003\067\055-\057\026\005\025\013-\023\074\075\062\046\030\031\077\047\034-\037]/;
876         }
877     }
878
879     sub Is_print_ascii {
880         my $char = substr(shift,0,1);
881         $char =~ /[ !"\#\$%&'()*+,\-.\/0-9:;<=>?\@A-Z[\\\]^_`a-z{|}~]/;
882     }
883
884     sub Is_delete {
885         my $char = substr(shift,0,1);
886         if (ord('^')==94)  { # ascii
887             return $char eq "\177";
888         }
889         else  {              # ebcdic
890             return $char eq "\007";
891         }
892     }
893
894     sub Is_c1 {
895         my $char = substr(shift,0,1);
896         if (ord('^')==94)  { # ascii
897             return $char =~ /[\200-\237]/;
898         }
899         if (ord('^')==176) { # 37
900             return $char =~ /[\040-\044\025\006\027\050-\054\011\012\033\060\061\032\063-\066\010\070-\073\040\024\076\377]/;
901         }
902         if (ord('^')==95)  { # 1047
903             return $char =~ /[\040-\045\006\027\050-\054\011\012\033\060\061\032\063-\066\010\070-\073\040\024\076\377]/;
904         }
905         if (ord('^')==106) { # posix-bc
906             return $char =~ 
907               /[\040-\045\006\027\050-\054\011\012\033\060\061\032\063-\066\010\070-\073\040\024\076\137]/;
908         }
909     }
910
911     sub Is_latin_1 {
912         my $char = substr(shift,0,1);
913         if (ord('^')==94)  { # ascii
914             return $char =~ /[\240-\377]/;
915         }
916         if (ord('^')==176) { # 37
917             return $char =~ 
918               /[\101\252\112\261\237\262\152\265\275\264\232\212\137\312\257\274\220\217\352\372\276\240\266\263\235\332\233\213\267\270\271\253\144\145\142\146\143\147\236\150\164\161-\163\170\165-\167\254\151\355\356\353\357\354\277\200\375\376\373\374\255\256\131\104\105\102\106\103\107\234\110\124\121-\123\130\125-\127\214\111\315\316\313\317\314\341\160\335\336\333\334\215\216\337]/;
919         }
920         if (ord('^')==95)  { # 1047
921             return $char =~
922               /[\101\252\112\261\237\262\152\265\273\264\232\212\260\312\257\274\220\217\352\372\276\240\266\263\235\332\233\213\267\270\271\253\144\145\142\146\143\147\236\150\164\161-\163\170\165-\167\254\151\355\356\353\357\354\277\200\375\376\373\374\272\256\131\104\105\102\106\103\107\234\110\124\121-\123\130\125-\127\214\111\315\316\313\317\314\341\160\335\336\333\334\215\216\337]/; 
923         }
924         if (ord('^')==106) { # posix-bc
925             return $char =~ 
926               /[\101\252\260\261\237\262\320\265\171\264\232\212\272\312\257\241\220\217\352\372\276\240\266\263\235\332\233\213\267\270\271\253\144\145\142\146\143\147\236\150\164\161-\163\170\165-\167\254\151\355\356\353\357\354\277\200\340\376\335\374\255\256\131\104\105\102\106\103\107\234\110\124\121-\123\130\125-\127\214\111\315\316\313\317\314\341\160\300\336\333\334\215\216\337]/;
927         }
928     }
929
930 Note however that only the C<Is_ascii_print()> sub is really independent 
931 of coded character set.  Another way to write C<Is_latin_1()> would be 
932 to use the characters in the range explicitly:
933
934     sub Is_latin_1 {
935         my $char = substr(shift,0,1);
936         $char =~ /[ ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ]/;
937     }
938
939 Although that form may run into trouble in network transit (due to the 
940 presence of 8 bit characters) or on non ISO-Latin character sets.
941
942 =head1 SOCKETS
943
944 Most socket programming assumes ASCII character encodings in network
945 byte order.  Exceptions can include CGI script writing under a
946 host web server where the server may take care of translation for you.
947 Most host web servers convert EBCDIC data to ISO-8859-1 or Unicode on
948 output.
949
950 =head1 SORTING
951
952 One big difference between ASCII based character sets and EBCDIC ones
953 are the relative positions of upper and lower case letters and the
954 letters compared to the digits.  If sorted on an ASCII based machine the
955 two letter abbreviation for a physician comes before the two letter
956 for drive, that is:
957
958     @sorted = sort(qw(Dr. dr.));  # @sorted holds ('Dr.','dr.') on ASCII,
959                                   # but ('dr.','Dr.') on EBCDIC
960
961 The property of lower case before uppercase letters in EBCDIC is
962 even carried to the Latin 1 EBCDIC pages such as 0037 and 1047.
963 An example would be that E<Euml> C<E WITH DIAERESIS> (203) comes 
964 before E<euml> C<e WITH DIAERESIS> (235) on an ASCII machine, but 
965 the latter (83) comes before the former (115) on an EBCDIC machine.  
966 (Astute readers will note that the upper case version of E<szlig> 
967 C<SMALL LETTER SHARP S> is simply "SS" and that the upper case version of 
968 E<yuml> C<y WITH DIAERESIS> is not in the 0..255 range but it is 
969 at U+x0178 in Unicode, or C<"\x{178}"> in a Unicode enabled Perl).
970
971 The sort order will cause differences between results obtained on
972 ASCII machines versus EBCDIC machines.  What follows are some suggestions
973 on how to deal with these differences.
974
975 =head2 Ignore ASCII vs. EBCDIC sort differences.
976
977 This is the least computationally expensive strategy.  It may require
978 some user education.
979
980 =head2 MONO CASE then sort data.
981
982 In order to minimize the expense of mono casing mixed test try to
983 C<tr///> towards the character set case most employed within the data.
984 If the data are primarily UPPERCASE non Latin 1 then apply tr/[a-z]/[A-Z]/
985 then sort().  If the data are primarily lowercase non Latin 1 then
986 apply tr/[A-Z]/[a-z]/ before sorting.  If the data are primarily UPPERCASE
987 and include Latin-1 characters then apply:  
988
989     tr/[a-z]/[A-Z]/; 
990     tr/[àáâãäåæçèéêëìíîïðñòóôõöøùúûüýþ]/[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞ]/;
991     s/ß/SS/g; 
992
993 then sort().  Do note however that such Latin-1 manipulation does not 
994 address the E<yuml> C<y WITH DIAERESIS> character that will remain at 
995 code point 255 on ASCII machines, but 223 on most EBCDIC machines 
996 where it will sort to a place less than the EBCDIC numerals.  With a 
997 Unicode enabled Perl you might try:
998
999     tr/^?/\x{178}/;
1000
1001 The strategy of mono casing data before sorting does not preserve the case 
1002 of the data and may not be acceptable for that reason.
1003
1004 =head2 Convert, sort data, then re convert.
1005
1006 This is the most expensive proposition that does not employ a network
1007 connection.
1008
1009 =head2 Perform sorting on one type of machine only.
1010
1011 This strategy can employ a network connection.  As such
1012 it would be computationally expensive.
1013
1014 =head1 TRANSFORMATION FORMATS
1015
1016 There are a variety of ways of transforming data with an intra character set 
1017 mapping that serve a variety of purposes.  Sorting was discussed in the 
1018 previous section and a few of the other more popular mapping techniques are 
1019 discussed next.
1020
1021 =head2 URL decoding and encoding
1022
1023 Note that some URLs have hexadecimal ASCII code points in them in an
1024 attempt to overcome character or protocol limitation issues.  For example 
1025 the tilde character is not on every keyboard hence a URL of the form:
1026
1027     http://www.pvhp.com/~pvhp/
1028
1029 may also be expressed as either of:
1030
1031     http://www.pvhp.com/%7Epvhp/
1032
1033     http://www.pvhp.com/%7epvhp/
1034
1035 where 7E is the hexadecimal ASCII code point for '~'.  Here is an example
1036 of decoding such a URL under CCSID 1047:
1037
1038     $url = 'http://www.pvhp.com/%7Epvhp/';
1039     # this array assumes code page 1047
1040     my @a2e_1047 = (
1041           0,  1,  2,  3, 55, 45, 46, 47, 22,  5, 21, 11, 12, 13, 14, 15,
1042          16, 17, 18, 19, 60, 61, 50, 38, 24, 25, 63, 39, 28, 29, 30, 31,
1043          64, 90,127,123, 91,108, 80,125, 77, 93, 92, 78,107, 96, 75, 97,
1044         240,241,242,243,244,245,246,247,248,249,122, 94, 76,126,110,111,
1045         124,193,194,195,196,197,198,199,200,201,209,210,211,212,213,214,
1046         215,216,217,226,227,228,229,230,231,232,233,173,224,189, 95,109,
1047         121,129,130,131,132,133,134,135,136,137,145,146,147,148,149,150,
1048         151,152,153,162,163,164,165,166,167,168,169,192, 79,208,161,  7,
1049          32, 33, 34, 35, 36, 37,  6, 23, 40, 41, 42, 43, 44,  9, 10, 27,
1050          48, 49, 26, 51, 52, 53, 54,  8, 56, 57, 58, 59,  4, 20, 62,255,
1051          65,170, 74,177,159,178,106,181,187,180,154,138,176,202,175,188,
1052         144,143,234,250,190,160,182,179,157,218,155,139,183,184,185,171,
1053         100,101, 98,102, 99,103,158,104,116,113,114,115,120,117,118,119,
1054         172,105,237,238,235,239,236,191,128,253,254,251,252,186,174, 89,
1055          68, 69, 66, 70, 67, 71,156, 72, 84, 81, 82, 83, 88, 85, 86, 87,
1056         140, 73,205,206,203,207,204,225,112,221,222,219,220,141,142,223
1057     );
1058     $url =~ s/%([0-9a-fA-F]{2})/pack("c",$a2e_1047[hex($1)])/ge;
1059
1060 Conversely, here is a partial solution for the task of encoding such 
1061 a URL under the 1047 code page:
1062
1063     $url = 'http://www.pvhp.com/~pvhp/';
1064     # this array assumes code page 1047
1065     my @e2a_1047 = (
1066           0,  1,  2,  3,156,  9,134,127,151,141,142, 11, 12, 13, 14, 15,
1067          16, 17, 18, 19,157, 10,  8,135, 24, 25,146,143, 28, 29, 30, 31,
1068         128,129,130,131,132,133, 23, 27,136,137,138,139,140,  5,  6,  7,
1069         144,145, 22,147,148,149,150,  4,152,153,154,155, 20, 21,158, 26,
1070          32,160,226,228,224,225,227,229,231,241,162, 46, 60, 40, 43,124,
1071          38,233,234,235,232,237,238,239,236,223, 33, 36, 42, 41, 59, 94,
1072          45, 47,194,196,192,193,195,197,199,209,166, 44, 37, 95, 62, 63,
1073         248,201,202,203,200,205,206,207,204, 96, 58, 35, 64, 39, 61, 34,
1074         216, 97, 98, 99,100,101,102,103,104,105,171,187,240,253,254,177,
1075         176,106,107,108,109,110,111,112,113,114,170,186,230,184,198,164,
1076         181,126,115,116,117,118,119,120,121,122,161,191,208, 91,222,174,
1077         172,163,165,183,169,167,182,188,189,190,221,168,175, 93,180,215,
1078         123, 65, 66, 67, 68, 69, 70, 71, 72, 73,173,244,246,242,243,245,
1079         125, 74, 75, 76, 77, 78, 79, 80, 81, 82,185,251,252,249,250,255,
1080          92,247, 83, 84, 85, 86, 87, 88, 89, 90,178,212,214,210,211,213,
1081          48, 49, 50, 51, 52, 53, 54, 55, 56, 57,179,219,220,217,218,159
1082     );
1083     # The following regular expression does not address the 
1084     # mappings for: ('.' => '%2E', '/' => '%2F', ':' => '%3A') 
1085     $url =~ s/([\t "#%&\(\),;<=>\?\@\[\\\]^`{|}~])/sprintf("%%%02X",$e2a_1047[ord($1)])/ge;
1086
1087 where a more complete solution would split the URL into components 
1088 and apply a full s/// substitution only to the appropriate parts.
1089
1090 In the remaining examples a @e2a or @a2e array may be employed
1091 but the assignment will not be shown explicitly.  For code page 1047
1092 you could use the @a2e_1047 or @e2a_1047 arrays just shown.
1093
1094 =head2 uu encoding and decoding
1095
1096 The C<u> template to pack() or unpack() will render EBCDIC data in EBCDIC 
1097 characters equivalent to their ASCII counterparts.  For example, the 
1098 following will print "Yes indeed\n" on either an ASCII or EBCDIC computer:
1099
1100     $all_byte_chrs = '';
1101     for (0..255) { $all_byte_chrs .= chr($_); }
1102     $uuencode_byte_chrs = pack('u', $all_byte_chrs);
1103     ($uu = <<'ENDOFHEREDOC') =~ s/^\s*//gm;
1104     M``$"`P0%!@<("0H+#`T.#Q`1$A,4%187&!D:&QP='A\@(2(C)"4F)R@I*BLL
1105     M+2XO,#$R,S0U-C<X.3H[/#T^/T!!0D-$149'2$E*2TQ-3D]045)35%565UA9
1106     M6EM<75Y?8&%B8V1E9F=H:6IK;&UN;W!Q<G-T=79W>'EZ>WQ]?G^`@8*#A(6&
1107     MAXB)BHN,C8Z/D)&2DY25EI>8F9J;G)V>GZ"AHJ.DI::GJ*FJJZRMKJ^PL;*S
1108     MM+6VM[BYNKN\O;Z_P,'"P\3%QL?(R<K+S,W.S]#1TM/4U=;7V-G:V]S=WM_@
1109     ?X>+CY.7FY^CIZNOL[>[O\/'R\_3U]O?X^?K[_/W^_P``
1110     ENDOFHEREDOC
1111     if ($uuencode_byte_chrs eq $uu) {
1112         print "Yes ";
1113     }
1114     $uudecode_byte_chrs = unpack('u', $uuencode_byte_chrs);
1115     if ($uudecode_byte_chrs eq $all_byte_chrs) {
1116         print "indeed\n";
1117     }
1118
1119 Here is a very spartan uudecoder that will work on EBCDIC provided
1120 that the @e2a array is filled in appropriately:
1121
1122     #!/usr/local/bin/perl
1123     @e2a = ( # this must be filled in
1124            );
1125     $_ = <> until ($mode,$file) = /^begin\s*(\d*)\s*(\S*)/;
1126     open(OUT, "> $file") if $file ne "";
1127     while(<>) {
1128         last if /^end/;
1129         next if /[a-z]/;
1130         next unless int(((($e2a[ord()] - 32 ) & 077) + 2) / 3) ==
1131             int(length() / 4);
1132         print OUT unpack("u", $_);
1133     }
1134     close(OUT);
1135     chmod oct($mode), $file;
1136
1137
1138 =head2 Quoted-Printable encoding and decoding
1139
1140 On ASCII encoded machines it is possible to strip characters outside of
1141 the printable set using:
1142
1143     # This QP encoder works on ASCII only
1144     $qp_string =~ s/([=\x00-\x1F\x80-\xFF])/sprintf("=%02X",ord($1))/ge;
1145
1146 Whereas a QP encoder that works on both ASCII and EBCDIC machines 
1147 would look somewhat like the following (where the EBCDIC branch @e2a 
1148 array is omitted for brevity):
1149
1150     if (ord('A') == 65) {    # ASCII
1151         $delete = "\x7F";    # ASCII
1152         @e2a = (0 .. 255)    # ASCII to ASCII identity map
1153     }
1154     else {                   # EBCDIC
1155         $delete = "\x07";    # EBCDIC
1156         @e2a =               # EBCDIC to ASCII map (as shown above)
1157     }
1158     $qp_string =~
1159       s/([^ !"\#\$%&'()*+,\-.\/0-9:;<>?\@A-Z[\\\]^_`a-z{|}~$delete])/sprintf("=%02X",$e2a[ord($1)])/ge;
1160
1161 (although in production code the substitutions might be done
1162 in the EBCDIC branch with the @e2a array and separately in the 
1163 ASCII branch without the expense of the identity map).
1164
1165 Such QP strings can be decoded with:
1166
1167     # This QP decoder is limited to ASCII only
1168     $string =~ s/=([0-9A-Fa-f][0-9A-Fa-f])/chr hex $1/ge;
1169     $string =~ s/=[\n\r]+$//;
1170
1171 Whereas a QP decoder that works on both ASCII and EBCDIC machines 
1172 would look somewhat like the following (where the @a2e array is
1173 omitted for brevity):
1174
1175     $string =~ s/=([0-9A-Fa-f][0-9A-Fa-f])/chr $a2e[hex $1]/ge;
1176     $string =~ s/=[\n\r]+$//;
1177
1178 =head2 Caesarian ciphers
1179
1180 The practice of shifting an alphabet one or more characters for encipherment
1181 dates back thousands of years and was explicitly detailed by Gaius Julius
1182 Caesar in his B<Gallic Wars> text.  A single alphabet shift is sometimes 
1183 referred to as a rotation and the shift amount is given as a number $n after
1184 the string 'rot' or "rot$n".  Rot0 and rot26 would designate identity maps 
1185 on the 26 letter English version of the Latin alphabet.  Rot13 has the 
1186 interesting property that alternate subsequent invocations are identity maps 
1187 (thus rot13 is its own non-trivial inverse in the group of 26 alphabet 
1188 rotations).  Hence the following is a rot13 encoder and decoder that will 
1189 work on ASCII and EBCDIC machines:
1190
1191     #!/usr/local/bin/perl
1192
1193     while(<>){
1194         tr/n-za-mN-ZA-M/a-zA-Z/;
1195         print;
1196     }
1197
1198 In one-liner form:
1199
1200     perl -ne 'tr/n-za-mN-ZA-M/a-zA-Z/;print'
1201
1202
1203 =head1 Hashing order and checksums
1204
1205 To the extent that it is possible to write code that depends on 
1206 hashing order there may be differences between hashes as stored
1207 on an ASCII based machine and hashes stored on an EBCDIC based machine.
1208 XXX
1209
1210 =head1 I18N AND L10N
1211
1212 Internationalization(I18N) and localization(L10N) are supported at least 
1213 in principle even on EBCDIC machines.  The details are system dependent 
1214 and discussed under the L<perlebcdic/OS ISSUES> section below.
1215
1216 =head1 MULTI OCTET CHARACTER SETS
1217
1218 Perl may work with an internal UTF-EBCDIC encoding form for wide characters 
1219 on EBCDIC platforms in a manner analogous to the way that it works with 
1220 the UTF-8 internal encoding form on ASCII based platforms.
1221
1222 Legacy multi byte EBCDIC code pages XXX.
1223
1224 =head1 OS ISSUES
1225
1226 There may be a few system dependent issues 
1227 of concern to EBCDIC Perl programmers.
1228
1229 =head2 OS/400 
1230
1231 The PASE environment.
1232
1233 =over 8
1234
1235 =item IFS access
1236
1237 XXX.
1238
1239 =back
1240
1241 =head2 OS/390, z/OS
1242
1243 Perl runs under Unix Systems Services or USS.
1244
1245 =over 8
1246
1247 =item chcp
1248
1249 B<chcp> is supported as a shell utility for displaying and changing 
1250 one's code page.  See also L<chcp>.
1251
1252 =item dataset access
1253
1254 For sequential data set access try:
1255
1256     my @ds_records = `cat //DSNAME`;
1257
1258 or:
1259
1260     my @ds_records = `cat //'HLQ.DSNAME'`;
1261
1262 See also the OS390::Stdio module on CPAN.
1263
1264 =item OS/390, z/OS iconv
1265
1266 B<iconv> is supported as both a shell utility and a C RTL routine.
1267 See also the iconv(1) and iconv(3) manual pages.
1268
1269 =item locales
1270
1271 On OS/390 or z/OS see L<locale> for information on locales.  The L10N files
1272 are in F</usr/nls/locale>.  $Config{d_setlocale} is 'define' on OS/390
1273 or z/OS.
1274
1275 =back
1276
1277 =head2 VM/ESA?
1278
1279 XXX.
1280
1281 =head2 POSIX-BC?
1282
1283 XXX.
1284
1285 =head1 BUGS
1286
1287 This pod document contains literal Latin 1 characters and may encounter 
1288 translation difficulties.  In particular one popular nroff implementation 
1289 was known to strip accented characters to their unaccented counterparts 
1290 while attempting to view this document through the B<pod2man> program 
1291 (for example, you may see a plain C<y> rather than one with a diaeresis 
1292 as in E<yuml>).  Another nroff truncated the resultant manpage at
1293 the first occurrence of 8 bit characters.
1294
1295 Not all shells will allow multiple C<-e> string arguments to perl to
1296 be concatenated together properly as recipes 0, 2, 4, 5, and 6 might 
1297 seem to imply.
1298
1299 =head1 SEE ALSO
1300
1301 L<perllocale>, L<perlfunc>, L<perlunicode>, L<utf8>.
1302
1303 =head1 REFERENCES
1304
1305 http://anubis.dkuug.dk/i18n/charmaps
1306
1307 http://www.unicode.org/
1308
1309 http://www.unicode.org/unicode/reports/tr16/
1310
1311 http://www.wps.com/texts/codes/
1312 B<ASCII: American Standard Code for Information Infiltration> Tom Jennings,
1313 September 1999.
1314
1315 B<The Unicode Standard, Version 3.0> The Unicode Consortium, Lisa Moore ed., 
1316 ISBN 0-201-61633-5, Addison Wesley Developers Press, February 2000. 
1317
1318 B<CDRA: IBM - Character Data Representation Architecture - 
1319 Reference and Registry>, IBM SC09-2190-00, December 1996. 
1320
1321 "Demystifying Character Sets", Andrea Vine, Multilingual Computing 
1322 & Technology, B<#26 Vol. 10 Issue 4>, August/September 1999;
1323 ISSN 1523-0309; Multilingual Computing Inc. Sandpoint ID, USA.
1324
1325 B<Codes, Ciphers, and Other Cryptic and Clandestine Communication>
1326 Fred B. Wrixon, ISBN 1-57912-040-7, Black Dog & Leventhal Publishers,
1327 1998.
1328
1329 http://www.bobbemer.com/P-BIT.HTM
1330 B<IBM - EBCDIC and the P-bit; The biggest Computer Goof Ever> Robert Bemer.
1331
1332 =head1 HISTORY
1333
1334 15 April 2001: added UTF-8 and UTF-EBCDIC to main table, pvhp.
1335
1336 =head1 AUTHOR
1337
1338 Peter Prymmer pvhp@best.com wrote this in 1999 and 2000 
1339 with CCSID 0819 and 0037 help from Chris Leach and 
1340 AndrE<eacute> Pirard A.Pirard@ulg.ac.be as well as POSIX-BC 
1341 help from Thomas Dorner Thomas.Dorner@start.de.
1342 Thanks also to Vickie Cooper, Philip Newton, William Raffloer, and 
1343 Joe Smith.  Trademarks, registered trademarks, service marks and 
1344 registered service marks used in this document are the property of 
1345 their respective owners.
1346
1347