forked from qt-creator/qt-creator
5cd6ebfdfd
This should make the indenter less strict and annoying for non-standard indentation styles. Reviewed-by: Roberto Raggi
279 lines
9.3 KiB
C++
279 lines
9.3 KiB
C++
/**************************************************************************
|
|
**
|
|
** 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 CPPCODEFORMATTER_H
|
|
#define CPPCODEFORMATTER_H
|
|
|
|
#include "cpptools_global.h"
|
|
|
|
#include <cplusplus/SimpleLexer.h>
|
|
#include <Token.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 TextEditor {
|
|
class TabSettings;
|
|
}
|
|
|
|
namespace CppTools {
|
|
namespace Internal {
|
|
class CppCodeFormatterData;
|
|
}
|
|
|
|
class CPPTOOLS_EXPORT CodeFormatter
|
|
{
|
|
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);
|
|
int indentForNewLineAfter(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<CPlusPlus::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;
|
|
|
|
protected:
|
|
enum StateType {
|
|
invalid = 0,
|
|
|
|
topmost_intro, // The first line in a "topmost" definition.
|
|
|
|
multiline_comment_start, // Inside the first line of a multi-line C style block comment.
|
|
multiline_comment_cont, // Inside the following lines of a multi-line C style block comment.
|
|
cpp_macro_start, // After the '#' token
|
|
cpp_macro, // The start of a C preprocessor macro definition.
|
|
cpp_macro_cont, // Subsequent lines of a multi-line C preprocessor macro definition.
|
|
cpp_macro_conditional, // Special marker used for separating saved from current state when dealing with #ifdef
|
|
qt_like_macro, // after an identifier starting with Q_ or QT_ at the beginning of the line
|
|
|
|
defun_open, // Brace that opens a top-level function definition.
|
|
using_start, // right after the "using" token
|
|
|
|
class_start, // after the 'class' token
|
|
class_open, // Brace that opens a class definition.
|
|
|
|
member_init_open, // After ':' that starts a member initialization list.
|
|
member_init, // At the start and after every ',' in member_init_open
|
|
member_init_paren_open, // After '(' in member_init.
|
|
|
|
enum_start, // After 'enum'
|
|
enum_open, // Brace that opens a enum declaration.
|
|
brace_list_open, // Open brace nested inside an enum or for a static array list.
|
|
|
|
namespace_start, // after the namespace token, before the opening brace.
|
|
namespace_open, // Brace that opens a C++ namespace block.
|
|
|
|
declaration_start, // shifted a token which could start a declaration.
|
|
operator_declaration, // after 'operator' in declaration_start
|
|
|
|
template_start, // after the 'template' token
|
|
template_param, // after the '<' in a template_start
|
|
|
|
if_statement, // After 'if'
|
|
maybe_else, // after the first substatement in an if
|
|
else_clause, // The else line of an if-else construct.
|
|
|
|
for_statement, // After the 'for' token
|
|
for_statement_paren_open, // While inside the (...)
|
|
for_statement_init, // The initializer part of the for statement
|
|
for_statement_condition, // The condition part of the for statement
|
|
for_statement_expression, // The expression part of the for statement
|
|
|
|
switch_statement, // After 'switch' token
|
|
case_start, // after a 'case' or 'default' token
|
|
case_cont, // after the colon in a case/default
|
|
|
|
statement_with_condition, // A statement that takes a condition after the start token.
|
|
do_statement, // After 'do' token
|
|
return_statement, // After 'return'
|
|
block_open, // Statement block open brace.
|
|
|
|
substatement, // The first line after a conditional or loop construct.
|
|
substatement_open, // The brace that opens a substatement block.
|
|
|
|
arglist_open, // after the lparen. TODO: check if this is enough.
|
|
stream_op, // After a '<<' or '>>' in a context where it's likely a stream operator.
|
|
stream_op_cont, // When finding another stream operator in stream_op
|
|
ternary_op, // The ? : operator
|
|
|
|
condition_open, // Start of a condition in 'if', 'while', entered after opening paren
|
|
condition_paren_open, // After an lparen in a condition
|
|
|
|
assign_open, // after an assignment token
|
|
|
|
expression, // after a '=' in a declaration_start once we're sure it's not '= {'
|
|
initializer, // after a '=' in a declaration start
|
|
};
|
|
|
|
class State {
|
|
public:
|
|
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 CPlusPlus::Token ¤tToken() const;
|
|
const CPlusPlus::Token &tokenAt(int idx) const;
|
|
int column(int position) const;
|
|
|
|
bool isBracelessState(int type) 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, bool *endedJoined = 0);
|
|
|
|
void turnInto(int newState);
|
|
|
|
bool tryExpression(bool alsoExpression = false);
|
|
bool tryDeclaration();
|
|
bool tryStatement();
|
|
|
|
void enter(int newState);
|
|
void leave(bool statementDone = false);
|
|
void correctIndentation(const QTextBlock &block);
|
|
|
|
void dump();
|
|
|
|
private:
|
|
static QStack<State> initialState();
|
|
|
|
QStack<State> m_beginState;
|
|
QStack<State> m_currentState;
|
|
QStack<State> m_newStates;
|
|
|
|
QList<CPlusPlus::Token> m_tokens;
|
|
QString m_currentLine;
|
|
CPlusPlus::Token m_currentToken;
|
|
int m_tokenIndex;
|
|
|
|
// should store indent level and padding instead
|
|
int m_indentDepth;
|
|
|
|
int m_tabSize;
|
|
|
|
friend class Internal::CppCodeFormatterData;
|
|
};
|
|
|
|
class CPPTOOLS_EXPORT QtStyleCodeFormatter : public CodeFormatter
|
|
{
|
|
public:
|
|
QtStyleCodeFormatter();
|
|
explicit QtStyleCodeFormatter(const TextEditor::TabSettings &tabSettings);
|
|
|
|
void setIndentSize(int size);
|
|
|
|
void setIndentSubstatementBraces(bool onOff);
|
|
void setIndentSubstatementStatements(bool onOff);
|
|
void setIndentDeclarationBraces(bool onOff);
|
|
void setIndentDeclarationMembers(bool onOff);
|
|
|
|
protected:
|
|
virtual void onEnter(int newState, int *indentDepth, int *savedIndentDepth) const;
|
|
virtual void adjustIndent(const QList<CPlusPlus::Token> &tokens, int lexerState, int *indentDepth) const;
|
|
|
|
virtual void saveBlockData(QTextBlock *block, const BlockData &data) const;
|
|
virtual bool loadBlockData(const QTextBlock &block, BlockData *data) const;
|
|
|
|
virtual void saveLexerState(QTextBlock *block, int state) const;
|
|
virtual int loadLexerState(const QTextBlock &block) const;
|
|
|
|
private:
|
|
int m_indentSize;
|
|
bool m_indentSubstatementBraces;
|
|
bool m_indentSubstatementStatements;
|
|
bool m_indentDeclarationBraces;
|
|
bool m_indentDeclarationMembers;
|
|
};
|
|
|
|
} // namespace CppTools
|
|
|
|
#endif // CPPCODEFORMATTER_H
|