%mik -> @mikmatch, %miks -> %miksearch

Author: zazedd

MIK.md

@@ -1,5 +1,5 @@
 
-# `%mik` extension
+# `%mikmatch` extension
 
 Accepts `mikmatch` syntax, along with some nice to haves.
 
@@ -68,34 +68,34 @@ Where `PREDEFINED_CLASS` is one of:
 ## Semantics and Examples
 ### Variable substitution
 ```ocaml
-let%mik re1 = {| "hello" |}
-let%mik re2 = {| re1 "world" |}
+let%mikmatch re1 = {| "hello" |}
+let%mikmatch re2 = {| re1 "world" |}
 
-let do_something = function%mik
+let do_something = function%mikmatch
   | {|/ ... (re2) ... /|} -> ...
   | _ -> ...
 
 (* will expand to *)
-let do_something = function%mik
+let do_something = function%mikmatch
   | {|/ ... ("hello" "world") ... /|} -> ...
   | _ -> ...
 ```
 
 ### Variable capture
 ```ocaml
-let%mik num = {| digit+ |}
+let%mikmatch num = {| digit+ |}
 
-let do_something = function%mik
+let do_something = function%mikmatch
   | {|/ ... (num as n) ... /|} -> ... (* (n : string) available here *)
   | _ -> ...
 ```
 
 Values are also available at the guard level:
 
 ```ocaml
-let%mik num = {| digit+ |}
+let%mikmatch num = {| digit+ |}
 
-let do_something = function%mik
+let do_something = function%mikmatch
   | {|/ ... (num as n) ... /|} when n = "123" -> ...
   | _ -> ...
 ```
@@ -104,23 +104,23 @@ let do_something = function%mik
 It is possible to convert variables to `int` of `float` on the fly:
 
 ```ocaml
-let%mik num = {| digit+ |}
+let%mikmatch num = {| digit+ |}
 
-let do_something = function%mik
+let do_something = function%mikmatch
   | {|/ 'd' (num as n : int) ... /|} when n = 123 -> ... (* (n : int) available here *)
   | {|/ 'f' (num as n : float) ... /|} -> ... (* (n : float) available here *)
   | _ -> ...
 ```
 
 It is also possible to pass the variables into any `string -> 'a` function:
 ```ocaml
-let%mik ip = {| (digit{1-3} '.'){3} digit{1-3}|}
+let%mikmatch ip = {| (digit{1-3} '.'){3} digit{1-3}|}
 let parse_ip = String.split_on_char '.'
-let get_ip = function%mik
+let get_ip = function%mikmatch
   | {|/ ... (ip as ip := parse_ip) ... /|} -> ... (* (ip : string list) available here *)
   | _ -> ...
 
-let get_upper_name = function%mik
+let get_upper_name = function%mikmatch
   | {|/ ... (['a'-'z'] as name := String.uppercase) ... /|} -> ... (* (name : string) available here *)
   | _ -> ...
 ```
@@ -141,22 +141,22 @@ let mk_example name num mode = match mode with
   | Some 'b' -> { name; num; mode = `B}
   | Some _ | None -> { name; num; mode = `Default}
 
-let mk_example_re = function%mik
+let mk_example_re = function%mikmatch
   | {|/ (['a'-'z'] as name := String.capitalize_ascii) ' ' (digit+ as num : int) ' ' ('a'|'b' as mode)? >>> mk_example as res /|} -> (* (res : example) available here, and all other bound variables *)
   | _ -> ...
 ```
 
 ## Case Insensitive Match
 
-You can use `%mik_i`: `match%mik_i` and `function%mik_i`. (not available at the variable level)
+You can use `%mikmatch_i`: `match%mikmatch_i` and `function%mikmatch_i`. (not available at the variable level)
 
 ## Alternatives
 ### Defining variables
 You have a choice between:
 ```ocaml
-let%mik re = {|some regex|}
+let%mikmatch re = {|some regex|}
 (* and *)
-let re = {%mik|some regex|}
+let re = {%mikmatch|some regex|}
 ```
 
 No `/` delimiters are needed here.
@@ -165,7 +165,7 @@ No `/` delimiters are needed here.
 #### `match%mik` and `function%mik`
 
 ```ocaml
