Document recent -dip1000 changes #2453

thewilsonator · 2018-08-23T07:24:48Z

Document recent dip1000 related changes in:
dlang/dmd#8346
dlang/dmd#8408
dlang/dmd#8504

@WalterBright is this an accurate description?

dlang-bot · 2018-08-23T07:24:49Z

Thanks for your pull request and interest in making D better, @thewilsonator! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

My PR is fully covered with tests (you can see the annotated coverage diff directly on GitHub with CodeCov's browser extension
My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
I have provided a detailed rationale explaining my changes
New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.

If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

JinShil · 2018-08-23T07:48:40Z

This is great, but I think it needs to be more formally described in the spec:

dlang/dmd#8346

That PR causes the compiler to silently remove the return storage class under certain conditions. I'd like that documented at https://dlang.org/spec/function.html#return-ref-parameters

Furthermore the return storage class is not yet documented in the table at https://dlang.org/spec/function.html#param-storage

dlang/dmd#8408

I think this PR should be reverted, and we should come up with another way for the programmer to meta-programatically infer the storage classes.

But, since that's unlikely, I'd like for the inference rules to documented in the spec. I'd also like for the spec to make it clear when inference takes place -- I think it only takes place for templates, not for ordinary functions or methods. That needs to clarified.

Also, what is maybeScope and how does that work. Maybe you can distill the following into something comprehendible.
https://github.com/dlang/dmd/blob/74f89cc8f876279093c3dd6ef9a3918db329db73/src/dmd/escape.d#L1601-L1620

dlang/dmd#8504

I think this requires mention in https://dlang.org/spec/function.html#return-ref-parameters. 1) The first parameter is special, iff it's ref or out (I think). 2) special mention for constructors that the first parameter is essentially a ref this. But I'm still not sure how this works for member functions as those too have an implicit this. 3) The relationship between return parameters and the special first ref parameter.

You're not going to buy me off with a summary and a few paragraphs 😛. I think there's more to it than that. We also have to consider what this does to the DIP 1000 document. Personally, I think before any of these PR were/are merged there should be a PR to DIP1000 approving the design first.

JinShil · 2018-08-23T07:53:21Z

There's also a lot in https://wiki.dlang.org/DIP25 and https://github.com/dlang/DIPs/blob/master/DIPs/DIP1000.md that should be folded into the spec with multiple examples illustrating the concepts.

JinShil · 2018-08-23T08:24:25Z

Another thing to consider is that a lot of these features are feature-gated behind -dip25 and -dip1000 command-line switches. I'm not sure about the status of DIP 25 and DIP 1000. Are they draft, experimental, transitional, or something-else features? Perhaps they should be put in their own page in the spec and only folded into the spec if/when they become a permanent part of the language.

thewilsonator · 2018-08-23T09:10:50Z

You're not going to buy me off with a summary and a few paragraphs

I wasn't expecting to. This is also for me to understand the state of the implementation and verify that it is what I think it is, which is probably not true in the general case.

The first parameter is special, iff it's ref or out

With dlang/dmd#8346 it's ignored if its not a pointer (incl. ref/out), so I think not?

Also, what is maybeScope and how does that work. Maybe you can distill the following into something comprehendible.

No idea either.

ntrel · 2018-08-23T11:46:56Z

@JinShil:

a lot of these features are feature-gated behind -dip25 and -dip1000 command-line switches

Return ref is already documented with a note about needing -dip25. I've added a note about -dip1000 for scope in ~~#2452~~ #2454.

JinShil · 2018-08-23T11:48:42Z

Return ref is already documented with a note about needing -dip25. I've added a note about -dip1000 for scope in #2452.

Thank you. But I still recommend moving anything related to DIP 25 and 1000 to a separate page until the design and implementation are finalized.

ntrel · 2018-08-24T13:26:54Z

@thewilsonator I've made some changes here to improve wording (and formatting). (Unfortunately github won't let me set your repo as the base for a PR for some reason).

edit: See the full commit message for details.

