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

drop the result compatibility package dependency #279

Merged
merged 2 commits into from
Mar 28, 2024
Merged

drop the result compatibility package dependency #279

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c6c528
drop the `result` compatibility package dependency
anmonteiro Mar 12, 2024
970f1fd
Reintroduce support for deriving from Result.result
NathanReb Mar 27, 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
1 change: 0 additions & 1 deletion ppx_deriving.opam
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ depends: [
"ocamlfind"
"ppx_derivers"
"ppxlib" {>= "0.32.0"}
"result"
"ounit2" {with-test}
]
synopsis: "Type-driven code generation for OCaml"
Expand Down
6 changes: 1 addition & 5 deletions src/api/dune
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@
(preprocess (pps ppxlib.metaquot))
(wrapped false)
(ppx_runtime_libraries ppx_deriving_runtime)
(libraries
compiler-libs.common
ppxlib
result
ppx_derivers))
(libraries compiler-libs.common ppxlib ppx_derivers))

(rule
(deps ppx_deriving.cppo.ml)
Expand Down
3 changes: 1 addition & 2 deletions src/api/ppx_deriving.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,8 @@ let string_of_expression_opt (e : Parsetree.expression) : string option =
| _ -> None

module Arg = struct
type 'a conv = expression -> ('a, string) Result.result
type 'a conv = expression -> ('a, string) result

open Result
let expr expr = Ok expr

let int expr =
Expand Down
18 changes: 9 additions & 9 deletions src/api/ppx_deriving.cppo.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,37 +104,37 @@ module Arg : sig
(** A type of conversion functions.

A conversion function of type ['a conv] converts a raw expression into an
argument of type ['a]. Or returns [Result.Error "error"] if conversion
argument of type ['a]. Or returns [Error "error"] if conversion
fails. *)
type 'a conv = expression -> ('a, string) Result.result
type 'a conv = expression -> ('a, string) result

(** [expr] returns the input expression as-is. *)
val expr : expression conv

(** [bool expr] extracts a boolean constant from [expr], or returns
[Result.Error "boolean"] if [expr] does not contain a boolean literal. *)
[Error "boolean"] if [expr] does not contain a boolean literal. *)
val bool : bool conv

(** [int expr] extracts an integer constant from [expr], or returns
[Result.Error "integer"] if [expr] does not contain an integer literal. *)
[Error "integer"] if [expr] does not contain an integer literal. *)
val int : int conv

(** [string expr] extracts a string constant from [expr], or returns
[Result.Error "string"] if [expr] does not contain a string literal. *)
[Error "string"] if [expr] does not contain a string literal. *)
val string : string conv

(** [char expr] extracts a char constant from [expr], or returns
[Result.Error "char"] if [expr] does not contain a char literal. *)
[Error "char"] if [expr] does not contain a char literal. *)
val char : char conv

(** [enum values expr] extracts a polymorphic variant constant from [expr],
or returns [Result.Error "one of: `a, `b, ..."] if [expr] does not
or returns [Error "one of: `a, `b, ..."] if [expr] does not
contain a polymorphic variant constructor included in [values]. *)
val enum : string list -> string conv

(** [list f expr] extracts a list constant from [expr] and maps every element
through [f], or returns [Result.Error "list:..."] where [...] is the
error returned by [f], or returns [Result.Error "list"] if [expr] does
through [f], or returns [Error "list:..."] where [...] is the
error returned by [f], or returns [Error "list"] if [expr] does
not contain a list. *)
val list : 'a conv -> 'a list conv

Expand Down
3 changes: 1 addition & 2 deletions src/runtime/dune
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
(name ppx_deriving_runtime)
(public_name ppx_deriving.runtime)
(wrapped false)
(synopsis "Type-driven code generation")
(libraries result))
(synopsis "Type-driven code generation"))

