Generation of init and variables for Windows

ocaml · Jun 12, 2023 · 4a31da2 · 4a31da2
1 parent fd429e3
commit 4a31da2
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 15 deletions.
diff --git a/master_changes.md b/master_changes.md
@@ -49,6 +49,7 @@ users)
   * Display actual location of OPAMROOT in `opam init` if `--root` or `OPAMROOT` have been set [#5212 @dra27 - fix #4992]
   * Surround and add a comment describing the role of the lines added to the ~/.profile or equivalent [#5456 @kit-ty-kate]
   * Don't require cc on Windows [#5541 @dra27]
+  * Generate init and variables for Windows [#5541 @dra27]
 
 ## Config report
   * [BUG] Don't fail is no switch is set [#5198 @rjbou]
@@ -643,6 +644,7 @@ users)
   * `OpamSwitchState.load`: fill empty switch synopsis with invariant formula instead of compiler package name [#5208 @rjbou]
   * `OpamSwitchState`: add `compiler_packages` that returns set of installed compilers, with their dependencies including only build & depopt [#5480 @rjbou]
   * `OpamEnv`: generalise splitting of environment variables [#5541 @dra27]
+  * `OpamEnv`: add handling of `SH_pwsh` and `SH_cmd` in shell lists [#5541 @dra27]
 
 ## opam-solver
   * `OpamCudf`: Change type of `conflict_case.Conflict_cycle` (`string list list` to `Cudf.package action list list`) and `cycle_conflict`, `string_of_explanations`, `conflict_explanations_raw` types accordingly [#4039 @gasche]

diff --git a/src/state/opamEnv.ml b/src/state/opamEnv.ml
@@ -562,7 +562,7 @@ let eval_string gt ?(set_opamswitch=false) switch =
 
 (** The shells for which we generate init scripts (bash and sh are the same
     entry) *)
-let shells_list = [ SH_sh; SH_zsh; SH_csh; SH_fish ]
+let shells_list = [ SH_sh; SH_zsh; SH_csh; SH_fish; SH_pwsh Powershell; SH_cmd ]
 
 let complete_file = function
   | SH_sh | SH_bash -> Some "complete.sh"
@@ -574,23 +574,22 @@ let env_hook_file = function
   | SH_zsh -> Some "env_hook.zsh"
   | SH_csh -> Some "env_hook.csh"
   | SH_fish -> Some "env_hook.fish"
-  | SH_pwsh _ | SH_cmd ->
-    (* N/A because not present in `shells_list` yet *) None
+  | SH_pwsh _ | SH_cmd -> None
 
 let variables_file = function
   | SH_sh | SH_bash | SH_zsh -> "variables.sh"
   | SH_csh -> "variables.csh"
   | SH_fish -> "variables.fish"
-  | SH_pwsh _ | SH_cmd ->
-    (* N/A because not present in `shells_list` yet *) "variables.sh"
+  | SH_pwsh _ -> "variables.ps1"
+  | SH_cmd -> "variables.cmd"
 
 let init_file = function
   | SH_sh | SH_bash -> "init.sh"
   | SH_zsh -> "init.zsh"
   | SH_csh -> "init.csh"
   | SH_fish -> "init.fish"
-  | SH_pwsh _ | SH_cmd ->
-    (* N/A because not present in `shells_list` yet *) "init.sh"
+  | SH_pwsh _ -> "init.ps1"
+  | SH_cmd -> "init.cmd"
 
 let complete_script = function
   | SH_sh | SH_bash -> Some OpamScript.complete
@@ -640,7 +639,7 @@ let export_in_shell shell =
         (make_comment comment) k v
   in
   let pwsh (k,v,comment) =
-    Printf.sprintf "%s$env:%s=%s;\n"
+    Printf.sprintf "%s$env:%s=%s\n"
       (make_comment comment) k v in
   let cmd (k,v,comment) =
     let make_cmd_comment comment_opt =
@@ -675,9 +674,9 @@ let source root shell f =
     Printf.sprintf "[[ ! -r %s ]] || source %s  > /dev/null 2> /dev/null\n"
       fname fname
   | SH_cmd ->
-    Printf.sprintf "if exist \"%s\" ( \"%s\" >NUL 2>NUL )\n" fname fname
+    Printf.sprintf "if exist \"%s\" call \"%s\" >NUL 2>NUL\n" fname fname
   | SH_pwsh _ ->
-    Printf.sprintf "& \"%s\" > $null 2> $null\n" fname
+    Printf.sprintf ". \"%s\" *> $null\n" fname
 
 let if_interactive_script shell t e =
   let ielse else_opt = match else_opt with
@@ -726,11 +725,26 @@ let string_of_update st shell updates =
     in
     let key, value =
       ident, match symbol with
-      | Eq  -> Printf.sprintf "'%s'" string
+      | Eq ->
+        (match shell with
+         | SH_pwsh _ ->
+           Printf.sprintf "'%s'" (OpamStd.Env.escape_powershell string)
+         | SH_cmd -> string
+         | _ -> Printf.sprintf "'%s'" string)
       | PlusEq | ColonEq | EqPlusEq ->
-        Printf.sprintf "'%s':\"$%s\"" string ident
+        let sep = get_env_property ident Separator in
+        (match shell with
+         | SH_pwsh _ ->
+           Printf.sprintf "'%s%c' + \"$env:%s\""
+             (OpamStd.Env.escape_powershell string) sep ident
+         | SH_cmd -> Printf.sprintf "%s%c%%%s%%" string sep ident
+         | _ -> Printf.sprintf "'%s':\"$%s\"" string ident)
       | EqColon | EqPlus ->
-        Printf.sprintf "\"$%s\":'%s'" ident string
+        let sep = get_env_property ident Separator in
+        (match shell with
+         | SH_pwsh _ -> Printf.sprintf "\"$env:%s\" + '%c%s'" ident sep string
+         | SH_cmd -> Printf.sprintf "%%%s%%%c%s" ident sep string
+         | _ -> Printf.sprintf "\"$%s\":'%s'" ident string)
     in
     export_in_shell shell (key, value, comment) in
   OpamStd.List.concat_map "" aux updates
@@ -810,15 +824,15 @@ let write_dynamic_init_scripts st =
       (fun shell ->
          write_script (OpamPath.init st.switch_global.root)
            (variables_file shell, string_of_update st shell updates))
-      [SH_sh; SH_csh; SH_fish]
+      [SH_sh; SH_csh; SH_fish; SH_pwsh Powershell; SH_cmd]
   with OpamSystem.Locked ->
     OpamConsole.warning
       "Global shell init scripts not installed (could not acquire lock)"
 
 let clear_dynamic_init_scripts gt =
   List.iter (fun shell ->
       OpamFilename.remove (OpamPath.init gt.root // variables_file shell))
-    [SH_sh; SH_csh; SH_fish]
+    [SH_sh; SH_csh; SH_fish; SH_pwsh Powershell; SH_cmd]
 
 let dot_profile_needs_update root dot_profile =
   if not (OpamFilename.exists dot_profile) then `yes else