Pass source token when formatting identifiers

simolus3 · simolus3 · commit 4583e45763fe · 2026-02-27T16:19:26.000+01:00
diff --git a/docs/lib/src/generated_snippets.dart b/docs/lib/src/generated_snippets.dart
@@ -31,7 +31,7 @@ const generatedSnippets = {
 'lib/src/snippets/drift_files/nested.expr.temp.dart.snippet.json': {'(full)': '<span></span>\n',},
 'lib/src/snippets/drift_files/small_snippets.drift.snippet.json': {'(full)': '<span><span class="keyword">import</span> <span class="string">\'tables.drift\'</span>; <span class="comment">-- single quotes are required for imports</span>\n\n<span class="function declaration">myQuery</span>(<span class="variable">:variable</span> <span class="keyword">AS</span> TEXT): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;\n<span class="function declaration">myNullableQuery</span>(<span class="variable">:variable</span> <span class="keyword">AS</span> TEXT <span class="keyword">OR</span> <span class="keyword">NULL</span>): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;\n<span class="function declaration">myRequiredQuery</span>(<span class="keyword">REQUIRED</span> <span class="variable">:variable</span> <span class="keyword">AS</span> TEXT <span class="keyword">OR</span> <span class="keyword">NULL</span>): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;\n<span class="function declaration">entriesWithId</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> <span class="property">id</span> <span class="keyword">IN</span> <span class="variable">?</span>;\n<span class="function declaration">_filterTodos</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> \$predicate;</span>\n','import': '<span><span class="keyword">import</span> <span class="string">\'tables.drift\'</span>; <span class="comment">-- single quotes are required for imports</span></span>\n','q1': '<span><span class="function declaration">myQuery</span>(<span class="variable">:variable</span> <span class="keyword">AS</span> TEXT): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;</span>\n','q2': '<span><span class="function declaration">myNullableQuery</span>(<span class="variable">:variable</span> <span class="keyword">AS</span> TEXT <span class="keyword">OR</span> <span class="keyword">NULL</span>): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;</span>\n','q3': '<span><span class="function declaration">myRequiredQuery</span>(<span class="keyword">REQUIRED</span> <span class="variable">:variable</span> <span class="keyword">AS</span> TEXT <span class="keyword">OR</span> <span class="keyword">NULL</span>): <span class="keyword">SELECT</span> <span class="variable">:variable</span>;</span>\n','entries': '<span><span class="function declaration">entriesWithId</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> <span class="property">id</span> <span class="keyword">IN</span> <span class="variable">?</span>;</span>\n','filter': '<span><span class="function declaration">_filterTodos</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> \$predicate;</span>\n',},
 'lib/src/snippets/drift_files/small_snippets.expr.temp.dart.snippet.json': {'(full)': '<span></span>\n',},
-'lib/src/snippets/drift_files/tables.drift.snippet.json': {'(full)': '<span><span class="keyword">CREATE</span> <span class="keyword">TABLE</span> <span class="class declaration">todos</span> (\n    <span class="property">id</span> <span class="type">INT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span> <span class="keyword">PRIMARY</span> <span class="keyword">KEY</span> <span class="keyword">AUTOINCREMENT</span>,\n    <span class="property">title</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>,\n    <span class="property">content</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>,\n    <span class="property">category</span> <span class="type">INTEGER</span> <span class="keyword">REFERENCES</span> <span class="class">categories</span>(<span class="property">id</span>)\n);\n\n<span class="keyword">CREATE</span> <span class="keyword">TABLE</span> <span class="class declaration">categories</span> (\n    <span class="property">id</span> <span class="type">INT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span> <span class="keyword">PRIMARY</span> <span class="keyword">KEY</span> <span class="keyword">AUTOINCREMENT</span>,\n    <span class="property">description</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>\n) <span class="keyword">AS</span> Category; <span class="comment">-- the AS xyz after the table defines the data class name</span>\n\n<span class="comment">-- You can also create an index or triggers with drift files</span>\n<span class="keyword">CREATE</span> <span class="keyword">INDEX</span> categories_description <span class="keyword">ON</span> categories(<span class="property">description</span>);\n\n<span class="comment">-- we can put named SQL queries in here as well:</span>\n<span class="function declaration">createEntry</span>: <span class="keyword">INSERT</span> <span class="keyword">INTO</span> <span class="class">todos</span> (<span class="property">title</span>, <span class="property">content</span>) <span class="keyword">VALUES</span> (<span class="variable">:title</span>, <span class="variable">:content</span>);\n<span class="function declaration">deleteById</span>: <span class="keyword">DELETE</span> <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> <span class="property">id</span> = <span class="variable">:id</span>;\n<span class="function declaration">allTodos</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span>;</span>\n',},
+'lib/src/snippets/drift_files/tables.drift.snippet.json': {'(full)': '<span><span class="keyword">CREATE</span> <span class="keyword">TABLE</span> <span class="class declaration">todos</span> (\n    <span class="property">id</span> <span class="type">INT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span> <span class="keyword">PRIMARY</span> <span class="keyword">KEY</span> <span class="keyword">AUTOINCREMENT</span>,\n    <span class="property">title</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>,\n    <span class="property">content</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>,\n    <span class="property">category</span> <span class="type">INTEGER</span> <span class="keyword">REFERENCES</span> <span class="class">categories</span>(<span class="property">id</span>)\n);\n\n<span class="keyword">CREATE</span> <span class="keyword">TABLE</span> <span class="class declaration">categories</span> (\n    <span class="property">id</span> <span class="type">INT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span> <span class="keyword">PRIMARY</span> <span class="keyword">KEY</span> <span class="keyword">AUTOINCREMENT</span>,\n    <span class="property">description</span> <span class="type">TEXT</span> <span class="keyword">NOT</span> <span class="keyword">NULL</span>\n) <span class="keyword">AS</span> Category; <span class="comment">-- the AS xyz after the table defines the data class name</span>\n\n<span class="comment">-- You can also create an index or triggers with drift files</span>\n<span class="keyword">CREATE</span> <span class="keyword">INDEX</span> categories_description <span class="keyword">ON</span> <span class="class">categories</span>(<span class="property">description</span>);\n\n<span class="comment">-- we can put named SQL queries in here as well:</span>\n<span class="function declaration">createEntry</span>: <span class="keyword">INSERT</span> <span class="keyword">INTO</span> <span class="class">todos</span> (<span class="property">title</span>, <span class="property">content</span>) <span class="keyword">VALUES</span> (<span class="variable">:title</span>, <span class="variable">:content</span>);\n<span class="function declaration">deleteById</span>: <span class="keyword">DELETE</span> <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> <span class="property">id</span> = <span class="variable">:id</span>;\n<span class="function declaration">allTodos</span>: <span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span>;</span>\n',},
 'lib/src/snippets/drift_files/tables.expr.temp.dart.snippet.json': {'(full)': '<span></span>\n',},
 'lib/src/snippets/drift_files/tables_comments.drift.snippet.json': {'(full)': '<span><span class="comment">--</span> <span class="keyword">import</span> <span class="string">\'tables.drift\'</span>;\n\n<span class="comment">-- we can put named SQL queries in here as well:</span>\n<span class="comment">--</span> <span class="function declaration">createEntry</span>:\n<span class="keyword">INSERT</span> <span class="keyword">INTO</span> <span class="class">todos</span> (<span class="property">title</span>, <span class="property">content</span>) <span class="keyword">VALUES</span> (<span class="variable">:title</span>, <span class="variable">:content</span>);\n\n<span class="comment">--</span> <span class="function declaration">deleteById</span>:\n<span class="keyword">DELETE</span> <span class="keyword">FROM</span> <span class="class">todos</span> <span class="keyword">WHERE</span> <span class="property">id</span> = <span class="variable">:id</span>;\n\n<span class="comment">--</span> <span class="function declaration">allTodos</span>:\n<span class="keyword">SELECT</span> * <span class="keyword">FROM</span> <span class="class">todos</span>;</span>\n',},
 'lib/src/snippets/drift_files/tables_comments.expr.temp.dart.snippet.json': {'(full)': '<span></span>\n',},
diff --git a/drift_dev/lib/src/writer/queries/sql_writer.dart b/drift_dev/lib/src/writer/queries/sql_writer.dart
@@ -35,7 +35,7 @@ extension ToSqlText on AstNode {
   }
 }
 
