8303018: Unicode Emoji Properties #13006

naotoj · 2023-03-13T21:16:24Z

Proposing accessor methods to Emoji properties defined in Unicode Technical Standard #51 in java.lang.Character class. This is per a request from the client group, as well as refining the currently existing ad-hoc emoji implementation in regex. A CSR has also been drafted, and I would appreciate reviews for it too.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue
Change requires CSR request JDK-8304027 to be approved

Issues

JDK-8303018: Unicode Emoji Properties
JDK-8304027: Unicode Emoji Properties (CSR)

Reviewers

Phil Race (@prrace - Reviewer) ⚠️ Review applies to 4b2a2418
Erik Joelsson (@erikj79 - Reviewer) ⚠️ Review applies to 4b2a2418
Roger Riggs (@RogerRiggs - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/13006/head:pull/13006
$ git checkout pull/13006

Update a local copy of the PR:
$ git checkout pull/13006
$ git pull https://git.openjdk.org/jdk.git pull/13006/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13006

View PR using the GUI difftool:
$ git pr show -t 13006

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/13006.diff

bridgekeeper · 2023-03-13T21:18:16Z

👋 Welcome back naoto! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2023-03-13T21:21:21Z

@naotoj The following labels will be automatically applied to this pull request:

build
core-libs
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2023-03-13T21:25:49Z

Webrevs

prrace

Not at all familiar with all these templates but everything I do understand lgtm :-)

AlanBateman · 2023-03-14T08:10:13Z

src/java.base/share/classes/java/lang/Character.java

