glsleditor.cpp 12.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32 33

#include "glsleditor.h"
#include "glsleditoreditable.h"
#include "glsleditorconstants.h"
#include "glsleditorplugin.h"
34
#include "glslhighlighter.h"
35 36
#include "glslautocompleter.h"
#include "glslindenter.h"
Leandro Melo's avatar
Leandro Melo committed
37
#include "glslcompletionassist.h"
38

Roberto Raggi's avatar
Roberto Raggi committed
39 40 41
#include <glsl/glsllexer.h>
#include <glsl/glslparser.h>
#include <glsl/glslengine.h>
42
#include <glsl/glslsemantic.h>
Roberto Raggi's avatar
Roberto Raggi committed
43
#include <glsl/glslsymbols.h>
Roberto Raggi's avatar
Roberto Raggi committed
44

45 46
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/actionmanager/actioncontainer.h>
47
#include <coreplugin/id.h>
48 49 50 51 52 53 54 55 56 57 58 59 60 61
#include <coreplugin/actionmanager/command.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/icore.h>
#include <coreplugin/mimedatabase.h>
#include <extensionsystem/pluginmanager.h>
#include <texteditor/basetextdocument.h>
#include <texteditor/texteditorconstants.h>
#include <texteditor/texteditorsettings.h>
#include <texteditor/syntaxhighlighter.h>
#include <texteditor/refactoroverlay.h>
#include <qmldesigner/qmldesignerconstants.h>
#include <utils/changeset.h>
#include <utils/uncommentselection.h>

62 63 64
#include <QFileInfo>
#include <QSignalMapper>
#include <QTimer>
65
#include <QTextBlock>
66

67 68 69 70 71 72
#include <QMenu>
#include <QComboBox>
#include <QHeaderView>
#include <QInputDialog>
#include <QToolBar>
#include <QTreeView>
73
#include <QSharedPointer>
74 75 76 77 78 79 80 81 82

using namespace GLSL;
using namespace GLSLEditor;
using namespace GLSLEditor::Internal;

enum {
    UPDATE_DOCUMENT_DEFAULT_INTERVAL = 150
};

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
namespace {

class CreateRanges: protected GLSL::Visitor
{
    QTextDocument *textDocument;
    Document::Ptr glslDocument;

public:
    CreateRanges(QTextDocument *textDocument, Document::Ptr glslDocument)
        : textDocument(textDocument), glslDocument(glslDocument) {}

    void operator()(GLSL::AST *ast) { accept(ast); }

protected:
    using GLSL::Visitor::visit;

    virtual void endVisit(GLSL::CompoundStatementAST *ast)
    {
        if (ast->symbol) {
            QTextCursor tc(textDocument);
            tc.setPosition(ast->start);
            tc.setPosition(ast->end, QTextCursor::KeepAnchor);
            glslDocument->addRange(tc, ast->symbol);
        }
    }
};

} // end of anonymous namespace

Document::Document()
    : _engine(0)
    , _ast(0)
    , _globalScope(0)
{

}

Document::~Document()
{
    delete _globalScope;
    delete _engine;
}

GLSL::Scope *Document::scopeAt(int position) const
{
    foreach (const Range &c, _cursors) {
        if (position >= c.cursor.selectionStart() && position <= c.cursor.selectionEnd())
            return c.scope;
    }
    return _globalScope;
}

void Document::addRange(const QTextCursor &cursor, GLSL::Scope *scope)
{
    Range c;
    c.cursor = cursor;
    c.scope = scope;
    _cursors.append(c);
}

143 144
GLSLTextEditorWidget::GLSLTextEditorWidget(QWidget *parent)
    : TextEditor::BaseTextEditorWidget(parent)
145
{
146
    baseTextDocument()->setId(GLSLEditor::Constants::C_GLSLEDITOR_ID);
147
    baseTextDocument()->setIndenter(new GLSLIndenter());
148 149 150 151 152 153 154 155 156 157 158 159
    ctor();
}

GLSLTextEditorWidget::GLSLTextEditorWidget(GLSLTextEditorWidget *other)
    : TextEditor::BaseTextEditorWidget(other)
{
    ctor();
}

void GLSLTextEditorWidget::ctor()
{
    m_outlineCombo = 0;
160 161 162
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
    setCodeFoldingSupported(true);
163
    setAutoCompleter(new GLSLCompleter());
164 165 166 167 168 169 170 171

    m_updateDocumentTimer = new QTimer(this);
    m_updateDocumentTimer->setInterval(UPDATE_DOCUMENT_DEFAULT_INTERVAL);
    m_updateDocumentTimer->setSingleShot(true);
    connect(m_updateDocumentTimer, SIGNAL(timeout()), this, SLOT(updateDocumentNow()));

    connect(this, SIGNAL(textChanged()), this, SLOT(updateDocument()));

172
    new Highlighter(baseTextDocument());
173 174 175 176 177 178 179 180 181 182 183

//    if (m_modelManager) {
//        m_semanticHighlighter->setModelManager(m_modelManager);
//        connect(m_modelManager, SIGNAL(documentUpdated(GLSL::Document::Ptr)),
//                this, SLOT(onDocumentUpdated(GLSL::Document::Ptr)));
//        connect(m_modelManager, SIGNAL(libraryInfoUpdated(QString,GLSL::LibraryInfo)),
//                this, SLOT(forceSemanticRehighlight()));
//        connect(this->document(), SIGNAL(modificationChanged(bool)), this, SLOT(modificationChanged(bool)));
//    }
}

184
GLSLTextEditorWidget::~GLSLTextEditorWidget()
185 186 187
{
}

188
int GLSLTextEditorWidget::editorRevision() const
189 190 191 192 193
{
    //return document()->revision();
    return 0;
}

