chiark / gitweb /
nailing-cargo: -o alias for --online, -O alias for --offline
[nailing-cargo.git] / nailing-cargo
index 3b673d83807ea4a71f356571d2664596abcf249a..a4d2d4a177579bc1fd2ba994b9f701291499f70a 100755 (executable)
@@ -18,9 +18,8 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 # example usages:
-#   ../nailing-cargo/nailing-caretwgo make
+#   ../nailing-cargo/nailing-cargo make
 #   ../nailing-cargo/nailing-cargo cargo build
-#   CARGO='../nailing-cargo/nailing-cargo cargo' make
 
 # Why do we need this ?
 #
 #  https://stackoverflow.com/questions/33025887/how-to-use-a-local-unpublished-crate
 #  https://github.com/rust-lang/cargo/issues/1481
 
-
-#: Cargo.nail:
+# Options:
+#    -v   Increase verbosity.  Default is 1.
+#    -q   Set verbosity ot 0.
+#    -D   Increase amount of debugging dump.
+#
+#    -n   "No action": stop after writing Cargo.toml.nailing~
+#         everywhere, and do not run any build command.
+#
+#    -T<arch> --target=<arch>
+#         Specify target architecture.  If <arch> starts with a
+#         capital ascii letter, is an alias for some other arch
+#         looked up in Cargo.nail and then in the builtin list:
+#           RPI   arm-unknown-linux-gnueabihf
+#         Translates to a --target= option to the ultimate command,
+#         unless that is a cargo subcommand which would reject it.
+#
+#    -u | --cargo-lock-update
+#    -U | --no-cargo-lock-update
+#         Arranges to do a dance to allow Cargo.lock (or
+#         alternative) to be updated in the source directory.
+#
+#         The Cargo.lock and Cargo.toml are copied to the build
+#         directory along with a skeleton just big enough to fool
+#         cargo.  After cargo has run, the resulting Cargo.lock is
+#         copied back to the source tree.
+#
+#         Makes no sense with in-tree builds.
+#
+#         Default is no update unless the ultimate command is a
+#         cargo subcommand which we know needs it.
+#
+#    -m | --cargo-manifest-args
+#    -M | --no-cargo-manifest-args
+#         Controls whether we add cargo command line options
+#         relating to finding Cargo.toml, to the command to
+#         run.
 #
+#         Default is true if we are doing an out-of- tree build,
+#         unless we are updating the Cargo.lock (in which case the
+#         only relevant files are to be found in the build directory).
+#
+#         The arguments are
+#             --manifest-path=<path/to/Cargo.toml>
+#             --locked
+#             --target-dir=target
+#
+#    -T | --no-cargo-target-arg
+#    -t | --cargo-target-arg
+#         Suppress --target (or un-suppress it).  Only useful with -m.
+#         Done automatically when nailing-cargo sees that the cargo
+#         subcommand is one which needs it, eg `fetch'.
+#
+#    --online  | -o
+#    --offline | -O
+#         Whether to allow cargo to make network access.
+#         (nailing-cargo always passes --offline to cargo, unless
+#         --online is in force).  The default is offline,
+#         unless the cargo subcommand is one which implies
+#         online (currently, `fetch').
+#
+# Cargo.nail:
+#
+#    # Adds each <subdir> to the list of directories whose
+#    # Cargo.toml is to be nailed, and also arranges to use
+#    # the package found there for other directories if
+#    # no other source of that package is evident in Cargo.nail.
+#    subdirs = [
+#      "<subdir>"
+#      ...
+#    ]
+# or:
+#    subdirs = """
+#      "<subdir>"
+#      ...
+#    """
+#
+#    # Adds <subdir> to the list of directories whose Cargo.toml
+#    # is to be nailed, and overrides any other nailing for <package>
 #    [packages]
-#    package = subdir
-#    package = { subdir = ... }
+#    <package> = <subdir>
+#    <package> = { <subdir> = ... }
+#
+# Configuration is read from
 #