-function%mik
+function%mikmatch
   | {|/ some regex /|} -> ...
   | {|/ another regex /|} -> ...
   ...
@@ -175,23 +175,23 @@ function%mik
 This match expression will compile all of the REs in the branches into one, and use marks to find which branch was executed.  
 Efficient if you have multiple branches.
 
-#### `match%miks` and `function%miks` (search, not anchored)
+#### `match%miksearch` and `function%miksearch` (search, not anchored)
 
 The previous extension was **anchored**, meaning, it will only match at the beginning of the string.
 
 This version is not, meaning, for example:
 
 ```ocaml
-let mik_test = function%mik
+let mik_test = function%mikmatch
   | {|/ (digit+ as num) /|} -> ...
   ...
   | _ -> failwith "no match"
 
 let () = mik_test "123" ...     (* match *)
 let () = mik_test "test123" ... (* ERROR: no match *)
 
-(* but, with %miks... *)
-let miks_test = function%miks
+(* but, with %miksearch... *)
+let miks_test = function%miksearch
   | {|/ (digit+ as num) /|} -> ...
   ...
   | _ -> failwith "no match"
@@ -200,23 +200,23 @@ let () = miks_test "123" ...     (* match *)
 let () = miks_test "test123" ... (* match *)
 ```
 
-Similar for `%miks_i`, except it is case insensitive.
+Similar for `%miksearch_i`, except it is case insensitive.
 
 #### General match/function
 
 ```ocaml
 function
   | "some string" -> ...
-  | {%mik|/ some regex /|} -> ...
+  | {%mikmatch|/ some regex /|} -> ...
   ...
   | "another string" -> ...
-  | {%miks|/ some regex /|} -> ... (* non-anchored *)
+  | {%miksearch|/ some regex /|} -> ... (* non-anchored *)
   ...
   | "yet another string" -> ...
-  | {%mik_i|/ another regex /|} -> ... (* case insensitive *)
+  | {%mikmatch_i|/ another regex /|} -> ... (* case insensitive *)
   ...
   | "would you guess it" -> ...
-  | {%miks_i|/ another regex /|} -> ... (* non-anchored, case insensitive *)
+  | {%miksearch_i|/ another regex /|} -> ... (* non-anchored, case insensitive *)
   | _ -> ...
 ```
 

README.md

@@ -58,9 +58,9 @@ The patterns are plain strings of the form accepted by `Re.Pcre`, with the follo
 A variable is allowed for the universal case and is bound to the matched
 string.
 
-### `%mik`
+### `%mikmatch`
 
-Full [%mik guide](./MIK.md)
+Full [%mikmatch guide](./MIK.md)
 
 #### Quick Links
 - [Variable capture](./MIK.md#variable-capture)

ppx_regexp/ppx_regexp.ml

@@ -25,7 +25,7 @@ let transformation ctx =
     method! structure_item item acc =
       match item.pstr_desc with
       (* let%mik/%pcre x = {|some regex|}*)
-      | Pstr_extension (({ txt = ("pcre" | "mik") as ext; _ }, PStr [ { pstr_desc = Pstr_value (rec_flag, vbs); _ } ]), _) ->
+      | Pstr_extension (({ txt = ("pcre" | "mikmatch") as ext; _ }, PStr [ { pstr_desc = Pstr_value (rec_flag, vbs); _ } ]), _) ->
         let mode = if ext = "pcre" then `Pcre else `Mik in
         let bindings = Transformations.transform_let ~mode ~ctx vbs in
         let new_item = { item with pstr_desc = Pstr_value (rec_flag, bindings) } in
@@ -36,7 +36,7 @@ let transformation ctx =
           List.fold_left
             (fun (vbs_acc, bindings_acc) vb ->
               match vb.pvb_expr.pexp_desc with
-              | Pexp_extension ({ txt = ("pcre" | "mik") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (expr, _); _ } ])
+              | Pexp_extension ({ txt = ("pcre" | "mikmatch") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (expr, _); _ } ])
                 when match expr.pexp_desc with Pexp_constant (Pconst_string _) -> true | _ -> false ->
                 let mode = if ext = "pcre" then `Pcre else `Mik in
                 let new_vb = { vb with pvb_expr = expr } in
