Emoji 支持

Unicode 联盟定义了一组具有相应 Unicode 序列的 emoji。Doxygen 支持 GitHub 使用的 emoji 字符子集(基于列表 https://api.github.com/emojis)。Emoji 使用 \emoji 命令创建。例如,\emoji smile\emoji :smile: 都能生成 😄

表示

对于不同的 Doxygen 输出类型,定义了输出格式:

  • Unicode 代码序列,实际表示取决于加载的字体可能性
    • HTML
    • DocBook
    • RTF,转换为 UTF-16 表示。
  • 图像
    • {\LaTeX},如果找到图像(参见 Emoji 图像检索),否则显示纯文本 emoji(即 :<text>:
  • 纯文本 emoji(即 :<text>:
    • man(手册页格式)
    • perl(脚本语言格式)
  • 对于 XML,有一个专用的 <emoji> 标签,带有 nameunicode 属性。

Emoji 图像检索

图像列表可以通过以下 Python 脚本下载

# script to download the emoticons from GitHub and to produce a table for
# inclusion in Doxygen. Works with python 2.7+ and python 3.x
import json
import os
import argparse
import re
try:
import urllib.request as urlrequest
except ImportError
import urllib as urlrequest
unicode_re = re.compile(r'.*?/unicode/(.*?).png\?.*')
def get_emojis()
response = urlrequest.urlopen('https://api.github.com/emojis')
raw_data = response.read()
return json.loads(raw_data)
def download_images(dir_name, silent)
if not os.path.exists(dir_name)
os.makedirs(dir_name)
json_data = get_emojis()
num_items = len(json_data)
cur_item=0
for image,url in sorted(json_data.items())
image_name = image+'.png'
cur_item=cur_item+1
if url.find('/unicode/')==-1 or not os.path.isfile(dir_name+'/'+image_name)
success = True
with open(dir_name+'/'+image_name,'wb') as file
if not silent
print('%s/%s: fetching %s' % (cur_item,num_items,image_name))
try:
file.write(urlrequest.urlopen(url).read())
except:
print('Unable to fetch %s' % (image_name))
success = False
if not success
os.remove(dir_name+'/'+image_name)
else:
if not silent
print('%s/%s: skipping %s' % (cur_item,num_items,image_name))
def produce_table()
json_data = get_emojis()
lines = []
for image,url in sorted(json_data.items())
match = unicode_re.match(url)
if match
unicodes = match.group(1).split('-')
unicodes_html = ''.join(["&#x"+x+";" for x in unicodes])
image_str = "\":"+image+":\","
unicode_str = "\""+unicodes_html+"\""
lines.append(' { %-42s %-38s }' % (image_str,unicode_str))
out_str = ',\n'.join(lines)
print("{")
print(out_str)
print("};")
if __name__=="__main__"
parser = argparse.ArgumentParser()
parser.add_argument('-d','--dir',help='directory to place images in')
parser.add_argument('-t','--table',help='generate code fragment',action='store_true')
parser.add_argument('-s','--silent',help='silent mode',action='store_true')
args = parser.parse_args()
if args.table
produce_table()
if args.dir
download_images(args.dir, args.silent)

当使用 -d image_dir 选项调用脚本时,图像将下载到 image_dir 目录。

当使用 -s 选项调用脚本时,在抓取图像时不会显示进度消息,除非抓取图像失败。

通过 Doxygen 配置参数 LATEX_EMOJI_DIRECTORY 可以选择所需的目录。

为方便起见,运行脚本的结果的 zip 文件也可以从 https://doxygen.cn/dl/github_emojis.zip 下载。

要查看支持的 emoji 列表,可以执行以下命令
doxygen -f emoji <输出文件名>

转到下一节或返回索引