wip theory

[topbloke.git] / Topbloke.pm

diff --git a/Topbloke.pm b/Topbloke.pm
index f5c469fe48515c99abbb43696223133ad0769350..a7ecad5880702f55a0ca928a4dd84fbe5ad44e9f 100644 (file)
--- a/Topbloke.pm
+++ b/Topbloke.pm
@@ -1,13 +1,15 @@
 # -*- perl -*-
 
 # -*- perl -*-
 

+package Topbloke;
+

 use strict;
 use warnings;
 
 use POSIX;
 use IO::File;
 use IPC::Open2;
 use strict;
 use warnings;
 
 use POSIX;
 use IO::File;
 use IPC::Open2;

-
-package Topbloke;
+use File::Path qw(make_path remove_tree);
+use File::Basename;

 
 BEGIN {
     use Exporter   ();
 
 BEGIN {
     use Exporter   ();


@@ -15,15 +17,17 @@ BEGIN {
 
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
 
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);

-    @EXPORT      = qw(debug
+    @EXPORT      = qw(debug $tiprefs $baserefs

                      run_git run_git_1line run_git_check_nooutput
                      run_git run_git_1line run_git_check_nooutput

-                     run_git_test_anyoutput
-                     git_config git_dir chdir_toplevel
-                     current_branch parse_patch_spec
+                     run_git_test_anyoutput git_get_object
+                     git_config git_dir chdir_toplevel enable_reflog
+                     current_branch parse_patch_spec parse_patch_name

                      setup_config check_no_unwanted_metadata
                      setup_config check_no_unwanted_metadata

+                     patch_matches_spec

                      foreach_patch
                      foreach_patch

-                     flagsfile_add_flag
-                     wf_start wf wf_abort wf_done wf_contents);
+                     propsfile_add_prop depsfile_add_dep
+                     wf_start wf wf_abort wf_done wf_contents
+                     closeout);

     %EXPORT_TAGS = ( );
     @EXPORT_OK   = qw();
 }
     %EXPORT_TAGS = ( );
     @EXPORT_OK   = qw();
 }


@@ -35,6 +39,8 @@ sub debug ($) {
     print STDERR "DEBUG: $msg\n" or die $!;
 }
 
     print STDERR "DEBUG: $msg\n" or die $!;
 }
 

