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.

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

Update Cookbook Examples #19

Merged
merged 5 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@ end

include Pro_mode_env
[@@config (project_mode = "pro")]

module A : sig
val name : string [@@cfg (project_mode = "pro")]
end = struct
let name = "Product" [@@cfg (project_mode = "pro")]
end
```

### Enabling/Disabling Let definitions
Expand Down Expand Up @@ -124,11 +130,23 @@ type favorite_bands =
| Yes
| KingCrimson [@config (likes_trumpets = true)]

let is_favorite x =
match x with
| Rush -> true
| Yes -> false
| KingCrimson -> false [@config (likes_trumpets = true)]

type has_published_album_recently =
[ `nope
| `yes
| `maybe [@config (is_indecisive = true)]
]

let get_has_published (x: has_published_album_recently) =
match x with
| `nope -> true
| `yes -> false
| `maybe -> false [@config (is_indecisive = true)]
```

### Enabling/Disabling Record Fields
Expand Down
83 changes: 76 additions & 7 deletions config/cfg_ppx.ml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ let eval_attr attr =
(* Printf.printf "\n\nattr name: %S\n\n" attr.attr_name.txt; *)
match attr.attr_payload with
| PStr [ { pstr_desc = Pstr_eval (e, []); _ } ] ->
(* let e = Pprintast.string_of_expression e in *)
(* Printf.printf "\n\npayload: %S\n\n" e; *)
(* let e_ = Pprintast.string_of_expression e in *)
(* Printf.printf "\n\npayload: %S\n\n" e_; *)
if Cfg_lang.eval ~loc ~env e then `keep else `drop
| _ -> `keep

Expand Down Expand Up @@ -137,22 +137,91 @@ let rec apply_config_on_expression (exp : expression) =
{ exp with pexp_desc }

let apply_config_on_value_bindings (vbs : value_binding list) =
List.map
(fun vb -> { vb with pvb_expr = apply_config_on_expression vb.pvb_expr })
List.filter_map
(fun vb ->
if should_keep vb.pvb_attributes = `keep then
Some { vb with pvb_expr = apply_config_on_expression vb.pvb_expr }
else None)
vbs