+     *          {@code false} otherwise.
+     * @since   21
+     */
+    public static boolean isExtendedPictographic(int codePoint) {


Is there a "cut 'n paste" error here, it looks like the description has been copied from isEmojiComponent.

My bad. You are right. Corrected.

AlanBateman · 2023-03-14T08:13:11Z

src/java.base/share/classes/java/lang/Character.java

+
+    /**
+     * Determines if the specified character (Unicode code point) has the
+     * Emoji Presentation by default.


"has the Emoji Presentation", should that be "has the Emoji Presentation property"?

Fixed this one as well

Fixed this one as well

Spec update looks good. I suppose I have to use an emoji to react to that 👍

erikj79

Build changes look ok.

eirbjo · 2023-03-14T17:09:54Z

make/jdk/src/classes/build/tools/generatecharacter/GenerateCharacter.java

+        maskEmojiPresentation = 0x008000000000L,
+        maskEmojiModifier   = 0x010000000000L,
+        maskEmojiModifierBase = 0x020000000000L,
+        maskEmojiComponent  = 0x040000000000L,
+        maskExtendedPictographic = 0x080000000000L;



Would be nice the have the '=' aligned in the same column as the ones above, or at least have the emoji ones align with each other.

Thanks. Indentation aligned, and although in production -string is used so comments are not emitted, added information for B table in GenerateCharacter.propertiesComments for consistency.

eirbjo · 2023-03-14T17:38:17Z

Would it make sense to add something like the following to GenerateCharacter.propertiesComments?

if ((val & maskEmoji) == maskEmoji) {
    result.append(", emoji ");
}
if ((val & maskEmojiPresentation) == maskEmojiPresentation) {
    result.append(", emojiPresentation ");
}
if ((val & maskEmojiModifier) == maskEmojiModifier) {
    result.append(", emojiModifier ");
}
if ((val & maskEmojiModifierBase) == maskEmojiModifierBase) {
    result.append(", emojiModifierBase ");
}
if ((val & maskEmojiComponent) == maskEmojiComponent) {
    result.append(", emojiComponent ");
}
if ((val & maskExtendedPictographic) == maskExtendedPictographic) {
    result.append(", extendedPictographic ");
}

This updates the comments of the B table to something like this sample:

0x0000,  //  34   unassigned, L
0x0440,  //  35   unassigned, L, emoji , emojiComponent
0x0000,  //  36   unassigned, L

RogerRiggs

Looks good.
There are opportunities to modernize the code, but maybe separately.

RogerRiggs · 2023-03-14T20:47:55Z

make/jdk/src/classes/build/tools/generatecharacter/EmojiData.java

+            case "Emoji_Modifier_Base" -> EMOJI_MODIFIER_BASE;
+            case "Emoji_Component" -> EMOJI_COMPONENT;
+            case "Extended_Pictographic" -> EXTENDED_PICTOGRAPHIC;
+            default -> throw new InternalError();


It would be useful to include the "type" as the exception argument. It give some idea as to the corruption or missing case.

Added type to the error message

RogerRiggs · 2023-03-14T20:52:12Z

make/jdk/src/classes/build/tools/generatecharacter/GenerateCharacter.java

+        maskOtherLowercase  = 0x000100000000L,
+        maskOtherUppercase  = 0x000200000000L,
+        maskOtherAlphabetic = 0x000400000000L,
+        maskIdeographic     = 0x000800000000L,
+        maskIDStart         = 0x001000000000L,
+        maskIDContinue      = 0x002000000000L,
+        maskEmoji           = 0x004000000000L,
+        maskEmojiPresentation = 0x008000000000L,
+        maskEmojiModifier   = 0x010000000000L,
+        maskEmojiModifierBase = 0x020000000000L,
+        maskEmojiComponent  = 0x040000000000L,
+        maskExtendedPictographic = 0x080000000000L;


It would be good to leverage a common definition (perhaps a bit number) here and in EmojiData.java
and build the constants with <<< shifts.

Good point. I managed to get rid of the constants in EmojiData altogether, by using the constants in GenerateCharacter. Used the bit numbers to construct constants.

RogerRiggs · 2023-03-14T21:08:11Z

make/jdk/src/classes/build/tools/generatecharacter/GenerateCharacter.java

+        if (x.equals("maskEmoji")) return "0x" + hex4(maskEmoji >> 32);
+        if (x.equals("maskEmojiPresentation")) return "0x" + hex4(maskEmojiPresentation >> 32);
+        if (x.equals("maskEmojiModifier")) return "0x" + hex4(maskEmojiModifier >> 32);
+        if (x.equals("maskEmojiModifierBase")) return "0x" + hex4(maskEmojiModifierBase >> 32);
+        if (x.equals("maskEmojiComponent")) return "0x" + hex4(maskEmojiComponent >> 32);
+        if (x.equals("maskExtendedPictographic")) return "0x" + hex4(maskExtendedPictographic >> 32);


An upgrade would be to modify hex4(), hexNN() to use HexFormat.of().toUpperCase().toHexDigits((short)xxx)
The HexFormat is reusable and would avoid creating extra strings.
Perhaps also create a method that combines the repetitive shift and prefixing.

This if...then... sequence could be an expression switch (x) {...}.

It would be good, but it would be for another day IMO.

eirbjo · 2023-03-15T20:43:22Z

Unrelated side note: Reviewing this PR inspired me to see if one could generate more efficient switch expressions for the CharacterDataLatin1 methods as replacement for the property lookup / masking done today. This seemed to give a small improvements on benchmarks and also collapsed a few methods to simply "return false". Could be something to explore at a later point.

naotoj · 2023-03-15T21:31:29Z

Unrelated side note: Reviewing this PR inspired me to see if one could generate more efficient switch expressions for the CharacterDataLatin1 methods as replacement for the property lookup / masking done today. This seemed to give a small improvements on benchmarks and also collapsed a few methods to simply "return false". Could be something to explore at a later point.

Yeah, agree. Latin1 can be (should be?) fast-path'ed as always.

openjdk · 2023-03-20T20:09:07Z

@naotoj This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8303018: Unicode Emoji Properties

Reviewed-by: prr, erikj, rriggs

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 88 new commits pushed to the master branch:

bc0ed73: 8304303: implement VirtualThread class notifyJvmti methods as C2 intrinsics
2d0d057: 8304016: Add BitMap find_last suite of functions
42723dc: 8304420: Regression ~11% with Javac-Generates on all platforms in b14
19f2edd: 8304541: Modules THROW_MSG_ should return nullptr instead of JNI_FALSE
622f239: 8304163: Move jdk.internal.module.ModuleInfoWriter to the test library
4c8c993: 8304364: [AIX] Build erroneously determines build disk is non-local when using GNU-utils df on AIX
4ed7350: 8304393: Provide method to iterate over regions of humongous object in G1
eb73fa8: 8301715: CDS should be disabled in exploded JDK
80e9797: 8304433: cleanup sentence breaker code in DocTreeMaker
c396f1e: 8304443: bootcycle builds fail after JDK-8015831
... and 78 more: https://git.openjdk.org/jdk/compare/5685107579f0f00b5eae881311315cec34c1ddcb...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

naotoj · 2023-03-20T20:19:10Z

/integrate

openjdk · 2023-03-20T20:20:28Z

Going to push as commit f593a6b.
Since your change was applied there have been 88 commits pushed to the master branch:

bc0ed73: 8304303: implement VirtualThread class notifyJvmti methods as C2 intrinsics
2d0d057: 8304016: Add BitMap find_last suite of functions
42723dc: 8304420: Regression ~11% with Javac-Generates on all platforms in b14
19f2edd: 8304541: Modules THROW_MSG_ should return nullptr instead of JNI_FALSE
622f239: 8304163: Move jdk.internal.module.ModuleInfoWriter to the test library
4c8c993: 8304364: [AIX] Build erroneously determines build disk is non-local when using GNU-utils df on AIX
4ed7350: 8304393: Provide method to iterate over regions of humongous object in G1
eb73fa8: 8301715: CDS should be disabled in exploded JDK
80e9797: 8304433: cleanup sentence breaker code in DocTreeMaker
c396f1e: 8304443: bootcycle builds fail after JDK-8015831
... and 78 more: https://git.openjdk.org/jdk/compare/5685107579f0f00b5eae881311315cec34c1ddcb...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-03-20T20:20:43Z

@naotoj Pushed as commit f593a6b.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

naotoj added 5 commits March 13, 2023 10:44

8303018: Unicode Emoji Properties

ce48bfa

added a test case

be73d6b

prepared javadoc

c30c77a

UTR -> UTS

b403fd9

Clean-up

4b2a241

openjdk bot added the rfr Pull request is ready for review label Mar 13, 2023

openjdk bot added build build-dev@openjdk.org core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Mar 13, 2023

openjdk bot added the csr Pull request needs approved CSR before integration label Mar 13, 2023

prrace approved these changes Mar 14, 2023

View reviewed changes

AlanBateman reviewed Mar 14, 2023

View reviewed changes

erikj79 approved these changes Mar 14, 2023

View reviewed changes

Fixed method descriptions

0b7b729

eirbjo reviewed Mar 14, 2023

View reviewed changes

RogerRiggs approved these changes Mar 14, 2023

View reviewed changes

naotoj added 2 commits March 14, 2023 14:46

Indentation/print comment fix

49613a0

InternalError message/mask constants cleanup

6b4eef9

RogerRiggs approved these changes Mar 15, 2023

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 20, 2023

openjdk bot added the ready Pull request is ready to be integrated label Mar 20, 2023

openjdk bot added the integrated Pull request has been integrated label Mar 20, 2023

openjdk bot closed this Mar 20, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 20, 2023

8303018: Unicode Emoji Properties #13006

8303018: Unicode Emoji Properties #13006

naotoj commented Mar 13, 2023 •

edited by openjdk bot

bridgekeeper bot commented Mar 13, 2023

openjdk bot commented Mar 13, 2023

mlbridge bot commented Mar 13, 2023 •

edited

prrace left a comment

AlanBateman Mar 14, 2023

naotoj Mar 14, 2023

AlanBateman Mar 14, 2023

naotoj Mar 14, 2023

AlanBateman Mar 14, 2023

erikj79 left a comment

eirbjo Mar 14, 2023

naotoj Mar 15, 2023

eirbjo commented Mar 14, 2023

RogerRiggs left a comment

RogerRiggs Mar 14, 2023

naotoj Mar 15, 2023

RogerRiggs Mar 14, 2023

naotoj Mar 15, 2023

RogerRiggs Mar 14, 2023

naotoj Mar 15, 2023

eirbjo commented Mar 15, 2023

naotoj commented Mar 15, 2023

openjdk bot commented Mar 20, 2023

naotoj commented Mar 20, 2023

openjdk bot commented Mar 20, 2023

openjdk bot commented Mar 20, 2023

8303018: Unicode Emoji Properties #13006

8303018: Unicode Emoji Properties #13006

Conversation

naotoj commented Mar 13, 2023 • edited by openjdk bot

Progress

Issues

Reviewers

Reviewing

bridgekeeper bot commented Mar 13, 2023

openjdk bot commented Mar 13, 2023

mlbridge bot commented Mar 13, 2023 • edited

Webrevs

prrace left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikj79 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eirbjo commented Mar 14, 2023

RogerRiggs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eirbjo commented Mar 15, 2023

naotoj commented Mar 15, 2023

openjdk bot commented Mar 20, 2023

naotoj commented Mar 20, 2023

openjdk bot commented Mar 20, 2023

openjdk bot commented Mar 20, 2023

naotoj commented Mar 13, 2023 •

edited by openjdk bot

mlbridge bot commented Mar 13, 2023 •

edited