Merge pull request #59976 from CodaFi/the-whole-shebang

Differentiate Shebang from Garbage

Author: CodaFi

include/swift/Syntax/Trivia.h.gyb

@@ -366,6 +366,7 @@ private:
     case TriviaKind::DocBlockComment:
       return Text.startswith("/**") && Text.endswith("*/");
     case TriviaKind::GarbageText:
+    case TriviaKind::Shebang:
       return !Text.empty();
 % for trivia in TRIVIAS:
 %   if trivia.is_collection():

lib/Parse/Lexer.cpp

@@ -3214,7 +3214,7 @@ ParsedTrivia TriviaLexer::lexTrivia(StringRef TriviaStr) {
         // Hashbang '#!/path/to/swift'.
         advanceToEndOfLine(CurPtr, BufferEnd);
         size_t Length = CurPtr - TriviaStart;
-        Pieces.push_back(TriviaKind::GarbageText, Length);
+        Pieces.push_back(TriviaKind::Shebang, Length);
         continue;
       }
       break;

unittests/Parse/LexerTriviaTests.cpp

@@ -109,7 +109,7 @@ TEST_F(LexerTriviaTest, TriviaHashbang) {
   ASSERT_EQ(LeadingTrivia, "#!/bin/swift\n");
   ASSERT_EQ(TrailingTrivia, "");
   ASSERT_EQ(LeadingTriviaPieces, (ParsedTrivia{{
-    ParsedTriviaPiece(TriviaKind::GarbageText, strlen("#!/bin/swift")),
+    ParsedTriviaPiece(TriviaKind::Shebang, strlen("#!/bin/swift")),
     ParsedTriviaPiece(TriviaKind::Newline, 1)}}));
   ASSERT_EQ(TrailingTriviaPieces, ParsedTrivia());
 }
@@ -140,7 +140,7 @@ TEST_F(LexerTriviaTest, TriviaHashbangAfterBOM) {
   ASSERT_EQ(TrailingTrivia, "");
   ASSERT_EQ(LeadingTriviaPieces, (ParsedTrivia{{
     ParsedTriviaPiece(TriviaKind::GarbageText, strlen("\xEF\xBB\xBF")),
-    ParsedTriviaPiece(TriviaKind::GarbageText, strlen("#!/bin/swift")),
+    ParsedTriviaPiece(TriviaKind::Shebang, strlen("#!/bin/swift")),
     ParsedTriviaPiece(TriviaKind::Newline, 1)}}));
   ASSERT_EQ(TrailingTriviaPieces, ParsedTrivia());
 }

unittests/Syntax/TriviaTests.cpp

@@ -173,7 +173,7 @@ TEST(TriviaTests, Contains) {
               .contains(TriviaKind::DocBlockComment));
   ASSERT_TRUE(Trivia::docLineComment("///")
               .contains(TriviaKind::DocLineComment));
-  ASSERT_TRUE(Trivia::garbageText("#!swift").contains(TriviaKind::GarbageText));
+  ASSERT_TRUE(Trivia::shebang("#!swift").contains(TriviaKind::Shebang));
   ASSERT_TRUE(Trivia::lineComment("//").contains(TriviaKind::LineComment));
   ASSERT_TRUE(Trivia::newlines(1).contains(TriviaKind::Newline));
   ASSERT_TRUE(Trivia::spaces(1).contains(TriviaKind::Space));

utils/gyb_syntax_support/Trivia.py

@@ -59,6 +59,8 @@ def is_collection(self):
            'with \'*/\'.',
            is_comment=True, serialization_code=11),
     Trivia('GarbageText', 'Any skipped garbage text.', serialization_code=12),
+    Trivia('Shebang', 'A script command, starting with \'#!\'.',
+           serialization_code=13),
 ]