1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
//!
//! Types for representing and customizing emoji
//!
use core::fmt;
use core::fmt::Display;
use core::marker::PhantomData;
use core::ops::Deref;
mod attributes;
pub use attributes::Family;
pub use attributes::Gender;
pub use attributes::Hair;
pub use attributes::OneOrTwo;
pub use attributes::Pair;
pub use attributes::Tone;
pub use attributes::TonePair;
pub use attributes::Version;
/// A specific emoji.
///
/// This is the basic type for all emojis, whether obtained via any of the statics (as defined in
/// the [`grouped`](crate::grouped) and [`flat`](crate::flat) module) or functions such as
/// [`parse_alias`](crate::parse_alias).
///
/// Tho, some statics are declared as [`With`] or [`WithNoDef`]. These represent customizable
/// emojis (i.e. a set of similar emojis), and provide functions for customizations (such as
/// [`With::tone`], [`With::gender`], and [`With::hair`]), which take an attribute to be customized
/// (such as [`Tone`], [`Gender`], or [`Hair`] respectively) and will eventually yield an `Emoji`.
///
/// `Emoji` implements `Display` to be directly printable (e.g. with `println!`). This will simply
/// print the [`grapheme`](Self::grapheme) (the Unicode sequence) of this emoji.
/// Additionally, this struct contains some meta data such as the explanatory
/// [`name`](Self::grapheme) of the emoji.
///
/// ```
/// # use emojic::emojis::Emoji;
/// # use emojic::emojis::Version;
/// let art = Emoji {
/// name: "artist palette",
/// since: Version(0,6), // E0.6
/// grapheme: "🎨",
/// };
/// assert_eq!(emojic::flat::ARTIST_PALETTE, art);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Emoji {
/// The full name of this emoji, much like a short description.
pub name: &'static str,
/// The Unicode Emoji version when this grapheme (i.e. emoji) was first introduced.
///
/// Notice, that since this stated version the recommended visuals may have changed or
/// additional variants might have been added related to this emoji. In that case, the
/// individual variants (which have their own `Emoji` instance) may have a different version
/// than the 'default' variant, depending on when they were first added, respetively.
pub since: Version,
/// The Unicode codepoint sequence of this emoji. The actual/rendered emoji.
pub grapheme: &'static str,
}
impl Emoji {
pub(crate) const fn new(name: &'static str, since: Version, grapheme: &'static str) -> Self {
Emoji {
name,
since,
grapheme,
}
}
}
impl Display for Emoji {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.grapheme)
}
}
/// Customizable emoji composer without default.
///
/// This struct contains a set of [`Emoji`] which can be differentiated by an attribute `M` such as
/// [`Tone`], [`Gender`], and [`Hair`]. Depending on the attribute type this struct provides
/// customization functions such as [`WithNoDef::tone`], [`WithNoDef::gender`],
/// and [`WithNoDef::hair`], respectively.
///
/// Notice unlike the [`With`], this struct has no default variant and thus can not directly be
/// used, instead customization is mandatory.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct WithNoDef<M, T: 'static> {
entries: &'static [T],
_m: PhantomData<M>,
}
impl<M, T> WithNoDef<M, T> {
pub(crate) const fn new(entries: &'static [T]) -> Self {
//assert_eq!(entries.len(), M::SIZE); invalid in const fn
WithNoDef {
entries,
_m: PhantomData,
}
}
}
/// Customizable emoji composer.
///
/// This struct contains a set of [`Emoji`] which can be differentiated by an attribute `M` such as
/// [`Tone`], [`Gender`], and [`Hair`]. Depending on the attribute type this struct provides
/// customization functions such as [`With::tone`], [`With::gender`], and [`With::hair`],
/// respectively.
///
/// Notice unlike the [`WithNoDef`], this struct has an default variant and thus `Deref`s to `T`,
/// and implements `Display` if `T` does.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct With<M, T: 'static> {
pub default: T,
entries: &'static [T],
_m: PhantomData<M>,
}
impl<M, T> With<M, T> {
pub(crate) const fn new(default: T, entries: &'static [T]) -> Self {
//assert_eq!(entries.len(), M::SIZE); invalid in const fn
With {
default,
entries,
_m: PhantomData,
}
}
}
impl<M, T> Deref for With<M, T> {
type Target = T;
fn deref(&self) -> &T {
&self.default
}
}
impl<M, T: Display> Display for With<M, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.default)
}
}
/// Customizing by [`Tone`].
///
/// # Examples
/// ```
/// # use emojic::flat::RAISING_HANDS;
/// # use emojic::Tone;
/// assert_eq!(RAISING_HANDS.to_string(), "🙌"); // default, derefs directly to `Emoji`
/// assert_eq!(RAISING_HANDS.tone(Tone::Medium).to_string(), "🙌🏽"); // Toned variant
/// ```
impl<T> With<Tone, T> {
pub const fn tone(&self, tone: Tone) -> &T {
&self.entries[tone as usize]
}
}
/// Customizing by [`Tone`] without defaults.
///
/// _There is currently no such emoji_
///
impl<T> WithNoDef<Tone, T> {
pub const fn tone(&self, tone: Tone) -> &T {
&self.entries[tone as usize]
}
}
/// Customizing by [`TonePair`].
///
/// Notice that [`Tone`] and `(Tone, Tone)` both implement `Into<TonePair>`.
///
/// # Examples
/// ```
/// # use emojic::flat::COUPLE_WITH_HEART;
/// # use emojic::Tone;
/// assert_eq!(COUPLE_WITH_HEART.to_string(), "💑"); // default, derefs directly to `Emoji`
/// assert_eq!(COUPLE_WITH_HEART.tone(Tone::Medium).to_string(), "💑🏽"); // Same skin tone
/// assert_eq!(COUPLE_WITH_HEART.tone((Tone::Light, Tone::Dark)).to_string(), "🧑🏻❤️🧑🏿"); // Two different skin tones
/// ```
impl<T> With<TonePair, T> {
pub fn tone(&self, tone: impl Into<TonePair>) -> &T {
self.tone_pair(tone.into())
}
pub const fn tone_pair(&self, tone_pair: TonePair) -> &T {
&self.entries[tone_pair.to_id()]
}
}
/// Customizing by [`TonePair`] without defaults.
///
/// _There is currently no such emoji_
///
impl<T> WithNoDef<TonePair, T> {
pub fn tone(&self, tone: impl Into<TonePair>) -> &T {
self.tone_pair(tone.into())
}
pub const fn tone_pair(&self, tone_pair: TonePair) -> &T {
&self.entries[tone_pair.to_id()]
}
}
/* Actually this does not exist currently in Unicode 13.1, so it doesn't make a lot of sens to put
it into the public API.
impl<T> With<TonePairReduced, T> {
pub fn tone(&self, tone: Tone) -> &T {
self.tone_pair((tone, tone))
}
pub fn tone_pair(&self, tone_pair: impl Into<TonePairReduced>) -> &T {
&self.entries[tone_pair.into().to_id()]
}
}
impl<T> WithNoDef<TonePairReduced, T> {
pub fn tone(&self, tone: Tone) -> &T {
self.tone_pair((tone, tone))
}
pub fn tone_pair(&self, tone_pair: impl Into<TonePairReduced>) -> &T {
&self.entries[tone_pair.into().to_id()]
}
}
*/
/// Customizing by [`Gender`].
///
/// # Examples
/// ```
/// # use emojic::flat::ELF;
/// # use emojic::Gender;
/// assert_eq!(ELF.to_string(), "🧝"); // default, derefs directly to `Emoji`
/// assert_eq!(ELF.gender(Gender::Female).to_string(), "🧝♀️"); // Variant with gender
/// ```
impl<T> With<Gender, T> {
pub const fn gender(&self, gender: Gender) -> &T {
&self.entries[gender as usize]
}
}
/// Customizing by [`Gender`] without defaults.
///
/// # Examples
/// ```
/// # use emojic::flat::PERSON_DANCING;
/// # use emojic::Gender;
/// //assert_eq!(PERSON_DANCING.to_string(), "?"); // no default, would not compile
/// assert_eq!(PERSON_DANCING.gender(Gender::Male).to_string(), "🕺"); // Variant with male gender
/// assert_eq!(PERSON_DANCING.gender(Gender::Female).to_string(), "💃"); // Variant with female gender
/// ```
impl<T> WithNoDef<Gender, T> {
pub const fn gender(&self, gender: Gender) -> &T {
&self.entries[gender as usize]
}
}
/// Customizing by [`Hair`].
///
/// # Examples
/// ```
/// # use emojic::flat::PERSON;
/// # use emojic::Hair;
/// assert_eq!(PERSON.to_string(), "🧑"); // default, derefs directly to `Emoji`
/// assert_eq!(PERSON.hair(Hair::Red).to_string(), "🧑🦰"); // Variant with hair style
/// ```
impl<T> With<Hair, T> {
pub const fn hair(&self, hair: Hair) -> &T {
&self.entries[hair as usize]
}
}
/// Customizing by [`Hair`] without defaults.
///
/// _There is currently no such emoji_
///
impl<T> WithNoDef<Hair, T> {
pub const fn hair(&self, hair: Hair) -> &T {
&self.entries[hair as usize]
}
}
/// Customizing by (gender) [`Pair`].
///
/// # Examples
/// ```
/// # use emojic::flat::PERSON_HOLDING_HANDS;
/// # use emojic::Pair;
/// assert_eq!(PERSON_HOLDING_HANDS.to_string(), "🧑🤝🧑"); // default, derefs directly to `Emoji`
/// assert_eq!(PERSON_HOLDING_HANDS.gender(Pair::Mixed).to_string(), "👫"); // With defined gender
/// ```
impl<T> With<Pair, T> {
pub fn gender(&self, pair: impl Into<Pair>) -> &T {
&self.entries[pair.into() as usize]
}
pub const fn pair(&self, pair: Pair) -> &T {
&self.entries[pair as usize]
}
}
/// Customizing by [`Pair`] without defaults.
///
/// _There is currently no such emoji_
///
impl<T> WithNoDef<Pair, T> {
pub fn gender(&self, pair: impl Into<Pair>) -> &T {
&self.entries[pair.into() as usize]
}
pub const fn pair(&self, pair: Pair) -> &T {
&self.entries[pair as usize]
}
}
impl<T> With<OneOrTwo, T> {
pub fn gender(&self, oot: impl Into<OneOrTwo>) -> &T {
&self.entries[oot.into().to_id()]
}
pub const fn pair(&self, oot: OneOrTwo) -> &T {
&self.entries[oot.to_id()]
}
}
impl<T> WithNoDef<OneOrTwo, T> {
pub fn gender(&self, oot: impl Into<OneOrTwo>) -> &T {
&self.entries[oot.into().to_id()]
}
pub const fn pair(&self, oot: OneOrTwo) -> &T {
&self.entries[oot.to_id()]
}
}
/// Customizing by [`Family`].
///
/// Notice that various type that implement `Into<Family>` such as `(Gender,Gender)`,
/// and `(Pair,Pair)`.
///
/// # Examples
/// ```
/// # use emojic::flat::FAMILY;
/// # use emojic::Gender;
/// # use emojic::Pair;
/// assert_eq!(FAMILY.to_string(), "👪"); // default, derefs directly to `Emoji`
/// assert_eq!(FAMILY.gender((Gender::Male, Gender::Female)).to_string(), "👨👧"); // Variant two single genders
/// assert_eq!(FAMILY.gender((Pair::Males, Pair::Females)).to_string(), "👨👨👧👧"); // Variant with two gender pairs
/// assert_eq!(FAMILY.gender(Gender::Female.with_children(Pair::Mixed)).to_string(), "👩👧👦"); // Variant based on composer chain
/// ```
impl<T> With<Family, T> {
pub fn gender(&self, family: impl Into<Family>) -> &T {
&self.entries[family.into().to_id()]
}
pub const fn family(&self, family: Family) -> &T {
&self.entries[family.to_id()]
}
}
/// Customizing by [`Family`] without defaults.
///
/// _There is currently no such emoji_
///
impl<T> WithNoDef<Family, T> {
pub fn gender(&self, family: impl Into<Family>) -> &T {
&self.entries[family.into().to_id()]
}
pub const fn family(&self, family: Family) -> &T {
&self.entries[family.to_id()]
}
}