Merge pull request #174 from ibbem/feature/add-columns

Add a way to insert columns

README.md

@@ -177,6 +177,16 @@ it using `:TableModeRealign` or using the default mapping
       (provided you are within a table row), this can also be preceeded with a
       [count] to delete multiple columns.
 
+  - **Insert Column** :
+
+      You can use the <kbd>\<Leader\>tic</kbd> mapping defined by the option
+      `g:table_mode_insert_column_after_map` to insert a column after the
+      cursor (provided you are within a table row). Of course you can use the
+      <kbd>\<Leader\>tiC</kbd> mapping defined by
+      `g:table_mode_insert_column_before_map` to insert a column before the
+      cursor. Both can also be preceeded with a [count] to insert multiple
+      columns.
+
 ## Advanced Usage: Spreadsheet Capabilities
 
 ### Table Formulas

autoload/tablemode.vim

@@ -40,6 +40,8 @@ function! s:ToggleMapping() "{{{2
       call s:Map('<Plug>(table-mode-realign)', g:table_mode_realign_map, 'n')
       call s:Map('<Plug>(table-mode-delete-row)', g:table_mode_delete_row_map, 'n')
       call s:Map('<Plug>(table-mode-delete-column)', g:table_mode_delete_column_map, 'n')
+      call s:Map('<Plug>(table-mode-insert-column-before)', g:table_mode_insert_column_before_map, 'n')
+      call s:Map('<Plug>(table-mode-insert-column-after)', g:table_mode_insert_column_after_map, 'n')
       call s:Map('<Plug>(table-mode-add-formula)', g:table_mode_add_formula_map, 'n')
       call s:Map('<Plug>(table-mode-eval-formula)', g:table_mode_eval_formula_map, 'n')
       call s:Map('<Plug>(table-mode-echo-cell)', g:table_mode_echo_cell_map, 'n')
@@ -57,6 +59,8 @@ function! s:ToggleMapping() "{{{2
       call s:UnMap(g:table_mode_realign_map, 'n')
       call s:UnMap(g:table_mode_delete_row_map, 'n')
       call s:UnMap(g:table_mode_delete_column_map, 'n')
+      call s:UnMap(g:table_mode_insert_column_before_map, 'n')
+      call s:UnMap(g:table_mode_insert_column_after_map, 'n')
       call s:UnMap(g:table_mode_add_formula_map, 'n')
       call s:UnMap(g:table_mode_eval_formula_map, 'n')
       call s:UnMap(g:table_mode_echo_cell_map, 'n')

autoload/tablemode/spreadsheet.vim

@@ -31,9 +31,28 @@ function! tablemode#spreadsheet#GetFirstRow(line) "{{{2
   endif
 endfunction
 
+function! tablemode#spreadsheet#GetFirstRowOrHeader(line) "{{{2
+  if tablemode#table#IsRow(a:line)
+    let line = tablemode#utils#line(a:line)
+
+    while tablemode#table#IsTable(line - 1)
+      let line -= 1
+    endwhile
+    if tablemode#table#IsBorder(line) | let line += 1 | endif
+
+    return line
+  endif
+endfunction
+
 function! tablemode#spreadsheet#MoveToFirstRow() "{{{2
   if tablemode#table#IsRow('.')
