xref: /vim-8.2.3635/runtime/indent/perl.vim (revision 2c7f8c57)
1" Vim indent file
2" Language:      Perl 5
3" Maintainer:    vim-perl <[email protected]>
4" Homepage:      https://github.com/vim-perl/vim-perl
5" Bugs/requests: https://github.com/vim-perl/vim-perl/issues
6" Last Change:   2020 Apr 15
7
8" Suggestions and improvements by :
9"   Aaron J. Sherman (use syntax for hints)
10"   Artem Chuprina (play nice with folding)
11
12" TODO things that are not or not properly indented (yet) :
13" - Continued statements
14"     print "foo",
15"       "bar";
16"     print "foo"
17"       if bar();
18" - Multiline regular expressions (m//x)
19" (The following probably needs modifying the perl syntax file)
20" - qw() lists
21" - Heredocs with terminators that don't match \I\i*
22
23" Only load this indent file when no other was loaded.
24if exists("b:did_indent")
25    finish
26endif
27let b:did_indent = 1
28
29" Is syntax highlighting active ?
30let b:indent_use_syntax = has("syntax")
31
32setlocal indentexpr=GetPerlIndent()
33setlocal indentkeys+=0=,0),0],0=or,0=and
34if !b:indent_use_syntax
35    setlocal indentkeys+=0=EO
36endif
37
38let s:cpo_save = &cpo
39set cpo-=C
40
41function! GetPerlIndent()
42
43    " Get the line to be indented
44    let cline = getline(v:lnum)
45
46    " Indent POD markers to column 0
47    if cline =~ '^\s*=\L\@!'
48        return 0
49    endif
50
51    " Get current syntax item at the line's first char
52    let csynid = ''
53    if b:indent_use_syntax
54        let csynid = synIDattr(synID(v:lnum,1,0),"name")
55    endif
56
57    " Don't reindent POD and heredocs
58    if csynid == "perlPOD" || csynid == "perlHereDoc" || csynid =~ "^pod"
59        return indent(v:lnum)
60    endif
61
62    " Indent end-of-heredocs markers to column 0
63    if b:indent_use_syntax
64        " Assumes that an end-of-heredoc marker matches \I\i* to avoid
65        " confusion with other types of strings
66        if csynid == "perlStringStartEnd" && cline =~ '^\I\i*$'
67            return 0
68        endif
69    else
70        " Without syntax hints, assume that end-of-heredocs markers begin with EO
71        if cline =~ '^\s*EO'
72            return 0
73        endif
74    endif
75
76    " Now get the indent of the previous perl line.
77
78    " Find a non-blank line above the current line.
79    let lnum = prevnonblank(v:lnum - 1)
80    " Hit the start of the file, use zero indent.
81    if lnum == 0
82        return 0
83    endif
84    let line = getline(lnum)
85    let ind = indent(lnum)
86    " Skip heredocs, POD, and comments on 1st column
87    if b:indent_use_syntax
88        let skippin = 2
89        while skippin
90            let synid = synIDattr(synID(lnum,1,0),"name")
91            if (synid == "perlStringStartEnd" && line =~ '^\I\i*$')
92                        \ || (skippin != 2 && synid == "perlPOD")
93                        \ || (skippin != 2 && synid == "perlHereDoc")
94                        \ || synid == "perlComment"
95                        \ || synid =~ "^pod"
96                let lnum = prevnonblank(lnum - 1)
97                if lnum == 0
98                    return 0
99                endif
100                let line = getline(lnum)
101                let ind = indent(lnum)
102                let skippin = 1
103            else
104                let skippin = 0
105            endif
106        endwhile
107    else
108        if line =~ "^EO"
109            let lnum = search("<<[\"']\\=EO", "bW")
110            let line = getline(lnum)
111            let ind = indent(lnum)
112        endif
113    endif
114
115    " Indent blocks enclosed by {}, (), or []
116    if b:indent_use_syntax
117        " Find a real opening brace
118        " NOTE: Unlike Perl character classes, we do NOT need to escape the
119        " closing brackets with a backslash.  Doing so just puts a backslash
120        " in the character class and causes sorrow.  Instead, put the closing
121        " bracket as the first character in the class.
122        let braceclass = '[][(){}]'
123        let bracepos = match(line, braceclass, matchend(line, '^\s*[])}]'))
124        while bracepos != -1
125            let synid = synIDattr(synID(lnum, bracepos + 1, 0), "name")
126            " If the brace is highlighted in one of those groups, indent it.
127            " 'perlHereDoc' is here only to handle the case '&foo(<<EOF)'.
128            if synid == ""
129                        \ || synid == "perlMatchStartEnd"
130                        \ || synid == "perlHereDoc"
131                        \ || synid == "perlBraces"
132                        \ || synid == "perlStatementIndirObj"
133                        \ || synid =~ "^perlFiledescStatement"
134                        \ || synid =~ '^perl\(Sub\|Block\|Package\)Fold'
135                let brace = strpart(line, bracepos, 1)
136                if brace == '(' || brace == '{' || brace == '['
137                    let ind = ind + shiftwidth()
138                else
139                    let ind = ind - shiftwidth()
140                endif
141            endif
142            let bracepos = match(line, braceclass, bracepos + 1)
143        endwhile
144        let bracepos = matchend(cline, '^\s*[])}]')
145        if bracepos != -1
146            let synid = synIDattr(synID(v:lnum, bracepos, 0), "name")
147            if synid == ""
148                        \ || synid == "perlMatchStartEnd"
149                        \ || synid == "perlBraces"
150                        \ || synid == "perlStatementIndirObj"
151                        \ || synid =~ '^perl\(Sub\|Block\|Package\)Fold'
152                let ind = ind - shiftwidth()
153            endif
154        endif
155    else
156        if line =~ '[{[(]\s*\(#[^])}]*\)\=$'
157            let ind = ind + shiftwidth()
158        endif
159        if cline =~ '^\s*[])}]'
160            let ind = ind - shiftwidth()
161        endif
162    endif
163
164    " Indent lines that begin with 'or' or 'and'
165    if cline =~ '^\s*\(or\|and\)\>'
166        if line !~ '^\s*\(or\|and\)\>'
167            let ind = ind + shiftwidth()
168        endif
169    elseif line =~ '^\s*\(or\|and\)\>'
170        let ind = ind - shiftwidth()
171    endif
172
173    return ind
174
175endfunction
176
177let &cpo = s:cpo_save
178unlet s:cpo_save
179
180" vim:ts=8:sts=4:sw=4:expandtab:ft=vim
181