xref: /vim-8.2.3635/runtime/indent/fortran.vim (revision ed37d9b3)
1" Vim indent file
2" Language:	Fortran 2008 (and older: Fortran 2003, 95, 90, and 77)
3" Version:	47
4" Last Change:	2020 Apr 20
5" Patched By:	Eisuke Kawashima
6" Maintainer:	Ajit J. Thakkar <[email protected]>; <http://www2.unb.ca/~ajit/>
7" Usage:	For instructions, do :help fortran-indent from Vim
8" Credits:
9"  Useful suggestions were made, in chronological order, by:
10"  Albert Oliver Serra, Takuya Fujiwara and Philipp Edelmann.
11
12" Only load this indent file when no other was loaded.
13if exists("b:did_indent")
14  finish
15endif
16let b:did_indent = 1
17
18let s:cposet=&cpoptions
19set cpoptions&vim
20
21setlocal indentkeys+==~end,=~case,=~if,=~else,=~do,=~where,=~elsewhere,=~select
22setlocal indentkeys+==~endif,=~enddo,=~endwhere,=~endselect,=~elseif
23setlocal indentkeys+==~type,=~interface,=~forall,=~associate,=~block,=~enum
24setlocal indentkeys+==~endforall,=~endassociate,=~endblock,=~endenum
25if exists("b:fortran_indent_more") || exists("g:fortran_indent_more")
26  setlocal indentkeys+==~function,=~subroutine,=~module,=~contains,=~program
27  setlocal indentkeys+==~endfunction,=~endsubroutine,=~endmodule
28  setlocal indentkeys+==~endprogram
29endif
30
31" Determine whether this is a fixed or free format source file
32" if this hasn't been done yet using the priority:
33" buffer-local value
34" > global value
35" > file extension as in Intel ifort, gcc (gfortran), NAG, Pathscale, and Cray compilers
36if !exists("b:fortran_fixed_source")
37  if exists("fortran_free_source")
38    " User guarantees free source form
39    let b:fortran_fixed_source = 0
40  elseif exists("fortran_fixed_source")
41    " User guarantees fixed source form
42    let b:fortran_fixed_source = 1
43  elseif expand("%:e") =~? '^f\%(90\|95\|03\|08\)$'
44    " Free-form file extension defaults as in Intel ifort, gcc(gfortran), NAG, Pathscale, and Cray compilers
45    let b:fortran_fixed_source = 0
46  elseif expand("%:e") =~? '^\%(f\|f77\|for\)$'
47    " Fixed-form file extension defaults
48    let b:fortran_fixed_source = 1
49  else
50    " Modern fortran still allows both fixed and free source form
51    " Assume fixed source form unless signs of free source form
52    " are detected in the first five columns of the first s:lmax lines.
53    " Detection becomes more accurate and time-consuming if more lines
54    " are checked. Increase the limit below if you keep lots of comments at
55    " the very top of each file and you have a fast computer.
56    let s:lmax = 500
57    if ( s:lmax > line("$") )
58      let s:lmax = line("$")
59    endif
60    let b:fortran_fixed_source = 1
61    let s:ln=1
62    while s:ln <= s:lmax
63      let s:test = strpart(getline(s:ln),0,5)
64      if s:test !~ '^[Cc*]' && s:test !~ '^ *[!#]' && s:test =~ '[^ 0-9\t]' && s:test !~ '^[ 0-9]*\t'
65	let b:fortran_fixed_source = 0
66	break
67      endif
68      let s:ln = s:ln + 1
69    endwhile
70  endif
71endif
72
73" Define the appropriate indent function but only once
74if (b:fortran_fixed_source == 1)
75  setlocal indentexpr=FortranGetFixedIndent()
76  if exists("*FortranGetFixedIndent")
77    finish
78  endif
79else
80  setlocal indentexpr=FortranGetFreeIndent()
81  if exists("*FortranGetFreeIndent")
82    finish
83  endif
84endif
85
86function FortranGetIndent(lnum)
87  let ind = indent(a:lnum)
88  let prevline=getline(a:lnum)
89  " Strip tail comment
90  let prevstat=substitute(prevline, '!.*$', '', '')
91  let prev2line=getline(a:lnum-1)
92  let prev2stat=substitute(prev2line, '!.*$', '', '')
93
94  "Indent do loops only if they are all guaranteed to be of do/end do type
95  if exists("b:fortran_do_enddo") || exists("g:fortran_do_enddo")
96    if prevstat =~? '^\s*\(\d\+\s\)\=\s*\(\a\w*\s*:\)\=\s*do\>'
97      let ind = ind + shiftwidth()
98    endif
99    if getline(v:lnum) =~? '^\s*\(\d\+\s\)\=\s*end\s*do\>'
100      let ind = ind - shiftwidth()
101    endif
102  endif
103
104  "Add a shiftwidth to statements following if, else, else if, case, class,
105  "where, else where, forall, type, interface and associate statements
106  if prevstat =~? '^\s*\(case\|class\|else\|else\s*if\|else\s*where\)\>'
107	\ ||prevstat=~? '^\s*\(type\|interface\|associate\|enum\)\>'
108	\ ||prevstat=~?'^\s*\(\d\+\s\)\=\s*\(\a\w*\s*:\)\=\s*\(forall\|where\|block\)\>'
109	\ ||prevstat=~? '^\s*\(\d\+\s\)\=\s*\(\a\w*\s*:\)\=\s*if\>'
110     let ind = ind + shiftwidth()
111    " Remove unwanted indent after logical and arithmetic ifs
112    if prevstat =~? '\<if\>' && prevstat !~? '\<then\>'
113      let ind = ind - shiftwidth()
114    endif
115    " Remove unwanted indent after type( statements
116    if prevstat =~? '^\s*type\s*('
117      let ind = ind - shiftwidth()
118    endif
119  endif
120
121  "Indent program units unless instructed otherwise
122  if !exists("b:fortran_indent_less") && !exists("g:fortran_indent_less")
123    let prefix='\(\(pure\|impure\|elemental\|recursive\)\s\+\)\{,2}'
124    let type='\(\(integer\|real\|double\s\+precision\|complex\|logical'
125          \.'\|character\|type\|class\)\s*\S*\s\+\)\='
126    if prevstat =~? '^\s*\(contains\|submodule\|program\)\>'
127            \ ||prevstat =~? '^\s*'.'module\>\(\s*\procedure\)\@!'
128            \ ||prevstat =~? '^\s*'.prefix.'subroutine\>'
129            \ ||prevstat =~? '^\s*'.prefix.type.'function\>'
130            \ ||prevstat =~? '^\s*'.type.prefix.'function\>'
131      let ind = ind + shiftwidth()
132    endif
133    if getline(v:lnum) =~? '^\s*contains\>'
134          \ ||getline(v:lnum)=~? '^\s*end\s*'
135          \ .'\(function\|subroutine\|module\|submodule\|program\)\>'
136      let ind = ind - shiftwidth()
137    endif
138  endif
139
140  "Subtract a shiftwidth from else, else if, elsewhere, case, class, end if,
141  " end where, end select, end forall, end interface, end associate,
142  " end enum, end type, end block and end type statements
143  if getline(v:lnum) =~? '^\s*\(\d\+\s\)\=\s*'
144        \. '\(else\|else\s*if\|else\s*where\|case\|class\|'
145        \. 'end\s*\(if\|where\|select\|interface\|'
146        \. 'type\|forall\|associate\|enum\|block\)\)\>'
147    let ind = ind - shiftwidth()
148    " Fix indent for case statement immediately after select
149    if prevstat =~? '\<select\s\+\(case\|type\)\>'
150      let ind = ind + shiftwidth()
151    endif
152  endif
153
154  "First continuation line
155  if prevstat =~ '&\s*$' && prev2stat !~ '&\s*$'
156    let ind = ind + shiftwidth()
157  endif
158  "Line after last continuation line
159  if prevstat !~ '&\s*$' && prev2stat =~ '&\s*$' && prevstat !~? '\<then\>'
160    let ind = ind - shiftwidth()
161  endif
162
163  return ind
164endfunction
165
166function FortranGetFreeIndent()
167  "Find the previous non-blank line
168  let lnum = prevnonblank(v:lnum - 1)
169
170  "Use zero indent at the top of the file
171  if lnum == 0
172    return 0
173  endif
174
175  let ind=FortranGetIndent(lnum)
176  return ind
177endfunction
178
179function FortranGetFixedIndent()
180  let currline=getline(v:lnum)
181  "Don't indent comments, continuation lines and labelled lines
182  if strpart(currline,0,6) =~ '[^ \t]'
183    let ind = indent(v:lnum)
184    return ind
185  endif
186
187  "Find the previous line which is not blank, not a comment,
188  "not a continuation line, and does not have a label
189  let lnum = v:lnum - 1
190  while lnum > 0
191    let prevline=getline(lnum)
192    if (prevline =~ "^[C*!]") || (prevline =~ "^\s*$")
193	\ || (strpart(prevline,5,1) !~ "[ 0]")
194      " Skip comments, blank lines and continuation lines
195      let lnum = lnum - 1
196    else
197      let test=strpart(prevline,0,5)
198      if test =~ "[0-9]"
199	" Skip lines with statement numbers
200	let lnum = lnum - 1
201      else
202	break
203      endif
204    endif
205  endwhile
206
207  "First line must begin at column 7
208  if lnum == 0
209    return 6
210  endif
211
212  let ind=FortranGetIndent(lnum)
213  return ind
214endfunction
215
216let &cpoptions=s:cposet
217unlet s:cposet
218
219" vim:sw=2 tw=130
220