Refactored for table within inline comments

- Fixes #5. We now have the ability to invoke table mode within inline
  comments. Works for both instant table creation and table conversion
  for csv data. Uses 'commentstring' option of vim to identify comments,
  so it should work for most filetypes as long as 'commentstring' option
  has been set. This is usually done appropriately in filetype plugins.

.gitignore

@@ -0,0 +1 @@
+tags

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log
+## Version 2.2.1
+* Added feature to allow Table-Mode to work within comments. Uses
+  'commentstring' option of vim to identify comments, so it should work for
+  most filetypes as long as 'commentstring' option has been set. This is
+  usually done appropriately in filetype plugins.
+
+## Version 2.2
+* Improved :Tableize to now accept a {pattern} just like :Tabular to match the
+  delimiter.
+
+## Version 2.1.3 :
+* Bug Fix #1, added new option `g:table_mode_no_border_padding` which removes
+  padding from the border.
+
+## Version 2.1.2 :
+* Bug Fixes #2, #3 & #4
+
+## Version 2.1.1 :
+* Added option g:table_mode_align to allow setting Tabular format option for
+  more control on how Tabular aligns text.
+
+## Version 2.1 :
+* VIM loads plugins in alphabetical order and so table-mode would be loaded
+  before Tabularize which it depends on. Hence Moved plugin into an after
+  plugin. Checking if Tabularize is available and finish immidiately if it's
+  not.
+
+## Version 2.0 :
+* Moved bulk of code to autoload for vimscript optimisation.
+
+## Version 1.1 :
+* Added Tableize command and mapping to convert existing content into a table.
+
+## Version 1.0 :
+* First stable release, create tables as you type.

README.md

@@ -4,31 +4,9 @@ An awesome automatic table creator & formatter allowing one to create neat
 tables as you type.
 
 ## Change Log
-### Version 2.1.3 :
+See <a
-* Bug Fix #1, added new option `g:table_mode_no_border_padding` which removes
+href="https://github.com/dhruvasagar/vim-table-mode/blob/master/CHANGELOG.md">
-  padding from the border.
+CHANGELOG.md </a>
-
-### Version 2.1.2 :
-* Bug Fixes #2, #3 & #4
-
-### Version 2.1.1 :
-* Added option g:table_mode_align to allow setting Tabular format option for
-  more control on how Tabular aligns text.
-
-### Version 2.1 :
-* VIM loads plugins in alphabetical order and so table-mode would be loaded
-  before Tabularize which it depends on. Hence Moved plugin into an after
-  plugin. Checking if Tabularize is available and finish immidiately if it's
-  not.
-
-### Version 2.0 :
-* Moved bulk of code to autoload for vimscript optimisation.
-
-### Version 1.1 :
-* Added Tableize command and mapping to convert existing content into a table.
-
-### Version 1.0 :
-* First stable release, create tables as you type.
 
 ## Getting Started
 ### Installation

after/plugin/table-mode.vim

@@ -4,7 +4,7 @@
 " Author:        Dhruva Sagar <http://dhruvasagar.com/>
 " License:       MIT (http://www.opensource.org/licenses/MIT)
 " Website:       http://github.com/dhruvasagar/vim-table-mode
-" Version:       2.1.3
+" Version:       2.2.1
 " Note:          This plugin was heavily inspired by the 'CucumberTables.vim'
 "                (https://gist.github.com/tpope/287147) plugin by Tim Pope and
 "                uses a small amount of code from it.
@@ -33,6 +33,11 @@ if !exists(':Tabularize')
 endif
 " }}}1
 
+" Avoiding side effects {{{1
+let s:save_cpo = &cpo
+set cpo&vim
+" }}}1
+
 function! s:SetGlobalOptDefault(opt, val) "{{{1
   if !exists('g:' . a:opt)
     let g:{a:opt} = a:val
