major cleanup/tidy/bugfix

Author: Gaspar Chilingarov

CHEATSHEET.md

@@ -15,10 +15,8 @@ shortcuts/commands:
     * `<Ctrl-v>` opens selected files in vertical split
     * `<Ctrl-s>` opens selected files in horizontal split
 
- * `<Leader>xt` opens correlative source/test file
- * `<Leader>xs` opens correlative source/test file in horizontal split
- * `<Leader>xv` opens correlative source/test file in vertical split
- * `<Leader>x!` opens correlative source/test, creates directories if necessary
+ * `<Leader>tt` finds and opens correlative source/test file.
+   See more shortcuts in **ExUnit** section below.
 
  **In file**
  * `<F1>` shows Elixir docs for function under cursor.
@@ -47,6 +45,7 @@ shortcuts/commands:
  * `<Enter>` or click on function name takes you to function definition.
  * `<p>` on function name takes you to function definition, but focus stays in tagbar.
  * `<P>` on function name opens function in preview window.
+ * `<Ctrl-W><Ctrl-Z>` or `:pc` close preview window.
 
  More on [tagbar page](https://majutsushi.github.io/tagbar/).
 
@@ -104,8 +103,9 @@ shortcuts/commands:
 
 #### Tracing
  * `<Leader>te` execute ExUnit test under cursor with tracing and window with
-   trace output
- * `<Leader>ts` execute selected text with tracing and show trace
+   trace output (mnemonics: Trace Exunit)
+ * `<Leader>ty` execute selected text with tracing and show trace (mnemonics:
+   Trace Yanked).
 
  **In trace window**
  * `<Enter>` opens file with module/function under cursor and changes window

README.md

@@ -248,7 +248,7 @@ Following commands and shortcuts are available:
 
  * `ErlTraceTest` or `<Leader>te` runs ExUnit test under cursor with tracing
    enabled and shows resulting trace in separate window.
- * `ErlTraceSelection` or `<Leader>ts` runs selected test with tracing enabled
+ * `ErlTraceSelection` or `<Leader>ty` runs selected test with tracing enabled
    and shows resulting trace in separate window.
 
  In tracing window there are shortcuts available:

ROADMAP.md

@@ -12,7 +12,7 @@ Items marked with x are done.
    * test on our team first ;)))
 
 ## Functionality
- * make it load w/reasonable defaults in empty vim (top)
+ x make it load w/reasonable defaults in empty vim (top)
  * add tpope/sensibleDefaults plugin
  x add indentLine plugin to bundle (top)
  x setup Hack font for GUI + size changes
@@ -45,10 +45,10 @@ Items marked with x are done.
 
 ## Debuging & developing
  * generate trace files and nicely show them
-   * run test clause and record call/return values/messages trace
-   * syntax/highlighting for trace file
-   * allow jumping to functions/clauses in trace/profile files
-   * shortcuts to trace selection/test
+   x run test clause and record call/return values/messages trace
+   x syntax/highlighting for trace file
+   x allow jumping to functions/clauses in trace/profile files
+   x shortcuts to trace selection/test
    * run test clause and record line-by-line execution trace using debugger (low)
  * run test clause and record fprof for it
  * syntax highlight for fprof dump file

autoload/vimide.vim

@@ -4,6 +4,17 @@
 
 let s:VIMIDE_BOOT_FINISHED = 0
 
+let s:rootPath = fnamemodify(resolve(expand('<sfile>:p')), ':h:h')
+let s:bundlePath = s:rootPath . "/bundle"
+
+function! vimide#getRootPath() " {{{
+  return s:rootPath
+endfunction " }}}
+
+function! vimide#getBundlePath() " {{{
+  return s:bundlePath
+endfunction " }}}
+
 function! vimide#setDefaults() " {{{
   call s:setGlobal('g:vimide_global_enable', 0)
   call s:setGlobal('g:vimide_manage_indents', 1)
@@ -43,6 +54,7 @@ function! vimide#setDefaults() " {{{
   call s:setGlobal('g:vimide_install_comment_shortcuts', 1)
   call s:setGlobal('g:vimide_install_align_shortcuts', 1)
   call s:setGlobal('g:vimide_install_other_shortcuts', 1)
