Add emoji documentation.

2 files changed, 121 insertions, 9 deletions

diff --git a/unicode/Makefile.am b/unicode/Makefile.am
index a3dad14..170cdce 100644
--- a/unicode/Makefile.am
+++ b/unicode/Makefile.am
@@ -127,6 +127,13 @@ man_MANS= \
         $(srcdir)/man/unicode_convert_toutf8.3 \
         $(srcdir)/man/unicode_convert_uc.3 \
         $(srcdir)/man/unicode_default_chset.3 \
+        $(srcdir)/man/unicode_emoji.3 \
+        $(srcdir)/man/unicode_emoji_component.3 \
+        $(srcdir)/man/unicode_emoji_extended_pictographic.3 \
+        $(srcdir)/man/unicode_emoji_lookup.3 \
+        $(srcdir)/man/unicode_emoji_modifier.3 \
+        $(srcdir)/man/unicode_emoji_modifier_base.3 \
+        $(srcdir)/man/unicode_emoji_presentation.3 \
         $(srcdir)/man/unicode_grapheme_break.3 \
         $(srcdir)/man/unicode_grapheme_break_deinit.3 \
         $(srcdir)/man/unicode_grapheme_break_init.3 \
diff --git a/unicode/book.xml b/unicode/book.xml
index 64a0635..9c1486c 100644
--- a/unicode/book.xml
+++ b/unicode/book.xml
@@ -6,6 +6,7 @@
 <!ENTITY tr14ver "45">
 <!ENTITY tr24ver "31">
 <!ENTITY tr29ver "37">
+<!ENTITY tr51ver "18">
 ]>
 
 <!--
@@ -228,21 +229,24 @@ See COPYING for distribution information.
 	  <title>SEE ALSO</title>
 
 	  <para>
+	    <link linkend="unicode_bidi">
+	      <citerefentry><refentrytitle>unicode_bidi</refentrytitle>
+	      <manvolnum>3</manvolnum></citerefentry></link>,
+	    <link linkend="unicode_category_lookup">
+	      <citerefentry><refentrytitle>unicode_category_lookup</refentrytitle>
+	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode_convert">
 	      <citerefentry><refentrytitle>unicode_convert</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode_default_chset">
 	      <citerefentry><refentrytitle>unicode_default_chset</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
+	    <link linkend="unicode_emoji_lookup">
+	      <citerefentry><refentrytitle>unicode_emoji_lookup</refentrytitle>
+	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode_html40ent_lookup">
 	      <citerefentry><refentrytitle>unicode_html40ent_lookup</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
-	    <link linkend="unicode_bidi">
-	      <citerefentry><refentrytitle>unicode_bidi</refentrytitle>
-	      <manvolnum>3</manvolnum></citerefentry></link>,
-	    <link linkend="unicode_category_lookup">
-	      <citerefentry><refentrytitle>unicode_category_lookup</refentrytitle>
-	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode_grapheme_break">
 	      <citerefentry><refentrytitle>unicode_grapheme_break</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
@@ -252,12 +256,12 @@ See COPYING for distribution information.
 	    <link linkend="unicode_script">
 	      <citerefentry><refentrytitle>unicode_script</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
-	    <link linkend="unicode_word_break">
-	      <citerefentry><refentrytitle>unicode_word_break</refentrytitle>
-	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode_uc">
 	      <citerefentry><refentrytitle>unicode_uc</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
+	    <link linkend="unicode_word_break">
+	      <citerefentry><refentrytitle>unicode_word_break</refentrytitle>
+	      <manvolnum>3</manvolnum></citerefentry></link>,
 	    <link linkend="unicode__bidi">
 	      <citerefentry><refentrytitle>unicode::bidi</refentrytitle>
 	      <manvolnum>3</manvolnum></citerefentry></link>,
@@ -1152,6 +1156,107 @@ See COPYING for distribution information.
 	</refsect1>
       </refentry>
 
+      <refentry id="unicode_emoji_lookup">
+	<refentryinfo><author><firstname>Sam</firstname><surname>Varshavchik</surname><contrib>Author</contrib></author><productname>Courier Unicode Library</productname></refentryinfo>
+
+	<refmeta>
+	  <refentrytitle>unicode_emoji_lookup</refentrytitle>
+	  <manvolnum>3</manvolnum>
+	</refmeta>
+
+	<refnamediv>
+	  <refname>unicode_emoji_lookup</refname>
+          <refname>unicode_emoji</refname>
+          <refname>unicode_emoji_presentation</refname>
+	  <refname>unicode_emoji_modifier</refname>
+	  <refname>unicode_emoji_modifier_base</refname>
+	  <refname>unicode_emoji_component</refname>
+	  <refname>unicode_emoji_extended_pictographic</refname>
+
+	  <refpurpose>look up unicode character's Unicode Emoji Classification</refpurpose>
+	</refnamediv>
+
+	<refsynopsisdiv>
+	  <funcsynopsis>
+	    <funcsynopsisinfo>#include &lt;courier-unicode.h&gt;</funcsynopsisinfo>
+	    <funcprototype>
+              <funcdef>unicode_emoji_t <function>unicode_emoji_lookup</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji_presentation</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji_modifier</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji_modifier_base</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji_component</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+
+	  <funcsynopsis>
+	    <funcprototype>
+              <funcdef>int <function>unicode_emoji_extended_pictographic</function></funcdef>
+              <paramdef>char32_t <parameter>c</parameter></paramdef>
+	    </funcprototype>
+	  </funcsynopsis>
+	</refsynopsisdiv>
+	<refsect1>
+	  <title>DESCRIPTION</title>
+	  <para>
+	    <function>unicode_emoji_lookup</function>() returns the
+	    unicode emoji properties of the specified character, as a bitmask
+	    of <literal>UNICODE_EMOJI</literal> flags, as defined in the
+	    header file.
+	    <function>unicode_emoji</function>(),
+	    <function>unicode_emoji_presentation</function>(),
+	    <function>unicode_emoji_modifier</function>(),
+	    <function>unicode_emoji_modifier_base</function>(),
+	    <function>unicode_emoji_component</function>(), and
+	    <function>unicode_emoji_extended_pictographic</function>()
+	    check whether the given character carries a specific emoji
+	    property. They return 0 if not, and non-0 if the specified
+	    character has the corresponding property.
+	  </para>
+        </refsect1>
+	<refsect1>
+	  <title>SEE ALSO</title>
+	  <para>
+	    <ulink url="https://www.unicode.org/reports/tr51/tr51-&tr51ver;.html">TR-51</ulink>,
+	    <link linkend="courier-unicode">
+	      <citerefentry>
+		<refentrytitle>courier-unicode</refentrytitle>
+		<manvolnum>7</manvolnum></citerefentry></link>.
+	  </para>
+	</refsect1>
+      </refentry>
+
       <refentry id="unicode_html40ent_lookup">
 	<refentryinfo><author><firstname>Sam</firstname><surname>Varshavchik</surname><contrib>Author</contrib></author><productname>Courier Unicode Library</productname></refentryinfo>