Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 3155533003f935295c32b0db2bdf8fad3170ad79 / . / llvm / utils / vim / vimrc
blob: 7b1fd872b274c9cae5916ece46e5b18997dc873f [file] [log] [blame]
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]1" LLVM coding guidelines conformance for VIM
Misha Brukmanac7b4562009-01-02 16:26:14 +0000[diff] [blame]2"
3" Maintainer: The LLVM Team, http://llvm.org
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]4" WARNING: Read before you source in all these commands and macros! Some
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +0000[diff] [blame]5" of them may change VIM behavior that you depend on.
Misha Brukmanac7b4562009-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
11set nocompatible
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]12
13" Wrap text at 80 cols
14set textwidth=80
15
16" A tab produces a 2-space indentation
Dan Gohman2dca8282009-01-04 00:05:43 +0000[diff] [blame]17set softtabstop=2
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]18set shiftwidth=2
19set expandtab
20
Misha Brukmanac7b4562009-01-02 16:26:14 +0000[diff] [blame]21" Highlight trailing whitespace
22highlight WhitespaceEOL ctermbg=DarkYellow guibg=DarkYellow
23match WhitespaceEOL /\s\+$/
24
Dan Gohman455be5a2009-01-21 21:30:25 +0000[diff] [blame]25" Enable filetype detection
26filetype on
27
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +0000[diff] [blame]28" Optional
29" C/C++ programming helpers
Dan Gohman455be5a2009-01-21 21:30:25 +0000[diff] [blame]30augroup csrc
31 au!
32 autocmd FileType * set nocindent smartindent
33 autocmd FileType c,cpp set cindent
34augroup END
Dan Gohmanbe631a32009-01-04 18:59:55 +0000[diff] [blame]35" Set a few indentation parameters. See the VIM help for cinoptions-values for
36" details. These aren't absolute rules; they're just an approximation of
37" common style in LLVM source.
38set cinoptions=:0,g0,(0,Ws
Misha Brukmanf1ed8ed2005-05-12 21:41:48 +0000[diff] [blame]39" Add and delete spaces in increments of `shiftwidth' for tabs
40set smarttab
41
Misha Brukmanac7b4562009-01-02 16:26:14 +0000[diff] [blame]42" Highlight syntax in programming languages
43syntax on
44
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]45" LLVM Makefiles can have names such as Makefile.rules or TEST.nightly.Makefile,
46" so it's important to categorize them as such.
47augroup filetype
Misha Brukmanac7b4562009-01-02 16:26:14 +0000[diff] [blame]48 au! BufRead,BufNewFile *Makefile* set filetype=make
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]49augroup END
50
51" In Makefiles, don't expand tabs to spaces, since we need the actual tabs
52autocmd FileType make set noexpandtab
53
54" Useful macros for cleaning up code to conform to LLVM coding guidelines
55
56" Delete trailing whitespace and tabs at the end of each line
Misha Brukman93bd1ca2009-01-08 02:17:30 +0000[diff] [blame]57command! DeleteTrailingWs :%s/\s\+$//
Misha Brukman831ad842005-04-24 17:05:04 +0000[diff] [blame]58
59" Convert all tab characters to two spaces
Misha Brukmanac7b4562009-01-02 16:26:14 +0000[diff] [blame]60command! Untab :%s/\t/ /g
Dan Gohman31555332009-01-21 21:47:51 +0000[diff] [blame^]61
62" Enable syntax highlighting for LLVM files. To use, copy
63" utils/vim/llvm.vim to ~/.vim/syntax .
64augroup filetype
65 au! BufRead,BufNewFile *.ll set filetype=llvm
66augroup END
67
68" Enable syntax highlighting for tablegen files. To use, copy
69" utils/vim/tablegen.vim to ~/.vim/syntax .
70augroup filetype
71 au! BufRead,BufNewFile *.td set filetype=tablegen
72augroup END