issue 64 hidden comments dont generate foldable blocks (#65)

* issue 64 hidden comments dont generate foldable blocks

* issue 64. now foldable blocks consider all service comments

* issue 64. removed unused function

* fixed import

* issue 64. fix pr comments

* format line

Author: Malarg

lib/src/code/code.dart

@@ -11,6 +11,7 @@ import '../hidden_ranges/hidden_ranges.dart';
 import '../issues/issue.dart';
 import '../named_sections/named_section.dart';
 import '../named_sections/parsers/abstract.dart';
+import '../service_comment_filter/service_comment_filter.dart';
 import '../single_line_comments/parser/single_line_comment_parser.dart';
 import '../single_line_comments/parser/single_line_comments.dart';
 import '../single_line_comments/single_line_comment.dart';
@@ -46,17 +47,12 @@ class Code {
       singleLineCommentSequences: sequences,
     );
 
-    final serviceComments = _filterServiceComments(
+    final serviceComments = ServiceCommentFilter.filter(
       commentParser.comments,
       namedSectionParser: namedSectionParser,
     );
 
-    final lines = _textToCodeLines(
-      text: text,
-      highlighted: highlighted,
-      language: language,
-      commentsByLines: commentParser.getCommentsByLines(),
-    );
+    final serviceCommentsNodesSet = serviceComments.sources;
 
     final issues = <Issue>[];
     final List<FoldableBlock> foldableBlocks;
@@ -65,7 +61,7 @@ class Code {
       foldableBlocks = const [];
     } else {
       final parser = HighlightFoldableBlockParser();
-      parser.parse(highlighted);
+      parser.parse(highlighted, serviceCommentsNodesSet);
       foldableBlocks = parser.blocks;
       issues.addAll(parser.invalidBlocks.map((b) => b.issue));
     }
@@ -76,6 +72,13 @@ class Code {
         const [];
     final sectionsMap = {for (final s in sections) s.name: s};
 
+    final lines = _textToCodeLines(
+      text: text,
+      highlighted: highlighted,
+      language: language,
+      commentsByLines: commentParser.getCommentsByLines(),
+    );
+
     _applyNamedSectionsToLines(
       lines: lines,
       sections: sectionsMap,
@@ -125,38 +128,6 @@ class Code {
     visibleText: '',
   );
 
-  static Iterable<SingleLineComment> _filterServiceComments(
-    List<SingleLineComment> comments, {
-    required AbstractNamedSectionParser? namedSectionParser,
-  }) sync* {
-    for (final comment in comments) {
-      if (_isServiceComment(comment, namedSectionParser: namedSectionParser)) {
-        yield comment;
-      }
-    }
-  }
-
-  static bool _isServiceComment(
-    SingleLineComment comment, {
-    required AbstractNamedSectionParser? namedSectionParser,
-  }) {
-    final words = _getCommentWords(comment.innerContent);
-    if (words.contains(Tokens.readonly)) {
-      return true;
-    }
-
-    if (namedSectionParser != null) {
-      final namedSections = namedSectionParser.parseUnsorted(
-        singleLineComments: [comment],
-      );
-      if (namedSections.isNotEmpty) {
-        return true;
-      }
-    }
-
-    return false;
-  }
-
   static List<CodeLine> _textToCodeLines({
     required String text,
     required Result? highlighted,

lib/src/folding/parsers/highlight.dart

@@ -31,23 +31,25 @@ class HighlightFoldableBlockParser extends AbstractFoldableBlockParser {
   /// not a comment.
   bool _foundNonWhitespace = false;
 
-  void parse(Result highlighted) {
+  void parse(Result highlighted, Set<Object?> serviceCommentsSources) {
     if (highlighted.nodes != null) {
-      _processNodes(highlighted.nodes!);
+      _processNodes(highlighted.nodes!, serviceCommentsSources);
     }
 
     _submitLine(); // In case the last one did not end with '\n'.
     finalize();
   }
 
-  void _processNodes(List<Node> nodes) {
-    nodes.forEach(_processNode);
+  void _processNodes(List<Node> nodes, Set<Object?> serviceCommentsSources) {
+    for (final node in nodes) {
+      _processNode(node, serviceCommentsSources);
+    }
   }
 
-  void _processNode(Node node) {
+  void _processNode(Node node, Set<Object?> serviceCommentsSources) {
     switch (node.className) {
       case NodeClasses.comment:
-        _processComment(node);
+        _processComment(node, serviceCommentsSources);
         break;
 
       case NodeClasses.keyword:
@@ -59,13 +61,21 @@ class HighlightFoldableBlockParser extends AbstractFoldableBlockParser {
         break;
 
       default:
-        _processDefault(node);
+        _processDefault(node, serviceCommentsSources);
     }
   }
 
-  void _processComment(Node node) {
+  void _processComment(Node node, Set<Object?> serviceComments) {
     final newlineCount = node.getNewlineCount();
 
+    if (_foundNonWhitespace) {
+      return;
+    }
+
+    if (serviceComments.contains(node)) {
+      return;
+    }
+
     if (newlineCount == 0) {
       _foundSingleLineComment = true;
       return;
@@ -114,11 +124,11 @@ class HighlightFoldableBlockParser extends AbstractFoldableBlockParser {
     _lineIndex += newlineCount;
   }
 
-  void _processDefault(Node node) {
+  void _processDefault(Node node, Set<Object?> serviceCommentsSources) {
     _processDefaultValue(node);
 
     if (node.children != null) {
-      _processNodes(node.children!);
+      _processNodes(node.children!, serviceCommentsSources);
     }
   }
 

lib/src/service_comment_filter/service_comment_filter.dart

@@ -0,0 +1,43 @@
+import '../../flutter_code_editor.dart';
+import '../single_line_comments/single_line_comment.dart';
+
+class ServiceCommentFilter {
+  static Iterable<SingleLineComment> filter(
+    List<SingleLineComment> comments, {
+    required AbstractNamedSectionParser? namedSectionParser,
+  }) sync* {
+    for (final comment in comments) {
+      if (_isServiceComment(comment, namedSectionParser: namedSectionParser)) {
+        yield comment;
+      }
+    }
+  }
+
+  static bool _isServiceComment(
+    SingleLineComment comment, {
+    required AbstractNamedSectionParser? namedSectionParser,
+  }) {
+    final words = _getCommentWords(comment.innerContent);
+    if (words.contains(Tokens.readonly)) {
+      return true;
+    }
+
+    if (namedSectionParser != null) {
+      final namedSections = namedSectionParser.parseUnsorted(
+        singleLineComments: [comment],
+      );
+      if (namedSections.isNotEmpty) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  static List<String> _getCommentWords(
+    String? comment,
+  ) {
+    // Split by any whitespaces.
+    return comment?.split(RegExp(r'\s+')) ?? const <String>[];
+  }
+}

lib/src/single_line_comments/parser/highlight_single_line_comment_parser.dart

@@ -35,6 +35,7 @@ class HighlightSingleLineCommentParser extends AbstractSingleLineCommentParser {
               lineIndex: lineIndex,
               characterIndex: characterIndex,
               sequences: singleLineCommentSequences,
+              source: node,
             ),
           );
         }

lib/src/single_line_comments/parser/text_single_line_comment_parser.dart

@@ -32,6 +32,7 @@ class TextSingleLineCommentParser extends AbstractSingleLineCommentParser {
             lineIndex: lineIndex,
             characterIndex: characterIndex + column,
             sequences: singleLineCommentSequences,
+            source: line,
           ),
         );
       }

lib/src/single_line_comments/single_line_comment.dart

@@ -14,11 +14,17 @@ class SingleLineComment {
   /// The comment text with the characters signifying the comment.
   final String outerContent;
 
+  /// The object this comment was parsed from, if any.
+  ///
+  /// The object class is specific to the parser.
+  final Object? source;
+
   const SingleLineComment({
     required this.innerContent,
     required this.lineIndex,
     this.characterIndex = 0,
     this.outerContent = '',
+    this.source,
   });
 
   /// Creates the object from [outerContent] by extracting [innerContent]
@@ -28,6 +34,7 @@ class SingleLineComment {
     required int characterIndex,
     required int lineIndex,
     required List<String> sequences,
+    Object? source,
   }) : this(
           characterIndex: characterIndex,
           innerContent: _cutSequence(
@@ -36,6 +43,7 @@ class SingleLineComment {
           ),
           lineIndex: lineIndex,
           outerContent: outerContent,
+          source: source,
         );
 
   @override
@@ -71,3 +79,7 @@ class SingleLineComment {
     throw Exception('$outerContent does not start with any of $sequences');
   }
 }
+
+extension SingleLineCommentIterable on Iterable<SingleLineComment> {
+  Set<Object?> get sources => {...map((e) => e.source)};
+}

test/src/folding/parsers/highlight_parser_test.dart

@@ -1,4 +1,8 @@
 import 'package:flutter_code_editor/flutter_code_editor.dart';
+import 'package:flutter_code_editor/src/service_comment_filter/service_comment_filter.dart';
+import 'package:flutter_code_editor/src/single_line_comments/parser/single_line_comment_parser.dart';
+import 'package:flutter_code_editor/src/single_line_comments/parser/single_line_comments.dart';
+import 'package:flutter_code_editor/src/single_line_comments/single_line_comment.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:highlight/highlight.dart';
 import 'package:highlight/languages/java.dart';
@@ -177,14 +181,57 @@ import java.lang.Exception;''',
           ],
           expectedInvalid: const [],
         ),
+
+        _Example(
+          'Java. Comment after a closing brace',
+          code: '''
+class MyClass {
+  void method() {
+  }// comment
+  // comment
+}''',
+          mode: java,
+          expected: const [
+            _FB(startLine: 0, endLine: 4, type: _T.braces),
+            _FB(startLine: 1, endLine: 2, type: _T.braces),
+          ],
+          expectedInvalid: const [],
+        ),
+
+        _Example(
+          'Java. Service comment sequences do not form a foldable block.',
+          code: '''
+class MyClass {
+  // [START section1]
+  // [END section2]
+}''',
+          mode: java,
+          expected: const [
+            _FB(startLine: 0, endLine: 3, type: _T.braces),
+          ],
+          expectedInvalid: const [],
+        ),
       ];
 
       for (final example in examples) {
         highlight.registerLanguage('language', example.mode);
         final highlighted = highlight.parse(example.code, language: 'language');
         final parser = HighlightFoldableBlockParser();
 
-        parser.parse(highlighted);
+        final sequences = SingleLineComments.byMode[example.mode] ?? [];
+
+        final commentParser = SingleLineCommentParser.parseHighlighted(
+          text: example.code,
+          highlighted: highlighted,
+          singleLineCommentSequences: sequences,
+        );
+
+        final serviceComments = ServiceCommentFilter.filter(
+          commentParser.comments,
+          namedSectionParser: const BracketsStartEndNamedSectionParser(),
+        );
+
+        parser.parse(highlighted, serviceComments.sources);
 
         expect(
           parser.blocks,