+  call s:setGlobal('g:vimide_install_elixir_shortcuts', 1)
   call s:setGlobal('g:vimide_manage_misc_settings', 1)
   call s:setGlobal('g:vimide_install_hack_font', 1)
 endfunction " }}}
@@ -56,7 +68,10 @@ function! vimide#init() " {{{
 endfunction " }}}
 
 function! vimide#boot(setGlobal) " {{{
-  if !s:VIMIDE_BOOT_FINISHED
+  let bootVarName = (a:setGlobal ? "s:VIMIDE_BOOT_FINISHED" : "b:VIMIDE_BOOT_FINISHED")
+  let bootFinished =  s:VIMIDE_BOOT_FINISHED || (exists(bootVarName) && execute("echo ".bootVarName) == 1)
+
+  if !bootFinished
     if g:vimide_colorscheme != ''         | call vimide#setColorscheme(a:setGlobal)          | endif
     if g:vimide_manage_encoding           | call vimide#setVimEncodingSettings(a:setGlobal)  | endif
     if g:vimide_manage_indents            | call vimide#setIndentSettings(a:setGlobal)       | endif
@@ -74,10 +89,12 @@ function! vimide#boot(setGlobal) " {{{
     if g:vimide_install_other_shortcuts   | call vimide#setOtherShortcuts(a:setGlobal)       | endif
     if g:vimide_install_hack_font         | call vimide#setHackFont(a:setGlobal)             | endif
     if g:vimide_manage_misc_settings      | call vimide#setMiscSettings(a:setGlobal)         | endif
-    let s:VIMIDE_BOOT_FINISHED = 1
+    execute("let " . bootVarName . "= 1")
   endif
 
   if &filetype == 'elixir'
+    " filetype specific initialization goes here, but it is basically very
+    " small piece of code
     call vimide#elixir#boot()
   endif
 
@@ -231,9 +248,7 @@ function! vimide#setIndentLineSettigns(setGlobal) "{{{
     " let g:indentLine_char = '⎥' straigh line
     " let g:indentLine_char = '⎸' (needs FreeSerif)
   else
-    " TODO: add BufferEnter/Exit logic to toggle indentLine only in elixir
-    " buffers
-    let pass = 1
+    nnoremap <silent> <buffer> <C-K><C-I> :IndentLinesToggle<CR>
   endif
 endfunction "}}}
 
@@ -295,6 +310,8 @@ function! vimide#setCommentShortcuts(setGlobal) " {{{
   " we want comments to be nicely aligned under each other and not follow
   " indentation
   let g:NERDDefaultAlign = "left"
+  let g:NERDCommentEmptyLines = 1
+
   " TODO: think of possibility leaving commented area in visual selected mode
   " (if it is good idea at all :)
   if a:setGlobal
@@ -330,22 +347,41 @@ function! vimide#setTabularizeShortcuts(setGlobal) " {{{
   " ####################################################################
   " Integration with Tabularize
 
+  " TODO: may be remove all indenting funcitonality alltogether, as it may be
+  " extremely annoying
+
   if a:setGlobal
     " tabularize both => and =
-    map <Leader>= =:Tabularize /=><CR>
-    map <Leader>eq =:Tabularize /=/<CR>
+    nmap <Leader>= ==:Tabularize /=><CR>
+    nmap <Leader>eq ==:Tabularize /=/<CR>
     " tabularize case clauses
-    map <Leader>- =:Tabularize /-><CR>
+    nmap <Leader>- ==:Tabularize /-><CR>
     " tabularize : in hashmaps and similar
-    map <Leader>: =:Tabularize /\v(:)@<=\s/l0<CR>
+    nmap <Leader>: ==:Tabularize /\v(:)@<=\s/l0<CR>
+
+    " tabularize both => and =
+    vmap <Leader>= =:'<,'>Tabularize /=><CR>
+    vmap <Leader>eq =:'<,'>Tabularize /=/<CR>
+    " tabularize case clauses
+    vmap <Leader>- =:'<,'>Tabularize /-><CR>
+    " tabularize : in hashmaps and similar
+    vmap <Leader>: =:'<,'>Tabularize /\v(:)@<=\s/l0<CR>
   else
     " tabularize both => and =
