xref: /vim-8.2.3635/runtime/scripts.vim (revision cb03397a)
1" Vim support file to detect file types in scripts
2"
3" Maintainer:	Bram Moolenaar <[email protected]>
4" Last change:	2016 May 21
5
6" This file is called by an autocommand for every file that has just been
7" loaded into a buffer.  It checks if the type of file can be recognized by
8" the file contents.  The autocommand is in $VIMRUNTIME/filetype.vim.
9
10
11" Only do the rest when the FileType autocommand has not been triggered yet.
12if did_filetype()
13  finish
14endif
15
16" Load the user defined scripts file first
17" Only do this when the FileType autocommand has not been triggered yet
18if exists("myscriptsfile") && filereadable(expand(myscriptsfile))
19  execute "source " . myscriptsfile
20  if did_filetype()
21    finish
22  endif
23endif
24
25" Line continuation is used here, remove 'C' from 'cpoptions'
26let s:cpo_save = &cpo
27set cpo&vim
28
29let s:line1 = getline(1)
30
31if s:line1 =~ "^#!"
32  " A script that starts with "#!".
33
34  " Check for a line like "#!/usr/bin/env VAR=val bash".  Turn it into
35  " "#!/usr/bin/bash" to make matching easier.
36  if s:line1 =~ '^#!\s*\S*\<env\s'
37    let s:line1 = substitute(s:line1, '\S\+=\S\+', '', 'g')
38    let s:line1 = substitute(s:line1, '\<env\s\+', '', '')
39  endif
40
41  " Get the program name.
42  " Only accept spaces in PC style paths: "#!c:/program files/perl [args]".
43  " If the word env is used, use the first word after the space:
44  " "#!/usr/bin/env perl [path/args]"
45  " If there is no path use the first word: "#!perl [path/args]".
46  " Otherwise get the last word after a slash: "#!/usr/bin/perl [path/args]".
47  if s:line1 =~ '^#!\s*\a:[/\\]'
48    let s:name = substitute(s:line1, '^#!.*[/\\]\(\i\+\).*', '\1', '')
49  elseif s:line1 =~ '^#!.*\<env\>'
50    let s:name = substitute(s:line1, '^#!.*\<env\>\s\+\(\i\+\).*', '\1', '')
51  elseif s:line1 =~ '^#!\s*[^/\\ ]*\>\([^/\\]\|$\)'
52    let s:name = substitute(s:line1, '^#!\s*\([^/\\ ]*\>\).*', '\1', '')
53  else
54    let s:name = substitute(s:line1, '^#!\s*\S*[/\\]\(\i\+\).*', '\1', '')
55  endif
56
57  " tcl scripts may have #!/bin/sh in the first line and "exec wish" in the
58  " third line.  Suggested by Steven Atkinson.
59  if getline(3) =~ '^exec wish'
60    let s:name = 'wish'
61  endif
62
63  " Bourne-like shell scripts: bash bash2 ksh ksh93 sh
64  if s:name =~ '^\(bash\d*\|\|ksh\d*\|sh\)\>'
65    call SetFileTypeSH(s:line1)	" defined in filetype.vim
66
67    " csh scripts
68  elseif s:name =~ '^csh\>'
69    if exists("g:filetype_csh")
70      call SetFileTypeShell(g:filetype_csh)
71    else
72      call SetFileTypeShell("csh")
73    endif
74
75    " tcsh scripts
76  elseif s:name =~ '^tcsh\>'
77    call SetFileTypeShell("tcsh")
78
79    " Z shell scripts
80  elseif s:name =~ '^zsh\>'
81    set ft=zsh
82
83    " TCL scripts
84  elseif s:name =~ '^\(tclsh\|wish\|expectk\|itclsh\|itkwish\)\>'
85    set ft=tcl
86
87    " Expect scripts
88  elseif s:name =~ '^expect\>'
89    set ft=expect
90
91    " Gnuplot scripts
92  elseif s:name =~ '^gnuplot\>'
93    set ft=gnuplot
94
95    " Makefiles
96  elseif s:name =~ 'make\>'
97    set ft=make
98
99    " Lua
100  elseif s:name =~ 'lua'
101    set ft=lua
102
103    " Perl 6
104  elseif s:name =~ 'perl6'
105    set ft=perl6
106
107    " Perl
108  elseif s:name =~ 'perl'
109    set ft=perl
110
111    " PHP
112  elseif s:name =~ 'php'
113    set ft=php
114
115    " Python
116  elseif s:name =~ 'python'
117    set ft=python
118
119    " Groovy
120  elseif s:name =~ '^groovy\>'
121    set ft=groovy
122
123    " Ruby
124  elseif s:name =~ 'ruby'
125    set ft=ruby
126
127    " BC calculator
128  elseif s:name =~ '^bc\>'
129    set ft=bc
130
131    " sed
132  elseif s:name =~ 'sed\>'
133    set ft=sed
134
135    " OCaml-scripts
136  elseif s:name =~ 'ocaml'
137    set ft=ocaml
138
139    " Awk scripts
140  elseif s:name =~ 'awk\>'
141    set ft=awk
142
143    " Website MetaLanguage
144  elseif s:name =~ 'wml'
145    set ft=wml
146
147    " Scheme scripts
148  elseif s:name =~ 'scheme'
149    set ft=scheme
150
151    " CFEngine scripts
152  elseif s:name =~ 'cfengine'
153    set ft=cfengine
154
155    " Erlang scripts
156  elseif s:name =~ 'escript'
157    set ft=erlang
158
159  endif
160  unlet s:name
161
162else
163  " File does not start with "#!".
164
165  let s:line2 = getline(2)
166  let s:line3 = getline(3)
167  let s:line4 = getline(4)
168  let s:line5 = getline(5)
169
170  " Bourne-like shell scripts: sh ksh bash bash2
171  if s:line1 =~ '^:$'
172    call SetFileTypeSH(s:line1)	" defined in filetype.vim
173
174    " Z shell scripts
175  elseif s:line1 =~ '^#compdef\>' || s:line1 =~ '^#autoload\>' ||
176        \ "\n".s:line1."\n".s:line2."\n".s:line3."\n".s:line4."\n".s:line5 =~ '\n\s*emulate\s\+\%(-[LR]\s\+\)\=[ckz]\=sh\>'
177    set ft=zsh
178
179  " ELM Mail files
180  elseif s:line1 =~ '^From \([a-zA-Z][a-zA-Z_0-9\.=-]*\(@[^ ]*\)\=\|-\) .* \(19\|20\)\d\d$'
181    set ft=mail
182
183    " Mason
184  elseif s:line1 =~ '^<[%&].*>'
185    set ft=mason
186
187    " Vim scripts (must have '" vim' as the first line to trigger this)
188  elseif s:line1 =~ '^" *[vV]im$'
189    set ft=vim
190
191    " MOO
192  elseif s:line1 =~ '^\*\* LambdaMOO Database, Format Version \%([1-3]\>\)\@!\d\+ \*\*$'
193    set ft=moo
194
195    " Diff file:
196    " - "diff" in first line (context diff)
197    " - "Only in " in first line
198    " - "--- " in first line and "+++ " in second line (unified diff).
199    " - "*** " in first line and "--- " in second line (context diff).
200    " - "# It was generated by makepatch " in the second line (makepatch diff).
201    " - "Index: <filename>" in the first line (CVS file)
202    " - "=== ", line of "=", "---", "+++ " (SVK diff)
203    " - "=== ", "--- ", "+++ " (bzr diff, common case)
204    " - "=== (removed|added|renamed|modified)" (bzr diff, alternative)
205    " - "# HG changeset patch" in first line (Mercurial export format)
206  elseif s:line1 =~ '^\(diff\>\|Only in \|\d\+\(,\d\+\)\=[cda]\d\+\>\|# It was generated by makepatch \|Index:\s\+\f\+\r\=$\|===== \f\+ \d\+\.\d\+ vs edited\|==== //\f\+#\d\+\|# HG changeset patch\)'
207	\ || (s:line1 =~ '^--- ' && s:line2 =~ '^+++ ')
208	\ || (s:line1 =~ '^\* looking for ' && s:line2 =~ '^\* comparing to ')
209	\ || (s:line1 =~ '^\*\*\* ' && s:line2 =~ '^--- ')
210	\ || (s:line1 =~ '^=== ' && ((s:line2 =~ '^=\{66\}' && s:line3 =~ '^--- ' && s:line4 =~ '^+++') || (s:line2 =~ '^--- ' && s:line3 =~ '^+++ ')))
211	\ || (s:line1 =~ '^=== \(removed\|added\|renamed\|modified\)')
212    set ft=diff
213
214    " PostScript Files (must have %!PS as the first line, like a2ps output)
215  elseif s:line1 =~ '^%![ \t]*PS'
216    set ft=postscr
217
218    " M4 scripts: Guess there is a line that starts with "dnl".
219  elseif s:line1 =~ '^\s*dnl\>'
220	\ || s:line2 =~ '^\s*dnl\>'
221	\ || s:line3 =~ '^\s*dnl\>'
222	\ || s:line4 =~ '^\s*dnl\>'
223	\ || s:line5 =~ '^\s*dnl\>'
224    set ft=m4
225
226    " AmigaDos scripts
227  elseif $TERM == "amiga"
228	\ && (s:line1 =~ "^;" || s:line1 =~ '^\.[bB][rR][aA]')
229    set ft=amiga
230
231    " SiCAD scripts (must have procn or procd as the first line to trigger this)
232  elseif s:line1 =~? '^ *proc[nd] *$'
233    set ft=sicad
234
235    " Purify log files start with "****  Purify"
236  elseif s:line1 =~ '^\*\*\*\*  Purify'
237    set ft=purifylog
238
239    " XML
240  elseif s:line1 =~ '<?\s*xml.*?>'
241    set ft=xml
242
243    " XHTML (e.g.: PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN")
244  elseif s:line1 =~ '\<DTD\s\+XHTML\s'
245    set ft=xhtml
246
247    " HTML (e.g.: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN")
248    " Avoid "doctype html", used by slim.
249  elseif s:line1 =~? '<!DOCTYPE\s\+html\>'
250    set ft=html
251
252    " PDF
253  elseif s:line1 =~ '^%PDF-'
254    set ft=pdf
255
256    " XXD output
257  elseif s:line1 =~ '^\x\{7}: \x\{2} \=\x\{2} \=\x\{2} \=\x\{2} '
258    set ft=xxd
259
260    " RCS/CVS log output
261  elseif s:line1 =~ '^RCS file:' || s:line2 =~ '^RCS file:'
262    set ft=rcslog
263
264    " CVS commit
265  elseif s:line2 =~ '^CVS:' || getline("$") =~ '^CVS: '
266    set ft=cvs
267
268    " Prescribe
269  elseif s:line1 =~ '^!R!'
270    set ft=prescribe
271
272    " Send-pr
273  elseif s:line1 =~ '^SEND-PR:'
274    set ft=sendpr
275
276    " SNNS files
277  elseif s:line1 =~ '^SNNS network definition file'
278    set ft=snnsnet
279  elseif s:line1 =~ '^SNNS pattern definition file'
280    set ft=snnspat
281  elseif s:line1 =~ '^SNNS result file'
282    set ft=snnsres
283
284    " Virata
285  elseif s:line1 =~ '^%.\{-}[Vv]irata'
286	\ || s:line2 =~ '^%.\{-}[Vv]irata'
287	\ || s:line3 =~ '^%.\{-}[Vv]irata'
288	\ || s:line4 =~ '^%.\{-}[Vv]irata'
289	\ || s:line5 =~ '^%.\{-}[Vv]irata'
290    set ft=virata
291
292    " Strace
293  elseif s:line1 =~ '^\(\[pid \d\+\] \)\=[0-9:.]* *execve(' || s:line1 =~ '^__libc_start_main'
294    set ft=strace
295
296    " VSE JCL
297  elseif s:line1 =~ '^\* $$ JOB\>' || s:line1 =~ '^// *JOB\>'
298    set ft=vsejcl
299
300    " TAK and SINDA
301  elseif s:line4 =~ 'K & K  Associates' || s:line2 =~ 'TAK 2000'
302    set ft=takout
303  elseif s:line3 =~ 'S Y S T E M S   I M P R O V E D '
304    set ft=sindaout
305  elseif getline(6) =~ 'Run Date: '
306    set ft=takcmp
307  elseif getline(9) =~ 'Node    File  1'
308    set ft=sindacmp
309
310    " DNS zone files
311  elseif s:line1.s:line2.s:line3.s:line4 =~ '^; <<>> DiG [0-9.]\+ <<>>\|BIND.*named\|$ORIGIN\|$TTL\|IN\s\+SOA'
312    set ft=bindzone
313
314    " BAAN
315  elseif s:line1 =~ '|\*\{1,80}' && s:line2 =~ 'VRC '
316	\ || s:line2 =~ '|\*\{1,80}' && s:line3 =~ 'VRC '
317    set ft=baan
318
319  " Valgrind
320  elseif s:line1 =~ '^==\d\+== valgrind' || s:line3 =~ '^==\d\+== Using valgrind'
321    set ft=valgrind
322
323  " Go docs
324  elseif s:line1 =~ '^PACKAGE DOCUMENTATION$'
325    set ft=godoc
326
327  " Renderman Interface Bytestream
328  elseif s:line1 =~ '^##RenderMan'
329    set ft=rib
330
331  " Scheme scripts
332  elseif s:line1 =~ 'exec\s\+\S*scheme' || s:line2 =~ 'exec\s\+\S*scheme'
333    set ft=scheme
334
335  " Git output
336  elseif s:line1 =~ '^\(commit\|tree\|object\) \x\{40\}\>\|^tag \S\+$'
337    set ft=git
338
339   " Gprof (gnu profiler)
340   elseif s:line1 == 'Flat profile:'
341     \ && s:line2 == ''
342     \ && s:line3 =~ '^Each sample counts as .* seconds.$'
343     set ft=gprof
344
345  " Erlang terms
346  " (See also: http://www.gnu.org/software/emacs/manual/html_node/emacs/Choosing-Modes.html#Choosing-Modes)
347  elseif s:line1 =~? '-\*-.*erlang.*-\*-'
348    set ft=erlang
349
350  " CVS diff
351  else
352    let s:lnum = 1
353    while getline(s:lnum) =~ "^? " && s:lnum < line("$")
354      let s:lnum += 1
355    endwhile
356    if getline(s:lnum) =~ '^Index:\s\+\f\+$'
357      set ft=diff
358
359      " locale input files: Formal Definitions of Cultural Conventions
360      " filename must be like en_US, fr_FR@euro or en_US.UTF-8
361    elseif expand("%") =~ '\a\a_\a\a\($\|[.@]\)\|i18n$\|POSIX$\|translit_'
362      let s:lnum = 1
363      while s:lnum < 100 && s:lnum < line("$")
364	if getline(s:lnum) =~ '^LC_\(IDENTIFICATION\|CTYPE\|COLLATE\|MONETARY\|NUMERIC\|TIME\|MESSAGES\|PAPER\|TELEPHONE\|MEASUREMENT\|NAME\|ADDRESS\)$'
365	  setf fdcc
366	  break
367	endif
368	let s:lnum += 1
369      endwhile
370    endif
371    unlet s:lnum
372
373  endif
374
375  unlet s:line2 s:line3 s:line4 s:line5
376
377endif
378
379" Restore 'cpoptions'
380let &cpo = s:cpo_save
381
382unlet s:cpo_save s:line1
383