Tip #335: Copy C++ function declaration into implementation file

tip karma

Rating 8/5, Viewed by 1047

created:		October 1, 2002 6:47		complexity:		basic
author:		Leif Wickland		as of Vim:		5.7

There's a handy plug in for MS Visual Studio called CodeWiz that has a nifty ability to copy a function declaration and deposit it into the implementation file on command. I actually missed while using vim, so I wrote an approximation of that capability. This isn't foolproof, but it works alright. " Copy Function Declaration from a header file into the implementation file. nmap <F5> "lYml[[kw"cye'l nmap <F6> ma:let @n=@/<cr>"lp==:s/\<virtual\>/\/\*&\*\//e<cr>:s/\<static\>/\/\*&\*\//e<cr>:s/\s*=\s*0\s*//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:let @/=@n<cr>'ajf(b"cPa::<esc>f;s<cr>{<cr>}<cr><esc>kk To use this, source it into vim, for example by placing it in your vimrc, press F5 in normal mode with the cursor on the line in the header file that declares the function you wish to copy. Then go to your implementation file and hit F6 in normal mode with the cursor where you want the function implementation inserted.

<<Loading scripts in .vimrc safely | type the line number and press enter to get there >>

Additional Notes

[email protected], October 1, 2002 21:16

I liked the idea behind Leif?s TIP and I thought ~a~ command you could call in the header ~or~ source file would be good(one less thing for me to remember) an besides I knew just how I wanted to do it! Along the way I?ve made a slight improvement or two (no longer clobbers registers/marks for instance). This is formatted to stuff into a file and drop into your plugin directory. So it seems to work in most cases (single line Member functions all(?) seem to work, anything else well, doesn?t) (trips on the same things Leif?s implementation does of course because it IS Leif?s implementation! I just moved some lines around ;) ) Happy VIMing! copycppdectoimp.vim>>> " vim:ff=unix ts=4 ss=4 " vim60:fdm=marker " \file copycppdectoimp.vim " " \brief From VIM-Tip #335: Copy C++ function declaration into implementation file " by Leif Wickland as of Vim: 5.7 " \note See: http://vim.sourceforge.net/tip_view.php?tip_id=335 " " \author Leif Wickland " \author (Mangled by) Robert KellyIV <[email protected]> " \note This file and work is based totally on Leif Wickland's VIM-TIP#335 " \date Tue, 01 Oct 2002 21:03 Pacific Daylight Time " \version $Id$ " Version: 0.2 " History: {{{ " [Feral:274/02@20:42] 0.2 " Improvments: from Leif's Tip (#335): " * can handle any number of default prams (as long as they are all " on the same line!) " * Options on how to format default params, virtual and static. " (see below) TextLink:||@|Prototype:| " * placed commands into a function (at least I think it's an " improvement ;) ) " * Improved clarity of the code, at least I hope. " * Preserves registers/marks. (rather does not use marks), Should " not dirty anything. " * All normal operations do not use mappings i.e. :normal! " (I have Y mapped to y$ so Leif's mappings could fail.) " " Limitations: " * fails on multi line declorations. All prams must be on the same " line. " * fails for non member functions. (though not horibly, just have " to remove the IncorectClass:: text... " 0.1 " Leif's original VIM-Tip #335 " }}} if exists("loaded_copycppdectoimp") finish endif let loaded_copycppdectoimp = 1 "{{{ [basic] Tip #335: Copy C++ function declaration into implementation file " tip karma Rating 5/2, Viewed by 49 " "created: October 1, 2002 6:47 complexity: basic "author: Leif Wickland as of Vim: 5.7 " "There's a handy plug in for MS Visual Studio called CodeWiz that has a nifty ability to copy a function declaration and deposit it into the implementation file on command. I actually missed while using vim, so I wrote an approximation of that capability. This isn't foolproof, but it works alright. " "" Copy Function Declaration from a header file into the implementation file. "nmap <F5> "lYml[[kw"cye'l "nmap <F6> ma:let @n=@/<cr>"lp==:s/\<virtual\>/\/\*&\*\//e<cr>:s/\<static\>/\/\*&\*\//e<cr>:s/\s*=\s*0\s*//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:s/(.\{-}\zs=\s*[^,)]\{-1,}\>\ze$\*\/$\@!.*)/\/\*&\*\//e<cr>:let @/=@n<cr>'ajf(b"cPa::<esc>f;s<cr>{<cr>}<cr><esc>kk " "To use this, source it into vim, for example by placing it in your vimrc, press F5 in normal mode with the cursor on the line in the header file that declares the function you wish to copy. Then go to your implementation file and hit F6 in normal mode with the cursor where you want the function implementation inserted. " }}} function! <SID>GrabFromHeaderPasteInSource(howtoshowVirtual, howtoshowStatic, howtoshowDefaultParams) "{{{ " echo confirm(expand("%:e")) if expand("%:e") ==? "h" "nmap <F5> "lYml[[kw"cye'l " execute ":normal! ml" let SaveL = line(".") let SaveC = virtcol(".") " into l yank the entire line " ([Feral:274/02@19:06] MY Y is mapped to y$, so I account for that below) :let Was_Reg_l = @l " execute ':normal! "lY' execute ':normal! 0"ly$' " echo confirm(@l) :let s:LineWithDecloration = @l :let @l=Was_Reg_l " [Feral:274/02@14:41] this works peachy for a member function, not so " well for a normal function, how can we fix this? Or do we bother? execute ":normal! [[" execute ":normal! kw" :let Was_Reg_c = @c execute ':normal! "cye' :let s:ClassName = @c :let @c=Was_Reg_c " execute ":normal! 'l" :execute ":normal! ".SaveL."G" :execute ":normal! ".SaveC."|" " echo confirm(s:ClassName) else " echo confirm(s:ClassName) let SaveL = line(".") let SaveC = virtcol(".") " :execute ':normal! ma' :let Was_Reg_n = @n :let @n=@/ :execute ':normal! O'.s:LineWithDecloration :execute ':normal! ==' " XXX if you want virtual commented in the implimentation: if a:howtoshowVirtual == 1 :s/\<virtual\>/\/\*&\*\//e else " XXX else, remove virtual and any spaces/tabs after it. :s/\<virtual\>\s*//e endif " XXX if you want static commented in the implimentation: if a:howtoshowStatic == 1 :s/\<static\>/\/\*&\*\//e else " XXX else, remove static and any spaces/tabs after it. :s/\<static\>\s*//e endif " wipe out a pure virtual thingie-ma-bob. (technical term? (= ) :s/\s*=\s*0\s*//e " Handle default params, if any. if a:howtoshowDefaultParams == 1 " Remove the default param assignments. :s/\s\{-}=\s\{-}[^,)]\{1,}//ge else " Comment the default param assignments. :s/\s\{-}$=\s\{-}[^,)]\{1,}$/\/\*\1\*\//ge if a:howtoshowDefaultParams == 3 " Remove the = and any spaces to the left or right. :s/\s*=\s*//ge endif endif :let @/=@n :let @n=Was_Reg_n :execute ":normal! ".SaveL."G" :execute ":normal! ".SaveC."|" :execute ':normal! f(b' :execute ':normal! i'.s:ClassName.'::' " find the ending ; and replace it with a brace structure on the next line. :execute ":normal! f;s\<cr>{\<cr>}\<cr>\<esc>kk" endif endfunc "}}} "***************************************************************** "* Commands "***************************************************************** " given: " virtual void Test_Member_Function_B3(int _iSomeNum2 = 5, char * _cpStr = "Yea buddy!"); " Prototype: "GrabFromHeaderPasteInSource(VirtualFlag, StaticFlag, DefaultParamsFlag) " VirtualFlag: " 1: if you want virtual commented in the implimentation: " /*virtual*/ void Test_Member_Function_B3(int _iSomeNum2 = 5, char * _cpStr = "Yea buddy!"); " else: remove virtual and any spaces/tabs after it. " void Test_Member_Function_B3(int _iSomeNum2 = 5, char * _cpStr = "Yea buddy!"); " StaticFlag: " 1: if you want static commented in the implimentation: " Same as virtual, save deal with static " else: remove static and any spaces/tabs after it. " Same as virtual, save deal with static " DefaultParamsFlag: " 1: If you want to remove default param reminders, i.e. " Test_Member_Function_B3(int _iSomeNum2, char * _cpStr); " 2: If you want to comment default param assignments, i.e. " Test_Member_Function_B3(int _iSomeNum2/*= 5*/, char * _cpStr/*= "Yea buddy!"*/); " 3: Like 2 but, If you do not want the = in the comment, i.e. " Test_Member_Function_B3(int _iSomeNum2/*5*/, char * _cpStr/*"Yea buddy!"*/); " " Examples: " smallest implimentation: " void Test_Member_Function_B3(int _iSomeNum2, char * _cpStr); ":command! -nargs=0 GHPH call <SID>GrabFromHeaderPasteInSource(0,0,1) " Verbose...: " /*virtual*/ void Test_Member_Function_B3(int _iSomeNum2/*5*/, char * _cpStr/*"Yea buddy!"*/); ":command! -nargs=0 GHPH call <SID>GrabFromHeaderPasteInSource(1,1,3) " What I like: " void Test_Member_Function_B3(int _iSomeNum2/*5*/, char * _cpStr/*"Yea buddy!"*/); :command! -nargs=0 GHPH call <SID>GrabFromHeaderPasteInSource(0,0,3) " Bit of trivia... GHPH.. get header, put header. ~shrug~ I needed a " command name.... (Name it whatever you wish, of course!) " eof <<<copycppdectoimp.vim

hermitte at free.vim, October 7, 2002 15:36

Several things can still be improved : * There is no need for using registers * We can easily find the class name (if any) -- easy because I'd already done this for my set of C++ ftplugins * We can accept prototypes written on several lines (this first version only supports parameters written on several lines). There are still some other things that can be done to improve this _ft_plugin, but here is a first (third) shot. <=== cut from here if exists("b:loaded_copycppdectoimp") | finish | endif let b:loaded_copycppdectoimp = 1 " Accept commands expressed on several lines let s:cpo_save=&cpo; set cpo&vim; " The main command, it could also be very interresting to propose " default mappings (:h <plug>) command! -buffer -nargs=0 GHPH \ call <SID>GrabFromHeaderPasteInSource(1,1,1) if exists("g:loaded_cpp_GotoMemberImpl_vim") let &cpo;=s:cpo_save finish endif let g:loaded_cpp_GotoMemberImpl_vim = 1 "------------------------------------------------------------------------ " Function: s:GetFunctionPrototype " {{{ " Todo: " * Retrieve the type even when it is not on the same line as the function " identifier. " * Retrieve the const modifier even when it is not on the same line as the " ')'. function! s:GetFunctionPrototype(lineNo) exe a:lineNo " 0- Go to the end of the current line (stop at the first found) call search( ')\|\n') " 1- Go to the start of the current prototype let pos = searchpair('\<\i\+\>\%(\n\|\s\)*(', '', ')', 'bW') let l0 = line('.') " 2- Go to the "end" of the current prototype let pos = searchpair('\<\i\+\>\%(\n\|\s\)*(', '', ')', 'W') let l1 = line('.') " Abort if nothing has been found if ((0==pos) || (l0>a:lineNo)) | return '' | endif " 3- Build the protoype string let proto = getline(l0) while l0 < l1 let l0 = l0 + 1 let proto = proto . "\n" . getline(l0) endwhile " 4- and return it. exe a:lineNo return proto endfunction " }}} "------------------------------------------------------------------------ " Function: Cpp_SearchClassDefinition {{{ " Excerpt from cpp_FindContextClass.vim function! Cpp_SearchClassDefinition(lineNo) let pos = a:lineNo exe a:lineNo let class = "" while pos != 0 let pos = searchpair('class\s\+\<\i\+\>\%(\n\|\s\)*{', '', '};', 'bW') if pos != 0 let cls_name = substitute(getline(pos), \ '^.*\s*class\s\+$\<\i\+\>$.*$', '\1', '') let class = class . '::' . cls_name endif endwhile exe a:lineNo return substitute (class, '^:\+', '', 'g') endfunction " }}} "------------------------------------------------------------------------ " Function: s:GrabFromHeaderPasteInSource "{{{ function! s:GrabFromHeaderPasteInSource( \ HowToShowVirtual, HowToShowStatic, HowToShowDefaultParams) " 1- Retrieve the context {{{ " 1.1- Get the class name,if any -- thanks to cpp_FindContextClass.vim let className = Cpp_SearchClassDefinition(line('.')) " 1.2- Get the whole prototype of the function (even if on several lines) let impl = s:GetFunctionPrototype(line('.')) " }}} " 2- Build the result string {{{ " 2.1- XXX if you want virtual commented in the implementation: let impl = substitute(impl, '$\<virtual\>$$\s*$', \ (1 == a:HowToShowVirtual ? '/*\1*/\2' : ''), '') " 2.2- XXX if you want static commented in the implementation: let impl = substitute(impl, '$\<static\>$$\s*$', \ (1 == a:HowToShowStatic ? '/*\1*/\2' : ''), '') " 2.3- Handle default params, if any. " 0 -> ignored " 1 -> commented " 2 -> commented, spaces trimmed if a:HowToShowDefaultParams == 0 | let pattern = '' elseif a:HowToShowDefaultParams == 1 | let pattern = '/*\1*/' elseif a:HowToShowDefaultParams == 2 | let pattern = '/*=\2*/' else | let pattern = '' endif let impl = substitute(impl, '\s*$=\s*\([^,)]\{1,}$\)', pattern, 'g') " 2.4- Add '::' to the class name (if any). if "" != className | let className = className . '::' | endif let impl = substitute(impl, '\<\i\+\>$'."\n".'\|\s$*(', className.'\0', '') " 2.5- Remove the last part, ';' expected let impl = substitute(impl, '$\s*=\s*0$\=\s*;\s*$', "\n{\n}", '') " }}} " 3- Add the string to the implementation file {{{ if exists(':AS') " from a.vim silent AS cpp else let file = fnamemodify(expand('%'), ':r') . '.cpp' silent exe ":sp ".file endif silent $put=impl let nl = strlen(substitute(impl, "[^\n]", '', 'g')) exe (line('$')-nl).',$v/^$/normal ==' " }}} endfunction " }}} let &cpo;=s:cpo_save "====================================================================== " vim60:fdm=marker




	If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly. Questions about Vim should go to [email protected] after searching the archive. Help Bram help Uganda.