MythTV  master
mythsorthelper.cpp
Go to the documentation of this file.
1 // -*- Mode: c++ -*-
2 // vim: set expandtab tabstop=4 shiftwidth=4
3 
4 #include "mythsorthelper.h"
5 
6 #include "mythcorecontext.h"
7 
15 {
16  m_prefixes = tr("^(The |A |An )",
17  "Regular Expression for what to ignore when sorting");
18  m_prefixes = m_prefixes.trimmed();
19  if (not hasPrefixes()) {
20  // This language doesn't ignore any words when sorting
22  return;
23  }
24  if (not m_prefixes.startsWith("^"))
25  m_prefixes = "^" + m_prefixes;
26 
27  if (m_caseSensitive == Qt::CaseInsensitive)
28  {
29  m_prefixes = m_prefixes.toLower();
30  m_exclusions = m_exclusions.toLower();
31  }
32  m_prefixesRegex = QRegularExpression(m_prefixes);
33  m_prefixesRegex2 = QRegularExpression(m_prefixes + "(.*)");
34 #if QT_VERSION < QT_VERSION_CHECK(5,14,0)
35  m_exclList = m_exclusions.split(";", QString::SkipEmptyParts);
36 #else
37  m_exclList = m_exclusions.split(";", Qt::SkipEmptyParts);
38 #endif
39  for (int i = 0; i < m_exclList.size(); i++)
40  m_exclList[i] = m_exclList[i].trimmed();
41 }
42 
53 {
54  if (gCoreContext) {
55 #if 0
56  // Last minute change. QStringRef::localeAwareCompare appears to
57  // always do case insensitive sorting, so there's no point in
58  // presenting this option to a user.
60  gCoreContext->GetBoolSetting("SortCaseSensitive", false)
61  ? Qt::CaseSensitive : Qt::CaseInsensitive;
62 #endif
63  m_prefixMode =
64  gCoreContext->GetBoolSetting("SortStripPrefixes", true)
66  m_exclusions =
67  gCoreContext->GetSetting("SortPrefixExceptions", "");
68  }
70 }
71 
85  Qt::CaseSensitivity case_sensitive,
86  SortPrefixMode prefix_mode,
87  QString exclusions) :
88  m_caseSensitive(case_sensitive),
89  m_prefixMode(prefix_mode),
90  m_exclusions(std::move(exclusions))
91 {
93 }
94 
105 {
106  if (other == nullptr)
107  {
108  LOG(VB_GENERAL, LOG_ERR,
109  QString("MythSortHelper created from null pointer."));
110  return;
111  }
113  m_prefixMode = other->m_prefixMode;
114  m_prefixes = other->m_prefixes;
117  m_exclusions = other->m_exclusions;
118  m_exclList = other->m_exclList;
119  m_exclMode = other->m_exclMode;
120 }
121 
122 static std::shared_ptr<MythSortHelper> singleton = nullptr;
123 
132 std::shared_ptr<MythSortHelper> getMythSortHelper(void)
133 {
134  if (singleton == nullptr)
135  singleton = std::make_shared<MythSortHelper>(new MythSortHelper());
136  return singleton;
137 }
138 
149 {
150  singleton = nullptr;
151 }
152 
165 QString MythSortHelper::doTitle(const QString& title) const
166 {
167  QString ltitle = title;
168  if (m_caseSensitive == Qt::CaseInsensitive)
169  ltitle = ltitle.toLower();
171  return ltitle;
173  {
174  if (m_exclList.contains(ltitle))
175  return ltitle;
176  } else {
177  for (const auto& str : qAsConst(m_exclList))
178  if (ltitle.startsWith(str))
179  return ltitle;
180  }
182  return ltitle.remove(m_prefixesRegex);
183  return ltitle.replace(m_prefixesRegex2, "\\2, \\1").trimmed();
184 }
185 
198 QString MythSortHelper::doPathname(const QString& pathname) const
199 {
200  QString lpathname = pathname;
201  if (m_caseSensitive == Qt::CaseInsensitive)
202  lpathname = lpathname.toLower();
204  return lpathname;
205  QStringList parts = lpathname.split("/");
206  for (int i = 0; i < parts.size(); ++i) {
207  bool excluded = false;
208  for (int j = 0; j < m_exclList.size(); ++j) {
209  if (parts[i].startsWith(m_exclList[j])) {
210  excluded = true;
211  break;
212  }
213  }
214  if (excluded)
215  continue;
217  parts[i] = parts[i].remove(m_prefixesRegex);
218  else
219  parts[i] = parts[i].replace(m_prefixesRegex2, "\\2, \\1").trimmed();
220  }
221  return parts.join("/");
222 }
MythSortHelper::m_exclMode
SortExclusionMode m_exclMode
Definition: mythsorthelper.h:78
MythSortHelper::m_prefixes
QString m_prefixes
A string containing the regular expression of prefixes to ignore when sorting.
Definition: mythsorthelper.h:62
getMythSortHelper
std::shared_ptr< MythSortHelper > getMythSortHelper(void)
Get a pointer to the MythSortHelper singleton.
Definition: mythsorthelper.cpp:132
title
QString title
Definition: mythplugins/mytharchive/mytharchivehelper/main.cpp:636
SortExclusionMatch
@ SortExclusionMatch
Definition: mythsorthelper.h:21
LOG
#define LOG(_MASK_, _LEVEL_, _QSTRING_)
Definition: mythlogging.h:23
MythSortHelper
A class to consolidate all the soring functions.
Definition: mythsorthelper.h:29
MythSortHelper::m_caseSensitive
Qt::CaseSensitivity m_caseSensitive
Whether sorting two strings should ignore upper/lower case.
Definition: mythsorthelper.h:53
MythSortHelper::m_exclusions
QString m_exclusions
A string containing names that should be ignored when greating the sortable form of a title.
Definition: mythsorthelper.h:75
mythsorthelper.h
MythSortHelper::doPathname
QString doPathname(const QString &pathname) const
Create the sortable form of an item.
Definition: mythsorthelper.cpp:198
SortPrefixRemove
@ SortPrefixRemove
Definition: mythsorthelper.h:15
MythSortHelper::doTitle
QString doTitle(const QString &title) const
Create the sortable form of an title string.
Definition: mythsorthelper.cpp:165
MythSortHelper::MythSortHelperCommon
void MythSortHelperCommon(void)
Common code for creating a MythSortHelper object.
Definition: mythsorthelper.cpp:14
MythSortHelper::m_exclList
QStringList m_exclList
The m_exclusion string converted into a string list.
Definition: mythsorthelper.h:77
MythSortHelper::MythSortHelper
MythSortHelper()
Create a MythSortHelper object.
Definition: mythsorthelper.cpp:52
MythSortHelper::m_prefixMode
SortPrefixMode m_prefixMode
Whether or not to ignore prefix words (like A, An, and The) when sorting two strings.
Definition: mythsorthelper.h:57
MythSortHelper::m_prefixesRegex2
QRegularExpression m_prefixesRegex2
A regular expression used for moving leading prefix to the end of a string.
Definition: mythsorthelper.h:68
gCoreContext
MythCoreContext * gCoreContext
This global variable contains the MythCoreContext instance for the app.
Definition: mythcorecontext.cpp:60
MythSortHelper::hasPrefixes
bool hasPrefixes(void)
Does the language translation specify any prefixes.
Definition: mythsorthelper.h:47
MythCoreContext::GetBoolSetting
bool GetBoolSetting(const QString &key, bool defaultval=false)
Definition: mythcorecontext.cpp:927
mythcorecontext.h
MythSortHelper::m_prefixesRegex
QRegularExpression m_prefixesRegex
A regular expression used for removing a leading prefix.
Definition: mythsorthelper.h:65
SortPrefixMode
SortPrefixMode
Definition: mythsorthelper.h:13
resetMythSortHelper
void resetMythSortHelper(void)
Delete the MythSortHelper singleton.
Definition: mythsorthelper.cpp:148
SortPrefixKeep
@ SortPrefixKeep
Definition: mythsorthelper.h:14
singleton
static std::shared_ptr< MythSortHelper > singleton
Definition: mythsorthelper.cpp:122
MythCoreContext::GetSetting
QString GetSetting(const QString &key, const QString &defaultval="")
Definition: mythcorecontext.cpp:919