From 46c859c8a10b9f420cc73087182f0c9a6b272f71 Mon Sep 17 00:00:00 2001 From: Ciro Santilli Date: Mon, 23 Feb 2015 08:05:46 +0100 Subject: [PATCH] gx works from anywhere inside Markdown links. Fix #99. --- README.md | 33 ++++++++++++++--- ftplugin/mkd.vim | 96 ++++++++++++++++++++++++++++++++++++++++++++++++ test/map.vader | 48 ++++++++++++++++++++++++ 3 files changed, 171 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0a652fa..8389667 100644 --- a/README.md +++ b/README.md @@ -97,12 +97,33 @@ let g:vim_markdown_frontmatter=1 The following work on normal and visual modes: -- `]]`: go to next header. `(Markdown_MoveToNextHeader)` -- `[[`: go to previous header. Contrast with `]c`. `(Markdown_MoveToPreviousHeader)` -- `][`: go to next sibling header if any. `(Markdown_MoveToNextSiblingHeader)` -- `[]`: go to previous sibling header if any. `(Markdown_MoveToPreviousSiblingHeader)` -- `]c`: go to Current header. `(Markdown_MoveToCurHeader)` -- `]u`: go to parent header (Up). `(Markdown_MoveToParentHeader)` +- `gx`: open the link under the cursor in the same browser as the standard `gx` command. + + The standard `gx` is extended by allowing you to put your cursor anywhere inside a link. + + For example, all the following cursor positions will work: + + [Example](http://example.com) + ^ ^ ^^ ^ ^ + 1 2 34 5 6 + + + ^ ^ ^ + 1 2 3 + + Known limitation: does not work for links that span multiple lines. + +- `]]`: go to next header. `(Markdown_MoveToNextHeader)` + +- `[[`: go to previous header. Contrast with `]c`. `(Markdown_MoveToPreviousHeader)` + +- `][`: go to next sibling header if any. `(Markdown_MoveToNextSiblingHeader)` + +- `[]`: go to previous sibling header if any. `(Markdown_MoveToPreviousSiblingHeader)` + +- `]c`: go to Current header. `(Markdown_MoveToCurHeader)` + +- `]u`: go to parent header (Up). `(Markdown_MoveToParentHeader)` ## Commands diff --git a/ftplugin/mkd.vim b/ftplugin/mkd.vim index 63d7914..a2e7b5e 100644 --- a/ftplugin/mkd.vim +++ b/ftplugin/mkd.vim @@ -411,6 +411,100 @@ function! s:TableFormat() call setpos('.', l:pos) endfunction +" Parameters: +" +" - step +1 for right, -1 for left +" +" TODO: multiple lines. +" +function! s:FindCornerOfSyntax(lnum, col, step) + let l:col = a:col + let l:syn = synIDattr(synID(a:lnum, l:col, 1), 'name') + while synIDattr(synID(a:lnum, l:col, 1), 'name') ==# l:syn + let l:col += a:step + endwhile + return l:col - a:step +endfunction + +" Return the next position of the given syntax name, +" inclusive on the given position. +" +" TODO: multiple lines +" +function! s:FindNextSyntax(lnum, col, name) + let l:col = a:col + let l:step = 1 + while synIDattr(synID(a:lnum, l:col, 1), 'name') !=# a:name + let l:col += l:step + endwhile + return [a:lnum, l:col] +endfunction + +function! s:FindCornersOfSyntax(lnum, col) + return [FindLeftOfSyntax(a:lnum, a:col), FindRightOfSyntax(a:lnum, a:col)] +endfunction + +function! s:FindRightOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, 1) +endfunction + +function! s:FindLeftOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, -1) +endfunction + +" Returns: +" +" - a string with the the URL for the link under the cursor +" - an empty string if the cursor is not on a link +" +" `b:` instead of `s:` to make it testable. +" +" TODO +" +" - multiline support +" - give an error if the separator does is not on a link +" +function! b:Markdown_GetUrlForPosition(lnum, col) + let l:lnum = a:lnum + let l:col = a:col + let l:syn = synIDattr(synID(l:lnum, l:col, 1), 'name') + + if l:syn ==# 'mkdInlineURL' || l:syn ==# 'mkdURL' || l:syn ==# 'mkdLinkDefTarget' + " Do nothing. + elseif l:syn ==# 'mkdLink' + let [l:lnum, l:col] = FindNextSyntax(l:lnum, l:col, 'mkdURL') + let l:syn = 'mkdURL' + elseif l:syn ==# 'mkdDelimiter' + let l:line = getline(l:lnum) + let l:char = l:line[col - 1] + if l:char ==# '<' + let l:col += 1 + elseif l:char ==# '>' || l:char ==# ')' + let l:col -= 1 + elseif l:char ==# '[' || l:char ==# ']' || l:char ==# '(' + let [l:lnum, l:col] = FindNextSyntax(l:lnum, l:col, 'mkdURL') + else + return '' + endif + else + return '' + endif + + let [l:left, l:right] = FindCornersOfSyntax(l:lnum, l:col) + return getline(l:lnum)[l:left - 1 : l:right - 1] +endfunction + +" Front end for GetUrlForPosition. +" +function! s:OpenUrlUnderCursor() + let l:url = b:Markdown_GetUrlForPosition(line('.'), col('.')) + if l:url != '' + call netrw#NetrwBrowseX(l:url, 0) + else + echomsg 'The cursor is not on a link.' + endif +endfunction + call MapNormVis('(Markdown_MoveToNextHeader)', 'Markdown_MoveToNextHeader') call MapNormVis('(Markdown_MoveToPreviousHeader)', 'Markdown_MoveToPreviousHeader') call MapNormVis('(Markdown_MoveToNextSiblingHeader)', 'Markdown_MoveToNextSiblingHeader') @@ -419,6 +513,7 @@ call MapNormVis('(Markdown_MoveToPreviousSiblingHeader)', 'Markd call MapNormVis('(Markdown_MoveToParentHeader)', 'Markdown_MoveToParentHeader') " Menmonic: Current call MapNormVis('(Markdown_MoveToCurHeader)', 'Markdown_MoveToCurHeader') +nnoremap (OpenUrlUnderCursor) :call OpenUrlUnderCursor() if !get(g:, 'vim_markdown_no_default_key_mappings', 0) nmap ]] (Markdown_MoveToNextHeader) @@ -427,6 +522,7 @@ if !get(g:, 'vim_markdown_no_default_key_mappings', 0) nmap [] (Markdown_MoveToPreviousSiblingHeader) nmap ]u (Markdown_MoveToParentHeader) nmap ]c (Markdown_MoveToCurHeader) + nmap gx (OpenUrlUnderCursor) vmap ]] (Markdown_MoveToNextHeader) vmap [[ (Markdown_MoveToPreviousHeader) diff --git a/test/map.vader b/test/map.vader index 6cf0cee..51bde78 100644 --- a/test/map.vader +++ b/test/map.vader @@ -1,3 +1,51 @@ +Given mkd; +a c + +Execute (gx autolink): + let b:url = 'http://b' + let b:line = getline(1) + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'a') + 1), '' + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, '<') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'h') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, '>') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'c') + 1), '' + +Given mkd; +a http://b.bb c + +Execute (gx implicit autolink): + let b:url = 'http://b.bb' + let b:line = getline(1) + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'a') + 1), '' + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'h') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'c') + 1), '' + +Given mkd; +[a]: http://b "c" + +Execute (gx link reference definition): + let b:url = 'http://b' + let b:line = getline(1) + " TODO would be cool if all of the following gave the link. + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'a') + 1), '' + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'h') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'c') + 1), '' + +Given mkd; +a [b](c) d + +Execute (gx autolink): + let b:url = 'c' + let b:line = getline(1) + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'a') + 1), '' + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, '[') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'b') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, ']') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, '(') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'c') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, ')') + 1), b:url + AssertEqual b:Markdown_GetUrlForPosition(1, match(b:line, 'd') + 1), '' + Given mkd; # a -- 2.39.5