X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=reprap-play.git;a=blobdiff_plain;f=commitid.scad.pl;h=65963be2734aca3fa7918f741e683f849c9f5230;hp=ad986bb4edb9a3a86a72f9702f9d5d445ca78a8d;hb=c66f67af18830c44747f7bfc3819f86c36a97e47;hpb=3c1ef754fea0a8771c9a0e6af3319353ed90df79

diff --git a/commitid.scad.pl b/commitid.scad.pl
index ad986bb..65963be 100755
--- a/commitid.scad.pl
+++ b/commitid.scad.pl
@@ -15,7 +15,7 @@ $SIG{__WARN__} = sub { die @_; };
 #   --git    generate git commit indications, as shown below
 #            (this is the default if no strings are requested with -t)
 #
-#   --git=object
+#   --git=objid
 #            generate git commit indication based on commit object only
 #            (ie avoid counting commits)
 #
@@ -25,7 +25,7 @@ $SIG{__WARN__} = sub { die @_; };
 #            generate a form FORM containing TEXT
 #            TEXT can contain newlines (final newline usually undesirable)
 #            if FORM not specified, generates Arg0 Arg1 Arg2 in sequence
-#            character set is SPC 0-9 a-f + * (`*' glyph is `=/=').
+#            character set is SPC 0-9 a-f + *
 #
 # We generate a physical indication of which commit was used.
 #
@@ -34,6 +34,15 @@ $SIG{__WARN__} = sub { die @_; };
 #    $Commitid_scale          if not set, we use 1.0 }  together
 #    $Commitid_depth          if not set, we use xy pixel size from above / 2
 #    $Commitid_depth_scale    if not set, we use 1.0 (multiplies depth above)
+#    $Commitid_max_best_scale if not set, we use 2.0 (max mult of xy in Best)
+#
+# We have auto-sizing modules:
+#
+#   module Commitid_BestCount_2D(max_sz, margin=Commitid_pixelsz()) { ... }
+#   module Commitid_BestCount   (max_sz, margin=Commitid_pixelsz()) { ... }
+#   module Commitid_BestObjid_2D(max_sz, margin=Commitid_pixelsz()) { ... }
+#   module Commitid_BestObjid   (max_sz, margin=Commitid_pixelsz()) { ... }
+#      // max_sz should be [x,y]
 #
 # For each form we have
 #
@@ -52,49 +61,51 @@ $SIG{__WARN__} = sub { die @_; };
 #
 # We can generate these forms:
 #
-#   Tiny3:
-#   Tiny4:
-#   Tiny5:
-#   Tiny6:
-#   Tiny7:
-#   Tiny8:
+#  In each case:
+#    if tree is dirty, * is suffixed or prefixed to count or commitid
+#    if tree has untracked files, + is added
+#    (where it is added depends on the Form; in any case it does not
+#    change the size, but steals space from digits)
+#
+#   Small2 Small3 ... Small10:
 #       git rev-list --first-parent --count HEAD
 #       typically 3-4 characters but we allow for up to 6
 #       padded with zeroes; if too long we reduce mod 10^n
-#       eg
-#            Tiny4    1070
-#       If tree is dirty, + or * is suffixed, reducing number of
-#       digits by 1.
+#       eg if the count is 123456
+#            Small5    3456*
+#            Small8    _*123456    (where _ are spaces)
+#       the git objectid is included if it will fit
+#       unambiguously and usefully eg
+#            Small9    ab*123456
 #
-#   Tiny4Q:
-#   Tiny6Q:
-#   Tiny9Q:
-#       same but in two lines eg
-#            Tiny4Q   10
-#                     70
+#   Small2S Small4S ... Small10S:
+#   Small3T Small9T:
+#       same but split into two lines (S) or three lines (T) eg
+#            Small4S  45     Small6T   _3
+#                     6*               45
+#                                      6*
 #
