Changes between Version 11 and Version 12 of CodingGuidelines/VIM

Timestamp:

Jul 8, 2010, 11:19:11 AM (14 years ago)

Author:

pulkomandy

Comment:

Update the regexps with more finetuned ones (avoids some false positives and checks some more things), and detailed the help text on how to use it.

CodingGuidelines/VIM

@@ -3 +3 @@
 
 {{{
+
+
+:fu FuncHaikuCheck()
+                call matchadd('Search', '\%>80v.\+', -1) " line with more than 80 chars
+        call matchadd('Search', '0\s* \s*', -1)        " probably wrong indenting
+        call matchadd('Search', '\(for\|if\|select\|while\)(', -1)
+                "keyword without space after it
+        call matchadd('Search', '[a-zA-Z0-9][,=>+\-*;][a-zA-Z0-9]', -1)
+                "operator without space around it (without false positive on
+                "templated<type>)
+        call matchadd('Search', '^[^#].*[^<][a-zA-Z0-9]*/[a-zA-Z0-9]', -1)
+                "operator without space around it (without false positive on
+                "#include <dir/file.h>)
+        call matchadd('Search', '^[^/]\{2}.*[^*][=/+\- ]$', -1)
+                "operator at end of line (without false positives on /* and */, nor
+                "char*\nClass::method())
+        call matchadd('Search', '\s$', -1) "Spaces at end of line
+        call matchadd('Search', ',\S', -1) " Missing space after comma
+:endfu
+}}}
+
+== Calling the scrip ==
+
+The obvious way to enable the script is to do it by hand :
+{{{
+:call FuncHaikuCheck()
+}}}
+
+It is also possible to make it run on every opened file (this is a bit annoying when using vim for something else than Haiku or C++ files)
+{{{
 " autocmd that will set up the w:created variable (vim tip 1598)
 " so we can run the check only once per window
 autocmd VimEnter * autocmd WinEnter * let w:created=1
-
-:fu FuncHaikuCheck()
-        call matchadd('Search', '\%>80v.\+', -1) " line with more than 80 chars
-        call matchadd('Search', '  ', -1)        " probably wrong indenting
-        call matchadd('Search', '\(for\|if\|select\|while\)(', -1) "keyword without space after it
-        call matchadd('Search', '[a-zA-Z0-9][,=>/+\-*;][a-zA-Z0-9]', -1) "operator without space around it (without template_d<t_ype>)
-        call matchadd('Search', '[^*][=/+\- ]$', -1) "operator at end of line (without false positives on char*\nclass::method(), /* and */)
-:endfu
 
 " call the function on all opened files
@@ -20 +42 @@
 }}}
 
+The last option is to define a keyboard shortcut to enable it (control+F3 in this example) :
+{{{
+map <C-F3> :call FuncHaikuCheck()<CR>
+}}}
+
 These rules have been ported to a standalone python program see the Style Checker Tools paragraph in the [http://www.haiku-os.org/development/coding-guidelines Haiku coding guidelines] and  [http://dev.haiku-os.org/browser/haiku/trunk/src/tools/checkstyle/ src/tools/checkstyle/]