Fix assertion on comments near end of file.

Author: threeifbyair

regression-tests/pure2-bugfix-for-late-comments.cpp2

@@ -0,0 +1,11 @@
+
+main: () -> int = {
+  x := crash_m0();
+  _ = x;
+}
+
+crash_m0: type = {
+  operator-: (this, _) -> int = 0;/* Comment starts here
+And continues here
+*/
+}

regression-tests/test-results/pure2-bugfix-for-late-comments.cpp

@@ -0,0 +1,47 @@
+
+#define CPP2_IMPORT_STD          Yes
+
+//=== Cpp2 type declarations ====================================================
+
+
+#include "cpp2util.h"
+
+#line 1 "pure2-bugfix-for-late-comments.cpp2"
+
+#line 7 "pure2-bugfix-for-late-comments.cpp2"
+class crash_m0;
+  
+
+//=== Cpp2 type definitions and function declarations ===========================
+
+#line 1 "pure2-bugfix-for-late-comments.cpp2"
+
+#line 2 "pure2-bugfix-for-late-comments.cpp2"
+[[nodiscard]] auto main() -> int;
+
+#line 7 "pure2-bugfix-for-late-comments.cpp2"
+class crash_m0 {
+  public: [[nodiscard]] auto operator-([[maybe_unused]] auto const& unnamed_param_2) const& -> int;
+  public: crash_m0() = default;
+  public: crash_m0(crash_m0 const&) = delete; /* No 'that' constructor, suppress copy */
+  public: auto operator=(crash_m0 const&) -> void = delete;
+
+
+#line 11 "pure2-bugfix-for-late-comments.cpp2"
+};
+
+
+//=== Cpp2 function definitions =================================================
+
+#line 1 "pure2-bugfix-for-late-comments.cpp2"
+
+#line 2 "pure2-bugfix-for-late-comments.cpp2"
+[[nodiscard]] auto main() -> int{
+  auto x {crash_m0()}; 
+  static_cast<void>(cpp2::move(x));
+}
+
+#line 8 "pure2-bugfix-for-late-comments.cpp2"
+  [[nodiscard]] auto crash_m0::operator-([[maybe_unused]] auto const& unnamed_param_2) const& -> int { return 0;  }/* Comment starts here
+And continues here
+*/

regression-tests/test-results/pure2-bugfix-for-late-comments.cpp2.output

@@ -0,0 +1,2 @@
+pure2-bugfix-for-late-comments.cpp2... ok (all Cpp2, passes safety checks)
+

source/to_cpp1.h

@@ -432,7 +432,7 @@ class positional_printer
         c.dbg_was_printed = true;
     }
 
-    auto flush_comments( source_position pos )
+    auto flush_comments( source_position pos, bool print_remaining_comments = false )
         -> void
     {
         if (!pcomments) {
@@ -444,7 +444,7 @@ class positional_printer
 
         //  Add unprinted comments and blank lines as needed to catch up vertically
         //
-        while (curr_pos.lineno < pos.lineno)
+        while (print_remaining_comments ? (next_comment < std::ssize(comments)) : (curr_pos.lineno < pos.lineno))
         {
             //  If a comment goes on this line, print it
             if (
@@ -468,7 +468,8 @@ class positional_printer
                     )
                 {
                     print_comment( comments[next_comment] );
-                    assert(curr_pos.lineno <= pos.lineno);  // we shouldn't have overshot
+                    if (!print_remaining_comments)
+                        assert(curr_pos.lineno <= pos.lineno);  // we shouldn't have overshot
                 }
 
                 ++next_comment;
@@ -479,6 +480,9 @@ class positional_printer
                 print("\n");
             }
         }
+        // And catch up.
+        while (curr_pos.lineno < pos.lineno)
+            print("\n");
     }
 
     auto print_unprinted_comments()
@@ -589,7 +593,7 @@ class positional_printer
             && psource->has_cpp2()
             )
         {
-            flush_comments( {curr_pos.lineno+1, 1} );
+            flush_comments( {curr_pos.lineno+1, 1}, print_remaining_comments );
 
             if (print_remaining_comments) {
                 print_unprinted_comments();