thewilsonator · 2018-08-24T13:57:16Z

Thanks will merge them tomorrow.

thewilsonator · 2018-08-26T05:22:21Z

@ntrel Applied with some minor edits.

thewilsonator · 2018-10-23T17:18:16Z

Pinging @WalterBright again.

PetarKirov · 2018-10-24T06:59:12Z

@andralex can you review this?

jacob-carlborg · 2018-10-24T08:47:19Z

spec/memory-safe-d.dd

+
+         $(P The function parameter attributes $(D return) and $(D scope) are used to track what happens to low-level pointers 
+         passed to functions. Such pointers include: pointers, $(D this), classes, `ref` parameters, delegate/lazy parameters, 
+         and aggregates containing a pointer.)


Arrays? Or do you count those as aggregates?

Suggest we use raw pointers, this, variables of reference type, ref/lazy parameters, ref return values and aggregates containing such pointers.

thewilsonator · 2018-11-14T13:36:57Z

Pinging @WalterBright again: if you want me to be a functional PR manager, you need to review this.

12345swordy · 2018-11-16T14:39:20Z

@thewilsonator Try emailing him directly if he is not responding.

spec/memory-safe-d.dd

thewilsonator · 2018-12-02T03:09:49Z

Woohoooo! Now I just need to figure out how to fix the LaTeX errors...

spec/memory-safe-d.dd

thewilsonator · 2019-01-04T11:53:29Z

Hmm, can't tell if that actually improved things. I'm going to split this PR.

wilzbach · 2019-01-04T12:54:43Z

Why don't you build it locally?

andralex · 2019-01-04T18:19:09Z

spec/function.dd

@@ -1241,8 +1241,13 @@ int foo(in int x, out int y, ref int z, int q);
    $(TROW $(D scope), references in the parameter
    cannot be escaped (e.g. assigned to a global variable).
    Ignored for parameters with no references)