-#   Git4   Git4Q
-#   Git6   Git6Q
-#   Git8   Git8Q
+#   Git2 Git3 ... Git10:
+#   Git4S Git6S ... Git10S:
+#   Git6T Git9T:
 #       git-rev-parse HEAD   (prefix of requested length)
-#       eg
-#            Git6    82f2a2
-#       If tree is dirty, + or * is suffixed to commitid,
-#       reducing number of hex digits by 1.
-
-#   Small3
-#   Small4
-#   Small5
-#   Small6
-#   Small7
-#   Small8
+#       eg if the commitid is abcdef0123...
+#            Git5    abcd*
+
+#   Full4 Full6 ... Full20:
 #       git-rev-list --first-parent --count HEAD
 #       git-rev-parse HEAD
+#       (all on two lines)
 #       eg
-#            Small6     1070
-#                     82f2a2
-#       If tree is dirty, + or * is suffixed to count (but not to
-#       commitid) reducing number of digits by 1.
+#            Full6    abcdef       Full8     abcdef01
+#                     23456*                 _123456*
+#
+#   Full6T Full9T ... Full30T
+#       as Full but commit is split over two lines
+#       for a 3-line message; eg
+#             Full9T    abc
+#                       de*
+#                       456
 #
 #   FontDemo
 #
@@ -121,6 +132,24 @@ sub chrmodname ($) {
     return "Commitid__chr_$chrx";
 }
 
