blob: b8cbf07bb262509d00d0776db1e8de9b3273245e [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001" Vim syntax file
Bram Moolenaarad3b3662013-05-17 18:14:19 +02002" Language: Erlang (http://www.erlang.org)
3" Maintainer: Csaba Hoch <csaba.hoch@gmail.com>
Bram Moolenaar036986f2017-03-16 17:41:02 +01004" Contributor: Adam Rutkowski <hq@mtod.org>
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02005" Last Update: 2020-May-26
Bram Moolenaar6be7f872012-01-20 21:08:56 +01006" License: Vim license
Bram Moolenaar036986f2017-03-16 17:41:02 +01007" URL: https://github.com/vim-erlang/vim-erlang-runtime
Bram Moolenaar071d4272004-06-13 20:20:40 +00008
Bram Moolenaar203d04d2013-06-06 21:36:40 +02009" Acknowledgements: This script was originally created by Kresimir Marzic [1].
10" The script was then revamped by Csaba Hoch [2]. During the revamp, the new
11" highlighting style and some code was taken from the Erlang syntax script
12" that is part of vimerl [3], created by Oscar Hellström [4] and improved by
13" Ricardo Catalinas Jiménez [5].
14
15" [1]: Kreąimir Marľić (Kresimir Marzic) <kmarzic@fly.srk.fer.hr>
16" [2]: Csaba Hoch <csaba.hoch@gmail.com>
17" [3]: https://github.com/jimenezrick/vimerl
18" [4]: Oscar Hellström <oscar@oscarh.net> (http://oscar.hellstrom.st)
19" [5]: Ricardo Catalinas Jiménez <jimenezrick@gmail.com>
20
Bram Moolenaarad3b3662013-05-17 18:14:19 +020021" Customization:
22"
Bram Moolenaar203d04d2013-06-06 21:36:40 +020023" To use the old highlighting style, add this to your .vimrc:
Bram Moolenaarad3b3662013-05-17 18:14:19 +020024"
Bram Moolenaar203d04d2013-06-06 21:36:40 +020025" let g:erlang_old_style_highlight = 1
Bram Moolenaarad3b3662013-05-17 18:14:19 +020026"
Bram Moolenaar203d04d2013-06-06 21:36:40 +020027" To highlight further module attributes, add them to
28" ~/.vim/after/syntax/erlang.vim:
Bram Moolenaarad3b3662013-05-17 18:14:19 +020029"
Bram Moolenaar203d04d2013-06-06 21:36:40 +020030" syn keyword erlangAttribute myattr1 myattr2 contained
Bram Moolenaarad3b3662013-05-17 18:14:19 +020031
Bram Moolenaar89bcfda2016-08-30 23:26:57 +020032" quit when a syntax file was already loaded
33if exists("b:current_syntax")
Bram Moolenaarad3b3662013-05-17 18:14:19 +020034 finish
Bram Moolenaar071d4272004-06-13 20:20:40 +000035endif
36
Bram Moolenaar9d98fe92013-08-03 18:35:36 +020037let s:cpo_save = &cpo
38set cpo&vim
39
Bram Moolenaarad3b3662013-05-17 18:14:19 +020040" Case sensitive
Bram Moolenaar071d4272004-06-13 20:20:40 +000041syn case match
42
Bram Moolenaar89bcfda2016-08-30 23:26:57 +020043setlocal iskeyword+=$,@-@
Bram Moolenaarad3b3662013-05-17 18:14:19 +020044
45" Comments
Bram Moolenaar203d04d2013-06-06 21:36:40 +020046syn match erlangComment '%.*$' contains=erlangCommentAnnotation,erlangTodo
Bram Moolenaar1d59aa12020-09-19 18:50:13 +020047syn match erlangCommentAnnotation ' \@<=@\%(clear\|docfile\|end\|headerfile\|todo\|TODO\|type\|author\|copyright\|doc\|reference\|see\|since\|title\|version\|deprecated\|hidden\|param\|private\|equiv\|spec\|throws\)' contained
Bram Moolenaar203d04d2013-06-06 21:36:40 +020048syn match erlangCommentAnnotation /`[^']*'/ contained
49syn keyword erlangTodo TODO FIXME XXX contained
Bram Moolenaarad3b3662013-05-17 18:14:19 +020050
51" Numbers (minimum base is 2, maximum is 36.)
Bram Moolenaar203d04d2013-06-06 21:36:40 +020052syn match erlangNumberInteger '\<\d\+\>'
53syn match erlangNumberInteger '\<\%([2-9]\|[12]\d\|3[0-6]\)\+#[[:alnum:]]\+\>'
54syn match erlangNumberFloat '\<\d\+\.\d\+\%([eE][+-]\=\d\+\)\=\>'
Bram Moolenaarad3b3662013-05-17 18:14:19 +020055
56" Strings, atoms, characters
Bram Moolenaar203d04d2013-06-06 21:36:40 +020057syn region erlangString start=/"/ end=/"/ contains=erlangStringModifier
58syn region erlangQuotedAtom start=/'/ end=/'/ contains=erlangQuotedAtomModifier
Bram Moolenaar036986f2017-03-16 17:41:02 +010059syn match erlangStringModifier '\\\%(\o\{1,3}\|x\x\x\|x{\x\+}\|\^.\|.\)\|\~\%([ni~]\|\%(-\=\d\+\|\*\)\=\.\=\%(\*\|\d\+\)\=\%(\..\)\=[tl]*[cfegswpWPBX#bx+]\)' contained
60syn match erlangQuotedAtomModifier '\\\%(\o\{1,3}\|x\x\x\|x{\x\+}\|\^.\|.\)' contained
Bram Moolenaar203d04d2013-06-06 21:36:40 +020061syn match erlangModifier '\$\%([^\\]\|\\\%(\o\{1,3}\|x\x\x\|x{\x\+}\|\^.\|.\)\)'
Bram Moolenaarad3b3662013-05-17 18:14:19 +020062
Bram Moolenaar203d04d2013-06-06 21:36:40 +020063" Operators, separators
Bram Moolenaar036986f2017-03-16 17:41:02 +010064syn match erlangOperator '==\|=:=\|/=\|=/=\|<\|=<\|>\|>=\|=>\|:=\|++\|--\|=\|!\|<-\|+\|-\|\*\|\/'
Bram Moolenaar203d04d2013-06-06 21:36:40 +020065syn keyword erlangOperator div rem or xor bor bxor bsl bsr and band not bnot andalso orelse
66syn match erlangBracket '{\|}\|\[\|]\||\|||'
67syn match erlangPipe '|'
68syn match erlangRightArrow '->'
Bram Moolenaarad3b3662013-05-17 18:14:19 +020069
Bram Moolenaar203d04d2013-06-06 21:36:40 +020070" Atoms, function calls (order is important)
71syn match erlangAtom '\<\l[[:alnum:]_@]*' contains=erlangBoolean
72syn keyword erlangBoolean true false contained
73syn match erlangLocalFuncCall '\<\a[[:alnum:]_@]*\>\%(\%(\s\|\n\|%.*\n\)*(\)\@=' contains=erlangBIF
74syn match erlangLocalFuncRef '\<\a[[:alnum:]_@]*\>\%(\%(\s\|\n\|%.*\n\)*/\)\@='
Bram Moolenaar036986f2017-03-16 17:41:02 +010075syn match erlangGlobalFuncCall '\<\%(\a[[:alnum:]_@]*\%(\s\|\n\|%.*\n\)*\.\%(\s\|\n\|%.*\n\)*\)*\a[[:alnum:]_@]*\%(\s\|\n\|%.*\n\)*:\%(\s\|\n\|%.*\n\)*\a[[:alnum:]_@]*\>\%(\%(\s\|\n\|%.*\n\)*(\)\@=' contains=erlangComment,erlangVariable
76syn match erlangGlobalFuncRef '\<\%(\a[[:alnum:]_@]*\%(\s\|\n\|%.*\n\)*\.\%(\s\|\n\|%.*\n\)*\)*\a[[:alnum:]_@]*\%(\s\|\n\|%.*\n\)*:\%(\s\|\n\|%.*\n\)*\a[[:alnum:]_@]*\>\%(\%(\s\|\n\|%.*\n\)*/\)\@=' contains=erlangComment,erlangVariable
Bram Moolenaarad3b3662013-05-17 18:14:19 +020077
Bram Moolenaar036986f2017-03-16 17:41:02 +010078" Variables, macros, records, maps
Bram Moolenaar203d04d2013-06-06 21:36:40 +020079syn match erlangVariable '\<[A-Z_][[:alnum:]_@]*'
80syn match erlangMacro '??\=[[:alnum:]_@]\+'
81syn match erlangMacro '\%(-define(\)\@<=[[:alnum:]_@]\+'
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +010082syn region erlangQuotedMacro start=/??\=\s*'/ end=/'/ contains=erlangQuotedAtomModifier
Bram Moolenaar036986f2017-03-16 17:41:02 +010083syn match erlangMap '#'
Bram Moolenaar203d04d2013-06-06 21:36:40 +020084syn match erlangRecord '#\s*\l[[:alnum:]_@]*'
Bram Moolenaar036986f2017-03-16 17:41:02 +010085syn region erlangQuotedRecord start=/#\s*'/ end=/'/ contains=erlangQuotedAtomModifier
86
87" Shebang (this line has to be after the ErlangMap)
88syn match erlangShebang '^#!.*'
Bram Moolenaar203d04d2013-06-06 21:36:40 +020089
90" Bitstrings
91syn match erlangBitType '\%(\/\%(\s\|\n\|%.*\n\)*\)\@<=\%(integer\|float\|binary\|bytes\|bitstring\|bits\|binary\|utf8\|utf16\|utf32\|signed\|unsigned\|big\|little\|native\|unit\)\%(\%(\s\|\n\|%.*\n\)*-\%(\s\|\n\|%.*\n\)*\%(integer\|float\|binary\|bytes\|bitstring\|bits\|binary\|utf8\|utf16\|utf32\|signed\|unsigned\|big\|little\|native\|unit\)\)*' contains=erlangComment
Bram Moolenaarad3b3662013-05-17 18:14:19 +020092
93" Constants and Directives
Bram Moolenaar9d98fe92013-08-03 18:35:36 +020094syn match erlangUnknownAttribute '^\s*-\%(\s\|\n\|%.*\n\)*\l[[:alnum:]_@]*' contains=erlangComment
Bram Moolenaar1d59aa12020-09-19 18:50:13 +020095syn match erlangAttribute '^\s*-\%(\s\|\n\|%.*\n\)*\%(behaviou\=r\|compile\|export\(_type\)\=\|file\|import\|module\|author\|copyright\|doc\|vsn\|on_load\|optional_callbacks\)\>' contains=erlangComment
Bram Moolenaar9d98fe92013-08-03 18:35:36 +020096syn match erlangInclude '^\s*-\%(\s\|\n\|%.*\n\)*\%(include\|include_lib\)\>' contains=erlangComment
97syn match erlangRecordDef '^\s*-\%(\s\|\n\|%.*\n\)*record\>' contains=erlangComment
98syn match erlangDefine '^\s*-\%(\s\|\n\|%.*\n\)*\%(define\|undef\)\>' contains=erlangComment
99syn match erlangPreCondit '^\s*-\%(\s\|\n\|%.*\n\)*\%(ifdef\|ifndef\|else\|endif\)\>' contains=erlangComment
100syn match erlangType '^\s*-\%(\s\|\n\|%.*\n\)*\%(spec\|type\|opaque\|callback\)\>' contains=erlangComment
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200101
102" Keywords
Bram Moolenaar036986f2017-03-16 17:41:02 +0100103syn keyword erlangKeyword after begin case catch cond end fun if let of
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200104syn keyword erlangKeyword receive when try
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200105
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200106" Build-in-functions (BIFs)
107syn keyword erlangBIF abs alive apply atom_to_binary atom_to_list contained
108syn keyword erlangBIF binary_part binary_to_atom contained
109syn keyword erlangBIF binary_to_existing_atom binary_to_float contained
110syn keyword erlangBIF binary_to_integer bitstring_to_list contained
111syn keyword erlangBIF binary_to_list binary_to_term bit_size contained
112syn keyword erlangBIF byte_size check_old_code check_process_code contained
113syn keyword erlangBIF concat_binary date delete_module demonitor contained
114syn keyword erlangBIF disconnect_node element erase error exit contained
115syn keyword erlangBIF float float_to_binary float_to_list contained
116syn keyword erlangBIF garbage_collect get get_keys group_leader contained
117syn keyword erlangBIF halt hd integer_to_binary integer_to_list contained
118syn keyword erlangBIF iolist_to_binary iolist_size is_alive contained
119syn keyword erlangBIF is_atom is_binary is_bitstring is_boolean contained
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +0100120syn keyword erlangBIF is_float is_function is_integer is_list is_map is_map_key contained
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200121syn keyword erlangBIF is_number is_pid is_port is_process_alive contained
122syn keyword erlangBIF is_record is_reference is_tuple length link contained
123syn keyword erlangBIF list_to_atom list_to_binary contained
124syn keyword erlangBIF list_to_bitstring list_to_existing_atom contained
125syn keyword erlangBIF list_to_float list_to_integer list_to_pid contained
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +0100126syn keyword erlangBIF list_to_tuple load_module make_ref map_size max contained
127syn keyword erlangBIF min module_loaded monitor monitor_node node contained
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200128syn keyword erlangBIF nodes now open_port pid_to_list port_close contained
129syn keyword erlangBIF port_command port_connect pre_loaded contained
130syn keyword erlangBIF process_flag process_flag process_info contained
131syn keyword erlangBIF process purge_module put register registered contained
132syn keyword erlangBIF round self setelement size spawn spawn_link contained
133syn keyword erlangBIF spawn_monitor spawn_opt split_binary contained
134syn keyword erlangBIF statistics term_to_binary throw time tl contained
135syn keyword erlangBIF trunc tuple_size tuple_to_list unlink contained
136syn keyword erlangBIF unregister whereis contained
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200137
138" Sync at the beginning of functions: if this is not used, multiline string
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200139" are not always recognized, and the indentation script cannot use the
140" "searchpair" (because it would not always skip strings and comments when
141" looking for keywords and opening parens/brackets).
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200142syn sync match erlangSync grouphere NONE "^[a-z]\s*("
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200143let b:erlang_syntax_synced = 1
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200144
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200145" Define the default highlighting. See ":help group-name" for the groups and
146" their colors.
147
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200148let s:old_style = (exists("g:erlang_old_style_highlight") &&
149 \g:erlang_old_style_highlight == 1)
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200150
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200151
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200152" Comments
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200153hi def link erlangComment Comment
154hi def link erlangCommentAnnotation Special
155hi def link erlangTodo Todo
156hi def link erlangShebang Comment
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200157
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200158" Numbers
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200159hi def link erlangNumberInteger Number
160hi def link erlangNumberFloat Float
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200161
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200162" Strings, atoms, characters
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200163hi def link erlangString String
Bram Moolenaar203d04d2013-06-06 21:36:40 +0200164
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200165if s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200166hi def link erlangQuotedAtom Type
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200167else
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200168hi def link erlangQuotedAtom String
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200169endif
170
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200171hi def link erlangStringModifier Special
172hi def link erlangQuotedAtomModifier Special
173hi def link erlangModifier Special
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200174
175" Operators, separators
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200176hi def link erlangOperator Operator
177hi def link erlangRightArrow Operator
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200178if s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200179hi def link erlangBracket Normal
180hi def link erlangPipe Normal
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200181else
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200182hi def link erlangBracket Delimiter
183hi def link erlangPipe Delimiter
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200184endif
185
186" Atoms, functions, variables, macros
187if s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200188hi def link erlangAtom Normal
189hi def link erlangLocalFuncCall Normal
190hi def link erlangLocalFuncRef Normal
191hi def link erlangGlobalFuncCall Function
192hi def link erlangGlobalFuncRef Function
193hi def link erlangVariable Normal
194hi def link erlangMacro Normal
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +0100195hi def link erlangQuotedMacro Normal
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200196hi def link erlangRecord Normal
Bram Moolenaar036986f2017-03-16 17:41:02 +0100197hi def link erlangQuotedRecord Normal
198hi def link erlangMap Normal
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200199else
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200200hi def link erlangAtom String
201hi def link erlangLocalFuncCall Normal
202hi def link erlangLocalFuncRef Normal
203hi def link erlangGlobalFuncCall Normal
204hi def link erlangGlobalFuncRef Normal
205hi def link erlangVariable Identifier
206hi def link erlangMacro Macro
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +0100207hi def link erlangQuotedMacro Macro
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200208hi def link erlangRecord Structure
Bram Moolenaar036986f2017-03-16 17:41:02 +0100209hi def link erlangQuotedRecord Structure
210hi def link erlangMap Structure
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200211endif
212
213" Bitstrings
214if !s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200215hi def link erlangBitType Type
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200216endif
217
218" Constants and Directives
219if s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200220hi def link erlangAttribute Type
221hi def link erlangMacroDef Type
222hi def link erlangUnknownAttribute Normal
223hi def link erlangInclude Type
224hi def link erlangRecordDef Type
225hi def link erlangDefine Type
226hi def link erlangPreCondit Type
227hi def link erlangType Type
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200228else
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200229hi def link erlangAttribute Keyword
230hi def link erlangMacroDef Macro
231hi def link erlangUnknownAttribute Normal
232hi def link erlangInclude Include
233hi def link erlangRecordDef Keyword
234hi def link erlangDefine Define
235hi def link erlangPreCondit PreCondit
236hi def link erlangType Type
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200237endif
238
239" Keywords
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200240hi def link erlangKeyword Keyword
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200241
242" Build-in-functions (BIFs)
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200243hi def link erlangBIF Function
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200244
245if s:old_style
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200246hi def link erlangBoolean Statement
247hi def link erlangExtra Statement
248hi def link erlangSignal Statement
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200249else
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200250hi def link erlangBoolean Boolean
251hi def link erlangExtra Statement
252hi def link erlangSignal Statement
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200253endif
254
Bram Moolenaar89bcfda2016-08-30 23:26:57 +0200255
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200256let b:current_syntax = "erlang"
257
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200258let &cpo = s:cpo_save
259unlet s:cpo_save
260
Bram Moolenaarad3b3662013-05-17 18:14:19 +0200261" vim: sw=2 et