Syntax: Don't highlight the LHS of type decl as types #81

Julow · 2022-07-19T15:19:40Z

I would expect ocamlTypeConstr to apply only to type constructors
within type expressions, not to the identifier after type in:

type foo = 'a bar list

foo is not highlighted with:

hi link ocamlTypeConstr Type

This makes the LHS of types, exceptions and constraints be matched as
ocamlTypedef, which is not highlighted by default.

Variance and type variables on the LHS remain highlighted as before.

Julow · 2022-07-19T15:21:47Z

Ping @Maelan

Maelan · 2022-07-19T21:28:28Z

Thanks @Julow! I’m fine either way. I’m just slightly concerned by adding complexity to that already complex piece, but I let our maintainers judge.

You’d also have to deal with type t = ... and u = ..., though.

syntax/ocaml.vim

Maelan · 2022-07-19T21:33:59Z

syntax/ocaml.vim

+\ matchgroup=ocamlTypedef end="\<\(\w\|'\)*\>"
+\ contains=@ocamlAllErrs,ocamlComment,ocamlTypeVariance,ocamlTypeVar
+\ skipwhite skipempty
+\ nextgroup=ocamlTypeDefImpl


I note that with this technique, there must be no comment (* *) between the defined type name and the equal sign =, which may be acceptable (we already have that limitation elsewhere).

I don't see this. Perhaps because the end regex don't contain \@= ?

I haven’t actually tested your code, but from what I understand about nextgroup= and contained, the ocamlTypeDefImpl group will never be tried except immediately after the end of the ocamlTypeDef group.

This is what skipwhite is doing, from the :h:

These arguments are only used in combination with "nextgroup". They can be used to allow the next group to match after skipping some text: skipwhite skip over space and tab characters skipnl skip over the end of a line skipempty skip over empty lines (implies a "skipnl")

I took thought this was doing something between start and end and nothing outside but it's actually the opposite, they take effect after end and do nothing inside the region (whitespace are skipped by default it seems).

Julow · 2022-07-20T10:49:52Z

I fixed the problems with and and restored the highlighting of exception. module-rec-and (which are broken on master) and let-and are not altered.

Comparison before/after with hi link ocamlTypeConstr Type:

copy · 2022-07-20T17:24:52Z

Fundamentally this change is fine, but I think we leave the current behavior configurable (personally, I prefer the current behavior).

This seems to break some things, in particular (from type-linter-test.ml):

  type ('a, 'b) t = 'a list * ('a, 'b) result (* the left pair of parenthesis *)
  type nonrec 'a o = 'a option = private None | Some of 'a (* the second equal sign *)
  type t += C of int (* the of *)

The module-rec-and find is interesting, would you mind adding it to type-linter-test.ml with a fixme?

syntax/ocaml.vim

Julow · 2022-07-21T10:12:59Z

I missed type-linter-test.ml, thanks.

I've added a way to get back the current behavior, what should be the default ? This is governed by hi link ocamlTypeIdentifier x which could be ocamlLCIdentifier (new) or ocamlTypeConstr (previous).

I've fixed the bugs with type params and equal signs but I introduced new bugs around let-bindings, which are matched as type decl. I would like ocamlTypeDefImpl to take effect only when invoked with nextgroup, is here a way to do that ? Otherwise, we need stronger rules for let-bindings.

I would expect 'ocamlTypeConstr' to apply only to type constructors within type expressions, not to the identifier after 'type' in: type foo = 'a bar list This makes the LHS of types, exceptions and constraints be matched as 'ocamlTypedef', which is not highlighted by default. Variance and type variables on the LHS remain highlighted as before.

Have stricter rules for the identifiers and allow exception constructors to be highlighted as before.

