Skip to content
  • Jeremy Evans's avatar
    80b5a0ff
    Make rb_scan_args handle keywords more similar to Ruby methods (#2460) · 80b5a0ff
    Jeremy Evans authored
    Cfuncs that use rb_scan_args with the : entry suffer similar keyword
    argument separation issues that Ruby methods suffer if the cfuncs
    accept optional or variable arguments.
    
    This makes the following changes to : handling.
    
    * Treats as **kw, prompting keyword argument separation warnings
      if called with a positional hash.
    
    * Do not look for an option hash if empty keywords are provided.
      For backwards compatibility, treat an empty keyword splat as a empty
      mandatory positional hash argument, but emit a a warning, as this
      behavior will be removed in Ruby 3.  The argument number check
      needs to be moved lower so it can correctly handle an empty
      positional argument being added.
    
    * If the last argument is nil and it is necessary to treat it as an option
      hash in order to make sure all arguments are processed, continue to
      treat the last argument as the option hash. Emit a warning in this case,
      as this behavior will be removed in Ruby 3.
    
    * If splitting the keyword hash into two hashes, issue a warning, as we
      will not be splitting hashes in Ruby 3.
    
    * If the keyword argument is required to fill a mandatory positional
      argument, continue to do so, but emit a warning as this behavior will
      be going away in Ruby 3.
    
    * If keyword arguments are provided and the last argument is not a hash,
      that indicates something wrong. This can happen if a cfunc is calling
      rb_scan_args multiple times, and providing arguments that were not
      passed to it from Ruby.  Callers need to switch to the new
      rb_scan_args_kw function, which allows passing of whether keywords
      were provided.
    
    This commit fixes all warnings caused by the changes above.
    
    It switches some function calls to *_kw versions with appropriate
    kw_splat flags. If delegating arguments, RB_PASS_CALLED_KEYWORDS
    is used.  If creating new arguments, RB_PASS_KEYWORDS is used if
    the last argument is a hash to be treated as keywords.
    
    In open_key_args in io.c, use rb_scan_args_kw.
    In this case, the arguments provided come from another C
    function, not Ruby.  The last argument may or may not be a hash,
    so we can't set keyword argument mode.  However, if it is a
    hash, we don't want to warn when treating it as keywords.
    
    In Ruby files, make sure to appropriately use keyword splats
    or literal keywords when calling Cfuncs that now issue keyword
    argument separation warnings through rb_scan_args.  Also, make
    sure not to pass nil in place of an option hash.
    
    Work around Kernel#warn warnings due to problems in the Rubygems
    override of the method.  There is an open pull request to fix
    these issues in Rubygems, but part of the Rubygems tests for
    their override fail on ruby-head due to rb_scan_args not
    recognizing empty keyword splats, which this commit fixes.
    
    Implementation wise, adding rb_scan_args_kw is kind of a pain,
    because rb_scan_args takes a variable number of arguments.
    In order to not duplicate all the code, the function internals need
    to be split into two functions taking a va_list, and to avoid passing
    in a ton of arguments, a single struct argument is used to handle
    the variables previously local to the function.
    80b5a0ff
    Make rb_scan_args handle keywords more similar to Ruby methods (#2460)
    Jeremy Evans authored
    Cfuncs that use rb_scan_args with the : entry suffer similar keyword
    argument separation issues that Ruby methods suffer if the cfuncs
    accept optional or variable arguments.
    
    This makes the following changes to : handling.
    
    * Treats as **kw, prompting keyword argument separation warnings
      if called with a positional hash.
    
    * Do not look for an option hash if empty keywords are provided.
      For backwards compatibility, treat an empty keyword splat as a empty
      mandatory positional hash argument, but emit a a warning, as this
      behavior will be removed in Ruby 3.  The argument number check
      needs to be moved lower so it can correctly handle an empty
      positional argument being added.
    
    * If the last argument is nil and it is necessary to treat it as an option
      hash in order to make sure all arguments are processed, continue to
      treat the last argument as the option hash. Emit a warning in this case,
      as this behavior will be removed in Ruby 3.
    
    * If splitting the keyword hash into two hashes, issue a warning, as we
      will not be splitting hashes in Ruby 3.
    
    * If the keyword argument is required to fill a mandatory positional
      argument, continue to do so, but emit a warning as this behavior will
      be going away in Ruby 3.
    
    * If keyword arguments are provided and the last argument is not a hash,
      that indicates something wrong. This can happen if a cfunc is calling
      rb_scan_args multiple times, and providing arguments that were not
      passed to it from Ruby.  Callers need to switch to the new
      rb_scan_args_kw function, which allows passing of whether keywords
      were provided.
    
    This commit fixes all warnings caused by the changes above.
    
    It switches some function calls to *_kw versions with appropriate
    kw_splat flags. If delegating arguments, RB_PASS_CALLED_KEYWORDS
    is used.  If creating new arguments, RB_PASS_KEYWORDS is used if
    the last argument is a hash to be treated as keywords.
    
    In open_key_args in io.c, use rb_scan_args_kw.
    In this case, the arguments provided come from another C
    function, not Ruby.  The last argument may or may not be a hash,
    so we can't set keyword argument mode.  However, if it is a
    hash, we don't want to warn when treating it as keywords.
    
    In Ruby files, make sure to appropriately use keyword splats
    or literal keywords when calling Cfuncs that now issue keyword
    argument separation warnings through rb_scan_args.  Also, make
    sure not to pass nil in place of an option hash.
    
    Work around Kernel#warn warnings due to problems in the Rubygems
    override of the method.  There is an open pull request to fix
    these issues in Rubygems, but part of the Rubygems tests for
    their override fail on ruby-head due to rb_scan_args not
    recognizing empty keyword splats, which this commit fixes.
    
    Implementation wise, adding rb_scan_args_kw is kind of a pain,
    because rb_scan_args takes a variable number of arguments.
    In order to not duplicate all the code, the function internals need
    to be split into two functions taking a va_list, and to avoid passing
    in a ton of arguments, a single struct argument is used to handle
    the variables previously local to the function.
Loading