@@ -48,7 +53,8 @@ call s:SetGlobalOptDefault('table_mode_fillchar', '-')
 call s:SetGlobalOptDefault('table_mode_toggle_map', '<LocalLeader>tm')
 call s:SetGlobalOptDefault('table_mode_always_active', 0)
 call s:SetGlobalOptDefault('table_mode_delimiter', ',')
-call s:SetGlobalOptDefault('table_mode_tableize_map', '<Leader>T')
+call s:SetGlobalOptDefault('table_mode_tableize_map', '<Leader>tt')
+call s:SetGlobalOptDefault('table_mode_tableize_op_map', '<Leader>T')
 call s:SetGlobalOptDefault('table_mode_align', 'l1')
 call s:SetGlobalOptDefault('table_mode_no_border_padding', '0')
 "}}}1
@@ -70,10 +76,15 @@ else
   unlet table_mode_separator_map
 endif
 
-command! -nargs=0 -range Tableize <line1>,<line2>call tablemode#TableizeRange()
+command! -nargs=? -range Tableize <line1>,<line2>call tablemode#TableizeRange(<q-args>)
 execute "xnoremap <silent> " . g:table_mode_tableize_map . " :Tableize<CR>"
 execute "nnoremap <silent> " . g:table_mode_tableize_map . " :Tableize<CR>"
+execute "xnoremap <silent> " . g:table_mode_tableize_op_map . " :<C-U>call tablemode#TableizeByDelimiter()<CR>"
 "}}}1
 
+" Avoiding side effects {{{1
+let &cpo = s:save_cpo
+" }}}1
+
 " ModeLine {{{
 " vim:fdl=0 fdm=marker

autoload/tablemode.vim

@@ -4,7 +4,7 @@
 " Author:        Dhruva Sagar <http://dhruvasagar.com/>
 " License:       MIT (http://www.opensource.org/licenses/MIT)
 " Website:       http://github.com/dhruvasagar/vim-table-mode
-" Version:       2.1.3
+" Version:       2.2.1
 " Note:          This plugin was heavily inspired by the 'CucumberTables.vim'
 "                (https://gist.github.com/tpope/287147) plugin by Tim Pope and
 "                uses a small amount of code from it.
@@ -40,6 +40,21 @@ function! s:CountSeparator(line, separator) "{{{2
 endfunction
 " }}}2
 
+function! s:GetCommentStart() "{{{2
+  return split(substitute(&commentstring, '%s', ' ', 'g'))[0]
+endfunction
+" }}}2
+
+function! s:StartExpr() "{{{2
+  return '^\s*\(' . s:GetCommentStart() . '\)\?\s*'
+endfunction
+" }}}2
+
+function! s:StartCommentExpr() "{{{2
+  return '^\s*' . s:GetCommentStart() . '\s*'
+endfunction
+" }}}2
+
 function! s:IsTableModeActive() "{{{2
   if g:table_mode_always_active | return 1 | endif
 
@@ -70,7 +85,7 @@ endfunction
 
 function! s:UpdateLineBorder(line) "{{{2
   let cline = a:line
-  let hf = '^\s*' . g:table_mode_corner . '[' . g:table_mode_corner . ' ' .
+  let hf = s:StartExpr() . g:table_mode_corner . '[' . g:table_mode_corner . ' ' .
          \ g:table_mode_fillchar . ']*' . g:table_mode_corner . '\?\s*$'
   let curr_line_count = s:CountSeparator(cline, g:table_mode_separator)
 
@@ -80,7 +95,12 @@ function! s:UpdateLineBorder(line) "{{{2
       silent! execute 'normal! kA' . repeat(g:table_mode_corner, curr_line_count - prev_line_count) . "\<Esc>j"
     endif
   else
-    call append(cline-1, repeat(g:table_mode_corner, curr_line_count))
+    if getline(cline) =~# s:StartCommentExpr()
+      let indent = matchstr(getline(cline), s:StartCommentExpr())
+      call append(cline-1, indent . repeat(g:table_mode_corner, curr_line_count))
+    else
+      call append(cline-1, repeat(g:table_mode_corner, curr_line_count))
+    endif
     let cline = a:line + 1 " because of the append, the current line moved down
   endif
 
