EmojiEntityMapper Class Reference

Singleton helper class to map emoji entities to other formats. More...

#include <src/emoji.h>

Collaboration diagram for EmojiEntityMapper:

Public Member Functions
const char *	name (int index) const
	Access routine to the name of the Emoji entity.
const char *	unicode (int index) const
	Access routine to the unicode sequence for the Emoji entity.
void	writeEmojiFile (TextStream &t)
	Writes the list of supported emojis to the given file.
int	symbol2index (const std::string &symName) const
	Returns a code for the requested Emoji entity name.

Static Public Member Functions
static EmojiEntityMapper &	instance ()
	Returns the one and only instance of the Emoji entity mapper.

Private Member Functions
	EmojiEntityMapper ()
	~EmojiEntityMapper ()

Private Attributes
std::map< std::string, int >	m_name2symGh

Static Private Attributes
static EmojiEntityMapper *	s_instance = nullptr

Detailed Description

Singleton helper class to map emoji entities to other formats.

Definition at line 26 of file emoji.h.

Constructor & Destructor Documentation

EmojiEntityMapper()

EmojiEntityMapper::EmojiEntityMapper ( )

private

Definition at line 1960 of file emoji.cpp.

{
  for (size_t i = 0; i < g_numEmojiEntities; i++)
  {
    m_name2symGh.emplace(g_emojiEntities[i].name, static_cast<int>(i));
  }
  for (size_t i = 0; i < g_numEmojiCompatibilityEntities; i++)
  {
    int ii = symbol2index(g_emojiCompatibilityEntities[i].newName);
    if (ii != -1) m_name2symGh.emplace(g_emojiCompatibilityEntities[i].oldName, ii);
  }
}

References g_emojiCompatibilityEntities, g_emojiEntities, g_numEmojiCompatibilityEntities, g_numEmojiEntities, m_name2symGh, name(), and symbol2index().

Referenced by instance().

~EmojiEntityMapper()

EmojiEntityMapper::~EmojiEntityMapper ( )

private

Definition at line 1973 of file emoji.cpp.

{
}

Member Function Documentation

instance()

EmojiEntityMapper & EmojiEntityMapper::instance ( )

static

Returns the one and only instance of the Emoji entity mapper.

Definition at line 1978 of file emoji.cpp.

{
  static EmojiEntityMapper inst;
  return inst;
}

References EmojiEntityMapper().

Referenced by DocEmoji::DocEmoji(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), TextDocVisitor::operator()(), XmlDocVisitor::operator()(), and readConfiguration().

name()

const char * EmojiEntityMapper::name

(

int

index

)

const

Access routine to the name of the Emoji entity.

Parameters

index

code of the requested Emoji entity returned by symbol2index()

Returns

the name of the Emoji entity in GitHub format (i.e. :smile:)

Definition at line 2026 of file emoji.cpp.

{
  return index>=0 && static_cast<size_t>(index)<g_numEmojiEntities ? g_emojiEntities[index].name : nullptr;
}

References g_emojiEntities, g_numEmojiEntities, and name().

Referenced by EmojiEntityMapper(), name(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

symbol2index()

int EmojiEntityMapper::symbol2index

(

const std::string &

symName

)

const

Returns a code for the requested Emoji entity name.

Parameters

symName

Emoji entity name

Returns

the code for the requested Emoji entity name, in case the requested Emoji item does not exist -1 is returned.

Definition at line 1990 of file emoji.cpp.

{
  auto it = m_name2symGh.find(symName);
  return it!=m_name2symGh.end() ? it->second : -1;
}

References m_name2symGh.

Referenced by DocEmoji::DocEmoji(), and EmojiEntityMapper().

unicode()

const char * EmojiEntityMapper::unicode

(

int

index

)

const

Access routine to the unicode sequence for the Emoji entity.

Parameters

index

code of the requested Emoji entity returned by symbol2index()

Returns

the unicode sequence of the Emoji entity,

Definition at line 2016 of file emoji.cpp.

{
  return index>=0 && static_cast<size_t>(index)<g_numEmojiEntities ? g_emojiEntities[index].unicode : nullptr;
}

References g_emojiEntities, g_numEmojiEntities, and unicode().

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), RTFDocVisitor::operator()(), TextDocVisitor::operator()(), and unicode().

writeEmojiFile()

void EmojiEntityMapper::writeEmojiFile

(

TextStream &

t

)

Writes the list of supported emojis to the given file.

Definition at line 1999 of file emoji.cpp.

{
  for (size_t i = 0; i < g_numEmojiEntities; i++)
  {
    t << g_emojiEntities[i].name << "\n";
  }
  for (size_t i = 0; i < g_numEmojiCompatibilityEntities; i++)
  {
    t << g_emojiCompatibilityEntities[i].oldName << "\n";
  }
}

References g_emojiCompatibilityEntities, g_emojiEntities, g_numEmojiCompatibilityEntities, g_numEmojiEntities, emojiEntityInfo::name, and emojiEntityCompatibility::oldName.

Referenced by readConfiguration().

Member Data Documentation

m_name2symGh

std::map<std::string,int> EmojiEntityMapper::m_name2symGh

private

Definition at line 40 of file emoji.h.

Referenced by EmojiEntityMapper(), and symbol2index().

s_instance

EmojiEntityMapper * EmojiEntityMapper::s_instance = nullptr

staticprivate

Definition at line 39 of file emoji.h.

---

The documentation for this class was generated from the following files:

• src/emoji.h
• src/emoji.cpp