Skip to content

Differentiate Shebang from Garbage #59976

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2022
Merged

Differentiate Shebang from Garbage #59976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/swift/Syntax/Trivia.h.gyb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Expand Down
2 changes: 1 addition & 1 deletion lib/Parse/Lexer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions unittests/Parse/LexerTriviaTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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());
}
Expand Down Expand Up @@ -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());
}
Expand Down
2 changes: 1 addition & 1 deletion unittests/Syntax/TriviaTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
2 changes: 2 additions & 0 deletions utils/gyb_syntax_support/Trivia.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
]


Expand Down