3 " Author: John Wellesz <John.wellesz (AT) teaser (DOT) fr>
4 " URL: http://www.2072productions.com/vim/indent/php.vim
5 " Last Change: 2010 Jully 26th
6 " Newsletter: http://www.2072productions.com/?to=php-indent-for-vim-newsletter.php
10 " If you find a bug, please report it on GitHub:
11 " http://github.com/2072/PHP-Indenting-for-VIm/issues
12 " with an example of code that breaks the algorithm.
15 " Thanks a lot for using this script.
18 " NOTE: This script must be used with PHP syntax ON and with the php syntax
19 " script by Lutz Eymers (http://www.ipdienste.net/data/php.vim ) or with the
20 " script by Peter Hodge (http://www.vim.org/scripts/script.php?script_id=1571 )
21 " the later is bunbdled by default with Vim 7.
24 " In the case you have syntax errors in your script such as HereDoc end
25 " identifiers not at col 1 you'll have to indent your file 2 times (This
26 " script will automatically put HereDoc end identifiers at col 1 if
27 " they are followed by a ';').
30 " NOTE: If you are editing files in Unix file format and that (by accident)
31 " there are '\r' before new lines, this script won't be able to proceed
32 " correctly and will make many mistakes because it won't be able to match
34 " So you have to remove those useless characters first with a command like:
38 " or simply 'let' the option PHP_removeCRwhenUnix to 1 and the script will
39 " silently remove them when VIM load this script (at each bufread).
41 " Options: See :help php-indent for available options.
44 if exists("b:did_indent")
50 let php_sync_method = 0
53 if exists("PHP_default_indenting")
54 let b:PHP_default_indenting = PHP_default_indenting * &sw
56 let b:PHP_default_indenting = 0
59 if exists("PHP_BracesAtCodeLevel")
60 let b:PHP_BracesAtCodeLevel = PHP_BracesAtCodeLevel
62 let b:PHP_BracesAtCodeLevel = 0
66 if exists("PHP_autoformatcomment")
67 let b:PHP_autoformatcomment = PHP_autoformatcomment
69 let b:PHP_autoformatcomment = 1
72 if exists("PHP_outdentphpescape")
73 let b:PHP_outdentphpescape = PHP_outdentphpescape
75 let b:PHP_outdentphpescape = 1
79 if exists("PHP_vintage_case_default_indent") && PHP_vintage_case_default_indent
80 let b:PHP_vintage_case_default_indent = 1
82 let b:PHP_vintage_case_default_indent = 0
87 let b:PHP_lastindented = 0
88 let b:PHP_indentbeforelast = 0
89 let b:PHP_indentinghuge = 0
90 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
91 let b:PHP_LastIndentedWasComment = 0
92 let b:PHP_InsideMultilineComment = 0
94 let b:InPHPcode_checked = 0
95 let b:InPHPcode_and_script = 0
96 let b:InPHPcode_tofind = ""
97 let b:PHP_oldchangetick = b:changedtick
98 let b:UserIsTypingComment = 0
101 setlocal nosmartindent
102 setlocal noautoindent
106 setlocal indentexpr=GetPhpIndent()
107 setlocal indentkeys=0{,0},0),:,!^F,o,O,e,*<Return>,=?>,=<?,=*/
111 let s:searchpairflags = 'bWr'
113 if &fileformat == "unix" && exists("PHP_removeCRwhenUnix") && PHP_removeCRwhenUnix
117 if exists("*GetPhpIndent")
118 call ResetPhpOptions()
122 let s:endline= '\s*\%(//.*\|#.*\|/\*.*\*/\s*\)\=$'
123 let s:PHP_startindenttag = '<?\%(.*?>\)\@!\|<script[^>]*>\%(.*<\/script>\)\@!'
126 function! GetLastRealCodeLNum(startline) " {{{
128 let lnum = a:startline
130 if b:GetLastRealCodeLNum_ADD && b:GetLastRealCodeLNum_ADD == lnum + 1
131 let lnum = b:GetLastRealCodeLNum_ADD
137 let lnum = prevnonblank(lnum)
138 let lastline = getline(lnum)
140 if b:InPHPcode_and_script && lastline =~ '?>\s*$'
142 elseif lastline =~ '^\s*?>.*<?\%(php\)\=\s*$'
144 elseif lastline =~ '^\s*\%(//\|#\|/\*.*\*/\s*$\)'
146 elseif lastline =~ '\*/\s*$'
148 if lastline !~ '^\*/'
149 call search('\*/', 'W')
151 let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
153 let lastline = getline(lnum)
154 if lastline =~ '^\s*/\*'
161 elseif lastline =~? '\%(//\s*\|?>.*\)\@<!<?\%(php\)\=\s*$\|^\s*<script\>'
163 while lastline !~ '\(<?.*\)\@<!?>' && lnum > 1
165 let lastline = getline(lnum)
167 if lastline =~ '^\s*?>'
174 elseif lastline =~? '^\a\w*;\=$' && lastline !~? s:notPhpHereDoc
175 let tofind=substitute( lastline, '\(\a\w*\);\=', '<<<''\\=\1''\\=$', '')
176 while getline(lnum) !~? tofind && lnum > 1
184 if lnum==1 && getline(lnum) !~ '<?'
188 if b:InPHPcode_and_script && !b:InPHPcode
189 let b:InPHPcode_and_script = 0
197 function! Skippmatch2()
199 let line = getline(".")
201 if line =~ '\%(".*\)\@<=/\*\%(.*"\)\@=' || line =~ '\%(\%(//\|#\).*\)\@<=/\*'
208 function! Skippmatch() " {{{
209 let synname = synIDattr(synID(line("."), col("."), 0), "name")
210 if synname == "Delimiter" || synname == "phpRegionDelimiter" || synname =~# "^phpParent" || synname == "phpArrayParens" || synname =~# '^php\%(Block\|Brace\)' || synname == "javaScriptBraces" || synname =~# "^phpComment" && b:UserIsTypingComment
217 function! FindOpenBracket(lnum) " {{{
218 call cursor(a:lnum, 1)
219 return searchpair('{', '', '}', 'bW', 'Skippmatch()')
222 function! FindTheIfOfAnElse (lnum, StopAfterFirstPrevElse) " {{{
224 if getline(a:lnum) =~# '^\s*}\s*else\%(if\)\=\>'
225 let beforeelse = a:lnum
227 let beforeelse = GetLastRealCodeLNum(a:lnum - 1)
234 if getline(beforeelse) =~# '^\s*\%(}\s*\)\=else\%(\s*if\)\@!\>'
235 let s:iftoskip = s:iftoskip + 1
238 if getline(beforeelse) =~ '^\s*}'
239 let beforeelse = FindOpenBracket(beforeelse)
241 if getline(beforeelse) =~ '^\s*{'
242 let beforeelse = GetLastRealCodeLNum(beforeelse - 1)
247 if !s:iftoskip && a:StopAfterFirstPrevElse && getline(beforeelse) =~# '^\s*\%([}]\s*\)\=else\%(if\)\=\>'
251 if getline(beforeelse) !~# '^\s*if\>' && beforeelse>1 || s:iftoskip && beforeelse>1
253 if s:iftoskip && getline(beforeelse) =~# '^\s*if\>'
254 let s:iftoskip = s:iftoskip - 1
257 let s:level = s:level + 1
258 let beforeelse = FindTheIfOfAnElse(beforeelse, a:StopAfterFirstPrevElse)
265 let s:defaultORcase = '^\s*\%(default\|case\).*:'
267 function! FindTheSwitchIndent (lnum) " {{{
270 let test = GetLastRealCodeLNum(a:lnum - 1)
273 return indent(1) - &sw * b:PHP_vintage_case_default_indent
276 if getline(test) =~ '^\s*}'
277 let test = FindOpenBracket(test)
279 if getline(test) =~ '^\s*{'
280 let test = GetLastRealCodeLNum(GetLastRealCodeLNum(test - 1) - 1)
284 if getline(test) =~# '^\s*switch\>'
286 elseif getline(test) =~# s:defaultORcase
287 return indent(test) - &sw * b:PHP_vintage_case_default_indent
289 return FindTheSwitchIndent(test)
295 function! IslinePHP (lnum, tofind) " {{{
296 let cline = getline(a:lnum)
299 let tofind = "^\\s*[\"']*\\s*\\zs\\S"
301 let tofind = a:tofind
304 let tofind = tofind . '\c'
306 let coltotest = match (cline, tofind) + 1
308 let synname = synIDattr(synID(a:lnum, coltotest, 0), "name")
310 if synname =~ '^php' || synname=="Delimiter" || synname =~? '^javaScript'
317 let s:notPhpHereDoc = '\%(break\|return\|continue\|exit\|else\)'
318 let s:blockstart = '\%(\%(\%(}\s*\)\=else\%(\s\+\)\=\)\=if\>\|else\>\|while\>\|switch\>\|case\>\|default\>\|for\%(each\)\=\>\|declare\>\|class\>\|interface\>\|abstract\>\|try\>\|catch\>\)'
320 let s:autoresetoptions = 0
321 if ! s:autoresetoptions
322 let s:autoresetoptions = 1
325 function! ResetPhpOptions()
326 if ! b:optionsset && &filetype == "php"
327 if b:PHP_autoformatcomment
329 setlocal comments=s1:/*,mb:*,ex:*/,://,:#
331 setlocal formatoptions-=t
332 setlocal formatoptions+=q
333 setlocal formatoptions+=r
334 setlocal formatoptions+=o
335 setlocal formatoptions+=w
336 setlocal formatoptions+=c
337 setlocal formatoptions+=b
343 call ResetPhpOptions()
345 function! GetPhpIndent()
347 let b:GetLastRealCodeLNum_ADD = 0
350 if b:PHP_oldchangetick != b:changedtick
351 let b:PHP_oldchangetick = b:changedtick
355 if b:PHP_default_indenting
356 let b:PHP_default_indenting = g:PHP_default_indenting * &sw
359 let cline = getline(v:lnum)
361 if !b:PHP_indentinghuge && b:PHP_lastindented > b:PHP_indentbeforelast
362 if b:PHP_indentbeforelast
363 let b:PHP_indentinghuge = 1
364 echom 'Large indenting detected, speed optimizations engaged (v1.33)'
366 let b:PHP_indentbeforelast = b:PHP_lastindented
369 if b:InPHPcode_checked && prevnonblank(v:lnum - 1) != b:PHP_lastindented
370 if b:PHP_indentinghuge
371 echom 'Large indenting deactivated'
372 let b:PHP_indentinghuge = 0
373 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
375 let b:PHP_lastindented = v:lnum
376 let b:PHP_LastIndentedWasComment=0
377 let b:PHP_InsideMultilineComment=0
378 let b:PHP_indentbeforelast = 0
381 let b:InPHPcode_checked = 0
382 let b:InPHPcode_and_script = 0
383 let b:InPHPcode_tofind = ""
385 elseif v:lnum > b:PHP_lastindented
386 let real_PHP_lastindented = b:PHP_lastindented
387 let b:PHP_lastindented = v:lnum
391 if !b:InPHPcode_checked " {{{ One time check
392 let b:InPHPcode_checked = 1
396 let synname = IslinePHP (prevnonblank(v:lnum), "")
400 if synname != "phpHereDoc" && synname != "phpHereDocDelimiter"
402 let b:InPHPcode_tofind = ""
404 if synname =~# "^phpComment"
405 let b:UserIsTypingComment = 1
407 let b:UserIsTypingComment = 0
410 if synname =~? '^javaScript'
411 let b:InPHPcode_and_script = 1
416 let b:UserIsTypingComment = 0
418 let lnum = v:lnum - 1
419 while getline(lnum) !~? '<<<''\=\a\w*''\=$' && lnum > 1
423 let b:InPHPcode_tofind = substitute( getline(lnum), '^.*<<<''\=\(\a\w*\)''\=$', '^\\s*\1;\\=$', '')
427 let b:UserIsTypingComment = 0
428 let b:InPHPcode_tofind = '<?\%(.*?>\)\@!\|<script.*>'
430 endif "!b:InPHPcode_checked }}}
433 " Test if we are indenting PHP code {{{
434 let lnum = prevnonblank(v:lnum - 1)
435 let last_line = getline(lnum)
437 if b:InPHPcode_tofind!=""
438 if cline =~? b:InPHPcode_tofind
440 let b:InPHPcode_tofind = ""
441 let b:UserIsTypingComment = 0
443 call cursor(v:lnum, 1)
445 call search('\*/', 'W')
447 let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
449 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
451 let b:PHP_LastIndentedWasComment = 0
453 if cline =~ '^\s*\*/'
454 return indent(lnum) + 1
459 elseif cline =~? '<script\>'
460 let b:InPHPcode_and_script = 1
461 let b:GetLastRealCodeLNum_ADD = v:lnum
468 if !b:InPHPcode_and_script && last_line =~ '\%(<?.*\)\@<!?>\%(.*<?\)\@!' && IslinePHP(lnum, '?>')=~"Delimiter"
469 if cline !~? s:PHP_startindenttag
471 let b:InPHPcode_tofind = s:PHP_startindenttag
472 elseif cline =~? '<script\>'
473 let b:InPHPcode_and_script = 1
476 elseif last_line =~? '<<<''\=\a\w*''\=$'
478 let b:InPHPcode_tofind = substitute( last_line, '^.*<<<''\=\(\a\w*\)''\=$', '^\\s*\1;\\=$', '')
480 elseif !UserIsEditing && cline =~ '^\s*/\*\%(.*\*/\)\@!' && getline(v:lnum + 1) !~ '^\s*\*'
482 let b:InPHPcode_tofind = '\*/'
484 elseif cline =~? '^\s*</script>'
486 let b:InPHPcode_tofind = s:PHP_startindenttag
491 if !b:InPHPcode && !b:InPHPcode_and_script
495 " Indent successive // or # comment the same way the first is {{{
496 if cline =~ '^\s*\%(//\|#\|/\*.*\*/\s*$\)'
497 if b:PHP_LastIndentedWasComment == 1
498 return indent(real_PHP_lastindented)
500 let b:PHP_LastIndentedWasComment = 1
502 let b:PHP_LastIndentedWasComment = 0
505 " Indent multiline /* comments correctly {{{
507 if b:PHP_InsideMultilineComment || b:UserIsTypingComment
508 if cline =~ '^\s*\*\%(\/\)\@!'
509 if last_line =~ '^\s*/\*'
510 return indent(lnum) + 1
515 let b:PHP_InsideMultilineComment = 0
519 if !b:PHP_InsideMultilineComment && cline =~ '^\s*/\*' && cline !~ '\*/\s*$'
520 if getline(v:lnum + 1) !~ '^\s*\*'
523 let b:PHP_InsideMultilineComment = 1
527 " Things always indented at col 1 (PHP delimiter: <?, ?>, Heredoc end) {{{
528 if cline =~# '^\s*<?' && cline !~ '?>' && b:PHP_outdentphpescape
532 if cline =~ '^\s*?>' && cline !~# '<?' && b:PHP_outdentphpescape
536 if cline =~? '^\s*\a\w*;$\|^\a\w*$' && cline !~? s:notPhpHereDoc
542 let lnum = GetLastRealCodeLNum(v:lnum - 1)
544 let last_line = getline(lnum)
545 let ind = indent(lnum)
546 let endline= s:endline
548 if ind==0 && b:PHP_default_indenting
549 let ind = b:PHP_default_indenting
553 return b:PHP_default_indenting
557 if cline =~ '^\s*}\%(}}\)\@!'
558 let ind = indent(FindOpenBracket(v:lnum))
559 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
563 if cline =~ '^\s*\*/'
564 call cursor(v:lnum, 1)
566 call search('\*/', 'W')
568 let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
570 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
572 if cline =~ '^\s*\*/'
573 return indent(lnum) + 1
580 if last_line =~ '[;}]'.endline && last_line !~ '^)' && last_line !~# s:defaultORcase
581 if ind==b:PHP_default_indenting
582 return b:PHP_default_indenting
583 elseif b:PHP_indentinghuge && ind==b:PHP_CurrentIndentLevel && cline !~# '^\s*\%(else\|\%(case\|default\).*:\|[})];\=\)' && last_line !~# '^\s*\%(\%(}\s*\)\=else\)' && getline(GetLastRealCodeLNum(lnum - 1))=~';'.endline
584 return b:PHP_CurrentIndentLevel
588 let LastLineClosed = 0
590 let terminated = '\%(;\%(\s*?>\)\=\|<<<''\=\a\w*''\=$\|^\s*}\)'.endline
592 let unstated = '\%(^\s*'.s:blockstart.'.*)\|\%(//.*\)\@<!\<e'.'lse\>\)'.endline
594 if ind != b:PHP_default_indenting && cline =~# '^\s*else\%(if\)\=\>'
595 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
596 return indent(FindTheIfOfAnElse(v:lnum, 1))
597 elseif cline =~# s:defaultORcase
598 return FindTheSwitchIndent(v:lnum) + &sw * b:PHP_vintage_case_default_indent
599 elseif cline =~ '^\s*)\=\s*{'
600 let previous_line = last_line
601 let last_line_num = lnum
603 while last_line_num > 1
605 if previous_line =~ '^\s*\%(' . s:blockstart . '\|\%([a-zA-Z]\s*\)*function\)'
607 let ind = indent(last_line_num)
609 if b:PHP_BracesAtCodeLevel
616 let last_line_num = last_line_num - 1
617 let previous_line = getline(last_line_num)
620 elseif last_line =~# unstated && cline !~ '^\s*);\='.endline
624 elseif (ind != b:PHP_default_indenting || last_line =~ '^)' ) && last_line =~ terminated
625 let previous_line = last_line
626 let last_line_num = lnum
627 let LastLineClosed = 1
630 if previous_line =~ '^\s*}'
631 let last_line_num = FindOpenBracket(last_line_num)
633 if getline(last_line_num) =~ '^\s*{'
634 let last_line_num = GetLastRealCodeLNum(last_line_num - 1)
637 let previous_line = getline(last_line_num)
642 if getline(last_line_num) =~# '^\s*else\%(if\)\=\>'
643 let last_line_num = FindTheIfOfAnElse(last_line_num, 0)
648 let last_match = last_line_num
650 let one_ahead_indent = indent(last_line_num)
651 let last_line_num = GetLastRealCodeLNum(last_line_num - 1)
652 let two_ahead_indent = indent(last_line_num)
653 let after_previous_line = previous_line
654 let previous_line = getline(last_line_num)
657 if previous_line =~# s:defaultORcase.'\|{'.endline
661 if after_previous_line=~# '^\s*'.s:blockstart.'.*)'.endline && previous_line =~# '[;}]'.endline
665 if one_ahead_indent == two_ahead_indent || last_line_num < 1
666 if previous_line =~# '\%(;\|^\s*}\)'.endline || last_line_num < 1
673 if indent(last_match) != ind
674 let ind = indent(last_match)
675 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
681 let plinnum = GetLastRealCodeLNum(lnum - 1)
682 let AntepenultimateLine = getline(plinnum)
684 let last_line = substitute(last_line,"\\(//\\|#\\)\\(\\(\\([^\"']*\\([\"']\\)[^\"']*\\5\\)\\+[^\"']*$\\)\\|\\([^\"']*$\\)\\)",'','')
687 if ind == b:PHP_default_indenting
688 if last_line =~ terminated
689 let LastLineClosed = 1
696 if last_line =~# '[{(]'.endline || last_line =~? '\h\w*\s*(.*,$' && AntepenultimateLine !~ '[,(]'.endline
698 if !b:PHP_BracesAtCodeLevel || last_line !~# '^\s*{'
702 if b:PHP_BracesAtCodeLevel || b:PHP_vintage_case_default_indent == 1
703 let b:PHP_CurrentIndentLevel = ind
708 elseif last_line =~ '\S\+\s*),'.endline
710 call search('),'.endline, 'W')
711 let openedparent = searchpair('(', '', ')', 'bW', 'Skippmatch()')
712 if openedparent != lnum
713 let ind = indent(openedparent)
716 elseif last_line =~ '^\s*'.s:blockstart
721 elseif AntepenultimateLine =~ '\%(;\%(\s*?>\)\=\|<<<''\=\a\w*''\=$\|^\s*}\|{\)'.endline . '\|' . s:defaultORcase
727 if cline =~ '^\s*);\='
731 let b:PHP_CurrentIndentLevel = ind