(rule
(deps ppx_deriving_runtime.cppo.ml)
Expand Down
21 changes: 0 additions & 21 deletions src/runtime/ppx_deriving_runtime.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,6 @@ module Stdlib = Stdlib

include Stdlib

module Result = struct
type ('a, 'b) t = ('a, 'b) result =
| Ok of 'a
| Error of 'b

type ('a, 'b) result = ('a, 'b) t =
| Ok of 'a
| Error of 'b
end
#else
module Pervasives = Pervasives
module Stdlib = Pervasives
Expand All @@ -58,18 +49,6 @@ module Weak = Weak
module Printf = Printf
module Format = Format
module Buffer = Buffer
module Result = struct
(* the "result" compatibility module defines Result.result,
not Result.t as the 4.08 stdlib *)
type ('a, 'b) t = ('a, 'b) Result.result =
| Ok of 'a
| Error of 'b

(* ... and we also expose Result.result for backward-compatibility *)
type ('a, 'b) result = ('a, 'b) Result.result =
| Ok of 'a
| Error of 'b
end
module Option = struct
type 'a t = 'a option

Expand Down
23 changes: 0 additions & 23 deletions src/runtime/ppx_deriving_runtime.cppo.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,6 @@ include module type of struct
end

module Stdlib = Stdlib

module Result : sig
type ('a, 'b) t = ('a, 'b) result =
| Ok of 'a
| Error of 'b

(* we also expose Result.result for backward-compatibility
with the Result package! *)
type ('a, 'b) result = ('a, 'b) t =
| Ok of 'a
| Error of 'b
end
#else
module Pervasives = Pervasives

Expand Down Expand Up @@ -71,17 +59,6 @@ module Printf = Printf
module Format = Format
module Buffer = Buffer

module Result : sig
type ('a, 'b) t = ('a, 'b) Result.result =
| Ok of 'a
| Error of 'b

(* we also expose Result.result for backward-compatibility *)
type ('a, 'b) result = ('a, 'b) Result.result =
| Ok of 'a
| Error of 'b
end

module Option : sig
type 'a t = 'a option

Expand Down
6 changes: 3 additions & 3 deletions src_plugins/eq/ppx_deriving_eq.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ and expr_of_typ quoter typ =
| Some a, Some b -> [%e expr_of_typ typ] a b
| _ -> false]
| true, ([%type: ([%t? ok_t], [%t? err_t]) result] |
[%type: ([%t? ok_t], [%t? err_t]) Result.result]) ->
[%type: ([%t? ok_t], [%t? err_t]) result]) ->
Copy link
Contributor

Choose a reason for hiding this comment

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

The two cases are now the same. Same in a bunch of other plugins.

But I wonder what implications this change has because this is a fully syntactic pattern. Code which previously derived explicitly for Result.result would no longer match here and fail to derive, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

that's fair. I didn't catch this as it was mostly find / replace. I think it might probably be warranted to keep this case here, which is just matching on an ident Result.result. Since that doesn't re-introduce back the result dependency I think it should be reverted.