+our $gtm_demo_i = -1;
+our $gtm_demo_j;
+our @gtm_demo_o;
+
+sub gentextmodule_demo_start_batch () {
+    $gtm_demo_j = 0;
+    $gtm_demo_i++;
+}
+
+sub gen3dmodule ($@) {
+    my ($modb,@argl) = (@_);
+    p "module ${modb}(".(join ', ', @argl)."){\n";
+    p " d=Commitid_depth();\n";
+    p " translate([0,0,-d]) linear_extrude(height=d*2)\n";
+    p "  ${modb}_2D(".(join ',', map { m/=/ ? $` : $_ } @argl).");\n";
+    p "}\n";
+}
+
 sub gentextmodule ($@) {
     my ($form, @lines) = @_;
     my $modb = "Commitid_$form";
@@ -133,21 +162,30 @@ sub gentextmodule ($@) {
 	$y--;
 	my $x = 0;
 	foreach my $chr (split //, $line) {
-	    next if $chr !~ m/\S/;
 	    p sprintf "  translate([%d * 0.8, %d * 1.2]) %s();\n",
-		$x, $y, chrmodname $chr;
+		$x, $y, chrmodname $chr
+		if $chr =~ m/\S/;
 	    $x++;
 	}
 	$cols = $x if $x > $cols;
     }
     p " }\n";
     p "}\n";
-    p "module ${modb}(){\n";
-    p " d=Commitid_depth();\n";
-    p " translate([0,0,-d]) linear_extrude(height=d*2) ${modb}_2D();\n";
-    p "}\n";
+    gen3dmodule($modb);
+
     p sprintf "function %s_sz() = Commitid__scale() * 0.1 * [ %d, %d ];\n",
 	$modb, 2 * ($cols * 4 - 1), 2 * (@lines * 6 - 1);
+
+    push @gtm_demo_o, <<END;
+ translate([$gtm_demo_i * st[0], $gtm_demo_j * st[1]]) {
+  difference(){
+   color("blue") translate([-e,-e]) square(${modb}_sz() + 2*[e,e]);
+   square(${modb}_sz());
+  }
+  ${modb}_2D();
+}
+END
+    $gtm_demo_j++;
 }
 
 our @demo;
@@ -228,27 +266,55 @@ our $do_git; # contains may chars 'c' (count) and/or 'o' (object)
 our $do_git_untracked = 1;
 our $argcounter;
 
-sub rjustt ($$) { # right justify and truncate (ie, pad and truncate at left)
-    my ($sz, $whole) = @_;
+our @forms;
+
+sub rjustt ($$;$) { # right justify and truncate (ie, pad and truncate at left)
+                    # always includes prefix
+    my ($sz, $whole, $prefix) = @_;
+    $prefix //= '';
     my $lw = length $whole;
-    return $lw > $sz
-	? substr($whole, $lw-$sz)
-	: sprintf "%${sz}s", $whole;
+    my $spare = $sz - $lw - (length $prefix);
+    return
+	($spare > 0 ? (' ' x $spare) : '').
+	$prefix.
+	substr($whole, ($spare < 0 ? -$spare : 0));
 }
 
-sub ljustt ($$$) { # always includes $suffix
+sub ljustt ($$;$) {
     my ($sz, $whole, $suffix) = @_;
+    $suffix //= '';
     $sz -= length $suffix;
     return sprintf "%-${sz}.${sz}s%s", $whole, $suffix;
 }
 
-sub gentextmodule_plusq ($$) {
-    my ($form, $s) = @_;
+sub genform ($@) {
+    my ($form, @lines) = @_;
+    gentextmodule($form, @lines);
+    my $f = {
+	Form => $form,
+	Chars => (length join '', @lines),
+	Lines => (scalar @lines),
+	Ambiguous => ($form =~ m/Full/ && !grep { m/\W/ } @lines),
+    };
+    push @forms, $f;
+}
+
+sub genform_q ($$$) {
+    my ($form, $s, $lines) = @_;
+    $gtm_demo_j++;
     my $l = length $s;
-    gentextmodule($form, $s);
-    if (!($l & 1) && $l>=4) {
-	gentextmodule("${form}Q", substr($s,0,$l/2), substr($s,$l/2));
-    }
+    return if $l % $lines;
+    my $e = $l/$lines;
+    return if $e < 2;
+    $gtm_demo_j--;
+    genform($form, $s =~ m/.{$e}/g);
+}
+
+sub genform_plusq ($$) {
+    my ($form, $s) = @_;
+    genform($form, $s);
+    genform_q("${form}S", $s, 2);
+    genform_q("${form}T", $s, 3);
 }
 
 our @gcmd;
@@ -304,25 +370,110 @@ sub do_git () {
 	$git_object = gitoutput qw(rev-parse HEAD);
     }
 
-    foreach my $sz (3..8) {
-	gentextmodule_plusq("Tiny$sz", rjustt($sz, $git_count.$git_dirty))
-	    if defined $git_count;
+    foreach my $sz (2..10) {
+	gentextmodule_demo_start_batch();
+
+	if (defined($git_count)) {
+	    my $smallstr = rjustt($sz, $git_count, $git_dirty);
+	    if (defined($git_object) && $sz >= length($git_count) + 3) {
+		$smallstr = $git_object;
+		$smallstr .= ($git_dirty || ' ');
+		$smallstr .= $git_count;
+		$smallstr = rjustt($sz, $smallstr);
+	    }
+	    genform_plusq("Small$sz", $smallstr);
+	}
 
-	gentextmodule_plusq("Git$sz", ljustt($sz, $git_object, $git_dirty))
+	genform_plusq("Git$sz", ljustt($sz, $git_object, $git_dirty))
 	    if defined $git_object;
 
-	gentextmodule("Small$sz",
-		      rjustt($sz, $git_count.$git_dirty),
-		      ljustt($sz, $git_object, ''))
-	    if defined $git_count && defined $git_object;
+	if (defined $git_count && defined $git_object) {
+	    genform("Full".($sz*2),
+		    ljustt($sz, $git_object),
+		    rjustt($sz, $git_count, $git_dirty));
+
+	    my $e = $sz;
+	    genform("Full".($e*3)."T",
+		    ljustt($e*2, $git_object, $git_dirty)
+		    =~ m/.{$e}/g,
+		    rjustt($e, $git_count));
+	}
+    }
+}
+
+sub do_some_best ($$) {
+    my ($modname, $formre) = @_;
+    my $fullmodname = "Commitid_${modname}_2D";
+    my @argl = qw(max_sz margin=Commitid_pixelsz());
+    p "module $fullmodname(".(join ', ', @argl).") {\n";
+    my $mbs = '$Commitid_max_best_scale';
+    p " sc_max = $mbs ? $mbs : 2;\n";
+    p " sz = max_sz - 2*[margin,margin];\n";
+    my @do;
+    foreach my $f (
+        sort {
+	    $b->{Chars} <=> $a->{Chars} or
+	    $a->{Lines} <=> $b->{Chars}
+        }
+        grep {
+	    $_->{Form} =~ m/$formre/ &&
+	    !$_->{Ambiguous}
+	}
+        @forms
+    ) {
+	my $form = $f->{Form};
+	p " sz_$form = Commitid_${form}_sz();\n";
+	foreach my $rot (qw(0 1)) {
+	    my $id = "${form}_r${rot}";
+	    p " sc_$id = min(sc_max";
+	    foreach my $xy (qw(0 1)) {
+		p ",sz[$xy]/sz_$form","[",(($xy xor $rot)+0),"]";
+	    }
+	    p ");\n";
+	    push @do, " if (sc_$id >= 1.0";
+	    push @do, " && sc_$id >= sc_${form}_r1" if !$rot;
+	    push @do, ") {\n";
+	    push @do, "  translate([margin,margin]) scale(sc_$id)\n";
+	    push @do, "   rotate(90) translate([0,-sz_$form"."[1]])\n" if $rot;
+	    push @do, "   Commitid_${form}_2D();\n";
+	    push @do, " } else";
+	}
     }
-}    
+    push @do, <<END;
+ {
+  echo("$fullmodname could not fit anything in", max_sz);
+ }
+END
+    p $_ foreach @do;
+    p "}\n";
+
+    gen3dmodule "Commitid_$modname", @argl;
+}
+
+sub do_git_best () {
+    return unless $do_git;
+
+    # Auto-computer for `best fit'
+    #
+    # We have two best fit approaches: with count, and git-object-id-only
+    #
+    # For `with count', we only ever include the git object id if the
+    # result would be unambigous.  That means that at least one space
+    # or punctuation was generated.
+    #
+    # We sort the options by firstly number of characters
+    # (decreasing), and then by number of lines (increasing) and
+    # try each one both ways round.
+
+    do_some_best('BestCount', 'Small|Full') if $do_git =~ m/c/;
+    do_some_best('BestObjid', 'Git|Full') if $do_git =~ m/o/;
+}
 
 while (@ARGV) {
     $_ = shift;
     if (m/^--(no)?-git$/) {
 	$do_git = $1 ? '' : 'co';
-    } elsif (m/^---git=object$/) {
+    } elsif (m/^---git=objid$/i) {
 	$do_git = 'o';
     } elsif (m/^-i$/) {
 	$do_git_untracked = 0;
@@ -342,9 +493,17 @@ while (@ARGV) {
 
 $do_git //= defined($argcounter) ? '' : 'co';
 
+gentextmodule_demo_start_batch();
 gentextmodule('FontDemo', @demo);
 
 do_git();
+do_git_best();
+
+p "module Commitid_2DDemo(){\n";
+p " st = Commitid__scale() * [ 10, 5 ];\n";
+p " e  = Commitid_pixelsz();\n";
+p $_ foreach @gtm_demo_o;
+p "}\n";
 
 flush STDOUT or die $!;
 close STDOUT or die $!;
@@ -377,8 +536,8 @@ a b c d e f
 
 + *
 
-      r
- #  ###
-###  #
- #  ###
-    L 
+    # #
+ #  \#/
+### ###
+ #  /#\
+    # #