Commit 822de6c1 authored by Christian Kamm's avatar Christian Kamm
Browse files

QmlJS: Introduce a new indenter that works similarly to the new C++ one.

Done-with: Thomas Hartmann
parent f6232260
......@@ -56,6 +56,11 @@ OTHER_FILES += \
$$PWD/parser/qmljs.g
contains(QT, gui) {
SOURCES += $$PWD/qmljsindenter.cpp
HEADERS += $$PWD/qmljsindenter.h
SOURCES += \
$$PWD/qmljsindenter.cpp \
$$PWD/qmljscodeformatter.cpp
HEADERS += \
$$PWD/qmljsindenter.h \
$$PWD/qmljscodeformatter.h
}
This diff is collapsed.
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** 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.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#ifndef QMLJSCODEFORMATTER_H
#define QMLJSCODEFORMATTER_H
#include "qmljs_global.h"
#include "qmljsscanner.h"
#include <QtCore/QChar>
#include <QtCore/QStack>
#include <QtCore/QList>
#include <QtCore/QVector>
#include <QtCore/QPointer>
QT_BEGIN_NAMESPACE
class QTextDocument;
class QTextBlock;
QT_END_NAMESPACE
namespace QmlJS {
class QMLJS_EXPORT CodeFormatter
{
Q_GADGET
public:
CodeFormatter();
virtual ~CodeFormatter();
// updates all states up until block if necessary
// it is safe to call indentFor on block afterwards
void updateStateUntil(const QTextBlock &block);
// calculates the state change introduced by changing a single line
void updateLineStateChange(const QTextBlock &block);
int indentFor(const QTextBlock &block);
void setTabSize(int tabSize);
void invalidateCache(QTextDocument *document);
protected:
virtual void onEnter(int newState, int *indentDepth, int *savedIndentDepth) const = 0;
virtual void adjustIndent(const QList<Token> &tokens, int lexerState, int *indentDepth) const = 0;
class State;
class BlockData
{
public:
BlockData();
QStack<State> m_beginState;
QStack<State> m_endState;
int m_indentDepth;
int m_blockRevision;
};
virtual void saveBlockData(QTextBlock *block, const BlockData &data) const = 0;
virtual bool loadBlockData(const QTextBlock &block, BlockData *data) const = 0;
virtual void saveLexerState(QTextBlock *block, int state) const = 0;
virtual int loadLexerState(const QTextBlock &block) const = 0;
public: // must be public to make Q_GADGET introspection work
enum StateType {
invalid = 0,
topmost_intro, // The first line in a "topmost" definition.
top_qml, // root state for qml
top_js, // root for js
objectdefinition_or_js, // file starts with identifier
multiline_comment_start,
multiline_comment_cont,
import_start, // after 'import'
import_maybe_dot_or_version_or_as, // after string or identifier
import_dot, // after .
import_maybe_as, // after version
import_as,
property_start, // after 'property'
default_property_start, // after 'default'
property_type, // after first identifier
property_list_open, // after 'list' as a type
property_maybe_initializer, // after
signal_start, // after 'signal'
signal_maybe_arglist, // after identifier
signal_arglist_open, // after '('
function_start, // after 'function'
function_arglist_open, // after '(' starting function argument list
function_arglist_closed, // after ')' in argument list, expecting '{'
binding_or_objectdefinition, // after an identifier
binding_assignment, // after :
objectdefinition_open, // after {
expression,
expression_continuation, // at the end of the line, when the next line definitely is a continuation
expression_maybe_continuation, // at the end of the line, when the next line may be an expression
expression_or_objectdefinition, // after a binding starting with an identifier ("x: foo")
paren_open, // opening ( in expression
bracket_open, // opening [ in expression
bracket_element_start, // after starting bracket_open or after ',' in bracket_open
bracket_element_maybe_objectdefinition, // after an identifier in bracket_element_start
ternary_op, // The ? : operator
jsblock_open,
empty_statement, // for a ';', will never linger
if_statement, // After 'if'
maybe_else, // after the first substatement in an if
else_clause, // The else line of an if-else construct.
condition_open, // Start of a condition in 'if', 'while', entered after opening paren
condition_paren_open, // After an lparen in a condition
substatement, // The first line after a conditional or loop construct.
substatement_open, // The brace that opens a substatement block.
return_statement, // After 'return'
statement_with_condition, // After the 'for', 'while', 'catch', ... token
statement_with_condition_paren_open, // While inside the (...)
statement_with_block, // try, finally
do_statement, // after 'do'
do_statement_while_paren_open, // after '(' in while clause
switch_statement, // After 'switch' token
case_start, // after a 'case' or 'default' token
case_cont, // after the colon in a case/default
};
Q_ENUMS(StateType)
protected:
// extends Token::Kind from qmljsscanner.h
// the entries until EndOfExistingTokenKinds must match
enum TokenKind {
EndOfFile,
Keyword,
Identifier,
String,
Comment,
Number,
LeftParenthesis,
RightParenthesis,
LeftBrace,
RightBrace,
LeftBracket,
RightBracket,
Semicolon,
Colon,
Comma,
Dot,
Delimiter,
EndOfExistingTokenKinds,
Break,
Case,
Catch,
Continue,
Debugger,
Default,
Delete,
Do,
Else,
Finally,
For,
Function,
If,
In,
Instanceof,
New,
Return,
Switch,
This,
Throw,
Try,
Typeof,
Var,
Void,
While,
With,
Import,
Signal,
On,
As,
List,
Property,
Question,
PlusPlus,
MinusMinus,
};
TokenKind extendedTokenKind(const QmlJS::Token &token) const;
struct State {
State()
: savedIndentDepth(0)
, type(0)
{}
State(quint8 ty, quint16 savedDepth)
: savedIndentDepth(savedDepth)
, type(ty)
{}
quint16 savedIndentDepth;
quint8 type;
bool operator==(const State &other) const {
return type == other.type
&& savedIndentDepth == other.savedIndentDepth;
}
};
State state(int belowTop = 0) const;
const QVector<State> &newStatesThisLine() const;
int tokenIndex() const;
int tokenCount() const;
const Token &currentToken() const;
const Token &tokenAt(int idx) const;
int column(int position) const;
bool isBracelessState(int type) const;
bool isExpressionEndState(int type) const;
void dump() const;
private:
void recalculateStateAfter(const QTextBlock &block);
void saveCurrentState(const QTextBlock &block);
void restoreCurrentState(const QTextBlock &block);
QStringRef currentTokenText() const;
int tokenizeBlock(const QTextBlock &block);
void turnInto(int newState);
bool tryInsideExpression(bool alsoExpression = false);
bool tryStatement();
void enter(int newState);
void leave(bool statementDone = false);
void correctIndentation(const QTextBlock &block);
private:
static QStack<State> initialState();
QStack<State> m_beginState;
QStack<State> m_currentState;
QStack<State> m_newStates;
QList<Token> m_tokens;
QString m_currentLine;
Token m_currentToken;
int m_tokenIndex;
// should store indent level and padding instead
int m_indentDepth;
int m_tabSize;
};
} // namespace QmlJS
#endif // QMLJSCODEFORMATTER_H
......@@ -33,8 +33,8 @@
#include "qmljseditorplugin.h"
#include "qmljsmodelmanager.h"
#include "qmloutlinemodel.h"
#include "qmljseditorcodeformatter.h"
#include <qmljs/qmljsindenter.h>
#include <qmljs/qmljsbind.h>
#include <qmljs/qmljscheck.h>
#include <qmljs/qmljsdocument.h>
......@@ -1276,15 +1276,25 @@ bool QmlJSTextEditor::isClosingBrace(const QList<Token> &tokens) const
return false;
}
static QmlJSEditor::QtStyleCodeFormatter setupCodeFormatter(const TextEditor::TabSettings &ts)
{
QmlJSEditor::QtStyleCodeFormatter codeFormatter;
codeFormatter.setIndentSize(ts.m_indentSize);
codeFormatter.setTabSize(ts.m_tabSize);
return codeFormatter;
}
void QmlJSTextEditor::indentBlock(QTextDocument *doc, QTextBlock block, QChar typedChar)
{
TextEditor::TabSettings ts = tabSettings();
QmlJSIndenter indenter;
indenter.setTabSize(ts.m_tabSize);
indenter.setIndentSize(ts.m_indentSize);
Q_UNUSED(doc)
Q_UNUSED(typedChar)
const TextEditor::TabSettings &ts = tabSettings();
QmlJSEditor::QtStyleCodeFormatter codeFormatter = setupCodeFormatter(ts);
const int indent = indenter.indentForBottomLine(doc->begin(), block.next(), typedChar);
ts.indentLine(block, indent);
codeFormatter.updateStateUntil(block);
const int depth = codeFormatter.indentFor(block);
ts.indentLine(block, depth);
}
TextEditor::BaseTextEditorEditable *QmlJSTextEditor::createEditableInterface()
......
......@@ -26,7 +26,8 @@ HEADERS += \
qmljscomponentfromobjectdef.h \
qmljsoutline.h \
qmloutlinemodel.h \
qmltaskmanager.h
qmltaskmanager.h \
qmljseditorcodeformatter.h
SOURCES += \
qmljscodecompletion.cpp \
......@@ -46,7 +47,8 @@ SOURCES += \
qmljsoutline.cpp \
qmloutlinemodel.cpp \
qmltaskmanager.cpp \
qmljsquickfixes.cpp
qmljsquickfixes.cpp \
qmljseditorcodeformatter.cpp
RESOURCES += qmljseditor.qrc
OTHER_FILES += QmlJSEditor.pluginspec QmlJSEditor.mimetypes.xml
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** 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.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#include "qmljseditorcodeformatter.h"
#include <QtCore/QDebug>
using namespace QmlJS;
using namespace QmlJSEditor;
using namespace TextEditor;
QtStyleCodeFormatter::QtStyleCodeFormatter()
: m_indentSize(4)
{
}
void QtStyleCodeFormatter::setIndentSize(int size)
{
m_indentSize = size;
}
void QtStyleCodeFormatter::saveBlockData(QTextBlock *block, const BlockData &data) const
{
TextBlockUserData *userData = BaseTextDocumentLayout::userData(*block);
QmlJSCodeFormatterData *cppData = static_cast<QmlJSCodeFormatterData *>(userData->codeFormatterData());
if (!cppData) {
cppData = new QmlJSCodeFormatterData;
userData->setCodeFormatterData(cppData);
}
cppData->m_data = data;
}
bool QtStyleCodeFormatter::loadBlockData(const QTextBlock &block, BlockData *data) const
{
TextBlockUserData *userData = BaseTextDocumentLayout::testUserData(block);
if (!userData)
return false;
QmlJSCodeFormatterData *cppData = static_cast<QmlJSCodeFormatterData *>(userData->codeFormatterData());
if (!cppData)
return false;
*data = cppData->m_data;
return true;
}
void QtStyleCodeFormatter::saveLexerState(QTextBlock *block, int state) const
{
BaseTextDocumentLayout::setLexerState(*block, state);
}
int QtStyleCodeFormatter::loadLexerState(const QTextBlock &block) const
{
return BaseTextDocumentLayout::lexerState(block);
}
void QtStyleCodeFormatter::onEnter(int newState, int *indentDepth, int *savedIndentDepth) const
{
const State &parentState = state();
const Token &tk = currentToken();
const int tokenPosition = column(tk.begin());
const bool firstToken = (tokenIndex() == 0);
const bool lastToken = (tokenIndex() == tokenCount() - 1);
switch (newState) {
case objectdefinition_open: {
// special case for things like "gradient: Gradient {"
if (parentState.type == binding_assignment)
*savedIndentDepth = state(1).savedIndentDepth;
bool followedByData = (!lastToken && !tokenAt(tokenIndex() + 1).kind == Token::Comment);
if (firstToken || followedByData)
*savedIndentDepth = tokenPosition;
*indentDepth = *savedIndentDepth;
if (followedByData) {
*indentDepth = column(tokenAt(tokenIndex() + 1).begin());
} else {
*indentDepth += m_indentSize;
}
break;
}
case binding_or_objectdefinition:
if (firstToken)
*indentDepth = *savedIndentDepth = tokenPosition;
break;
case binding_assignment:
if (lastToken)
*indentDepth = *savedIndentDepth + 4;
else
*indentDepth = column(tokenAt(tokenIndex() + 1).begin());
break;
case expression_or_objectdefinition:
*indentDepth = tokenPosition;
break;
case expression:
// expression_or_objectdefinition has already consumed the first token
// ternary already adjusts indents nicely
if (parentState.type != expression_or_objectdefinition
&& parentState.type != binding_assignment
&& parentState.type != ternary_op) {
*indentDepth += 2 * m_indentSize;
}
if (!firstToken && parentState.type != expression_or_objectdefinition) {
*indentDepth = tokenPosition;
}
break;
case expression_maybe_continuation:
// set indent depth to indent we'd get if the expression ended here
for (int i = 1; state(i).type != topmost_intro; ++i) {
const int type = state(i).type;
if (isExpressionEndState(type) && !isBracelessState(type)) {
*indentDepth = state(i - 1).savedIndentDepth;
break;
}
}
break;
case bracket_open:
if (parentState.type == expression && state(1).type == binding_assignment) {
*savedIndentDepth = state(2).savedIndentDepth;
*indentDepth = *savedIndentDepth + m_indentSize;
} else if (!lastToken) {
*indentDepth = tokenPosition + 1;
} else {
*indentDepth = *savedIndentDepth + m_indentSize;
}
break;
case function_start:
if (parentState.type == expression) {
// undo the continuation indent of the expression
*indentDepth = parentState.savedIndentDepth;
*savedIndentDepth = *indentDepth;
}
break;
case do_statement_while_paren_open:
case statement_with_condition_paren_open:
case signal_arglist_open:
case function_arglist_open:
case paren_open:
case condition_paren_open:
if (!lastToken)
*indentDepth = tokenPosition + 1;
else
*indentDepth += m_indentSize;
break;
case ternary_op:
if (!lastToken)
*indentDepth = tokenPosition + tk.length + 1;
else
*indentDepth += m_indentSize;
break;
case jsblock_open:
// closing brace should be aligned to case
if (parentState.type == case_cont) {
*savedIndentDepth = parentState.savedIndentDepth;
break;
}
// fallthrough
case substatement_open:
// special case for foo: {
if (parentState.type == binding_assignment && state(1).type == binding_or_objectdefinition)
*savedIndentDepth = state(1).savedIndentDepth;
*indentDepth = *savedIndentDepth + m_indentSize;
break;
case statement_with_condition:
case statement_with_block:
case if_statement:
case do_statement:
case switch_statement:
if (firstToken || parentState.type == binding_assignment)
*savedIndentDepth = tokenPosition;
// ### continuation
*indentDepth = *savedIndentDepth; // + 2*m_indentSize;
break;
case maybe_else: {
// set indent to outermost braceless savedIndent
int outermostBraceless = 0;
while (isBracelessState(state(outermostBraceless + 1).type))
++outermostBraceless;
*indentDepth = state(outermostBraceless).savedIndentDepth;
// this is where the else should go, if one appears - aligned to if_statement
*savedIndentDepth = state().savedIndentDepth;
break;