-#    [subdirs]
-#    subdir
+#    /etc/nailing-cargo/cfg.toml
+#    ~/.nailing-cargo.toml
+#    ./.nailing-cargo.toml
+#    ../Nailing-Cargo.toml
+#    ../Cargo.nail
+#
+#  To control use of alternative Cargo.lock filename:
+#    [alt_cargolock]
+#
+#    file = true               # equivalent to "Cargo.lock.example"
+#    file = false              # disables this feature
+#    file = "<some leafname>"
+# 
+#    force = false    # default, uses alt file only if it already exists
+#    force = true     # always uses alt file; creation would make Cargo.lock
+#
+# (you can also specify just alt_cargo_lock instead of alt_cargo_lock.file)
+#
+# To enable out of tree builds:
+#    [oot]
+#    dir = "<build-directory>"    # default is Build, if use is specified
+# and then
+#    use = "really"
+#    user = "<someuser>"
+#  or
+#    use = "ssh"
+#    user = "<user>@host"         # NB must still share a filesystem!
+#  or
+#    use = "command_args"
+#    command = ["<command>", "<which works like>", "nice"]
+#  or
+#    use = "command_sh"
+#    command = ["<command>", "<which work like>", "sh -c"]
+#  or
+#    use = "null"
+#
+# Other settings:
+#    [misc]
+#    online = true   # forces default to be --online
+#    online = false  # forces default to be --offline
+#
+# Limitations:
+#
+#   Always dirties everyone's Cargo.toml, but tries to put them
+#     back (if not, running it again should fix it).  Cannnot be
+#     fixed without changes to cargo.
+#
+#   Out of tree builds require a unified filesystem view: eg,
+#     different users on the same host, NFS, or something.  This
+#     could be improved.
+#
+#   Alternative Cargo.lock file must currently be a leafname.
+#     I think this just involves review to check other values work.
+#
+#   Alternative Cargo.lock file must be on smae filesystem.
+#     This is not so easy; we would want the existing algorithm but
+#     a fallback for this case.
+#
+#   Cargo.nail unconditionally looked for in ..
+#     Ideally should be configurable, and also perhaps be able
+#     to combine multiple Cargo.nail files ?
+#
+# Env vars we pass to the command:
+#   NAILINGCARGO_WORKSPHERE     absolute path of invocation ..
+#   NAILINGCARGO_MANIFEST_DIR   absolute path of invocation .
+#   NAILINGCARGO_BUILDSPHERE    only if out of tree: abs parent of build dir
+#   NAILINGCARGO_BUILD_DIR      absolute path of build dir (even if = src)
+
+
+our $self;
 
 use strict;
-use TOML;
 use POSIX;
+use Types::Serialiser;
+
+our %archmap = (
+    RPI => 'arm-unknown-linux-gnueabihf',
+);
+
+BEGIN {
+  $self = $0;  $self =~ s{^.*/(?=.)}{};
+  my $deref = $0;
+  while ($deref =~ m{^/}) {
+    my $link = readlink $deref;
+    if (!defined $link) {
+      $! == EINVAL
+       or die "$self: checking our script location $deref: $!\n";
+      $deref =~ s{/[^/]+$}{}
+       or die "$self: unexpected script path: $deref\n";
+      unshift @INC, $deref."/TOML-Tiny/lib";
+      last;
+    }
+    last if $link !~ m{^/};
+    $deref = $link;
+  }
+}
+
 use Fcntl qw(LOCK_EX);
-use Cwd;
+use File::Compare;
+use TOML::Tiny::Faithful;
+
+our $src_absdir = getcwd() // die "$self: getcwd failed: $!\n";
+
+our $worksphere = $src_absdir;
+$worksphere =~ s{/([^/]+)$}{}
+  or die "$self: cwd \`$worksphere' unsupported!\n";
+our $subdir = $1; # leafname
 
-my $self = $0;  $self =~ s{^.*/(?=.)}{};
+our $lockfile = "../.nailing-cargo.lock";
 
-my $worksphere = fastcwd // die "$self: Cwd::fastcwd failed: $!\n";
-$worksphere =~ s{/[^/]+}{} or die "$self: cwd \`$worksphere' unsupported!\n";
-our $lockfile = "../.nailing-cargo-sphere.lock";
+our $cargo_lock_update;
+our $cargo_manifest_args;
+our $cargo_target_arg=1;
+our $alt_cargo_lock;
+our $online;
 
 our @configs;
+our $verbose=1;
+our ($noact,$dump);
+our $target;
 
 sub read_or_enoent ($) {
-    my ($fn) = @_;
-    if (!open R, '<', $fn) {
-       return undef if $!==ENOENT;
-       die "$self: open $fn: $!\n";
-    }
-    local ($/) = undef;
-    my ($r) = <R> // die "$self: read $fn: $!\n";
-    $r;
+  my ($fn) = @_;
+  if (!open R, '<', $fn) {
+    return undef if $!==ENOENT;
+    die "$self: open $fn: $!\n";
+  }
+  local ($/) = undef;
+  my ($r) = <R> // die "$self: read $fn: $!\n";
+  $r;
+}
+
+sub stat_exists ($$) {
+  my ($fn, $what) = @_;
+  if (stat $fn) { return 1; }
+  $!==ENOENT or die "$self: stat $what: $fn: $!\n";
+  return 0;
 }
 
 sub toml_or_enoent ($$) {
-    my ($f,$what) = @_;
-    my $toml = read_or_enoent($f) // return;
-    my ($toml,$e) = from_toml($toml);
-    die "$self: parse TOML: $what: $f: $e\n" if defined $e;
-    $toml;
+  my ($f,$what) = @_;
+  my $toml = read_or_enoent($f) // return;
+  print STDERR "Read TOML from $f\n" if $dump;
+  my ($v,$e) = from_toml($toml);
+  if (!defined $v) {
+    chomp $e;
+    die "$self: parse TOML: $what: $f: $e\n";
+  }
+  die "$e ?" if length $e;
+  $v;
 }
 
 sub load1config ($) {
-    my ($f) = @_;
-    my $toml = toml_or_enoent($f, "config file");
-    push @configs, $toml if defined $toml;
+  my ($f) = @_;
+  my $toml = toml_or_enoent($f, "config file");
+  push @configs, $toml if defined $toml;
 }
 
 sub loadconfigs () {
-    my $cfgleaf = ".nailing-cargo-cfg.toml";
-    load1config("/etc/nailing-cargo/cfg.toml");
-    load1config("$worksphere/$cfgleaf");
-    load1config("$HOME/$cfgleaf") if defined $HOME;
+  my $dotfile = ".nailing-cargo.toml";
+  load1config("../Nailing-Cargo.toml");
+  load1config($dotfile);
+  load1config("$ENV{HOME}/$dotfile") if defined $ENV{HOME};
+  load1config("/etc/nailing-cargo/cfg.toml");
 }
 