+#----- general interaction with git -----
+

 sub run_git {
     # takes optional prefix arguments:
     #    coderef    hook to call for each line read,
 sub run_git {
     # takes optional prefix arguments:
     #    coderef    hook to call for each line read,


@@ -93,21 +99,27 @@ sub git_get_object ($) {
     my ($objname) = @_;
     our ($gro_pid, $gro_out, $gro_in);
     if (!$gro_pid) {
     my ($objname) = @_;
     our ($gro_pid, $gro_out, $gro_in);
     if (!$gro_pid) {

-       $gro_pid = IPC::Open2::open2($gro_out, $gro_in,
-                                    $git_command, qw(cat-file --batch))
+       $gro_pid = open2($gro_out, $gro_in, $git_command, qw(cat-file --batch))

            or die $!;
     }
            or die $!;
     }

+    #debug("git_get_object $objname");

     $SIG{'PIPE'} = 'IGN';
     print $gro_in $objname,"\n" or die $!;
     $gro_in->flush or die "$objname $!";
     $SIG{'PIPE'} = 'DFL';
     my $l = <$gro_out>;
     chomp $l or die "$objname $l ?";
     $SIG{'PIPE'} = 'IGN';
     print $gro_in $objname,"\n" or die $!;
     $gro_in->flush or die "$objname $!";
     $SIG{'PIPE'} = 'DFL';
     my $l = <$gro_out>;
     chomp $l or die "$objname $l ?";

+    #debug("git_get_object $objname => $l");

     if ($l =~ m/ missing$/) {
        return 'missing';
     } elsif (my ($type,$bytes) = $l =~ m/^\S+ (\w+) (\d+)$/) {
     if ($l =~ m/ missing$/) {
        return 'missing';
     } elsif (my ($type,$bytes) = $l =~ m/^\S+ (\w+) (\d+)$/) {

-       my $data;
-       read $gro_out, $data, $bytes == $bytes or die "$objname $!";
+       my $data = '';
+       if ($bytes) {
+           (read $gro_out, $data, $bytes) == $bytes or die "$objname $!";
+       }
+       my $nl;
+       (read $gro_out, $nl, 1) == 1 or die "$objname $!";
+       $nl eq "\n" or die "$objname ?";

        return ($type, $data);
     } else {
        die "$objname $l";
        return ($type, $data);
     } else {
        die "$objname $l";


@@ -138,6 +150,8 @@ sub git_dir () {
     return $git_dir;
 }
 
     return $git_dir;
 }
 

+#----- specific interactions with git -----
+

 sub chdir_toplevel () {
     my $toplevel;
     run_git(sub { $toplevel = $_; }, 
 sub chdir_toplevel () {
     my $toplevel;
     run_git(sub { $toplevel = $_; }, 


@@ -146,6 +160,91 @@ sub chdir_toplevel () {
     chdir $toplevel or die "chdir toplevel $toplevel: $!\n";
 }
 
     chdir $toplevel or die "chdir toplevel $toplevel: $!\n";
 }
 

+sub enable_reflog ($) {
+    my ($branchref) = @_;
+    $branchref =~ m#^refs/# or die;
+    my $logsdir = git_dir().'/logs/';
+    my $dirname = $logsdir.dirname($branchref);
+    make_path($dirname) or die "$dirname $!";
+    open REFLOG, '>>', $logsdir.$branchref or die "$logsdir$branchref $!";
+    close REFLOG or die $!;
+}    
+
+sub check_no_unwanted_metadata ($) {
+    # for checking foreign branches aren't contaminated
+    my ($gitbranch) = @_;
+    run_git_check_nooutput('foreign unexpectedly contains',
+                          qw(ls-tree --name-only),
+                          "$gitbranch:",
+                          qw(.topbloke));
+}
+
+sub check_clean_tree ($) {
+    run_git_check_nooutput("operation requires working tree to be clean",
+                          qw(diff --name-only HEAD --));
+    run_git_check_nooutput("operation cannot proceed with staged changes",
+                          qw(diff --cached --name-only HEAD --));
+}
+
+#----- configuring a tree -----
+
+sub setup_config () {
+    my (@files) = (qw(msg deps included props pprops));
+    my $version = 1;
+    foreach my $iteration (qw(0 1)) {
+       foreach my $file (@files) {
+           my $cfgname = "merge.topbloke-$file";
+           my ($current, $current_estatus);
+           run_git(\$current_estatus,
+                   sub { $current = $_; },
+                   qw(config), "$cfgname.driver");
+           $current = "## failed $current_estatus" if $current_estatus;
+           next if $current =~ m/^topbloke-merge-driver --v$version /o;
+           die "$file $current ?" if $iteration;
+           debug("setting merge driver $file");
+           run_git(qw(config), "$cfgname.name",
+                   "topbloke merge driver for $file");
+           run_git(qw(config), "$cfgname.driver",
+                   "topbloke-merge-driver --v$version".
+                   " $file %O %A %B %L");
+       }
+       my ($newattrs, $attrsfile);
+       foreach my $file (@files) {
+           my $path = ".topbloke/$file";
+           my $current = run_git_1line(qw(check-attr merge), $path);
+           $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
+           my $want = "topbloke-$file";
+           next if $current eq $want;
+           die "$file $current ?" unless $current eq 'unspecified';
+           die "$file $current ?" if $iteration;
+           if (!$newattrs) {
+               $attrsfile = git_dir()."/info/attributes";
+               $newattrs = new IO::File "$attrsfile.tmp", 'w'
+                   or die "$attrsfile.tmp: $!";
+               if (!open OA, '<', "$attrsfile") {
+                   die "$attrsfile $!" unless $!==&ENOENT;
+               } else {
+                   while (<OA>) {
+                       print $newattrs $_ or die $!;
+                       print "\n" or die $! unless chomp;
+                   }
+                   die $! if OA->error;
+                   die $! unless close OA;
+               }
+           }
+           print $newattrs "$path\tmerge=$want\n" or die $!;
+       }
+       last if !$newattrs;
+       close $newattrs or die $!;
+       rename "$attrsfile.tmp", "$attrsfile" or die $!;
+    }
+}
+
+#----- branch and patch specs and parsed patch names -----
+
+our $tiprefs = 'refs/topbloke-tips';
+our $baserefs = 'refs/topbloke-bases';
+

 sub current_branch () {
     open R, git_dir().'/HEAD' or die "open HEAD $!";
     my $ref = <R>;  defined $ref or die $!;
 sub current_branch () {
     open R, git_dir().'/HEAD' or die "open HEAD $!";
     my $ref = <R>;  defined $ref or die $!;


@@ -158,6 +257,7 @@ sub current_branch () {
        };
     }
     if ($ref =~ m#^refs/topbloke-(tip|base)s/([^/\@]*)\@([^/\@]*)/([^/]*)/#) {
        };
     }
     if ($ref =~ m#^refs/topbloke-(tip|base)s/([^/\@]*)\@([^/\@]*)/([^/]*)/#) {

+       my $fullname = "$2\@$3/$4/$'";

        return {
            Kind => $1,
            Email => $2,
        return {
            Kind => $1,
            Email => $2,


@@ -165,13 +265,14 @@ sub current_branch () {
            Date => $4,
            Nick => $', #',
            Ref => $ref,
            Date => $4,
            Nick => $', #',
            Ref => $ref,

-           DepSpec => "$2\@$3/$4/$'",
+           DepSpec => $fullname,
+           Fullname => $fullname,

        };
     } elsif ($ref =~ m#^refs/heads/#) {
        return {
            Kind => 'foreign',
            Ref => $ref,
        };
     } elsif ($ref =~ m#^refs/heads/#) {
        return {
            Kind => 'foreign',
            Ref => $ref,

-           DepSpec => "/$ref",
+           DepSpec => ".f $ref",

        };
     } else {
        return {
        };
     } else {
        return {


@@ -192,12 +293,17 @@ sub parse_patch_name ($) {
        Domain => $domain,
        Date => $date,
        Nick => $nick,
        Domain => $domain,
        Date => $date,
        Nick => $nick,

+       Kind => 'tip',
+       DepSpec => $patch,
+       Fullname => $patch,
+       Ref => "refs/topbloke-tips/$patch",

     };
 }
 
 sub parse_patch_spec ($) {
     my ($orig) = @_;
     local $_ = $orig;
     };
 }
 
 sub parse_patch_spec ($) {
     my ($orig) = @_;
     local $_ = $orig;

+    die 'FORMAT has new spec syntax nyi';

     my $spec = { }; # Email Domain DatePrefix DateNear Nick
     my $set = sub {
        my ($key,$val,$whats) = @_;
     my $spec = { }; # Email Domain DatePrefix DateNear Nick
     my $set = sub {
        my ($key,$val,$whats) = @_;


@@ -248,82 +354,40 @@ sub parse_patch_spec ($) {
     return $spec;
 }
 
     return $spec;
 }
 

-sub setup_config () {
-    my (@files) = (qw(msg deps included flags pflags));
-    my $version = 1;
-    foreach my $iteration (qw(0 1)) {
-       foreach my $file (@files) {
-           my $cfgname = "merge.topbloke-$file";
-           my ($current, $current_estatus);
-           run_git(\$current_estatus,
-                   sub { $current = $_; },
-                   qw(config), "$cfgname.driver");
-           $current = "## failed $current_estatus" if $current_estatus;
-           next if $current =~ m/^topbloke-merge-driver --v$version /o;
-           die "$file $current ?" if $iteration;
-           debug("setting merge driver $file");
-           run_git(qw(config), "$cfgname.name",
-                   "topbloke merge driver for $file");
-           run_git(qw(config), "$cfgname.driver",
-                   "topbloke-merge-driver --v$version".
-                   " $file %O %A %B %L");
-       }
-       my ($newattrs, $attrsfile);
-       foreach my $file (@files) {
-           my $path = ".topbloke/$file";
-           my $current = run_git_1line(qw(check-attr merge), $path);
-           $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
-           my $want = "topbloke-$file";
-           next if $current eq $want;
-           die "$file $current ?" unless $current eq 'unspecified';
-           die "$file $current ?" if $iteration;
-           if (!$newattrs) {
-               $attrsfile = git_dir()."/info/attributes";
-               $newattrs = new IO::File "$attrsfile.tmp", 'w'
-                   or die "$attrsfile.tmp: $!";
-               if (!open OA, '<', "$attrsfile") {
-                   die "$attrsfile $!" unless $!==&ENOENT;
-               } else {
-                   while (<OA>) {
-                       print $newattrs $_ or die $!;
-                       print "\n" or die $! unless chomp;
-                   }
-                   die $! if OA->error;
-                   die $! unless close OA;
-               }
-           }
-           print $newattrs "$path\tmerge=$want\n" or die $!;
-       }
-       last if !$newattrs;
-       close $newattrs or die $!;
-       rename "$attrsfile.tmp", "$attrsfile" or die $!;
+sub patch_matches_spec ($$) {
+    my ($parsedname, $spec) = @_;
+    foreach my $k (qw(Email Domain Nick)) {
+       debug("patch_matches_spec  mismatch $k"), return 0
+           if defined $spec->{$k} &&
+              $parsedname->{$k} ne $spec->{$k};

     }
     }

+    debug("patch_matches_spec  mismatch DatePrefix"), return 0
+       if defined $spec->{DatePrefix} &&
+          substr($parsedname->{Date}, 0, length $spec->{DatePrefix})
+              ne $spec->{DatePrefix};
+    debug("patch_matches_spec  match"), return 1;

 }
 
 }
 

-sub check_no_unwanted_metadata ($) {
-    # for checking foreign branches aren't contaminated
-    my ($gitbranch) = @_;
-    run_git_check_nooutput('foreign unexpectedly contains',
-                          qw(ls-tree --name-only),
-                          "$gitbranch:",
-                          qw(.topbloke));
-}
+#----- reading topbloke metadata -----

 
 sub foreach_patch ($$$$) {
     my ($spec, $deleted_ok, $want, $body) = @_;
 
 sub foreach_patch ($$$$) {
     my ($spec, $deleted_ok, $want, $body) = @_;

-    # runs $body->($fullname, \%flags, \%deps, \%pflags, \%included)
-    #                        $Want->[0]   1        2         3
+    # runs $body->($patch, $parsedname, \%props, \%deps, \%pprops, \%included)
+    #                                   $want->[0]   1        2         3

     # where $deps->{$fullname} etc. are 1 for true or nonexistent for false
     #  and if $want->[$item] is not true, the corresponding item may be undef
     # where $deps->{$fullname} etc. are 1 for true or nonexistent for false
     #  and if $want->[$item] is not true, the corresponding item may be undef

+    # and $parsedname is only valid if $spec is not undef
+    #  (say $spec { }  if you want the name parsed but no restrictions)
+    my @want = @$want;
+    $want[0] ||= !$deleted_ok;

     run_git(sub {
        debug("foreach_patch considering $_");
        m/ / or die "$_ ?";
        my $objname = $`;
        my @out;
        my $patch = substr($',19); #');
     run_git(sub {
        debug("foreach_patch considering $_");
        m/ / or die "$_ ?";
        my $objname = $`;
        my @out;
        my $patch = substr($',19); #');

-       push @out, $patch;
-       $want->[0] ||= !$deleted_ok;
-       foreach my $file (qw(flags deps pflags included)) {
+       my $wantix = 0;
+       foreach my $file (qw(props deps pprops included)) {

 
            if ($file eq 'deps') {
                # do this check after checking for deleted patches,
 
            if ($file eq 'deps') {
                # do this check after checking for deleted patches,


@@ -331,19 +395,15 @@ sub foreach_patch ($$$$) {
                # right, check the spec next
                if ($spec) {
                    my $have = parse_patch_name($patch);
                # right, check the spec next
                if ($spec) {
                    my $have = parse_patch_name($patch);

-                   foreach my $k (qw(Email Domain Nick)) {
-                       debug("foreach_patch  mismatch $k"), return
-                           if defined $spec->{$k} &&
-                              $have->{$k} ne $spec->{$k};
-                   }
-                   debug("foreach_patch  mismatch DatePrefix"), return
-                       if defined $spec->{DatePrefix} &&
-                          substr($have->{Date}, 0, length $spec->{DatePrefix})
-                              ne $spec->{DatePrefix};
+                   debug("foreach_patch  mismatch"), return
+                       unless patch_matches_spec($have, $spec);
+                   unshift @out, $have;
+               } else {
+                   unshift @out, undef;

                }
            }
 
                }
            }
 

-           if (!shift @$want) {
+           if (!$want[$wantix++]) {

                push @out, undef;
                next;
            }
                push @out, undef;
                next;
            }


@@ -351,38 +411,71 @@ sub foreach_patch ($$$$) {
            my ($got, $data) = git_get_object("$objname:.topbloke/$file");
            die "$patch $file ?" unless defined $data;
            my %data;
            my ($got, $data) = git_get_object("$objname:.topbloke/$file");
            die "$patch $file ?" unless defined $data;
            my %data;

-           $data{$_}=1 foreach split /\n/, $data;
+           if ($file !~ m/props/) {
+               $data{$_}=1 foreach split /\n/, $data;
+           } elseif {
+               foreach (split /\n/, $data) {
+                   m/ / or m/$/;
+                   $data{$`} = $'; #';
+               }
+           }

 
 

-           if ($file eq 'flags') {
+           if ($file eq 'props') {

                debug("foreach_patch  Deleted"), return
                    if !$deleted_ok && $data{Deleted};
            }
 
            push @out, \%data;
        }
                debug("foreach_patch  Deleted"), return
                    if !$deleted_ok && $data{Deleted};
            }
 
            push @out, \%data;
        }

-       debug("foreach_patch  YES @out"), return
-       $body->(@out);
+       debug("foreach_patch  YES ".(join '', map { 0+defined } @out)), return
+       $body->($patch, @out);

            },
            qw(for-each-ref --format), '%(objectname) %(refname)',
                qw(refs/topbloke-tips));
 }
 
            },
            qw(for-each-ref --format), '%(objectname) %(refname)',
                qw(refs/topbloke-tips));
 }
 

-sub flagsfile_add_flag ($$) {
-    # works on "deps" too
-    my ($flagsfile, $flag) = @_;
-    my $wf = wf_start(".topbloke/$flagsfile");
-    open FI, '<', ".topbloke/$flagsfile" or die $!;
+#----- updating topbloke metadata -----
+
+sub propsfile_set_prop ($$$) {
+    # set $value to undef to delete; returns old value
+    my ($propsfile, $prop, $value) = @_;
+    my $wf = wf_start(".topbloke/$propsfile");
+    my $oldvalue;
+    open FI, '<', ".topbloke/$propsfile" or die $!;
+    while (<FI>) {
+       chomp or die;
+       m/ / or m/$/;
+       if ($` eq $prop) {
+           die "prop $prop repeated in $propsfile ?!" if defined $oldvalue;
+           $oldvalue = $'; #';
+       } else {
+           wf($wf, "$_\n");
+       }
+    }
+    FI->error and die $!;
+    close FI or die $!;
+    wf($wf, "$prop $value\n") if defined $value;
+    wf_done($wf);
+    return $oldvalue;
+}
+
+sub depssfile_add_dep ($$) {
+    my ($depsfile, $depspec) = @_;
+    my $wf = wf_start(".topbloke/$depsfile");
+    open FI, '<', ".topbloke/$depsfile" or die $!;

     while (<FI>) {
        chomp or die;
     while (<FI>) {
        chomp or die;

-       die "flag $flag already set in $flagsfile ?!" if $_ eq $flag;
+       die "dep $depspec already set in $depsfile ?!" if $_ eq $depspec;

        wf($wf, "$_\n");
     }
     FI->error and die $!;
     close FI or die $!;
        wf($wf, "$_\n");
     }
     FI->error and die $!;
     close FI or die $!;

-    wf($wf, "$flag\n");
+    wf($wf, "$depspec\n");

     wf_done($wf);
 }
 
     wf_done($wf);
 }
 

+#----- general utilities -----
+

 sub wf_start ($) {
     my ($path) = @_;
     my $fh = new IO::File "$path.tmp", '>' or die "create $path.tmp: $!\n";
 sub wf_start ($) {
     my ($path) = @_;
     my $fh = new IO::File "$path.tmp", '>' or die "create $path.tmp: $!\n";


@@ -416,4 +509,9 @@ sub wf_contents ($$) {
     wf_done($wf);
 }
 
     wf_done($wf);
 }
 

+sub closeout () {
+    STDOUT->error and die $!;
+    close STDOUT or die $!;
+}
+

 1;
 1;