Improve syntax highlighting in the sql IDE

moor_generator/lib/src/backends/plugin/backend/driver.dart

@@ -3,8 +3,8 @@ import 'dart:async';
 
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/file_system/file_system.dart';
-import 'package:analyzer/src/dart/analysis/file_state.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
+import 'package:analyzer/src/dart/analysis/file_state.dart';
 import 'package:logging/logging.dart';
 import 'package:moor_generator/src/analyzer/runner/file_graph.dart';
 import 'package:moor_generator/src/analyzer/session.dart';
@@ -154,8 +154,13 @@ class MoorDriver implements AnalysisDriverGeneric {
     return session.completedTasks.expand((task) => task.analyzedFiles);
   }
 
-  /// Waits for the file at [path] to be parsed.
+  /// Waits for the file at [path] to be parsed. If the file is neither a Dart
+  /// or a moor file, returns `null`.
   Future<FoundFile> waitFileParsed(String path) {
+    if (!_ownsFile(path)) {
+      return Future.value(null);
+    }
+
     final found = pathToFoundFile(path);
 
     if (found.isParsed) {

moor_generator/lib/src/backends/plugin/backend/driver_synchronizer.dart

@@ -1,9 +1,9 @@
 import 'dart:async';
 import 'dart:collection';
 
-// ignore: implementation_imports
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:moor_generator/src/analyzer/runner/task.dart';
+
 import 'driver.dart';
 
 const _lowestPriority = AnalysisDriverPriority.general;
@@ -43,7 +43,7 @@ class DriverSynchronizer {
     assert(_currentUnit != null && _waitForResume == null,
         'Dart driver can only be used as a part of a non-paused task');
     _waitForResume = Completer();
-    // make safeRunTask or resume complete, so tha work is delegated to the
+    // make safeRunTask or resume complete, so that work is delegated to the
     // dart driver
     _currentUnit._completeCurrentStep();
 
@@ -61,11 +61,12 @@ class DriverSynchronizer {
     return _currentUnit._currentCompleter.future;
   }
 
-  Future<void> safeRunTask(Task task) {
+  Future<void> safeRunTask(Task task) async {
     assert(!hasPausedWork, "Can't start a new task, another one was paused");
     _currentUnit = _WorkUnit()..task = task;
 
-    task.runTask().then((_) => _handleTaskCompleted(task));
+    await task.runTask();
+    _handleTaskCompleted(task);
 
     return _currentUnit._currentCompleter.future;
   }

moor_generator/lib/src/backends/plugin/plugin.dart

@@ -1,6 +1,6 @@
-import 'package:analyzer/src/context/context_root.dart'; // ignore: implementation_imports
-import 'package:analyzer/src/context/builder.dart'; // ignore: implementation_imports
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/src/context/builder.dart'; // ignore: implementation_imports
+import 'package:analyzer/src/context/context_root.dart'; // ignore: implementation_imports
 import 'package:analyzer_plugin/plugin/assist_mixin.dart';
 import 'package:analyzer_plugin/plugin/completion_mixin.dart';
 import 'package:analyzer_plugin/plugin/folding_mixin.dart';
@@ -8,6 +8,7 @@ import 'package:analyzer_plugin/plugin/highlights_mixin.dart';
 import 'package:analyzer_plugin/plugin/navigation_mixin.dart';
 import 'package:analyzer_plugin/plugin/outline_mixin.dart';
 import 'package:analyzer_plugin/plugin/plugin.dart';
+import 'package:analyzer_plugin/protocol/protocol.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
 import 'package:analyzer_plugin/utilities/assist/assist.dart';
 import 'package:analyzer_plugin/utilities/completion/completion_core.dart';
@@ -15,6 +16,7 @@ import 'package:analyzer_plugin/utilities/folding/folding.dart';
 import 'package:analyzer_plugin/utilities/highlights/highlights.dart';
 import 'package:analyzer_plugin/utilities/navigation/navigation.dart';
 import 'package:analyzer_plugin/utilities/outline/outline.dart';
+import 'package:moor_generator/src/analyzer/runner/file_graph.dart';
 import 'package:moor_generator/src/backends/plugin/backend/file_tracker.dart';
 import 'package:moor_generator/src/backends/plugin/services/assists/assist_service.dart';
 import 'package:moor_generator/src/backends/plugin/services/autocomplete.dart';
@@ -97,10 +99,26 @@ class MoorPlugin extends ServerPlugin
     return driver as MoorDriver;
   }
 
-  Future<MoorRequest> _createMoorRequest(String path) async {
+  Future<FoundFile> _waitParsed(String path) async {
     final driver = _moorDriverForPath(path);
-    final file = await driver.waitFileParsed(path);
+    if (driver == null) {
+      throw RequestFailure(plugin.RequestError(
+          plugin.RequestErrorCode.INVALID_PARAMETER,
+          "Path isn't covered by plugin: $path"));
+    }
 
+    final file = await driver.waitFileParsed(path);
+    if (file == null) {
+      throw RequestFailure(plugin.RequestError(
+          plugin.RequestErrorCode.PLUGIN_ERROR,
+          'Unknown file: Neither Dart or moor: $path'));
+    }
+
+    return file;
+  }
+
+  Future<MoorRequest> _createMoorRequest(String path) async {
+    final file = await _waitParsed(path);
     return MoorRequest(file, resourceProvider);
   }
 
@@ -110,8 +128,9 @@ class MoorPlugin extends ServerPlugin
   }
 
   @override
-  Future<OutlineRequest> getOutlineRequest(String path) =>
-      _createMoorRequest(path);
+  Future<OutlineRequest> getOutlineRequest(String path) {
+    return _createMoorRequest(path);
+  }
 
   @override
   List<HighlightsContributor> getHighlightsContributors(String path) {
@@ -119,8 +138,9 @@ class MoorPlugin extends ServerPlugin
   }
 
   @override
-  Future<HighlightsRequest> getHighlightsRequest(String path) =>
-      _createMoorRequest(path);
+  Future<HighlightsRequest> getHighlightsRequest(String path) {
+    return _createMoorRequest(path);
+  }
 
   @override
   List<FoldingContributor> getFoldingContributors(String path) {
@@ -128,8 +148,9 @@ class MoorPlugin extends ServerPlugin
   }
 
   @override
-  Future<FoldingRequest> getFoldingRequest(String path) =>
-      _createMoorRequest(path);
+  Future<FoldingRequest> getFoldingRequest(String path) {
+    return _createMoorRequest(path);
+  }
 
   @override
   List<CompletionContributor> getCompletionContributors(String path) {
@@ -140,8 +161,7 @@ class MoorPlugin extends ServerPlugin
   Future<CompletionRequest> getCompletionRequest(
       plugin.CompletionGetSuggestionsParams parameters) async {
     final path = parameters.file;
-    final driver = _moorDriverForPath(path);
-    final file = await driver.waitFileParsed(path);
+    final file = await _waitParsed(path);
 
     return MoorCompletionRequest(parameters.offset, resourceProvider, file);
   }
@@ -155,8 +175,7 @@ class MoorPlugin extends ServerPlugin
   Future<AssistRequest> getAssistRequest(
       plugin.EditGetAssistsParams parameters) async {
     final path = parameters.file;
-    final driver = _moorDriverForPath(path);
-    final file = await driver.waitFileParsed(path);
+    final file = await _waitParsed(path);
 
     return MoorRequestAtPosition(
         file, parameters.length, parameters.offset, resourceProvider);
@@ -171,8 +190,7 @@ class MoorPlugin extends ServerPlugin
   Future<NavigationRequest> getNavigationRequest(
       plugin.AnalysisGetNavigationParams parameters) async {
     final path = parameters.file;
-    final driver = _moorDriverForPath(path);
-    final file = await driver.waitFileParsed(path);
+    final file = await _waitParsed(path);
 
     return MoorRequestAtPosition(
         file, parameters.length, parameters.offset, resourceProvider);

moor_generator/lib/src/backends/plugin/services/highlights.dart

@@ -21,10 +21,22 @@ class MoorHighlightContributor implements HighlightsContributor {
       result.parsedFile.accept(visitor);
 
       for (final token in result.parseResult.tokens) {
+        final start = token.span.start.offset;
+        final length = token.span.length;
+
         if (token is KeywordToken && !token.isIdentifier) {
-          final start = token.span.start.offset;
-          final length = token.span.length;
           collector.addRegion(start, length, HighlightRegionType.BUILT_IN);
+        } else if (token is CommentToken) {
+          final mode = const {
+            CommentMode.cStyle: HighlightRegionType.COMMENT_BLOCK,
+            CommentMode.line: HighlightRegionType.COMMENT_END_OF_LINE,
+          }[token];
+          collector.addRegion(start, length, mode);
+        } else if (token is InlineDartToken) {
+          collector.addRegion(start, length, HighlightRegionType.ANNOTATION);
+        } else if (token is VariableToken) {
+          collector.addRegion(
+              start, length, HighlightRegionType.PARAMETER_REFERENCE);
         }
       }
     }
@@ -36,7 +48,7 @@ class _HighlightingVisitor extends RecursiveVisitor<void> {
 
   _HighlightingVisitor(this.collector);
 
-  void _contribute(AstNode node, HighlightRegionType type) {
+  void _contribute(SyntacticEntity node, HighlightRegionType type) {
     final offset = node.firstPosition;
     final length = node.lastPosition - offset;
     collector.addRegion(offset, length, type);
@@ -44,7 +56,70 @@ class _HighlightingVisitor extends RecursiveVisitor<void> {
 
   @override
   void visitReference(Reference e) {
-    _contribute(e, HighlightRegionType.INSTANCE_FIELD_REFERENCE);
+    _contribute(e, HighlightRegionType.INSTANCE_GETTER_REFERENCE);
+  }
+
+  @override
+  void visitQueryable(Queryable e) {
+    if (e is TableReference) {
+      final tableToken = e.tableNameToken;
+      if (tableToken != null) {
+        _contribute(e, HighlightRegionType.TYPE_PARAMETER);
+      }
+    }
+    visitChildren(e);
+  }
+
+  @override
+  void visitCreateTableStatement(CreateTableStatement e) {
+    _visitTableInducingStatement(e);
+  }
+
+  @override
+  void visitCreateVirtualTableStatement(CreateVirtualTableStatement e) {
+    _visitTableInducingStatement(e);
+  }
+
+  void _visitTableInducingStatement(TableInducingStatement e) {
+    if (e.tableNameToken != null) {
+      _contribute(e.tableNameToken, HighlightRegionType.CLASS);
+    }
+
+    visitChildren(e);
+  }
+
+  @override
+  void visitColumnDefinition(ColumnDefinition e) {
+    final nameToken = e.nameToken;
+    if (nameToken != null) {
+      _contribute(nameToken, HighlightRegionType.INSTANCE_FIELD_DECLARATION);
+    }
+
+    final typeTokens = e.typeNames;
+    if (typeTokens != null && typeTokens.isNotEmpty) {
+      final first = typeTokens.first.firstPosition;
+      final last = typeTokens.last.lastPosition;
+      final length = last - first;
+      collector.addRegion(first, length, HighlightRegionType.TYPE_PARAMETER);
+    }
+
+    visitChildren(e);
+  }
+
+  @override
+  void visitSetComponent(SetComponent e) {
+    _contribute(e.column, HighlightRegionType.INSTANCE_SETTER_REFERENCE);
+    visitChildren(e);
+  }
+
+  @override
+  void visitMoorDeclaredStatement(DeclaredStatement e) {
+    if (e.identifier != null) {
+      _contribute(
+          e.identifier, HighlightRegionType.TOP_LEVEL_FUNCTION_DECLARATION);
+    }
+
+    visitChildren(e);
   }
 
   @override

moor_generator/lib/src/backends/plugin/services/navigation.dart

@@ -32,9 +32,10 @@ class _NavigationVisitor extends RecursiveVisitor<void> {
     final offset = span.start.offset;
     final length = span.end.offset - offset;
 
-    // The client only wants the navigation target for a single region, but
-    // we always scan the whole file. Only report if there is an intersection
-    if (intersect(span, request.span)) {
+    // Some clients only want the navigation target for a single region, others
+    // want the whole file. For the former, only report regions is there is an
+    // intersection
+    if (!request.hasSpan || intersect(span, request.span)) {
       collector.addRegion(offset, length, kind, target);
     }
   }
@@ -99,7 +100,7 @@ class _NavigationVisitor extends RecursiveVisitor<void> {
     if (e is TableReference) {
       final resolved = e.resolved;
 
-      if (resolved is Table) {
+      if (resolved is Table && resolved != null) {
         final declaration = resolved.meta<TableDeclaration>();
         _reportForSpan(
             e.span, ElementKind.CLASS, locationOfDeclaration(declaration));

moor_generator/lib/src/backends/plugin/services/requests.dart

@@ -68,6 +68,8 @@ class MoorRequestAtPosition
   @override
   final ResourceProvider resourceProvider;
 
+  bool get hasSpan => offset > 0;
+
   SourceSpan get span {
     return SourceSpan(
       SourceLocation(offset),

sqlparser/lib/sqlparser.dart

@@ -6,4 +6,5 @@ export 'src/ast/ast.dart';
 export 'src/engine/module/module.dart';
 export 'src/engine/sql_engine.dart';
 export 'src/reader/parser/parser.dart' show ParsingError;
+export 'src/reader/syntactic_entity.dart';
 export 'src/reader/tokenizer/token.dart' hide keywords, moorKeywords, isKeyword;

sqlparser/lib/src/analysis/steps/set_parent_visitor.dart

@@ -12,6 +12,7 @@ class SetParentVisitor {
     node.parent = parent;
 
     for (final child in node.childNodes) {
+      assert(child != null, '$node had a null-child');
       _applyFor(child, node);
     }
   }

sqlparser/lib/src/ast/ast.dart

@@ -1,18 +1,17 @@
 import 'package:collection/collection.dart';
 import 'package:meta/meta.dart';
 import 'package:source_span/source_span.dart';
-import 'package:sqlparser/src/reader/tokenizer/token.dart';
 import 'package:sqlparser/src/analysis/analysis.dart';
+import 'package:sqlparser/src/reader/syntactic_entity.dart';
+import 'package:sqlparser/src/reader/tokenizer/token.dart';
 import 'package:sqlparser/src/utils/meta.dart';
 
 part 'clauses/limit.dart';
 part 'clauses/ordering.dart';
 part 'clauses/with.dart';
-
 part 'common/queryables.dart';
 part 'common/renamable.dart';
 part 'common/tuple.dart';
-
 part 'expressions/aggregate.dart';
 part 'expressions/case.dart';
 part 'expressions/expressions.dart';
@@ -22,15 +21,12 @@ part 'expressions/reference.dart';
 part 'expressions/simple.dart';
 part 'expressions/subquery.dart';
 part 'expressions/variables.dart';
-
 part 'moor/declared_statement.dart';
 part 'moor/import_statement.dart';
 part 'moor/inline_dart.dart';
 part 'moor/moor_file.dart';
-
 part 'schema/column_definition.dart';
 part 'schema/table_definition.dart';
-
 part 'statements/create_table.dart';
 part 'statements/delete.dart';
 part 'statements/insert.dart';
@@ -39,7 +35,7 @@ part 'statements/statement.dart';
 part 'statements/update.dart';
 
 /// A node in the abstract syntax tree of an SQL statement.
-abstract class AstNode with HasMetaMixin {
+abstract class AstNode with HasMetaMixin implements SyntacticEntity {
   /// The parent of this node, or null if this is the root node. Will be set
   /// by the analyzer after the tree has been parsed.
   AstNode parent;
@@ -52,25 +48,22 @@ abstract class AstNode with HasMetaMixin {
   /// all nodes.
   Token last;
 
-  /// Whether this ast node is synthetic, meaning that it doesn't appear in the
-  /// actual source.
+  @override
   bool synthetic;
 
-  /// The first index in the source that belongs to this node. Not set for all
-  /// nodes.
+  @override
   int get firstPosition => first.span.start.offset;
 
-  /// The (exclusive) last index of this node in the source. In other words, the
-  /// first index that is _not_ a part of this node. Not set for all nodes.
+  @override
   int get lastPosition => last.span.end.offset;
 
+  @override
   FileSpan get span {
     if (!hasSpan) return null;
     return first.span.expand(last.span);
   }
 
-  /// Whether a source span has been set on this node. The span describes what
-  /// range in the source code is covered by this node.
+  @override
   bool get hasSpan => first != null && last != null;
 
   /// Sets the [AstNode.first] and [AstNode.last] property in one go.

sqlparser/lib/src/ast/common/queryables.dart

@@ -39,6 +39,8 @@ class TableReference extends TableOrSubquery
     with ReferenceOwner
     implements Renamable, ResolvesToResultSet, VisibleToChildren {
   final String tableName;
+  Token tableNameToken;
+
   @override
   final String as;
 

sqlparser/lib/src/ast/schema/column_definition.dart

@@ -8,6 +8,7 @@ class ColumnDefinition extends AstNode {
 
   /// The tokens there were involved in defining the type of this column.
   List<Token> typeNames;
+  Token nameToken;
 
   ColumnDefinition(
       {@required this.columnName,

sqlparser/lib/src/ast/statements/create_table.dart

@@ -11,6 +11,8 @@ abstract class TableInducingStatement extends Statement
   /// enabled or if no name has been set.
   final String overriddenDataClassName;
 
+  Token tableNameToken;
+
   TableInducingStatement._(this.ifNotExists, this.tableName,
       [this.overriddenDataClassName]);
 }

sqlparser/lib/src/reader/parser/crud.dart

@@ -285,7 +285,8 @@ mixin CrudParser on ParserBase {
       final tableName = firstToken.identifier;
       final alias = _as();
       return TableReference(tableName, alias?.identifier)
-        ..setSpan(firstToken, _previous);
+        ..setSpan(firstToken, _previous)
+        ..tableNameToken = firstToken;
     }
     return null;
   }

sqlparser/lib/src/reader/parser/schema.dart

@@ -20,7 +20,7 @@ mixin SchemaParser on ParserBase {
     final tableIdentifier = _consumeIdentifier('Expected a table name');
 
     if (virtual) {
-      return _virtualTable(first, ifNotExists, tableIdentifier.identifier);
+      return _virtualTable(first, ifNotExists, tableIdentifier);
     }
 
     // we don't currently support CREATE TABLE x AS SELECT ... statements
@@ -69,13 +69,14 @@ mixin SchemaParser on ParserBase {
     )
       ..setSpan(first, _previous)
       ..openingBracket = leftParen
-      ..closingBracket = rightParen;
+      ..closingBracket = rightParen
+      ..tableNameToken = tableIdentifier;
   }
 
   /// Parses a `CREATE VIRTUAL TABLE` statement, after the `CREATE VIRTUAL TABLE
   /// <name>` tokens have already been read.
   CreateVirtualTableStatement _virtualTable(
-      Token first, bool ifNotExists, String name) {
+      Token first, bool ifNotExists, IdentifierToken nameToken) {
     _consume(TokenType.using, 'Expected USING for virtual table declaration');
     final moduleName = _consumeIdentifier('Expected a module name');
     final args = <SourceSpanWithContext>[];
@@ -132,11 +133,13 @@ mixin SchemaParser on ParserBase {
     final moorDataClassName = _overriddenDataClassName();
     return CreateVirtualTableStatement(
       ifNotExists: ifNotExists,
-      tableName: name,
+      tableName: nameToken.identifier,
       moduleName: moduleName.identifier,
       arguments: args,
       overriddenDataClassName: moorDataClassName,
-    )..setSpan(first, _previous);
+    )
+      ..setSpan(first, _previous)
+      ..tableNameToken = nameToken;
   }
 
   String _overriddenDataClassName() {
@@ -171,7 +174,8 @@ mixin SchemaParser on ParserBase {
       constraints: constraints,
     )
       ..setSpan(name, _previous)
-      ..typeNames = typeTokens;
+      ..typeNames = typeTokens
+      ..nameToken = name;
   }
 
   List<Token> _typeName() {

sqlparser/lib/src/reader/syntactic_entity.dart

@@ -0,0 +1,28 @@
+import 'package:source_span/source_span.dart';
+
+/// Interface for entities that appear in a piece of text. As far as the
+/// parser is concerned, this contains tokens and ast nodes.
+abstract class SyntacticEntity {
+  /// Whether this entity has a source span associated with it.
+  bool get hasSpan;
+
+  /// The piece of text forming this syntactic entity.
+  FileSpan get span;
+
+  /// The first position of this entity, as an zero-based offset in the file it
+  /// was read from.
+  ///
+  /// Instead of returning null, this getter may throw for entities where
+  /// [hasSpan] is false.
+  int get firstPosition;
+
+  /// The (exclusive) last index of this entity in the source.
+  ///
+  /// Instead of returning null, this getter may throw for entities where
+  /// [hasSpan] is false.
+  int get lastPosition;
+
+  /// Whether this entity is synthetic, meaning that it doesn't appear in the
+  /// actual source.
+  bool get synthetic;
+}

sqlparser/lib/src/reader/tokenizer/token.dart

@@ -1,4 +1,5 @@
 import 'package:source_span/source_span.dart';
+import 'package:sqlparser/sqlparser.dart';
 
 enum TokenType {
   leftParen,
@@ -268,13 +269,14 @@ const Map<String, TokenType> moorKeywords = {
 /// Returns true if the [type] belongs to a keyword
 bool isKeyword(TokenType type) => reverseKeywords.containsKey(type);
 
-class Token {
+class Token implements SyntacticEntity {
   final TokenType type;
 
   /// Whether this token should be invisible to the parser. We use this for
   /// comment tokens.
   bool get invisibleToParser => false;
 
+  @override
   final FileSpan span;
   String get lexeme => span.text;
 
@@ -283,10 +285,22 @@ class Token {
 
   Token(this.type, this.span);
 
+  @override
+  bool get hasSpan => true;
+
   @override
   String toString() {
     return '$type: $lexeme';
   }
+
+  @override
+  int get firstPosition => span.start.offset;
+
+  @override
+  int get lastPosition => span.end.offset;
+
+  @override
+  bool get synthetic => false;
 }
 
 class StringLiteralToken extends Token {
@@ -306,6 +320,7 @@ class IdentifierToken extends Token {
   /// Whether this identifier token is synthetic. We sometimes convert
   /// [KeywordToken]s to identifiers if they're unambiguous, in which case
   /// [synthetic] will be true on this token because it was not scanned as such.
+  @override
   final bool synthetic;
 
   String get identifier {
@@ -363,7 +378,7 @@ class InlineDartToken extends Token {
 /// the keywords easily.
 class KeywordToken extends Token {
   /// Whether this token has been used as an identifier while parsing.
-  bool isIdentifier;
+  bool isIdentifier = false;
 
   KeywordToken(TokenType type, FileSpan span) : super(type, span);