@@ -90,7 +110,12 @@ function! s:UpdateLineBorder(line) "{{{2
       silent! execute 'normal! jA' . repeat(g:table_mode_corner, curr_line_count - next_line_count) . "\<Esc>k"
     end
   else
-    call append(cline, repeat(g:table_mode_corner, curr_line_count))
+    if getline(cline) =~# s:StartCommentExpr()
+      let indent = matchstr(getline(cline), s:StartCommentExpr())
+      call append(cline, indent . repeat(g:table_mode_corner, curr_line_count))
+    else
+      call append(cline, repeat(g:table_mode_corner, curr_line_count))
+    endif
   endif
 endfunction
 " }}}2
@@ -110,14 +135,18 @@ function! s:FillTableBorder() "{{{2
 endfunction
 " }}}2
 
-function! s:ConvertDelimiterToSeparator(line) "{{{2
+function! s:ConvertDelimiterToSeparator(line, ...) "{{{2
-  silent! execute a:line . 's/^\s*\zs\ze.\|' . g:table_mode_delimiter .
+  let delim = g:table_mode_delimiter
-        \ '\|$/' . g:table_mode_separator . '/g'
+  if a:0 | let delim = a:1 | endif
+  silent! execute a:line . 's/' . s:StartExpr() . '\zs\ze.\|' . delim .  '\|$/' .
+        \ g:table_mode_separator . '/g'
 endfunction
 " }}}2
 
-function! s:Tableizeline(line) "{{{2
+function! s:Tableizeline(line, ...) "{{{2
-  call s:ConvertDelimiterToSeparator(a:line)
+  let delim = g:table_mode_delimiter
+  if a:0 && type(a:1) == type('') && !empty(a:1) | let delim = a:1[1:-1] | endif
+  call s:ConvertDelimiterToSeparator(a:line, delim)
   if g:table_mode_border | call s:UpdateLineBorder(a:line) | endif
   execute 'Tabularize/[' . g:table_mode_separator . g:table_mode_corner . ']/' . g:table_mode_align
 endfunction
@@ -128,7 +157,7 @@ endfunction
 " Public API {{{1
 
 function! tablemode#TableizeInsertMode() "{{{2
-  if s:IsTableModeActive() && getline('.') =~# ('^\s*' . g:table_mode_separator)
+  if s:IsTableModeActive() && getline('.') =~# (s:StartExpr() . g:table_mode_separator)
     let column = s:Strlen(substitute(getline('.')[0:col('.')], '[^' . g:table_mode_separator . ']', '', 'g'))
     let position = s:Strlen(matchstr(getline('.')[0:col('.')], '.*' . g:table_mode_separator . '\s*\zs.*'))
     if g:table_mode_border | call s:UpdateLineBorder(line('.')) | endif
@@ -161,16 +190,16 @@ function! tablemode#TableModeToggle() "{{{2
 endfunction
 " }}}2
 
-function! tablemode#TableizeRange() range "{{{2
+function! tablemode#TableizeRange(...) range "{{{2
   let shift = 1
   if g:table_mode_border | let shift = shift + 1 | endif
-  call s:Tableizeline(a:firstline)
+  call s:Tableizeline(a:firstline, a:1)
   undojoin
   " The first one causes 2 extra lines for top & bottom border while the
   " following lines cause only 1 for the bottom border.
   let lnum = a:firstline + shift + (g:table_mode_border > 0)
   while lnum < (a:firstline + (a:lastline - a:firstline + 1)*shift)
-    call s:Tableizeline(lnum)
+    call s:Tableizeline(lnum, a:1)
     undojoin
     let lnum = lnum + shift
   endwhile
@@ -178,6 +207,16 @@ function! tablemode#TableizeRange() range "{{{2
 endfunction
 " }}}2
 
