csupport.txt C/C++ Support Aug 14 2016
C/C++ Support c-support csupport
Plug-in version 6.2
for Vim version 7.0 and above
Wolfgang Mehner <wolfgang-mehner@web.de>
(formerly Fritz Mehner <mehner.fritz@web.de>)
C/C++-IDE for Vim/gVim. It is written to considerably speed up writing code in
a consistent style. This is done by inserting complete statements,idioms,
code snippets, templates, and comments. Syntax checking, compiling, running
a program, running a code checker or a reformatter can be done with a
keystroke.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++ The plug-in version 6.0+ is a rewriting of version 5.19+. ++
++ The versions 5.0+ are based on a new and more powerful template system ++
++ (please see |template-support| for more information). ++
++ The template syntax has changed! ++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1. Usage |csupport-usage-gvim|
1.1 Menu 'Comments' |csupport-comm|
1.1.1 Append aligned comments |csupport-comm-aligned|
1.1.2 Adjust end-of-line comments |csupport-comm-realign|
1.1.3 Code to comment |csupport-code-to-comm|
1.1.4 Comment to code |csupport-comm-to-code|
1.1.5 Toggle non-C comments |csupport-comm-non-c|
1.1.6 Frame comments, file header, ... |csupport-comm-frame|
1.1.7 File section comments |csupport-comm-sections|
1.1.8 Keyword comment, special comment |csupport-comm-keyword|
1.1.9 Macros |csupport-comm-macros|
1.1.10 Date and date+time |csupport-comm-date|
1.1.11 C to C++ comments and vice versa |csupport-comm-c-cpp|
1.2 Menu 'Statements' |csupport-stat|
1.2.1 Normal mode, insert mode. |csupport-stat-normal-mode|
1.2.2 Visual mode. |csupport-stat-visual-mode|
1.3 Menu 'Preprocessor' |csupport-prep|
1.3.1 Normal mode, insert mode. |csupport-prep-normal-mode|
1.3.2 Visual mode. |csupport-prep-visual-mode|
1.3.3 Block out code with #if 0 .. #endif |csupport-prep-if0|
1.4 Menu 'Idioms' |csupport-idioms|
1.4.1 Item 'function' |csupport-idioms-function|
1.4.2 for-loop control |csupport-idioms-for-loop|
1.4.3 Item 'open input file' |csupport-idioms-input|
1.4.4 Item 'open output file' |csupport-idioms-output|
1.5 Menu 'Snippets' |csupport-snippets|
1.5.1 Code snippets |csupport-snippets|
1.5.2 Picking up prototypes |csupport-proto|
1.5.3 Code templates |csupport-templates-menu|
1.6 Menu 'C++' |csupport-c++|
1.6.1 Normal mode, insert mode. |csupport-c++-normal-mode|
1.6.2 Visual mode. |csupport-c++-visual-mode|
1.6.3 Implementation |csupport-c++-impl|
1.7 Menu 'Run' |csupport-run|
1.7.1 Compile, link, run |csupport-run-buffer|
1.7.2 Command line arguments |csupport-run-cmdline-args|
1.7.3 Executable to run |csupport-run-make-run|
1.7.4 Run debugger |csupport-run-debugger|
1.7.5 Splint |csupport-run-splint|
1.7.6 Cppcheck |csupport-run-cppcheck|
1.7.7 CodeCheck |csupport-run-codecheck|
1.7.8 Indent |csupport-run-indent|
1.7.9 Hardcopy |csupport-run-hardcopy|
1.7.10 Xterm size |csupport-run-xterm|
1.7.11 Output redirection |csupport-run-output|
1.8 Tool Box |csupport-toolbox|
1.8.1 Make |csupport-toolbox-make|
1.8.2 Other Tools |csupport-toolbox-others|
1.9 Menu 'Help' |csupport-help|
1.10 Menu 'Doxygen' |csupport-doxygen|
1.10.1 Enabling the menu |csupport-doxygen-enable|
2. Usage without GUI |csupport-usage-vim|
3. Hotkeys |csupport-hotkeys|
4. Customization and configuration |csupport-custom|
4.1 Global variables |csupport-custom-glob-vars|
4.2 The root menu |csupport-custom-root|
4.3 System-wide installation |csupport-system-wide|
5. Template files and tags |csupport-templates|
5.1 Template files |csupport-templates-files|
5.2 Macros |csupport-templates-macros|
5.2.1 User defined formats for date and time |csupport-templates-date|
5.3 Templates |csupport-templates-names|
5.3.1 Template definition |csupport-templates-definition|
5.3.2 The jump tags <+text+> etc. |csupport-templates-jumptags|
5.3.3 Command Ctrl-j |csupport-Ctrl-j|
5.5 Binding a style to a file extension |csupport-templates-bind|
6. C/C++ Dictionaries |csupport-dictionary|
7. Extend ctags |csupport-ctags|
7.1 Make and qmake |csupport-ctags-make|
7.2 Templates |csupport-ctags-templates|
8. Folding |csupport-folding|
9 Additional Mappings |csupport-ad-mappings|
10. Windows particularities |csupport-windows|
11. Additional tips |csupport-tips|
12. Troubleshooting |csupport-troubleshooting|
13. Release Notes /Change Log |csupport-release-notes|
How to add this help file to Vim's help |add-local-help|
1. USAGE WITH GUI (gVim) csupport-usage-gvim
If the root menu 'C/C++' is not visible call it with the item "Load C Support" from the standard Tools-menu. The item "Load C Support" can also be used to unload the C/C++-root menu. Nearly all menu entries insert code snippets or comments. All of these are contained within template files and can be changed by the user to meet their requirements (see|csupport-templates|).
1.1 MENU 'Comments' csupport-comm
1.1.1 APPEND ALIGNED COMMENTS TO CONSECUTIVE LINES csupport-comm-aligned In NORMAL MODE, the menu item 'end-of-line comment' will append a comment to the current line. In VISUAL MODE, this item will append aligned comments to all marked lines. Marking the first 4 linesprint_double_array ( double array[],int n,int columns,char* arrayname)and choosing 'end-of-line comment' will yieldprint_double_array ( double array[], /* */int n, /* */int columns, /* */char* arrayname /* */)If one or more lines go beyond the starting column (s.below), the comments will start at the second column after the longest line. The cursor will then be positioned inside the first comment. The default starting column is 49 ( = (multiple of 2,4, or 8) + 1 ). This can be changed by setting a global variable in the file ~/.vimrc , e.g. :let g:C_LineEndCommColDefault = 45The starting column can also be set by the menu item 'Comments->set end-of-line com. col'. Just position the cursor in an arbitrary column (column number is shown in the Vim status line) and choose this menu item. This setting is buffer related. If the cursor was at the end of a line you will be asked for a column number because this position is most likely not the desired starting column. Your choice will be confirmed.
1.1.2 ADJUST END-OF-LINE COMMENTS csupport-comm-realign After some changes end-of-line comments may be no longer aligned:print_double_array ( double array[], /* */long int n, /* */unsigned int columns, /* */char* a_name /* */)Realignment can be achieved with the menu item 'adjust end-of-line com.' In normal mode the comment (if any) in the current line will be aligned to the end-of-line comment column (see above) if possible. In visual mode the comments in the marked block will be aligned:print_double_array ( double array[], /* */long int n, /* */unsigned int columns, /* */char* a_name /* */)The realignment will not be done for comments with nothing else than leading whitespaces. These comments are usually captions:max = other.max; /* the maximum value */len = other.len; /* the length *//* ===== the next section ===== */pos = (x+y+z)/3.0; /* the next position */After the alignment we have:max = other.max; /* the maximum value */len = other.len; /* the length *//* ===== the next section ===== */pos = (x+y+z)/3.0; /* the next position */
1.1.3 CODE TO COMMENT csupport-code-to-comm The marked blockxxxxxxxxxxxxxxxxxxxxxxxxwill be changed by the menu item 'code->comment /**/' into the multiline comment (all (partially) marked lines):/* xxxxxxxx* xxxxxxxx* xxxxxxxx*/The marked block will be changed by the menu item 'code->comment //' into the multiline comment//xxxxxxxx//xxxxxxxx//xxxxxxxxThe menu items works also for a single line. A single line needs not to be marked.
1.1.4 COMMENT TO CODE csupport-comm-to-code If one (or more) complete comment (i.e. all lines belonging to the comment) is marked the item 'comment->code' will uncomment it. If the following lines are marked* printf ("\n");*/printf ("\n");// printf ("\n");///** printf ("\n");*/uncommenting will yield* printf ("\n");*/printf ("\n");printf ("\n");printf ("\n");The first 2 lines are only a part of a C-comment and remain unchanged. A C-comment can start with /* , /** or /*! . The menu item works also for a single line with a leading // . A single line needs not to be marked.
1.1.5 TOGGLE NON-C COMMENTS csupport-comm-non-c This menu item toggles the non-C comment for a single line or a marked range of lines for embedded non-C code. The default comment uses the hash characters '#'. The non-C comment can start with any string. You can change the default by setting a global variable in '~/.vimrc':let g:C_NonCComment = '^^'
1.1.6 FRAME COMMENTS, FILE HEADER, ... csupport-comm-frame Frame comments, file header comments and function, methods, class descriptions are read as templates from the appropriate files (see |csupport-templates|). There are two file description templates (menu items 'file description impl' and 'file description header', see also |csupport-templates|): implementation : files .c .cc .cp .cxx .cpp .CPP *.c++ .C .i *.ii header : everything else with filetype 'c' or 'cpp' The appropriate template will also be included into a new file. The plugin decides on the basis of the file extension. The default is shown above. You can change the list by setting a global variable in '~/.vimrc':autocmd BufRead,BufNewFile *.XYZ set filetype=clet g:C_SourceCodeExtensions = 'XYZ c cc cp cxx cpp CPP c++ C i ii'A new file named 'test.XYZ' will now be considered a C implementation file.
1.1.7 FILE SECTION COMMENTS csupport-comm-sections File section comments can be uses to separate typical C- and H-file sections with comments of similar appearance, e.g./* ##### HEADER FILE INCLUDES ################################################### *//* ##### MACROS - LOCAL TO THIS SOURCE FILE ################################### *//* ##### TYPE DEFINITIONS - LOCAL TO THIS SOURCE FILE ######################### */These section comments can also be inserted using the hotkey \ccs for C/C++ files, or \chs for H-files.
1.1.8 KEYWORD COMMENT, SPECIAL COMMENT csupport-comm-keyword Keword comments are end-of-line comments:/* :y Keywords are BUG COMPILER REMARK TODO TRICKY WARNING WORKAROUND user-defined-keyword These are preliminary comments to document places where work will be resumed shortly. They are usually not meant for the final documentation. These comments are easily found by searching for the keyword. The keyword comments can also be inserted using the hotkey \ckc . Special comments are occasionally used to mark special features of a code construct (e.g. a fall through cases in a switch statement, an empty loop):<keyword>:<date+time>:<author reference>:<arbitrary comment text>*//* EMPTY *//* NOT REACHED *//* REMAINS TO BE IMPLEMENTED */....The special comments can also be inserted using the hotkey \csc .
1.1.9 MACROS (PLUGIN) csupport-comm-macros The submenu 'macros' let you insert the predefined macros from the template system (see|csupport-templates-macros|).
1.1.10 DATE AND DATE+TIME csupport-comm-date The format for 'date' and 'date time' can be defined by the user (see |csupport-templates-date|).
1.1.11 C TO C++ COMMENTS AND VICE VERSA csupport-comm-c-cpp
The menu item '/* xxx */ <-> // xxx' changes a C++ comment into a C comment
and a C++ comment into a C comment (toggle).
This is done for the current line in normal or insert mode and for a marked
area of lines in visual mode.
The hotkey \cx does the same. It can be used with a range:
3\cx
changes the current line and the next 2 lines.
1.2 MENU 'Statements' csupport-stat
1.2.1 NORMAL MODE, INSERT MODE. csupport-stat-normal-mode An empty statement will be inserted and properly indented. The item 'if block' will insert an if-statement:if ( ) {<-IF_PART->}1.2.2 VISUAL MODE. csupport-stat-visual-mode STATEMENTS WITH BLOCKS AND CASE LABEL.
The highlighted areaxxxxxxxxxxcan be surrounded by one of the following statements:+----------------------------+-----------------------------+|if ( )| if ( ) ||{| { ||xxxxx| xxxxx ||xxxxx| xxxxx ||}| } ||| else ||| { ||| } |+----------------------------+-----------------------------+|for ( ; ; )| while ( ) ||{| { ||xxxxx| xxxxx ||xxxxx| xxxxx ||}| } |+----------------------------+-----------------------------+|do| ||{| { ||xxxxx| xxxxx ||xxxxx| xxxxx ||}| } ||while ( );| |+----------------------------+-----------------------------+|switch ( ) {||case :||break;||||case :||break;||||case :||break;||||case :||break;||||default:||break;||}|+----------------------------+-----------------------------+The whole statement will be indented after insertion. STATEMENTS WITHOUT BLOCKS.
One of the following statements can be inserted:+-------------------------------+--------------------------+|if ( )| for ( ; ; ) |+-------------------------------+--------------------------+|if ( )| while ( ) ||else| |+-------------------------------+--------------------------+|case :| ||break;| |+-------------------------------+--------------------------+
1.3 MENU 'Preprocessor' csupport-prep
1.3.1 NORMAL MODE, INSERT MODE. csupport-prep-normal-mode The preprocessor statements will be inserted and properly indented. 1.3.2 VISUAL MODE. csupport-prep-visual-mode STATEMENTS WITH BLOCKS
The highlighted areaxxxxxxxxxxcan be surrounded by one of the following statements:+----------------------------+-----------------------------+|#if CONDITION||xxxxx||xxxxx||#else /* ----- #if CONDITION ----- */||||#endif /* ----- #if CONDITION ----- */|+----------------------------------------------------------+|#ifdef CONDITION||xxxxx||xxxxx||#else /* ----- #ifdef CONDITION ----- */||||#endif /* ----- #ifdef CONDITION ----- */|+----------------------------------------------------------+|#ifndef CONDITION||xxxxx||xxxxx||#else /* ----- #ifndef CONDITION ----- */||||#endif /* ----- #ifndef CONDITION ----- */|+----------------------------------------------------------+|#ifndef INC_TEST||#define INC_TEST||xxxxx||xxxxx||#endif /* ----- #ifndef INC_TEST ----- */|+----------------------------------------------------------+|#if 0 /* ----- #if 0 : If0Label_1 ----- */||||#endif /* ----- #if 0 : If0Label_1 ----- */|+----------------------------------------------------------+The macro name for an include guard (e.g. INC_TEST above) will be derived as a suggestion from the file name. 1.3.3 BLOCK OUT CODE WITH #if 0 ... #endif csupport-prep-if0 The menu item #if 0 #endif inserts the lines#if 0 /* ----- #if 0 : If0Label_1 ----- */#endif /* ----- #if 0 : If0Label_1 ----- */In visual mode the marked block of lines will be surrounded by these lines. This is usually done to temporarily block out some code. The label names like If0Label_1 are automatically inserted into the comments. The trailing numbers are automatically incremented. These numbers can be changed by the user. The next number will be one above the highest number found in the current buffer. A corresponding label can be found by searching with the vim star command (*). All labels can be found with a global search like :g/If0Label_/ or :g/If0Label_\d\+/. All corresponding lines can be deleted with :g/If0Label_/d . REMOVE THE ENCLOSING #if 0 ... #endif -CONSTRUCT. The menu item 'remove #if #endif' removes such a construct if the cursor is in the middle of such a section or on one of the two enclosing lines. Nested constructs will be untouched.
1.4 MENU 'Idioms' csupport-idioms
1.4.1 Item 'function' csupport-idioms-function NORMAL MODE, INSERT MODE: The name of the function is asked for and the following lines (for function name "f") will be inserted:voidf (<+argument_list+>){return<+return_value+>;} /* ----- end of function f ----- */voidVISUAL MODE: Main or function: the highlighted lines will go inside the new function or main. for-loops: the highlighted lines will be set in braces. 1.4.2 for-loop control csupport-idioms-for-loop The menu items 'for( x=0; ... )' and 'for( x=n-1; ... )' can be used to write the control statement for a for-loop counting upward or downward. These items start an input dialog [TYPE (expand)] VARIABLE [START [END [INCR.]]] : asking for at least the name of the loop variable. The other parameters are optional. The type is restricted to the following integral data types:charintlonglong intlong longlong long intshortshort intsize_tunsignedunsigned charunsigned intunsigned longunsigned long intunsigned long longunsigned long long intunsigned shortunsigned short intOne of these types can be specified by typing it completely or by typing zero or more characters of its name and completing them to the full name by using the tab key (tab completion). If the start of the type name is ambiguous (e.g. 'uns') a list of completion candidates is provided to choose from. 1.4.3 Item 'open input file' csupport-idioms-input The item 'open input file' will create the statements to open and close an input file (e.g. with the file pointer 'infile'). 1.4.4 Item 'open output file' csupport-idioms-output The item 'open output file' will create the statements to open and close an output file (e.g. with the file pointer 'outfile').
1.5 MENU 'Snippets' csupport-snippets
1.5.1 CODE SNIPPETS
Code snippets are pieces of code which are kept in separate files in a special
directory (e.g. a few lines of code or a complete template for a Makefile).
File names are used to identify the snippets. The snippet directory will be
created during the installation ( $HOME/.vim/codesnippets-c is the default).
Snippets are managed with the 4 items
C/C++ -> Snippets -> read code snippet
C/C++ -> Snippets -> view code snippet
C/C++ -> Snippets -> write code snippet
C/C++ -> Snippets -> edit code snippet
from the Snippets submenu.
CREATING A NEW SNIPPET
When nothing is marked, "write code snippet" will write the whole buffer
to a snippet file, otherwise the marked area will be written to a file.
INSERT A SNIPPET
Select the appropriate file from the snippet directory ("read code snippet").
The inserted lines will be indented.
EDIT A SNIPPET
This is a normal edit.
VIEW A SNIPPET
Show file in a read-only buffer.
INDENTATION / NO INDENTATION
Code snippets are normally indented after insertion. To suppress indentation
add the file extension "ni" or "noindent" to the snippet file name, e.g.
parameter_handling.c.noindent
Snippet browser
Under a GUI a file requester will be put up. Without GUI the filename will be read from the command line. You can change this behavior by setting a global variable in your ~/.vimrc :let g:C_GuiSnippetBrowser = 'commandline'The default value is 'gui'. 1.5.2 PICKING UP PROTOTYPES csupport-proto PICK UP FUNCTION PROTOTYPES (key mappings \np, \nf). To make a prototype from a function head mark the function head and choose 'Snippets -> pick up funct. prototype'. From the first six lines ofvoidprint_double_array ( double array[], /* array to print */int n, /* number of elements to print */int columns, /* number of elements per column */char* arrayname /* array name */){...} /* ---------- end of function print_double_array ---------- */the prototypevoid print_double_array ( double array[], int n, int columns, char* arrayname );is produced and put in an internal buffer. - Leading and trailing whitespaces are removed. - All inner whitespaces are squeezed. - All comments will be discarded. - Trailing parts of the function body (e.g a '{' ) will also be removed. - The class name and the scope resolution operator will be removed (C++ method implementations). Further prototypes can be picked up and gathered in the buffer. PICK UP METHOD PROTOTYPES (key mapping \nm). For C++ methods the menu item 'Snippets -> pick up method prototype' should be used. Namespace names and class names will be removed (exception: 'std::' ). The first two lines ofstd::stringROBOT::Robot::get_name ( void ){return type_name;} /* ----- end of method Robot::get_name ----- */result in the prototypestd::string get_name ( void );The 3 linestemplate<class T>const Stack<T>&Stackresult in the prototype<T>::operator = ( const Stack &other )const Stack& operator = ( const Stack &other );Folding may help picking up prototypes (see |csupport-folding|). INSERT PROTOTYPES With 'Snippets -> insert prototype(s)' all picked up prototypes currently in the buffer will be inserted below the cursor. The prototype buffer will be cleared after insertion. DISCARD PROTOTYPES The prototype buffer can be cleared with 'Snippets -> clear prototype(s)' . SHOW PROTOTYPES The list of gathered prototypes can be shown with 'Snippets -> show prototype(s)'. The number and the filename are shown, e.g.(1) matrix.c # double** calloc_double_matrix ( int rows, int columns );(2) matrix.c # void free_double_matrix ( double **m );(3) foomain.c # void foo ( );REMARK. Generating prototypes this way is nice in a small project. You may want to use an extractor like cextract or something else. 1.5.3 Code Templates csupport-templates-menu
Nearly all menu entries insert code snippets or comments. All these stuff is
taken from template files and can be changed by the user to meet his
requirements (see|csupport-templates|on how to use the template system).
The menu items 'edit ... templates' open various template files. The stock
templates are usually located in the "local" template file:
~/.vim/c-support/templates/Templates
The template files named "custom" and "personal" can be used for
customization, which avoids editing the stock templates.
There may be dependent files loaded from the main files. Change whatever file
you want, save it, and click on the menu item 'reread templates' to read in
the file(s) and to rebuild the internal representation of the templates.
Template browser
When editing a template file, it is selected via |:Explore|. You can change this behavior by setting a global variable in your ~/.vimrc (see |g:Templates_TemplateBrowser|):let g:Templates_TemplateBrowser = 'browse'Template Style
The template system supports different template styles. If there are more than one style the menu item 'choose style' let you choose a style on the fly. Template Jump Tags
You can use different jump tags in a template, e.g. {-tagname-}. The allowed
tags can be chosen from this menu.(see|csupport-templates-jumptags|)
1.6 MENU 'C++' csupport-c++
1.6.1 NORMAL MODE, INSERT MODE. csupport-c++-normal-mode An empty statement will be inserted and in some cases properly indented. The item 'try catch' will insert the following lines:try {}catch ( const &ExceptObj ) { // handle exception:}catch (...) { // handle exception: unspecified}The cursor will go into the try block. 1.6.2 VISUAL MODE. csupport-c++-visual-mode The highlighted area can be surrounded by one of the following statements: try catch catch catch all extern C namespace block xxx The whole statement will be indented after insertion. 1.6.3 IMPLEMENTATION csupport-c++-impl The menu item 'method implement.' asks for a method name. If this item is called the first time you will see just an scope resolution operator. If you specify the scope this is used the next time you call this item. If you use one of the menu items to generate a class (see |csupport-templates|) the scope will be extracted and used for the next method.
1.7 MENU 'Run' csupport-run
1.7.1 COMPILE, LINK, RUN csupport-run-buffer The 'Run' menu provides a minimal make functionality for single file projects (e.g. in education) : SAVE AND COMPILE 'save and compile' saves the buffer and run the compiler with the given options (see |csupport-custom-glob-vars|). An error window will be opened if the compiler reports errors and/or warnings. Quickfix commands can now be used to jump to an error location. Consider using maps likemap<silent><F7><Esc>:cprevious<CR>mapin your ~/.vimrc file to jump over the error locations and make navigation easier. The error list and the error locations in your source buffer will be synchronized. The filename extension for an object file can be set in ~.vimrc :<silent><F8><Esc>:cnext<CR>let g:C_ObjExtension = '.obj'The default is '.o' ('.obj' for Windows). LINK 'link' makes an executable from the current buffer. The buffer will be saved first if necessary. The linking will only be tried if the current buffer contains a main function. No object file will be created. The behavior of the compiler / linker is determined by the options assigned to the variables described in |csupport-custom-glob-vars| (4.group).Note:The source is first compiled using the settings g:C_CFlags and then linked using g:C_LFlags. Every time one setting is changed, the other has to be changed accordingly. The flags in g:C_CFlags have to cause compilation only. The same holds for g:C_CplusCFlags and g:C_CplusLFlags. RUN 'run' runs the executable with the same name as the current buffer. The buffer will be saved first if necessary. 'run' makes an executable from the current buffer if none is available. The linking will only be tried if the current buffer contains a main function. No object file will be craeted. The filename extension for an executable can be set in ~.vimrc :let g:C_ExeExtension = '.exe'The default is the empty string. 1.7.2 COMMAND LINE ARGUMENTS csupport-run-cmdline-args The item 'command line arguments' calls an input dialog which asks for command line arguments. These arguments are forwarded to the program which is run by the 'run' item. The arguments are kept until you change them. Tab expansion can be used for filenames and directory names. The input will also be kept in the internal history. The ex command:CCmdlineArgs ...can also be used to set the command line arguments. The arguments belong to the current buffer (that is, each buffer can have its own arguments). If the buffer gets a new name with "save as" the arguments will now belong to the buffer with the new name. The command line arguments can be followed by pipes and redirections:11 22 |1.7.3 EXECUTABLE TO RUN csupport-run-make-run The item 'executable to run' asks for the name of the executable built by make. If the name given is nonempty this executable will be run by the menu item 'run' (\rr, C-F9). To return to the default behavior (see |csupport-run-buffer|) remove the name with the another 'executable to run'. 1.7.4 RUN DEBUGGER csupport-run-debugger Start a debugger from the menu item Run->'run debugger', with hotkey \rd. One of three debuggers can be started. The preference can be set with the variable g:C_Debugger (possible values: 'gdb', 'kdbg', 'ddd' ). The default is 'gdb'). (1) gdb The program will be run as 'gdb executable arguments' in an xterm. (2) kdbg The debugger kdbg will be started as an independent process. (3) ddd The data display debugger ddd is a graphical front end for gdb. It will be started as an independent process. The debugger ddd is not available under MS-Windows. If the executable to run was specified via Run->'executable to run' than this executable will be used for debugging. If no executable was specified yet you will be asked. 1.7.5 SPLINT csupport-run-splint Splint is a tool for statically checking C programs (see http://www.splint.org). Of course it has to be installed in order to be used within Vim. The menu item 'Run->splint' will run the current buffer through splint. An error window will be opened if splint has something to complain about. Quickfix commands can now be used to jump to an error location. For easier navigation see tip under 'SAVE AND COMPILE' |csupport-run-buffer|. Splint has many options. Presumably the best way is to keep the options in an option file (~/.splintrc). For a quick try you can use the menu item 'Run->cmd. line arg. for splint' to specify some buffer related options. When vim is started this plugin will check whether splint is executable. If not, the menu item will *NOT' be visible. 1.7.6 CPPCHECK csupport-run-cppcheck Cppcheck (http://sourceforge.net/apps/mediawiki/cppcheck/) is tool for static C++ code analysis. Cppcheck only detects the types of bugs that the compilers normally fail to detect. An error window will be opened if cppcheck has something to complain about. Quickfix commands can now be used to jump to an error location. For easier navigation see tip under 'SAVE AND COMPILE' |csupport-run-buffer|. Cppcheck has many options. Predefined groups of checks can be enabled by the menu item 'cppcheck severity'. The ex commandsort -rn| head -10 > out:CppcheckSeverity ...can also be used to set the severity for cppcheck. Please see the original documentation for more information. 1.7.7 CODECHECK csupport-run-codecheck CodeCheck (TM) is a commercial code analyzing tool produced by Abraxas Software, Inc. (www.abraxas-software.com). Of course it has to be installed in order to be used within Vim. The menu item 'Run->CodeCheck' will run the current buffer through CodeCheck. An error window will be opened if CodeCheck has something to complain about. Quickfix commands can now be used to jump to an error location. For easier navigation see tip under 'SAVE AND COMPILE' |csupport-run-buffer|. CodeCheck has many options. For a quick try you can use the menu item 'Run->cmd. line arg. for CodeCheck' to specify some buffer related options. CodeCheck will be run with default options (see |csupport-custom-glob-vars|). The default options can be overwritten by placing a global variable in ~/.vimrc , e.g.let g:C_CodeCheckOptions = "-K13 -Rmeyers"The default name for the executable is 'check'. There are other names in use on different platforms. The name can be changed by placing a global variable in ~/.vimrc , e.g.let g:C_CodeCheckExeName = "chknt.exe"When vim is started this plugin will check whether CodeCheck is executable. If not, the menu item will *NOT' be visible. 1.7.8 INDENT csupport-run-indent The formatter 'indent' can be run over the whole buffer. Before formatting a buffer this buffer will be saved to disk and you will be asked for a confirmation. Indent has many options. These are kept in the file '.indent.pro' in your home directory. See the indent manual for more information. 1.7.9 HARDCOPY csupport-run-hardcopy Generates a PostScript file from the whole buffer or from a marked region. On a Windows system a printer dialog is displayed. The hardcopy goes to the current working directory. If the buffer contains documentation or other material from non-writable directories the hardcopy goes to the HOME directory. The output destination will be shown in a message. The print header contains date and time for the current locale. The definition used islet s:C_Printheader = "%<%f%h%m%< %=%The current locale can be overwritten by changing the language, e.g.{strftime('%x %X')}Page %N":language Cor by setting a global variable in the file ~/.vimrc , e.g. :let g:C_Printheader = "%<%f%h%m%< %=%See :h printheader and :h strftime() for more details. 1.7.10 XTERM SIZE csupport-run-xterm The size of the xterm used for running a program (below) can be set by this menu item. The default is 80 columns with 24 lines. This feature is not available under Windows. 1.7.11 OUTPUT REDIRECTION csupport-run-output Running a program can be done in one of three ways: (1) Run the program from the gVim command line. This is for interactive programs with little input and output. (2) Run the program and direct the output into a window with name "C-Output". The buffer and its content will disappear when the window is closed and reused otherwise. This is for non-interactive programs with little to very much output. You have unlimited line length, regex search, navigation, ... The tabstop value will be set to 8 for "C-Output". (3) Run the program in an xterm. The output method can be chosen from the menu item 'Run->output: ...'. This menu has three states: output: VIM->buffer->xterm output: BUFFER->xterm->vim output: XTERM->vim->buffer The first (uppercase) item shows the current method. The default is 'vim'. This can be changed by setting the variable g:C_OutputGvim to another value. Possible values are 'vim', 'buffer' and 'xterm' . The xterm defaults can be set in ~/.vimrc by the variable g:Xterm_Options . The default is "-fa courier -fs 12 -geometry 80x24" : font name : -fa courier font size : -fs 12 terminal size : -geometry 80x24 See 'xterm -help' for more options. Xterms are not available under Windows.{strftime('%x %X')}SEITE %N"
1.8 MENU 'Tool Box' csupport-toolbox
Tools which can be used by several plugins are located in the Tool Box. Examples are tools for make(1) or doxygen. The Tool Box has its own documentation:|toolbox|. To switch the Tool Box off add the following line to the file .vimrclet g:C_UseToolbox = 'no'1.8.1 Make csupport-toolbox-make The tool box for make provides a small set hotkeys, menu items, and ex commands for controlling make. Please see|toolbox-make|. To switch the make tool box off add the following line to the file .vimrclet g:C_UseTool_make = 'no'The hotkeys for the make tool are defined in the file ~/.vim/ftplugin/c.vim . 1.8.2 Other Tools csupport-toolbox-others In general, to enable a tool called<name>, add the following line to your .vimrc:let g:C_UseTool_For example:<name>= 'yes'let g:C_UseTool_cmake = 'yes'let g:C_UseTool_doxygen = 'yes'
1.9 MENU 'Help' csupport-help
Plugin help
The menu item 'help (plugin)' shows this plugin help in a help window. The
help tags must have been generated with
:helptags ~/.vim/doc
The hotkey is \hp (for "help plugin").
Displaying a manual
The menu item 'show manual' shows the manual for the word under the cursor. If there is more than one manual a selection list will be presented. If there is no word under the cursor you can type in a name. An interface to the on-line reference manuals must be installed (usually man(1) for Linux/Unix, see |csupport-custom-glob-vars|). The hotkey is \hm (for "help manual"). English dictionary
The menu item 'English' opens an online dictionary for the word under the cursor. Doxygen reference
The menu item 'Doxygen' opens the online reference for the Doxygen command under the cursor.
The browser for opening the online documentation, or the English dictionary,
can be configured by setting a global variable in your ~/.vimrc (see
|g:Templates_InternetBrowserExec| and |g:Templates_InternetBrowserFlags|):
let g:Templates_InternetBrowserExec = 'firefox'
1.10 MENU 'Doxygen' csupport-doxygen
A menu 'Doxygen' with templates for writing Doxygen comments can optionally be included. It contains two kinds of entries. If the name includes a "block", the template inserts a whole Doxygen comment block. Other templates insert a line extending an existing block. The special entry 'brief, after member' can be used to append a brief description after a member. Similarly to 'Comments->end-of-line comment', it will append the comment to several lines when in visual mode. When marking the four lines within the enumenum Color{Background,Transparent,Black,White}; // ----- end of enum Color -----and then choosing 'brief, after member', the result will look like thisenum Color{Background, /!< \brief /Transparent, /!< \brief /Black, /!< \brief /White, /!< \brief /}; // ----- end of enum Color -----Now the elements can be documented one by one. This feature works like 'Comments->end-of-line comment' in every other aspect. The comments can be aligned using 'Comments->adjust end-of-line com.' and respect the column set by 'Comments->set end-of-line com. col' (see |csupport-comm-aligned|). 1.10.1 ENABLING THE MENU csupport-doxygen-enable The 'Doxygen' submenu is disabled by default. To enable it, the Doxygen templates have to be added to the template library. Find out the path where the plug-in is installed (<PATH_TO_PLUG>/plugin/c.vim) and add this line to the .vimrc:call mmtemplates#config#Add ( 'C', 'The first parameter adds the file to your C templates, the second is the path. The remaining two optional parameters specify the symbolic name for these templates and the map to edit them. The map is '\ntd' in this example.<PATH_TO_PLUG>/c-support/templates/doxygen.templates', 'Doxygen', 'ntd' )
2. USAGE WITHOUT GUI (Vim) csupport-usage-vim
The frequently used constructs can be inserted with key mappings. The
mappings are also described in the document c-hot-keys.pdf (reference card,
part of this package).
Hint: Typing speed matters. The combination of a leader ('\') and the
following character(s) will only be recognized for a short time.
Some mappings can be used with range (of lines). In normal mode
\cl
appends a end-of-line comment to the current line, whereas
4\cl
appends end-of-line comments to the 4 lines starting with the current line.
Legend: (i) insert mode, (n) normal mode, (v) visual mode
[n] range
-- Help ---------------------------------------------------------------
\he open an English dictionary for the (n,i)
word under the cursor
\hd open the reference for the Doxygen (n,i)
command under the cursor
\hm show manual for word under the cursor (n,i)
\hp show plugin help (n,i)
-- Comments -----------------------------------------------------------
[n]\cl end-of-line comment (n,v,i)
[n]\cj adjust end-of-line comment(s) (n,v,i)
\cs set end-of-line comment column (n)
[n]\c* code -> comment /* */ (n,v,i)
[n]\cc code -> comment // (n,v,i)
[n]\co comment -> code (n,v,i)
[n]\cn toggle non-C comment (n,v,i)
\cfr frame comment (n,i)
\cfu function comment (n,i)
\cme method description (n,i)
\ccl class description (n,i)
\cfdi file description (implementation) (n,i)
\cfdh file description (header) (n,i)
\ccs C/C++-file section (tab. compl.) (n,i)
\chs H-file section (tab. compl.) (n,i)
\ckc keyword comment (tab. compl.) (n,i)
\csc special comment (tab. compl.) (n,i)
\cma plugin macros (tab. compl.) (n,i)
\cd date (n,v,i)
\ct date \& time (n,v,i)
[n]\cx toggle comments: C <--> C++ (n,v,i)
-- Statements ---------------------------------------------------------
\sd do { } while (n,v,i)
\sf for (n,i)
\sfo for { } (n,v,i)
\si if (n,i)
\sif if { } (n,v,i)
\sie if else (n,v,i)
\sife if { } else { } (n,v,i)
\se else { } (n,v,i)
\sw while (n,i)
\swh while { } (n,v,i)
\ss switch (n,v,i)
\sc case (n,i)
\sb {} (n,v,i)
-- Idioms -------------------------------------------------------------
\if function (n,v,i)
\isf function static (n,v,i)
\im main() (n,v,i)
\ie enum + typedef (n,i)
\is struct + typedef (n,i)
\iu union + typedef (n,i)
\isc scanf() (n,i)
\ipr printf() (n,i)
\ica p=calloc() (n,i)
\ima p=malloc() (n,i)
\ire p=realloc() (n,i)
\isi sizeof() (n,v,i)
\ias assert() (n,v)
\ii open input file (n,i)
\io open output file (n,i)
\ifsc fscanf (n,i)
\ifpr fprintf (n,i)
[n]\i0 for( x=0; x<n; x+=1 ) (n,v,i)
[n]\in for( x=n-1; x>=0; x-=1 ) (n,v,i)
-- Preprocessor -------------------------------------------------------
\pih include standard library header (n,i)
\piph include POSIX header (n,i)
\pg #include <> (global) (n,i)
\pl #include "" (local) (n,i)
\pd #define (n,i)
\pu #undef (n,i)
\pif #if #endif (n,v,i)
\pie #if #else #endif (n,v,i)
\pid #ifdef #else #endif (n,v,i)
\pin #ifndef #else #endif (n,v,i)
\pind #ifndef #def #endif (n,v,i)
\pe #error (n,i)
\pl #line (n,i)
\pp #pragma (n,i)
\pw #warning (n,i)
\pi0 #if 0 #endif (n,v,i)
\pr0 remove #if 0 #endif (n,i)
-- Snippets -----------------------------------------------------------
\nr read code snippet (n,i)
\nv view code snippet (read-only) (n,i)
\nw write code snippet (n,v,i)
\ne edit code snippet (n,i)
[n]\nf pick up function prototype (n,v,i)
[n]\np pick up function prototype (n,v,i)
[n]\nm pick up method prototype (n,v,i)
\ni insert prototype(s) (n,i)
\nc clear prototype(s) (n,i)
\ns show prototype(s) (n,i)
\ntg edit global template file (n,i)
\ntl edit local templates (n,i)
\ntc edit custom template file (n,i)
\ntp edit personal template file (n,i)
\ntr reread templates (n,i)
\ntw template setup wizard (n,i)
\nts choose style (n,i)
\njt include jump tags (n,i)
-- C++ ----------------------------------------------------------------
\+ih include C++ standard library header (n,i)
\+ich include C standard library header (n,i)
\+om output manipulators (n,i)
\+fb ios flag bits (n,i)
\+c class (n,i)
\+cn class (using new) (n,i)
\+tc template class (n,i)
\+tcn template class (using new) (n,i)
\+ec error class (n,i)
\+tf template function (n,i)
\+tr try ... catch (n,v,i)
\+ca catch (n,v,i)
\+caa catch(...) (n,v,i)
\+ex extern "C" { } (n,v,i)
\+oif open input file (n,v,i)
\+oof open output file (n,v,i)
\+uns using namespace std; (n,v,i)
\+un using namespace xxx; (n,v,i)
\+unb namespace xxx { } (n,v,i)
\+na namespace alias (n,v,i)
\+rt RTTI (n,v,i)
\+ic class implementation (n,i)
\+icn class (using new) implementation (n,i)
\+im method implementation (n,i)
\+ia accessor implementation (n,i)
\+itc template class implementation (n,i)
\+itcn template class (using new) impl. (n,i)
\+itm template method implementation (n,i)
\+ita template accessor implementation (n,i)
\+ioi operator >> (n,i)
\+ioo operator << (n,i)
-- Run ----------------------------------------------------------------
\rc save and compile (n,i)
\rl link (n,i)
\rr run (n,i)
\ra set comand line arguments (n,i)
\rd run debugger (n,i)
\re executable to run (n,i)
\rp run splint (n,i)
\rpa cmd. line arg. for splint (n,i)
\rcc run cppcheck (n,i)
\rccs severity for cppcheck (n,i)
\rk run CodeCheck (TM) (n,i)
\rka cmd. line arg. for CodeCheck (TM) (n,i)
\ri run indent (n,v,i)
[n]\rh hardcopy buffer (n,v,i)
\rs show plugin settings (n,i)
\rx set xterm size (n, only Linux/UNIX & GUI)
\ro change output destination (n,i)
The file c-hotkeys.pdf contains a reference card for these key mappings.
Multi-line inserts and code snippets will be indented after insertion.
The hotkeys are defined in the template files (part of this csupport
plugin package) and described in the document c-hotkeys.pdf
Changing the default map leader '\'
The map leader can be changed by the user by setting a global variable in the file .vimrclet g:C_MapLeader = ','The map leader is now a comma. The 'line end comment' command is now defined as ',cl'. This setting will be used as a so called local leader and influences only files with filetype 'c' and 'cpp'. The configured mapleader can also be used in the ftplugin, by calling the functions C_SetMapLeader() and C_ResetMapLeader() . The maps created between the two calls will use |g:C_MapLeader| as the |<LocalLeader>|:call C_SetMapLeader ()map<buffer><LocalLeader>eg :echo "Example Map :)"<CR>call C_ResetMapLeader ()
3. HOTKEYS csupport-hotkeys
The following hotkeys are defined in normal, visual and insert mode:
F9 compile and link
Alt-F9 write buffer and compile
Ctrl-F9 run executable
Shift-F9 set command line arguments
Shift-F2 switch between source files and header files
The hotkeys are defined in the file type plugin c.vim. All hotkeys from the
non-GUI mode also work for gVim (see |csupport-usage-vim|).
Shift-F2 can be used to switch between source files and header files if the
plugin a.vim (http://vim.sourceforge.net/scripts/script.php?script_id=31) is
present. To suppress the creation of a new header file when switching from a
source file the file ~/.vimrc should contain a line
let g:alternateNoDefaultAlternate = 1
A header file will only be opened if it already exists.
The Shift-key is dead when you are working with Vim in a console terminal
(non-Gui). You could add
noremap \a :A<CR>
inoremap \a <C-C>:A<CR>
to get a hot key for this case.
4. CUSTOMIZATION csupport-custom
4.1 GLOBAL VARIABLES csupport-custom-glob-vars
Several global variables are checked by the script to customize it: ---------------------------------------------------------------------------- GLOBAL VARIABLE DEFAULT VALUE TAG (see below) ---------------------------------------------------------------------------- g:C_CExtension 'c' g:C_CFlags '-Wall -g -O0 -c' g:C_CodeCheckExeName 'check' g:C_CodeCheckOptions '-K13' g:C_CodeSnippets plugin_dir.'/c-support/codesnippets/' g:C_Ctrl_j 'on' g:C_CustomTemplateFile $HOME.'/.vim/templates/c.templates' g:C_Debugger 'gdb' g:C_Dictionary_File '' g:C_GlobalTemplateFile plugin_dir.'c-support/templates/Templates' g:C_GuiSnippetBrowser 'gui' g:C_InsertFileHeader 'yes' g:C_LFlags '-Wall -g -O0' g:C_Libs '-lm' g:C_LineEndCommColDefault 49 g:C_LoadMenus 'yes' g:C_CreateMenusDelayed 'no' g:C_LocalTemplateFile $HOME.'/.vim/c-support/templates/Templates' g:C_MapLeader '\' g:C_MenuHeader 'yes' g:C_NonCComment '#' g:C_OutputGvim 'vim' g:C_Printheader "%<%f%h%m%< %=%{strftime('%x %X')}Page %N" g:C_RootMenu '&C\/C\+\+.' g:C_SourceCodeExtensions 'c cc cp cxx cpp CPP c++ C i ii' g:C_TypeOfH 'cpp' g:C_VimCompilerName gcc g:Xterm_Executable 'xterm' g:Xterm_Options '-fa courier -fs 12 -geometry 80x24' Linux/UNIX: g:C_CCompiler 'gcc' g:C_CplusCompiler 'g++' g:C_ExeExtension '' g:C_Man 'man' g:C_ObjExtension '.o' Windows: g:C_CCompiler 'gcc.exe' g:C_CplusCompiler 'g++.exe' g:C_ExeExtension '.exe' g:C_Man 'man.exe' g:C_ObjExtension '.obj' The variable plugin_dir will automatically be set to one of the following values: $HOME.'/.vim/' for Linux/Unix $VIM.'/vimfiles/' for Windows ---------------------------------------------------------------------------- GLOBAL VARIABLE SHORT EXPLANATION ---------------------------------------------------------------------------- g:C_CCompiler : The name of the C compiler. g:C_CExtension : Extension of C files. Everything else is C++. g:C_CFlags : Compiler flags used for a compilation. g:C_CodeCheckExeName : The name of the CodeCheck (TM) executable (the default is 'check') g:C_CodeCheckOptions : Default options for CodeCheck (TM) (see |csupport-run-codecheck|). g:C_CodeSnippets : The name of the code snippet directory (see |csupport-snippets|). g:C_CplusCompiler : The name of the C++ compiler. g:C_Ctrl_j : hotkey Ctrl-j 'on'/'off' (see |csupport-Ctrl-j|) g:C_CustomTemplateFile : sets the custom template file (see|csupport-templates|) g:C_Debugger : the default debugging: 'gdb', 'kdbg', or 'ddd' g:C_Dictionary_File : The name(s) of the dictionary file(s) used for word completion (see also |csupport-dictionary|) g:C_ExeExtension : C/C+ file extension for executables (leading point required if not empty) g:C_GlobalTemplateFile : sets the global template file (see |csupport-templates|) g:C_GuiSnippetBrowser : code snippet browser: 'gui', 'commandline' g:C_InsertFileHeader : insert file prolog in a new file ('yes', 'no') g:C_LFlags : Compiler flags used for linkage. g:C_Libs : Libraries to link with. g:C_LineEndCommColDefault : Default starting column for end-of-line comments. g:C_LoadMenus : Load menus and mappings ("yes", "no") at startup. g:C_CreateMenusDelayed : Load menus only with filetypes 'c' or 'cpp' g:C_LocalTemplateFile : sets the local template file (see |csupport-templates|) g:C_Man : The name of the man utility. g:C_MapLeader : the map leader for hotkeys (see ||csupport-usage-vim|) g:C_MenuHeader : Switch the submenu header on/off. g:C_NonCComment : comment leader string for a non-C comment g:C_ObjExtension : C/C+ file extension for objects (leading point required if not empty) g:C_OutputGvim : when program is running output goes to the vim command line ("vim"), to a buffer ("buffer") or to an xterm ("xterm"). g:C_Printheader : hardcopy: definition of the page header g:C_RootMenu : The name of the root menu entry of this plugin (see |csupport-custom-root|). g:C_SourceCodeExtensions : filename extensions for C/C++ implementation files g:C_TypeOfH : filetype of header files with extension 'h' (c,cpp) g:C_VimCompilerName : the compiler name used by :compiler g:Xterm_Executable : the xterm executable g:Xterm_Options : the xterm options g:C_XtermDefaults : the xterm options (included for backwards compatibility) To override the default add appropriate assignments to ~/.vimrc . The following global variables can be changed on the fly from the Vim command line, i.e. without restarting the editor:C_CCompilerC_CFlagsC_LFlagsC_LibsC_CplusCFlagsC_CplusCompilerC_CplusLFlagsC_CplusLibsC_DebuggerIf you change g:C_CFlags or g:C_LFlags, you have change to change the other accordingly. The same holds for g:C_CplusCFlags and g:C_CplusLFlags (see also |csupport-run-buffer|).
4.2 THE ROOT MENU csupport-custom-root
The variable g:C_RootMenu, if set (in '.vimrc' or in '.gvimrc'), gives the name of the single gVim root menu entry in which the C/C++ submenus will be put. The default is'&C\/C\+\+.'''Notethe terminating dot. If you want to set the plugin root menu into another menu, e.g. 'Plugin', this is done by the following line in '.vimrc'let g:C_RootMenu = '&Plugin.&C\/C\+\+.'
4.3 SYSTEM-WIDE INSTALLATION csupport-system-wide
A system-wide installation (one installation for all users) of the plug-in can be done. This will mean however, that a user can not edit the template library, for example to set his own name. So in case of a system-wide installation, every user can have an own set of templates (called local templates), which are localed in each users' home directory.Note:As you might have guessed, this behavior is much more inspired by Linux than Windows. A system-wide installation is done as follows. As *** SUPERUSER *** : (1) Find the Vim installation directory. The Vim Ex command ':echo $VIM' gives '/usr/local/share/vim' or something like that. Beyond this directory you will find the Vim installation, e.g. in '/usr/local/share/vim/vim73' if Vim version 7.3 has been installed (Windows: 'C:\Program Files\Vim'). (2) Create a new subdirectory 'vimfiles', e.g. '/usr/local/share/vim/vimfiles' (Windows: 'C:\Program Files\Vim\vimfiles'). (3) Install C/C++ Support Copy the archive cvim.zip to this new directory and unpack it: unzip cvim.zip (4) Generate the help tags: :helptags $VIM/vimfiles/doc SPECIAL CASES. Some Linux distributions use non-standard names for Vim directories. SUSE has a directory '/usr/share/vim/site' to put plugins in. These directories will not be found automatically. After installing the plugin below '/usr/share/vim/site' the use of the templates will be enabled by the following line in '~/.vimrc':let g:C_GlobalTemplateFile = '/usr/share/vim/site/c-support/templates/Templates'As *** USER *** : Use the template setup wizard: C -> Snippets -> template setup wizard to create a personalization file and/or a custom template file. The personalization file will be read by all plug-ins supporting this feature, and should contain only information relevant for all template libraries. You can set some macros in this file with your personal information in order to obtain personalized comments, e.g. something like this:SetMacro( 'AUTHOR', 'Wolfgang Mehner' )SetMacro( 'AUTHORREF', 'wm' )SetMacro( 'EMAIL', 'wolfgang-mehner@web.de' )SetMacro( 'COPYRIGHT', 'Copyright (c) |Use the custom template file for C templates which override the global templates or to add new ones. The old system (before version 6.2), using a "local" template file,YEAR|, |AUTHOR|' )~/.vim/c-support/templatesis still supported for backwards compatibility. Create your private snippet directory:mkdir --parents ~/.vim/c-support/codesnippetsYou may want to copy the snippets coming with this plugin (in $VIM/vimfiles/c-support/codesnippets) into the new directory or to set a link to the global directory.
5. TEMPLATE FILES AND TAGS csupport-templates
Nearly all menu items insert code snippets or comments. All of these are
contained within template files and can be changed by the user to meet their
requirements. The menu shortcuts (e.g. 'c' for the Comments menu) and the
menu item hotkeys (e.g. '\ct' insert date and time) are also defined in the
templates.
The template engine comes as a separate plug-in contributed by Wolfgang Mehner.
This section is a short introduction to this template system. Please see
|templatesupport| for more information.
The master template file is '$HOME/.vim/c-support/templates/Templates' for
a user installation and '$VIM/vimfiles/c-support/templates/Templates' for
a system-wide installation (see |csupport-system-wide|).
The master template file can be edited itself to adapt the templates/menus to
the users need. Alternatively, a custom template file can be added (see
g:C_CustomTemplateFile), which eliminates the need to edit stock templates.
The personalization (name, email, ..., date and time format) can be done in a
special personalization template file. It will be read by all plug-ins which
support this feature, so it should only contain basic information not
pertaining to a specific programming language. It can be set up using a
wizard, which is run by the map \ntw or the menu entry:
C/C++ -> Snippets -> template setup wizard
Further template files can be added using the call:
call mmtemplates#config#Add ( 'C', '<PATH>/some.templates', 'example', 'nte' )
The first parameter adds the file to your C templates, the second is the path.
The remaining two optional parameters specify the symbolic name for these
templates and the map to edit them. The map is '\nte' in this example, if the
standard mapleader is set.
5.1 TEMPLATE FILES csupport-templates-files
The master template file starts with various settings followed by templates for single menu items or better by including other template files grouping the templates according to the menu structure of this plug-in. The master file usually looks like this: Example:§ ==========================================================§ Settings§ ==========================================================SetMacro( 'AUTHOR', 'YOUR NAME' )SetMacro( 'AUTHORREF', '' )SetMacro( 'EMAIL', '' )SetMacro( 'ORGANIZATION', '' )SetMacro( 'COMPANY', '' )SetMacro( 'COPYRIGHT', 'Copyright (c) |YEAR|, |AUTHOR|' )SetMacro( 'LICENSE', 'GNU General Public License' )SetStyle( 'C' )§ ==========================================================§ File Includes and Shortcuts§ ==========================================================MenuShortcut( 'Comments', 'c' )MenuShortcut( 'Statements', 's' )MenuShortcut( 'Idioms', 'i' )MenuShortcut( 'Preprocessor', 'p' )MenuShortcut( 'Snippets', 'n' )MenuShortcut( 'C++', 'c' )§IncludeFile( 'snippets.template' )§== USE STYLES : C ==IncludeFile( 'c.comments.template' )IncludeFile( 'c.cpp.template' )IncludeFile( 'c.idioms.template' )IncludeFile( 'c.preprocessor.template' )IncludeFile( 'c.statements.template' )== ENDSTYLES ==§== USE STYLES : CPP ==IncludeFile( 'cpp.comments.template' )IncludeFile( 'cpp.cpp.template' )IncludeFile( 'cpp.idioms.template' )IncludeFile( 'cpp.preprocessor.template' )IncludeFile( 'cpp.statements.template' )== ENDSTYLES ==Lines starting with a section sign (§) are comments. The section starting withSetMacro( 'AUTHOR', 'YOUR NAME' )assigns values to predefined tags (macros). Arbitrary user-defined macros are possible. The macro name must follows the rules for a C language identifier: first character letter or underscore; case matters; digits are allowed beginning with the second character. Some of the macros assigned here are placeholders, they will be overwritten by template files read later on, which contain the user's configuration. The statementIncludeFile( 'c.comments.templates' )includes the templates from the file 'c.comments.templates' (in the same directory). An absolute path would also be possible. The statementMenuShortcut( 'Comments', 'c' )sets 'c' as the shortcut for the Comments menu.
5.2 MACROS csupport-templates-macros
The following macro names are predefined. The first group is used to personalize templates.|BASENAME| filename without path and suffix|DATE| the preferred date representation for the current localewithout the time|FILENAME| filename without path|PATH| path without filename|SUFFIX| filename suffix|TIME| the preferred time representation for the current localewithout the date and the time zone or name or abbreviation|---------------------------------------------------------------------------- PREDEFINED TAGS USED IN TEMPLATES ----------------------------------------------------------------------------YEAR| the year as a decimal number including the century<CURSOR>The cursor position after insertion of a template.<+text+>,<-text->See |csupport-templates-jumptags|.{+text+},{-text-}[+text+],[-text-]<SPLIT>The split point when inserting in visual mode (see|csupport-templates|) A dependent template file can start with its own command section. There is no need to have all user defined macros in the master file.
5.2.1 USER DEFINED FORMATS FOR DATE AND TIME csupport-templates-date
The format for |DATE| ,|TIME| , and|YEAR| can be set by the user. The defaults are Example:|DATE| '%x'|TIME| '%X'|See the manual page of the C function strftime() for the format. The accepted format depends on your system, thus this is not portable! The maximum length of the result is 80 characters. User defined formats can be set using the following function calls in the master template file is '$HOME/.vim/c-support/templates/Templates', e.g.YEAR| '%Y'SetFormat( 'DATE', '%D' )SetFormat( 'TIME', '%H:%M' )SetFormat( 'YEAR', 'year %Y' )
5.3 TEMPLATES csupport-templates-names
5.3.1 Template definition csupport-templates-definition The template behind a menu entry is identified by a given name. The first part of the name identifies the menu name, the second part identifies the item. A template definition starts with a template header with the following syntax: == menu_name.template_name == options == The options are described here: |template-support-options|. 5.3.2 The jump tags<+text+>etc. csupport-templates-jumptags There are four jump tag types which can be used as jump targets in templates:<+text+>Can be jumped to by hitting Ctrl-j.{+text+}Same as<+text+>. Used in cases where indentation gives unwanted results with the first one.<-text->Same as the two above. Will be removed if the template is used{-text-}in visual mode. [+text+] The "optional" tag. Serves as a jump tag, but can be deleted using Ctrl-d. [-text-] Same as above, removed in visual mode. The text inside the brackets is userdefined and can be empty. The text can be composed from letters (uppercase and lowercase), digits, and underscores. After the insertion of an template these jump targets will be highlighted. 5.3.3 Command Ctrl-j csupport-Ctrl-j Use the command Ctrl-j to jump to the next target. The target will be removed and the mode will switched to insertion. Ctrl-j works in normal and in insert mode. The template for an if-else-statement can be written as follows:== Statements.if, else == map:sie, sc:i ==if<CURSOR><SPLIT><-IF_PART->else<+ELSE_PART+>endifThe cursor will be set as shown. When the condition is specified a Ctrl-j let you jump to the target<-IF PART->and deletes it. When the block is written a Ctrl-j leads you to the else-part. The target<+ELSE_PART+>disappears and you can type on.
5.5 BINDING A STYLE TO A FILE EXTENSION csupport-templates-bind
You can bind the existing styles to one or more filename extensions. To do so
assign a Dictionary to the global variable g:C_Styles in '~/.vimrc' :
let g:C_Styles = { '.c,.h' : 'C', '.cc,.cpp,.c++,.C,.hh,.h++,*.H' : 'CPP' }
A Dictionary is created with a comma separated list of entries in curly
braces. Each entry has a key and a value, separated by a colon. Each key can
only appear once. The keys are themselves a comma separated list of filename
pattern. The values are existing styles defined in the template files.
The given style will be set automatically when switching to a buffer or
opening a new buffer with the associated filename pattern and supersedes the
macro |STYLE| .
6. C/C++ DICTIONARY csupport-dictionary
The files c-c++-keywords.list k+r.list stl_index.list are a part of this plugin and can be used (together with your own lists) as dictionaries for automatic word completion. This feature is enabled by default. The default word lists are plugin_dir/c-support/wordlists/c-c++-keywords.list plugin_dir/c-support/wordlists/k+r.list plugin_dir/c-support/wordlists/stl_index.list The variable plugin_dir will automatically be set by the plugin to one of the following values: $HOME.'/.vim/' for Linux/Unix $VIM.'/vimfiles/' for Windows If you want to use an additional list MyC.list put the following lines into ~/.vimrc :let g:C_Dictionary_File = PLUGIN_DIR.'/c-support/wordlists/c-c++-keywords.list,'.\ PLUGIN_DIR.'/c-support/wordlists/k+r.list,'.\ PLUGIN_DIR.'/c-support/wordlists/stl_index.list,'.\ PLUGIN_DIR.'/c-support/wordlists/MyC.list'When in file ~/.vimrc the name PLUGIN_DIR has to be replaced by $HOME or $VIM (see above). Whitespaces in the pathnames have to be escaped with a backslash. The right side is a comma separated list of files.Notethe point at the end of the first line (string concatenation) and the backslash in front of the second line (continuation line). You can use Vim's dictionary featureCTRL-X,CTRL-K(andCTRL-P,CTRL-N).
7. EXTENDING ctags csupport-ctags
7.1 make AND qmake csupport-ctags-make
The use of the Vim plugin taglist.vim (Author: Yegappan Lakshmanan) is highly recommended. It uses the program ctags which generates tag files for 3 dozen languages (Exuberant Ctags, Darren Hiebert, http://ctags.sourceforge.net). With the following extensions the list of targets in a makefile can be shown in the taglist window. 1) Append the file customization.ctags to the file $HOME/.ctags . 2) Add the following lines (from customization.vimrc) to $HOME/.vimrc :""-------------------------------------------------------------------" taglist.vim : toggle the taglist window" taglist.vim : define the title texts for make" taglist.vim : define the title texts for qmake"-------------------------------------------------------------------noremap<silent><F11><Esc><Esc>:Tlist<CR>inoremap<silent><F11><Esc><Esc>:Tlist<CR>let tlist_make_settings = 'make;m:makros;t:targets;i:includes'let tlist_qmake_settings = 'qmake;t:SystemVariables'if has("autocmd")" ---------- qmake : set file type for *.pro ----------autocmd BufNewFile,BufRead *.pro set filetype=qmakeendif " has("autocmd")3) restart vim/gvim The two maps will toggle the taglist window (hotkey F11) in all editing modes. The two assignments define the headings for the (q)make sections in the taglist window. The autocmd set the file type 'qmake' for the filename extension 'pro' (ctags needs this).
7.2 TEMPLATES csupport-ctags-templates
If you frequently change the plugin templates and you are using the taglist plugin (section above) you may want to use this plugin for navigation. This is achieved in two steps. First add a new language definition to the file $HOME/.ctags :--langdef=template--langmap=template:.template,TEMPLATE--regex-template=/^==\s+([^=]+)\s+==\s*(\s+==\s+([^=]+)\s+==)?/\1/t,template/Now add the following lines to the file $HOME/.vimrc :let tlist_template_settings = 'template;t:template'"---------------------------------------------------------------" plugin templates : set filetype for *.template"---------------------------------------------------------------if has("autocmd")autocmd BufNewFile,BufRead Templates set filetype=templateautocmd BufNewFile,BufRead *.template set filetype=templateendif " has("autocmd")The assignment defines the heading for the template section in the taglist window. The autocmds set the file type 'template' for the main template file 'Templates' and the includefiles '*.template' (if any).
8. FOLDING csupport-folding
This plugin can be used together with folding. There are a few peculiarities when the cursor is on a closed fold before inserting a template: Normal mode
Inserting blocks of complete lines below and above a fold (e.g. frame comments) and inserting at the top of a buffer (e.g. file description) works as usual. Insertions which go to the end of a line (e.g. end-of-line comments) and insertions which go to the cursor position (e.g. 'sizeof()') will be suppressed and a warning will be shown. Visual mode
A range of lines containing closed folds can be surrounded by constructs which have a visual mode, e.g. a for-loop:for ( ; ; ) {+--- 4 lines: {------------------------------------------------------------}See |folding| for more information on folding.
9. Additional Mappings csupport-ad-mappings
There are a few additional filetype specific key mappings defined in
'~/.vim/ftplugin/c.vim'.
Complete a classical C comment: '/' => '/ | */' (modes: i,v).
Complete a classical C multi-line comment (mode: i):
'/<CR>' => /
* |
*/
Open a block (modes: i,v):
'{<CR>' => {
|
}
In visual mode the content of the new block will be indented.
The file customization.cpp.vim provides additional insert mode mappings to
facilitate writting cin and cout statements, e.g.
'<<' -> ' << |'
'<<"' -> ' << "|" '
'<<;' -> ' << "|\n";'
'>>' -> ' >> |'
Copy this file to ~/.vim/ftplugin and rename it to 'cpp.vim'.
10. WINDOWS PARTICULARITIES csupport-windows
For a user installation the plugin should go into the directory structure below $HOME/vimfiles/ for a system installation below $VIM/vimfiles/ The values of the two variables can be found from inside Vim: :echo $VIM or :echo $HOME The configuration files for a user are $HOME/_vimrc and $HOME/_gvimrc for the system $VIM/_vimrc and $VIM/_gvimrc Compiler settings: It could be necessary to add further settings for your compiler. To compile C++-programs using a Dev-C++ installation (http://www.bloodshed.net) the following item in $VIM/_vimrc is needed (depends on the Dev-C++ install directory): let g:C_CFlags = '-Wall -g -o0 -c -I c:\programs\dev-c++\include\g++'
11. ADDITIONAL TIPS csupport-tips
(1) gVim. Toggle 'insert mode' <--> 'normal mode' with the right mouse button
(see mapping in file costumization.gvimrc).
(2) gVim. Use tear off menus.
(3) Try 'Focus under mouse' as window behavior (No mouse click when the mouse
pointer is back from the menu item).
(4) Use Emulate3Buttons "on" (X11) even for a 3-button mouse. Pressing left
and right button at the same time without moving your fingers is faster
then moving a finger to the middle button (often a wheel).
12. TROUBLESHOOTING csupport-troubleshooting
* I do not see any new main menu item.
- Was the archive extracted into the right directory?
* How can I see what was loaded?
- Use ':scriptnames' from the Vim command line.
* Some hotkeys do not work.
- The hotkeys might be in use by your graphical desktop environment. Under
KDE Ctrl-F9 is the hotkey which let you switch to the 9. desktop. The key
settings can usually be redefined.
* The plug-in loads slowly.
- By default, the template library is read while the plug-in is loading,
since the templates also define most of the menu structure. To not slow
down the startup of Vim, you can choose to only create the C/C++-menu when
opening the first C/C++-file. For that, add this line to your ~/.vimrc:
let g:C_CreateMenusDelayed = 'yes'
The only downside is that you won't see the C/C++-menu before you start
working on a C-file, or use the menu entry "Tools->Load C Support".
* After changing g:C_LFlags / g:C_CplusLFlags my source can not be linked or
run.
- The settings g:C_CFlags / g:C_CplusCFlags have to be changed accordingly
(see |csupport-run-buffer|)
* Splint and/or CodeCheck menu item not visible.
- The program is not installed or not found (path not set) or not executable.
* External programs (compiler, make, cmake, ...) are not running.
- Are they executable from the command line?
- Is the $PATH variable set correctly?
- Are the settings correct? See:
:help |csupport-custom-glob-vars|
Compare the documentation of the toolbox, such as |toolbox-cmake-issues|,
|toolbox-doxygen-issues|
- Under Windows, make sure the options 'shell', 'shellcmdflag',
'shellquote', and 'shellxquote' are set correctly. If "cmd.exe" is used as
the 'shell', 'shellxquote' must be set to a double quote:
:set shellxquote=\"
* Code incorrectly indented after template insertion. The indentation may be
incorrect inside blocks, if the <CURSOR> tag also appears inside the block.
See |template-support-templ-tags| for a detailed explanation.
13. RELEASE NOTES csupport-release-notes
See file c-support/doc/ChangeLog .
vim:tw=78:expandtab:ts=2:ft=help:norl:
Generated by vim2html (modified) on Sa 27. Aug 18:27:23 CEST 2016