Skip to content

Disallow multi-line filenames and non-decimal line numbers in #sourceLocation directive in Swift 6 mode #71238

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 2 commits into from
Feb 1, 2024
Merged

Disallow multi-line filenames and non-decimal line numbers in #sourceLocation directive in Swift 6 mode #71238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e2430b
[Parse] Disallow non-decimal line numbers to `#sourceLocation` directive
ahoppen Jan 30, 2024
4a386d4
[Parse] Disallow multiline string literals for filename in #sourceLoc…
ahoppen Jan 30, 2024
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
2 changes: 2 additions & 0 deletions include/swift/AST/DiagnosticsParse.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ WARNING(escaped_parameter_name,none,

ERROR(forbidden_interpolated_string,none,
"%0 cannot be an interpolated string literal", (StringRef))
ERROR(forbidden_multiline_string,none,
"%0 cannot be a multi-line string literal", (StringRef))
ERROR(forbidden_extended_escaping_string,none,
"%0 cannot be an extended escaping string literal", (StringRef))

Expand Down
5 changes: 4 additions & 1 deletion include/swift/Parse/Parser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,8 +706,11 @@ class Parser {
///
/// \param Loc where to diagnose.
/// \param DiagText name for the string literal in the diagnostic.
/// \param AllowMultiline Whether the string literal can be a multiline string
/// literal.
llvm::Optional<StringRef>
getStringLiteralIfNotInterpolated(SourceLoc Loc, StringRef DiagText);
getStringLiteralIfNotInterpolated(SourceLoc Loc, StringRef DiagText,
bool AllowMultiline);

/// Returns true to indicate that experimental concurrency syntax should be
/// parsed if the parser is generating only a syntax tree or if the user has
Expand Down
42 changes: 26 additions & 16 deletions lib/Parse/ParseDecl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,8 @@ ParserResult<AvailableAttr> Parser::parseExtendedAvailabilitySpecList(
}

auto Value = getStringLiteralIfNotInterpolated(
AttrLoc, ("'" + ArgumentKindStr + "'").str());
AttrLoc, ("'" + ArgumentKindStr + "'").str(),
/*AllowMultiline=*/true);
consumeToken();
if (!Value) {
AnyArgumentInvalid = true;
Expand Down Expand Up @@ -1453,7 +1454,8 @@ bool Parser::parseExternAttribute(DeclAttributes &Attributes,
return std::nullopt;
}
llvm::Optional<StringRef> importModuleName =
getStringLiteralIfNotInterpolated(Loc, ("'" + AttrName + "'").str());
getStringLiteralIfNotInterpolated(Loc, ("'" + AttrName + "'").str(),
/*AllowMultiline=*/false);
consumeToken(tok::string_literal);

if (!importModuleName.has_value()) {
Expand Down Expand Up @@ -3233,8 +3235,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
return makeParserSuccess();
}

AsmName =
getStringLiteralIfNotInterpolated(Loc, ("'" + AttrName + "'").str());
AsmName = getStringLiteralIfNotInterpolated(
Loc, ("'" + AttrName + "'").str(), /*AllowMultiline=*/false);

consumeToken(tok::string_literal);

Expand Down Expand Up @@ -3305,7 +3307,7 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
}

auto Name = getStringLiteralIfNotInterpolated(
Loc, ("'" + AttrName + "'").str());
Loc, ("'" + AttrName + "'").str(), /*AllowMultiline=*/false);

consumeToken(tok::string_literal);

Expand Down Expand Up @@ -3392,7 +3394,7 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
}

auto Value = getStringLiteralIfNotInterpolated(
Loc, ("'" + AttrName + "'").str());
Loc, ("'" + AttrName + "'").str(), /*AllowMultiline=*/false);

consumeToken(tok::string_literal);

