set term support for firebird

Author: SPRINX0\prochazka

src/options.ts

@@ -8,6 +8,7 @@ export interface SplitterOptions {
   allowSemicolon: boolean;
   allowCustomDelimiter: boolean;
   allowCustomSqlTerminator: boolean;
+  allowCustomSetTerm: boolean;
   allowGoDelimiter: boolean;
   allowSlashDelimiter: boolean;
   allowDollarDollarString: boolean;
@@ -41,6 +42,7 @@ export const defaultSplitterOptions: SplitterOptions = {
   allowSemicolon: true,
   allowCustomDelimiter: false,
   allowCustomSqlTerminator: false,
+  allowCustomSetTerm: false,
   allowGoDelimiter: false,
   allowSlashDelimiter: false,
   allowDollarDollarString: false,
@@ -136,6 +138,7 @@ export const oracleSplitterOptions: SplitterOptions = {
 export const firebirdSplitterOptions: SplitterOptions = {
   ...defaultSplitterOptions,
 
+  allowCustomSetTerm: true,
   skipSeparatorBeginEnd: true,
   queryParameterStyle: ':', // Firebird uses colon-prefixed parameters (:param_name)
 };

src/splitQuery.ts

@@ -6,6 +6,10 @@ const BEGIN_EXTRA_KEYWORDS_REGEX = new RegExp(`^(?:${BEGIN_EXTRA_KEYWORDS.join('
 const END_EXTRA_KEYWORDS = ['TRANSACTION', 'IF'];
 const END_EXTRA_KEYWORDS_REGEX = new RegExp(`^(?:${END_EXTRA_KEYWORDS.join('|')})`, 'i');
 
+function escapeRegExp(str: string): string {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
 type SplitterSpecialMarkerType = 'copy_stdin_start' | 'copy_stdin_end' | 'copy_stdin_line';
 export interface SplitStreamContext {
   options: SplitterOptions;
@@ -283,7 +287,22 @@ export function scanToken(context: ScannerContext): Token {
     }
   }
 
+  if (context.options.allowCustomSetTerm) {
+    // Firebird: SET TERM ^ ;
+    // The command ends with the current delimiter
+    const firebirdPattern = new RegExp(`^SET[ \\t]+TERM[ \\t]+(\\S+)[ \\t]*${escapeRegExp(context.currentDelimiter || SEMICOLON)}`, 'i');
+    const firebirdMatch = s.slice(pos).match(firebirdPattern);
+    if (firebirdMatch) {
+      return {
+        type: 'set_sqlterminator',
+        value: firebirdMatch[1],
+        length: firebirdMatch[0].length,
+      };
+    }
+  }
+
   if (context.options.allowCustomSqlTerminator) {
+    // Oracle: SET SQLTERMINATOR "."
     const m = s.slice(pos).match(/^SET[ \t]+SQLT(ERMINATOR)?[ \t]+(ON|OFF|".")/i);
     if (m) {
       if (m[2].toUpperCase() == 'OFF') {

src/splitter.test.ts

@@ -384,3 +384,63 @@ END`;
   expect(output.length).toBe(1);
   expect(output[0]).toEqual(input);
 });
+
+test('Firebird - SET TERM with trigger', () => {
+  const input = `set term ^;
+alter trigger ZAK_ROZPISKY_AU
+as
+declare xpocet                    integer;
+declare xtermin_vykres            timestamp;
+BEGIN
+  SELECT 1 FROM TABLE1;
+END^
+set term ;^
+SELECT * FROM TABLE2`;
+  const output = splitQuery(input, firebirdSplitterOptions);
+
+  expect(output.length).toBe(2);
+  expect(output[0]).toMatch(/alter trigger/i);
+  expect(output[0]).toMatch(/SELECT 1 FROM TABLE1/);
+  expect(output[1]).toEqual('SELECT * FROM TABLE2');
+});
+
+test('Firebird - SET TERM with procedure', () => {
+  const input = `SET TERM ^ ;
+CREATE PROCEDURE test_proc
+AS
+BEGIN
+  SELECT 1;
+  SELECT 2;
+END^
+SET TERM ; ^
+SELECT 3;`;
+  const output = splitQuery(input, firebirdSplitterOptions);
+
+  expect(output.length).toBe(2);
+  expect(output[0]).toMatch(/CREATE PROCEDURE/);
+  expect(output[0]).toMatch(/SELECT 1/);
+  expect(output[0]).toMatch(/SELECT 2/);
+  expect(output[1]).toEqual('SELECT 3');
+});
+
+test('Firebird - SET TERM with multiple procedures', () => {
+  const input = `SET TERM ^ ;
+CREATE PROCEDURE proc1
+AS
+BEGIN
+  SELECT 1;
+END^
+CREATE PROCEDURE proc2
+AS
+BEGIN
+  SELECT 2;
+END^
+SET TERM ; ^`;
+  const output = splitQuery(input, firebirdSplitterOptions);
+
+  expect(output.length).toBe(2);
+  expect(output[0]).toMatch(/proc1/);
+  expect(output[0]).toMatch(/SELECT 1/);
+  expect(output[1]).toMatch(/proc2/);
+  expect(output[1]).toMatch(/SELECT 2/);
+});