+function! tablemode#TableizeByDelimiter() "{{{2
+  let delim = input('/')
+  if delim =~# "\<Esc>" || delim =~# "\<C-C>" | return | endif
+  let vm = visualmode()
+  if vm ==? 'line' || vm ==? 'V'
+    exec line("'<") . ',' . line("'>") . "call tablemode#TableizeRange('/' . delim)"
+  endif
+endfunction
+" }}}2
+
 " }}}1
 
 " ModeLine {{{

doc/table-mode.txt

@@ -1,7 +1,7 @@
-*table-mode.txt*			Table Mode for easy table formatting. v2.1.2
+*table-mode.txt*			Table Mode for easy table formatting. v2.2.1
 ===============================================================================
 	Table Mode, THE AWESOME AUTOMATIC TABLE CREATOR & FORMATTER
-				 VERSION 2.1.2
+				 VERSION 2.2.1
 
 		Author: Dhruva Sagar <http://dhruvasagar.com/>
 		License: MIT <http://opensource.org/licenses/MIT/>
@@ -48,78 +48,95 @@ The table mode is disabled by default and you can enter table mode using
 OPTIONS							*table-mode-options*
 
 Overview:
-	|table-mode-options-loaded| ............. Disable the plugin
+	|table-mode-loaded| ............. Disable the plugin.
-	|table-mode-options-border| ............. Enable border
+	|table-mode-border| ............. Enable border.
-	|table-mode-options-corner| ............. Set corner character
+	|table-mode-corner| ............. Set corner character.
-	|table-mode-options-separator| .......... Set separator character
+	|table-mode-separator| .......... Set separator character.
-	|table-mode-options-fillchar| ........... Set table fillchar character
+	|table-mode-fillchar| ........... Set table fillchar character.
-	|table-mode-options-toggle-map| ......... Set table mode toggle mapping
+	|table-mode-toggle-map| ......... Set table mode toggle mapping.
-	|table-mode-options-always-active| ...... Set table mode to always enabled
+	|table-mode-always-active| ...... Set table mode to always enabled.
-	|table-mode-options-delimiter| .......... Set the delimiter for Tableize
+	|table-mode-delimiter| .......... Set the delimiter for Tableize.
-	|table-mode-options-align| .............. Set the text alignment for
+	|table-mode-tableize-map| ....... Set mapping for Tableize.
-						Tableize
+	|table-mode-tableize-op-map| .... Set mapping for Tableize with input.
-	|table-mode-options-no-border-padding| .. Set for no border padding.
+	|table-mode-align| .............. Set the text alignment for
+		        		Tableize.
+	|table-mode-no-border-padding| .. Set for no border padding.
 
-g:table_mode_loaded				*table-mode-options-loaded*
+g:table_mode_loaded					*table-mode-loaded*
 	Use this option to disable the plugin: >
 		let g:table_mode_loaded = 1
 <
 
-g:table_mode_border				*table-mode-options-border*
+g:table_mode_border					*table-mode-border*
 	Use this option to enable / disable table border: >
 		let g:table_mode_border = 1
 <
 
-g:table_mode_corner				*table-mode-options-corner*
+g:table_mode_corner					*table-mode-corner*
 	Use this option to define the table corner character: >
 		let g:table_mode_corner = '+'
 <
-g:table_mode_separator				*table-mode-options-separator*
+g:table_mode_separator					*table-mode-separator*
 	Use this option to define the table column separator character: >
 		let g:table_mode_separator = '|'
 <
 	This option also defines the trigger to be used to start creating a
 	table row in insert mode.
 
-g:table_mode_fillchar				*table-mode-options-fillchar*
+g:table_mode_fillchar					*table-mode-fillchar*
 	Use this option to define the table border fill character: >
 		let g:table_mode_fillchar = '-'
 <
 
-g:table_mode_toggle_map				*table-mode-options-toggle-map*
+g:table_mode_toggle_map					*table-mode-toggle-map*
 	Use this option to define the mapping for toggling the table mode: >
 		let g:table_mode_toggle_map = '<Leader>tm'
 <
 	Read |table-mode-mappings-toggle| for more info.
 
