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

Implement context help for pro file editor

Browse Source 
Task-number: QTCREATORBUG-6325
Change-Id: Ie8b2eb582eb527eac6af56d0c69a8ae1dafdc1df
Reviewed-by: Leandro Melo <leandro.melo@nokia.com>
This commit is contained in:
Jarek Kobus
2011-11-10 11:55:05 +01:00
parent 8fcb4d8084
commit da14d86104
11 changed files with 332 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
src/plugins/qt4projectmanager/profilehoverhandler.cpp Normal file
View File

@@ -0,0 +1,170 @@
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
**************************************************************************/
#include "profilehoverhandler.h"
#include "profileeditor.h"
#include "profilekeywords.h"
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/helpmanager.h>
#include <extensionsystem/pluginmanager.h>
#include <texteditor/itexteditor.h>
#include <texteditor/basetexteditor.h>
#include <texteditor/helpitem.h>
#include <texteditor/tooltip/tooltip.h>
#include <utils/htmldocextractor.h>
#include <QtGui/QTextCursor>
#include <QtGui/QTextBlock>
#include <QtCore/QUrl>
using namespace Qt4ProjectManager;
using namespace Qt4ProjectManager::Internal;
using namespace Core;
ProFileHoverHandler::ProFileHoverHandler(QObject *parent)
: BaseHoverHandler(parent),
m_manualKind(UnknownManual)
{
}
ProFileHoverHandler::~ProFileHoverHandler()
{}
bool ProFileHoverHandler::acceptEditor(IEditor *editor)
{
if (qobject_cast<ProFileEditor *>(editor) != 0)
return true;
return false;
}
void ProFileHoverHandler::identifyMatch(TextEditor::ITextEditor *editor, int pos)
{
m_docFragment = QString();
m_manualKind = UnknownManual;
if (ProFileEditorWidget *proFileEditor = qobject_cast<ProFileEditorWidget *>(editor->widget())) {
if (!proFileEditor->extraSelectionTooltip(pos).isEmpty()) {
setToolTip(proFileEditor->extraSelectionTooltip(pos));
} else {
QTextDocument *document = proFileEditor->document();
QTextBlock block = document->findBlock(pos);
identifyQMakeKeyword(block.text(), pos - block.position());
if (m_manualKind != UnknownManual) {
QUrl url(QString::fromLatin1("qthelp://com.trolltech.qmake/qdoc/qmake-%1-reference.html#%2")
.arg(manualName()).arg(m_docFragment));
setLastHelpItemIdentified(TextEditor::HelpItem(url.toString(),
m_docFragment, TextEditor::HelpItem::QMakeVariableOfFunction));
} else {
// General qmake manual will be shown outside any function or variable
setLastHelpItemIdentified(TextEditor::HelpItem(QLatin1String("qmake"),
TextEditor::HelpItem::Unknown));
}
}
}
}
void ProFileHoverHandler::identifyQMakeKeyword(const QString &text, int pos)
{
if (text.isEmpty())
return;
QString buf;
for (int i = 0; i < text.length(); ++i) {
const QChar c = text.at(i);
bool checkBuffer = false;
if (c.isLetter() || c == QLatin1Char('_') || c == QLatin1Char('.') || c.isDigit()) {
buf += c;
if (i == text.length() - 1)
checkBuffer = true;
} else {
checkBuffer = true;
}
if (checkBuffer) {
if (!buf.isEmpty()) {
if ((i >= pos) && (i - buf.size() <= pos)) {
if (ProFileKeywords::isFunction(buf))
identifyDocFragment(FunctionManual, buf);
else if (ProFileKeywords::isVariable(buf))
identifyDocFragment(VariableManual, buf);
break;
}
buf.clear();
} else {
if (i >= pos)
break; // we are after the tooltip pos
}
if (c == '#')
break; // comment start
}
}
}
QString ProFileHoverHandler::manualName() const
{
if (m_manualKind == FunctionManual)
return QLatin1String("function");
else if (m_manualKind == VariableManual)
return QLatin1String("variable");
return QString();
}
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://com.trolltech.qmake/qdoc/qmake-%1-reference.html").arg(manualName()));
const QByteArray &html = Core::HelpManager::instance()->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(html, m_docFragment);
}
}