Skip to content

Commit

Permalink
Switch the default mode for clang-format to '-file'. Make 'LLVM' the
Browse files Browse the repository at this point in the history
fallback syntax used when we fail to find a '.clang-format' file. Adjust
variable names appropriately.

Update the editor integration pieces that specify a '-style' option to
specify it as '-style=file'. I left the functionality in place because
even if the preferred method is to use '.clang-format' files, this way
if someone needs to clobber the style in their editor we show how to do
so in these examples.

Also check in a '.clang-format' file for Clang to ensure that separate
checkouts and builds of Clang from LLVM can still get the nice
formatting. =] This unfortunately required nuking the test for the
absence of a '.clang-format' file as now the directory happening to be
under your clang source tree will cause there to always be a file. ;]

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@189741 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
chandlerc committed Sep 2, 2013
1 parent 0180688 commit 439fc85
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
1 change: 1 addition & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
BasedOnStyle: LLVM
7 changes: 2 additions & 5 deletions test/Format/style-on-command-line.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
// RUN: clang-format -style="{BasedOnStyle: invalid, IndentWidth: 7}" %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK3 %s
// RUN: clang-format -style="{lsjd}" %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK4 %s
// RUN: [ ! -e %T/.clang-format ] || rm %T/.clang-format
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK5 %s
// RUN: printf "BasedOnStyle: google\nIndentWidth: 5\n" > %T/.clang-format
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK6 %s
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK5 %s
void f() {
// CHECK1: {{^ int\* i;$}}
// CHECK2: {{^ int \*i;$}}
Expand All @@ -15,9 +14,7 @@ void f() {
// CHECK3: {{^ int \*i;$}}
// CHECK4: Error parsing -style: Invalid argument, using LLVM style
// CHECK4: {{^ int \*i;$}}
// CHECK5: Can't find usable .clang-format, using LLVM style
// CHECK5: {{^ int \*i;$}}
// CHECK6: {{^ int\* i;$}}
// CHECK5: {{^ int\* i;$}}
int*i;
int j;
}
14 changes: 7 additions & 7 deletions tools/clang-format/ClangFormat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@

using namespace llvm;

// Default style to use when no style specified or specified style not found.
static const char *DefaultStyle = "LLVM";
// Fallback style when no style specified or found in a .clang-format file.
static const char FallbackStyle[] = "LLVM";

static cl::opt<bool> Help("h", cl::desc("Alias for -help"), cl::Hidden);

Expand Down Expand Up @@ -72,7 +72,7 @@ static cl::opt<std::string>
"Use -style=\"{key: value, ...}\" to set specific\n"
"parameters, e.g.:\n"
" -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\""),
cl::init(DefaultStyle), cl::cat(ClangFormatCategory));
cl::init("file"), cl::cat(ClangFormatCategory));
static cl::opt<bool> Inplace("i",
cl::desc("Inplace edit <file>s, if specified."),
cl::cat(ClangFormatCategory));
Expand Down Expand Up @@ -108,20 +108,20 @@ static FileID createInMemoryFile(StringRef FileName, const MemoryBuffer *Source,

FormatStyle getStyle(StringRef StyleName, StringRef FileName) {
FormatStyle Style;
getPredefinedStyle(DefaultStyle, &Style);
getPredefinedStyle(FallbackStyle, &Style);

if (StyleName.startswith("{")) {
// Parse YAML/JSON style from the command line.
if (error_code ec = parseConfiguration(StyleName, &Style)) {
llvm::errs() << "Error parsing -style: " << ec.message()
<< ", using " << DefaultStyle << " style\n";
<< ", using " << FallbackStyle << " style\n";
}
return Style;
}

if (!StyleName.equals_lower("file")) {
if (!getPredefinedStyle(StyleName, &Style))
llvm::errs() << "Invalid value for -style, using " << DefaultStyle
llvm::errs() << "Invalid value for -style, using " << FallbackStyle
<< " style\n";
return Style;
}
Expand Down Expand Up @@ -153,7 +153,7 @@ FormatStyle getStyle(StringRef StyleName, StringRef FileName) {
return Style;
}
}
llvm::errs() << "Can't find usable .clang-format, using " << DefaultStyle
llvm::errs() << "Can't find usable .clang-format, using " << FallbackStyle
<< " style\n";
return Style;
}
Expand Down
7 changes: 4 additions & 3 deletions tools/clang-format/clang-format-sublime.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@
# Change this to the full path if clang-format is not on the path.
binary = 'clang-format'

# Change this to format according to other formatting styles
# (see clang-format -help).
style = 'LLVM'
# Change this to format according to other formatting styles. See the output of
# 'clang-format --help' for a list of supported styles. The default looks for
# a '.clang-format' file to indicate the style that should be used.
style = 'file'

class ClangFormatCommand(sublime_plugin.TextCommand):
def run(self, edit):
Expand Down
2 changes: 1 addition & 1 deletion tools/clang-format/clang-format.el
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
(let* ((orig-windows (get-buffer-window-list (current-buffer)))
(orig-window-starts (mapcar #'window-start orig-windows))
(orig-point (point))
(style "LLVM"))
(style "file"))
(unwind-protect
(call-process-region (point-min) (point-max) clang-format-binary t t nil
"-offset" (number-to-string (1- begin))
Expand Down
7 changes: 4 additions & 3 deletions tools/clang-format/clang-format.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@
# Change this to the full path if clang-format is not on the path.
binary = 'clang-format'

# Change this to format according to other formatting styles (see
# clang-format -help)
style = 'LLVM'
# Change this to format according to other formatting styles. See the output of
# 'clang-format --help' for a list of supported styles. The default looks for
# a '.clang-format' file to indicate the style that should be used.
style = 'file'

# Get the current text.
buf = vim.current.buffer
Expand Down

0 comments on commit 439fc85

Please sign in to comment.