let apply_config_on_signature_items sig_items =
List.filter_map
(fun sig_item ->
match sig_item.psig_desc with
| Psig_value val_desc ->
if should_keep val_desc.pval_attributes = `keep then Some sig_item
else None
| Psig_type (rec_flag, tds) ->
let tds = apply_config_on_types tds in
if List.length tds = 0 then None
else Some { sig_item with psig_desc = Psig_type (rec_flag, tds) }
| _ -> Some sig_item)
sig_items

let apply_config_on_module_type mod_type =
match mod_type.pmty_desc with
| Pmty_signature signature_items ->
let signature_items = apply_config_on_signature_items signature_items in
{ mod_type with pmty_desc = Pmty_signature signature_items }
| _ -> mod_type

let rec apply_config_on_module_expr mod_expr =
match mod_expr.pmod_desc with
| Pmod_apply _ | Pmod_unpack _ | Pmod_extension _ | Pmod_ident _
| Pmod_functor _ ->
mod_expr
| Pmod_structure structs ->
let new_structs =
List.filter_map
(fun stri ->
match stri.pstr_desc with
| Pstr_value (rec_flag, vbs) ->
let vbs = apply_config_on_value_bindings vbs in
if List.length vbs = 0 then None
else Some { stri with pstr_desc = Pstr_value (rec_flag, vbs) }
| _ -> Some stri)
structs
in
{ mod_expr with pmod_desc = Pmod_structure new_structs }
| Pmod_constraint (module_expr, module_type) ->
let module_expr = apply_config_on_module_expr module_expr in
let module_type = apply_config_on_module_type module_type in
{ mod_expr with pmod_desc = Pmod_constraint (module_expr, module_type) }

let apply_config_on_structure_item stri =
try
match stri.pstr_desc with
| Pstr_typext { ptyext_attributes = attrs; _ }
| Pstr_modtype { pmtd_attributes = attrs; _ }
| Pstr_open { popen_attributes = attrs; _ }
| Pstr_include { pincl_attributes = attrs; _ }
| Pstr_exception { ptyexn_attributes = attrs; _ }
| Pstr_primitive { pval_attributes = attrs; _ }
| Pstr_eval (_, attrs)
| Pstr_module { pmb_attributes = attrs; _ } ->
| Pstr_eval (_, attrs) ->
if should_keep attrs = `keep then Some stri else None
| Pstr_modtype { pmtd_attributes; pmtd_name; pmtd_type; pmtd_loc } ->
if should_keep pmtd_attributes = `keep then
match pmtd_type with
| None -> Some stri
| Some pmtd_type ->
let pmtd_type = Some (apply_config_on_module_type pmtd_type) in
Some
{
stri with
pstr_desc =
Pstr_modtype
{ pmtd_attributes; pmtd_name; pmtd_type; pmtd_loc };
}
else None
| Pstr_module { pmb_expr; pmb_name; pmb_attributes; pmb_loc } ->
if should_keep pmb_attributes = `keep then
let pmb_expr = apply_config_on_module_expr pmb_expr in
Some
{
stri with
pstr_desc =
Pstr_module { pmb_expr; pmb_name; pmb_attributes; pmb_loc };
}
else None
| Pstr_value (recflag, vbs) ->
if should_keep_many vbs (fun vb -> vb.pvb_attributes) = `keep then
let vbs = apply_config_on_value_bindings vbs in
Expand Down
33 changes: 28 additions & 5 deletions config/ppx.t/cond_module.ml
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
module M = struct
let best_band_in_the_world = "RUSH"
module type A = sig
val best_band_in_the_world : string [@@cfg (value = "1")]
val worst_band_in_the_world : string [@@cfg (value = "2")]
val get_lower_case_band_name : string -> string [@@cfg (value = "2")]
val get_upper_case_band_name : string -> string [@@cfg (value = "1")]
end
[@@config (made_up = true)]

let rush () = M.best_band_in_the_world
[@@config (made_up = true)]
module B:A = struct
let best_band_in_the_world = "RUSH" [@@cfg (value = "1")]
let worst_band_in_the_world = "Nickelback" [@@cfg (value = "2")]
let get_lower_case_band_name name = name [@@cfg (value = "2")]
let get_upper_case_band_name name = name [@@cfg (value = "1")]
end

module C : sig
val best_band_in_the_world : string [@@cfg (value = "1")]
val worst_band_in_the_world : string [@@cfg (value = "2")]
end = struct
let best_band_in_the_world = "RUSH" [@@cfg (value = "1")]
let worst_band_in_the_world = "Nickelback" [@@cfg (value = "2")]
end

module D = struct
let best_band_in_the_world = "RUSH" [@@cfg (value = "1")]
let worst_band_in_the_world = "Nickelback" [@@cfg (value = "2")]
end
[@@cfg (value = "2")]

let rush () = C.best_band_in_the_world
let nickelback () = C.worst_band_in_the_world [@@cfg (value = "2")]
2 changes: 2 additions & 0 deletions config/ppx.t/cond_type.mli
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
type band = { name : string; } [@@config (made_up = true)]
val best_band_in_the_world : unit -> band [@@config (made_up = true)]
33 changes: 33 additions & 0 deletions config/ppx.t/run.t
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,36 @@
cookies = []
}]
external foo : unit -> int = "made_up_call"

$ dune clean
$ value=1 target_os=madeup dune describe pp cond_module.ml
[@@@ocaml.ppx.context
{
tool_name = "ppx_driver";
include_dirs = [];
load_path = [];
open_modules = [];
for_package = None;
debug = false;
use_threads = false;
use_vmthreads = false;
recursive_types = false;
principal = false;
transparent_modules = false;
unboxed_types = false;
unsafe_string = false;
cookies = []
}]
module type A =
sig
val best_band_in_the_world : string[@@cfg value = "1"]
val get_upper_case_band_name : string -> string[@@cfg value = "1"]
end
module B : A =
struct
let best_band_in_the_world = "RUSH"[@@cfg value = "1"]
let get_upper_case_band_name name = name[@@cfg value = "1"]
end
module C : sig val best_band_in_the_world : string[@@cfg value = "1"] end =
struct let best_band_in_the_world = "RUSH"[@@cfg value = "1"] end
let rush () = C.best_band_in_the_world
Loading