Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-emoji Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:15:05 2020 GMT+0.
• Introduction | What cl-emoji is all about | |
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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/)
(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:")
=> "š"
(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):
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")
...)
Those are appears in Full Emoji Data, 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
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")
Fernado Garcia Borges (fgborges@pm.me)
src/cl-emoji.lisp is licensed under the MIT License
data/emoji-list.lisp is licensed under
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The cl-emoji system |
asciian
MIT
cl-emoji provides the Unicode emoji characters
# :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
cl-emoji.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The cl-emoji/src module |
cl-emoji (system)
src/
cl-emoji.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The cl-emoji.asd file | ||
• The cl-emoji/src/cl-emoji.lisp file |
Next: The cl-emoji/src/cl-emojiā¤lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-emoji.asd
cl-emoji (system)
Previous: The cl-emojiā¤asd file, Up: Lisp files [Contents][Index]
src (module)
src/cl-emoji.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The cl-emoji-asd package | ||
• The cl-emoji package |
Next: The cl-emoji package, Previous: Packages, Up: Packages [Contents][Index]
cl-emoji.asd
Previous: The cl-emoji-asd package, Up: Packages [Contents][Index]
cl-emoji.lisp (file)
emoji
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
cl-emoji.lisp (file)
cl-emoji.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
cl-emoji.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
cl-emoji.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | C F L M |
---|
Jump to: | C F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
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 |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
S |
---|
Jump to: | *
+
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S |
---|
Jump to: | C P S |
---|