A new region is used to avoid matching the 'and' keyword too often (that would interfere with let-and and module-rec-and.

Fix tupled type params, += and whitespaces around keywords. Add examples to the test file.

Using the commit date instead of the author date.

Julow · 2023-06-08T14:38:12Z

Any opinion on this ?

Here's how it can be used:

hi link ocamlTypeConstr Type
hi link ocamlTypeIdentifier Identifier

The first line is both before and after this PR. The second line is with the two line above applied:

rgrinberg · 2023-06-08T20:34:28Z

@copy do you want to make the call on this?

copy · 2023-06-09T13:20:38Z

This change and the mechanism to configure it looks good.

However, it causes some problems with the highlighting of number literals (highlighted as error across the type-linter-test.ml file), the fun keyword (highlighted like a type on line 332 and 338) and comments (a correct type highlighting is removed from line 349). You can use vim's :TOhtml followed by diff (or vimdiff, patdiff, ...) to check.

It's a `contained` region but was not added to `ocamlContained`.

This is a styling change.

Julow · 2023-06-20T09:46:51Z

Thanks for the review! I fixed this issue, it was a missing ocamlContained declaration. I also changed my editor setup to use this patch everyday to be sure to test it well.

copy · 2023-06-26T04:14:26Z

Thanks! Super-minor, but it still removes the type highlighting from the following (on the int):

  type t (*c*) =  int

Julow · 2023-06-27T09:33:27Z

Good catch! I'm failing to fix it.

The ocamlTypeDef region ends at t and jump into the ocamlTypeDefImpl region, which starts at = using nextgroup. I couldn't find a way to accept the comment without interfering with nextgroup, which is very handy to handle types without RHS and and types.
Any idea ?

copy · 2023-06-27T11:21:05Z

This comment from @Maelan looks relevant: #81 (comment)

Julow · 2023-07-03T16:30:56Z

Sorry for the slow reply. I managed to handle the comment at this location while keeping nextgroup working for and types.

copy · 2023-07-04T11:33:41Z

The latest commit seems to have broken the highlighting of identifiers in some places (e.g. the f in line 49 is recognized as a type). You can use :TOhtml and diff to find any differences between this branch and master.

It was missing from the ocamlTypeContained group.

Julow · 2023-07-05T09:22:00Z

I think I managed to fix the identifier issue. The TOhtml diff seems fine now. The added Error class is due to a newly added test case.

copy · 2023-07-06T07:31:43Z

On the last commit (817e8f7), some highlights are still incorrect (e.g. the let f on line 49), and show up in the diff.

Maelan reviewed Jul 19, 2022

View reviewed changes

rgrinberg requested a review from copy July 20, 2022 02:15

rgrinberg reviewed Jul 20, 2022

View reviewed changes

syntax/ocaml.vim Show resolved Hide resolved

Julow added 6 commits June 8, 2023 16:20

Match exception declaration separately

715285b

Have stricter rules for the identifiers and allow exception constructors to be highlighted as before.

Fix highlighting of and-types

32619c5

A new region is used to avoid matching the 'and' keyword too often (that would interfere with let-and and module-rec-and.

Syntax: Dedicated group for type decl identifiers

6dce805

Syntax: Fixes to type declarations

0f91255

Fix tupled type params, += and whitespaces around keywords. Add examples to the test file.

More accurate date for the last syntax changes

921eed7

Using the commit date instead of the author date.

Julow force-pushed the syn_type_decl_lhs branch from cebc78e to 921eed7 Compare June 8, 2023 14:27

Julow added 2 commits June 20, 2023 11:37

Fix type decl RHS interfering with expressions

62f63bd

It's a `contained` region but was not added to `ocamlContained`.

Merge matchgroups of the same name

31acc7b

This is a styling change.

syntax: Handle comments in type decl

22e88da

Julow added 2 commits July 5, 2023 11:15

Fix and-type interaction with modules

0871d88

Fix type identifiers being recognized in lets

817e8f7

It was missing from the ocamlTypeContained group.

Julow mentioned this pull request Jan 30, 2024

Add OCamldoc/Odoc highlighting #106

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Syntax: Don't highlight the LHS of type decl as types #81

Syntax: Don't highlight the LHS of type decl as types #81

Julow commented Jul 19, 2022

Julow commented Jul 19, 2022

Maelan commented Jul 19, 2022

Maelan Jul 19, 2022

Julow Jul 20, 2022

Maelan Jul 20, 2022

Julow Jul 20, 2022

Julow commented Jul 20, 2022

copy commented Jul 20, 2022

Julow commented Jul 21, 2022

Julow commented Jun 8, 2023

rgrinberg commented Jun 8, 2023

copy commented Jun 9, 2023

Julow commented Jun 20, 2023

copy commented Jun 26, 2023

Julow commented Jun 27, 2023

copy commented Jun 27, 2023

Julow commented Jul 3, 2023

copy commented Jul 4, 2023

Julow commented Jul 5, 2023

copy commented Jul 6, 2023

Syntax: Don't highlight the LHS of type decl as types #81

Are you sure you want to change the base?

Syntax: Don't highlight the LHS of type decl as types #81

Conversation

Julow commented Jul 19, 2022

Julow commented Jul 19, 2022

Maelan commented Jul 19, 2022

Maelan Jul 19, 2022

Choose a reason for hiding this comment

Julow Jul 20, 2022

Choose a reason for hiding this comment

Maelan Jul 20, 2022

Choose a reason for hiding this comment

Julow Jul 20, 2022

Choose a reason for hiding this comment

Julow commented Jul 20, 2022

copy commented Jul 20, 2022

Julow commented Jul 21, 2022

Julow commented Jun 8, 2023

rgrinberg commented Jun 8, 2023

copy commented Jun 9, 2023

Julow commented Jun 20, 2023

copy commented Jun 26, 2023

Julow commented Jun 27, 2023

copy commented Jun 27, 2023

Julow commented Jul 3, 2023

copy commented Jul 4, 2023

Julow commented Jul 5, 2023

copy commented Jul 6, 2023