-    map <buffer> <Leader>= =:Tabularize /=><CR>
-    map <buffer> <Leader>eq =:Tabularize /=/<CR>
+    nmap <buffer> <Leader>= ==:Tabularize /=><CR>
+    nmap <buffer> <Leader>eq ==:Tabularize /=/<CR>
     " tabularize case clauses
-    map <buffer> <Leader>- =:Tabularize /-><CR>
+    nmap <buffer> <Leader>- ==:Tabularize /-><CR>
     " tabularize : in hashmaps and similar
-    map <buffer> <Leader>: =:Tabularize /\v(:)@<=\s/l0<CR>
+    nmap <buffer> <Leader>: ==:Tabularize /\v(:)@<=\s/l0<CR>
+
+    " tabularize both => and =
+    vmap <buffer> <Leader>= =:'<,'>Tabularize /=><CR>
+    vmap <buffer> <Leader>eq =:'<,'>Tabularize /=/<CR>
+    " tabularize case clauses
+    vmap <buffer> <Leader>- =:'<,'>Tabularize /-><CR>
+    " tabularize : in hashmaps and similar
+    vmap <buffer> <Leader>: =:'<,'>Tabularize /\v(:)@<=\s/l0<CR>
   endif
 endfunction " }}}
 
@@ -382,7 +418,6 @@ function! vimide#setOtherShortcuts(setGlobal) " {{{
     map <C-K><C-l> :exec 'match NonText /\<' . expand("<cword>") . '\>/'<CR>
 
     " delete buffer and keep split
-    " cannot have it local
     cab bdd bp\|bd #
 
     " refactoring support
@@ -435,6 +470,9 @@ function! vimide#setOtherShortcuts(setGlobal) " {{{
     nmap <buffer> <F2> :w<CR>
     imap <buffer> <F2> <Esc>:w<CR>a
 
+    " delete buffer and keep split
+    cab <buffer> bdd bp\|bd #
+
     " lookup item under the cursor in file and show the list of
     " entries
     "
@@ -529,6 +567,7 @@ function! vimide#stripTrailingWhitespace() " {{{
   call winrestview(l:save)
 endfunction " }}}
 
+" TODO: consolidate in lib
 function! s:setGlobal(name, default) " {{{
   if !exists(a:name)
     if type(a:name) == 0 || type(a:name) == 5

autoload/vimide/elixir.vim

