Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.64 KB

codestyle.md

File metadata and controls

49 lines (38 loc) · 1.64 KB
Raw

Code Style

Command-Line

We follow the Google Cpp Style Guide. There is a .clang-format file in the root directory that is derived from this style. It can be used with the clang-format tool to reformat the source files, e.g.,

$ clang-format -style=file analyzer/lib/Slicing/Slicer.cpp

This will use the .clang-format file to re-format the source file and print it to the console. To re-format the file in-place, add the -i flag.

$ clang-format -i -style=file analyzer/lib/Slicing/Slicer.cpp
$ clang-format -i -style=file analyzer/lib/*/*.cpp

Make target

We defined a make target in the CMakeFiles to run clang-format on all source files when invoked.

make format

(first time using it should do a cd build; cmake ..)

IDE

If you are using Clion, the IDE supports .clang-format style. Go to Settings/Preferences | Editor | Code Style, check the box Enable ClangFormat with clangd server.

Vim

clang-format can also be integrated with vim doc. Put the following in your .vimrc will automatically run clang-format whenever you save (write) the .cpp or .h files. The Ctrl-K command will format selected regions.

map <C-K> :pyf /opt/software/llvm/3.9.1/dist/share/clang/clang-format.py<cr>
imap <C-K> <c-o>:pyf /opt/software/llvm/3.9.1/dist/share/clang/clang-format.py<cr>

function! Formatonsave()
  let l:formatdiff = 1
  pyf /opt/software/llvm/3.9.1/dist/share/clang/clang-format.py
endfunction
autocmd BufWritePre *.h,*.cc,*.cpp call Formatonsave()