3 # Makes emoji support available within ZSH
5 # See the README for documentation.
7 # Handle $0 according to the standard:
8 # https://zdharma-continuum.github.io/Zsh-100-Commits-Club/Zsh-Plugin-Standard.html
9 0="${${ZERO:-${0:#$ZSH_ARGZERO}}:-${(%):-%N}}"
10 0="${${(M)0:#/*}:-$PWD/$0}"
12 _omz_emoji_plugin_dir="${0:h}"
16 local LC_ALL=en_US.UTF-8
18 typeset -gAH emoji_skintone
20 source "$_omz_emoji_plugin_dir/emoji-char-definitions.zsh"
21 unset _omz_emoji_plugin_dir
23 # These additional emoji are not in the definition file, but are useful in conjunction with it
25 # This is a combining character that can be placed after any other character to surround
26 # it in a "keycap" symbol.
27 # The digits 0-9 are already in the emoji table as keycap_digit_<N>, keycap_ten, etc.
28 # It's unclear whether this should be in the $emoji array, because those characters are all ones
29 # which can be displayed on their own.
31 emoji[regional_indicator_symbol_letter_d_regional_indicator_symbol_letter_e]=$'\xF0\x9F\x87\xA9\xF0\x9F\x87\xAA'
32 emoji[regional_indicator_symbol_letter_g_regional_indicator_symbol_letter_b]=$'\xF0\x9F\x87\xAC\xF0\x9F\x87\xA7'
33 emoji[regional_indicator_symbol_letter_c_regional_indicator_symbol_letter_n]=$'\xF0\x9F\x87\xA8\xF0\x9F\x87\xB3'
34 emoji[regional_indicator_symbol_letter_j_regional_indicator_symbol_letter_p]=$'\xF0\x9F\x87\xAF\xF0\x9F\x87\xB5'
35 emoji[regional_indicator_symbol_letter_k_regional_indicator_symbol_letter_r]=$'\xF0\x9F\x87\xB0\xF0\x9F\x87\xB7'
36 emoji[regional_indicator_symbol_letter_f_regional_indicator_symbol_letter_r]=$'\xF0\x9F\x87\xAB\xF0\x9F\x87\xB7'
37 emoji[regional_indicator_symbol_letter_e_regional_indicator_symbol_letter_s]=$'\xF0\x9F\x87\xAA\xF0\x9F\x87\xB8'
38 emoji[regional_indicator_symbol_letter_i_regional_indicator_symbol_letter_t]=$'\xF0\x9F\x87\xAE\xF0\x9F\x87\xB9'
39 emoji[regional_indicator_symbol_letter_u_regional_indicator_symbol_letter_s]=$'\xF0\x9F\x87\xBA\xF0\x9F\x87\xB8'
40 emoji[regional_indicator_symbol_letter_r_regional_indicator_symbol_letter_u]=$'\xF0\x9F\x87\xB7\xF0\x9F\x87\xBA'
42 # Easier access to skin tone modifiers
43 emoji_skintone[1_2]=$'\U1F3FB'
44 emoji_skintone[3]=$'\U1F3FC'
45 emoji_skintone[4]=$'\U1F3FD'
46 emoji_skintone[5]=$'\U1F3FE'
47 emoji_skintone[6]=$'\U1F3FF'
50 # Prints a random emoji character
52 # random_emoji [group]
54 function random_emoji() {
57 if [[ -z "$group" || "$group" == "all" ]]; then
60 names=(${=emoji_groups[$group]})
62 local list_size=${#names}
63 [[ $list_size -eq 0 ]] && return 1
64 local random_index=$(( ( RANDOM % $list_size ) + 1 ))
65 local name=${names[$random_index]}
66 if [[ "$group" == "flags" ]]; then
67 echo ${emoji_flags[$name]}
73 # Displays a listing of emoji with their names
75 # display_emoji [group]
77 function display_emoji() {
80 if [[ -z "$group" || "$group" == "all" ]]; then
83 names=(${=emoji_groups[$group]})
85 # The extra spaces in output here are a hack for readability, since some
86 # terminals treat these emoji chars as single-width.
89 if [[ "$group" == "flags" ]]; then
90 printf '%s ' "$emoji_flags[$i]"
92 printf '%s ' "$emoji[$i]"
94 # New line every 20 emoji, to avoid weirdnesses
95 if (($counter % 20 == 0)); then
98 let counter=$counter+1
102 if [[ "$group" == "flags" ]]; then
103 echo "${emoji_flags[$i]} = $i"
105 echo "${emoji[$i]} = $i"