+    $(TROW $(D return), Parameter may be returned or copied to the first parameter,


The LaTeX errors are caused by the last comma in this line. The comma is interpreted by ddoc as a parameter separator, which in LaTeX is translated into an column separator (ampersand) because you're in a table. To fix, you may want to use $(TROW $(D return), $(ARGS Parameter may be returned...))

andralex · 2019-01-04T18:21:25Z

Made a commit directly in the interest of time.

thewilsonator · 2019-01-04T23:19:58Z

Thanks, I fixed some whitespace you left. Hopefully this works.

thewilsonator · 2019-01-04T23:45:59Z

IT WORKS!!! Thanks everyone!

WalterBright · 2021-07-16T09:29:01Z

@tgehr I cannot see a rationale here for this change.

dkorpel · 2021-07-16T09:32:31Z

Probably just an oversight.

thewilsonator requested review from andralex and WalterBright as code owners August 23, 2018 07:24

thewilsonator mentioned this pull request Oct 1, 2018

[WIP] Allow implicit conversion to shared. dlang/dmd#8782

Closed

jacob-carlborg reviewed Oct 24, 2018

View reviewed changes

thewilsonator force-pushed the dip1000 branch from c394642 to fd37c5a Compare November 9, 2018 23:04

thewilsonator added Blocking other work Needs Approval Spec / content Vision https://wiki.dlang.org/Vision/2018H1 labels Nov 10, 2018

n8sh reviewed Nov 18, 2018

View reviewed changes

spec/memory-safe-d.dd Outdated Show resolved Hide resolved

WalterBright approved these changes Dec 2, 2018

View reviewed changes

thewilsonator removed the Needs Approval label Dec 2, 2018

thewilsonator force-pushed the dip1000 branch from 2e1be40 to 4c330dc Compare December 2, 2018 11:43

thewilsonator force-pushed the dip1000 branch from 4c330dc to 47021d2 Compare December 30, 2018 06:27

wilzbach reviewed Jan 4, 2019

View reviewed changes

spec/memory-safe-d.dd Outdated Show resolved Hide resolved

wilzbach reviewed Jan 4, 2019

View reviewed changes

spec/memory-safe-d.dd Outdated Show resolved Hide resolved

thewilsonator mentioned this pull request Jan 4, 2019

Add the return parameter storage class #2544

Closed

andralex approved these changes Jan 4, 2019

View reviewed changes

Document recent -dip1000 changes

8224c76

thewilsonator force-pushed the dip1000 branch from 1688365 to 8224c76 Compare January 4, 2019 23:47

andralex merged commit 71522a6 into dlang:master Jan 5, 2019

This was referenced Jan 5, 2019

fix Issue 19097 - Extend Return Scope Semantics dlang/dmd#8504

Merged

specify Unsigned, Integral, Floating, Arithmetic and Scalar Types #2546

Open

Add documentation for Objective-C classes #2540

Merged

thewilsonator mentioned this pull request Mar 19, 2019

Add definition of full expression #2605

Merged

WalterBright mentioned this pull request Jul 26, 2021

specify @trusted functions must have @safe interface #3076

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document recent -dip1000 changes #2453

Document recent -dip1000 changes #2453

thewilsonator commented Aug 23, 2018

dlang-bot commented Aug 23, 2018

JinShil commented Aug 23, 2018 •

edited

Loading

JinShil commented Aug 23, 2018 •

edited

Loading

JinShil commented Aug 23, 2018

thewilsonator commented Aug 23, 2018

ntrel commented Aug 23, 2018 •

edited

Loading

JinShil commented Aug 23, 2018

ntrel commented Aug 24, 2018 •

edited

Loading

thewilsonator commented Aug 24, 2018

thewilsonator commented Aug 26, 2018

thewilsonator commented Oct 23, 2018

PetarKirov commented Oct 24, 2018

jacob-carlborg Oct 24, 2018

ntrel Oct 27, 2018

thewilsonator commented Nov 14, 2018

12345swordy commented Nov 16, 2018

thewilsonator commented Dec 2, 2018

thewilsonator commented Jan 4, 2019

wilzbach commented Jan 4, 2019

andralex Jan 4, 2019

andralex commented Jan 4, 2019

thewilsonator commented Jan 4, 2019

thewilsonator commented Jan 4, 2019

WalterBright commented Jul 16, 2021

dkorpel commented Jul 16, 2021

Document recent -dip1000 changes #2453

Document recent -dip1000 changes #2453

Conversation

thewilsonator commented Aug 23, 2018

dlang-bot commented Aug 23, 2018

Bugzilla references

JinShil commented Aug 23, 2018 • edited Loading

dlang/dmd#8346

dlang/dmd#8408

dlang/dmd#8504

JinShil commented Aug 23, 2018 • edited Loading

JinShil commented Aug 23, 2018

thewilsonator commented Aug 23, 2018

ntrel commented Aug 23, 2018 • edited Loading

JinShil commented Aug 23, 2018

ntrel commented Aug 24, 2018 • edited Loading

thewilsonator commented Aug 24, 2018

thewilsonator commented Aug 26, 2018

thewilsonator commented Oct 23, 2018

PetarKirov commented Oct 24, 2018

jacob-carlborg Oct 24, 2018

Choose a reason for hiding this comment

ntrel Oct 27, 2018

Choose a reason for hiding this comment

thewilsonator commented Nov 14, 2018

12345swordy commented Nov 16, 2018

thewilsonator commented Dec 2, 2018

thewilsonator commented Jan 4, 2019

wilzbach commented Jan 4, 2019

andralex Jan 4, 2019

Choose a reason for hiding this comment

andralex commented Jan 4, 2019

thewilsonator commented Jan 4, 2019

thewilsonator commented Jan 4, 2019

WalterBright commented Jul 16, 2021

dkorpel commented Jul 16, 2021

JinShil commented Aug 23, 2018 •

edited

Loading

JinShil commented Aug 23, 2018 •

edited

Loading

ntrel commented Aug 23, 2018 •

edited

Loading

ntrel commented Aug 24, 2018 •

edited

Loading