[%expr fun x y ->
match x, y with
| Result.Ok a, Result.Ok b -> [%e expr_of_typ ok_t] a b
| Result.Error a, Result.Error b -> [%e expr_of_typ err_t] a b
| Ok a, Ok b -> [%e expr_of_typ ok_t] a b
| Error a, Error b -> [%e expr_of_typ err_t] a b
| _ -> false]
| true, ([%type: [%t? typ] lazy_t] | [%type: [%t? typ] Lazy.t]) ->
[%expr fun (lazy x) (lazy y) -> [%e expr_of_typ typ] x y]
Expand Down
6 changes: 3 additions & 3 deletions src_plugins/fold/ppx_deriving_fold.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ let rec expr_of_typ typ =
| true, [%type: [%t? typ] option] ->
[%expr fun acc -> function None -> acc | Some x -> [%e expr_of_typ typ] acc x]
| true, ([%type: ([%t? ok_t], [%t? err_t]) result] |
[%type: ([%t? ok_t], [%t? err_t]) Result.result]) ->
[%type: ([%t? ok_t], [%t? err_t]) result]) ->
[%expr
fun acc -> function
| Result.Ok ok -> [%e expr_of_typ ok_t] acc ok
| Result.Error err -> [%e expr_of_typ err_t] acc err]
| Ok ok -> [%e expr_of_typ ok_t] acc ok
| Error err -> [%e expr_of_typ err_t] acc err]
| _, { ptyp_desc = Ptyp_constr ({ txt = lid }, args) } ->
app (Exp.ident (mknoloc (Ppx_deriving.mangle_lid (`Prefix deriver) lid)))
(List.map expr_of_typ args)
Expand Down
6 changes: 3 additions & 3 deletions src_plugins/iter/ppx_deriving_iter.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ let rec expr_of_typ typ =
[%expr Ppx_deriving_runtime.Array.iter [%e expr_of_typ typ]]
| true, [%type: [%t? typ] option] ->
[%expr function None -> () | Some x -> [%e expr_of_typ typ] x]
| true, [%type: ([%t? ok_t], [%t? err_t]) Result.result] ->
| true, [%type: ([%t? ok_t], [%t? err_t]) result] ->
[%expr
function
| Result.Ok ok -> ignore ([%e expr_of_typ ok_t] ok)
| Result.Error err -> ignore ([%e expr_of_typ err_t] err)]
| Ok ok -> ignore ([%e expr_of_typ ok_t] ok)
| Error err -> ignore ([%e expr_of_typ err_t] err)]
| _, { ptyp_desc = Ptyp_constr ({ txt = lid }, args) } ->
app (Exp.ident (mknoloc (Ppx_deriving.mangle_lid (`Prefix deriver) lid)))
(List.map expr_of_typ args)
Expand Down
6 changes: 3 additions & 3 deletions src_plugins/map/ppx_deriving_map.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ let rec expr_of_typ ?decl typ =
| true, [%type: [%t? typ] option] ->
[%expr function None -> None | Some x -> Some ([%e expr_of_typ ?decl typ] x)]
| true, ([%type: ([%t? ok_t], [%t? err_t]) result] |
[%type: ([%t? ok_t], [%t? err_t]) Result.result]) ->
[%type: ([%t? ok_t], [%t? err_t]) result]) ->
[%expr
function
| Result.Ok ok -> Result.Ok ([%e expr_of_typ ?decl ok_t] ok)
| Result.Error err -> Result.Error ([%e expr_of_typ ?decl err_t] err)]
| Ok ok -> Ok ([%e expr_of_typ ?decl ok_t] ok)
| Error err -> Error ([%e expr_of_typ ?decl err_t] err)]
| _, { ptyp_desc = Ptyp_constr ({ txt = lid }, args) } ->
app (Exp.ident (mknoloc (Ppx_deriving.mangle_lid (`Prefix deriver) lid)))
(List.map (expr_of_typ ?decl) args)
Expand Down
10 changes: 5 additions & 5 deletions src_plugins/ord/ppx_deriving_ord.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,13 @@ and expr_of_typ quoter typ =
| None, Some _ -> -1
| Some _, None -> 1]
| true, ([%type: ([%t? ok_t], [%t? err_t]) result] |
[%type: ([%t? ok_t], [%t? err_t]) Result.result]) ->
[%type: ([%t? ok_t], [%t? err_t]) result]) ->
[%expr fun x y ->
match x, y with
| Result.Error a, Result.Error b -> [%e expr_of_typ err_t] a b
| Result.Ok a, Result.Ok b -> [%e expr_of_typ ok_t] a b
| Result.Ok _ , Result.Error _ -> -1
| Result.Error _ , Result.Ok _ -> 1]
| Error a, Error b -> [%e expr_of_typ err_t] a b
| Ok a, Ok b -> [%e expr_of_typ ok_t] a b
| Ok _ , Error _ -> -1
| Error _ , Ok _ -> 1]
| true, ([%type: [%t? typ] lazy_t] | [%type: [%t? typ] Lazy.t]) ->
[%expr fun (lazy x) (lazy y) -> [%e expr_of_typ typ] x y]
| _, { ptyp_desc = Ptyp_constr ({ txt = lid }, args) } ->
Expand Down
6 changes: 3 additions & 3 deletions src_plugins/show/ppx_deriving_show.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,14 @@ let rec expr_of_typ quoter typ =
[%e expr_of_typ typ] x;
Ppx_deriving_runtime.Format.pp_print_string fmt ")"]
| true, ([%type: ([%t? ok_t], [%t? err_t]) result] |
[%type: ([%t? ok_t], [%t? err_t]) Result.result]) ->
[%type: ([%t? ok_t], [%t? err_t]) result]) ->
[%expr
function
| Result.Ok ok ->
| Ok ok ->
Ppx_deriving_runtime.Format.pp_print_string fmt "(Ok ";
[%e expr_of_typ ok_t] ok;
Ppx_deriving_runtime.Format.pp_print_string fmt ")"
| Result.Error e ->
| Error e ->
Ppx_deriving_runtime.Format.pp_print_string fmt "(Error ";
[%e expr_of_typ err_t] e;
Ppx_deriving_runtime.Format.pp_print_string fmt ")"]
Expand Down
1 change: 0 additions & 1 deletion src_test/eq/test_deriving_eq.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,6 @@ let test_result ctxt =
assert_equal ~printer false (eq (Error 123) (Error 0))

let test_result_result ctxt =
let open Result in
let eq = [%eq: (string, int) result] in
assert_equal ~printer true (eq (Ok "ttt") (Ok "ttt"));
assert_equal ~printer false (eq (Ok "123") (Error 123));
Expand Down
6 changes: 3 additions & 3 deletions src_test/fold/test_deriving_fold.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ let test_result ctxt =
assert_equal ~printer:string_of_int 1 (f 0 (Ok 1));
assert_equal ~printer:string_of_int (-1) (f 0 (Error 1))

type ('a, 'b) result_res = ('a, 'b) Result.result [@@deriving fold]
type ('a, 'b) result_res = ('a, 'b) result [@@deriving fold]

let test_result_result ctxt =
let f = fold_result_res (+) (-) in
assert_equal ~printer:string_of_int 1 (f 0 (Result.Ok 1));
assert_equal ~printer:string_of_int (-1) (f 0 (Result.Error 1))
assert_equal ~printer:string_of_int 1 (f 0 (Ok 1));
assert_equal ~printer:string_of_int (-1) (f 0 (Error 1))

let suite = "Test deriving(fold)" >::: [
"test_btree" >:: test_btree;
Expand Down
6 changes: 3 additions & 3 deletions src_test/iter/test_deriving_iter.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ type 'a btreer = Node of { lft: 'a btree; elt: 'a; rgt: 'a btree } | Leaf
type 'a ty = 'a * int list
[@@deriving iter]

type 'a res0 = ('a, char) Result.result [@@deriving iter]
type 'a res0 = ('a, char) result [@@deriving iter]

let test_iter_res ctxt =
let has_ok = ref false in
iter_res0 (fun _ -> has_ok := true) (Result.Ok "xxx");
iter_res0 (fun _ -> has_ok := true) (Ok "xxx");
assert_bool "set ok" !has_ok;
iter_res0 (fun _ -> has_ok := false) (Result.Error 'c');
iter_res0 (fun _ -> has_ok := false) (Error 'c');
assert_bool "set ok" !has_ok

let suite = "Test deriving(iter)" >::: [
Expand Down
3 changes: 1 addition & 2 deletions src_test/map/test_deriving_map.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,9 @@ let test_map_result ctxt =
assert_equal ~printer (Ok 10) (f (Ok 9));
assert_equal ~printer (Error true) (f (Error true))

type 'a result_result0 = ('a, bool) Result.result [@@deriving show,map]
type 'a result_result0 = ('a, bool) result [@@deriving show,map]

let test_map_result_result ctxt =
let open Result in
let f = map_result_result0 succ in
let printer = show_result_result0 fmt_int in
assert_equal ~printer (Ok 10) (f (Ok 9));
Expand Down
3 changes: 1 addition & 2 deletions src_test/ord/test_deriving_ord.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,7 @@ let test_ord_result ctx =
assert_equal ~printer 1 (compare_res0 (Error ()) (Ok ()))

let test_ord_result_result ctx =
let compare_res0 = [%ord: (unit, unit) Result.result] in
let open Result in
let compare_res0 = [%ord: (unit, unit) result] in
assert_equal ~printer 0 (compare_res0 (Ok ()) (Ok ()));
assert_equal ~printer (-1) (compare_res0 (Ok ()) (Error ()));
assert_equal ~printer 1 (compare_res0 (Error ()) (Ok ()))
Expand Down
8 changes: 4 additions & 4 deletions src_test/runtime/test_runtime.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,21 @@ let test_hashtbl
(x : ('a, 'b) Ppx_deriving_runtime.Hashtbl.t)

let test_result_qualified
(x : ('a, 'b) Result.result)
(x : ('a, 'b) result)
=
(x : ('a, 'b) Ppx_deriving_runtime.Result.t)
(x : ('a, 'b) result)

#if OCAML_VERSION >= (4, 06, 0)
let test_result_included
(x : ('a, 'b) result)
=
(x : ('a, 'b) Ppx_deriving_runtime.Result.t)
(x : ('a, 'b) result)
#endif

#if OCAML_VERSION >= (4, 07, 0)
let test_result_in_stdlib
(x : ('a, 'b) Stdlib.result)
=
(x : ('a, 'b) Ppx_deriving_runtime.Result.t)
(x : ('a, 'b) result)
#endif

5 changes: 2 additions & 3 deletions src_test/show/test_deriving_show.cppo.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,11 @@ let test_result ctxt =
assert_equal ~printer "(Test_deriving_show.I_has (Error \"err\"))"
(show_i_has_result (I_has (Error "err")))

type i_has_result_result = I_has of (bool, string) Result.result [@@deriving show]
type i_has_result_result = I_has of (bool, string) result [@@deriving show]

let test_result_result ctxt =
let open Result in
assert_equal ~printer "(Ok 100)"
([%show: (int, bool) result] (Result.Ok 100));
([%show: (int, bool) result] (Ok 100));
assert_equal ~printer "(Test_deriving_show.I_has (Ok true))"
(show_i_has_result_result (I_has (Ok true)));
assert_equal ~printer "(Test_deriving_show.I_has (Error \"err\"))"
Expand Down