Skip to content

Shortcut for extension and attributes#342

Merged
alainfrisch merged 18 commits intoocaml:trunkfrom
Drup:ext_attr
Feb 5, 2016
Merged

Shortcut for extension and attributes#342
alainfrisch merged 18 commits intoocaml:trunkfrom
Drup:ext_attr

Conversation

@Drup
Copy link
Contributor

@Drup Drup commented Dec 9, 2015

Since we are just finished with #326, Let's move on. :]

In current OCaml, instead of writing

[%foo 
  let x = ...
]

it is possible to write

let%foo x = ...

For some reason, this shortcut was added only for the let, but not for the other structure. Additionally, it is possible to write let[@foo] x = ... in ... but it's not possible to use it on structure items. This patchset adds extension and attributes shortcut on every structure and signature items.

Example of use cases:

  • In eliom, for location annotations
  • In ppx_inline_test, it allows to replace the akward
let%test_module "name" = (module <module-expr>)

by the more natural

module%test My_test = <module-expr>

I will add tests/changelog when the conversation reaches a fixpoint.

@alainfrisch
Copy link
Contributor

I'm generally fine with this direction, but it should be noted that it is a bit irregular. Consider local let bindings:

let[@foo] x1 = e1
and x2 = e2
in
e

This is equivalent to:

(let x1 = e1
and x2 = e2
in
e)[@foo]

i.e. the attribute applies to the whole expression.

A quick look at your PR suggests that it would accept:

type[@foo1] t1 = ...
and[@foo2] t2 = ...

equivalent to:

type t1 = ... [@@foo1]
and t2 = ... [@@foo2]

Since each individual declaration in the group can have its own attributes, one can indeed allow attributes on the and, contrary to let .. and .. in ...

Another slightly unpleasant fact is that the syntax here is different between the prefix (attached to the keyword) and the postfix form: @vs @@.

Something else: if we now consider non-local let bindings, then one should probably support attributes, including on the and keyword

let[@foo1] x1 = e1
and[@foo2] x2 = e

mapped to:

let x1 = e1
 [@@foo1]
and x2 = e
 [@@foo2]

This would be coherent with type ... and ... and other str/sig items, but at odds with the corresponding form on local let bindings. Should we do it?

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

Ah, I meant to add attributes on let/and. I will add that.

@alainfrisch
Copy link
Contributor

So you're ok with the rather different interpretation for the attribute on the local and non-local version of let[@foo]?

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

There is no choice: attributes are per-binding in structure let and per group of bindings in expression let. Would you rather change that ?

@alainfrisch
Copy link
Contributor

There is no choice

Not supporting the short syntax for attributes on non-local let declarations would not be coherent with type ... and ... but it could avoid some confusion.

(Note that internally, the parsetree already accepts the equivalent of:

let x1 = 1 [@@foo1] and x2 = 2 [@@foo2] in ()

This is rejected by the parser but could simply be accepted.)

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

I vote for the second solution.

@alainfrisch
Copy link
Contributor

Which solution?

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

Allow per-binding attributes for both the structure and the expression let.

@alainfrisch
Copy link
Contributor

This is trivial to add but would increase possible confusion, because of

let[@foo] x = e1 in e2   <====>  (let x = e1 in e2)[@foo]
let[@foo] x = e1         <====>  let x = e1 [@@foo]

even though users might expect:

let[@foo] x = e1 in e2   <====>  let x = e1 [@@foo] in e2

since this form would now be valid. But we really don't want to do that, since it breaks the current rule on expression that attributes after the keyword are equivalent to attributes on the entire expression.

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

I actually think it's better that way, even if it breaks the usual rule a little bit.

Let us take a concrete example of an attribute that should be placed on lets : [@inline]. It seems much more beneficial to specify it for each binding, rather than for a whole group of bindings.

@alainfrisch
Copy link
Contributor

Ok, I'm ready to change my mind on "we really don't want to do that": it's indeed probably more useful even if not uniform. But we are now talking about a backward incompatible change. I'm not against in principle, but this cannot be done lightly. Can someone check on OPAM packages how often let[@xxx] is used?

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

I couldn't find any ppx library that uses attributes on let bindings (except the compiler). That doesn't say anything about usage though.

@gasche
Copy link
Member

gasche commented Dec 9, 2015

I would find it problematic if some @foo gets translated to @@foo during desugaring. Could we keep the number of symbols constant?

@Drup
Copy link
Contributor Author

Drup commented Dec 9, 2015

@gasche we already don't. let%foo x = 3 is valid. I personally don't understand why people want that, since it's completely non ambiguous (those are not the same syntactic constructs ...). It justs makes the syntax more heavy.

