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