Expand Down Expand Up @@ -3455,8 +3457,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
// Parse the next string literal as the original module name.
auto ModuleNameLoc = Tok.getLoc();
if (Tok.is(tok::string_literal)) {
auto NameOp = getStringLiteralIfNotInterpolated(Tok.getLoc(),
"original module name");
auto NameOp = getStringLiteralIfNotInterpolated(
Tok.getLoc(), "original module name", /*AllowMultiline=*/false);
if (NameOp.has_value())
OriginalModuleName = *NameOp;
consumeToken();
Expand Down Expand Up @@ -3545,7 +3547,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
diagnose(ColonLoc, diag::attr_private_import_expected_sourcefile_name);
return makeParserSuccess();
}
filename = getStringLiteralIfNotInterpolated(Loc, "_private");
filename = getStringLiteralIfNotInterpolated(Loc, "_private",
/*AllowMultiline=*/false);
if (!filename.has_value()) {
diagnose(ColonLoc, diag::attr_private_import_expected_sourcefile_name);
return makeParserSuccess();
Expand Down Expand Up @@ -3818,8 +3821,8 @@ ParserStatus Parser::parseNewDeclAttribute(DeclAttributes &Attributes,
return makeParserSuccess();
}

llvm::Optional<StringRef> value =
getStringLiteralIfNotInterpolated(Tok.getLoc(), flag);
llvm::Optional<StringRef> value = getStringLiteralIfNotInterpolated(
Tok.getLoc(), flag, /*AllowMultiline=*/false);
if (!value)
return makeParserSuccess();
Token stringTok = Tok;
Expand Down Expand Up @@ -4533,7 +4536,8 @@ bool Parser::parseConventionAttributeInternal(SourceLoc atLoc, SourceLoc attrLoc
diagnose(Tok, diag::convention_attribute_ctype_expected_string);
return true;
}
if (auto ty = getStringLiteralIfNotInterpolated(Tok.getLoc(), "(C type)")) {
if (auto ty = getStringLiteralIfNotInterpolated(Tok.getLoc(), "(C type)",
/*AllowMultiline=*/false)) {
cType = Located<StringRef>(ty.value(), Tok.getLoc());
}
consumeToken(tok::string_literal);
Expand Down Expand Up @@ -7167,8 +7171,8 @@ ParserStatus Parser::parseLineDirective(bool isLine) {
return makeParserError();
}

Filename =
getStringLiteralIfNotInterpolated(Loc, "'#sourceLocation'");
Filename = getStringLiteralIfNotInterpolated(Loc, "'#sourceLocation'",
/*AllowMultiline=*/false);
if (!Filename.has_value())
return makeParserError();
SourceLoc filenameLoc = consumeToken(tok::string_literal);
Expand All @@ -7186,6 +7190,11 @@ ParserStatus Parser::parseLineDirective(bool isLine) {
}
SmallString<16> buffer;
auto text = stripUnderscoresIfNeeded(Tok.getText(), buffer);
if (text.find_first_not_of("0123456789") != StringRef::npos) {
// Disallow non-decimal line numbers in Swift 6.
diagnose(Tok, diag::expected_line_directive_number)
.warnUntilSwiftVersion(6);
}
if (text.getAsInteger(0, StartLine)) {
diagnose(Tok, diag::expected_line_directive_number);
return makeParserError();
Expand Down Expand Up @@ -7233,8 +7242,9 @@ ParserStatus Parser::parseLineDirective(bool isLine) {
diagnose(Tok, diag::expected_line_directive_name);
return makeParserError();
}

Filename = getStringLiteralIfNotInterpolated(Loc, "'#line'");

Filename = getStringLiteralIfNotInterpolated(Loc, "'#line'",
/*AllowMultiline=*/false);
if (!Filename.has_value())
return makeParserError();
}
Expand Down
5 changes: 3 additions & 2 deletions lib/Parse/ParseStmt.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2773,8 +2773,9 @@ ParserResult<Stmt> Parser::parseStmtPoundAssert() {
return makeParserError();
}

auto messageOpt = getStringLiteralIfNotInterpolated(Tok.getLoc(),
"'#assert' message");
auto messageOpt =
getStringLiteralIfNotInterpolated(Tok.getLoc(), "'#assert' message",
/*AllowMultiline=*/true);
consumeToken();
if (!messageOpt)
return makeParserError();
Expand Down
7 changes: 6 additions & 1 deletion lib/Parse/Parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,14 +1080,19 @@ Parser::parseList(tok RightK, SourceLoc LeftLoc, SourceLoc &RightLoc,
}

llvm::Optional<StringRef>
Parser::getStringLiteralIfNotInterpolated(SourceLoc Loc, StringRef DiagText) {
Parser::getStringLiteralIfNotInterpolated(SourceLoc Loc, StringRef DiagText,
bool AllowMultiline) {
assert(Tok.is(tok::string_literal));

// FIXME: Support extended escaping string literal.
if (Tok.getCustomDelimiterLen()) {
diagnose(Loc, diag::forbidden_extended_escaping_string, DiagText);
return llvm::None;
}
if (!AllowMultiline && Tok.isMultilineString()) {
diagnose(Loc, diag::forbidden_multiline_string, DiagText)
.warnUntilSwiftVersion(6);
}

SmallVector<Lexer::StringSegment, 1> Segments;
L->getStringLiteralSegments(Tok, Segments);
Expand Down
11 changes: 11 additions & 0 deletions test/Parse/line-directive.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ x // expected-error {{parameterless closing #sourceLocation() directive without

#sourceLocation(file: x.swift, line: 1) // expected-error{{expected filename string literal}}

// expected-warning@+1 {{expected starting line number for #sourceLocation directive; this is an error in Swift 6}}
#sourceLocation(file: "x.swift", line: 0xff)

#sourceLocation()

// expected-warning@+1 {{'#sourceLocation' cannot be a multi-line string literal; this is an error in Swift 6}}
#sourceLocation(file: """
x.swift
y.swift
""", line: 42)

#sourceLocation(file: "x.swift", line: 42)
x x ; // should be ignored by expected_error because it is in a different file
x
Expand Down