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