-sub getcfg ($$) {
-    my ($k, $def) = @_;
-    foreach my $cfg (@configs) {
-       my $v = $cfg{$k};
-       return $v if defined $v;
-    }
-    return $df;
-}
-
-sub lock () {
-    for (;;) {
-       open LOCK, ">", $lockfile or die "$0: open/create $lockfile: $!\n";
-       flock LOCK, LOCK_EX or die "$0: lock $lockfile: $!\n";
-       my @fstat = stat LOCK or die "$0: fstat: $!\n";
-       my @stat  = stat $lockfile;
-       if (!@stat) {
-           next if $! == ENOENT;
-           die "$0: stat $lockfile: $!\n";
-       }
-       last if "@fstat[0..5]" == "@stat[0..5]";
+sub unlink_or_enoent ($) { unlink $_[0] or $!==ENOENT; }
+
+sub same_file ($$) {
+  my ($x,$y) = @_;
+  "@$x[0..5]" eq "@$y[0..5]";
+}
+
+sub takelock () {
+  for (;;) {
+    open LOCK, ">", $lockfile or die "$self: open/create $lockfile: $!\n";
+    flock LOCK, LOCK_EX or die "$self: lock $lockfile: $!\n";
+    my @fstat = stat LOCK or die "$self: fstat: $!\n";
+    my @stat  = stat $lockfile;
+    if (!@stat) {
+      next if $! == ENOENT;
+      die "$self: stat $lockfile: $!\n";
     }
+    last if same_file(\@fstat,\@stat);
+  }
 }
 sub unlock () {
-    unlink $lockfile or die "$0: removing lockfile: $!\n";
+  unlink $lockfile or die "$self: removing lockfile: $!\n";
 }
 
 our $nail;
 
-sub readnail () {
-    my $nailfile = "../Cargo.nail";
-    open N, '<', $nailfile or die "$0: open $nailfile: $!\n";
-    local ($/) = undef;
-    my $toml = <N> // die "$0: read $nailfile: $!";
-    my $transformed;
-    if ($toml !~ m{^\s*\[/}m &&
-       $toml !~ m{^[^\n\#]*\=}m &&
-       # old non-toml syntax
-       $toml =~ s{^[ \t]*([-_0-9a-z]+)[ \t]+(\S+)[ \t]*$}{$1 = $2}mig) {
-       $toml =~ s{^}{[packages\]\n};
-       $transformed = 1;
+sub badcfg {
+  my $m = pop @_;
+  $" = '.';
+  die "$self: config key \`@_': $m\n";
+}
+
+sub cfg_uc {
+  foreach my $cfg (@configs) {
+    my $v = $cfg;
+    foreach my $k (@_) {
+      last unless defined $v;
+      ref($v) eq 'HASH' or badcfg @_, "parent key \`$k' is not a hash";
+      $v = $v->{$k};
     }
-    my $e;
-    ($nail,$e) = from_toml($toml);
-    if (defined $e) {
-       if ($transformed) {
-           $toml =~ s/^/    /mg;
-           print STDERR "$self: $nailfile transformed into TOML:\n$toml\n";
-       }
-       die "$0: parse $nailfile: $e\n";
+    return $v if defined $v;
+  }
+  return undef;
+}
+
+sub cfge {
+  my $exp = shift @_;
+  my $v = cfg_uc @_;
+  my $got = ref($v) || 'scalar';
+  return $v if !defined($v) || $got eq $exp;
+  badcfg @_, "found \L$got\E, expected \L$exp\E";
+  # ^ toml doesn't make refs to scalars, so this is unambiguous
+}
+
+sub cfgn {
+  my $exp = shift @_;
+  (cfge $exp, @_) // badcfg @_, "missing";
+}
+
+sub cfgs  { cfge 'scalar', @_ }
+sub cfgsn { cfgn 'scalar', @_ }
+
+sub cfg_bool {
+  my $v = cfg_uc @_;
+  return $v if !defined($v) || Types::Serialiser::is_bool $v;
+  badcfg @_, "expected boolean";
+}
+
+sub cfgn_list {
+  my $l = cfge 'ARRAY', @_;
+  foreach my $x (@$l) {
+    !ref $x or badcfg @_, "list contains non-scalar element";
+  }
+  @$l
+}
+
+sub readnail () {
+  my $nailfile = "../Cargo.nail";
+  open N, '<', $nailfile or die "$self: open $nailfile: $!\n";
+  local ($/) = undef;
+  my $toml = <N> // die "$self: read $nailfile: $!";
+  my $transformed;
+  if ($toml !~ m{^\s*\[/}m &&
+      $toml !~ m{^[^\n\#]*\=}m &&
+      # old non-toml syntax
+      $toml =~ s{^[ \t]*([-_0-9a-z]+)[ \t]+(\S+)[ \t]*$}{$1 = \"$2\"}mig) {
+    $toml =~ s{^}{[packages\]\n};
+    my @sd;
+    $toml =~ s{^[ \t]*\-[ \t]*\=[ \t]*(\"[-_0-9a-z]+\"\n?)$}{
+      push @sd, $1; '';
+    }mige;
+    $toml = "subdirs = [\n".(join '', map { "$_\n" } @sd)."]\n".$toml;
+    $transformed = 1;
+  }
+  my $e;
+  ($nail,$e) = from_toml($toml);
+  if (!defined $nail) {
+    if ($transformed) {
+      $toml =~ s/^/    /mg;
+      print STDERR "$self: $nailfile transformed into TOML:\n$toml\n";
     }
-    die unless defined $nail;
+    $/="\n"; chomp $e;
+    die "$self: parse $nailfile: $e\n";
+  }
+  die "$e ?" if length $e;
+
+  $nail->{subdirs} //= [ ];
+
+  if (!ref $nail->{subdirs}) {
+    $nail->{subdirs} = [
+      grep /^[^\#]/,
+      map { s/^\s+//; s/\s+$//; $_; }
+      split m{\n},
+      $nail->{subdirs}
+    ];
+  }
+
+  unshift @configs, $nail;
+}
+
+our @alt_cargo_lock_stat;
+
+sub consider_alt_cargo_lock () {
+  my @ck = qw(alt_cargo_lock);
+  # User should *either* have Cargo.lock in .gitignore,
+  # or expect to commit Cargo.lock.example ($alt_cargo_lock)
+
+  $alt_cargo_lock = (cfg_uc @ck);
+
+  my $force = 0;
+  if (defined($alt_cargo_lock) && ref($alt_cargo_lock) eq 'HASH') {
+    $force = cfg_bool qw(alt_cargo_lock force);
+    my @ck = qw(alt_cargo_lock file);
+    $alt_cargo_lock = cfg_uc @ck;
+  }
+  $alt_cargo_lock //= Types::Serialiser::true;
+
+  if (Types::Serialiser::is_bool $alt_cargo_lock) {
+    if (!$alt_cargo_lock) { $alt_cargo_lock = undef; return; }
+    $alt_cargo_lock = 'Cargo.lock.example';
+  }
+
+  if (ref($alt_cargo_lock) || $alt_cargo_lock =~ m{/}) {
+    badcfg @ck, "expected boolean, or leafname";
+  }
+
+  if (!stat_exists $alt_cargo_lock, "alt_cargo_lock") {
+    $alt_cargo_lock = undef unless $force;
+    return;
+  }
+  
+  @alt_cargo_lock_stat = stat _;
+}
+
+our $oot_dir;      # oot.dir or "Build"
+
+sub consider_oot () {
+  $oot_dir = cfgs qw(oot dir);
+  my $use = cfgs qw(oot use);
+  unless (defined($oot_dir) || defined($use)) {
+    die "$self: specified --cargo-lock-update but not out-of-tree build!\n"
+      if $cargo_lock_update;
+    $cargo_lock_update=0;
+    return;
+  }
+  $oot_dir //= 'Build';
 }
 
 our %manifests;
 our %packagemap;
 
 sub read_manifest ($) {
-    my ($subdir) = @_;
-    my $manifest = "../$subdir/Cargo.toml";
-    if (defined $manifests{$manifesst}) {
-       print STDERR
-"$self: warning: $subdir: specified more than once!\n";
-       return undef;
-    }
-    foreach my $try ("$manifest.unnailed", "$manifest") {
-       my $toml = toml_or_enoent($try, "package manifest") // next;
-       my $p = $toml->{package}{name};
-       if (!defined $p) {
-           print STDERR
-"$self: warning: $subdir: missing package.name in $try, ignoring\n";
-           next;
-       }
-       $manifests{$manifest} = $toml;
-       return $p;
-    }
+  my ($subdir) = @_;
+  my $manifest = "../$subdir/Cargo.toml";
+  print STDERR "$self: reading $manifest...\n" if $verbose>=4;
+  if (defined $manifests{$manifest}) {
+    print STDERR
+ "$self: warning: $subdir: specified more than once!\n";
     return undef;
+  }
+  foreach my $try ("$manifest.unnailed", "$manifest") {
+    my $toml = toml_or_enoent($try, "package manifest") // next;
+    my $p = $toml->{package}{name};
+    if (!defined $p) {
+      print STDERR
+ "$self: warning: $subdir: missing package.name in $try, ignoring\n";
+      next;
+    }
+    $manifests{$manifest} = $toml;
+    return $p;
+  }
+  return undef;
 }
 
 sub readorigs () {
-    foreach my $p (keys %{ $nail->{packages} }) {
-       my $v = $nail->{packages}{$p};
-       my $subdir = ref($v) ? $v->{subdir} : $v;
-       my $gotpackage = read_manifest($subdir) // '<nothing!>';
-       if ($gotpackage ne $p) {
-           print STDERR
- "$self: warning: honouring Cargo.nail [packages.$subdir]=$p even though $subdir contains package $gotpackage!\n";
-       }
-       die if defined $packagemap{$p};
-       $packagemap{$p} = $subdir;
+  foreach my $p (keys %{ $nail->{packages} }) {
+    my $v = $nail->{packages}{$p};
+    my $subdir = ref($v) ? $v->{subdir} : $v;
+    my $gotpackage = read_manifest($subdir) // '<nothing!>';
+    if ($gotpackage ne $p) {
+      print STDERR
+ "$self: warning: honouring Cargo.nail packages.$subdir=$p even though $subdir contains package $gotpackage!\n";
     }
-    foreach my $subdir (@{ $nail->{subdirs} }) {
-       my $gotpackage = read_manifest($subdir);
-       if (!defined $gotpackage) {
-           print STDERR
+    die if defined $packagemap{$p};
+    $packagemap{$p} = $subdir;
+  }
+  foreach my $subdir (@{ $nail->{subdirs} }) {
+    my $gotpackage = read_manifest($subdir);
+    if (!defined $gotpackage) {
+      print STDERR
  "$self: warning: ignoring subdir $subdir which has no Cargo.toml\n";
-           next;
+      next;
+    }
+    $packagemap{$gotpackage} //= $subdir;
+  }
+}
+
+sub calculate () {
+  foreach my $p (sort keys %packagemap) {
+    print STDERR "$self: package $p in $packagemap{$p}\n" if $verbose>=2;
+  }
+  foreach my $mf (keys %manifests) {
+    my $toml = $manifests{$mf};
+    foreach my $k (qw(dependencies build-dependencies dev-dependencies)) {
+      my $deps = $toml->{$k};
+      next unless $deps;
+      foreach my $p (keys %packagemap) {
+       my $info = $deps->{$p};
+       next unless defined $info;
+       $deps->{$p} = $info = { } unless ref $info;
+       delete $info->{version};
+       $info->{path} = $worksphere.'/'.$packagemap{$p};
+      }
+    }
+    my $nailing = "$mf.nailing~";
+    unlink_or_enoent $nailing or die "$self: remove old $nailing: $!\n";
+    open N, '>', $nailing or die "$self: create new $nailing: $!\n";
+    print N to_toml($toml) or die "$self: write new $nailing: $!\n";
+    close N or die "$self: close new $nailing: $!\n";
+  }
+}
+
+sub addargs () {
+  $online //= cfg_bool qw(misc online);
+
+  if (@ARGV>=2 &&
+      $ARGV[0] =~ m{\bcargo\b}) {
+    if ($ARGV[1] =~ m/^(?:generate-lockfile|update)$/) {
+      $cargo_lock_update //= 1;
+      $target = undef;
+    }
+    if ($ARGV[1] =~ m/^(?:fetch)$/) {
+      $cargo_target_arg=0;
+      $online //= 1;
+    }
+  }
+  $cargo_lock_update //= 0;
+  $cargo_manifest_args //=
+    (defined $oot_dir) && !$cargo_lock_update;
+
+  $online //= 0;
+
+  if ($cargo_manifest_args) {
+    push @ARGV, "--manifest-path=${src_absdir}/Cargo.toml",
+      qw(--locked);
+    push @ARGV, qw(--target-dir=target) if $cargo_target_arg;
+  }
+
+  if (defined $target) {
+    if ($target =~ m{^[A-Z]}) {
+      $target = (cfgs 'arch', $target) // $archmap{$target}
+       // die "$self: --target=$target alias specified; not in cfg or map\n";
+    }
+    push @ARGV, "--target=$target";
+  }
+
+  push @ARGV, "--offline" unless $online;
+}
+
+our $oot_absdir;
+our $build_absdir; # .../Build/<subdir>
+
+sub oot_massage_cmdline () {
+  return unless defined $oot_dir;
+
+  my $use = cfgs qw(oot use);
+  $oot_absdir = ($oot_dir !~ m{^/} ? "$worksphere/" : ""). $oot_dir;
+  $build_absdir = "$oot_absdir/$subdir";
+
+  my ($pre,$post);
+  my @xargs;
+  if (!$cargo_lock_update) {
+    push @xargs, $build_absdir;
+    ($pre, $post) = ('cd "$1"; shift; ', '');
+  } else {
+    push @xargs, $oot_absdir, $subdir, $src_absdir;
+    $pre =  <<'END';
+        cd "$1"; shift;
+        mkdir -p -- "$1"; cd "$1"; shift;
+        cp -- "$1"/Cargo.toml
+END
+    $pre .= <<'ENDLK' if stat_exists 'Cargo.lock', 'working cargo lockfile';
+              "$1"/Cargo.lock
+ENDLK
+    $pre .= <<'ENDCP';
+                              .;
+ENDCP
+    $pre .= <<'ENDPRE';
+        shift;
+        mkdir -p src; >src/lib.rs; >build.rs
+ENDPRE
+    $post = <<'ENDPOST';
+        rm -r src Cargo.toml build.rs;
+ENDPOST
+  }
+  my $addpath = (cfg_uc qw(oot path_add)) //
+    $use eq 'really' ? Types::Serialiser::true : Types::Serialiser::false;
+  $addpath =
+    !Types::Serialiser::is_bool $addpath ? $addpath           :
+    $addpath                             ? '$HOME/.cargo/bin' :
+                                           undef;
+  if (defined $addpath) {
+    $pre .= <<END
+        PATH=$addpath:\${PATH-/usr/local/bin:/bin:/usr/bin};
+        export PATH;
+END
+  }
+  $pre  =~ s/^\s+//mg; $pre  =~ s/\s+/ /g;
+  $post =~ s/^\s+//mg; $post =~ s/\s+/ /g;
+
+  my $getuser = sub { cfgsn qw(oot user) };
+  my @command;
+  my $xe = $verbose >= 2 ? 'xe' : 'e';
+  my $sh_ec = sub {
+    if (!length $post) {
+      @command = (@_, 'sh',"-${xe}c",$pre.'exec "$@"','--',@xargs);
+    } else {
+      @command = (@_, 'sh',"-${xe}c",$pre.'"$@"; '.$post,'--',@xargs);
+    }
+    push @command, @ARGV;
+  };
+  my $command_sh = sub {
+    my $quoted = join ' ', map {
+      return $_ if !m/\W/;
+      s/\'/\'\\'\'/g;
+      "'$_'"
+    } @ARGV;
+    @command = @_, "set -${xe}; $pre $quoted; $post";
+  };
+  print STDERR "$self: out-of-tree, building in: \`$build_absdir'\n"
+    if $verbose;
+  if ($use eq 'really') {
+    my $user = $getuser->();
+    my @pw = getpwnam $user or die "$self: oot.user \`$user' lookup failed\n";
+    my $homedir = $pw[7];
+    $sh_ec->('really','-u',$user,'env',"HOME=$homedir");
+    print STDERR "$self: using really to run as user \`$user'\n" if $verbose;
+  } elsif ($use eq 'ssh') {
+    my $user = $getuser->();
+    $user .= '@localhost' unless $user =~ m/\@/;
+    $command_sh->('ssh',$user);
+    print STDERR "$self: using ssh to run as \`$user'\n" if $verbose;
+  } elsif ($use eq 'command_args') {
+    my @c = cfgn_list qw(oot command);
+    $sh_ec->(@c);
+    print STDERR "$self: out-of-tree, adverbial command: @c\n" if $verbose;
+  } elsif ($use eq 'command_sh') {
+    my @c = cfgn_list qw(oot command);
+    $command_sh->(@c);
+    print STDERR "$self: out-of-tree, ssh'ish command: @c\n" if $verbose;
+  } elsif ($use eq 'null') {
+    $sh_ec->();
+  } else {
+    die "$self: oot.use mode $use not recognised\n";
+  }
+  die unless @command;
+  @ARGV = @command;
+}
+
+sub setenvs () {
+  $ENV{NAILINGCARGO_WORKSPHERE}   = $worksphere;
+  $ENV{NAILINGCARGO_MANIFEST_DIR} = $src_absdir;
+  $ENV{NAILINGCARGO_BUILDSPHERE}  = $oot_absdir;
+  delete $ENV{NAILINGCARGO_BUILDSPHERE} unless $oot_absdir;
+  $ENV{NAILINGCARGO_BUILD_DIR}    = $build_absdir // $src_absdir;
+}
+
+our $want_uninstall;
+
+END {
+  if ($want_uninstall) {
+    local ($?);
+    foreach my $mf (keys %manifests) {
+      eval { uninstall1($mf,1); 1; } or warn "$@";
+    }
+    eval { unaltcargolock(1); 1; } or warn "$@";
+  }
+}
+
+our $cleanup_cargo_lock;
+sub makebackups () {
+  foreach my $mf (keys %manifests) {
+    link "$mf", "$mf.unnailed" or $!==EEXIST
+      or die "$self: make backup link $mf.unnailed: $!\n";
+  }
+
+  if (defined($alt_cargo_lock)) {
+    if (@alt_cargo_lock_stat) {
+      print STDERR "$self: using alt_cargo_lock `$alt_cargo_lock'..."
+       if $verbose>=3;
+      if (link $alt_cargo_lock, 'Cargo.lock') {
+       print STDERR " linked\n" if $verbose>=3;
+      } elsif ($! != EEXIST) {
+       print STDERR "\n" if $verbose>=3;
+       die "$self: make \`Cargo.lock' available as \`$alt_cargo_lock': $!\n";
+      } else {
+       print STDERR "checking quality." if $verbose>=3;
+       my @lock_stat = stat 'Cargo.lock'
+         or die "$self: stat Cargo.lock (for alt check: $!\n";
+       same_file(\@alt_cargo_lock_stat, \@lock_stat)
+         or die
+"$self: \`Cargo.lock' and alt file \`$alt_cargo_lock' both exist and are not the same file!\n";
+      }
+      $cleanup_cargo_lock = 1;
+    } else {
+      $cleanup_cargo_lock = 1;
+      # If Cargo.lock exists and alt doesn't, that means either
+      # that a previous run was interrupted, or that the user has
+      # messed up.
+    }
+  }
+}
+
+sub nailed ($) {
+  my ($mf) = @_;
+  my $nailed  = "$mf.nailed~"; $nailed =~ s{/([^/]+)$}{/.$1} or die;
+  $nailed;
+}    
+
+sub install () {
+  my @our_unfound_stab = stat_exists('Cargo.toml', 'local Cargo.toml')
+    ? (stat _) : ();
+  foreach my $mf (keys %manifests) {
+    if (@our_unfound_stab) {
+      if (stat_exists $mf, "manifest in to-be-nailed directory") {
+       my @mf_stab = stat _ ;
+       if ("@mf_stab[0..1]" eq "@our_unfound_stab[0..1]") {
+         @our_unfound_stab = ();
        }
-       $packagemap{$gotpackage} //= $subdir;
+      }
+    }
+
+    my $nailing = "$mf.nailing~";
+    my $nailed = nailed($mf);
+    my ($use, $rm);
+    my $diff;
+    if (open NN, '<', $nailed) {
+      $diff = compare($nailing, \*NN);
+      die "$self: compare $nailing and $nailed: $!" if $diff<0;
+    } else {
+      $!==ENOENT or die "$self: check previous $nailed: $!\n";
+      $diff = 1;
+    }
+    if ($diff) {
+      $use = $nailing;
+      $rm  = $nailed;
+    } else {
+      $use = $nailed;
+      $rm  = $nailing;
     }
+    rename $use, $mf or die "$self: install nailed $use: $!\n";
+    unlink_or_enoent $rm or die "$self: remove old $rm: $!\n";
+    print STDERR "$self: nailed $mf\n" if $verbose>=3;
+  }
+
+  if (@our_unfound_stab) {
+    print STDERR
+ "$self: *WARNING* cwd is not in Cargo.nail thbough it has Cargo.toml!\n";
+  }
+}
+
+sub invoke () {
+  my $r = system @ARGV;
+  if (!$r) {
+    return 0;
+  } elsif ($r<0) {
+    print STDERR "$self: could not execute $ARGV[0]: $!\n";
+    return 127;
+  } elsif ($r & 0xff00) {
+    print STDERR "$self: $ARGV[0] failed (exit status $r)\n";
+    return $r >> 8;
+  } else {
+    print STDERR "$self: $ARGV[0] died due to signal! (wait status $r)\n";
+    return 125;
+  }
+}
+
+sub cargo_lock_update_after () {
+  if ($cargo_lock_update) {
+    # avoids importing File::Copy and the error handling is about as good
+    $!=0; $?=0;
+    my $r= system qw(cp --), "$build_absdir/Cargo.lock", "Cargo.lock";
+    die "$self: run cp: $! $?" if $r<0 || $r & 0xff;
+    die "$self: failed to update local Cargo.lock (wait status $r)\n" if $r;
+  }
+}
+
+sub uninstall1 ($$) {
+  my ($mf, $enoentok) = @_;
+  my $unnailed = "$mf.unnailed";
+  rename $unnailed, $mf or ($enoentok && $!==ENOENT)
+    or die "$self: failed to restore: rename $unnailed back to $mf: $!\n";
+}
+
+sub unaltcargolock ($) {
+  my ($enoentok) = @_;
+  return unless $cleanup_cargo_lock;
+  die 'internal error!' unless defined $alt_cargo_lock;
+
+  # we ignore $enoentok because we don't know if one was supposed to
+  # have been created.
+
+  rename('Cargo.lock', $alt_cargo_lock) or $!==ENOENT or die
+ "$self: cleanup: rename possibly-updated \`Cargo.lock' to \`$alt_cargo_lock': $!\n";
+
+  unlink 'Cargo.lock' or $!==ENOENT or die
+ "$self: cleanup: remove \`Cargo.lock' in favour of \`$alt_cargo_lock': $!\n";
+  # ^ this also helps clean up the stupid rename() corner case
+}
+
+sub uninstall () {
+  foreach my $mf (keys %manifests) {
+    my $nailed = nailed($mf);
+    link $mf, $nailed or die "$self: preserve (link) $mf as $nailed: $!\n";
+    uninstall1($mf,0);
+  }
+  unaltcargolock(0);
 }
 
 while (@ARGV && $ARGV[0] =~ m/^-/) {
-    $_ = shift @ARGV;
-    last if m/^--$/;
+  $_ = shift @ARGV;
+  last if m{^--$};
+  if (m{^-[^-]}) {
+    while (m{^-.}) {
+      if (s{^-v}{-}) {
+       $verbose++;
+      } elsif (s{^-q}{-}) {
+       $verbose=0;
+      } elsif (s{^-n}{-}) {
+       $noact++;
+      } elsif (s{^-D}{-}) {
+       $dump++;
+      } elsif (s{^-T(.+)}{-}s) {
+       $target = $1;
+      } elsif (s{^-([uU])}{-}) {
+       $cargo_lock_update= $1=~m/[a-z]/;
+      } elsif (s{^-([mM])}{-}) {
+       $cargo_manifest_args= $1=~m/[a-z]/;
+      } elsif (s{^-([tT])}{-}) {
+       $cargo_target_arg= $1=~m/[a-z]/;
+      } elsif (s{^-([oO])}{-}) {
+       $online= $1=~m/[a-z]/;
+      } else {
+       die "$self: unknown short option(s) $_\n";
+      }
+    }
+  } elsif (s{^--target=}{}) {
+    $target = $_;
+  } elsif (m{^--(no-)?cargo-lock-update}) {
+    $cargo_lock_update= !!$1;
+  } elsif (m{^--(no-)?cargo-manifest-args}) {
+    $cargo_manifest_args= !!$1;
+  } elsif (m{^--(no-)?cargo-target-arg}) {
+    $cargo_target_arg= !!$1;
+  } elsif (m{^--(on|off)line$}) {
+    $online = $1 eq 'on';
+  } else {
+    die "$self: unknown long option $_\n";
+  }
 }
 
-lock();
+die "$self: need command to run\n" unless @ARGV || $noact;
+
+loadconfigs();
+takelock();
 readnail();
+consider_alt_cargo_lock();
+consider_oot();
 readorigs();
+calculate();
+addargs();
+our @display_cmd = @ARGV;
+oot_massage_cmdline();
+setenvs();
+
+if ($dump) {
+  eval '
+    use Data::Dumper;
+    print STDERR Dumper(\%manifests) if $dump>=2;
+    print STDERR Dumper(\%packagemap, \@ARGV,
+                        { src_absdir => $src_absdir,
+                          worksphere => $worksphere,
+                          subdir => $subdir,
+                          oot_dir => $oot_dir,
+                          oot_absdir => $oot_absdir,
+                          build_absdir => $build_absdir });
+  ' or die $@;
+}
+
+exit 0 if $noact;
+
+$want_uninstall = 1;
+makebackups();
+install();
+
+printf STDERR "$self: nailed (%s manifests, %s packages)%s\n",
+  (scalar keys %manifests), (scalar keys %packagemap),
+  (defined($alt_cargo_lock) and ", using `$alt_cargo_lock'")
+  if $verbose;
+
+print STDERR "$self: invoking: @display_cmd\n" if $verbose;
+my $estatus = invoke();
+
+cargo_lock_update_after();
+
+uninstall();
+$want_uninstall = 0;
+
+print STDERR "$self: unnailed.  status $estatus.\n" if $verbose;
 
-__DATA__
-
-lock=${PWD%/*}/.nail.lock
-if [ "x$NAILING_CARGO" != "x$lock" ]; then
-       NAILING_CARGO=$lock \
-       exec with-lock-ex -w "$lock" "$0" "$@"
-fi
-
-exec 203<../Cargo.nail
-f=Cargo.toml
-
-sed='
-/^ *\[\(build-\)\?dependencies\]/,/^ \[/{
-'
-
-if test -e ../Cargo.nail-env; then
-       . ../Cargo.nail-env
-fi
-
-exec 204<../Cargo.nail
-while read <&204 what where; do
-       if [ "x$what" = x- ]; then continue; fi
-       if [ "x$what" = 'x#' ]; then continue; fi
-       qwhere="${where//\//\\/}"
-       sed+='
-               /{.*path *=/ b
-               s/^'$what' *= *\(\".*\"\) *$/'$what' = { version = \1 }/;
-               s#^'$what' *= *{#'$what' = { path = "'"${PWD%/*}"'/'"${qwhere}"'", #;
-               /^'$what' *=/ s/version *= *\"[^"]*\"//;
-               /^'$what' *=/ s/, *\([,}]\)/\1/;
-       '
-done
-sed+='}
-'
-
-exec 204<../Cargo.nail
-while read <&204 what where; do
-       if [ "x$what" = 'x#' ]; then continue; fi
-       wf=../$where/$f
-       rm -f $wf.nailing~
-       sed <$wf >$wf.nailing~ "$sed"
-done
-
-exec 204<../Cargo.nail
-while read <&204 what where; do
-       if [ "x$what" = 'x#' ]; then continue; fi
-       wf=../$where/$f
-       if ! test -e $wf.unnailed~; then
-               ln $wf $wf.unnailed~
-       fi
-done
-
-trap '
-       set +e
-       while read <&203 what where; do
-               if [ "x$what" = "x#" ]; then continue; fi
-               wf=../$where/$f
-               if test -e $wf.unnailed~; then
-                       rm -f $wf.nailed~
-                       ln $wf $wf.nailed~
-                       mv -f $wf.unnailed~ $wf
-               fi
-       done
-       echo >&2 'Unnailed'
-' EXIT
-
-exec 204<../Cargo.nail
-printf >&2 'Nailing'
-while read <&204 what where; do
-       if [ "x$what" = 'x#' ]; then continue; fi
-       wf=../$where/$f
-       printf >&2 ' %s' "$what"
-       if cmp -s $wf.nailed~ $wf.nailing~; then
-               mv -f $wf.nailed~ $wf
-               rm -f $wf.nailing
-       else
-               mv -f $wf.nailing~ $wf
-               rm -f $wf.nailed
-       fi
-done
-echo >&2
-
-"$@"
+exit $estatus;