dt-sql-parser 4.0.0-beta.4.10 → 4.0.0-beta.4.11

package/README.md

@@ -187,8 +187,9 @@ class MyVisitor extends AbstractParseTreeVisitor<Result> implements MySqlParserV
         console.log('SelectElements:', selectElements);
         return '';
     }
-    visitProgram(ctx) {
-        return 'Return by program node'
+    visitProgram(ctx) { // program is root rule
+        this.visitChildren(ctx);
+        return 'Return by program context'
     }
 }
 const visitor = new MyVisitor();
@@ -289,7 +290,7 @@ console.log(sqlSlices)
 Obtaining code completion information at a specified position in SQL.
 We can refer to the example of using `FlinkSQL`.
 
-Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the row and column numbers indicating the position where code completion is desired.
+Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the row and column numbers indicating the position where code completion is desired. The following are some additional explanations about [CaretPosition](#caretposition-of-code-completion).
 + **keyword candidates list**
 
     ```javascript
@@ -357,6 +358,76 @@ The grammar-related code completion information returns an array, where each ite
 
 <br/>
 
+## Position and Range
+Some return results of the APIs provided by `dt-sql-parser` contain text information, among which the range and start value of line number, column number and index may cause some confusion.
+
+### Index
+The index starts at 0. In the programming field, it is more intuitive.
+
+![index-image](./docs/images/index.png)
+
+For an index range, the start index starts from 0 and ends with n-1, as shown in the figure above, an index range of blue text should be represented as follows:
+
+```javascript
+{
+    startIndex: 0,
+    endIndex: 3
+}
+```
+
+### Line
+The line starts at 1.
+
+![line-image](./docs/images/line.png)
+
+For a range of multiple lines, the line number starts from 1 and ends with n. A range of the first and second lines is represented as follows:
+
+```javascript
+{
+    startLine: 1,
+    endLine: 2
+}
+```
+
+### Column 
+The column also starts at 1.
+
+![column-image](./docs/images/column.png)
+
+It is easier to understand by comparing the column number with the cursor position of the editor. For a range of multiple columns, the column number starts from 1 and ends with n+1, as shown in the figure above, a range of blue text columns is represented as follows:
+
+```javascript
+{
+    startColumn: 1,
+    endColumn: 5
+}
+```
+
+### CaretPosition Of Code Completion
+The code completion of `dt-sql-parser` was designed to be used in the editor, so the format of the second parameter (CaretPosition) of the `getSuggestionAtCaretPosition` method is line and column number instead of character position index. This makes it easier to integrate the code completion into the editor. For the editor, it only needs to get the text content and cursor position in the editor at a specific time to call the code completion of `dt-sql-parser`, without any additional calculation.
+
+But in some other scenarios, you may need to get the caret position required by the code completion through conversion or calculation. Then, there are some precautions that you may need to care about before that.
+
+The code completion of `dt-sql-parser` depends on [antlr4-c3](https://github.com/mike-lischke/antlr4-c3), which is a great library. The code completion of `dt-sql-parser` is just encapsulated and converted based on antlr4-c3, including converting the line and column number information into the token index required by antlr4-c3, as shown in the figure below:
+
+![column-image](./docs/images/token.png)
+
+Regard the column in the figure as the cursor position, and put this text into the editor, you will get 13 possible cursor positions, while for dt-sql-parser, this text will generate 4 Tokens after being parsed. An important strategy of the code completion is: **When the cursor (CaretPosition) has not completely left a Token, dt-sql-parser thinks that this Token has not been completed, and the code completion will infer what can be filled in the position of this Token.**
+
+For example, if you want to know what to fill in after `SHOW` through the code completion, the caret position should be:
+
+```javascript
+{
+    lineNumber: 1,
+    column: 6
+}
+```
+
+At this time, dt-sql-parser will think that `SHOW` is already a complete Token, and it should infer what can be filled in after `SHOW`. If the column in the passed-in caret position is 5, then dt-sql-parser will think that `SHOW` has not been completed, and then infer what can be filled in the position of `SHOW`. In other words, in the figure above, `column: 5` belongs to `token: 0`, and `column: 6` belongs to `token: 1`.
+
+For the editor, this strategy is also more intuitive. After the user enters `SHOW`, before pressing the space key, the user probably has not finished entering, maybe the user wants to enter something like `SHOWS`. When the user presses the space key, the editor thinks that the user wants to enter the next Token, and it is time to ask dt-sql-parser what can be filled in the next Token position.
+
+<br/>
 ## License
 
 [MIT](./LICENSE)

package/dist/parser/common/basic-parser-types.d.ts

@@ -46,11 +46,13 @@ export interface WordRange {
     readonly text: string;
     /** start at 0 */
     readonly startIndex: number;
-    readonly stopIndex: number;
+    /** end at ..n-1 */
+    readonly endIndex: number;
     /** start at 1 */
     readonly line: number;
     /** start at 1 */
     readonly startColumn: number;
+    /** end at ..n + 1 */
     readonly stopColumn: number;
 }
 /**
@@ -76,12 +78,15 @@ export interface Suggestions<T = WordRange> {
 export interface TextSlice {
     /** start at 0 */
     readonly startIndex: number;
+    /** end at ..n-1 */
     readonly endIndex: number;
     /** start at 1 */
     readonly startLine: number;
+    /** end at ..n */
     readonly endLine: number;
     /** start at 1 */
     readonly startColumn: number;
+    /** end at ..n + 1 */
     readonly endColumn: number;
     readonly text: string;
 }

package/dist/parser/common/basicParser.d.ts

@@ -31,7 +31,7 @@ export default abstract class BasicParser<L extends Lexer = Lexer, PRC extends P
      * Create a antlr4 Lexer instance.
      * @param input source string
      */
-    protected abstract createLexerFormCharStream(charStreams: CodePointCharStream): L;
+    protected abstract createLexerFromCharStream(charStreams: CodePointCharStream): L;
     /**
      * Create Parser by CommonTokenStream
      * @param tokenStream CommonTokenStream

package/dist/parser/common/basicParser.js

@@ -22,7 +22,7 @@ export default class BasicParser {
      */
     createLexer(input, errorListener) {
         const charStreams = CharStreams.fromString(input.toUpperCase());
-        const lexer = this.createLexerFormCharStream(charStreams);
+        const lexer = this.createLexerFromCharStream(charStreams);
         if (errorListener) {
             lexer.removeErrorListeners();
             lexer.addErrorListener(new ParseErrorListener(errorListener));
@@ -63,7 +63,7 @@ export default class BasicParser {
     createParserWithCache(input) {
         this._parseTree = null;
         this._charStreams = CharStreams.fromString(input.toUpperCase());
-        this._lexer = this.createLexerFormCharStream(this._charStreams);
+        this._lexer = this.createLexerFromCharStream(this._charStreams);
         this._lexer.removeErrorListeners();
         this._lexer.addErrorListener(new ParseErrorListener(this._errorListener));
         this._tokenStream = new CommonTokenStream(this._lexer);
@@ -151,7 +151,7 @@ export default class BasicParser {
                 startLine: start.line,
                 endLine: stop.line,
                 startColumn: start.charPositionInLine + 1,
-                endColumn: stop.charPositionInLine + stop.text.length,
+                endColumn: stop.charPositionInLine + 1 + stop.text.length,
                 text: this._parsedInput.slice(start.startIndex, stop.stopIndex + 1),
             };
         });
@@ -246,10 +246,10 @@ export default class BasicParser {
                 return {
                     text: this._parsedInput.slice(token.startIndex, token.stopIndex + 1),
                     startIndex: token.startIndex,
-                    stopIndex: token.stopIndex,
+                    endIndex: token.stopIndex,
                     line: token.line,
                     startColumn: token.charPositionInLine + 1,
-                    stopColumn: token.charPositionInLine + token.text.length,
+                    stopColumn: token.charPositionInLine + 1 + token.text.length,
                 };
             });
             return {

package/dist/parser/common/parseErrorListener.d.ts

@@ -4,10 +4,14 @@ import { ATNSimulator } from 'antlr4ts/atn/ATNSimulator';
  * Converted from {@link SyntaxError}.
  */
 export interface ParseError {
+    /** start at 1 */
     readonly startLine: number;
+    /** end at ..n */
     readonly endLine: number;
-    readonly startCol: number;
-    readonly endCol: number;
+    /** start at 1 */
+    readonly startColumn: number;
+    /** end at ..n + 1 */
+    readonly endColumn: number;
     readonly message: string;
 }
 /**

package/dist/parser/common/parseErrorListener.js

@@ -11,8 +11,8 @@ export default class ParseErrorListener {
             this._errorListener({
                 startLine: line,
                 endLine: line,
-                startCol: charPositionInLine,
-                endCol: endCol,
+                startColumn: charPositionInLine + 1,
+                endColumn: endCol + 1,
                 message: msg,
             }, {
                 e,

package/dist/parser/flinksql.d.ts

@@ -6,7 +6,7 @@ import { FlinkSqlParserListener } from '../lib/flinksql/FlinkSqlParserListener';
 import { Suggestions } from './common/basic-parser-types';
 import BasicParser from './common/basicParser';
 export default class FlinkSQL extends BasicParser<FlinkSqlLexer, ProgramContext, FlinkSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): FlinkSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): FlinkSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): FlinkSqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): FlinkSqlSplitListener;

package/dist/parser/flinksql.js

@@ -19,7 +19,7 @@ export default class FlinkSQL extends BasicParser {
             FlinkSqlParser.RULE_columnNameCreate,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new FlinkSqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/hive.d.ts

@@ -6,7 +6,7 @@ import BasicParser from './common/basicParser';
 import { HiveSqlParserListener } from '../lib/hive/HiveSqlParserListener';
 import { Suggestions } from './common/basic-parser-types';
 export default class HiveSQL extends BasicParser<HiveSqlLexer, ProgramContext, HiveSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): HiveSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): HiveSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): HiveSqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): HiveSqlSplitListener;

package/dist/parser/hive.js

@@ -19,7 +19,7 @@ export default class HiveSQL extends BasicParser {
             HiveSqlParser.RULE_columnNameCreate,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new HiveSqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/impala.d.ts

@@ -6,7 +6,7 @@ import BasicParser from './common/basicParser';
 import { ImpalaSqlParserListener } from '../lib/impala/ImpalaSqlParserListener';
 import { Suggestions } from './common/basic-parser-types';
 export default class ImpalaSQL extends BasicParser<ImpalaSqlLexer, ProgramContext, ImpalaSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): ImpalaSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): ImpalaSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): ImpalaSqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): ImpalaSqlSplitListener;

package/dist/parser/impala.js

@@ -18,7 +18,7 @@ export default class ImpalaSQL extends BasicParser {
             ImpalaSqlParser.RULE_columnNamePath,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new ImpalaSqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/mysql.d.ts

@@ -6,7 +6,7 @@ import BasicParser from './common/basicParser';
 import { Suggestions } from './common/basic-parser-types';
 import { MySqlParserListener } from '../lib/mysql/MySqlParserListener';
 export default class MySQL extends BasicParser<MySqlLexer, ProgramContext, MySqlParser> {
-    protected createLexerFormCharStream(charStreams: any): MySqlLexer;
+    protected createLexerFromCharStream(charStreams: any): MySqlLexer;
     protected createParserFromTokenStream(tokenStream: any): MySqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): MysqlSplitListener;

package/dist/parser/mysql.js

@@ -18,7 +18,7 @@ export default class MySQL extends BasicParser {
             MySqlParser.RULE_columnNameCreate,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new MySqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/pgsql.d.ts

@@ -6,7 +6,7 @@ import BasicParser from './common/basicParser';
 import { PostgreSQLParserListener } from '../lib/pgsql/PostgreSQLParserListener';
 import { Suggestions } from './common/basic-parser-types';
 export default class PostgresSQL extends BasicParser<PostgreSQLLexer, ProgramContext, PostgreSQLParser> {
-    protected createLexerFormCharStream(charStreams: any): PostgreSQLLexer;
+    protected createLexerFromCharStream(charStreams: any): PostgreSQLLexer;
     protected createParserFromTokenStream(tokenStream: any): PostgreSQLParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): PgSqlSplitListener;

package/dist/parser/pgsql.js

@@ -22,7 +22,7 @@ export default class PostgresSQL extends BasicParser {
             PostgreSQLParser.RULE_column_name, // column name
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new PostgreSQLLexer(charStreams);
         return lexer;
     }

package/dist/parser/plsql.d.ts

@@ -5,7 +5,7 @@ import { PlSqlParser, ProgramContext } from '../lib/plsql/PlSqlParser';
 import BasicParser from './common/basicParser';
 import { Suggestions } from './common/basic-parser-types';
 export default class PLSQL extends BasicParser<PlSqlLexer, ProgramContext, PlSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): PlSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): PlSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): PlSqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): any;

package/dist/parser/plsql.js

@@ -6,7 +6,7 @@ export default class PLSQL extends BasicParser {
         super(...arguments);
         this.preferredRules = new Set();
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new PlSqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/spark.d.ts

@@ -6,7 +6,7 @@ import BasicParser from './common/basicParser';
 import { Suggestions } from './common/basic-parser-types';
 import { SparkSqlParserListener } from '../lib/spark/SparkSqlParserListener';
 export default class SparkSQL extends BasicParser<SparkSqlLexer, ProgramContext, SparkSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): SparkSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): SparkSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): SparkSqlParser;
     protected preferredRules: Set<number>;
     protected get splitListener(): SparkSqlSplitListener;

package/dist/parser/spark.js

@@ -18,7 +18,7 @@ export default class SparkSQL extends BasicParser {
             SparkSqlParser.RULE_columnNameCreate,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new SparkSqlLexer(charStreams);
         return lexer;
     }

package/dist/parser/trinosql.d.ts

@@ -6,7 +6,7 @@ import { TrinoSqlListener } from '../lib/trinosql/TrinoSqlListener';
 import BasicParser from './common/basicParser';
 import { Suggestions } from './common/basic-parser-types';
 export default class TrinoSQL extends BasicParser<TrinoSqlLexer, ProgramContext, TrinoSqlParser> {
-    protected createLexerFormCharStream(charStreams: any): TrinoSqlLexer;
+    protected createLexerFromCharStream(charStreams: any): TrinoSqlLexer;
     protected createParserFromTokenStream(tokenStream: any): TrinoSqlParser;
     protected get splitListener(): TrinoSqlSplitListener;
     protected preferredRules: Set<number>;

package/dist/parser/trinosql.js

@@ -19,7 +19,7 @@ export default class TrinoSQL extends BasicParser {
             TrinoSqlParser.RULE_columnNameCreate,
         ]);
     }
-    createLexerFormCharStream(charStreams) {
+    createLexerFromCharStream(charStreams) {
         const lexer = new TrinoSqlLexer(charStreams);
         return lexer;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dt-sql-parser",
-  "version": "4.0.0-beta.4.10",
+  "version": "4.0.0-beta.4.11",
   "authors": "DTStack Corporation",
   "description": "SQL Parsers for BigData, built with antlr4",
   "keywords": [