Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 1 | " LLVM coding guidelines conformance for VIM |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 2 | " |
| 3 | " Maintainer: The LLVM Team, http://llvm.org |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 4 | " WARNING: Read before you source in all these commands and macros! Some |
Misha Brukman | 2bb5508 | 2005-05-12 21:41:48 +0000 | [diff] [blame] | 5 | " of them may change VIM behavior that you depend on. |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 6 | " |
| 7 | " You can run VIM with these settings without changing your current setup with: |
| 8 | " $ vim -u /path/to/llvm/utils/vim/vimrc |
| 9 | |
| 10 | " It's VIM, not VI |
| 11 | set nocompatible |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 12 | |
| 13 | " Wrap text at 80 cols |
| 14 | set textwidth=80 |
| 15 | |
| 16 | " A tab produces a 2-space indentation |
Dan Gohman | f225d2e | 2009-01-04 00:05:43 +0000 | [diff] [blame] | 17 | set softtabstop=2 |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 18 | set shiftwidth=2 |
| 19 | set expandtab |
| 20 | |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 21 | " Highlight trailing whitespace |
| 22 | highlight WhitespaceEOL ctermbg=DarkYellow guibg=DarkYellow |
| 23 | match WhitespaceEOL /\s\+$/ |
| 24 | |
Misha Brukman | 2bb5508 | 2005-05-12 21:41:48 +0000 | [diff] [blame] | 25 | " Optional |
| 26 | " C/C++ programming helpers |
Dan Gohman | 96eafe2 | 2009-01-04 00:03:54 +0000 | [diff] [blame] | 27 | set cindent |
Dan Gohman | a0741ba | 2009-01-04 18:59:55 +0000 | [diff] [blame] | 28 | " Set a few indentation parameters. See the VIM help for cinoptions-values for |
| 29 | " details. These aren't absolute rules; they're just an approximation of |
| 30 | " common style in LLVM source. |
| 31 | set cinoptions=:0,g0,(0,Ws |
Misha Brukman | 2bb5508 | 2005-05-12 21:41:48 +0000 | [diff] [blame] | 32 | " Add and delete spaces in increments of `shiftwidth' for tabs |
| 33 | set smarttab |
| 34 | |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 35 | " Highlight syntax in programming languages |
| 36 | syntax on |
| 37 | |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 38 | " Enable filetype detection |
| 39 | filetype on |
| 40 | |
| 41 | " LLVM Makefiles can have names such as Makefile.rules or TEST.nightly.Makefile, |
| 42 | " so it's important to categorize them as such. |
| 43 | augroup filetype |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 44 | au! BufRead,BufNewFile *Makefile* set filetype=make |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 45 | augroup END |
| 46 | |
| 47 | " In Makefiles, don't expand tabs to spaces, since we need the actual tabs |
| 48 | autocmd FileType make set noexpandtab |
| 49 | |
| 50 | " Useful macros for cleaning up code to conform to LLVM coding guidelines |
| 51 | |
| 52 | " Delete trailing whitespace and tabs at the end of each line |
Misha Brukman | 5539a1e | 2009-01-08 02:17:30 +0000 | [diff] [blame] | 53 | command! DeleteTrailingWs :%s/\s\+$// |
Misha Brukman | 3d6eea5 | 2005-04-24 17:05:04 +0000 | [diff] [blame] | 54 | |
| 55 | " Convert all tab characters to two spaces |
Misha Brukman | adf4e4d | 2009-01-02 16:26:14 +0000 | [diff] [blame] | 56 | command! Untab :%s/\t/ /g |