This is the cl-emoji Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 03:52:15 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-emojicl-emoji provides the Unicode emoji characters
asciian
MIT
# :smile: Cl-Emoji [](http://quickdocs.org/cl-emoji/)
cl-emoji provides the Unicode emoji characters
:smile: :heart_eyes: :scream: :alien: :fire: :zzz: :hand:
cl-emoji is able to treat Emoji 5.0 defined in Unicode 10.0! (ex. UFO; https://emojipedia.org/flying-saucer/)
## :boom: Usage
“‘lisp
(ql:quickload :cl-emoji)
(emoji:codepoint ’("U+1F600"))
=> "š"
(emoji:name "grinning face")
=> "š"
(emoji:annotation "face")
=> (("š" "U+1F600" "grinning face" ("face" "grin" "person")) ...)
;; We can also get emoji with slack-like string
(emoji:alpha-code ":grin:")
=> "š"
“‘
“‘lisp
(format t "Hello~a!~%" (emoji:name "grinning face"))
=> Helloš!
“‘
According to PR #3, we can use following APIs.
If you tell emoji version to cl-emoji API, do like this (and I checked if path generated at API calling):
“‘lisp
CL-USRE> (trace format)
CL-USER> (cl-emoji:annotation "grin")
0: (FORMAT NIL "file ~A"
"/home/foo/cl-emoji/data/emoji_4.0_release-30.lisp")
0: FORMAT returned
"file /home/foo/cl-emoji/data/emoji_4.0_release-30.lisp"
(("š" ("U+1F600") "grinning face" ("face" "grin") "Smileys & People"
"face-positive")
...)
CL-USER> (let ((cl-emoji:*current-version* (second cl-emoji:+versions+)))
(cl-emoji:annotation "grin"))
0: (FORMAT NIL "file ~A"
"/home/foo/cl-emoji/data/emoji_5.0_release-31.lisp")
0: FORMAT returned
"file /home/foo/cl-emoji/data/emoji_5.0_release-31.lisp"
(("š" ("U+1F600") "grinning face" ("face" "grin") "Smileys & People"
"face-positive")
...)
“‘
### :smile: Groups and Subgroups
Those are appears in [Full Emoji Data](http://www.unicode.org/emoji/charts-beta/full-emoji-list.html), for instance ‘Smileys & People‘ is a group and ‘face-positive‘ is a subgroup.
You can get emoji by group name and subgroup name with API ‘cl-emoji:group‘ and ‘cl-emoji:subgroup‘.
see also [Full Emoji Data](http://unicode.org/emoji/charts/full-emoji-list.html)
### :smile: Search
If you want to search available annotations/groups/subgroups, then.
“‘
CL-USER> (emoji:group-apropos "foo")
CL-USER> (emoji:subgroup-apropos "bar")
CL-USER> (emoji:annotation-apropos "bazz")
“‘
## :laughing: Author
* Fernado Garcia Borges (fgborges@pm.me)
## :ok_hand: Copyright
* Fernado Garcia Borges (fgborges@pm.me)
* src/cl-emoji.lisp is licensed under the MIT License
* data/emoji-list.lisp is licensed under the Unicoded License
0.2
src (module).
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
cl-emoji/src/cl-emoji.lispsrc (module).
*current-version* (special variable).
+versions+ (special variable).
alpha-code (function).
annotation (function).
annotation-apropos (function).
codepoint (function).
group (function).
group-apropos (function).
name (function).
subgroup (function).
subgroup-apropos (function).
with-emoji-list (macro).
bind1 (function).
bind2 (function).
emoji-apropos (function).
emoji-apropos-list (function).
load-emoji (function).
Packages are listed by definition order.
cl-emojiemoji
common-lisp.
*current-version* (special variable).
+versions+ (special variable).
alpha-code (function).
annotation (function).
annotation-apropos (function).
codepoint (function).
group (function).
group-apropos (function).
name (function).
subgroup (function).
subgroup-apropos (function).
with-emoji-list (macro).
bind1 (function).
bind2 (function).
emoji-apropos (function).
emoji-apropos-list (function).
load-emoji (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
| Jump to: | A B C E F G L M N S W |
|---|
| Jump to: | A B C E F G L M N S W |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | C F M P S |
|---|
| Jump to: | C F M P S |
|---|