194
bool GLSLTextEditorWidget::isOutdated() const
195 196 197 198 199 200 201
{
//    if (m_semanticInfo.revision() != editorRevision())
//        return true;

    return false;
}

202
Core::IEditor *GLSLEditorEditable::duplicate()
203
{
204 205
    GLSLTextEditorWidget *newEditor = new GLSLTextEditorWidget(
                qobject_cast<GLSLTextEditorWidget *>(editorWidget()));
206
    TextEditor::TextEditorSettings::initializeEditor(newEditor);
207
    return newEditor->editor();
208 209
}

210
bool GLSLEditorEditable::open(QString *errorString, const QString &fileName, const QString &realFileName)
211
{
212
    baseTextDocument()->setMimeType(Core::MimeDatabase::findByFile(QFileInfo(fileName)).type());
213
    bool b = TextEditor::BaseTextEditor::open(errorString, fileName, realFileName);
214 215 216
    return b;
}

217 218 219 220 221
TextEditor::CompletionAssistProvider *GLSLEditorEditable::completionAssistProvider()
{
    return ExtensionSystem::PluginManager::getObject<GLSLCompletionAssistProvider>();
}

222
QString GLSLTextEditorWidget::wordUnderCursor() const
223 224
{
    QTextCursor tc = textCursor();
225
    const QChar ch = document()->characterAt(tc.position() - 1);
226 227 228 229 230 231 232 233 234
    // 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;
}

235
TextEditor::BaseTextEditor *GLSLTextEditorWidget::createEditor()
236 237 238 239 240 241
{
    GLSLEditorEditable *editable = new GLSLEditorEditable(this);
    createToolBar(editable);
    return editable;
}

242
void GLSLTextEditorWidget::createToolBar(GLSLEditorEditable *editor)
243 244 245
{
    m_outlineCombo = new QComboBox;
    m_outlineCombo->setMinimumContentsLength(22);
Roberto Raggi's avatar
Roberto Raggi committed
246 247

    // ### m_outlineCombo->setModel(m_outlineModel);
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

    QTreeView *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);

263
    editor->insertExtraToolBarWidget(TextEditor::BaseTextEditor::Left, m_outlineCombo);
264 265
}

266
void GLSLTextEditorWidget::updateDocument()
267
{
Roberto Raggi's avatar
Roberto Raggi committed
268
    m_updateDocumentTimer->start();
269 270
}

271
void GLSLTextEditorWidget::updateDocumentNow()
272
{
Roberto Raggi's avatar
Roberto Raggi committed
273 274
    m_updateDocumentTimer->stop();

275
    int variant = languageVariant(baseTextDocument()->mimeType());
Roberto Raggi's avatar
Roberto Raggi committed
276 277 278
    const QString contents = toPlainText(); // get the code from the editor
    const QByteArray preprocessedCode = contents.toLatin1(); // ### use the QtCreator C++ preprocessor.

279 280 281 282
    Document::Ptr doc(new Document());
    GLSL::Engine *engine = new GLSL::Engine();
    doc->_engine = new GLSL::Engine();
    Parser parser(doc->_engine, preprocessedCode.constData(), preprocessedCode.size(), variant);
283
    TranslationUnitAST *ast = parser.parse();
Roberto Raggi's avatar
Roberto Raggi committed
284 285
    if (ast != 0 || extraSelections(CodeWarningsSelection).isEmpty()) {
        Semantic sem;
286 287
        Scope *globalScope = engine->newNamespace();
        doc->_globalScope = globalScope;
hjk's avatar
hjk committed
288 289 290 291 292 293 294 295 296 297
        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);
        }
298 299 300 301
        sem.translationUnit(ast, globalScope, engine);

        CreateRanges createRanges(document(), doc);
        createRanges(ast);
Roberto Raggi's avatar
Roberto Raggi committed
302 303 304 305 306 307 308 309 310 311 312 313

        QTextCharFormat errorFormat;
        errorFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
        errorFormat.setUnderlineColor(Qt::red);

        QTextCharFormat warningFormat;
        warningFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
        warningFormat.setUnderlineColor(Qt::darkYellow);

        QList<QTextEdit::ExtraSelection> sels;
        QSet<int> errors;

314
        foreach (const DiagnosticMessage &m, engine->diagnosticMessages()) {
Roberto Raggi's avatar
Roberto Raggi committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
            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);
333
        m_glslDocument = doc;
Roberto Raggi's avatar
Roberto Raggi committed
334
    }
335
}
Roberto Raggi's avatar
Roberto Raggi committed
336

337
int GLSLTextEditorWidget::languageVariant(const QString &type)
Roberto Raggi's avatar
Roberto Raggi committed
338
{
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
    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
366
        variant |= Lexer::Variant_GLSL_ES_100;
367 368 369 370 371
    if (isVertex)
        variant |= Lexer::Variant_VertexShader;
    if (isFragment)
        variant |= Lexer::Variant_FragmentShader;
    return variant;
Roberto Raggi's avatar
Roberto Raggi committed
372
}
373

Leandro Melo's avatar
Leandro Melo committed
374 375 376 377 378 379 380
TextEditor::IAssistInterface *GLSLTextEditorWidget::createAssistInterface(
    TextEditor::AssistKind kind,
    TextEditor::AssistReason reason) const
{
    if (kind == TextEditor::Completion)
        return new GLSLCompletionAssistInterface(document(),
                                                 position(),
381
                                                 editor()->document()->filePath(),
Leandro Melo's avatar
Leandro Melo committed
382
                                                 reason,
383
                                                 baseTextDocument()->mimeType(),
hjk's avatar
hjk committed
384
                                                 m_glslDocument);
Leandro Melo's avatar
Leandro Melo committed
385 386
    return BaseTextEditorWidget::createAssistInterface(kind, reason);
}