-g:table_mode_always_active			*table-mode-options-always-active*
+g:table_mode_always_active				*table-mode-always-active*
 	Use this option to permanently enable the table mode: >
 		let g:table_mode_always_active = 0
 <
 	This will trigger table creation once you type the
-	|table-mode-options-separator| as long as it's the first character on
+	|table-mode-separator| as long as it's the first character on
 	the line, which can be annoying. I recommend you to instead use the
 	|table-mode-mappings-toggle| or |table-mode-commands-toggle| to toggle
 	the table mode or |table-mode-commands-enable| to enable and
 	|table-mode-commands-disable| to disable mode when needed.
 
-g:table_mode_delimiter				*table-mode-options-delimiter*
+g:table_mode_delimiter					*table-mode-delimiter*
 	Use this option to define the delimiter which used by
-	|table-mode-commands-tableize|
+	|table-mode-commands-tableize| >
+		let g:table_mode_delimiter = ','
+<
 
-g:table_mode_align				*table-mode-options-align*
+g:table_mode_tableize_map			*table-mode-tableize-map*
+	Use this option to define the mapping to invoke |:Tableize| with
+	default delimiter, i.e. |:Tableize| without input. >
+		let g:table_mode_tableize_map = '<Leader>tt'
+<
+
+g:table_mode_tableize_op_map			*table-mode-tableize-op-map*
+	Use this option to define the mapping to invoke |:Tableize| with input
+	parameter. This option will ask for command-line input {pattern} that
+	defines the delimiter. >
+		let g:table_mode_tableize_op_map = '<Leader>T'
+<
+
+g:table_mode_align					*table-mode-align*
 	Use this option to define the format for text alignment to be used for
 	the tables. Go through |tabular-walkthrough| for details on how to set
 	the format options for alignment. >
 		let g:table_mode_align = 'l1'
 <
 
-g:table_mode_no_border_padding		*table-mode-options-no-border-padding*
+g:table_mode_no_border_padding			*table-mode-no-border-padding*
 	Use this option to remove the border padding (extra spaces around the
-	|table-mode-options-fillchar|). >
+	|table-mode-fillchar|). >
 		let g:table_mode_no_border_padding = 0
 <
-	NOTE this option changes |table-mode-options-align| to 'c0', so that
+	NOTE this option changes |table-mode-align| to 'c0', so that
 	there is no extra padding around the contents.
 ===============================================================================
 MAPPINGS						*table-mode-mappings*
@@ -129,52 +146,66 @@ MAPPINGS						*table-mode-mappings*
 		using the |toggle-mode-options-toggle-map| option.
 		
 		NOTE This is applicable only if
-		|table-mode-options-always-active| is not set.
+		|table-mode-always-active| is not set.
 
 						*table-mode-mappings-trigger*
 |		Trigger table creation in table mode. You can change this
 		using the |toggle-mode-options-separator| option.
 
-<Leader>T	Triggers |table-mode-commands-tableize| on the visually
+<Leader>tt	Triggers |table-mode-commands-tableize| on the visually
 		selected content.
 
+						*table-mode-mappings-op-trigger*
+<Leader>T	Triggers |table-mode-commands-tableize| on the visually
+		selected asking for user to input the delimiter.
+
 ===============================================================================
 COMMANDS						*table-mode-commands*
 
 							*:TableModeToggle*
-						*table-mode-commands-toggle*
+						*table-mode-:TableModeToggle*
 :TableModeToggle
 	Toggles the table mode. Same effect as |toggle-mode-mappings-toggle|.
 
-	NOTE this is applicable only if |table-mode-options-always-active| is
+	NOTE this is applicable only if |table-mode-always-active| is
 	not set.
 
 							*:TableModeEnable*
-						*table-mode-commands-enable*
+						*table-mode-:TableModeEnable*
 :TableModeEnable
 	Enables Table Mode.
 