-class SqlWriter extends NodeSqlBuilder {
+final class SqlWriter extends NodeSqlBuilder {
   final StringBuffer _out;
   final SqlQuery? query;
   final DriftOptions options;
diff --git a/sqlparser/lib/src/ast/common/queryables.dart b/sqlparser/lib/src/ast/common/queryables.dart
@@ -23,9 +23,9 @@ class TableReference extends TableOrSubquery
     with ReferenceOwner
     implements Renamable, ResolvesToResultSet, InExpressionTarget {
   final String? schemaName;
-  Token? schemaNameToken;
+  IdentifierToken? schemaNameToken;
   final String tableName;
-  Token? tableNameToken;
+  IdentifierToken? tableNameToken;
 
   @override
   AliasClause? as;
@@ -210,7 +210,7 @@ class TableValuedFunction extends Queryable
   final String name;
 
   @override
-  Token? schemaNameToken;
+  IdentifierToken? schemaNameToken;
 
   @override
   Token? nameToken;
diff --git a/sqlparser/lib/src/ast/expressions/aggregate.dart b/sqlparser/lib/src/ast/expressions/aggregate.dart
@@ -10,7 +10,7 @@ class AggregateFunctionInvocation extends Expression
   String get name => function.identifier;
 
   @override
-  Token? schemaNameToken;
+  IdentifierToken? schemaNameToken;
 
   @override
   Token? nameToken;
diff --git a/sqlparser/lib/src/ast/expressions/function.dart b/sqlparser/lib/src/ast/expressions/function.dart
@@ -13,7 +13,7 @@ abstract class SqlInvocation implements AstNode {
   /// The name of the function being called
   String get name;
 
-  Token? schemaNameToken;
+  IdentifierToken? schemaNameToken;
   Token? nameToken;
 
   FunctionParameters get parameters;
@@ -41,7 +41,7 @@ class FunctionExpression extends Expression
   FunctionParameters parameters;
 
   @override
-  Token? schemaNameToken;
+  IdentifierToken? schemaNameToken;
   @override
   Token? nameToken;
 
diff --git a/sqlparser/lib/src/reader/parser.dart b/sqlparser/lib/src/reader/parser.dart
@@ -3182,7 +3182,7 @@ final class _ExpressionParser extends ParserState {
   }
 
   AggregateFunctionInvocation _aggregate(
-    Token? schemaName,
+    IdentifierToken? schemaName,
     IdentifierToken name,
     FunctionParameters params,
     OrderByBase? orderBy,
diff --git a/sqlparser/lib/utils/node_to_text.dart b/sqlparser/lib/utils/node_to_text.dart
@@ -6,7 +6,7 @@ library;
 import 'package:charcode/charcode.dart';
 import 'package:sqlparser/sqlparser.dart';
 
-class NodeSqlBuilder extends AstVisitor<void, void> {
+base class NodeSqlBuilder extends AstVisitor<void, void> {
   final StringSink buffer;
 
   /// Whether we need to insert a space before writing the next identifier.
@@ -822,7 +822,8 @@ class NodeSqlBuilder extends AstVisitor<void, void> {
   @override
   void visitFunction(FunctionExpression e, void arg) {
     if (e.schemaName != null) {
-      identifier(e.schemaName!, spaceAfter: false);
+      identifier(e.schemaName!,
+          fromToken: e.schemaNameToken, spaceAfter: false);
       symbol('.');
     }
     identifier(e.name);
@@ -1080,25 +1081,30 @@ class NodeSqlBuilder extends AstVisitor<void, void> {
     var didWriteSpaceBefore = false;
 
     if (e.schemaName != null) {
-      identifier(e.schemaName!, spaceAfter: false);
+      identifier(e.schemaName!,
+          fromToken: e.schemaNameToken, spaceAfter: false);
       symbol('.');
       didWriteSpaceBefore = true;
     }
     if (e.entityName != null) {
       identifier(e.entityName!,
-          spaceAfter: false, spaceBefore: !didWriteSpaceBefore);
+          spaceAfter: false,
+          fromToken: e.entityNameToken,
+          spaceBefore: !didWriteSpaceBefore);
       symbol('.');
       didWriteSpaceBefore = true;
     }
 
     identifier(e.columnName,
-        spaceAfter: true, spaceBefore: !didWriteSpaceBefore);
+        fromToken: e.columnNameToken,
+        spaceAfter: true,
+        spaceBefore: !didWriteSpaceBefore);
   }
 
   @override
   visitAliasClause(AliasClause e, void arg) {
     keyword(TokenType.as);
-    identifier(e.name);
+    identifier(e.name, fromToken: e.nameToken);
   }
 
   @override
@@ -1251,10 +1257,12 @@ class NodeSqlBuilder extends AstVisitor<void, void> {
   @override
   void visitTableReference(TableReference e, void arg) {
     if (e.schemaName != null) {
-      identifier(e.schemaName!, spaceAfter: false);
+      identifier(e.schemaName!,
+          fromToken: e.schemaNameToken, spaceAfter: false);
       symbol('.');
     }
-    identifier(e.tableName, spaceBefore: e.schemaName == null);
+    identifier(e.tableName,
+        fromToken: e.tableNameToken, spaceBefore: e.schemaName == null);
     visitNullable(e.as, arg);
   }
 
@@ -1482,8 +1490,12 @@ class NodeSqlBuilder extends AstVisitor<void, void> {
   }
 
   /// Writes an identifier, escaping it if necessary.
-  void identifier(String identifier,
-      {bool spaceBefore = true, bool spaceAfter = true}) {
+  void identifier(
+    String identifier, {
+    IdentifierToken? fromToken,
+    bool spaceBefore = true,
+    bool spaceAfter = true,
+  }) {
     if (isKeyword(identifier) || _notAKeywordRegex.hasMatch(identifier)) {
       identifier = escapeIdentifier(identifier);
     }

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ extension ToSqlText on AstNode {`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`
`38`		`-class SqlWriter extends NodeSqlBuilder {`
	`38`	`+final class SqlWriter extends NodeSqlBuilder {`
`39`	`39`	`final StringBuffer _out;`
`40`	`40`	`final SqlQuery? query;`
`41`	`41`	`final DriftOptions options;`
Original file line number	Diff line number	Diff line change
`@@ -3182,7 +3182,7 @@ final class _ExpressionParser extends ParserState {`
`3182`	`3182`	`}`
`3183`	`3183`
`3184`	`3184`	`AggregateFunctionInvocation _aggregate(`
`3185`		`- Token? schemaName,`
	`3185`	`+ IdentifierToken? schemaName,`
`3186`	`3186`	`IdentifierToken name,`
`3187`	`3187`	`FunctionParameters params,`
`3188`	`3188`	`OrderByBase? orderBy,`