The cl-emoji Reference Manual

This is the cl-emoji Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:24:13 2019 GMT+0.

1 Introduction

:smile: 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

(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")
 ...)

:smile: Groups and Subgroups

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

: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

asciian (asciian@outlook.jp)

:ok_hand: Copyright

src/cl-emoji.lisp is licensed under the MIT License
data/emoji-list.lisp is licensed under

2 Systems

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

2.1 `cl-emoji`

Author

asciian

License

MIT

Description

cl-emoji provides the Unicode emoji characters

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

* asciian (asciian@outlook.jp)

## :ok_hand: Copyright

* 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 (file)

Component

src (module)

3 Modules

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

3.1 `cl-emoji/src`

Parent: cl-emoji (system)
Location: src/
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.asd`

Location: cl-emoji.asd
Systems: cl-emoji (system)
Packages: cl-emoji-asd

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

Parent

src (module)

Location

src/cl-emoji.lisp

Packages

cl-emoji

Exported Definitions

*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)

Internal Definitions

bind1 (function)
bind2 (function)
emoji-apropos (function)
emoji-apropos-list (function)
load-emoji (function)

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 (file)

Nickname

emoji

Use List

common-lisp

Exported Definitions

*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)

Internal Definitions

bind1 (function)
bind2 (function)
emoji-apropos (function)
emoji-apropos-list (function)
load-emoji (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *current-version*

Package: cl-emoji
Source: cl-emoji.lisp (file)

Special Variable: +versions+

Package: cl-emoji
Source: cl-emoji.lisp (file)

6.1.2 Macros

Macro: with-emoji-list (EMOJI-LIST-VAR) &body BODY

Package: cl-emoji
Source: cl-emoji.lisp (file)

6.1.3 Functions

Function: alpha-code ALPHA-CODE

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: annotation ANNOT

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: annotation-apropos KEYWORD

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: codepoint CODE

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: group GROUP

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: group-apropos KEYWORD

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: name NAME

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: subgroup SUBGROUP

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: subgroup-apropos KEYWORD

Package: cl-emoji
Source: cl-emoji.lisp (file)

6.2 Internal definitions

6.2.1 Functions

Function: bind1 FUNCTION &rest ARGS1

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: bind2 FUNCTION &rest ARGS2

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: emoji-apropos KEY VALUE &key TEST

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: emoji-apropos-list KEY VALUE &key TEST

Package: cl-emoji
Source: cl-emoji.lisp (file)

Function: load-emoji ()

Package: cl-emoji
Source: cl-emoji.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L M

	Index Entry	Section

C
	`cl-emoji.asd`:	The cl-emoji․asd file
	`cl-emoji/src`:	The cl-emoji/src module
	`cl-emoji/src/cl-emoji.lisp`:	The cl-emoji/src/cl-emoji․lisp file

F
	File, Lisp, `cl-emoji.asd`:	The cl-emoji․asd file
	File, Lisp, `cl-emoji/src/cl-emoji.lisp`:	The cl-emoji/src/cl-emoji․lisp file

L
	Lisp File, `cl-emoji.asd`:	The cl-emoji․asd file
	Lisp File, `cl-emoji/src/cl-emoji.lisp`:	The cl-emoji/src/cl-emoji․lisp file

M
	Module, `cl-emoji/src`:	The cl-emoji/src module

Jump to:	C F L M

A.2 Functions

Jump to:	A B C E F G L M N S W

	Index Entry	Section

A
	`alpha-code`:	Exported functions
	`annotation`:	Exported functions
	`annotation-apropos`:	Exported functions

B
	`bind1`:	Internal functions
	`bind2`:	Internal functions

C
	`codepoint`:	Exported functions

E
	`emoji-apropos`:	Internal functions
	`emoji-apropos-list`:	Internal functions

F
	`Function, alpha-code`:	Exported functions
	`Function, annotation`:	Exported functions
	`Function, annotation-apropos`:	Exported functions
	`Function, bind1`:	Internal functions
	`Function, bind2`:	Internal functions
	`Function, codepoint`:	Exported functions
	`Function, emoji-apropos`:	Internal functions
	`Function, emoji-apropos-list`:	Internal functions
	`Function, group`:	Exported functions
	`Function, group-apropos`:	Exported functions
	`Function, load-emoji`:	Internal functions
	`Function, name`:	Exported functions
	`Function, subgroup`:	Exported functions
	`Function, subgroup-apropos`:	Exported functions

G
	`group`:	Exported functions
	`group-apropos`:	Exported functions

L
	`load-emoji`:	Internal functions

M
	`Macro, with-emoji-list`:	Exported macros

N
	`name`:	Exported functions

S
	`subgroup`:	Exported functions
	`subgroup-apropos`:	Exported functions

W
	`with-emoji-list`:	Exported macros

Jump to:	A B C E F G L M N S W

A.3 Variables

Jump to:	* + S

	Index Entry	Section

*
	`current-version`:	Exported special variables

+
	`+versions+`:	Exported special variables

S
	`Special Variable, current-version`:	Exported special variables
	`Special Variable, +versions+`:	Exported special variables

Jump to:	* + S

A.4 Data types

Jump to:	C P S

	Index Entry	Section

C
	`cl-emoji`:	The cl-emoji system
	`cl-emoji`:	The cl-emoji package
	`cl-emoji-asd`:	The cl-emoji-asd package

P
	`Package, cl-emoji`:	The cl-emoji package
	`Package, cl-emoji-asd`:	The cl-emoji-asd package

S
	`System, cl-emoji`:	The cl-emoji system

Jump to:	C P S

• 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

• Concept index
• Function index
• Variable index
• Data type index

• The cl-emoji.asd file
• The cl-emoji/src/cl-emoji.lisp file

• Exported special variables
• Exported macros
• Exported functions

The cl-emoji Reference Manual

Table of Contents

The cl-emoji Reference Manual

1 Introduction

:smile: Cl-Emoji

:boom: Usage

:smile: Groups and Subgroups

:smile: Search

:laughing: Author

:ok_hand: Copyright

2 Systems

2.1 cl-emoji

3 Modules

3.1 cl-emoji/src

4 Files

4.1 Lisp

4.1.1 cl-emoji.asd

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

5 Packages

5.1 cl-emoji-asd

5.2 cl-emoji

6 Definitions

6.1 Exported definitions

6.1.1 Special variables

6.1.2 Macros

6.1.3 Functions

6.2 Internal definitions

6.2.1 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-emoji`

3.1 `cl-emoji/src`

4.1.1 `cl-emoji.asd`

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

5.1 `cl-emoji-asd`

5.2 `cl-emoji`