" Vimball Archiver by Charles E. Campbell, Ph.D.
UseVimball
finish
ftplugin/c/VisCdecl.vim	[[[1
40
" VisCdecl.vim:
"   Author:  Charles E. Campbell
"   Date:    Oct 26, 2006 - May 11, 2023
"   Version: 1b	ASTRO-ONLY
"
"   Use visual mode (V will do!) to select some declarations 
"   for processing by cdecl
" ---------------------------------------------------------------------
let g:loaded_VisCdecl= "v1b"

" ---------------------------------------------------------------------
"  Public Interface: {{{1
if !hasmapto('<Plug>VisCdecl')
 map <buffer> <unique> <c-F1>	<Plug>VisCdecl
endif
vmap <silent> <script> <Plug>VisCdecl	:call <SID>VisCdecl()<CR>

" ---------------------------------------------------------------------
" VisCdecl: appends a comment explaining the declaration {{{1
fun! s:VisCdecl()
  if !executable("cdecl")
   redraw!
   echohl WarningMsg | echo "sorry, can't find cdecl on your system" | echohl None
   return
  endif
  let curline = getline(".")
  let curline = substitute(curline,'^','explain ','')
  let curline = substitute(curline,'\s*= .*;',';','')
  let akeep   = @a
  let @a      = curline
  put a
  .!cdecl -
  s/^.*$/\/* & *\//
  norm! kJ
  let @a=akeep
endfun

" ---------------------------------------------------------------------
"  Modelines: {{{1
"  vim: fdm=marker
doc/VisCdecl.txt	[[[1
40
*VisCdecl.txt*	Visual C Declarations			Oct 26, 2006
Author:  Charles E. Campbell  <NcampObell@SdrPchip.AorgM-NOSPAM>
	  (remove NOSPAM from Campbell's email first)
Copyright: (c) 2004-2006 by Charles E. Campbell		*VisCdecl-copyright*
           The VIM LICENSE applies to VisCdecl.vim, and VisCdecl.txt
           (see |copyright|) except use "VisCdecl" instead of "Vim"
	   No warranty, express or implied.  Use At-Your-Own-Risk.

==============================================================================
1. Contents					*VisCdecl* *VisCdecl-contents*

   1. Contents................................: |VisCdecl-contents|
   2. VisCdecl Manual.........................: |VisCdecl-manual|
   3. History.................................: |VisCdecl-history|

==============================================================================
2. VisCdecl Manual					*VisCdecl-manual*

   VisCdecl depends upon the cdecl program, usually available with your linux
   distributions.  Its really easy to use; just use visual mode (V is fine)
   to pick up a one-variable declaration and a <s-f1> key will cause an
   explanation to get appended.  It resides in ftplugin/c/VisCdecl.vim, and so
   its only invoked for C files.  I've used it to explain all the following
   declarations, for example: >

 int x;                 /* declare x as int                                                                                   */
 int (*f)(int);         /* declare f as pointer to function (int) returning int                                               */
 int *(*f)(int,double); /* declare f as pointer to function (int, double) returning pointer to int                            */
 int (*f())[5];         /* declare f as function returning pointer to array 5 of int                                          */
 int (*(*(*f)())())[5]; /* declare f as pointer to function returning pointer to function returning pointer to array 5 of int */
<
(I also used \acom from AlignMaps to line up the comments)

==============================================================================
3. VisCdecl History					*VisCdecl-history*  {{{1

   Oct 27, 2006 v1 : initial release

Modelines: {{{1
vim:tw=78:ts=8:ft=help:fdm=marker: