qtscripteditor.cpp 11.7 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
7
8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
9
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** 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.
24
**
25
26
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
33
34
#include "qtscripteditor.h"
#include "qtscripteditorconstants.h"
#include "qtscripthighlighter.h"
#include "qtscripteditorplugin.h"

35
36
37
38
39
40
41
#include "parser/javascriptengine_p.h"
#include "parser/javascriptparser_p.h"
#include "parser/javascriptlexer_p.h"
#include "parser/javascriptnodepool_p.h"
#include "parser/javascriptastvisitor_p.h"
#include "parser/javascriptast_p.h"

con's avatar
con committed
42
43
44
#include <indenter.h>

#include <coreplugin/icore.h>
45
#include <coreplugin/actionmanager/actionmanager.h>
con's avatar
con committed
46
47
48
49
#include <texteditor/basetextdocument.h>
#include <texteditor/fontsettings.h>
#include <texteditor/textblockiterator.h>
#include <texteditor/texteditorconstants.h>
50
#include <texteditor/texteditorsettings.h>
con's avatar
con committed
51

52
#include <QtCore/QTimer>
Roberto Raggi's avatar
Roberto Raggi committed
53
54
55
56
#include <QtCore/QtDebug>

#include <QtGui/QMenu>
#include <QtGui/QComboBox>
57
58
59
60

enum {
    UPDATE_DOCUMENT_DEFAULT_INTERVAL = 100
};
con's avatar
con committed
61

Roberto Raggi's avatar
Roberto Raggi committed
62
63
64
using namespace JavaScript::AST;


con's avatar
con committed
65
66
67
namespace QtScriptEditor {
namespace Internal {

Roberto Raggi's avatar
Roberto Raggi committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class FindDeclarations: protected Visitor
{
    QList<Declaration> declarations;

public:
    QList<Declaration> accept(JavaScript::AST::Node *node)
    {
        JavaScript::AST::Node::acceptChild(node, this);
        return declarations;
    }

protected:
    using Visitor::visit;

    virtual bool visit(FunctionExpression *)
    {
        return false;
    }

    virtual bool visit(FunctionDeclaration *ast)
    {
89
90
91
        if (! ast->name)
            return false;

Roberto Raggi's avatar
Roberto Raggi committed
92
93
94
95
        QString text = ast->name->asString();

        text += QLatin1Char('(');
        for (FormalParameterList *it = ast->formals; it; it = it->next) {
96
97
            if (it->name)
                text += it->name->asString();
Roberto Raggi's avatar
Roberto Raggi committed
98
99
100
101
102
103
104
105
106

            if (it->next)
                text += QLatin1String(", ");
        }

        text += QLatin1Char(')');

        Declaration d;
        d.text = text;
107
        d.startLine = ast->startLine;
Roberto Raggi's avatar
Roberto Raggi committed
108
109
110
111
112
113
114
115
116
117
118
        d.startColumn = ast->startColumn;
        d.endLine = ast->endLine;
        d.endColumn = ast->endColumn;

        declarations.append(d);

        return false;
    }

    virtual bool visit(VariableDeclaration *ast)
    {
119
120
121
        if (! ast->name)
            return false;

Roberto Raggi's avatar
Roberto Raggi committed
122
123
124
125
126
127
128
129
130
131
132
133
        Declaration d;
        d.text = ast->name->asString();
        d.startLine= ast->startLine;
        d.startColumn = ast->startColumn;
        d.endLine = ast->endLine;
        d.endColumn = ast->endColumn;

        declarations.append(d);
        return false;
    }
};

con's avatar
con committed
134
135
136
137
138
139
140
141
ScriptEditorEditable::ScriptEditorEditable(ScriptEditor *editor, const QList<int>& context)
    : BaseTextEditorEditable(editor), m_context(context)
{
}

ScriptEditor::ScriptEditor(const Context &context,
                           QWidget *parent) :
    TextEditor::BaseTextEditor(parent),
Roberto Raggi's avatar
Roberto Raggi committed
142
143
    m_context(context),
    m_methodCombo(0)
con's avatar
con committed
144
145
146
{
    setParenthesesMatchingEnabled(true);
    setMarksVisible(true);
147
    setCodeFoldingSupported(true);
con's avatar
con committed
148
149
150
    setCodeFoldingVisible(true);
    setMimeType(QtScriptEditor::Constants::C_QTSCRIPTEDITOR_MIMETYPE);

151
152
153
154
155
156
157
158
    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()));

con's avatar
con committed
159
160
161
162
163
164
165
    baseTextDocument()->setSyntaxHighlighter(new QtScriptHighlighter);
}

ScriptEditor::~ScriptEditor()
{
}

