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