Merge branch 'source-map' into develop

Author: thinca

autoload/themis/style/vimspec.vim

@@ -19,14 +19,18 @@ function s:parse_describe(tokens, lnum, context_stack, scope_id) abort
 
   let funcname = printf('s:themis_vimspec_scope_%d', a:scope_id)
   call add(a:context_stack, ['describe', a:lnum, funcname, a:scope_id])
-  return [
+  let result = [
   \   printf('function %s() abort', funcname),
   \   printf('let s:themis_vimspec_bundles += [%s]', bundle_new),
   \   'let s:themis_vimspec_bundles[-1]._vimspec_hooks = {}',
   \   'function s:themis_vimspec_bundles[-1]._vimspec_hooks.start_test()',
   \   printf('  call s:themis_vimspec_scopes.tmp_scope(%d)', a:scope_id),
   \   'endfunction',
   \ ]
+  return {
+  \   'result': result,
+  \   'map_pos': 1,
+  \ }
 endfunction
 
 function s:parse_example(tokens, lnum, context_stack, func_id) abort
@@ -42,14 +46,18 @@ function s:parse_example(tokens, lnum, context_stack, func_id) abort
   call add(a:context_stack, ['example', a:lnum])
   let bundle_var = 's:themis_vimspec_bundles'
   let scope_var = 's:themis_vimspec_scopes'
-  return [
+  let result = [
   \   printf('let %s[-1].suite_descriptions["T_%05d"] = %s',
   \           bundle_var, a:func_id, string(example)),
   \   printf('function %s[-1].suite.T_%05d() abort',
   \           bundle_var, a:func_id),
   \   printf('execute %s.extend("%s.scope(%d)", 0)',
   \           scope_var, scope_var, scope_id),
   \ ]
+  return {
+  \   'result': result,
+  \   'map_pos': 2,
+  \ }
 endfunction
 
 function s:parse_hook(tokens, lnum, context_stack) abort
@@ -72,12 +80,16 @@ function s:parse_hook(tokens, lnum, context_stack) abort
   call add(a:context_stack, ['hook', a:lnum, timing])
   let bundle_var = 's:themis_vimspec_bundles'
   let scope_var = 's:themis_vimspec_scopes'
-  return [
+  let result = [
   \   printf('function %s[-1]._vimspec_hooks.%s() abort',
   \           bundle_var, hook_point),
   \   printf('execute %s.extend("%s.scope(%d)", %d)',
   \           scope_var, scope_var, scope_id, copy),
   \ ]
+  return {
+  \   'result': result,
+  \   'map_pos': 1,
+  \ }
 endfunction
 
 function s:parse_end(tokens, lnum, context_stack) abort
@@ -125,6 +137,8 @@ function s:translate_script(lines) abort
   let lnum = 0
   let heredoc_endmarker = ''
 
+  let map_lines = []
+
   for line in a:lines
     let lnum += 1
 
@@ -145,24 +159,30 @@ function s:translate_script(lines) abort
 
     let tokens = matchlist(line, '^\s*\([Dd]escribe\|[Cc]ontext\)\s*\(.*\)$')
     if !empty(tokens)
-      let result +=
+      let parsed =
       \   s:parse_describe(tokens, lnum, context_stack, current_scope_id)
       let current_scope_id += 1
+      let map_lines += [[len(result) + parsed.map_pos, lnum, 'desc']]
+      let result += parsed.result
       continue
     endif
 
     let tokens = matchlist(line, '^\s*\([Ii]t\)\s*\(.*\)$')
     if !empty(tokens)
-      let result +=
+      let parsed =
       \   s:parse_example(tokens, lnum, context_stack, current_func_id)
       let current_func_id += 1
+      let map_lines += [[len(result) + parsed.map_pos, lnum, 'it']]
+      let result += parsed.result
       continue
     endif
 
     let tokens = matchlist(line,
     \                      '^\s*\([Bb]efore\|[Aa]fter\)\%(\s\+\(.*\)\)\?$')
     if !empty(tokens)
-      let result += s:parse_hook(tokens, lnum, context_stack)
+      let parsed = s:parse_hook(tokens, lnum, context_stack)
+      let map_lines += [[len(result) + parsed.map_pos, lnum, 'hook']]
+      let result += parsed.result
       continue
     endif
 
@@ -180,13 +200,14 @@ function s:translate_script(lines) abort
     throw printf('vimspec:%d:This declaration is not closed.', opened_lnum)
   endif
 
-  return result
+  return [result, map_lines]
 endfunction
 
 function s:compile_specfile(specfile_path, result_path) abort
   let slines = readfile(a:specfile_path)
-  let rlines = s:translate_script(slines)
+  let [rlines, map_lines] = s:translate_script(slines)
   call writefile(rlines, a:result_path)
+  return map_lines
 endfunction
 
 
@@ -294,8 +315,12 @@ function s:style.load_script(filename, runner) abort
   let compiled_specfile_path = tempname()
   call add(self.event._converted_files, compiled_specfile_path)
   try
-    call s:compile_specfile(a:filename, compiled_specfile_path)
+    let map_lines = s:compile_specfile(a:filename, compiled_specfile_path)
     execute 'source' fnameescape(compiled_specfile_path)
+    call themis#util#add_source_map(compiled_specfile_path, {
+    \   'original_filename': a:filename,
+    \   'map_lines': reverse(map_lines),
+    \ })
   catch /^vimspec:/
     let pat = '\v^vimspec:(\d+):(.*)'
     let [lnum, message] = matchlist(v:exception, pat)[1 : 2]

autoload/themis/util.vim

@@ -4,11 +4,12 @@
 
 let s:func_aliases = {}
 let s:line_adjuster = {}
+let s:source_maps = {}
 
 let s:StackInfo = {
 \   'stack': '',
 \   'type': '',
-\   'line': 0,
+\   'lnum': 0,
 \   'filled': 0,
 \ }
 
@@ -20,13 +21,16 @@ function s:StackInfo.fill_info() abort
   if themis#util#is_funcname(self.stack)
     call extend(self, themis#util#funcdata(self.stack), 'keep')
     let self.type = 'function'
+    call self.apply_source_map()
     return
   endif
   if filereadable(self.stack)
     let self.exists = 1
     let self.filename = self.stack
     let self.funcname = ''
     let self.type = 'file'
+
+    call self.apply_source_map()
     return
   endif
   let matched = matchlist(self.stack, '^\(\w\+\) Autocommands for \(.*\)')
@@ -43,6 +47,25 @@ function s:StackInfo.fill_info() abort
   let self.type = 'unknown'
 endfunction
 
+function s:StackInfo.apply_source_map() abort
+  let source_map = get(s:source_maps, self.filename, 0)
+  if source_map is 0
+    return
+  endif
+  let self.filename = get(source_map, 'original_filename', self.filename)
+
+  let deflnum = self.deflnum
+  let map_lines = get(source_map, 'map_lines', [])
+  if deflnum && len(map_lines) != 0
+    for [slnum, alnum; _] in map_lines
+      if slnum <= deflnum
+        let self.deflnum = alnum + (deflnum - slnum)
+        break
+      endif
+    endfor
+  endif
+endfunction
+
 function s:StackInfo.make_signature() abort
   let funcname = get(s:func_aliases, self.funcname, self.funcname)
   let args = join(self.arguments, ', ')
@@ -70,14 +93,14 @@ function s:StackInfo.format() abort
   endif
 
   if self.type ==# 'file'
-    return printf('%s Line:%d', self.filename, self.line)
+    return printf('%s Line:%d', self.filename, self.lnum)
   endif
   if self.type ==# 'function'
     let result = self.make_signature()
-    if self.line
+    if self.lnum
       let result .= '  Line:' . self.adjusted_lnum()
     endif
-    if self.defline
+    if self.deflnum
       let result .= '  [ Absolute Line: ' . self.adjusted_abs_lnum() . ' ]'
     endif
     return result . '  (' . self.filename . ')'
@@ -89,7 +112,7 @@ function s:StackInfo.format() abort
 endfunction
 
 function s:StackInfo.get_line(...) abort
-  let lnum = a:0 ? a:1 : self.line
+  let lnum = a:0 ? a:1 : self.lnum
   call self.fill_info()
   if self.type ==# 'file'
     if !has_key(self, 'body')
@@ -110,20 +133,17 @@ function s:StackInfo.get_line(...) abort
 endfunction
 
 function s:StackInfo.adjusted_lnum(...) abort
-  let lnum = a:0 ? a:1 : self.line
+  let lnum = a:0 ? a:1 : self.lnum
   let adjuster = get(s:line_adjuster, self.funcname, 0)
   return lnum + adjuster
 endfunction
 
-function s:StackInfo.adjusted_abs_lnum(...) abort
-  let lnum = a:0 ? a:1 : self.line
-  let deflnum = self.defline
-  let adjuster = get(s:line_adjuster, self.funcname, 0)
-  return lnum + deflnum + adjuster
+function s:StackInfo.adjusted_abs_lnum() abort
+  return self.adjusted_lnum() + self.deflnum
 endfunction
 
 function s:StackInfo.get_line_with_lnum(...) abort
-  let lnum = a:0 ? a:1 : self.line
+  let lnum = a:0 ? a:1 : self.lnum
   let line = self.get_line(lnum)
   return printf('%3d: %s', self.adjusted_lnum(lnum), line)
 endfunction
@@ -141,7 +161,7 @@ function themis#util#stack_info(stack) abort
       let matched = matchlist(a:stack, pat)
       if !empty(matched)
         let info.stack = matched[1]
-        let info.line = matched[2] - 0
+        let info.lnum = matched[2] - 0
       endif
     endfor
   endif
@@ -179,6 +199,11 @@ function themis#util#adjust_func_line(target, line) abort
   endif
 endfunction
 
+function themis#util#add_source_map(filename, source_map) abort
+  let filename = substitute(a:filename, '[/\\]\+', '/', 'g')
+  let s:source_maps[filename] = a:source_map
+endfunction
+
 function themis#util#callstacklines(throwpoint, ...) abort
   let infos = call('themis#util#callstack', [a:throwpoint] + a:000)
   return map(infos, 'v:val.format()')
@@ -228,7 +253,7 @@ function themis#util#funcdata(func) abort
   let signature = matchstr(lines[0], '^\s*\zs.*')
   let file = matchstr(lines[1], '^\t\%(Last set from\|.\{-}:\)\s*\zs.*$')
   let file = substitute(file, '[/\\]\+', '/', 'g')
-  let defline = str2nr(matchstr(file, '\d\+$'))
+  let deflnum = str2nr(matchstr(file, '\d\+$'))
   " XXX: Remove ' line 10' at tail.  But the message may be translated.
   "      This can fail in some languages.
   let file = substitute(file, ' \S\+ \d\+$', '', '')
@@ -239,7 +264,7 @@ function themis#util#funcdata(func) abort
   \   'exists': 1,
   \   'filename': file,
   \   'funcname': func,
-  \   'defline': defline,
+  \   'deflnum': deflnum,
   \   'signature': signature,
   \   'arguments': arguments,
   \   'arity': arity,
@@ -255,7 +280,7 @@ endfunction
 function themis#util#error_info(stacktrace) abort
   let tracelines = map(copy(a:stacktrace), 'v:val.format()')
   let tail = a:stacktrace[-1]
-  if tail.line
+  if tail.lnum
     let tracelines += [tail.get_line_with_lnum()]
   endif
   return join(tracelines, "\n")

test/style/vimspec/source_map.vimspec

@@ -0,0 +1,34 @@
+Describe vimspec-style
+  Describe source_map
+    Before
+      try
+        throw 'hook'  " Here is line 5 in file
+      catch
+        let hook_point = v:throwpoint
+      endtry
+    End
+
+    It treats correct line number
+      try
+        throw 'error'  " Here is line 13 in file
+      catch
+        let throwpoint = v:throwpoint
+      endtry
+      let stacks = themis#util#parse_callstack(throwpoint)
+      let last_stack = stacks[-1]
+      call last_stack.fill_info()
+      Assert Equals(fnamemodify(last_stack.filename, ':t'), 'source_map.vimspec')
+      Assert Equals(last_stack.adjusted_lnum(), 2)
+      Assert Equals(last_stack.adjusted_abs_lnum(), 13)
+    End
+
+    It treats correct line number in hook
+      let stacks = themis#util#parse_callstack(hook_point)
+      let last_stack = stacks[-1]
+      call last_stack.fill_info()
+      Assert Equals(fnamemodify(last_stack.filename, ':t'), 'source_map.vimspec')
+      Assert Equals(last_stack.adjusted_lnum(), 2)
+      Assert Equals(last_stack.adjusted_abs_lnum(), 5)
+    End
+  End
+End

test/util.vimspec

@@ -41,25 +41,25 @@ Describe util
     It can parse tail line number
       let info = themis#util#stack_info('<SNR>567_foo, line 5')
       Assert Equals(info.stack, '<SNR>567_foo')
-      Assert Equals(info.line, 5)
+      Assert Equals(info.lnum, 5)
     End
 
     It can parse nested function line number
       let info = themis#util#stack_info('<SNR>567_foo[5]')
       Assert Equals(info.stack, '<SNR>567_foo')
-      Assert Equals(info.line, 5)
+      Assert Equals(info.lnum, 5)
     End
 
     It accepts old stacktrace
       let info = themis#util#stack_info('<SNR>567_foo')
       Assert Equals(info.stack, '<SNR>567_foo')
-      Assert Equals(info.line, 0)
+      Assert Equals(info.lnum, 0)
     End
 
     It can treat autocmd entry
       let info = themis#util#stack_info('FileType Autocommands for "vim"')
       Assert Equals(info.stack, 'FileType Autocommands for "vim"')
-      Assert Equals(info.line, 0)
+      Assert Equals(info.lnum, 0)
     End
   End
 
@@ -68,11 +68,11 @@ Describe util
       let stacks = themis#util#parse_callstack(ExecuteCmd('return expand("<sfile>")'))
       for stack in stacks
         Assert HasKey(stack, 'stack')
-        Assert HasKey(stack, 'line')
+        Assert HasKey(stack, 'lnum')
       endfor
       let laststack = stacks[-1]
       Assert Equals(laststack.stack, 'ExecuteCmd')
-      Assert Equals(laststack.line, 0)
+      Assert Equals(laststack.lnum, 0)
     End
 
     It can parse throwpoint
@@ -83,11 +83,11 @@ Describe util
       endtry
       for stack in stacks
         Assert HasKey(stack, 'stack')
-        Assert HasKey(stack, 'line')
+        Assert HasKey(stack, 'lnum')
       endfor
       let laststack = stacks[-1]
       Assert Equals(laststack.stack, 'ExecuteCmd')
-      Assert Equals(laststack.line, 1)
+      Assert Equals(laststack.lnum, 1)
     End
   End