feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Prefer project's Qt version for context help

Browse Source 
To avoid additional dependencies, let the QtSupport plugin register a
function for filtering help URLs, and add information about the
originating file path to the help items created by the context help
handlers. The filter hook then finds out the corresponding project,
active target, and corresponding Qt version, and filters the help URLs
accordingly.

With the default setting in "Kits > Qt Versions > Register
documentation", only the highest versioned documentation set within a
major Qt version is registered, so context help now shows the highest
versioned help from Qt 5 or Qt 6 depending on active target. If that is
changed to "All", context help now shows documentation from exactly the
version that is currently used by the project.

Fixes: QTCREATORBUG-10331
Change-Id: I7d87793737cc5ab7d228ee4bfe568d7e8343ee7d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
This commit is contained in:
Eike Ziller
2022-09-23 13:20:12 +02:00
parent bf6914a704
commit e3f375925d
8 changed files with 187 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
src/plugins/coreplugin/helpitem.cpp
View File

@@ -11,14 +11,16 @@
using namespace Core;
Q_GLOBAL_STATIC(HelpItem::LinkNarrower, m_linkNarrower);
HelpItem::HelpItem() = default;
HelpItem::HelpItem(const char *helpId)
: HelpItem(QStringList(QString::fromUtf8(helpId)), {}, Unknown)
: HelpItem(QStringList(QString::fromUtf8(helpId)), {}, {}, Unknown)
{}
HelpItem::HelpItem(const QString &helpId)
: HelpItem(QStringList(helpId), {}, Unknown)
: HelpItem(QStringList(helpId), {}, {}, Unknown)
{}
HelpItem::HelpItem(const QUrl &url)
@@ -31,13 +33,20 @@ HelpItem::HelpItem(const QUrl &url, const QString &docMark, HelpItem::Category c
, m_category(category)
{}
HelpItem::HelpItem(const QString &helpId, const QString &docMark, Category category)
: HelpItem(QStringList(helpId), docMark, category)
HelpItem::HelpItem(const QString &helpId,
const Utils::FilePath &filePath,
const QString &docMark,
Category category)
: HelpItem(QStringList(helpId), filePath, docMark, category)
{}
HelpItem::HelpItem(const QStringList &helpIds, const QString &docMark, Category category)
HelpItem::HelpItem(const QStringList &helpIds,
const Utils::FilePath &filePath,
const QString &docMark,
Category category)
: m_docMark(docMark)
, m_category(category)
, m_filePath(filePath)
{
setHelpIds(helpIds);
}
@@ -75,6 +84,24 @@ void HelpItem::setCategory(Category cat)
HelpItem::Category HelpItem::category() const
{ return m_category; }
/*!
Sets the \a filePath that this help item originates from, for example
in case of context help.
*/
void HelpItem::setFilePath(const Utils::FilePath &filePath)
{
m_filePath = filePath;
}
/*!
Returns the filePath that this help item originates from, for example
in case of context help.
*/
Utils::FilePath HelpItem::filePath() const
{
return m_filePath;
}
bool HelpItem::isEmpty() const
{
return m_helpUrl.isEmpty() && m_helpIds.isEmpty();
@@ -184,7 +211,7 @@ static QVersionNumber qtVersionHeuristic(const QString &digits)
return {};
}
static std::pair<QUrl, QVersionNumber> extractVersion(const QUrl &url)
std::pair<QUrl, QVersionNumber> HelpItem::extractQtVersionNumber(const QUrl &url)
{
const QString host = url.host();
const QStringList hostParts = host.split('.');
@@ -203,8 +230,8 @@ static std::pair<QUrl, QVersionNumber> extractVersion(const QUrl &url)
// sort primary by "url without version" and seconday by "version"
static bool helpUrlLessThan(const QUrl &a, const QUrl &b)
{
const std::pair<QUrl, QVersionNumber> va = extractVersion(a);
const std::pair<QUrl, QVersionNumber> vb = extractVersion(b);
const std::pair<QUrl, QVersionNumber> va = HelpItem::extractQtVersionNumber(a);
const std::pair<QUrl, QVersionNumber> vb = HelpItem::extractQtVersionNumber(b);
const QString sa = va.first.toString();
const QString sb = vb.first.toString();
if (sa == sb)
@@ -258,7 +285,7 @@ static const HelpItem::Links getBestLinks(const HelpItem::Links &links)
HelpItem::Links bestLinks;
QUrl currentUnversionedUrl;
for (const HelpItem::Link &link : links) {
const QUrl unversionedUrl = extractVersion(link.second).first;
const QUrl unversionedUrl = HelpItem::extractQtVersionNumber(link.second).first;
if (unversionedUrl != currentUnversionedUrl) {
currentUnversionedUrl = unversionedUrl;
bestLinks.push_back(link);
@@ -279,7 +306,7 @@ static const HelpItem::Links getBestLink(const HelpItem::Links &links)
// Default to first link if version extraction failed, possibly because it is not a Qt doc link
HelpItem::Link bestLink = links.front();
for (const HelpItem::Link &link : links) {
const QVersionNumber version = extractVersion(link.second).second;
const QVersionNumber version = HelpItem::extractQtVersionNumber(link.second).second;
if (version > highestVersion) {
highestVersion = version;
bestLink = link;
@@ -292,7 +319,8 @@ const HelpItem::Links HelpItem::bestLinks() const
{
if (isFuzzyMatch())
return getBestLinks(links());
return getBestLink(links());
const Links filteredLinks = *m_linkNarrower ? (*m_linkNarrower)(*this, links()) : links();
return getBestLink(filteredLinks);
}
const QString HelpItem::keyword() const
@@ -306,3 +334,8 @@ bool HelpItem::isFuzzyMatch() const
links();
return m_isFuzzyMatch;
}
void HelpItem::setLinkNarrower(const LinkNarrower &narrower)
{
*m_linkNarrower = narrower;
}