@@ -68,15 +68,17 @@ let transformation ctx =
       in
       match e_ext.pexp_desc with
       (* match%mik/match%pcre and function%mik/function%pcre, anchored *)
-      | Pexp_extension ({ txt = ("pcre" | "mik" | "pcre_i" | "mik_i") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (e, _); _ } ]) ->
+      | Pexp_extension ({ txt = ("pcre" | "mikmatch" | "pcre_i" | "mikmatch_i") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (e, _); _ } ])
+        ->
         let mode = if String.starts_with ~prefix:"pcre" ext then `Pcre else `Mik in
         let opts =
           if String.ends_with ~suffix:"_i" ext then `Caseless :: `Anchored :: Util.default_opts else `Anchored :: Util.default_opts
         in
         let loc = e.pexp_loc in
         make_transformations ~mode ~opts ~loc e.pexp_desc
       (* match%miks/match%pcres and function%miks/function%pcres, non anchored (search) *)
-      | Pexp_extension ({ txt = ("pcres" | "miks" | "pcres_i" | "miks_i") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (e, _); _ } ]) ->
+      | Pexp_extension
+          ({ txt = ("pcres" | "miksearch" | "pcres_i" | "miksearch_i") as ext; _ }, PStr [ { pstr_desc = Pstr_eval (e, _); _ } ]) ->
         let mode = if String.starts_with ~prefix:"pcre" ext then `Pcre else `Mik in
         let opts = if String.ends_with ~suffix:"_i" ext then `Caseless :: Util.default_opts else Util.default_opts in
         let loc = e.pexp_loc in
@@ -88,7 +90,9 @@ let transformation ctx =
             begin
               fun case ->
                 match case.pc_lhs.ppat_desc with
-                | Ppat_extension ({ txt = "pcre" | "pcres" | "mik" | "miks" | "pcre_i" | "pcres_i" | "mik_i" | "miks_i"; _ }, _) -> true
+                | Ppat_extension
+                    ({ txt = "pcre" | "pcres" | "mikmatch" | "miksearch" | "pcre_i" | "pcres_i" | "mikmatch_i" | "miksearch_i"; _ }, _) ->
+                  true
                 | _ -> false
             end
             cases
@@ -100,7 +104,9 @@ let transformation ctx =
             begin
               fun case ->
                 match case.pc_lhs.ppat_desc with
-                | Ppat_extension ({ txt = "pcre" | "pcres" | "mik" | "miks" | "pcre_i" | "pcres_i" | "mik_i" | "miks_i"; _ }, _) -> true
+                | Ppat_extension
+                    ({ txt = "pcre" | "pcres" | "mikmatch" | "miksearch" | "pcre_i" | "pcres_i" | "mikmatch_i" | "miksearch_i"; _ }, _) ->
+                  true
                 | _ -> false
             end
             cases

ppx_regexp/transformations.ml

@@ -324,7 +324,7 @@ let transform_mixed_match ~loc ~ctx ?matched_expr cases acc =
   let aux case =
     match case.pc_lhs.ppat_desc with
     | Ppat_extension
-        ( { txt = ("pcre" | "mik" | "pcre_i" | "mik_i") as ext; _ },
+        ( { txt = ("pcre" | "mikmatch" | "pcre_i" | "mikmatch_i") as ext; _ },
           (* anchored *)
           PStr [ { pstr_desc = Pstr_eval ({ pexp_desc = Pexp_constant (Pconst_string (pat, str_loc, _)); _ }, _); _ } ] ) ->
       let pos = str_loc.loc_start in
@@ -336,7 +336,7 @@ let transform_mixed_match ~loc ~ctx ?matched_expr cases acc =
       let re, bs, nG = extract_bindings ~parser ~pos ~ctx pat in
       `Mik (opts, re, nG, bs, case.pc_rhs, case.pc_guard)
     | Ppat_extension
-        ( { txt = ("pcres" | "miks" | "pcres_i" | "miks_i") as ext; _ },
+        ( { txt = ("pcres" | "miksearch" | "pcres_i" | "miksearch_i") as ext; _ },
           (* search, non anchored *)
           PStr [ { pstr_desc = Pstr_eval ({ pexp_desc = Pexp_constant (Pconst_string (pat, str_loc, _)); _ }, _); _ } ] ) ->
       let pos = str_loc.loc_start in