void ProFileHoverHandler::identifyDocFragment(ProFileHoverHandler::ManualKind manualKind,
const QString &keyword)
{
m_manualKind = manualKind;
m_docFragment = keyword.toLower();
// Special case: _PRO_FILE_ and _PRO_FILE_PWD_ ids
// don't have starting and ending '_'.
if (m_docFragment.startsWith(QLatin1Char('_')))
m_docFragment = m_docFragment.mid(1);
if (m_docFragment.endsWith(QLatin1Char('_')))
m_docFragment = m_docFragment.left(m_docFragment.size() - 1);
m_docFragment.replace(QLatin1Char('.'), QLatin1Char('-'));
m_docFragment.replace(QLatin1Char('_'), QLatin1Char('-'));
if (m_manualKind == FunctionManual) {
QUrl url(QString::fromLatin1("qthelp://org.qt-project.qmake/qmake/qmake-%1-reference.html").arg(manualName()));
const QByteArray html = Core::HelpManager::fileData(url);
Utils::HtmlDocExtractor htmlExtractor;
htmlExtractor.setMode(Utils::HtmlDocExtractor::FirstParagraph);
// Document fragment of qmake function is retrieved from docs.
// E.g. in case of the keyword "find" the document fragment
// parsed from docs is "find-variablename-substr".
m_docFragment = htmlExtractor.getQMakeFunctionId(QString::fromUtf8(html), m_docFragment);
}
}
QString HelpItem::extractContent(bool extended) const
{
Utils::HtmlDocExtractor htmlExtractor;
if (extended)
htmlExtractor.setMode(Utils::HtmlDocExtractor::Extended);
else
htmlExtractor.setMode(Utils::HtmlDocExtractor::FirstParagraph);
QString contents;
QMap<QString, QUrl> helpLinks = Core::HelpManager::instance()->linksForIdentifier(m_helpId);
foreach (const QUrl &url, helpLinks) {
const QByteArray &html = Core::HelpManager::instance()->fileData(url);
switch (m_category) {
case Brief:
contents = htmlExtractor.getClassOrNamespaceBrief(html, m_docMark);
break;
case ClassOrNamespace:
contents = htmlExtractor.getClassOrNamespaceDescription(html, m_docMark);
break;
case Function:
contents = htmlExtractor.getFunctionDescription(html, m_docMark);
break;
case Enum:
contents = htmlExtractor.getEnumDescription(html, m_docMark);
break;
case Typedef:
contents = htmlExtractor.getTypedefDescription(html, m_docMark);
break;
case Macro:
contents = htmlExtractor.getMacroDescription(html, m_docMark);
break;
case QmlComponent:
contents = htmlExtractor.getQmlComponentDescription(html, m_docMark);
break;
case QmlProperty:
contents = htmlExtractor.getQmlPropertyDescription(html, m_docMark);
break;
default:
break;
}
if (!contents.isEmpty())
break;
}
return contents;
}
QString HelpItem::extractContent(bool extended) const
{
Utils::HtmlDocExtractor htmlExtractor;
if (extended)
htmlExtractor.setMode(Utils::HtmlDocExtractor::Extended);
else
htmlExtractor.setMode(Utils::HtmlDocExtractor::FirstParagraph);
QString contents;
QMap<QString, QUrl> helpLinks = retrieveHelpLinks();
if (helpLinks.isEmpty()) {
// Maybe this is already an URL...
QUrl url(m_helpId);
if (url.isValid())
helpLinks.insert(m_helpId, m_helpId);
}
foreach (const QUrl &url, helpLinks) {
const QString html = QString::fromUtf8(Core::HelpManager::instance()->fileData(url));
switch (m_category) {
case Brief:
contents = htmlExtractor.getClassOrNamespaceBrief(html, m_docMark);
break;
case ClassOrNamespace:
contents = htmlExtractor.getClassOrNamespaceDescription(html, m_docMark);
break;
case Function:
contents = htmlExtractor.getFunctionDescription(html, m_docMark);
break;
case Enum:
contents = htmlExtractor.getEnumDescription(html, m_docMark);
break;
case Typedef:
contents = htmlExtractor.getTypedefDescription(html, m_docMark);
break;
case Macro:
contents = htmlExtractor.getMacroDescription(html, m_docMark);
break;
case QmlComponent:
contents = htmlExtractor.getQmlComponentDescription(html, m_docMark);
break;
case QmlProperty:
contents = htmlExtractor.getQmlPropertyDescription(html, m_docMark);
break;
case QMakeVariableOfFunction:
contents = htmlExtractor.getQMakeVariableOrFunctionDescription(html, m_docMark);
break;
default:
break;
}
if (!contents.isEmpty())
break;
}
return contents;
}