deduplicate emojibase loading

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-04-20 19:17:58 +01:00 · 2020-04-20 19:17:58 +01:00 · 66d2a67142
commit 66d2a67142
parent 5c57b9ab9b
2 changed files with 24 additions and 20 deletions
--- a/src/emoji.ts
+++ b/src/emoji.ts
@ -0,0 +1,109 @@
+/*
+Copyright 2019 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// @ts-ignore - import * as EMOJIBASE actually breaks this
+import EMOJIBASE from 'emojibase-data/en/compact.json';
+
+export interface IEmoji {
+    annotation: string;
+    group: number;
+    hexcode: string;
+    order: number;
+    shortcodes: string[];
+    tags: string[];
+    unicode: string;
+    emoticon?: string;
+}
+
+interface IEmojiWithFilterString extends IEmoji {
+    filterString?: string;
+}
+
+// The unicode is stored without the variant selector
+const UNICODE_TO_EMOJI = new Map<string, IEmojiWithFilterString>(); // not exported as gets for it are handled by getEmojiFromUnicode
+export const EMOTICON_TO_EMOJI = new Map<string, IEmojiWithFilterString>();
+export const SHORTCODE_TO_EMOJI = new Map<string, IEmojiWithFilterString>();
+
+export const getEmojiFromUnicode = unicode => UNICODE_TO_EMOJI.get(stripVariation(unicode));
+
+const EMOJIBASE_GROUP_ID_TO_CATEGORY = [
+    "people", // smileys
+    "people", // actually people
+    "control", // modifiers and such, not displayed in picker
+    "nature",
+    "foods",
+    "places",
+    "activity",
+    "objects",
+    "symbols",
+    "flags",
+];
+
+export const DATA_BY_CATEGORY = {
+    "people": [],
+    "nature": [],
+    "foods": [],
+    "places": [],
+    "activity": [],
+    "objects": [],
+    "symbols": [],
+    "flags": [],
+};
+
+// Store various mappings from unicode/emoticon/shortcode to the Emoji objects
+EMOJIBASE.forEach((emoji: IEmojiWithFilterString) => {
+    const categoryId = EMOJIBASE_GROUP_ID_TO_CATEGORY[emoji.group];
+    if (DATA_BY_CATEGORY.hasOwnProperty(categoryId)) {
+        DATA_BY_CATEGORY[categoryId].push(emoji);
+    }
+    // This is used as the string to match the query against when filtering emojis
+    emoji.filterString = `${emoji.annotation}\n${emoji.shortcodes.join('\n')}}\n${emoji.emoticon || ''}`.toLowerCase();
+
+    // Add mapping from unicode to Emoji object
+    // The 'unicode' field that we use in emojibase has either
+    // VS15 or VS16 appended to any characters that can take
+    // variation selectors. Which one it appends depends
+    // on whether emojibase considers their type to be 'text' or
+    // 'emoji'. We therefore strip any variation chars from strings
+    // both when building the map and when looking up.
+    UNICODE_TO_EMOJI.set(stripVariation(emoji.unicode), emoji);
+
+    if (emoji.emoticon) {
+        // Add mapping from emoticon to Emoji object
+        EMOTICON_TO_EMOJI.set(emoji.emoticon, emoji);
+    }
+
+    if (emoji.shortcodes) {
+        // Add mapping from each shortcode to Emoji object
+        emoji.shortcodes.forEach(shortcode => {
+            SHORTCODE_TO_EMOJI.set(shortcode, emoji);
+        });
+    }
+});
+
+/**
+ * Strips variation selectors from the end of given string
+ * NB. Skin tone modifiers are not variation selectors:
+ * this function does not touch them. (Should it?)
+ *
+ * @param {string} str string to strip
+ * @returns {string} stripped string
+ */
+function stripVariation(str) {
+    return str.replace(/[\uFE00-\uFE0F]$/, "");
+}
+
+export const EMOJI: IEmoji[] = EMOJIBASE;