Skip to content
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.

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

Check that def, macro, and block parameters don't end with ? or ! #12197

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
19 changes: 19 additions & 0 deletions spec/compiler/parser/parser_spec.cr
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,25 @@ module Crystal
assert_syntax_error "foo { |(#{kw}))| }", "cannot use '#{kw}' as a block parameter name", 1, 9
end

# #10917
%w(
bar? bar!
).each do |name|
assert_syntax_warning "def foo(#{name}); end", "invalid parameter name: #{name}", 1, 14
assert_syntax_warning "def foo(foo #{name}); end", "invalid parameter name: #{name}", 1, 17
it_parses "def foo(#{name} foo); end", Def.new("foo", [Arg.new("foo", external_name: name.to_s)])

assert_syntax_warning "macro foo(#{name}); end", "invalid parameter name: #{name}", 1, 16
assert_syntax_warning "macro foo(foo #{name}); end", "invalid parameter name: #{name}", 1, 19
it_parses "macro foo(#{name} foo); end", Macro.new("foo", [Arg.new("foo", external_name: name.to_s)], body: MacroLiteral.new(" "))

it_parses "foo(#{name})", Call.new(nil, "foo", [name.call] of ASTNode)
it_parses "foo #{name}", Call.new(nil, "foo", [name.call] of ASTNode)

assert_syntax_warning "foo { |#{name}| }", "invalid parameter name: #{name}", 1, 12
assert_syntax_warning "foo { |(#{name})| }", "invalid parameter name: #{name}", 1, 13
end

it_parses "def self.foo\n1\nend", Def.new("foo", body: 1.int32, receiver: "self".var)
it_parses "def self.foo()\n1\nend", Def.new("foo", body: 1.int32, receiver: "self".var)
it_parses "def self.foo=\n1\nend", Def.new("foo=", body: 1.int32, receiver: "self".var)
Expand Down
10 changes: 10 additions & 0 deletions spec/support/syntax.cr
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,16 @@ def assert_syntax_error(str, message = nil, line = nil, column = nil, metafile =
end
end

def assert_syntax_warning(str, message = nil, line = nil, column = nil, metafile = __FILE__, metaline = __LINE__, metaendline = __END_LINE__)
it "says syntax warning on #{str.inspect}", metafile, metaline, metaendline do
warnings = WarningCollection.new
parse str, false, nil, warnings
if warnings.infos.find { |info| info.ends_with?(message) }.nil?
fail "Expected warnings to include '#{message}'"
end
end
end

def parse(string, wants_doc = false, filename = nil, warnings = nil)
parser = Parser.new(string, warnings: warnings)
parser.warnings = warnings if warnings
Expand Down
17 changes: 17 additions & 0 deletions src/compiler/crystal/syntax/parser.cr
Original file line number Diff line number Diff line change
Expand Up @@ -3887,9 +3887,11 @@ module Crystal
do_next_token = true
found_string_literal = false
invalid_internal_name = nil
external_name_token = nil

if allow_external_name && (@token.type.ident? || string_literal_start?)
name_location = @token.location
external_name_token = @token.dup
if @token.type.ident?
if @token.keyword? && invalid_internal_name?(@token.value)
invalid_internal_name = @token.dup
Expand Down Expand Up @@ -3921,6 +3923,8 @@ module Crystal
raise "when specified, external name must be different than internal name", @token
end

check_valid_param_name

uses_arg = false
do_next_token = true
when .instance_var?
Expand Down Expand Up @@ -3984,6 +3988,10 @@ module Crystal
raise "cannot use '#{invalid_internal_name}' as a parameter name", invalid_internal_name
end
arg_name = external_name
if external_name_token.nil?
raise "missing external name token"
end
Comment on lines +4104 to +4106
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When external_name is present external_name_token should also be present, so it may be better to turn this into an invariant.

check_valid_param_name(external_name_token)
else
unexpected_token
end
Expand Down Expand Up @@ -4033,6 +4041,13 @@ module Crystal
end
end

def check_valid_param_name(token : Token = @token)
param_name = token.value.to_s
if param_name[-1]?.in?('?', '!')
warnings.add_warning_at(token.location, "invalid parameter name: #{param_name}")
end
end

def parse_if(check_end = true)
location = @token.location

Expand Down Expand Up @@ -4351,6 +4366,7 @@ module Crystal
end

arg_name = @token.value.to_s
check_valid_param_name

if all_names.includes?(arg_name)
raise "duplicated block parameter name: #{arg_name}", @token
Expand All @@ -4372,6 +4388,7 @@ module Crystal
end

sub_arg_name = @token.value.to_s
check_valid_param_name

if all_names.includes?(sub_arg_name)
raise "duplicated block parameter name: #{sub_arg_name}", @token
Expand Down