Skip to content
This repository has been archived by the owner on Apr 23, 2020. It is now read-only.

Commit

Permalink
Allow _clang-format as alternative to .clang-format config filename
Browse files Browse the repository at this point in the history
Dotfiles are impractical on Windows. This makes clang-format search
for the style configuration file as '_clang-format' in addition to
the usual '.clang-format'. This is similar to how VIM searches for
'_vimrc' on Windows.

Differential Revision: http://llvm-reviews.chandlerc.com/D1629

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@190413 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
zmodem committed Sep 10, 2013
1 parent daa07e9 commit 9a7a50e
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/ClangFormat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ to format C/C++/Obj-C code.
When the desired code formatting style is different from the available options,
the style can be customized using the ``-style="{key: value, ...}"`` option or
by putting your style configuration to the ``.clang-format`` file in your
project's directory and using ``clang-format -style=file``.
by putting your style configuration in the ``.clang-format`` or ``_clang-format``
file in your project's directory and using ``clang-format -style=file``.

An easy way to create the ``.clang-format`` file is:

Expand Down
4 changes: 2 additions & 2 deletions docs/ClangFormatStyleOptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Configuring Style with clang-format

:program:`clang-format` supports two ways to provide custom style options:
directly specify style configuration in the ``-style=`` command line option or
use ``-style=file`` and put style configuration in the ``.clang-format`` file
in the project directory.
use ``-style=file`` and put style configuration in the ``.clang-format`` or
``_clang-format`` file in the project directory.

When using ``-style=file``, :program:`clang-format` for each input file will
try to find the ``.clang-format`` file located in the closest parent directory
Expand Down
5 changes: 5 additions & 0 deletions test/Format/style-on-command-line.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK5 %s
// RUN: printf "\n" > %T/.clang-format
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK6 %s
// RUN: [ ! -e %T/.clang-format ] || rm %T/.clang-format
// RUN: [ ! -e %T/_clang-format ] || rm %T/_clang-format
// RUN: printf "BasedOnStyle: google\nIndentWidth: 6\n" > %T/_clang-format
// RUN: clang-format -style=file %t.cpp 2>&1 | FileCheck -strict-whitespace -check-prefix=CHECK7 %s
void f() {
// CHECK1: {{^ int\* i;$}}
// CHECK2: {{^ int \*i;$}}
Expand All @@ -19,6 +23,7 @@ void f() {
// CHECK5: {{^ int\* i;$}}
// CHECK6: {{^Error reading .*\.clang-format: Invalid argument}}
// CHECK6: {{^ int \*i;$}}
// CHECK7: {{^ int\* i;$}}
int*i;
int j;
}
7 changes: 4 additions & 3 deletions tools/clang-format-vs/ClangFormat/ClangFormatPackage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,12 @@ public class OptionPageGrid : DialogPage
[DisplayName("Style")]
[Description("Coding style, currently supports:\n" +
" - Predefined styles ('LLVM', 'Google', 'Chromium', 'Mozilla').\n" +
" - 'File' to search for a YAML .clang-format configuration.\n" +
" - 'File' to search for a YAML .clang-format or _clang-format\n" +
" configuration file.\n" +
" - A YAML configuration snippet.\n\n" +
"'File':\n" +
" Searches for a .clang-format configuration in the source file's\n" +
" directory and its parents.\n\n" +
" Searches for a .clang-format or _clang-format configuration file\n" +
" in the source file's directory and its parents.\n\n" +
"YAML configuration snippet:\n" +
" The content of a .clang-format configuration file, as string.\n" +
" Example: '{BasedOnStyle: \"LLVM\", IndentWidth: 8}'\n\n" +
Expand Down
10 changes: 10 additions & 0 deletions tools/clang-format/ClangFormat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,22 @@ FormatStyle getStyle(StringRef StyleName, StringRef FileName) {
!Directory.empty();
Directory = llvm::sys::path::parent_path(Directory)) {
SmallString<128> ConfigFile(Directory);

llvm::sys::path::append(ConfigFile, ".clang-format");
DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
bool IsFile = false;
// Ignore errors from is_regular_file: we only need to know if we can read
// the file or not.
llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);

if (!IsFile) {
// Try _clang-format too, since dotfiles are not commonly used on Windows.
ConfigFile = Directory;
llvm::sys::path::append(ConfigFile, "_clang-format");
DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
llvm::sys::fs::is_regular_file(Twine(ConfigFile), IsFile);
}

if (IsFile) {
OwningPtr<MemoryBuffer> Text;
if (error_code ec = MemoryBuffer::getFile(ConfigFile, Text)) {
Expand Down
3 changes: 2 additions & 1 deletion tools/clang-format/clang-format-sublime.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@

# 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.
# a '.clang-format' or '_clang-format' file to indicate the style that should be
# used.
style = 'file'

class ClangFormatCommand(sublime_plugin.TextCommand):
Expand Down
3 changes: 2 additions & 1 deletion tools/clang-format/clang-format.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@

# 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.
# a '.clang-format' or '_clang-format' file to indicate the style that should be
# used.
style = 'file'

# Get the current text.
Expand Down

0 comments on commit 9a7a50e

Please sign in to comment.