" ---- Author & Copyright: ---------------------------------------------- {{{1 " " Author: Christian J. Robinson " URL: http://www.infynity.spodzone.com/vim/HTML/ " Last Change: June 20, 2008 " Version: 0.35.3 " Original Concept: Doug Renze " " " The original Copyright goes to Doug Renze, although nearly all of his " efforts have been modified in this implementation. My changes and additions " are Copyrighted by me, on the dates marked in the ChangeLog. " " (Doug Renze has authorized me to place the original "code" under the GPL.) " " ---------------------------------------------------------------------------- " " This program is free software; you can redistribute it and/or modify it " under the terms of the GNU General Public License as published by the Free " Software Foundation; either version 2 of the License, or (at your option) " any later version. " " This program is distributed in the hope that it will be useful, but WITHOUT " ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for " more details. " " ---- Original Author's Notes: ---------------------------------------------- " " HTML Macros " I wrote these HTML macros for my personal use. They're " freely-distributable and freely-modifiable. " " If you do make any major additions or changes, or even just " have a suggestion for improvement, feel free to let me " know. I'd appreciate any suggestions. " " Credit must go to Eric Tilton, Carl Steadman and Tyler " Jones for their excellent book "Web Weaving" which was " my primary source. " " Doug Renze " " ---- TODO: ------------------------------------------------------------ {{{1 " " - Specific browser mappings for Win32 with "start ..." ? " - Find a way to make "gv" after executing a visual mapping re-select the " right text. (Currently my extra code that wraps around the visual " mappings can tweak the selected area significantly.) " + This should probably exclude the newly created tags, so things like " visual selection ;ta, then gv and ;tr, then gv and ;td work. " - Add :HTMLmappingsreload/html/xhtml to the HTML menu? " " ---- RCS Information: ------------------------------------------------- {{{1 " $Id: HTML.vim,v 1.205 2008/06/20 08:11:11 infynity Exp $ " ----------------------------------------------------------------------- }}}1 " ---- Initialization: -------------------------------------------------- {{{1 if v:version < 700 echoerr "HTML.vim no longer supports Vim versions prior to 7." sleep 2 finish "elseif v:version < 700 " let s:tmp = " \ "The HTML macros support for Vim versions prior to 7\n" . " \ "will be abandoned in future versions.\n\n" . " \ "You should seriously consider upgrading your version of Vim." " call confirm(s:tmp, "&Dismiss", 1, 'Warning') " unlet s:tmp endif " Save cpoptions and remove some junk that will throw us off (reset at the end " of the script): let s:savecpo = &cpoptions set cpoptions&vim let s:doing_internal_html_mappings = 1 if ! exists("b:did_html_mappings_init") let b:did_html_mappings_init = 1 setlocal matchpairs+=<:> " ---- Init Functions: -------------------------------------------------- {{{2 " s:BoolVar() {{{3 " " Given a string, test to see if a variable by that string name exists, and if " so, whether it's set to 1|true|yes / 0|false|no (Actually, anything not " listed here also returns as 1.) " " Arguments: " 1 - String: The name of the variable to test (not its value!) " Return Value: " 1/0 " " Limitations: " This /will not/ work on function-local variable names. function! s:BoolVar(var) if a:var =~ '^[bgstvw]:' let var = a:var else let var = 'g:' . a:var endif if s:IsSet(var) execute "let varval = " . var return s:Bool(varval) else return 0 endif endfunction " s:Bool() {{{3 " " Helper to s:BoolVar() -- Test the string passed to it and return true/false " based on that string. " " Arguments: " 1 - String: 1|true|yes / 0|false|no " Return Value: " 1/0 function! s:Bool(str) return a:str !~? '^no$\|^false$\|^0$\|^$' endfunction " SetIfUnset() {{{3 " " Set a variable if it's not already set. " " Arguments: " 1 - String: The variable name " 2 ... N - String: The default value to use, "-" for the null string " Return Value: " 0 - The variable already existed " 1 - The variable didn't exist and was set " -1 - An error occurred function! SetIfUnset(var, ...) if a:var =~ '^[bgstvw]:' let var = a:var else let var = 'g:' . a:var endif if a:0 == 0 echohl ErrorMsg echomsg "E119: Not enough arguments for function: SetIfUnset" echohl None return -1 else let val = join(a:000, ' ') endif if ! s:IsSet(var) if val == "-" execute "let " . var . "= \"\"" else execute "let " . var . "= val" endif return 1 endif return 0 endfunction " s:IsSet() {{{3 " " Given a string, test to see if a variable by that string name exists. " " Arguments: " 1 - String: The variable name " Return Value: " 1/0 function! s:IsSet(str) execute "let varisset = exists(\"" . a:str . "\")" return varisset endfunction "}}}3 " ----------------------------------------------------------------------- }}}2 command! -nargs=+ SetIfUnset call SetIfUnset() SetIfUnset g:html_bgcolor #FFFFFF SetIfUnset g:html_textcolor #000000 SetIfUnset g:html_linkcolor #0000EE SetIfUnset g:html_alinkcolor #FF0000 SetIfUnset g:html_vlinkcolor #990066 SetIfUnset g:html_tag_case uppercase SetIfUnset g:html_map_leader ; SetIfUnset g:html_map_entity_leader & SetIfUnset g:html_default_charset iso-8859-1 " No way to know sensible defaults here so just make sure the " variables are set: SetIfUnset g:html_authorname - SetIfUnset g:html_authoremail - if g:html_map_entity_leader ==# g:html_map_leader echohl ErrorMsg echomsg 'ERROR! "g:html_map_entity_leader" and "g:html_map_leader" have the same value!' echomsg ' Resetting "g:html_map_entity_leader" to "&".' echohl None sleep 2 let g:html_map_entity_leader = '&' endif if exists('b:html_tag_case') let b:html_tag_case_save = b:html_tag_case endif " Detect whether to force uppper or lower case: {{{2 if &filetype ==? "xhtml" \ || s:BoolVar('g:do_xhtml_mappings') \ || s:BoolVar('b:do_xhtml_mappings') let b:do_xhtml_mappings = 1 else let b:do_xhtml_mappings = 0 if s:BoolVar('g:html_tag_case_autodetect') \ && (line('$') != 1 || getline(1) != '') let s:found_upper = search('\C<$\s*/$\?\s*\u\+\_[^<>]*>', 'wn') let s:found_lower = search('\C<$\s*/$\?\s*\l\+\_[^<>]*>', 'wn') if s:found_upper && ! s:found_lower let b:html_tag_case = 'uppercase' elseif ! s:found_upper && s:found_lower let b:html_tag_case = 'lowercase' endif unlet s:found_upper s:found_lower endif endif if s:BoolVar('b:do_xhtml_mappings') let b:html_tag_case = 'lowercase' endif " }}}2 call SetIfUnset('b:html_tag_case', g:html_tag_case) let s:thisfile = expand(":p") " ---------------------------------------------------------------------------- " ---- Functions: ------------------------------------------------------- {{{1 if ! exists("g:did_html_functions") let g:did_html_functions = 1 " HTMLencodeString() {{{2 " " Encode the characters in a string into their HTML &#...; representations. " " Arguments: " 1 - String: The string to encode. " 2 - String: Optional, whether to decode rather than encode the string: " d/decode: Decode the &#...; elements of the provided string " anything else: Encode the string (default) " Return Value: " String: The encoded string. function! HTMLencodeString(string, ...) let out = '' if a:0 > 0 if a:1 =~? '^d$ecode$\=$' let out = substitute(a:string, '&#$\d\+$;', '\=nr2char(submatch(1))', 'g') let out = substitute(out, '%$\x\{2}$', '\=nr2char("0x".submatch(1))', 'g') return out elseif a:1 == '%' let out = substitute(a:string, '$.$', '\=printf("%%%02X", char2nr(submatch(1)))', 'g') return out endif endif let string = split(a:string, '\zs') for c in string let out = out . '&#' . char2nr(c) . ';' endfor return out endfunction " HTMLmap() {{{2 " " Define the HTML mappings with the appropriate case, plus some extra stuff. " " Arguments: " 1 - String: Which map command to run. " 2 - String: LHS of the map. " 3 - String: RHS of the map. " 4 - Integer: Optional, applies only to visual maps: " -1: Don't add any extra special code to the mapping. " 0: Mapping enters insert mode. " Applies only when filetype indenting is on: " 1: re-selects the region, moves down a line, and re-indents. " 2: re-selects the region and re-indents. " (Don't use these two arguments for maps that enter insert " mode!) let s:modes = { \ 'n': 'normal', \ 'v': 'visual', \ 'o': 'operator-pending', \ 'i': 'insert', \ 'c': 'command-line', \ 'l': 'langmap', \} function! HTMLmap(cmd, map, arg, ...) let mode = strpart(a:cmd, 0, 1) let map = substitute(a:map, '^\c', escape(g:html_map_leader, '&~\'), '') let map = substitute(map, '^\c', escape(g:html_map_entity_leader, '&~\'), '') if exists('s:modes[mode]') && s:MapCheck(map, mode) >= 2 return endif let arg = s:ConvertCase(a:arg) if ! s:BoolVar('b:do_xhtml_mappings') let arg = substitute(arg, ' \?/>', '>', 'g') endif if mode == 'v' " If 'selection' is "exclusive" all the visual mode mappings need to " behave slightly differently: let arg = substitute(arg, "`>a\\C", "`>i=VI()", 'g') if a:0 >= 1 && a:1 < 0 execute a:cmd . " " . map . " " . arg elseif a:0 >= 1 && a:1 >= 1 execute a:cmd . " " . map . " :call TO(0)gv" . arg \ . ":call TO(1)m':call ReIndent(line(\"'<\"), line(\"'>\"), " . a:1 . ")``" elseif a:0 >= 1 execute a:cmd . " " . map . " :call TO(0)gv" . arg \ . ":call TO(1)" else execute a:cmd . " " . map . " :call TO(0)gv" . arg \ . ":call TO(1)" endif else execute a:cmd . " " . map . " " . arg endif if exists('s:modes[mode]') let b:HTMLclearMappings = b:HTMLclearMappings . ':' . mode . "unmap " . map . "\" else let b:HTMLclearMappings = b:HTMLclearMappings . ":unmap " . map . "\" endif call s:ExtraMappingsAdd(':call HTMLmap("' . a:cmd . '", "' . escape(a:map, '"\') \ . '", "' . escape(a:arg, '"\') . (a:0 >= 1 ? ('", ' . a:1) : '"' ) . ')') endfunction " HTMLmapo() {{{2 " " Define a map that takes an operator to its corresponding visual mode " mapping. " " Arguments: " 1 - String: The mapping. " 2 - Boolean: Whether to enter insert mode after the mapping has executed. " (A value greater than 1 tells the mapping not to move right one " character.) function! HTMLmapo(map, insert) let map = substitute(a:map, "^", g:html_map_leader, '') if s:MapCheck(map, 'o') >= 2 return endif execute 'nnoremap ' . map \ . " :let b:htmltagaction='" . map . "'" \ . ":let b:htmltaginsert=" . a:insert . "" \ . ':set operatorfunc=WRg@' let b:HTMLclearMappings = b:HTMLclearMappings . ":nunmap " . map . "\" call s:ExtraMappingsAdd(':call HTMLmapo("' . escape(a:map, '"\') . '", ' . a:insert . ')') endfunction " s:MapCheck() {{{2 " " Check to see if a mapping for a mode already exists. If there is, and " overriding hasn't been suppressed, print an error. " " Arguments: " 1 - String: The map sequence (LHS). " 2 - Character: The mode for the mapping. " Return Value: " 0 - No mapping was found. " 1 - A mapping was found, but overriding has /not/ been suppressed. " 2 - A mapping was found and overriding has been suppressed. " 3 - The mapping to be defined was suppressed by g:no_html_maps. " " (Note that suppression only works for the internal mappings.) function! s:MapCheck(map, mode) if exists('s:doing_internal_html_mappings') && \ ( (exists('g:no_html_maps') && a:map =~# g:no_html_maps) || \ (exists('b:no_html_maps') && a:map =~# b:no_html_maps) ) return 3 elseif exists('s:modes[a:mode]') && maparg(a:map, a:mode) != '' if s:BoolVar('g:no_html_map_override') && exists('s:doing_internal_html_mappings') return 2 else echohl WarningMsg echomsg "WARNING: A mapping to \"" . a:map . "\" for " . s:modes[a:mode] . " mode has been overridden for this buffer." echohl None return 1 endif endif return 0 endfunction " s:WR() {{{2 " Function set in 'operatorfunc' for mappings that take an operator: function! s:WR(type) let sel_save = &selection let &selection = "inclusive" if a:type == 'line' execute "normal `[V`]" . b:htmltagaction elseif a:type == 'block' execute "normal `[\`]" . b:htmltagaction else execute "normal `[v`]" . b:htmltagaction endif let &selection = sel_save if b:htmltaginsert if b:htmltaginsert < 2 execute "normal \" endif startinsert endif " Leave these set so .-repeating of operator mappings works: "unlet b:htmltagaction b:htmltaginsert endfunction " s:ExtraMappingsAdd() {{{2 " " Add to the b:HTMLextraMappings variable if necessary. " " Arguments: " 1 - String: The command necessary to re-define the mapping. function! s:ExtraMappingsAdd(arg) if ! exists('s:doing_internal_html_mappings') && ! exists('s:doing_extra_html_mappings') if ! exists('b:HTMLextraMappings') let b:HTMLextraMappings = '' endif let b:HTMLextraMappings = b:HTMLextraMappings . a:arg . ' |' endif endfunction " s:TO() {{{2 " " Used to make sure the 'showmatch', 'indentexpr', and 'formatoptions' options " are off temporarily to prevent the visual mappings from causing a " (visual)bell or inserting improperly. " " Arguments: " 1 - Integer: 0 - Turn options off. " 1 - Turn options back on, if they were on before. function! s:TO(s) if a:s == 0 let s:savesm=&l:sm | let &l:sm=0 let s:saveinde=&l:inde | let &l:inde='' let s:savefo=&l:fo | let &l:fo='' " A trick to make leading indent on the first line of visual-line " selections is handled properly (turn it into a character-wise " selection and exclude the leading indent): if visualmode() ==# 'V' let s:visualmode_save = visualmode() exe "normal `<^v`>\" endif else let &l:sm=s:savesm | unlet s:savesm let &l:inde=s:saveinde | unlet s:saveinde let &l:fo=s:savefo | unlet s:savefo " Restore the last visual mode if it was changed: if exists('s:visualmode_save') exe "normal gv" . s:visualmode_save . "\" unlet s:visualmode_save endif endif endfunction " s:TC() {{{2 " " Used to make sure the 'comments' option is off temporarily to prevent " certain mappings from inserting unwanted comment leaders. " " Arguments: " 1 - Integer: 0 - Turn options off. " 1 - Turn options back on, if they were on before. function! s:TC(s) if a:s == 0 let s:savecom=&l:com | let &l:com='' else let &l:com=s:savecom | unlet s:savecom endif endfunction " s:VI() {{{2 " " Used by HTMLmap() to enter insert mode in Visual mappings in the right " place, depending on what 'selection' is set to. " " Arguments: " None " Return Value: " The proper movement command based on the value of 'selection'. function! s:VI() if &selection == 'inclusive' return "\" else return "\`>" endif endfunction " s:ConvertCase() {{{2 " " Convert special regions in a string to the appropriate case determined by " b:html_tag_case. " " Arguments: " 1 - String: The string with the regions to convert surrounded by [{...}]. " Return Value: " The converted string. function! s:ConvertCase(str) if (! exists('b:html_tag_case')) || b:html_tag_case =~? 'u$pper\(case$\?\)\?' || b:html_tag_case == '' let str = substitute(a:str, '\[{$.\{-}$}\]', '\U\1', 'g') elseif b:html_tag_case =~? 'l$ower\(case$\?\)\?' let str = substitute(a:str, '\[{$.\{-}$}\]', '\L\1', 'g') else echohl WarningMsg echomsg "WARNING: b:html_tag_case = '" . b:html_tag_case . "' invalid, overriding to 'upppercase'." echohl None let b:html_tag_case = 'uppercase' let str = s:ConvertCase(a:str) endif return str endfunction " s:ReIndent() {{{2 " " Re-indent a region. (Usually called by HTMLmap.) " Nothing happens if filetype indenting isn't enabled or 'indentexpr' is " unset. " " Arguments: " 1 - Integer: Start of region. " 2 - Integer: End of region. " 3 - Integer: 1: Add an extra line below the region to re-indent. " *: Don't add an extra line. function! s:ReIndent(first, last, extraline) " To find out if filetype indenting is enabled: let save_register = @x redir @x | silent! filetype | redir END let filetype_output = @x let @x = save_register if filetype_output =~ "indent:OFF" && &indentexpr == '' return endif " Make sure the range is in the proper order: if a:last >= a:first let firstline = a:first let lastline = a:last else let lastline = a:first let firstline = a:last endif " Make sure the full region to be re-indendted is included: if a:extraline == 1 if firstline == lastline let lastline = lastline + 2 else let lastline = lastline + 1 endif endif execute firstline . ',' . lastline . 'norm ==' endfunction " s:ByteOffset() {{{2 " " Return the byte number of the current position. " " Arguments: " None " Return Value: " The byte offset function! s:ByteOffset() return line2byte(line('.')) + col('.') - 1 endfunction " HTMLnextInsertPoint() {{{2 " " Position the cursor at the next point in the file that needs data. " " Arguments: " 1 - Character: Optional, the mode the function is being called from. 'n' " for normal, 'i' for insert. If 'i' is used the function " enables an extra feature where if the cursor is on the start " of a closing tag it places the cursor after the tag. " Default is 'n'. " Return Value: " None. " Known problems: " Due to the necessity of running the search twice (why doesn't Vim support " cursor offset positioning in search()?) this function " a) won't ever position the cursor on an "empty" tag that starts on the " first character of the first line of the buffer " b) won't let the cursor "escape" from an "empty" tag that it can match on " the first line of the buffer when the cursor is on the first line and " tab is successively pressed function! HTMLnextInsertPoint(...) let saveerrmsg = v:errmsg let v:errmsg = '' let saveruler = &ruler | let &ruler=0 let saveshowcmd = &showcmd | let &showcmd=0 let byteoffset = s:ByteOffset() " Tab in insert mode on the beginning of a closing tag jumps us to " after the tag: if a:0 >= 1 && a:1 == 'i' if strpart(getline(line('.')), col('.') - 1, 2) == '' normal f> let done = 1 else let done = 0 endif if done == 1 if col('.') == col('$') - 1 startinsert! else normal l endif return endif endif normal 0 " Running the search twice is inefficient, but it squelches error " messages and the second search puts my cursor where it's needed... if search('<$[^ <>]\+$\_[^<>]*>\_s*<\/\1>\|<\_[^<>]*""\_[^<>]*>\|', 'w') == 0 if byteoffset == -1 go 1 else execute ':go ' . byteoffset if a:0 >= 1 && a:1 == 'i' && col('.') == col('$') - 1 startinsert! endif endif else normal 0 silent! execute ':go ' . s:ByteOffset() - 1 execute 'silent! normal! /<$[^ <>]\+$\_[^<>]*>\_s*<\/\1>\|<\_[^<>]*""\_[^<>]*>\|/;/>\_s*<\|""\|/e' . "\" " Handle cursor positioning for comments and/or open+close tags spanning " multiple lines: if getline('.') =~ '' execute "normal F\" elseif getline('.') =~ '^ *-->' && getline(line('.')-1) =~ '' && getline(line('.')-1) =~ '^ *$' normal k$ elseif getline('.') =~ '^ *<\/[^<>]\+>' && getline(line('.')-1) =~ '^ *$' normal k$ endif call histdel('search', -1) let @/ = histget('search', -1) endif let v:errmsg = saveerrmsg let &ruler = saveruler let &showcmd = saveshowcmd endfunction " s:tag() {{{2 " " Causes certain tags (such as bold, italic, underline) to be closed then " opened rather than opened then closed where appropriate, if syntax " highlighting is on. " " Arguments: " 1 - String: The tag name. " 2 - Character: The mode: " 'i' - Insert mode " 'v' - Visual mode " Return Value: " The string to be executed to insert the tag. " s:smarttags[tag][mode][open/close] = keystrokes {{{ " tag - The literal tag, without the <>'s " mode - i = insert, v = visual " (no "o", because o-mappings invoke visual mode) " open/close - c = When inside an equivalent tag, close then open it " o = When not inside an equivalent tag " keystrokes - The mapping keystrokes to execute let s:smarttags = {} let s:smarttags['i'] = { \ 'i': { \ 'o': "<[{I>\F<", \ 'c': "<[{/I>\F<", \ }, \ 'v': { \ 'o': "`>a\`<<[{I}]>", \ 'c': "`>a<[{I}]>\`<", \ } \ } let s:smarttags['em'] = { \ 'i': { \ 'o': "<[{EM>\F<", \ 'c': "<[{/EM>\F<", \ }, \ 'v': { \ 'o': "`>a\`<<[{EM}]>", \ 'c': "`>a<[{EM}]>\`<", \ } \ } let s:smarttags['b'] = { \ 'i': { \ 'o': "<[{B>\F<", \ 'c': "<[{/B>\F<", \}, \ 'v': { \ 'o': "`>a\`<<[{B}]>", \ 'c': "`>a<[{B}]>\`<", \ } \ } let s:smarttags['strong'] = { \ 'i': { \ 'o': "<[{STRONG>\F<", \ 'c': "<[{/STRONG>\F<", \}, \ 'v': { \ 'o': "`>a\`<<[{STRONG}]>", \ 'c': "`>a<[{STRONG}]>\`<", \ } \ } let s:smarttags['u'] = { \ 'i': { \ 'o': "<[{U>\F<", \ 'c': "<[{/U>\F<", \}, \ 'v': { \ 'o': "`>a\`<<[{U}]>", \ 'c': "`>a<[{U}]>\`<", \ } \ } let s:smarttags['comment'] = { \ 'i': { \ 'o': "\F ", \ 'c': " -->\`<", \ } \ } " }}} function! s:tag(tag, mode) let attr=synIDattr(synID(line('.'), col('.') - 1, 1), "name") if ( a:tag == 'i' && attr =~? 'italic' ) \ || ( a:tag == 'em' && attr =~? 'italic' ) \ || ( a:tag == 'b' && attr =~? 'bold' ) \ || ( a:tag == 'strong' && attr =~? 'bold' ) \ || ( a:tag == 'u' && attr =~? 'underline' ) \ || ( a:tag == 'comment' && attr =~? 'comment' ) let ret=s:ConvertCase(s:smarttags[a:tag][a:mode]['c']) else let ret=s:ConvertCase(s:smarttags[a:tag][a:mode]['o']) endif if a:mode == 'v' " If 'selection' is "exclusive" all the visual mode mappings need to " behave slightly differently: let ret = substitute(ret, "`>a\\C", "`>i" . s:VI(), 'g') endif return ret endfunction " s:DetectCharset() {{{2 " " Detects the HTTP-EQUIV Content-Type charset based on Vim's current " encoding/fileencoding. " " Arguments: " None " Return Value: " The value for the Content-Type charset based on 'fileencoding' or " 'encoding'. " TODO: This table needs to be expanded: let s:charsets = {} let s:charsets['latin1'] = 'iso-8859-1' let s:charsets['utf_8'] = 'UTF-8' let s:charsets['utf_16'] = 'UTF-16' let s:charsets['shift_jis'] = 'Shift_JIS' let s:charsets['euc_jp'] = 'EUC-JP' let s:charsets['cp950'] = 'Big5' let s:charsets['big5'] = 'Big5' function! s:DetectCharset() if exists("g:html_charset") return g:html_charset endif if &fileencoding != '' let enc=tolower(&fileencoding) else let enc=tolower(&encoding) endif " The iso-8859-* encodings are valid for the Content-Type charset header: if enc =~? '^iso-8859-' return enc endif let enc=substitute(enc, '\W', '_', 'g') if s:charsets[enc] != '' return s:charsets[enc] endif return g:html_default_charset endfunction " HTMLgenerateTable() {{{2 " " Interactively creates a table. " " Arguments: " None " Return Value: " None function! HTMLgenerateTable() let byteoffset = s:ByteOffset() let rows = inputdialog("Number of rows: ") + 0 let columns = inputdialog("Number of columns: ") + 0 if ! (rows > 0 && columns > 0) echo "Rows and columns must be integers." return endif let border = inputdialog("Border width of table [none]: ") + 0 if border execute s:ConvertCase("normal o<[{TABLE BORDER}]=" . border . ">\") else execute s:ConvertCase("normal o<[{TABLE}]>\") endif for r in range(rows) execute s:ConvertCase("normal o<[{TR}]>\") for c in range(columns) execute s:ConvertCase("normal o<[{TD}]>\\") endfor execute s:ConvertCase("normal o\") endfor execute s:ConvertCase("normal o\") execute ":go " . (byteoffset <= 0 ? 1 : byteoffset) normal jjj^ endfunction " s:MappingsControl() {{{2 " " Disable/enable all the mappings defined by HTMLmap()/HTMLmapo(). " " Arguments: " 1 - String: Whether to disable or enable the mappings: " d/disable: Clear the mappings " e/enable: Redefine the mappings " r/reload: Completely reload the script " h/html: Reload the mapppings in HTML mode " x/xhtml: Reload the mapppings in XHTML mode " Return Value: " None silent! function! s:MappingsControl(dowhat) if ! exists('b:did_html_mappings_init') echohl ErrorMsg echomsg "The HTML mappings were not sourced for this buffer." echohl None return endif if b:did_html_mappings_init < 0 unlet b:did_html_mappings_init endif if a:dowhat =~? '^d$isable$\=\|off$' if exists('b:did_html_mappings') silent execute b:HTMLclearMappings unlet b:did_html_mappings if exists("g:did_html_menus") call s:MenuControl('disable') endif elseif ! exists('s:quiet_errors') echohl ErrorMsg echomsg "The HTML mappings are already disabled." echohl None endif elseif a:dowhat =~? '^e$nable$\=\|on$' if exists('b:did_html_mappings') echohl ErrorMsg echomsg "The HTML mappings are already enabled." echohl None else execute "source " . s:thisfile if exists('b:HTMLextraMappings') let s:doing_extra_html_mappings = 1 silent execute b:HTMLextraMappings unlet s:doing_extra_html_mappings endif endif elseif a:dowhat =~? '^r$eload\|einit$\=$' let s:quiet_errors = 1 HTMLmappings off let b:did_html_mappings_init=-1 silent! unlet g:did_html_menus g:did_html_toolbar g:did_html_functions silent! unmenu HTML silent! unmenu! HTML HTMLmappings on unlet s:quiet_errors elseif a:dowhat =~? '^h$tml$\=$' if exists('b:html_tag_case_save') let b:html_tag_case = b:html_tag_case_save endif let b:do_xhtml_mappings=0 HTMLmappings off let b:did_html_mappings_init=-1 HTMLmappings on elseif a:dowhat =~? '^x$html$\=$' let b:do_xhtml_mappings=1 HTMLmappings off let b:did_html_mappings_init=-1 HTMLmappings on else echohl ErrorMsg echomsg "Invalid argument: " . a:dowhat echohl None endif endfunction command! -nargs=1 HTMLmappings call MappingsControl() " s:MenuControl() {{{2 " " Disable/enable the HTML menu and toolbar. " " Arguments: " 1 - String: Optional, Whether to disable or enable the mappings: " empty: Detect which to do " "disable": Disable the menu and toolbar " "enable": Enable the menu and toolbar " Return Value: " None function! s:MenuControl(...) if a:0 > 0 if a:1 !~? '^$dis\|en$able$' echoerr "Invalid argument: " . a:1 return else let bool = a:1 endif else let bool = '' endif if bool == 'disable' || ! exists("b:did_html_mappings") amenu disable HTML amenu disable HTML.* if exists('g:did_html_toolbar') amenu disable ToolBar.* amenu enable ToolBar.Open amenu enable ToolBar.Save amenu enable ToolBar.SaveAll amenu enable ToolBar.Cut amenu enable ToolBar.Copy amenu enable ToolBar.Paste amenu enable ToolBar.Find amenu enable ToolBar.Replace endif if exists('b:did_html_mappings_init') && ! exists('b:did_html_mappings') amenu enable HTML amenu disable HTML.Control.* amenu enable HTML.Control amenu enable HTML.Control.Enable\ Mappings amenu enable HTML.Control.Reload\ Mappings endif elseif bool == 'enable' || exists("b:did_html_mappings_init") amenu enable HTML if exists("b:did_html_mappings") amenu enable HTML.* amenu enable HTML.Control.* amenu disable HTML.Control.Enable\ Mappings if s:BoolVar('b:do_xhtml_mappings') amenu disable HTML.Control.Switch\ to\ XHTML\ mode amenu enable HTML.Control.Switch\ to\ HTML\ mode else amenu enable HTML.Control.Switch\ to\ XHTML\ mode amenu disable HTML.Control.Switch\ to\ HTML\ mode endif if exists('g:did_html_toolbar') amenu enable ToolBar.* endif else amenu enable HTML.Control.Enable\ Mappings endif endif endfunction " s:ShowColors() {{{2 " " Create a window to display the HTML colors, highlighted " " Arguments: " None " Return Value: " None function! s:ShowColors(...) if ! exists('g:did_html_menus') echohl ErrorMsg echomsg "The HTML menu was not created." echohl None return endif if ! exists('b:did_html_mappings_init') echohl ErrorMsg echomsg "Not in an html buffer." echohl None return endif let curbuf = bufnr('%') let maxw = 0 silent new [HTML\ Colors\ Display] setlocal buftype=nofile noswapfile bufhidden=wipe for key in keys(s:color_list) if strlen(key) > maxw let maxw = strlen(key) endif endfor let col = 0 let line = '' for key in sort(keys(s:color_list)) let col+=1 let line.=repeat(' ', maxw - strlen(key)) . key . ' = ' . s:color_list[key] if col >= 2 call append('$', line) let line = '' let col = 0 else let line .= ' ' endif let key2 = substitute(key, ' ', '', 'g') execute 'syntax match hc_' . key2 . ' /' . s:color_list[key] . '/' execute 'highlight hc_' . key2 . ' guibg=' . s:color_list[key] endfor if line != '' call append('$', line) endif call append(0, [ \'+++ q = quit = page down b = page up +++', \'+++ = Go to next color +++', \'+++ or = Select color under cursor +++', \]) exe 0 exe '1,3center ' . (maxw + 13) * 2 setlocal nomodifiable syntax match hc_colorsKeys =^\%<4l\s*+++ .\+ +++$= highlight link hc_colorsKeys Comment wincmd _ noremap q c inoremap q

