vim: add include guards to C/C++ header files

[shutils.git] / dotfiles / vim / .vimrc

diff --git a/dotfiles/vim/.vimrc b/dotfiles/vim/.vimrc
index 7a05e1d5250798c9e3d6c6457632be1c28112158..5da54996af79d7730b9e6dfb1fec05781fb8b839 100644 (file)
--- a/dotfiles/vim/.vimrc
+++ b/dotfiles/vim/.vimrc
@@ -130,27 +130,31 @@ function PrependCppNamespaceToIdent(ns, id)
     "                           |/* id */
     "                           |::id
     "                           |/**/ ::id
+       "                           |#include <id>
     "
     " In order to not match '* id' it is assumed that multi-line comment lines
     " in the middle begin with a star.
 
-    " If // and /* and ^* and :: is not prepend:
-    execute ':%s_\(\(\/\/\|\/\*\|^\s*\*[^/]\).*\|::\)\@<!\<' . a:id . '\>_' . a:ns . '::' . a:id . '_ge'
-    " If // and :: is not prepend, but */ is, and no further /* or // are found
-    execute ':%s_\(\/\/.*\)\@<!\*\/\(\/[^\/\*]\|[^\/]\)*\zs\(::\)\@<!\<' . a:id . '\>_' . a:ns . '::' . a:id . '_ge'
+    " If #include and // and /* and ^* and :: is not prepend:
+    execute ':%s@\(\(#include\|\/\/\|\/\*\|^\s*\*[^/]\).*\|::\)\@<!\<' . a:id . '\>@' . a:ns . '::' . a:id . '@ge'
+    " If #include and // and :: is not prepend, but */ is, and no further /* or // are found
+    execute ':%s@\(\(#include\|\/\/\).*\)\@<!\*\/\(\/[^\/\*]\|[^\/]\)*\zs\(::\)\@<!\<' . a:id . '\>@' . a:ns . '::' . a:id . '@ge'
 
 endfunction
 
 "Prepend STL namespace 'std::' to several identifiers
 function PrependSTLNamespace()
+       " This list of identifier is not complete, but adding all of them is too
+       " much. We rather like to add identifieres that are 'typical' for C++.
+       " Others, like 'move' are likely to not be C++ specific. In this cases the
+       " user is asked to call PrependCppNamespaceToIdent by hand.
     let id = []
     let id = id +['cin', 'cout', 'cerr', 'endl']
     let id = id +['swap', 'sort', 'max', 'min']
     let id = id +['vector', 'deque', 'list', 'map', 'multimap', 'set']
     let id = id +['queue', 'stack', 'priority_queue']
-    let id = id +['ostream', 'istream']
+    let id = id +['ostream', 'istream', 'sstream']
     let id = id +['pair', 'string']
-    let id = ['map']
 
     for i in id
         call PrependCppNamespaceToIdent("std", i)
@@ -164,6 +168,19 @@ function EscapeHexToChar()
     execute '%s/^\(.*\)$/"\1"/'
 endfunction
 
+function InsertIncludeGuardsWithoutEndif()
+       let gatename = substitute(expand("%:t"), "\\.", "_", "g") . '_' . strpart(system('pwgen -c 16 1'), 0, 16)
+       execute "normal! i#ifndef " . gatename
+       execute "normal!   o#define " . gatename
+endfunction
+
+function AddIncludeGuards()
+       execute "normal! Go#endif"
+       execute "normal! gg"
+       call InsertIncludeGuardsWithoutEndif()
+endfunction
+
+autocmd BufNewFile *.{h,hpp} call AddIncludeGuards()
 
 
 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""