clang-format
LLVM's formatter for C and its family, in its LLVM style.
- Formats
- C, C++
- In
ur.toml [format] style = "clang-format"- Its options
- https://clang.llvm.org/docs/ClangFormatStyleOptions.html
C, formatted
cart.c, as written#include <stddef.h>
/* What a cart costs. */
struct item { const char *name; int price; int quantity; };
int subtotal(const struct item *items, size_t count)
{
int sum=0;
for(size_t i=0;i<count;i++) sum+=items[i].price*items[i].quantity;
return sum;
}
ur format --style clang-format cart.c#include <stddef.h>
/* What a cart costs. */
struct item {
const char *name;
int price;
int quantity;
};
int subtotal(const struct item *items, size_t count) {
int sum = 0;
for (size_t i = 0; i < count; i++)
sum += items[i].price * items[i].quantity;
return sum;
}
C++, formatted
cart.cpp, as written#include <vector>
// What a cart costs.
namespace cart {
struct Item { int price; int quantity; };
int subtotal(const std::vector<Item> & items){
int sum=0;
for(const Item & item:items) sum+=item.price*item.quantity;
return sum;
}
} // namespace cart
ur format --style clang-format cart.cpp#include <vector>
// What a cart costs.
namespace cart {
struct Item {
int price;
int quantity;
};
int subtotal(const std::vector<Item> &items) {
int sum = 0;
for (const Item &item : items)
sum += item.price * item.quantity;
return sum;
}
} // namespace cart
Defaults
The shared options, as clang-format sets them when nothing configures it. Its own names for them are read from its configuration files, but ur.toml sets them by the shared name only.
| Option | Default | clang-format calls it |
|---|---|---|
width | 80 | ColumnLimit |
max-width | ||
indent.width | 2 | IndentWidth |
indent.style | ||
line-ending | "auto" | |
trailing-comma.add | "preserve" | |
trailing-comma.forces-break | false | |
quotes | "preserve" | |
target |
Its own options
Set in a table named for it, such as [format.clang-format], or in a language's table, as clang-format = { ... }.
| Option | Default | Values |
|---|---|---|
BasedOnStyle | "LLVM" | any value |
AlignAfterOpenBracket | true | any value |
AccessModifierOffset | -2 | any value |
AlignArrayOfStructures | "None" | any value |
AlignConsecutiveAssignments.Enabled | false | any value |
AlignConsecutiveAssignments.AcrossEmptyLines | false | any value |
AlignConsecutiveAssignments.AcrossComments | false | any value |
AlignConsecutiveAssignments.AlignCompound | false | any value |
AlignConsecutiveAssignments.AlignFunctionDeclarations | false | any value |
AlignConsecutiveAssignments.AlignFunctionPointers | false | any value |
AlignConsecutiveAssignments.PadOperators | true | any value |
AlignConsecutiveBitFields.Enabled | false | any value |
AlignConsecutiveBitFields.AcrossEmptyLines | false | any value |
AlignConsecutiveBitFields.AcrossComments | false | any value |
AlignConsecutiveBitFields.AlignCompound | false | any value |
AlignConsecutiveBitFields.AlignFunctionDeclarations | false | any value |
AlignConsecutiveBitFields.AlignFunctionPointers | false | any value |
AlignConsecutiveBitFields.PadOperators | false | any value |
AlignConsecutiveDeclarations.Enabled | false | any value |
AlignConsecutiveDeclarations.AcrossEmptyLines | false | any value |
AlignConsecutiveDeclarations.AcrossComments | false | any value |
AlignConsecutiveDeclarations.AlignCompound | false | any value |
AlignConsecutiveDeclarations.AlignFunctionDeclarations | true | any value |
AlignConsecutiveDeclarations.AlignFunctionPointers | false | any value |
AlignConsecutiveDeclarations.PadOperators | false | any value |
AlignConsecutiveMacros.Enabled | false | any value |
AlignConsecutiveMacros.AcrossEmptyLines | false | any value |
AlignConsecutiveMacros.AcrossComments | false | any value |
AlignConsecutiveMacros.AlignCompound | false | any value |
AlignConsecutiveMacros.AlignFunctionDeclarations | false | any value |
AlignConsecutiveMacros.AlignFunctionPointers | false | any value |
AlignConsecutiveMacros.PadOperators | false | any value |
AlignConsecutiveShortCaseStatements.Enabled | false | any value |
AlignConsecutiveShortCaseStatements.AcrossEmptyLines | false | any value |
AlignConsecutiveShortCaseStatements.AcrossComments | false | any value |
AlignConsecutiveShortCaseStatements.AlignCaseArrows | false | any value |
AlignConsecutiveShortCaseStatements.AlignCaseColons | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.Enabled | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.AcrossEmptyLines | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.AcrossComments | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.AlignCompound | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.AlignFunctionDeclarations | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.AlignFunctionPointers | false | any value |
AlignConsecutiveTableGenBreakingDAGArgColons.PadOperators | false | any value |
AlignConsecutiveTableGenCondOperatorColons.Enabled | false | any value |
AlignConsecutiveTableGenCondOperatorColons.AcrossEmptyLines | false | any value |
AlignConsecutiveTableGenCondOperatorColons.AcrossComments | false | any value |
AlignConsecutiveTableGenCondOperatorColons.AlignCompound | false | any value |
AlignConsecutiveTableGenCondOperatorColons.AlignFunctionDeclarations | false | any value |
AlignConsecutiveTableGenCondOperatorColons.AlignFunctionPointers | false | any value |
AlignConsecutiveTableGenCondOperatorColons.PadOperators | false | any value |
AlignConsecutiveTableGenDefinitionColons.Enabled | false | any value |
AlignConsecutiveTableGenDefinitionColons.AcrossEmptyLines | false | any value |
AlignConsecutiveTableGenDefinitionColons.AcrossComments | false | any value |
AlignConsecutiveTableGenDefinitionColons.AlignCompound | false | any value |
AlignConsecutiveTableGenDefinitionColons.AlignFunctionDeclarations | false | any value |
AlignConsecutiveTableGenDefinitionColons.AlignFunctionPointers | false | any value |
AlignConsecutiveTableGenDefinitionColons.PadOperators | false | any value |
AlignEscapedNewlines | "Right" | any value |
AlignOperands | "Align" | any value |
AlignTrailingComments.AlignPPAndNotPP | true | any value |
AlignTrailingComments.Kind | "Always" | any value |
AlignTrailingComments.OverEmptyLines | 0 | any value |
AllowAllArgumentsOnNextLine | true | any value |
AllowAllParametersOfDeclarationOnNextLine | true | any value |
AllowBreakBeforeNoexceptSpecifier | "Never" | any value |
AllowBreakBeforeQtProperty | false | any value |
AllowShortBlocksOnASingleLine | "Never" | any value |
AllowShortCaseExpressionOnASingleLine | true | any value |
AllowShortCaseLabelsOnASingleLine | false | any value |
AllowShortCompoundRequirementOnASingleLine | true | any value |
AllowShortEnumsOnASingleLine | true | any value |
AllowShortFunctionsOnASingleLine | "All" | any value |
AllowShortIfStatementsOnASingleLine | "Never" | any value |
AllowShortLambdasOnASingleLine | "All" | any value |
AllowShortLoopsOnASingleLine | false | any value |
AllowShortNamespacesOnASingleLine | false | any value |
AlwaysBreakAfterDefinitionReturnType | "None" | any value |
AlwaysBreakBeforeMultilineStrings | false | any value |
AttributeMacros | ["__capability"] | any value |
BinPackArguments | true | any value |
BinPackLongBracedList | true | any value |
BinPackParameters | "BinPack" | any value |
BitFieldColonSpacing | "Both" | any value |
BracedInitializerIndentWidth | -1 | any value |
BraceWrapping.AfterCaseLabel | false | any value |
BraceWrapping.AfterClass | false | any value |
BraceWrapping.AfterControlStatement | "Never" | any value |
BraceWrapping.AfterEnum | false | any value |
BraceWrapping.AfterExternBlock | false | any value |
BraceWrapping.AfterFunction | false | any value |
BraceWrapping.AfterNamespace | false | any value |
BraceWrapping.AfterObjCDeclaration | false | any value |
BraceWrapping.AfterStruct | false | any value |
BraceWrapping.AfterUnion | false | any value |
BraceWrapping.BeforeCatch | false | any value |
BraceWrapping.BeforeElse | false | any value |
BraceWrapping.BeforeLambdaBody | false | any value |
BraceWrapping.BeforeWhile | false | any value |
BraceWrapping.IndentBraces | false | any value |
BraceWrapping.SplitEmptyFunction | true | any value |
BraceWrapping.SplitEmptyRecord | true | any value |
BraceWrapping.SplitEmptyNamespace | true | any value |
BreakAdjacentStringLiterals | true | any value |
BreakAfterAttributes | "Leave" | any value |
BreakAfterJavaFieldAnnotations | false | any value |
BreakAfterOpenBracketBracedList | false | any value |
BreakAfterOpenBracketFunction | false | any value |
BreakAfterOpenBracketIf | false | any value |
BreakAfterOpenBracketLoop | false | any value |
BreakAfterOpenBracketSwitch | false | any value |
BreakAfterReturnType | "None" | any value |
BreakArrays | true | any value |
BreakBeforeBinaryOperators | "None" | any value |
BreakBeforeCloseBracketBracedList | false | any value |
BreakBeforeCloseBracketFunction | false | any value |
BreakBeforeCloseBracketIf | false | any value |
BreakBeforeCloseBracketLoop | false | any value |
BreakBeforeCloseBracketSwitch | false | any value |
BreakBeforeConceptDeclarations | "Always" | any value |
BreakBeforeBraces | "Attach" | any value |
BreakBeforeInlineASMColon | "OnlyMultiline" | any value |
BreakBeforeTemplateCloser | false | any value |
BreakBeforeTernaryOperators | true | any value |
BreakBinaryOperations | "Never" | any value |
BreakConstructorInitializers | "BeforeColon" | any value |
BreakFunctionDefinitionParameters | false | any value |
BreakInheritanceList | "BeforeColon" | any value |
BreakStringLiterals | true | any value |
BreakTemplateDeclarations | "MultiLine" | any value |
CommentPragmas | "^ IWYU pragma:" | any value |
CompactNamespaces | false | any value |
ConstructorInitializerIndentWidth | 4 | any value |
ContinuationIndentWidth | 4 | any value |
Cpp11BracedListStyle | "AlignFirstComment" | any value |
DerivePointerAlignment | false | any value |
DisableFormat | false | any value |
EmptyLineAfterAccessModifier | "Never" | any value |
EmptyLineBeforeAccessModifier | "LogicalBlock" | any value |
EnumTrailingComma | "Leave" | any value |
ExperimentalAutoDetectBinPacking | false | any value |
FixNamespaceComments | true | any value |
ForEachMacros | ["foreach","Q_FOREACH","BOOST_FOREACH"] | any value |
IfMacros | ["KJ_IF_MAYBE"] | any value |
IncludeBlocks | "Preserve" | any value |
IncludeCategories | [{"Regex":"^\"(llvm|llvm-c|clang|clang-c)/","Priority":2,"SortPriority":0,"CaseSensitive":false},{"Regex":"^(<|\"(gtest|gmock|isl|json)/)","Priority":3,"SortPriority":0,"CaseSensitive":false},{"Regex":".*","Priority":1,"SortPriority":0,"CaseSensitive":false}] | any value |
IncludeIsMainRegex | "(Test)?$" | any value |
IncludeIsMainSourceRegex | "" | any value |
IndentAccessModifiers | false | any value |
IndentCaseBlocks | false | any value |
IndentCaseLabels | false | any value |
IndentExportBlock | true | any value |
IndentExternBlock | "AfterExternBlock" | any value |
IndentGotoLabels | true | any value |
IndentPPDirectives | "None" | any value |
IndentRequiresClause | true | any value |
IndentWrappedFunctionNames | false | any value |
InsertBraces | false | any value |
InsertNewlineAtEOF | false | any value |
InsertTrailingCommas | "None" | any value |
IntegerLiteralSeparator.Binary | 0 | any value |
IntegerLiteralSeparator.BinaryMinDigitsInsert | 0 | any value |
IntegerLiteralSeparator.BinaryMaxDigitsRemove | 0 | any value |
IntegerLiteralSeparator.Decimal | 0 | any value |
IntegerLiteralSeparator.DecimalMinDigitsInsert | 0 | any value |
IntegerLiteralSeparator.DecimalMaxDigitsRemove | 0 | any value |
IntegerLiteralSeparator.Hex | 0 | any value |
IntegerLiteralSeparator.HexMinDigitsInsert | 0 | any value |
IntegerLiteralSeparator.HexMaxDigitsRemove | 0 | any value |
IntegerLiteralSeparator.BinaryMinDigits | 0 | any value |
IntegerLiteralSeparator.DecimalMinDigits | 0 | any value |
IntegerLiteralSeparator.HexMinDigits | 0 | any value |
JavaScriptQuotes | "Leave" | any value |
JavaScriptWrapImports | true | any value |
KeepEmptyLines.AtEndOfFile | false | any value |
KeepEmptyLines.AtStartOfBlock | true | any value |
KeepEmptyLines.AtStartOfFile | true | any value |
KeepFormFeed | false | any value |
LambdaBodyIndentation | "Signature" | any value |
LineEnding | "DeriveLF" | any value |
MacroBlockBegin | "" | any value |
MacroBlockEnd | "" | any value |
MainIncludeChar | "Quote" | any value |
MaxEmptyLinesToKeep | 1 | any value |
NamespaceIndentation | "None" | any value |
NumericLiteralCase.ExponentLetter | "Leave" | any value |
NumericLiteralCase.HexDigit | "Leave" | any value |
NumericLiteralCase.Prefix | "Leave" | any value |
NumericLiteralCase.Suffix | "Leave" | any value |
ObjCBinPackProtocolList | "Auto" | any value |
ObjCBlockIndentWidth | 2 | any value |
ObjCBreakBeforeNestedBlockParam | true | any value |
ObjCSpaceAfterProperty | false | any value |
ObjCSpaceBeforeProtocolList | true | any value |
OneLineFormatOffRegex | "" | any value |
PackConstructorInitializers | "BinPack" | any value |
PenaltyBreakAssignment | 2 | any value |
PenaltyBreakBeforeFirstCallParameter | 19 | any value |
PenaltyBreakBeforeMemberAccess | 150 | any value |
PenaltyBreakComment | 300 | any value |
PenaltyBreakFirstLessLess | 120 | any value |
PenaltyBreakOpenParenthesis | 0 | any value |
PenaltyBreakScopeResolution | 500 | any value |
PenaltyBreakString | 1000 | any value |
PenaltyBreakTemplateDeclaration | 10 | any value |
PenaltyExcessCharacter | 1000000 | any value |
PenaltyIndentedWhitespace | 0 | any value |
PenaltyReturnTypeOnItsOwnLine | 60 | any value |
PointerAlignment | "Right" | any value |
PPIndentWidth | -1 | any value |
QualifierAlignment | "Leave" | any value |
ReferenceAlignment | "Pointer" | any value |
ReflowComments | "Always" | any value |
RemoveBracesLLVM | false | any value |
RemoveEmptyLinesInUnwrappedLines | false | any value |
RemoveParentheses | "Leave" | any value |
RemoveSemicolon | false | any value |
RequiresClausePosition | "OwnLine" | any value |
RequiresExpressionIndentation | "OuterScope" | any value |
SeparateDefinitionBlocks | "Leave" | any value |
ShortNamespaceLines | 1 | any value |
SkipMacroDefinitionBody | false | any value |
SortIncludes.Enabled | true | any value |
SortIncludes.IgnoreCase | false | any value |
SortIncludes.IgnoreExtension | false | any value |
SortJavaStaticImport | "Before" | any value |
SortUsingDeclarations | "LexicographicNumeric" | any value |
SpaceAfterCStyleCast | false | any value |
SpaceAfterLogicalNot | false | any value |
SpaceAfterOperatorKeyword | false | any value |
SpaceAfterTemplateKeyword | true | any value |
SpaceAroundPointerQualifiers | "Default" | any value |
SpaceBeforeAssignmentOperators | true | any value |
SpaceBeforeCaseColon | false | any value |
SpaceBeforeCpp11BracedList | false | any value |
SpaceBeforeCtorInitializerColon | true | any value |
SpaceBeforeInheritanceColon | true | any value |
SpaceBeforeJsonColon | false | any value |
SpaceBeforeParens | "ControlStatements" | any value |
SpaceBeforeParensOptions.AfterControlStatements | true | any value |
SpaceBeforeParensOptions.AfterForeachMacros | true | any value |
SpaceBeforeParensOptions.AfterFunctionDefinitionName | false | any value |
SpaceBeforeParensOptions.AfterFunctionDeclarationName | false | any value |
SpaceBeforeParensOptions.AfterIfMacros | true | any value |
SpaceBeforeParensOptions.AfterNot | false | any value |
SpaceBeforeParensOptions.AfterOverloadedOperator | false | any value |
SpaceBeforeParensOptions.AfterPlacementOperator | true | any value |
SpaceBeforeParensOptions.AfterRequiresInClause | false | any value |
SpaceBeforeParensOptions.AfterRequiresInExpression | false | any value |
SpaceBeforeParensOptions.BeforeNonEmptyParentheses | false | any value |
SpaceBeforeRangeBasedForLoopColon | true | any value |
SpaceBeforeSquareBrackets | false | any value |
SpaceInEmptyBraces | "Never" | any value |
SpacesBeforeTrailingComments | 1 | any value |
SpacesInAngles | "Never" | any value |
SpacesInContainerLiterals | true | any value |
SpacesInLineCommentPrefix.Minimum | 1 | any value |
SpacesInLineCommentPrefix.Maximum | -1 | any value |
SpacesInParens | "Never" | any value |
SpacesInParensOptions.ExceptDoubleParentheses | false | any value |
SpacesInParensOptions.InCStyleCasts | false | any value |
SpacesInParensOptions.InConditionalStatements | false | any value |
SpacesInParensOptions.InEmptyParentheses | false | any value |
SpacesInParensOptions.Other | false | any value |
SpacesInSquareBrackets | false | any value |
Standard | "Latest" | any value |
StatementAttributeLikeMacros | ["Q_EMIT"] | any value |
StatementMacros | ["Q_UNUSED","QT_REQUIRE_VERSION"] | any value |
TableGenBreakInsideDAGArg | "DontBreak" | any value |
TabWidth | 8 | any value |
UseTab | "Never" | any value |
VerilogBreakBetweenInstancePorts | true | any value |
WhitespaceSensitiveMacros | ["BOOST_PP_STRINGIZE","CF_SWIFT_NAME","NS_SWIFT_NAME","PP_STRINGIZE","STRINGIZE"] | any value |
WrapNamespaceBodyWithEmptyLines | "Leave" | any value |