/usr/share/vim-scripts/ftplugin/xml.vim is in vim-scripts 20130814ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 | " Vim script file vim600:fdm=marker:
" FileType: XML
" Author: Devin Weaver <suki (at) tritarget.com>
" Maintainer: Devin Weaver <suki (at) tritarget.com>
" Last Change: Thu Jul 22 16:06:01 EDT 2010
" Version: 1.9.1
" Location: http://www.vim.org/scripts/script.php?script_id=301
" Licence: This program is free software; you can redistribute it
" and/or modify it under the terms of the GNU General Public
" License. See http://www.gnu.org/copyleft/gpl.txt
" GetLatestVimScripts: 301 1 :AutoInstall: xmledit.vba
" This script provides some convenience when editing XML (and some SGML)
" formated documents.
" Section: Documentation
" ----------------------
"
" Documentation should be available by ":help xml-plugin" command, once the
" script has been copied in you .vim/plugin directory.
"
" You still can read the documentation in the file "doc/xml-plugin.txt"
" Note: If you used the 5.x version of this file (xmledit.vim) you'll need to
" comment out the section where you called it since it is no longer used in
" version 6.x.
" TODO: Revamp ParseTag to pull appart a tag a rebuild it properly.
" a tag like: < test nowrap testatt=foo >
" should be fixed to: <test nowrap="nowrap" testatt="foo"></test>
"==============================================================================
" Only do this when not done yet for this buffer
if exists("b:did_ftplugin") || exists("loaded_xmledit")
finish
endif
" sboles, init these variables so vim doesn't complain on wrap cancel
let b:last_wrap_tag_used = ""
let b:last_wrap_atts_used = ""
" WrapTag -> Places an XML tag around a visual selection. {{{1
" Brad Phelan: Wrap the argument in an XML tag
" Added nice GUI support to the dialogs.
" Rewrote function to implement new algorythem that addresses several bugs.
if !exists("*s:WrapTag")
function s:WrapTag(text)
if (line(".") < line("'<"))
let insert_cmd = "o"
elseif (col(".") < col("'<"))
let insert_cmd = "a"
else
let insert_cmd = "i"
endif
if strlen(a:text) > 10
let input_text = strpart(a:text, 0, 10) . '...'
else
let input_text = a:text
endif
if exists("b:last_wrap_tag_used")
let default_tag = b:last_wrap_tag_used
else
let default_tag = ""
endif
let wraptag = inputdialog('Tag to wrap "' . input_text . '" : ', default_tag)
if strlen(wraptag)==0
undo
return
else
if wraptag == default_tag && exists("b:last_wrap_atts_used")
let default_atts = b:last_wrap_atts_used
else
let default_atts = ""
endif
let atts = inputdialog('Attributes in <' . wraptag . '> : ', default_atts)
endif
if (visualmode() ==# 'V')
let text = strpart(a:text,0,strlen(a:text)-1)
if (insert_cmd ==# "o")
let eol_cmd = ""
else
let eol_cmd = "\<Cr>"
endif
else
let text = a:text
let eol_cmd = ""
endif
if strlen(atts)==0
let text = "<".wraptag.">".text."</".wraptag.">"
let b:last_wrap_tag_used = wraptag
let b:last_wrap_atts_used = ""
else
let text = "<".wraptag." ".atts.">".text."</".wraptag.">"
let b:last_wrap_tag_used = wraptag
let b:last_wrap_atts_used = atts
endif
execute "normal! ".insert_cmd.text.eol_cmd
endfunction
endif
" NewFileXML -> Inserts <?xml?> at top of new file. {{{1
if !exists("*s:NewFileXML")
function s:NewFileXML( )
" Where is g:did_xhtmlcf_inits defined?
if &filetype == 'docbk' || &filetype == 'xml' || (!exists ("g:did_xhtmlcf_inits") && exists ("g:xml_use_xhtml") && (&filetype == 'html' || &filetype == 'xhtml'))
if append (0, '<?xml version="1.0"?>')
normal! G
endif
endif
endfunction
endif
" Callback -> Checks for tag callbacks and executes them. {{{1
if !exists("*s:Callback")
function s:Callback( xml_tag, isHtml )
let text = 0
if a:isHtml == 1 && exists ("*HtmlAttribCallback")
let text = HtmlAttribCallback (a:xml_tag)
elseif exists ("*XmlAttribCallback")
let text = XmlAttribCallback (a:xml_tag)
endif
if text != '0'
execute "normal! i " . text ."\<Esc>l"
endif
endfunction
endif
" IsParsableTag -> Check to see if the tag is a real tag. {{{1
if !exists("*s:IsParsableTag")
function s:IsParsableTag( tag )
" The "Should I parse?" flag.
let parse = 1
" make sure a:tag has a proper tag in it and is not a instruction or end tag.
if a:tag !~ '^<[[:alnum:]_:\-].*>$'
let parse = 0
endif
" make sure this tag isn't already closed.
if strpart (a:tag, strlen (a:tag) - 2, 1) == '/'
let parse = 0
endif
return parse
endfunction
endif
" ParseTag -> The major work hourse for tag completion. {{{1
if !exists("*s:ParseTag")
function s:ParseTag( )
" Save registers
let old_reg_save = @"
let old_save_x = @x
if (!exists("g:xml_no_auto_nesting") && strpart (getline ("."), col (".") - 2, 2) == '>>')
let multi_line = 1
execute "normal! \"xX"
else
let multi_line = 0
endif
let @" = ""
execute "normal! \"xy%%"
let ltag = @"
if (&filetype == 'html' || &filetype == 'xhtml') && (!exists ("g:xml_no_html"))
let html_mode = 1
let ltag = substitute (ltag, '[^[:graph:]]\+', ' ', 'g')
let ltag = substitute (ltag, '<\s*\([^[:alnum:]_:\-[:blank:]]\=\)\s*\([[:alnum:]_:\-]\+\)\>', '<\1\2', '')
else
let html_mode = 0
endif
if <SID>IsParsableTag (ltag)
" find the break between tag name and atributes (or closing of tag)
let index = matchend (ltag, '[[:alnum:]_:\.\-]\+')
let tag_name = strpart (ltag, 1, index - 1)
if strpart (ltag, index) =~ '[^/>[:blank:]]'
let has_attrib = 1
else
let has_attrib = 0
endif
" That's (index - 1) + 2, 2 for the '</' and 1 for the extra character the
" while includes (the '>' is ignored because <Esc> puts the curser on top
" of the '>'
let index = index + 2
" print out the end tag and place the cursor back were it left off
if html_mode && tag_name =~? '^\(img\|input\|param\|frame\|br\|hr\|meta\|link\|base\|area\)$'
if has_attrib == 0
call <SID>Callback (tag_name, html_mode)
endif
if exists ("g:xml_use_xhtml")
execute "normal! i /\<Esc>l"
endif
else
if multi_line
" Can't use \<Tab> because that indents 'tabstop' not 'shiftwidth'
" Also >> doesn't shift on an empty line hence the temporary char 'x'
let com_save = &comments
set comments-=n:>
execute "normal! a\<Cr>\<Cr>\<Esc>kAx\<Esc>>>$\"xx"
execute "set comments=" . substitute(com_save, " ", "\\\\ ", "g")
else
if has_attrib == 0
call <SID>Callback (tag_name, html_mode)
endif
if exists("g:xml_jump_string")
let index = index + strlen(g:xml_jump_string)
let jump_char = g:xml_jump_string
call <SID>InitEditFromJump()
else
let jump_char = ""
endif
execute "normal! a</" . tag_name . ">" . jump_char . "\<Esc>" . index . "h"
endif
endif
endif
" restore registers
let @" = old_reg_save
let @x = old_save_x
if multi_line
startinsert!
else
execute "normal! l"
startinsert
endif
endfunction
endif
" ParseTag2 -> Experimental function to replace ParseTag {{{1
"if !exists("*s:ParseTag2")
"function s:ParseTag2( )
" My thought is to pull the tag out and reformat it to a normalized tag
" and put it back.
"endfunction
"endif
" BuildTagName -> Grabs the tag's name for tag matching. {{{1
if !exists("*s:BuildTagName")
function s:BuildTagName( )
"First check to see if we Are allready on the end of the tag. The / search
"forwards command will jump to the next tag otherwise
" Store contents of register x in a variable
let b:xreg = @x
exec "normal! v\"xy"
if @x=='>'
" Don't do anything
else
exec "normal! />/\<Cr>"
endif
" Now we head back to the < to reach the beginning.
exec "normal! ?<?\<Cr>"
" Capture the tag (a > will be catured by the /$/ match)
exec "normal! v/\\s\\|$/\<Cr>\"xy"
" We need to strip off any junk at the end.
let @x=strpart(@x, 0, match(@x, "[[:blank:]>\<C-J>]"))
"remove <, >
let @x=substitute(@x,'^<\|>$','','')
" remove spaces.
let @x=substitute(@x,'/\s*','/', '')
let @x=substitute(@x,'^\s*','', '')
" Swap @x and b:xreg
let temp = @x
let @x = b:xreg
let b:xreg = temp
endfunction
endif
" TagMatch1 -> First step in tag matching. {{{1
" Brad Phelan: First step in tag matching.
if !exists("*s:TagMatch1")
function s:TagMatch1()
" Save registers
let old_reg_save = @"
"Drop a marker here just in case we have a mismatched tag and
"wish to return (:mark looses column position)
normal! mz
call <SID>BuildTagName()
"Check to see if it is an end tag. If it is place a 1 in endtag
if match(b:xreg, '^/')==-1
let endtag = 0
else
let endtag = 1
endif
" Extract the tag from the whole tag block
" eg if the block =
" tag attrib1=blah attrib2=blah
" we will end up with
" tag
" with no trailing or leading spaces
let b:xreg=substitute(b:xreg,'^/','','g')
" Make sure the tag is valid.
" Malformed tags could be <?xml ?>, <![CDATA[]]>, etc.
if match(b:xreg,'^[[:alnum:]_:\-]') != -1
" Pass the tag to the matching
" routine
call <SID>TagMatch2(b:xreg, endtag)
endif
" Restore registers
let @" = old_reg_save
endfunction
endif
" TagMatch2 -> Second step in tag matching. {{{1
" Brad Phelan: Second step in tag matching.
if !exists("*s:TagMatch2")
function s:TagMatch2(tag,endtag)
let match_type=''
" Build the pattern for searching for XML tags based
" on the 'tag' type passed into the function.
" Note we search forwards for end tags and
" backwards for start tags
if a:endtag==0
"let nextMatch='normal /\(<\s*' . a:tag . '\(\s\+.\{-}\)*>\)\|\(<\/' . a:tag . '\s*>\)'
let match_type = '/'
else
"let nextMatch='normal ?\(<\s*' . a:tag . '\(\s\+.\{-}\)*>\)\|\(<\/' . a:tag . '\s*>\)'
let match_type = '?'
endif
if a:endtag==0
let stk = 1
else
let stk = 1
end
" wrapscan must be turned on. We'll recored the value and reset it afterward.
" We have it on because if we don't we'll get a nasty error if the search hits
" BOF or EOF.
let wrapval = &wrapscan
let &wrapscan = 1
"Get the current location of the cursor so we can
"detect if we wrap on ourselves
let lpos = line(".")
let cpos = col(".")
if a:endtag==0
" If we are trying to find a start tag
" then decrement when we find a start tag
let iter = 1
else
" If we are trying to find an end tag
" then increment when we find a start tag
let iter = -1
endif
"Loop until stk == 0.
while 1
" exec search.
" Make sure to avoid />$/ as well as /\s$/ and /$/.
exec "normal! " . match_type . '<\s*\/*\s*' . a:tag . '\([[:blank:]>]\|$\)' . "\<Cr>"
" Check to see if our match makes sence.
if a:endtag == 0
if line(".") < lpos
call <SID>MisMatchedTag (0, a:tag)
break
elseif line(".") == lpos && col(".") <= cpos
call <SID>MisMatchedTag (1, a:tag)
break
endif
else
if line(".") > lpos
call <SID>MisMatchedTag (2, '/'.a:tag)
break
elseif line(".") == lpos && col(".") >= cpos
call <SID>MisMatchedTag (3, '/'.a:tag)
break
endif
endif
call <SID>BuildTagName()
if match(b:xreg,'^/')==-1
" Found start tag
let stk = stk + iter
else
" Found end tag
let stk = stk - iter
endif
if stk == 0
break
endif
endwhile
let &wrapscan = wrapval
endfunction
endif
" MisMatchedTag -> What to do if a tag is mismatched. {{{1
if !exists("*s:MisMatchedTag")
function s:MisMatchedTag( id, tag )
"Jump back to our formor spot
normal! `z
normal zz
echohl WarningMsg
" For debugging
"echo "Mismatched tag " . a:id . ": <" . a:tag . ">"
" For release
echo "Mismatched tag <" . a:tag . ">"
echohl None
endfunction
endif
" DeleteTag -> Deletes surrounding tags from cursor. {{{1
" Modifies mark z
if !exists("*s:DeleteTag")
function s:DeleteTag( )
if strpart (getline ("."), col (".") - 1, 1) == "<"
normal! l
endif
if search ("<[^\/]", "bW") == 0
return
endif
normal! mz
normal \5
normal! d%`zd%
endfunction
endif
" VisualTag -> Selects Tag body in a visual selection. {{{1
" Modifies mark z
if !exists("*s:VisualTag")
function s:VisualTag( )
if strpart (getline ("."), col (".") - 1, 1) == "<"
normal! l
endif
if search ("<[^\/]", "bW") == 0
return
endif
normal! mz
normal \5
normal! %
exe "normal! " . visualmode()
normal! `z
endfunction
endif
" InsertGt -> close tags only if the cursor is in a HTML or XML context {{{1
" Else continue editing
if !exists("*s:InsertGt")
function s:InsertGt( )
let save_matchpairs = &matchpairs
set matchpairs-=<:>
execute "normal! a>"
execute "set matchpairs=" . save_matchpairs
" When the current char is text within a tag it will not proccess as a
" syntax'ed element and return nothing below. Since the multi line wrap
" feture relies on using the '>' char as text within a tag we must use the
" char prior to establish if it is valid html/xml
if (getline('.')[col('.') - 1] == '>')
let char_syn=synIDattr(synID(line("."), col(".") - 1, 1), "name")
endif
if !exists("g:xml_tag_syntax_prefixes")
let tag_syn_patt = 'html\|xml\|docbk'
else
let tag_syn_patt = g:xml_tag_syntax_prefixes
endif
if -1 == match(char_syn, "xmlProcessing") && 0 == match(char_syn, tag_syn_patt)
call <SID>ParseTag()
else
if col(".") == col("$") - 1
startinsert!
else
execute "normal! l"
startinsert
endif
endif
endfunction
endif
" InitEditFromJump -> Set some needed autocommands and syntax highlights for EditFromJump. {{{1
if !exists("*s:InitEditFromJump")
function s:InitEditFromJump( )
" Add a syntax highlight for the xml_jump_string.
execute "syntax match Error /\\V" . g:xml_jump_string . "/"
endfunction
endif
" ClearJumpMarks -> Clean out extranious left over xml_jump_string garbage. {{{1
if !exists("*s:ClearJumpMarks")
function s:ClearJumpMarks( )
if exists("g:xml_jump_string")
if g:xml_jump_string != ""
execute ":%s/" . g:xml_jump_string . "//ge"
endif
endif
endfunction
endif
" EditFromJump -> Jump to the end of the tag and continue editing. {{{1
" g:xml_jump_string must be set.
if !exists("*s:EditFromJump")
function s:EditFromJump( )
if exists("g:xml_jump_string")
if g:xml_jump_string != ""
let foo = search(g:xml_jump_string, 'csW') " Moves cursor by default
execute "normal! " . strlen(g:xml_jump_string) . "x"
if col(".") == col("$") - 1
startinsert!
else
startinsert
endif
endif
else
echohl WarningMsg
echo "Function disabled. xml_jump_string not defined."
echohl None
endif
endfunction
endif
" Mappings and Settings. {{{1
" This makes the '%' jump between the start and end of a single tag.
setlocal matchpairs+=<:>
setlocal commentstring=<!--%s-->
" Have this as an escape incase you want a literal '>' not to run the
" ParseTag function.
if !exists("g:xml_tag_completion_map")
inoremap <buffer> <LocalLeader>. >
inoremap <buffer> <LocalLeader>> >
endif
" Jump between the beggining and end tags.
nnoremap <buffer> <LocalLeader>5 :call <SID>TagMatch1()<Cr>
nnoremap <buffer> <LocalLeader>% :call <SID>TagMatch1()<Cr>
vnoremap <buffer> <LocalLeader>5 <Esc>:call <SID>VisualTag()<Cr>
vnoremap <buffer> <LocalLeader>% <Esc>:call <SID>VisualTag()<Cr>
" Wrap selection in XML tag
vnoremap <buffer> <LocalLeader>x "xx:call <SID>WrapTag(@x)<Cr>
nnoremap <buffer> <LocalLeader>d :call <SID>DeleteTag()<Cr>
" Parse the tag after pressing the close '>'.
if !exists("g:xml_tag_completion_map")
" inoremap <buffer> > ><Esc>:call <SID>ParseTag()<Cr>
inoremap <buffer> > <Esc>:call <SID>InsertGt()<Cr>
else
execute "inoremap <buffer> " . g:xml_tag_completion_map . " <Esc>:call <SID>InsertGt()<Cr>"
endif
nnoremap <buffer> <LocalLeader><LocalLeader> :call <SID>EditFromJump()<Cr>
inoremap <buffer> <LocalLeader><LocalLeader> <Esc>:call <SID>EditFromJump()<Cr>
" Clear out all left over xml_jump_string garbage
nnoremap <buffer> <LocalLeader>w :call <SID>ClearJumpMarks()<Cr>
" The syntax files clear out any predefined syntax definitions. Recreate
" this when ever a xml_jump_string is created. (in ParseTag)
augroup xml
au!
au BufNewFile * call <SID>NewFileXML()
" Remove left over garbage from xml_jump_string on file save.
au BufWritePre <buffer> call <SID>ClearJumpMarks()
augroup END
"}}}1
finish
|