The cl-emoji Reference Manual

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.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-emoji

cl-emoji provides the Unicode emoji characters

Author

asciian

License

MIT

Long Description

# :smile: Cl-Emoji [![Quicklisp](http://quickdocs.org/badge/cl-emoji.svg)](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

Version

0.2

Source

cl-emoji.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-emoji/src

Source

cl-emoji.asd.

Parent Component

cl-emoji (system).

Child Component

cl-emoji.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-emoji/cl-emoji.asd

Source

cl-emoji.asd.

Parent Component

cl-emoji (system).

ASDF Systems

cl-emoji.

Packages

cl-emoji-asd.


4.1.2 cl-emoji/src/cl-emoji.lisp

Source

cl-emoji.asd.

Parent Component

src (module).

Packages

cl-emoji.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-emoji-asd

Source

cl-emoji.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 cl-emoji

Source

cl-emoji.lisp.

Nickname

emoji

Use List

common-lisp.

Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: *current-version*
Package

cl-emoji.

Source

cl-emoji.lisp.

Special Variable: +versions+
Package

cl-emoji.

Source

cl-emoji.lisp.


6.1.2 Macros

Macro: with-emoji-list ((emoji-list-var) &body body)
Package

cl-emoji.

Source

cl-emoji.lisp.


6.1.3 Ordinary functions

Function: alpha-code (alpha-code)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: annotation (annot)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: annotation-apropos (keyword)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: codepoint (code)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: group (group)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: group-apropos (keyword)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: name (name)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: subgroup (subgroup)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: subgroup-apropos (keyword)
Package

cl-emoji.

Source

cl-emoji.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: bind1 (function &rest args1)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: bind2 (function &rest args2)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: emoji-apropos (key value &key test)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: emoji-apropos-list (key value &key test)
Package

cl-emoji.

Source

cl-emoji.lisp.

Function: load-emoji ()
Package

cl-emoji.

Source

cl-emoji.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions