forked from qt-creator/qt-creator
54a43de656
This adds a configuration file for clang-format [1] and a test file to demonstrate benefits and current problems with respect to Qt Creator's coding rules [2]. This is based on clang-format from the llvm/clang 5.0 branch, which is about to be released soon in the next days/weeks (already behind schedule). Using clang-format for Qt Creator brings these advantages: * Enforce a bunch of coding rules by a simple tool/shortcut invocation. * Spend less review cycles for authors and reviewers regarding formatting. This helps especially for/with first-time contributors. * clang-format sorts includes and using declarations. * clang-format adds/updates namespace end comments, e.g.: } // namespace Foo See dist/clangformat/README.md for setup instructions und currently known issues. [1] https://clang.llvm.org/docs/ClangFormat.html [2] https://doc-snapshots.qt.io/qtcreator-extending/coding-style.html Task-number: QTCREATORBUG-17643 Change-Id: I87bdd66b8e492e99a360022962b0053f02a33e57 Reviewed-by: Alessandro Portale <alessandro.portale@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
116 lines
3.4 KiB
YAML
116 lines
3.4 KiB
YAML
# .clang-format for Qt Creator
|
|
#
|
|
# This is for clang-format >= 5.0.
|
|
#
|
|
# The configuration below follows the Qt Creator Coding Rules [1] as closely as
|
|
# possible. For documentation of the options, see [2].
|
|
#
|
|
# Use ../../tests/manual/clang-format-for-qtc/test.cpp for documenting problems
|
|
# or testing changes.
|
|
#
|
|
# [1] https://doc-snapshots.qt.io/qtcreator-extending/coding-style.html
|
|
# [2] https://clang.llvm.org/docs/ClangFormatStyleOptions.html
|
|
#
|
|
---
|
|
Language: Cpp
|
|
AccessModifierOffset: -4
|
|
AlignAfterOpenBracket: Align
|
|
AlignConsecutiveAssignments: false
|
|
AlignConsecutiveDeclarations: false
|
|
AlignEscapedNewlines: DontAlign
|
|
AlignOperands: true
|
|
AlignTrailingComments: true
|
|
AllowAllParametersOfDeclarationOnNextLine: true
|
|
AllowShortBlocksOnASingleLine: false
|
|
AllowShortCaseLabelsOnASingleLine: false
|
|
AllowShortFunctionsOnASingleLine: Inline
|
|
AllowShortIfStatementsOnASingleLine: false
|
|
AllowShortLoopsOnASingleLine: false
|
|
AlwaysBreakAfterReturnType: None
|
|
AlwaysBreakBeforeMultilineStrings: false
|
|
AlwaysBreakTemplateDeclarations: true
|
|
BinPackArguments: false
|
|
BinPackParameters: false
|
|
BraceWrapping:
|
|
AfterClass: true
|
|
AfterControlStatement: false
|
|
AfterEnum: false
|
|
AfterFunction: true
|
|
AfterNamespace: false
|
|
AfterObjCDeclaration: false
|
|
AfterStruct: true
|
|
AfterUnion: false
|
|
BeforeCatch: false
|
|
BeforeElse: false
|
|
IndentBraces: false
|
|
SplitEmptyFunction: false
|
|
SplitEmptyRecord: false
|
|
SplitEmptyNamespace: false
|
|
BreakBeforeBinaryOperators: All
|
|
BreakBeforeBraces: Custom
|
|
BreakBeforeInheritanceComma: false
|
|
BreakBeforeTernaryOperators: true
|
|
BreakConstructorInitializersBeforeComma: false
|
|
BreakConstructorInitializers: BeforeComma
|
|
BreakAfterJavaFieldAnnotations: false
|
|
BreakStringLiterals: false
|
|
ColumnLimit: 100
|
|
CommentPragmas: '^ IWYU pragma:'
|
|
CompactNamespaces: false
|
|
ConstructorInitializerAllOnOneLineOrOnePerLine: false
|
|
ConstructorInitializerIndentWidth: 4
|
|
ContinuationIndentWidth: 4
|
|
Cpp11BracedListStyle: true
|
|
DerivePointerAlignment: false
|
|
DisableFormat: false
|
|
ExperimentalAutoDetectBinPacking: false
|
|
FixNamespaceComments: true
|
|
ForEachMacros:
|
|
- forever # avoids { wrapped to next line
|
|
- foreach
|
|
- Q_FOREACH
|
|
- BOOST_FOREACH
|
|
IncludeCategories:
|
|
- Regex: '^<Q.*'
|
|
Priority: 200
|
|
IncludeIsMainRegex: '(Test)?$'
|
|
IndentCaseLabels: false
|
|
IndentWidth: 4
|
|
IndentWrappedFunctionNames: false
|
|
JavaScriptQuotes: Leave
|
|
JavaScriptWrapImports: true
|
|
KeepEmptyLinesAtTheStartOfBlocks: false
|
|
# Do not add QT_BEGIN_NAMESPACE/QT_END_NAMESPACE as this will indent lines in between.
|
|
MacroBlockBegin: ""
|
|
MacroBlockEnd: ""
|
|
MaxEmptyLinesToKeep: 1
|
|
NamespaceIndentation: None
|
|
ObjCBlockIndentWidth: 4
|
|
ObjCSpaceAfterProperty: false
|
|
ObjCSpaceBeforeProtocolList: true
|
|
PenaltyBreakAssignment: 150
|
|
PenaltyBreakBeforeFirstCallParameter: 300
|
|
PenaltyBreakComment: 500
|
|
PenaltyBreakFirstLessLess: 400
|
|
PenaltyBreakString: 600
|
|
PenaltyExcessCharacter: 50
|
|
PenaltyReturnTypeOnItsOwnLine: 300
|
|
PointerAlignment: Right
|
|
ReflowComments: false
|
|
SortIncludes: true
|
|
SortUsingDeclarations: true
|
|
SpaceAfterCStyleCast: true
|
|
SpaceAfterTemplateKeyword: false
|
|
SpaceBeforeAssignmentOperators: true
|
|
SpaceBeforeParens: ControlStatements
|
|
SpaceInEmptyParentheses: false
|
|
SpacesBeforeTrailingComments: 1
|
|
SpacesInAngles: false
|
|
SpacesInContainerLiterals: false
|
|
SpacesInCStyleCastParentheses: false
|
|
SpacesInParentheses: false
|
|
SpacesInSquareBrackets: false
|
|
Standard: Cpp11
|
|
TabWidth: 4
|
|
UseTab: Never
|