Edit: /usr/share/perl5/pod/perluniprops.pod (285306B)
=begin comment
# !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
# This file is machine-generated by lib/unicore/mktables from the Unicode
# database, Version 9.0.0. Any changes made here will be lost!
To change this file, edit lib/unicore/mktables instead.
=end comment
=head1 NAME
perluniprops - Index of Unicode Version 9.0.0 character properties in Perl
=head1 DESCRIPTION
This document provides information about the portion of the Unicode database
that deals with character properties, that is the portion that is defined on
single code points. (L
below briefly mentions other data that Unicode provides.)
Perl can provide access to all non-provisional Unicode character properties,
though not all are enabled by default. The omitted ones are the Unihan
properties (accessible via the CPAN module L
) and certain
deprecated or Unicode-internal properties. (An installation may choose to
recompile Perl's tables to change this. See L.)
For most purposes, access to Unicode properties from the Perl core is through
regular expression matches, as described in the next section.
For some special purposes, and to access the properties that are not suitable
for regular expression matching, all the Unicode character properties that
Perl handles are accessible via the standard L module, as
described in the section L.
Perl also provides some additional extensions and short-cut synonyms
for Unicode properties.
This document merely lists all available properties and does not attempt to
explain what each property really means. There is a brief description of each
Perl extension; see L for more information on
these. There is some detail about Blocks, Scripts, General_Category,
and Bidi_Class in L, but to find out about the intricacies of the
official Unicode properties, refer to the Unicode standard. A good starting
place is L.
Note that you can define your own properties; see
L.
=head1 Properties accessible through C<\p{}> and C<\P{}>
The Perl regular expression C<\p{}> and C<\P{}> constructs give access to
most of the Unicode character properties. The table below shows all these
constructs, both single and compound forms.
B consist of two components, separated by an equals sign or a
colon. The first component is the property name, and the second component is
the particular value of the property to match against, for example,
C<\p{Script: Greek}> and C<\p{Script=Greek}> both mean to match characters
whose Script property value is Greek.
B, like C<\p{Greek}>, are mostly Perl-defined shortcuts for
their equivalent compound forms. The table shows these equivalences. (In our
example, C<\p{Greek}> is a just a shortcut for C<\p{Script=Greek}>.)
There are also a few Perl-defined single forms that are not shortcuts for a
compound form. One such is C<\p{Word}>. These are also listed in the table.
In parsing these constructs, Perl always ignores Upper/lower case differences
everywhere within the {braces}. Thus C<\p{Greek}> means the same thing as
C<\p{greek}>. But note that changing the case of the C<"p"> or C<"P"> before
the left brace completely changes the meaning of the construct, from "match"
(for C<\p{}>) to "doesn't match" (for C<\P{}>). Casing in this document is
for improved legibility.
Also, white space, hyphens, and underscores are normally ignored
everywhere between the {braces}, and hence can be freely added or removed
even if the C modifier hasn't been specified on the regular expression.
But in the table below a 'B' at the beginning of an entry
means that tighter (stricter) rules are used for that entry:
=over 4
=over 4
=item Single form (C<\p{name}>) tighter rules:
White space, hyphens, and underscores ARE significant
except for:
=over 4
=item * white space adjacent to a non-word character
=item * underscores separating digits in numbers
=back
That means, for example, that you can freely add or remove white space
adjacent to (but within) the braces without affecting the meaning.
=item Compound form (C<\p{name=value}> or C<\p{name:value}>) tighter rules:
The tighter rules given above for the single form apply to everything to the
right of the colon or equals; the looser rules still apply to everything to
the left.
That means, for example, that you can freely add or remove white space
adjacent to (but within) the braces and the colon or equal sign.
=back
=back
Some properties are considered obsolete by Unicode, but still available.
There are several varieties of obsolescence:
=over 4
=over 4
=item Stabilized
A property may be stabilized. Such a determination does not indicate
that the property should or should not be used; instead it is a declaration
that the property will not be maintained nor extended for newly encoded
characters. Such properties are marked with an 'B' in the
table.
=item Deprecated
A property may be deprecated, perhaps because its original intent
has been replaced by another property, or because its specification was
somehow defective. This means that its use is strongly
discouraged, so much so that a warning will be issued if used, unless the
regular expression is in the scope of a C>
statement. A 'B' flags each such entry in the table, and
the entry there for the longest, most descriptive version of the property will
give the reason it is deprecated, and perhaps advice. Perl may issue such a
warning, even for properties that aren't officially deprecated by Unicode,
when there used to be characters or code points that were matched by them, but
no longer. This is to warn you that your program may not work like it did on
earlier Unicode releases.
A deprecated property may be made unavailable in a future Perl version, so it
is best to move away from them.
A deprecated property may also be stabilized, but this fact is not shown.
=item Obsolete
Properties marked with an 'B' in the table are considered (plain)
obsolete. Generally this designation is given to properties that Unicode once
used for internal purposes (but not any longer).
=item Discouraged
This is not actually a Unicode-specified obsolescence, but applies to certain
Perl extensions that are present for backwards compatibility, but are
discouraged from being used. These are not obsolete, but their meanings are
not stable. Future Unicode versions could force any of these extensions to be
removed without warning, replaced by another property with the same name that
means something different. An 'B' flags each such entry in the
table. Use the equivalent shown instead.
In particular, matches in the Block property have single forms
defined by Perl that begin with C<"In_">, C<"Is_>, or even with no prefix at
all, Like all B forms, these are not stable. For example,
C<\p{Block=Deseret}> can currently be written as C<\p{In_Deseret}>,
C<\p{Is_Deseret}>, or C<\p{Deseret}>. But, a new Unicode version may
come along that would force Perl to change the meaning of one or more of
these, and your program would no longer be correct. Currently there are no
such conflicts with the form that begins C<"In_">, but there are many with the
other two shortcuts, and Unicode continues to define new properties that begin
with C<"In">, so it's quite possible that a conflict will occur in the future.
The compound form is guaranteed to not become obsolete, and its meaning is
clearer anyway. See L for more information about this.
=back
=back
The table below has two columns. The left column contains the C<\p{}>
constructs to look up, possibly preceded by the flags mentioned above; and
the right column contains information about them, like a description, or
synonyms. The table shows both the single and compound forms for each
property that has them. If the left column is a short name for a property,
the right column will give its longer, more descriptive name; and if the left
column is the longest name, the right column will show any equivalent shortest
name, in both single and compound forms if applicable.
If braces are not needed to specify a property (e.g., C<\pL>), the left
column contains both forms, with and without braces.
The right column will also caution you if a property means something different
than what might normally be expected.
All single forms are Perl extensions; a few compound forms are as well, and
are noted as such.
Numbers in (parentheses) indicate the total number of Unicode code points
matched by the property. For emphasis, those properties that match no code
points at all are listed as well in a separate section following the table.
Most properties match the same code points regardless of whether C<"/i">
case-insensitive matching is specified or not. But a few properties are
affected. These are shown with the notation S)>>
in the second column. Under case-insensitive matching they match the
same code pode points as the property I.
There is no description given for most non-Perl defined properties (See
L for that).
For compactness, 'B<*>' is used as a wildcard instead of showing all possible
combinations. For example, entries like:
\p{Gc: *} \p{General_Category: *}
mean that 'Gc' is a synonym for 'General_Category', and anything that is valid
for the latter is also valid for the former. Similarly,
\p{Is_*} \p{*}
means that if and only if, for example, C<\p{Foo}> exists, then
C<\p{Is_Foo}> and C<\p{IsFoo}> are also valid and all mean the same thing.
And similarly, C<\p{Foo=Bar}> means the same as C<\p{Is_Foo=Bar}> and
C<\p{IsFoo=Bar}>. "*" here is restricted to something not beginning with an
underscore.
Also, in binary properties, 'Yes', 'T', and 'True' are all synonyms for 'Y'.
And 'No', 'F', and 'False' are all synonyms for 'N'. The table shows 'Y*' and
'N*' to indicate this, and doesn't have separate entries for the other
possibilities. Note that not all properties which have values 'Yes' and 'No'
are binary, and they have all their values spelled out without using this wild
card, and a C clause in their description that highlights their not being
binary. These also require the compound form to match them, whereas true
binary properties have both single and compound forms available.
Note that all non-essential underscores are removed in the display of the
short names below.
B