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.

Sign up for GitHub

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

Jump to bottom

feat(lsp): Add Inlay types #2005

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(lsp): Add Inlay types #2005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3cc4ffe
feat(lsp): Add Inlay types
spotandjake Feb 2, 2024
1a5872a
chore: Simplify `Function` inlays
spotandjake Feb 2, 2024
848978c
feat(lsp): Implement Inlays For parameters
spotandjake Jul 29, 2024
217b7e5
Do not show hints for top level statements
spotandjake Jul 29, 2024
da038be
chore: Disable type hints for functions.
spotandjake Aug 2, 2024
ffc8709
chore: Add flag to toggle the type hints
spotandjake Aug 2, 2024
04048de
chore: Apply suggestions from code review
spotandjake Aug 2, 2024
d281379
chore: Apply suggestions from oscar code review
spotandjake Aug 5, 2024
e86c6f2
chore: Remove cmdline toggle
spotandjake Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 87 additions & 1 deletion compiler/src/language_server/inlayhint.re
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,100 @@ let send_no_result = (~id: Protocol.message_id) => {
Protocol.response(~id, `Null);
};

let build_hint =
(position: Protocol.position, message: string): ResponseResult.inlay_hint => {
{label: ": " ++ message, position};
};

let rec resolve_typ = (typ: Types.type_expr) => {
switch (typ.desc) {
| TTyLink(type_expr)
| TTySubst(type_expr) => resolve_typ(type_expr)
| _ => typ
};
};
let string_of_typ = (typ: Types.type_expr) => {
Printtyp.string_of_type_scheme(resolve_typ(typ));
};

let is_func_typ = (typ: Types.type_expr) => {
switch (resolve_typ(typ).desc) {
| TTyArrow(_, _, _) => true
| _ => false
};
};

let find_hints = program => {
let hints = ref([]);
open Typedtree;
open Protocol;
module Iterator =
TypedtreeIter.MakeIterator({
include TypedtreeIter.DefaultIteratorArgument;
// Inlay hints for various expressions can be included here.

let enter_expression = ({exp_desc, exp_type}: expression) =>
switch (exp_desc) {
| TExpLambda(bindings, _) =>
List.iter(
({mb_pat, mb_loc}: match_branch) => {
switch (mb_pat.pat_desc) {
| TPatTuple(args) =>
switch (resolve_typ(exp_type).desc) {
| TTyArrow(typ_args, _, _) =>
let argument_typs =
List.map(
((arg, typ: Types.type_expr)) =>
switch (arg) {
| Default(_) => None
| _ => Some(typ)
},
typ_args,
);
if (List.length(argument_typs) == List.length(args)) {
List.iter(
((arg: pattern, typ: option(Types.type_expr))) => {
switch (arg.pat_desc, typ) {
| (TPatVar(_, _), Some(typ)) =>
let bind_end = arg.pat_loc.loc_end;
let p: Protocol.position = {
line: bind_end.pos_lnum - 1,
character: bind_end.pos_cnum - bind_end.pos_bol,
};
let typeSignature = string_of_typ(typ);
hints := [build_hint(p, typeSignature), ...hints^];
| _ => ()
}
},
List.combine(args, argument_typs),
);
};
| _ => ()
Copy link
Member

Choose a reason for hiding this comment

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

Would this ever be possible? If not should we do failwith("Impossible: ...")?

Copy link
Member Author

Choose a reason for hiding this comment

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

It seems as though there is a case where it can be a constructor.

}
| _ => ()
}
},
bindings,
)
| _ => ()
};

let enter_binding = ({vb_pat, vb_expr}: value_binding, toplevel: bool) =>
if (!toplevel) {
Copy link
Member

Choose a reason for hiding this comment

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

Nit: cut down on the condition nesting, perhaps if (!toplevel && toggle_type_hints) and then

switch (vb_pat) {
| {pat_extra: [], pat_desc: TPatVar(_, {loc}) => ...
| _ => ()
}

switch (vb_pat) {
| {pat_extra: [], pat_desc: TPatVar(_, {loc})} =>
let bind_end = loc.loc_end;
let p: Protocol.position = {
line: bind_end.pos_lnum - 1,
character: bind_end.pos_cnum - bind_end.pos_bol,
};
let typ = vb_pat.pat_type;
if (!is_func_typ(typ)) {
let typeSignature = string_of_typ(typ);
hints := [build_hint(p, typeSignature), ...hints^];
};
| _ => ()
};
};
});
Iterator.iter_typed_program(program);
hints^;
Expand Down
22 changes: 11 additions & 11 deletions compiler/src/typed/typedtreeIter.re
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ module type IteratorArgument = {
let leave_core_type: core_type => unit;
let leave_toplevel_stmt: toplevel_stmt => unit;

let enter_bindings: (rec_flag, mut_flag) => unit;
let enter_binding: value_binding => unit;
let enter_bindings: (rec_flag, mut_flag, bool) => unit;
let enter_binding: (value_binding, bool) => unit;
let leave_binding: value_binding => unit;
let leave_bindings: (rec_flag, mut_flag) => unit;

Expand Down Expand Up @@ -74,16 +74,16 @@ module MakeIterator =
Iter.leave_core_type(ct);
}

and iter_binding = ({vb_pat, vb_expr} as vb) => {
Iter.enter_binding(vb);
and iter_binding = (~toplevel=false, {vb_pat, vb_expr} as vb) => {
Iter.enter_binding(vb, toplevel);
iter_pattern(vb_pat);
iter_expression(vb_expr);
Iter.leave_binding(vb);
}

and iter_bindings = (rec_flag, mut_flag, binds) => {
Iter.enter_bindings(rec_flag, mut_flag);
List.iter(iter_binding, binds);
and iter_bindings = (~toplevel=false, rec_flag, mut_flag, binds) => {
Iter.enter_bindings(rec_flag, mut_flag, toplevel);
List.iter(iter_binding(~toplevel), binds);
Iter.leave_bindings(rec_flag, mut_flag);
}

Expand Down Expand Up @@ -132,7 +132,7 @@ module MakeIterator =
| TTopModule({tmod_statements}) => iter_toplevel_stmts(tmod_statements)
| TTopExpr(e) => iter_expression(e)
| TTopLet(recflag, mutflag, binds) =>
iter_bindings(recflag, mutflag, binds)
iter_bindings(recflag, mutflag, binds, ~toplevel=true)
};
Iter.leave_toplevel_stmt(stmt);
}
Expand Down Expand Up @@ -206,7 +206,7 @@ module MakeIterator =
| TExpIdent(_)
| TExpConstant(_) => ()
| TExpLet(recflag, mutflag, binds) =>
iter_bindings(recflag, mutflag, binds)
iter_bindings(recflag, mutflag, binds, ~toplevel=false)
| TExpLambda(branches, _) => iter_match_branches(branches)
| TExpApp(exp, _, args) =>
iter_expression(exp);
Expand Down Expand Up @@ -274,8 +274,8 @@ module DefaultIteratorArgument: IteratorArgument = {
let enter_expression = _ => ();
let enter_core_type = _ => ();
let enter_toplevel_stmt = _ => ();
let enter_bindings = (_, _) => ();
let enter_binding = _ => ();
let enter_bindings = (_, _, _) => ();
let enter_binding = (_, _) => ();
let enter_data_declaration = _ => ();
let enter_data_declarations = () => ();

Expand Down
4 changes: 2 additions & 2 deletions compiler/src/typed/typedtreeIter.rei
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ module type IteratorArgument = {
let leave_core_type: core_type => unit;
let leave_toplevel_stmt: toplevel_stmt => unit;

let enter_bindings: (rec_flag, mut_flag) => unit;
let enter_binding: value_binding => unit;
let enter_bindings: (rec_flag, mut_flag, bool) => unit;
let enter_binding: (value_binding, bool) => unit;
let leave_binding: value_binding => unit;
let leave_bindings: (rec_flag, mut_flag) => unit;

Expand Down
Loading