Files
qt-creator/src/plugins/glsleditor/glsleditor.cpp
David Schulz dba4bff703 TextEditor: use Utils::FilePath as file member in AssistInterface
Change-Id: I3bf9b013b9350411f918efdb9d1a36a2c22bf972
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-09-04 10:14:21 +00:00

412 lines
14 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.
**
****************************************************************************/
#include "glsleditor.h"
#include "glsleditorconstants.h"
#include "glsleditorplugin.h"
#include "glslhighlighter.h"
#include "glslautocompleter.h"
#include "glslcompletionassist.h"
#include "glslindenter.h"
#include <glsl/glsllexer.h>
#include <glsl/glslparser.h>
#include <glsl/glslengine.h>
#include <glsl/glslsemantic.h>
#include <glsl/glslsymbols.h>
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/icore.h>
#include <cplusplus/SimpleLexer.h>
#include <extensionsystem/pluginmanager.h>
#include <extensionsystem/pluginspec.h>
#include <texteditor/fontsettings.h>
#include <texteditor/refactoroverlay.h>
#include <texteditor/textdocument.h>
#include <texteditor/syntaxhighlighter.h>
#include <texteditor/texteditoractionhandler.h>
#include <texteditor/texteditorconstants.h>
#include <texteditor/texteditorsettings.h>
#include <utils/algorithm.h>
#include <utils/changeset.h>
#include <utils/qtcassert.h>
#include <utils/tooltip/tooltip.h>
#include <utils/uncommentselection.h>
#include <QCoreApplication>
#include <QSettings>
#include <QComboBox>
#include <QFileInfo>
#include <QHeaderView>
#include <QTextBlock>
#include <QTimer>
#include <QTreeView>
using namespace TextEditor;
using namespace GLSL;
namespace GlslEditor {
namespace Internal {
static int versionFor(const QString &source)
{
CPlusPlus::SimpleLexer lexer;
lexer.setPreprocessorMode(false);
const CPlusPlus::Tokens tokens = lexer(source);
int version = -1;
// QString profile;
const int end = tokens.size();
for (int it = 0; it + 2 < end; ++it) {
const CPlusPlus::Token &token = tokens.at(it);
if (token.isComment())
continue;
if (token.kind() == CPlusPlus::T_POUND) {
const int line = token.lineno;
const CPlusPlus::Token &successor = tokens.at(it + 1);
if (line != successor.lineno)
break;
if (successor.kind() != CPlusPlus::T_IDENTIFIER)
break;
if (source.mid(successor.bytesBegin(), successor.bytes()) != "version")
break;
const CPlusPlus::Token &versionToken = tokens.at(it + 2);
if (line != versionToken.lineno)
break;
if (versionToken.kind() != CPlusPlus::T_NUMERIC_LITERAL)
break;
version = source.mid(versionToken.bytesBegin(), versionToken.bytes()).toInt();
// if (version >= 150 && it + 3 < end) {
// const CPlusPlus::Token &profileToken = tokens.at(it + 3);
// if (line != profileToken.lineno)
// break;
// if (profileToken.kind() != CPlusPlus::T_IDENTIFIER)
// break;
// profile = source.mid(profileToken.bytesBegin(), profileToken.bytes());
// }
break;
}
break;
}
return version;
}
enum {
UPDATE_DOCUMENT_DEFAULT_INTERVAL = 150
};
class CreateRanges: protected Visitor
{
QTextDocument *textDocument;
Document::Ptr glslDocument;
public:
CreateRanges(QTextDocument *textDocument, Document::Ptr glslDocument)
: textDocument(textDocument), glslDocument(glslDocument) {}
void operator()(AST *ast) { accept(ast); }
protected:
using GLSL::Visitor::visit;
void endVisit(CompoundStatementAST *ast) override
{
if (ast->symbol) {
QTextCursor tc(textDocument);
tc.setPosition(ast->start);
tc.setPosition(ast->end, QTextCursor::KeepAnchor);
glslDocument->addRange(tc, ast->symbol);
}
}
};
//
// GlslEditorWidget
//
class GlslEditorWidget : public TextEditorWidget
{
public:
GlslEditorWidget();
int editorRevision() const;
bool isOutdated() const;
QSet<QString> identifiers() const;
AssistInterface *createAssistInterface(AssistKind assistKind, AssistReason reason) const override;
private:
void updateDocumentNow();
void setSelectedElements();
void onTooltipRequested(const QPoint &point, int pos);
QString wordUnderCursor() const;
QTimer m_updateDocumentTimer;
QComboBox *m_outlineCombo = nullptr;
Document::Ptr m_glslDocument;
};
GlslEditorWidget::GlslEditorWidget()
{
setAutoCompleter(new GlslCompleter);
m_updateDocumentTimer.setInterval(UPDATE_DOCUMENT_DEFAULT_INTERVAL);
m_updateDocumentTimer.setSingleShot(true);
connect(&m_updateDocumentTimer, &QTimer::timeout,
this, &GlslEditorWidget::updateDocumentNow);
connect(this, &QPlainTextEdit::textChanged,
[this]() { m_updateDocumentTimer.start(); });
m_outlineCombo = new QComboBox;
m_outlineCombo->setMinimumContentsLength(22);
// ### m_outlineCombo->setModel(m_outlineModel);
auto treeView = new QTreeView;
treeView->header()->hide();
treeView->setItemsExpandable(false);
treeView->setRootIsDecorated(false);
m_outlineCombo->setView(treeView);
treeView->expandAll();
//m_outlineCombo->setSizeAdjustPolicy(QComboBox::AdjustToContents);
// Make the combo box prefer to expand
QSizePolicy policy = m_outlineCombo->sizePolicy();
policy.setHorizontalPolicy(QSizePolicy::Expanding);
m_outlineCombo->setSizePolicy(policy);
insertExtraToolBarWidget(TextEditorWidget::Left, m_outlineCombo);
connect(this, &TextEditorWidget::tooltipRequested, this, &GlslEditorWidget::onTooltipRequested);
}
int GlslEditorWidget::editorRevision() const
{
//return document()->revision();
return 0;
}
bool GlslEditorWidget::isOutdated() const
{
// if (m_semanticInfo.revision() != editorRevision())
// return true;
return false;
}
QString GlslEditorWidget::wordUnderCursor() const
{
QTextCursor tc = textCursor();
const QChar ch = document()->characterAt(tc.position() - 1);
// make sure that we're not at the start of the next word.
if (ch.isLetterOrNumber() || ch == QLatin1Char('_'))
tc.movePosition(QTextCursor::Left);
tc.movePosition(QTextCursor::StartOfWord);
tc.movePosition(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
const QString word = tc.selectedText();
return word;
}
void GlslEditorWidget::updateDocumentNow()
{
m_updateDocumentTimer.stop();
int variant = languageVariant(textDocument()->mimeType());
const QString contents = toPlainText(); // get the code from the editor
int version = versionFor(contents);
if (version >= 330)
variant |= GLSL::Lexer::Variant_GLSL_400;
const QByteArray preprocessedCode = contents.toLatin1(); // ### use the QtCreator C++ preprocessor.
Document::Ptr doc(new Document());
doc->_engine = new Engine();
Parser parser(doc->_engine, preprocessedCode.constData(), preprocessedCode.size(), variant);
TranslationUnitAST *ast = parser.parse();
if (ast || extraSelections(CodeWarningsSelection).isEmpty()) {
Semantic sem;
Scope *globalScope = new Namespace();
doc->_globalScope = globalScope;
const GlslEditorPlugin::InitFile *file = GlslEditorPlugin::shaderInit(variant);
sem.translationUnit(file->ast(), globalScope, file->engine());
if (variant & Lexer::Variant_VertexShader) {
file = GlslEditorPlugin::vertexShaderInit(variant);
sem.translationUnit(file->ast(), globalScope, file->engine());
}
if (variant & Lexer::Variant_FragmentShader) {
file = GlslEditorPlugin::fragmentShaderInit(variant);
sem.translationUnit(file->ast(), globalScope, file->engine());
}
sem.translationUnit(ast, globalScope, doc->_engine);
CreateRanges createRanges(document(), doc);
createRanges(ast);
const TextEditor::FontSettings &fontSettings = TextEditor::TextEditorSettings::instance()->fontSettings();
QTextCharFormat warningFormat = fontSettings.toTextCharFormat(TextEditor::C_WARNING);
QTextCharFormat errorFormat = fontSettings.toTextCharFormat(TextEditor::C_ERROR);
QList<QTextEdit::ExtraSelection> sels;
QSet<int> errors;
foreach (const DiagnosticMessage &m, doc->_engine->diagnosticMessages()) {
if (! m.line())
continue;
else if (errors.contains(m.line()))
continue;
errors.insert(m.line());
QTextCursor cursor(document()->findBlockByNumber(m.line() - 1));
cursor.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);
QTextEdit::ExtraSelection sel;
sel.cursor = cursor;
sel.format = m.isError() ? errorFormat : warningFormat;
sel.format.setToolTip(m.message());
sels.append(sel);
}
setExtraSelections(CodeWarningsSelection, sels);
m_glslDocument = doc;
}
}
void GlslEditorWidget::onTooltipRequested(const QPoint &point, int pos)
{
QTC_ASSERT(m_glslDocument && m_glslDocument->engine(), return);
const int lineno = document()->findBlock(pos).blockNumber() + 1;
const QStringList messages
= Utils::transform<QStringList>(
Utils::filtered(m_glslDocument->engine()->diagnosticMessages(),
[lineno](const DiagnosticMessage &msg) {
return msg.line() == lineno;
}),
[](const DiagnosticMessage &msg) {
return msg.message();
});
if (!messages.isEmpty())
Utils::ToolTip::show(point, messages.join("<hr/>"), this);
else
Utils::ToolTip::hide();
}
int languageVariant(const QString &type)
{
int variant = 0;
bool isVertex = false;
bool isFragment = false;
bool isDesktop = false;
if (type.isEmpty()) {
// ### Before file has been opened, so don't know the mime type.
isVertex = true;
isFragment = true;
} else if (type == QLatin1String("text/x-glsl") ||
type == QLatin1String("application/x-glsl")) {
isVertex = true;
isFragment = true;
isDesktop = true;
} else if (type == QLatin1String("text/x-glsl-vert")) {
isVertex = true;
isDesktop = true;
} else if (type == QLatin1String("text/x-glsl-frag")) {
isFragment = true;
isDesktop = true;
} else if (type == QLatin1String("text/x-glsl-es-vert")) {
isVertex = true;
} else if (type == QLatin1String("text/x-glsl-es-frag")) {
isFragment = true;
}
if (isDesktop)
variant |= Lexer::Variant_GLSL_120;
else
variant |= Lexer::Variant_GLSL_ES_100;
if (isVertex)
variant |= Lexer::Variant_VertexShader;
if (isFragment)
variant |= Lexer::Variant_FragmentShader;
return variant;
}
AssistInterface *GlslEditorWidget::createAssistInterface(
AssistKind kind, AssistReason reason) const
{
if (kind == Completion)
return new GlslCompletionAssistInterface(document(),
position(),
textDocument()->filePath(),
reason,
textDocument()->mimeType(),
m_glslDocument);
return TextEditorWidget::createAssistInterface(kind, reason);
}
//
// GlslEditorFactory
//
GlslEditorFactory::GlslEditorFactory()
{
setId(Constants::C_GLSLEDITOR_ID);
setDisplayName(QCoreApplication::translate("OpenWith::Editors", Constants::C_GLSLEDITOR_DISPLAY_NAME));
addMimeType(Constants::GLSL_MIMETYPE);
addMimeType(Constants::GLSL_MIMETYPE_VERT);
addMimeType(Constants::GLSL_MIMETYPE_FRAG);
addMimeType(Constants::GLSL_MIMETYPE_VERT_ES);
addMimeType(Constants::GLSL_MIMETYPE_FRAG_ES);
setDocumentCreator([]() { return new TextDocument(Constants::C_GLSLEDITOR_ID); });
setEditorWidgetCreator([]() { return new GlslEditorWidget; });
setIndenterCreator([](QTextDocument *doc) { return new GlslIndenter(doc); });
setSyntaxHighlighterCreator([]() { return new GlslHighlighter; });
setCommentDefinition(Utils::CommentDefinition::CppStyle);
setCompletionAssistProvider(new GlslCompletionAssistProvider);
setParenthesesMatchingEnabled(true);
setCodeFoldingSupported(true);
setEditorActionHandlers(TextEditorActionHandler::Format
| TextEditorActionHandler::UnCommentSelection
| TextEditorActionHandler::UnCollapseAll);
}
} // namespace Internal
} // namespace GlslEditor