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