This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
mktables: Define PatWS for Unicode versions missing it
[perl5.git] / lib / unicore / mktables
1 #!/usr/bin/perl -w
2
3 # !!!!!!!!!!!!!!       IF YOU MODIFY THIS FILE       !!!!!!!!!!!!!!!!!!!!!!!!!
4 # Any files created or read by this program should be listed in 'mktables.lst'
5 # Use -makelist to regenerate it.
6
7 # Needs 'no overloading' to run faster on miniperl.  Code commented out at the
8 # subroutine objaddr can be used instead to work as far back (untested) as
9 # 5.8: needs pack "U".  But almost all occurrences of objaddr have been
10 # removed in favor of using 'no overloading'.  You also would have to go
11 # through and replace occurrences like:
12 #       my $addr = do { no overloading; pack 'J', $self; }
13 # with
14 #       my $addr = main::objaddr $self;
15 # (or reverse commit 9b01bafde4b022706c3d6f947a0963f821b2e50b
16 # that instituted the change to main::objaddr, and subsequent commits that
17 # changed 0+$self to pack 'J', $self.)
18
19 my $start_time;
20 BEGIN { # Get the time the script started running; do it at compilation to
21         # get it as close as possible
22     $start_time= time;
23 }
24
25 require 5.010_001;
26 use strict;
27 use warnings;
28 use Carp;
29 use Config;
30 use File::Find;
31 use File::Path;
32 use File::Spec;
33 use Text::Tabs;
34 use re "/aa";
35
36 sub DEBUG () { 0 }  # Set to 0 for production; 1 for development
37 my $debugging_build = $Config{"ccflags"} =~ /-DDEBUGGING/;
38
39 sub NON_ASCII_PLATFORM { ord("A") != 65 }
40
41 ##########################################################################
42 #
43 # mktables -- create the runtime Perl Unicode files (lib/unicore/.../*.pl),
44 # from the Unicode database files (lib/unicore/.../*.txt),  It also generates
45 # a pod file and .t files, depending on option parameters.
46 #
47 # The structure of this file is:
48 #   First these introductory comments; then
49 #   code needed for everywhere, such as debugging stuff; then
50 #   code to handle input parameters; then
51 #   data structures likely to be of external interest (some of which depend on
52 #       the input parameters, so follows them; then
53 #   more data structures and subroutine and package (class) definitions; then
54 #   the small actual loop to process the input files and finish up; then
55 #   a __DATA__ section, for the .t tests
56 #
57 # This program works on all releases of Unicode so far.  The outputs have been
58 # scrutinized most intently for release 5.1.  The others have been checked for
59 # somewhat more than just sanity.  It can handle all non-provisional Unicode
60 # character properties in those releases.
61 #
62 # This program is mostly about Unicode character (or code point) properties.
63 # A property describes some attribute or quality of a code point, like if it
64 # is lowercase or not, its name, what version of Unicode it was first defined
65 # in, or what its uppercase equivalent is.  Unicode deals with these disparate
66 # possibilities by making all properties into mappings from each code point
67 # into some corresponding value.  In the case of it being lowercase or not,
68 # the mapping is either to 'Y' or 'N' (or various synonyms thereof).  Each
69 # property maps each Unicode code point to a single value, called a "property
70 # value".  (Some more recently defined properties, map a code point to a set
71 # of values.)
72 #
73 # When using a property in a regular expression, what is desired isn't the
74 # mapping of the code point to its property's value, but the reverse (or the
75 # mathematical "inverse relation"): starting with the property value, "Does a
76 # code point map to it?"  These are written in a "compound" form:
77 # \p{property=value}, e.g., \p{category=punctuation}.  This program generates
78 # files containing the lists of code points that map to each such regular
79 # expression property value, one file per list
80 #
81 # There is also a single form shortcut that Perl adds for many of the commonly
82 # used properties.  This happens for all binary properties, plus script,
83 # general_category, and block properties.
84 #
85 # Thus the outputs of this program are files.  There are map files, mostly in
86 # the 'To' directory; and there are list files for use in regular expression
87 # matching, all in subdirectories of the 'lib' directory, with each
88 # subdirectory being named for the property that the lists in it are for.
89 # Bookkeeping, test, and documentation files are also generated.
90
91 my $matches_directory = 'lib';   # Where match (\p{}) files go.
92 my $map_directory = 'To';        # Where map files go.
93
94 # DATA STRUCTURES
95 #
96 # The major data structures of this program are Property, of course, but also
97 # Table.  There are two kinds of tables, very similar to each other.
98 # "Match_Table" is the data structure giving the list of code points that have
99 # a particular property value, mentioned above.  There is also a "Map_Table"
100 # data structure which gives the property's mapping from code point to value.
101 # There are two structures because the match tables need to be combined in
102 # various ways, such as constructing unions, intersections, complements, etc.,
103 # and the map ones don't.  And there would be problems, perhaps subtle, if
104 # a map table were inadvertently operated on in some of those ways.
105 # The use of separate classes with operations defined on one but not the other
106 # prevents accidentally confusing the two.
107 #
108 # At the heart of each table's data structure is a "Range_List", which is just
109 # an ordered list of "Ranges", plus ancillary information, and methods to
110 # operate on them.  A Range is a compact way to store property information.
111 # Each range has a starting code point, an ending code point, and a value that
112 # is meant to apply to all the code points between the two end points,
113 # inclusive.  For a map table, this value is the property value for those
114 # code points.  Two such ranges could be written like this:
115 #   0x41 .. 0x5A, 'Upper',
116 #   0x61 .. 0x7A, 'Lower'
117 #
118 # Each range also has a type used as a convenience to classify the values.
119 # Most ranges in this program will be Type 0, or normal, but there are some
120 # ranges that have a non-zero type.  These are used only in map tables, and
121 # are for mappings that don't fit into the normal scheme of things.  Mappings
122 # that require a hash entry to communicate with utf8.c are one example;
123 # another example is mappings for charnames.pm to use which indicate a name
124 # that is algorithmically determinable from its code point (and the reverse).
125 # These are used to significantly compact these tables, instead of listing
126 # each one of the tens of thousands individually.
127 #
128 # In a match table, the value of a range is irrelevant (and hence the type as
129 # well, which will always be 0), and arbitrarily set to the null string.
130 # Using the example above, there would be two match tables for those two
131 # entries, one named Upper would contain the 0x41..0x5A range, and the other
132 # named Lower would contain 0x61..0x7A.
133 #
134 # Actually, there are two types of range lists, "Range_Map" is the one
135 # associated with map tables, and "Range_List" with match tables.
136 # Again, this is so that methods can be defined on one and not the others so
137 # as to prevent operating on them in incorrect ways.
138 #
139 # Eventually, most tables are written out to files to be read by utf8_heavy.pl
140 # in the perl core.  All tables could in theory be written, but some are
141 # suppressed because there is no current practical use for them.  It is easy
142 # to change which get written by changing various lists that are near the top
143 # of the actual code in this file.  The table data structures contain enough
144 # ancillary information to allow them to be treated as separate entities for
145 # writing, such as the path to each one's file.  There is a heading in each
146 # map table that gives the format of its entries, and what the map is for all
147 # the code points missing from it.  (This allows tables to be more compact.)
148 #
149 # The Property data structure contains one or more tables.  All properties
150 # contain a map table (except the $perl property which is a
151 # pseudo-property containing only match tables), and any properties that
152 # are usable in regular expression matches also contain various matching
153 # tables, one for each value the property can have.  A binary property can
154 # have two values, True and False (or Y and N, which are preferred by Unicode
155 # terminology).  Thus each of these properties will have a map table that
156 # takes every code point and maps it to Y or N (but having ranges cuts the
157 # number of entries in that table way down), and two match tables, one
158 # which has a list of all the code points that map to Y, and one for all the
159 # code points that map to N.  (For each binary property, a third table is also
160 # generated for the pseudo Perl property.  It contains the identical code
161 # points as the Y table, but can be written in regular expressions, not in the
162 # compound form, but in a "single" form like \p{IsUppercase}.)  Many
163 # properties are binary, but some properties have several possible values,
164 # some have many, and properties like Name have a different value for every
165 # named code point.  Those will not, unless the controlling lists are changed,
166 # have their match tables written out.  But all the ones which can be used in
167 # regular expression \p{} and \P{} constructs will.  Prior to 5.14, generally
168 # a property would have either its map table or its match tables written but
169 # not both.  Again, what gets written is controlled by lists which can easily
170 # be changed.  Starting in 5.14, advantage was taken of this, and all the map
171 # tables needed to reconstruct the Unicode db are now written out, while
172 # suppressing the Unicode .txt files that contain the data.  Our tables are
173 # much more compact than the .txt files, so a significant space savings was
174 # achieved.  Also, tables are not written out that are trivially derivable
175 # from tables that do get written.  So, there typically is no file containing
176 # the code points not matched by a binary property (the table for \P{} versus
177 # lowercase \p{}), since you just need to invert the True table to get the
178 # False table.
179
180 # Properties have a 'Type', like 'binary', or 'string', or 'enum' depending on
181 # how many match tables there are and the content of the maps.  This 'Type' is
182 # different than a range 'Type', so don't get confused by the two concepts
183 # having the same name.
184 #
185 # For information about the Unicode properties, see Unicode's UAX44 document:
186
187 my $unicode_reference_url = 'http://www.unicode.org/reports/tr44/';
188
189 # As stated earlier, this program will work on any release of Unicode so far.
190 # Most obvious problems in earlier data have NOT been corrected except when
191 # necessary to make Perl or this program work reasonably, and to keep out
192 # potential security issues.  For example, no folding information was given in
193 # early releases, so this program substitutes lower case instead, just so that
194 # a regular expression with the /i option will do something that actually
195 # gives the right results in many cases.  There are also a couple other
196 # corrections for version 1.1.5, commented at the point they are made.  As an
197 # example of corrections that weren't made (but could be) is this statement
198 # from DerivedAge.txt: "The supplementary private use code points and the
199 # non-character code points were assigned in version 2.0, but not specifically
200 # listed in the UCD until versions 3.0 and 3.1 respectively."  (To be precise
201 # it was 3.0.1 not 3.0.0)  More information on Unicode version glitches is
202 # further down in these introductory comments.
203 #
204 # This program works on all non-provisional properties as of the current
205 # Unicode release, though the files for some are suppressed for various
206 # reasons.  You can change which are output by changing lists in this program.
207 #
208 # The old version of mktables emphasized the term "Fuzzy" to mean Unicode's
209 # loose matchings rules (from Unicode TR18):
210 #
211 #    The recommended names for UCD properties and property values are in
212 #    PropertyAliases.txt [Prop] and PropertyValueAliases.txt
213 #    [PropValue]. There are both abbreviated names and longer, more
214 #    descriptive names. It is strongly recommended that both names be
215 #    recognized, and that loose matching of property names be used,
216 #    whereby the case distinctions, whitespace, hyphens, and underbar
217 #    are ignored.
218 #
219 # The program still allows Fuzzy to override its determination of if loose
220 # matching should be used, but it isn't currently used, as it is no longer
221 # needed; the calculations it makes are good enough.
222 #
223 # SUMMARY OF HOW IT WORKS:
224 #
225 #   Process arguments
226 #
227 #   A list is constructed containing each input file that is to be processed
228 #
229 #   Each file on the list is processed in a loop, using the associated handler
230 #   code for each:
231 #        The PropertyAliases.txt and PropValueAliases.txt files are processed
232 #            first.  These files name the properties and property values.
233 #            Objects are created of all the property and property value names
234 #            that the rest of the input should expect, including all synonyms.
235 #        The other input files give mappings from properties to property
236 #           values.  That is, they list code points and say what the mapping
237 #           is under the given property.  Some files give the mappings for
238 #           just one property; and some for many.  This program goes through
239 #           each file and populates the properties and their map tables from
240 #           them.  Some properties are listed in more than one file, and
241 #           Unicode has set up a precedence as to which has priority if there
242 #           is a conflict.  Thus the order of processing matters, and this
243 #           program handles the conflict possibility by processing the
244 #           overriding input files last, so that if necessary they replace
245 #           earlier values.
246 #        After this is all done, the program creates the property mappings not
247 #            furnished by Unicode, but derivable from what it does give.
248 #        The tables of code points that match each property value in each
249 #            property that is accessible by regular expressions are created.
250 #        The Perl-defined properties are created and populated.  Many of these
251 #            require data determined from the earlier steps
252 #        Any Perl-defined synonyms are created, and name clashes between Perl
253 #            and Unicode are reconciled and warned about.
254 #        All the properties are written to files
255 #        Any other files are written, and final warnings issued.
256 #
257 # For clarity, a number of operators have been overloaded to work on tables:
258 #   ~ means invert (take all characters not in the set).  The more
259 #       conventional '!' is not used because of the possibility of confusing
260 #       it with the actual boolean operation.
261 #   + means union
262 #   - means subtraction
263 #   & means intersection
264 # The precedence of these is the order listed.  Parentheses should be
265 # copiously used.  These are not a general scheme.  The operations aren't
266 # defined for a number of things, deliberately, to avoid getting into trouble.
267 # Operations are done on references and affect the underlying structures, so
268 # that the copy constructors for them have been overloaded to not return a new
269 # clone, but the input object itself.
270 #
271 # The bool operator is deliberately not overloaded to avoid confusion with
272 # "should it mean if the object merely exists, or also is non-empty?".
273 #
274 # WHY CERTAIN DESIGN DECISIONS WERE MADE
275 #
276 # This program needs to be able to run under miniperl.  Therefore, it uses a
277 # minimum of other modules, and hence implements some things itself that could
278 # be gotten from CPAN
279 #
280 # This program uses inputs published by the Unicode Consortium.  These can
281 # change incompatibly between releases without the Perl maintainers realizing
282 # it.  Therefore this program is now designed to try to flag these.  It looks
283 # at the directories where the inputs are, and flags any unrecognized files.
284 # It keeps track of all the properties in the files it handles, and flags any
285 # that it doesn't know how to handle.  It also flags any input lines that
286 # don't match the expected syntax, among other checks.
287 #
288 # It is also designed so if a new input file matches one of the known
289 # templates, one hopefully just needs to add it to a list to have it
290 # processed.
291 #
292 # As mentioned earlier, some properties are given in more than one file.  In
293 # particular, the files in the extracted directory are supposedly just
294 # reformattings of the others.  But they contain information not easily
295 # derivable from the other files, including results for Unihan, which this
296 # program doesn't ordinarily look at, and for unassigned code points.  They
297 # also have historically had errors or been incomplete.  In an attempt to
298 # create the best possible data, this program thus processes them first to
299 # glean information missing from the other files; then processes those other
300 # files to override any errors in the extracted ones.  Much of the design was
301 # driven by this need to store things and then possibly override them.
302 #
303 # It tries to keep fatal errors to a minimum, to generate something usable for
304 # testing purposes.  It always looks for files that could be inputs, and will
305 # warn about any that it doesn't know how to handle (the -q option suppresses
306 # the warning).
307 #
308 # Why is there more than one type of range?
309 #   This simplified things.  There are some very specialized code points that
310 #   have to be handled specially for output, such as Hangul syllable names.
311 #   By creating a range type (done late in the development process), it
312 #   allowed this to be stored with the range, and overridden by other input.
313 #   Originally these were stored in another data structure, and it became a
314 #   mess trying to decide if a second file that was for the same property was
315 #   overriding the earlier one or not.
316 #
317 # Why are there two kinds of tables, match and map?
318 #   (And there is a base class shared by the two as well.)  As stated above,
319 #   they actually are for different things.  Development proceeded much more
320 #   smoothly when I (khw) realized the distinction.  Map tables are used to
321 #   give the property value for every code point (actually every code point
322 #   that doesn't map to a default value).  Match tables are used for regular
323 #   expression matches, and are essentially the inverse mapping.  Separating
324 #   the two allows more specialized methods, and error checks so that one
325 #   can't just take the intersection of two map tables, for example, as that
326 #   is nonsensical.
327 #
328 # What about 'fate' and 'status'.  The concept of a table's fate was created
329 #   late when it became clear that something more was needed.  The difference
330 #   between this and 'status' is unclean, and could be improved if someone
331 #   wanted to spend the effort.
332 #
333 # DEBUGGING
334 #
335 # This program is written so it will run under miniperl.  Occasionally changes
336 # will cause an error where the backtrace doesn't work well under miniperl.
337 # To diagnose the problem, you can instead run it under regular perl, if you
338 # have one compiled.
339 #
340 # There is a good trace facility.  To enable it, first sub DEBUG must be set
341 # to return true.  Then a line like
342 #
343 # local $to_trace = 1 if main::DEBUG;
344 #
345 # can be added to enable tracing in its lexical scope (plus dynamic) or until
346 # you insert another line:
347 #
348 # local $to_trace = 0 if main::DEBUG;
349 #
350 # To actually trace, use a line like "trace $a, @b, %c, ...;
351 #
352 # Some of the more complex subroutines already have trace statements in them.
353 # Permanent trace statements should be like:
354 #
355 # trace ... if main::DEBUG && $to_trace;
356 #
357 # If there is just one or a few files that you're debugging, you can easily
358 # cause most everything else to be skipped.  Change the line
359 #
360 # my $debug_skip = 0;
361 #
362 # to 1, and every file whose object is in @input_file_objects and doesn't have
363 # a, 'non_skip => 1,' in its constructor will be skipped.  However, skipping
364 # Jamo.txt or UnicodeData.txt will likely cause fatal errors.
365 #
366 # To compare the output tables, it may be useful to specify the -annotate
367 # flag.  (As of this writing, this can't be done on a clean workspace, due to
368 # requirements in Text::Tabs used in this option; so first run mktables
369 # without this option.)  This option adds comment lines to each table, one for
370 # each non-algorithmically named character giving, currently its code point,
371 # name, and graphic representation if printable (and you have a font that
372 # knows about it).  This makes it easier to see what the particular code
373 # points are in each output table.  Non-named code points are annotated with a
374 # description of their status, and contiguous ones with the same description
375 # will be output as a range rather than individually.  Algorithmically named
376 # characters are also output as ranges, except when there are just a few
377 # contiguous ones.
378 #
379 # FUTURE ISSUES
380 #
381 # The program would break if Unicode were to change its names so that
382 # interior white space, underscores, or dashes differences were significant
383 # within property and property value names.
384 #
385 # It might be easier to use the xml versions of the UCD if this program ever
386 # would need heavy revision, and the ability to handle old versions was not
387 # required.
388 #
389 # There is the potential for name collisions, in that Perl has chosen names
390 # that Unicode could decide it also likes.  There have been such collisions in
391 # the past, with mostly Perl deciding to adopt the Unicode definition of the
392 # name.  However in the 5.2 Unicode beta testing, there were a number of such
393 # collisions, which were withdrawn before the final release, because of Perl's
394 # and other's protests.  These all involved new properties which began with
395 # 'Is'.  Based on the protests, Unicode is unlikely to try that again.  Also,
396 # many of the Perl-defined synonyms, like Any, Word, etc, are listed in a
397 # Unicode document, so they are unlikely to be used by Unicode for another
398 # purpose.  However, they might try something beginning with 'In', or use any
399 # of the other Perl-defined properties.  This program will warn you of name
400 # collisions, and refuse to generate tables with them, but manual intervention
401 # will be required in this event.  One scheme that could be implemented, if
402 # necessary, would be to have this program generate another file, or add a
403 # field to mktables.lst that gives the date of first definition of a property.
404 # Each new release of Unicode would use that file as a basis for the next
405 # iteration.  And the Perl synonym addition code could sort based on the age
406 # of the property, so older properties get priority, and newer ones that clash
407 # would be refused; hence existing code would not be impacted, and some other
408 # synonym would have to be used for the new property.  This is ugly, and
409 # manual intervention would certainly be easier to do in the short run; lets
410 # hope it never comes to this.
411 #
412 # A NOTE ON UNIHAN
413 #
414 # This program can generate tables from the Unihan database.  But it doesn't
415 # by default, letting the CPAN module Unicode::Unihan handle them.  Prior to
416 # version 5.2, this database was in a single file, Unihan.txt.  In 5.2 the
417 # database was split into 8 different files, all beginning with the letters
418 # 'Unihan'.  This program will read those file(s) if present, but it needs to
419 # know which of the many properties in the file(s) should have tables created
420 # for them.  It will create tables for any properties listed in
421 # PropertyAliases.txt and PropValueAliases.txt, plus any listed in the
422 # @cjk_properties array and the @cjk_property_values array.  Thus, if a
423 # property you want is not in those files of the release you are building
424 # against, you must add it to those two arrays.  Starting in 4.0, the
425 # Unicode_Radical_Stroke was listed in those files, so if the Unihan database
426 # is present in the directory, a table will be generated for that property.
427 # In 5.2, several more properties were added.  For your convenience, the two
428 # arrays are initialized with all the 6.0 listed properties that are also in
429 # earlier releases.  But these are commented out.  You can just uncomment the
430 # ones you want, or use them as a template for adding entries for other
431 # properties.
432 #
433 # You may need to adjust the entries to suit your purposes.  setup_unihan(),
434 # and filter_unihan_line() are the functions where this is done.  This program
435 # already does some adjusting to make the lines look more like the rest of the
436 # Unicode DB;  You can see what that is in filter_unihan_line()
437 #
438 # There is a bug in the 3.2 data file in which some values for the
439 # kPrimaryNumeric property have commas and an unexpected comment.  A filter
440 # could be added for these; or for a particular installation, the Unihan.txt
441 # file could be edited to fix them.
442 #
443 # HOW TO ADD A FILE TO BE PROCESSED
444 #
445 # A new file from Unicode needs to have an object constructed for it in
446 # @input_file_objects, probably at the end or at the end of the extracted
447 # ones.  The program should warn you if its name will clash with others on
448 # restrictive file systems, like DOS.  If so, figure out a better name, and
449 # add lines to the README.perl file giving that.  If the file is a character
450 # property, it should be in the format that Unicode has implicitly
451 # standardized for such files for the more recently introduced ones.
452 # If so, the Input_file constructor for @input_file_objects can just be the
453 # file name and release it first appeared in.  If not, then it should be
454 # possible to construct an each_line_handler() to massage the line into the
455 # standardized form.
456 #
457 # For non-character properties, more code will be needed.  You can look at
458 # the existing entries for clues.
459 #
460 # UNICODE VERSIONS NOTES
461 #
462 # The Unicode UCD has had a number of errors in it over the versions.  And
463 # these remain, by policy, in the standard for that version.  Therefore it is
464 # risky to correct them, because code may be expecting the error.  So this
465 # program doesn't generally make changes, unless the error breaks the Perl
466 # core.  As an example, some versions of 2.1.x Jamo.txt have the wrong value
467 # for U+1105, which causes real problems for the algorithms for Jamo
468 # calculations, so it is changed here.
469 #
470 # But it isn't so clear cut as to what to do about concepts that are
471 # introduced in a later release; should they extend back to earlier releases
472 # where the concept just didn't exist?  It was easier to do this than to not,
473 # so that's what was done.  For example, the default value for code points not
474 # in the files for various properties was probably undefined until changed by
475 # some version.  No_Block for blocks is such an example.  This program will
476 # assign No_Block even in Unicode versions that didn't have it.  This has the
477 # benefit that code being written doesn't have to special case earlier
478 # versions; and the detriment that it doesn't match the Standard precisely for
479 # the affected versions.
480 #
481 # Here are some observations about some of the issues in early versions:
482 #
483 # Prior to version 3.0, there were 3 character decompositions.  These are not
484 # handled by Unicode::Normalize, nor will it compile when presented a version
485 # that has them.  However, you can trivially get it to compile by simply
486 # ignoring those decompositions, by changing the croak to a carp.  At the time
487 # of this writing, the line (in cpan/Unicode-Normalize/mkheader) reads
488 #
489 #   croak("Weird Canonical Decomposition of U+$h");
490 #
491 # Simply comment it out.  It will compile, but will not know about any three
492 # character decompositions.  If using the .pm version, there is a similar
493 # line.
494
495 # The number of code points in \p{alpha=True} halved in 2.1.9.  It turns out
496 # that the reason is that the CJK block starting at 4E00 was removed from
497 # PropList, and was not put back in until 3.1.0.  The Perl extension (the
498 # single property name \p{alpha}) has the correct values.  But the compound
499 # form is simply not generated until 3.1, as it can be argued that prior to
500 # this release, this was not an official property.  The comments for
501 # filter_old_style_proplist() give more details.
502 #
503 # Unicode introduced the synonym Space for White_Space in 4.1.  Perl has
504 # always had a \p{Space}.  In release 3.2 only, they are not synonymous.  The
505 # reason is that 3.2 introduced U+205F=medium math space, which was not
506 # classed as white space, but Perl figured out that it should have been. 4.0
507 # reclassified it correctly.
508 #
509 # Another change between 3.2 and 4.0 is the CCC property value ATBL.  In 3.2
510 # this was erroneously a synonym for 202 (it should be 200).  In 4.0, ATB
511 # became 202, and ATBL was left with no code points, as all the ones that
512 # mapped to 202 stayed mapped to 202.  Thus if your program used the numeric
513 # name for the class, it would not have been affected, but if it used the
514 # mnemonic, it would have been.
515 #
516 # \p{Script=Hrkt} (Katakana_Or_Hiragana) came in 4.0.1.  Before that code
517 # points which eventually came to have this script property value, instead
518 # mapped to "Unknown".  But in the next release all these code points were
519 # moved to \p{sc=common} instead.
520 #
521 # The default for missing code points for BidiClass is complicated.  Starting
522 # in 3.1.1, the derived file DBidiClass.txt handles this, but this program
523 # tries to do the best it can for earlier releases.  It is done in
524 # process_PropertyAliases()
525 #
526 # In version 2.1.2, the entry in UnicodeData.txt:
527 #   0275;LATIN SMALL LETTER BARRED O;Ll;0;L;;;;;N;;;;019F;
528 # should instead be
529 #   0275;LATIN SMALL LETTER BARRED O;Ll;0;L;;;;;N;;;019F;;019F
530 # Without this change, there are casing problems for this character.
531 #
532 # Search for $string_compare_versions to see how to compare changes to
533 # properties between Unicode versions
534 #
535 ##############################################################################
536
537 my $UNDEF = ':UNDEF:';  # String to print out for undefined values in tracing
538                         # and errors
539 my $MAX_LINE_WIDTH = 78;
540
541 # Debugging aid to skip most files so as to not be distracted by them when
542 # concentrating on the ones being debugged.  Add
543 # non_skip => 1,
544 # to the constructor for those files you want processed when you set this.
545 # Files with a first version number of 0 are special: they are always
546 # processed regardless of the state of this flag.  Generally, Jamo.txt and
547 # UnicodeData.txt must not be skipped if you want this program to not die
548 # before normal completion.
549 my $debug_skip = 0;
550
551
552 # Normally these are suppressed.
553 my $write_Unicode_deprecated_tables = 0;
554
555 # Set to 1 to enable tracing.
556 our $to_trace = 0;
557
558 { # Closure for trace: debugging aid
559     my $print_caller = 1;        # ? Include calling subroutine name
560     my $main_with_colon = 'main::';
561     my $main_colon_length = length($main_with_colon);
562
563     sub trace {
564         return unless $to_trace;        # Do nothing if global flag not set
565
566         my @input = @_;
567
568         local $DB::trace = 0;
569         $DB::trace = 0;          # Quiet 'used only once' message
570
571         my $line_number;
572
573         # Loop looking up the stack to get the first non-trace caller
574         my $caller_line;
575         my $caller_name;
576         my $i = 0;
577         do {
578             $line_number = $caller_line;
579             (my $pkg, my $file, $caller_line, my $caller) = caller $i++;
580             $caller = $main_with_colon unless defined $caller;
581
582             $caller_name = $caller;
583
584             # get rid of pkg
585             $caller_name =~ s/.*:://;
586             if (substr($caller_name, 0, $main_colon_length)
587                 eq $main_with_colon)
588             {
589                 $caller_name = substr($caller_name, $main_colon_length);
590             }
591
592         } until ($caller_name ne 'trace');
593
594         # If the stack was empty, we were called from the top level
595         $caller_name = 'main' if ($caller_name eq ""
596                                     || $caller_name eq 'trace');
597
598         my $output = "";
599         foreach my $string (@input) {
600             #print STDERR __LINE__, ": ", join ", ", @input, "\n";
601             if (ref $string eq 'ARRAY' || ref $string eq 'HASH') {
602                 $output .= simple_dumper($string);
603             }
604             else {
605                 $string = "$string" if ref $string;
606                 $string = $UNDEF unless defined $string;
607                 chomp $string;
608                 $string = '""' if $string eq "";
609                 $output .= " " if $output ne ""
610                                 && $string ne ""
611                                 && substr($output, -1, 1) ne " "
612                                 && substr($string, 0, 1) ne " ";
613                 $output .= $string;
614             }
615         }
616
617         print STDERR sprintf "%4d: ", $line_number if defined $line_number;
618         print STDERR "$caller_name: " if $print_caller;
619         print STDERR $output, "\n";
620         return;
621     }
622 }
623
624 # This is for a rarely used development feature that allows you to compare two
625 # versions of the Unicode standard without having to deal with changes caused
626 # by the code points introduced in the later version.  Change the 0 to a
627 # string containing a SINGLE dotted Unicode release number (e.g. "2.1").  Only
628 # code points introduced in that release and earlier will be used; later ones
629 # are thrown away.  You use the version number of the earliest one you want to
630 # compare; then run this program on directory structures containing each
631 # release, and compare the outputs.  These outputs will therefore include only
632 # the code points common to both releases, and you can see the changes caused
633 # just by the underlying release semantic changes.  For versions earlier than
634 # 3.2, you must copy a version of DAge.txt into the directory.
635 my $string_compare_versions = DEBUG && 0; #  e.g., "2.1";
636 my $compare_versions = DEBUG
637                        && $string_compare_versions
638                        && pack "C*", split /\./, $string_compare_versions;
639
640 sub uniques {
641     # Returns non-duplicated input values.  From "Perl Best Practices:
642     # Encapsulated Cleverness".  p. 455 in first edition.
643
644     my %seen;
645     # Arguably this breaks encapsulation, if the goal is to permit multiple
646     # distinct objects to stringify to the same value, and be interchangeable.
647     # However, for this program, no two objects stringify identically, and all
648     # lists passed to this function are either objects or strings. So this
649     # doesn't affect correctness, but it does give a couple of percent speedup.
650     no overloading;
651     return grep { ! $seen{$_}++ } @_;
652 }
653
654 $0 = File::Spec->canonpath($0);
655
656 my $make_test_script = 0;      # ? Should we output a test script
657 my $make_norm_test_script = 0; # ? Should we output a normalization test script
658 my $write_unchanged_files = 0; # ? Should we update the output files even if
659                                #    we don't think they have changed
660 my $use_directory = "";        # ? Should we chdir somewhere.
661 my $pod_directory;             # input directory to store the pod file.
662 my $pod_file = 'perluniprops';
663 my $t_path;                     # Path to the .t test file
664 my $file_list = 'mktables.lst'; # File to store input and output file names.
665                                # This is used to speed up the build, by not
666                                # executing the main body of the program if
667                                # nothing on the list has changed since the
668                                # previous build
669 my $make_list = 1;             # ? Should we write $file_list.  Set to always
670                                # make a list so that when the pumpking is
671                                # preparing a release, s/he won't have to do
672                                # special things
673 my $glob_list = 0;             # ? Should we try to include unknown .txt files
674                                # in the input.
675 my $output_range_counts = $debugging_build;   # ? Should we include the number
676                                               # of code points in ranges in
677                                               # the output
678 my $annotate = 0;              # ? Should character names be in the output
679
680 # Verbosity levels; 0 is quiet
681 my $NORMAL_VERBOSITY = 1;
682 my $PROGRESS = 2;
683 my $VERBOSE = 3;
684
685 my $verbosity = $NORMAL_VERBOSITY;
686
687 # Stored in mktables.lst so that if this program is called with different
688 # options, will regenerate even if the files otherwise look like they're
689 # up-to-date.
690 my $command_line_arguments = join " ", @ARGV;
691
692 # Process arguments
693 while (@ARGV) {
694     my $arg = shift @ARGV;
695     if ($arg eq '-v') {
696         $verbosity = $VERBOSE;
697     }
698     elsif ($arg eq '-p') {
699         $verbosity = $PROGRESS;
700         $| = 1;     # Flush buffers as we go.
701     }
702     elsif ($arg eq '-q') {
703         $verbosity = 0;
704     }
705     elsif ($arg eq '-w') {
706         $write_unchanged_files = 1; # update the files even if havent changed
707     }
708     elsif ($arg eq '-check') {
709         my $this = shift @ARGV;
710         my $ok = shift @ARGV;
711         if ($this ne $ok) {
712             print "Skipping as check params are not the same.\n";
713             exit(0);
714         }
715     }
716     elsif ($arg eq '-P' && defined ($pod_directory = shift)) {
717         -d $pod_directory or croak "Directory '$pod_directory' doesn't exist";
718     }
719     elsif ($arg eq '-maketest' || ($arg eq '-T' && defined ($t_path = shift)))
720     {
721         $make_test_script = 1;
722     }
723     elsif ($arg eq '-makenormtest')
724     {
725         $make_norm_test_script = 1;
726     }
727     elsif ($arg eq '-makelist') {
728         $make_list = 1;
729     }
730     elsif ($arg eq '-C' && defined ($use_directory = shift)) {
731         -d $use_directory or croak "Unknown directory '$use_directory'";
732     }
733     elsif ($arg eq '-L') {
734
735         # Existence not tested until have chdir'd
736         $file_list = shift;
737     }
738     elsif ($arg eq '-globlist') {
739         $glob_list = 1;
740     }
741     elsif ($arg eq '-c') {
742         $output_range_counts = ! $output_range_counts
743     }
744     elsif ($arg eq '-annotate') {
745         $annotate = 1;
746         $debugging_build = 1;
747         $output_range_counts = 1;
748     }
749     else {
750         my $with_c = 'with';
751         $with_c .= 'out' if $output_range_counts;   # Complements the state
752         croak <<END;
753 usage: $0 [-c|-p|-q|-v|-w] [-C dir] [-L filelist] [ -P pod_dir ]
754           [ -T test_file_path ] [-globlist] [-makelist] [-maketest]
755           [-check A B ]
756   -c          : Output comments $with_c number of code points in ranges
757   -q          : Quiet Mode: Only output serious warnings.
758   -p          : Set verbosity level to normal plus show progress.
759   -v          : Set Verbosity level high:  Show progress and non-serious
760                 warnings
761   -w          : Write files regardless
762   -C dir      : Change to this directory before proceeding. All relative paths
763                 except those specified by the -P and -T options will be done
764                 with respect to this directory.
765   -P dir      : Output $pod_file file to directory 'dir'.
766   -T path     : Create a test script as 'path'; overrides -maketest
767   -L filelist : Use alternate 'filelist' instead of standard one
768   -globlist   : Take as input all non-Test *.txt files in current and sub
769                 directories
770   -maketest   : Make test script 'TestProp.pl' in current (or -C directory),
771                 overrides -T
772   -makelist   : Rewrite the file list $file_list based on current setup
773   -annotate   : Output an annotation for each character in the table files;
774                 useful for debugging mktables, looking at diffs; but is slow
775                 and memory intensive
776   -check A B  : Executes $0 only if A and B are the same
777 END
778     }
779 }
780
781 # Stores the most-recently changed file.  If none have changed, can skip the
782 # build
783 my $most_recent = (stat $0)[9];   # Do this before the chdir!
784
785 # Change directories now, because need to read 'version' early.
786 if ($use_directory) {
787     if ($pod_directory && ! File::Spec->file_name_is_absolute($pod_directory)) {
788         $pod_directory = File::Spec->rel2abs($pod_directory);
789     }
790     if ($t_path && ! File::Spec->file_name_is_absolute($t_path)) {
791         $t_path = File::Spec->rel2abs($t_path);
792     }
793     chdir $use_directory or croak "Failed to chdir to '$use_directory':$!";
794     if ($pod_directory && File::Spec->file_name_is_absolute($pod_directory)) {
795         $pod_directory = File::Spec->abs2rel($pod_directory);
796     }
797     if ($t_path && File::Spec->file_name_is_absolute($t_path)) {
798         $t_path = File::Spec->abs2rel($t_path);
799     }
800 }
801
802 # Get Unicode version into regular and v-string.  This is done now because
803 # various tables below get populated based on it.  These tables are populated
804 # here to be near the top of the file, and so easily seeable by those needing
805 # to modify things.
806 open my $VERSION, "<", "version"
807                     or croak "$0: can't open required file 'version': $!\n";
808 my $string_version = <$VERSION>;
809 close $VERSION;
810 chomp $string_version;
811 my $v_version = pack "C*", split /\./, $string_version;        # v string
812
813 # The following are the complete names of properties with property values that
814 # are known to not match any code points in some versions of Unicode, but that
815 # may change in the future so they should be matchable, hence an empty file is
816 # generated for them.
817 my @tables_that_may_be_empty;
818 push @tables_that_may_be_empty, 'Joining_Type=Left_Joining'
819                                                     if $v_version lt v6.3.0;
820 push @tables_that_may_be_empty, 'Script=Common' if $v_version le v4.0.1;
821 push @tables_that_may_be_empty, 'Title' if $v_version lt v2.0.0;
822 push @tables_that_may_be_empty, 'Script=Katakana_Or_Hiragana'
823                                                     if $v_version ge v4.1.0;
824 push @tables_that_may_be_empty, 'Script_Extensions=Katakana_Or_Hiragana'
825                                                     if $v_version ge v6.0.0;
826 push @tables_that_may_be_empty, 'Grapheme_Cluster_Break=Prepend'
827                                                     if $v_version ge v6.1.0;
828 push @tables_that_may_be_empty, 'Canonical_Combining_Class=CCC133'
829                                                     if $v_version ge v6.2.0;
830
831 # The lists below are hashes, so the key is the item in the list, and the
832 # value is the reason why it is in the list.  This makes generation of
833 # documentation easier.
834
835 my %why_suppressed;  # No file generated for these.
836
837 # Files aren't generated for empty extraneous properties.  This is arguable.
838 # Extraneous properties generally come about because a property is no longer
839 # used in a newer version of Unicode.  If we generated a file without code
840 # points, programs that used to work on that property will still execute
841 # without errors.  It just won't ever match (or will always match, with \P{}).
842 # This means that the logic is now likely wrong.  I (khw) think its better to
843 # find this out by getting an error message.  Just move them to the table
844 # above to change this behavior
845 my %why_suppress_if_empty_warn_if_not = (
846
847    # It is the only property that has ever officially been removed from the
848    # Standard.  The database never contained any code points for it.
849    'Special_Case_Condition' => 'Obsolete',
850
851    # Apparently never official, but there were code points in some versions of
852    # old-style PropList.txt
853    'Non_Break' => 'Obsolete',
854 );
855
856 # These would normally go in the warn table just above, but they were changed
857 # a long time before this program was written, so warnings about them are
858 # moot.
859 if ($v_version gt v3.2.0) {
860     push @tables_that_may_be_empty,
861                                 'Canonical_Combining_Class=Attached_Below_Left'
862 }
863
864 # These are listed in the Property aliases file in 6.0, but Unihan is ignored
865 # unless explicitly added.
866 if ($v_version ge v5.2.0) {
867     my $unihan = 'Unihan; remove from list if using Unihan';
868     foreach my $table (qw (
869                            kAccountingNumeric
870                            kOtherNumeric
871                            kPrimaryNumeric
872                            kCompatibilityVariant
873                            kIICore
874                            kIRG_GSource
875                            kIRG_HSource
876                            kIRG_JSource
877                            kIRG_KPSource
878                            kIRG_MSource
879                            kIRG_KSource
880                            kIRG_TSource
881                            kIRG_USource
882                            kIRG_VSource
883                            kRSUnicode
884                         ))
885     {
886         $why_suppress_if_empty_warn_if_not{$table} = $unihan;
887     }
888 }
889
890 # Enum values for to_output_map() method in the Map_Table package.
891 my $EXTERNAL_MAP = 1;
892 my $INTERNAL_MAP = 2;
893 my $OUTPUT_ADJUSTED = 3;
894
895 # To override computed values for writing the map tables for these properties.
896 # The default for enum map tables is to write them out, so that the Unicode
897 # .txt files can be removed, but all the data to compute any property value
898 # for any code point is available in a more compact form.
899 my %global_to_output_map = (
900     # Needed by UCD.pm, but don't want to publicize that it exists, so won't
901     # get stuck supporting it if things change.  Since it is a STRING
902     # property, it normally would be listed in the pod, but INTERNAL_MAP
903     # suppresses that.
904     Unicode_1_Name => $INTERNAL_MAP,
905
906     Present_In => 0,                # Suppress, as easily computed from Age
907     Block => (NON_ASCII_PLATFORM) ? 1 : 0,  # Suppress, as Blocks.txt is
908                                             # retained, but needed for
909                                             # non-ASCII
910
911     # Suppress, as mapping can be found instead from the
912     # Perl_Decomposition_Mapping file
913     Decomposition_Type => 0,
914 );
915
916 # Properties that this program ignores.
917 my @unimplemented_properties;
918
919 # With this release, it is automatically handled if the Unihan db is
920 # downloaded
921 push @unimplemented_properties, 'Unicode_Radical_Stroke' if $v_version lt v5.2.0;
922
923 # There are several types of obsolete properties defined by Unicode.  These
924 # must be hand-edited for every new Unicode release.
925 my %why_deprecated;  # Generates a deprecated warning message if used.
926 my %why_stabilized;  # Documentation only
927 my %why_obsolete;    # Documentation only
928
929 {   # Closure
930     my $simple = 'Perl uses the more complete version';
931     my $unihan = 'Unihan properties are by default not enabled in the Perl core.  Instead use CPAN: Unicode::Unihan';
932
933     my $other_properties = 'other properties';
934     my $contributory = "Used by Unicode internally for generating $other_properties and not intended to be used stand-alone";
935     my $why_no_expand  = "Deprecated by Unicode.  These are characters that expand to more than one character in the specified normalization form, but whether they actually take up more bytes or not depends on the encoding being used.  For example, a UTF-8 encoded character may expand to a different number of bytes than a UTF-32 encoded character.";
936
937     %why_deprecated = (
938         'Grapheme_Link' => 'Deprecated by Unicode:  Duplicates ccc=vr (Canonical_Combining_Class=Virama)',
939         'Jamo_Short_Name' => $contributory,
940         'Line_Break=Surrogate' => 'Deprecated by Unicode because surrogates should never appear in well-formed text, and therefore shouldn\'t be the basis for line breaking',
941         'Other_Alphabetic' => $contributory,
942         'Other_Default_Ignorable_Code_Point' => $contributory,
943         'Other_Grapheme_Extend' => $contributory,
944         'Other_ID_Continue' => $contributory,
945         'Other_ID_Start' => $contributory,
946         'Other_Lowercase' => $contributory,
947         'Other_Math' => $contributory,
948         'Other_Uppercase' => $contributory,
949         'Expands_On_NFC' => $why_no_expand,
950         'Expands_On_NFD' => $why_no_expand,
951         'Expands_On_NFKC' => $why_no_expand,
952         'Expands_On_NFKD' => $why_no_expand,
953     );
954
955     %why_suppressed = (
956         # There is a lib/unicore/Decomposition.pl (used by Normalize.pm) which
957         # contains the same information, but without the algorithmically
958         # determinable Hangul syllables'.  This file is not published, so it's
959         # existence is not noted in the comment.
960         'Decomposition_Mapping' => 'Accessible via Unicode::Normalize or prop_invmap() or charprop() in Unicode::UCD::',
961
962         'Indic_Matra_Category' => "Withdrawn by Unicode while still provisional",
963
964         # Don't suppress ISO_Comment, as otherwise special handling is needed
965         # to differentiate between it and gc=c, which can be written as 'isc',
966         # which is the same characters as ISO_Comment's short name.
967
968         'Name' => "Accessible via \\N{...} or 'use charnames;' or charprop() or prop_invmap() in Unicode::UCD::",
969
970         'Simple_Case_Folding' => "$simple.  Can access this through casefold(), charprop(), or prop_invmap() in Unicode::UCD",
971         'Simple_Lowercase_Mapping' => "$simple.  Can access this through charinfo(), charprop(), or prop_invmap() in Unicode::UCD",
972         'Simple_Titlecase_Mapping' => "$simple.  Can access this through charinfo(), charprop(), or prop_invmap() in Unicode::UCD",
973         'Simple_Uppercase_Mapping' => "$simple.  Can access this through charinfo(), charprop(), or prop_invmap() in Unicode::UCD",
974
975         FC_NFKC_Closure => 'Deprecated by Unicode, and supplanted in usage by NFKC_Casefold; otherwise not useful',
976     );
977
978     foreach my $property (
979
980             # The following are suppressed because they were made contributory
981             # or deprecated by Unicode before Perl ever thought about
982             # supporting them.
983             'Jamo_Short_Name',
984             'Grapheme_Link',
985             'Expands_On_NFC',
986             'Expands_On_NFD',
987             'Expands_On_NFKC',
988             'Expands_On_NFKD',
989
990             # The following are suppressed because they have been marked
991             # as deprecated for a sufficient amount of time
992             'Other_Alphabetic',
993             'Other_Default_Ignorable_Code_Point',
994             'Other_Grapheme_Extend',
995             'Other_ID_Continue',
996             'Other_ID_Start',
997             'Other_Lowercase',
998             'Other_Math',
999             'Other_Uppercase',
1000     ) {
1001         $why_suppressed{$property} = $why_deprecated{$property};
1002     }
1003
1004     # Customize the message for all the 'Other_' properties
1005     foreach my $property (keys %why_deprecated) {
1006         next if (my $main_property = $property) !~ s/^Other_//;
1007         $why_deprecated{$property} =~ s/$other_properties/the $main_property property (which should be used instead)/;
1008     }
1009 }
1010
1011 if ($write_Unicode_deprecated_tables) {
1012     foreach my $property (keys %why_suppressed) {
1013         delete $why_suppressed{$property} if $property =~
1014                                                     / ^ Other | Grapheme /x;
1015     }
1016 }
1017
1018 if ($v_version ge 4.0.0) {
1019     $why_stabilized{'Hyphen'} = 'Use the Line_Break property instead; see www.unicode.org/reports/tr14';
1020     if ($v_version ge 6.0.0) {
1021         $why_deprecated{'Hyphen'} = 'Supplanted by Line_Break property values; see www.unicode.org/reports/tr14';
1022     }
1023 }
1024 if ($v_version ge 5.2.0 && $v_version lt 6.0.0) {
1025     $why_obsolete{'ISO_Comment'} = 'Code points for it have been removed';
1026     if ($v_version ge 6.0.0) {
1027         $why_deprecated{'ISO_Comment'} = 'No longer needed for Unicode\'s internal chart generation; otherwise not useful, and code points for it have been removed';
1028     }
1029 }
1030
1031 # Probably obsolete forever
1032 if ($v_version ge v4.1.0) {
1033     $why_suppressed{'Script=Katakana_Or_Hiragana'} = 'Obsolete.  All code points previously matched by this have been moved to "Script=Common".';
1034 }
1035 if ($v_version ge v6.0.0) {
1036     $why_suppressed{'Script=Katakana_Or_Hiragana'} .= '  Consider instead using "Script_Extensions=Katakana" or "Script_Extensions=Hiragana" (or both)';
1037     $why_suppressed{'Script_Extensions=Katakana_Or_Hiragana'} = 'All code points that would be matched by this are matched by either "Script_Extensions=Katakana" or "Script_Extensions=Hiragana"';
1038 }
1039
1040 # This program can create files for enumerated-like properties, such as
1041 # 'Numeric_Type'.  This file would be the same format as for a string
1042 # property, with a mapping from code point to its value, so you could look up,
1043 # for example, the script a code point is in.  But no one so far wants this
1044 # mapping, or they have found another way to get it since this is a new
1045 # feature.  So no file is generated except if it is in this list.
1046 my @output_mapped_properties = split "\n", <<END;
1047 END
1048
1049 # If you are using the Unihan database in a Unicode version before 5.2, you
1050 # need to add the properties that you want to extract from it to this table.
1051 # For your convenience, the properties in the 6.0 PropertyAliases.txt file are
1052 # listed, commented out
1053 my @cjk_properties = split "\n", <<'END';
1054 #cjkAccountingNumeric; kAccountingNumeric
1055 #cjkOtherNumeric; kOtherNumeric
1056 #cjkPrimaryNumeric; kPrimaryNumeric
1057 #cjkCompatibilityVariant; kCompatibilityVariant
1058 #cjkIICore ; kIICore
1059 #cjkIRG_GSource; kIRG_GSource
1060 #cjkIRG_HSource; kIRG_HSource
1061 #cjkIRG_JSource; kIRG_JSource
1062 #cjkIRG_KPSource; kIRG_KPSource
1063 #cjkIRG_KSource; kIRG_KSource
1064 #cjkIRG_TSource; kIRG_TSource
1065 #cjkIRG_USource; kIRG_USource
1066 #cjkIRG_VSource; kIRG_VSource
1067 #cjkRSUnicode; kRSUnicode                ; Unicode_Radical_Stroke; URS
1068 END
1069
1070 # Similarly for the property values.  For your convenience, the lines in the
1071 # 6.0 PropertyAliases.txt file are listed.  Just remove the first BUT NOT both
1072 # '#' marks (for Unicode versions before 5.2)
1073 my @cjk_property_values = split "\n", <<'END';
1074 ## @missing: 0000..10FFFF; cjkAccountingNumeric; NaN
1075 ## @missing: 0000..10FFFF; cjkCompatibilityVariant; <code point>
1076 ## @missing: 0000..10FFFF; cjkIICore; <none>
1077 ## @missing: 0000..10FFFF; cjkIRG_GSource; <none>
1078 ## @missing: 0000..10FFFF; cjkIRG_HSource; <none>
1079 ## @missing: 0000..10FFFF; cjkIRG_JSource; <none>
1080 ## @missing: 0000..10FFFF; cjkIRG_KPSource; <none>
1081 ## @missing: 0000..10FFFF; cjkIRG_KSource; <none>
1082 ## @missing: 0000..10FFFF; cjkIRG_TSource; <none>
1083 ## @missing: 0000..10FFFF; cjkIRG_USource; <none>
1084 ## @missing: 0000..10FFFF; cjkIRG_VSource; <none>
1085 ## @missing: 0000..10FFFF; cjkOtherNumeric; NaN
1086 ## @missing: 0000..10FFFF; cjkPrimaryNumeric; NaN
1087 ## @missing: 0000..10FFFF; cjkRSUnicode; <none>
1088 END
1089
1090 # The input files don't list every code point.  Those not listed are to be
1091 # defaulted to some value.  Below are hard-coded what those values are for
1092 # non-binary properties as of 5.1.  Starting in 5.0, there are
1093 # machine-parsable comment lines in the files that give the defaults; so this
1094 # list shouldn't have to be extended.  The claim is that all missing entries
1095 # for binary properties will default to 'N'.  Unicode tried to change that in
1096 # 5.2, but the beta period produced enough protest that they backed off.
1097 #
1098 # The defaults for the fields that appear in UnicodeData.txt in this hash must
1099 # be in the form that it expects.  The others may be synonyms.
1100 my $CODE_POINT = '<code point>';
1101 my %default_mapping = (
1102     Age => "Unassigned",
1103     # Bidi_Class => Complicated; set in code
1104     Bidi_Mirroring_Glyph => "",
1105     Block => 'No_Block',
1106     Canonical_Combining_Class => 0,
1107     Case_Folding => $CODE_POINT,
1108     Decomposition_Mapping => $CODE_POINT,
1109     Decomposition_Type => 'None',
1110     East_Asian_Width => "Neutral",
1111     FC_NFKC_Closure => $CODE_POINT,
1112     General_Category => 'Cn',
1113     Grapheme_Cluster_Break => 'Other',
1114     Hangul_Syllable_Type => 'NA',
1115     ISO_Comment => "",
1116     Jamo_Short_Name => "",
1117     Joining_Group => "No_Joining_Group",
1118     # Joining_Type => Complicated; set in code
1119     kIICore => 'N',   #                       Is converted to binary
1120     #Line_Break => Complicated; set in code
1121     Lowercase_Mapping => $CODE_POINT,
1122     Name => "",
1123     Name_Alias => "",
1124     NFC_QC => 'Yes',
1125     NFD_QC => 'Yes',
1126     NFKC_QC => 'Yes',
1127     NFKD_QC => 'Yes',
1128     Numeric_Type => 'None',
1129     Numeric_Value => 'NaN',
1130     Script => ($v_version le 4.1.0) ? 'Common' : 'Unknown',
1131     Sentence_Break => 'Other',
1132     Simple_Case_Folding => $CODE_POINT,
1133     Simple_Lowercase_Mapping => $CODE_POINT,
1134     Simple_Titlecase_Mapping => $CODE_POINT,
1135     Simple_Uppercase_Mapping => $CODE_POINT,
1136     Titlecase_Mapping => $CODE_POINT,
1137     Unicode_1_Name => "",
1138     Unicode_Radical_Stroke => "",
1139     Uppercase_Mapping => $CODE_POINT,
1140     Word_Break => 'Other',
1141 );
1142
1143 # Below are files that Unicode furnishes, but this program ignores, and why.
1144 # NormalizationCorrections.txt requires some more explanation.  It documents
1145 # the cumulative fixes to erroneous normalizations in earlier Unicode
1146 # versions.  Its main purpose is so that someone running on an earlier version
1147 # can use this file to override what got published in that earlier release.
1148 # It would be easy for mktables to read and handle this file.  But all the
1149 # corrections in it should already be in the other files for the release it
1150 # is.  To get it to actually mean something useful, someone would have to be
1151 # using an earlier Unicode release, and copy it to the files for that release
1152 # and recomplile.  So far there has been no demand to do that, so this hasn't
1153 # been implemented.
1154 my %ignored_files = (
1155     'CJKRadicals.txt' => 'Maps the kRSUnicode property values to corresponding code points',
1156     'Index.txt' => 'Alphabetical index of Unicode characters',
1157     'NamedSqProv.txt' => 'Named sequences proposed for inclusion in a later version of the Unicode Standard; if you need them now, you can append this file to F<NamedSequences.txt> and recompile perl',
1158     'NamesList.txt' => 'Annotated list of characters',
1159     'NamesList.html' => 'Describes the format and contents of F<NamesList.txt>',
1160     'NormalizationCorrections.txt' => 'Documentation of corrections already incorporated into the Unicode data base',
1161     'Props.txt' => 'Only in very early releases; is a subset of F<PropList.txt> (which is used instead)',
1162     'ReadMe.txt' => 'Documentation',
1163     'StandardizedVariants.txt' => 'Certain glyph variations for character display are standardized.  This lists the non-Unihan ones; the Unihan ones are also not used by Perl, and are in a separate Unicode data base L<http://www.unicode.org/ivd>',
1164     'StandardizedVariants.html' => 'Provides a visual display of the standard variant sequences derived from F<StandardizedVariants.txt>.',
1165     'EmojiSources.txt' => 'Maps certain Unicode code points to their legacy Japanese cell-phone values',
1166     'USourceData.txt' => 'Documentation of status and cross reference of proposals for encoding by Unicode of Unihan characters',
1167     'USourceGlyphs.pdf' => 'Pictures of the characters in F<USourceData.txt>',
1168     'auxiliary/WordBreakTest.html' => 'Documentation of validation tests',
1169     'auxiliary/SentenceBreakTest.html' => 'Documentation of validation tests',
1170     'auxiliary/GraphemeBreakTest.html' => 'Documentation of validation tests',
1171     'auxiliary/LineBreakTest.html' => 'Documentation of validation tests',
1172 );
1173
1174 my %skipped_files;  # List of files that we skip
1175
1176 ### End of externally interesting definitions, except for @input_file_objects
1177
1178 my $HEADER=<<"EOF";
1179 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
1180 # This file is machine-generated by $0 from the Unicode
1181 # database, Version $string_version.  Any changes made here will be lost!
1182 EOF
1183
1184 my $INTERNAL_ONLY_HEADER = <<"EOF";
1185
1186 # !!!!!!!   INTERNAL PERL USE ONLY   !!!!!!!
1187 # This file is for internal use by core Perl only.  The format and even the
1188 # name or existence of this file are subject to change without notice.  Don't
1189 # use it directly.  Use Unicode::UCD to access the Unicode character data
1190 # base.
1191 EOF
1192
1193 my $DEVELOPMENT_ONLY=<<"EOF";
1194 # !!!!!!!   DEVELOPMENT USE ONLY   !!!!!!!
1195 # This file contains information artificially constrained to code points
1196 # present in Unicode release $string_compare_versions.
1197 # IT CANNOT BE RELIED ON.  It is for use during development only and should
1198 # not be used for production.
1199
1200 EOF
1201
1202 my $MAX_UNICODE_CODEPOINT_STRING = ($v_version ge v2.0.0)
1203                                    ? "10FFFF"
1204                                    : "FFFF";
1205 my $MAX_UNICODE_CODEPOINT = hex $MAX_UNICODE_CODEPOINT_STRING;
1206 my $MAX_UNICODE_CODEPOINTS = $MAX_UNICODE_CODEPOINT + 1;
1207
1208 # We work with above-Unicode code points, up to UV_MAX.   But when you get
1209 # that high, above IV_MAX, some operations don't work, and you can easily get
1210 # overflow.  Therefore for internal use, we use a much smaller number,
1211 # translating it to UV_MAX only for output.  The exact number is immaterial
1212 # (all Unicode code points are treated exactly the same), but the algorithm
1213 # requires it to be at least 2 * $MAX_UNICODE_CODEPOINTS + 1;
1214 my $MAX_WORKING_CODEPOINTS= $MAX_UNICODE_CODEPOINT * 8;
1215 my $MAX_WORKING_CODEPOINT = $MAX_WORKING_CODEPOINTS - 1;
1216 my $MAX_WORKING_CODEPOINT_STRING = sprintf("%X", $MAX_WORKING_CODEPOINT);
1217
1218 my $MAX_PLATFORM_CODEPOINT = ~0;
1219
1220 # Matches legal code point.  4-6 hex numbers, If there are 6, the first
1221 # two must be 10; if there are 5, the first must not be a 0.  Written this way
1222 # to decrease backtracking.  The first regex allows the code point to be at
1223 # the end of a word, but to work properly, the word shouldn't end with a valid
1224 # hex character.  The second one won't match a code point at the end of a
1225 # word, and doesn't have the run-on issue
1226 my $run_on_code_point_re =
1227             qr/ (?: 10[0-9A-F]{4} | [1-9A-F][0-9A-F]{4} | [0-9A-F]{4} ) \b/x;
1228 my $code_point_re = qr/\b$run_on_code_point_re/;
1229
1230 # This matches the beginning of the line in the Unicode db files that give the
1231 # defaults for code points not listed (i.e., missing) in the file.  The code
1232 # depends on this ending with a semi-colon, so it can assume it is a valid
1233 # field when the line is split() by semi-colons
1234 my $missing_defaults_prefix = qr/^#\s+\@missing:\s+0000\.\.10FFFF\s*;/;
1235
1236 # Property types.  Unicode has more types, but these are sufficient for our
1237 # purposes.
1238 my $UNKNOWN = -1;   # initialized to illegal value
1239 my $NON_STRING = 1; # Either binary or enum
1240 my $BINARY = 2;
1241 my $FORCED_BINARY = 3; # Not a binary property, but, besides its normal
1242                        # tables, additional true and false tables are
1243                        # generated so that false is anything matching the
1244                        # default value, and true is everything else.
1245 my $ENUM = 4;       # Include catalog
1246 my $STRING = 5;     # Anything else: string or misc
1247
1248 # Some input files have lines that give default values for code points not
1249 # contained in the file.  Sometimes these should be ignored.
1250 my $NO_DEFAULTS = 0;        # Must evaluate to false
1251 my $NOT_IGNORED = 1;
1252 my $IGNORED = 2;
1253
1254 # Range types.  Each range has a type.  Most ranges are type 0, for normal,
1255 # and will appear in the main body of the tables in the output files, but
1256 # there are other types of ranges as well, listed below, that are specially
1257 # handled.   There are pseudo-types as well that will never be stored as a
1258 # type, but will affect the calculation of the type.
1259
1260 # 0 is for normal, non-specials
1261 my $MULTI_CP = 1;           # Sequence of more than code point
1262 my $HANGUL_SYLLABLE = 2;
1263 my $CP_IN_NAME = 3;         # The NAME contains the code point appended to it.
1264 my $NULL = 4;               # The map is to the null string; utf8.c can't
1265                             # handle these, nor is there an accepted syntax
1266                             # for them in \p{} constructs
1267 my $COMPUTE_NO_MULTI_CP = 5; # Pseudo-type; means that ranges that would
1268                              # otherwise be $MULTI_CP type are instead type 0
1269
1270 # process_generic_property_file() can accept certain overrides in its input.
1271 # Each of these must begin AND end with $CMD_DELIM.
1272 my $CMD_DELIM = "\a";
1273 my $REPLACE_CMD = 'replace';    # Override the Replace
1274 my $MAP_TYPE_CMD = 'map_type';  # Override the Type
1275
1276 my $NO = 0;
1277 my $YES = 1;
1278
1279 # Values for the Replace argument to add_range.
1280 # $NO                      # Don't replace; add only the code points not
1281                            # already present.
1282 my $IF_NOT_EQUIVALENT = 1; # Replace only under certain conditions; details in
1283                            # the comments at the subroutine definition.
1284 my $UNCONDITIONALLY = 2;   # Replace without conditions.
1285 my $MULTIPLE_BEFORE = 4;   # Don't replace, but add a duplicate record if
1286                            # already there
1287 my $MULTIPLE_AFTER = 5;    # Don't replace, but add a duplicate record if
1288                            # already there
1289 my $CROAK = 6;             # Die with an error if is already there
1290
1291 # Flags to give property statuses.  The phrases are to remind maintainers that
1292 # if the flag is changed, the indefinite article referring to it in the
1293 # documentation may need to be as well.
1294 my $NORMAL = "";
1295 my $DEPRECATED = 'D';
1296 my $a_bold_deprecated = "a 'B<$DEPRECATED>'";
1297 my $A_bold_deprecated = "A 'B<$DEPRECATED>'";
1298 my $DISCOURAGED = 'X';
1299 my $a_bold_discouraged = "an 'B<$DISCOURAGED>'";
1300 my $A_bold_discouraged = "An 'B<$DISCOURAGED>'";
1301 my $STRICTER = 'T';
1302 my $a_bold_stricter = "a 'B<$STRICTER>'";
1303 my $A_bold_stricter = "A 'B<$STRICTER>'";
1304 my $STABILIZED = 'S';
1305 my $a_bold_stabilized = "an 'B<$STABILIZED>'";
1306 my $A_bold_stabilized = "An 'B<$STABILIZED>'";
1307 my $OBSOLETE = 'O';
1308 my $a_bold_obsolete = "an 'B<$OBSOLETE>'";
1309 my $A_bold_obsolete = "An 'B<$OBSOLETE>'";
1310
1311 my %status_past_participles = (
1312     $DISCOURAGED => 'discouraged',
1313     $STABILIZED => 'stabilized',
1314     $OBSOLETE => 'obsolete',
1315     $DEPRECATED => 'deprecated',
1316 );
1317
1318 # Table fates.  These are somewhat ordered, so that fates < $MAP_PROXIED should be
1319 # externally documented.
1320 my $ORDINARY = 0;       # The normal fate.
1321 my $MAP_PROXIED = 1;    # The map table for the property isn't written out,
1322                         # but there is a file written that can be used to
1323                         # reconstruct this table
1324 my $INTERNAL_ONLY = 2;  # The file for this table is written out, but it is
1325                         # for Perl's internal use only
1326 my $LEGACY_ONLY = 3;    # Like $INTERNAL_ONLY, but not actually used by Perl.
1327                         # Is for backwards compatibility for applications that
1328                         # read the file directly, so it's format is
1329                         # unchangeable.
1330 my $SUPPRESSED = 4;     # The file for this table is not written out, and as a
1331                         # result, we don't bother to do many computations on
1332                         # it.
1333 my $PLACEHOLDER = 5;    # Like $SUPPRESSED, but we go through all the
1334                         # computations anyway, as the values are needed for
1335                         # things to work.  This happens when we have Perl
1336                         # extensions that depend on Unicode tables that
1337                         # wouldn't normally be in a given Unicode version.
1338
1339 # The format of the values of the tables:
1340 my $EMPTY_FORMAT = "";
1341 my $BINARY_FORMAT = 'b';
1342 my $DECIMAL_FORMAT = 'd';
1343 my $FLOAT_FORMAT = 'f';
1344 my $INTEGER_FORMAT = 'i';
1345 my $HEX_FORMAT = 'x';
1346 my $RATIONAL_FORMAT = 'r';
1347 my $STRING_FORMAT = 's';
1348 my $ADJUST_FORMAT = 'a';
1349 my $HEX_ADJUST_FORMAT = 'ax';
1350 my $DECOMP_STRING_FORMAT = 'c';
1351 my $STRING_WHITE_SPACE_LIST = 'sw';
1352
1353 my %map_table_formats = (
1354     $BINARY_FORMAT => 'binary',
1355     $DECIMAL_FORMAT => 'single decimal digit',
1356     $FLOAT_FORMAT => 'floating point number',
1357     $INTEGER_FORMAT => 'integer',
1358     $HEX_FORMAT => 'non-negative hex whole number; a code point',
1359     $RATIONAL_FORMAT => 'rational: an integer or a fraction',
1360     $STRING_FORMAT => 'string',
1361     $ADJUST_FORMAT => 'some entries need adjustment',
1362     $HEX_ADJUST_FORMAT => 'mapped value in hex; some entries need adjustment',
1363     $DECOMP_STRING_FORMAT => 'Perl\'s internal (Normalize.pm) decomposition mapping',
1364     $STRING_WHITE_SPACE_LIST => 'string, but some elements are interpreted as a list; white space occurs only as list item separators'
1365 );
1366
1367 # Unicode didn't put such derived files in a separate directory at first.
1368 my $EXTRACTED_DIR = (-d 'extracted') ? 'extracted' : "";
1369 my $EXTRACTED = ($EXTRACTED_DIR) ? "$EXTRACTED_DIR/" : "";
1370 my $AUXILIARY = 'auxiliary';
1371
1372 # Hashes and arrays that will eventually go into Heavy.pl for the use of
1373 # utf8_heavy.pl and into UCD.pl for the use of UCD.pm
1374 my %loose_to_file_of;       # loosely maps table names to their respective
1375                             # files
1376 my %stricter_to_file_of;    # same; but for stricter mapping.
1377 my %loose_property_to_file_of; # Maps a loose property name to its map file
1378 my @inline_definitions = "V0"; # Each element gives a definition of a unique
1379                             # inversion list.  When a definition is inlined,
1380                             # its value in the hash it's in (one of the two
1381                             # defined just above) will include an index into
1382                             # this array.  The 0th element is initialized to
1383                             # the definition for a zero length invwersion list
1384 my %file_to_swash_name;     # Maps the file name to its corresponding key name
1385                             # in the hash %utf8::SwashInfo
1386 my %nv_floating_to_rational; # maps numeric values floating point numbers to
1387                              # their rational equivalent
1388 my %loose_property_name_of; # Loosely maps (non_string) property names to
1389                             # standard form
1390 my %string_property_loose_to_name; # Same, for string properties.
1391 my %loose_defaults;         # keys are of form "prop=value", where 'prop' is
1392                             # the property name in standard loose form, and
1393                             # 'value' is the default value for that property,
1394                             # also in standard loose form.
1395 my %loose_to_standard_value; # loosely maps table names to the canonical
1396                             # alias for them
1397 my %ambiguous_names;        # keys are alias names (in standard form) that
1398                             # have more than one possible meaning.
1399 my %prop_aliases;           # Keys are standard property name; values are each
1400                             # one's aliases
1401 my %prop_value_aliases;     # Keys of top level are standard property name;
1402                             # values are keys to another hash,  Each one is
1403                             # one of the property's values, in standard form.
1404                             # The values are that prop-val's aliases.
1405 my %ucd_pod;    # Holds entries that will go into the UCD section of the pod
1406
1407 # Most properties are immune to caseless matching, otherwise you would get
1408 # nonsensical results, as properties are a function of a code point, not
1409 # everything that is caselessly equivalent to that code point.  For example,
1410 # Changes_When_Case_Folded('s') should be false, whereas caselessly it would
1411 # be true because 's' and 'S' are equivalent caselessly.  However,
1412 # traditionally, [:upper:] and [:lower:] are equivalent caselessly, so we
1413 # extend that concept to those very few properties that are like this.  Each
1414 # such property will match the full range caselessly.  They are hard-coded in
1415 # the program; it's not worth trying to make it general as it's extremely
1416 # unlikely that they will ever change.
1417 my %caseless_equivalent_to;
1418
1419 # These constants names and values were taken from the Unicode standard,
1420 # version 5.1, section 3.12.  They are used in conjunction with Hangul
1421 # syllables.  The '_string' versions are so generated tables can retain the
1422 # hex format, which is the more familiar value
1423 my $SBase_string = "0xAC00";
1424 my $SBase = CORE::hex $SBase_string;
1425 my $LBase_string = "0x1100";
1426 my $LBase = CORE::hex $LBase_string;
1427 my $VBase_string = "0x1161";
1428 my $VBase = CORE::hex $VBase_string;
1429 my $TBase_string = "0x11A7";
1430 my $TBase = CORE::hex $TBase_string;
1431 my $SCount = 11172;
1432 my $LCount = 19;
1433 my $VCount = 21;
1434 my $TCount = 28;
1435 my $NCount = $VCount * $TCount;
1436
1437 # For Hangul syllables;  These store the numbers from Jamo.txt in conjunction
1438 # with the above published constants.
1439 my %Jamo;
1440 my %Jamo_L;     # Leading consonants
1441 my %Jamo_V;     # Vowels
1442 my %Jamo_T;     # Trailing consonants
1443
1444 # For code points whose name contains its ordinal as a '-ABCD' suffix.
1445 # The key is the base name of the code point, and the value is an
1446 # array giving all the ranges that use this base name.  Each range
1447 # is actually a hash giving the 'low' and 'high' values of it.
1448 my %names_ending_in_code_point;
1449 my %loose_names_ending_in_code_point;   # Same as above, but has blanks, dashes
1450                                         # removed from the names
1451 # Inverse mapping.  The list of ranges that have these kinds of
1452 # names.  Each element contains the low, high, and base names in an
1453 # anonymous hash.
1454 my @code_points_ending_in_code_point;
1455
1456 # To hold Unicode's normalization test suite
1457 my @normalization_tests;
1458
1459 # Boolean: does this Unicode version have the hangul syllables, and are we
1460 # writing out a table for them?
1461 my $has_hangul_syllables = 0;
1462
1463 # Does this Unicode version have code points whose names end in their
1464 # respective code points, and are we writing out a table for them?  0 for no;
1465 # otherwise points to first property that a table is needed for them, so that
1466 # if multiple tables are needed, we don't create duplicates
1467 my $needing_code_points_ending_in_code_point = 0;
1468
1469 my @backslash_X_tests;     # List of tests read in for testing \X
1470 my @SB_tests;              # List of tests read in for testing \b{sb}
1471 my @WB_tests;              # List of tests read in for testing \b{wb}
1472 my @unhandled_properties;  # Will contain a list of properties found in
1473                            # the input that we didn't process.
1474 my @match_properties;      # Properties that have match tables, to be
1475                            # listed in the pod
1476 my @map_properties;        # Properties that get map files written
1477 my @named_sequences;       # NamedSequences.txt contents.
1478 my %potential_files;       # Generated list of all .txt files in the directory
1479                            # structure so we can warn if something is being
1480                            # ignored.
1481 my @files_actually_output; # List of files we generated.
1482 my @more_Names;            # Some code point names are compound; this is used
1483                            # to store the extra components of them.
1484 my $MIN_FRACTION_LENGTH = 3; # How many digits of a floating point number at
1485                            # the minimum before we consider it equivalent to a
1486                            # candidate rational
1487 my $MAX_FLOATING_SLOP = 10 ** - $MIN_FRACTION_LENGTH; # And in floating terms
1488
1489 # These store references to certain commonly used property objects
1490 my $ccc;
1491 my $gc;
1492 my $perl;
1493 my $block;
1494 my $perl_charname;
1495 my $print;
1496 my $All;
1497 my $Assigned;   # All assigned characters in this Unicode release
1498 my $script;
1499
1500 # Are there conflicting names because of beginning with 'In_', or 'Is_'
1501 my $has_In_conflicts = 0;
1502 my $has_Is_conflicts = 0;
1503
1504 sub internal_file_to_platform ($) {
1505     # Convert our file paths which have '/' separators to those of the
1506     # platform.
1507
1508     my $file = shift;
1509     return undef unless defined $file;
1510
1511     return File::Spec->join(split '/', $file);
1512 }
1513
1514 sub file_exists ($) {   # platform independent '-e'.  This program internally
1515                         # uses slash as a path separator.
1516     my $file = shift;
1517     return 0 if ! defined $file;
1518     return -e internal_file_to_platform($file);
1519 }
1520
1521 sub objaddr($) {
1522     # Returns the address of the blessed input object.
1523     # It doesn't check for blessedness because that would do a string eval
1524     # every call, and the program is structured so that this is never called
1525     # for a non-blessed object.
1526
1527     no overloading; # If overloaded, numifying below won't work.
1528
1529     # Numifying a ref gives its address.
1530     return pack 'J', $_[0];
1531 }
1532
1533 # These are used only if $annotate is true.
1534 # The entire range of Unicode characters is examined to populate these
1535 # after all the input has been processed.  But most can be skipped, as they
1536 # have the same descriptive phrases, such as being unassigned
1537 my @viacode;            # Contains the 1 million character names
1538 my @printable;          # boolean: And are those characters printable?
1539 my @annotate_char_type; # Contains a type of those characters, specifically
1540                         # for the purposes of annotation.
1541 my $annotate_ranges;    # A map of ranges of code points that have the same
1542                         # name for the purposes of annotation.  They map to the
1543                         # upper edge of the range, so that the end point can
1544                         # be immediately found.  This is used to skip ahead to
1545                         # the end of a range, and avoid processing each
1546                         # individual code point in it.
1547 my $unassigned_sans_noncharacters; # A Range_List of the unassigned
1548                                    # characters, but excluding those which are
1549                                    # also noncharacter code points
1550
1551 # The annotation types are an extension of the regular range types, though
1552 # some of the latter are folded into one.  Make the new types negative to
1553 # avoid conflicting with the regular types
1554 my $SURROGATE_TYPE = -1;
1555 my $UNASSIGNED_TYPE = -2;
1556 my $PRIVATE_USE_TYPE = -3;
1557 my $NONCHARACTER_TYPE = -4;
1558 my $CONTROL_TYPE = -5;
1559 my $ABOVE_UNICODE_TYPE = -6;
1560 my $UNKNOWN_TYPE = -7;  # Used only if there is a bug in this program
1561
1562 sub populate_char_info ($) {
1563     # Used only with the $annotate option.  Populates the arrays with the
1564     # input code point's info that are needed for outputting more detailed
1565     # comments.  If calling context wants a return, it is the end point of
1566     # any contiguous range of characters that share essentially the same info
1567
1568     my $i = shift;
1569     Carp::carp_extra_args(\@_) if main::DEBUG && @_;
1570
1571     $viacode[$i] = $perl_charname->value_of($i) || "";
1572
1573     # A character is generally printable if Unicode says it is,
1574     # but below we make sure that most Unicode general category 'C' types
1575     # aren't.
1576     $printable[$i] = $print->contains($i);
1577
1578     $annotate_char_type[$i] = $perl_charname->type_of($i) || 0;
1579
1580     # Only these two regular types are treated specially for annotations
1581     # purposes
1582     $annotate_char_type[$i] = 0 if $annotate_char_type[$i] != $CP_IN_NAME
1583                                 && $annotate_char_type[$i] != $HANGUL_SYLLABLE;
1584
1585     # Give a generic name to all code points that don't have a real name.
1586     # We output ranges, if applicable, for these.  Also calculate the end
1587     # point of the range.
1588     my $end;
1589     if (! $viacode[$i]) {
1590         my $nonchar;
1591         if ($i > $MAX_UNICODE_CODEPOINT) {
1592             $viacode[$i] = 'Above-Unicode';
1593             $annotate_char_type[$i] = $ABOVE_UNICODE_TYPE;
1594             $printable[$i] = 0;
1595             $end = $MAX_WORKING_CODEPOINT;
1596         }
1597         elsif ($gc-> table('Private_use')->contains($i)) {
1598             $viacode[$i] = 'Private Use';
1599             $annotate_char_type[$i] = $PRIVATE_USE_TYPE;
1600             $printable[$i] = 0;
1601             $end = $gc->table('Private_Use')->containing_range($i)->end;
1602         }
1603         elsif ((defined ($nonchar =
1604                             Property::property_ref('Noncharacter_Code_Point'))
1605                && $nonchar->table('Y')->contains($i)))
1606         {
1607             $viacode[$i] = 'Noncharacter';
1608             $annotate_char_type[$i] = $NONCHARACTER_TYPE;
1609             $printable[$i] = 0;
1610             $end = property_ref('Noncharacter_Code_Point')->table('Y')->
1611                                                     containing_range($i)->end;
1612         }
1613         elsif ($gc-> table('Control')->contains($i)) {
1614             $viacode[$i] = property_ref('Name_Alias')->value_of($i) || 'Control';
1615             $annotate_char_type[$i] = $CONTROL_TYPE;
1616             $printable[$i] = 0;
1617         }
1618         elsif ($gc-> table('Unassigned')->contains($i)) {
1619             $annotate_char_type[$i] = $UNASSIGNED_TYPE;
1620             $printable[$i] = 0;
1621             if ($v_version lt v2.0.0) { # No blocks in earliest releases
1622                 $viacode[$i] = 'Unassigned';
1623                 $end = $gc-> table('Unassigned')->containing_range($i)->end;
1624             }
1625             else {
1626                 $viacode[$i] = 'Unassigned, block=' . $block-> value_of($i);
1627
1628                 # Because we name the unassigned by the blocks they are in, it
1629                 # can't go past the end of that block, and it also can't go
1630                 # past the unassigned range it is in.  The special table makes
1631                 # sure that the non-characters, which are unassigned, are
1632                 # separated out.
1633                 $end = min($block->containing_range($i)->end,
1634                            $unassigned_sans_noncharacters->
1635                                                     containing_range($i)->end);
1636             }
1637         }
1638         elsif ($v_version lt v2.0.0) {  # No surrogates in earliest releases
1639             $viacode[$i] = $gc->value_of($i);
1640             $annotate_char_type[$i] = $UNKNOWN_TYPE;
1641             $printable[$i] = 0;
1642         }
1643         elsif ($gc-> table('Surrogate')->contains($i)) {
1644             $viacode[$i] = 'Surrogate';
1645             $annotate_char_type[$i] = $SURROGATE_TYPE;
1646             $printable[$i] = 0;
1647             $end = $gc->table('Surrogate')->containing_range($i)->end;
1648         }
1649         else {
1650             Carp::my_carp_bug("Can't figure out how to annotate "
1651                               . sprintf("U+%04X", $i)
1652                               . ".  Proceeding anyway.");
1653             $viacode[$i] = 'UNKNOWN';
1654             $annotate_char_type[$i] = $UNKNOWN_TYPE;
1655             $printable[$i] = 0;
1656         }
1657     }
1658
1659     # Here, has a name, but if it's one in which the code point number is
1660     # appended to the name, do that.
1661     elsif ($annotate_char_type[$i] == $CP_IN_NAME) {
1662         $viacode[$i] .= sprintf("-%04X", $i);
1663         $end = $perl_charname->containing_range($i)->end;
1664     }
1665
1666     # And here, has a name, but if it's a hangul syllable one, replace it with
1667     # the correct name from the Unicode algorithm
1668     elsif ($annotate_char_type[$i] == $HANGUL_SYLLABLE) {
1669         use integer;
1670         my $SIndex = $i - $SBase;
1671         my $L = $LBase + $SIndex / $NCount;
1672         my $V = $VBase + ($SIndex % $NCount) / $TCount;
1673         my $T = $TBase + $SIndex % $TCount;
1674         $viacode[$i] = "HANGUL SYLLABLE $Jamo{$L}$Jamo{$V}";
1675         $viacode[$i] .= $Jamo{$T} if $T != $TBase;
1676         $end = $perl_charname->containing_range($i)->end;
1677     }
1678
1679     return if ! defined wantarray;
1680     return $i if ! defined $end;    # If not a range, return the input
1681
1682     # Save this whole range so can find the end point quickly
1683     $annotate_ranges->add_map($i, $end, $end);
1684
1685     return $end;
1686 }
1687
1688 # Commented code below should work on Perl 5.8.
1689 ## This 'require' doesn't necessarily work in miniperl, and even if it does,
1690 ## the native perl version of it (which is what would operate under miniperl)
1691 ## is extremely slow, as it does a string eval every call.
1692 #my $has_fast_scalar_util = $^X !~ /miniperl/
1693 #                            && defined eval "require Scalar::Util";
1694 #
1695 #sub objaddr($) {
1696 #    # Returns the address of the blessed input object.  Uses the XS version if
1697 #    # available.  It doesn't check for blessedness because that would do a
1698 #    # string eval every call, and the program is structured so that this is
1699 #    # never called for a non-blessed object.
1700 #
1701 #    return Scalar::Util::refaddr($_[0]) if $has_fast_scalar_util;
1702 #
1703 #    # Check at least that is a ref.
1704 #    my $pkg = ref($_[0]) or return undef;
1705 #
1706 #    # Change to a fake package to defeat any overloaded stringify
1707 #    bless $_[0], 'main::Fake';
1708 #
1709 #    # Numifying a ref gives its address.
1710 #    my $addr = pack 'J', $_[0];
1711 #
1712 #    # Return to original class
1713 #    bless $_[0], $pkg;
1714 #    return $addr;
1715 #}
1716
1717 sub max ($$) {
1718     my $a = shift;
1719     my $b = shift;
1720     return $a if $a >= $b;
1721     return $b;
1722 }
1723
1724 sub min ($$) {
1725     my $a = shift;
1726     my $b = shift;
1727     return $a if $a <= $b;
1728     return $b;
1729 }
1730
1731 sub clarify_number ($) {
1732     # This returns the input number with underscores inserted every 3 digits
1733     # in large (5 digits or more) numbers.  Input must be entirely digits, not
1734     # checked.
1735
1736     my $number = shift;
1737     my $pos = length($number) - 3;
1738     return $number if $pos <= 1;
1739     while ($pos > 0) {
1740         substr($number, $pos, 0) = '_';
1741         $pos -= 3;
1742     }
1743     return $number;
1744 }
1745
1746 sub clarify_code_point_count ($) {
1747     # This is like clarify_number(), but the input is assumed to be a count of
1748     # code points, rather than a generic number.
1749
1750     my $append = "";
1751
1752     my $number = shift;
1753     if ($number > $MAX_UNICODE_CODEPOINTS) {
1754         $number -= ($MAX_WORKING_CODEPOINTS - $MAX_UNICODE_CODEPOINTS);
1755         return "All above-Unicode code points" if $number == 0;
1756         $append = " + all above-Unicode code points";
1757     }
1758     return clarify_number($number) . $append;
1759 }
1760
1761 package Carp;
1762
1763 # These routines give a uniform treatment of messages in this program.  They
1764 # are placed in the Carp package to cause the stack trace to not include them,
1765 # although an alternative would be to use another package and set @CARP_NOT
1766 # for it.
1767
1768 our $Verbose = 1 if main::DEBUG;  # Useful info when debugging
1769
1770 # This is a work-around suggested by Nicholas Clark to fix a problem with Carp
1771 # and overload trying to load Scalar:Util under miniperl.  See
1772 # http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-11/msg01057.html
1773 undef $overload::VERSION;
1774
1775 sub my_carp {
1776     my $message = shift || "";
1777     my $nofold = shift || 0;
1778
1779     if ($message) {
1780         $message = main::join_lines($message);
1781         $message =~ s/^$0: *//;     # Remove initial program name
1782         $message =~ s/[.;,]+$//;    # Remove certain ending punctuation
1783         $message = "\n$0: $message;";
1784
1785         # Fold the message with program name, semi-colon end punctuation
1786         # (which looks good with the message that carp appends to it), and a
1787         # hanging indent for continuation lines.
1788         $message = main::simple_fold($message, "", 4) unless $nofold;
1789         $message =~ s/\n$//;        # Remove the trailing nl so what carp
1790                                     # appends is to the same line
1791     }
1792
1793     return $message if defined wantarray;   # If a caller just wants the msg
1794
1795     carp $message;
1796     return;
1797 }
1798
1799 sub my_carp_bug {
1800     # This is called when it is clear that the problem is caused by a bug in
1801     # this program.
1802
1803     my $message = shift;
1804     $message =~ s/^$0: *//;
1805     $message = my_carp("Bug in $0.  Please report it by running perlbug or if that is unavailable, by sending email to perbug\@perl.org:\n$message");
1806     carp $message;
1807     return;
1808 }
1809
1810 sub carp_too_few_args {
1811     if (@_ != 2) {
1812         my_carp_bug("Wrong number of arguments: to 'carp_too_few_arguments'.  No action taken.");
1813         return;
1814     }
1815
1816     my $args_ref = shift;
1817     my $count = shift;
1818
1819     my_carp_bug("Need at least $count arguments to "
1820         . (caller 1)[3]
1821         . ".  Instead got: '"
1822         . join ', ', @$args_ref
1823         . "'.  No action taken.");
1824     return;
1825 }
1826
1827 sub carp_extra_args {
1828     my $args_ref = shift;
1829     my_carp_bug("Too many arguments to 'carp_extra_args': (" . join(', ', @_) . ");  Extras ignored.") if @_;
1830
1831     unless (ref $args_ref) {
1832         my_carp_bug("Argument to 'carp_extra_args' ($args_ref) must be a ref.  Not checking arguments.");
1833         return;
1834     }
1835     my ($package, $file, $line) = caller;
1836     my $subroutine = (caller 1)[3];
1837
1838     my $list;
1839     if (ref $args_ref eq 'HASH') {
1840         foreach my $key (keys %$args_ref) {
1841             $args_ref->{$key} = $UNDEF unless defined $args_ref->{$key};
1842         }
1843         $list = join ', ', each %{$args_ref};
1844     }
1845     elsif (ref $args_ref eq 'ARRAY') {
1846         foreach my $arg (@$args_ref) {
1847             $arg = $UNDEF unless defined $arg;
1848         }
1849         $list = join ', ', @$args_ref;
1850     }
1851     else {
1852         my_carp_bug("Can't cope with ref "
1853                 . ref($args_ref)
1854                 . " . argument to 'carp_extra_args'.  Not checking arguments.");
1855         return;
1856     }
1857
1858     my_carp_bug("Unrecognized parameters in options: '$list' to $subroutine.  Skipped.");
1859     return;
1860 }
1861
1862 package main;
1863
1864 { # Closure
1865
1866     # This program uses the inside-out method for objects, as recommended in
1867     # "Perl Best Practices".  (This is the best solution still, since this has
1868     # to run under miniperl.)  This closure aids in generating those.  There
1869     # are two routines.  setup_package() is called once per package to set
1870     # things up, and then set_access() is called for each hash representing a
1871     # field in the object.  These routines arrange for the object to be
1872     # properly destroyed when no longer used, and for standard accessor
1873     # functions to be generated.  If you need more complex accessors, just
1874     # write your own and leave those accesses out of the call to set_access().
1875     # More details below.
1876
1877     my %constructor_fields; # fields that are to be used in constructors; see
1878                             # below
1879
1880     # The values of this hash will be the package names as keys to other
1881     # hashes containing the name of each field in the package as keys, and
1882     # references to their respective hashes as values.
1883     my %package_fields;
1884
1885     sub setup_package {
1886         # Sets up the package, creating standard DESTROY and dump methods
1887         # (unless already defined).  The dump method is used in debugging by
1888         # simple_dumper().
1889         # The optional parameters are:
1890         #   a)  a reference to a hash, that gets populated by later
1891         #       set_access() calls with one of the accesses being
1892         #       'constructor'.  The caller can then refer to this, but it is
1893         #       not otherwise used by these two routines.
1894         #   b)  a reference to a callback routine to call during destruction
1895         #       of the object, before any fields are actually destroyed
1896
1897         my %args = @_;
1898         my $constructor_ref = delete $args{'Constructor_Fields'};
1899         my $destroy_callback = delete $args{'Destroy_Callback'};
1900         Carp::carp_extra_args(\@_) if main::DEBUG && %args;
1901
1902         my %fields;
1903         my $package = (caller)[0];
1904
1905         $package_fields{$package} = \%fields;
1906         $constructor_fields{$package} = $constructor_ref;
1907
1908         unless ($package->can('DESTROY')) {
1909             my $destroy_name = "${package}::DESTROY";
1910             no strict "refs";
1911
1912             # Use typeglob to give the anonymous subroutine the name we want
1913             *$destroy_name = sub {
1914                 my $self = shift;
1915                 my $addr = do { no overloading; pack 'J', $self; };
1916
1917                 $self->$destroy_callback if $destroy_callback;
1918                 foreach my $field (keys %{$package_fields{$package}}) {
1919                     #print STDERR __LINE__, ": Destroying ", ref $self, " ", sprintf("%04X", $addr), ": ", $field, "\n";
1920                     delete $package_fields{$package}{$field}{$addr};
1921                 }
1922                 return;
1923             }
1924         }
1925
1926         unless ($package->can('dump')) {
1927             my $dump_name = "${package}::dump";
1928             no strict "refs";
1929             *$dump_name = sub {
1930                 my $self = shift;
1931                 return dump_inside_out($self, $package_fields{$package}, @_);
1932             }
1933         }
1934         return;
1935     }
1936
1937     sub set_access {
1938         # Arrange for the input field to be garbage collected when no longer
1939         # needed.  Also, creates standard accessor functions for the field
1940         # based on the optional parameters-- none if none of these parameters:
1941         #   'addable'    creates an 'add_NAME()' accessor function.
1942         #   'readable' or 'readable_array'   creates a 'NAME()' accessor
1943         #                function.
1944         #   'settable'   creates a 'set_NAME()' accessor function.
1945         #   'constructor' doesn't create an accessor function, but adds the
1946         #                field to the hash that was previously passed to
1947         #                setup_package();
1948         # Any of the accesses can be abbreviated down, so that 'a', 'ad',
1949         # 'add' etc. all mean 'addable'.
1950         # The read accessor function will work on both array and scalar
1951         # values.  If another accessor in the parameter list is 'a', the read
1952         # access assumes an array.  You can also force it to be array access
1953         # by specifying 'readable_array' instead of 'readable'
1954         #
1955         # A sort-of 'protected' access can be set-up by preceding the addable,
1956         # readable or settable with some initial portion of 'protected_' (but,
1957         # the underscore is required), like 'p_a', 'pro_set', etc.  The
1958         # "protection" is only by convention.  All that happens is that the
1959         # accessor functions' names begin with an underscore.  So instead of
1960         # calling set_foo, the call is _set_foo.  (Real protection could be
1961         # accomplished by having a new subroutine, end_package, called at the
1962         # end of each package, and then storing the __LINE__ ranges and
1963         # checking them on every accessor.  But that is way overkill.)
1964
1965         # We create anonymous subroutines as the accessors and then use
1966         # typeglobs to assign them to the proper package and name
1967
1968         my $name = shift;   # Name of the field
1969         my $field = shift;  # Reference to the inside-out hash containing the
1970                             # field
1971
1972         my $package = (caller)[0];
1973
1974         if (! exists $package_fields{$package}) {
1975             croak "$0: Must call 'setup_package' before 'set_access'";
1976         }
1977
1978         # Stash the field so DESTROY can get it.
1979         $package_fields{$package}{$name} = $field;
1980
1981         # Remaining arguments are the accessors.  For each...
1982         foreach my $access (@_) {
1983             my $access = lc $access;
1984
1985             my $protected = "";
1986
1987             # Match the input as far as it goes.
1988             if ($access =~ /^(p[^_]*)_/) {
1989                 $protected = $1;
1990                 if (substr('protected_', 0, length $protected)
1991                     eq $protected)
1992                 {
1993
1994                     # Add 1 for the underscore not included in $protected
1995                     $access = substr($access, length($protected) + 1);
1996                     $protected = '_';
1997                 }
1998                 else {
1999                     $protected = "";
2000                 }
2001             }
2002
2003             if (substr('addable', 0, length $access) eq $access) {
2004                 my $subname = "${package}::${protected}add_$name";
2005                 no strict "refs";
2006
2007                 # add_ accessor.  Don't add if already there, which we
2008                 # determine using 'eq' for scalars and '==' otherwise.
2009                 *$subname = sub {
2010                     use strict "refs";
2011                     return Carp::carp_too_few_args(\@_, 2) if main::DEBUG && @_ < 2;
2012                     my $self = shift;
2013                     my $value = shift;
2014                     my $addr = do { no overloading; pack 'J', $self; };
2015                     Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2016                     if (ref $value) {
2017                         return if grep { $value == $_ } @{$field->{$addr}};
2018                     }
2019                     else {
2020                         return if grep { $value eq $_ } @{$field->{$addr}};
2021                     }
2022                     push @{$field->{$addr}}, $value;
2023                     return;
2024                 }
2025             }
2026             elsif (substr('constructor', 0, length $access) eq $access) {
2027                 if ($protected) {
2028                     Carp::my_carp_bug("Can't set-up 'protected' constructors")
2029                 }
2030                 else {
2031                     $constructor_fields{$package}{$name} = $field;
2032                 }
2033             }
2034             elsif (substr('readable_array', 0, length $access) eq $access) {
2035
2036                 # Here has read access.  If one of the other parameters for
2037                 # access is array, or this one specifies array (by being more
2038                 # than just 'readable_'), then create a subroutine that
2039                 # assumes the data is an array.  Otherwise just a scalar
2040                 my $subname = "${package}::${protected}$name";
2041                 if (grep { /^a/i } @_
2042                     or length($access) > length('readable_'))
2043                 {
2044                     no strict "refs";
2045                     *$subname = sub {
2046                         use strict "refs";
2047                         Carp::carp_extra_args(\@_) if main::DEBUG && @_ > 1;
2048                         my $addr = do { no overloading; pack 'J', $_[0]; };
2049                         if (ref $field->{$addr} ne 'ARRAY') {
2050                             my $type = ref $field->{$addr};
2051                             $type = 'scalar' unless $type;
2052                             Carp::my_carp_bug("Trying to read $name as an array when it is a $type.  Big problems.");
2053                             return;
2054                         }
2055                         return scalar @{$field->{$addr}} unless wantarray;
2056
2057                         # Make a copy; had problems with caller modifying the
2058                         # original otherwise
2059                         my @return = @{$field->{$addr}};
2060                         return @return;
2061                     }
2062                 }
2063                 else {
2064
2065                     # Here not an array value, a simpler function.
2066                     no strict "refs";
2067                     *$subname = sub {
2068                         use strict "refs";
2069                         Carp::carp_extra_args(\@_) if main::DEBUG && @_ > 1;
2070                         no overloading;
2071                         return $field->{pack 'J', $_[0]};
2072                     }
2073                 }
2074             }
2075             elsif (substr('settable', 0, length $access) eq $access) {
2076                 my $subname = "${package}::${protected}set_$name";
2077                 no strict "refs";
2078                 *$subname = sub {
2079                     use strict "refs";
2080                     if (main::DEBUG) {
2081                         return Carp::carp_too_few_args(\@_, 2) if @_ < 2;
2082                         Carp::carp_extra_args(\@_) if @_ > 2;
2083                     }
2084                     # $self is $_[0]; $value is $_[1]
2085                     no overloading;
2086                     $field->{pack 'J', $_[0]} = $_[1];
2087                     return;
2088                 }
2089             }
2090             else {
2091                 Carp::my_carp_bug("Unknown accessor type $access.  No accessor set.");
2092             }
2093         }
2094         return;
2095     }
2096 }
2097
2098 package Input_file;
2099
2100 # All input files use this object, which stores various attributes about them,
2101 # and provides for convenient, uniform handling.  The run method wraps the
2102 # processing.  It handles all the bookkeeping of opening, reading, and closing
2103 # the file, returning only significant input lines.
2104 #
2105 # Each object gets a handler which processes the body of the file, and is
2106 # called by run().  All character property files must use the generic,
2107 # default handler, which has code scrubbed to handle things you might not
2108 # expect, including automatic EBCDIC handling.  For files that don't deal with
2109 # mapping code points to a property value, such as test files,
2110 # PropertyAliases, PropValueAliases, and named sequences, you can override the
2111 # handler to be a custom one.  Such a handler should basically be a
2112 # while(next_line()) {...} loop.
2113 #
2114 # You can also set up handlers to
2115 #   1) call before the first line is read, for pre processing
2116 #   2) call to adjust each line of the input before the main handler gets
2117 #      them.  This can be automatically generated, if appropriately simple
2118 #      enough, by specifiying a Properties parameter in the constructor.
2119 #   3) call upon EOF before the main handler exits its loop
2120 #   4) call at the end, for post processing
2121 #
2122 # $_ is used to store the input line, and is to be filtered by the
2123 # each_line_handler()s.  So, if the format of the line is not in the desired
2124 # format for the main handler, these are used to do that adjusting.  They can
2125 # be stacked (by enclosing them in an [ anonymous array ] in the constructor,
2126 # so the $_ output of one is used as the input to the next.  None of the other
2127 # handlers are stackable, but could easily be changed to be so.
2128 #
2129 # Most of the handlers can call insert_lines() or insert_adjusted_lines()
2130 # which insert the parameters as lines to be processed before the next input
2131 # file line is read.  This allows the EOF handler to flush buffers, for
2132 # example.  The difference between the two routines is that the lines inserted
2133 # by insert_lines() are subjected to the each_line_handler()s.  (So if you
2134 # called it from such a handler, you would get infinite recursion.)  Lines
2135 # inserted by insert_adjusted_lines() go directly to the main handler without
2136 # any adjustments.  If the  post-processing handler calls any of these, there
2137 # will be no effect.  Some error checking for these conditions could be added,
2138 # but it hasn't been done.
2139 #
2140 # carp_bad_line() should be called to warn of bad input lines, which clears $_
2141 # to prevent further processing of the line.  This routine will output the
2142 # message as a warning once, and then keep a count of the lines that have the
2143 # same message, and output that count at the end of the file's processing.
2144 # This keeps the number of messages down to a manageable amount.
2145 #
2146 # get_missings() should be called to retrieve any @missing input lines.
2147 # Messages will be raised if this isn't done if the options aren't to ignore
2148 # missings.
2149
2150 sub trace { return main::trace(@_); }
2151
2152 { # Closure
2153     # Keep track of fields that are to be put into the constructor.
2154     my %constructor_fields;
2155
2156     main::setup_package(Constructor_Fields => \%constructor_fields);
2157
2158     my %file; # Input file name, required
2159     main::set_access('file', \%file, qw{ c r });
2160
2161     my %first_released; # Unicode version file was first released in, required
2162     main::set_access('first_released', \%first_released, qw{ c r });
2163
2164     my %handler;    # Subroutine to process the input file, defaults to
2165                     # 'process_generic_property_file'
2166     main::set_access('handler', \%handler, qw{ c });
2167
2168     my %property;
2169     # name of property this file is for.  defaults to none, meaning not
2170     # applicable, or is otherwise determinable, for example, from each line.
2171     main::set_access('property', \%property, qw{ c r });
2172
2173     my %optional;
2174     # If this is true, the file is optional.  If not present, no warning is
2175     # output.  If it is present, the string given by this parameter is
2176     # evaluated, and if false the file is not processed.
2177     main::set_access('optional', \%optional, 'c', 'r');
2178
2179     my %non_skip;
2180     # This is used for debugging, to skip processing of all but a few input
2181     # files.  Add 'non_skip => 1' to the constructor for those files you want
2182     # processed when you set the $debug_skip global.
2183     main::set_access('non_skip', \%non_skip, 'c');
2184
2185     my %skip;
2186     # This is used to skip processing of this input file semi-permanently,
2187     # when it evaluates to true.  The value should be the reason the file is
2188     # being skipped.  It is used for files that we aren't planning to process
2189     # anytime soon, but want to allow to be in the directory and not raise a
2190     # message that we are not handling.  Mostly for test files.  This is in
2191     # contrast to the non_skip element, which is supposed to be used very
2192     # temporarily for debugging.  Sets 'optional' to 1.  Also, files that we
2193     # pretty much will never look at can be placed in the global
2194     # %ignored_files instead.  Ones used here will be added to %skipped files
2195     main::set_access('skip', \%skip, 'c');
2196
2197     my %each_line_handler;
2198     # list of subroutines to look at and filter each non-comment line in the
2199     # file.  defaults to none.  The subroutines are called in order, each is
2200     # to adjust $_ for the next one, and the final one adjusts it for
2201     # 'handler'
2202     main::set_access('each_line_handler', \%each_line_handler, 'c');
2203
2204     my %properties; # Optional ordered list of the properties that occur in each
2205     # meaningful line of the input file.  If present, an appropriate
2206     # each_line_handler() is automatically generated and pushed onto the stack
2207     # of such handlers.  This is useful when a file contains multiple
2208     # proerties per line, but no other special considerations are necessary.
2209     # The special value "<ignored>" means to discard the corresponding input
2210     # field.
2211     # Any @missing lines in the file should also match this syntax; no such
2212     # files exist as of 6.3.  But if it happens in a future release, the code
2213     # could be expanded to properly parse them.
2214     main::set_access('properties', \%properties, qw{ c r });
2215
2216     my %has_missings_defaults;
2217     # ? Are there lines in the file giving default values for code points
2218     # missing from it?.  Defaults to NO_DEFAULTS.  Otherwise NOT_IGNORED is
2219     # the norm, but IGNORED means it has such lines, but the handler doesn't
2220     # use them.  Having these three states allows us to catch changes to the
2221     # UCD that this program should track.  XXX This could be expanded to
2222     # specify the syntax for such lines, like %properties above.
2223     main::set_access('has_missings_defaults',
2224                                         \%has_missings_defaults, qw{ c r });
2225
2226     my %pre_handler;
2227     # Subroutine to call before doing anything else in the file.  If undef, no
2228     # such handler is called.
2229     main::set_access('pre_handler', \%pre_handler, qw{ c });
2230
2231     my %eof_handler;
2232     # Subroutine to call upon getting an EOF on the input file, but before
2233     # that is returned to the main handler.  This is to allow buffers to be
2234     # flushed.  The handler is expected to call insert_lines() or
2235     # insert_adjusted() with the buffered material
2236     main::set_access('eof_handler', \%eof_handler, qw{ c r });
2237
2238     my %post_handler;
2239     # Subroutine to call after all the lines of the file are read in and
2240     # processed.  If undef, no such handler is called.
2241     main::set_access('post_handler', \%post_handler, qw{ c });
2242
2243     my %progress_message;
2244     # Message to print to display progress in lieu of the standard one
2245     main::set_access('progress_message', \%progress_message, qw{ c });
2246
2247     my %handle;
2248     # cache open file handle, internal.  Is undef if file hasn't been
2249     # processed at all, empty if has;
2250     main::set_access('handle', \%handle);
2251
2252     my %added_lines;
2253     # cache of lines added virtually to the file, internal
2254     main::set_access('added_lines', \%added_lines);
2255
2256     my %remapped_lines;
2257     # cache of lines added virtually to the file, internal
2258     main::set_access('remapped_lines', \%remapped_lines);
2259
2260     my %errors;
2261     # cache of errors found, internal
2262     main::set_access('errors', \%errors);
2263
2264     my %missings;
2265     # storage of '@missing' defaults lines
2266     main::set_access('missings', \%missings);
2267
2268     sub _next_line;
2269     sub _next_line_with_remapped_range;
2270
2271     sub new {
2272         my $class = shift;
2273
2274         my $self = bless \do{ my $anonymous_scalar }, $class;
2275         my $addr = do { no overloading; pack 'J', $self; };
2276
2277         # Set defaults
2278         $handler{$addr} = \&main::process_generic_property_file;
2279         $non_skip{$addr} = 0;
2280         $skip{$addr} = 0;
2281         $has_missings_defaults{$addr} = $NO_DEFAULTS;
2282         $handle{$addr} = undef;
2283         $added_lines{$addr} = [ ];
2284         $remapped_lines{$addr} = [ ];
2285         $each_line_handler{$addr} = [ ];
2286         $errors{$addr} = { };
2287         $missings{$addr} = [ ];
2288
2289         # Two positional parameters.
2290         return Carp::carp_too_few_args(\@_, 2) if main::DEBUG && @_ < 2;
2291         $file{$addr} = main::internal_file_to_platform(shift);
2292         $first_released{$addr} = shift;
2293
2294         undef $file{$addr} if $first_released{$addr} gt $v_version;
2295
2296         # The rest of the arguments are key => value pairs
2297         # %constructor_fields has been set up earlier to list all possible
2298         # ones.  Either set or push, depending on how the default has been set
2299         # up just above.
2300         my %args = @_;
2301         foreach my $key (keys %args) {
2302             my $argument = $args{$key};
2303
2304             # Note that the fields are the lower case of the constructor keys
2305             my $hash = $constructor_fields{lc $key};
2306             if (! defined $hash) {
2307                 Carp::my_carp_bug("Unrecognized parameters '$key => $argument' to new() for $self.  Skipped");
2308                 next;
2309             }
2310             if (ref $hash->{$addr} eq 'ARRAY') {
2311                 if (ref $argument eq 'ARRAY') {
2312                     foreach my $argument (@{$argument}) {
2313                         next if ! defined $argument;
2314                         push @{$hash->{$addr}}, $argument;
2315                     }
2316                 }
2317                 else {
2318                     push @{$hash->{$addr}}, $argument if defined $argument;
2319                 }
2320             }
2321             else {
2322                 $hash->{$addr} = $argument;
2323             }
2324             delete $args{$key};
2325         };
2326
2327         # If the file has a property for it, it means that the property is not
2328         # listed in the file's entries.  So add a handler to the list of line
2329         # handlers to insert the property name into the lines, to provide a
2330         # uniform interface to the final processing subroutine.
2331         # the final code doesn't have to worry about that.
2332         if ($property{$addr}) {
2333             push @{$each_line_handler{$addr}}, \&_insert_property_into_line;
2334         }
2335
2336         if ($non_skip{$addr} && ! $debug_skip && $verbosity) {
2337             print "Warning: " . __PACKAGE__ . " constructor for $file{$addr} has useless 'non_skip' in it\n";
2338         }
2339
2340         # If skipping, set to optional, and add to list of ignored files,
2341         # including its reason
2342         if ($skip{$addr}) {
2343             $optional{$addr} = 1;
2344             $skipped_files{$file{$addr}} = $skip{$addr} if $file{$addr};
2345         }
2346         elsif ($properties{$addr}) {
2347
2348             # Add a handler for each line in the input so that it creates a
2349             # separate input line for each property in those input lines, thus
2350             # making them suitable for process_generic_property_file().
2351
2352             push @{$each_line_handler{$addr}},
2353                  sub {
2354                     my $file = shift;
2355                     Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2356
2357                     my @fields = split /\s*;\s*/, $_, -1;
2358
2359                     if (@fields - 1 > @{$properties{$addr}}) {
2360                         $file->carp_bad_line('Extra fields');
2361                         $_ = "";
2362                         return;
2363                     }
2364                     my $range = shift @fields;  # 0th element is always the
2365                                                 # range
2366
2367                     # The next fields in the input line correspond
2368                     # respectively to the stored properties.
2369                     for my $i (0 ..  @{$properties{$addr}} - 1) {
2370                         my $property_name = $properties{$addr}[$i];
2371                         next if $property_name eq '<ignored>';
2372                         $file->insert_adjusted_lines(
2373                               "$range; $property_name; $fields[$i]");
2374                     }
2375                     $_ = "";
2376
2377                     return;
2378                 };
2379         }
2380
2381         {   # On non-ascii platforms, we use a special handler
2382             no strict;
2383             no warnings 'once';
2384             *next_line = (main::NON_ASCII_PLATFORM)
2385                          ? *_next_line_with_remapped_range
2386                          : *_next_line;
2387         }
2388
2389         return $self;
2390     }
2391
2392
2393     use overload
2394         fallback => 0,
2395         qw("") => "_operator_stringify",
2396         "." => \&main::_operator_dot,
2397         ".=" => \&main::_operator_dot_equal,
2398     ;
2399
2400     sub _operator_stringify {
2401         my $self = shift;
2402
2403         return __PACKAGE__ . " object for " . $self->file;
2404     }
2405
2406     # flag to make sure extracted files are processed early
2407     my $seen_non_extracted_non_age = 0;
2408
2409     sub run {
2410         # Process the input object $self.  This opens and closes the file and
2411         # calls all the handlers for it.  Currently,  this can only be called
2412         # once per file, as it destroy's the EOF handler
2413
2414         my $self = shift;
2415         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2416
2417         my $addr = do { no overloading; pack 'J', $self; };
2418
2419         my $file = $file{$addr};
2420
2421         # Don't process if not expecting this file (because released later
2422         # than this Unicode version), and isn't there.  This means if someone
2423         # copies it into an earlier version's directory, we will go ahead and
2424         # process it.
2425         return if $first_released{$addr} gt $v_version
2426                   && (! defined $file || ! -e $file);
2427
2428         # If in debugging mode and this file doesn't have the non-skip
2429         # flag set, and isn't one of the critical files, skip it.
2430         if ($debug_skip
2431             && $first_released{$addr} ne v0
2432             && ! $non_skip{$addr})
2433         {
2434             print "Skipping $file in debugging\n" if $verbosity;
2435             return;
2436         }
2437
2438         # File could be optional
2439         if ($optional{$addr}) {
2440             return unless -e $file;
2441             my $result = eval $optional{$addr};
2442             if (! defined $result) {
2443                 Carp::my_carp_bug("Got '$@' when tried to eval $optional{$addr}.  $file Skipped.");
2444                 return;
2445             }
2446             if (! $result) {
2447                 if ($verbosity) {
2448                     print STDERR "Skipping processing input file '$file' because '$optional{$addr}' is not true\n";
2449                 }
2450                 return;
2451             }
2452         }
2453
2454         if (! defined $file || ! -e $file) {
2455
2456             # If the file doesn't exist, see if have internal data for it
2457             # (based on first_released being 0).
2458             if ($first_released{$addr} eq v0) {
2459                 $handle{$addr} = 'pretend_is_open';
2460             }
2461             else {
2462                 if (! $optional{$addr}  # File could be optional
2463                     && $v_version ge $first_released{$addr})
2464                 {
2465                     print STDERR "Skipping processing input file '$file' because not found\n";
2466                 }
2467                 return;
2468             }
2469         }
2470         else {
2471
2472             # Here, the file exists.  Some platforms may change the case of
2473             # its name
2474             if ($seen_non_extracted_non_age) {
2475                 if ($file =~ /$EXTRACTED/i) {
2476                     Carp::my_carp_bug(main::join_lines(<<END
2477 $file should be processed just after the 'Prop...Alias' files, and before
2478 anything not in the $EXTRACTED_DIR directory.  Proceeding, but the results may
2479 have subtle problems
2480 END
2481                     ));
2482                 }
2483             }
2484             elsif ($EXTRACTED_DIR
2485                     && $first_released{$addr} ne v0
2486                     && $file !~ /$EXTRACTED/i
2487                     && lc($file) ne 'dage.txt')
2488             {
2489                 # We don't set this (by the 'if' above) if we have no
2490                 # extracted directory, so if running on an early version,
2491                 # this test won't work.  Not worth worrying about.
2492                 $seen_non_extracted_non_age = 1;
2493             }
2494
2495             # And mark the file as having being processed, and warn if it
2496             # isn't a file we are expecting.  As we process the files,
2497             # they are deleted from the hash, so any that remain at the
2498             # end of the program are files that we didn't process.
2499             my $fkey = File::Spec->rel2abs($file);
2500             my $expecting = delete $potential_files{lc($fkey)};
2501
2502             Carp::my_carp("Was not expecting '$file'.") if
2503                     ! $expecting
2504                     && ! defined $handle{$addr};
2505
2506             # Having deleted from expected files, we can quit if not to do
2507             # anything.  Don't print progress unless really want verbosity
2508             if ($skip{$addr}) {
2509                 print "Skipping $file.\n" if $verbosity >= $VERBOSE;
2510                 return;
2511             }
2512
2513             # Open the file, converting the slashes used in this program
2514             # into the proper form for the OS
2515             my $file_handle;
2516             if (not open $file_handle, "<", $file) {
2517                 Carp::my_carp("Can't open $file.  Skipping: $!");
2518                 return 0;
2519             }
2520             $handle{$addr} = $file_handle; # Cache the open file handle
2521
2522             if ($v_version ge v3.2.0 && lc($file) ne 'unicodedata.txt') {
2523                 if ($file !~ /^Unihan/i) {
2524                     $_ = <$file_handle>;
2525                     if ($_ !~ / - $string_version \. /x) {
2526                         chomp;
2527                         $_ =~ s/^#\s*//;
2528                         die Carp::my_carp("File '$file' is version '$_'.  It should be version $string_version");
2529                     }
2530                 }
2531                 else {
2532                     while (<$file_handle>) {
2533                         if ($_ !~ /^#/) {
2534                             Carp::my_carp_bug("Could not find the expected version info in file '$file'");
2535                             last;
2536                         }
2537                         chomp;
2538                         $_ =~ s/^#\s*//;
2539                         next if $_ !~ / version: /x;
2540                         last if $_ =~ /$string_version/;
2541                         die Carp::my_carp("File '$file' is '$_'.  It should be version $string_version");
2542                     }
2543                 }
2544             }
2545         }
2546
2547         if ($verbosity >= $PROGRESS) {
2548             if ($progress_message{$addr}) {
2549                 print "$progress_message{$addr}\n";
2550             }
2551             else {
2552                 # If using a virtual file, say so.
2553                 print "Processing ", (-e $file)
2554                                        ? $file
2555                                        : "substitute $file",
2556                                      "\n";
2557             }
2558         }
2559
2560
2561         # Call any special handler for before the file.
2562         &{$pre_handler{$addr}}($self) if $pre_handler{$addr};
2563
2564         # Then the main handler
2565         &{$handler{$addr}}($self);
2566
2567         # Then any special post-file handler.
2568         &{$post_handler{$addr}}($self) if $post_handler{$addr};
2569
2570         # If any errors have been accumulated, output the counts (as the first
2571         # error message in each class was output when it was encountered).
2572         if ($errors{$addr}) {
2573             my $total = 0;
2574             my $types = 0;
2575             foreach my $error (keys %{$errors{$addr}}) {
2576                 $total += $errors{$addr}->{$error};
2577                 delete $errors{$addr}->{$error};
2578                 $types++;
2579             }
2580             if ($total > 1) {
2581                 my $message
2582                         = "A total of $total lines had errors in $file.  ";
2583
2584                 $message .= ($types == 1)
2585                             ? '(Only the first one was displayed.)'
2586                             : '(Only the first of each type was displayed.)';
2587                 Carp::my_carp($message);
2588             }
2589         }
2590
2591         if (@{$missings{$addr}}) {
2592             Carp::my_carp_bug("Handler for $file didn't look at all the \@missing lines.  Generated tables likely are wrong");
2593         }
2594
2595         # If a real file handle, close it.
2596         close $handle{$addr} or Carp::my_carp("Can't close $file: $!") if
2597                                                         ref $handle{$addr};
2598         $handle{$addr} = "";   # Uses empty to indicate that has already seen
2599                                # the file, as opposed to undef
2600         return;
2601     }
2602
2603     sub _next_line {
2604         # Sets $_ to be the next logical input line, if any.  Returns non-zero
2605         # if such a line exists.  'logical' means that any lines that have
2606         # been added via insert_lines() will be returned in $_ before the file
2607         # is read again.
2608
2609         my $self = shift;
2610         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2611
2612         my $addr = do { no overloading; pack 'J', $self; };
2613
2614         # Here the file is open (or if the handle is not a ref, is an open
2615         # 'virtual' file).  Get the next line; any inserted lines get priority
2616         # over the file itself.
2617         my $adjusted;
2618
2619         LINE:
2620         while (1) { # Loop until find non-comment, non-empty line
2621             #local $to_trace = 1 if main::DEBUG;
2622             my $inserted_ref = shift @{$added_lines{$addr}};
2623             if (defined $inserted_ref) {
2624                 ($adjusted, $_) = @{$inserted_ref};
2625                 trace $adjusted, $_ if main::DEBUG && $to_trace;
2626                 return 1 if $adjusted;
2627             }
2628             else {
2629                 last if ! ref $handle{$addr}; # Don't read unless is real file
2630                 last if ! defined ($_ = readline $handle{$addr});
2631             }
2632             chomp;
2633             trace $_ if main::DEBUG && $to_trace;
2634
2635             # See if this line is the comment line that defines what property
2636             # value that code points that are not listed in the file should
2637             # have.  The format or existence of these lines is not guaranteed
2638             # by Unicode since they are comments, but the documentation says
2639             # that this was added for machine-readability, so probably won't
2640             # change.  This works starting in Unicode Version 5.0.  They look
2641             # like:
2642             #
2643             # @missing: 0000..10FFFF; Not_Reordered
2644             # @missing: 0000..10FFFF; Decomposition_Mapping; <code point>
2645             # @missing: 0000..10FFFF; ; NaN
2646             #
2647             # Save the line for a later get_missings() call.
2648             if (/$missing_defaults_prefix/) {
2649                 if ($has_missings_defaults{$addr} == $NO_DEFAULTS) {
2650                     $self->carp_bad_line("Unexpected \@missing line.  Assuming no missing entries");
2651                 }
2652                 elsif ($has_missings_defaults{$addr} == $NOT_IGNORED) {
2653                     my @defaults = split /\s* ; \s*/x, $_;
2654
2655                     # The first field is the @missing, which ends in a
2656                     # semi-colon, so can safely shift.
2657                     shift @defaults;
2658
2659                     # Some of these lines may have empty field placeholders
2660                     # which get in the way.  An example is:
2661                     # @missing: 0000..10FFFF; ; NaN
2662                     # Remove them.  Process starting from the top so the
2663                     # splice doesn't affect things still to be looked at.
2664                     for (my $i = @defaults - 1; $i >= 0; $i--) {
2665                         next if $defaults[$i] ne "";
2666                         splice @defaults, $i, 1;
2667                     }
2668
2669                     # What's left should be just the property (maybe) and the
2670                     # default.  Having only one element means it doesn't have
2671                     # the property.
2672                     my $default;
2673                     my $property;
2674                     if (@defaults >= 1) {
2675                         if (@defaults == 1) {
2676                             $default = $defaults[0];
2677                         }
2678                         else {
2679                             $property = $defaults[0];
2680                             $default = $defaults[1];
2681                         }
2682                     }
2683
2684                     if (@defaults < 1
2685                         || @defaults > 2
2686                         || ($default =~ /^</
2687                             && $default !~ /^<code *point>$/i
2688                             && $default !~ /^<none>$/i
2689                             && $default !~ /^<script>$/i))
2690                     {
2691                         $self->carp_bad_line("Unrecognized \@missing line: $_.  Assuming no missing entries");
2692                     }
2693                     else {
2694
2695                         # If the property is missing from the line, it should
2696                         # be the one for the whole file
2697                         $property = $property{$addr} if ! defined $property;
2698
2699                         # Change <none> to the null string, which is what it
2700                         # really means.  If the default is the code point
2701                         # itself, set it to <code point>, which is what
2702                         # Unicode uses (but sometimes they've forgotten the
2703                         # space)
2704                         if ($default =~ /^<none>$/i) {
2705                             $default = "";
2706                         }
2707                         elsif ($default =~ /^<code *point>$/i) {
2708                             $default = $CODE_POINT;
2709                         }
2710                         elsif ($default =~ /^<script>$/i) {
2711
2712                             # Special case this one.  Currently is from
2713                             # ScriptExtensions.txt, and means for all unlisted
2714                             # code points, use their Script property values.
2715                             # For the code points not listed in that file, the
2716                             # default value is 'Unknown'.
2717                             $default = "Unknown";
2718                         }
2719
2720                         # Store them as a sub-arrays with both components.
2721                         push @{$missings{$addr}}, [ $default, $property ];
2722                     }
2723                 }
2724
2725                 # There is nothing for the caller to process on this comment
2726                 # line.
2727                 next;
2728             }
2729
2730             # Remove comments and trailing space, and skip this line if the
2731             # result is empty
2732             s/#.*//;
2733             s/\s+$//;
2734             next if /^$/;
2735
2736             # Call any handlers for this line, and skip further processing of
2737             # the line if the handler sets the line to null.
2738             foreach my $sub_ref (@{$each_line_handler{$addr}}) {
2739                 &{$sub_ref}($self);
2740                 next LINE if /^$/;
2741             }
2742
2743             # Here the line is ok.  return success.
2744             return 1;
2745         } # End of looping through lines.
2746
2747         # If there is an EOF handler, call it (only once) and if it generates
2748         # more lines to process go back in the loop to handle them.
2749         if ($eof_handler{$addr}) {
2750             &{$eof_handler{$addr}}($self);
2751             $eof_handler{$addr} = "";   # Currently only get one shot at it.
2752             goto LINE if $added_lines{$addr};
2753         }
2754
2755         # Return failure -- no more lines.
2756         return 0;
2757
2758     }
2759
2760     sub _next_line_with_remapped_range {
2761         my $self = shift;
2762         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2763
2764         # like _next_line(), but for use on non-ASCII platforms.  It sets $_
2765         # to be the next logical input line, if any.  Returns non-zero if such
2766         # a line exists.  'logical' means that any lines that have been added
2767         # via insert_lines() will be returned in $_ before the file is read
2768         # again.
2769         #
2770         # The difference from _next_line() is that this remaps the Unicode
2771         # code points in the input to those of the native platform.  Each
2772         # input line contains a single code point, or a single contiguous
2773         # range of them  This routine splits each range into its individual
2774         # code points and caches them.  It returns the cached values,
2775         # translated into their native equivalents, one at a time, for each
2776         # call, before reading the next line.  Since native values can only be
2777         # a single byte wide, no translation is needed for code points above
2778         # 0xFF, and ranges that are entirely above that number are not split.
2779         # If an input line contains the range 254-1000, it would be split into
2780         # three elements: 254, 255, and 256-1000.  (The downstream table
2781         # insertion code will sort and coalesce the individual code points
2782         # into appropriate ranges.)
2783
2784         my $addr = do { no overloading; pack 'J', $self; };
2785
2786         while (1) {
2787
2788             # Look in cache before reading the next line.  Return any cached
2789             # value, translated
2790             my $inserted = shift @{$remapped_lines{$addr}};
2791             if (defined $inserted) {
2792                 trace $inserted if main::DEBUG && $to_trace;
2793                 $_ = $inserted =~ s/^ ( \d+ ) /sprintf("%04X", utf8::unicode_to_native($1))/xer;
2794                 trace $_ if main::DEBUG && $to_trace;
2795                 return 1;
2796             }
2797
2798             # Get the next line.
2799             return 0 unless _next_line($self);
2800
2801             # If there is a special handler for it, return the line,
2802             # untranslated.  This should happen only for files that are
2803             # special, not being code-point related, such as property names.
2804             return 1 if $handler{$addr}
2805                                     != \&main::process_generic_property_file;
2806
2807             my ($range, $property_name, $map, @remainder)
2808                 = split /\s*;\s*/, $_, -1; # -1 => retain trailing null fields
2809
2810             if (@remainder
2811                 || ! defined $property_name
2812                 || $range !~ /^ ($code_point_re) (?:\.\. ($code_point_re) )? $/x)
2813             {
2814                 Carp::my_carp_bug("Unrecognized input line '$_'.  Ignored");
2815             }
2816
2817             my $low = hex $1;
2818             my $high = (defined $2) ? hex $2 : $low;
2819
2820             # If the input maps the range to another code point, remap the
2821             # target if it is between 0 and 255.
2822             my $tail;
2823             if (defined $map) {
2824                 $map =~ s/\b 00 ( [0-9A-F]{2} ) \b/sprintf("%04X", utf8::unicode_to_native(hex $1))/gxe;
2825                 $tail = "$property_name; $map";
2826                 $_ = "$range; $tail";
2827             }
2828             else {
2829                 $tail = $property_name;
2830             }
2831
2832             # If entire range is above 255, just return it, unchanged (except
2833             # any mapped-to code point, already changed above)
2834             return 1 if $low > 255;
2835
2836             # Cache an entry for every code point < 255.  For those in the
2837             # range above 255, return a dummy entry for just that portion of
2838             # the range.  Note that this will be out-of-order, but that is not
2839             # a problem.
2840             foreach my $code_point ($low .. $high) {
2841                 if ($code_point > 255) {
2842                     $_ = sprintf "%04X..%04X; $tail", $code_point, $high;
2843                     return 1;
2844                 }
2845                 push @{$remapped_lines{$addr}}, "$code_point; $tail";
2846             }
2847         } # End of looping through lines.
2848
2849         # NOTREACHED
2850     }
2851
2852 #   Not currently used, not fully tested.
2853 #    sub peek {
2854 #        # Non-destructive look-ahead one non-adjusted, non-comment, non-blank
2855 #        # record.  Not callable from an each_line_handler(), nor does it call
2856 #        # an each_line_handler() on the line.
2857 #
2858 #        my $self = shift;
2859 #        my $addr = do { no overloading; pack 'J', $self; };
2860 #
2861 #        foreach my $inserted_ref (@{$added_lines{$addr}}) {
2862 #            my ($adjusted, $line) = @{$inserted_ref};
2863 #            next if $adjusted;
2864 #
2865 #            # Remove comments and trailing space, and return a non-empty
2866 #            # resulting line
2867 #            $line =~ s/#.*//;
2868 #            $line =~ s/\s+$//;
2869 #            return $line if $line ne "";
2870 #        }
2871 #
2872 #        return if ! ref $handle{$addr}; # Don't read unless is real file
2873 #        while (1) { # Loop until find non-comment, non-empty line
2874 #            local $to_trace = 1 if main::DEBUG;
2875 #            trace $_ if main::DEBUG && $to_trace;
2876 #            return if ! defined (my $line = readline $handle{$addr});
2877 #            chomp $line;
2878 #            push @{$added_lines{$addr}}, [ 0, $line ];
2879 #
2880 #            $line =~ s/#.*//;
2881 #            $line =~ s/\s+$//;
2882 #            return $line if $line ne "";
2883 #        }
2884 #
2885 #        return;
2886 #    }
2887
2888
2889     sub insert_lines {
2890         # Lines can be inserted so that it looks like they were in the input
2891         # file at the place it was when this routine is called.  See also
2892         # insert_adjusted_lines().  Lines inserted via this routine go through
2893         # any each_line_handler()
2894
2895         my $self = shift;
2896
2897         # Each inserted line is an array, with the first element being 0 to
2898         # indicate that this line hasn't been adjusted, and needs to be
2899         # processed.
2900         no overloading;
2901         push @{$added_lines{pack 'J', $self}}, map { [ 0, $_ ] } @_;
2902         return;
2903     }
2904
2905     sub insert_adjusted_lines {
2906         # Lines can be inserted so that it looks like they were in the input
2907         # file at the place it was when this routine is called.  See also
2908         # insert_lines().  Lines inserted via this routine are already fully
2909         # adjusted, ready to be processed; each_line_handler()s handlers will
2910         # not be called.  This means this is not a completely general
2911         # facility, as only the last each_line_handler on the stack should
2912         # call this.  It could be made more general, by passing to each of the
2913         # line_handlers their position on the stack, which they would pass on
2914         # to this routine, and that would replace the boolean first element in
2915         # the anonymous array pushed here, so that the next_line routine could
2916         # use that to call only those handlers whose index is after it on the
2917         # stack.  But this is overkill for what is needed now.
2918
2919         my $self = shift;
2920         trace $_[0] if main::DEBUG && $to_trace;
2921
2922         # Each inserted line is an array, with the first element being 1 to
2923         # indicate that this line has been adjusted
2924         no overloading;
2925         push @{$added_lines{pack 'J', $self}}, map { [ 1, $_ ] } @_;
2926         return;
2927     }
2928
2929     sub get_missings {
2930         # Returns the stored up @missings lines' values, and clears the list.
2931         # The values are in an array, consisting of the default in the first
2932         # element, and the property in the 2nd.  However, since these lines
2933         # can be stacked up, the return is an array of all these arrays.
2934
2935         my $self = shift;
2936         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2937
2938         my $addr = do { no overloading; pack 'J', $self; };
2939
2940         # If not accepting a list return, just return the first one.
2941         return shift @{$missings{$addr}} unless wantarray;
2942
2943         my @return = @{$missings{$addr}};
2944         undef @{$missings{$addr}};
2945         return @return;
2946     }
2947
2948     sub _insert_property_into_line {
2949         # Add a property field to $_, if this file requires it.
2950
2951         my $self = shift;
2952         my $addr = do { no overloading; pack 'J', $self; };
2953         my $property = $property{$addr};
2954         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2955
2956         $_ =~ s/(;|$)/; $property$1/;
2957         return;
2958     }
2959
2960     sub carp_bad_line {
2961         # Output consistent error messages, using either a generic one, or the
2962         # one given by the optional parameter.  To avoid gazillions of the
2963         # same message in case the syntax of a  file is way off, this routine
2964         # only outputs the first instance of each message, incrementing a
2965         # count so the totals can be output at the end of the file.
2966
2967         my $self = shift;
2968         my $message = shift;
2969         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
2970
2971         my $addr = do { no overloading; pack 'J', $self; };
2972
2973         $message = 'Unexpected line' unless $message;
2974
2975         # No trailing punctuation so as to fit with our addenda.
2976         $message =~ s/[.:;,]$//;
2977
2978         # If haven't seen this exact message before, output it now.  Otherwise
2979         # increment the count of how many times it has occurred
2980         unless ($errors{$addr}->{$message}) {
2981             Carp::my_carp("$message in '$_' in "
2982                             . $file{$addr}
2983                             . " at line $..  Skipping this line;");
2984             $errors{$addr}->{$message} = 1;
2985         }
2986         else {
2987             $errors{$addr}->{$message}++;
2988         }
2989
2990         # Clear the line to prevent any further (meaningful) processing of it.
2991         $_ = "";
2992
2993         return;
2994     }
2995 } # End closure
2996
2997 package Multi_Default;
2998
2999 # Certain properties in early versions of Unicode had more than one possible
3000 # default for code points missing from the files.  In these cases, one
3001 # default applies to everything left over after all the others are applied,
3002 # and for each of the others, there is a description of which class of code
3003 # points applies to it.  This object helps implement this by storing the
3004 # defaults, and for all but that final default, an eval string that generates
3005 # the class that it applies to.
3006
3007
3008 {   # Closure
3009
3010     main::setup_package();
3011
3012     my %class_defaults;
3013     # The defaults structure for the classes
3014     main::set_access('class_defaults', \%class_defaults);
3015
3016     my %other_default;
3017     # The default that applies to everything left over.
3018     main::set_access('other_default', \%other_default, 'r');
3019
3020
3021     sub new {
3022         # The constructor is called with default => eval pairs, terminated by
3023         # the left-over default. e.g.
3024         # Multi_Default->new(
3025         #        'T' => '$gc->table("Mn") + $gc->table("Cf") - 0x200C
3026         #               -  0x200D',
3027         #        'R' => 'some other expression that evaluates to code points',
3028         #        .
3029         #        .
3030         #        .
3031         #        'U'));
3032
3033         my $class = shift;
3034
3035         my $self = bless \do{my $anonymous_scalar}, $class;
3036         my $addr = do { no overloading; pack 'J', $self; };
3037
3038         while (@_ > 1) {
3039             my $default = shift;
3040             my $eval = shift;
3041             $class_defaults{$addr}->{$default} = $eval;
3042         }
3043
3044         $other_default{$addr} = shift;
3045
3046         return $self;
3047     }
3048
3049     sub get_next_defaults {
3050         # Iterates and returns the next class of defaults.
3051         my $self = shift;
3052         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3053
3054         my $addr = do { no overloading; pack 'J', $self; };
3055
3056         return each %{$class_defaults{$addr}};
3057     }
3058 }
3059
3060 package Alias;
3061
3062 # An alias is one of the names that a table goes by.  This class defines them
3063 # including some attributes.  Everything is currently setup in the
3064 # constructor.
3065
3066
3067 {   # Closure
3068
3069     main::setup_package();
3070
3071     my %name;
3072     main::set_access('name', \%name, 'r');
3073
3074     my %loose_match;
3075     # Should this name match loosely or not.
3076     main::set_access('loose_match', \%loose_match, 'r');
3077
3078     my %make_re_pod_entry;
3079     # Some aliases should not get their own entries in the re section of the
3080     # pod, because they are covered by a wild-card, and some we want to
3081     # discourage use of.  Binary
3082     main::set_access('make_re_pod_entry', \%make_re_pod_entry, 'r', 's');
3083
3084     my %ucd;
3085     # Is this documented to be accessible via Unicode::UCD
3086     main::set_access('ucd', \%ucd, 'r', 's');
3087
3088     my %status;
3089     # Aliases have a status, like deprecated, or even suppressed (which means
3090     # they don't appear in documentation).  Enum
3091     main::set_access('status', \%status, 'r');
3092
3093     my %ok_as_filename;
3094     # Similarly, some aliases should not be considered as usable ones for
3095     # external use, such as file names, or we don't want documentation to
3096     # recommend them.  Boolean
3097     main::set_access('ok_as_filename', \%ok_as_filename, 'r');
3098
3099     sub new {
3100         my $class = shift;
3101
3102         my $self = bless \do { my $anonymous_scalar }, $class;
3103         my $addr = do { no overloading; pack 'J', $self; };
3104
3105         $name{$addr} = shift;
3106         $loose_match{$addr} = shift;
3107         $make_re_pod_entry{$addr} = shift;
3108         $ok_as_filename{$addr} = shift;
3109         $status{$addr} = shift;
3110         $ucd{$addr} = shift;
3111
3112         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3113
3114         # Null names are never ok externally
3115         $ok_as_filename{$addr} = 0 if $name{$addr} eq "";
3116
3117         return $self;
3118     }
3119 }
3120
3121 package Range;
3122
3123 # A range is the basic unit for storing code points, and is described in the
3124 # comments at the beginning of the program.  Each range has a starting code
3125 # point; an ending code point (not less than the starting one); a value
3126 # that applies to every code point in between the two end-points, inclusive;
3127 # and an enum type that applies to the value.  The type is for the user's
3128 # convenience, and has no meaning here, except that a non-zero type is
3129 # considered to not obey the normal Unicode rules for having standard forms.
3130 #
3131 # The same structure is used for both map and match tables, even though in the
3132 # latter, the value (and hence type) is irrelevant and could be used as a
3133 # comment.  In map tables, the value is what all the code points in the range
3134 # map to.  Type 0 values have the standardized version of the value stored as
3135 # well, so as to not have to recalculate it a lot.
3136
3137 sub trace { return main::trace(@_); }
3138
3139 {   # Closure
3140
3141     main::setup_package();
3142
3143     my %start;
3144     main::set_access('start', \%start, 'r', 's');
3145
3146     my %end;
3147     main::set_access('end', \%end, 'r', 's');
3148
3149     my %value;
3150     main::set_access('value', \%value, 'r');
3151
3152     my %type;
3153     main::set_access('type', \%type, 'r');
3154
3155     my %standard_form;
3156     # The value in internal standard form.  Defined only if the type is 0.
3157     main::set_access('standard_form', \%standard_form);
3158
3159     # Note that if these fields change, the dump() method should as well
3160
3161     sub new {
3162         return Carp::carp_too_few_args(\@_, 3) if main::DEBUG && @_ < 3;
3163         my $class = shift;
3164
3165         my $self = bless \do { my $anonymous_scalar }, $class;
3166         my $addr = do { no overloading; pack 'J', $self; };
3167
3168         $start{$addr} = shift;
3169         $end{$addr} = shift;
3170
3171         my %args = @_;
3172
3173         my $value = delete $args{'Value'};  # Can be 0
3174         $value = "" unless defined $value;
3175         $value{$addr} = $value;
3176
3177         $type{$addr} = delete $args{'Type'} || 0;
3178
3179         Carp::carp_extra_args(\%args) if main::DEBUG && %args;
3180
3181         return $self;
3182     }
3183
3184     use overload
3185         fallback => 0,
3186         qw("") => "_operator_stringify",
3187         "." => \&main::_operator_dot,
3188         ".=" => \&main::_operator_dot_equal,
3189     ;
3190
3191     sub _operator_stringify {
3192         my $self = shift;
3193         my $addr = do { no overloading; pack 'J', $self; };
3194
3195         # Output it like '0041..0065 (value)'
3196         my $return = sprintf("%04X", $start{$addr})
3197                         .  '..'
3198                         . sprintf("%04X", $end{$addr});
3199         my $value = $value{$addr};
3200         my $type = $type{$addr};
3201         $return .= ' (';
3202         $return .= "$value";
3203         $return .= ", Type=$type" if $type != 0;
3204         $return .= ')';
3205
3206         return $return;
3207     }
3208
3209     sub standard_form {
3210         # Calculate the standard form only if needed, and cache the result.
3211         # The standard form is the value itself if the type is special.
3212         # This represents a considerable CPU and memory saving - at the time
3213         # of writing there are 368676 non-special objects, but the standard
3214         # form is only requested for 22047 of them - ie about 6%.
3215
3216         my $self = shift;
3217         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3218
3219         my $addr = do { no overloading; pack 'J', $self; };
3220
3221         return $standard_form{$addr} if defined $standard_form{$addr};
3222
3223         my $value = $value{$addr};
3224         return $value if $type{$addr};
3225         return $standard_form{$addr} = main::standardize($value);
3226     }
3227
3228     sub dump {
3229         # Human, not machine readable.  For machine readable, comment out this
3230         # entire routine and let the standard one take effect.
3231         my $self = shift;
3232         my $indent = shift;
3233         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3234
3235         my $addr = do { no overloading; pack 'J', $self; };
3236
3237         my $return = $indent
3238                     . sprintf("%04X", $start{$addr})
3239                     . '..'
3240                     . sprintf("%04X", $end{$addr})
3241                     . " '$value{$addr}';";
3242         if (! defined $standard_form{$addr}) {
3243             $return .= "(type=$type{$addr})";
3244         }
3245         elsif ($standard_form{$addr} ne $value{$addr}) {
3246             $return .= "(standard '$standard_form{$addr}')";
3247         }
3248         return $return;
3249     }
3250 } # End closure
3251
3252 package _Range_List_Base;
3253
3254 # Base class for range lists.  A range list is simply an ordered list of
3255 # ranges, so that the ranges with the lowest starting numbers are first in it.
3256 #
3257 # When a new range is added that is adjacent to an existing range that has the
3258 # same value and type, it merges with it to form a larger range.
3259 #
3260 # Ranges generally do not overlap, except that there can be multiple entries
3261 # of single code point ranges.  This is because of NameAliases.txt.
3262 #
3263 # In this program, there is a standard value such that if two different
3264 # values, have the same standard value, they are considered equivalent.  This
3265 # value was chosen so that it gives correct results on Unicode data
3266
3267 # There are a number of methods to manipulate range lists, and some operators
3268 # are overloaded to handle them.
3269
3270 sub trace { return main::trace(@_); }
3271
3272 { # Closure
3273
3274     our $addr;
3275
3276     # Max is initialized to a negative value that isn't adjacent to 0, for
3277     # simpler tests
3278     my $max_init = -2;
3279
3280     main::setup_package();
3281
3282     my %ranges;
3283     # The list of ranges
3284     main::set_access('ranges', \%ranges, 'readable_array');
3285
3286     my %max;
3287     # The highest code point in the list.  This was originally a method, but
3288     # actual measurements said it was used a lot.
3289     main::set_access('max', \%max, 'r');
3290
3291     my %each_range_iterator;
3292     # Iterator position for each_range()
3293     main::set_access('each_range_iterator', \%each_range_iterator);
3294
3295     my %owner_name_of;
3296     # Name of parent this is attached to, if any.  Solely for better error
3297     # messages.
3298     main::set_access('owner_name_of', \%owner_name_of, 'p_r');
3299
3300     my %_search_ranges_cache;
3301     # A cache of the previous result from _search_ranges(), for better
3302     # performance
3303     main::set_access('_search_ranges_cache', \%_search_ranges_cache);
3304
3305     sub new {
3306         my $class = shift;
3307         my %args = @_;
3308
3309         # Optional initialization data for the range list.
3310         my $initialize = delete $args{'Initialize'};
3311
3312         my $self;
3313
3314         # Use _union() to initialize.  _union() returns an object of this
3315         # class, which means that it will call this constructor recursively.
3316         # But it won't have this $initialize parameter so that it won't
3317         # infinitely loop on this.
3318         return _union($class, $initialize, %args) if defined $initialize;
3319
3320         $self = bless \do { my $anonymous_scalar }, $class;
3321         my $addr = do { no overloading; pack 'J', $self; };
3322
3323         # Optional parent object, only for debug info.
3324         $owner_name_of{$addr} = delete $args{'Owner'};
3325         $owner_name_of{$addr} = "" if ! defined $owner_name_of{$addr};
3326
3327         # Stringify, in case it is an object.
3328         $owner_name_of{$addr} = "$owner_name_of{$addr}";
3329
3330         # This is used only for error messages, and so a colon is added
3331         $owner_name_of{$addr} .= ": " if $owner_name_of{$addr} ne "";
3332
3333         Carp::carp_extra_args(\%args) if main::DEBUG && %args;
3334
3335         $max{$addr} = $max_init;
3336
3337         $_search_ranges_cache{$addr} = 0;
3338         $ranges{$addr} = [];
3339
3340         return $self;
3341     }
3342
3343     use overload
3344         fallback => 0,
3345         qw("") => "_operator_stringify",
3346         "." => \&main::_operator_dot,
3347         ".=" => \&main::_operator_dot_equal,
3348     ;
3349
3350     sub _operator_stringify {
3351         my $self = shift;
3352         my $addr = do { no overloading; pack 'J', $self; };
3353
3354         return "Range_List attached to '$owner_name_of{$addr}'"
3355                                                 if $owner_name_of{$addr};
3356         return "anonymous Range_List " . \$self;
3357     }
3358
3359     sub _union {
3360         # Returns the union of the input code points.  It can be called as
3361         # either a constructor or a method.  If called as a method, the result
3362         # will be a new() instance of the calling object, containing the union
3363         # of that object with the other parameter's code points;  if called as
3364         # a constructor, the first parameter gives the class that the new object
3365         # should be, and the second parameter gives the code points to go into
3366         # it.
3367         # In either case, there are two parameters looked at by this routine;
3368         # any additional parameters are passed to the new() constructor.
3369         #
3370         # The code points can come in the form of some object that contains
3371         # ranges, and has a conventionally named method to access them; or
3372         # they can be an array of individual code points (as integers); or
3373         # just a single code point.
3374         #
3375         # If they are ranges, this routine doesn't make any effort to preserve
3376         # the range values and types of one input over the other.  Therefore
3377         # this base class should not allow _union to be called from other than
3378         # initialization code, so as to prevent two tables from being added
3379         # together where the range values matter.  The general form of this
3380         # routine therefore belongs in a derived class, but it was moved here
3381         # to avoid duplication of code.  The failure to overload this in this
3382         # class keeps it safe.
3383         #
3384         # It does make the effort during initialization to accept tables with
3385         # multiple values for the same code point, and to preserve the order
3386         # of these.  If there is only one input range or range set, it doesn't
3387         # sort (as it should already be sorted to the desired order), and will
3388         # accept multiple values per code point.  Otherwise it will merge
3389         # multiple values into a single one.
3390
3391         my $self;
3392         my @args;   # Arguments to pass to the constructor
3393
3394         my $class = shift;
3395
3396         # If a method call, will start the union with the object itself, and
3397         # the class of the new object will be the same as self.
3398         if (ref $class) {
3399             $self = $class;
3400             $class = ref $self;
3401             push @args, $self;
3402         }
3403
3404         # Add the other required parameter.
3405         push @args, shift;
3406         # Rest of parameters are passed on to the constructor
3407
3408         # Accumulate all records from both lists.
3409         my @records;
3410         my $input_count = 0;
3411         for my $arg (@args) {
3412             #local $to_trace = 0 if main::DEBUG;
3413             trace "argument = $arg" if main::DEBUG && $to_trace;
3414             if (! defined $arg) {
3415                 my $message = "";
3416                 if (defined $self) {
3417                     no overloading;
3418                     $message .= $owner_name_of{pack 'J', $self};
3419                 }
3420                 Carp::my_carp_bug($message . "Undefined argument to _union.  No union done.");
3421                 return;
3422             }
3423
3424             $arg = [ $arg ] if ! ref $arg;
3425             my $type = ref $arg;
3426             if ($type eq 'ARRAY') {
3427                 foreach my $element (@$arg) {
3428                     push @records, Range->new($element, $element);
3429                     $input_count++;
3430                 }
3431             }
3432             elsif ($arg->isa('Range')) {
3433                 push @records, $arg;
3434                 $input_count++;
3435             }
3436             elsif ($arg->can('ranges')) {
3437                 push @records, $arg->ranges;
3438                 $input_count++;
3439             }
3440             else {
3441                 my $message = "";
3442                 if (defined $self) {
3443                     no overloading;
3444                     $message .= $owner_name_of{pack 'J', $self};
3445                 }
3446                 Carp::my_carp_bug($message . "Cannot take the union of a $type.  No union done.");
3447                 return;
3448             }
3449         }
3450
3451         # Sort with the range containing the lowest ordinal first, but if
3452         # two ranges start at the same code point, sort with the bigger range
3453         # of the two first, because it takes fewer cycles.
3454         if ($input_count > 1) {
3455             @records = sort { ($a->start <=> $b->start)
3456                                       or
3457                                     # if b is shorter than a, b->end will be
3458                                     # less than a->end, and we want to select
3459                                     # a, so want to return -1
3460                                     ($b->end <=> $a->end)
3461                                    } @records;
3462         }
3463
3464         my $new = $class->new(@_);
3465
3466         # Fold in records so long as they add new information.
3467         for my $set (@records) {
3468             my $start = $set->start;
3469             my $end   = $set->end;
3470             my $value = $set->value;
3471             my $type  = $set->type;
3472             if ($start > $new->max) {
3473                 $new->_add_delete('+', $start, $end, $value, Type => $type);
3474             }
3475             elsif ($end > $new->max) {
3476                 $new->_add_delete('+', $new->max +1, $end, $value,
3477                                                                 Type => $type);
3478             }
3479             elsif ($input_count == 1) {
3480                 # Here, overlaps existing range, but is from a single input,
3481                 # so preserve the multiple values from that input.
3482                 $new->_add_delete('+', $start, $end, $value, Type => $type,
3483                                                 Replace => $MULTIPLE_AFTER);
3484             }
3485         }
3486
3487         return $new;
3488     }
3489
3490     sub range_count {        # Return the number of ranges in the range list
3491         my $self = shift;
3492         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3493
3494         no overloading;
3495         return scalar @{$ranges{pack 'J', $self}};
3496     }
3497
3498     sub min {
3499         # Returns the minimum code point currently in the range list, or if
3500         # the range list is empty, 2 beyond the max possible.  This is a
3501         # method because used so rarely, that not worth saving between calls,
3502         # and having to worry about changing it as ranges are added and
3503         # deleted.
3504
3505         my $self = shift;
3506         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3507
3508         my $addr = do { no overloading; pack 'J', $self; };
3509
3510         # If the range list is empty, return a large value that isn't adjacent
3511         # to any that could be in the range list, for simpler tests
3512         return $MAX_WORKING_CODEPOINT + 2 unless scalar @{$ranges{$addr}};
3513         return $ranges{$addr}->[0]->start;
3514     }
3515
3516     sub contains {
3517         # Boolean: Is argument in the range list?  If so returns $i such that:
3518         #   range[$i]->end < $codepoint <= range[$i+1]->end
3519         # which is one beyond what you want; this is so that the 0th range
3520         # doesn't return false
3521         my $self = shift;
3522         my $codepoint = shift;
3523         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3524
3525         my $i = $self->_search_ranges($codepoint);
3526         return 0 unless defined $i;
3527
3528         # The search returns $i, such that
3529         #   range[$i-1]->end < $codepoint <= range[$i]->end
3530         # So is in the table if and only iff it is at least the start position
3531         # of range $i.
3532         no overloading;
3533         return 0 if $ranges{pack 'J', $self}->[$i]->start > $codepoint;
3534         return $i + 1;
3535     }
3536
3537     sub containing_range {
3538         # Returns the range object that contains the code point, undef if none
3539
3540         my $self = shift;
3541         my $codepoint = shift;
3542         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3543
3544         my $i = $self->contains($codepoint);
3545         return unless $i;
3546
3547         # contains() returns 1 beyond where we should look
3548         no overloading;
3549         return $ranges{pack 'J', $self}->[$i-1];
3550     }
3551
3552     sub value_of {
3553         # Returns the value associated with the code point, undef if none
3554
3555         my $self = shift;
3556         my $codepoint = shift;
3557         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3558
3559         my $range = $self->containing_range($codepoint);
3560         return unless defined $range;
3561
3562         return $range->value;
3563     }
3564
3565     sub type_of {
3566         # Returns the type of the range containing the code point, undef if
3567         # the code point is not in the table
3568
3569         my $self = shift;
3570         my $codepoint = shift;
3571         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3572
3573         my $range = $self->containing_range($codepoint);
3574         return unless defined $range;
3575
3576         return $range->type;
3577     }
3578
3579     sub _search_ranges {
3580         # Find the range in the list which contains a code point, or where it
3581         # should go if were to add it.  That is, it returns $i, such that:
3582         #   range[$i-1]->end < $codepoint <= range[$i]->end
3583         # Returns undef if no such $i is possible (e.g. at end of table), or
3584         # if there is an error.
3585
3586         my $self = shift;
3587         my $code_point = shift;
3588         Carp::carp_extra_args(\@_) if main::DEBUG && @_;
3589
3590         my $addr = do { no overloading; pack 'J', $self; };
3591
3592         return if $code_point > $max{$addr};
3593         my $r = $ranges{$addr};                # The current list of ranges
3594         my $range_list_size = scalar @$r;
3595         my $i;
3596
3597         use integer;        # want integer division
3598
3599         # Use the cached result as the starting guess for this one, because,
3600         # an experiment on 5.1 showed that 90% of the time the cache was the
3601         # same as the result on the next call (and 7% it was one less).
3602         $i = $_search_ranges_cache{$addr};
3603         $i = 0 if $i >= $range_list_size;   # Reset if no longer valid (prob.
3604                                             # from an intervening deletion
3605         #local $to_trace = 1 if main::DEBUG;
3606         trace "previous \$i is still valid: $i" if main::DEBUG && $to_trace && $code_point <= $r->[$i]->end && ($i == 0 || $r->[$i-1]->end < $code_point);
3607         return $i if $code_point <= $r->[$i]->end
3608                      && ($i == 0 || $r->[$i-1]->end < $code_point);
3609
3610         # Here the cache doesn't yield the correct $i.  Try adding 1.
3611         if ($i < $range_list_size - 1
3612             && $r->[$i]->end < $code_point &&
3613             $code_point <= $r->[$i+1]->end)
3614         {
3615             $i++;
3616             trace "next \$i is correct: $i" if main::DEBUG && $to_trace;
3617             $_search_ranges_cache{$addr} = $i;
3618             return $i;
3619         }
3620
3621         # Here, adding 1 also didn't work.  We do a binary search to
3622         # find the correct position, starting with current $i
3623         my $lower = 0;
3624         my $upper = $range_list_size - 1;
3625         while (1) {
3626             trace "top of loop i=$i:", sprintf("%04X", $r->[$lower]->start), "[$lower] .. ", sprintf("%04X", $r->[$i]->start), "[$i] .. ", sprintf("%04X", $r->[$upper]->start), "[$upper]" if main::DEBUG && $to_trace;
3627
3628             if ($code_point <= $r->[$i]->end) {
3629
3630                 # Here we have met the upper constraint.  We can quit if we
3631                 # also meet the lower one.
3632                 last if $i == 0 || $r->[$i-1]->end < $code_point;
3633
3634                 $upper = $i;        # Still too high.
3635
3636             }
3637             else {
3638
3639                 # Here, $r[$i]->end < $code_point, so look higher up.
3640                 $lower = $i;
3641             }
3642
3643             # Split search domain in half to try again.
3644             my $temp = ($upper + $lower) / 2;
3645
3646             # No point in continuing unless $i changes for next time
3647             # in the loop.
3648             if ($temp == $i) {
3649
3650                 # We can't reach the highest element because of the averaging.
3651                 # So if one below the upper edge, force it there and try one
3652                 # more time.
3653                 if ($i == $range_list_size - 2) {
3654
3655                     trace "Forcing to upper edge" if main::DEBUG && $to_trace;
3656                     $i = $range_list_size - 1;
3657
3658                     # Change $lower as well so if fails next time through,
3659                     # taking the average will yield the same $i, and we will
3660                     # quit with the error message just below.
3661                     $lower = $i;
3662                     next;
3663                 }
3664                 Carp::my_carp_bug("$owner_name_of{$addr}Can't find where the range ought to go.  No action taken.");
3665                 return;
3666             }
3667             $i = $temp;
3668         } # End of while loop
3669
3670         if (main::DEBUG && $to_trace) {
3671             trace 'i-1=[', $i-1, ']', $r->[$i-1] if $i;
3672             trace "i=  [ $i ]", $r->[$i];
3673             trace 'i+1=[', $i+1, ']', $r->[$i+1] if $i < $range_list_size - 1;
3674         }
3675
3676         # Here we have found the offset.  Cache it as a starting point for the
3677         # next call.
3678         $_search_ranges_cache{$addr} = $i;
3679         return $i;
3680     }
3681
3682     sub _add_delete {
3683         # Add, replace or delete ranges to or from a list.  The $type
3684         # parameter gives which:
3685         #   '+' => insert or replace a range, returning a list of any changed
3686         #          ranges.
3687         #   '-' => delete a range, returning a list of any deleted ranges.
3688         #
3689         # The next three parameters give respectively the start, end, and
3690         # value associated with the range.  'value' should be null unless the
3691         # operation is '+';
3692         #
3693         # The range list is kept sorted so that the range with the lowest
3694         # starting position is first in the list, and generally, adjacent
3695         # ranges with the same values are merged into a single larger one (see
3696         # exceptions below).
3697         #
3698         # There are more parameters; all are key => value pairs:
3699         #   Type    gives the type of the value.  It is only valid for '+'.
3700         #           All ranges have types; if this parameter is omitted, 0 is
3701         #           assumed.  Ranges with type 0 are assumed to obey the
3702         #           Unicode rules for casing, etc; ranges with other types are
3703         #           not.  Otherwise, the type is arbitrary, for the caller's
3704         #           convenience, and looked at only by this routine to keep
3705         #           adjacent ranges of different types from being merged into
3706         #           a single larger range, and when Replace =>
3707         #           $IF_NOT_EQUIVALENT is specified (see just below).
3708         #   Replace  determines what to do if the range list already contains
3709         #            ranges which coincide with all or portions of the input
3710         #            range.  It is only valid for '+':
3711         #       => $NO            means that the new value is not to replace
3712         #                         any existing ones, but any empty gaps of the
3713         #                         range list coinciding with the input range
3714         #                         will be filled in with the new value.
3715         #       => $UNCONDITIONALLY  means to replace the existing values with
3716         #                         this one unconditionally.  However, if the
3717         #                         new and old values are identical, the
3718         #                         replacement is skipped to save cycles
3719         #       => $IF_NOT_EQUIVALENT means to replace the existing values
3720         #          (the default)  with this one if they are not equivalent.
3721         #                         Ranges are equivalent if their types are the
3722         #                         same, and they are the same string; or if
3723         #                         both are type 0 ranges, if their Unicode
3724         #                         standard forms are identical.  In this last
3725         #                         case, the routine chooses the more "modern"
3726         #                         one to use.  This is because some of the
3727         #                         older files are formatted with values that
3728         #                         are, for example, ALL CAPs, whereas the
3729         #                         derived files have a more modern style,
3730         #                         which looks better.  By looking for this
3731         #                         style when the pre-existing and replacement
3732         #                         standard forms are the same, we can move to
3733         #                         the modern style
3734         #       => $MULTIPLE_BEFORE means that if this range duplicates an
3735         #                         existing one, but has a different value,
3736         #                         don't replace the existing one, but insert
3737         #                         this, one so that the same range can occur
3738         #                         multiple times.  They are stored LIFO, so
3739         #                         that the final one inserted is the first one
3740         #                         returned in an ordered search of the table.
3741         #                         If this is an exact duplicate, including the
3742         #                         value, the original will be moved to be
3743         #                         first, before any other duplicate ranges
3744         #                         with different values.
3745         #       => $MULTIPLE_AFTER is like $MULTIPLE_BEFORE, but is stored
3746         #                         FIFO, so that this one is inserted after all
3747         #                         others that currently exist.  If this is an
3748         #                         exact duplicate, including value, of an
3749         #                         existing range, this one is discarded
3750         #                         (leaving the existing one in its original,
3751         #                         higher priority position
3752         #       => anything else  is the same as => $IF_NOT_EQUIVALENT
3753         #
3754         # "same value" means identical for non-type-0 ranges, and it means
3755         # having the same standard forms for type-0 ranges.
3756
3757         return Carp::carp_too_few_args(\@_, 5) if main::DEBUG && @_ < 5;
3758
3759         my $self = shift;
3760         my $operation = shift;   # '+' for add/replace; '-' for delete;
3761         my $start = shift;
3762         my $end   = shift;
3763         my $value = shift;
3764
3765         my %args = @_;
3766
3767         $value = "" if not defined $value;        # warning: $value can be "0"
3768
3769         my $replace = delete $args{'Replace'};
3770         $replace = $IF_NOT_EQUIVALENT unless defined $replace;
3771
3772         my $type = delete $args{'Type'};
3773         $type = 0 unless defined $type;
3774
3775         Carp::carp_extra_args(\%args) if main::DEBUG && %args;
3776
3777         my $addr = do { no overloading; pack 'J', $self; };
3778
3779         if ($operation ne '+' && $operation ne '-') {
3780             Carp::my_carp_bug("$owner_name_of{$addr}First parameter to _add_delete must be '+' or '-'.  No action taken.");
3781             return;
3782         }
3783         unless (defined $start && defined $end) {
3784             Carp::my_carp_bug("$owner_name_of{$addr}Undefined start and/or end to _add_delete.  No action taken.");
3785             return;
3786         }
3787         unless ($end >= $start) {
3788             Carp::my_carp_bug("$owner_name_of{$addr}End of range (" . sprintf("%04X", $end) . ") must not be before start (" . sprintf("%04X", $start) . ").  No action taken.");
3789             return;
3790         }
3791         #local $to_trace = 1 if main::DEBUG;
3792
3793         if ($operation eq '-') {
3794             if ($replace != $IF_NOT_EQUIVALENT) {
3795                 Carp::my_carp_bug("$owner_name_of{$addr}Replace => \$IF_NOT_EQUIVALENT is required when deleting a range from a range list.  Assuming Replace => \$IF_NOT_EQUIVALENT.");
3796                 $replace = $IF_NOT_EQUIVALENT;
3797             }
3798             if ($type) {
3799                 Carp::my_carp_bug("$owner_name_of{$addr}Type => 0 is required when deleting a range from a range list.  Assuming Type => 0.");
3800                 $type = 0;
3801             }
3802             if ($value ne "") {
3803                 Carp::my_carp_bug("$owner_name_of{$addr}Value => \"\" is required when deleting a range from a range list.  Assuming Value => \"\".");
3804                 $value = "";
3805             }
3806         }
3807
3808         my $r = $ranges{$addr};               # The current list of ranges
3809         my $range_list_size = scalar @$r;     # And its size
3810         my $max = $max{$addr};                # The current high code point in
3811                                               # the list of ranges
3812
3813         # Do a special case requiring fewer machine cycles when the new range
3814         # starts after the current highest point.  The Unicode input data is
3815         # structured so this is common.
3816         if ($start > $max) {
3817
3818             trace "$owner_name_of{$addr} $operation", sprintf("%04X..%04X (%s) type=%d; prev max=%04X", $start, $end, $value, $type, $max) if main::DEBUG && $to_trace;
3819             return if $operation eq '-'; # Deleting a non-existing range is a
3820                                          # no-op
3821
3822             # If the new range doesn't logically extend the current final one
3823             # in the range list, create a new range at the end of the range
3824             # list.  (max cleverly is initialized to a negative number not
3825             # adjacent to 0 if the range list is empty, so even adding a range
3826             # to an empty range list starting at 0 will have this 'if'
3827             # succeed.)
3828             if ($start > $max + 1        # non-adjacent means can't extend.
3829                 || @{$r}[-1]->value ne $value # values differ, can't extend.
3830                 || @{$r}[-1]->type != $type # types differ, can't extend.
3831             ) {
3832                 push @$r, Range->new($start, $end,
3833                                      Value => $value,
3834                                      Type => $type);
3835             }
3836             else {
3837
3838                 # Here, the new range starts just after the current highest in
3839                 # the range list, and they have the same type and value.
3840                 # Extend the current range to incorporate the new one.
3841                 @{$r}[-1]->set_end($end);
3842             }
3843
3844             # This becomes the new maximum.
3845             $max{$addr} = $end;
3846
3847             return;
3848         }
3849         #local $to_trace = 0 if main::DEBUG;
3850
3851         trace "$owner_name_of{$addr} $operation", sprintf("%04X", $start) . '..' . sprintf("%04X", $end) . " ($value) replace=$replace" if main::DEBUG && $to_trace;
3852
3853         # Here, the input range isn't after the whole rest of the range list.
3854         # Most likely 'splice' will be needed.  The rest of the routine finds
3855         # the needed splice parameters, and if necessary, does the splice.
3856         # First, find the offset parameter needed by the splice function for
3857         # the input range.  Note that the input range may span multiple
3858         # existing ones, but we'll worry about that later.  For now, just find
3859         # the beginning.  If the input range is to be inserted starting in a
3860         # position not currently in the range list, it must (obviously) come
3861         # just after the range below it, and just before the range above it.
3862         # Slightly less obviously, it will occupy the position currently
3863         # occupied by the range that is to come after it.  More formally, we
3864         # are looking for the position, $i, in the array of ranges, such that:
3865         #
3866         # r[$i-1]->start <= r[$i-1]->end < $start < r[$i]->start <= r[$i]->end
3867         #
3868         # (The ordered relationships within existing ranges are also shown in
3869         # the equation above).  However, if the start of the input range is
3870         # within an existing range, the splice offset should point to that
3871         # existing range's position in the list; that is $i satisfies a
3872         # somewhat different equation, namely:
3873         #
3874         #r[$i-1]->start <= r[$i-1]->end < r[$i]->start <= $start <= r[$i]->end
3875         #
3876         # More briefly, $start can come before or after r[$i]->start, and at
3877         # this point, we don't know which it will be.  However, these
3878         # two equations share these constraints:
3879         #
3880         #   r[$i-1]->end < $start <= r[$i]->end
3881         #
3882         # And that is good enough to find $i.
3883
3884         my $i = $self->_search_ranges($start);
3885         if (! defined $i) {
3886             Carp::my_carp_bug("Searching $self for range beginning with $start unexpectedly returned undefined.  Operation '$operation' not performed");
3887             return;
3888         }
3889
3890         # The search function returns $i such that:
3891         #
3892         # r[$i-1]->end < $start <= r[$i]->end
3893         #
3894         # That means that $i points to the first range in the range list
3895         # that could possibly be affected by this operation.  We still don't
3896         # know if the start of the input range is within r[$i], or if it
3897         # points to empty space between r[$i-1] and r[$i].
3898         trace "[$i] is the beginning splice point.  Existing range there is ", $r->[$i] if main::DEBUG && $to_trace;
3899
3900         # Special case the insertion of data that is not to replace any
3901         # existing data.
3902         if ($replace == $NO) {  # If $NO, has to be operation '+'
3903             #local $to_trace = 1 if main::DEBUG;
3904             trace "Doesn't replace" if main::DEBUG && $to_trace;
3905
3906             # Here, the new range is to take effect only on those code points
3907             # that aren't already in an existing range.  This can be done by
3908             # looking through the existing range list and finding the gaps in
3909             # the ranges that this new range affects, and then calling this
3910             # function recursively on each of those gaps, leaving untouched
3911             # anything already in the list.  Gather up a list of the changed
3912             # gaps first so that changes to the internal state as new ranges
3913             # are added won't be a problem.
3914             my @gap_list;
3915
3916             # First, if the starting point of the input range is outside an
3917             # existing one, there is a gap from there to the beginning of the
3918             # existing range -- add a span to fill the part that this new
3919             # range occupies
3920             if ($start < $r->[$i]->start) {
3921                 push @gap_list, Range->new($start,
3922                                            main::min($end,
3923                                                      $r->[$i]->start - 1),
3924                                            Type => $type);
3925                 trace "gap before $r->[$i] [$i], will add", $gap_list[-1] if main::DEBUG && $to_trace;
3926             }
3927
3928             # Then look through the range list for other gaps until we reach
3929             # the highest range affected by the input one.
3930             my $j;
3931             for ($j = $i+1; $j < $range_list_size; $j++) {
3932                 trace "j=[$j]", $r->[$j] if main::DEBUG && $to_trace;
3933                 last if $end < $r->[$j]->start;
3934
3935                 # If there is a gap between when this range starts and the
3936                 # previous one ends, add a span to fill it.  Note that just
3937                 # because there are two ranges doesn't mean there is a
3938                 # non-zero gap between them.  It could be that they have
3939                 # different values or types
3940                 if ($r->[$j-1]->end + 1 != $r->[$j]->start) {
3941                     push @gap_list,
3942                         Range->new($r->[$j-1]->end + 1,
3943                                    $r->[$j]->start - 1,
3944                                    Type => $type);
3945                     trace "gap between $r->[$j-1] and $r->[$j] [$j], will add: $gap_list[-1]" if main::DEBUG && $to_trace;
3946                 }
3947             }
3948
3949             # Here, we have either found an existing range in the range list,
3950             # beyond the area affected by the input one, or we fell off the
3951             # end of the loop because the input range affects the whole rest
3952             # of the range list.  In either case, $j is 1 higher than the
3953             # highest affected range.  If $j == $i, it means that there are no
3954             # affected ranges, that the entire insertion is in the gap between
3955             # r[$i-1], and r[$i], which we already have taken care of before
3956             # the loop.
3957             # On the other hand, if there are affected ranges, it might be
3958             # that there is a gap that needs filling after the final such
3959             # range to the end of the input range
3960             if ($r->[$j-1]->end < $end) {
3961                     push @gap_list, Range->new(main::max($start,
3962                                                          $r->[$j-1]->end + 1),
3963                                                $end,
3964                                                Type => $type);
3965                     trace "gap after $r->[$j-1], will add $gap_list[-1]" if main::DEBUG && $to_trace;
3966             }
3967
3968             # Call recursively to fill in all the gaps.
3969             foreach my $gap (@gap_list) {
3970                 $self->_add_delete($operation,
3971                                    $gap->start,
3972                                    $gap->end,
3973                                    $value,
3974                                    Type => $type);
3975             }
3976
3977             return;
3978         }
3979
3980         # Here, we have taken care of the case where $replace is $NO.
3981         # Remember that here, r[$i-1]->end < $start <= r[$i]->end
3982         # If inserting a multiple record, this is where it goes, before the
3983         # first (if any) existing one if inserting LIFO.  (If this is to go
3984         # afterwards, FIFO, we below move the pointer to there.)  These imply
3985         # an insertion, and no change to any existing ranges.  Note that $i
3986         # can be -1 if this new range doesn't actually duplicate any existing,
3987         # and comes at the beginning of the list.
3988         if ($replace == $MULTIPLE_BEFORE || $replace == $MULTIPLE_AFTER) {
3989
3990             if ($start != $end) {
3991                 Carp::my_carp_bug("$owner_name_of{$addr}Can't cope with adding a multiple record when the range ($start..$end) contains more than one code point.  No action taken.");
3992                 return;
3993             }
3994
3995             # If the new code point is within a current range ...
3996             if ($end >= $r->[$i]->start) {
3997
3998                 # Don't add an exact duplicate, as it isn't really a multiple
3999                 my $existing_value = $r->[$i]->value;
4000                 my $existing_type = $r->[$i]->type;
4001                 return if $value eq $existing_value && $type eq $existing_type;
4002
4003                 # If the multiple value is part of an existing range, we want
4004                 # to split up that range, so that only the single code point
4005                 # is affected.  To do this, we first call ourselves
4006                 # recursively to delete that code point from the table, having
4007                 # preserved its current data above.  Then we call ourselves
4008                 # recursively again to add the new multiple, which we know by
4009  &nb