The cl-emoji Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-emoji Reference Manual

This is the cl-emoji Reference Manual, version 0.2, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:15:12 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

:smile: Cl-Emoji Quicklisp

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

:ok_hand: Copyright

Copyright (c) 2015 asciian (asciian@outlook.jp)


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Copyright (c) 2015 asciian (asciian@outlook.jp)

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


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 cl-emoji/src

Parent

cl-emoji (system)

Location

src/

Component

cl-emoji.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-emoji.asd

Location

cl-emoji.asd

Systems

cl-emoji (system)

Packages

cl-emoji-asd


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/cl-emoji.lisp

Packages

cl-emoji

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-emoji-asd

Source

cl-emoji.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 cl-emoji

Source

cl-emoji.lisp (file)

Nickname

emoji

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

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

cl-emoji

Source

cl-emoji.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-emoji.asd: The cl-emoji<dot>asd file
cl-emoji/src: The cl-emoji/src module
cl-emoji/src/cl-emoji.lisp: The cl-emoji/src/cl-emoji<dot>lisp file

F
File, Lisp, cl-emoji.asd: The cl-emoji<dot>asd file
File, Lisp, cl-emoji/src/cl-emoji.lisp: The cl-emoji/src/cl-emoji<dot>lisp file

L
Lisp File, cl-emoji.asd: The cl-emoji<dot>asd file
Lisp File, cl-emoji/src/cl-emoji.lisp: The cl-emoji/src/cl-emoji<dot>lisp file

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

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

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  

Next: , Previous: , Up: Indexes   [Contents][Index]

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  

Previous: , Up: Indexes   [Contents][Index]

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