@@ -1,4 +1,164 @@
+function! vimide#elixir#boot()
+  call s:setGlobal('g:alchemist#elixir_erlang_src', vimide#getRootPath() . "/sources")
 
-function vimide#elixir#boot()
   setlocal wildignore+=*.beam
+  if g:vimide_install_elixir_shortcuts   | call vimide#elixir#setOtherShortcuts() | endif
+
+  call vimide#elixir#installTagbarIntegration()
+endfunction
+
+function! vimide#elixir#setOtherShortcuts()
+  " ####################################################################
+  " integration with vim-alchemist
+  nnoremap <buffer> <silent> <F1> :call alchemist#exdoc()<CR>
+endfunction
+
+"let g:ConqueTerm_CloseOnEnd=1
+"let g:alchemist_iex_term_size = 15
+
+function! vimide#elixir#tagbarFilter(tags) " {{{
+  " remove OTP callbacks from ordinary function list
+  call filter(a:tags, ' !(v:val.fields.kind == "f" && v:val.name =~ "\\v(handle_call|handle_info|handle_cast|init|terminate)") ')
+
+  function! Arity_extract(idx, tag)
+    if a:tag.fields.kind == 'f' || a:tag.fields.kind == 'g'
+      let args_string = substitute(a:tag.pattern, "^.*defp\\?[ \t]*".a:tag.name."[ \t]*", "", "")
+      let args_string = substitute(args_string, "do[ \t]*\\\\[$]$", "", "") " multiline
+"      TODO: remove
+"      if a:tag.pattern =~ "defp reply"
+"        debug echo("asd")
+"      endif
+      let args_string = substitute(args_string, ")\\([ \t]*when.*\\)\\?,[ \t]*do.*\\\\[$]$", ")", "")
+      let args_string = substitute(args_string, "[ \t]*", "", "g")
+
+      let args_len = len(args_string)
+
+      if args_len == 0
+        let a:tag.name = a:tag.name."/0"
+      else
+        let old_args_len = -10000
+        while args_len != old_args_len
+          let args_string = substitute(args_string, "{[^}]*}", "", "g")
+          let args_string = substitute(args_string, "\\[[^]]*\\]", "", "g")
+          let old_args_len = args_len
+          let args_len = len(args_string)
+        endwhile
+
+        let comma_count = len(substitute(args_string, "[^,]", "", "g"))
+        let a:tag.name = a:tag.name . "/" . (comma_count + 1)
+      endif
+
+      return a:tag
+    else
+      return a:tag
+    endif
+  endfunction
+
+  " replaces function names with function_name/arity notation
+  call map(a:tags, function('Arity_extract'))
+
+  let seen_list = map(copy(a:tags), '[v:val.fields.kind, v:val.name, v:val.fields.line]')
+
+  let seen_fnames = {}
+  for [kind, fname, line] in seen_list
+    if ! has_key(seen_fnames, kind.fname)
+      let seen_fnames[kind.fname] = line
+    endif
+  endfor
+
+  " leaves only first definition of function with same arity
+  function! Filter_fun(seen_hash, idx, tag)
+    let key = a:tag.fields.kind . a:tag.name
+    let line = a:tag.fields.line
+
+    return a:seen_hash[key] == line
+  endfunction
+
+  call filter(a:tags, function('Filter_fun', [seen_fnames]))
+
+  return a:tags
+endfunction " }}}
+
+function! vimide#elixir#installTagbarIntegration()
+  " ####################################################################
+  " integration with Tagbar
+  "
+
+  let g:tagbar_type_elixir = {
+        \ 'ctagstype' : 'elixir',
+        \ 'deffile' : vimide#getRootPath() . '/extras/elixir-ctags/.ctags',
+        \ 'transform': function("vimide#elixir#tagbarFilter"),
+        \ 'kinds' : [
+        \ 'm:modules:1',
+        \ 'O:OTP callbacks',
+        \ 't:tests',
+        \ 'f:functions (public)',
+        \ 'g:functions (private)',
+        \ 'c:callbacks',
+        \ 'd:delegates',
+        \ 'e:exceptions',
+        \ 'i:implementations',
+        \ 'a:macros',
+        \ 'o:operators',
+        \ 's:structs',
+        \ 'p:protocols',
+        \ 'r:records',
+        \ 'T:types',
+        \ 'z:foo'
+        \ ]
+        \ }
+
 endfunction
+
+
+"function! ErlBalloonExpr()
+"	"	return 'Cursor is at line ' . v:beval_lnum .
+"	"	\', column ' . v:beval_col .
+"	"	\ ' of file ' .  bufname(v:beval_bufnr) .
+"	"	\ ' on word "' . v:beval_text . '"'
+"
+"	let text = alchemist#get_doc(v:beval_text)
+"	return text
+"endfunction
+"
+"set bexpr=ErlBalloonExpr()
+"set ballooneval
+
+"map <F12> :IEx<CR>
+
+" TODO: for future work
+" ####################################################################
+" Elixir cross reference
+"
+"  mix xref callers Mod
+"  mix xref callers Mod.Fun
+"  mix xref callers Mod.Fun/Arity
+"
+"  which files are called/included
+"  mix xref graph --source lib/feed/betco_pusher/stream/api.ex --format pretty
+"
+"  which files call/include this one
+"  mix xref graph --sink lib/feed/betco_pusher/stream/api.ex --format pretty
+"
+"  mix xref unreachable
+"  mix xref warnings
+"
+
+function! s:ShowXRef()
+  " does not work well right now :)
+  let a=alchemist#get_current_module_details()['module']['name']
+  let b=tagbar#currenttag('%s', '')
+  let c=a.".".b
+  exec "Mix xref callers ".c
+endfunction
+
+" TODO: consolidate in lib
+function! s:setGlobal(name, default) " {{{
+  if !exists(a:name)
+    if type(a:name) == 0 || type(a:name) == 5
+      exec "let " . a:name . " = " . a:default
+    elseif type(a:name) == 1
+      exec "let " . a:name . " = '" . escape(a:default, "\'") . "'"
+    endif
+  endif
+endfunction " }}}