chiark / gitweb /
commitid.scad.pl: Clearer docs
[reprap-play.git] / commitid.scad.pl
index b8d295af420f608546d09751f38b259986590a5c..ebdbe917a39a6cb73db24da322d83a22e85af045 100755 (executable)
@@ -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.
 #
@@ -52,49 +52,68 @@ $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)
+#
+#   Small3:
+#   Small4:
+#   Small5:
+#   Small6:
+#   Small7:
+#   Small8:
+#   Small9:
+#   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)
 #
-#   Tiny4Q:
-#   Tiny6Q:
-#   Tiny9Q:
-#       same but in two lines eg
-#            Tiny4Q   10
-#                     70
+#   Small4S:
+#   Small6S:   Small6T:
+#   Small8S:   Small9T:
+#   Small10S:
+#       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
+#   Git4   Git4S
+#   Git6   Git6S   Git6T
+#   Git8   Git8S
+#   Git9           Git9T
+#   Git10  Git10S
 #       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*
+
+#   Full3
+#   Full4
+#   Full5
+#   Full6
+#   Full7
+#   Full8
+#   Full9
+#   Full10
 #       git-rev-list --first-parent --count HEAD
 #       git-rev-parse HEAD
 #       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
+#   Full12T
+#   Full15T
+#       as Full but commit is split over two lines
+#       for a 3-line message; eg
+#             Full9T    abc
+#                       de*
+#                       456
 #
 #   FontDemo
 #
@@ -121,6 +140,15 @@ 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_i, $gtm_demo_j) = @_;
+    $gtm_demo_j //= 0;
+}
+
 sub gentextmodule ($@) {
     my ($form, @lines) = @_;
     my $modb = "Commitid_$form";
@@ -133,9 +161,9 @@ 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;
@@ -146,8 +174,20 @@ sub gentextmodule ($@) {
     p " d=Commitid_depth();\n";
     p " translate([0,0,-d]) linear_extrude(height=d*2) ${modb}_2D();\n";
     p "}\n";
+
     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;
@@ -242,13 +282,22 @@ sub ljustt ($$$) { # always includes $suffix
     return sprintf "%-${sz}.${sz}s%s", $whole, $suffix;
 }
 
+sub gentextmodule_q ($$$) {
+    my ($form, $s, $lines) = @_;
+    $gtm_demo_j++;
+    my $l = length $s;
+    return if $l % $lines;
+    my $e = $l/$lines;
+    return if $e < 2;
+    $gtm_demo_j--;
+    gentextmodule($form, $s =~ m/.{$e}/g);
+}
+
 sub gentextmodule_plusq ($$) {
     my ($form, $s) = @_;
-    my $l = length $s;
     gentextmodule($form, $s);
-    if (!($l & 1) && $l>=4) {
-       gentextmodule("${form}Q", substr($s,0,$l/2), substr($s,$l/2));
-    }
+    gentextmodule_q("${form}S", $s, 2);
+    gentextmodule_q("${form}T", $s, 3);
 }
 
 our @gcmd;
@@ -304,17 +353,28 @@ 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))
+    foreach my $sz (3..10) {
+       gentextmodule_demo_start_batch($sz-3);
+
+       gentextmodule_plusq("Small$sz", rjustt($sz, $git_count.$git_dirty))
            if defined $git_count;
 
        gentextmodule_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) {
+           gentextmodule("Full$sz",
+                         ljustt($sz, $git_object, ''),
+                         rjustt($sz, $git_count.$git_dirty));
+
+           if (!($sz % 2)) {
+               my $e = $sz/2;
+               gentextmodule("Full".($e*3)."T",
+                             ljustt($e*2, $git_object, $git_dirty)
+                             =~ m/.{$e}/g,
+                             rjustt($e, $git_count));
+           }
+       }
     }
 }    
 
@@ -342,10 +402,17 @@ while (@ARGV) {
 
 $do_git //= defined($argcounter) ? '' : 'co';
 
+gentextmodule_demo_start_batch(-1);
 gentextmodule('FontDemo', @demo);
 
 do_git();
 
+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 +444,8 @@ a b c d e f
 
 + *
 
-      r
- #  ###
-###  #
- #  ###
-    L 
+    # #
+ #  \#/
+### ###
+ #  /#\
+    # #