" vim:tabstop=2:shiftwidth=2:expandtab:foldmethod=marker:textwidth=79 " Vimwiki autoload plugin file " Desc: Basic functionality " Home: https://github.com/vimwiki/vimwiki/ if exists("g:loaded_vimwiki_auto") || &cp finish endif let g:loaded_vimwiki_auto = 1 " s:vimwiki_get_known_syntaxes function! s:vimwiki_get_known_syntaxes() " {{{ " Getting all syntaxes that different wikis could have let syntaxes = {} let syntaxes['default'] = 1 for wiki in g:vimwiki_list if has_key(wiki, 'syntax') let syntaxes[wiki.syntax] = 1 endif endfor " append map g:vimwiki_ext2syntax for syn in values(g:vimwiki_ext2syntax) let syntaxes[syn] = 1 endfor return keys(syntaxes) endfunction " }}} " vimwiki#base#apply_wiki_options function! vimwiki#base#apply_wiki_options(options) " {{{ Update the current " wiki using the options dictionary for kk in keys(a:options) let g:vimwiki_list[g:vimwiki_current_idx][kk] = a:options[kk] endfor call Validate_wiki_options(g:vimwiki_current_idx) call vimwiki#base#setup_buffer_state(g:vimwiki_current_idx) endfunction " }}} " vimwiki#base#read_wiki_options function! vimwiki#base#read_wiki_options(check) " {{{ Attempt to read wiki " options from the current page's directory, or its ancesters. If a file " named vimwiki.vimrc is found, which declares a wiki-options dictionary " named g:local_wiki, a message alerts the user that an update has been " found and may be applied. If the argument check=1, the user is queried " before applying the update to the current wiki's option. " Save global vimwiki options ... after all, the global list is often " initialized for the first time in vimrc files, and we don't want to " overwrite !! (not to mention all the other globals ...) let l:vimwiki_list = deepcopy(g:vimwiki_list, 1) " if a:check > 1 call vimwiki#base#print_wiki_state() echo " \n" endif " let g:local_wiki = {} let done = 0 " ... start the wild-goose chase! for invsubdir in ['.', '..', '../..', '../../..'] " other names are possible, but most vimrc files will cause grief! for nm in ['vimwiki.vimrc'] " TODO: use an alternate strategy, instead of source, to read options if done continue endif " let local_wiki_options_filename = expand('%:p:h').'/'.invsubdir.'/'.nm if !filereadable(local_wiki_options_filename) continue endif " echo "\nFound file : ".local_wiki_options_filename let query = "Vimwiki: Check for options in this file [Y]es/[n]o? " if a:check > 0 && input(query) =~? '^n') continue endif " try execute 'source '.local_wiki_options_filename catch endtry if empty(g:local_wiki) continue endif " if a:check > 0 echo "\n\nFound wiki options\n g:local_wiki = ".string(g:local_wiki) let query = "Vimwiki: Apply these options [Y]es/[n]o? " if input(query) =~? '^n' let g:local_wiki = {} continue endif endif " " restore global list " - this prevents corruption by g:vimwiki_list in options_file let g:vimwiki_list = deepcopy(l:vimwiki_list, 1) " call vimwiki#base#apply_wiki_options(g:local_wiki) let done = 1 endfor endfor if !done " " restore global list, if no local options were found " - this prevents corruption by g:vimwiki_list in options_file let g:vimwiki_list = deepcopy(l:vimwiki_list, 1) " endif if a:check > 1 echo " \n " if done call vimwiki#base#print_wiki_state() else echo "Vimwiki: No options were applied." endif endif endfunction " }}} " vimwiki#base#setup_buffer_state function! vimwiki#base#setup_buffer_state(idx) " {{{ Init page-specific variables " Only call this function *after* opening a wiki page. if a:idx < 0 return endif let g:vimwiki_current_idx = a:idx " The following state depends on the current active wiki page let subdir = vimwiki#base#current_subdir(a:idx) call VimwikiSet('subdir', subdir, a:idx) call VimwikiSet('invsubdir', vimwiki#base#invsubdir(subdir), a:idx) if g:vimwiki_auto_chdir == 1 exe 'lcd' VimwikiGet('path') endif " update cache call vimwiki#base#cache_buffer_state() endfunction " }}} " vimwiki#base#cache_buffer_state function! vimwiki#base#cache_buffer_state() "{{{ if !exists('g:vimwiki_current_idx') && g:vimwiki_debug echo "[Vimwiki Internal Error]: Missing global state variable: 'g:vimwiki_current_idx'" endif let b:vimwiki_idx = g:vimwiki_current_idx endfunction "}}} " vimwiki#base#recall_buffer_state function! vimwiki#base#recall_buffer_state() "{{{ if !exists('b:vimwiki_idx') if g:vimwiki_debug echo "[Vimwiki Internal Error]: Missing buffer state variable: 'b:vimwiki_idx'" endif return 0 else let g:vimwiki_current_idx = b:vimwiki_idx return 1 endif endfunction " }}} " vimwiki#base#print_wiki_state function! vimwiki#base#print_wiki_state() "{{{ print wiki options " and buffer state variables let g_width = 18 let b_width = 18 echo "- Wiki Options (idx=".g:vimwiki_current_idx.") -" for kk in VimwikiGetOptionNames() echo " '".kk."': ".repeat(' ', g_width-len(kk)).string(VimwikiGet(kk)) endfor if !exists('b:vimwiki_list') return endif echo "- Cached Variables -" for kk in keys(b:vimwiki_list) echo " '".kk."': ".repeat(' ', b_width-len(kk)).string(b:vimwiki_list[kk]) endfor endfunction "}}} " vimwiki#base#file_pattern function! vimwiki#base#file_pattern(files) "{{{ Get search regex from glob() " string. Aim to support *all* special characters, forcing the user to choose " names that are compatible with any external restrictions that they " encounter (e.g. filesystem, wiki conventions, other syntaxes, ...). " See: http://code.google.com/p/vimwiki/issues/detail?id=316 " Change / to [/\\] to allow "Windows paths" return '\V\%('.join(a:files, '\|').'\)\m' endfunction "}}} " vimwiki#base#subdir "FIXME TODO slow and faulty function! vimwiki#base#subdir(path, filename) "{{{ let g:VimwikiLog.subdir += 1 "XXX let path = a:path " ensure that we are not fooled by a symbolic link "FIXME if we are not "fooled", we end up in a completely different wiki? if a:filename !~# '^scp:' let filename = resolve(a:filename) else let filename = a:filename endif let idx = 0 "FIXME this can terminate in the middle of a path component! while path[idx] ==? filename[idx] let idx = idx + 1 endwhile let p = split(strpart(filename, idx), '[/\\]') let res = join(p[:-2], '/') if len(res) > 0 let res = res.'/' endif return res endfunction "}}} " vimwiki#base#current_subdir function! vimwiki#base#current_subdir(idx)"{{{ return vimwiki#base#subdir(VimwikiGet('path', a:idx), expand('%:p')) endfunction"}}} " vimwiki#base#invsubdir function! vimwiki#base#invsubdir(subdir) " {{{ return substitute(a:subdir, '[^/\.]\+/', '../', 'g') endfunction " }}} " Returns: the number of the wiki a file belongs to function! vimwiki#base#find_wiki(path) "{{{ let path = vimwiki#path#path_norm(vimwiki#path#chomp_slash(a:path)) let idx = 0 while idx < len(g:vimwiki_list) let idx_path = expand(VimwikiGet('path', idx)) let idx_path = vimwiki#path#path_norm(vimwiki#path#chomp_slash(idx_path)) if vimwiki#path#is_equal( \ vimwiki#path#path_common_pfx(idx_path, path), idx_path) return idx endif let idx += 1 endwhile " an orphan page has been detected return -1 endfunction "}}} " THE central function of Vimwiki. Extract infos about the target from a link. " If the second parameter is present, which should be an absolute file path, it " is assumed that the link appears in that file. Without it, the current file " is used. function! vimwiki#base#resolve_link(link_text, ...) "{{{ if a:0 let source_wiki = vimwiki#base#find_wiki(a:1) let source_file = a:1 else let source_wiki = g:vimwiki_current_idx let source_file = expand('%:p') endif let link_text = a:link_text " if link is schemeless add wikiN: scheme if link_text !~# g:vimwiki_rxSchemeUrl let link_text = 'wiki'.source_wiki.':'.link_text endif let link_infos = { \ 'index': -1, \ 'scheme': '', \ 'filename': '', \ 'anchor': '', \ 'relative': 0, \ } " extract scheme let link_infos.scheme = matchstr(link_text, g:vimwiki_rxSchemeUrlMatchScheme) if link_infos.scheme == '' || link_text == '' let link_infos.filename = '' " malformed link return link_infos endif if link_infos.scheme !~# '\mwiki\d\+\|diary\|local\|file' let link_infos.filename = link_text " unknown scheme, may be a weblink return link_infos endif let link_text = matchstr(link_text, g:vimwiki_rxSchemeUrlMatchUrl) let is_wiki_link = link_infos.scheme =~# '\mwiki\d\+' || \ link_infos.scheme ==# 'diary' " extract anchor if is_wiki_link let split_lnk = split(link_text, '#', 1) let link_text = split_lnk[0] if len(split_lnk) > 1 && split_lnk[-1] != '' let link_infos.anchor = join(split_lnk[1:], '#') endif if link_text == '' " because the link was of the form '#anchor' let link_text = fnamemodify(source_file, ':p:t:r') endif endif " check if absolute or relative path if is_wiki_link && link_text[0] == '/' let link_text = link_text[1:] let link_infos.relative = 0 elseif !is_wiki_link && vimwiki#path#is_absolute(link_text) let link_infos.relative = 0 else let link_infos.relative = 1 let root_dir = fnamemodify(source_file, ':p:h') . '/' endif " extract the other items depending on the scheme if link_infos.scheme =~# '\mwiki\d\+' let link_infos.index = eval(matchstr(link_infos.scheme, '\D\+\zs\d\+\ze')) if link_infos.index < 0 || link_infos.index >= len(g:vimwiki_list) let link_infos.filename = '' return link_infos endif if !link_infos.relative || link_infos.index != source_wiki let root_dir = VimwikiGet('path', link_infos.index) endif let link_infos.filename = root_dir . link_text if vimwiki#path#is_link_to_dir(link_text) if g:vimwiki_dir_link != '' let link_infos.filename .= g:vimwiki_dir_link . \ VimwikiGet('ext', link_infos.index) endif else let link_infos.filename .= VimwikiGet('ext', link_infos.index) endif elseif link_infos.scheme ==# 'diary' let link_infos.index = source_wiki let link_infos.filename = \ VimwikiGet('path', link_infos.index) . \ VimwikiGet('diary_rel_path', link_infos.index) . \ link_text . \ VimwikiGet('ext', link_infos.index) elseif (link_infos.scheme ==# 'file' || link_infos.scheme ==# 'local') \ && link_infos.relative let link_infos.filename = simplify(root_dir . link_text) else " absolute file link " collapse repeated leading "/"'s within a link let link_text = substitute(link_text, '\m^/\+', '/', '') " expand ~/ let link_text = fnamemodify(link_text, ':p') let link_infos.filename = simplify(link_text) endif let link_infos.filename = vimwiki#path#normalize(link_infos.filename) return link_infos endfunction "}}} " vimwiki#base#system_open_link function! vimwiki#base#system_open_link(url) "{{{ " handlers function! s:win32_handler(url) "http://vim.wikia.com/wiki/Opening_current_Vim_file_in_your_Windows_browser "disable 'shellslash', otherwise the url will be enclosed in single quotes, "which is problematic "see https://github.com/vimwiki/vimwiki/issues/54#issuecomment-48011289 if exists('+shellslash') let old_ssl = &shellslash set noshellslash let url = shellescape(a:url, 1) let &shellslash = old_ssl else let url = shellescape(a:url, 1) endif execute 'silent ! start "Title" /B ' . url endfunction function! s:macunix_handler(url) execute '!open ' . shellescape(a:url, 1) endfunction function! s:linux_handler(url) call system('xdg-open ' . shellescape(a:url).' &') endfunction try if vimwiki#u#is_windows() call s:win32_handler(a:url) return elseif has("macunix") call s:macunix_handler(a:url) return else call s:linux_handler(a:url) return endif endtry echomsg 'Default Vimwiki link handler was unable to open the HTML file!' endfunction "}}} " vimwiki#base#open_link function! vimwiki#base#open_link(cmd, link, ...) "{{{ let link_infos = vimwiki#base#resolve_link(a:link) if g:vimwiki_debug echom 'open_link:' string(link_infos) endif if link_infos.filename == '' echom 'Vimwiki Error: Unable to resolve link!' return endif let is_wiki_link = link_infos.scheme =~# '\mwiki\d\+' \ || link_infos.scheme =~# 'diary' let update_prev_link = is_wiki_link && \ !vimwiki#path#is_equal(link_infos.filename, expand('%:p')) let vimwiki_prev_link = [] " update previous link for wiki pages if update_prev_link if a:0 let vimwiki_prev_link = [a:1, []] elseif &ft ==# 'vimwiki' let vimwiki_prev_link = [expand('%:p'), getpos('.')] endif endif " open/edit if is_wiki_link call vimwiki#base#edit_file(a:cmd, link_infos.filename, link_infos.anchor, \ vimwiki_prev_link, update_prev_link) if link_infos.index != g:vimwiki_current_idx " this call to setup_buffer_state may not be necessary call vimwiki#base#setup_buffer_state(link_infos.index) endif else call vimwiki#base#system_open_link(link_infos.filename) endif endfunction " }}} " vimwiki#base#get_globlinks_escaped function! vimwiki#base#get_globlinks_escaped() abort "{{{only get links from the current dir " change to the directory of the current file let orig_pwd = getcwd() lcd! %:h " all path are relative to the current file's location let globlinks = glob('*'.VimwikiGet('ext'),1)."\n" " remove extensions let globlinks = substitute(globlinks, '\'.VimwikiGet('ext').'\ze\n', '', 'g') " restore the original working directory exe 'lcd! '.orig_pwd " convert to a List let lst = split(globlinks, '\n') " Apply fnameescape() to each item call map(lst, 'fnameescape(v:val)') " Convert back to newline-separated list let globlinks = join(lst, "\n") " return all escaped links as a single newline-separated string return globlinks endfunction " }}} " vimwiki#base#generate_links function! vimwiki#base#generate_links() "{{{ let links = vimwiki#base#get_wikilinks(g:vimwiki_current_idx, 0) call append(line('$'), substitute(g:vimwiki_rxH1_Template, '__Header__', 'Generated Links', '')) call sort(links) let bullet = repeat(' ', vimwiki#lst#get_list_margin()). \ vimwiki#lst#default_symbol().' ' for link in links let abs_filepath = vimwiki#path#abs_path_of_link(link) if !s:is_diary_file(abs_filepath) call append(line('$'), bullet. \ substitute(g:vimwiki_WikiLinkTemplate1, '__LinkUrl__', '\='."'".link."'", '')) endif endfor endfunction " }}} " vimwiki#base#goto function! vimwiki#base#goto(...) "{{{ let key = a:1 let anchor = a:0 > 1 ? a:2 : '' call vimwiki#base#edit_file(':e', \ VimwikiGet('path') . key . VimwikiGet('ext'), \ anchor) endfunction "}}} " vimwiki#base#backlinks function! vimwiki#base#backlinks() "{{{ let current_filename = expand("%:p") let locations = [] for idx in range(len(g:vimwiki_list)) let syntax = VimwikiGet('syntax', idx) let wikifiles = s:find_files(idx, 0) for source_file in wikifiles let links = s:get_links(source_file, idx) for [target_file, _, lnum, col] in links " don't include links from the current file to itself if vimwiki#path#is_equal(target_file, current_filename) && \ !vimwiki#path#is_equal(target_file, source_file) call add(locations, {'filename':source_file, 'lnum':lnum, 'col':col}) endif endfor endfor endfor if empty(locations) echom 'vimwiki: no other file links to this file' else call setloclist(0, locations, 'r') lopen endif endfunction "}}} " Returns: a list containing all files of the given wiki as absolute file path. " If the given wiki number is negative, the diary of the current wiki is used " If the second argument is not zero, only directories are found function! s:find_files(wiki_nr, directories_only) let wiki_nr = a:wiki_nr if wiki_nr >= 0 let root_directory = VimwikiGet('path', wiki_nr) else let root_directory = VimwikiGet('path').VimwikiGet('diary_rel_path') let wiki_nr = g:vimwiki_current_idx endif if a:directories_only let ext = '/' else let ext = VimwikiGet('ext', wiki_nr) endif " if current wiki is temporary -- was added by an arbitrary wiki file then do " not search wiki files in subdirectories. Or it would hang the system if " wiki file was created in $HOME or C:/ dirs. if VimwikiGet('temp', wiki_nr) let pattern = '*'.ext else let pattern = '**/*'.ext endif return split(globpath(root_directory, pattern), '\n') endfunction " Returns: a list containing the links to get from the current file to all wiki " files in the given wiki. " If the given wiki number is negative, the diary of the current wiki is used. " If also_absolute_links is nonzero, also return links of the form /file function! vimwiki#base#get_wikilinks(wiki_nr, also_absolute_links) let files = s:find_files(a:wiki_nr, 0) if a:wiki_nr == g:vimwiki_current_idx let cwd = vimwiki#path#wikify_path(expand('%:p:h')) elseif a:wiki_nr < 0 let cwd = VimwikiGet('path').VimwikiGet('diary_rel_path') else let cwd = VimwikiGet('path', a:wiki_nr) endif let result = [] for wikifile in files let wikifile = fnamemodify(wikifile, ':r') " strip extension let wikifile = vimwiki#path#relpath(cwd, wikifile) call add(result, wikifile) endfor if a:also_absolute_links for wikifile in files if a:wiki_nr == g:vimwiki_current_idx let cwd = VimwikiGet('path') elseif a:wiki_nr < 0 let cwd = VimwikiGet('path').VimwikiGet('diary_rel_path') endif let wikifile = fnamemodify(wikifile, ':r') " strip extension let wikifile = '/'.vimwiki#path#relpath(cwd, wikifile) call add(result, wikifile) endfor endif return result endfunction " Returns: a list containing the links to all directories from the current file function! vimwiki#base#get_wiki_directories(wiki_nr) let dirs = s:find_files(a:wiki_nr, 1) if a:wiki_nr == g:vimwiki_current_idx let cwd = vimwiki#path#wikify_path(expand('%:p:h')) let root_dir = VimwikiGet('path') else let cwd = VimwikiGet('path', a:wiki_nr) endif let result = ['./'] for wikidir in dirs let wikidir_relative = vimwiki#path#relpath(cwd, wikidir).'/' call add(result, wikidir_relative) if a:wiki_nr == g:vimwiki_current_idx let wikidir_absolute = '/'.vimwiki#path#relpath(root_dir, wikidir).'/' call add(result, wikidir_absolute) endif endfor return result endfunction function! vimwiki#base#get_anchors(filename, syntax) "{{{ if !filereadable(a:filename) return [] endif let rxheader = g:vimwiki_{a:syntax}_header_search let rxbold = g:vimwiki_{a:syntax}_bold_search let anchor_level = ['', '', '', '', '', '', ''] let anchors = [] let current_complete_anchor = '' for line in readfile(a:filename) " collect headers let h_match = matchlist(line, rxheader) if !empty(h_match) let header = vimwiki#u#trim(h_match[2]) let level = len(h_match[1]) call add(anchors, header) let anchor_level[level-1] = header for l in range(level, 6) let anchor_level[l] = '' endfor if level == 1 let current_complete_anchor = header else let current_complete_anchor = '' for l in range(level-1) if anchor_level[l] != '' let current_complete_anchor .= anchor_level[l].'#' endif endfor let current_complete_anchor .= header call add(anchors, current_complete_anchor) endif endif " collect bold text (there can be several in one line) let bold_count = 1 while 1 let bold_text = matchstr(line, rxbold, 0, bold_count) if bold_text == '' break endif call add(anchors, bold_text) if current_complete_anchor != '' call add(anchors, current_complete_anchor.'#'.bold_text) endif let bold_count += 1 endwhile endfor return anchors endfunction "}}} " s:jump_to_anchor function! s:jump_to_anchor(anchor) "{{{ let oldpos = getpos('.') call cursor(1, 1) let anchor = vimwiki#u#escape(a:anchor) let segments = split(anchor, '#', 0) for segment in segments let anchor_header = substitute( \ g:vimwiki_{VimwikiGet('syntax')}_header_match, \ '__Header__', "\\='".segment."'", '') let anchor_bold = substitute(g:vimwiki_{VimwikiGet('syntax')}_bold_match, \ '__Text__', "\\='".segment."'", '') if !search(anchor_header, 'Wc') && !search(anchor_bold, 'Wc') call setpos('.', oldpos) break endif let oldpos = getpos('.') endfor endfunction "}}} " Params: full path to a wiki file and its wiki number " Returns: a list of all links inside the wiki file " Every list item has the form " [target file, anchor, line number of the link in source file, column number] function! s:get_links(wikifile, idx) "{{{ if !filereadable(a:wikifile) return [] endif let syntax = VimwikiGet('syntax', a:idx) let rx_link = g:vimwiki_{syntax}_wikilink let links = [] let lnum = 0 for line in readfile(a:wikifile) let lnum += 1 let link_count = 1 while 1 let col = match(line, rx_link, 0, link_count)+1 let link_text = matchstr(line, rx_link, 0, link_count) if link_text == '' break endif let link_count += 1 let target = vimwiki#base#resolve_link(link_text, a:wikifile) if target.filename != '' && \ target.scheme =~# '\mwiki\d\+\|diary\|file\|local' call add(links, [target.filename, target.anchor, lnum, col]) endif endwhile endfor return links endfunction "}}} function! vimwiki#base#check_links() "{{{ let anchors_of_files = {} let links_of_files = {} let errors = [] for idx in range(len(g:vimwiki_list)) let syntax = VimwikiGet('syntax', idx) let wikifiles = s:find_files(idx, 0) for wikifile in wikifiles let links_of_files[wikifile] = s:get_links(wikifile, idx) let anchors_of_files[wikifile] = vimwiki#base#get_anchors(wikifile, syntax) endfor endfor for wikifile in keys(links_of_files) for [target_file, target_anchor, lnum, col] in links_of_files[wikifile] if target_file == '' && target_anchor == '' call add(errors, {'filename':wikifile, 'lnum':lnum, 'col':col, \ 'text': "numbered scheme refers to a non-existent wiki"}) elseif has_key(anchors_of_files, target_file) if target_anchor != '' && index(anchors_of_files[target_file], target_anchor) < 0 call add(errors, {'filename':wikifile, 'lnum':lnum, 'col':col, \'text': "there is no such anchor: ".target_anchor}) endif else if target_file =~ '/$' " maybe it's a link to a directory if !isdirectory(target_file) call add(errors, {'filename':wikifile, 'lnum':lnum, 'col':col, \'text': "there is no such directory: ".target_file}) endif else if filereadable(target_file) " maybe it's a non-wiki file let anchors_of_files[target_file] = [] else call add(errors, {'filename':wikifile, 'lnum':lnum, 'col':col, \'text': "there is no such file: ".target_file}) endif endif endif endfor endfor let reachable_wikifiles = {} for wikifile in keys(links_of_files) let reachable_wikifiles[wikifile] = 0 endfor for idx in range(len(g:vimwiki_list)) let index_file = VimwikiGet('path', idx) . VimwikiGet('index', idx) . \ VimwikiGet('ext', idx) let reachable_wikifiles[index_file] = 1 endfor while 1 let visit_wikifile = '' for wf in keys(reachable_wikifiles) if reachable_wikifiles[wf] == 1 let visit_wikifile = wf let reachable_wikifiles[wf] = 2 break endif endfor if visit_wikifile == '' break endif for [target_file, target_anchor, lnum, col] in links_of_files[visit_wikifile] if has_key(reachable_wikifiles, target_file) && reachable_wikifiles[target_file] == 0 let reachable_wikifiles[target_file] = 1 endif endfor endwhile for wf in keys(reachable_wikifiles) if reachable_wikifiles[wf] == 0 call add(errors, {'text':wf." is not reachable from the index file"}) endif endfor if empty(errors) echom 'vimwiki: all links are OK' else call setqflist(errors, 'r') copen endif endfunction "}}} " vimwiki#base#edit_file function! vimwiki#base#edit_file(command, filename, anchor, ...) "{{{ " XXX: Should we allow * in filenames!? " Maxim: It is allowed, escaping here is for vim to be able to open files " which have that symbols. " Try to remove * from escaping and open&save : " [[testBLAfile]]... " then " [[test*file]]... " you'll have E77: Too many file names let fname = escape(a:filename, '% *|#') let dir = fnamemodify(a:filename, ":p:h") let ok = vimwiki#path#mkdir(dir, 1) if !ok echom ' ' echom 'Vimwiki: Unable to edit file in non-existent directory: '.dir return endif " check if the file we want to open is already the current file " which happens if we jump to an achor in the current file. " This hack is necessary because apparently Vim messes up the result of " getpos() directly after this command. Strange. if !(a:command ==# ':e ' && vimwiki#path#is_equal(a:filename, expand('%:p'))) execute a:command.' '.fname " Make sure no other plugin takes ownership over the new file. Vimwiki " rules them all! Well, except for directories, which may be opened with " Netrw if &filetype != 'vimwiki' && fname !~ '\m/$' set filetype=vimwiki endif endif if a:anchor != '' call s:jump_to_anchor(a:anchor) endif " save previous link " a:1 -- previous vimwiki link to save " a:2 -- should we update previous link if a:0 && a:2 && len(a:1) > 0 let b:vimwiki_prev_link = a:1 endif endfunction " }}} " vimwiki#base#search_word function! vimwiki#base#search_word(wikiRx, cmd) "{{{ let match_line = search(a:wikiRx, 's'.a:cmd) if match_line == 0 echomsg 'vimwiki: Wiki link not found.' endif endfunction " }}} " vimwiki#base#matchstr_at_cursor " Returns part of the line that matches wikiRX at cursor function! vimwiki#base#matchstr_at_cursor(wikiRX) "{{{ let col = col('.') - 1 let line = getline('.') let ebeg = -1 let cont = match(line, a:wikiRX, 0) while (ebeg >= 0 || (0 <= cont) && (cont <= col)) let contn = matchend(line, a:wikiRX, cont) if (cont <= col) && (col < contn) let ebeg = match(line, a:wikiRX, cont) let elen = contn - ebeg break else let cont = match(line, a:wikiRX, contn) endif endwh if ebeg >= 0 return strpart(line, ebeg, elen) else return "" endif endf "}}} " vimwiki#base#replacestr_at_cursor function! vimwiki#base#replacestr_at_cursor(wikiRX, sub) "{{{ let col = col('.') - 1 let line = getline('.') let ebeg = -1 let cont = match(line, a:wikiRX, 0) while (ebeg >= 0 || (0 <= cont) && (cont <= col)) let contn = matchend(line, a:wikiRX, cont) if (cont <= col) && (col < contn) let ebeg = match(line, a:wikiRX, cont) let elen = contn - ebeg break else let cont = match(line, a:wikiRX, contn) endif endwh if ebeg >= 0 " TODO: There might be problems with Unicode chars... let newline = strpart(line, 0, ebeg).a:sub.strpart(line, ebeg+elen) call setline(line('.'), newline) endif endf "}}} " s:print_wiki_list function! s:print_wiki_list() "{{{ let idx = 0 while idx < len(g:vimwiki_list) if idx == g:vimwiki_current_idx let sep = ' * ' echohl PmenuSel else let sep = ' ' echohl None endif echo (idx + 1).sep.VimwikiGet('path', idx) let idx += 1 endwhile echohl None endfunction " }}} " s:update_wiki_link function! s:update_wiki_link(fname, old, new) " {{{ echo "Updating links in ".a:fname let has_updates = 0 let dest = [] for line in readfile(a:fname) if !has_updates && match(line, a:old) != -1 let has_updates = 1 endif " XXX: any other characters to escape!? call add(dest, substitute(line, a:old, escape(a:new, "&"), "g")) endfor " add exception handling... if has_updates call rename(a:fname, a:fname.'#vimwiki_upd#') call writefile(dest, a:fname) call delete(a:fname.'#vimwiki_upd#') endif endfunction " }}} " s:update_wiki_links_dir function! s:update_wiki_links_dir(dir, old_fname, new_fname) " {{{ let old_fname = substitute(a:old_fname, '[/\\]', '[/\\\\]', 'g') let new_fname = a:new_fname let old_fname_r = vimwiki#base#apply_template( \ g:vimwiki_WikiLinkMatchUrlTemplate, old_fname, '', '') let files = split(glob(VimwikiGet('path').a:dir.'*'.VimwikiGet('ext')), '\n') for fname in files call s:update_wiki_link(fname, old_fname_r, new_fname) endfor endfunction " }}} " s:tail_name function! s:tail_name(fname) "{{{ let result = substitute(a:fname, ":", "__colon__", "g") let result = fnamemodify(result, ":t:r") let result = substitute(result, "__colon__", ":", "g") return result endfunction "}}} " s:update_wiki_links function! s:update_wiki_links(old_fname, new_fname) " {{{ let old_fname = a:old_fname let new_fname = a:new_fname let subdirs = split(a:old_fname, '[/\\]')[: -2] " TODO: Use Dictionary here... let dirs_keys = [''] let dirs_vals = [''] if len(subdirs) > 0 let dirs_keys = [''] let dirs_vals = [join(subdirs, '/').'/'] let idx = 0 while idx < len(subdirs) - 1 call add(dirs_keys, join(subdirs[: idx], '/').'/') call add(dirs_vals, join(subdirs[idx+1 :], '/').'/') let idx = idx + 1 endwhile call add(dirs_keys,join(subdirs, '/').'/') call add(dirs_vals, '') endif let idx = 0 while idx < len(dirs_keys) let dir = dirs_keys[idx] let new_dir = dirs_vals[idx] call s:update_wiki_links_dir(dir, \ new_dir.old_fname, new_dir.new_fname) let idx = idx + 1 endwhile endfunction " }}} " s:get_wiki_buffers function! s:get_wiki_buffers() "{{{ let blist = [] let bcount = 1 while bcount<=bufnr("$") if bufexists(bcount) let bname = fnamemodify(bufname(bcount), ":p") if bname =~# VimwikiGet('ext')."$" let bitem = [bname, getbufvar(bname, "vimwiki_prev_link")] call add(blist, bitem) endif endif let bcount = bcount + 1 endwhile return blist endfunction " }}} " s:open_wiki_buffer function! s:open_wiki_buffer(item) "{{{ call vimwiki#base#edit_file(':e', a:item[0], '') if !empty(a:item[1]) call setbufvar(a:item[0], "vimwiki_prev_link", a:item[1]) endif endfunction " }}} " vimwiki#base#nested_syntax function! vimwiki#base#nested_syntax(filetype, start, end, textSnipHl) abort "{{{ " From http://vim.wikia.com/wiki/VimTip857 let ft=toupper(a:filetype) let group='textGroup'.ft if exists('b:current_syntax') let s:current_syntax=b:current_syntax " Remove current syntax definition, as some syntax files (e.g. cpp.vim) " do nothing if b:current_syntax is defined. unlet b:current_syntax endif " Some syntax files set up iskeyword which might scratch vimwiki a bit. " Let us save and restore it later. " let b:skip_set_iskeyword = 1 let is_keyword = &iskeyword try " keep going even if syntax file is not found execute 'syntax include @'.group.' syntax/'.a:filetype.'.vim' execute 'syntax include @'.group.' after/syntax/'.a:filetype.'.vim' catch endtry let &iskeyword = is_keyword if exists('s:current_syntax') let b:current_syntax=s:current_syntax else unlet b:current_syntax endif execute 'syntax region textSnip'.ft. \ ' matchgroup='.a:textSnipHl. \ ' start="'.a:start.'" end="'.a:end.'"'. \ ' contains=@'.group.' keepend' " A workaround to Issue 115: Nested Perl syntax highlighting differs from " regular one. " Perl syntax file has perlFunctionName which is usually has no effect due to " 'contained' flag. Now we have 'syntax include' that makes all the groups " included as 'contained' into specific group. " Here perlFunctionName (with quite an angry regexp "\h\w*[^:]") clashes with " the rest syntax rules as now it has effect being really 'contained'. " Clear it! if ft =~? 'perl' syntax clear perlFunctionName endif endfunction "}}} " WIKI link following functions {{{ " vimwiki#base#find_next_link function! vimwiki#base#find_next_link() "{{{ call vimwiki#base#search_word(g:vimwiki_rxAnyLink, '') endfunction " }}} " vimwiki#base#find_prev_link function! vimwiki#base#find_prev_link() "{{{ "Jump 2 times if the cursor is in the middle of a link if synIDattr(synID(line('.'), col('.'), 0), "name") =~# "VimwikiLink.*" && \ synIDattr(synID(line('.'), col('.')-1, 0), "name") =~# "VimwikiLink.*" call vimwiki#base#search_word(g:vimwiki_rxAnyLink, 'b') endif call vimwiki#base#search_word(g:vimwiki_rxAnyLink, 'b') endfunction " }}} " vimwiki#base#follow_link function! vimwiki#base#follow_link(split, ...) "{{{ Parse link at cursor and pass " to VimwikiLinkHandler, or failing that, the default open_link handler if exists('*vimwiki#'.VimwikiGet('syntax').'_base#follow_link') " Syntax-specific links " XXX: @Stuart: do we still need it? " XXX: @Maxim: most likely! I am still working on a seemless way to " integrate regexp's without complicating syntax/vimwiki.vim if a:0 call vimwiki#{VimwikiGet('syntax')}_base#follow_link(a:split, a:1) else call vimwiki#{VimwikiGet('syntax')}_base#follow_link(a:split) endif else if a:split ==# "split" let cmd = ":split " elseif a:split ==# "vsplit" let cmd = ":vsplit " elseif a:split ==# "tabnew" let cmd = ":tabnew " else let cmd = ":e " endif " try WikiLink let lnk = matchstr(vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWikiLink), \ g:vimwiki_rxWikiLinkMatchUrl) " try WikiIncl if lnk == "" let lnk = matchstr(vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWikiIncl), \ g:vimwiki_rxWikiInclMatchUrl) endif " try Weblink if lnk == "" let lnk = matchstr(vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWeblink), \ g:vimwiki_rxWeblinkMatchUrl) endif if lnk != "" if !VimwikiLinkHandler(lnk) call vimwiki#base#open_link(cmd, lnk) endif return endif if a:0 > 0 execute "normal! ".a:1 else call vimwiki#base#normalize_link(0) endif endif endfunction " }}} " vimwiki#base#go_back_link function! vimwiki#base#go_back_link() "{{{ if exists("b:vimwiki_prev_link") " go back to saved wiki link let prev_word = b:vimwiki_prev_link execute ":e ".substitute(prev_word[0], '\s', '\\\0', 'g') call setpos('.', prev_word[1]) endif endfunction " }}} " vimwiki#base#goto_index function! vimwiki#base#goto_index(wnum, ...) "{{{ if a:wnum > len(g:vimwiki_list) echom "vimwiki: Wiki ".a:wnum." is not registered in g:vimwiki_list!" return endif " usually a:wnum is greater then 0 but with the following command it is == 0: " vim -n -c "exe 'VimwikiIndex' | echo g:vimwiki_current_idx" if a:wnum > 0 let idx = a:wnum - 1 else let idx = 0 endif if a:0 let cmd = 'tabedit' else let cmd = 'edit' endif if g:vimwiki_debug == 3 echom "--- Goto_index g:curr_idx=".g:vimwiki_current_idx." ww_idx=".idx."" endif call vimwiki#base#edit_file(cmd, \ VimwikiGet('path', idx).VimwikiGet('index', idx). \ VimwikiGet('ext', idx), \ '') call vimwiki#base#setup_buffer_state(idx) endfunction "}}} " vimwiki#base#delete_link function! vimwiki#base#delete_link() "{{{ "" file system funcs "" Delete wiki link you are in from filesystem let val = input('Delete "'.expand('%').'" [y]es/[N]o? ') if val !~? '^y' return endif let fname = expand('%:p') try call delete(fname) catch /.*/ echomsg 'vimwiki: Cannot delete "'.expand('%:t:r').'"!' return endtry call vimwiki#base#go_back_link() execute "bdelete! ".escape(fname, " ") " reread buffer => deleted wiki link should appear as non-existent if expand('%:p') != "" execute "e" endif endfunction "}}} " vimwiki#base#rename_link " Rename current file, update all links to it function! vimwiki#base#rename_link() "{{{ let subdir = VimwikiGet('subdir') let old_fname = subdir.expand('%:t') " there is no file (new one maybe) if glob(expand('%:p')) == '' echomsg 'vimwiki: Cannot rename "'.expand('%:p'). \'". It does not exist! (New file? Save it before renaming.)' return endif let val = input('Rename "'.expand('%:t:r').'" [y]es/[N]o? ') if val !~? '^y' return endif let new_link = input('Enter new name: ') if new_link =~# '[/\\]' " It is actually doable but I do not have free time to do it. echomsg 'vimwiki: Cannot rename to a filename with path!' return endif " check new_fname - it should be 'good', not empty if substitute(new_link, '\s', '', 'g') == '' echomsg 'vimwiki: Cannot rename to an empty filename!' return endif let url = matchstr(new_link, g:vimwiki_rxWikiLinkMatchUrl) if url != '' let new_link = url endif let new_link = subdir.new_link let new_fname = VimwikiGet('path').new_link.VimwikiGet('ext') " do not rename if file with such name exists let fname = glob(new_fname) if fname != '' echomsg 'vimwiki: Cannot rename to "'.new_fname. \ '". File with that name exist!' return endif " rename wiki link file try echomsg "Renaming ".VimwikiGet('path').old_fname." to ".new_fname let res = rename(expand('%:p'), expand(new_fname)) if res != 0 throw "Cannot rename!" end catch /.*/ echomsg 'vimwiki: Cannot rename "'.expand('%:t:r').'" to "'.new_fname.'"' return endtry let &buftype="nofile" let cur_buffer = [expand('%:p'), \getbufvar(expand('%:p'), "vimwiki_prev_link")] let blist = s:get_wiki_buffers() " save wiki buffers for bitem in blist execute ':b '.escape(bitem[0], ' ') execute ':update' endfor execute ':b '.escape(cur_buffer[0], ' ') " remove wiki buffers for bitem in blist execute 'bwipeout '.escape(bitem[0], ' ') endfor let setting_more = &more setlocal nomore " update links call s:update_wiki_links(s:tail_name(old_fname), new_link) " restore wiki buffers for bitem in blist if !vimwiki#path#is_equal(bitem[0], cur_buffer[0]) call s:open_wiki_buffer(bitem) endif endfor call s:open_wiki_buffer([new_fname, \ cur_buffer[1]]) " execute 'bwipeout '.escape(cur_buffer[0], ' ') echomsg old_fname." is renamed to ".new_fname let &more = setting_more endfunction " }}} " vimwiki#base#ui_select function! vimwiki#base#ui_select() "{{{ call s:print_wiki_list() let idx = input("Select Wiki (specify number): ") if idx == "" return endif call vimwiki#base#goto_index(idx) endfunction "}}} " }}} " TEXT OBJECTS functions {{{ " vimwiki#base#TO_header function! vimwiki#base#TO_header(inner, visual) "{{{ if !search('^\(=\+\).\+\1\s*$', 'bcW') return endif let sel_start = line("'<") let sel_end = line("'>") let block_start = line(".") let advance = 0 let level = vimwiki#u#count_first_sym(getline('.')) let is_header_selected = sel_start == block_start \ && sel_start != sel_end if a:visual && is_header_selected if level > 1 let level -= 1 call search('^\(=\{'.level.'\}\).\+\1\s*$', 'bcW') else let advance = 1 endif endif normal! V if a:visual && is_header_selected call cursor(sel_end + advance, 0) endif if search('^\(=\{1,'.level.'}\).\+\1\s*$', 'W') call cursor(line('.') - 1, 0) else call cursor(line('$'), 0) endif if a:inner && getline(line('.')) =~# '^\s*$' let lnum = prevnonblank(line('.') - 1) call cursor(lnum, 0) endif endfunction "}}} " vimwiki#base#TO_table_cell function! vimwiki#base#TO_table_cell(inner, visual) "{{{ if col('.') == col('$')-1 return endif if a:visual normal! `> let sel_end = getpos('.') normal! `< let sel_start = getpos('.') let firsttime = sel_start == sel_end if firsttime if !search('|\|\(-+-\)', 'cb', line('.')) return endif if getline('.')[virtcol('.')] == '+' normal! l endif if a:inner normal! 2l endif let sel_start = getpos('.') endif normal! `> call search('|\|\(-+-\)', '', line('.')) if getline('.')[virtcol('.')] == '+' normal! l endif if a:inner if firsttime || abs(sel_end[2] - getpos('.')[2]) != 2 normal! 2h endif endif let sel_end = getpos('.') call setpos('.', sel_start) exe "normal! \" call setpos('.', sel_end) " XXX: WORKAROUND. " if blockwise selection is ended at | character then pressing j to extend " selection furhter fails. But if we shake the cursor left and right then " it works. normal! hl else if !search('|\|\(-+-\)', 'cb', line('.')) return endif if a:inner normal! 2l endif normal! v call search('|\|\(-+-\)', '', line('.')) if !a:inner && getline('.')[virtcol('.')-1] == '|' normal! h elseif a:inner normal! 2h endif endif endfunction "}}} " vimwiki#base#TO_table_col function! vimwiki#base#TO_table_col(inner, visual) "{{{ let t_rows = vimwiki#tbl#get_rows(line('.')) if empty(t_rows) return endif " TODO: refactor it! if a:visual normal! `> let sel_end = getpos('.') normal! `< let sel_start = getpos('.') let firsttime = sel_start == sel_end if firsttime " place cursor to the top row of the table call vimwiki#u#cursor(t_rows[0][0], virtcol('.')) " do not accept the match at cursor position if cursor is next to column " separator of the table separator (^ is a cursor): " |-----^-+-------| " | bla | bla | " |-------+-------| " or it will select wrong column. if strpart(getline('.'), virtcol('.')-1) =~# '^-+' let s_flag = 'b' else let s_flag = 'cb' endif " search the column separator backwards if !search('|\|\(-+-\)', s_flag, line('.')) return endif " -+- column separator is matched --> move cursor to the + sign if getline('.')[virtcol('.')] == '+' normal! l endif " inner selection --> reduce selection if a:inner normal! 2l endif let sel_start = getpos('.') endif normal! `> if !firsttime && getline('.')[virtcol('.')] == '|' normal! l elseif a:inner && getline('.')[virtcol('.')+1] =~# '[|+]' normal! 2l endif " search for the next column separator call search('|\|\(-+-\)', '', line('.')) " Outer selection selects a column without border on the right. So we move " our cursor left if the previous search finds | border, not -+-. if getline('.')[virtcol('.')] != '+' normal! h endif if a:inner " reduce selection a bit more if inner. normal! h endif " expand selection to the bottom line of the table call vimwiki#u#cursor(t_rows[-1][0], virtcol('.')) let sel_end = getpos('.') call setpos('.', sel_start) exe "normal! \" call setpos('.', sel_end) else " place cursor to the top row of the table call vimwiki#u#cursor(t_rows[0][0], virtcol('.')) " do not accept the match at cursor position if cursor is next to column " separator of the table separator (^ is a cursor): " |-----^-+-------| " | bla | bla | " |-------+-------| " or it will select wrong column. if strpart(getline('.'), virtcol('.')-1) =~# '^-+' let s_flag = 'b' else let s_flag = 'cb' endif " search the column separator backwards if !search('|\|\(-+-\)', s_flag, line('.')) return endif " -+- column separator is matched --> move cursor to the + sign if getline('.')[virtcol('.')] == '+' normal! l endif " inner selection --> reduce selection if a:inner normal! 2l endif exe "normal! \" " search for the next column separator call search('|\|\(-+-\)', '', line('.')) " Outer selection selects a column without border on the right. So we move " our cursor left if the previous search finds | border, not -+-. if getline('.')[virtcol('.')] != '+' normal! h endif " reduce selection a bit more if inner. if a:inner normal! h endif " expand selection to the bottom line of the table call vimwiki#u#cursor(t_rows[-1][0], virtcol('.')) endif endfunction "}}} " }}} " HEADER functions {{{ " vimwiki#base#AddHeaderLevel function! vimwiki#base#AddHeaderLevel() "{{{ let lnum = line('.') let line = getline(lnum) let rxHdr = g:vimwiki_rxH if line =~# '^\s*$' return endif if line =~# g:vimwiki_rxHeader let level = vimwiki#u#count_first_sym(line) if level < 6 if g:vimwiki_symH let line = substitute(line, '\('.rxHdr.'\+\).\+\1', rxHdr.'&'.rxHdr, '') else let line = substitute(line, '\('.rxHdr.'\+\).\+', rxHdr.'&', '') endif call setline(lnum, line) endif else let line = substitute(line, '^\s*', '&'.rxHdr.' ', '') if g:vimwiki_symH let line = substitute(line, '\s*$', ' '.rxHdr.'&', '') endif call setline(lnum, line) endif endfunction "}}} " vimwiki#base#RemoveHeaderLevel function! vimwiki#base#RemoveHeaderLevel() "{{{ let lnum = line('.') let line = getline(lnum) let rxHdr = g:vimwiki_rxH if line =~# '^\s*$' return endif if line =~# g:vimwiki_rxHeader let level = vimwiki#u#count_first_sym(line) let old = repeat(rxHdr, level) let new = repeat(rxHdr, level - 1) let chomp = line =~# rxHdr.'\s' if g:vimwiki_symH let line = substitute(line, old, new, 'g') else let line = substitute(line, old, new, '') endif if level == 1 && chomp let line = substitute(line, '^\s', '', 'g') let line = substitute(line, '\s$', '', 'g') endif let line = substitute(line, '\s*$', '', '') call setline(lnum, line) endif endfunction " }}} " a:create == 1: creates or updates TOC in current file " a:create == 0: update if TOC exists function! vimwiki#base#table_of_contents(create) " apparently, Vim behaves strange when files change while in diff mode if &diff return endif " look for existing TOC let toc_header = '^\s*'.substitute(g:vimwiki_rxH1_Template, '__Header__', \ '\='."'".g:vimwiki_toc_header."'", '').'\s*$' let toc_line = 0 let lnum = 1 while lnum <= &modelines + 2 && lnum <= line('$') if getline(lnum) =~# toc_header let toc_line = lnum break endif let lnum += 1 endwhile if !a:create && toc_line <= 0 return endif let old_cursor_pos = getpos('.') let bullet = vimwiki#lst#default_symbol().' ' let rx_bullet = vimwiki#u#escape(bullet) let whitespaces = matchstr(getline(toc_line), '^\s*') " delete old TOC if toc_line > 0 let endoftoc = toc_line+1 while endoftoc <= line('$') && getline(endoftoc) =~# '^\s*'.rx_bullet.g:vimwiki_rxWikiLink.'\s*$' let endoftoc += 1 endwhile silent exe toc_line.','.string(endoftoc-1).'delete _' else let toc_line = 1 endif " collect new headers let headers = [] let headers_levels = [['', 0], ['', 0], ['', 0], ['', 0], ['', 0], ['', 0]] for lnum in range(1, line('$')) let line_content = getline(lnum) if line_content !~# g:vimwiki_rxHeader continue endif let h_level = vimwiki#u#count_first_sym(line_content) let h_text = vimwiki#u#trim(matchstr(line_content, g:vimwiki_rxHeader)) let headers_levels[h_level-1] = [h_text, headers_levels[h_level-1][1]+1] for idx in range(h_level, 5) | let headers_levels[idx] = ['', 0] | endfor let h_complete_id = '' for l in range(h_level-1) if headers_levels[l][0] != '' let h_complete_id .= headers_levels[l][0].'#' endif endfor let h_complete_id .= headers_levels[h_level-1][0] if g:vimwiki_html_header_numbering > 0 \ && g:vimwiki_html_header_numbering <= h_level let h_number = join(map(copy(headers_levels[ \ g:vimwiki_html_header_numbering-1 : h_level-1]), 'v:val[1]'), '.') let h_number .= g:vimwiki_html_header_numbering_sym let h_text = h_number.' '.h_text endif call add(headers, [h_level, h_complete_id, h_text]) endfor " write new TOC call append(toc_line-1, whitespaces . substitute(g:vimwiki_rxH1_Template, \ '__Header__', '\='."'".g:vimwiki_toc_header."'", '')) let startindent = repeat(' ', vimwiki#lst#get_list_margin()) let indentstring = repeat(' ', vimwiki#u#sw()) for [lvl, link, desc] in headers let esc_link = substitute(link, "'", "''", 'g') let esc_desc = substitute(desc, "'", "''", 'g') let link = substitute(g:vimwiki_WikiLinkTemplate2, '__LinkUrl__', \ '\='."'".'#'.esc_link."'", '') let link = substitute(link, '__LinkDescription__', '\='."'".esc_desc."'", '') call append(toc_line, startindent.repeat(indentstring, lvl-1).bullet.link) let toc_line += 1 endfor if getline(toc_line+1) !~# '^\s*$' call append(toc_line, '') endif call setpos('.', old_cursor_pos) endfunction "}}} " LINK functions {{{ " vimwiki#base#apply_template " Construct a regular expression matching from template (with special " characters properly escaped), by substituting rxUrl for __LinkUrl__, rxDesc " for __LinkDescription__, and rxStyle for __LinkStyle__. The three " arguments rxUrl, rxDesc, and rxStyle are copied verbatim, without any " special character escapes or substitutions. function! vimwiki#base#apply_template(template, rxUrl, rxDesc, rxStyle) "{{{ let lnk = a:template if a:rxUrl != "" let lnk = substitute(lnk, '__LinkUrl__', '\='."'".a:rxUrl."'", 'g') endif if a:rxDesc != "" let lnk = substitute(lnk, '__LinkDescription__', '\='."'".a:rxDesc."'", 'g') endif if a:rxStyle != "" let lnk = substitute(lnk, '__LinkStyle__', '\='."'".a:rxStyle."'", 'g') endif return lnk endfunction " }}} " s:clean_url function! s:clean_url(url) " {{{ let url = split(a:url, '/\|=\|-\|&\|?\|\.') let url = filter(url, 'v:val !=# ""') let url = filter(url, 'v:val !=# "www"') let url = filter(url, 'v:val !=# "com"') let url = filter(url, 'v:val !=# "org"') let url = filter(url, 'v:val !=# "net"') let url = filter(url, 'v:val !=# "edu"') let url = filter(url, 'v:val !=# "http\:"') let url = filter(url, 'v:val !=# "https\:"') let url = filter(url, 'v:val !=# "file\:"') let url = filter(url, 'v:val !=# "xml\:"') return join(url, " ") endfunction " }}} " s:is_diary_file function! s:is_diary_file(filename) " {{{ let file_path = vimwiki#path#path_norm(a:filename) let rel_path = VimwikiGet('diary_rel_path') let diary_path = vimwiki#path#path_norm(VimwikiGet('path') . rel_path) return rel_path != '' \ && file_path =~# '^'.vimwiki#u#escape(diary_path) endfunction " }}} " vimwiki#base#normalize_link_helper function! vimwiki#base#normalize_link_helper(str, rxUrl, rxDesc, template) " {{{ let str = a:str let url = matchstr(str, a:rxUrl) let descr = matchstr(str, a:rxDesc) let template = a:template if descr == "" let descr = s:clean_url(url) endif let lnk = substitute(template, '__LinkDescription__', '\="'.descr.'"', '') let lnk = substitute(lnk, '__LinkUrl__', '\="'.url.'"', '') return lnk endfunction " }}} " vimwiki#base#normalize_imagelink_helper function! vimwiki#base#normalize_imagelink_helper(str, rxUrl, rxDesc, rxStyle, template) "{{{ let lnk = vimwiki#base#normalize_link_helper(a:str, a:rxUrl, a:rxDesc, a:template) let style = matchstr(a:str, a:rxStyle) let lnk = substitute(lnk, '__LinkStyle__', '\="'.style.'"', '') return lnk endfunction " }}} " s:normalize_link_in_diary function! s:normalize_link_in_diary(lnk) " {{{ let link = a:lnk . VimwikiGet('ext') let link_wiki = VimwikiGet('path') . '/' . link let link_diary = VimwikiGet('path') . '/' \ . VimwikiGet('diary_rel_path') . '/' . link let link_exists_in_diary = filereadable(link_diary) let link_exists_in_wiki = filereadable(link_wiki) let link_is_date = a:lnk =~# '\d\d\d\d-\d\d-\d\d' if ! link_exists_in_wiki || link_exists_in_diary || link_is_date let str = a:lnk let rxUrl = g:vimwiki_rxWord let rxDesc = '' let template = g:vimwiki_WikiLinkTemplate1 else let depth = len(split(VimwikiGet('diary_rel_path'), '/')) let str = repeat('../', depth) . a:lnk . '|' . a:lnk let rxUrl = '^.*\ze|' let rxDesc = '|\zs.*$' let template = g:vimwiki_WikiLinkTemplate2 endif return vimwiki#base#normalize_link_helper(str, rxUrl, rxDesc, template) endfunction " }}} " s:normalize_link_syntax_n function! s:normalize_link_syntax_n() " {{{ " try WikiLink let lnk = vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWikiLink) if !empty(lnk) let sub = vimwiki#base#normalize_link_helper(lnk, \ g:vimwiki_rxWikiLinkMatchUrl, g:vimwiki_rxWikiLinkMatchDescr, \ g:vimwiki_WikiLinkTemplate2) call vimwiki#base#replacestr_at_cursor(g:vimwiki_rxWikiLink, sub) if g:vimwiki_debug > 1 echomsg "WikiLink: ".lnk." Sub: ".sub endif return endif " try WikiIncl let lnk = vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWikiIncl) if !empty(lnk) " NO-OP !! if g:vimwiki_debug > 1 echomsg "WikiIncl: ".lnk." Sub: ".lnk endif return endif " try Word (any characters except separators) " rxWord is less permissive than rxWikiLinkUrl which is used in " normalize_link_syntax_v let lnk = vimwiki#base#matchstr_at_cursor(g:vimwiki_rxWord) if !empty(lnk) if s:is_diary_file(expand("%:p")) let sub = s:normalize_link_in_diary(lnk) else let sub = vimwiki#base#normalize_link_helper(lnk, \ g:vimwiki_rxWord, '', \ g:vimwiki_WikiLinkTemplate1) endif call vimwiki#base#replacestr_at_cursor('\V'.lnk, sub) if g:vimwiki_debug > 1 echomsg "Word: ".lnk." Sub: ".sub endif return endif endfunction " }}} " s:normalize_link_syntax_v function! s:normalize_link_syntax_v() " {{{ let sel_save = &selection let &selection = "old" let rv = @" let rt = getregtype('"') try " Save selected text to register " normal! gv""y " Set substitution if s:is_diary_file(expand("%:p")) let sub = s:normalize_link_in_diary(@") else let sub = substitute(g:vimwiki_WikiLinkTemplate1, \ '__LinkUrl__', '\=' . "'" . @" . "'", '') endif " Put substitution in register " and change text call setreg('"', sub, 'v') normal! `>""pgvd finally call setreg('"', rv, rt) let &selection = sel_save endtry endfunction " }}} " vimwiki#base#normalize_link function! vimwiki#base#normalize_link(is_visual_mode) "{{{ if exists('*vimwiki#'.VimwikiGet('syntax').'_base#normalize_link') " Syntax-specific links call vimwiki#{VimwikiGet('syntax')}_base#normalize_link(a:is_visual_mode) else if !a:is_visual_mode call s:normalize_link_syntax_n() elseif visualmode() ==# 'v' && line("'<") == line("'>") " action undefined for 'line-wise' or 'multi-line' visual mode selections call s:normalize_link_syntax_v() endif endif endfunction "}}} " }}} " Command completion functions {{{ " vimwiki#base#complete_links_escaped function! vimwiki#base#complete_links_escaped(ArgLead, CmdLine, CursorPos) abort " {{{ " We can safely ignore args if we use -custom=complete option, Vim engine " will do the job of filtering. return vimwiki#base#get_globlinks_escaped() endfunction " }}} "}}} " ------------------------------------------------------------------------- " Load syntax-specific Wiki functionality for s:syn in s:vimwiki_get_known_syntaxes() execute 'runtime! autoload/vimwiki/'.s:syn.'_base.vim' endfor " -------------------------------------------------------------------------