Files
qt-creator/src/plugins/cpptools/baseeditordocumentprocessor.h
Christian Kandeler 949bb0e67b ClangCodeModel: Show value in tool tips, if possible
When hovering over a constant expression, it's probably helpful
to show that value to the user.
Requires clang 11 to fully work. For now, it only shows the value for
variable initializations.

Fixes: QTCREATORBUG-23967
Change-Id: I6b844231bac50993c2fa2fa82c552ad9cef590df
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
2020-05-26 08:50:58 +00:00

135 lines
4.6 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "baseeditordocumentparser.h"
#include "cppcursorinfo.h"
#include "cppsymbolinfo.h"
#include "cppsemanticinfo.h"
#include "cpptools_global.h"
#include <coreplugin/helpitem.h>
#include <texteditor/codeassist/assistinterface.h>
#include <texteditor/quickfix.h>
#include <texteditor/texteditor.h>
#include <texteditor/textdocument.h>
#include <cplusplus/CppDocument.h>
#include <QTextEdit>
#include <QVariant>
#include <functional>
namespace TextEditor {
class TextDocument;
}
namespace CppTools {
// For clang code model only, move?
struct CPPTOOLS_EXPORT ToolTipInfo {
QString text;
QString briefComment;
QStringList qDocIdCandidates;
QString qDocMark;
Core::HelpItem::Category qDocCategory;
QVariant value;
QString sizeInBytes;
};
class CPPTOOLS_EXPORT BaseEditorDocumentProcessor : public QObject
{
Q_OBJECT
public:
BaseEditorDocumentProcessor(QTextDocument *textDocument, const QString &filePath);
~BaseEditorDocumentProcessor() override;
void run(bool projectsUpdated = false);
virtual void semanticRehighlight() = 0;
virtual void recalculateSemanticInfoDetached(bool force) = 0;
virtual CppTools::SemanticInfo recalculateSemanticInfo() = 0;
virtual CPlusPlus::Snapshot snapshot() = 0;
virtual BaseEditorDocumentParser::Ptr parser() = 0;
virtual bool isParserRunning() const = 0;
virtual TextEditor::QuickFixOperations
extraRefactoringOperations(const TextEditor::AssistInterface &assistInterface);
virtual void invalidateDiagnostics();
virtual void editorDocumentTimerRestarted();
virtual void setParserConfig(const BaseEditorDocumentParser::Configuration &config);
virtual QFuture<CursorInfo> cursorInfo(const CursorInfoParams &params) = 0;
virtual QFuture<CursorInfo> requestLocalReferences(const QTextCursor &cursor) = 0;
virtual QFuture<SymbolInfo> requestFollowSymbol(int line, int column) = 0;
virtual QFuture<ToolTipInfo> toolTipInfo(const QByteArray &codecName, int line, int column);
QString filePath() const { return m_filePath; }
public:
using HeaderErrorDiagnosticWidgetCreator = std::function<QWidget*()>;
signals:
// Signal interface to implement
void projectPartInfoUpdated(const CppTools::ProjectPartInfo &projectPartInfo);
void codeWarningsUpdated(unsigned revision,
const QList<QTextEdit::ExtraSelection> &selections,
const HeaderErrorDiagnosticWidgetCreator &creator,
const TextEditor::RefactorMarkers &refactorMarkers);
void ifdefedOutBlocksUpdated(unsigned revision,
const QList<TextEditor::BlockRange> &ifdefedOutBlocks);
void cppDocumentUpdated(const CPlusPlus::Document::Ptr document); // TODO: Remove me
void semanticInfoUpdated(const CppTools::SemanticInfo semanticInfo); // TODO: Remove me
protected:
static void runParser(QFutureInterface<void> &future,
BaseEditorDocumentParser::Ptr parser,
BaseEditorDocumentParser::UpdateParams updateParams);
// Convenience
unsigned revision() const { return static_cast<unsigned>(m_textDocument->revision()); }
QTextDocument *textDocument() const { return m_textDocument; }
private:
virtual void runImpl(const BaseEditorDocumentParser::UpdateParams &updateParams) = 0;
private:
QString m_filePath;
QTextDocument *m_textDocument;
};
} // namespace CppTools