chiark / gitweb /
fix a few bugs in THEORY
[topbloke.git] / Topbloke.pm
index 741cecb..5ea0ae7 100644 (file)
@@ -17,15 +17,17 @@ BEGIN {
 
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
-    @EXPORT      = qw(debug $tiprefs $baserefs
+    @EXPORT      = qw(debug $tiprefs $baserefs %known_metadata
                      run_git run_git_1line run_git_check_nooutput
                      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
+                      check_no_metadata foreach_unknown_metadata
+                      check_clean_tree
+                     setup_config 
+                     current_branch parse_patch_name parse_patch_spec
                      patch_matches_spec
                      foreach_patch
-                     propsfile_add_prop depsfile_add_dep
+                     metafile_process depsfile_add_dep
                      wf_start wf wf_abort wf_done wf_contents
                      closeout);
     %EXPORT_TAGS = ( );
@@ -34,6 +36,8 @@ BEGIN {
 
 our $git_command = 'git';
 
+our %known_metadata;
+
 sub debug ($) {
     my ($msg) = @_;
     print STDERR "DEBUG: $msg\n" or die $!;
@@ -170,7 +174,7 @@ sub enable_reflog ($) {
     close REFLOG or die $!;
 }    
 
-sub check_no_unwanted_metadata ($) {
+sub check_no_metadata ($) {
     # for checking foreign branches aren't contaminated
     my ($gitbranch) = @_;
     run_git_check_nooutput('foreign unexpectedly contains',
@@ -179,6 +183,20 @@ sub check_no_unwanted_metadata ($) {
                           qw(.topbloke));
 }
 
+sub foreach_unknown_metadata ($$) {
+    my ($ref, $code) = @_;
+    # Examines $ref.
+    # Executes $code for each tolerable unknown metadata found, with
+    # $_ being the (leaf) name of the metadata file
+    run_git(sub {
+       die unless s#^\.topbloke/##;
+       next if $known_metadata{$_};
+       m/-$/ or die "found unsupported metadata in $ref; you must upgrade\n";
+       $code->();
+           },
+           qw(ls-tree --name-only -r HEAD: .topbloke));
+}
+
 sub check_clean_tree ($) {
     run_git_check_nooutput("operation requires working tree to be clean",
                           qw(diff --name-only HEAD --));
@@ -186,11 +204,14 @@ sub check_clean_tree ($) {
                           qw(diff --cached --name-only HEAD --));
 }
 
+$known_metadata{$_}=1 foreach qw(msg patch base deps deleted
+                                 +included +ends);
+
 #----- configuring a tree -----
 
 sub setup_config () {
-    my (@files) = (qw(msg patch base deps deleted topgit- lwildcard-
-                      +included +ends +iwildcard-));
+    my (@files) = (qw(lwildcard- msg patch base deps deleted
+                      +iwildcard- +included +ends));
     my $version = 1;
     my $drvname = sub {
        my ($file) = @_;
@@ -225,32 +246,36 @@ sub setup_config () {
                $pat = ($file =~ m/^\+/ ? '+' : '[^+]').'*';
                $check =~ s/\w.*/xxxunknown/ or die;
            }
+           $pat = ".topbloke/$pat";
+           $check = ".topbloke/$check";
            my $want = "topbloke-".$drvname->($file);
            $attrs .= "$pat\tmerge=$want\n";
            my $current = run_git_1line(qw(check-attr merge), $check);
-           $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
+           $current =~ s#^\Q$check\E: merge: ## or die "$file $current ?";
            next if $current eq $want;
-           die "$file $current ?" unless $current eq 'unspecified';
-           push @needupdate, $file;
+           die "$file $current ?" unless 
+               $current eq 'unspecified' ||
+               $current =~ m/^topbloke-\wwildcard$/;
+           push @needupdate, "$file=$current";
        }
        if (@needupdate) {
+           $attrsfile = git_dir()."/info/attributes";
            my $newattrsf = new IO::File "$attrsfile.tmp", 'w'
                    or die "$attrsfile.tmp: $!";
-           die "@needupdate $current ?" if $iteration;
-           $attrsfile = git_dir()."/info/attributes";
+           die "@needupdate ?" if $iteration;
            if (!open OA, '<', "$attrsfile") {
                die "$attrsfile $!" unless $!==ENOENT;
            } else {
                while (<OA>) {
                    next if m#^\.topbloke/#;
                    print $newattrsf $_ or die $!;
-                   print "\n" or die $! unless chomp;
+                   print $newattrsf "\n" or die $! unless chomp;
                }
                die $! if OA->error;
                die $! unless close OA;
            }
-           print $newattrsf or die $!;
-           close $newattrs or die $!;
+           print $newattrsf $attrs or die $!;
+           close $newattrsf or die $!;
            rename "$attrsfile.tmp", "$attrsfile" or die $!;
        }
     }
@@ -274,7 +299,7 @@ sub current_branch () {
     }
     if ($ref =~ m#^refs/topbloke-(tip|base)s/([^/\@]*)\@([^/\@]*)/([^/]*)/#) {
        my $fullname = "$2\@$3/$4/$'";
-       return {
+       my $v = {
            Kind => $1,
            Email => $2,
            Domain => $3,
@@ -284,11 +309,12 @@ sub current_branch () {
            DepSpec => $fullname,
            Fullname => $fullname,
        };
+       return $v;
     } elsif ($ref =~ m#^refs/heads/#) {
        return {
            Kind => 'foreign',
            Ref => $ref,
-           DepSpec => ".f $ref",
+           DepSpec => "- $ref",
        };
     } else {
        return {
@@ -319,7 +345,7 @@ sub parse_patch_name ($) {
 sub parse_patch_spec ($) {
     my ($orig) = @_;
     local $_ = $orig;
-    die 'FORMAT has new spec syntax nyi';
+    warn 'FORMAT has new spec syntax nyi';
     my $spec = { }; # Email Domain DatePrefix DateNear Nick
     my $set = sub {
        my ($key,$val,$whats) = @_;
@@ -388,17 +414,19 @@ sub patch_matches_spec ($$) {
 
 sub foreach_patch ($$$$) {
     my ($spec, $deleted_ok, $want, $body) = @_;
-    # runs $body->($patch, $parsedname, \%props)
-    # where $props{<metadata filename>} is, for <metadata filename> in @$want:
+    # runs $body->($patch, $parsedname, \%meta)
+    # where $meta{<metadata filename>} is, for <metadata filename> in @$want:
     #              undefined if metadata file doesn't exist
     #              defined with contents of file
     # and $parsedname is only valid if $spec is not undef
     #  (say $spec { }  if you want the name parsed but no restrictions)
     # entries in want may also be "<metadata filename>_"
-    #  which means "strip trailing newlines" (result key in %props is the same)
+    #  which means "strip trailing newlines" (result key in %meta is the same)
+    # <metadata filename> may instead be "B_<metadata filename>"
+    #  which means to look in the corresponding base branch
     my @want = @$want;
     my $atfront = sub {
-       my $thing = @_;
+       my ($thing) = @_;
        @want = ($thing, grep { $_ ne $thing } @want);
     };
     $atfront->(' patch');
@@ -407,48 +435,45 @@ sub foreach_patch ($$$$) {
        debug("foreach_patch considering $_");
        m/ / or die "$_ ?";
        my $objname = $`;
-       my %props;
+       my %meta;
        my $parsedname;
        my $patch = substr($',19); #');
        my $wantix = 0;
        foreach my $wantent (@want) {
            my $file = $wantent;
            my $stripnl = ($file =~ s/_$//);
+           my $key = $file;
+           my $inbase = ($file =~ s/^B_//);
 
            if ($file eq ' patch') {
                if ($spec) {
                    $parsedname = parse_patch_name($patch);
-                   debug("foreach_patch  mismatch"), return
-                       unless patch_matches_spec($parsedname, $spec);
+                   if (!patch_matches_spec($parsedname, $spec)) {
+                       debug("foreach_patch  mismatch");
+                       return;
+                   }
                }
                next;
            }
 
-           my ($got, $data) = git_get_object("$objname:.topbloke/$file");
-
-xxx up to here new foreach_patch api
-xxx up to here new metadata in this function
-           
-           die "$patch $file ?" unless defined $data;
-           my %data;
-           if ($file !~ m/props/) {
-               $data{$_}=1 foreach split /\n/, $data;
-           } elseif {
-               foreach (split /\n/, $data) {
-                   m/ / or m/$/;
-                   $data{$`} = $'; #';
+           my $objkey = (!$inbase ? "$objname" : 
+                         "$baserefs/$patch").":.topbloke/$file";
+           my ($got, $data) = git_get_object($objkey);
+           if ($got eq 'missing') {
+               $meta{$key} = undef;
+           } elsif ($got eq 'blob') {
+               $meta{$key} = $data;
+               if ($file eq 'deleted' && !$deleted_ok) {
+                   debug("foreach_patch  Deleted");
+                   return;
                }
+           } else {
+               warn "patch $patch object $objkey has unexpected type $got!\n";
+               return;
            }
-
-           if ($file eq 'props') {
-               debug("foreach_patch  Deleted"), return
-                   if !$deleted_ok && $data{Deleted};
-           }
-
-           push @out, \%data;
        }
-       debug("foreach_patch  YES ".(join '', map { 0+defined } @out)), return
-       $body->($patch, @out);
+       debug("foreach_patch  YES $patch");
+       $body->($patch, $parsedname, \%meta);
            },
            qw(for-each-ref --format), '%(objectname) %(refname)',
                qw(refs/topbloke-tips));
@@ -456,44 +481,52 @@ xxx up to here new metadata in this function
 
 #----- updating topbloke metadata -----
 
-xxx this section needs updating for new 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 {
+sub metafile_process ($$$$$) {
+    my ($metafile, $startcode, $linecode, $endcode, $enoentcode) = @_;
+    # runs $startcode->($outwf) at start
+    # runs $linecode->($outwf) for each old line, with $_ the chomped line
+    #   may modify $_, which will be written to $outf
+    # at end runs $endcode->($outwf);
+    # runs $enoentcode->($outwf) instead of ever calling $linecode
+    #  if the existing file does not exist;
+    #  if it's false dies instead
+    # any of these may return false, in which case we quit immediately
+    # any of these except enoentcode may be undef to mean "noop"
+    # if they all return true, we install the new file
+    my $wf = wf_start(".topbloke/$metafile");
+    my $call = sub {
+       return 1 unless $_->[0];
+       return 1 if $_->[0]($wf);
+       wf_abort($wf);
+       close FI;
+       return 0;
+    };
+    return unless $call->($startcode);
+    if (!open FI, '<', ".topbloke/$metafile") {
+       die "$metafile $!" unless $!==ENOENT;
+       die "$metafile $!" unless $enoentcode;
+       return unless $call->($enoentcode);
+    } else {
+       while (<FI>) {
+           chomp or die;
+           return unless $call->($linecode);
            wf($wf, "$_\n");
        }
+       FI->error and die $!;
+       close FI or die $!;
     }
-    FI->error and die $!;
-    close FI or die $!;
-    wf($wf, "$prop $value\n") if defined $value;
+    return unless $call->($endcode);
     wf_done($wf);
-    return $oldvalue;
 }
+    
 
-sub depssfile_add_dep ($$) {
+sub depsfile_add_dep ($$) {
     my ($depsfile, $depspec) = @_;
-    my $wf = wf_start(".topbloke/$depsfile");
-    open FI, '<', ".topbloke/$depsfile" or die $!;
-    while (<FI>) {
-       chomp or die;
+    metafile_process($depsfile, undef, sub {
        die "dep $depspec already set in $depsfile ?!" if $_ eq $depspec;
-       wf($wf, "$_\n");
-    }
-    FI->error and die $!;
-    close FI or die $!;
-    wf($wf, "$depspec\n");
-    wf_done($wf);
+    }, sub {
+       wf($_->[0], "$depspec\n");
+    }, undef);
 }
 
 #----- general utilities -----