Merge branch 'vim-with-runtime' into feat/quickfix-title
[vim_extended.git] / runtime / indent / php.vim
blob9f1a1ed9d3993aeb22535bc67cdf530a1fb2d895
1 " Vim indent file
2 " Language:     PHP
3 " Author:       John Wellesz <John.wellesz (AT) teaser (DOT) fr>
4 " URL:          http://www.2072productions.com/vim/indent/php.vim
5 " Last Change:  2008 November 22nd
6 " Newsletter:   http://www.2072productions.com/?to=php-indent-for-vim-newsletter.php
7 " Version:      1.30
10 "  If you find a bug, please e-mail me at John.wellesz (AT) teaser (DOT) fr
11 "  with an example of code that breaks the algorithm.
14 "       Thanks a lot for using this script.
17 " NOTE: This script must be used with PHP syntax ON and with the php syntax
18 "       script by Lutz Eymers (http://www.isp.de/data/php.vim ) or with the
19 "       script by Peter Hodge (http://www.vim.org/scripts/script.php?script_id=1571 )
20 "       the later is bunbdled by default with Vim 7.
23 "       In the case you have syntax errors in your script such as HereDoc end
24 "       identifiers not at col 1 you'll have to indent your file 2 times (This
25 "       script will automatically put HereDoc end identifiers at col 1 if
26 "       they are followed by a ';').
29 " NOTE: If you are editing files in Unix file format and that (by accident)
30 "       there are '\r' before new lines, this script won't be able to proceed
31 "       correctly and will make many mistakes because it won't be able to match
32 "       '\s*$' correctly.
33 "       So you have to remove those useless characters first with a command like:
35 "       :%s /\r$//g
37 "       or simply 'let' the option PHP_removeCRwhenUnix to 1 and the script will
38 "       silently remove them when VIM load this script (at each bufread).
40 " Options: See :help php-indent for available options.
43 if exists("b:did_indent")
44     finish
45 endif
46 let b:did_indent = 1
49 let php_sync_method = 0
52 if exists("PHP_default_indenting")
53     let b:PHP_default_indenting = PHP_default_indenting * &sw
54 else
55     let b:PHP_default_indenting = 0
56 endif
58 if exists("PHP_BracesAtCodeLevel")
59     let b:PHP_BracesAtCodeLevel = PHP_BracesAtCodeLevel
60 else
61     let b:PHP_BracesAtCodeLevel = 0
62 endif
65 if exists("PHP_autoformatcomment")
66     let b:PHP_autoformatcomment = PHP_autoformatcomment
67 else
68     let b:PHP_autoformatcomment = 1
69 endif
71 if exists("PHP_vintage_case_default_indent")
72     let b:PHP_vintage_case_default_indent = PHP_vintage_case_default_indent
73 else
74     let b:PHP_vintage_case_default_indent = 0
75 endif
79 let b:PHP_lastindented = 0
80 let b:PHP_indentbeforelast = 0
81 let b:PHP_indentinghuge = 0
82 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
83 let b:PHP_LastIndentedWasComment = 0
84 let b:PHP_InsideMultilineComment = 0
85 let b:InPHPcode = 0
86 let b:InPHPcode_checked = 0
87 let b:InPHPcode_and_script = 0
88 let b:InPHPcode_tofind = ""
89 let b:PHP_oldchangetick = b:changedtick
90 let b:UserIsTypingComment = 0
91 let b:optionsset = 0
93 setlocal nosmartindent
94 setlocal noautoindent
95 setlocal nocindent
96 setlocal nolisp
98 setlocal indentexpr=GetPhpIndent()
99 setlocal indentkeys=0{,0},0),:,!^F,o,O,e,*<Return>,=?>,=<?,=*/
103 let s:searchpairflags = 'bWr'
105 if &fileformat == "unix" && exists("PHP_removeCRwhenUnix") && PHP_removeCRwhenUnix
106     silent! %s/\r$//g
107 endif
109 if exists("*GetPhpIndent")
110     call ResetPhpOptions()
111     finish " XXX
112 endif
114 let s:endline= '\s*\%(//.*\|#.*\|/\*.*\*/\s*\)\=$'
115 let s:PHP_startindenttag = '<?\%(.*?>\)\@!\|<script[^>]*>\%(.*<\/script>\)\@!'
116 "setlocal debug=msg " XXX
119 function! GetLastRealCodeLNum(startline) " {{{
121     let lnum = a:startline
123     if b:GetLastRealCodeLNum_ADD && b:GetLastRealCodeLNum_ADD == lnum + 1
124         let lnum = b:GetLastRealCodeLNum_ADD
125     endif
127     let old_lnum = lnum
129     while lnum > 1
130         let lnum = prevnonblank(lnum)
131         let lastline = getline(lnum)
133         if b:InPHPcode_and_script && lastline =~ '?>\s*$'
134             let lnum = lnum - 1
135         elseif lastline =~ '^\s*?>.*<?\%(php\)\=\s*$'
136             let lnum = lnum - 1
137         elseif lastline =~ '^\s*\%(//\|#\|/\*.*\*/\s*$\)'
138             let lnum = lnum - 1
139         elseif lastline =~ '\*/\s*$'
140             call cursor(lnum, 1)
141             if lastline !~ '^\*/'
142                 call search('\*/', 'W')
143             endif
144             let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
146             let lastline = getline(lnum)
147             if lastline =~ '^\s*/\*'
148                 let lnum = lnum - 1
149             else
150                 break
151             endif
154         elseif lastline =~? '\%(//\s*\|?>.*\)\@<!<?\%(php\)\=\s*$\|^\s*<script\>'
156             while lastline !~ '\(<?.*\)\@<!?>' && lnum > 1
157                 let lnum = lnum - 1
158                 let lastline = getline(lnum)
159             endwhile
160             if lastline =~ '^\s*?>'
161                 let lnum = lnum - 1
162             else
163                 break
164             endif
167         elseif lastline =~? '^\a\w*;\=$' && lastline !~? s:notPhpHereDoc " XXX 0607
168             let tofind=substitute( lastline, '\(\a\w*\);\=', '<<<''\\=\1''\\=$', '') " XXX 0607
169             while getline(lnum) !~? tofind && lnum > 1
170                 let lnum = lnum - 1
171             endwhile
172         else
173             break
174         endif
175     endwhile
177     if lnum==1 && getline(lnum)!~ '<?'
178         let lnum=0
179     endif
181     if b:InPHPcode_and_script && !b:InPHPcode
182         let b:InPHPcode_and_script = 0
183     endif
187     return lnum
188 endfunction " }}}
190 function! Skippmatch2()
192     let line = getline(".")
194    if line =~ '\%(".*\)\@<=/\*\%(.*"\)\@=' || line =~ '\%(\%(//\|#\).*\)\@<=/\*'
195        return 1
196    else
197        return 0
198    endif
199 endfun
201 function! Skippmatch()  " {{{
202     let synname = synIDattr(synID(line("."), col("."), 0), "name")
203     if synname == "Delimiter" || synname == "phpRegionDelimiter" || synname =~# "^phpParent" || synname == "phpArrayParens" || synname =~# '^php\%(Block\|Brace\)' || synname == "javaScriptBraces" || synname =~# "^phpComment" && b:UserIsTypingComment
204         return 0
205     else
206         return 1
207     endif
208 endfun " }}}
210 function! FindOpenBracket(lnum) " {{{
211     call cursor(a:lnum, 1)
212     return searchpair('{', '', '}', 'bW', 'Skippmatch()')
213 endfun " }}}
215 function! FindTheIfOfAnElse (lnum, StopAfterFirstPrevElse) " {{{
217     if getline(a:lnum) =~# '^\s*}\s*else\%(if\)\=\>'
218         let beforeelse = a:lnum
219     else
220         let beforeelse = GetLastRealCodeLNum(a:lnum - 1)
221     endif
223     if !s:level
224         let s:iftoskip = 0
225     endif
227     if getline(beforeelse) =~# '^\s*\%(}\s*\)\=else\%(\s*if\)\@!\>'
228         let s:iftoskip = s:iftoskip + 1
229     endif
231     if getline(beforeelse) =~ '^\s*}'
232         let beforeelse = FindOpenBracket(beforeelse)
234         if getline(beforeelse) =~ '^\s*{'
235             let beforeelse = GetLastRealCodeLNum(beforeelse - 1)
236         endif
237     endif
240     if !s:iftoskip && a:StopAfterFirstPrevElse && getline(beforeelse) =~# '^\s*\%([}]\s*\)\=else\%(if\)\=\>'
241         return beforeelse
242     endif
244     if getline(beforeelse) !~# '^\s*if\>' && beforeelse>1 || s:iftoskip && beforeelse>1
246         if  s:iftoskip && getline(beforeelse) =~# '^\s*if\>'
247             let s:iftoskip = s:iftoskip - 1
248         endif
250         let s:level =  s:level + 1
251         let beforeelse = FindTheIfOfAnElse(beforeelse, a:StopAfterFirstPrevElse)
252     endif
254     return beforeelse
256 endfunction " }}}
258 function! IslinePHP (lnum, tofind) " {{{
259     let cline = getline(a:lnum)
261     if a:tofind==""
262         let tofind = "^\\s*[\"']*\\s*\\zs\\S"
263     else
264         let tofind = a:tofind
265     endif
267     let tofind = tofind . '\c'
269     let coltotest = match (cline, tofind) + 1
271     let synname = synIDattr(synID(a:lnum, coltotest, 0), "name")
273     if synname =~ '^php' || synname=="Delimiter" || synname =~? '^javaScript'
274         return synname
275     else
276         return ""
277     endif
278 endfunction " }}}
280 let s:notPhpHereDoc = '\%(break\|return\|continue\|exit\|else\)'
281 let s:blockstart = '\%(\%(\%(}\s*\)\=else\%(\s\+\)\=\)\=if\>\|else\>\|while\>\|switch\>\|for\%(each\)\=\>\|declare\>\|class\>\|interface\>\|abstract\>\|try\>\|catch\>\)'
283 let s:autoresetoptions = 0
284 if ! s:autoresetoptions
285     let s:autoresetoptions = 1
286 endif
288 function! ResetPhpOptions()
289     if ! b:optionsset && &filetype == "php" 
290         if b:PHP_autoformatcomment
292             setlocal comments=s1:/*,mb:*,ex:*/,://,:#
294             setlocal formatoptions-=t
295             setlocal formatoptions+=q
296             setlocal formatoptions+=r
297             setlocal formatoptions+=o
298             setlocal formatoptions+=w
299             setlocal formatoptions+=c
300             setlocal formatoptions+=b
301         endif
302         let b:optionsset = 1
303     endif
304 endfunc
306 call ResetPhpOptions()
308 function! GetPhpIndent()
310     let b:GetLastRealCodeLNum_ADD = 0
312     let UserIsEditing=0
313     if  b:PHP_oldchangetick != b:changedtick
314         let b:PHP_oldchangetick = b:changedtick
315         let UserIsEditing=1
316     endif
318     if b:PHP_default_indenting
319         let b:PHP_default_indenting = g:PHP_default_indenting * &sw
320     endif
322     let cline = getline(v:lnum)
324     if !b:PHP_indentinghuge && b:PHP_lastindented > b:PHP_indentbeforelast
325         if b:PHP_indentbeforelast
326             let b:PHP_indentinghuge = 1
327             echom 'Large indenting detected, speed optimizations engaged (v1.30)'
328         endif
329         let b:PHP_indentbeforelast = b:PHP_lastindented
330     endif
332     if b:InPHPcode_checked && prevnonblank(v:lnum - 1) != b:PHP_lastindented
333         if b:PHP_indentinghuge
334             echom 'Large indenting deactivated'
335             let b:PHP_indentinghuge = 0
336             let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
337         endif
338         let b:PHP_lastindented = v:lnum
339         let b:PHP_LastIndentedWasComment=0
340         let b:PHP_InsideMultilineComment=0
341         let b:PHP_indentbeforelast = 0
343         let b:InPHPcode = 0
344         let b:InPHPcode_checked = 0
345         let b:InPHPcode_and_script = 0
346         let b:InPHPcode_tofind = ""
348     elseif v:lnum > b:PHP_lastindented
349         let real_PHP_lastindented = b:PHP_lastindented
350         let b:PHP_lastindented = v:lnum
351     endif
354     if !b:InPHPcode_checked " {{{ One time check
355         let b:InPHPcode_checked = 1
357         let synname = ""
358         if cline !~ '<?.*?>'
359             let synname = IslinePHP (prevnonblank(v:lnum), "")
360         endif
362         if synname!=""
363             if synname != "phpHereDoc" && synname != "phpHereDocDelimiter"
364                 let b:InPHPcode = 1
365                 let b:InPHPcode_tofind = ""
367                 if synname =~# "^phpComment"
368                     let b:UserIsTypingComment = 1
369                 else
370                     let b:UserIsTypingComment = 0
371                 endif
373                 if synname =~? '^javaScript'
374                     let b:InPHPcode_and_script = 1
375                 endif
377             else
378                 let b:InPHPcode = 0
379                 let b:UserIsTypingComment = 0
381                 let lnum = v:lnum - 1
382                 while getline(lnum) !~? '<<<''\=\a\w*''\=$' && lnum > 1
383                     let lnum = lnum - 1
384                 endwhile
386                 let b:InPHPcode_tofind = substitute( getline(lnum), '^.*<<<''\=\(\a\w*\)''\=$', '^\\s*\1;\\=$', '') " XXX 0607
387             endif
388         else
389             let b:InPHPcode = 0
390             let b:UserIsTypingComment = 0
391             let b:InPHPcode_tofind = '<?\%(.*?>\)\@!\|<script.*>'
392         endif
393     endif "!b:InPHPcode_checked }}}
396     " Test if we are indenting PHP code {{{
397     let lnum = prevnonblank(v:lnum - 1)
398     let last_line = getline(lnum)
400     if b:InPHPcode_tofind!=""
401         if cline =~? b:InPHPcode_tofind
402             let b:InPHPcode = 1
403             let b:InPHPcode_tofind = ""
404             let b:UserIsTypingComment = 0
405             if cline =~ '\*/'
406                 call cursor(v:lnum, 1)
407                 if cline !~ '^\*/'
408                     call search('\*/', 'W')
409                 endif
410                 let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
412                 let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
414                 let b:PHP_LastIndentedWasComment = 0
416                 if cline =~ '^\s*\*/'
417                     return indent(lnum) + 1
418                 else
419                     return indent(lnum)
420                 endif
422             elseif cline =~? '<script\>'
423                 let b:InPHPcode_and_script = 1
424                 let b:GetLastRealCodeLNum_ADD = v:lnum
425             endif
426         endif
427     endif
429     if b:InPHPcode
431         if !b:InPHPcode_and_script && last_line =~ '\%(<?.*\)\@<!?>\%(.*<?\)\@!' && IslinePHP(lnum, '?>')=~"Delimiter"
432             if cline !~? s:PHP_startindenttag
433                 let b:InPHPcode = 0
434                 let b:InPHPcode_tofind = s:PHP_startindenttag
435             elseif cline =~? '<script\>'
436                 let b:InPHPcode_and_script = 1
437             endif
439         elseif last_line =~? '<<<''\=\a\w*''\=$' " XXX 0607
440             let b:InPHPcode = 0
441             let b:InPHPcode_tofind = substitute( last_line, '^.*<<<''\=\(\a\w*\)''\=$', '^\\s*\1;\\=$', '') " XXX 0607
443         elseif !UserIsEditing && cline =~ '^\s*/\*\%(.*\*/\)\@!' && getline(v:lnum + 1) !~ '^\s*\*'
444             let b:InPHPcode = 0
445             let b:InPHPcode_tofind = '\*/'
447         elseif cline =~? '^\s*</script>'
448             let b:InPHPcode = 0
449             let b:InPHPcode_tofind = s:PHP_startindenttag
450         endif
451     endif " }}}
454     if !b:InPHPcode && !b:InPHPcode_and_script
455         return -1
456     endif
458     " Indent successive // or # comment the same way the first is {{{
459     if cline =~ '^\s*\%(//\|#\|/\*.*\*/\s*$\)'
460         if b:PHP_LastIndentedWasComment == 1
461             return indent(real_PHP_lastindented)
462         endif
463         let b:PHP_LastIndentedWasComment = 1
464     else
465         let b:PHP_LastIndentedWasComment = 0
466     endif " }}}
468     " Indent multiline /* comments correctly {{{
470     if b:PHP_InsideMultilineComment || b:UserIsTypingComment
471         if cline =~ '^\s*\*\%(\/\)\@!'
472             if last_line =~ '^\s*/\*'
473                 return indent(lnum) + 1
474             else
475                 return indent(lnum)
476             endif
477         else
478             let b:PHP_InsideMultilineComment = 0
479         endif
480     endif
482     if !b:PHP_InsideMultilineComment && cline =~ '^\s*/\*' && cline !~ '\*/\s*$'
483         if getline(v:lnum + 1) !~ '^\s*\*'
484             return -1
485         endif
486         let b:PHP_InsideMultilineComment = 1
487     endif " }}}
490     " Things always indented at col 1 (PHP delimiter: <?, ?>, Heredoc end) {{{
491     if cline =~# '^\s*<?' && cline !~ '?>'
492         return 0
493     endif
495     if  cline =~ '^\s*?>' && cline !~# '<?'
496         return 0
497     endif
499     if cline =~? '^\s*\a\w*;$\|^\a\w*$' && cline !~? s:notPhpHereDoc " XXX 0607
500         return 0
501     endif " }}}
503     let s:level = 0
505     let lnum = GetLastRealCodeLNum(v:lnum - 1)
507     let last_line = getline(lnum)
508     let ind = indent(lnum)
509     let endline= s:endline
511     if ind==0 && b:PHP_default_indenting
512         let ind = b:PHP_default_indenting
513     endif
515     if lnum == 0
516         return b:PHP_default_indenting
517     endif
520     if cline =~ '^\s*}\%(}}\)\@!'
521         let ind = indent(FindOpenBracket(v:lnum))
522         let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
523         return ind
524     endif
526     if cline =~ '^\s*\*/'
527         call cursor(v:lnum, 1)
528         if cline !~ '^\*/'
529             call search('\*/', 'W')
530         endif
531         let lnum = searchpair('/\*', '', '\*/', s:searchpairflags, 'Skippmatch2()')
533         let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
535         if cline =~ '^\s*\*/'
536             return indent(lnum) + 1
537         else
538             return indent(lnum)
539         endif
540     endif
542     let defaultORcase = '^\s*\%(default\|case\).*:'
544     if last_line =~ '[;}]'.endline && last_line !~ '^)' && last_line !~# defaultORcase " Added && last_line !~ '^)' on 2007-12-30
545         if ind==b:PHP_default_indenting
546             return b:PHP_default_indenting
547         elseif b:PHP_indentinghuge && ind==b:PHP_CurrentIndentLevel && cline !~# '^\s*\%(else\|\%(case\|default\).*:\|[})];\=\)' && last_line !~# '^\s*\%(\%(}\s*\)\=else\)' && getline(GetLastRealCodeLNum(lnum - 1))=~';'.endline
548             return b:PHP_CurrentIndentLevel
549         endif
550     endif
552     let LastLineClosed = 0
554     let terminated = '\%(;\%(\s*?>\)\=\|<<<''\=\a\w*''\=$\|^\s*}\)'.endline " XXX 0607
556     let unstated   = '\%(^\s*'.s:blockstart.'.*)\|\%(//.*\)\@<!\<e'.'lse\>\)'.endline
558     if ind != b:PHP_default_indenting && cline =~# '^\s*else\%(if\)\=\>'
559         let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
560         return indent(FindTheIfOfAnElse(v:lnum, 1))
561     elseif cline =~ '^\s*)\=\s*{'
562         let previous_line = last_line
563         let last_line_num = lnum
565         while last_line_num > 1
567             if previous_line =~ '^\s*\%(' . s:blockstart . '\|\%([a-zA-Z]\s*\)*function\)'
569                 let ind = indent(last_line_num)
571                 if  b:PHP_BracesAtCodeLevel
572                     let ind = ind + &sw
573                 endif
575                 return ind
576             endif
578             let last_line_num = last_line_num - 1
579             let previous_line = getline(last_line_num)
580         endwhile
582     elseif last_line =~# unstated && cline !~ '^\s*);\='.endline
583         let ind = ind + &sw " we indent one level further when the preceding line is not stated
584         return ind
586     elseif (ind != b:PHP_default_indenting || last_line =~ '^)' ) && last_line =~ terminated " Added || last_line =~ '^)' on 2007-12-30 (array indenting [rpblem broke other things)
587         let previous_line = last_line
588         let last_line_num = lnum
589         let LastLineClosed = 1
591         while 1
592             if previous_line =~ '^\s*}'
593                 let last_line_num = FindOpenBracket(last_line_num)
595                 if getline(last_line_num) =~ '^\s*{'
596                     let last_line_num = GetLastRealCodeLNum(last_line_num - 1)
597                 endif
599                 let previous_line = getline(last_line_num)
601                 continue
602             else
604                 if getline(last_line_num) =~# '^\s*else\%(if\)\=\>'
605                     let last_line_num = FindTheIfOfAnElse(last_line_num, 0)
606                     continue
607                 endif
610                 let last_match = last_line_num
612                 let one_ahead_indent = indent(last_line_num)
613                 let last_line_num = GetLastRealCodeLNum(last_line_num - 1)
614                 let two_ahead_indent = indent(last_line_num)
615                 let after_previous_line = previous_line
616                 let previous_line = getline(last_line_num)
619                 if previous_line =~# defaultORcase.'\|{'.endline
620                     break
621                 endif
623                 if after_previous_line=~# '^\s*'.s:blockstart.'.*)'.endline && previous_line =~# '[;}]'.endline
624                     break
625                 endif
627                 if one_ahead_indent == two_ahead_indent || last_line_num < 1
628                     if previous_line =~# '\%(;\|^\s*}\)'.endline || last_line_num < 1
629                         break
630                     endif
631                 endif
632             endif
633         endwhile
635         if indent(last_match) != ind
636             let ind = indent(last_match)
637             let b:PHP_CurrentIndentLevel = b:PHP_default_indenting
639             if cline =~# defaultORcase
640                 let ind = ind - &sw
641             endif
642             return ind
643         endif
644     endif
646     let plinnum = GetLastRealCodeLNum(lnum - 1)
647     let pline = getline(plinnum)
649     let last_line = substitute(last_line,"\\(//\\|#\\)\\(\\(\\([^\"']*\\([\"']\\)[^\"']*\\5\\)\\+[^\"']*$\\)\\|\\([^\"']*$\\)\\)",'','')
652     if ind == b:PHP_default_indenting
653         if last_line =~ terminated
654             let LastLineClosed = 1
655         endif
656     endif
658     if !LastLineClosed
661         if last_line =~# '[{(]'.endline || last_line =~? '\h\w*\s*(.*,$' && pline !~ '[,(]'.endline
663             if !b:PHP_BracesAtCodeLevel || last_line !~# '^\s*{'
664                 let ind = ind + &sw
665             endif
667             if b:PHP_BracesAtCodeLevel || b:PHP_vintage_case_default_indent == 1 || cline !~# defaultORcase
668                 let b:PHP_CurrentIndentLevel = ind
670                 return ind
671             endif
673         elseif last_line =~ '\S\+\s*),'.endline
674             call cursor(lnum, 1)
675             call search('),'.endline, 'W')
676             let openedparent = searchpair('(', '', ')', 'bW', 'Skippmatch()')
677             if openedparent != lnum
678                 let ind = indent(openedparent)
679             endif
680         elseif last_line =~ '^\s*'.s:blockstart
681             let ind = ind + &sw
683         elseif last_line =~# defaultORcase && cline !~# defaultORcase
684             let ind = ind + &sw
687         elseif pline =~ '\%(;\%(\s*?>\)\=\|<<<''\=\a\w*''\=$\|^\s*}\|{\)'.endline . '\|' . defaultORcase && cline !~# defaultORcase
689             let ind = ind + &sw
690         endif
692     endif
694     if cline =~  '^\s*);\='
695         let ind = ind - &sw
696     elseif cline =~# defaultORcase && last_line !~# defaultORcase
697         let ind = ind - &sw
699     endif
701     let b:PHP_CurrentIndentLevel = ind
702     return ind
703 endfunction