-	NOTE this is applicable only if |table-mode-options-always-active| is
+	NOTE this is applicable only if |table-mode-always-active| is
 	not set.
 
 							*:TableModeDisable*
-						*table-mode-commands-disable*
+						*table-mode-:TableModeDisable*
 :TableModeDisable
 	Disables Table Mode. 
 
-	NOTE this is applicable only if |table-mode-options-always-active| is
+	NOTE this is applicable only if |table-mode-always-active| is
 	not set.
 
 								*:Tableize*
-:Tableize					*table-mode-commands-tableize*
+							*table-mode-:Tableize*
+:Tableize
 	This converts the current line into a table if it consists of
-	|table-mode-options-delimiter|. This accepts a range, without which it
+	|table-mode-delimiter|. This accepts a range, without which it
 	applies on the current line.
+
+	This accepts a {pattern} similar to Tabular which defines the
+	delimiter. eg.) >
+		:Tableize/;
+<
+	The above command will Tableize using ';' as the delimiter.
+
+	NOTE this is optional, by default without the expression it will
+	tableize the content using |g:table-mode-delimiter| as the delimiter.
 ===============================================================================
 CONTRIBUTING						*table-mode-contributing*
 
 If you want to take a stab at it, by all means, send me a pull request on
-Github (http://github.com/dhruvasagar/table-mode.git) or get in touch with me
+Github (http://github.com/dhruvasagar/table-mode) or get in touch with me
 directly via e-mail at dhruva 'dot' sagar 'at' gmail.com.
 
 ===============================================================================

doc/tags

@@ -1,29 +0,0 @@
-:TableModeDisable	table-mode.txt	/*:TableModeDisable*
-:TableModeEnable	table-mode.txt	/*:TableModeEnable*
-:TableModeToggle	table-mode.txt	/*:TableModeToggle*
-:Tableize	table-mode.txt	/*:Tableize*
-table-mode-commands	table-mode.txt	/*table-mode-commands*
-table-mode-commands-disable	table-mode.txt	/*table-mode-commands-disable*
-table-mode-commands-enable	table-mode.txt	/*table-mode-commands-enable*
-table-mode-commands-tableize	table-mode.txt	/*table-mode-commands-tableize*
-table-mode-commands-toggle	table-mode.txt	/*table-mode-commands-toggle*
-table-mode-contents	table-mode.txt	/*table-mode-contents*
-table-mode-contributing	table-mode.txt	/*table-mode-contributing*
-table-mode-getting-started	table-mode.txt	/*table-mode-getting-started*
-table-mode-introduction	table-mode.txt	/*table-mode-introduction*
-table-mode-mappings	table-mode.txt	/*table-mode-mappings*
-table-mode-mappings-toggle	table-mode.txt	/*table-mode-mappings-toggle*
-table-mode-mappings-trigger	table-mode.txt	/*table-mode-mappings-trigger*
-table-mode-options	table-mode.txt	/*table-mode-options*
-table-mode-options-align	table-mode.txt	/*table-mode-options-align*
-table-mode-options-always-active	table-mode.txt	/*table-mode-options-always-active*
-table-mode-options-border	table-mode.txt	/*table-mode-options-border*
-table-mode-options-corner	table-mode.txt	/*table-mode-options-corner*
-table-mode-options-delimiter	table-mode.txt	/*table-mode-options-delimiter*
-table-mode-options-fillchar	table-mode.txt	/*table-mode-options-fillchar*
-table-mode-options-loaded	table-mode.txt	/*table-mode-options-loaded*
-table-mode-options-separator	table-mode.txt	/*table-mode-options-separator*
-table-mode-options-toggle-map	table-mode.txt	/*table-mode-options-toggle-map*
-table-mode-report-issues	table-mode.txt	/*table-mode-report-issues*
-table-mode-requirements	table-mode.txt	/*table-mode-requirements*
-table-mode.txt	table-mode.txt	/*table-mode.txt*