c noremap

inoremap

noremap b inoremap b

noremap :call search('[A-Za-z][A-Za-z ]\+ = #\x\{6\}') inoremap

:call search('[A-Za-z][A-Za-z ]\+ = #\x\{6\}') if a:0 >= 1 let ext = ', "' . escape(a:1, '"') . '"' else let ext = '' endif execute 'noremap :call ColorSelect(' . curbuf . ext . ')' execute 'inoremap

:call ColorSelect(' . curbuf . ext . ')' execute 'noremap <2-leftmouse> :call ColorSelect(' . curbuf . ext . ')' execute 'inoremap <2-leftmouse> :call ColorSelect(' . curbuf . ext . ')' endfunction function! s:ColorSelect(bufnr, ...) let line = getline('.') let col = col('.') let color = substitute(line, '.\{-\}\%<' . (col + 1) . 'c$[A-Za-z][A-Za-z ]\+ = #\x\{6\}$\%>' . col . 'c.*', '\1', '') if color == line return '' endif let colora = split(color, ' = ') close if bufwinnr(a:bufnr) == -1 exe 'buffer ' . a:bufnr else exe a:bufnr . 'wincmd w' endif if a:0 >= 1 let which = a:1 else let which = 'i' endif exe 'normal ' . which . colora[1] stopinsert echo color endfunction function! s:ShellEscape(str) " {{{2 if exists('*shellescape') return shellescape(a:str) else if has('unix') return "'" . substitute(a:str, "'", "'\\\\''", 'g') . "'" else " Don't know how to properly escape for 'doze, so don't bother: return a:str endif endif endfunction " ---- Template Creation Stuff: {{{2 " HTMLtemplate() {{{3 " " Determine whether to insert the HTML template. " " Arguments: " None " Return Value: " 0 - The cursor is not on an insert point. " 1 - The cursor is on an insert point. function! HTMLtemplate() let ret = 0 let save_ruler = &ruler let save_showcmd = &showcmd set noruler noshowcmd if line('$') == 1 && getline(1) == '' let ret = s:HTMLtemplate2() else let YesNoOverwrite = confirm("Non-empty file.\nInsert template anyway?", "&Yes\n&No\n&Overwrite", 2, "W") if YesNoOverwrite == 1 let ret = s:HTMLtemplate2() elseif YesNoOverwrite == 3 execute "1,$delete" let ret = s:HTMLtemplate2() endif endif let &ruler = save_ruler let &showcmd = save_showcmd return ret endfunction " }}}3 " s:HTMLtemplate2() {{{3 " " Actually insert the HTML template. " " Arguments: " None " Return Value: " 0 - The cursor is not on an insert point. " 1 - The cursor is on an insert point. function! s:HTMLtemplate2() if g:html_authoremail != '' let g:html_authoremail_encoded = HTMLencodeString(g:html_authoremail) else let g:html_authoremail_encoded = '' endif let template = '' if exists('b:html_template') && b:html_template != '' let template = b:html_template elseif exists('g:html_template') && g:html_template != '' let template = g:html_template endif if template != '' if filereadable(expand(template)) silent execute "0read " . template else echohl ErrorMsg echomsg "Unable to insert template file: " . template echomsg "Either it doesn't exist or it isn't readable." echohl None return 0 endif else 0put =b:internal_html_template endif if getline('$') =~ '^\s*$' $delete endif " Replace the various tokens with appropriate values: silent! %s/\C%authorname%/\=g:html_authorname/g silent! %s/\C%authoremail%/\=g:html_authoremail_encoded/g silent! %s/\C%bgcolor%/\=g:html_bgcolor/g silent! %s/\C%textcolor%/\=g:html_textcolor/g silent! %s/\C%linkcolor%/\=g:html_linkcolor/g silent! %s/\C%alinkcolor%/\=g:html_alinkcolor/g silent! %s/\C%vlinkcolor%/\=g:html_vlinkcolor/g silent! %s/\C%date%/\=strftime('%B %d, %Y')/g "silent! %s/\C%date\s*$[^%]\{-}$\s*%/\=strftime(substitute(submatch(1),'\\\@DetectCharset()/g silent! %s/\C%vimversion%/\=strpart(v:version, 0, 1) . '.' . (strpart(v:version, 1, 2) + 0)/g go 1 call HTMLnextInsertPoint('n') if getline('.')[col('.') - 2] . getline('.')[col('.') - 1] == '><' \ || (getline('.') =~ '^\s*$' && line('.') != 1) return 1 else return 0 endif endfunction " }}}3 endif " ! exists("g:did_html_functions") let s:internal_html_template= \" <[{HEAD}]>\n\n" . \" <[{TITLE>\n\n" . \" <[{META NAME}]=\"Generator\" [{CONTENT}]=\"Vim %vimversion% (Vi IMproved editor; http://www.vim.org/)\" />\n" . \" <[{META NAME}]=\"Author\" [{CONTENT}]=\"%authorname%\" />\n" . \" <[{META NAME}]=\"Copyright\" [{CONTENT}]=\"Copyright (C) %date% %authorname%\" />\n" . \" <[{LINK REV}]=\"made\" [{HREF}]=\"mailto:%authoremail%\" />\n\n" . \" <[{STYLE TYPE}]=\"text/css\">\n" . \" \n" . \" \n\n" . \" \n" . \" <[{BODY BGCOLOR}]=\"%bgcolor%\"" . \" [{TEXT}]=\"%textcolor%\"" . \" [{LINK}]=\"%linkcolor%\"" . \" [{ALINK}]=\"%alinkcolor%\"" . \" [{VLINK}]=\"%vlinkcolor%\">\n\n" . \" <[{H1 ALIGN=\"CENTER\">\n\n" . \" <[{P}]>\n" . \" \n\n" . \" <[{HR WIDTH}]=\"75%\" />\n\n" . \" <[{P}]>\n" . \" Last Modified: <[{I}]>%date%\n" . \" \n\n" . \" <[{ADDRESS}]>\n" . \" <[{A HREF}]=\"mailto:%authoremail%\">%authorname% <%authoremail%>\n" . \" \n" . \" \n" . \"" if s:BoolVar('b:do_xhtml_mappings') let b:internal_html_template = "\n" . \ "\n" . \ s:internal_html_template else let b:internal_html_template = "\n" . \ "<[{HTML}]>\n" . \ s:internal_html_template let b:internal_html_template = substitute(b:internal_html_template, ' />', '>', 'g') endif let b:internal_html_template = s:ConvertCase(b:internal_html_template) " ---------------------------------------------------------------------------- endif " ! exists("b:did_html_mappings_init") " ---- Misc. Mappings: -------------------------------------------------- {{{1 if ! exists("b:did_html_mappings") let b:did_html_mappings = 1 let b:HTMLclearMappings = 'normal ' " Make it easy to use a ; (or whatever the map leader is) as normal: call HTMLmap("inoremap", '' . g:html_map_leader, g:html_map_leader) call HTMLmap("vnoremap", '' . g:html_map_leader, g:html_map_leader, -1) call HTMLmap("nnoremap", '' . g:html_map_leader, g:html_map_leader) " Make it easy to insert a & (or whatever the entity leader is): call HTMLmap("inoremap", "" . g:html_map_entity_leader, g:html_map_entity_leader) if ! s:BoolVar('g:no_html_tab_mapping') " Allow hard tabs to be inserted: call HTMLmap("inoremap", "", "") call HTMLmap("nnoremap", "", "") " Tab takes us to a (hopefully) reasonable next insert point: call HTMLmap("inoremap", "", ":call HTMLnextInsertPoint('i')") call HTMLmap("nnoremap", "", ":call HTMLnextInsertPoint('n')") call HTMLmap("vnoremap", "", ":call HTMLnextInsertPoint('n')", -1) else call HTMLmap("inoremap", "", ":call HTMLnextInsertPoint('i')") call HTMLmap("nnoremap", "", ":call HTMLnextInsertPoint('n')") call HTMLmap("vnoremap", "", ":call HTMLnextInsertPoint('n')", -1) endif " Update an image tag's WIDTH & HEIGHT attributes (experimental!): runtime! MangleImageTag.vim if exists("*MangleImageTag") call HTMLmap("nnoremap", "mi", ":call MangleImageTag()") call HTMLmap("inoremap", "mi", ":call MangleImageTag()") endif call HTMLmap("nnoremap", "html", ":if HTMLtemplate() \\| startinsert \\| endif") " ---------------------------------------------------------------------------- " ---- General Markup Tag Mappings: ------------------------------------- {{{1 " SGML Doctype Command "call HTMLmap("nnoremap", "4", "1GO``") " SGML Doctype Command if ! s:BoolVar('b:do_xhtml_mappings') " Transitional HTML (Looser): call HTMLmap("nnoremap", "4", ":call append(0, '')") " Strict HTML: call HTMLmap("nnoremap", "s4", ":call append(0, '')") else " Transitional XHTML (Looser): call HTMLmap("nnoremap", "4", ":call append(0, '')") " Strict XHTML: call HTMLmap("nnoremap", "s4", ":call append(0, '')") endif call HTMLmap("imap", "4", "" . g:html_map_leader . "4") call HTMLmap("imap", "s4", "" . g:html_map_leader . "s4") " Content-Type META tag call HTMLmap("inoremap", "ct", "<[{META HTTP-EQUIV}]=\"Content-Type\" [{CONTENT}]=\"text/html; charset==DetectCharset()\" />") " Comment Tag call HTMLmap("inoremap", "cm", "=tag('comment','i')") " Visual mapping: call HTMLmap("vnoremap", "cm", ":execute \"normal \" . tag('comment','v')", 2) " Motion mapping: call HTMLmapo('cm', 0) " A HREF Anchor Hyperlink HTML 2.0 call HTMLmap("inoremap", "ah", "<[{A HREF=\"\">F\"") call HTMLmap("inoremap", "aH", "<[{A HREF=\"*\">F<") " Visual mappings: call HTMLmap("vnoremap", "ah", "`>a

