highlight sqlplus define variables as preprocessor. Add examples to test file

Author: lee-lindley

README.md

@@ -35,13 +35,13 @@ describes how I came to create this repository.
 
 ## plsql.vim syntax file
 
-The syntax file replaces the functionality of the *plsql.vim* file that ships with vim (it was last updated
+The syntax file replaces the functionality of the *plsql.vim* file that ships with vim versions 8 and earlier (it was last updated
 for Oracle 9). 
 
-> Release v20220503_1.3 (tag r1.3) of this syntax file was submitted to the *vim* maintainers for inclusion in *vim* version 9.
-
 > Release v20220821_1.4 (tag r1.4) of this syntax file was submitted to the *vim* maintainers for inclusion in *vim* version 9.
 
+> Release v20220924_1.5 (tag r1.5) of this syntax file was submitted to the *vim* maintainers for inclusion in *vim* verison 9.
+
 Relative to the original *plsql.vim*, this update adds keywords and syntax through Oracle version 19c.
 It fixes Q-quote operator syntax, exponential notation and assorted oddities, plus 
 adds optional folding.
@@ -55,6 +55,7 @@ original behavior, add the following to your *.vimrc* file:
 ```vim
 let plsql_legacy_sql_keywords = 1
 ```
+We also added highlighting for some *SqlPlus* commands and define variables.
 
 ### Folding
 

syntax/plsql.vim

@@ -57,6 +57,7 @@ syn case ignore
 
 syn match   plsqlGarbage "[^ \t()]"
 syn match   plsqlIdentifier "[a-z][a-z0-9$_#]*"
+syn match   plsqlSqlPlusDefine "&&\?[a-z][a-z0-9$_#]*\.\?"
 syn match   plsqlHostIdentifier ":[a-z][a-z0-9$_#]*"
 
 " The Non-Breaking is often accidentally typed (Mac User: Opt+Space, after typing the "|",  Opt+7);
@@ -86,7 +87,6 @@ syn match   plsqlOperator "\<IS\\_s\+\(NOT\_s\+\)\?NULL\>"
 "
 " conditional compilation Preprocessor directives and sqlplus define sigil
 syn match plsqlPseudo "$[$a-z][a-z0-9$_#]*"
-syn match plsqlPseudo "&"
 
 syn match plsqlReserved "\<\(CREATE\|THEN\|UPDATE\|INSERT\|SET\)\>"
 syn match plsqlKeyword "\<\(REPLACE\|PACKAGE\|FUNCTION\|PROCEDURE\|TYPE|BODY\|WHEN\|MATCHED\)\>"
@@ -591,18 +591,18 @@ syn match plsqlEND "\<END\>"
 syn match plsqlISAS "\<\(IS\|AS\)\>"
 
 " Various types of comments.
-syntax region plsqlCommentL start="--" skip="\\$" end="$" keepend extend contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace
+syntax region plsqlCommentL start="--" skip="\\$" end="$" keepend extend contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace,plsqlSqlplusDefine
 if get(g:,"plsql_fold",0) == 1
     syntax region plsqlComment
         \ start="/\*" end="\*/"
         \ extend
-        \ contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace
+        \ contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace,plsqlSqlplusDefine
         \ fold
 else
     syntax region plsqlComment
         \ start="/\*" end="\*/"
         \ extend
-        \ contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace
+        \ contains=@plsqlCommentGroup,plsqlSpaceError,plsqlIllegalSpace,plsqlSqlplusDefine
 endif
 syn cluster plsqlCommentAll contains=plsqlCommentL,plsqlComment
 
@@ -625,23 +625,23 @@ syn match   plsqlFloatLiteral contained "\.\(\d\+\([eE][+-]\?\d\+\)\?\)[fd]\?"
 " double quoted strings in SQL are database object names. Should be a subgroup of Normal.
 " We will use Character group as a proxy for that so color can be chosen close to Normal
 syn region plsqlQuotedIdentifier	matchgroup=plsqlOperator start=+n\?"+     end=+"+ keepend extend
-syn cluster plsqlIdentifiers contains=plsqlIdentifier,plsqlQuotedIdentifier
+syn cluster plsqlIdentifiers contains=plsqlIdentifier,plsqlQuotedIdentifier,plsqlSqlPlusDefine
 
 " quoted string literals
 if get(g:,"plsql_fold",0) == 1
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?'+  skip=+''+    end=+'+ fold keepend extend
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\z([^[(<{]\)+    end=+\z1'+ fold keepend extend
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'<+   end=+>'+ fold keepend extend
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'{+   end=+}'+ fold keepend extend
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'(+   end=+)'+ fold keepend extend
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\[+  end=+]'+ fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?'+  skip=+''+    end=+'+ contains=plsqlSqlplusDefine fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\z([^[(<{]\)+    end=+\z1'+ contains=plsqlSqlplusDefine fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'<+   end=+>'+ contains=plsqlSqlplusDefine fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'{+   end=+}'+ contains=plsqlSqlplusDefine fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'(+   end=+)'+ contains=plsqlSqlplusDefine fold keepend extend
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\[+  end=+]'+ contains=plsqlSqlplusDefine fold keepend extend
 else
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?'+  skip=+''+    end=+'+ 
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\z([^[(<{]\)+    end=+\z1'+ 
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'<+   end=+>'+ 
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'{+   end=+}'+ 
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'(+   end=+)'+ 
-    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\[+  end=+]'+ 
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?'+  skip=+''+    end=+'+ contains=plsqlSqlplusDefine
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\z([^[(<{]\)+    end=+\z1'+ contains=plsqlSqlplusDefine
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'<+   end=+>'+ contains=plsqlSqlplusDefine
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'{+   end=+}'+ contains=plsqlSqlplusDefine
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'(+   end=+)'+ contains=plsqlSqlplusDefine
+    syn region plsqlStringLiteral	matchgroup=plsqlOperator start=+n\?q'\[+  end=+]'+ contains=plsqlSqlplusDefine
 endif
 
 syn keyword plsqlBooleanLiteral TRUE FALSE 
@@ -839,6 +839,7 @@ hi def link plsqlTypeAttribute      StorageClass
 hi def link plsqlTodo		        Todo
 
 hi def link plsqlIllegalSpace       Error
+hi def link plsqlSqlPlusDefine      PreProc
 hi def link plsqlSqlPlusCommand     PreProc
 hi def link plsqlSqlPlusRunFile     Include
 hi def link plsqlSqlPlusCommentL    Comment

test/plsql.pls

@@ -1,8 +1,13 @@
+REM a sqlplus comment
+prompt set this to anything you want
+define literal_keyword="whatever dude"
+whenever sqlerror then failure
 ().,;
-SELECT e.first_name AS "First Name", e.last_name AS "Last Name"
+SELECT 
+    e.first_name AS "First Name", e.last_name AS "Last Name"
     , d.department_name AS "Department 
 Name"
-    , 'a string with embedded quote ('')' as regq, q'{a string with embedded quote (')}' as qquote
+    , 'a &literal_keyword string with embedded quote ('')' as regq, q'{a &&literal_keyword. string with embedded quote (')}' as qquote
     , 'a string ending in a quote ''' as "regq_end_quote XXX", 'xxx' AS XXX
     , 123 AS "integer val" , .7 as "trailing dec", 123. as "really an int but classified float"
     , 123.456 as "float" , 1.27E-2 as "exp not"
@@ -12,8 +17,8 @@ Name"
     , +123 AS "p integer val" , +.7 as "p trailing dec", +123.F as "p really an int but classified float"
     , +123.456f as "p float", -123.456d as "p_double" , +1.27E2D as "p exp not double"
 -- TODO XXX DEBUG NOTE FIXME 
-FROM hr.employees e
-JOIN hr.departments d
+FROM &hr_schema..employees e
+JOIN &&hr_schema..departments d
     ON e.department_id = d.department_id
 WHERE e.first_name = 'Bruce' AND e.last_name = 'Lee'
 ORDER BY d.department_name;