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

Warn on inline given aliases with functions as RHS #16499

Merged
merged 2 commits into from
Dec 15, 2022

Conversation

odersky
Copy link
Contributor

@odersky odersky commented Dec 10, 2022

    inline given a: Conversion[String, Item] = Item(_)

will now produce this warning:

 5 |  inline given a: Conversion[String, Item] = Item(_)
   |                                             ^^^^^^^
   |An inline given alias with a function value as right-hand side can significantly increase
   |generated code size. You should either drop the `inline` or rewrite the given with an
   |explicit `apply` method.
   |----------------------------------------------------------------------------
   | Explanation (enabled by `-explain`)
   |- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   | A function value on the right-hand side of an inline given alias expands to
   | an anonymous class. Each application of the inline given will then create a
   | fresh copy of that class, which can increase code size in surprising ways.
   | For that reason, functions are discouraged as right hand sides of inline given aliases.
   | You should either drop `inline` or rewrite to an explicit `apply` method. E.g.
   |
   |     inline given Conversion[A, B] = x => x.toB
   |
   | should be re-formulated as
   |
   |     inline given Conversion[A, B] with
   |       def apply(x: A) = x.toB
   |

Fixes #16497
Alternative to #16498

```scala
    inline given a: Conversion[String, Item] = Item(_)
```
will now produce this warning:
```
 5 |  inline given a: Conversion[String, Item] = Item(_)
   |                                             ^^^^^^^
   |An inline given alias with a function value as right-hand side can significantly increase
   |generated code size. You should either drop the `inline` or rewrite the given with an
   |explicit `apply` method.
   |----------------------------------------------------------------------------
   | Explanation (enabled by `-explain`)
   |- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   | A function value on the right-hand side of an inline given alias expands to
   | an anonymous class. Each application of the inline given will then create a
   | fresh copy of that class, which can increase code size in surprising ways.
   | For that reason, functions are discouraged as right hand sides of inline given aliases.
   | You should either drop `inline` or rewrite to an explicit `apply` method. E.g.
   |
   |     inline given Conversion[A, B] = x => x.toB
   |
   | should be re-formulated as
   |
   |     inline given Conversion[A, B] with
   |       def apply(x: A) = x.toB
   |
```
Fixes scala#16497
Copy link
Member

@smarter smarter left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM.

compiler/src/dotty/tools/dotc/reporting/messages.scala Outdated Show resolved Hide resolved
@smarter smarter assigned odersky and unassigned smarter Dec 14, 2022
@odersky odersky merged commit bd86363 into scala:main Dec 15, 2022
@odersky odersky deleted the warn-inline-given branch December 15, 2022 10:21
@Kordyjan Kordyjan modified the milestones: 3.3.0-RC1, 3.3.0 Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inline SAM conversions can generate lots of code
3 participants