166
167
168
QList<Declaration> ScriptEditor::declarations() const
{ return m_declarations; }

169
170
171
QStringList ScriptEditor::words() const
{ return m_words; }

con's avatar
con committed
172
173
Core::IEditor *ScriptEditorEditable::duplicate(QWidget *parent)
{
174
175
176
177
    ScriptEditor *newEditor = new ScriptEditor(m_context, parent);
    newEditor->duplicateFrom(editor());
    QtScriptEditorPlugin::instance()->initializeEditor(newEditor);
    return newEditor->editableInterface();
con's avatar
con committed
178
179
180
181
182
183
184
185
186
187
188
189
}

const char *ScriptEditorEditable::kind() const
{
    return QtScriptEditor::Constants::C_QTSCRIPTEDITOR;
}

ScriptEditor::Context ScriptEditorEditable::context() const
{
    return m_context;
}

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
void ScriptEditor::updateDocument()
{
    m_updateDocumentTimer->start(UPDATE_DOCUMENT_DEFAULT_INTERVAL);
}

void ScriptEditor::updateDocumentNow()
{
    // ### move in the parser thread.

    m_updateDocumentTimer->stop();

    const QString fileName = file()->fileName();
    const QString code = toPlainText();

    JavaScriptParser parser;
    JavaScriptEnginePrivate driver;

    JavaScript::NodePool nodePool(fileName, &driver);
    driver.setNodePool(&nodePool);

    JavaScript::Lexer lexer(&driver);
    lexer.setCode(code, /*line = */ 1);
    driver.setLexer(&lexer);

214
215
216
    if (parser.parse(&driver)) {
        JavaScript::AST::Visitor v;
        driver.ast()->accept(&v);
217

218
219
        FindDeclarations decls;
        m_declarations = decls.accept(driver.ast());
Roberto Raggi's avatar
Roberto Raggi committed
220

221
222
223
224
        m_words.clear();
        foreach (const JavaScriptNameIdImpl &id, driver.literals())
            m_words.append(id.asString());

225
226
        QStringList items;
        items.append(tr("<Select Symbol>"));
Roberto Raggi's avatar
Roberto Raggi committed
227

228
229
        foreach (Declaration decl, m_declarations)
            items.append(decl.text);
Roberto Raggi's avatar
Roberto Raggi committed
230

231
232
233
234
        m_methodCombo->clear();
        m_methodCombo->addItems(items);
        updateMethodBoxIndex();
    }
235
236

    QList<QTextEdit::ExtraSelection> selections;
Roberto Raggi's avatar
Roberto Raggi committed
237

238
239
240
    QTextCharFormat errorFormat;
    errorFormat.setUnderlineColor(Qt::red);
    errorFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
Roberto Raggi's avatar
Roberto Raggi committed
241

242
    QTextCharFormat warningFormat;
243
    warningFormat.setUnderlineColor(Qt::darkYellow);
244
    warningFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
245

246
247
248
    QTextEdit::ExtraSelection sel;

    foreach (const JavaScriptParser::DiagnosticMessage &d, parser.diagnosticMessages()) {
249
250
        int line = d.line;
        int column = d.column;
251

252
253
        if (column == 0)
            column = 1;
254

Roberto Raggi's avatar
Roberto Raggi committed
255
256
257
258
        if (d.isWarning())
            sel.format = warningFormat;
        else
            sel.format = errorFormat;
259

260
261
262
        QTextCursor c(document()->findBlockByNumber(line - 1));
        sel.cursor = c;
        sel.cursor.setPosition(c.position() + column - 1);
263
264
265
266
267
268
269
270
        sel.cursor.movePosition(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);

        selections.append(sel);
    }

    setExtraSelections(CodeWarningsSelection, selections);
}

Roberto Raggi's avatar
Roberto Raggi committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
void ScriptEditor::jumpToMethod(int index)
{
    if (index) {
        Declaration d = m_declarations.at(index - 1);
        gotoLine(d.startLine, d.startColumn - 1);
        setFocus();
    }
}

void ScriptEditor::updateMethodBoxIndex()
{
    int line = 0, column = 0;
    convertPosition(position(), &line, &column);

    int currentSymbolIndex = 0;

287
288
289
290
291
292
293
294
    int index = 0;
    while (index < m_declarations.size()) {
        const Declaration &d = m_declarations.at(index++);

        if (line < d.startLine)
            break;
        else
            currentSymbolIndex = index;
Roberto Raggi's avatar
Roberto Raggi committed
295
296
297
298
299
300
301
302
303
304
305
306
307
    }

    m_methodCombo->setCurrentIndex(currentSymbolIndex);
}