@damiendoligez damiendoligez added this to the 4.04-or-later milestone Dec 23, 2015
@Drup
Copy link
Contributor Author

Drup commented Jan 3, 2016

I just saw the milestone: Regardless of all the rest, the potential breaking change is currently inconsequential (as I said, nobody is using [@...] on let bindings) but it would not be the case after 4.03 ([@inline]).

@damiendoligez Do you want me to split some parts of the PR that could be integrated ?

@damiendoligez damiendoligez modified the milestones: maybe-4.03.0, 4.04-or-later Jan 29, 2016
@damiendoligez
Copy link
Member

@gasche @alainfrisch do you still have objections to this PR?

@gasche
Copy link
Member

gasche commented Jan 29, 2016

My objection was due to not being familiar with the problem space, and I think it was adequately answered.

@damiendoligez
Copy link
Member

Let's merge this unless @alainfrisch speaks up very soon.

@alainfrisch
Copy link
Contributor

No objection from me.

@mshinwell
Copy link
Contributor

@Drup Have you signed a CLA?

@Drup
Copy link
Contributor Author

Drup commented Feb 2, 2016

I'm not sure I have (even if I probably should have already :p).

I have not implemented the changes discussed with @alainfrisch, give me a few hours to do that.

@mshinwell
Copy link
Contributor

@damiendoligez This looks to me to be large enough for a CLA requirement, do you agree?

@damiendoligez
Copy link
Member

You're probably right. Let me check.

@mshinwell
Copy link
Contributor

@alainfrisch Do you have anything more to say on this?

@alainfrisch
Copy link
Contributor

I'm fine with the proposal and it is properly documented. I did not read the implementation, but this is low risk and there seems to be a good test, so let's merge!

alainfrisch added a commit that referenced this pull request Feb 5, 2016
Shortcut for extension and attributes
@alainfrisch alainfrisch merged commit 901c675 into ocaml:trunk Feb 5, 2016
@gasche
Copy link
Member

gasche commented Feb 5, 2016

I think that @xavierleroy has a marked preference for commits names using their author's full identity. In particular (this is my opinion here), if a particular contribution is covered by a CLA, the name of the git author should match the name on the CLA. This PR unfortunately commits all requests with authorship information Drup <[email protected]>.

@Drup , could you switch your git author information to something like "Gabriel 'Drup' Radanne " instead?

@alainfrisch / other mergers: it would be nice to try to check this before merging a PR.

We should be more explicit about this in CONTRIBUTING.md. Any volunteer for a clarification?

@gasche
Copy link
Member

gasche commented Feb 5, 2016

( @lefessan has suggested maintaining a list CONTRIBUTORS and adding a Travis check to make sure that commit authors are members of this list, and I must say that I am mellowing to this idea. )

@agarwal
Copy link
Member

agarwal commented Feb 5, 2016

You can also add a .mailmap file.

@Drup Drup deleted the ext_attr branch February 6, 2016 14:51
@damiendoligez
Copy link
Member

OTOH Gabriel's name is mentioned in the Changes entry, so it's not so hard to find out.

@gasche
Copy link
Member

gasche commented Feb 8, 2016

I will experiment with the .mailmap solution to see whether that works well enough.

gasche added a commit to gasche/ocaml that referenced this pull request Feb 12, 2016
This summarizes Xavier's recommendations at
  ocaml#342 (comment)
which were later reused at
  ocaml#307 (comment)

In particular this should create a URL anchor to direct people to:
gasche added a commit to gasche/ocaml that referenced this pull request Feb 12, 2016
@bobzhang
Copy link
Member

hi @Drup , there seems to be some missing places

class type x = object%xx
end

class type x = object[@xx]
end

@Drup
Copy link
Contributor Author

Drup commented Feb 23, 2016

@bobzhang Indeed, I forgot class types. Note that object%xx is not possible (try to do it without shortcut).

@alainfrisch I noticed an issue with class fields. Should the attributes/extension be before or after the mutable/virtual keywords ? If we follow what is used for rec, I would guess before.

@alainfrisch
Copy link
Contributor

If we follow what is used for rec, I would guess before.

Agreed.