-    call cursor(tablemode#spreadsheet#GetFirstRow('.'), col('.'))
+    call tablemode#utils#MoveToLine(tablemode#spreadsheet#GetFirstRow('.'))
+  endif
+endfunction
+
+function! tablemode#spreadsheet#MoveToFirstRowOrHeader() "{{{2
+  if tablemode#table#IsRow('.')
+    call tablemode#utils#MoveToLine(tablemode#spreadsheet#GetFirstRowOrHeader('.'))
   endif
 endfunction
 
@@ -52,7 +71,7 @@ endfunction
 
 function! tablemode#spreadsheet#MoveToLastRow() "{{{2
   if tablemode#table#IsRow('.')
-    call cursor(tablemode#spreadsheet#GetLastRow('.'), col('.'))
+    call tablemode#utils#MoveToLine(tablemode#spreadsheet#GetLastRow('.'))
   endif
 endfunction
 
@@ -113,13 +132,11 @@ function! tablemode#spreadsheet#ColumnNr(pos) "{{{2
     return 0
   endif
   let row_start = stridx(getline(pos[0]), g:table_mode_separator)
-  return tablemode#utils#strlen(substitute(getline(pos[0])[(row_start):pos[1]-2], '[^' . g:table_mode_separator . ']', '', 'g'))
+  return tablemode#utils#SeparatorCount(getline(pos[0])[row_start:pos[1]-2])
 endfunction
 
 function! tablemode#spreadsheet#ColumnCount(line) "{{{2
-  let line = tablemode#utils#line(a:line)
+  return tablemode#utils#SeparatorCount(getline(tablemode#utils#line(a:line))) - 1
-
-  return tablemode#utils#strlen(substitute(getline(line), '[^' . g:table_mode_separator . ']', '', 'g'))-1
 endfunction
 
 function! tablemode#spreadsheet#IsFirstCell() "{{{2
@@ -131,19 +148,25 @@ function! tablemode#spreadsheet#IsLastCell() "{{{2
 endfunction
 
 function! tablemode#spreadsheet#MoveToStartOfCell() "{{{2
-  if getline('.')[col('.')-1] ==# g:table_mode_separator && !tablemode#spreadsheet#IsLastCell()
+  if getline('.')[col('.')-1] !=# g:table_mode_separator || tablemode#spreadsheet#IsLastCell()
-    normal! 2l
+    call search(g:table_mode_escaped_separator_regex, 'b', line('.'))
-  else
-    execute 'normal! F' . g:table_mode_separator . '2l'
   endif
+  normal! 2l
+endfunction
+
+function! tablemode#spreadsheet#MoveToEndOfCell() "{{{2
+  call search(g:table_mode_escaped_separator_regex, 'z', line('.'))
+  normal! 2h
 endfunction
 
 function! tablemode#spreadsheet#DeleteColumn() "{{{2
   if tablemode#table#IsRow('.')
     for i in range(v:count1)
       call tablemode#spreadsheet#MoveToStartOfCell()
-      call tablemode#spreadsheet#MoveToFirstRow()
+      call tablemode#spreadsheet#MoveToFirstRowOrHeader()
-      silent! execute "normal! h\<C-V>f" . g:table_mode_separator
+      silent! execute "normal! h\<C-V>"
+      call tablemode#spreadsheet#MoveToEndOfCell()
+      normal! 2l
       call tablemode#spreadsheet#MoveToLastRow()
       normal! d
     endfor
@@ -168,6 +191,59 @@ function! tablemode#spreadsheet#DeleteRow() "{{{2
   endif
 endfunction
 
+function! tablemode#spreadsheet#InsertColumn(after) "{{{2
+  if tablemode#table#IsRow('.')
+    let quantity = v:count1
+
+    call tablemode#spreadsheet#MoveToFirstRowOrHeader()
+    call tablemode#spreadsheet#MoveToStartOfCell()
+    if a:after
+      call tablemode#spreadsheet#MoveToEndOfCell()
+      normal! 3l
+    endif
+    execute "normal! h\<C-V>"
+    call tablemode#spreadsheet#MoveToLastRow()
+    normal! y
+
+    let corner = tablemode#utils#get_buffer_or_global_option('table_mode_corner')
+    if a:after
+      let cell_line = g:table_mode_separator.'  '
+      let header_line = corner.g:table_mode_fillchar.g:table_mode_fillchar
+    else
+      let cell_line = '  '.g:table_mode_separator
+      let header_line = g:table_mode_fillchar.g:table_mode_fillchar.corner
+    endif
+    let cell_line = escape(cell_line, '\&')
+    let header_line = escape(header_line, '\&')
+
+    " This transforms the character column before or after the column separator
+    " into a new column with separator.
+    " This requires, that
+    "      g:table_mode_separator != g:table_mode_fillchar
+    "   && g:table_mode_separator != g:table_mode_header_fillchar
+    "   && g:table_mode_separator != g:table_mode_align_char
+    call setreg(
+      \ '"',
+      \ substitute(
+      \   substitute(@", ' ', cell_line, 'g'),
+      \   '\V\C'.escape(g:table_mode_fillchar, '\')
+      \     .'\|'.escape(g:table_mode_header_fillchar, '\')
+      \     .'\|'.escape(g:table_mode_align_char, '\'),
+      \   header_line,
+      \   'g'),
+      \ 'b')
+
+    if a:after
+      execute "normal! ".quantity."pl"
+    else
+      execute "normal! ".quantity."P"
+    endif
+
+    call tablemode#table#Realign('.')
+    startinsert
+  endif
+endfunction
+
 function! tablemode#spreadsheet#Sum(range, ...) abort "{{{2
   let args = copy(a:000)
   call insert(args, a:range)

autoload/tablemode/utils.vim

@@ -51,3 +51,16 @@ endfunction
 function! tablemode#utils#get_buffer_or_global_option(table_option) "{{{2
   return get(b:, a:table_option, get(g:, a:table_option))
 endf
+
+function tablemode#utils#MoveToLine(line) "{{{2
+  let offset = tablemode#utils#line(a:line) - line('.')
+  if offset > 0
+    execute "normal! ".offset."j"
+  elseif offset < 0
+    execute "normal! ".(-offset)."k"
+  endif
+endfunction
+
+function! tablemode#utils#SeparatorCount(str)
+  return tablemode#utils#strlen(substitute(a:str, '\V\C\(\\' . escape(g:table_mode_separator, '\') . '\|\[^' . escape(g:table_mode_separator, ']^-\') . ']\)', '', 'g'))
+endfunction

doc/table-mode.txt

@@ -75,6 +75,10 @@ Manipulation of tables:
 	3. Delete Row : Delete an entire table row using
 	|table-mode-delete-row-map|
 
+	4. Insert Column : Insert a table column either before the cursor
+        using |table-mode-insert-column-before-map| or after the cusor using
+	|table-mode-insert-column-after-map|.
+
 Table Formulas:
 	Table Mode now has support for formulas like a spreadsheet. There
 	are 2 ways of defining formulas :
@@ -165,6 +169,12 @@ Overview:
         |table-mode-realign-map| ........ Set the realign mapping
         |table-mode-delete-row-map| ..... Set the delete row mapping
         |table-mode-delete-column-map| .. Set the delete column mapping
+        |table-mode-insert-column-before-map|
+                                        Set the insert column before the
+                                        cursor mapping
+        |table-mode-insert-column-after-map|
+                                        Set the insert column after the
+                                        cursor mapping
         |table-mode-add-formula-map| .... Set the add formula mapping
         |table-mode-eval-formula-map| ... Set the eval formula mapping
         |table-mode-echo-cell-map| ...... Set the echo cell mapping
@@ -286,6 +296,16 @@ g:table_mode_delete_column_map                    *table-mode-delete-column-map*
         Set this to configure the mapping for deleting a table column. >
                 let g:table_mode_delete_column_map = '<Leader>tdc'
 >
+g:table_mode_insert_column_before_map      *table-mode-insert-column-before-map*
+        Set this to configure the mapping for inserting a table column before
+        the cursor. >
+                let g:table_mode_insert_column_before_map = '<Leader>tiC'
+>
+g:table_mode_insert_column_after_map        *table-mode-insert-column-after-map*
+        Set this to configure the mapping for inserting a table column after
+        the cursor. >
+                let g:table_mode_insert_column_after_map = '<Leader>tic'
+>
 g:table_mode_add_formula_map                        *table-mode-add-formula-map*
         Set this to configure the mapping for adding a formula for a table
         cell. >
@@ -379,6 +399,16 @@ MAPPINGS						*table-mode-mappings*
 		with a [count] to delete multiple columns to the right. You
 		can change this using |table-mode-delete-column-map| option.
 
+                                    *table-mode-mappings-insert-column-before*
+<Leader>tiC	Insert a table column before the column you are within. You can
+		preceed it with a [count] to insert multiple columns. You can
+		change this using |table-mode-insert-column-before-map| option.
+
+                                     *table-mode-mappings-insert-column-after*
+<Leader>tic	Insert a table column after the column you are within. You can
+		preceed it with a [count] to insert multiple columns. You can
+		change this using |table-mode-insert-column-after-map| option.
+
                                              *table-mode-mappings-add-formula*
 <Leader>tfa	Add a fomula for the current table cell. This invokes
 		|TableAddFormula| command.

plugin/table-mode.vim

@@ -18,7 +18,7 @@ endfunction
 call s:SetGlobalOptDefault('table_mode_corner', '+')
 call s:SetGlobalOptDefault('table_mode_verbose', 1)
 call s:SetGlobalOptDefault('table_mode_separator', '|')
-call s:SetGlobalOptDefault('table_mode_escaped_separator_regex', '\(\\\)\@<!' . g:table_mode_separator)
+call s:SetGlobalOptDefault('table_mode_escaped_separator_regex', '\V\C\\\@1<!'.escape(g:table_mode_separator, '\'))
 call s:SetGlobalOptDefault('table_mode_fillchar', '-')
 call s:SetGlobalOptDefault('table_mode_header_fillchar', '-')
 call s:SetGlobalOptDefault('table_mode_map_prefix', '<Leader>t')
@@ -40,6 +40,8 @@ call s:SetGlobalOptDefault('table_mode_cell_text_object_i_map', 'i<Bar>')
 call s:SetGlobalOptDefault('table_mode_realign_map', g:table_mode_map_prefix.'r')
 call s:SetGlobalOptDefault('table_mode_delete_row_map', g:table_mode_map_prefix.'dd')
 call s:SetGlobalOptDefault('table_mode_delete_column_map', g:table_mode_map_prefix.'dc')
+call s:SetGlobalOptDefault('table_mode_insert_column_before_map', g:table_mode_map_prefix.'iC')
+call s:SetGlobalOptDefault('table_mode_insert_column_after_map', g:table_mode_map_prefix.'ic')
 call s:SetGlobalOptDefault('table_mode_add_formula_map', g:table_mode_map_prefix.'fa')
 call s:SetGlobalOptDefault('table_mode_eval_formula_map', g:table_mode_map_prefix.'fe')
 call s:SetGlobalOptDefault('table_mode_echo_cell_map', g:table_mode_map_prefix.'?')
@@ -102,6 +104,8 @@ xnoremap <silent> <Plug>(table-mode-cell-text-object-i) :<C-U>call tablemode#spr
 
 nnoremap <silent> <Plug>(table-mode-delete-row) :<C-U>call tablemode#spreadsheet#DeleteRow()<CR>
 nnoremap <silent> <Plug>(table-mode-delete-column) :<C-U>call tablemode#spreadsheet#DeleteColumn()<CR>
+nnoremap <silent> <Plug>(table-mode-insert-column-before) :<C-U>call tablemode#spreadsheet#InsertColumn(0)<CR>
+nnoremap <silent> <Plug>(table-mode-insert-column-after) :<C-U>call tablemode#spreadsheet#InsertColumn(1)<CR>
 
 nnoremap <silent> <Plug>(table-mode-add-formula) :call tablemode#spreadsheet#formula#Add()<CR>
 nnoremap <silent> <Plug>(table-mode-eval-formula) :call tablemode#spreadsheet#formula#EvaluateFormulaLine()<CR>

t/config/options.vim

@@ -1,6 +1,6 @@
 let g:table_mode_corner = '+'
 let g:table_mode_separator = '|'
-let g:table_mode_escaped_separator_regex = '\(\\\)\@<!|'
+let g:table_mode_escaped_separator_regex = '\V\C\\\@1<!|'
 let g:table_mode_fillchar = '-'
 let g:table_mode_header_fillchar = '-'
 let g:table_mode_map_prefix = '<Leader>t'
@@ -22,6 +22,8 @@ let g:table_mode_cell_text_object_i_map = 'i<Bar>'
 let g:table_mode_realign_map = '<Leader>tr'
 let g:table_mode_delete_row_map = '<Leader>tdd'
 let g:table_mode_delete_column_map = '<Leader>tdc'
+let g:table_mode_insert_column_before_map = '<Leader>tiC'
+let g:table_mode_insert_column_after_map = '<Leader>tic'
 let g:table_mode_add_formula_map = '<Leader>tfa'
 let g:table_mode_eval_formula_map = '<Leader>tfe'
 let g:table_mode_echo_cell_map = '<Leader>t?'

t/fixtures/complex_header.txt

@@ -0,0 +1,9 @@
+|----------+----------+----------+----------|
+| counting | backward | alphabet | backward |
+|:========:+:=========+=========:+==========|
+|     1    | 9        |        a | z        |
+|     2    | 8        |        b | y        |
+|     3    | 7        |        c | x        |
+|     4    | 6        |        d | w        |
+|     5    | 5        |        e | v        |
+|----------+----------+----------+----------|

t/fixtures/escaped_seperator.txt

@@ -0,0 +1,9 @@
+|-------------------+---------------------------|
+| The \| works as   | It can be escaped by a \. |
+| a separator.      |                           |
+|                   |                           |
+| Escaping \ with   | This feature would        |
+| a \ doesn't work. | be unnecessary, because   |
+|                   | a separator must be       |
+|                   | preceded by a space.      |
+|-------------------+---------------------------|

t/spreadsheet.vim

@@ -101,6 +101,60 @@ describe 'spreadsheet'
       call tablemode#spreadsheet#DeleteColumn()
       Expect tablemode#spreadsheet#ColumnCount('.') == 1
     end
+
+    it 'should successfully insert a column before the cursor'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 2
+      call tablemode#spreadsheet#InsertColumn(0)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      Expect getline('.') == '|  | test11 | test12 |'
+    end
+
+    it 'should successfully insert a column after the cursor'
+      normal! $
+      Expect tablemode#spreadsheet#ColumnCount('.') == 2
+      call tablemode#spreadsheet#InsertColumn(1)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      Expect getline('.') == '| test11 | test12 |  |'
+    end
+  end
+
+  describe 'Manipulation of tables with headers'
+    before
+      new
+      normal! ggdG
+      let g:table_mode_header_fillchar = '='
+      read t/fixtures/complex_header.txt
+      call cursor(4, 7)
+    end
+
+    it 'should successfully delete a row '
+      Expect tablemode#spreadsheet#RowCount('.') == 5
+      call tablemode#spreadsheet#DeleteRow()
+      Expect tablemode#spreadsheet#RowCount('.') == 4
+      Expect getline(4) == '|     2    | 8        |        b | y        |'
+    end
+
+    it 'should successfully delete a column'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+      call tablemode#spreadsheet#DeleteColumn()
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      Expect getline(4) == '| 9        |        a | z        |'
+    end
+
+    it 'should successfully insert a column before the cursor'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+      call tablemode#spreadsheet#InsertColumn(0)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 5
+      Expect getline(4) == '|  |     1    | 9        |        a | z        |'
+    end
+
+    it 'should successfully insert a column after the cursor'
+      normal! $
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+      call tablemode#spreadsheet#InsertColumn(1)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 5
+      Expect getline(4) == '|     1    | 9        |        a | z        |  |'
+    end
   end
 
   describe 'Repeated Manipulations'
@@ -122,5 +176,84 @@ describe 'spreadsheet'
       .,.+1 call tablemode#spreadsheet#DeleteColumn()
       Expect tablemode#spreadsheet#ColumnCount('.') == 2
     end
+
+    it 'should insert multiple columns before the cursor correctly'
+      call cursor(2, 7)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+      execute "normal! 2:\<C-u>call tablemode#spreadsheet#InsertColumn(0)\<CR>"
+      Expect tablemode#spreadsheet#ColumnCount('.') == 6
+      Expect getline('.') == '| 1 |  |  | 9 | a | z |'
+    end
+
+    it 'should insert multiple columns after the cursor correctly'
+      call cursor(2, 7)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+      execute "normal! 2:\<C-u>call tablemode#spreadsheet#InsertColumn(1)\<CR>"
+      Expect tablemode#spreadsheet#ColumnCount('.') == 6
+      Expect getline('.') == '| 1 | 9 |  |  | a | z |'
+    end
+  end
+
+  describe 'Unicode table separators'
+    before
+      new
+      normal! ggdG
+      read t/fixtures/table/sample_realign_unicode_after.txt
+      call cursor(2, 19)
+    end
+
+    it 'should not prevent the deletion of rows'
+      Expect tablemode#spreadsheet#RowCount('.') == 4
+      call tablemode#spreadsheet#DeleteRow()
+      Expect tablemode#spreadsheet#RowCount('.') == 3
+    end
+
+    it 'should not prevent the deletion of columns'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      call tablemode#spreadsheet#DeleteColumn()
+      Expect tablemode#spreadsheet#ColumnCount('.') == 2
+    end
+
+    it 'should not prevent the insertion of columns before the cursor'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      call tablemode#spreadsheet#InsertColumn(1)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+    end
+
+    it 'should not prevent the insertion of columns after the cursor'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      call tablemode#spreadsheet#InsertColumn(1)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 4
+    end
+  end
+
+  describe 'Escaped table separators'
+    before
+      new
+      normal! ggdG
+      read t/fixtures/escaped_seperator.txt
+      call cursor(2, 3)
+    end
+
+    it 'should not prevent the deletion of rows'
+      Expect tablemode#spreadsheet#RowCount('.') == 7
+      call tablemode#spreadsheet#DeleteRow()
+      Expect tablemode#spreadsheet#RowCount('.') == 6
+      Expect getline('.') == '| a separator.      |                         |'
+    end
+
+    it 'should not prevent the deletion of columns'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 2
+      call tablemode#spreadsheet#DeleteColumn()
+      Expect tablemode#spreadsheet#ColumnCount('.') == 1
+      Expect getline('.') == '| It can be escaped by a \. |'
+    end
+
+    it 'should not prevent the insertion of columns'
+      Expect tablemode#spreadsheet#ColumnCount('.') == 2
+      call tablemode#spreadsheet#InsertColumn(1)
+      Expect tablemode#spreadsheet#ColumnCount('.') == 3
+      Expect getline('.') == '| The \| works as   |  | It can be escaped by a \. |'
+    end
   end
 end