basis/xmode/modes/batch.xml

   1 <?xml version="1.0"?>
   2
   3 <!DOCTYPE MODE SYSTEM "xmode.dtd">
   4
   5 <!--
   6         Token types:
   7                 KEYWORD1        Internal shell commands - Fast
   8                 KEYWORD2        DOS-style %1, %%v, %variables%
   9                 KEYWORD3        Common commands arguments and glue keywords
  10                 KEYWORD4        Standard device names (NUL, CON, COM1, etc.)
  11                 FUNCTION        External commands - Slow
  12                 MARKUP          NT-style expanded !variables!
  13                 LITERAL1        Quoted "strings"
  14                 LITERAL2        Echo arguments
  15                 COMMENT1        REM remarks
  16                 COMMENT2        :: or :# Fake labels used as comments
  17                 COMMENT4        %# Fake variables used as comments #%
  18
  19         Known issues:
  20         - The ^ escape character is not detected at all, so some rules fire when they shouldn't.
  21         - The word FOR, used as an argument to another command, will trigger the rule set="FOR".
  22           This usually causes the rest of the line to be mistakenly coloured as INVALID.
  23           Fortunately, this does not happen with (echo For example) because of echo's own rules that prevent this.
  24         - Same phenomenons with the word REM.
  25         - The DO is not always detected when using a complex pipeline within a FOR /f %%f IN ('pipeline') DO ...
  26
  27         To do:
  28         - Find why ESCAPE="^" does not work.
  29         - Find a general way to parse the (command [arguments]) syntax.
  30           This is complicated by the fact that I/O redirections may be present ahead of the command.
  31           So the actual syntax is ([I/O redirection] command [arguments and other I/O redirections])
  32         - Find a way to parse the (IF VALUE1==VALUE2 command) syntax.
  33         - Parse the SET command, and flag as comment the trailing characters it ignores.
  34
  35         2016-12-07 - Jean-Francois Larvoire
  36         Fixed indentation when a comment followed the opening parenthesis.
  37         Avoid detecting arguments containing a : as labels. (Which caused the rest of the line to be flagged as comment)
  38
  39         2016-11-29 - Jean-Francois Larvoire
  40         Added :: and :# and %#...#% comment markers.
  41         Added !variables!.
  42         Added %* argument line variable.
  43         Added %~ qualifiers for %N command-line arguments and %%f loop variables.
  44         Added many new internal and external commands added in XP, Vista, and Windows 7.
  45         Recursively apply %variable% rules within !variable! rules within "string" rules.
  46         Verify the FOR loops syntax, and flag common errors as INVALID. Ex: missing IN or DO.
  47         Added partial support for IF, CALL, ECHO syntaxes.
  48         Added < > X>&Y | & && || ( ) pilelining and sequencing operators.
  49
  50         2003-10-09 - Mirco Bova
  51         Added some new batch commands using win2K help as reference.
  52
  53         2003-02-28 - Alex Jacoby
  54         Minor enhancements.
  55
  56         2001-12-04 - Mirco Bova
  57         this file is based on the original JEdit batch.xml mode.
  58         The main upgrade consisting in adding the standard MS-DOS
  59         commands as keywords and functions:
  60         - keywords =            internal shell commands;
  61         - functions =           standard MS-DOS commands (.exe or .com in DOS or
  62                                                           windows\command directory).
  63 -->
  64
  65 <MODE>
  66         <PROPS>
  67                 <PROPERTY NAME="lineComment" VALUE="rem" />
  68                 <PROPERTY NAME="indentNextLines" VALUE="(^|.*\s+)\(([^()]|\([^()]+\))*$" />
  69                 <PROPERTY NAME="unindentThisLine"  VALUE="^([^()]|\([^()]+\))*\).*$" />
  70                 <PROPERTY NAME="unindentNextLines" VALUE="^([^()]|\([^()]+\))*\).*$" />
  71                 <PROPERTY NAME="electricKeys" VALUE="()" /><!-- Apply the last 3 rules every time () are pressed -->
  72                 <PROPERTY NAME="wordBreakChars" VALUE="()&amp;|&lt;&gt;,;=" /><!-- Unused? -->
  73                 <PROPERTY NAME="noWordSep" VALUE="_.[]{}/\-#$*?" /><!-- Doc says: Word breaks = Any non-alphanumeric not in this list -->
  74         </PROPS>
  75
  76         <RULES IGNORE_CASE="TRUE" NO_WORD_SEP="_.[]{}/\-#$*?" HIGHLIGHT_DIGITS="FALSE">
  77                 <!-- Parenthesis blocks (Used for group piping) -->
  78                 <IMPORT DELEGATE="Parenthesis_blocks"/>
  79
  80                 <!-- Pipelining operators -->
  81                 <IMPORT DELEGATE="Pipeline_operators"/>
  82
  83                 <!-- Anything else has to be a single command -->
  84                 <IMPORT DELEGATE="@Command"/>
  85         </RULES>
  86
  87         <!-- A label, or one command, possibly not echoed, and its arguments -->
  88         <RULES SET="@Command" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
  89                 <!-- Fake :: or :# labels used for remarks. Also protect everything up to the end of line, even & operators -->
  90                 <!-- Must be defined before :labels to be detected -->
  91                 <!-- Do not use AT_WHITESPACE_END="TRUE", because comments can be located after an & operator -->
  92                 <EOL_SPAN_REGEXP TYPE="COMMENT4" AT_WORD_START="TRUE" HASH_CHAR="">\s*:[:#]</EOL_SPAN_REGEXP>
  93
  94                 <!-- :labels. Anything that follows is ignored by the parser, even & operators, and can be used as a comment -->
  95                 <!-- Do use AT_WHITESPACE_END="TRUE", else the rule will fire for arguments containing a : -->
  96                 <EOL_SPAN_REGEXP MATCH_TYPE="LABEL" TYPE="COMMENT4" AT_WHITESPACE_END="TRUE" HASH_CHAR="">(?:.?[,;=\s]*):[^+:,;=\s]+</EOL_SPAN_REGEXP>
  97
  98                 <!-- '@echo off' command prefix -->
  99                 <EOL_SPAN AT_WORD_START="TRUE" TYPE="OPERATOR" DELEGATE="Command">@</EOL_SPAN>
 100
 101                 <!-- <SEQ_REGEXP HASH_CHARS="   " DELEGATE="Command">\s+</SEQ_REGEXP>-->
 102                 <IMPORT DELEGATE="Command"/>
 103         </RULES>
 104
 105         <!-- One command and its arguments -->
 106         <RULES SET="Command" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 107                 <!-- Argument separators -->
 108                 <SEQ TYPE="OPERATOR">,</SEQ>
 109                 <SEQ TYPE="OPERATOR">;</SEQ>
 110                 <SEQ TYPE="OPERATOR">=</SEQ>
 111
 112                 <!-- REM remarks cover the whole line, even if it contains & operators -->
 113                 <EOL_SPAN_REGEXP TYPE="COMMENT1" AT_WORD_START="TRUE" HASH_CHAR="REM">REM\b</EOL_SPAN_REGEXP>
 114
 115                 <!-- DOS-style %variables% -->
 116                 <IMPORT DELEGATE="Percent_Variable"/>
 117
 118                 <!-- NT-style expanded !variables! -->
 119                 <IMPORT DELEGATE="Expand_Variable"/>
 120
 121                 <!-- String literals -->
 122                 <IMPORT DELEGATE="Quoted_string"/>
 123
 124                 <!-- Commands with special syntaxes -->
 125                 <IMPORT DELEGATE="Special_commands"/>
 126
 127                 <!-- All internal and external commands -->
 128                 <IMPORT DELEGATE="Known_commands"/>
 129
 130                 <!-- Standard device names -->
 131                 <IMPORT DELEGATE="Device_names"/>
 132         </RULES>
 133
 134         <!-- All internal and external commands -->
 135         <RULES SET="Known_commands" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 136                 <KEYWORDS>
 137                         <!-- KEYWORD1 are internal MS-DOS shell commands -->
 138                         <KEYWORD1>break</KEYWORD1>
 139                         <KEYWORD3>call</KEYWORD3>       <!-- call is a special case we want to distinguish as a KEYWORD3 -->
 140                         <KEYWORD1>cd</KEYWORD1>
 141                         <!-- <KEYWORD1>chcp</KEYWORD1>  This became an external command in NT -->
 142                         <KEYWORD1>chdir</KEYWORD1>
 143                         <KEYWORD1>cls</KEYWORD1>
 144                         <KEYWORD1>copy</KEYWORD1>
 145                         <!-- <KEYWORD1>ctty</KEYWORD1>  This became an external command in NT -->
 146                         <KEYWORD1>date</KEYWORD1>
 147                         <KEYWORD1>del</KEYWORD1>
 148                         <KEYWORD1>dir</KEYWORD1>
 149                         <KEYWORD1>echo</KEYWORD1>
 150                         <KEYWORD1>echo.</KEYWORD1>
 151                         <KEYWORD1>echo(</KEYWORD1>
 152                         <KEYWORD1>erase</KEYWORD1>
 153                         <KEYWORD1>exit</KEYWORD1>
 154                         <KEYWORD1>for</KEYWORD1>
 155                         <KEYWORD3>goto</KEYWORD3>       <!-- goto is a special case we want to distinguish as a KEYWORD3 -->
 156                         <KEYWORD1>if</KEYWORD1>
 157                         <KEYWORD1>lfnfor</KEYWORD1>
 158                         <KEYWORD1>lh</KEYWORD1>
 159                         <KEYWORD1>loadhigh</KEYWORD1>
 160                         <KEYWORD1>lock</KEYWORD1>
 161                         <KEYWORD1>md</KEYWORD1>
 162                         <KEYWORD1>mkdir</KEYWORD1>
 163                         <KEYWORD1>path</KEYWORD1>
 164                         <KEYWORD1>pause</KEYWORD1>
 165                         <KEYWORD1>prompt</KEYWORD1>
 166                         <KEYWORD1>rd</KEYWORD1>
 167                         <!-- <KEYWORD1>rem</KEYWORD1>   remarks are processed separately -->
 168                         <KEYWORD1>ren</KEYWORD1>
 169                         <KEYWORD1>rename</KEYWORD1>
 170                         <KEYWORD1>rmdir</KEYWORD1>
 171                         <KEYWORD1>set</KEYWORD1>
 172                         <KEYWORD1>shift</KEYWORD1>
 173                         <KEYWORD1>time</KEYWORD1>
 174                         <!-- <KEYWORD1>truename</KEYWORD1> This undocumented internal DOS command was not implemented in NT -->
 175                         <KEYWORD1>type</KEYWORD1>
 176                         <KEYWORD1>unlock</KEYWORD1>
 177                         <KEYWORD1>ver</KEYWORD1>
 178                         <KEYWORD1>verify</KEYWORD1>
 179                         <KEYWORD1>vol</KEYWORD1>
 180
 181                         <!-- New internal commands in Win2K -->
 182                         <KEYWORD1>endlocal</KEYWORD1>
 183                         <KEYWORD1>move</KEYWORD1>       <!-- This was an external command in DOS -->
 184                         <KEYWORD1>setlocal</KEYWORD1>
 185                         <KEYWORD1>start</KEYWORD1>
 186                         <KEYWORD1>subst</KEYWORD1>      <!-- This was an external command in DOS -->
 187
 188                         <!-- New internal commands in XP (Some may be in Win2K already) -->
 189                         <KEYWORD1>assoc</KEYWORD1>
 190                         <KEYWORD1>color</KEYWORD1>
 191                         <KEYWORD1>dpath</KEYWORD1>
 192                         <KEYWORD1>ftype</KEYWORD1>
 193                         <KEYWORD1>keys</KEYWORD1>
 194                         <KEYWORD1>popd</KEYWORD1>
 195                         <KEYWORD1>pushd</KEYWORD1>
 196                         <KEYWORD1>title</KEYWORD1>
 197
 198                         <!-- New internal commands in Vista -->
 199                         <KEYWORD1>mklink</KEYWORD1>
 200
 201                         <!-- Theare are NO new internal commands in Windows 7 to Windows 10 -->
 202
 203                         <!-- ECHO and VERIFY and BREAK associated keywords -->
 204                         <KEYWORD3>on</KEYWORD3>
 205                         <KEYWORD3>off</KEYWORD3>
 206
 207                         <!-- FOR associated keywords -->
 208                         <!-- Must _not_ be defined here, to allow catching all invalid FOR syntaxes
 209                         <KEYWORD3>in</KEYWORD3>
 210                         <KEYWORD3>do</KEYWORD3>
 211                         -->
 212
 213                         <!-- IF associated keywords -->
 214                         <KEYWORD3>not</KEYWORD3>
 215                         <KEYWORD3>exist</KEYWORD3>
 216                         <KEYWORD3>errorlevel</KEYWORD3>
 217                         <KEYWORD3>==</KEYWORD3>
 218                         <!-- New IF keywords in Win2K -->
 219                         <KEYWORD1>defined</KEYWORD1>
 220                         <KEYWORD1>else</KEYWORD1>
 221                         <!-- New IF keywords in XP (May be in Win2K already) -->
 222                         <KEYWORD3>equ</KEYWORD3>
 223                         <KEYWORD3>neq</KEYWORD3>
 224                         <KEYWORD3>lss</KEYWORD3>
 225                         <KEYWORD3>leq</KEYWORD3>
 226                         <KEYWORD3>gtr</KEYWORD3>
 227                         <KEYWORD3>geq</KEYWORD3>
 228
 229                         <!-- SETLOCAL associated keywords -->
 230                         <KEYWORD3>disableextensions</KEYWORD3>
 231                         <KEYWORD3>enableextensions</KEYWORD3>
 232                         <KEYWORD3>disabledelayedexpansion</KEYWORD3>
 233                         <KEYWORD3>enabledelayedexpansion</KEYWORD3>
 234
 235                         <!-- FUNCTION are standard DOS or WIN32 console commands -->
 236                         <!-- Standard MS-DOS commands -->
 237                         <!-- (those you find as stand-alone .exe or .com) in win95 %windows_root%\command folder -->
 238                         <FUNCTION>append</FUNCTION>
 239                         <FUNCTION>attrib</FUNCTION>
 240                         <FUNCTION>chkdsk</FUNCTION>
 241                         <FUNCTION>choice</FUNCTION>
 242                         <FUNCTION>command</FUNCTION>
 243                         <FUNCTION>debug</FUNCTION>
 244                         <FUNCTION>defrag</FUNCTION>
 245                         <FUNCTION>deltree</FUNCTION>
 246                         <FUNCTION>diskcomp</FUNCTION>
 247                         <FUNCTION>diskcopy</FUNCTION>
 248                         <FUNCTION>doskey</FUNCTION>
 249                         <FUNCTION>drvspace</FUNCTION>
 250                         <FUNCTION>emm386</FUNCTION>
 251                         <FUNCTION>expand</FUNCTION>
 252                         <FUNCTION>fastopen</FUNCTION>
 253                         <FUNCTION>fc</FUNCTION>
 254                         <FUNCTION>fdisk</FUNCTION>
 255                         <FUNCTION>find</FUNCTION>
 256                         <FUNCTION>format</FUNCTION>
 257                         <FUNCTION>graphics</FUNCTION>
 258                         <FUNCTION>graftabl</FUNCTION>
 259                         <FUNCTION>keyb</FUNCTION>
 260                         <FUNCTION>label</FUNCTION>
 261                         <FUNCTION>loadfix</FUNCTION>
 262                         <FUNCTION>mem</FUNCTION>
 263                         <FUNCTION>mode</FUNCTION>
 264                         <FUNCTION>more</FUNCTION>
 265                         <FUNCTION>move</FUNCTION>
 266                         <FUNCTION>mscdex</FUNCTION>
 267                         <FUNCTION>net</FUNCTION>
 268                         <FUNCTION>nlsfunc</FUNCTION>
 269                         <FUNCTION>power</FUNCTION>
 270                         <FUNCTION>print</FUNCTION>
 271                         <FUNCTION>replace</FUNCTION>
 272                         <FUNCTION>restore</FUNCTION>
 273                         <FUNCTION>scandisk</FUNCTION>
 274                         <FUNCTION>setver</FUNCTION>
 275                         <FUNCTION>share</FUNCTION>
 276                         <FUNCTION>sort</FUNCTION>
 277                         <FUNCTION>subst</FUNCTION>
 278                         <FUNCTION>sys</FUNCTION>
 279                         <FUNCTION>tree</FUNCTION>
 280                         <FUNCTION>undelete</FUNCTION>
 281                         <FUNCTION>unformat</FUNCTION>
 282                         <FUNCTION>vsafe</FUNCTION>
 283                         <FUNCTION>xcopy</FUNCTION>
 284
 285                         <!-- Additional Win9X commands -->
 286                         <FUNCTION>cscript</FUNCTION>
 287                         <FUNCTION>cvt</FUNCTION>
 288                         <FUNCTION>extract</FUNCTION>
 289                         <FUNCTION>iextract</FUNCTION>
 290                         <FUNCTION>scanreg</FUNCTION>
 291                         <FUNCTION>sulfnbk</FUNCTION>
 292                         <FUNCTION>xcopy32</FUNCTION>
 293
 294                         <!-- Additional XP console commands (Most were in Win2K already) -->
 295                         <FUNCTION>arp</FUNCTION>
 296                         <FUNCTION>at</FUNCTION>
 297                         <FUNCTION>bootcfg</FUNCTION>
 298                         <FUNCTION>cacls</FUNCTION>
 299                         <FUNCTION>chcp</FUNCTION>       <!-- This was an internal command in DOS -->
 300                         <FUNCTION>chkntfs</FUNCTION>
 301                         <FUNCTION>cipher</FUNCTION>
 302                         <FUNCTION>cmd</FUNCTION>
 303                         <FUNCTION>comp</FUNCTION>
 304                         <FUNCTION>compact</FUNCTION>
 305                         <FUNCTION>convert</FUNCTION>
 306                         <FUNCTION>ctty</FUNCTION>       <!-- This was an internal command in DOS -->
 307                         <FUNCTION>diskpart</FUNCTION>
 308                         <FUNCTION>driverquery</FUNCTION>
 309                         <FUNCTION>eventcreate</FUNCTION>
 310                         <FUNCTION>findstr</FUNCTION>
 311                         <FUNCTION>fsutil</FUNCTION>
 312                         <FUNCTION>ftp</FUNCTION>
 313                         <FUNCTION>getmac</FUNCTION>
 314                         <FUNCTION>help</FUNCTION>
 315                         <FUNCTION>hostname</FUNCTION>
 316                         <FUNCTION>ipconfig</FUNCTION>
 317                         <FUNCTION>logman</FUNCTION>
 318                         <FUNCTION>logoff</FUNCTION>
 319                         <FUNCTION>makecab</FUNCTION>
 320                         <FUNCTION>mountvol</FUNCTION>
 321                         <FUNCTION>msg</FUNCTION>
 322                         <FUNCTION>nbtstat</FUNCTION>
 323                         <FUNCTION>netsh</FUNCTION>
 324                         <FUNCTION>netstat</FUNCTION>
 325                         <FUNCTION>nslookup</FUNCTION>
 326                         <FUNCTION>openfiles</FUNCTION>
 327                         <FUNCTION>pathping</FUNCTION>
 328                         <FUNCTION>ping</FUNCTION>
 329                         <FUNCTION>powercfg</FUNCTION>
 330                         <FUNCTION>qprocess</FUNCTION>
 331                         <FUNCTION>rasdial</FUNCTION>
 332                         <FUNCTION>recover</FUNCTION>
 333                         <FUNCTION>reg</FUNCTION>
 334                         <FUNCTION>regini</FUNCTION>
 335                         <FUNCTION>reset</FUNCTION>
 336                         <FUNCTION>route</FUNCTION>
 337                         <FUNCTION>runas</FUNCTION>
 338                         <FUNCTION>sc</FUNCTION>
 339                         <FUNCTION>schtasks</FUNCTION>
 340                         <FUNCTION>shutdown</FUNCTION>
 341                         <FUNCTION>systeminfo</FUNCTION>
 342                         <FUNCTION>taskkill</FUNCTION>
 343                         <FUNCTION>tasklist</FUNCTION>
 344                         <FUNCTION>telnet</FUNCTION>
 345                         <FUNCTION>tftp</FUNCTION>
 346                         <FUNCTION>tracert</FUNCTION>
 347                         <FUNCTION>tsconn</FUNCTION>
 348                         <FUNCTION>tsdisconn</FUNCTION>
 349                         <FUNCTION>tskill</FUNCTION>
 350                         <FUNCTION>w32tm</FUNCTION>
 351                         <FUNCTION>winrs</FUNCTION>
 352                         <FUNCTION>wmic</FUNCTION>
 353
 354                         <!-- Additional Vista console commands -->
 355                         <FUNCTION>bcdedit</FUNCTION>
 356                         <FUNCTION>choice</FUNCTION>
 357                         <FUNCTION>certutil</FUNCTION>
 358                         <FUNCTION>change</FUNCTION>
 359                         <FUNCTION>clip</FUNCTION>
 360                         <FUNCTION>forfiles</FUNCTION>
 361                         <FUNCTION>icacls</FUNCTION>
 362                         <FUNCTION>pnputil</FUNCTION>
 363                         <FUNCTION>query</FUNCTION>
 364                         <FUNCTION>quser</FUNCTION>
 365                         <FUNCTION>setx</FUNCTION>
 366                         <FUNCTION>timeout</FUNCTION>
 367                         <FUNCTION>waitfor</FUNCTION>
 368                         <FUNCTION>where</FUNCTION>
 369                         <FUNCTION>whoami</FUNCTION>
 370
 371                         <!-- Additional Windows 7 console commands -->
 372                         <FUNCTION>bcdboot</FUNCTION>
 373                         <FUNCTION>dism</FUNCTION>
 374                         <FUNCTION>djoin</FUNCTION>
 375                         <FUNCTION>setspn</FUNCTION>
 376                         <FUNCTION>tzutil</FUNCTION>
 377                 </KEYWORDS>
 378         </RULES>
 379
 380         <!-- DOS-style %variables% -->
 381         <RULES SET="Percent_Variable" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE">
 382                 <!-- Fake %# variables #% used for commenting sections of a line -->
 383                 <!-- Must be defined before other %variables% to be detected -->
 384                 <SPAN_REGEXP TYPE="COMMENT2" HASH_CHAR="%#" NO_LINE_BREAK="TRUE">
 385                         <BEGIN>%#</BEGIN>
 386                         <END>#%</END>
 387                 </SPAN_REGEXP>
 388                 <!-- %%N arguments -->
 389                 <SEQ TYPE="KEYWORD2">%*</SEQ>
 390                 <SEQ_REGEXP TYPE="KEYWORD2" HASH_CHAR="%" AT_WORD_START="FALSE"
 391                                         >%(~[fdpnxsatz]*($[^:]+:)?)?[\d]</SEQ_REGEXP>
 392                 <!-- for-loop %%v variable (one char after %%) -->
 393                 <SEQ_REGEXP TYPE="KEYWORD2" HASH_CHAR="%" AT_WORD_START="FALSE"
 394                                         >%%(~[fdpnxsatz]*(\$[^:]+:)?)?[^,;="&amp;|%!\s]</SEQ_REGEXP>
 395                 <!-- %variables% -->
 396                 <SEQ_REGEXP TYPE="KEYWORD2" HASH_CHAR="%" AT_WORD_START="FALSE"
 397                                         >%[^%]*%</SEQ_REGEXP>
 398         </RULES>
 399
 400         <!-- NT-style !variables! -->
 401         <RULES SET="_Expand_Variable" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="MARKUP">
 402                 <!-- DOS-style %variables% inside NT-style !variables! -->
 403                 <IMPORT DELEGATE="Percent_Variable"/>
 404         </RULES>
 405         <RULES SET="Expand_Variable" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE">
 406                 <!-- NT-style !variables! -->
 407                 <SPAN TYPE="MARKUP" NO_LINE_BREAK="TRUE" DELEGATE="_Expand_Variable">
 408                         <BEGIN>!</BEGIN>
 409                         <END>!</END>
 410                 </SPAN>
 411         </RULES>
 412
 413         <!-- "Quoted strings" -->
 414         <RULES SET="_Quoted_string" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="LITERAL1">
 415                 <!-- DOS-style %variables% inside "Quoted strings" -->
 416                 <IMPORT DELEGATE="Percent_Variable"/>
 417                 <!-- NT-style !variables! inside "Quoted strings"-->
 418                 <IMPORT DELEGATE="Expand_Variable"/>
 419         </RULES>
 420         <RULES SET="Quoted_string" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE">
 421                 <SPAN TYPE="LITERAL1" NO_LINE_BREAK="TRUE" DELEGATE="_Quoted_string">
 422                         <BEGIN>"</BEGIN>
 423                         <END>"</END>
 424                 </SPAN>
 425         </RULES>
 426
 427         <!-- Standard device names -->
 428         <RULES SET="Device_names" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 429                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="NUL">NUL\b</SEQ_REGEXP>
 430                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="AUX">AUX\b</SEQ_REGEXP>
 431                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="PRN">PRN\b</SEQ_REGEXP>
 432                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="CON">CON\b</SEQ_REGEXP>
 433                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="COM">COM\d+\b</SEQ_REGEXP>
 434                 <SEQ_REGEXP TYPE="KEYWORD4" AT_WORD_START="TRUE" HASH_CHAR="LPT">LPT\d+\b</SEQ_REGEXP>
 435         </RULES>
 436
 437         <!-- Pipeling and sequencing operators -->
 438         <RULES SET="Pipeline_operators" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 439                 <SEQ_REGEXP TYPE="OPERATOR" HASH_CHAR="^">\^$</SEQ_REGEXP><!-- Line continuation character. TO DO: The delegation should continue on next line -->
 440                 <SEQ_REGEXP TYPE="OPERATOR" AT_WORD_START="TRUE" HASH_CHARS="&gt;0123456789">\d*&gt;(&amp;\d+)?</SEQ_REGEXP><!-- Ex: > or >> or 2> or 2>&1 -->
 441                 <SEQ TYPE="OPERATOR">&lt;</SEQ>
 442                 <SEQ TYPE="OPERATOR" DELEGATE="MAIN">&amp;&amp;</SEQ>
 443                 <SEQ TYPE="OPERATOR" DELEGATE="MAIN">&amp;</SEQ>
 444                 <SEQ TYPE="OPERATOR" DELEGATE="MAIN">||</SEQ>
 445                 <SEQ TYPE="OPERATOR" DELEGATE="MAIN">|</SEQ>
 446                 <!-- TO DO: Why aren't these ) caught by RULES SET="Parenthesis_blocks" below ?
 447                      I'd like to flag only the extra ) as invalid here! -->
 448                 <SEQ TYPE="OPERATOR" DELEGATE="MAIN">)</SEQ>
 449         </RULES>
 450
 451         <!-- A block of commands within a pair of parenthesis -->
 452         <RULES SET="Parenthesis_blocks" DEFAULT="NULL">
 453                 <SPAN MATCH_TYPE="OPERATOR" NO_LINE_BREAK="FALSE" DELEGATE="MAIN">
 454                         <BEGIN>(</BEGIN>
 455                         <END>)</END>
 456                 </SPAN>
 457         </RULES>
 458
 459         <!-- Commands with special syntaxes -->
 460         <RULES SET="Special_commands" DEFAULT="NULL">
 461                 <!-- FOR loops -->
 462                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="FOR"  DELEGATE="FOR">FOR\b</EOL_SPAN_REGEXP>
 463                 <!-- IF ... ELSE ... -->
 464                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="IF"   DELEGATE="IF">IF\b</EOL_SPAN_REGEXP>
 465                 <!-- CALL and GOTO :label -->
 466                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="CALL" DELEGATE="CALL">CALL\b</EOL_SPAN_REGEXP>
 467                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="GOTO" DELEGATE="CALL">GOTO\b</EOL_SPAN_REGEXP>
 468                 <!-- ECHO message. DOS documented ECHO.message to display any string. NT supports a few other characters, like ECHO(message -->
 469                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="ECHO" DELEGATE="ECHO.">ECHO[./\\:+(]</EOL_SPAN_REGEXP>
 470                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="ECHO" DELEGATE="ECHO">ECHO\b</EOL_SPAN_REGEXP>
 471
 472                 <!-- Commands with free arguments that are _not_ keywords -->
 473                 <!-- Workaround to avoid triggering the other rules above, if one of the arguments is FOR, IF, CALL, ... -->
 474                 <!-- The correct way to do this would be to find a general way to parse the (command [arguments]) syntax -->
 475                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="SET"  DELEGATE="Arguments">SET\b</EOL_SPAN_REGEXP>
 476                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="CD"   DELEGATE="Arguments">CD\b</EOL_SPAN_REGEXP>
 477                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="MD"   DELEGATE="Arguments">MD\b</EOL_SPAN_REGEXP>
 478                 <EOL_SPAN_REGEXP TYPE="KEYWORD1" AT_WORD_START="TRUE" HASH_CHAR="RD"   DELEGATE="Arguments">RD\b</EOL_SPAN_REGEXP>
 479         </RULES>
 480
 481         <!-- Arguments -->
 482         <RULES SET="Arguments" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="NULL">
 483                 <IMPORT DELEGATE="Pipeline_operators"/>
 484                 <IMPORT DELEGATE="Percent_Variable"/>
 485                 <IMPORT DELEGATE="Expand_Variable"/>
 486                 <IMPORT DELEGATE="Quoted_string"/>
 487                 <IMPORT DELEGATE="Device_names"/>
 488         </RULES>
 489
 490         <!-- FOR loops -->
 491         <RULES SET="FOR" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 492                 <SEQ TYPE="KEYWORD3" AT_WORD_START="TRUE" DELEGATE="FOR /D">/D</SEQ>
 493                 <SEQ TYPE="KEYWORD3" AT_WORD_START="TRUE" DELEGATE="FOR /F">/F</SEQ>
 494                 <SEQ TYPE="KEYWORD3" AT_WORD_START="TRUE" DELEGATE="FOR /L">/L</SEQ>
 495                 <SEQ TYPE="KEYWORD3" AT_WORD_START="TRUE" DELEGATE="FOR /R">/R</SEQ>
 496                 <SEQ TYPE="NULL">/</SEQ>
 497                 <IMPORT DELEGATE="FOR %%"/><!-- Anything else is invalid here -->
 498         </RULES>
 499         <!-- Expect the %%v loop variable, and nothing else -->
 500         <RULES SET="FOR %%" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 501                 <SEQ_REGEXP TYPE="INVALID"  HASH_CHAR="%%" DELEGATE="FOR IN">%%[^,;="&amp;|%!\s]\S</SEQ_REGEXP>
 502                 <SEQ_REGEXP TYPE="KEYWORD2" HASH_CHAR="%%" DELEGATE="FOR IN">%%[^,;="&amp;|%!\s]</SEQ_REGEXP>
 503                 <SEQ TYPE="NULL">%%</SEQ>
 504                 <SEQ TYPE="NULL">%</SEQ>
 505                 <IMPORT DELEGATE="INVALID"/><!-- Anything else is invalid here -->
 506         </RULES>
 507         <!-- Expect for /d arguments -->
 508         <RULES SET="FOR /D" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 509                 <IMPORT DELEGATE="FOR %%"/><!-- Anything else is invalid here -->
 510         </RULES>
 511         <!-- Expect for /f arguments -->
 512         <RULES SET="FOR /F" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 513                 <IMPORT DELEGATE="Quoted_string"/>
 514                 <IMPORT DELEGATE="FOR %%"/><!-- Anything else is invalid here -->
 515         </RULES>
 516         <!-- Expect for /l arguments -->
 517         <RULES SET="FOR /L" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 518                 <IMPORT DELEGATE="FOR %%"/><!-- Anything else is invalid here -->
 519         </RULES>
 520         <!-- Expect for /r arguments -->
 521         <RULES SET="FOR /R" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 522                 <!-- The pathname that follows /r is either quoted -->
 523                 <IMPORT DELEGATE="Quoted_string"/>
 524                 <!-- Or it's a sequence of pathname characters that do not need quoting -->
 525                 <SEQ_REGEXP TYPE="NULL" DELEGATE="FOR %%">[^%\*\?""&lt;&gt;\|\(\)\s]+</SEQ_REGEXP>
 526                 <IMPORT DELEGATE="FOR %%"/><!-- Anything else is invalid here -->
 527         </RULES>
 528         <!-- Expect the for IN keyword, and nothing else -->
 529         <RULES SET="FOR IN" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 530                 <SEQ_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="IN" DELEGATE="FOR LIST">IN\b</SEQ_REGEXP>
 531                 <SEQ_REGEXP TYPE="NULL" AT_WORD_START="TRUE" HASH_CHAR="I">I\b</SEQ_REGEXP><!-- Avoid showing an error while typing the I of IN -->
 532                 <IMPORT DELEGATE="INVALID"/><!-- Anything else is invalid here -->
 533         </RULES>
 534         <!-- Expect the for (list) DO sequence -->
 535         <RULES SET="FOR LIST" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 536                 <!-- Special case of for ... in ('for ... ^(loop^)') -->
 537                 <SPAN MATCH_TYPE="OPERATOR" NO_LINE_BREAK="FALSE" DELEGATE="FOR /F ()">
 538                         <BEGIN>^(</BEGIN>
 539                         <END>^)</END>
 540                 </SPAN>
 541                 <!-- DOS-style (list of files) -->
 542                 <SPAN MATCH_TYPE="OPERATOR" NO_LINE_BREAK="FALSE" DELEGATE="FOR /F ()">
 543                         <BEGIN>(</BEGIN>
 544                         <END>)</END>
 545                 </SPAN>
 546                 <IMPORT DELEGATE="FOR DO"/><!-- Anything else is invalid here -->
 547         </RULES>
 548         <!-- Expect the for /F (list or 'command') -->
 549         <RULES SET="FOR /F ()" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 550                 <!-- NT-style 'command' or `command` -->
 551                 <SPAN_REGEXP MATCH_TYPE="OPERATOR" HASH_CHAR="" NO_LINE_BREAK="FALSE" DELEGATE="'Command'">
 552                         <BEGIN>(['`])</BEGIN>
 553                         <END REGEXP="TRUE">$1</END>
 554                 </SPAN_REGEXP>
 555                 <!-- DOS-style list -->
 556                 <IMPORT DELEGATE="Arguments"/>
 557         </RULES>
 558         <!-- NT-style 'command' or `command` -->
 559         <RULES SET="'Command'" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 560                 <!--
 561                 <SEQ_REGEXP DELEGATE="FOR DO">'\s*\)</SEQ_REGEXP>
 562                 -->
 563                 <!-- Standard device names -->
 564                 <IMPORT DELEGATE="Device_names"/>
 565                 <!-- All internal and external commands -->
 566                 <IMPORT DELEGATE="Known_commands"/>
 567                 <!-- TO DO: Why can't we delegate this to MAIN? (Breaks the end of block detection) -->
 568                 <!-- Known bug: Even with this workaround, an & in the pipeline will break the end of ') block detection -->
 569                 <IMPORT DELEGATE="Arguments"/>
 570         </RULES>
 571         <!-- Expect the for DO keyword -->
 572         <RULES SET="FOR DO" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 573                 <SEQ_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="DO" DELEGATE="MAIN">DO\b</SEQ_REGEXP>
 574                 <SEQ_REGEXP TYPE="NULL" AT_WORD_START="TRUE" HASH_CHAR="D">D\b</SEQ_REGEXP><!-- Avoid showing an error while typing the D of DO -->
 575                 <IMPORT DELEGATE="INVALID"/><!-- Anything else is invalid here -->
 576         </RULES>
 577
 578         <!-- IF ... ELSE ... -->
 579         <RULES SET="IF" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 580                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="NOT" DELEGATE="IFF">NOT\b</EOL_SPAN_REGEXP>
 581                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="/I"  DELEGATE="IF COMPARE">/I\b</EOL_SPAN_REGEXP>
 582                 <IMPORT DELEGATE="IFF"/>
 583         </RULES>
 584         <RULES SET="IFF" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 585                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="DEF" DELEGATE="IF DEFINED">DEFINED\b</EOL_SPAN_REGEXP>
 586                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="EXI" DELEGATE="IF EXIST">EXIST\b</EOL_SPAN_REGEXP>
 587                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="ERR" DELEGATE="IF ERRORLEVEL">ERRORLEVEL\b</EOL_SPAN_REGEXP>
 588                 <EOL_SPAN_REGEXP TYPE="KEYWORD3" AT_WORD_START="TRUE" HASH_CHAR="CMD" DELEGATE="IF CMDEXTVERSION">CMDEXTVERSION\b</EOL_SPAN_REGEXP>
 589                 <IMPORT DELEGATE="IF COMPARE"/>
 590         </RULES>
 591         <RULES SET="IF DEFINED" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 592                 <IMPORT DELEGATE="MAIN"/><!-- For lack of a better solution -->
 593         </RULES>
 594         <RULES SET="IF EXIST" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 595                 <IMPORT DELEGATE="MAIN"/><!-- For lack of a better solution -->
 596         </RULES>
 597         <RULES SET="IF ERRORLEVEL" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 598                 <IMPORT DELEGATE="MAIN"/><!-- For lack of a better solution -->
 599         </RULES>
 600         <RULES SET="IF CMDEXTVERSION" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 601                 <IMPORT DELEGATE="MAIN"/><!-- For lack of a better solution -->
 602         </RULES>
 603         <RULES SET="IF COMPARE" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE">
 604                 <SEQ TYPE="KEYWORD3">==</SEQ>
 605                 <IMPORT DELEGATE="MAIN"/><!-- For lack of a better solution -->
 606         </RULES>
 607
 608         <!-- CALL and GOTO :label -->
 609         <RULES SET="CALL" IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="NULL">
 610                 <IMPORT DELEGATE="Pipeline_operators"/>
 611                 <IMPORT DELEGATE="Percent_Variable"/>
 612                 <IMPORT DELEGATE="Expand_Variable"/>
 613                 <IMPORT DELEGATE="Quoted_string"/>
 614                 <IMPORT DELEGATE="Device_names"/>
 615                 <!-- labels - eg "call :test" or "goto :test" -->
 616                 <EOL_SPAN_REGEXP AT_WORD_START="TRUE" HASH_CHAR=":" TYPE="LABEL" DELEGATE="Arguments">:[^+:,;=\s]+</EOL_SPAN_REGEXP>
 617         </RULES>
 618
 619         <!-- ECHO message -->
 620         <RULES SET="ECHO" IGNORE_CASE="TRUE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="LITERAL4">
 621                 <!-- TO DO: (echo Off we go) is valid, and outputs the 3 words. How to catch that and color all 3 as LITERAL4? -->
 622                 <EOL_SPAN_REGEXP AT_WORD_START="TRUE" HASH_CHAR="O" TYPE="KEYWORD3" DELEGATE="ECHO.">(ON|OFF)\b</EOL_SPAN_REGEXP>
 623                 <IMPORT DELEGATE="ECHO."/>
 624         </RULES>
 625         <RULES SET="ECHO." IGNORE_CASE="FALSE" HIGHLIGHT_DIGITS="FALSE" DEFAULT="LITERAL4">
 626                 <IMPORT DELEGATE="Pipeline_operators"/>
 627                 <IMPORT DELEGATE="Percent_Variable"/>
 628                 <IMPORT DELEGATE="Expand_Variable"/>
 629                 <IMPORT DELEGATE="Quoted_string"/>
 630                 <IMPORT DELEGATE="Device_names"/>
 631         </RULES>
 632
 633         <!-- Empty ruleset to delegate to for spots where any non-whitespace is invalid -->
 634         <RULES SET="INVALID" DEFAULT="INVALID">
 635                 <!-- Limit the error to one line -->
 636                 <EOL_SPAN_REGEXP TYPE="INVALID">\S.*</EOL_SPAN_REGEXP>
 637         </RULES>
 638 </MODE>