pimhwang
/
qTox
mirror of https://github.com/qTox/qTox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

refactor: SmileyPack refactoring 

Brief list of changes:
  - removed unnecessary headers;
  - QList several times replaced with QVector for faster iteration;
  - some other things
reviewable/pr4322/r10
noavarice 8 years ago
parent
b691cf9bed
commit
e0f1a01a74
2 changed files with 104 additions and 156 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 238
      src/persistence/smileypack.cpp
  2. 22
      src/persistence/smileypack.h

238
src/persistence/smileypack.cpp
Unescape View File

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
Copyright © 2014-2015 by The qTox Project Contributors
Copyright © 2014-2017 by The qTox Project Contributors
This file is part of qTox, a Qt-based graphical interface for Tox.
@ -19,34 +19,17 @@ @@ -19,34 +19,17 @@
#include "smileypack.h"
#include "src/persistence/settings.h"
#include "src/widget/style.h"
#include <QBuffer>
#include <QBuffer>
#include <QCoreApplication>
#include <QCoreApplication>
#include <QDir>
#include <QDir>
#include <QDomDocument>
#include <QDomDocument>
#include <QDomElement>
#include <QDomElement>
#include <QFile>
#include <QFileInfo>
#include <QFont>
#include <QFontInfo>
#include <QIcon>
#include <QPixmap>
#include <QRegularExpression>
#include <QStandardPaths>
#include <QStringBuilder>
#include <QtConcurrent/QtConcurrentRun>
#if defined(Q_OS_FREEBSD)
#include <locale.h>
#endif
#define EMOTICONS_SUB_DIR QStringLiteral("emoticons")
/**
* @class SmileyPack
* @brief Maps emoticons to smileys.
@ -67,36 +50,27 @@ @@ -67,36 +50,27 @@
* @brief Contains all directories where smileys could be found
*/
QStringList SmileyPack::defaultPaths = loadDefaultPaths();
QStringList loadDefaultPaths();
SmileyPack::SmileyPack()
{
loadingMutex.lock();
QtConcurrent::run(this, &SmileyPack::load, Settings::getInstance().getSmileyPack());
connect(&Settings::getInstance(), &Settings::smileyPackChanged, this,
&SmileyPack::onSmileyPackChanged);
}
static const QStringList DEFAULT_PATHS = loadDefaultPaths();
static const QString RICH_TEXT_PATTERN = QStringLiteral("<img title=\"%1\" src=\"key:%1\"\\>");
/**
* @brief Returns the singleton instance.
* @brief Construct list of standard directories with "emoticons" sub dir, whether these directories
* exist or not
* @return Constructed list of default emoticons directories
*/
SmileyPack& SmileyPack::getInstance()
{
static SmileyPack smileyPack;
return smileyPack;
}
QStringList SmileyPack::loadDefaultPaths()
QStringList loadDefaultPaths()
{
#if defined(Q_OS_FREEBSD)
// TODO: Remove when will be fixed.
// Workaround to fix https://bugreports.qt.io/browse/QTBUG-57522
setlocale(LC_ALL, "");
#endif
QStringList paths =
QStringList{":/smileys", "~/.kde4/share/emoticons", "~/.kde/share/emoticons"};
// qTox should find emoticons next to the binary
paths.append('.' + QDir::separator() + EMOTICONS_SUB_DIR);
const QString EMOTICONS_SUB_PATH = QDir::separator() + QStringLiteral("emoticons");
QStringList paths
{":/smileys", "~/.kde4/share/emoticons", "~/.kde/share/emoticons", EMOTICONS_SUB_PATH};
// qTox exclusive emoticons
QStandardPaths::StandardLocation location;
@ -106,36 +80,61 @@ QStringList SmileyPack::loadDefaultPaths() @@ -106,36 +80,61 @@ QStringList SmileyPack::loadDefaultPaths()
#warning "Qt < 5.4.0 has a trouble with unicode symbols in path on few systems"
location = QStandardPaths::DataLocation;
#endif
for (auto qtoxPath : QStandardPaths::standardLocations(location)) {
qtoxPath += QDir::separator() + EMOTICONS_SUB_DIR;
if (!paths.contains(qtoxPath)) {
paths << qtoxPath;
}
}
QStringList locations = QStandardPaths::standardLocations(location);
// system wide emoticons
for (auto genericPath : QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation)) {
genericPath += QDir::separator() + EMOTICONS_SUB_DIR;
if (!paths.contains(genericPath)) {
paths << genericPath;
locations.append(QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation));
for (QString qtoxPath : locations) {
qtoxPath.append(EMOTICONS_SUB_PATH);
if (!paths.contains(qtoxPath)) {
paths.append(qtoxPath);
}
}
return paths;
}
QList<QPair<QString, QString>> SmileyPack::listSmileyPacks()
/**
* @brief Wraps passed string into smiley HTML image reference
* @param key Describes which smiley is needed
* @return Key that wrapped into image ref
*/
QString getAsRichText(const QString& key)
{
return RICH_TEXT_PATTERN.arg(key);
}
SmileyPack::SmileyPack()
{
loadingMutex.lock();
QtConcurrent::run(this, &SmileyPack::load, Settings::getInstance().getSmileyPack());
connect(&Settings::getInstance(), &Settings::smileyPackChanged, this,
&SmileyPack::onSmileyPackChanged);
}
/**
* @brief Returns the singleton instance.
*/
SmileyPack& SmileyPack::getInstance()
{
return listSmileyPacks(defaultPaths);
static SmileyPack smileyPack;
return smileyPack;
}
QList<QPair<QString, QString>> SmileyPack::listSmileyPacks(const QStringList& paths)
QVector<QPair<QString, QString>> SmileyPack::listSmileyPacks()
{
QList<QPair<QString, QString>> smileyPacks;
return listSmileyPacks(DEFAULT_PATHS);
}
QVector<QPair<QString, QString>> SmileyPack::listSmileyPacks(const QStringList& paths)
{
QVector<QPair<QString, QString>> smileyPacks;
const QString fileName = QStringLiteral("emoticons.xml");
const QString homePath = QDir::homePath();
for (QString path : paths) {
if (path.leftRef(1) == "~") {
path.replace(0, 1, QDir::homePath());
if (path.startsWith('~')) {
path.replace(0, 1, homePath);
}
QDir dir(path);
@ -145,14 +144,11 @@ QList<QPair<QString, QString>> SmileyPack::listSmileyPacks(const QStringList& pa @@ -145,14 +144,11 @@ QList<QPair<QString, QString>> SmileyPack::listSmileyPacks(const QStringList& pa
for (const QString& subdirectory : dir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)) {
dir.cd(subdirectory);
QFileInfoList entries = dir.entryInfoList(QStringList() << "emoticons.xml", QDir::Files);
// Does it contain a file called emoticons.xml?
if (entries.size() > 0) {
QString packageName = dir.dirName();
QString absPath = entries[0].absoluteFilePath();
if (!smileyPacks.contains(QPair<QString, QString>(packageName, absPath))) {
smileyPacks << QPair<QString, QString>(packageName, absPath);
if (dir.exists(fileName)) {
QString absPath = dir.absolutePath() + QDir::separator() + fileName;
QPair<QString, QString> p{dir.dirName(), absPath};
if (!smileyPacks.contains(p)) {
smileyPacks.append(p);
}
}
@ -176,19 +172,16 @@ bool SmileyPack::isValid(const QString& filename) @@ -176,19 +172,16 @@ bool SmileyPack::isValid(const QString& filename)
*/
bool SmileyPack::load(const QString& filename)
{
// discard old data
filenameTable.clear();
iconCache.clear();
emoticons.clear();
path.clear();
// open emoticons.xml
QFile xmlFile(filename);
if (!xmlFile.open(QIODevice::ReadOnly)) {
if (!xmlFile.exists() || !xmlFile.open(QIODevice::ReadOnly)) {
loadingMutex.unlock();
return false; // cannot open file
return false;
}
QDomDocument doc;
doc.setContent(xmlFile.readAll());
xmlFile.close();
/* parse the cfg file
* sample:
* <?xml version='1.0'?>
@ -205,61 +198,54 @@ bool SmileyPack::load(const QString& filename) @@ -205,61 +198,54 @@ bool SmileyPack::load(const QString& filename)
*/
path = QFileInfo(filename).absolutePath();
QDomDocument doc;
doc.setContent(xmlFile.readAll());
QDomNodeList emoticonElements = doc.elementsByTagName("emoticon");
for (int i = 0; i < emoticonElements.size(); ++i) {
QString file = emoticonElements.at(i).attributes().namedItem("file").nodeValue();
QDomElement stringElement = emoticonElements.at(i).firstChildElement("string");
QStringList emoticonSet; // { ":)", ":-)" } etc.
const QString itemName = QStringLiteral("file");
const QString childName = QStringLiteral("string");
emoticons.clear();
emoticonToIcon.clear();
icons.clear();
const int iconsCount = emoticonElements.size();
icons.reserve(iconsCount);
for (int i = 0; i < iconsCount; ++i) {
QString iconName = emoticonElements.at(i).attributes().namedItem(itemName).nodeValue();
QString iconPath = QDir{path}.filePath(iconName);
icons.append(QIcon{iconPath});
QDomElement stringElement = emoticonElements.at(i).firstChildElement(childName);
QStringList emoticonList;
while (!stringElement.isNull()) {
QString emoticon = stringElement.text().replace("<", "&lt;").replace(">", "&gt;");
filenameTable.insert(emoticon, file);
cacheSmiley(file); // preload all smileys
if (!getCachedSmiley(emoticon).isNull()) {
emoticonSet.push_back(emoticon);
}
emoticonToIcon.insert(emoticon, &icons[i]);
emoticonList.append(emoticon);
stringElement = stringElement.nextSibling().toElement();
}
if (emoticonSet.size() > 0) {
emoticons.push_back(emoticonSet);
}
emoticons.append(emoticonList);
}
// success!
loadingMutex.unlock();
return true;
}
QString SmileyPack::smileyfied(QString msg)
QString SmileyPack::smileyfied(const QString& msg)
{
QMutexLocker locker(&loadingMutex);
QRegExp exp("\\S+"); // matches words
int index = msg.indexOf(exp);
// if a word is key of a smiley, replace it by its corresponding image in Rich Text
while (index >= 0) {
QString key = exp.cap();
if (filenameTable.contains(key)) {
QString result(msg);
QRegularExpression exp("\\S+");
QRegularExpressionMatchIterator iter = exp.globalMatch(result);
int replaceDiff = 0;
while (iter.hasNext()) {
QRegularExpressionMatch match = iter.next();
QString key = match.captured();
int startPos = match.capturedStart();
int keyLength = key.length();
if (emoticonToIcon.contains(key)) {
QString imgRichText = getAsRichText(key);
msg.replace(index, key.length(), imgRichText);
index += imgRichText.length() - key.length();
result.replace(startPos + replaceDiff, keyLength, imgRichText);
replaceDiff += imgRichText.length() - keyLength;
}
index = msg.indexOf(exp, index + key.length());
}
return msg;
return result;
}
QList<QStringList> SmileyPack::getEmoticons() const
@ -268,40 +254,10 @@ QList<QStringList> SmileyPack::getEmoticons() const @@ -268,40 +254,10 @@ QList<QStringList> SmileyPack::getEmoticons() const
return emoticons;
}
QString SmileyPack::getAsRichText(const QString& key)
{
return QString("<img title=\"%1\" src=\"key:%1\"\\>").arg(key);
}
QIcon SmileyPack::getAsIcon(const QString& key)
QIcon SmileyPack::getAsIcon(const QString& emoticon)
{
QMutexLocker locker(&loadingMutex);
return getCachedSmiley(key);
}
void SmileyPack::cacheSmiley(const QString& name)
{
QString filename = QDir(path).filePath(name);
QIcon icon;
icon.addFile(filename);
iconCache.insert(name, icon);
}
QIcon SmileyPack::getCachedSmiley(const QString& key)
{
// valid key?
if (!filenameTable.contains(key)) {
return QPixmap();
}
// cache it if needed
QString file = filenameTable.value(key);
if (!iconCache.contains(file)) {
cacheSmiley(file);
}
return iconCache.value(file);
return emoticonToIcon.contains(emoticon) ? *(emoticonToIcon[emoticon]) : QIcon();
}
void SmileyPack::onSmileyPackChanged()

22
src/persistence/smileypack.h
Unescape View File

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
/*
Copyright © 2014-2015 by The qTox Project Contributors
Copyright © 2014-2017 by The qTox Project Contributors
This file is part of qTox, a Qt-based graphical interface for Tox.
@ -20,12 +20,9 @@ @@ -20,12 +20,9 @@
#ifndef SMILEYPACK_H
#define SMILEYPACK_H
#include <QHash>
#include <QIcon>
#include <QMap>
#include <QMutex>
#include <QObject>
#include <QString>
#include <QStringList>
class SmileyPack : public QObject
{
@ -33,13 +30,12 @@ class SmileyPack : public QObject @@ -33,13 +30,12 @@ class SmileyPack : public QObject
public:
static SmileyPack& getInstance();
static QList<QPair<QString, QString>> listSmileyPacks(const QStringList& paths);
static QList<QPair<QString, QString>> listSmileyPacks();
static QVector<QPair<QString, QString>> listSmileyPacks(const QStringList& paths);
static QVector<QPair<QString, QString>> listSmileyPacks();
static bool isValid(const QString& filename);
QString smileyfied(QString msg);
QString smileyfied(const QString& msg);
QList<QStringList> getEmoticons() const;
QString getAsRichText(const QString& key);
QIcon getAsIcon(const QString& key);
private slots:
@ -51,15 +47,11 @@ private: @@ -51,15 +47,11 @@ private:
SmileyPack& operator=(const SmileyPack&) = delete;
bool load(const QString& filename);
void cacheSmiley(const QString& name);
QIcon getCachedSmiley(const QString& key);
static QStringList loadDefaultPaths();
QHash<QString, QString> filenameTable;
QHash<QString, QIcon> iconCache;
QVector<QIcon> icons;
QMap<QString, QIcon const*> emoticonToIcon;
QList<QStringList> emoticons;
QString path;
static QStringList defaultPaths;
mutable QMutex loadingMutex;
};

Write Preview
Loading…
Cancel
Save