diff options
author | altermo <107814000+altermo@users.noreply.github.com> | 2024-02-26 11:42:51 -0800 |
---|---|---|
committer | Lewis Russell <me@lewisr.dev> | 2024-02-28 16:26:00 +0000 |
commit | 2f85bbe61513d12c746641fed6ad07559bd95719 (patch) | |
tree | 52bf628d6ea746e7508d576b441122beffe8a3b7 | |
parent | c538ec85220aea11bbdb52028aa335787e9e4f42 (diff) | |
download | rneovim-2f85bbe61513d12c746641fed6ad07559bd95719.tar.gz rneovim-2f85bbe61513d12c746641fed6ad07559bd95719.tar.bz2 rneovim-2f85bbe61513d12c746641fed6ad07559bd95719.zip |
feat!: rewrite TOhtml in lua
Co-authored-by: wookayin <wookayin@gmail.com>
Co-authored-by: clason <c.clason@uni-graz.at>
Co-authored-by: Lewis Russell <me@lewisr.dev>
-rw-r--r-- | runtime/autoload/tohtml.vim | 951 | ||||
-rw-r--r-- | runtime/doc/lua.txt | 31 | ||||
-rw-r--r-- | runtime/doc/news.txt | 3 | ||||
-rw-r--r-- | runtime/doc/syntax.txt | 438 | ||||
-rw-r--r-- | runtime/doc/vim_diff.txt | 1 | ||||
-rw-r--r-- | runtime/lua/tohtml.lua | 1335 | ||||
-rw-r--r-- | runtime/plugin/tohtml.lua | 11 | ||||
-rw-r--r-- | runtime/plugin/tohtml.vim | 254 | ||||
-rw-r--r-- | runtime/syntax/2html.vim | 2068 | ||||
-rwxr-xr-x | scripts/gen_vimdoc.lua | 7 | ||||
-rw-r--r-- | test/functional/plugin/tohtml_spec.lua | 370 |
11 files changed, 1761 insertions, 3708 deletions
diff --git a/runtime/autoload/tohtml.vim b/runtime/autoload/tohtml.vim deleted file mode 100644 index b1693efc5d..0000000000 --- a/runtime/autoload/tohtml.vim +++ /dev/null @@ -1,951 +0,0 @@ -" Vim autoload file for the tohtml plugin. -" Maintainer: Ben Fritz <fritzophrenic@gmail.com> -" Last Change: 2023 Sep 03 -" -" Additional contributors: -" -" Original by Bram Moolenaar <Bram@vim.org> -" Diff2HTML() added by Christian Brabandt <cb@256bit.org> -" -" See Mercurial change logs for more! - -" this file uses line continuations -let s:cpo_sav = &cpo -set cpo&vim - -" Automatically find charsets from all encodings supported natively by Vim. With -" the 8bit- and 2byte- prefixes, Vim can actually support more encodings than -" this. Let the user specify these however since they won't be supported on -" every system. -" -" Note, not all of Vim's supported encodings have a charset to use. -" -" Names in this list are from: -" http://www.iana.org/assignments/character-sets -" g:tohtml#encoding_to_charset: {{{ -let g:tohtml#encoding_to_charset = { - \ 'latin1' : 'ISO-8859-1', - \ 'iso-8859-2' : 'ISO-8859-2', - \ 'iso-8859-3' : 'ISO-8859-3', - \ 'iso-8859-4' : 'ISO-8859-4', - \ 'iso-8859-5' : 'ISO-8859-5', - \ 'iso-8859-6' : 'ISO-8859-6', - \ 'iso-8859-7' : 'ISO-8859-7', - \ 'iso-8859-8' : 'ISO-8859-8', - \ 'iso-8859-9' : 'ISO-8859-9', - \ 'iso-8859-10' : '', - \ 'iso-8859-13' : 'ISO-8859-13', - \ 'iso-8859-14' : '', - \ 'iso-8859-15' : 'ISO-8859-15', - \ 'koi8-r' : 'KOI8-R', - \ 'koi8-u' : 'KOI8-U', - \ 'macroman' : 'macintosh', - \ 'cp437' : '', - \ 'cp775' : '', - \ 'cp850' : '', - \ 'cp852' : '', - \ 'cp855' : '', - \ 'cp857' : '', - \ 'cp860' : '', - \ 'cp861' : '', - \ 'cp862' : '', - \ 'cp863' : '', - \ 'cp865' : '', - \ 'cp866' : 'IBM866', - \ 'cp869' : '', - \ 'cp874' : '', - \ 'cp1250' : 'windows-1250', - \ 'cp1251' : 'windows-1251', - \ 'cp1253' : 'windows-1253', - \ 'cp1254' : 'windows-1254', - \ 'cp1255' : 'windows-1255', - \ 'cp1256' : 'windows-1256', - \ 'cp1257' : 'windows-1257', - \ 'cp1258' : 'windows-1258', - \ 'euc-jp' : 'EUC-JP', - \ 'sjis' : 'Shift_JIS', - \ 'cp932' : 'Shift_JIS', - \ 'cp949' : '', - \ 'euc-kr' : 'EUC-KR', - \ 'cp936' : 'GBK', - \ 'euc-cn' : 'GB2312', - \ 'big5' : 'Big5', - \ 'cp950' : 'Big5', - \ 'utf-8' : 'UTF-8', - \ 'ucs-2' : 'UTF-8', - \ 'ucs-2le' : 'UTF-8', - \ 'utf-16' : 'UTF-8', - \ 'utf-16le' : 'UTF-8', - \ 'ucs-4' : 'UTF-8', - \ 'ucs-4le' : 'UTF-8', - \ } -lockvar g:tohtml#encoding_to_charset -" Notes: -" 1. All UCS/UTF are converted to UTF-8 because it is much better supported -" 2. Any blank spaces are there because Vim supports it but at least one major -" web browser does not according to http://wiki.whatwg.org/wiki/Web_Encodings. -" }}} - -" Only automatically find encodings supported natively by Vim, let the user -" specify the encoding if it's not natively supported. This function is only -" used when the user specifies the charset, they better know what they are -" doing! -" -" Names in this list are from: -" http://www.iana.org/assignments/character-sets -" g:tohtml#charset_to_encoding: {{{ -let g:tohtml#charset_to_encoding = { - \ 'iso_8859-1:1987' : 'latin1', - \ 'iso-ir-100' : 'latin1', - \ 'iso_8859-1' : 'latin1', - \ 'iso-8859-1' : 'latin1', - \ 'latin1' : 'latin1', - \ 'l1' : 'latin1', - \ 'ibm819' : 'latin1', - \ 'cp819' : 'latin1', - \ 'csisolatin1' : 'latin1', - \ 'iso_8859-2:1987' : 'iso-8859-2', - \ 'iso-ir-101' : 'iso-8859-2', - \ 'iso_8859-2' : 'iso-8859-2', - \ 'iso-8859-2' : 'iso-8859-2', - \ 'latin2' : 'iso-8859-2', - \ 'l2' : 'iso-8859-2', - \ 'csisolatin2' : 'iso-8859-2', - \ 'iso_8859-3:1988' : 'iso-8859-3', - \ 'iso-ir-109' : 'iso-8859-3', - \ 'iso_8859-3' : 'iso-8859-3', - \ 'iso-8859-3' : 'iso-8859-3', - \ 'latin3' : 'iso-8859-3', - \ 'l3' : 'iso-8859-3', - \ 'csisolatin3' : 'iso-8859-3', - \ 'iso_8859-4:1988' : 'iso-8859-4', - \ 'iso-ir-110' : 'iso-8859-4', - \ 'iso_8859-4' : 'iso-8859-4', - \ 'iso-8859-4' : 'iso-8859-4', - \ 'latin4' : 'iso-8859-4', - \ 'l4' : 'iso-8859-4', - \ 'csisolatin4' : 'iso-8859-4', - \ 'iso_8859-5:1988' : 'iso-8859-5', - \ 'iso-ir-144' : 'iso-8859-5', - \ 'iso_8859-5' : 'iso-8859-5', - \ 'iso-8859-5' : 'iso-8859-5', - \ 'cyrillic' : 'iso-8859-5', - \ 'csisolatincyrillic' : 'iso-8859-5', - \ 'iso_8859-6:1987' : 'iso-8859-6', - \ 'iso-ir-127' : 'iso-8859-6', - \ 'iso_8859-6' : 'iso-8859-6', - \ 'iso-8859-6' : 'iso-8859-6', - \ 'ecma-114' : 'iso-8859-6', - \ 'asmo-708' : 'iso-8859-6', - \ 'arabic' : 'iso-8859-6', - \ 'csisolatinarabic' : 'iso-8859-6', - \ 'iso_8859-7:1987' : 'iso-8859-7', - \ 'iso-ir-126' : 'iso-8859-7', - \ 'iso_8859-7' : 'iso-8859-7', - \ 'iso-8859-7' : 'iso-8859-7', - \ 'elot_928' : 'iso-8859-7', - \ 'ecma-118' : 'iso-8859-7', - \ 'greek' : 'iso-8859-7', - \ 'greek8' : 'iso-8859-7', - \ 'csisolatingreek' : 'iso-8859-7', - \ 'iso_8859-8:1988' : 'iso-8859-8', - \ 'iso-ir-138' : 'iso-8859-8', - \ 'iso_8859-8' : 'iso-8859-8', - \ 'iso-8859-8' : 'iso-8859-8', - \ 'hebrew' : 'iso-8859-8', - \ 'csisolatinhebrew' : 'iso-8859-8', - \ 'iso_8859-9:1989' : 'iso-8859-9', - \ 'iso-ir-148' : 'iso-8859-9', - \ 'iso_8859-9' : 'iso-8859-9', - \ 'iso-8859-9' : 'iso-8859-9', - \ 'latin5' : 'iso-8859-9', - \ 'l5' : 'iso-8859-9', - \ 'csisolatin5' : 'iso-8859-9', - \ 'iso-8859-10' : 'iso-8859-10', - \ 'iso-ir-157' : 'iso-8859-10', - \ 'l6' : 'iso-8859-10', - \ 'iso_8859-10:1992' : 'iso-8859-10', - \ 'csisolatin6' : 'iso-8859-10', - \ 'latin6' : 'iso-8859-10', - \ 'iso-8859-13' : 'iso-8859-13', - \ 'iso-8859-14' : 'iso-8859-14', - \ 'iso-ir-199' : 'iso-8859-14', - \ 'iso_8859-14:1998' : 'iso-8859-14', - \ 'iso_8859-14' : 'iso-8859-14', - \ 'latin8' : 'iso-8859-14', - \ 'iso-celtic' : 'iso-8859-14', - \ 'l8' : 'iso-8859-14', - \ 'iso-8859-15' : 'iso-8859-15', - \ 'iso_8859-15' : 'iso-8859-15', - \ 'latin-9' : 'iso-8859-15', - \ 'koi8-r' : 'koi8-r', - \ 'cskoi8r' : 'koi8-r', - \ 'koi8-u' : 'koi8-u', - \ 'macintosh' : 'macroman', - \ 'mac' : 'macroman', - \ 'csmacintosh' : 'macroman', - \ 'ibm437' : 'cp437', - \ 'cp437' : 'cp437', - \ '437' : 'cp437', - \ 'cspc8codepage437' : 'cp437', - \ 'ibm775' : 'cp775', - \ 'cp775' : 'cp775', - \ 'cspc775baltic' : 'cp775', - \ 'ibm850' : 'cp850', - \ 'cp850' : 'cp850', - \ '850' : 'cp850', - \ 'cspc850multilingual' : 'cp850', - \ 'ibm852' : 'cp852', - \ 'cp852' : 'cp852', - \ '852' : 'cp852', - \ 'cspcp852' : 'cp852', - \ 'ibm855' : 'cp855', - \ 'cp855' : 'cp855', - \ '855' : 'cp855', - \ 'csibm855' : 'cp855', - \ 'ibm857' : 'cp857', - \ 'cp857' : 'cp857', - \ '857' : 'cp857', - \ 'csibm857' : 'cp857', - \ 'ibm860' : 'cp860', - \ 'cp860' : 'cp860', - \ '860' : 'cp860', - \ 'csibm860' : 'cp860', - \ 'ibm861' : 'cp861', - \ 'cp861' : 'cp861', - \ '861' : 'cp861', - \ 'cp-is' : 'cp861', - \ 'csibm861' : 'cp861', - \ 'ibm862' : 'cp862', - \ 'cp862' : 'cp862', - \ '862' : 'cp862', - \ 'cspc862latinhebrew' : 'cp862', - \ 'ibm863' : 'cp863', - \ 'cp863' : 'cp863', - \ '863' : 'cp863', - \ 'csibm863' : 'cp863', - \ 'ibm865' : 'cp865', - \ 'cp865' : 'cp865', - \ '865' : 'cp865', - \ 'csibm865' : 'cp865', - \ 'ibm866' : 'cp866', - \ 'cp866' : 'cp866', - \ '866' : 'cp866', - \ 'csibm866' : 'cp866', - \ 'ibm869' : 'cp869', - \ 'cp869' : 'cp869', - \ '869' : 'cp869', - \ 'cp-gr' : 'cp869', - \ 'csibm869' : 'cp869', - \ 'windows-1250' : 'cp1250', - \ 'windows-1251' : 'cp1251', - \ 'windows-1253' : 'cp1253', - \ 'windows-1254' : 'cp1254', - \ 'windows-1255' : 'cp1255', - \ 'windows-1256' : 'cp1256', - \ 'windows-1257' : 'cp1257', - \ 'windows-1258' : 'cp1258', - \ 'extended_unix_code_packed_format_for_japanese' : 'euc-jp', - \ 'cseucpkdfmtjapanese' : 'euc-jp', - \ 'euc-jp' : 'euc-jp', - \ 'shift_jis' : 'sjis', - \ 'ms_kanji' : 'sjis', - \ 'sjis' : 'sjis', - \ 'csshiftjis' : 'sjis', - \ 'ibm-thai' : 'cp874', - \ 'csibmthai' : 'cp874', - \ 'ks_c_5601-1987' : 'cp949', - \ 'iso-ir-149' : 'cp949', - \ 'ks_c_5601-1989' : 'cp949', - \ 'ksc_5601' : 'cp949', - \ 'korean' : 'cp949', - \ 'csksc56011987' : 'cp949', - \ 'euc-kr' : 'euc-kr', - \ 'cseuckr' : 'euc-kr', - \ 'gbk' : 'cp936', - \ 'cp936' : 'cp936', - \ 'ms936' : 'cp936', - \ 'windows-936' : 'cp936', - \ 'gb_2312-80' : 'euc-cn', - \ 'iso-ir-58' : 'euc-cn', - \ 'chinese' : 'euc-cn', - \ 'csiso58gb231280' : 'euc-cn', - \ 'big5' : 'big5', - \ 'csbig5' : 'big5', - \ 'utf-8' : 'utf-8', - \ 'iso-10646-ucs-2' : 'ucs-2', - \ 'csunicode' : 'ucs-2', - \ 'utf-16' : 'utf-16', - \ 'utf-16be' : 'utf-16', - \ 'utf-16le' : 'utf-16le', - \ 'utf-32' : 'ucs-4', - \ 'utf-32be' : 'ucs-4', - \ 'utf-32le' : 'ucs-4le', - \ 'iso-10646-ucs-4' : 'ucs-4', - \ 'csucs4' : 'ucs-4' - \ } -lockvar g:tohtml#charset_to_encoding -"}}} - -func! tohtml#Convert2HTML(line1, line2) "{{{ - let s:settings = tohtml#GetUserSettings() - - if !&diff || s:settings.diff_one_file "{{{ - if a:line2 >= a:line1 - let g:html_start_line = a:line1 - let g:html_end_line = a:line2 - else - let g:html_start_line = a:line2 - let g:html_end_line = a:line1 - endif - runtime syntax/2html.vim "}}} - else "{{{ - let win_list = [] - let buf_list = [] - windo if &diff | call add(win_list, winbufnr(0)) | endif - let s:settings.whole_filler = 1 - let g:html_diff_win_num = 0 - for window in win_list - " switch to the next buffer to convert - exe ":" .. bufwinnr(window) .. "wincmd w" - - " figure out whether current charset and encoding will work, if not - " default to UTF-8 - if !exists('g:html_use_encoding') && - \ (((&l:fileencoding=='' || (&l:buftype!='' && &l:buftype!=?'help')) - \ && &encoding!=?s:settings.vim_encoding) - \ || &l:fileencoding!='' && &l:fileencoding!=?s:settings.vim_encoding) - echohl WarningMsg - echomsg "TOhtml: mismatched file encodings in Diff buffers, using UTF-8" - echohl None - let s:settings.vim_encoding = 'utf-8' - let s:settings.encoding = 'UTF-8' - endif - - " set up for diff-mode conversion - let g:html_start_line = 1 - let g:html_end_line = line('$') - let g:html_diff_win_num += 1 - - " convert this file - runtime syntax/2html.vim - - " remember the HTML buffer for later combination - call add(buf_list, bufnr('%')) - endfor - unlet g:html_diff_win_num - call tohtml#Diff2HTML(win_list, buf_list) - endif "}}} - - unlet g:html_start_line - unlet g:html_end_line - unlet s:settings -endfunc "}}} - -func! tohtml#Diff2HTML(win_list, buf_list) "{{{ - let xml_line = "" - let tag_close = '>' - - let s:old_paste = &paste - set paste - let s:old_magic = &magic - set magic - - let html = [] - if !s:settings.no_doc - if s:settings.use_xhtml - if s:settings.encoding != "" - let xml_line = "<?xml version=\"1.0\" encoding=\"" .. s:settings.encoding .. "\"?>" - else - let xml_line = "<?xml version=\"1.0\"?>" - endif - let tag_close = ' />' - endif - - let style = [s:settings.use_xhtml ? "" : '-->'] - let body_line = '' - - let s:html5 = 0 - if s:settings.use_xhtml - call add(html, xml_line) - endif - if s:settings.use_xhtml - call add(html, "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">") - call add(html, '<html xmlns="http://www.w3.org/1999/xhtml">') - elseif s:settings.use_css && !s:settings.no_pre - call add(html, "<!DOCTYPE html>") - call add(html, '<html>') - let s:html5 = 1 - else - call add(html, '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"') - call add(html, ' "http://www.w3.org/TR/html4/loose.dtd">') - call add(html, '<html>') - endif - call add(html, '<head>') - - " include encoding as close to the top as possible, but only if not already - " contained in XML information - if s:settings.encoding != "" && !s:settings.use_xhtml - if s:html5 - call add(html, '<meta charset="' .. s:settings.encoding .. '"' .. tag_close) - else - call add(html, "<meta http-equiv=\"content-type\" content=\"text/html; charset=" .. s:settings.encoding .. '"' .. tag_close) - endif - endif - - call add(html, '<title>diff</title>') - call add(html, '<meta name="Generator" content="Vim/'..v:version/100..'.'..v:version%100..'"'..tag_close) - call add(html, '<meta name="plugin-version" content="'..g:loaded_2html_plugin..'"'..tag_close) - call add(html, '<meta name="settings" content="'. - \ join(filter(keys(s:settings),'s:settings[v:val]'),','). - \ ',prevent_copy='..s:settings.prevent_copy. - \ ',use_input_for_pc='..s:settings.use_input_for_pc. - \ '"'..tag_close) - call add(html, '<meta name="colorscheme" content="'. - \ (exists('g:colors_name') - \ ? g:colors_name - \ : 'none').. '"'..tag_close) - - call add(html, '</head>') - let body_line_num = len(html) - call add(html, '<body'..(s:settings.line_ids ? ' onload="JumpToLine();"' : '')..'>') - endif - call add(html, "<table "..(s:settings.use_css? "" : "border='1' width='100%' ").."id='vimCodeElement"..s:settings.id_suffix.."'>") - - call add(html, '<tr>') - for buf in a:win_list - call add(html, '<th>'..bufname(buf)..'</th>') - endfor - call add(html, '</tr><tr>') - - let diff_style_start = 0 - let insert_index = 0 - - for buf in a:buf_list - let temp = [] - exe bufwinnr(buf) .. 'wincmd w' - - " If text is folded because of user foldmethod settings, etc. we don't want - " to act on everything in a fold by mistake. - setlocal nofoldenable - - " When not using CSS or when using xhtml, the <body> line can be important. - " Assume it will be the same for all buffers and grab it from the first - " buffer. Similarly, need to grab the body end line as well. - if !s:settings.no_doc - if body_line == '' - 1 - call search('<body') - let body_line = getline('.') - $ - call search('</body>', 'b') - let s:body_end_line = getline('.') - endif - - " Grab the style information. Some of this will be duplicated so only insert - " it if it's not already there. {{{ - 1 - let style_start = search('^<style\( type="text/css"\)\?>') - 1 - let style_end = search('^</style>') - if style_start > 0 && style_end > 0 - let buf_styles = getline(style_start + 1, style_end - 1) - for a_style in buf_styles - if index(style, a_style) == -1 - if diff_style_start == 0 - if a_style =~ '\<Diff\(Change\|Text\|Add\|Delete\)' - let diff_style_start = len(style)-1 - endif - endif - call insert(style, a_style, insert_index) - let insert_index += 1 - endif - endfor - endif " }}} - - " everything new will get added before the diff styles so diff highlight - " properly overrides normal highlight - if diff_style_start != 0 - let insert_index = diff_style_start - endif - - " Delete those parts that are not needed so we can include the rest into the - " resulting table. - 1,/^<body.*\%(\n<!--.*-->\_s\+.*id='oneCharWidth'.*\_s\+.*id='oneInputWidth'.*\_s\+.*id='oneEmWidth'\)\?\zs/d_ - $ - ?</body>?,$d_ - elseif !s:settings.no_modeline - " remove modeline from source files if it is included and we haven't deleted - " due to removing html footer already - $d - endif - let temp = getline(1,'$') - " clean out id on the main content container because we already set it on - " the table - let temp[0] = substitute(temp[0], " id='vimCodeElement[^']*'", "", "") - " undo deletion of start and end part - " so we can later save the file as valid html - " TODO: restore using grabbed lines if undolevel is 1? - if !s:settings.no_doc - normal! 2u - elseif !s:settings.no_modeline - normal! u - endif - if s:settings.use_css - call add(html, '<td><div>') - elseif s:settings.use_xhtml - call add(html, '<td nowrap="nowrap" valign="top"><div>') - else - call add(html, '<td nowrap valign="top"><div>') - endif - let html += temp - call add(html, '</div></td>') - - " Close this buffer - " TODO: the comment above says we're going to allow saving the file - " later...but here we discard it? - quit! - endfor - - if !s:settings.no_doc - let html[body_line_num] = body_line - endif - - call add(html, '</tr>') - call add(html, '</table>') - if !s:settings.no_doc - call add(html, s:body_end_line) - call add(html, '</html>') - endif - - " The generated HTML is admittedly ugly and takes a LONG time to fold. - " Make sure the user doesn't do syntax folding when loading a generated file, - " using a modeline. - if !s:settings.no_modeline - call add(html, '<!-- vim: set foldmethod=manual : -->') - endif - - let i = 1 - let name = "Diff" .. (s:settings.use_xhtml ? ".xhtml" : ".html") - " Find an unused file name if current file name is already in use - while filereadable(name) - let name = substitute(name, '\d*\.x\?html$', '', '') .. i .. '.' .. fnamemodify(copy(name), ":t:e") - let i += 1 - endwhile - - let s:ei_sav = &eventignore - set eventignore+=FileType - exe "topleft new " .. name - let &eventignore=s:ei_sav - unlet s:ei_sav - - setlocal modifiable - - " just in case some user autocmd creates content in the new buffer, make sure - " it is empty before proceeding - %d - - " set the fileencoding to match the charset we'll be using - let &l:fileencoding=s:settings.vim_encoding - - " According to http://www.w3.org/TR/html4/charset.html#doc-char-set, the byte - " order mark is highly recommend on the web when using multibyte encodings. But, - " it is not a good idea to include it on UTF-8 files. Otherwise, let Vim - " determine when it is actually inserted. - if s:settings.vim_encoding == 'utf-8' - setlocal nobomb - else - setlocal bomb - endif - - call append(0, html) - - if !s:settings.no_doc - if len(style) > 0 - 1 - let style_start = search('^</head>')-1 - - " add required javascript in reverse order so we can just call append again - " and again without adjusting {{{ - - let s:uses_script = s:settings.dynamic_folds || s:settings.line_ids - - " insert script closing tag if needed - if s:uses_script - call append(style_start, [ - \ '', - \ s:settings.use_xhtml ? '//]]>' : '-->', - \ "</script>" - \ ]) - endif - - " insert javascript to get IDs from line numbers, and to open a fold before - " jumping to any lines contained therein - if s:settings.line_ids - call append(style_start, [ - \ " /* Always jump to new location even if the line was hidden inside a fold, or", - \ " * we corrected the raw number to a line ID.", - \ " */", - \ " if (lineElem) {", - \ " lineElem.scrollIntoView(true);", - \ " }", - \ " return true;", - \ "}", - \ "if ('onhashchange' in window) {", - \ " window.onhashchange = JumpToLine;", - \ "}" - \ ]) - - if s:settings.dynamic_folds - call append(style_start, [ - \ "", - \ " /* navigate upwards in the DOM tree to open all folds containing the line */", - \ " var node = lineElem;", - \ " while (node && node.id != 'vimCodeElement"..s:settings.id_suffix.."')", - \ " {", - \ " if (node.className == 'closed-fold')", - \ " {", - \ " /* toggle open the fold ID (remove window ID) */", - \ " toggleFold(node.id.substr(4));", - \ " }", - \ " node = node.parentNode;", - \ " }", - \ ]) - endif - endif - - if s:settings.line_ids - call append(style_start, [ - \ "", - \ "/* function to open any folds containing a jumped-to line before jumping to it */", - \ "function JumpToLine()", - \ "{", - \ " var lineNum;", - \ " lineNum = window.location.hash;", - \ " lineNum = lineNum.substr(1); /* strip off '#' */", - \ "", - \ " if (lineNum.indexOf('L') == -1) {", - \ " lineNum = 'L'+lineNum;", - \ " }", - \ " if (lineNum.indexOf('W') == -1) {", - \ " lineNum = 'W1'+lineNum;", - \ " }", - \ " var lineElem = document.getElementById(lineNum);" - \ ]) - endif - - " Insert javascript to toggle matching folds open and closed in all windows, - " if dynamic folding is active. - if s:settings.dynamic_folds - call append(style_start, [ - \ " function toggleFold(objID)", - \ " {", - \ " for (win_num = 1; win_num <= "..len(a:buf_list).."; win_num++)", - \ " {", - \ " var fold;", - \ ' fold = document.getElementById("win"+win_num+objID);', - \ " if(fold.className == 'closed-fold')", - \ " {", - \ " fold.className = 'open-fold';", - \ " }", - \ " else if (fold.className == 'open-fold')", - \ " {", - \ " fold.className = 'closed-fold';", - \ " }", - \ " }", - \ " }", - \ ]) - endif - - if s:uses_script - " insert script tag if needed - call append(style_start, [ - \ "<script" .. (s:html5 ? "" : " type='text/javascript'") .. ">", - \ s:settings.use_xhtml ? '//<![CDATA[' : "<!--"]) - endif - - " Insert styles from all the generated html documents and additional styles - " for the table-based layout of the side-by-side diff. The diff should take - " up the full browser window (but not more), and be static in size, - " horizontally scrollable when the lines are too long. Otherwise, the diff - " is pretty useless for really long lines. {{{ - if s:settings.use_css - call append(style_start, - \ ['<style' .. (s:html5 ? '' : 'type="text/css"') .. '>']+ - \ style+ - \ [ s:settings.use_xhtml ? '' : '<!--', - \ 'table { table-layout: fixed; }', - \ 'html, body, table, tbody { width: 100%; margin: 0; padding: 0; }', - \ 'table, td, th { border: 1px solid; }', - \ 'td { vertical-align: top; }', - \ 'th, td { width: '..printf("%.1f",100.0/len(a:win_list))..'%; }', - \ 'td div { overflow: auto; }', - \ s:settings.use_xhtml ? '' : '-->', - \ '</style>' - \]) - endif "}}} - endif - endif - - let &paste = s:old_paste - let &magic = s:old_magic -endfunc "}}} - -" Gets a single user option and sets it in the passed-in Dict, or gives it the -" default value if the option doesn't actually exist. -func! tohtml#GetOption(settings, option, default) "{{{ - if exists('g:html_'..a:option) - let a:settings[a:option] = g:html_{a:option} - else - let a:settings[a:option] = a:default - endif -endfunc "}}} - -" returns a Dict containing the values of all user options for 2html, including -" default values for those not given an explicit value by the user. Discards the -" html_ prefix of the option for nicer looking code. -func! tohtml#GetUserSettings() "{{{ - if exists('s:settings') - " just restore the known options if we've already retrieved them - return s:settings - else - " otherwise figure out which options are set - let user_settings = {} - - " Define the correct option if the old option name exists and we haven't - " already defined the correct one. - if exists('g:use_xhtml') && !exists("g:html_use_xhtml") - echohl WarningMsg - echomsg "Warning: g:use_xhtml is deprecated, use g:html_use_xhtml" - echohl None - let g:html_use_xhtml = g:use_xhtml - endif - - " get current option settings with appropriate defaults {{{ - call tohtml#GetOption(user_settings, 'no_progress', !has("statusline") ) - call tohtml#GetOption(user_settings, 'diff_one_file', 0 ) - call tohtml#GetOption(user_settings, 'number_lines', &number ) - call tohtml#GetOption(user_settings, 'pre_wrap', &wrap ) - call tohtml#GetOption(user_settings, 'use_css', 1 ) - call tohtml#GetOption(user_settings, 'ignore_conceal', 0 ) - call tohtml#GetOption(user_settings, 'ignore_folding', 0 ) - call tohtml#GetOption(user_settings, 'dynamic_folds', 0 ) - call tohtml#GetOption(user_settings, 'no_foldcolumn', user_settings.ignore_folding) - call tohtml#GetOption(user_settings, 'hover_unfold', 0 ) - call tohtml#GetOption(user_settings, 'no_pre', 0 ) - call tohtml#GetOption(user_settings, 'no_doc', 0 ) - call tohtml#GetOption(user_settings, 'no_links', 0 ) - call tohtml#GetOption(user_settings, 'no_modeline', 0 ) - call tohtml#GetOption(user_settings, 'no_invalid', 0 ) - call tohtml#GetOption(user_settings, 'whole_filler', 0 ) - call tohtml#GetOption(user_settings, 'use_xhtml', 0 ) - call tohtml#GetOption(user_settings, 'line_ids', user_settings.number_lines ) - call tohtml#GetOption(user_settings, 'use_input_for_pc', 'none') - " }}} - - " override those settings that need it {{{ - - " hover opening implies dynamic folding - if user_settings.hover_unfold - let user_settings.dynamic_folds = 1 - endif - - " ignore folding overrides dynamic folding - if user_settings.ignore_folding && user_settings.dynamic_folds - let user_settings.dynamic_folds = 0 - let user_settings.hover_unfold = 0 - endif - - " dynamic folding with no foldcolumn implies hover opens - if user_settings.dynamic_folds && user_settings.no_foldcolumn - let user_settings.hover_unfold = 1 - endif - - " dynamic folding implies css - if user_settings.dynamic_folds - let user_settings.use_css = 1 - else - let user_settings.no_foldcolumn = 1 " won't do anything but for consistency and for the test suite - endif - - " if we're not using CSS we cannot use a pre section because <font> tags - " aren't allowed inside a <pre> block - if !user_settings.use_css - let user_settings.no_pre = 1 - endif - - " pre_wrap doesn't do anything if not using pre or not using CSS - if user_settings.no_pre || !user_settings.use_css - let user_settings.pre_wrap = 0 - endif - "}}} - - " set up expand_tabs option after all the overrides so we know the - " appropriate defaults {{{ - if user_settings.no_pre == 0 - call tohtml#GetOption(user_settings, - \ 'expand_tabs', - \ &expandtab || &ts != 8 || (exists("+vts") && &vts != '') || user_settings.number_lines || - \ (user_settings.dynamic_folds && !user_settings.no_foldcolumn)) - else - let user_settings.expand_tabs = 1 - endif - " }}} - - " textual options - if exists("g:html_use_encoding") "{{{ - " user specified the desired MIME charset, figure out proper - " 'fileencoding' from it or warn the user if we cannot - let user_settings.encoding = g:html_use_encoding - let user_settings.vim_encoding = tohtml#EncodingFromCharset(g:html_use_encoding) - if user_settings.vim_encoding == '' - echohl WarningMsg - echomsg "TOhtml: file encoding for" - \ g:html_use_encoding - \ "unknown, please set 'fileencoding'" - echohl None - endif - else - " Figure out proper MIME charset from 'fileencoding' if possible - if &l:fileencoding != '' - " If the buffer is not a "normal" type, the 'fileencoding' value may not - " be trusted; since the buffer should not be written the fileencoding is - " not intended to be used. - if &l:buftype=='' || &l:buftype==?'help' - let user_settings.vim_encoding = &l:fileencoding - call tohtml#CharsetFromEncoding(user_settings) - else - let user_settings.encoding = '' " trigger detection using &encoding - endif - endif - - " else from 'encoding' if possible - if &l:fileencoding == '' || user_settings.encoding == '' - let user_settings.vim_encoding = &encoding - call tohtml#CharsetFromEncoding(user_settings) - endif - - " else default to UTF-8 and warn user - if user_settings.encoding == '' - let user_settings.vim_encoding = 'utf-8' - let user_settings.encoding = 'UTF-8' - echohl WarningMsg - echomsg "TOhtml: couldn't determine MIME charset, using UTF-8" - echohl None - endif - endif "}}} - - " Default to making nothing uncopyable, because we default to - " not-standards way of doing things, and also because Microsoft Word and - " others paste the <input> elements anyway. - " - " html_prevent_copy only has an effect when using CSS. - " - " All options: - " f - fold column - " n - line numbers (also within fold text) - " t - fold text - " d - diff filler - " c - concealed text (reserved future) - " l - listchars (reserved possible future) - " s - signs (reserved possible future) - " - " Normal text is always selectable. - let user_settings.prevent_copy = "" - if user_settings.use_css - if exists("g:html_prevent_copy") - if user_settings.dynamic_folds && !user_settings.no_foldcolumn && g:html_prevent_copy =~# 'f' - let user_settings.prevent_copy ..= 'f' - endif - if user_settings.number_lines && g:html_prevent_copy =~# 'n' - let user_settings.prevent_copy ..= 'n' - endif - if &diff && g:html_prevent_copy =~# 'd' - let user_settings.prevent_copy ..= 'd' - endif - if !user_settings.ignore_folding && g:html_prevent_copy =~# 't' - let user_settings.prevent_copy ..= 't' - endif - else - let user_settings.prevent_copy = "" - endif - endif - if empty(user_settings.prevent_copy) - let user_settings.no_invalid = 0 - endif - - " enforce valid values for use_input_for_pc - if user_settings.use_input_for_pc !~# 'fallback\|none\|all' - let user_settings.use_input_for_pc = 'none' - echohl WarningMsg - echomsg '2html: "' .. g:html_use_input_for_pc .. '" is not valid for g:html_use_input_for_pc' - echomsg '2html: defaulting to "' .. user_settings.use_input_for_pc .. '"' - echohl None - sleep 3 - endif - - if exists('g:html_id_expr') - let user_settings.id_suffix = eval(g:html_id_expr) - if user_settings.id_suffix !~ '^[-_:.A-Za-z0-9]*$' - echohl WarningMsg - echomsg '2html: g:html_id_expr evaluated to invalid string for HTML id attributes' - echomsg '2html: Omitting user-specified suffix' - echohl None - sleep 3 - let user_settings.id_suffix="" - endif - else - let user_settings.id_suffix="" - endif - - " TODO: font - - return user_settings - endif -endfunc "}}} - -" get the proper HTML charset name from a Vim encoding option. -function! tohtml#CharsetFromEncoding(settings) "{{{ - let l:vim_encoding = a:settings.vim_encoding - if exists('g:html_charset_override') && has_key(g:html_charset_override, l:vim_encoding) - let a:settings.encoding = g:html_charset_override[l:vim_encoding] - else - if l:vim_encoding =~ '^8bit\|^2byte' - " 8bit- and 2byte- prefixes are to indicate encodings available on the - " system that Vim will convert with iconv(), look up just the encoding name, - " not Vim's prefix. - let l:vim_encoding = substitute(l:vim_encoding, '^8bit-\|^2byte-', '', '') - endif - if has_key(g:tohtml#encoding_to_charset, l:vim_encoding) - let a:settings.encoding = g:tohtml#encoding_to_charset[l:vim_encoding] - else - let a:settings.encoding = "" - endif - endif - if a:settings.encoding != "" - let l:vim_encoding = tohtml#EncodingFromCharset(a:settings.encoding) - if l:vim_encoding != "" - " if the Vim encoding to HTML encoding conversion is set up (by default or - " by the user) to convert to a different encoding, we need to also change - " the Vim encoding of the new buffer - let a:settings.vim_encoding = l:vim_encoding - endif - endif -endfun "}}} - -" Get the proper Vim encoding option setting from an HTML charset name. -function! tohtml#EncodingFromCharset(encoding) "{{{ - if exists('g:html_encoding_override') && has_key(g:html_encoding_override, a:encoding) - return g:html_encoding_override[a:encoding] - elseif has_key(g:tohtml#charset_to_encoding, tolower(a:encoding)) - return g:tohtml#charset_to_encoding[tolower(a:encoding)] - else - return "" - endif -endfun "}}} - -let &cpo = s:cpo_sav -unlet s:cpo_sav - -" Make sure any patches will probably use consistent indent -" vim: ts=8 sw=2 sts=2 noet fdm=marker diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 2b269f7d9c..5f6f6fb149 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -4363,4 +4363,35 @@ vim.text.hexencode({str}) *vim.text.hexencode()* (`string`) Hex encoded string +============================================================================== +Lua module: tohtml *vim.tohtml* + + +:TOhtml {file} *:TOhtml* +Converts the buffer shown in the current window to HTML, opens the generated +HTML in a new split window, and saves its contents to {file}. If {file} is not +given, a temporary file (created by |tempname()|) is used. + + +tohtml.tohtml({winid}, {opt}) *tohtml.tohtml.tohtml()* + Converts the buffer shown in the window {winid} to HTML and returns the + output as a list of string. + + Parameters: ~ + • {winid} (`integer?`) Window to convert (defaults to current window) + • {opt} (`table?`) Optional parameters. + • title (string): Title tag to set in the generated HTML code + (defaults to buffer name) + • number_lines (boolean): Show line numbers (defaults to + `false`) + • font (string|string[]): Fonts to use (defaults to + `guifont`) + • width (integer) Width used for items which are either right + aligned or repeat a character infinitely (defaults to + 'textwidth' if non-zero or window width otherwise) + + Return: ~ + (`string[]`) + + vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl: diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 6895254a42..50beb79adf 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -134,6 +134,9 @@ The following changes may require adaptations in user config or plugins. If necessary, the respective capability can be removed when calling |vim.lsp.protocol.make_client_capabilities()|. +• |:TOhtml| has been rewritten in Lua to support Neovim-specific decorations, + and many options have been removed. + ============================================================================== BREAKING CHANGES IN HEAD *news-breaking-dev* diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt index 0e7c38b38d..c02752a2b7 100644 --- a/runtime/doc/syntax.txt +++ b/runtime/doc/syntax.txt @@ -341,443 +341,11 @@ Upon loading a file, Vim finds the relevant syntax file as follows: syntax. ============================================================================== -4. Conversion to HTML *2html.vim* *convert-to-HTML* +4. Conversion to HTML *convert-to-HTML* *2html.vim* -2html is not a syntax file itself, but a script that converts the current -window into HTML. Vim opens a new window in which it builds the HTML file. +The old to html converter has ben replaced by a Lua version and the +documentation has been moved to |:TOhtml|. -After you save the resulting file, you can view it with any browser. The -colors should be exactly the same as you see them in Vim. With -|g:html_line_ids| you can jump to specific lines by adding (for example) #L123 -or #123 to the end of the URL in your browser's address bar. And with -|g:html_dynamic_folds| enabled, you can show or hide the text that is folded -in Vim. - -You are not supposed to set the 'filetype' or 'syntax' option to "2html"! -Source the script to convert the current file: > - - :runtime! syntax/2html.vim -< -Many variables affect the output of 2html.vim; see below. Any of the on/off -options listed below can be enabled or disabled by setting them explicitly to -the desired value, or restored to their default by removing the variable using -|:unlet|. - -Remarks: -- Some truly ancient browsers may not show the background colors. -- From most browsers you can also print the file (in color)! - -Here is an example how to run the script over all .c and .h files from a -Unix shell: > - for f in *.[ch]; do gvim -f +"syn on" +"run! syntax/2html.vim" +"wq" +"q" $f; done -< - *g:html_start_line* *g:html_end_line* -To restrict the conversion to a range of lines, use a range with the |:TOhtml| -command below, or set "g:html_start_line" and "g:html_end_line" to the first -and last line to be converted. Example, using the last set Visual area: > - - :let g:html_start_line = line("'<") - :let g:html_end_line = line("'>") - :runtime! syntax/2html.vim -< - *:TOhtml* -:[range]TOhtml The ":TOhtml" command is defined in a standard plugin. - This command will source |2html.vim| for you. When a - range is given, this command sets |g:html_start_line| - and |g:html_end_line| to the start and end of the - range, respectively. Default range is the entire - buffer. - - If the current window is part of a |diff|, unless - |g:html_diff_one_file| is set, :TOhtml will convert - all windows which are part of the diff in the current - tab and place them side-by-side in a <table> element - in the generated HTML. With |g:html_line_ids| you can - jump to lines in specific windows with (for example) - #W1L42 for line 42 in the first diffed window, or - #W3L87 for line 87 in the third. - - Examples: > - - :10,40TOhtml " convert lines 10-40 to html - :'<,'>TOhtml " convert current/last visual selection - :TOhtml " convert entire buffer -< - *g:html_diff_one_file* -Default: 0. -When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab -page are converted to HTML and placed side-by-side in a <table> element. When -1, only the current buffer is converted. -Example: > - - let g:html_diff_one_file = 1 -< - *g:html_whole_filler* -Default: 0. -When 0, if |g:html_diff_one_file| is 1, a sequence of more than 3 filler lines -is displayed as three lines with the middle line mentioning the total number -of inserted lines. -When 1, always display all inserted lines as if |g:html_diff_one_file| were -not set. -> - :let g:html_whole_filler = 1 -< - *TOhtml-performance* *g:html_no_progress* -Default: 0. -When 0, display a progress bar in the statusline for each major step in the -2html.vim conversion process. -When 1, do not display the progress bar. This offers a minor speed improvement -but you won't have any idea how much longer the conversion might take; for big -files it can take a long time! -Example: > - - let g:html_no_progress = 1 -< -You can obtain better performance improvements by also instructing Vim to not -run interactively, so that too much time is not taken to redraw as the script -moves through the buffer, switches windows, and the like: > - - vim -E -s -c "let g:html_no_progress=1" -c "syntax on" -c "set ft=c" -c "runtime syntax/2html.vim" -cwqa myfile.c -< -Note that the -s flag prevents loading your vimrc and any plugins, so you -need to explicitly source/enable anything that will affect the HTML -conversion. See |-E| and |-s-ex| for details. It is probably best to create a -script to replace all the -c commands and use it with the -u flag instead of -specifying each command separately. - - *hl-TOhtmlProgress* *TOhtml-progress-color* -When displayed, the progress bar will show colored boxes along the statusline -as the HTML conversion proceeds. By default, the background color as the -current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine" -have the same background color, TOhtml will automatically adjust the color to -differ. If you do not like the automatically selected colors, you can define -your own highlight colors for the progress bar. Example: > - - hi TOhtmlProgress guifg=#c0ffee ctermbg=7 -< - *g:html_number_lines* -Default: Current 'number' setting. -When 0, buffer text is displayed in the generated HTML without line numbering. -When 1, a column of line numbers is added to the generated HTML with the same -highlighting as the line number column in Vim (|hl-LineNr|). -Force line numbers even if 'number' is not set: > - :let g:html_number_lines = 1 -Force to omit the line numbers: > - :let g:html_number_lines = 0 -Go back to the default to use 'number' by deleting the variable: > - :unlet g:html_number_lines -< - *g:html_line_ids* -Default: 1 if |g:html_number_lines| is set, 0 otherwise. -When 1, adds an HTML id attribute to each line number, or to an empty <span> -inserted for that purpose if no line numbers are shown. This ID attribute -takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view -pages, and is used to jump to a specific line (in a specific window of a diff -view). Javascript is inserted to open any closed dynamic folds -(|g:html_dynamic_folds|) containing the specified line before jumping. The -javascript also allows omitting the window ID in the url, and the leading L. -For example: > - - page.html#L123 jumps to line 123 in a single-buffer file - page.html#123 does the same - - diff.html#W1L42 jumps to line 42 in the first window in a diff - diff.html#42 does the same -< - *g:html_use_css* -Default: 1. -When 1, generate valid HTML 5 markup with CSS styling, supported in all modern -browsers and many old browsers. -When 0, generate <font> tags and similar outdated markup. This is not -recommended but it may work better in really old browsers, email clients, -forum posts, and similar situations where basic CSS support is unavailable. -Example: > - :let g:html_use_css = 0 -< - *g:html_ignore_conceal* -Default: 0. -When 0, concealed text is removed from the HTML and replaced with a character -from |:syn-cchar| or 'listchars' as appropriate, depending on the current -value of 'conceallevel'. -When 1, include all text from the buffer in the generated HTML, even if it is -|conceal|ed. - -Either of the following commands will ensure that all text in the buffer is -included in the generated HTML (unless it is folded): > - :let g:html_ignore_conceal = 1 - :setl conceallevel=0 -< - *g:html_ignore_folding* -Default: 0. -When 0, text in a closed fold is replaced by the text shown for the fold in -Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow -the user to expand the fold as in Vim to see the text inside. -When 1, include all text from the buffer in the generated HTML; whether the -text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect. - -Either of these commands will ensure that all text in the buffer is included -in the generated HTML (unless it is concealed): > - zR - :let g:html_ignore_folding = 1 -< - *g:html_dynamic_folds* -Default: 0. -When 0, text in a closed fold is not included at all in the generated HTML. -When 1, generate javascript to open a fold and show the text within, just like -in Vim. - -Setting this variable to 1 causes 2html.vim to always use CSS for styling, -regardless of what |g:html_use_css| is set to. - -This variable is ignored when |g:html_ignore_folding| is set. -> - :let g:html_dynamic_folds = 1 -< - *g:html_no_foldcolumn* -Default: 0. -When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to -Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds -open or closed. The minimum width of the generated text column is the current -'foldcolumn' setting. -When 1, do not generate this column; instead, hovering the mouse cursor over -folded text will open the fold as if |g:html_hover_unfold| were set. -> - :let g:html_no_foldcolumn = 1 -< - *TOhtml-uncopyable-text* *g:html_prevent_copy* -Default: Empty string. -This option prevents certain regions of the generated HTML from being copied, -when you select all text in document rendered in a browser and copy it. Useful -for allowing users to copy-paste only the source text even if a fold column or -line numbers are shown in the generated content. Specify regions to be -affected in this way as follows: - f: fold column - n: line numbers (also within fold text) - t: fold text - d: diff filler - -Example, to make the fold column and line numbers uncopyable: > - :let g:html_prevent_copy = "fn" -< -The method used to prevent copying in the generated page depends on the value -of |g:html_use_input_for_pc|. - - *g:html_use_input_for_pc* -Default: "none" -If |g:html_prevent_copy| is non-empty, then: - -When "all", read-only <input> elements are used in place of normal text for -uncopyable regions. In some browsers, especially older browsers, after -selecting an entire page and copying the selection, the <input> tags are not -pasted with the page text. If |g:html_no_invalid| is 0, the <input> tags have -invalid type; this works in more browsers, but the page will not validate. -Note: This method does NOT work in recent versions of Chrome and equivalent -browsers; the <input> tags get pasted with the text. - -When "fallback" (default value), the same <input> elements are generated for -older browsers, but newer browsers (detected by CSS feature query) hide the -<input> elements and instead use generated content in an ::before pseudoelement -to display the uncopyable text. This method should work with the largest -number of browsers, both old and new. - -When "none", the <input> elements are not generated at all. Only the -generated-content method is used. This means that old browsers, notably -Internet Explorer, will either copy the text intended not to be copyable, or -the non-copyable text may not appear at all. However, this is the most -standards-based method, and there will be much less markup. - - *g:html_no_invalid* -Default: 0. -When 0, if |g:html_prevent_copy| is non-empty and |g:html_use_input_for_pc| is -not "none", an invalid attribute is intentionally inserted into the <input> -element for the uncopyable areas. This prevents pasting the <input> elements -in some applications. Specifically, some versions of Microsoft Word will not -paste the <input> elements if they contain this invalid attribute. When 1, no -invalid markup is inserted, and the generated page should validate. However, -<input> elements may be pasted into some applications and can be difficult to -remove afterward. - - *g:html_hover_unfold* -Default: 0. -When 0, the only way to open a fold generated by 2html.vim with -|g:html_dynamic_folds| set, is to click on the generated fold column. -When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse -cursor over the displayed fold text. This is useful to allow users with -disabled javascript to view the folded text. - -Note that old browsers (notably Internet Explorer 6) will not support this -feature. Browser-specific markup for IE6 is included to fall back to the -normal CSS1 styling so that the folds show up correctly for this browser, but -they will not be openable without a foldcolumn. -> - :let g:html_hover_unfold = 1 -< - *g:html_id_expr* -Default: "" -Dynamic folding and jumping to line IDs rely on unique IDs within the document -to work. If generated HTML is copied into a larger document, these IDs are no -longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can -evaluate to get a unique string to append to each ID used in a given document, -so that the full IDs will be unique even when combined with other content in a -larger HTML document. Example, to append _ and the buffer number to each ID: > - - :let g:html_id_expr = '"_" .. bufnr("%")' -< -To append a string "_mystring" to the end of each ID: > - - :let g:html_id_expr = '"_mystring"' -< -Note: When converting a diff view to HTML, the expression will only be -evaluated for the first window in the diff, and the result used for all the -windows. - - *TOhtml-wrap-text* *g:html_pre_wrap* -Default: Current 'wrap' setting. -When 0, if |g:html_no_pre| is 0 or unset, the text in the generated HTML does -not wrap at the edge of the browser window. -When 1, if |g:html_use_css| is 1, the CSS 2.0 "white-space:pre-wrap" value is -used, causing the text to wrap at whitespace at the edge of the browser -window. -Explicitly enable text wrapping: > - :let g:html_pre_wrap = 1 -Explicitly disable wrapping: > - :let g:html_pre_wrap = 0 -Go back to default, determine wrapping from 'wrap' setting: > - :unlet g:html_pre_wrap -< - *g:html_no_pre* -Default: 0. -When 0, buffer text in the generated HTML is surrounded by <pre>...</pre> -tags. Series of whitespace is shown as in Vim without special markup, and tab -characters can be included literally (see |g:html_expand_tabs|). -When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is -used instead. Whitespace is replaced by a series of character -references, and <br> is used to end each line. This is another way to allow -text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in -old browsers, but may cause noticeable differences between Vim's display and -the rendered page generated by 2html.vim. -> - :let g:html_no_pre = 1 -< - *g:html_no_doc* -Default: 0. -When 1 it doesn't generate a full HTML document with a DOCTYPE, <head>, -<body>, etc. If |g:html_use_css| is enabled (the default) you'll have to -define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids| -settings (off by default) also insert some JavaScript. - - - *g:html_no_links* -Default: 0. -Don't generate <a> tags for text that looks like an URL. - - *g:html_no_modeline* -Default: 0. -Don't generate a modeline disabling folding. - - *g:html_expand_tabs* -Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use, - and no fold column or line numbers occur in the generated HTML; - 1 otherwise. -When 1, <Tab> characters in the buffer text are replaced with an appropriate -number of space characters, or references if |g:html_no_pre| is 1. -When 0, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text -are included as-is in the generated HTML. This is useful for when you want to -allow copy and paste from a browser without losing the actual whitespace in -the source document. Note that this can easily break text alignment and -indentation in the HTML, unless set by default. - -Force |2html.vim| to keep <Tab> characters: > - :let g:html_expand_tabs = 0 -< -Force tabs to be expanded: > - :let g:html_expand_tabs = 1 -< - *TOhtml-encoding-detect* *TOhtml-encoding* -It is highly recommended to set your desired encoding with -|g:html_use_encoding| for any content which will be placed on a web server. - -If you do not specify an encoding, |2html.vim| uses the preferred IANA name -for the current value of 'fileencoding' if set, or 'encoding' if not. -'encoding' is always used for certain 'buftype' values. 'fileencoding' will be -set to match the chosen document encoding. - -Automatic detection works for the encodings mentioned specifically by name in -|encoding-names|, but TOhtml will only automatically use those encodings with -wide browser support. However, you can override this to support specific -encodings that may not be automatically detected by default (see options -below). See https://www.iana.org/assignments/character-sets for the IANA names. - -Note: By default all Unicode encodings are converted to UTF-8 with no BOM in -the generated HTML, as recommended by W3C: - - https://www.w3.org/International/questions/qa-choosing-encodings - https://www.w3.org/International/questions/qa-byte-order-mark - - *g:html_use_encoding* -Default: none, uses IANA name for current 'fileencoding' as above. -To overrule all automatic charset detection, set g:html_use_encoding to the -name of the charset to be used. It is recommended to set this variable to -something widely supported, like UTF-8, for anything you will be hosting on a -webserver: > - :let g:html_use_encoding = "UTF-8" -You can also use this option to omit the line that specifies the charset -entirely, by setting g:html_use_encoding to an empty string (NOT recommended): > - :let g:html_use_encoding = "" -To go back to the automatic mechanism, delete the |g:html_use_encoding| -variable: > - :unlet g:html_use_encoding -< - *g:html_encoding_override* -Default: none, autoload/tohtml.vim contains default conversions for encodings - mentioned by name at |encoding-names|. -This option allows |2html.vim| to detect the correct 'fileencoding' when you -specify an encoding with |g:html_use_encoding| which is not in the default -list of conversions. - -This is a dictionary of charset-encoding pairs that will replace existing -pairs automatically detected by TOhtml, or supplement with new pairs. - -Detect the HTML charset "windows-1252" as the encoding "8bit-cp1252": > - :let g:html_encoding_override = {'windows-1252': '8bit-cp1252'} -< - *g:html_charset_override* -Default: none, autoload/tohtml.vim contains default conversions for encodings - mentioned by name at |encoding-names| and which have wide - browser support. -This option allows |2html.vim| to detect the HTML charset for any -'fileencoding' or 'encoding' which is not detected automatically. You can also -use it to override specific existing encoding-charset pairs. For example, -TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16 -and UTF-32 instead, use: > - :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'} - -Note that documents encoded in either UTF-32 or UTF-16 have known -compatibility problems with some major browsers. - - *g:html_font* -Default: "monospace" -You can specify the font or fonts used in the converted document using -g:html_font. If this option is set to a string, then the value will be -surrounded with single quotes. If this option is set to a list then each list -item is surrounded by single quotes and the list is joined with commas. Either -way, "monospace" is added as the fallback generic family name and the entire -result used as the font family (using CSS) or font face (if not using CSS). -Examples: > - - " font-family: 'Consolas', monospace; - :let g:html_font = "Consolas" - - " font-family: 'DejaVu Sans Mono', 'Consolas', monospace; - :let g:html_font = ["DejaVu Sans Mono", "Consolas"] -< - *convert-to-XML* *convert-to-XHTML* *g:html_use_xhtml* -Default: 0. -When 0, generate standard HTML 4.01 (strict when possible). -When 1, generate XHTML 1.0 instead (XML compliant HTML). -> - :let g:html_use_xhtml = 1 -< ============================================================================== 5. Syntax file remarks *:syn-file-remarks* diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 1d5d62c737..b0caf9fdaf 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -635,6 +635,7 @@ Commands: :lcscope :scscope :Vimuntar + The old `:TOhtml`, replaced by a Lua version (contains many differences) Compile-time features: Emacs tags support diff --git a/runtime/lua/tohtml.lua b/runtime/lua/tohtml.lua new file mode 100644 index 0000000000..e3c7fc68c0 --- /dev/null +++ b/runtime/lua/tohtml.lua @@ -0,0 +1,1335 @@ +--- @brief +---<pre>help +---:TOhtml {file} *:TOhtml* +---Converts the buffer shown in the current window to HTML, opens the generated +---HTML in a new split window, and saves its contents to {file}. If {file} is not +---given, a temporary file (created by |tempname()|) is used. +---</pre> + +-- The HTML conversion script is different from Vim's one. If you want to use +-- Vim's TOhtml converter, download it from the vim GitHub repo. +-- Here are the Vim files related to this functionality: +-- - https://github.com/vim/vim/blob/master/runtime/syntax/2html.vim +-- - https://github.com/vim/vim/blob/master/runtime/autoload/tohtml.vim +-- - https://github.com/vim/vim/blob/master/runtime/plugin/tohtml.vim +-- +-- Main differences between this and the vim version: +-- - No "ignore some visual thing" settings (just set the right Vim option) +-- - No support for legacy web engines +-- - No support for legacy encoding (supports only UTF-8) +-- - No interactive webpage +-- - No specifying the internal HTML (no XHTML, no use_css=false) +-- - No multiwindow diffs +-- - No ranges +-- +-- Remarks: +-- - Not all visuals are supported, so it may differ. + +--- @class vim.tohtml.opt +--- @field title? string|false +--- @field number_lines? boolean +--- @field font? string[]|string +--- @field width? integer + +--- @class vim.tohtml.state.global +--- @field background string +--- @field foreground string +--- @field title string|false +--- @field font string +--- @field highlights_name table<integer,string> +--- @field conf vim.tohtml.opt + +--- @class vim.tohtml.state:vim.tohtml.state.global +--- @field style vim.tohtml.styletable +--- @field tabstop string|false +--- @field opt vim.wo +--- @field winid integer +--- @field bufnr integer +--- @field width integer +--- @field buflen integer + +--- @class vim.tohtml.styletable +--- @field [integer] vim.tohtml.line (integer: (1-index, exclusive)) + +--- @class vim.tohtml.line +--- @field virt_lines {[integer]:{[1]:string,[2]:integer}[]} +--- @field pre_text string[][] +--- @field hide? boolean +--- @field [integer] vim.tohtml.cell? (integer: (1-index, exclusive)) + +--- @class vim.tohtml.cell +--- @field [1] integer[] start +--- @field [2] integer[] close +--- @field [3] any[][] virt_text +--- @field [4] any[][] overlay_text + +local HIDE_ID = -1 +-- stylua: ignore start +local cterm_8_to_hex={ + [0] = "#808080", "#ff6060", "#00ff00", "#ffff00", + "#8080ff", "#ff40ff", "#00ffff", "#ffffff", +} +local cterm_16_to_hex={ + [0] = "#000000", "#c00000", "#008000", "#804000", + "#0000c0", "#c000c0", "#008080", "#c0c0c0", + "#808080", "#ff6060", "#00ff00", "#ffff00", + "#8080ff", "#ff40ff", "#00ffff", "#ffffff", +} +local cterm_88_to_hex={ + [0] = "#000000", "#c00000", "#008000", "#804000", + "#0000c0", "#c000c0", "#008080", "#c0c0c0", + "#808080", "#ff6060", "#00ff00", "#ffff00", + "#8080ff", "#ff40ff", "#00ffff", "#ffffff", + "#000000", "#00008b", "#0000cd", "#0000ff", + "#008b00", "#008b8b", "#008bcd", "#008bff", + "#00cd00", "#00cd8b", "#00cdcd", "#00cdff", + "#00ff00", "#00ff8b", "#00ffcd", "#00ffff", + "#8b0000", "#8b008b", "#8b00cd", "#8b00ff", + "#8b8b00", "#8b8b8b", "#8b8bcd", "#8b8bff", + "#8bcd00", "#8bcd8b", "#8bcdcd", "#8bcdff", + "#8bff00", "#8bff8b", "#8bffcd", "#8bffff", + "#cd0000", "#cd008b", "#cd00cd", "#cd00ff", + "#cd8b00", "#cd8b8b", "#cd8bcd", "#cd8bff", + "#cdcd00", "#cdcd8b", "#cdcdcd", "#cdcdff", + "#cdff00", "#cdff8b", "#cdffcd", "#cdffff", + "#ff0000", "#ff008b", "#ff00cd", "#ff00ff", + "#ff8b00", "#ff8b8b", "#ff8bcd", "#ff8bff", + "#ffcd00", "#ffcd8b", "#ffcdcd", "#ffcdff", + "#ffff00", "#ffff8b", "#ffffcd", "#ffffff", + "#2e2e2e", "#5c5c5c", "#737373", "#8b8b8b", + "#a2a2a2", "#b9b9b9", "#d0d0d0", "#e7e7e7", +} +local cterm_256_to_hex={ + [0] = "#000000", "#c00000", "#008000", "#804000", + "#0000c0", "#c000c0", "#008080", "#c0c0c0", + "#808080", "#ff6060", "#00ff00", "#ffff00", + "#8080ff", "#ff40ff", "#00ffff", "#ffffff", + "#000000", "#00005f", "#000087", "#0000af", + "#0000d7", "#0000ff", "#005f00", "#005f5f", + "#005f87", "#005faf", "#005fd7", "#005fff", + "#008700", "#00875f", "#008787", "#0087af", + "#0087d7", "#0087ff", "#00af00", "#00af5f", + "#00af87", "#00afaf", "#00afd7", "#00afff", + "#00d700", "#00d75f", "#00d787", "#00d7af", + "#00d7d7", "#00d7ff", "#00ff00", "#00ff5f", + "#00ff87", "#00ffaf", "#00ffd7", "#00ffff", + "#5f0000", "#5f005f", "#5f0087", "#5f00af", + "#5f00d7", "#5f00ff", "#5f5f00", "#5f5f5f", + "#5f5f87", "#5f5faf", "#5f5fd7", "#5f5fff", + "#5f8700", "#5f875f", "#5f8787", "#5f87af", + "#5f87d7", "#5f87ff", "#5faf00", "#5faf5f", + "#5faf87", "#5fafaf", "#5fafd7", "#5fafff", + "#5fd700", "#5fd75f", "#5fd787", "#5fd7af", + "#5fd7d7", "#5fd7ff", "#5fff00", "#5fff5f", + "#5fff87", "#5fffaf", "#5fffd7", "#5fffff", + "#870000", "#87005f", "#870087", "#8700af", + "#8700d7", "#8700ff", "#875f00", "#875f5f", + "#875f87", "#875faf", "#875fd7", "#875fff", + "#878700", "#87875f", "#878787", "#8787af", + "#8787d7", "#8787ff", "#87af00", "#87af5f", + "#87af87", "#87afaf", "#87afd7", "#87afff", + "#87d700", "#87d75f", "#87d787", "#87d7af", + "#87d7d7", "#87d7ff", "#87ff00", "#87ff5f", + "#87ff87", "#87ffaf", "#87ffd7", "#87ffff", + "#af0000", "#af005f", "#af0087", "#af00af", + "#af00d7", "#af00ff", "#af5f00", "#af5f5f", + "#af5f87", "#af5faf", "#af5fd7", "#af5fff", + "#af8700", "#af875f", "#af8787", "#af87af", + "#af87d7", "#af87ff", "#afaf00", "#afaf5f", + "#afaf87", "#afafaf", "#afafd7", "#afafff", + "#afd700", "#afd75f", "#afd787", "#afd7af", + "#afd7d7", "#afd7ff", "#afff00", "#afff5f", + "#afff87", "#afffaf", "#afffd7", "#afffff", + "#d70000", "#d7005f", "#d70087", "#d700af", + "#d700d7", "#d700ff", "#d75f00", "#d75f5f", + "#d75f87", "#d75faf", "#d75fd7", "#d75fff", + "#d78700", "#d7875f", "#d78787", "#d787af", + "#d787d7", "#d787ff", "#d7af00", "#d7af5f", + "#d7af87", "#d7afaf", "#d7afd7", "#d7afff", + "#d7d700", "#d7d75f", "#d7d787", "#d7d7af", + "#d7d7d7", "#d7d7ff", "#d7ff00", "#d7ff5f", + "#d7ff87", "#d7ffaf", "#d7ffd7", "#d7ffff", + "#ff0000", "#ff005f", "#ff0087", "#ff00af", + "#ff00d7", "#ff00ff", "#ff5f00", "#ff5f5f", + "#ff5f87", "#ff5faf", "#ff5fd7", "#ff5fff", + "#ff8700", "#ff875f", "#ff8787", "#ff87af", + "#ff87d7", "#ff87ff", "#ffaf00", "#ffaf5f", + "#ffaf87", "#ffafaf", "#ffafd7", "#ffafff", + "#ffd700", "#ffd75f", "#ffd787", "#ffd7af", + "#ffd7d7", "#ffd7ff", "#ffff00", "#ffff5f", + "#ffff87", "#ffffaf", "#ffffd7", "#ffffff", + "#080808", "#121212", "#1c1c1c", "#262626", + "#303030", "#3a3a3a", "#444444", "#4e4e4e", + "#585858", "#626262", "#6c6c6c", "#767676", + "#808080", "#8a8a8a", "#949494", "#9e9e9e", + "#a8a8a8", "#b2b2b2", "#bcbcbc", "#c6c6c6", + "#d0d0d0", "#dadada", "#e4e4e4", "#eeeeee", +} +-- stylua: ignore end + +--- @type table<integer,string> +local cterm_color_cache = {} +--- @type string? +local background_color_cache = nil +--- @type string? +local foreground_color_cache = nil + +--- @see https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Operating-System-Commands +--- @param color "background"|"foreground"|integer +--- @return string? +local function try_query_terminal_color(color) + local parameter = 4 + if color == 'foreground' then + parameter = 10 + elseif color == 'background' then + parameter = 11 + end + --- @type string? + local hex = nil + local au = vim.api.nvim_create_autocmd('TermResponse', { + once = true, + callback = function(args) + hex = '#' + .. table.concat({ args.data:match('\027%]%d+;%d*;?rgb:(%w%w)%w%w/(%w%w)%w%w/(%w%w)%w%w') }) + end, + }) + if type(color) == 'number' then + io.stdout:write(('\027]%s;%s;?\027\\'):format(parameter, color)) + else + io.stdout:write(('\027]%s;?\027\\'):format(parameter)) + end + vim.wait(100, function() + return hex and true or false + end) + pcall(vim.api.nvim_del_autocmd, au) + return hex +end + +--- @param colorstr string +--- @return string +local function cterm_to_hex(colorstr) + if colorstr:sub(1, 1) == '#' then + return colorstr + end + assert(colorstr ~= '') + local color = tonumber(colorstr) + assert(color and 0 <= color and color <= 255) + if cterm_color_cache[color] then + return cterm_color_cache[color] + end + local hex = try_query_terminal_color(color) + if hex then + cterm_color_cache[color] = hex + else + vim.notify_once("Info(TOhtml): Couldn't get terminal colors, using fallback") + local t_Co = tonumber(vim.api.nvim_eval('&t_Co')) + if t_Co <= 8 then + cterm_color_cache = cterm_8_to_hex + elseif t_Co == 88 then + cterm_color_cache = cterm_88_to_hex + elseif t_Co == 256 then + cterm_color_cache = cterm_256_to_hex + else + cterm_color_cache = cterm_16_to_hex + end + end + return cterm_color_cache[color] +end + +--- @return string +local function get_background_color() + local bg = vim.fn.synIDattr(vim.fn.hlID('Normal'), 'bg#') + if bg ~= '' then + return cterm_to_hex(bg) + end + if background_color_cache then + return background_color_cache + end + local hex = try_query_terminal_color('background') + if not hex or not hex:match('#%x%x%x%x%x%x') then + vim.notify_once("Info(TOhtml): Couldn't get terminal background colors, using fallback") + hex = vim.o.background == 'light' and '#ffffff' or '#000000' + end + background_color_cache = hex + return hex +end + +--- @return string +local function get_foreground_color() + local fg = vim.fn.synIDattr(vim.fn.hlID('Normal'), 'fg#') + if fg ~= '' then + return cterm_to_hex(fg) + end + if foreground_color_cache then + return foreground_color_cache + end + local hex = try_query_terminal_color('foreground') + if not hex or not hex:match('#%x%x%x%x%x%x') then + vim.notify_once("Info(TOhtml): Couldn't get terminal foreground colors, using fallback") + hex = vim.o.background == 'light' and '#000000' or '#ffffff' + end + foreground_color_cache = hex + return hex +end + +--- @param style_line vim.tohtml.line +--- @param col integer (1-index) +--- @param field integer +--- @param val any +local function _style_line_insert(style_line, col, field, val) + if style_line[col] == nil then + style_line[col] = { {}, {}, {}, {} } + end + table.insert(style_line[col][field], val) +end + +--- @param style_line vim.tohtml.line +--- @param col integer (1-index) +--- @param val any[] +local function style_line_insert_overlay_char(style_line, col, val) + _style_line_insert(style_line, col, 4, val) +end + +--- @param style_line vim.tohtml.line +--- @param col integer (1-index) +--- @param val any[] +local function style_line_insert_virt_text(style_line, col, val) + _style_line_insert(style_line, col, 3, val) +end + +--- @param state vim.tohtml.state +--- @param hl string|integer|nil +--- @return nil|integer +local function register_hl(state, hl) + if type(hl) == 'nil' then + return + elseif type(hl) == 'string' then + hl = vim.fn.hlID(hl) + assert(hl ~= 0) + end + hl = vim.fn.synIDtrans(hl) + if not state.highlights_name[hl] then + local name = vim.fn.synIDattr(hl, 'name') + assert(name ~= '') + state.highlights_name[hl] = name + end + return hl +end + +--- @param state vim.tohtml.state +--- @param start_row integer (1-index) +--- @param start_col integer (1-index) +--- @param end_row integer (1-index) +--- @param end_col integer (1-index) +--- @param conceal_text string +--- @param hl_group string|integer? +local function styletable_insert_conceal( + state, + start_row, + start_col, + end_row, + end_col, + conceal_text, + hl_group +) + assert(state.opt.conceallevel > 0) + local styletable = state.style + if start_col == end_col and start_row == end_row then + return + end + if state.opt.conceallevel == 1 and conceal_text == '' then + conceal_text = vim.opt_local.listchars:get().conceal or ' ' + end + local hlid = register_hl(state, hl_group) + if vim.wo[state.winid].conceallevel ~= 3 then + _style_line_insert(styletable[start_row], start_col, 3, { conceal_text, hlid }) + end + _style_line_insert(styletable[start_row], start_col, 1, HIDE_ID) + _style_line_insert(styletable[end_row], end_col, 2, HIDE_ID) +end + +--- @param state vim.tohtml.state +--- @param start_row integer (1-index) +--- @param start_col integer (1-index) +--- @param end_row integer (1-index) +--- @param end_col integer (1-index) +--- @param hl_group string|integer|nil +local function styletable_insert_range(state, start_row, start_col, end_row, end_col, hl_group) + if start_col == end_col and start_row == end_row or not hl_group then + return + end + local styletable = state.style + _style_line_insert(styletable[start_row], start_col, 1, hl_group) + _style_line_insert(styletable[end_row], end_col, 2, hl_group) +end + +--- @param bufnr integer +--- @return vim.tohtml.styletable +local function generate_styletable(bufnr) + --- @type vim.tohtml.styletable + local styletable = {} + for row = 1, vim.api.nvim_buf_line_count(bufnr) + 1 do + styletable[row] = { virt_lines = {}, pre_text = {} } + end + return styletable +end + +--- @param state vim.tohtml.state +local function styletable_syntax(state) + for row = 1, state.buflen do + local prev_id = 0 + local prev_col = nil + for col = 1, #vim.fn.getline(row) + 1 do + local hlid = vim.fn.synID(row, col, 1) + hlid = hlid == 0 and 0 or assert(register_hl(state, hlid)) + if hlid ~= prev_id then + if prev_id ~= 0 then + styletable_insert_range(state, row, assert(prev_col), row, col, prev_id) + end + prev_col = col + prev_id = hlid + end + end + end +end + +--- @param state vim.tohtml.state +local function styletable_diff(state) + local styletable = state.style + for row = 1, state.buflen do + local style_line = styletable[row] + local filler = vim.fn.diff_filler(row) + if filler ~= 0 then + local fill = (vim.opt_local.fillchars:get().diff or '-') + table.insert( + style_line.virt_lines, + { { fill:rep(state.width), register_hl(state, 'DiffDelete') } } + ) + end + if row == state.buflen + 1 then + break + end + local prev_id = 0 + local prev_col = nil + for col = 1, #vim.fn.getline(row) do + local hlid = vim.fn.diff_hlID(row, col) + hlid = hlid == 0 and 0 or assert(register_hl(state, hlid)) + if hlid ~= prev_id then + if prev_id ~= 0 then + styletable_insert_range(state, row, assert(prev_col), row, col, prev_id) + end + prev_col = col + prev_id = hlid + end + end + if prev_id ~= 0 then + styletable_insert_range(state, row, assert(prev_col), row, #vim.fn.getline(row) + 1, prev_id) + end + end +end + +--- @param state vim.tohtml.state +local function styletable_treesitter(state) + local bufnr = state.bufnr + local buf_highlighter = vim.treesitter.highlighter.active[bufnr] + if not buf_highlighter then + return + end + buf_highlighter.tree:parse(true) + buf_highlighter.tree:for_each_tree(function(tstree, tree) + --- @cast tree LanguageTree + if not tstree then + return + end + local root = tstree:root() + local q = buf_highlighter:get_query(tree:lang()) + --- @type Query? + local query = q:query() + if not query then + return + end + for capture, node, metadata in query:iter_captures(root, buf_highlighter.bufnr, 0, state.buflen) do + local srow, scol, erow, ecol = node:range() + --- @diagnostic disable-next-line: invisible + local c = q._query.captures[capture] + if c ~= nil then + local hlid = register_hl(state, '@' .. c .. '.' .. tree:lang()) + if metadata.conceal and state.opt.conceallevel ~= 0 then + styletable_insert_conceal(state, srow + 1, scol + 1, erow + 1, ecol + 1, metadata.conceal) + end + styletable_insert_range(state, srow + 1, scol + 1, erow + 1, ecol + 1, hlid) + end + end + end) +end + +--- @param state vim.tohtml.state +--- @param extmark {[1]:integer,[2]:integer,[3]:integer,[4]:vim.api.keyset.set_extmark|any} +--- @param namespaces table<integer,string> +local function _styletable_extmarks_highlight(state, extmark, namespaces) + if not extmark[4].hl_group then + return + end + ---TODO(altermo) LSP semantic tokens (and some other extmarks) are only + ---generated in visible lines, and not in the whole buffer. + if (namespaces[extmark[4].ns_id] or ''):find('vim_lsp_semantic_tokens') then + vim.notify_once('Info(TOhtml): lsp semantic tokens are not supported, HTML may be incorrect') + return + end + local srow, scol, erow, ecol = + extmark[2], extmark[3], extmark[4].end_row or extmark[2], extmark[4].end_col or extmark[3] + if scol == ecol and srow == erow then + return + end + local hlid = register_hl(state, extmark[4].hl_group) + styletable_insert_range(state, srow + 1, scol + 1, erow + 1, ecol + 1, hlid) +end + +--- @param state vim.tohtml.state +--- @param extmark {[1]:integer,[2]:integer,[3]:integer,[4]:vim.api.keyset.set_extmark|any} +local function _styletable_extmarks_virt_text(state, extmark) + if not extmark[4].virt_text then + return + end + local styletable = state.style + --- @type integer,integer + local row, col = extmark[2], extmark[3] + if + extmark[4].virt_text_pos == 'inline' + or extmark[4].virt_text_pos == 'eol' + or extmark[4].virt_text_pos == 'overlay' + then + if extmark[4].virt_text_pos == 'eol' then + style_line_insert_virt_text(styletable[row + 1], #vim.fn.getline(row + 1) + 1, { ' ' }) + end + local virt_text_len = 0 + for _, i in + ipairs(extmark[4].virt_text --[[@as (string[][])]]) + do + local hlid = register_hl(state, i[2]) + if extmark[4].virt_text_pos == 'eol' then + style_line_insert_virt_text( + styletable[row + 1], + #vim.fn.getline(row + 1) + 1, + { i[1], hlid } + ) + else + style_line_insert_virt_text(styletable[row + 1], col + 1, { i[1], hlid }) + end + virt_text_len = virt_text_len + #i[1] + end + if extmark[4].virt_text_pos == 'overlay' then + styletable_insert_range(state, row + 1, col + 1, row + 1, col + virt_text_len + 1, HIDE_ID) + end + end + local not_supported = { + virt_text_pos = 'right_align', + hl_mode = 'blend', + hl_group = 'combine', + } + for opt, val in ipairs(not_supported) do + if extmark[4][opt] == val then + vim.notify_once( + ('Info(TOhtml): extmark.%s="%s" is not supported, HTML may be incorrect'):format(opt, val) + ) + end + end +end + +--- @param state vim.tohtml.state +--- @param extmark {[1]:integer,[2]:integer,[3]:integer,[4]:vim.api.keyset.set_extmark|any} +local function _styletable_extmarks_virt_lines(state, extmark) + ---TODO(altermo) if the fold start is equal to virt_line start then the fold hides the virt_line + if not extmark[4].virt_lines then + return + end + --- @type integer + local row = extmark[2] + (extmark[4].virt_lines_above and 1 or 2) + for _, line in + ipairs(extmark[4].virt_lines --[[@as (string[][][])]]) + do + local virt_line = {} + for _, i in ipairs(line) do + local hlid = register_hl(state, i[2]) + table.insert(virt_line, { i[1], hlid }) + end + table.insert(state.style[row].virt_lines, virt_line) + end +end + +--- @param state vim.tohtml.state +--- @param extmark {[1]:integer,[2]:integer,[3]:integer,[4]:vim.api.keyset.set_extmark|any} +local function _styletable_extmarks_conceal(state, extmark) + if not extmark[4].conceal or state.opt.conceallevel == 0 then + return + end + local srow, scol, erow, ecol = + extmark[2], extmark[3], extmark[4].end_row or extmark[2], extmark[4].end_col or extmark[3] + styletable_insert_conceal( + state, + srow + 1, + scol + 1, + erow + 1, + ecol + 1, + extmark[4].conceal, + extmark[4].hl_group or 'Conceal' + ) +end + +--- @param state vim.tohtml.state +local function styletable_extmarks(state) + --TODO(altermo) extmarks may have col/row which is outside of the buffer, which could cause an error + local bufnr = state.bufnr + local extmarks = vim.api.nvim_buf_get_extmarks(bufnr, -1, 0, -1, { details = true }) + local namespaces = vim.tbl_add_reverse_lookup(vim.api.nvim_get_namespaces()) + for _, v in ipairs(extmarks) do + _styletable_extmarks_highlight(state, v, namespaces) + end + for _, v in ipairs(extmarks) do + _styletable_extmarks_conceal(state, v) + end + for _, v in ipairs(extmarks) do + _styletable_extmarks_virt_text(state, v) + end + for _, v in ipairs(extmarks) do + _styletable_extmarks_virt_lines(state, v) + end +end + +--- @param state vim.tohtml.state +local function styletable_folds(state) + local styletable = state.style + local has_folded = false + for row = 1, state.buflen do + if vim.fn.foldclosed(row) > 0 then + has_folded = true + styletable[row].hide = true + end + if vim.fn.foldclosed(row) == row then + local hlid = register_hl(state, 'Folded') + ---TODO(altermo): Is there a way to get highlighted foldtext? + local foldtext = vim.fn.foldtextresult(row) + foldtext = foldtext .. (vim.opt.fillchars:get().fold or '·'):rep(state.width - #foldtext) + table.insert(styletable[row].virt_lines, { { foldtext, hlid } }) + end + end + if has_folded and type(({ pcall(vim.api.nvim_eval, vim.o.foldtext) })[2]) == 'table' then + vim.notify_once( + 'Info(TOhtml): foldtext returning a table is half supported, HTML may be incorrect' + ) + end +end + +--- @param state vim.tohtml.state +local function styletable_conceal(state) + local bufnr = state.bufnr + vim.api.nvim_buf_call(bufnr, function() + for row = 1, state.buflen do + --- @type table<integer,{[1]:integer,[2]:integer,[3]:string}> + local conceals = {} + local line_len_exclusive = #vim.fn.getline(row) + 1 + for col = 1, line_len_exclusive do + --- @type integer,string,integer + local is_concealed, conceal, hlid = unpack(vim.fn.synconcealed(row, col) --[[@as table]]) + if is_concealed == 0 then + assert(true) + elseif not conceals[hlid] then + conceals[hlid] = { col, math.min(col + 1, line_len_exclusive), conceal } + else + conceals[hlid][2] = math.min(col + 1, line_len_exclusive) + end + end + for _, v in pairs(conceals) do + styletable_insert_conceal(state, row, v[1], row, v[2], v[3], 'Conceal') + end + end + end) +end + +--- @param state vim.tohtml.state +local function styletable_match(state) + for _, match in + ipairs(vim.fn.getmatches(state.winid) --[[@as (table[])]]) + do + local hlid = register_hl(state, match.group) + local function range(srow, scol, erow, ecol) + if match.group == 'Conceal' and state.opt.conceallevel ~= 0 then + styletable_insert_conceal(state, srow, scol, erow, ecol, match.conceal or '', hlid) + else + styletable_insert_range(state, srow, scol, erow, ecol, hlid) + end + end + if match.pos1 then + for key, v in + pairs(match --[[@as (table<string,integer[]>)]]) + do + if not key:match('^pos(%d+)$') then + assert(true) + elseif #v == 1 then + range(v[1], 1, v[1], #vim.fn.getline(v[1]) + 1) + else + range(v[1], v[2], v[1], v[3] + v[2]) + end + end + else + for _, v in + ipairs(vim.fn.matchbufline(state.bufnr, match.pattern, 1, '$') --[[@as (table[])]]) + do + range(v.lnum, v.byteidx + 1, v.lnum, v.byteidx + 1 + #v.text) + end + end + end +end + +--- Requires state.conf.number_lines to be set to true +--- @param state vim.tohtml.state +local function styletable_statuscolumn(state) + if not state.conf.number_lines then + return + end + local statuscolumn = state.opt.statuscolumn + + if statuscolumn == '' then + if state.opt.relativenumber then + if state.opt.number then + statuscolumn = '%C%s%{%v:lnum!=line(".")?"%=".v:relnum." ":v:lnum%}' + else + statuscolumn = '%C%s%{%"%=".v:relnum." "%}' + end + else + statuscolumn = '%C%s%{%"%=".v:lnum." "%}' + end + end + local minwidth = 0 + + local signcolumn = state.opt.signcolumn + if state.opt.number or state.opt.relativenumber then + minwidth = minwidth + state.opt.numberwidth + if signcolumn == 'number' then + signcolumn = 'no' + end + end + if signcolumn == 'number' then + signcolumn = 'auto' + end + if signcolumn ~= 'no' then + local max = tonumber(signcolumn:match('^%w-:(%d)')) or 1 + if signcolumn:match('^auto') then + --- @type table<integer,integer> + local signcount = {} + for _, extmark in + ipairs(vim.api.nvim_buf_get_extmarks(state.bufnr, -1, 0, -1, { details = true })) + do + if extmark[4].sign_text then + signcount[extmark[2]] = (signcount[extmark[2]] or 0) + 1 + end + end + local maxsigns = 0 + for _, v in pairs(signcount) do + if v > maxsigns then + maxsigns = v + end + end + minwidth = minwidth + math.min(maxsigns, max) * 2 + else + minwidth = minwidth + max * 2 + end + end + + local foldcolumn = state.opt.foldcolumn + if foldcolumn ~= '0' then + if foldcolumn:match('^auto') then + local max = tonumber(foldcolumn:match('^%w-:(%d)')) or 1 + local maxfold = 0 + vim.api.nvim_buf_call(state.bufnr, function() + for row = 1, vim.api.nvim_buf_line_count(state.bufnr) do + local foldlevel = vim.fn.foldlevel(row) + if foldlevel > maxfold then + maxfold = foldlevel + end + end + end) + minwidth = minwidth + math.min(maxfold, max) + else + minwidth = minwidth + tonumber(foldcolumn) + end + end + + --- @type table<integer,any> + local statuses = {} + for row = 1, state.buflen do + local status = vim.api.nvim_eval_statusline( + statuscolumn, + { winid = state.winid, use_statuscol_lnum = row, highlights = true } + ) + local width = vim.api.nvim_strwidth(status.str) + if width > minwidth then + minwidth = width + end + table.insert(statuses, status) + --- @type string + end + for row, status in pairs(statuses) do + --- @type string + local str = status.str + --- @type table[] + local hls = status.highlights + for k, v in ipairs(hls) do + local text = str:sub(v.start + 1, hls[k + 1] and hls[k + 1].start or nil) + if k == #hls then + text = text .. (' '):rep(minwidth - vim.api.nvim_strwidth(str)) + end + if text ~= '' then + local hlid = register_hl(state, v.group) + local virt_text = { text, hlid } + table.insert(state.style[row].pre_text, virt_text) + end + end + end +end + +--- @param state vim.tohtml.state +local function styletable_listchars(state) + if not state.opt.list then + return + end + --- @return string + local function utf8_sub(str, i, j) + return vim.fn.strcharpart(str, i - 1, j and j - i + 1 or nil) + end + local len = vim.api.nvim_strwidth + --- @type table<string,string> + local listchars = vim.opt_local.listchars:get() + local ids = setmetatable({}, { + __index = function(t, k) + rawset(t, k, register_hl(state, k)) + return rawget(t, k) + end, + }) + + if listchars.eol then + for row = 1, state.buflen do + local style_line = state.style[row] + style_line_insert_overlay_char( + style_line, + #vim.fn.getline(row) + 1, + { listchars.eol, ids.NonText } + ) + end + end + + if listchars.tab and state.tabstop then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, '\t', 1, '$') --[[@as (table[])]]) + do + --- @type integer + local tablen = #state.tabstop + - ((vim.fn.virtcol({ match.lnum, match.byteidx }, false, state.winid)) % #state.tabstop) + --- @type string? + local text + if len(listchars.tab) == 3 then + if tablen == 1 then + text = utf8_sub(listchars.tab, 3, 3) + else + text = utf8_sub(listchars.tab, 1, 1) + .. utf8_sub(listchars.tab, 2, 2):rep(tablen - 2) + .. utf8_sub(listchars.tab, 3, 3) + end + else + text = utf8_sub(listchars.tab, 1, 1) .. utf8_sub(listchars.tab, 2, 2):rep(tablen - 1) + end + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + 1, + { text, ids.Whitespace } + ) + end + end + + if listchars.space then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, ' ', 1, '$') --[[@as (table[])]]) + do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + 1, + { listchars.space, ids.Whitespace } + ) + end + end + + if listchars.multispace then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, [[ \+]], 1, '$') --[[@as (table[])]]) + do + local text = utf8_sub(listchars.multispace:rep(len(match.text)), 1, len(match.text)) + for i = 1, len(text) do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + i, + { utf8_sub(text, i, i), ids.Whitespace } + ) + end + end + end + + if listchars.lead or listchars.leadmultispace then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, [[^ \+]], 1, '$') --[[@as (table[])]]) + do + local text = '' + if len(match.text) == 1 or not listchars.leadmultispace then + if listchars.lead then + text = listchars.lead:rep(len(match.text)) + end + elseif listchars.leadmultispace then + text = utf8_sub(listchars.leadmultispace:rep(len(match.text)), 1, len(match.text)) + end + for i = 1, len(text) do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + i, + { utf8_sub(text, i, i), ids.Whitespace } + ) + end + end + end + + if listchars.trail then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, [[ \+$]], 1, '$') --[[@as (table[])]]) + do + local text = listchars.trail:rep(len(match.text)) + for i = 1, len(text) do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + i, + { utf8_sub(text, i, i), ids.Whitespace } + ) + end + end + end + + if listchars.nbsp then + for _, match in + ipairs(vim.fn.matchbufline(state.bufnr, '\xe2\x80\xaf\\|\xa0', 1, '$') --[[@as (table[])]]) + do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + 1, + { listchars.nbsp, ids.Whitespace } + ) + for i = 2, #match.text do + style_line_insert_overlay_char( + state.style[match.lnum], + match.byteidx + i, + { '', ids.Whitespace } + ) + end + end + end +end + +--- @param name string +--- @return string +local function highlight_name_to_class_name(name) + return (name:gsub('%.', '-'):gsub('@', '-')) +end + +--- @param name string +--- @return string +local function name_to_tag(name) + return '<span class="' .. highlight_name_to_class_name(name) .. '">' +end + +--- @param _ string +--- @return string +local function name_to_closetag(_) + return '</span>' +end + +--- @param str string +--- @param tabstop string|false? +--- @return string +local function html_escape(str, tabstop) + str = str:gsub('&', '&'):gsub('<', '<'):gsub('>', '>'):gsub('"', '"') + if tabstop then + --- @type string + str = str:gsub('\t', tabstop) + end + return str +end + +--- @param out string[] +--- @param state vim.tohtml.state.global +local function extend_style(out, state) + table.insert(out, '<style>') + table.insert(out, ('* {font-family: %s}'):format(state.font)) + table.insert( + out, + ('body {background-color: %s; color: %s}'):format(state.background, state.foreground) + ) + for hlid, name in pairs(state.highlights_name) do + --TODO(altermo) use local namespace (instead of global 0) + local fg = vim.fn.synIDattr(hlid, 'fg#') + local bg = vim.fn.synIDattr(hlid, 'bg#') + local decor_line = {} + if vim.fn.synIDattr(hlid, 'underline') ~= '' then + table.insert(decor_line, 'underline') + end + if vim.fn.synIDattr(hlid, 'strikethrough') ~= '' then + table.insert(decor_line, 'line-through') + end + if vim.fn.synIDattr(hlid, 'undercurl') ~= '' then + table.insert(decor_line, 'underline') + end + local c = { + color = fg ~= '' and cterm_to_hex(fg) or nil, + ['background-color'] = bg ~= '' and cterm_to_hex(bg) or nil, + ['font-style'] = vim.fn.synIDattr(hlid, 'italic') ~= '' and 'italic' or nil, + ['font-weight'] = vim.fn.synIDattr(hlid, 'bold') ~= '' and 'bold' or nil, + ['text-decoration-line'] = not vim.tbl_isempty(decor_line) and table.concat(decor_line, ' ') + or nil, + --TODO(altermo) if strikethrough and undercurl then the strikethrough becomes wavy + ['text-decoration-style'] = vim.fn.synIDattr(hlid, 'undercurl') ~= '' and 'wavy' or nil, + } + local attrs = {} + for attr, val in pairs(c) do + table.insert(attrs, attr .. ': ' .. val) + end + table.insert( + out, + '.' .. highlight_name_to_class_name(name) .. ' {' .. table.concat(attrs, '; ') .. '}' + ) + end + table.insert(out, '</style>') +end + +--- @param out string[] +--- @param state vim.tohtml.state.global +local function extend_head(out, state) + table.insert(out, '<head>') + table.insert(out, '<meta charset="UTF-8">') + if state.title ~= false then + table.insert(out, ('<title>%s</title>'):format(state.title)) + end + local colorscheme = vim.api.nvim_exec2('colorscheme', { output = true }).output + table.insert( + out, + ('<meta name="colorscheme" content="%s"></meta>'):format(html_escape(colorscheme)) + ) + extend_style(out, state) + table.insert(out, '</head>') +end + +--- @param out string[] +--- @param state vim.tohtml.state +--- @param row integer +local function _extend_virt_lines(out, state, row) + local style_line = state.style[row] + for _, virt_line in ipairs(style_line.virt_lines) do + local virt_s = '' + for _, v in ipairs(virt_line) do + if v[2] then + virt_s = virt_s .. (name_to_tag(state.highlights_name[v[2]])) + end + virt_s = virt_s .. v[1] + if v[2] then + --- @type string + virt_s = virt_s .. (name_to_closetag(state.highlights_name[v[2]])) + end + end + table.insert(out, virt_s) + end +end + +--- @param state vim.tohtml.state +--- @param row integer +--- @return string +local function _pre_text_to_html(state, row) + local style_line = state.style[row] + local s = '' + for _, pre_text in ipairs(style_line.pre_text) do + if pre_text[2] then + s = s .. (name_to_tag(state.highlights_name[pre_text[2]])) + end + s = s .. (html_escape(pre_text[1], state.tabstop)) + if pre_text[2] then + --- @type string + s = s .. (name_to_closetag(state.highlights_name[pre_text[2]])) + end + end + return s +end + +--- @param state vim.tohtml.state +--- @param char table +--- @return string +local function _char_to_html(state, char) + local s = '' + if char[2] then + s = s .. name_to_tag(state.highlights_name[char[2]]) + end + s = s .. html_escape(char[1], state.tabstop) + if char[2] then + s = s .. name_to_closetag(state.highlights_name[char[2]]) + end + return s +end + +--- @param state vim.tohtml.state +--- @param cell vim.tohtml.cell +--- @return string +local function _virt_text_to_html(state, cell) + local s = '' + for _, v in ipairs(cell[3]) do + if v[2] then + s = s .. (name_to_tag(state.highlights_name[v[2]])) + end + --- @type string + s = s .. html_escape(v[1], state.tabstop) + if v[2] then + s = s .. name_to_closetag(state.highlights_name[v[2]]) + end + end + return s +end + +--- @param out string[] +--- @param state vim.tohtml.state +local function extend_pre(out, state) + local styletable = state.style + table.insert(out, '<pre>') + local hide_count = 0 + --- @type integer[] + local stack = {} + + local function loop(row) + local style_line = styletable[row] + if style_line.hide and (styletable[row - 1] or {}).hide then + return + end + _extend_virt_lines(out, state, row) + --Possible improvement (altermo): + --Instead of looping over all the buffer characters per line, + --why not loop over all the style_line cells, + --and then calculating the amount of text. + if style_line.hide then + return + end + local line = vim.api.nvim_buf_get_lines(state.bufnr, row - 1, row, false)[1] or '' + local s = '' + s = s .. _pre_text_to_html(state, row) + for col = 1, #line + 1 do + local cell = style_line[col] + --- @type table? + local char + if cell then + for i = #cell[2], 1, -1 do + local hlid = cell[2][i] + if hlid < 0 then + if hlid == HIDE_ID then + hide_count = hide_count - 1 + end + else + --- @type integer? + local index + for idx = #stack, 1, -1 do + s = s .. (name_to_closetag(state.highlights_name[stack[idx]])) + if stack[idx] == hlid then + index = idx + break + end + end + assert(index, 'a coles tag which has no corresponding open tag') + for idx = index + 1, #stack do + s = s .. (name_to_tag(state.highlights_name[stack[idx]])) + end + table.remove(stack, index) + end + end + + for _, hlid in ipairs(cell[1]) do + if hlid < 0 then + if hlid == HIDE_ID then + hide_count = hide_count + 1 + end + else + table.insert(stack, hlid) + s = s .. (name_to_tag(state.highlights_name[hlid])) + end + end + + if cell[3] then + s = s .. _virt_text_to_html(state, cell) + end + + char = cell[4][#cell[4]] + end + + if col == #line + 1 and not char then + break + end + + if hide_count == 0 then + s = s + .. _char_to_html( + state, + char + or { vim.api.nvim_buf_get_text(state.bufnr, row - 1, col - 1, row - 1, col, {})[1] } + ) + end + end + table.insert(out, s) + end + + for row = 1, state.buflen + 1 do + loop(row) + end + assert(#stack == 0, 'an open HTML tag was never closed') + table.insert(out, '</pre>') +end + +--- @param out string[] +--- @param fn fun() +local function extend_body(out, fn) + table.insert(out, '<body style="display: flex">') + fn() + table.insert(out, '</body>') +end + +--- @param out string[] +--- @param fn fun() +local function extend_html(out, fn) + table.insert(out, '<!DOCTYPE html>') + table.insert(out, '<html>') + fn() + table.insert(out, '</html>') +end + +--- @param winid integer +--- @param global_state vim.tohtml.state.global +--- @return vim.tohtml.state +local function global_state_to_state(winid, global_state) + local bufnr = vim.api.nvim_win_get_buf(winid) + local opt = global_state.conf + local width = opt.width or vim.bo[bufnr].textwidth + if not width or width < 1 then + width = vim.api.nvim_win_get_width(winid) + end + local state = setmetatable({ + winid = winid == 0 and vim.api.nvim_get_current_win() or winid, + opt = vim.wo[winid], + style = generate_styletable(bufnr), + bufnr = bufnr, + tabstop = (' '):rep(vim.bo[bufnr].tabstop), + width = width, + buflen = vim.api.nvim_buf_line_count(bufnr), + }, { __index = global_state }) + return state --[[@as vim.tohtml.state]] +end + +--- @param opt vim.tohtml.opt +--- @param title? string +--- @return vim.tohtml.state.global +local function opt_to_global_state(opt, title) + local fonts = {} + if opt.font then + fonts = type(opt.font) == 'string' and { opt.font } or opt.font --[[@as (string[])]] + elseif vim.o.guifont:match('^[^:]+') then + table.insert(fonts, vim.o.guifont:match('^[^:]+')) + end + table.insert(fonts, 'monospace') + --- @type vim.tohtml.state.global + local state = { + background = get_background_color(), + foreground = get_foreground_color(), + title = opt.title or title or false, + font = table.concat(fonts, ','), + highlights_name = {}, + conf = opt, + } + return state +end + +--- @type fun(state: vim.tohtml.state)[] +local styletable_funcs = { + styletable_syntax, + styletable_diff, + styletable_treesitter, + styletable_match, + styletable_extmarks, + styletable_conceal, + styletable_listchars, + styletable_folds, + styletable_statuscolumn, +} + +--- @param state vim.tohtml.state +local function state_generate_style(state) + vim.api.nvim_win_call(state.winid, function() + for _, fn in ipairs(styletable_funcs) do + --- @type string? + local cond + if type(fn) == 'table' then + cond = fn[2] --[[@as string]] + --- @type function + fn = fn[1] + end + if not cond or cond(state) then + fn(state) + end + end + end) +end + +--- @param winid integer[]|integer +--- @param opt? vim.tohtml.opt +--- @return string[] +local function win_to_html(winid, opt) + if type(winid) == 'number' then + winid = { winid } + end + --- @cast winid integer[] + assert(#winid > 0, 'no window specified') + opt = opt or {} + local title = table.concat( + vim.tbl_map(vim.api.nvim_buf_get_name, vim.tbl_map(vim.api.nvim_win_get_buf, winid)), + ',' + ) + local global_state = opt_to_global_state(opt, title) + --- @type vim.tohtml.state[] + local states = {} + for _, i in ipairs(winid) do + local state = global_state_to_state(i, global_state) + state_generate_style(state) + table.insert(states, state) + end + local html = {} + extend_html(html, function() + extend_head(html, global_state) + extend_body(html, function() + for _, state in ipairs(states) do + extend_pre(html, state) + end + end) + end) + return html +end + +local M = {} + +--- Converts the buffer shown in the window {winid} to HTML and returns the output as a list of string. +--- @param winid? integer Window to convert (defaults to current window) +--- @param opt? vim.tohtml.opt (table) Optional parameters. +--- - title (string): Title tag to set in the generated HTML code (defaults to buffer name) +--- - number_lines (boolean): Show line numbers (defaults to `false`) +--- - font (string|string[]): Fonts to use (defaults to `guifont`) +--- - width (integer) Width used for items which are either right aligned or repeat a character infinitely +--- (defaults to 'textwidth' if non-zero or window width otherwise) +--- @return string[] +function M.tohtml(winid, opt) + return win_to_html(winid or 0, opt) +end + +return M diff --git a/runtime/plugin/tohtml.lua b/runtime/plugin/tohtml.lua new file mode 100644 index 0000000000..893419ece6 --- /dev/null +++ b/runtime/plugin/tohtml.lua @@ -0,0 +1,11 @@ +if vim.g.loaded_2html_plugin ~= nil then + return +end +vim.g.loaded_2html_plugin = true + +vim.api.nvim_create_user_command('TOhtml', function(args) + local outfile = args.args ~= '' and args.args or vim.fn.tempname() .. '.html' + local html = require('tohtml').tohtml() + vim.fn.writefile(html, outfile) + vim.cmd.split(outfile) +end, { bar = true, nargs = '?' }) diff --git a/runtime/plugin/tohtml.vim b/runtime/plugin/tohtml.vim deleted file mode 100644 index 56eb2c15bf..0000000000 --- a/runtime/plugin/tohtml.vim +++ /dev/null @@ -1,254 +0,0 @@ -" Vim plugin for converting a syntax highlighted file to HTML. -" Maintainer: Ben Fritz <fritzophrenic@gmail.com> -" Last Change: 2023 Sep 07 -" -" The core of the code is in $VIMRUNTIME/autoload/tohtml.vim and -" $VIMRUNTIME/syntax/2html.vim -" -if exists('g:loaded_2html_plugin') - finish -endif -let g:loaded_2html_plugin = 'vim9.0_v2' - -" -" Changelog: {{{ -" 9.0_v2 (this version): - Warn if using deprecated g:use_xhtml option -" - Change default g:html_use_input_for_pc to "none" -" instead of "fallback". All modern browsers support -" the "user-select: none" and "content:" CSS -" properties so the older method relying on extra -" markup and unspecified browser/app clipboard -" handling is only needed in rare special cases. -" - Fix SourceForge issue #33: generate diff filler -" correctly when new lines have been added to or -" removed from end of buffer. -" - Fix SourceForge issue #32/Vim Github issue #8547: -" use translated highlight ID for styling the -" special-use group names (e.g. LineNr) used -" directly by name in the 2html processing. -" - Fix SourceForge issue #26, refactoring to use -" :let-heredoc style string assignment and -" additional fixes for ".." vs. "." style string -" concatenation. Requires Vim v8.1.1354 or higher. -" 9.0_v1 (Vim 9.0.1275): - Implement g:html_no_doc and g:html_no_modeline -" for diff mode. Add tests. -" (Vim 9.0.1122): NOTE: no version string update for this version! -" - Bugfix for variable name in g:html_no_doc -" (Vim 9.0.0819): NOTE: no version string update for this version! -" - Add options g:html_no_doc, g:html_no_lines, -" and g:html_no_modeline (partially included in Vim -" runtime prior to version string update). -" - Updates for new Vim9 string append style (i.e. use -" ".." instead of "."). Requires Vim version -" 8.1.1114 or higher. -" -" 8.1 updates: {{{ -" 8.1_v2 (Vim 8.1.2312): - Fix SourceForge issue #19: fix calculation of tab -" stop position to use in expanding a tab, when that -" tab occurs after a syntax match which in turn -" comes after previously expanded tabs. -" - Set eventignore while splitting a window for the -" destination file to ignore FileType events; -" speeds up processing when the destination file -" already exists and HTML highlight takes too long. -" - Fix SourceForge issue #20: progress bar could not be -" seen when DiffDelete background color matched -" StatusLine background color. Added TOhtmlProgress -" highlight group for manual user override, but -" calculate it to be visible compared to StatusLine -" by default. -" - Fix SourceForge issue #1: Remove workaround for old -" browsers which don't support 'ch' CSS unit, since -" all modern browsers, including IE>=9, support it. -" - Fix SourceForge issue #10: support termguicolors -" - Fix SourceForge issue #21: default to using -" generated content instead of <input> tags for -" uncopyable text, so that text is correctly -" prevented from being copied in chrome. Use -" g:html_use_input_for_pc option to control the -" method used. -" - Switch to HTML5 to allow using vnu as a validator -" in unit test. -" - Fix fallback sizing of <input> tags for browsers -" without "ch" support. -" - Fix cursor on unselectable diff filler text. -" 8.1_v1 (Vim 8.1.0528): - Fix SourceForge issue #6: Don't generate empty -" script tag. -" - Fix SourceForge issue #5: javascript should -" declare variables with "var". -" - Fix SourceForge issue #13: errors thrown sourcing -" 2html.vim directly when plugins not loaded. -" - Fix SourceForge issue #16: support 'vartabstop'. -"}}} -" -" 7.4 updates: {{{ -" 7.4_v2 (Vim 7.4.0899): Fix error raised when converting a diff containing -" an empty buffer. Jan Stocker: allow g:html_font to -" take a list so it is easier to specfiy fallback -" fonts in the generated CSS. -" 7.4_v1 (Vim 7.4.0000): Fix modeline mangling for new "Vim:" format, and -" also for version-specific modelines like "vim>703:". -"}}} -" -" 7.3 updates: {{{ -" 7.3_v14 (Vim 7.3.1246): Allow suppressing line number anchors using -" g:html_line_ids=0. Allow customizing -" important IDs (like line IDs and fold IDs) using -" g:html_id_expr evaluated when the buffer conversion -" is started. -" 7.3_v13 (Vim 7.3.1088): Keep foldmethod at manual in the generated file and -" insert modeline to set it to manual. -" Fix bug: diff mode with 2 unsaved buffers creates a -" duplicate of one buffer instead of including both. -" Add anchors to each line so you can put '#L123' -" or '#123' at the end of the URL to jump to line 123 -" (idea by Andy Spencer). Add javascript to open folds -" to show the anchor being jumped to if it is hidden. -" Fix XML validation error: &nsbp; not part of XML. -" Allow TOhtml to chain together with other commands -" using |. -" 7.3_v12 (Vim 7.3.0616): Fix modeline mangling to also work for when multiple -" highlight groups make up the start-of-modeline text. -" Improve render time of page with uncopyable regions -" by not using one-input-per-char. Change name of -" uncopyable option from html_unselectable to -" html_prevent_copy. Added html_no_invalid option and -" default to inserting invalid markup for uncopyable -" regions to prevent MS Word from pasting undeletable -" <input> elements. Fix 'cpo' handling (Thilo Six). -" 7.3_v12b1: Add html_unselectable option. Rework logic to -" eliminate post-processing substitute commands in -" favor of doing the work up front. Remove unnecessary -" special treatment of 'LineNr' highlight group. Minor -" speed improvements. Fix modeline mangling in -" generated output so it works for text in the first -" column. Fix missing line number and fold column in -" diff filler lines. Fix that some fonts have a 1px -" gap (using a dirty hack, improvements welcome). Add -" "colorscheme" meta tag. Does NOT include support for -" the new default foldtext added in v11, as the patch -" adding it has not yet been included in Vim. -" 7.3_v11 ( unreleased ): Support new default foldtext from patch by Christian -" Brabandt in -" http://groups.google.com/d/topic/vim_dev/B6FSGfq9VoI/discussion. -" This patch has not yet been included in Vim, thus -" these changes are removed in the next version. -" 7.3_v10 (Vim 7.3.0227): Fix error E684 when converting a range wholly inside -" multiple nested folds with dynamic folding on. -" Also fix problem with foldtext in this situation. -" 7.3_v9 (Vim 7.3.0170): Add html_pre_wrap option active with html_use_css -" and without html_no_pre, default value same as -" 'wrap' option, (Andy Spencer). Don't use -" 'fileencoding' for converted document encoding if -" 'buftype' indicates a special buffer which isn't -" written. -" 7.3_v8 (Vim 7.3.0100): Add html_expand_tabs option to allow leaving tab -" characters in generated output (Andy Spencer). -" Escape text that looks like a modeline so Vim -" doesn't use anything in the converted HTML as a -" modeline. Bugfixes: Fix folding when a fold starts -" before the conversion range. Remove fold column when -" there are no folds. -" 7.3_v7 (Vim 7-3-0063): see betas released on vim_dev below: -" 7.3_v7b3: Fixed bug, convert Unicode to UTF-8 all the way. -" 7.3_v7b2: Remove automatic detection of encodings that are not -" supported by all major browsers according to -" http://wiki.whatwg.org/wiki/Web_Encodings and -" convert to UTF-8 for all Unicode encodings. Make -" HTML encoding to Vim encoding detection be -" case-insensitive for built-in pairs. -" 7.3_v7b1: Remove use of setwinvar() function which cannot be -" called in restricted mode (Andy Spencer). Use -" 'fencoding' instead of 'encoding' to determine by -" charset, and make sure the 'fenc' of the generated -" file matches its indicated charset. Add charsets for -" all of Vim's natively supported encodings. -" 7.3_v6 (Vim 7.3.0000): Really fix bug with 'nowrapscan', 'magic' and other -" user settings interfering with diff mode generation, -" trailing whitespace (e.g. line number column) when -" using html_no_pre, and bugs when using -" html_hover_unfold. -" 7.3_v5 ( unreleased ): Fix bug with 'nowrapscan' and also with out-of-sync -" folds in diff mode when first line was folded. -" 7.3_v4 (Vim 7.3.0000): Bugfixes, especially for xhtml markup, and diff mode -" 7.3_v3 (Vim 7.3.0000): Refactor option handling and make html_use_css -" default to true when not set to anything. Use strict -" doctypes where possible. Rename use_xhtml option to -" html_use_xhtml for consistency. Use .xhtml extension -" when using this option. Add meta tag for settings. -" 7.3_v2 (Vim 7.3.0000): Fix syntax highlighting in diff mode to use both the -" diff colors and the normal syntax colors -" 7.3_v1 (Vim 7.3.0000): Add conceal support and meta tags in output -"}}} -"}}} - -" TODO: {{{ -" * Check the issue tracker: -" https://sourceforge.net/p/vim-tohtml/issues/search/?q=%21status%3Aclosed -" * Options for generating the CSS in external style sheets. New :TOcss -" command to convert the current color scheme into a (mostly) generic CSS -" stylesheet which can be re-used. Alternate stylesheet support? Good start -" by Erik Falor -" ( https://groups.google.com/d/topic/vim_use/7XTmC4D22dU/discussion ). -" * Add optional argument to :TOhtml command to specify mode (gui, cterm, -" term) to use for the styling. Suggestion by "nacitar". -" * Add way to override or specify which RGB colors map to the color numbers -" in cterm. Get better defaults than just guessing? Suggestion by "nacitar". -" * Disable filetype detection until after all processing is done. -" * Add option for not generating the hyperlink on stuff that looks like a -" URL? Or just color the link to fit with the colorscheme (and only special -" when hovering)? -" * Bug: Opera does not allow printing more than one page if uncopyable -" regions is turned on. Possible solution: Add normal text line numbers with -" display:none, set to display:inline for print style sheets, and hide -" <input> elements for print, to allow Opera printing multiple pages (and -" other uncopyable areas?). May need to make the new text invisible to IE -" with conditional comments to prevent copying it, IE for some reason likes -" to copy hidden text. Other browsers too? -" * Bug: still a 1px gap throughout the fold column when html_prevent_copy is -" "fn" in some browsers. Specifically, in Chromium on Ubuntu (but not Chrome -" on Windows). Perhaps it is font related? -" * Bug: still some gaps in the fold column when html_prevent_copy contains -" 'd' and showing the whole diff (observed in multiple browsers). Only gaps -" on diff lines though. -" * Undercurl support via CSS3, with fallback to dotted or something: -" https://groups.google.com/d/topic/vim_use/BzXA6He1pHg/discussion -" * Redo updates for modified default foldtext (v11) when/if the patch is -" accepted to modify it. -" * Test case +diff_one_file-dynamic_folds+expand_tabs-hover_unfold -" +ignore_conceal-ignore_folding+no_foldcolumn+no_pre+no_progress -" +number_lines-pre_wrap-use_css+use_xhtml+whole_filler.xhtml -" does not show the whole diff filler as it is supposed to? -" * Bug: when 'isprint' is wrong for the current encoding, will generate -" invalid content. Can/should anything be done about this? Maybe a separate -" plugin to correct 'isprint' based on encoding? -" * Check to see if the windows-125\d encodings actually work in Unix without -" the 8bit- prefix. Add prefix to autoload dictionaries for Unix if not. -" * Font auto-detection similar to -" http://www.vim.org/scripts/script.php?script_id=2384 but for a variety of -" platforms. -" * Pull in code from http://www.vim.org/scripts/script.php?script_id=3113 : -" - listchars support -" - full-line background highlight -" - other? -" * Make it so deleted lines in a diff don't create side-scrolling (get it -" free with full-line background highlight above). -" * Restore open/closed folds and cursor position after processing each file -" with option not to restore for speed increase. -" * Add extra meta info (generation time, etc.)? -" * Tidy up so we can use strict doctype in even more situations -" * Implementation detail: add threshold for writing the lines to the html -" buffer before we're done (5000 or so lines should do it) -" * TODO comments for code cleanup scattered throughout -"}}} - -" Define the :TOhtml command when: -" - 'compatible' is not set -" - this plugin or user override was not already loaded -" - user commands are available. {{{ -if !&cp && !exists(":TOhtml") && has("user_commands") - command -range=% -bar TOhtml :call tohtml#Convert2HTML(<line1>, <line2>) -endif "}}} - -" Make sure any patches will probably use consistent indent -" vim: ts=8 sw=2 sts=2 noet fdm=marker diff --git a/runtime/syntax/2html.vim b/runtime/syntax/2html.vim deleted file mode 100644 index 5fbdad90f3..0000000000 --- a/runtime/syntax/2html.vim +++ /dev/null @@ -1,2068 +0,0 @@ -" Vim syntax support file -" Maintainer: Ben Fritz <fritzophrenic@gmail.com> -" Last Change: 2023 Sep 05 -" -" Additional contributors: -" -" Original by Bram Moolenaar <Bram@vim.org> -" Modified by David Ne\v{c}as (Yeti) <yeti@physics.muni.cz> -" XHTML support by Panagiotis Issaris <takis@lumumba.luc.ac.be> -" Made w3 compliant by Edd Barrett <vext01@gmail.com> -" Added html_font. Edd Barrett <vext01@gmail.com> -" Progress bar based off code from "progressbar widget" plugin by -" Andreas Politz, heavily modified: -" http://www.vim.org/scripts/script.php?script_id=2006 -" -" See Mercurial change logs for more! - -" Transform a file into HTML, using the current syntax highlighting. - -" this file uses line continuations -let s:cpo_sav = &cpo -let s:ls = &ls -let s:ei_sav = &eventignore -set cpo&vim - -" HTML filetype can take a while to load/highlight if the destination file -" already exists. -set eventignore+=FileType - -let s:end=line('$') - -" Font -if exists("g:html_font") - if type(g:html_font) == type([]) - let s:htmlfont = "'".. join(g:html_font,"','") .. "', monospace" - else - let s:htmlfont = "'".. g:html_font .. "', monospace" - endif -else - let s:htmlfont = "monospace" -endif - -let s:settings = tohtml#GetUserSettings() - -if s:settings.use_xhtml - let s:html5 = 0 -elseif s:settings.use_css && !s:settings.no_pre - let s:html5 = 1 -else - let s:html5 = 0 -endif - -if !exists('s:FOLDED_ID') - let s:FOLDED_ID = hlID("Folded") | lockvar s:FOLDED_ID - let s:FOLD_C_ID = hlID("FoldColumn") | lockvar s:FOLD_C_ID - let s:LINENR_ID = hlID('LineNr') | lockvar s:LINENR_ID - let s:DIFF_D_ID = hlID("DiffDelete") | lockvar s:DIFF_D_ID - let s:DIFF_A_ID = hlID("DiffAdd") | lockvar s:DIFF_A_ID - let s:DIFF_C_ID = hlID("DiffChange") | lockvar s:DIFF_C_ID - let s:DIFF_T_ID = hlID("DiffText") | lockvar s:DIFF_T_ID - let s:CONCEAL_ID = hlID('Conceal') | lockvar s:CONCEAL_ID -endif - -" Whitespace -if s:settings.pre_wrap - let s:whitespace = "white-space: pre-wrap; " -else - let s:whitespace = "" -endif - -if !empty(s:settings.prevent_copy) - if s:settings.no_invalid - " User has decided they don't want invalid markup. Still works in - " OpenOffice, and for text editors, but when pasting into Microsoft Word the - " input elements get pasted too and they cannot be deleted (at least not - " easily). - let s:unselInputType = "" - else - " Prevent from copy-pasting the input elements into Microsoft Word where - " they cannot be deleted easily by deliberately inserting invalid markup. - let s:unselInputType = " type='invalid_input_type'" - endif -endif - -" When gui colors are not supported, we can only guess the colors. -" TODO - is this true anymore? Is there a way to ask the terminal what colors -" each number means or read them from some file? -if &termguicolors || has("gui_running") - let s:whatterm = "gui" -else - let s:whatterm = "cterm" - if &t_Co == 8 - let s:cterm_color = { - \ 0: "#808080", 1: "#ff6060", 2: "#00ff00", 3: "#ffff00", - \ 4: "#8080ff", 5: "#ff40ff", 6: "#00ffff", 7: "#ffffff" - \ } - else - let s:cterm_color = { - \ 0: "#000000", 1: "#c00000", 2: "#008000", 3: "#804000", - \ 4: "#0000c0", 5: "#c000c0", 6: "#008080", 7: "#c0c0c0", - \ 8: "#808080", 9: "#ff6060", 10: "#00ff00", 11: "#ffff00", - \ 12: "#8080ff", 13: "#ff40ff", 14: "#00ffff", 15: "#ffffff" - \ } - - " Colors for 88 and 256 come from xterm. - if &t_Co == 88 - call extend(s:cterm_color, { - \ 16: "#000000", 17: "#00008b", 18: "#0000cd", 19: "#0000ff", - \ 20: "#008b00", 21: "#008b8b", 22: "#008bcd", 23: "#008bff", - \ 24: "#00cd00", 25: "#00cd8b", 26: "#00cdcd", 27: "#00cdff", - \ 28: "#00ff00", 29: "#00ff8b", 30: "#00ffcd", 31: "#00ffff", - \ 32: "#8b0000", 33: "#8b008b", 34: "#8b00cd", 35: "#8b00ff", - \ 36: "#8b8b00", 37: "#8b8b8b", 38: "#8b8bcd", 39: "#8b8bff", - \ 40: "#8bcd00", 41: "#8bcd8b", 42: "#8bcdcd", 43: "#8bcdff", - \ 44: "#8bff00", 45: "#8bff8b", 46: "#8bffcd", 47: "#8bffff", - \ 48: "#cd0000", 49: "#cd008b", 50: "#cd00cd", 51: "#cd00ff", - \ 52: "#cd8b00", 53: "#cd8b8b", 54: "#cd8bcd", 55: "#cd8bff", - \ 56: "#cdcd00", 57: "#cdcd8b", 58: "#cdcdcd", 59: "#cdcdff", - \ 60: "#cdff00", 61: "#cdff8b", 62: "#cdffcd", 63: "#cdffff", - \ 64: "#ff0000" - \ }) - call extend(s:cterm_color, { - \ 65: "#ff008b", 66: "#ff00cd", 67: "#ff00ff", 68: "#ff8b00", - \ 69: "#ff8b8b", 70: "#ff8bcd", 71: "#ff8bff", 72: "#ffcd00", - \ 73: "#ffcd8b", 74: "#ffcdcd", 75: "#ffcdff", 76: "#ffff00", - \ 77: "#ffff8b", 78: "#ffffcd", 79: "#ffffff", 80: "#2e2e2e", - \ 81: "#5c5c5c", 82: "#737373", 83: "#8b8b8b", 84: "#a2a2a2", - \ 85: "#b9b9b9", 86: "#d0d0d0", 87: "#e7e7e7" - \ }) - elseif &t_Co == 256 - call extend(s:cterm_color, { - \ 16: "#000000", 17: "#00005f", 18: "#000087", 19: "#0000af", - \ 20: "#0000d7", 21: "#0000ff", 22: "#005f00", 23: "#005f5f", - \ 24: "#005f87", 25: "#005faf", 26: "#005fd7", 27: "#005fff", - \ 28: "#008700", 29: "#00875f", 30: "#008787", 31: "#0087af", - \ 32: "#0087d7", 33: "#0087ff", 34: "#00af00", 35: "#00af5f", - \ 36: "#00af87", 37: "#00afaf", 38: "#00afd7", 39: "#00afff", - \ 40: "#00d700", 41: "#00d75f", 42: "#00d787", 43: "#00d7af", - \ 44: "#00d7d7", 45: "#00d7ff", 46: "#00ff00", 47: "#00ff5f", - \ 48: "#00ff87", 49: "#00ffaf", 50: "#00ffd7", 51: "#00ffff", - \ 52: "#5f0000", 53: "#5f005f", 54: "#5f0087", 55: "#5f00af", - \ 56: "#5f00d7", 57: "#5f00ff", 58: "#5f5f00", 59: "#5f5f5f", - \ 60: "#5f5f87", 61: "#5f5faf", 62: "#5f5fd7", 63: "#5f5fff", - \ 64: "#5f8700" - \ }) - call extend(s:cterm_color, { - \ 65: "#5f875f", 66: "#5f8787", 67: "#5f87af", 68: "#5f87d7", - \ 69: "#5f87ff", 70: "#5faf00", 71: "#5faf5f", 72: "#5faf87", - \ 73: "#5fafaf", 74: "#5fafd7", 75: "#5fafff", 76: "#5fd700", - \ 77: "#5fd75f", 78: "#5fd787", 79: "#5fd7af", 80: "#5fd7d7", - \ 81: "#5fd7ff", 82: "#5fff00", 83: "#5fff5f", 84: "#5fff87", - \ 85: "#5fffaf", 86: "#5fffd7", 87: "#5fffff", 88: "#870000", - \ 89: "#87005f", 90: "#870087", 91: "#8700af", 92: "#8700d7", - \ 93: "#8700ff", 94: "#875f00", 95: "#875f5f", 96: "#875f87", - \ 97: "#875faf", 98: "#875fd7", 99: "#875fff", 100: "#878700", - \ 101: "#87875f", 102: "#878787", 103: "#8787af", 104: "#8787d7", - \ 105: "#8787ff", 106: "#87af00", 107: "#87af5f", 108: "#87af87", - \ 109: "#87afaf", 110: "#87afd7", 111: "#87afff", 112: "#87d700" - \ }) - call extend(s:cterm_color, { - \ 113: "#87d75f", 114: "#87d787", 115: "#87d7af", 116: "#87d7d7", - \ 117: "#87d7ff", 118: "#87ff00", 119: "#87ff5f", 120: "#87ff87", - \ 121: "#87ffaf", 122: "#87ffd7", 123: "#87ffff", 124: "#af0000", - \ 125: "#af005f", 126: "#af0087", 127: "#af00af", 128: "#af00d7", - \ 129: "#af00ff", 130: "#af5f00", 131: "#af5f5f", 132: "#af5f87", - \ 133: "#af5faf", 134: "#af5fd7", 135: "#af5fff", 136: "#af8700", - \ 137: "#af875f", 138: "#af8787", 139: "#af87af", 140: "#af87d7", - \ 141: "#af87ff", 142: "#afaf00", 143: "#afaf5f", 144: "#afaf87", - \ 145: "#afafaf", 146: "#afafd7", 147: "#afafff", 148: "#afd700", - \ 149: "#afd75f", 150: "#afd787", 151: "#afd7af", 152: "#afd7d7", - \ 153: "#afd7ff", 154: "#afff00", 155: "#afff5f", 156: "#afff87", - \ 157: "#afffaf", 158: "#afffd7" - \ }) - call extend(s:cterm_color, { - \ 159: "#afffff", 160: "#d70000", 161: "#d7005f", 162: "#d70087", - \ 163: "#d700af", 164: "#d700d7", 165: "#d700ff", 166: "#d75f00", - \ 167: "#d75f5f", 168: "#d75f87", 169: "#d75faf", 170: "#d75fd7", - \ 171: "#d75fff", 172: "#d78700", 173: "#d7875f", 174: "#d78787", - \ 175: "#d787af", 176: "#d787d7", 177: "#d787ff", 178: "#d7af00", - \ 179: "#d7af5f", 180: "#d7af87", 181: "#d7afaf", 182: "#d7afd7", - \ 183: "#d7afff", 184: "#d7d700", 185: "#d7d75f", 186: "#d7d787", - \ 187: "#d7d7af", 188: "#d7d7d7", 189: "#d7d7ff", 190: "#d7ff00", - \ 191: "#d7ff5f", 192: "#d7ff87", 193: "#d7ffaf", 194: "#d7ffd7", - \ 195: "#d7ffff", 196: "#ff0000", 197: "#ff005f", 198: "#ff0087", - \ 199: "#ff00af", 200: "#ff00d7", 201: "#ff00ff", 202: "#ff5f00", - \ 203: "#ff5f5f", 204: "#ff5f87" - \ }) - call extend(s:cterm_color, { - \ 205: "#ff5faf", 206: "#ff5fd7", 207: "#ff5fff", 208: "#ff8700", - \ 209: "#ff875f", 210: "#ff8787", 211: "#ff87af", 212: "#ff87d7", - \ 213: "#ff87ff", 214: "#ffaf00", 215: "#ffaf5f", 216: "#ffaf87", - \ 217: "#ffafaf", 218: "#ffafd7", 219: "#ffafff", 220: "#ffd700", - \ 221: "#ffd75f", 222: "#ffd787", 223: "#ffd7af", 224: "#ffd7d7", - \ 225: "#ffd7ff", 226: "#ffff00", 227: "#ffff5f", 228: "#ffff87", - \ 229: "#ffffaf", 230: "#ffffd7", 231: "#ffffff", 232: "#080808", - \ 233: "#121212", 234: "#1c1c1c", 235: "#262626", 236: "#303030", - \ 237: "#3a3a3a", 238: "#444444", 239: "#4e4e4e", 240: "#585858", - \ 241: "#626262", 242: "#6c6c6c", 243: "#767676", 244: "#808080", - \ 245: "#8a8a8a", 246: "#949494", 247: "#9e9e9e", 248: "#a8a8a8", - \ 249: "#b2b2b2", 250: "#bcbcbc", 251: "#c6c6c6", 252: "#d0d0d0", - \ 253: "#dadada", 254: "#e4e4e4", 255: "#eeeeee" - \ }) - endif - endif -endif - -" Return good color specification: in GUI no transformation is done, in -" terminal return RGB values of known colors and empty string for unknown -if s:whatterm == "gui" - function! s:HtmlColor(color) - return a:color - endfun -else - function! s:HtmlColor(color) - if has_key(s:cterm_color, a:color) - return s:cterm_color[a:color] - else - return "" - endif - endfun -endif - -" Find out the background and foreground color for use later -let s:fgc = s:HtmlColor(synIDattr(hlID("Normal")->synIDtrans(), "fg#", s:whatterm)) -let s:bgc = s:HtmlColor(synIDattr(hlID("Normal")->synIDtrans(), "bg#", s:whatterm)) -if s:fgc == "" - let s:fgc = ( &background == "dark" ? "#ffffff" : "#000000" ) -endif -if s:bgc == "" - let s:bgc = ( &background == "dark" ? "#000000" : "#ffffff" ) -endif - -if !s:settings.use_css - " Return opening HTML tag for given highlight id - function! s:HtmlOpening(id, extra_attrs) - let a = "" - let translated_ID = synIDtrans(a:id) - if synIDattr(translated_ID, "inverse") - " For inverse, we always must set both colors (and exchange them) - let x = s:HtmlColor(synIDattr(translated_ID, "fg#", s:whatterm)) - let a = a .. '<span '..a:extra_attrs..'style="background-color: ' .. ( x != "" ? x : s:fgc ) .. '">' - let x = s:HtmlColor(synIDattr(translated_ID, "bg#", s:whatterm)) - let a = a .. '<font color="' .. ( x != "" ? x : s:bgc ) .. '">' - else - let x = s:HtmlColor(synIDattr(translated_ID, "bg#", s:whatterm)) - if x != "" - let a = a .. '<span '..a:extra_attrs..'style="background-color: ' .. x .. '">' - elseif !empty(a:extra_attrs) - let a = a .. '<span '..a:extra_attrs..'>' - endif - let x = s:HtmlColor(synIDattr(translated_ID, "fg#", s:whatterm)) - if x != "" | let a = a .. '<font color="' .. x .. '">' | endif - endif - if synIDattr(translated_ID, "bold") | let a = a .. "<b>" | endif - if synIDattr(translated_ID, "italic") | let a = a .. "<i>" | endif - if synIDattr(translated_ID, "underline") | let a = a .. "<u>" | endif - return a - endfun - - " Return closing HTML tag for given highlight id - function! s:HtmlClosing(id, has_extra_attrs) - let a = "" - let translated_ID = synIDtrans(a:id) - if synIDattr(translated_ID, "underline") | let a = a .. "</u>" | endif - if synIDattr(translated_ID, "italic") | let a = a .. "</i>" | endif - if synIDattr(translated_ID, "bold") | let a = a .. "</b>" | endif - if synIDattr(translated_ID, "inverse") - let a = a .. '</font></span>' - else - let x = s:HtmlColor(synIDattr(translated_ID, "fg#", s:whatterm)) - if x != "" | let a = a .. '</font>' | endif - let x = s:HtmlColor(synIDattr(translated_ID, "bg#", s:whatterm)) - if x != "" || a:has_extra_attrs | let a = a .. '</span>' | endif - endif - return a - endfun -endif - -" Use a different function for formatting based on user options. This way we -" can avoid a lot of logic during the actual execution. -" -" Build the function line by line containing only what is needed for the options -" in use for maximum code sharing with minimal branch logic for greater speed. -" -" Note, 'exec' commands do not recognize line continuations, so must concatenate -" lines rather than continue them. -if s:settings.use_css - " save CSS to a list of rules to add to the output at the end of processing - - " first, get the style names we need - let s:wrapperfunc_lines = [] - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - function! s:BuildStyleWrapper(style_id, diff_style_id, extra_attrs, text, make_unselectable, unformatted) - - let l:style_name = synIDattr(a:style_id, "name", s:whatterm) - ENDLET - if &diff - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - let l:diff_style_name = synIDattr(a:diff_style_id, "name", s:whatterm) - ENDLET - - " Add normal groups and diff groups to separate lists so we can order them to - " allow diff highlight to override normal highlight - - " if primary style IS a diff style, grab it from the diff cache instead - " (always succeeds because we pre-populate it) - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - - if a:style_id == s:DIFF_D_ID || a:style_id == s:DIFF_A_ID || a:style_id == s:DIFF_C_ID || a:style_id == s:DIFF_T_ID - let l:saved_style = get(s:diffstylelist,a:style_id) - else - ENDLET - endif - - " get primary style info from cache or build it on the fly if not found - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - let l:saved_style = get(s:stylelist,a:style_id) - if type(l:saved_style) == type(0) - unlet l:saved_style - let l:saved_style = s:CSS1(a:style_id) - if l:saved_style != "" - let l:saved_style = "." .. l:style_name .. " { " .. l:saved_style .. "}" - endif - let s:stylelist[a:style_id] = l:saved_style - endif - ENDLET - if &diff - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - endif - ENDLET - endif -" Ignore this comment, just bypassing a highlighting issue: if - - " Build the wrapper tags around the text. It turns out that caching these - " gives pretty much zero performance gain and adds a lot of logic. - - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - - if l:saved_style == "" && empty(a:extra_attrs) - ENDLET - if &diff - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - if a:diff_style_id <= 0 - ENDLET - endif - " no surroundings if neither primary nor diff style has any info - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - return a:text - ENDLET - if &diff - " no primary style, but diff style - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - else - return '<span class="' ..l:diff_style_name .. '">'..a:text.."</span>" - endif - ENDLET - endif - " Ignore this comment, just bypassing a highlighting issue: if - - " open tag for non-empty primary style - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - else - ENDLET - " non-empty primary style. handle either empty or non-empty diff style. - " - " separate the two classes by a space to apply them both if there is a diff - " style name, unless the primary style is empty, then just use the diff style - " name - let s:diffstyle = - \ (&diff ? '(a:diff_style_id <= 0 ? "" : " " .. l:diff_style_name)..' - \ : '') - if s:settings.prevent_copy == "" - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim eval ENDLET - return "<span "..a:extra_attrs..'class="' .. l:style_name ..{s:diffstyle}'">'..a:text.."</span>" - ENDLET - else - - " New method: use generated content in the CSS. The only thing needed here - " is a span with no content, with an attribute holding the desired text. - " - " Old method: use an <input> element when text is unsectable. This is still - " used in conditional comments for Internet Explorer, where the new method - " doesn't work. - " - " Wrap the <input> in a <span> to allow fixing the stupid bug in some fonts - " which cause browsers to display a 1px gap between lines when these - " <input>s have a background color (maybe not really a bug, this isn't - " well-defined) - " - " use strwidth, because we care only about how many character boxes are - " needed to size the input, we don't care how many characters (including - " separately counted composing chars, from strchars()) or bytes (from - " len())the string contains. strdisplaywidth() is not needed because none of - " the unselectable groups can contain tab characters (fold column, fold - " text, line number). - " - " Note, if maxlength property needs to be added in the future, it will need - " to use strchars(), because HTML specifies that the maxlength parameter - " uses the number of unique codepoints for its limit. - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim eval ENDLET - if a:make_unselectable - let return_span = "<span "..a:extra_attrs..'class="' .. l:style_name ..{s:diffstyle}'"' - ENDLET - if s:settings.use_input_for_pc !=# 'all' - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - let return_span ..= " data-" .. l:style_name .. '-content="'..a:text..'"' - ENDLET - endif - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - let return_span ..= '>' - ENDLET - if s:settings.use_input_for_pc !=# 'none' - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim eval ENDLET - let return_span ..= '<input'..s:unselInputType..' class="' .. l:style_name ..{s:diffstyle}'"' - let return_span ..= ' value="'..substitute(a:unformatted,'\s\+$',"","")..'"' - let return_span ..= " onselect='this.blur(); return false;'" - let return_span ..= " onmousedown='this.blur(); return false;'" - let return_span ..= " onclick='this.blur(); return false;'" - let return_span ..= " readonly='readonly'" - let return_span ..= ' size="'..strwidth(a:unformatted)..'"' - let return_span ..= (s:settings.use_xhtml ? '/>' : '>') - ENDLET - endif - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim eval ENDLET - return return_span..'</span>' - else - return "<span "..a:extra_attrs..'class="' .. l:style_name .. {s:diffstyle}'">'..a:text.."</span>" - endif - ENDLET - endif - call add(s:wrapperfunc_lines, []) - let s:wrapperfunc_lines[-1] =<< trim ENDLET - endif - endfun - ENDLET -else - " Non-CSS method just needs the wrapper. - " - " Functions used to get opening/closing automatically return null strings if - " no styles exist. - if &diff - let s:wrapperfunc_lines =<< trim ENDLET - function! s:BuildStyleWrapper(style_id, diff_style_id, extra_attrs, text, unusedarg, unusedarg2) - if a:diff_style_id <= 0 - let l:diff_opening = s:HtmlOpening(a:diff_style_id, "") - let l:diff_closing = s:HtmlClosing(a:diff_style_id, 0) - else - let l:diff_opening = "" - let l:diff_closing = "" - endif - return s:HtmlOpening(a:style_id, a:extra_attrs)..l:diff_opening..a:text..l:diff_closing..s:HtmlClosing(a:style_id, !empty(a:extra_attrs)) - endfun - ENDLET - else - let s:wrapperfunc_lines =<< trim ENDLET - function! s:BuildStyleWrapper(style_id, diff_style_id, extra_attrs, text, unusedarg, unusedarg2) - return s:HtmlOpening(a:style_id, a:extra_attrs)..a:text..s:HtmlClosing(a:style_id, !empty(a:extra_attrs)) - endfun - ENDLET - endif -endif - -" create the function we built line by line above -exec join(flatten(s:wrapperfunc_lines), "\n") - -let s:diff_mode = &diff - -" Return HTML valid characters enclosed in a span of class style_name with -" unprintable characters expanded and double spaces replaced as necessary. -" -" TODO: eliminate unneeded logic like done for BuildStyleWrapper -function! s:HtmlFormat(text, style_id, diff_style_id, extra_attrs, make_unselectable) - " Replace unprintable characters - let unformatted = strtrans(a:text) - - let formatted = unformatted - - " Replace the reserved html characters - let formatted = substitute(formatted, '&', '\&', 'g') - let formatted = substitute(formatted, '<', '\<', 'g') - let formatted = substitute(formatted, '>', '\>', 'g') - let formatted = substitute(formatted, '"', '\"', 'g') - " ' is not valid in HTML but it is in XHTML, so just use the numeric - " reference for it instead. Needed because it could appear in quotes - " especially if unselectable regions is turned on. - let formatted = substitute(formatted, '"', '\'', 'g') - - " Replace a "form feed" character with HTML to do a page break - " TODO: need to prevent this in unselectable areas? Probably it should never - " BE in an unselectable area... - let formatted = substitute(formatted, "\x0c", '<hr class="PAGE-BREAK">', 'g') - - " Replace double spaces, leading spaces, and trailing spaces if needed - if ' ' != s:HtmlSpace - let formatted = substitute(formatted, ' ', s:HtmlSpace .. s:HtmlSpace, 'g') - let formatted = substitute(formatted, '^ ', s:HtmlSpace, 'g') - let formatted = substitute(formatted, ' \+$', s:HtmlSpace, 'g') - endif - - " Enclose in the correct format - return s:BuildStyleWrapper(a:style_id, a:diff_style_id, a:extra_attrs, formatted, a:make_unselectable, unformatted) -endfun - -" set up functions to call HtmlFormat in certain ways based on whether the -" element is supposed to be unselectable or not -if s:settings.prevent_copy =~# 'n' - if s:settings.number_lines - if s:settings.line_ids - function! s:HtmlFormat_n(text, style_id, diff_style_id, lnr) - if a:lnr > 0 - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, 'id="'..(exists('g:html_diff_win_num') ? 'W'..g:html_diff_win_num : "")..'L'..a:lnr..s:settings.id_suffix..'" ', 1) - else - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 1) - endif - endfun - else - function! s:HtmlFormat_n(text, style_id, diff_style_id, lnr) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 1) - endfun - endif - elseif s:settings.line_ids - " if lines are not being numbered the only reason this function gets called - " is to put the line IDs on each line; "text" will be empty but lnr will - " always be non-zero, however we don't want to use the <input> because that - " won't work as nice for empty text - function! s:HtmlFormat_n(text, style_id, diff_style_id, lnr) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, 'id="'..(exists('g:html_diff_win_num') ? 'W'..g:html_diff_win_num : "")..'L'..a:lnr..s:settings.id_suffix..'" ', 0) - endfun - endif -else - if s:settings.line_ids - function! s:HtmlFormat_n(text, style_id, diff_style_id, lnr) - if a:lnr > 0 - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, 'id="'..(exists('g:html_diff_win_num') ? 'W'..g:html_diff_win_num : "")..'L'..a:lnr..s:settings.id_suffix..'" ', 0) - else - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 0) - endif - endfun - else - function! s:HtmlFormat_n(text, style_id, diff_style_id, lnr) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 0) - endfun - endif -endif -if s:settings.prevent_copy =~# 'd' - function! s:HtmlFormat_d(text, style_id, diff_style_id) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 1) - endfun -else - function! s:HtmlFormat_d(text, style_id, diff_style_id) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 0) - endfun -endif -if s:settings.prevent_copy =~# 'f' - if s:settings.use_input_for_pc ==# 'none' - " Simply space-pad to the desired width inside the generated content (note - " that the FoldColumn definition includes a whitespace:pre rule) - function! s:FoldColumn_build(char, len, numfill, char2, class, click) - return "<a href='#' class='"..a:class.."' onclick='"..a:click.."' data-FoldColumn-content='". - \ repeat(a:char, a:len)..a:char2..repeat(' ', a:numfill). - \ "'></a>" - endfun - function! s:FoldColumn_fill() - return s:HtmlFormat(repeat(' ', s:foldcolumn), s:FOLD_C_ID, 0, "", 1) - endfun - else - " Note the <input> elements for fill spaces will have a single space for - " content, to allow active cursor CSS selection to work. - " - " Wrap the whole thing in a span for the 1px padding workaround for gaps. - " - " Build the function line by line containing only what is needed for the - " options in use for maximum code sharing with minimal branch logic for - " greater speed. - " - " Note, 'exec' commands do not recognize line continuations, so must - " concatenate lines rather than continue them. - let s:build_fun_lines = [] - call add(s:build_fun_lines, []) - let s:build_fun_lines[-1] =<< trim ENDLET - function! s:FoldColumn_build(char, len, numfill, char2, class, click) - let l:input_open = "<input readonly='readonly'"..s:unselInputType - let l:input_open ..= " onselect='this.blur(); return false;'" - let l:input_open ..= " onmousedown='this.blur(); "..a:click.." return false;'" - let l:input_open ..= " onclick='return false;' size='" - let l:input_open ..= string(a:len + (empty(a:char2) ? 0 : 1) + a:numfill) .. "' " - let l:common_attrs = "class='FoldColumn' value='" - let l:input_close = (s:settings.use_xhtml ? "' />" : "'>") - let l:return_span = "<span class='"..a:class.."'>" - let l:return_span ..= l:input_open..l:common_attrs..repeat(a:char, a:len)..(a:char2) - let l:return_span ..= l:input_close - ENDLET - if s:settings.use_input_for_pc ==# 'fallback' - call add(s:build_fun_lines, []) - let s:build_fun_lines[-1] =<< trim ENDLET - let l:return_span ..= "<a href='#' class='FoldColumn' onclick='"..a:click.."'" - let l:return_span ..= " data-FoldColumn-content='" - let l:return_span ..= repeat(a:char, a:len)..a:char2..repeat(' ', a:numfill) - let l:return_span ..= "'></a>" - ENDLET - endif - call add(s:build_fun_lines, []) - let s:build_fun_lines[-1] =<< trim ENDLET - let l:return_span ..= "</span>" - return l:return_span - endfun - ENDLET - " create the function we built line by line above - exec join(flatten(s:build_fun_lines), "\n") - - function! s:FoldColumn_fill() - return s:FoldColumn_build(' ', s:foldcolumn, 0, '', 'FoldColumn', '') - endfun - endif -else - " For normal fold columns, simply space-pad to the desired width (note that - " the FoldColumn definition includes a whitespace:pre rule) - function! s:FoldColumn_build(char, len, numfill, char2, class, click) - return "<a href='#' class='"..a:class.."' onclick='"..a:click.."'>". - \ repeat(a:char, a:len)..a:char2..repeat(' ', a:numfill). - \ "</a>" - endfun - function! s:FoldColumn_fill() - return s:HtmlFormat(repeat(' ', s:foldcolumn), s:FOLD_C_ID, 0, "", 0) - endfun -endif -if s:settings.prevent_copy =~# 't' - " put an extra empty span at the end for dynamic folds, so the linebreak can - " be surrounded. Otherwise do it as normal. - " - " TODO: isn't there a better way to do this, than placing it here and using a - " substitute later? - if s:settings.dynamic_folds - function! s:HtmlFormat_t(text, style_id, diff_style_id) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 1) . - \ s:HtmlFormat("", a:style_id, 0, "", 0) - endfun - else - function! s:HtmlFormat_t(text, style_id, diff_style_id) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 1) - endfun - endif -else - function! s:HtmlFormat_t(text, style_id, diff_style_id) - return s:HtmlFormat(a:text, a:style_id, a:diff_style_id, "", 0) - endfun -endif - -" Return CSS style describing given highlight id (can be empty) -function! s:CSS1(id) - let a = "" - let translated_ID = synIDtrans(a:id) - if synIDattr(translated_ID, "inverse") - " For inverse, we always must set both colors (and exchange them) - let x = s:HtmlColor(synIDattr(translated_ID, "bg#", s:whatterm)) - let a = a .. "color: " .. ( x != "" ? x : s:bgc ) .. "; " - let x = s:HtmlColor(synIDattr(translated_ID, "fg#", s:whatterm)) - let a = a .. "background-color: " .. ( x != "" ? x : s:fgc ) .. "; " - else - let x = s:HtmlColor(synIDattr(translated_ID, "fg#", s:whatterm)) - if x != "" | let a = a .. "color: " .. x .. "; " | endif - let x = s:HtmlColor(synIDattr(translated_ID, "bg#", s:whatterm)) - if x != "" - let a = a .. "background-color: " .. x .. "; " - " stupid hack because almost every browser seems to have at least one font - " which shows 1px gaps between lines which have background - let a = a .. "padding-bottom: 1px; " - elseif (translated_ID == s:FOLDED_ID || translated_ID == s:LINENR_ID || translated_ID == s:FOLD_C_ID) && !empty(s:settings.prevent_copy) - " input elements default to a different color than the rest of the page - let a = a .. "background-color: " .. s:bgc .. "; " - endif - endif - if synIDattr(translated_ID, "bold") | let a = a .. "font-weight: bold; " | endif - if synIDattr(translated_ID, "italic") | let a = a .. "font-style: italic; " | endif - if synIDattr(translated_ID, "underline") | let a = a .. "text-decoration: underline; " | endif - return a -endfun - -if s:settings.dynamic_folds - " compares two folds as stored in our list of folds - " A fold is "less" than another if it starts at an earlier line number, - " or ends at a later line number, ties broken by fold level - function! s:FoldCompare(f1, f2) - if a:f1.firstline != a:f2.firstline - " put it before if it starts earlier - return a:f1.firstline - a:f2.firstline - elseif a:f1.lastline != a:f2.lastline - " put it before if it ends later - return a:f2.lastline - a:f1.lastline - else - " if folds begin and end on the same lines, put lowest fold level first - return a:f1.level - a:f2.level - endif - endfunction - -endif - - -" Set some options to make it work faster. -" Don't report changes for :substitute, there will be many of them. -" Don't change other windows; turn off scroll bind temporarily -let s:old_title = &title -let s:old_icon = &icon -let s:old_et = &l:et -let s:old_bind = &l:scrollbind -let s:old_report = &report -let s:old_search = @/ -let s:old_more = &more -set notitle noicon -setlocal et -set nomore -set report=1000000 -setlocal noscrollbind - -if exists(':ownsyntax') && exists('w:current_syntax') - let s:current_syntax = w:current_syntax -elseif exists('b:current_syntax') - let s:current_syntax = b:current_syntax -else - let s:current_syntax = 'none' -endif - -if s:current_syntax == '' - let s:current_syntax = 'none' -endif - -" If the user is sourcing this script directly then the plugin version isn't -" known because the main plugin script didn't load. In the usual case where the -" user still has the full Vim runtime installed, or has this full plugin -" installed in a package or something, then we can extract the version from the -" main plugin file at it's usual spot relative to this file. Otherwise the user -" is assembling their runtime piecemeal and we have no idea what versions of -" other files may be present so don't even try to make a guess or assume the -" presence of other specific files with specific meaning. -" -" We don't want to actually source the main plugin file here because the user -" may have a good reason not to (e.g. they define their own TOhtml command or -" something). -" -" If this seems way too complicated and convoluted, it is. Probably I should -" have put the version information in the autoload file from the start. But the -" version has been in the global variable for so long that changing it could -" break a lot of user scripts. -if exists("g:loaded_2html_plugin") - let s:pluginversion = g:loaded_2html_plugin -else - if !exists("g:unloaded_tohtml_plugin") - let s:main_plugin_path = expand("<sfile>:p:h:h").."/plugin/tohtml.vim" - if filereadable(s:main_plugin_path) - let s:lines = readfile(s:main_plugin_path, "", 20) - call filter(s:lines, 'v:val =~ "loaded_2html_plugin = "') - if empty(s:lines) - let g:unloaded_tohtml_plugin = "unknown" - else - let g:unloaded_tohtml_plugin = substitute(s:lines[0], '.*loaded_2html_plugin = \([''"]\)\(\%(\1\@!.\)\+\)\1', '\2', '') - endif - unlet s:lines - else - let g:unloaded_tohtml_plugin = "unknown" - endif - unlet s:main_plugin_path - endif - let s:pluginversion = g:unloaded_tohtml_plugin -endif - -" Split window to create a buffer with the HTML file. -let s:orgbufnr = winbufnr(0) -let s:origwin_stl = &l:stl -if expand("%") == "" - if exists('g:html_diff_win_num') - exec 'new Untitled_win'..g:html_diff_win_num..'.'.(s:settings.use_xhtml ? 'xhtml' : 'html') - else - exec 'new Untitled.'..(s:settings.use_xhtml ? 'xhtml' : 'html') - endif -else - exec 'new %.'..(s:settings.use_xhtml ? 'xhtml' : 'html') -endif - -" Resize the new window to very small in order to make it draw faster -let s:old_winheight = winheight(0) -let s:old_winfixheight = &l:winfixheight -if s:old_winheight > 2 - resize 1 " leave enough room to view one line at a time - norm! G - norm! zt -endif -setlocal winfixheight - -let s:newwin_stl = &l:stl - -" on the new window, set the least time-consuming fold method -let s:old_fen = &foldenable -setlocal foldmethod=manual -setlocal nofoldenable - -let s:newwin = winnr() -let s:orgwin = bufwinnr(s:orgbufnr) - -setlocal modifiable -%d -let s:old_paste = &paste -set paste -let s:old_magic = &magic -set magic - -" set the fileencoding to match the charset we'll be using -let &l:fileencoding=s:settings.vim_encoding - -" According to http://www.w3.org/TR/html4/charset.html#doc-char-set, the byte -" order mark is highly recommend on the web when using multibyte encodings. But, -" it is not a good idea to include it on UTF-8 files. Otherwise, let Vim -" determine when it is actually inserted. -if s:settings.vim_encoding == 'utf-8' - setlocal nobomb -else - setlocal bomb -endif - -let s:lines = [] - -if s:settings.use_xhtml - if s:settings.encoding != "" - call add(s:lines, "<?xml version=\"1.0\" encoding=\"" .. s:settings.encoding .. "\"?>") - else - call add(s:lines, "<?xml version=\"1.0\"?>") - endif - let s:tag_close = ' />' -else - let s:tag_close = '>' -endif - -let s:HtmlSpace = ' ' -let s:LeadingSpace = ' ' -let s:HtmlEndline = '' -if s:settings.no_pre - let s:HtmlEndline = '<br' .. s:tag_close - let s:LeadingSpace = s:settings.use_xhtml ? ' ' : ' ' - let s:HtmlSpace = '\' .. s:LeadingSpace -endif - -" HTML header, with the title and generator ;-). Left free space for the CSS, -" to be filled at the end. -if !s:settings.no_doc - call extend(s:lines, [ - \ "<html>", - \ "<head>"]) - " include encoding as close to the top as possible, but only if not already - " contained in XML information (to avoid haggling over content type) - if s:settings.encoding != "" && !s:settings.use_xhtml - if s:html5 - call add(s:lines, '<meta charset="' .. s:settings.encoding .. '"' .. s:tag_close) - else - call add(s:lines, "<meta http-equiv=\"content-type\" content=\"text/html; charset=" .. s:settings.encoding .. '"' .. s:tag_close) - endif - endif - call extend(s:lines, [ - \ ("<title>"..expand("%:p:~").."</title>"), - \ ("<meta name=\"Generator\" content=\"Vim/"..v:version/100.."."..v:version%100..'"'..s:tag_close), - \ ("<meta name=\"plugin-version\" content=\""..s:pluginversion..'"'..s:tag_close) - \ ]) - call add(s:lines, '<meta name="syntax" content="'..s:current_syntax..'"'..s:tag_close) - call add(s:lines, '<meta name="settings" content="'.. - \ join(filter(keys(s:settings),'s:settings[v:val]'),',').. - \ ',prevent_copy='..s:settings.prevent_copy.. - \ ',use_input_for_pc='..s:settings.use_input_for_pc.. - \ '"'..s:tag_close) - call add(s:lines, '<meta name="colorscheme" content="'.. - \ (exists('g:colors_name') - \ ? g:colors_name - \ : 'none').. '"'..s:tag_close) - - if s:settings.use_css - call extend(s:lines, [ - \ "<style" .. (s:html5 ? "" : " type=\"text/css\"") .. ">", - \ s:settings.use_xhtml ? "" : "<!--"]) - let s:ieonly = [] - if s:settings.dynamic_folds - if s:settings.hover_unfold - " if we are doing hover_unfold, use css 2 with css 1 fallback for IE6 - call extend(s:lines, [ - \ ".FoldColumn { text-decoration: none; white-space: pre; }", - \ "", - \ "body * { margin: 0; padding: 0; }", "", - \ ".open-fold > span.Folded { display: none; }", - \ ".open-fold > .fulltext { display: inline; }", - \ ".closed-fold > .fulltext { display: none; }", - \ ".closed-fold > span.Folded { display: inline; }", - \ "", - \ ".open-fold > .toggle-open { display: none; }", - \ ".open-fold > .toggle-closed { display: inline; }", - \ ".closed-fold > .toggle-open { display: inline; }", - \ ".closed-fold > .toggle-closed { display: none; }", - \ "", "", - \ '/* opening a fold while hovering won''t be supported by IE6 and other', - \ "similar browsers, but it should fail gracefully. */", - \ ".closed-fold:hover > .fulltext { display: inline; }", - \ ".closed-fold:hover > .toggle-filler { display: none; }", - \ ".closed-fold:hover > .Folded { display: none; }"]) - " TODO: IE6 is REALLY old and I can't even test it anymore. Maybe we - " should remove this? Leave it in for now, it was working at one point, - " and doesn't affect any modern browsers. Even newer IE versions should - " support the above code and ignore the following. - let s:ieonly = [ - \ "<!--[if lt IE 7]><style type=\"text/css\">", - \ ".open-fold .fulltext { display: inline; }", - \ ".open-fold span.Folded { display: none; }", - \ ".open-fold .toggle-open { display: none; }", - \ ".open-fold .toggle-closed { display: inline; }", - \ "", - \ ".closed-fold .fulltext { display: none; }", - \ ".closed-fold span.Folded { display: inline; }", - \ ".closed-fold .toggle-open { display: inline; }", - \ ".closed-fold .toggle-closed { display: none; }", - \ "</style>", - \ "<![endif]-->", - \] - else - " if we aren't doing hover_unfold, use CSS 1 only - call extend(s:lines, [ - \ ".FoldColumn { text-decoration: none; white-space: pre; }", - \ ".open-fold .fulltext { display: inline; }", - \ ".open-fold span.Folded { display: none; }", - \ ".open-fold .toggle-open { display: none; }", - \ ".open-fold .toggle-closed { display: inline; }", - \ "", - \ ".closed-fold .fulltext { display: none; }", - \ ".closed-fold span.Folded { display: inline; }", - \ ".closed-fold .toggle-open { display: inline; }", - \ ".closed-fold .toggle-closed { display: none; }", - \]) - endif - endif - " else we aren't doing any dynamic folding, no need for any special rules - - call extend(s:lines, [ - \ s:settings.use_xhtml ? "" : '-->', - \ "</style>", - \]) - call extend(s:lines, s:ieonly) - unlet s:ieonly - endif - - let s:uses_script = s:settings.dynamic_folds || s:settings.line_ids - - " insert script tag if needed - if s:uses_script - call extend(s:lines, [ - \ "", - \ "<script" .. (s:html5 ? "" : " type='text/javascript'") .. ">", - \ s:settings.use_xhtml ? '//<![CDATA[' : "<!--"]) - endif - - " insert javascript to toggle folds open and closed - if s:settings.dynamic_folds - call extend(s:lines, [ - \ "", - \ "function toggleFold(objID)", - \ "{", - \ " var fold;", - \ " fold = document.getElementById(objID);", - \ " if (fold.className == 'closed-fold')", - \ " {", - \ " fold.className = 'open-fold';", - \ " }", - \ " else if (fold.className == 'open-fold')", - \ " {", - \ " fold.className = 'closed-fold';", - \ " }", - \ "}" - \ ]) - endif - - if s:settings.line_ids - " insert javascript to get IDs from line numbers, and to open a fold before - " jumping to any lines contained therein - call extend(s:lines, [ - \ "", - \ "/* function to open any folds containing a jumped-to line before jumping to it */", - \ "function JumpToLine()", - \ "{", - \ " var lineNum;", - \ " lineNum = window.location.hash;", - \ " lineNum = lineNum.substr(1); /* strip off '#' */", - \ "", - \ " if (lineNum.indexOf('L') == -1) {", - \ " lineNum = 'L'+lineNum;", - \ " }", - \ " var lineElem = document.getElementById(lineNum);" - \ ]) - - if s:settings.dynamic_folds - call extend(s:lines, [ - \ "", - \ " /* navigate upwards in the DOM tree to open all folds containing the line */", - \ " var node = lineElem;", - \ " while (node && node.id != 'vimCodeElement"..s:settings.id_suffix.."')", - \ " {", - \ " if (node.className == 'closed-fold')", - \ " {", - \ " node.className = 'open-fold';", - \ " }", - \ " node = node.parentNode;", - \ " }", - \ ]) - endif - call extend(s:lines, [ - \ " /* Always jump to new location even if the line was hidden inside a fold, or", - \ " * we corrected the raw number to a line ID.", - \ " */", - \ " if (lineElem) {", - \ " lineElem.scrollIntoView(true);", - \ " }", - \ " return true;", - \ "}", - \ "if ('onhashchange' in window) {", - \ " window.onhashchange = JumpToLine;", - \ "}" - \ ]) - endif - - " insert script closing tag if needed - if s:uses_script - call extend(s:lines, [ - \ '', - \ s:settings.use_xhtml ? '//]]>' : '-->', - \ "</script>" - \ ]) - endif - - call extend(s:lines, ["</head>", - \ "<body"..(s:settings.line_ids ? " onload='JumpToLine();'" : "")..">"]) -endif - -if s:settings.no_pre - " if we're not using CSS we use a font tag which can't have a div inside - if s:settings.use_css - call extend(s:lines, ["<div id='vimCodeElement" .. s:settings.id_suffix .. "'>"]) - endif -else - call extend(s:lines, ["<pre id='vimCodeElement" .. s:settings.id_suffix .. "'>"]) -endif - -exe s:orgwin .. "wincmd w" - -" caches of style data -" initialize to include line numbers if using them -if s:settings.number_lines - let s:stylelist = { s:LINENR_ID : ".LineNr { " .. s:CSS1( s:LINENR_ID ) .. "}" } -else - let s:stylelist = {} -endif -let s:diffstylelist = { - \ s:DIFF_A_ID : ".DiffAdd { " .. s:CSS1( s:DIFF_A_ID ) .. "}", - \ s:DIFF_C_ID : ".DiffChange { " .. s:CSS1( s:DIFF_C_ID ) .. "}", - \ s:DIFF_D_ID : ".DiffDelete { " .. s:CSS1( s:DIFF_D_ID ) .. "}", - \ s:DIFF_T_ID : ".DiffText { " .. s:CSS1( s:DIFF_T_ID ) .. "}" - \ } - -" set up progress bar in the status line -if !s:settings.no_progress - " ProgressBar Indicator - let s:progressbar={} - - " Progressbar specific functions - - func! s:SetProgbarColor() - if hlID("TOhtmlProgress") != 0 - hi! link TOhtmlProgress_auto TOhtmlProgress - elseif hlID("TOhtmlProgress_auto")==0 || - \ !exists("s:last_colors_name") || !exists("g:colors_name") || - \ g:colors_name != s:last_colors_name - let s:last_colors_name = exists("g:colors_name") ? g:colors_name : "none" - - let l:diffatr = synIDattr(hlID("DiffDelete")->synIDtrans(), "reverse", s:whatterm) ? "fg#" : "bg#" - let l:stlatr = synIDattr(hlID("StatusLine")->synIDtrans(), "reverse", s:whatterm) ? "fg#" : "bg#" - - let l:progbar_color = synIDattr(hlID("DiffDelete")->synIDtrans(), l:diffatr, s:whatterm) - let l:stl_color = synIDattr(hlID("StatusLine")->synIDtrans(), l:stlatr, s:whatterm) - - if "" == l:progbar_color - let l:progbar_color = synIDattr(hlID("DiffDelete")->synIDtrans(), "reverse", s:whatterm) ? s:fgc : s:bgc - endif - if "" == l:stl_color - let l:stl_color = synIDattr(hlID("StatusLine")->synIDtrans(), "reverse", s:whatterm) ? s:fgc : s:bgc - endif - - if l:progbar_color == l:stl_color - if s:whatterm == 'cterm' - if l:progbar_color >= (&t_Co/2) - let l:progbar_color-=1 - else - let l:progbar_color+=1 - endif - else - let l:rgb = map(matchlist(l:progbar_color, '#\zs\x\x\ze\(\x\x\)\(\x\x\)')[:2], 'str2nr(v:val, 16)') - let l:avg = (l:rgb[0] + l:rgb[1] + l:rgb[2])/3 - if l:avg >= 128 - let l:avg_new = l:avg - while l:avg - l:avg_new < 0x15 - let l:rgb = map(l:rgb, 'v:val * 3 / 4') - let l:avg_new = (l:rgb[0] + l:rgb[1] + l:rgb[2])/3 - endwhile - else - let l:avg_new = l:avg - while l:avg_new - l:avg < 0x15 - let l:rgb = map(l:rgb, 'min([max([v:val, 4]) * 5 / 4, 255])') - let l:avg_new = (l:rgb[0] + l:rgb[1] + l:rgb[2])/3 - endwhile - endif - let l:progbar_color = printf("#%02x%02x%02x", l:rgb[0], l:rgb[1], l:rgb[2]) - endif - echomsg "diff detected progbar color set to" l:progbar_color - endif - exe "hi TOhtmlProgress_auto" s:whatterm.."bg="..l:progbar_color - endif - endfun - - func! s:ProgressBar(title, max_value, winnr) - let pgb=copy(s:progressbar) - let pgb.title = a:title..' ' - let pgb.max_value = a:max_value - let pgb.winnr = a:winnr - let pgb.cur_value = 0 - - let pgb.items = { 'title' : { 'color' : 'Statusline' }, - \'bar' : { 'color' : 'Statusline' , 'fillcolor' : 'TOhtmlProgress_auto' , 'bg' : 'Statusline' } , - \'counter' : { 'color' : 'Statusline' } } - let pgb.last_value = 0 - let pgb.needs_redraw = 0 - " Note that you must use len(split) instead of len() if you want to use - " unicode in title. - " - " Subtract 3 for spacing around the title. - " Subtract 4 for the percentage display. - " Subtract 2 for spacing before this. - " Subtract 2 more for the '|' on either side of the progress bar - let pgb.subtractedlen=len(split(pgb.title, '\zs'))+3+4+2+2 - let pgb.max_len = 0 - set laststatus=2 - return pgb - endfun - - " Function: progressbar.calculate_ticks() {{{1 - func! s:progressbar.calculate_ticks(pb_len) - if a:pb_len<=0 - let pb_len = 100 - else - let pb_len = a:pb_len - endif - let self.progress_ticks = map(range(pb_len+1), "v:val * self.max_value / pb_len") - endfun - - "Function: progressbar.paint() - func! s:progressbar.paint() - " Recalculate widths. - let max_len = winwidth(self.winnr) - let pb_len = 0 - " always true on first call because of initial value of self.max_len - if max_len != self.max_len - let self.max_len = max_len - - " Progressbar length - let pb_len = max_len - self.subtractedlen - - call self.calculate_ticks(pb_len) - - let self.needs_redraw = 1 - let cur_value = 0 - let self.pb_len = pb_len - else - " start searching at the last found index to make the search for the - " appropriate tick value normally take 0 or 1 comparisons - let cur_value = self.last_value - let pb_len = self.pb_len - endif - - let cur_val_max = pb_len > 0 ? pb_len : 100 - - " find the current progress bar position based on precalculated thresholds - while cur_value < cur_val_max && self.cur_value > self.progress_ticks[cur_value] - let cur_value += 1 - endwhile - - " update progress bar - if self.last_value != cur_value || self.needs_redraw || self.cur_value == self.max_value - let self.needs_redraw = 1 - let self.last_value = cur_value - - let t_color = self.items.title.color - let b_fcolor = self.items.bar.fillcolor - let b_color = self.items.bar.color - let c_color = self.items.counter.color - - let stl = "%#".t_color."#%-( ".self.title." %)". - \"%#".b_color."#". - \(pb_len>0 ? - \ ('|%#'.b_fcolor."#%-(".repeat(" ",cur_value)."%)". - \ '%#'.b_color."#".repeat(" ",pb_len-cur_value)."|"): - \ ('')). - \"%=%#".c_color."#%( ".printf("%3.d ",100*self.cur_value/self.max_value)."%% %)" - call setwinvar(self.winnr, '&stl', stl) - endif - endfun - - func! s:progressbar.incr( ... ) - let self.cur_value += (a:0 ? a:1 : 1) - " if we were making a general-purpose progress bar, we'd need to limit to a - " lower limit as well, but since we always increment with a positive value - " in this script, we only need limit the upper value - let self.cur_value = (self.cur_value > self.max_value ? self.max_value : self.cur_value) - call self.paint() - endfun - " }}} - if s:settings.dynamic_folds - " to process folds we make two passes through each line - let s:pgb = s:ProgressBar("Processing folds:", line('$')*2, s:orgwin) - endif - - call s:SetProgbarColor() -endif - -let s:build_fun_lines = [] -call add(s:build_fun_lines, []) -let s:build_fun_lines[-1] =<< trim ENDLET - func! s:Add_diff_fill(lnum) - let l:filler = diff_filler(a:lnum) - if l:filler > 0 - let l:to_insert = l:filler - while l:to_insert > 0 - let l:new = repeat(s:difffillchar, 3) - - if l:to_insert > 2 && l:to_insert < l:filler && !s:settings.whole_filler - let l:new = l:new .. " " .. l:filler .. " inserted lines " - let l:to_insert = 2 - endif -ENDLET -call add(s:build_fun_lines, []) -if !s:settings.no_pre - let s:build_fun_lines[-1] =<< trim ENDLET - " HTML line wrapping is off--go ahead and fill to the margin - " TODO: what about when CSS wrapping is turned on? - let l:new = l:new .. repeat(s:difffillchar, &columns - strlen(l:new) - s:margin) - ENDLET -else - let s:build_fun_lines[-1] =<< trim ENDLET - let l:new = l:new .. repeat(s:difffillchar, 3) - ENDLET -endif -call add(s:build_fun_lines, []) -let s:build_fun_lines[-1] =<< trim ENDLET - let l:new = s:HtmlFormat_d(l:new, s:DIFF_D_ID, 0) -ENDLET -if s:settings.number_lines - call add(s:build_fun_lines, []) - let s:build_fun_lines[-1] =<< trim ENDLET - " Indent if line numbering is on. Indent gets style of line number - " column. - let l:new = s:HtmlFormat_n(repeat(' ', s:margin), s:LINENR_ID, 0, 0) .. l:new - ENDLET -endif -if s:settings.dynamic_folds && !s:settings.no_foldcolumn - call add(s:build_fun_lines, []) - let s:build_fun_lines[-1] =<< trim ENDLET - if s:foldcolumn > 0 - " Indent for foldcolumn if there is one. Assume it's empty, there should - " not be a fold for deleted lines in diff mode. - let l:new = s:FoldColumn_fill() .. l:new - endif - ENDLET -endif -" Ignore this comment, just bypassing a highlighting issue: if -call add(s:build_fun_lines, []) -let s:build_fun_lines[-1] =<< trim ENDLET - call add(s:lines, l:new..s:HtmlEndline) - let l:to_insert = l:to_insert - 1 - endwhile - endif - endfun -ENDLET -exec join(flatten(s:build_fun_lines), "\n") - -" First do some preprocessing for dynamic folding. Do this for the entire file -" so we don't accidentally start within a closed fold or something. -let s:allfolds = [] - -if s:settings.dynamic_folds - let s:lnum = 1 - let s:end = line('$') - " save the fold text and set it to the default so we can find fold levels - let s:foldtext_save = &foldtext - setlocal foldtext& - - " we will set the foldcolumn in the html to the greater of the maximum fold - " level and the current foldcolumn setting - let s:foldcolumn = &foldcolumn - - " get all info needed to describe currently closed folds - while s:lnum <= s:end - if foldclosed(s:lnum) == s:lnum - " default fold text has '+-' and then a number of dashes equal to fold - " level, so subtract 2 from index of first non-dash after the dashes - " in order to get the fold level of the current fold - let s:level = match(foldtextresult(s:lnum), '+-*\zs[^-]') - 2 - " store fold info for later use - let s:newfold = {'firstline': s:lnum, 'lastline': foldclosedend(s:lnum), 'level': s:level,'type': "closed-fold"} - call add(s:allfolds, s:newfold) - " open the fold so we can find any contained folds - execute s:lnum.."foldopen" - else - if !s:settings.no_progress - call s:pgb.incr() - if s:pgb.needs_redraw - redrawstatus - let s:pgb.needs_redraw = 0 - endif - endif - let s:lnum = s:lnum + 1 - endif - endwhile - - " close all folds to get info for originally open folds - silent! %foldclose! - let s:lnum = 1 - - " the originally open folds will be all folds we encounter that aren't - " already in the list of closed folds - while s:lnum <= s:end - if foldclosed(s:lnum) == s:lnum - " default fold text has '+-' and then a number of dashes equal to fold - " level, so subtract 2 from index of first non-dash after the dashes - " in order to get the fold level of the current fold - let s:level = match(foldtextresult(s:lnum), '+-*\zs[^-]') - 2 - let s:newfold = {'firstline': s:lnum, 'lastline': foldclosedend(s:lnum), 'level': s:level,'type': "closed-fold"} - " only add the fold if we don't already have it - if empty(s:allfolds) || index(s:allfolds, s:newfold) == -1 - let s:newfold.type = "open-fold" - call add(s:allfolds, s:newfold) - endif - " open the fold so we can find any contained folds - execute s:lnum.."foldopen" - else - if !s:settings.no_progress - call s:pgb.incr() - if s:pgb.needs_redraw - redrawstatus - let s:pgb.needs_redraw = 0 - endif - endif - let s:lnum = s:lnum + 1 - endif - endwhile - - " sort the folds so that we only ever need to look at the first item in the - " list of folds - call sort(s:allfolds, "s:FoldCompare") - - let &l:foldtext = s:foldtext_save - unlet s:foldtext_save - - " close all folds again so we can get the fold text as we go - silent! %foldclose! - - " Go through and remove folds we don't need to (or cannot) process in the - " current conversion range - " - " If a fold is removed which contains other folds, which are included, we need - " to adjust the level of the included folds as used by the conversion logic - " (avoiding special cases is good) - " - " Note any time we remove a fold, either all of the included folds are in it, - " or none of them, because we only remove a fold if neither its start nor its - " end are within the conversion range. - let leveladjust = 0 - for afold in s:allfolds - let removed = 0 - if exists("g:html_start_line") && exists("g:html_end_line") - if afold.firstline < g:html_start_line - if afold.lastline <= g:html_end_line && afold.lastline >= g:html_start_line - " if a fold starts before the range to convert but stops within the - " range, we need to include it. Make it start on the first converted - " line. - let afold.firstline = g:html_start_line - else - " if the fold lies outside the range or the start and stop enclose - " the entire range, don't bother parsing it - call remove(s:allfolds, index(s:allfolds, afold)) - let removed = 1 - if afold.lastline > g:html_end_line - let leveladjust += 1 - endif - endif - elseif afold.firstline > g:html_end_line - " If the entire fold lies outside the range we need to remove it. - call remove(s:allfolds, index(s:allfolds, afold)) - let removed = 1 - endif - elseif exists("g:html_start_line") - if afold.firstline < g:html_start_line - " if there is no last line, but there is a first line, the end of the - " fold will always lie within the region of interest, so keep it - let afold.firstline = g:html_start_line - endif - elseif exists("g:html_end_line") - " if there is no first line we default to the first line in the buffer so - " the fold start will always be included if the fold itself is included. - " If however the entire fold lies outside the range we need to remove it. - if afold.firstline > g:html_end_line - call remove(s:allfolds, index(s:allfolds, afold)) - let removed = 1 - endif - endif - if !removed - let afold.level -= leveladjust - if afold.level+1 > s:foldcolumn - let s:foldcolumn = afold.level+1 - endif - endif - endfor - - " if we've removed folds containing the conversion range from processing, - " getting foldtext as we go won't know to open the removed folds, so the - " foldtext would be wrong; open them now. - " - " Note that only when a start and an end line is specified will a fold - " containing the current range ever be removed. - while leveladjust > 0 - exe g:html_start_line.."foldopen" - let leveladjust -= 1 - endwhile -endif - -" Now loop over all lines in the original text to convert to html. -" Use html_start_line and html_end_line if they are set. -if exists("g:html_start_line") - let s:lnum = html_start_line - if s:lnum < 1 || s:lnum > line("$") - let s:lnum = 1 - endif -else - let s:lnum = 1 -endif -if exists("g:html_end_line") - let s:end = html_end_line - if s:end < s:lnum || s:end > line("$") - let s:end = line("$") - endif -else - let s:end = line("$") -endif - -" stack to keep track of all the folds containing the current line -let s:foldstack = [] - -if !s:settings.no_progress - let s:pgb = s:ProgressBar("Processing lines:", s:end - s:lnum + 1, s:orgwin) -endif - -if s:settings.number_lines - let s:margin = strlen(s:end) + 1 -else - let s:margin = 0 -endif - -if has('folding') && !s:settings.ignore_folding - let s:foldfillchar = &fillchars[matchend(&fillchars, 'fold:')] - if s:foldfillchar == '' - let s:foldfillchar = '-' - endif -endif -let s:difffillchar = &fillchars[matchend(&fillchars, 'diff:')] -if s:difffillchar == '' - let s:difffillchar = '-' -endif - -let s:foldId = 0 - -if !s:settings.expand_tabs - " If keeping tabs, add them to printable characters so we keep them when - " formatting text (strtrans() doesn't replace printable chars) - let s:old_isprint = &isprint - setlocal isprint+=9 -endif - -while s:lnum <= s:end - - " If there are filler lines for diff mode, show these above the line. - call s:Add_diff_fill(s:lnum) - - " Start the line with the line number. - if s:settings.number_lines - let s:numcol = repeat(' ', s:margin - 1 - strlen(s:lnum)) .. s:lnum .. ' ' - endif - - let s:new = "" - - if has('folding') && !s:settings.ignore_folding && foldclosed(s:lnum) > -1 && !s:settings.dynamic_folds - " - " This is the beginning of a folded block (with no dynamic folding) - let s:new = foldtextresult(s:lnum) - if !s:settings.no_pre - " HTML line wrapping is off--go ahead and fill to the margin - let s:new = s:new .. repeat(s:foldfillchar, &columns - strlen(s:new)) - endif - - " put numcol in a separate group for sake of unselectable text - let s:new = (s:settings.number_lines ? s:HtmlFormat_n(s:numcol, s:FOLDED_ID, 0, s:lnum): "") .. s:HtmlFormat_t(s:new, s:FOLDED_ID, 0) - - " Skip to the end of the fold - let s:new_lnum = foldclosedend(s:lnum) - - if !s:settings.no_progress - call s:pgb.incr(s:new_lnum - s:lnum) - endif - - let s:lnum = s:new_lnum - - else - " - " A line that is not folded, or doing dynamic folding. - " - let s:line = getline(s:lnum) - let s:len = strlen(s:line) - - if s:settings.dynamic_folds - " First insert a closing for any open folds that end on this line - while !empty(s:foldstack) && get(s:foldstack,0).lastline == s:lnum-1 - let s:new = s:new.."</span></span>" - call remove(s:foldstack, 0) - endwhile - - " Now insert an opening for any new folds that start on this line - let s:firstfold = 1 - while !empty(s:allfolds) && get(s:allfolds,0).firstline == s:lnum - let s:foldId = s:foldId + 1 - let s:new ..= "<span id='" - let s:new ..= (exists('g:html_diff_win_num') ? "win"..g:html_diff_win_num : "") - let s:new ..= "fold"..s:foldId..s:settings.id_suffix.."' class='"..s:allfolds[0].type.."'>" - - - " Unless disabled, add a fold column for the opening line of a fold. - " - " Note that dynamic folds require using css so we just use css to take - " care of the leading spaces rather than using in the case of - " html_no_pre to make it easier - if !s:settings.no_foldcolumn - " add fold column that can open the new fold - if s:allfolds[0].level > 1 && s:firstfold - let s:new = s:new .. s:FoldColumn_build('|', s:allfolds[0].level - 1, 0, "", - \ 'toggle-open FoldColumn','javascript:toggleFold("fold'..s:foldstack[0].id..s:settings.id_suffix..'");') - endif - " add the filler spaces separately from the '+' char so that it can be - " shown/hidden separately during a hover unfold - let s:new = s:new .. s:FoldColumn_build("+", 1, 0, "", - \ 'toggle-open FoldColumn', 'javascript:toggleFold("fold'..s:foldId..s:settings.id_suffix..'");') - " If this is not the last fold we're opening on this line, we need - " to keep the filler spaces hidden if the fold is opened by mouse - " hover. If it is the last fold to open in the line, we shouldn't hide - " them, so don't apply the toggle-filler class. - let s:new = s:new .. s:FoldColumn_build(" ", 1, s:foldcolumn - s:allfolds[0].level - 1, "", - \ 'toggle-open FoldColumn'.. (get(s:allfolds, 1, {'firstline': 0}).firstline == s:lnum ?" toggle-filler" :""), - \ 'javascript:toggleFold("fold'..s:foldId..s:settings.id_suffix..'");') - - " add fold column that can close the new fold - " only add extra blank space if we aren't opening another fold on the - " same line - if get(s:allfolds, 1, {'firstline': 0}).firstline != s:lnum - let s:extra_space = s:foldcolumn - s:allfolds[0].level - else - let s:extra_space = 0 - endif - if s:firstfold - " the first fold in a line has '|' characters from folds opened in - " previous lines, before the '-' for this fold - let s:new ..= s:FoldColumn_build('|', s:allfolds[0].level - 1, s:extra_space, '-', - \ 'toggle-closed FoldColumn', 'javascript:toggleFold("fold'..s:foldId..s:settings.id_suffix..'");') - else - " any subsequent folds in the line only add a single '-' - let s:new = s:new .. s:FoldColumn_build("-", 1, s:extra_space, "", - \ 'toggle-closed FoldColumn', 'javascript:toggleFold("fold'..s:foldId..s:settings.id_suffix..'");') - endif - let s:firstfold = 0 - endif - - " Add fold text, moving the span ending to the next line so collapsing - " of folds works correctly. - " Put numcol in a separate group for sake of unselectable text. - let s:new = s:new .. (s:settings.number_lines ? s:HtmlFormat_n(s:numcol, s:FOLDED_ID, 0, 0) : "") .. substitute(s:HtmlFormat_t(foldtextresult(s:lnum), s:FOLDED_ID, 0), '</span>', s:HtmlEndline..'\n\0', '') - let s:new = s:new .. "<span class='fulltext'>" - - " open the fold now that we have the fold text to allow retrieval of - " fold text for subsequent folds - execute s:lnum.."foldopen" - call insert(s:foldstack, remove(s:allfolds,0)) - let s:foldstack[0].id = s:foldId - endwhile - - " Unless disabled, add a fold column for other lines. - " - " Note that dynamic folds require using css so we just use css to take - " care of the leading spaces rather than using in the case of - " html_no_pre to make it easier - if !s:settings.no_foldcolumn - if empty(s:foldstack) - " add the empty foldcolumn for unfolded lines if there is a fold - " column at all - if s:foldcolumn > 0 - let s:new = s:new .. s:FoldColumn_fill() - endif - else - " add the fold column for folds not on the opening line - if get(s:foldstack, 0).firstline < s:lnum - let s:new = s:new .. s:FoldColumn_build('|', s:foldstack[0].level, s:foldcolumn - s:foldstack[0].level, "", - \ 'FoldColumn', 'javascript:toggleFold("fold'..s:foldstack[0].id..s:settings.id_suffix..'");') - endif - endif - endif - endif - - " Now continue with the unfolded line text - if s:settings.number_lines - let s:new = s:new .. s:HtmlFormat_n(s:numcol, s:LINENR_ID, 0, s:lnum) - elseif s:settings.line_ids - let s:new = s:new .. s:HtmlFormat_n("", s:LINENR_ID, 0, s:lnum) - endif - - " Get the diff attribute, if any. - let s:diffattr = diff_hlID(s:lnum, 1) - - " initialize conceal info to act like not concealed, just in case - let s:concealinfo = [0, ''] - - " Loop over each character in the line - let s:col = 1 - - " most of the time we won't use the diff_id, initialize to zero - let s:diff_id = 0 - - while s:col <= s:len || (s:col == 1 && s:diffattr) - let s:startcol = s:col " The start column for processing text - if !s:settings.ignore_conceal && has('conceal') - let s:concealinfo = synconcealed(s:lnum, s:col) - endif - if !s:settings.ignore_conceal && s:concealinfo[0] - let s:col = s:col + 1 - " Speed loop (it's small - that's the trick) - " Go along till we find a change in the match sequence number (ending - " the specific concealed region) or until there are no more concealed - " characters. - while s:col <= s:len && s:concealinfo == synconcealed(s:lnum, s:col) | let s:col = s:col + 1 | endwhile - elseif s:diffattr - let s:diff_id = diff_hlID(s:lnum, s:col) - let s:id = synID(s:lnum, s:col, 1) - let s:col = s:col + 1 - " Speed loop (it's small - that's the trick) - " Go along till we find a change in hlID - while s:col <= s:len && s:id == synID(s:lnum, s:col, 1) - \ && s:diff_id == diff_hlID(s:lnum, s:col) | - \ let s:col = s:col + 1 | - \ endwhile - if s:len < &columns && !s:settings.no_pre - " Add spaces at the end of the raw text line to extend the changed - " line to the full width. - let s:line = s:line .. repeat(' ', &columns - virtcol([s:lnum, s:len]) - s:margin) - let s:len = &columns - endif - else - let s:id = synID(s:lnum, s:col, 1) - let s:col = s:col + 1 - " Speed loop (it's small - that's the trick) - " Go along till we find a change in synID - while s:col <= s:len && s:id == synID(s:lnum, s:col, 1) | let s:col = s:col + 1 | endwhile - endif - - if s:settings.ignore_conceal || !s:concealinfo[0] - " Expand tabs if needed - let s:expandedtab = strpart(s:line, s:startcol - 1, s:col - s:startcol) - if s:settings.expand_tabs - let s:offset = 0 - let s:idx = stridx(s:expandedtab, "\t") - let s:tablist = exists("+vts") ? split(&vts,',') : [] - if empty(s:tablist) - let s:tablist = [ &ts ] - endif - let s:tabidx = 0 - let s:tabwidth = 0 - while s:idx >= 0 - if s:startcol + s:idx == 1 - let s:i = s:tablist[0] - else - " Get the character, which could be multiple bytes, which falls - " immediately before the found tab. Extract it by matching a - " character just prior to the column where the tab matches. - " We'll use this to get the byte index of the character - " immediately preceding the tab, so we can then look up the - " virtual column that character appears in, to determine how - " much of the current tabstop has been used up. - if s:idx == 0 - " if the found tab is the first character in the text being - " processed, we need to get the character prior to the text, - " given by startcol. - let s:prevc = matchstr(s:line, '.\%' .. (s:startcol + s:offset) .. 'c') - else - " Otherwise, the byte index of the tab into s:expandedtab is - " given by s:idx. - let s:prevc = matchstr(s:expandedtab, '.\%' .. (s:idx + 1) .. 'c') - endif - let s:vcol = virtcol([s:lnum, s:startcol + s:idx + s:offset - len(s:prevc)]) - - " find the tabstop interval to use for the tab we just found. Keep - " adding tabstops (which could be variable) until we would exceed - " the virtual screen position of the start of the found tab. - while s:vcol >= s:tabwidth + s:tablist[s:tabidx] - let s:tabwidth += s:tablist[s:tabidx] - if s:tabidx < len(s:tablist)-1 - let s:tabidx = s:tabidx+1 - endif - endwhile - let s:i = s:tablist[s:tabidx] - (s:vcol - s:tabwidth) - endif - " update offset to keep the index within the line corresponding to - " actual tab characters instead of replaced spaces; s:idx reflects - " replaced spaces in s:expandedtab, s:offset cancels out all but - " the tab character itself. - let s:offset -= s:i - 1 - let s:expandedtab = substitute(s:expandedtab, '\t', repeat(' ', s:i), '') - let s:idx = stridx(s:expandedtab, "\t") - endwhile - end - - " get the highlight group name to use - let s:id = synIDtrans(s:id) - else - " use Conceal highlighting for concealed text - let s:id = s:CONCEAL_ID - let s:expandedtab = s:concealinfo[1] - endif - - " Output the text with the same synID, with class set to the highlight ID - " name, unless it has been concealed completely. - if strlen(s:expandedtab) > 0 - let s:new = s:new .. s:HtmlFormat(s:expandedtab, s:id, s:diff_id, "", 0) - endif - endwhile - endif - - call extend(s:lines, split(s:new..s:HtmlEndline, '\n', 1)) - if !s:settings.no_progress && s:pgb.needs_redraw - redrawstatus - let s:pgb.needs_redraw = 0 - endif - let s:lnum = s:lnum + 1 - - if !s:settings.no_progress - call s:pgb.incr() - endif -endwhile - -" Diff filler is returned based on what needs inserting *before* the given line. -" So to get diff filler at the end of the buffer, we need to use last line + 1 -call s:Add_diff_fill(s:end+1) - -if s:settings.dynamic_folds - " finish off any open folds - while !empty(s:foldstack) - let s:lines[-1]..="</span></span>" - call remove(s:foldstack, 0) - endwhile - - " add fold column to the style list if not already there - let s:id = s:FOLD_C_ID - if !has_key(s:stylelist, s:id) - let s:stylelist[s:id] = '.FoldColumn { ' .. s:CSS1(s:id) .. '}' - endif -endif - -if s:settings.no_pre - if !s:settings.use_css - " Close off the font tag that encapsulates the whole <body> - call extend(s:lines, ["</font>"]) - else - call extend(s:lines, ["</div>"]) - endif -else - call extend(s:lines, ["</pre>"]) -endif -if !s:settings.no_doc - call extend(s:lines, ["</body>", "</html>"]) -endif - -exe s:newwin .. "wincmd w" -call setline(1, s:lines) -unlet s:lines - -" Mangle modelines so Vim doesn't try to use HTML text as a modeline if editing -" this file in the future; need to do this after generating all the text in case -" the modeline text has different highlight groups which all turn out to be -" stripped from the final output. -%s!\v(%(^|\s+)%([Vv]i%(m%([<=>]?\d+)?)?|ex)):!\1\:!ge - -" The generated HTML is admittedly ugly and takes a LONG time to fold. -" Make sure the user doesn't do syntax folding when loading a generated file, -" using a modeline. -if !s:settings.no_modeline - call append(line('$'), "<!-- vim: set foldmethod=manual : -->") -endif - -" Now, when we finally know which, we define the colors and styles -if s:settings.use_css && !s:settings.no_doc - 1;/<style\>/+1 - - " Normal/global attributes - if s:settings.no_pre - call append('.', "body { color: " .. s:fgc .. "; background-color: " .. s:bgc .. "; font-family: ".. s:htmlfont .."; }") - + - else - call append('.', "pre { " .. s:whitespace .. "font-family: ".. s:htmlfont .."; color: " .. s:fgc .. "; background-color: " .. s:bgc .. "; }") - + - yank - put - execute "normal! ^cwbody\e" - " body should not have the wrap formatting, only the pre section - if s:whitespace != '' - exec 's#'..s:whitespace - endif - endif - " fix browser inconsistencies (sometimes within the same browser) of different - " default font size for different elements - call append('.', '* { font-size: 1em; }') - + - " if we use any input elements for unselectable content, make sure they look - " like normal text - if !empty(s:settings.prevent_copy) - if s:settings.use_input_for_pc !=# "none" - call append('.', 'input { border: none; margin: 0; padding: 0; font-family: '..s:htmlfont..'; }') - + - " ch units for browsers which support them, em units for a somewhat - " reasonable fallback. - for w in range(1, 20, 1) - call append('.', [ - \ "input[size='"..w.."'] { width: "..w.."em; width: "..w.."ch; }" - \ ]) - + - endfor - endif - - if s:settings.use_input_for_pc !=# 'all' - let s:unselectable_styles = [] - if s:settings.prevent_copy =~# 'f' - call add(s:unselectable_styles, 'FoldColumn') - endif - if s:settings.prevent_copy =~# 'n' - call add(s:unselectable_styles, 'LineNr') - endif - if s:settings.prevent_copy =~# 't' && !s:settings.ignore_folding - call add(s:unselectable_styles, 'Folded') - endif - if s:settings.prevent_copy =~# 'd' - call add(s:unselectable_styles, 'DiffDelete') - endif - if s:settings.use_input_for_pc !=# 'none' - call append('.', [ - \ '/* Note: IE does not support @supports conditionals, but also does not fully support', - \ ' "content:" with custom content, so we *want* the check to fail */', - \ '@supports ( content: attr(data-custom-content) ) {' - \ ]) - +3 - endif - " The line number column inside the foldtext is styled just like the fold - " text in Vim, but it should use the prevent_copy settings of line number - " rather than fold text. Apply the prevent_copy styles to foldtext - " specifically for line numbers, which always come after the fold column, - " or at the beginning of the line. - if s:settings.prevent_copy =~# 'n' && !s:settings.ignore_folding - call append('.', [ - \ ' .FoldColumn + .Folded, .Folded:first-child { user-select: none; }', - \ ' .FoldColumn + [data-Folded-content]::before, [data-Folded-content]:first-child::before { content: attr(data-Folded-content); }', - \ ' .FoldColumn + [data-Folded-content]::before, [data-Folded-content]:first-child::before { padding-bottom: 1px; display: inline-block; /* match the 1-px padding of standard items with background */ }', - \ ' .FoldColumn + span[data-Folded-content]::before, [data-Folded-content]:first-child::before { cursor: default; }', - \ ]) - +4 - endif - for s:style_name in s:unselectable_styles - call append('.', [ - \ ' .'..s:style_name..' { user-select: none; }', - \ ' [data-'..s:style_name..'-content]::before { content: attr(data-'..s:style_name..'-content); }', - \ ' [data-'..s:style_name..'-content]::before { padding-bottom: 1px; display: inline-block; /* match the 1-px padding of standard items with background */ }', - \ ' span[data-'..s:style_name..'-content]::before { cursor: default; }', - \ ]) - +4 - endfor - if s:settings.use_input_for_pc !=# 'none' - " Note, the extra '}' is to match the "@supports" above - call append('.', [ - \ ' input { display: none; }', - \ '}' - \ ]) - +2 - endif - unlet s:unselectable_styles - endif - - " Fix mouse cursor shape for the fallback <input> method of uncopyable text - if s:settings.use_input_for_pc !=# 'none' - if s:settings.prevent_copy =~# 'f' - " Make the cursor show active fold columns as active areas, and empty fold - " columns as not interactive. - call append('.', ['input.FoldColumn { cursor: pointer; }', - \ 'input.FoldColumn[value="'..repeat(' ', s:foldcolumn)..'"] { cursor: default; }' - \ ]) - +2 - if s:settings.use_input_for_pc !=# 'all' - call append('.', [ - \ 'a[data-FoldColumn-content="'..repeat(' ', s:foldcolumn)..'"] { cursor: default; }' - \ ]) - +1 - end - endif - " make line number column show as non-interactive if not selectable - if s:settings.prevent_copy =~# 'n' - call append('.', 'input.LineNr { cursor: default; }') - + - endif - " make fold text and line number column within fold text show as - " non-interactive if not selectable - if (s:settings.prevent_copy =~# 'n' || s:settings.prevent_copy =~# 't') && !s:settings.ignore_folding - call append('.', 'input.Folded { cursor: default; }') - + - endif - " make diff filler show as non-interactive if not selectable - if s:settings.prevent_copy =~# 'd' - call append('.', 'input.DiffDelete { cursor: default; }') - + - endif - endif - endif -endif - -if !s:settings.use_css && !s:settings.no_doc - " For Netscape 4, set <body> attributes too, though, strictly speaking, it's - " incorrect. - execute '%s:<body\([^>]*\):<body bgcolor="' .. s:bgc .. '" text="' .. s:fgc .. '"\1>\r<font face="'.. s:htmlfont ..'"' -endif - -" Gather attributes for all other classes. Do diff first so that normal -" highlight groups are inserted before it. -if s:settings.use_css && !s:settings.no_doc - if s:diff_mode - call append('.', filter(map(keys(s:diffstylelist), "s:diffstylelist[v:val]"), 'v:val != ""')) - endif - if !empty(s:stylelist) - call append('.', filter(map(keys(s:stylelist), "s:stylelist[v:val]"), 'v:val != ""')) - endif -endif - -" Add hyperlinks -if !s:settings.no_links - %s+\(https\=://\S\{-}\)\(\([.,;:}]\=\(\s\|$\)\)\|[\\"'<>]\|>\|<\|"\)+<a href="\1">\1</a>\2+ge -endif - -" The DTD -if !s:settings.no_doc - if s:settings.use_xhtml - exe "normal! gg$a\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">" - elseif s:html5 - exe "normal! gg0i<!DOCTYPE html>\n" - else - exe "normal! gg0i<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">\n" - endif -endif - -if s:settings.use_xhtml && !s:settings.no_doc - exe "normal! gg/<html/e\na xmlns=\"http://www.w3.org/1999/xhtml\"\e" -endif - -" Cleanup -%s:\s\+$::e - -" Restore old settings (new window first) -" -" Don't bother restoring foldmethod in case it was syntax because the markup is -" so weirdly formatted it can take a LONG time. -let &l:foldenable = s:old_fen -let &report = s:old_report -let &title = s:old_title -let &icon = s:old_icon -let &paste = s:old_paste -let &magic = s:old_magic -let @/ = s:old_search -let &more = s:old_more - -" switch to original window to restore those settings -exe s:orgwin .. "wincmd w" - -if !s:settings.expand_tabs - let &l:isprint = s:old_isprint -endif -let &l:stl = s:origwin_stl -let &l:et = s:old_et -let &l:scrollbind = s:old_bind - -" and back to the new window again to end there -exe s:newwin .. "wincmd w" - -let &l:stl = s:newwin_stl -exec 'resize' s:old_winheight -let &l:winfixheight = s:old_winfixheight - -let &ls=s:ls -let &eventignore=s:ei_sav - -" Save a little bit of memory (worth doing?) -unlet s:htmlfont s:whitespace -unlet s:old_et s:old_paste s:old_icon s:old_report s:old_title s:old_search -unlet s:old_magic s:old_more s:old_fen s:old_winheight -unlet! s:old_isprint -unlet s:whatterm s:stylelist s:diffstylelist s:lnum s:end s:margin s:fgc s:bgc s:old_winfixheight -unlet! s:col s:id s:attr s:len s:line s:new s:expandedtab s:concealinfo s:diff_mode -unlet! s:orgwin s:newwin s:orgbufnr s:idx s:i s:offset s:ls s:ei_sav s:origwin_stl -unlet! s:newwin_stl s:current_syntax -if !v:profiling - delfunc s:HtmlColor - delfunc s:HtmlFormat - delfunc s:CSS1 - delfunc s:BuildStyleWrapper - if !s:settings.use_css - delfunc s:HtmlOpening - delfunc s:HtmlClosing - endif - if s:settings.dynamic_folds - delfunc s:FoldCompare - endif - - if !s:settings.no_progress - delfunc s:ProgressBar - delfunc s:progressbar.paint - delfunc s:progressbar.incr - unlet s:pgb s:progressbar - endif - - delfunc s:Add_diff_fill -endif - -unlet! s:new_lnum s:diffattr s:difffillchar s:foldfillchar s:HtmlSpace s:diffstyle -unlet! s:LeadingSpace s:HtmlEndline s:firstfold s:numcol s:foldcolumn -unlet! s:wrapperfunc_lines s:build_fun_lines -unlet s:foldstack s:allfolds s:foldId s:settings - -let &cpo = s:cpo_sav -unlet! s:cpo_sav - -" Make sure any patches will probably use consistent indent -" vim: ts=8 sw=2 sts=2 noet diff --git a/scripts/gen_vimdoc.lua b/scripts/gen_vimdoc.lua index 290cd83fbc..8acae66f49 100755 --- a/scripts/gen_vimdoc.lua +++ b/scripts/gen_vimdoc.lua @@ -161,6 +161,7 @@ local config = { 'iter.lua', 'snippet.lua', 'text.lua', + 'tohtml.lua', }, files = { 'runtime/lua/vim/iter.lua', @@ -189,6 +190,7 @@ local config = { 'runtime/lua/vim/_meta/lpeg.lua', 'runtime/lua/vim/_meta/re.lua', 'runtime/lua/vim/_meta/spell.lua', + 'runtime/lua/tohtml.lua', }, fn_xform = function(fun) if contains(fun.module, { 'vim.uri', 'vim.shared', 'vim._editor' }) then @@ -232,6 +234,9 @@ local config = { then return 'VIM.' .. name:upper() end + if name == 'tohtml' then + return 'Lua module: tohtml' + end return 'Lua module: vim.' .. name end, helptag_fmt = function(name) @@ -239,6 +244,8 @@ local config = { return '*lua-vim*' elseif name == '_options' then return '*lua-vimscript*' + elseif name == 'tohtml' then + return '*tohtml*' end return '*vim.' .. name:lower() .. '*' end, diff --git a/test/functional/plugin/tohtml_spec.lua b/test/functional/plugin/tohtml_spec.lua new file mode 100644 index 0000000000..66dcfde3aa --- /dev/null +++ b/test/functional/plugin/tohtml_spec.lua @@ -0,0 +1,370 @@ +local Screen = require('test.functional.ui.screen') +local helpers = require('test.functional.helpers')(after_each) + +local clear = helpers.clear +local exec = helpers.exec +local exec_lua = helpers.exec_lua +local eq = helpers.eq +local fn = helpers.fn +local api = helpers.api +local insert = helpers.insert + +local function html_syntax_match() + local styles = + vim.split(api.nvim_exec2([[/<style>/+,/<\/style>/-p]], { output = true }).output, '\n') + local attrnames = { + ['font%-weight: bold'] = 'bold', + ['text%-decoration%-line: [^;]*underline'] = 'underline', + ['font%-style: italic'] = 'italic', + ['text%-decoration%-line: [^;]*line%-through'] = 'strikethrough', + } + local hls = {} + for _, style in ipairs(styles) do + local attr = {} + for match, attrname in pairs(attrnames) do + if style:find(match) then + ---@type boolean + attr[attrname] = true + end + end + if style:find('text%-decoration%-style: wavy') and attr.underline then + ---@type boolean + attr.underline = nil + attr.undercurl = true + end + attr.bg = style:match('background%-color: #(%x+)') + if attr.bg then + attr.bg = tonumber(attr.bg, 16) + end + attr.fg = style:match('[^%-]color: #(%x+)') + if attr.fg then + attr.fg = tonumber(attr.fg, 16) + end + if style:match('^%.(%w+)') then + ---@type table + hls[style:match('^%.(%w+)')] = attr + end + end + local whitelist = { + 'fg', + 'bg', + --'sp', + --'blend', + 'bold', + --'standout', + 'underline', + 'undercurl', + --'underdouble', + --'underdotted', + --'underdashed', + 'strikethrough', + 'italic', + --'reverse', + --'nocombine', + } + for name, attrs_old in + pairs(api.nvim_get_hl(0, { link = true }) --[[@as table<string,table>]]) + do + ---@type table + local other = hls[name:gsub('%.', '-'):gsub('@', '-')] + if other then + local attrs = {} + for _, attrname in ipairs(whitelist) do + ---@type table + attrs[attrname] = attrs_old[attrname] + end + eq(attrs, other) + end + end + return hls +end + +local function html_to_extmarks() + local buf = api.nvim_get_current_buf() + local ns = api.nvim_create_namespace 'test-namespace' + api.nvim_buf_clear_namespace(buf, ns, 0, -1) + exec 'silent! norm! ggd/^<pre>$\rddG3dk' + local stack = {} + exec [[set filetype=]] + exec [[silent! %s/</¤/g]] + exec [[silent! %s/"/"/g]] + exec [[silent! %s/&/\&/g]] + exec [[silent! %s/>/>/g]] + exec [[silent! %s/</</g]] + for _, match in + ipairs( + fn.matchbufline(buf, [[¤span class="\([^"]\+\)">\|¤/span>]], 1, '$', { submatches = true }) --[[@as (table[])]] + ) + do + if match.text == '¤/span>' then + local val = table.remove(stack) + api.nvim_buf_set_extmark(buf, ns, val.lnum - 1, val.byteidx, { + hl_group = val.submatches[1], + end_row = match.lnum - 1, + end_col = match.byteidx, + }) + else + table.insert(stack, match) + end + end + exec [[silent! %s/¤\/span>//g]] + exec [[silent! %s/¤span[^>]*>//g]] +end + +---@param screen test.functional.ui.screen +---@param func function? +local function run_tohtml_and_assert(screen, func) + exec('norm! ggO-;') + exec('norm! gg0f;:\r') + screen:sleep(10) + local snapshot = { grid = screen:get_snapshot().grid, attr_ids = screen:get_snapshot().attr_ids } + do + (func or exec)('TOhtml') + end + exec('only') + html_syntax_match() + html_to_extmarks() + exec('norm! gg0f;:\r') + screen:sleep(10) + eq(snapshot, { grid = screen:get_snapshot().grid, attr_ids = screen:get_snapshot().attr_ids }) +end + +describe(':TOhtml', function() + --- @type test.functional.ui.screen + local screen + before_each(function() + clear({ args = { '--clean' } }) + screen = Screen.new(80, 80) + screen:attach({ term_name = 'xterm' }) + exec('colorscheme default') + end) + + it('expected internal html generated', function() + insert([[line]]) + exec('set termguicolors') + local bg = fn.synIDattr(fn.hlID('Normal'), 'bg#', 'gui') + local fg = fn.synIDattr(fn.hlID('Normal'), 'fg#', 'gui') + exec_lua [[ + local outfile = vim.fn.tempname() .. '.html' + local html = require('tohtml').tohtml(0,{title="title",font="dumyfont"}) + vim.fn.writefile(html, outfile) + vim.cmd.split(outfile) + ]] + local out_file = api.nvim_buf_get_name(api.nvim_get_current_buf()) + eq({ + '<!DOCTYPE html>', + '<html>', + '<head>', + '<meta charset="UTF-8">', + '<title>title</title>', + ('<meta name="colorscheme" content="%s"></meta>'):format(api.nvim_get_var('colors_name')), + '<style>', + '* {font-family: dumyfont,monospace}', + ('body {background-color: %s; color: %s}'):format(bg, fg), + '</style>', + '</head>', + '<body style="display: flex">', + '<pre>', + 'line', + '', + '</pre>', + '</body>', + '</html>', + }, fn.readfile(out_file)) + end) + + it('highlight attributes generated', function() + --Make sure to uncomment the attribute in `html_syntax_match()` + exec('hi LINE gui=' .. table.concat({ + 'bold', + 'underline', + 'italic', + 'strikethrough', + }, ',')) + exec('hi UNDERCURL gui=undercurl') + exec('syn keyword LINE line') + exec('syn keyword UNDERCURL undercurl') + insert('line\nundercurl') + run_tohtml_and_assert(screen) + end) + + it('syntax', function() + insert [[ + function main() + print("hello world") + end + ]] + exec('set termguicolors') + exec('syntax enable') + exec('setf lua') + run_tohtml_and_assert(screen) + end) + + it('diff', function() + exec('set diffopt=') + insert [[ + diffadd + nochage + diffchange1 + ]] + exec('new') + insert [[ + nochage + diffchange2 + diffremove + ]] + exec('set diff') + exec('close') + exec('set diff') + run_tohtml_and_assert(screen) + end) + + it('treesitter', function() + insert [[ + function main() + print("hello world") + end + ]] + exec('setf lua') + exec_lua('vim.treesitter.start()') + run_tohtml_and_assert(screen) + end) + + it('matchadd', function() + insert [[ + line + ]] + fn.matchadd('Visual', 'line') + run_tohtml_and_assert(screen) + end) + + describe('conceallevel', function() + local function run(level) + insert([[ + line0 + line1 + line2 + line3 + ]]) + local ns = api.nvim_create_namespace '' + fn.matchadd('Conceal', 'line1', 3, 5, { conceal = 'a' }) + api.nvim_buf_set_extmark(0, ns, 2, 0, { conceal = 'a', end_col = 5 }) + exec(':syntax match Conceal "line3" conceal cchar=a') + exec('set conceallevel=' .. level) + run_tohtml_and_assert(screen) + end + it('conceallevel=0', function() + run(0) + end) + it('conceallevel=1', function() + run(1) + end) + it('conceallevel=2', function() + run(2) + end) + it('conceallevel=3', function() + run(3) + end) + end) + + describe('extmarks', function() + it('virt_text', function() + insert [[ + line1 + line2 + line3 + line4 + ]] + local ns = api.nvim_create_namespace '' + api.nvim_buf_set_extmark(0, ns, 0, 0, { virt_text = { { 'foo' } } }) + api.nvim_buf_set_extmark( + 0, + ns, + 1, + 0, + { virt_text = { { 'foo' } }, virt_text_pos = 'overlay' } + ) + api.nvim_buf_set_extmark(0, ns, 2, 0, { virt_text = { { 'foo' } }, virt_text_pos = 'inline' }) + --api.nvim_buf_set_extmark(0,ns,3,0,{virt_text={{'foo'}},virt_text_pos='right_align'}) + run_tohtml_and_assert(screen) + end) + it('highlgith', function() + insert [[ + line1 + ]] + local ns = api.nvim_create_namespace '' + api.nvim_buf_set_extmark(0, ns, 0, 0, { end_col = 2, hl_group = 'Visual' }) + run_tohtml_and_assert(screen) + end) + it('virt_line', function() + insert [[ + line1 + line2 + ]] + local ns = api.nvim_create_namespace '' + api.nvim_buf_set_extmark(0, ns, 1, 0, { end_col = 2, virt_lines = { { { 'foo' } } } }) + run_tohtml_and_assert(screen) + end) + end) + + it('listchars', function() + exec('setlocal list') + exec( + 'setlocal listchars=eol:$,tab:<->,space:-,multispace:++,lead:_,leadmultispace:##,trail:&,nbsp:%' + ) + fn.setline(1, '\tfoo\t') + fn.setline(2, ' foo foo ') + fn.setline(3, ' foo foo ') + fn.setline(4, 'foo\x2cfoo') + run_tohtml_and_assert(screen) + exec('new|only') + fn.setline(1, '\tfoo\t') + exec('setlocal list') + exec('setlocal listchars=tab:a-') + run_tohtml_and_assert(screen) + end) + + it('folds', function() + insert([[ + line1 + line2 + ]]) + exec('set foldtext=foldtext()') + exec('%fo') + run_tohtml_and_assert(screen) + end) + + it('statuscol', function() + local function run() + local buf = api.nvim_get_current_buf() + run_tohtml_and_assert(screen, function() + exec_lua [[ + local outfile = vim.fn.tempname() .. '.html' + local html = require('tohtml').tohtml(0,{number_lines=true}) + vim.fn.writefile(html, outfile) + vim.cmd.split(outfile) + ]] + end) + api.nvim_set_current_buf(buf) + end + insert([[ + line1 + line2 + ]]) + exec('setlocal relativenumber') + run() + exec('setlocal norelativenumber') + exec('setlocal number') + run() + exec('setlocal relativenumber') + run() + exec('setlocal signcolumn=yes:2') + run() + exec('setlocal foldcolumn=2') + run() + exec('setlocal norelativenumber') + run() + exec('setlocal signcolumn=no') + run() + end) +end) |