`<<[{A HREF}]=\"\">F\"", 0) call HTMLmap("vnoremap", "aH", "`>a\">

`<<[{A HREF}]=\"f<", 0) " Motion mappings: call HTMLmapo('ah', 1) call HTMLmapo('aH', 1) " A HREF Anchor Hyperlink, with TARGET="" call HTMLmap("inoremap", "at", "<[{A HREF=\"\" TARGET=\"\">3F\"") call HTMLmap("inoremap", "aT", "<[{A HREF=\"*\" TARGET=\"\">F\"") " Visual mappings: call HTMLmap("vnoremap", "at", "`>a

`<<[{A HREF=\"\" TARGET}]=\"\">3F\"", 0) call HTMLmap("vnoremap", "aT", "`>a\" [{TARGET=\"\">`<<[{A HREF}]=\"3f\"", 0) " Motion mappings: call HTMLmapo('at', 1) call HTMLmapo('aT', 1) " A NAME Named Anchor HTML 2.0 call HTMLmap("inoremap", "an", "<[{A NAME=\"\">F\"") call HTMLmap("inoremap", "aN", "<[{A NAME=\"*\">F<") " Visual mappings: call HTMLmap("vnoremap", "an", "`>a

`<<[{A NAME}]=\"\">F\"", 0) call HTMLmap("vnoremap", "aN", "`>a\">

`<<[{A NAME}]=\"f<", 0) " Motion mappings: call HTMLmapo('an', 1) call HTMLmapo('aN', 1) " ABBR Abbreviation HTML 4.0 call HTMLmap("inoremap", "ab", "<[{ABBR TITLE=\"\">F\"") call HTMLmap("inoremap", "aB", "<[{ABBR TITLE=\"*\">F<") " Visual mappings: call HTMLmap("vnoremap", "ab", "`>a

`<<[{ABBR TITLE}]=\"\">F\"", 0) call HTMLmap("vnoremap", "aB", "`>a\">

`<<[{ABBR TITLE}]=\"f<", 0) " Motion mappings: call HTMLmapo('ab', 1) call HTMLmapo('aB', 1) " ACRONYM HTML 4.0 call HTMLmap("inoremap", "ac", "<[{ACRONYM TITLE=\"\">F\"") call HTMLmap("inoremap", "aC", "<[{ACRONYM TITLE=\"*\">F<") " Visual mappings: call HTMLmap("vnoremap", "ac", "`>a

`<<[{ACRONYM TITLE}]=\"\">F\"", 0) call HTMLmap("vnoremap", "aC", "`>a\">

`<<[{ACRONYM TITLE}]=\"f<", 0) " Motion mappings: call HTMLmapo('ac', 1) call HTMLmapo('aC', 1) " ADDRESS HTML 2.0 call HTMLmap("inoremap", "ad", "<[{ADDRESS>F<") " Visual mapping: call HTMLmap("vnoremap", "ad", "`>a

`<<[{ADDRESS}]>", 2) " Motion mapping: call HTMLmapo('ad', 0) " B Boldfaced Text HTML 2.0 call HTMLmap("inoremap", "bo", "=tag('b','i')") " Visual mapping: call HTMLmap("vnoremap", "bo", ":execute \"normal \" . tag('b','v')", 2) " Motion mapping: call HTMLmapo('bo', 0) " BASE HTML 2.0 HEADER call HTMLmap("inoremap", "bh", "<[{BASE HREF}]=\"\" />F\"") " Visual mapping: call HTMLmap("vnoremap", "bh", "`>a\" />`<<[{BASE HREF}]=\"", 2) " Motion mapping: call HTMLmapo('bh', 0) " BIG HTML 3.0 call HTMLmap("inoremap", "bi", "<[{BIG>F<") " Visual mapping: call HTMLmap("vnoremap", "bi", "`>a

`<<[{BIG}]>") " Motion mapping: call HTMLmapo('bi', 0) " BLOCKQUOTE HTML 2.0 call HTMLmap("inoremap", "bl", "<[{BLOCKQUOTE}]>O") " Visual mapping: call HTMLmap("vnoremap", "bl", "`>a

`<<[{BLOCKQUOTE}]>", 1) " Motion mapping: call HTMLmapo('bl', 0) " BODY HTML 2.0 call HTMLmap("inoremap", "bd", "<[{BODY}]>O") " Visual mapping: call HTMLmap("vnoremap", "bd", "`>a

`<<[{BODY}]>", 1) " Motion mapping: call HTMLmapo('bd', 0) " BR Line break HTML 2.0 call HTMLmap("inoremap", "br", "<[{BR}] />") " CENTER NETSCAPE call HTMLmap("inoremap", "ce", "<[{CENTER>F<") " Visual mapping: call HTMLmap("vnoremap", "ce", "`>a

`<<[{CENTER}]>", 2) " Motion mapping: call HTMLmapo('ce', 0) " CITE HTML 2.0 call HTMLmap("inoremap", "ci", "<[{CITE>F<") " Visual mapping: call HTMLmap("vnoremap", "ci", "`>a

`<<[{CITE}]>", 2) " Motion mapping: call HTMLmapo('ci', 0) " CODE HTML 2.0 call HTMLmap("inoremap", "co", "<[{CODE>F<") " Visual mapping: call HTMLmap("vnoremap", "co", "`>a

`<<[{CODE}]>", 2) " Motion mapping: call HTMLmapo('co', 0) " DEFINITION LIST COMPONENTS HTML 2.0 " DL Definition List " DT Definition Term " DD Definition Body call HTMLmap("inoremap", "dl", "<[{DL}]>O") call HTMLmap("inoremap", "dt", "<[{DT}]>

F<") call HTMLmap("inoremap", "dd", "<[{DD}]>

F<") " Visual mappings: call HTMLmap("vnoremap", "dl", "`>a

`<<[{DL}]>", 1) call HTMLmap("vnoremap", "dt", "`>a

`<<[{DT}]>", 2) call HTMLmap("vnoremap", "dd", "`>a

`<<[{DD}]>", 2) " Motion mapping: call HTMLmapo('dl', 0) call HTMLmapo('dt', 0) call HTMLmapo('dd', 0) " DEL Deleted Text HTML 3.0 call HTMLmap("inoremap", "de", "[{DEL>F<") " Visual mapping: call HTMLmap("vnoremap", "de", "`>a

`<[{DEL}]>") " Motion mapping: call HTMLmapo('de', 0) " DFN Defining Instance HTML 3.0 call HTMLmap("inoremap", "df", "<[{DFN>F<") " Visual mapping: call HTMLmap("vnoremap", "df", "`>a

`<<[{DFN}]>", 2) " Motion mapping: call HTMLmapo('df', 0) " DIV Document Division HTML 3.0 call HTMLmap("inoremap", "