blob: e85174e7b0c9145243ce04943e7a1bbe51713ca2 [file] [log] [blame]
Bram Moolenaar0c5fa7d2012-10-05 22:26:30 +02001" Vim syntax file
Aliaksei Budavei40524742024-04-14 19:57:00 +03002" Language: Java
3" Maintainer: Aliaksei Budavei <0x000c70 AT gmail DOT com>
4" Former Maintainer: Claudio Fleiner <claudio@fleiner.com>
5" Repository: https://github.com/zzzyxwvut/java-vim.git
6" Last Change: 2024 Apr 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00007
8" Please check :help java.vim for comments on some of the options available.
9
Bram Moolenaar89bcfda2016-08-30 23:26:57 +020010" quit when a syntax file was already loaded
Bram Moolenaar071d4272004-06-13 20:20:40 +000011if !exists("main_syntax")
Bram Moolenaar89bcfda2016-08-30 23:26:57 +020012 if exists("b:current_syntax")
Bram Moolenaar071d4272004-06-13 20:20:40 +000013 finish
14 endif
15 " we define it here so that included files can test for it
16 let main_syntax='java'
Bram Moolenaar5c736222010-01-06 20:54:52 +010017 syn region javaFold start="{" end="}" transparent fold
Bram Moolenaar071d4272004-06-13 20:20:40 +000018endif
19
Bram Moolenaar0c5fa7d2012-10-05 22:26:30 +020020let s:cpo_save = &cpo
21set cpo&vim
22
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020023" Admit the ASCII dollar sign to keyword characters (JLS-17, §3.8):
24execute printf('syntax iskeyword %s,$', &l:iskeyword)
25
Bram Moolenaar071d4272004-06-13 20:20:40 +000026" some characters that cannot be in a java program (outside a string)
27syn match javaError "[\\@`]"
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +010028syn match javaError "<<<\|\.\.\|=>\|||=\|&&=\|\*\/"
Bram Moolenaar0c5fa7d2012-10-05 22:26:30 +020029
Bram Moolenaar071d4272004-06-13 20:20:40 +000030" use separate name so that it can be deleted in javacc.vim
31syn match javaError2 "#\|=<"
Bram Moolenaarf37506f2016-08-31 22:22:10 +020032hi def link javaError2 javaError
Bram Moolenaar071d4272004-06-13 20:20:40 +000033
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020034" Keywords (JLS-17, §3.9):
Bram Moolenaar071d4272004-06-13 20:20:40 +000035syn keyword javaExternal native package
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020036syn match javaExternal "\<import\>\%(\s\+static\>\)\="
Bram Moolenaar071d4272004-06-13 20:20:40 +000037syn keyword javaError goto const
38syn keyword javaConditional if else switch
39syn keyword javaRepeat while for do
40syn keyword javaBoolean true false
41syn keyword javaConstant null
42syn keyword javaTypedef this super
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020043syn keyword javaOperator new instanceof
44syn match javaOperator "\<var\>\%(\s*(\)\@!"
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +010045" Since the yield statement, which could take a parenthesised operand,
46" and _qualified_ yield methods get along within the switch block
47" (JLS-17, §3.8), it seems futile to make a region definition for this
48" block; instead look for the _yield_ word alone, and if found,
49" backtrack (arbitrarily) 80 bytes, at most, on the matched line and,
50" if necessary, on the line before that (h: \@<=), trying to match
51" neither a method reference nor a qualified method invocation.
52syn match javaOperator "\%(\%(::\|\.\)[[:space:]\n]*\)\@80<!\<yield\>"
Bram Moolenaar071d4272004-06-13 20:20:40 +000053syn keyword javaType boolean char byte short int long float double
54syn keyword javaType void
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +010055syn keyword javaStatement return
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020056syn keyword javaStorageClass static synchronized transient volatile strictfp serializable
Bram Moolenaar071d4272004-06-13 20:20:40 +000057syn keyword javaExceptions throw try catch finally
58syn keyword javaAssert assert
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020059syn keyword javaMethodDecl throws
60" Differentiate a "MyClass.class" literal from the keyword "class".
Bram Moolenaar071d4272004-06-13 20:20:40 +000061syn match javaTypedef "\.\s*\<class\>"ms=s+1
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020062syn keyword javaClassDecl enum extends implements interface
63syn match javaClassDecl "\<permits\>\%(\s*(\)\@!"
64syn match javaClassDecl "\<record\>\%(\s*(\)\@!"
Bram Moolenaar071d4272004-06-13 20:20:40 +000065syn match javaClassDecl "^class\>"
66syn match javaClassDecl "[^.]\s*\<class\>"ms=s+1
Aliaksei Budavei40524742024-04-14 19:57:00 +030067syn match javaAnnotation "@\%(\K\k*\.\)*\K\k*\>"
Bram Moolenaar00a927d2010-05-14 23:24:24 +020068syn match javaClassDecl "@interface\>"
Bram Moolenaar071d4272004-06-13 20:20:40 +000069syn keyword javaBranch break continue nextgroup=javaUserLabelRef skipwhite
70syn match javaUserLabelRef "\k\+" contained
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000071syn match javaVarArg "\.\.\."
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020072syn keyword javaScopeDecl public protected private
73syn keyword javaConceptKind abstract final
74syn match javaConceptKind "\<non-sealed\>"
75syn match javaConceptKind "\<sealed\>\%(\s*(\)\@!"
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +010076syn match javaConceptKind "\<default\>\%(\s*\%(:\|->\)\)\@!"
Bram Moolenaar071d4272004-06-13 20:20:40 +000077
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020078" Note that a "module-info" file will be recognised with an arbitrary
79" file extension (or no extension at all) so that more than one such
80" declaration for the same Java module can be maintained for modular
81" testing in a project without attendant confusion for IDEs, with the
82" ".java\=" extension used for a production version and an arbitrary
83" extension used for a testing version.
84let s:module_info_cur_buf = fnamemodify(bufname("%"), ":t") =~ '^module-info\%(\.class\>\)\@!'
85lockvar s:module_info_cur_buf
Bram Moolenaar63f32602022-06-09 20:45:54 +010086
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +020087" Java modules (since Java 9, for "module-info.java" file).
88if s:module_info_cur_buf
89 syn keyword javaModuleStorageClass module transitive
90 syn keyword javaModuleStmt open requires exports opens uses provides
91 syn keyword javaModuleExternal to with
92 syn cluster javaTop add=javaModuleStorageClass,javaModuleStmt,javaModuleExternal
Bram Moolenaar91f84f62018-07-29 15:07:52 +020093endif
94
Bram Moolenaar8ada17c2006-01-19 22:16:24 +000095if exists("java_highlight_java_lang_ids")
96 let java_highlight_all=1
97endif
Bram Moolenaar91f84f62018-07-29 15:07:52 +020098if exists("java_highlight_all") || exists("java_highlight_java") || exists("java_highlight_java_lang")
Bram Moolenaar071d4272004-06-13 20:20:40 +000099 " java.lang.*
Bram Moolenaar63f32602022-06-09 20:45:54 +0100100 "
101 " The keywords of javaR_JavaLang, javaC_JavaLang, javaE_JavaLang,
102 " and javaX_JavaLang are sub-grouped according to the Java version
103 " of their introduction, and sub-group keywords (that is, class
104 " names) are arranged in alphabetical order, so that future newer
105 " keywords can be pre-sorted and appended without disturbing
106 " the current keyword placement. The below _match_es follow suit.
107
Aliaksei Budavei63d68c22024-03-26 20:12:05 +0300108 syn keyword javaR_JavaLang ArithmeticException ArrayIndexOutOfBoundsException ArrayStoreException ClassCastException IllegalArgumentException IllegalMonitorStateException IllegalThreadStateException IndexOutOfBoundsException NegativeArraySizeException NullPointerException NumberFormatException RuntimeException SecurityException StringIndexOutOfBoundsException IllegalStateException UnsupportedOperationException EnumConstantNotPresentException TypeNotPresentException IllegalCallerException LayerInstantiationException WrongThreadException MatchException
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000109 syn cluster javaTop add=javaR_JavaLang
110 syn cluster javaClasses add=javaR_JavaLang
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200111 hi def link javaR_JavaLang javaR_Java
Bram Moolenaar63f32602022-06-09 20:45:54 +0100112 " Member enumerations:
113 syn match javaC_JavaLang "\%(\<Thread\.\)\@<=\<State\>"
114 syn match javaC_JavaLang "\%(\<Character\.\)\@<=\<UnicodeScript\>"
115 syn match javaC_JavaLang "\%(\<ProcessBuilder\.Redirect\.\)\@<=\<Type\>"
116 syn match javaC_JavaLang "\%(\<StackWalker\.\)\@<=\<Option\>"
117 syn match javaC_JavaLang "\%(\<System\.Logger\.\)\@<=\<Level\>"
118 " Member classes:
119 syn match javaC_JavaLang "\%(\<Character\.\)\@<=\<Subset\>"
120 syn match javaC_JavaLang "\%(\<Character\.\)\@<=\<UnicodeBlock\>"
121 syn match javaC_JavaLang "\%(\<ProcessBuilder\.\)\@<=\<Redirect\>"
122 syn match javaC_JavaLang "\%(\<ModuleLayer\.\)\@<=\<Controller\>"
123 syn match javaC_JavaLang "\%(\<Runtime\.\)\@<=\<Version\>"
124 syn match javaC_JavaLang "\%(\<System\.\)\@<=\<LoggerFinder\>"
125 syn match javaC_JavaLang "\%(\<Enum\.\)\@<=\<EnumDesc\>"
126 syn keyword javaC_JavaLang Boolean Character Class ClassLoader Compiler Double Float Integer Long Math Number Object Process Runtime SecurityManager String StringBuffer Thread ThreadGroup Byte Short Void InheritableThreadLocal Package RuntimePermission ThreadLocal StrictMath StackTraceElement Enum ProcessBuilder StringBuilder ClassValue Module ModuleLayer StackWalker Record
127 syn match javaC_JavaLang "\<System\>" " See javaDebug.
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +0200128 " As of JDK 21, java.lang.Compiler is no more (deprecated in JDK 9).
Aliaksei Budavei63d68c22024-03-26 20:12:05 +0300129 syn keyword javaLangDeprecated Compiler
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000130 syn cluster javaTop add=javaC_JavaLang
131 syn cluster javaClasses add=javaC_JavaLang
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200132 hi def link javaC_JavaLang javaC_Java
Bram Moolenaar63f32602022-06-09 20:45:54 +0100133 syn keyword javaE_JavaLang AbstractMethodError ClassCircularityError ClassFormatError Error IllegalAccessError IncompatibleClassChangeError InstantiationError InternalError LinkageError NoClassDefFoundError NoSuchFieldError NoSuchMethodError OutOfMemoryError StackOverflowError ThreadDeath UnknownError UnsatisfiedLinkError VerifyError VirtualMachineError ExceptionInInitializerError UnsupportedClassVersionError AssertionError BootstrapMethodError
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000134 syn cluster javaTop add=javaE_JavaLang
135 syn cluster javaClasses add=javaE_JavaLang
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200136 hi def link javaE_JavaLang javaE_Java
Bram Moolenaar63f32602022-06-09 20:45:54 +0100137 syn keyword javaX_JavaLang ClassNotFoundException CloneNotSupportedException Exception IllegalAccessException InstantiationException InterruptedException NoSuchMethodException Throwable NoSuchFieldException ReflectiveOperationException
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000138 syn cluster javaTop add=javaX_JavaLang
139 syn cluster javaClasses add=javaX_JavaLang
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200140 hi def link javaX_JavaLang javaX_Java
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000141
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200142 hi def link javaR_Java javaR_
143 hi def link javaC_Java javaC_
144 hi def link javaE_Java javaE_
145 hi def link javaX_Java javaX_
146 hi def link javaX_ javaExceptions
147 hi def link javaR_ javaExceptions
148 hi def link javaE_ javaExceptions
149 hi def link javaC_ javaConstant
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000150
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151 syn keyword javaLangObject clone equals finalize getClass hashCode
152 syn keyword javaLangObject notify notifyAll toString wait
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200153 hi def link javaLangObject javaConstant
Bram Moolenaar8ada17c2006-01-19 22:16:24 +0000154 syn cluster javaTop add=javaLangObject
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155endif
156
157if filereadable(expand("<sfile>:p:h")."/javaid.vim")
158 source <sfile>:p:h/javaid.vim
159endif
160
161if exists("java_space_errors")
162 if !exists("java_no_trail_space_error")
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200163 syn match javaSpaceError "\s\+$"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 endif
165 if !exists("java_no_tab_space_error")
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200166 syn match javaSpaceError " \+\t"me=e-1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 endif
168endif
169
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +0100170syn match javaUserLabel "^\s*\<\K\k*\>\%(\<default\>\)\@<!\s*:"he=e-1
171syn region javaLabelRegion transparent matchgroup=javaLabel start="\<case\>" matchgroup=NONE end=":\|->" contains=javaLabelCastType,javaLabelNumber,javaCharacter,javaString,javaConstant,@javaClasses,javaLabelDefault,javaLabelVarType,javaLabelWhenClause
172syn region javaLabelRegion transparent matchgroup=javaLabel start="\<default\>\%(\s*\%(:\|->\)\)\@=" matchgroup=NONE end=":\|->" oneline
173" Consider grouped _default_ _case_ labels, i.e.
174" case null, default ->
175" case null: default:
176syn keyword javaLabelDefault contained default
177syn keyword javaLabelVarType contained var
178syn keyword javaLabelCastType contained char byte short int
179" Allow for the contingency of the enclosing region not being able to
180" _keep_ its _end_, e.g. case ':':.
181syn region javaLabelWhenClause contained transparent matchgroup=javaLabel start="\<when\>" matchgroup=NONE end=":"me=e-1 end="->"me=e-2 contains=TOP,javaExternal
182syn match javaLabelNumber contained "\<0\>[lL]\@!"
183syn match javaLabelNumber contained "\<\%(0\%([xX]\x\%(_*\x\)*\|_*\o\%(_*\o\)*\|[bB][01]\%(_*[01]\)*\)\|[1-9]\%(_*\d\)*\)\>[lL]\@!"
184hi def link javaLabelDefault javaLabel
185hi def link javaLabelVarType javaOperator
186hi def link javaLabelNumber javaNumber
187hi def link javaLabelCastType javaType
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188
Bram Moolenaarb6b046b2011-12-30 13:11:27 +0100189" highlighting C++ keywords as errors removed, too many people find it
190" annoying. Was: if !exists("java_allow_cpp_keywords")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
192" The following cluster contains all java groups except the contained ones
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +0100193syn cluster javaTop add=javaExternal,javaError,javaBranch,javaLabelRegion,javaConditional,javaRepeat,javaBoolean,javaConstant,javaTypedef,javaOperator,javaType,javaStatement,javaStorageClass,javaAssert,javaExceptions,javaMethodDecl,javaClassDecl,javaScopeDecl,javaConceptKind,javaError2,javaUserLabel,javaLangObject,javaAnnotation,javaVarArg
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194
195
196" Comments
197syn keyword javaTodo contained TODO FIXME XXX
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300198
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199if exists("java_comment_strings")
200 syn region javaCommentString contained start=+"+ end=+"+ end=+$+ end=+\*/+me=s-1,he=s-1 contains=javaSpecial,javaCommentStar,javaSpecialChar,@Spell
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300201 syn region javaCommentString contained start=+"""[ \t\x0c\r]*$+hs=e+1 end=+"""+he=s-1 contains=javaSpecial,javaCommentStar,javaSpecialChar,@Spell,javaSpecialError,javaTextBlockError
202 syn region javaComment2String contained start=+"+ end=+$\|"+ contains=javaSpecial,javaSpecialChar,@Spell
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203 syn match javaCommentCharacter contained "'\\[^']\{1,6\}'" contains=javaSpecialChar
204 syn match javaCommentCharacter contained "'\\''" contains=javaSpecialChar
205 syn match javaCommentCharacter contained "'[^\\]'"
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300206 syn cluster javaCommentSpecial add=javaCommentString,javaCommentCharacter,javaNumber,javaStrTempl
207 syn cluster javaCommentSpecial2 add=javaComment2String,javaCommentCharacter,javaNumber,javaStrTempl
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208endif
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300209
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300210syn region javaComment matchgroup=javaCommentStart start="/\*" end="\*/" contains=@javaCommentSpecial,javaTodo,javaCommentError,javaSpaceError,@Spell
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200211syn match javaCommentStar contained "^\s*\*[^/]"me=e-1
212syn match javaCommentStar contained "^\s*\*$"
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300213syn match javaLineComment "//.*" contains=@javaCommentSpecial2,javaTodo,javaCommentMarkupTag,javaSpaceError,@Spell
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300214syn match javaCommentMarkupTag contained "@\%(end\|highlight\|link\|replace\|start\)\>" nextgroup=javaCommentMarkupTagAttr,javaSpaceError skipwhite
215syn match javaCommentMarkupTagAttr contained "\<region\>" nextgroup=javaCommentMarkupTagAttr,javaSpaceError skipwhite
216syn region javaCommentMarkupTagAttr contained transparent matchgroup=htmlArg start=/\<\%(re\%(gex\|gion\|placement\)\|substring\|t\%(arget\|ype\)\)\%(\s*=\)\@=/ matchgroup=htmlString end=/\%(=\s*\)\@<=\%("[^"]\+"\|'[^']\+'\|\%([.-]\|\k\)\+\)/ nextgroup=javaCommentMarkupTagAttr,javaSpaceError skipwhite oneline
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300217hi def link javaCommentMarkupTagAttr htmlArg
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200218hi def link javaCommentString javaString
219hi def link javaComment2String javaString
220hi def link javaCommentCharacter javaCharacter
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300221syn match javaCommentError contained "/\*"me=e-1 display
222hi def link javaCommentError javaError
223hi def link javaCommentStart javaComment
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224
225syn cluster javaTop add=javaComment,javaLineComment
226
227if !exists("java_ignore_javadoc") && main_syntax != 'jsp'
228 syntax case ignore
229 " syntax coloring for javadoc comments (HTML)
Bram Moolenaar63f32602022-06-09 20:45:54 +0100230 syntax include @javaHtml syntax/html.vim
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 unlet b:current_syntax
Bram Moolenaar5c736222010-01-06 20:54:52 +0100232 " HTML enables spell checking for all text that is not in a syntax item. This
233 " is wrong for Java (all identifiers would be spell-checked), so it's undone
234 " here.
235 syntax spell default
236
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300237 syn region javaDocComment start="/\*\*" end="\*/" keepend contains=javaCommentTitle,@javaHtml,javaDocTags,javaDocSeeTag,javaDocCodeTag,javaDocSnippetTag,javaTodo,javaCommentError,javaSpaceError,@Spell
238 syn region javaCommentTitle contained matchgroup=javaDocComment start="/\*\*" matchgroup=javaCommentTitle end="\.$" end="\.[ \t\r]\@=" end="\%(^\s*\**\s*\)\@<=@"me=s-2,he=s-1 end="\*/"me=s-1,he=s-1 contains=@javaHtml,javaCommentStar,javaTodo,javaCommentError,javaSpaceError,@Spell,javaDocTags,javaDocSeeTag,javaDocCodeTag,javaDocSnippetTag
239 syn region javaCommentTitle contained matchgroup=javaDocComment start="/\*\*\s*\r\=\n\=\s*\**\s*\%({@return\>\)\@=" matchgroup=javaCommentTitle end="}\%(\s*\.*\)*" contains=@javaHtml,javaCommentStar,javaTodo,javaCommentError,javaSpaceError,@Spell,javaDocTags,javaDocSeeTag,javaDocCodeTag,javaDocSnippetTag
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300240 syn region javaDocTags contained start="{@\%(li\%(teral\|nk\%(plain\)\=\)\|inherit[Dd]oc\|doc[rR]oot\|value\)\>" end="}"
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300241 syn match javaDocTags contained "@\%(param\|exception\|throws\|since\)\s\+\S\+" contains=javaDocParam
242 syn match javaDocParam contained "\s\S\+"
243 syn match javaDocTags contained "@\%(version\|author\|return\|deprecated\|serial\%(Field\|Data\)\=\)\>"
244 syn region javaDocSeeTag contained matchgroup=javaDocTags start="@see\s\+" matchgroup=NONE end="\_."re=e-1 contains=javaDocSeeTagParam
245 syn match javaDocSeeTagParam contained @"\_[^"]\+"\|<a\s\+\_.\{-}</a>\|\%(\k\|\.\)*\%(#\k\+\%((\_[^)]*)\)\=\)\=@ contains=@javaHtml extend
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300246 syn region javaCodeSkipBlock contained transparent start="{\%(@code\>\)\@!" end="}" contains=javaCodeSkipBlock,javaDocCodeTag
247 syn region javaDocCodeTag contained start="{@code\>" end="}" contains=javaDocCodeTag,javaCodeSkipBlock
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300248 syn region javaDocSnippetTagAttr contained transparent matchgroup=htmlArg start=/\<\%(class\|file\|id\|lang\|region\)\%(\s*=\)\@=/ matchgroup=htmlString end=/:$/ end=/\%(=\s*\)\@<=\%("[^"]\+"\|'[^']\+'\|\%([.\\/-]\|\k\)\+\)/ nextgroup=javaDocSnippetTagAttr skipwhite skipnl
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300249 syn region javaSnippetSkipBlock contained transparent start="{\%(@snippet\>\)\@!" end="}" contains=javaSnippetSkipBlock,javaDocSnippetTag,javaCommentMarkupTag
250 syn region javaDocSnippetTag contained start="{@snippet\>" end="}" contains=javaDocSnippetTag,javaSnippetSkipBlock,javaDocSnippetTagAttr,javaCommentMarkupTag
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251 syntax case match
252endif
253
254" match the special comment /**/
255syn match javaComment "/\*\*/"
256
257" Strings and constants
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200258syn match javaSpecialError contained "\\."
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259syn match javaSpecialCharError contained "[^']"
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300260" Escape Sequences (JLS-17, §3.10.7):
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300261syn match javaSpecialChar contained "\\\%(u\x\x\x\x\|[0-3]\o\o\|\o\o\=\|[bstnfr"'\\]\)"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262syn region javaString start=+"+ end=+"+ end=+$+ contains=javaSpecialChar,javaSpecialError,@Spell
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300263syn region javaString start=+"""[ \t\x0c\r]*$+hs=e+1 end=+"""+he=s-1 contains=javaSpecialChar,javaSpecialError,javaTextBlockError,@Spell
264syn match javaTextBlockError +"""\s*"""+
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300265syn region javaStrTemplEmbExp contained matchgroup=javaStrTempl start="\\{" end="}" contains=TOP
266syn region javaStrTempl start=+\%(\.[[:space:]\n]*\)\@<="+ end=+"+ contains=javaStrTemplEmbExp,javaSpecialChar,javaSpecialError,@Spell
267syn region javaStrTempl start=+\%(\.[[:space:]\n]*\)\@<="""[ \t\x0c\r]*$+hs=e+1 end=+"""+he=s-1 contains=javaStrTemplEmbExp,javaSpecialChar,javaSpecialError,javaTextBlockError,@Spell
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300268" The next line is commented out, it can cause a crash for a long line
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300269"syn match javaStringError +"\%([^"\\]\|\\.\)*$+
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270syn match javaCharacter "'[^']*'" contains=javaSpecialChar,javaSpecialCharError
271syn match javaCharacter "'\\''" contains=javaSpecialChar
272syn match javaCharacter "'[^\\]'"
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300273" Integer literals (JLS-17, §3.10.1):
274syn keyword javaNumber 0 0l 0L
275syn match javaNumber "\<\%(0\%([xX]\x\%(_*\x\)*\|_*\o\%(_*\o\)*\|[bB][01]\%(_*[01]\)*\)\|[1-9]\%(_*\d\)*\)[lL]\=\>"
276" Decimal floating-point literals (JLS-17, §3.10.2):
277" Against "\<\d\+\>\.":
278syn match javaNumber "\<\d\%(_*\d\)*\."
279syn match javaNumber "\%(\<\d\%(_*\d\)*\.\%(\d\%(_*\d\)*\)\=\|\.\d\%(_*\d\)*\)\%([eE][-+]\=\d\%(_*\d\)*\)\=[fFdD]\=\>"
280syn match javaNumber "\<\d\%(_*\d\)*[eE][-+]\=\d\%(_*\d\)*[fFdD]\=\>"
281syn match javaNumber "\<\d\%(_*\d\)*\%([eE][-+]\=\d\%(_*\d\)*\)\=[fFdD]\>"
282" Hexadecimal floating-point literals (JLS-17, §3.10.2):
283syn match javaNumber "\<0[xX]\%(\x\%(_*\x\)*\.\=\|\%(\x\%(_*\x\)*\)\=\.\x\%(_*\x\)*\)[pP][-+]\=\d\%(_*\d\)*[fFdD]\=\>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300285" Unicode characters
286syn match javaSpecial "\\u\x\x\x\x"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300288syn cluster javaTop add=javaString,javaStrTempl,javaCharacter,javaNumber,javaSpecial,javaStringError,javaTextBlockError
Bram Moolenaar071d4272004-06-13 20:20:40 +0000289
290if exists("java_highlight_functions")
291 if java_highlight_functions == "indent"
Aliaksei Budavei40524742024-04-14 19:57:00 +0300292 syn match javaFuncDef "^\%(\t\| \%( \{6\}\)\=\)\K\%(\k\|[ .,<>\[\]]\)*([^-+*/]*)" contains=javaScopeDecl,javaConceptKind,javaType,javaStorageClass,@javaClasses,javaAnnotation
293 syn region javaFuncDef start=+^\%(\t\| \%( \{6\}\)\=\)\K\%(\k\|[ .,<>\[\]]\)*([^-+*/]*,\s*+ end=+)+ contains=javaScopeDecl,javaConceptKind,javaType,javaStorageClass,@javaClasses,javaAnnotation
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 else
Aliaksei Budavei40524742024-04-14 19:57:00 +0300295 " This is the "style" variant (:help ft-java-syntax).
296 "
297 " Match arbitrarily indented method and constructor declarations
298 " and some enum constants.
299 "
300 " TODO: Come back to refine and fix the parts of javaFuncDef.
301 " TODO: Request the new regexp engine for [:upper:] and [:lower:].
302 "
303 " XXX: \C\<[^a-z0-9]\k*\> rejects "type", but matches "τύπος".
304 " XXX: \C\<[^A-Z0-9]\k*\> rejects "Method", but matches "Μέθοδος".
305 "
306 " Match: [abstract] [<α, β>] [Τʬ][<γ>][[][]] [μΜ]ʭʭ(/* ... */);
307 syn region javaFuncDef start=+^\s\+\%(\%(public\|protected\|private\|static\|\%(abstract\|default\)\|final\|native\|synchronized\)\s\+\)*\%(<.*>\s\+\)\=\%(\%(void\|boolean\|char\|byte\|short\|int\|long\|float\|double\|\%(\K\k*\.\)*\<[^a-z0-9]\k*\>\)\%(<[^(){}]*>\)\=\%(\[\]\)*\s\+\<[^A-Z0-9]\k*\>\|\<[^a-z0-9]\k*\>\)\s*(+ end=+)+ contains=javaScopeDecl,javaConceptKind,javaType,javaStorageClass,javaComment,javaLineComment,@javaClasses,javaAnnotation
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 endif
Aliaksei Budavei40524742024-04-14 19:57:00 +0300309
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +0100310 syn match javaLambdaDef "\<\K\k*\>\%(\<default\>\)\@<!\s*->"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 syn match javaBraces "[{}]"
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +0100312 syn cluster javaTop add=javaFuncDef,javaBraces,javaLambdaDef
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313endif
314
315if exists("java_highlight_debug")
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 " Strings and constants
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300317 syn match javaDebugSpecial contained "\\\%(u\x\x\x\x\|[0-3]\o\o\|\o\o\=\|[bstnfr"'\\]\)"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 syn region javaDebugString contained start=+"+ end=+"+ contains=javaDebugSpecial
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300319 syn region javaDebugString contained start=+"""[ \t\x0c\r]*$+hs=e+1 end=+"""+he=s-1 contains=javaDebugSpecial,javaDebugTextBlockError
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300320 " The highlight groups of java{StrTempl,Debug{,Paren,StrTempl}}\,
321 " share one colour by default. Do not conflate unrelated parens.
322 syn region javaDebugStrTemplEmbExp contained matchgroup=javaDebugStrTempl start="\\{" end="}" contains=javaComment,javaLineComment,javaDebug\%(Paren\)\@!.*
323 syn region javaDebugStrTempl contained start=+\%(\.[[:space:]\n]*\)\@<="+ end=+"+ contains=javaDebugStrTemplEmbExp,javaDebugSpecial
324 syn region javaDebugStrTempl contained start=+\%(\.[[:space:]\n]*\)\@<="""[ \t\x0c\r]*$+hs=e+1 end=+"""+he=s-1 contains=javaDebugStrTemplEmbExp,javaDebugSpecial,javaDebugTextBlockError
325 " The next line is commented out, it can cause a crash for a long line
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300326" syn match javaDebugStringError contained +"\%([^"\\]\|\\.\)*$+
327 syn match javaDebugTextBlockError contained +"""\s*"""+
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 syn match javaDebugCharacter contained "'[^\\]'"
329 syn match javaDebugSpecialCharacter contained "'\\.'"
330 syn match javaDebugSpecialCharacter contained "'\\''"
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300331 syn keyword javaDebugNumber contained 0 0l 0L
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300332 syn match javaDebugNumber contained "\<\d\%(_*\d\)*\."
Aliaksei Budavei100a6652024-03-02 01:11:14 +0300333 syn match javaDebugNumber contained "\<\%(0\%([xX]\x\%(_*\x\)*\|_*\o\%(_*\o\)*\|[bB][01]\%(_*[01]\)*\)\|[1-9]\%(_*\d\)*\)[lL]\=\>"
334 syn match javaDebugNumber contained "\%(\<\d\%(_*\d\)*\.\%(\d\%(_*\d\)*\)\=\|\.\d\%(_*\d\)*\)\%([eE][-+]\=\d\%(_*\d\)*\)\=[fFdD]\=\>"
335 syn match javaDebugNumber contained "\<\d\%(_*\d\)*[eE][-+]\=\d\%(_*\d\)*[fFdD]\=\>"
336 syn match javaDebugNumber contained "\<\d\%(_*\d\)*\%([eE][-+]\=\d\%(_*\d\)*\)\=[fFdD]\>"
337 syn match javaDebugNumber contained "\<0[xX]\%(\x\%(_*\x\)*\.\=\|\%(\x\%(_*\x\)*\)\=\.\x\%(_*\x\)*\)[pP][-+]\=\d\%(_*\d\)*[fFdD]\=\>"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 syn keyword javaDebugBoolean contained true false
339 syn keyword javaDebugType contained null this super
340 syn region javaDebugParen start=+(+ end=+)+ contained contains=javaDebug.*,javaDebugParen
341
Aliaksei Budavei40524742024-04-14 19:57:00 +0300342 " To make this work, define the highlighting for these groups.
343 syn match javaDebug "\<System\.\%(out\|err\)\.print\%(ln\)\=\s*("me=e-1 contains=javaDebug.* nextgroup=javaDebugParen
344" FIXME: What API does "p" belong to?
345" syn match javaDebug "\<p\s*("me=e-1 contains=javaDebug.* nextgroup=javaDebugParen
346 syn match javaDebug "\<\K\k*\.printStackTrace\s*("me=e-1 contains=javaDebug.* nextgroup=javaDebugParen
347" FIXME: What API do "trace*" belong to?
348" syn match javaDebug "\<trace[SL]\=\s*("me=e-1 contains=javaDebug.* nextgroup=javaDebugParen
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349
350 syn cluster javaTop add=javaDebug
351
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200352 hi def link javaDebug Debug
353 hi def link javaDebugString DebugString
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300354 hi def link javaDebugStrTempl Macro
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200355 hi def link javaDebugStringError javaError
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300356 hi def link javaDebugTextBlockError javaDebugStringError
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200357 hi def link javaDebugType DebugType
358 hi def link javaDebugBoolean DebugBoolean
359 hi def link javaDebugNumber Debug
360 hi def link javaDebugSpecial DebugSpecial
361 hi def link javaDebugSpecialCharacter DebugSpecial
362 hi def link javaDebugCharacter DebugString
363 hi def link javaDebugParen Debug
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200365 hi def link DebugString String
366 hi def link DebugSpecial Special
367 hi def link DebugBoolean Boolean
368 hi def link DebugType Type
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369endif
370
371if exists("java_mark_braces_in_parens_as_errors")
372 syn match javaInParen contained "[{}]"
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200373 hi def link javaInParen javaError
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 syn cluster javaTop add=javaInParen
375endif
376
377" catch errors caused by wrong parenthesis
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +0100378syn region javaParenT transparent matchgroup=javaParen start="(" end=")" contains=@javaTop,javaParenT1
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379syn region javaParenT1 transparent matchgroup=javaParen1 start="(" end=")" contains=@javaTop,javaParenT2 contained
380syn region javaParenT2 transparent matchgroup=javaParen2 start="(" end=")" contains=@javaTop,javaParenT contained
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200381syn match javaParenError ")"
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000382" catch errors caused by wrong square parenthesis
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +0100383syn region javaParenT transparent matchgroup=javaParen start="\[" end="\]" contains=@javaTop,javaParenT1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000384syn region javaParenT1 transparent matchgroup=javaParen1 start="\[" end="\]" contains=@javaTop,javaParenT2 contained
385syn region javaParenT2 transparent matchgroup=javaParen2 start="\[" end="\]" contains=@javaTop,javaParenT contained
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200386syn match javaParenError "\]"
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000387
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200388hi def link javaParenError javaError
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +0100390if exists("java_highlight_functions")
Aliaksei Budavei40524742024-04-14 19:57:00 +0300391 " Make ()-matching definitions after the parenthesis error catcher.
392 syn match javaLambdaDef "\k\@4<!(\%(\k\|[[:space:]<>?\[\]@,.]\)*)\s*->"
Bram Moolenaarf3c2afb2015-03-02 23:16:07 +0100393endif
394
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395if !exists("java_minlines")
396 let java_minlines = 10
397endif
Aliaksei Budavei8e59a7b2024-03-25 18:18:28 +0300398
399" Note that variations of a /*/ balanced comment, e.g., /*/*/, /*//*/,
400" /* /*/, /* /*/, etc., may have their rightmost /*/ part accepted
401" as a comment start by ':syntax sync ccomment'; consider alternatives
402" to make synchronisation start further towards file's beginning by
403" bumping up g:java_minlines or issuing ':syntax sync fromstart' or
404" preferring &foldmethod set to 'syntax'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405exec "syn sync ccomment javaComment minlines=" . java_minlines
406
407" The default highlighting.
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200408hi def link javaLambdaDef Function
409hi def link javaFuncDef Function
410hi def link javaVarArg Function
411hi def link javaBraces Function
412hi def link javaBranch Conditional
413hi def link javaUserLabelRef javaUserLabel
414hi def link javaLabel Label
415hi def link javaUserLabel Label
416hi def link javaConditional Conditional
417hi def link javaRepeat Repeat
418hi def link javaExceptions Exception
419hi def link javaAssert Statement
420hi def link javaStorageClass StorageClass
421hi def link javaMethodDecl javaStorageClass
422hi def link javaClassDecl javaStorageClass
423hi def link javaScopeDecl javaStorageClass
Aliaksei Budavei9ecf02c2024-02-28 21:30:22 +0100424hi def link javaConceptKind NonText
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200425
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200426hi def link javaBoolean Boolean
427hi def link javaSpecial Special
428hi def link javaSpecialError Error
429hi def link javaSpecialCharError Error
430hi def link javaString String
Aliaksei Budaveia2c65802024-03-09 20:03:11 +0300431hi def link javaStrTempl Macro
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200432hi def link javaCharacter Character
433hi def link javaSpecialChar SpecialChar
434hi def link javaNumber Number
435hi def link javaError Error
436hi def link javaStringError Error
Aliaksei Budaveib3030b62024-03-03 17:51:01 +0300437hi def link javaTextBlockError javaStringError
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200438hi def link javaStatement Statement
439hi def link javaOperator Operator
440hi def link javaComment Comment
441hi def link javaDocComment Comment
442hi def link javaLineComment Comment
443hi def link javaConstant Constant
444hi def link javaTypedef Typedef
445hi def link javaTodo Todo
446hi def link javaAnnotation PreProc
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200448hi def link javaCommentTitle SpecialComment
449hi def link javaDocTags Special
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300450hi def link javaDocCodeTag Special
451hi def link javaDocSnippetTag Special
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200452hi def link javaDocParam Function
453hi def link javaDocSeeTagParam Function
454hi def link javaCommentStar javaComment
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200456hi def link javaType Type
457hi def link javaExternal Include
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200459hi def link htmlComment Special
460hi def link htmlCommentPart Special
Aliaksei Budavei3e72bf12024-03-22 21:32:48 +0300461hi def link htmlArg Type
462hi def link htmlString String
Bram Moolenaarf37506f2016-08-31 22:22:10 +0200463hi def link javaSpaceError Error
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +0200465if s:module_info_cur_buf
466 hi def link javaModuleStorageClass StorageClass
467 hi def link javaModuleStmt Statement
468 hi def link javaModuleExternal Include
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200469endif
470
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471let b:current_syntax = "java"
472
473if main_syntax == 'java'
474 unlet main_syntax
475endif
476
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +0200477let b:spell_options = "contained"
Bram Moolenaar0c5fa7d2012-10-05 22:26:30 +0200478let &cpo = s:cpo_save
Aliaksei Budavei5ccdcc42024-04-04 21:51:18 +0200479unlet s:module_info_cur_buf s:cpo_save
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480
481" vim: ts=8