1" Vim support file to detect file types in scripts 2" 3" Maintainer: Bram Moolenaar <[email protected]> 4" Last change: 2021 Jan 22 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 114 elseif s:name =~# 'perl' 115 set ft=perl 116 117 " PHP 118 elseif s:name =~# 'php' 119 set ft=php 120 121 " Python 122 elseif s:name =~# 'python' 123 set ft=python 124 125 " Groovy 126 elseif s:name =~# '^groovy\>' 127 set ft=groovy 128 129 " Raku 130 elseif s:name =~# 'raku' 131 set ft=raku 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 " Free Pascal 186 elseif s:name =~# 'instantfpc\>' 187 set ft=pascal 188 189 " Fennel 190 elseif s:name =~# 'fennel\>' 191 set ft=fennel 192 193 " MikroTik RouterOS script 194 elseif s:name =~# 'rsc\>' 195 set ft=routeros 196 197 " Fish shell 198 elseif s:name =~# 'fish\>' 199 set ft=fish 200 201 endif 202 unlet s:name 203 204else 205 " File does not start with "#!". 206 207 let s:line2 = getline(2) 208 let s:line3 = getline(3) 209 let s:line4 = getline(4) 210 let s:line5 = getline(5) 211 212 " Bourne-like shell scripts: sh ksh bash bash2 213 if s:line1 =~# '^:$' 214 call dist#ft#SetFileTypeSH(s:line1) " defined in filetype.vim 215 216 " Z shell scripts 217 elseif s:line1 =~# '^#compdef\>' || s:line1 =~# '^#autoload\>' || 218 \ "\n".s:line1."\n".s:line2."\n".s:line3."\n".s:line4."\n".s:line5 =~# '\n\s*emulate\s\+\%(-[LR]\s\+\)\=[ckz]\=sh\>' 219 set ft=zsh 220 221 " ELM Mail files 222 elseif s:line1 =~# '^From \([a-zA-Z][a-zA-Z_0-9\.=-]*\(@[^ ]*\)\=\|-\) .* \(19\|20\)\d\d$' 223 set ft=mail 224 225 " Mason 226 elseif s:line1 =~# '^<[%&].*>' 227 set ft=mason 228 229 " Vim scripts (must have '" vim' as the first line to trigger this) 230 elseif s:line1 =~# '^" *[vV]im$' 231 set ft=vim 232 233 " libcxx and libstdc++ standard library headers like "iostream" do not have 234 " an extension, recognize the Emacs file mode. 235 elseif s:line1 =~? '-\*-.*C++.*-\*-' 236 set ft=cpp 237 238 " MOO 239 elseif s:line1 =~# '^\*\* LambdaMOO Database, Format Version \%([1-3]\>\)\@!\d\+ \*\*$' 240 set ft=moo 241 242 " Diff file: 243 " - "diff" in first line (context diff) 244 " - "Only in " in first line 245 " - "--- " in first line and "+++ " in second line (unified diff). 246 " - "*** " in first line and "--- " in second line (context diff). 247 " - "# It was generated by makepatch " in the second line (makepatch diff). 248 " - "Index: <filename>" in the first line (CVS file) 249 " - "=== ", line of "=", "---", "+++ " (SVK diff) 250 " - "=== ", "--- ", "+++ " (bzr diff, common case) 251 " - "=== (removed|added|renamed|modified)" (bzr diff, alternative) 252 " - "# HG changeset patch" in first line (Mercurial export format) 253 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\)' 254 \ || (s:line1 =~# '^--- ' && s:line2 =~# '^+++ ') 255 \ || (s:line1 =~# '^\* looking for ' && s:line2 =~# '^\* comparing to ') 256 \ || (s:line1 =~# '^\*\*\* ' && s:line2 =~# '^--- ') 257 \ || (s:line1 =~# '^=== ' && ((s:line2 =~# '^=\{66\}' && s:line3 =~# '^--- ' && s:line4 =~# '^+++') || (s:line2 =~# '^--- ' && s:line3 =~# '^+++ '))) 258 \ || (s:line1 =~# '^=== \(removed\|added\|renamed\|modified\)') 259 set ft=diff 260 261 " PostScript Files (must have %!PS as the first line, like a2ps output) 262 elseif s:line1 =~# '^%![ \t]*PS' 263 set ft=postscr 264 265 " M4 scripts: Guess there is a line that starts with "dnl". 266 elseif s:line1 =~# '^\s*dnl\>' 267 \ || s:line2 =~# '^\s*dnl\>' 268 \ || s:line3 =~# '^\s*dnl\>' 269 \ || s:line4 =~# '^\s*dnl\>' 270 \ || s:line5 =~# '^\s*dnl\>' 271 set ft=m4 272 273 " AmigaDos scripts 274 elseif $TERM == "amiga" 275 \ && (s:line1 =~# "^;" || s:line1 =~? '^\.bra') 276 set ft=amiga 277 278 " SiCAD scripts (must have procn or procd as the first line to trigger this) 279 elseif s:line1 =~? '^ *proc[nd] *$' 280 set ft=sicad 281 282 " Purify log files start with "**** Purify" 283 elseif s:line1 =~# '^\*\*\*\* Purify' 284 set ft=purifylog 285 286 " XML 287 elseif s:line1 =~# '<?\s*xml.*?>' 288 set ft=xml 289 290 " XHTML (e.g.: PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN") 291 elseif s:line1 =~# '\<DTD\s\+XHTML\s' 292 set ft=xhtml 293 294 " HTML (e.g.: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN") 295 " Avoid "doctype html", used by slim. 296 elseif s:line1 =~? '<!DOCTYPE\s\+html\>' 297 set ft=html 298 299 " PDF 300 elseif s:line1 =~# '^%PDF-' 301 set ft=pdf 302 303 " XXD output 304 elseif s:line1 =~# '^\x\{7}: \x\{2} \=\x\{2} \=\x\{2} \=\x\{2} ' 305 set ft=xxd 306 307 " RCS/CVS log output 308 elseif s:line1 =~# '^RCS file:' || s:line2 =~# '^RCS file:' 309 set ft=rcslog 310 311 " CVS commit 312 elseif s:line2 =~# '^CVS:' || getline("$") =~# '^CVS: ' 313 set ft=cvs 314 315 " Prescribe 316 elseif s:line1 =~# '^!R!' 317 set ft=prescribe 318 319 " Send-pr 320 elseif s:line1 =~# '^SEND-PR:' 321 set ft=sendpr 322 323 " SNNS files 324 elseif s:line1 =~# '^SNNS network definition file' 325 set ft=snnsnet 326 elseif s:line1 =~# '^SNNS pattern definition file' 327 set ft=snnspat 328 elseif s:line1 =~# '^SNNS result file' 329 set ft=snnsres 330 331 " Virata 332 elseif s:line1 =~# '^%.\{-}[Vv]irata' 333 \ || s:line2 =~# '^%.\{-}[Vv]irata' 334 \ || s:line3 =~# '^%.\{-}[Vv]irata' 335 \ || s:line4 =~# '^%.\{-}[Vv]irata' 336 \ || s:line5 =~# '^%.\{-}[Vv]irata' 337 set ft=virata 338 339 " Strace 340 elseif s:line1 =~# '[0-9:.]* *execve(' || s:line1 =~# '^__libc_start_main' 341 set ft=strace 342 343 " VSE JCL 344 elseif s:line1 =~# '^\* $$ JOB\>' || s:line1 =~# '^// *JOB\>' 345 set ft=vsejcl 346 347 " TAK and SINDA 348 elseif s:line4 =~# 'K & K Associates' || s:line2 =~# 'TAK 2000' 349 set ft=takout 350 elseif s:line3 =~# 'S Y S T E M S I M P R O V E D ' 351 set ft=sindaout 352 elseif getline(6) =~# 'Run Date: ' 353 set ft=takcmp 354 elseif getline(9) =~# 'Node File 1' 355 set ft=sindacmp 356 357 " DNS zone files 358 elseif s:line1.s:line2.s:line3.s:line4 =~# '^; <<>> DiG [0-9.]\+.* <<>>\|$ORIGIN\|$TTL\|IN\s\+SOA' 359 set ft=bindzone 360 361 " BAAN 362 elseif s:line1 =~# '|\*\{1,80}' && s:line2 =~# 'VRC ' 363 \ || s:line2 =~# '|\*\{1,80}' && s:line3 =~# 'VRC ' 364 set ft=baan 365 366 " Valgrind 367 elseif s:line1 =~# '^==\d\+== valgrind' || s:line3 =~# '^==\d\+== Using valgrind' 368 set ft=valgrind 369 370 " Go docs 371 elseif s:line1 =~# '^PACKAGE DOCUMENTATION$' 372 set ft=godoc 373 374 " Renderman Interface Bytestream 375 elseif s:line1 =~# '^##RenderMan' 376 set ft=rib 377 378 " Scheme scripts 379 elseif s:line1 =~# 'exec\s\+\S*scheme' || s:line2 =~# 'exec\s\+\S*scheme' 380 set ft=scheme 381 382 " Git output 383 elseif s:line1 =~# '^\(commit\|tree\|object\) \x\{40\}\>\|^tag \S\+$' 384 set ft=git 385 386 " Gprof (gnu profiler) 387 elseif s:line1 == 'Flat profile:' 388 \ && s:line2 == '' 389 \ && s:line3 =~# '^Each sample counts as .* seconds.$' 390 set ft=gprof 391 392 " Erlang terms 393 " (See also: http://www.gnu.org/software/emacs/manual/html_node/emacs/Choosing-Modes.html#Choosing-Modes) 394 elseif s:line1 =~? '-\*-.*erlang.*-\*-' 395 set ft=erlang 396 397 " YAML 398 elseif s:line1 =~# '^%YAML' 399 set ft=yaml 400 401 " MikroTik RouterOS script 402 elseif s:line1 =~# '^#.*by RouterOS.*$' 403 set ft=routeros 404 405 " CVS diff 406 else 407 let s:lnum = 1 408 while getline(s:lnum) =~# "^? " && s:lnum < line("$") 409 let s:lnum += 1 410 endwhile 411 if getline(s:lnum) =~# '^Index:\s\+\f\+$' 412 set ft=diff 413 414 " locale input files: Formal Definitions of Cultural Conventions 415 " filename must be like en_US, fr_FR@euro or en_US.UTF-8 416 elseif expand("%") =~# '\a\a_\a\a\($\|[.@]\)\|i18n$\|POSIX$\|translit_' 417 let s:lnum = 1 418 while s:lnum < 100 && s:lnum < line("$") 419 if getline(s:lnum) =~# '^LC_\(IDENTIFICATION\|CTYPE\|COLLATE\|MONETARY\|NUMERIC\|TIME\|MESSAGES\|PAPER\|TELEPHONE\|MEASUREMENT\|NAME\|ADDRESS\)$' 420 setf fdcc 421 break 422 endif 423 let s:lnum += 1 424 endwhile 425 endif 426 unlet s:lnum 427 428 endif 429 430 unlet s:line2 s:line3 s:line4 s:line5 431 432endif 433 434" Restore 'cpoptions' 435let &cpo = s:cpo_save 436 437unlet s:cpo_save s:line1 438