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