This was referenced Feb 23, 2016
Octachron pushed a commit to Octachron/ocaml that referenced this pull request Feb 29, 2016
nojb pushed a commit to nojb/ocaml that referenced this pull request Jun 2, 2016
stedolan pushed a commit to stedolan/ocaml that referenced this pull request Dec 13, 2021
chambart pushed a commit to chambart/ocaml-1 that referenced this pull request Jan 4, 2022
chambart pushed a commit to chambart/ocaml-1 that referenced this pull request Feb 1, 2022
23a7f73 flambda-backend: Fix some Debuginfo.t scopes in the frontend (ocaml#248)
33a04a6 flambda-backend: Attempt to shrink the heap before calling the assembler (ocaml#429)
8a36a16 flambda-backend: Fix to allow stage 2 builds in Flambda 2 -Oclassic mode (ocaml#442)
d828db6 flambda-backend: Rename -no-extensions flag to -disable-all-extensions (ocaml#425)
68c39d5 flambda-backend: Fix mistake with extension records (ocaml#423)
423f312 flambda-backend: Refactor -extension and -standard flags (ocaml#398)
585e023 flambda-backend: Improved simplification of array operations (ocaml#384)
faec6b1 flambda-backend: Typos (ocaml#407)
8914940 flambda-backend: Ensure allocations are initialised, even dead ones (ocaml#405)
6b58001 flambda-backend: Move compiler flag -dcfg out of ocaml/ subdirectory (ocaml#400)
4fd57cf flambda-backend: Use ghost loc for extension to avoid expressions with overlapping locations (ocaml#399)
8d993c5 flambda-backend: Let's fix instead of reverting flambda_backend_args (ocaml#396)
d29b133 flambda-backend: Revert "Move flambda-backend specific flags out of ocaml/ subdirectory (ocaml#382)" (ocaml#395)
d0cda93 flambda-backend: Revert ocaml#373 (ocaml#393)
1c6eee1 flambda-backend: Fix "make check_all_arches" in ocaml/ subdirectory (ocaml#388)
a7960dd flambda-backend: Move flambda-backend specific flags out of ocaml/ subdirectory (ocaml#382)
bf7b1a8 flambda-backend: List and Array Comprehensions (ocaml#147)
f2547de flambda-backend: Compile more stdlib files with -O3 (ocaml#380)
3620c58 flambda-backend: Four small inliner fixes (ocaml#379)
2d165d2 flambda-backend: Regenerate ocaml/configure
3838b56 flambda-backend: Bump Menhir to version 20210419 (ocaml#362)
43c14d6 flambda-backend: Re-enable -flambda2-join-points (ocaml#374)
5cd2520 flambda-backend: Disable inlining of recursive functions by default (ocaml#372)
e98b277 flambda-backend: Import ocaml#10736 (stack limit increases) (ocaml#373)
82c8086 flambda-backend: Use hooks for type tree and parse tree (ocaml#363)
33bbc93 flambda-backend: Fix parsecmm.mly in ocaml subdirectory (ocaml#357)
9650034 flambda-backend: Right-to-left evaluation of arguments of String.get and friends (ocaml#354)
f7d3775 flambda-backend: Revert "Magic numbers" (ocaml#360)
0bd2fa6 flambda-backend: Add [@inline ready] attribute and remove [@inline hint] (not [@inlined hint]) (ocaml#351)
cee74af flambda-backend: Ensure that functions are evaluated after their arguments (ocaml#353)
954be59 flambda-backend: Bootstrap
dd5c299 flambda-backend: Change prefix of all magic numbers to avoid clashes with upstream.
c2b1355 flambda-backend: Fix wrong shift generation in Cmm_helpers (ocaml#347)
739243b flambda-backend: Add flambda_oclassic attribute (ocaml#348)
dc9b7fd flambda-backend: Only speculate during inlining if argument types have useful information (ocaml#343)
aa190ec flambda-backend: Backport fix from PR#10719 (ocaml#342)
c53a574 flambda-backend: Reduce max inlining depths at -O2 and -O3 (ocaml#334)
a2493dc flambda-backend: Tweak error messages in Compenv.
1c7b580 flambda-backend: Change Name_abstraction to use a parameterized type (ocaml#326)
07e0918 flambda-backend: Save cfg to file (ocaml#257)
9427a8d flambda-backend: Make inlining parameters more aggressive (ocaml#332)
fe0610f flambda-backend: Do not cache young_limit in a processor register (upstream PR 9876) (ocaml#315)
56f28b8 flambda-backend: Fix an overflow bug in major GC work computation (ocaml#310)
8e43a49 flambda-backend: Cmm invariants (port upstream PR 1400) (ocaml#258)
e901f16 flambda-backend: Add attributes effects and coeffects (#18)
aaa1cdb flambda-backend: Expose Flambda 2 flags via OCAMLPARAM (ocaml#304)
62db54f flambda-backend: Fix freshening substitutions
57231d2 flambda-backend: Evaluate signature substitutions lazily (upstream PR 10599) (ocaml#280)
a1a07de flambda-backend: Keep Sys.opaque_identity in Cmm and Mach (port upstream PR 9412) (ocaml#238)
faaf149 flambda-backend: Rename Un_cps -> To_cmm (ocaml#261)
ecb0201 flambda-backend: Add "-dcfg" flag to ocamlopt (ocaml#254)
32ec58a flambda-backend: Bypass Simplify (ocaml#162)
bd4ce4a flambda-backend: Revert "Semaphore without probes: dummy notes (ocaml#142)" (ocaml#242)
c98530f flambda-backend: Semaphore without probes: dummy notes (ocaml#142)
c9b6a04 flambda-backend: Remove hack for .depend from runtime/dune  (ocaml#170)
6e5d4cf flambda-backend: Build and install Semaphore (ocaml#183)
924eb60 flambda-backend: Special constructor for %sys_argv primitive (ocaml#166)
2ac6334 flambda-backend: Build ocamldoc (ocaml#157)
c6f7267 flambda-backend: Add -mbranches-within-32B to major_gc.c compilation (where supported)
a99fdee flambda-backend: Merge pull request ocaml#10195 from stedolan/mark-prefetching
bd72dcb flambda-backend: Prefetching optimisations for sweeping (ocaml#9934)
27fed7e flambda-backend: Add missing index param for Obj.field (ocaml#145)
cd48b2f flambda-backend: Fix camlinternalOO at -O3 with Flambda 2 (ocaml#132)
9d85430 flambda-backend: Fix testsuite execution (ocaml#125)
ac964ca flambda-backend: Comment out `[@inlined]` annotation. (ocaml#136)
ad4afce flambda-backend: Fix magic numbers (test suite) (ocaml#135)
9b033c7 flambda-backend: Disable the comparison of bytecode programs (`ocamltest`) (ocaml#128)
e650abd flambda-backend: Import flambda2 changes (`Asmpackager`) (ocaml#127)
14dcc38 flambda-backend: Fix error with Record_unboxed (bug in block kind patch) (ocaml#119)
2d35761 flambda-backend: Resurrect [@inline never] annotations in camlinternalMod (ocaml#121)
f5985ad flambda-backend: Magic numbers for cmx and cmxa files (ocaml#118)
0e8b9f0 flambda-backend: Extend conditions to include flambda2 (ocaml#115)
99870c8 flambda-backend: Fix Translobj assertions for Flambda 2 (ocaml#112)
5106317 flambda-backend: Minor fix for "lazy" compilation in Matching with Flambda 2 (ocaml#110)
dba922b flambda-backend: Oclassic/O2/O3 etc (ocaml#104)
f88af3e flambda-backend: Wire in the remaining Flambda 2 flags (ocaml#103)
678d647 flambda-backend: Wire in the Flambda 2 inlining flags (ocaml#100)
1a8febb flambda-backend: Formatting of help text for some Flambda 2 options (ocaml#101)
9ae1c7a flambda-backend: First set of command-line flags for Flambda 2 (ocaml#98)
bc0bc5e flambda-backend: Add config variables flambda_backend, flambda2 and probes (ocaml#99)
efb8304 flambda-backend: Build our own ocamlobjinfo from tools/objinfo/ at the root (ocaml#95)
d2cfaca flambda-backend: Add mutability annotations to Pfield etc. (ocaml#88)
5532555 flambda-backend: Lambda block kinds (ocaml#86)
0c597ba flambda-backend: Revert VERSION, etc. back to 4.12.0 (mostly reverts 822d0a0 from upstream 4.12) (ocaml#93)
037c3d0 flambda-backend: Float blocks
7a9d190 flambda-backend: Allow --enable-middle-end=flambda2 etc (ocaml#89)
9057474 flambda-backend: Root scanning fixes for Flambda 2 (ocaml#87)
08e02a3 flambda-backend: Ensure that Lifthenelse has a boolean-valued condition (ocaml#63)
77214b7 flambda-backend: Obj changes for Flambda 2 (ocaml#71)
ecfdd72 flambda-backend: Cherry-pick 9432cfdadb043a191b414a2caece3e4f9bbc68b7 (ocaml#84)
d1a4396 flambda-backend: Add a `returns` field to `Cmm.Cextcall` (ocaml#74)
575dff5 flambda-backend: CMM traps (ocaml#72)
8a87272 flambda-backend: Remove Obj.set_tag and Obj.truncate (ocaml#73)
d9017ae flambda-backend: Merge pull request ocaml#80 from mshinwell/fb-backport-pr10205
3a4824e flambda-backend: Backport PR#10205 from upstream: Avoid overwriting closures while initialising recursive modules
f31890e flambda-backend: Install missing headers of ocaml/runtime/caml (ocaml#77)
83516f8 flambda-backend: Apply node created for probe should not be annotated as tailcall (ocaml#76)
bc430cb flambda-backend: Add Clflags.is_flambda2 (ocaml#62)
ed87247 flambda-backend: Preallocation of blocks in Translmod for value let rec w/ flambda2 (ocaml#59)
a4b04d5 flambda-backend: inline never on Gc.create_alarm (ocaml#56)
cef0bb6 flambda-backend: Config.flambda2 (ocaml#58)
ff0e4f7 flambda-backend: Pun labelled arguments with type constraint in function applications (ocaml#53)
d72c5fb flambda-backend: Remove Cmm.memory_chunk.Double_u (ocaml#42)
9d34d99 flambda-backend: Install missing artifacts
10146f2 flambda-backend: Add ocamlcfg (ocaml#34)
819d38a flambda-backend: Use OC_CFLAGS, OC_CPPFLAGS, and SHAREDLIB_CFLAGS for foreign libs (#30)
f98b564 flambda-backend: Pass -function-sections iff supported. (#29)
e0eef5e flambda-backend: Bootstrap (#11 part 2)
17374b4 flambda-backend: Add [@@Builtin] attribute to Primitives (#11 part 1)
85127ad flambda-backend: Add builtin, effects and coeffects fields to Cextcall (#12)
b670bcf flambda-backend: Replace tuple with record in Cextcall (#10)
db451b5 flambda-backend: Speedups in Asmlink (#8)
2fe489d flambda-backend: Cherry-pick upstream PR#10184 from upstream, dynlink invariant removal (rev 3dc3cd7 upstream)
d364bfa flambda-backend: Local patch against upstream: enable function sections in the Dune build
886b800 flambda-backend: Local patch against upstream: remove Raw_spacetime_lib (does not build with -m32)
1a7db7c flambda-backend: Local patch against upstream: make dune ignore ocamldoc/ directory
e411dd3 flambda-backend: Local patch against upstream: remove ocaml/testsuite/tests/tool-caml-tex/
1016d03 flambda-backend: Local patch against upstream: remove ocaml/dune-project and ocaml/ocaml-variants.opam
93785e3 flambda-backend: To upstream: export-dynamic for otherlibs/dynlink/ via the natdynlinkops files (still needs .gitignore + way of generating these files)
63db8c1 flambda-backend: To upstream: stop using -O3 in otherlibs/Makefile.otherlibs.common
eb2f1ed flambda-backend: To upstream: stop using -O3 for dynlink/
6682f8d flambda-backend: To upstream: use flambda_o3 attribute instead of -O3 in the Makefile for systhreads/
de197df flambda-backend: To upstream: renamed ocamltest_unix.xxx files for dune
bf3773d flambda-backend: To upstream: dune build fixes (depends on previous to-upstream patches)
6fbc80e flambda-backend: To upstream: refactor otherlibs/dynlink/, removing byte/ and native/
71a03ef flambda-backend: To upstream: fix to Ocaml_modifiers in ocamltest
686d6e3 flambda-backend: To upstream: fix dependency problem with Instruct
c311155 flambda-backend: To upstream: remove threadUnix
52e6e78 flambda-backend: To upstream: stabilise filenames used in backtraces: stdlib/, otherlibs/systhreads/, toplevel/toploop.ml
7d08e0e flambda-backend: To upstream: use flambda_o3 attribute in stdlib
403b82e flambda-backend: To upstream: flambda_o3 attribute support (includes bootstrap)
65032b1 flambda-backend: To upstream: use nolabels attribute instead of -nolabels for otherlibs/unix/
f533fad flambda-backend: To upstream: remove Compflags, add attributes, etc.
49fc1b5 flambda-backend: To upstream: Add attributes and bootstrap compiler
a4b9e0d flambda-backend: Already upstreamed: stdlib capitalisation patch
4c1c259 flambda-backend: ocaml#9748 from xclerc/share-ev_defname (cherry-pick 3e937fc)
00027c4 flambda-backend: permanent/default-to-best-fit (cherry-pick 64240fd)
2561dd9 flambda-backend: permanent/reraise-by-default (cherry-pick 50e9490)
c0aa4f4 flambda-backend: permanent/gc-tuning (cherry-pick e9d6d2f)

git-subtree-dir: ocaml
git-subtree-split: 23a7f73
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants