xref: /vim-8.2.3635/runtime/scripts.vim (revision 58a8f170)
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    " Lua
104  elseif s:name =~# 'lua'
105    set ft=lua
106
107    " Perl 6
108  elseif s:name =~# 'perl6'
109    set ft=perl6
110
111    " Perl
112  elseif s:name =~# 'perl'
113    set ft=perl
114
115    " PHP
116  elseif s:name =~# 'php'
117    set ft=php
118
119    " Python
120  elseif s:name =~# 'python'
121    set ft=python
122
123    " Groovy
124  elseif s:name =~# '^groovy\>'
125    set ft=groovy
126
127    " Ruby
128  elseif s:name =~# 'ruby'
129    set ft=ruby
130
131    " JavaScript
132  elseif s:name =~# 'node\(js\)\=\>' || s:name =~# 'rhino\>'
133    set ft=javascript
134
135    " BC calculator
136  elseif s:name =~# '^bc\>'
137    set ft=bc
138
139    " sed
140  elseif s:name =~# 'sed\>'
141    set ft=sed
142
143    " OCaml-scripts
144  elseif s:name =~# 'ocaml'
145    set ft=ocaml
146
147    " Awk scripts
148  elseif s:name =~# 'awk\>'
149    set ft=awk
150
151    " Website MetaLanguage
152  elseif s:name =~# 'wml'
153    set ft=wml
154
155    " Scheme scripts
156  elseif s:name =~# 'scheme'
157    set ft=scheme
158
159    " CFEngine scripts
160  elseif s:name =~# 'cfengine'
161    set ft=cfengine
162
163    " Erlang scripts
164  elseif s:name =~# 'escript'
165    set ft=erlang
166
167    " Haskell
168  elseif s:name =~# 'haskell'
169    set ft=haskell
170
171    " Scala
172  elseif s:name =~# 'scala\>'
173    set ft=scala
174
175  endif
176  unlet s:name
177
178else
179  " File does not start with "#!".
180
181  let s:line2 = getline(2)
182  let s:line3 = getline(3)
183  let s:line4 = getline(4)
184  let s:line5 = getline(5)
185
186  " Bourne-like shell scripts: sh ksh bash bash2
187  if s:line1 =~# '^:$'
188    call dist#ft#SetFileTypeSH(s:line1)	" defined in filetype.vim
189
190    " Z shell scripts
191  elseif s:line1 =~# '^#compdef\>' || s:line1 =~# '^#autoload\>' ||
192        \ "\n".s:line1."\n".s:line2."\n".s:line3."\n".s:line4."\n".s:line5 =~# '\n\s*emulate\s\+\%(-[LR]\s\+\)\=[ckz]\=sh\>'
193    set ft=zsh
194
195  " ELM Mail files
196  elseif s:line1 =~# '^From \([a-zA-Z][a-zA-Z_0-9\.=-]*\(@[^ ]*\)\=\|-\) .* \(19\|20\)\d\d$'
197    set ft=mail
198
199    " Mason
200  elseif s:line1 =~# '^<[%&].*>'
201    set ft=mason
202
203    " Vim scripts (must have '" vim' as the first line to trigger this)
204  elseif s:line1 =~# '^" *[vV]im$'
205    set ft=vim
206
207    " MOO
208  elseif s:line1 =~# '^\*\* LambdaMOO Database, Format Version \%([1-3]\>\)\@!\d\+ \*\*$'
209    set ft=moo
210
211    " Diff file:
212    " - "diff" in first line (context diff)
213    " - "Only in " in first line
214    " - "--- " in first line and "+++ " in second line (unified diff).
215    " - "*** " in first line and "--- " in second line (context diff).
216    " - "# It was generated by makepatch " in the second line (makepatch diff).
217    " - "Index: <filename>" in the first line (CVS file)
218    " - "=== ", line of "=", "---", "+++ " (SVK diff)
219    " - "=== ", "--- ", "+++ " (bzr diff, common case)
220    " - "=== (removed|added|renamed|modified)" (bzr diff, alternative)
221    " - "# HG changeset patch" in first line (Mercurial export format)
222  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\)'
223	\ || (s:line1 =~# '^--- ' && s:line2 =~# '^+++ ')
224	\ || (s:line1 =~# '^\* looking for ' && s:line2 =~# '^\* comparing to ')
225	\ || (s:line1 =~# '^\*\*\* ' && s:line2 =~# '^--- ')
226	\ || (s:line1 =~# '^=== ' && ((s:line2 =~# '^=\{66\}' && s:line3 =~# '^--- ' && s:line4 =~# '^+++') || (s:line2 =~# '^--- ' && s:line3 =~# '^+++ ')))
227	\ || (s:line1 =~# '^=== \(removed\|added\|renamed\|modified\)')
228    set ft=diff
229
230    " PostScript Files (must have %!PS as the first line, like a2ps output)
231  elseif s:line1 =~# '^%![ \t]*PS'
232    set ft=postscr
233
234    " M4 scripts: Guess there is a line that starts with "dnl".
235  elseif s:line1 =~# '^\s*dnl\>'
236	\ || s:line2 =~# '^\s*dnl\>'
237	\ || s:line3 =~# '^\s*dnl\>'
238	\ || s:line4 =~# '^\s*dnl\>'
239	\ || s:line5 =~# '^\s*dnl\>'
240    set ft=m4
241
242    " AmigaDos scripts
243  elseif $TERM == "amiga"
244	\ && (s:line1 =~# "^;" || s:line1 =~? '^\.bra')
245    set ft=amiga
246
247    " SiCAD scripts (must have procn or procd as the first line to trigger this)
248  elseif s:line1 =~? '^ *proc[nd] *$'
249    set ft=sicad
250
251    " Purify log files start with "****  Purify"
252  elseif s:line1 =~# '^\*\*\*\*  Purify'
253    set ft=purifylog
254
255    " XML
256  elseif s:line1 =~# '<?\s*xml.*?>'
257    set ft=xml
258
259    " XHTML (e.g.: PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN")
260  elseif s:line1 =~# '\<DTD\s\+XHTML\s'
261    set ft=xhtml
262
263    " HTML (e.g.: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN")
264    " Avoid "doctype html", used by slim.
265  elseif s:line1 =~? '<!DOCTYPE\s\+html\>'
266    set ft=html
267
268    " PDF
269  elseif s:line1 =~# '^%PDF-'
270    set ft=pdf
271
272    " XXD output
273  elseif s:line1 =~# '^\x\{7}: \x\{2} \=\x\{2} \=\x\{2} \=\x\{2} '
274    set ft=xxd
275
276    " RCS/CVS log output
277  elseif s:line1 =~# '^RCS file:' || s:line2 =~# '^RCS file:'
278    set ft=rcslog
279
280    " CVS commit
281  elseif s:line2 =~# '^CVS:' || getline("$") =~# '^CVS: '
282    set ft=cvs
283
284    " Prescribe
285  elseif s:line1 =~# '^!R!'
286    set ft=prescribe
287
288    " Send-pr
289  elseif s:line1 =~# '^SEND-PR:'
290    set ft=sendpr
291
292    " SNNS files
293  elseif s:line1 =~# '^SNNS network definition file'
294    set ft=snnsnet
295  elseif s:line1 =~# '^SNNS pattern definition file'
296    set ft=snnspat
297  elseif s:line1 =~# '^SNNS result file'
298    set ft=snnsres
299
300    " Virata
301  elseif s:line1 =~# '^%.\{-}[Vv]irata'
302	\ || s:line2 =~# '^%.\{-}[Vv]irata'
303	\ || s:line3 =~# '^%.\{-}[Vv]irata'
304	\ || s:line4 =~# '^%.\{-}[Vv]irata'
305	\ || s:line5 =~# '^%.\{-}[Vv]irata'
306    set ft=virata
307
308    " Strace
309  elseif s:line1 =~# '[0-9:.]* *execve(' || s:line1 =~# '^__libc_start_main'
310    set ft=strace
311
312    " VSE JCL
313  elseif s:line1 =~# '^\* $$ JOB\>' || s:line1 =~# '^// *JOB\>'
314    set ft=vsejcl
315
316    " TAK and SINDA
317  elseif s:line4 =~# 'K & K  Associates' || s:line2 =~# 'TAK 2000'
318    set ft=takout
319  elseif s:line3 =~# 'S Y S T E M S   I M P R O V E D '
320    set ft=sindaout
321  elseif getline(6) =~# 'Run Date: '
322    set ft=takcmp
323  elseif getline(9) =~# 'Node    File  1'
324    set ft=sindacmp
325
326    " DNS zone files
327  elseif s:line1.s:line2.s:line3.s:line4 =~# '^; <<>> DiG [0-9.]\+.* <<>>\|$ORIGIN\|$TTL\|IN\s\+SOA'
328    set ft=bindzone
329
330    " BAAN
331  elseif s:line1 =~# '|\*\{1,80}' && s:line2 =~# 'VRC '
332	\ || s:line2 =~# '|\*\{1,80}' && s:line3 =~# 'VRC '
333    set ft=baan
334
335  " Valgrind
336  elseif s:line1 =~# '^==\d\+== valgrind' || s:line3 =~# '^==\d\+== Using valgrind'
337    set ft=valgrind
338
339  " Go docs
340  elseif s:line1 =~# '^PACKAGE DOCUMENTATION$'
341    set ft=godoc
342
343  " Renderman Interface Bytestream
344  elseif s:line1 =~# '^##RenderMan'
345    set ft=rib
346
347  " Scheme scripts
348  elseif s:line1 =~# 'exec\s\+\S*scheme' || s:line2 =~# 'exec\s\+\S*scheme'
349    set ft=scheme
350
351  " Git output
352  elseif s:line1 =~# '^\(commit\|tree\|object\) \x\{40\}\>\|^tag \S\+$'
353    set ft=git
354
355   " Gprof (gnu profiler)
356   elseif s:line1 == 'Flat profile:'
357     \ && s:line2 == ''
358     \ && s:line3 =~# '^Each sample counts as .* seconds.$'
359     set ft=gprof
360
361  " Erlang terms
362  " (See also: http://www.gnu.org/software/emacs/manual/html_node/emacs/Choosing-Modes.html#Choosing-Modes)
363  elseif s:line1 =~? '-\*-.*erlang.*-\*-'
364    set ft=erlang
365
366  " CVS diff
367  else
368    let s:lnum = 1
369    while getline(s:lnum) =~# "^? " && s:lnum < line("$")
370      let s:lnum += 1
371    endwhile
372    if getline(s:lnum) =~# '^Index:\s\+\f\+$'
373      set ft=diff
374
375      " locale input files: Formal Definitions of Cultural Conventions
376      " filename must be like en_US, fr_FR@euro or en_US.UTF-8
377    elseif expand("%") =~# '\a\a_\a\a\($\|[.@]\)\|i18n$\|POSIX$\|translit_'
378      let s:lnum = 1
379      while s:lnum < 100 && s:lnum < line("$")
380	if getline(s:lnum) =~# '^LC_\(IDENTIFICATION\|CTYPE\|COLLATE\|MONETARY\|NUMERIC\|TIME\|MESSAGES\|PAPER\|TELEPHONE\|MEASUREMENT\|NAME\|ADDRESS\)$'
381	  setf fdcc
382	  break
383	endif
384	let s:lnum += 1
385      endwhile
386    endif
387    unlet s:lnum
388
389  endif
390
391  unlet s:line2 s:line3 s:line4 s:line5
392
393endif
394
395" Restore 'cpoptions'
396let &cpo = s:cpo_save
397
398unlet s:cpo_save s:line1
399