void ScriptEditor::updateMethodBoxToolTip()
{
}

void ScriptEditor::updateFileName()
{
}

con's avatar
con committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
void ScriptEditor::setFontSettings(const TextEditor::FontSettings &fs)
{
    TextEditor::BaseTextEditor::setFontSettings(fs);
    QtScriptHighlighter *highlighter = qobject_cast<QtScriptHighlighter*>(baseTextDocument()->syntaxHighlighter());
    if (!highlighter)
        return;

    static QVector<QString> categories;
    if (categories.isEmpty()) {
        categories << QLatin1String(TextEditor::Constants::C_NUMBER)
                   << QLatin1String(TextEditor::Constants::C_STRING)
                   << QLatin1String(TextEditor::Constants::C_TYPE)
                   << QLatin1String(TextEditor::Constants::C_KEYWORD)
                   << QLatin1String(TextEditor::Constants::C_PREPROCESSOR)
                   << QLatin1String(TextEditor::Constants::C_LABEL)
                   << QLatin1String(TextEditor::Constants::C_COMMENT);
    }

    highlighter->setFormats(fs.toTextCharFormats(categories));
    highlighter->rehighlight();
}

bool ScriptEditor::isElectricCharacter(const QChar &ch) const
{
    if (ch == QLatin1Char('{') || ch == QLatin1Char('}'))
        return true;
    return false;
}

    // Indent a code line based on previous
template <class Iterator>
static void indentScriptBlock(const TextEditor::TabSettings &ts,
                              const QTextBlock &block,
                              const Iterator &programBegin,
                              const Iterator &programEnd,
                              QChar typedChar)
{
    typedef typename SharedTools::Indenter<Iterator> Indenter ;
    Indenter &indenter = Indenter::instance();
347
348
    indenter.setTabSize(ts.m_tabSize);
    indenter.setIndentSize(ts.m_indentSize);
con's avatar
con committed
349
350
351
352
353
354
355
356
357
358
359
360
361
    const TextEditor::TextBlockIterator current(block);
    const int indent = indenter.indentForBottomLine(current, programBegin,
                                                    programEnd, typedChar);
    ts.indentLine(block, indent);
}

void ScriptEditor::indentBlock(QTextDocument *doc, QTextBlock block, QChar typedChar)
{
    const TextEditor::TextBlockIterator begin(doc->begin());
    const TextEditor::TextBlockIterator end(block.next());
    indentScriptBlock(tabSettings(), block, begin, end, typedChar);
}

Roberto Raggi's avatar
Roberto Raggi committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
TextEditor::BaseTextEditorEditable *ScriptEditor::createEditableInterface()
{
    ScriptEditorEditable *editable = new ScriptEditorEditable(this, m_context);
    createToolBar(editable);
    return editable;
}

void ScriptEditor::createToolBar(ScriptEditorEditable *editable)
{
    m_methodCombo = new QComboBox;
    m_methodCombo->setMinimumContentsLength(22);
    //m_methodCombo->setSizeAdjustPolicy(QComboBox::AdjustToContents);

    // Make the combo box prefer to expand
    QSizePolicy policy = m_methodCombo->sizePolicy();
    policy.setHorizontalPolicy(QSizePolicy::Expanding);
    m_methodCombo->setSizePolicy(policy);

    connect(m_methodCombo, SIGNAL(activated(int)), this, SLOT(jumpToMethod(int)));
    connect(this, SIGNAL(cursorPositionChanged()), this, SLOT(updateMethodBoxIndex()));
    connect(m_methodCombo, SIGNAL(currentIndexChanged(int)), this, SLOT(updateMethodBoxToolTip()));

    connect(file(), SIGNAL(changed()), this, SLOT(updateFileName()));

    QToolBar *toolBar = editable->toolBar();

    QList<QAction*> actions = toolBar->actions();
    toolBar->insertWidget(actions.first(), m_methodCombo);
}

con's avatar
con committed
392
393
394
395
void ScriptEditor::contextMenuEvent(QContextMenuEvent *e)
{
    QMenu *menu = createStandardContextMenu();

396
    if (Core::ActionContainer *mcontext = Core::ICore::instance()->actionManager()->actionContainer(QtScriptEditor::Constants::M_CONTEXT)) {
con's avatar
con committed
397
        QMenu *contextMenu = mcontext->menu();
hjk's avatar
hjk committed
398
        foreach (QAction *action, contextMenu->actions())
con's avatar
con committed
399
400
401
402
403
404
405
406
407
            menu->addAction(action);
    }

    menu->exec(e->globalPos());
    delete menu;
}

} // namespace Internal
} // namespace QtScriptEditor