1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.text;
18 
19 import android.icu.lang.UCharacter;
20 import android.icu.lang.UProperty;
21 
22 /**
23  * An utility class for Emoji.
24  * @hide
25  */
26 public class Emoji {
27     public static int COMBINING_ENCLOSING_KEYCAP = 0x20E3;
28 
29     public static int ZERO_WIDTH_JOINER = 0x200D;
30 
31     public static int VARIATION_SELECTOR_16 = 0xFE0F;
32 
33     public static int CANCEL_TAG = 0xE007F;
34 
35     /**
36      * Returns true if the given code point is regional indicator symbol.
37      */
isRegionalIndicatorSymbol(int codePoint)38     public static boolean isRegionalIndicatorSymbol(int codePoint) {
39         return 0x1F1E6 <= codePoint && codePoint <= 0x1F1FF;
40     }
41 
42     /**
43      * Returns true if the given code point is emoji modifier.
44      */
isEmojiModifier(int codePoint)45     public static boolean isEmojiModifier(int codePoint) {
46         return UCharacter.hasBinaryProperty(codePoint, UProperty.EMOJI_MODIFIER);
47     }
48 
49     //
50 
51     /**
52      * Returns true if the given code point is emoji modifier base.
53      * @param c codepoint to check
54      * @return true if is emoji modifier base
55      */
isEmojiModifierBase(int c)56     public static boolean isEmojiModifierBase(int c) {
57         // These two characters were removed from Emoji_Modifier_Base in Emoji 4.0, but we need to
58         // keep them as emoji modifier bases since there are fonts and user-generated text out there
59         // that treats these as potential emoji bases.
60         if (c == 0x1F91D || c == 0x1F93C) {
61             return true;
62         }
63         // Emoji Modifier Base characters new in Unicode emoji 11
64         // From https://www.unicode.org/Public/emoji/11.0/emoji-data.txt
65         // TODO: Remove once emoji-data.text 11 is in ICU or update to 11.
66         if ((0x1F9B5 <= c && c <= 0x1F9B6) || (0x1F9B8 <= c && c <= 0x1F9B9)) {
67             return true;
68         }
69         return UCharacter.hasBinaryProperty(c, UProperty.EMOJI_MODIFIER_BASE);
70     }
71 
72     /**
73      * Returns true if the character is a new emoji still not supported in our version of ICU.
74      */
isNewEmoji(int c)75     public static boolean isNewEmoji(int c) {
76         // Emoji characters new in Unicode emoji 12
77         // From https://www.unicode.org/Public/emoji/12.0/emoji-data.txt
78         // TODO: Remove once emoji-data.text 12 is in ICU or update to 12.
79         if (c < 0x1F6D5 || c > 0x1FA95) {
80             // Optimization for characters outside the new emoji range.
81             return false;
82         }
83         return c == 0x1F6D5 || c == 0x1F6FA || c == 0x1F93F || c == 0x1F971 || c == 0x1F97B
84                 || (0x1F7E0 <= c && c <= 0x1F7EB) || (0x1F90D <= c && c <= 0x1F90F)
85                 || (0x1F9A5 <= c && c <= 0x1F9AA) || (0x1F9AE <= c && c <= 0x1F9AF)
86                 || (0x1F9BA <= c && c <= 0x1F9BF) || (0x1F9C3 <= c && c <= 0x1F9CA)
87                 || (0x1F9CD <= c && c <= 0x1F9CF) || (0x1FA70 <= c && c <= 0x1FA73)
88                 || (0x1FA78 <= c && c <= 0x1FA7A) || (0x1FA80 <= c && c <= 0x1FA82)
89                 || (0x1FA90 <= c && c <= 0x1FA95);
90     }
91 
92     /**
93      * Returns true if the character has Emoji property.
94      */
isEmoji(int codePoint)95     public static boolean isEmoji(int codePoint) {
96         return isNewEmoji(codePoint) || UCharacter.hasBinaryProperty(codePoint, UProperty.EMOJI);
97     }
98 
99     // Returns true if the character can be a base character of COMBINING ENCLOSING KEYCAP.
isKeycapBase(int codePoint)100     public static boolean isKeycapBase(int codePoint) {
101         return ('0' <= codePoint && codePoint <= '9') || codePoint == '#' || codePoint == '*';
102     }
103 
104     /**
105      * Returns true if the character can be a part of tag_spec in emoji tag sequence.
106      *
107      * Note that 0xE007F (CANCEL TAG) is not included.
108      */
isTagSpecChar(int codePoint)109     public static boolean isTagSpecChar(int codePoint) {
110         return 0xE0020 <= codePoint && codePoint <= 0xE007E;
111     }
112 }
113