refactor(nix/escapeExecline): move into own directory

The escaping functions are going to be used by both `writeExecline`
and `runExecline`, so let’s move them to their own namespace.

Change-Id: Iccf69eaeca3062573e0751a17c548b7def86196d
Reviewed-on: https://cl.tvl.fyi/c/depot/+/706
Reviewed-by: tazjin <mail@tazj.in>
Reviewed-by: Kane York <rikingcoding@gmail.com>
This commit is contained in:
Profpatsch 2020-06-28 00:06:11 +02:00
parent dc07977866
commit 7a6a007302
3 changed files with 34 additions and 30 deletions

View file

@ -0,0 +1,3 @@
inherited: true
owners:
- Profpatsch

View file

@ -0,0 +1,29 @@
{ lib, ... }:
let
# replaces " and \ to \" and \\ respectively and quote with "
# e.g.
# a"b\c -> "a\"b\\c"
# a\"bc -> "a\\\"bc"
escapeExeclineArg = arg:
''"${builtins.replaceStrings [ ''"'' ''\'' ] [ ''\"'' ''\\'' ] (toString arg)}"'';
# Escapes an execline (list of execline strings) to be passed to execlineb
# Give it a nested list of strings. Nested lists are interpolated as execline
# blocks ({}).
# Everything is quoted correctly.
#
# Example:
# escapeExecline [ "if" [ "somecommand" ] "true" ]
# == ''"if" { "somecommand" } "true"''
escapeExecline = execlineList: lib.concatStringsSep " "
(let
go = arg:
if builtins.isString arg then [(escapeExeclineArg arg)]
else if builtins.isPath arg then [(escapeExeclineArg "${arg}")]
else if lib.isDerivation arg then [(escapeExeclineArg arg)]
else if builtins.isList arg then [ "{" ] ++ builtins.concatMap go arg ++ [ "}" ]
else abort "escapeExecline can only hande nested lists of strings, was ${lib.generators.toPretty {} arg}";
in builtins.concatMap go execlineList);
in
escapeExecline

View file

@ -1,4 +1,4 @@
{ pkgs, lib, ... }: { pkgs, depot, ... }:
# Write an execline script, represented as nested nix lists. # Write an execline script, represented as nested nix lists.
# Everything is escaped correctly. # Everything is escaped correctly.
@ -6,34 +6,6 @@
# TODO(Profpatsch) upstream into nixpkgs # TODO(Profpatsch) upstream into nixpkgs
let
# replaces " and \ to \" and \\ respectively and quote with "
# e.g.
# a"b\c -> "a\"b\\c"
# a\"bc -> "a\\\"bc"
escapeExeclineArg = arg:
''"${builtins.replaceStrings [ ''"'' ''\'' ] [ ''\"'' ''\\'' ] (toString arg)}"'';
# Escapes an execline (list of execline strings) to be passed to execlineb
# Give it a nested list of strings. Nested lists are interpolated as execline
# blocks ({}).
# Everything is quoted correctly.
#
# Example:
# escapeExecline [ "if" [ "somecommand" ] "true" ]
# == ''"if" { "somecommand" } "true"''
escapeExecline = execlineList: lib.concatStringsSep " "
(let
go = arg:
if builtins.isString arg then [(escapeExeclineArg arg)]
else if builtins.isPath arg then [(escapeExeclineArg "${arg}")]
else if lib.isDerivation arg then [(escapeExeclineArg arg)]
else if builtins.isList arg then [ "{" ] ++ builtins.concatMap go arg ++ [ "}" ]
else abort "escapeExecline can only hande nested lists of strings, was ${lib.generators.toPretty {} arg}";
in builtins.concatMap go execlineList);
in
name: name:
{ {
# "var": substitute readNArgs variables and start $@ # "var": substitute readNArgs variables and start $@
@ -63,5 +35,5 @@ in
# TODO(Profpatsch): rewrite `writeScript` with `runExecline` # TODO(Profpatsch): rewrite `writeScript` with `runExecline`
pkgs.writeScript name '' pkgs.writeScript name ''
#!${pkgs.execline}/bin/execlineb -W${env} #!${pkgs.execline}/bin/execlineb -W${env}
${escapeExecline argList} ${depot.nix.escapeExecline argList}
'' ''