3 # commitid.scad.pl - a program for annotating solid models with commit info
4 # Copyright (C)2016 Ian Jackson. See below. There is NO WARRANTY.
10 # .../commitid.scad.pl [OPTION...] [STRING...] >commitid.scad.new \
11 # && mv -f commitid.scad.new commitid.scad
13 # Run without arguments, commitid.scad.pl will output an openscad file
14 # which contains 2D and 3D models of the current git commit count and
15 # commit object id (commit hash), useful for identifying printed
18 # See below for details. You probably want these two sections, as a
19 # quick starting point:
20 # General form of provided openscad modules
23 # We can also generate models of short mainly-numeric strings
24 # specified on the command line.
29 # --git Generate git commit indications, as shown below
30 # (this is the default if no strings are requested with -t).
31 # Ie, produce the `Autoscaling modules' and `Specific layouts'.
34 # Generate git commit indication based on commit object only
35 # (ie avoid counting commits). Ie, do not generate `Small'
36 # and `Full' layouts (and never select them for `Best').
38 # -i Do not generate `+' dirty indication if git-untracked files
39 # are present (ie, missing .gitignore entries). The `*'
40 # dirty tree indication (for modified files) cannot be disabled.
43 # Generate a layout LAYOUT containing TEXT. TEXT can
44 # contain newlines (a final newline usually undesirable, as
45 # it will generate a blank line). If LAYOUT is not specified,
46 # generates Arg0, Arg1, Arg2, etc., for successive such
47 # TEXTs. The permissible character set in is TEXT is:
54 # Dynamic variables for configuration
55 # -----------------------------------
57 # We honour the following variables to control various scaling factors:
60 # $Commitid_pixelsz 0.8 \ multiplied together
61 # $Commitid_scale 1.0 /
62 # $Commitid_depth pixelsz/2 \ multiplied together
63 # $Commitid_depth_scale 1.0 /
64 # $Commitid_max_best_scale 2.0 limits XY scaling in *Best*
66 # FYI the font is nominally 3x5 pixels, with 1-pixel inter-line and
67 # inter-character gaps. (It's not strictly speaking a 3x5 bitmap
68 # font, size it contains partial pixels and diagonals.)
71 # Non-`module'-specific functions
72 # -------------------------------
74 # We provide the following functions (which depend on the config
75 # variables, but not on anything else) and compute useful values:
77 # function Commitid_pixelsz() Actual size of each nominal pixel
78 # function Commitid_depth() Depth to use (the amount characters
79 # should be raised or sunken)
81 # General form of provided openscad modules
82 # -----------------------------------------
84 # module Commitid_MODULE_2D(...) Collection of polygons forming characters
85 # module Commitid_MODULE(...) The above, extruded up and down in Z
86 # module Commitid_MODULE_M_2D(...) Mirror writing
87 # module Commitid_MODULE_M(...) 3D mirror writing
88 # function Commitid_MODULE_sz() A 2-vector giving the X,Y size
90 # Except for *Best* modules, the XY origin is in the bottom left
91 # corner without any margin. Likewise Commitid_MODULE_sz does not
94 # For 3D versions, the model is 2*depth deep and the XY plane bisects
95 # the model. This means it's convenient to either add or subtract from
96 # a workpiece whose face is in the XY plane.
98 # The _M versions are provided to avoid doing inconvenient translation
99 # and rotation to get the flipped version in the right place.
102 # Autoscaling modules
103 # -------------------
105 # These modules take a specification of the available XY space, and
106 # select and generate a suitable specific identification layout:
108 # module Commitid_BestCount_2D (max_sz, margin=Commitid_pixelsz())
109 # module Commitid_BestCount (max_sz, margin=Commitid_pixelsz())
110 # module Commitid_BestCount_M_2D(max_sz, margin=Commitid_pixelsz())
111 # module Commitid_BestCount_M (max_sz, margin=Commitid_pixelsz())
112 # module Commitid_BestObjid_2D (max_sz, margin=Commitid_pixelsz())
113 # module Commitid_BestObjid (max_sz, margin=Commitid_pixelsz())
114 # module Commitid_BestObjid_M_2D(max_sz, margin=Commitid_pixelsz())
115 # module Commitid_BestObjid_M (max_sz, margin=Commitid_pixelsz())
117 # max_sz should be [x,y].
119 # BestCount includes (as much as it can of) the git commit count,
121 # git rev-list --first-parent --count HEAD
122 # (and it may include some of the git revision ID too).
124 # BestObjid includes as much as it can of the git commit object hash,
125 # and never includes any of the count.
127 # All of these will autoscale and autorotate the selected model, and
128 # will include an internal margin of the specified size (by default,
129 # one pixel around each edge). If no margin is needed, pass margin=0.
131 # There are no `function Commitid_Best*_sz'. If they existed they
132 # would simply return max_sz.
138 # In general the output, although it may be over multiple lines,
139 # is always in this order
140 # git commit object id (hash)
144 # Not all layouts have all these parts. The commit object id may
145 # sometimes be split over multiple lines, but the count will not be.
146 # If both commit id and commit count appear they will be separated
147 # by (at least) a newline, or a dirty indicator, or a space.
149 # The commit id is truncated to fit, from the right.
151 # The commit count is truncated from the _left_, leaving the least
152 # significant decimal digits.
154 # The dirty indicator can be
156 # * meaning the working tree contains differences from HEAD
158 # + meaning the working tree contains untracked files
159 # (ie files you have failed to `git add' and also failed
160 # to add to gitignore). (But see the -i option.)
166 # If you want to control the exact layout (and make space for it in
167 # your design), you can use these:
169 # module Commitid_LAYOUT_2D()
170 # module Commitid_LAYOUT()
171 # module Commitid_LAYOUT_M_2D()
172 # module Commitid_LAYOUT_M()
173 # function Commitid_LAYOUT_sz()
175 # Here LAYOUT is one of the following (giving for example, `module
176 # Commitid_Full8_2D'). In the examples, we will assume that the tree
177 # is dirty, the commit count is 123456, and the commit object id
178 # starts abcdeffedbcaabcdef... In the examples `_' shows where a
179 # space would be printed.
181 # Small2 Small3 ... Small9 Small10 Small12 Small14 Small16
182 # A single line containing as much of the count will fit, eg:
185 # The objectid is included if more than one character of of it
186 # will fit without makign the output ambiguous:
189 # Small2S Small4S ... Small16S
190 # Small3T Small9T Small12T
191 # Same as Small but split into two lines (S)
192 # or three lines (T). Eg:
193 # Small4S *4 Small6T _*
196 # Git2 Git3 ... Git9 Git10 Git12 Git14 Git16
197 # Git4S Git6S ... Git16S
199 # Just the commit object hash, in one, two (S) or three (T)
203 # Full4 Full6 ... Full20:
204 # The commit object hash plus the commit count, on
205 # separate lines, eg:
206 # Full12 abcdef Full16 abcdeffe
209 # Full6T Full9T ... Full30T
210 # As Full but the commit object id is split over two lines
211 # producing a 3-line layout, eg:
212 # Full9T abc Full21T abcdeff
221 # A demonstration of the built-in 18-character font
225 # Strings passed on command line (without -t, or bare -t,
226 # rather than with -tLAYOUT).
230 # Generated by passing -tLAYOUT on the command line.
234 # COPYRIGHT, LICENCE AND LACK-OF-WARRANTY INFORMATION
235 # ===================================================
237 # This program is Free Software and a Free Cultural Work.
239 # You can redistribute it and/or modify it under the terms of the
240 # GNU General Public License as published by the Free Software
241 # Foundation, either version 3 of the License, or (at your option)
244 # This program is distributed in the hope that it will be useful,
245 # but WITHOUT ANY WARRANTY; without even the implied warranty of
246 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
247 # GNU General Public License for more details.
249 # You should have received a copy of the GNU General Public License
250 # along with this program. If not, see <http://www.gnu.org/licenses/>.
252 # Alternatively, at your option:
254 # This work is licensed under the Creative Commons
255 # Attribution-ShareAlike 4.0 International License.
257 # There is NO WARRANTY.
262 $SIG{__WARN__} = sub { die @_; };
266 if (@ARGV && $ARGV[0] =~ m/^-(D+)$/) {
271 sub p { print @_ or die $!; }
273 sub p_debug { print STDERR @_ if $debug; }
276 // *** AUTOGENERATED - DO NOT EDIT *** //
277 function Commitid_pixelsz() =
278 ($Commitid_pixelsz ? $Commitid_pixelsz : 0.8) *
279 ($Commitid_scale ? $Commitid_scale : 1.0);
280 function Commitid_depth() =
281 ($Commitid_depth ? $Commitid_depth : Commitid_pixelsz()/2) *
282 ($Commitid_depth_scale ? $Commitid_depth_scale : 1.0);
283 function Commitid__scale() =
284 Commitid_pixelsz() / 0.2;
289 my $chrx = sprintf '%#x', ord $chr;
290 return "Commitid__chr_$chrx";
293 our $gtm_demo_i = -1;
297 sub gentextmodule_demo_start_batch () {
302 sub argl_formal (@) { join ', ', @_; }
303 sub argl_actual (@) { join ',', map { m/=/ ? $` : $_ } @_; }
305 sub gen3dmodule ($@) {
306 my ($modb,$size,@argl) = (@_);
307 $size ||= "${modb}_sz()";
308 p "module ${modb}_M_2D(".argl_formal(@argl)."){\n";
309 p " translate([${size}[0],0])\n";
310 p " mirror([1,0,0])\n";
311 p " ${modb}_2D(".argl_actual(@argl).");\n";
313 foreach my $mir ('','_M') {
314 my $mm = "${modb}${mir}";
315 p "module ${mm}(".argl_formal(@argl)."){\n";
316 p " d=Commitid_depth();\n";
317 p " translate([0,0,-d]) linear_extrude(height=d*2)\n";
318 p " ${mm}_2D(".argl_actual(@argl).");\n";
323 sub gentextmodule ($@) {
324 my ($form, @lines) = @_;
325 my $modb = "Commitid_$form";
326 p "module ${modb}_2D(){\n";
327 p " // |$_|\n" foreach @lines;
328 p " scale(Commitid__scale()){\n";
331 foreach my $line (@lines) {
334 foreach my $chr (split //, $line) {
335 p sprintf " translate([%d * 0.8, %d * 1.2]) %s();\n",
336 $x, $y, chrmodname $chr
340 $cols = $x if $x > $cols;
344 gen3dmodule($modb,'');
346 p sprintf "function %s_sz() = Commitid__scale() * 0.1 * [ %d, %d ];\n",
347 $modb, 2 * ($cols * 4 - 1), 2 * (@lines * 6 - 1);
349 push @gtm_demo_o, <<END;
350 translate([$gtm_demo_i * st[0], $gtm_demo_j * st[1]]) {
352 color("blue") translate([-e,-e]) square(${modb}_sz() + 2*[e,e]);
353 square(${modb}_sz());
367 last if %cellmap && !m/\S/;
377 my @chrs = split / /, $_;
378 <DATA> !~ m/\S/ or die;
379 foreach my $row (reverse 0..4) {
390 foreach my $chr (@chrs) {
391 s{^ }{} or die "$chr $_ ?";
392 foreach my $col (0..2) {
396 my $f = $cellmap{$&};
398 $f =~ s/\b\d/ sprintf '%05d', $col*2000 + $&*1025 /ge;
399 $f =~ s/\d\b/ sprintf '%05d', $row*2000 + $&*1025 /ge;
400 push @{ $chrpolys{$chr} }, [ split / /, $f ];
412 foreach my $chr (sort keys %chrpolys) {
413 my $mod = chrmodname $chr;
414 p "module $mod () {\n";
415 foreach my $poly (@{ $chrpolys{$chr} }) {
418 foreach my $pt (@$poly) {
420 $pt =~ s{\d{5}}{$&,};
421 $pt =~ s{\b\d}{$&.}g;
430 @demo = reverse $demo =~ m{.{1,$democols}}go;
435 our $do_git; # contains may chars 'c' (count) and/or 'o' (object)
436 our $do_git_untracked = 1;
440 our %included; # 0 = not at all; 1 = truncated; 2 = full
443 # right justify and truncate (ie, pad and truncate at left)
444 # always includes prefix
445 # sets $included{$what}
446 my ($sz, $what, $whole, $prefix) = @_;
448 my $lw = length $whole;
449 my $spare = $sz - $lw - (length $prefix);
450 $included{$what}= 1 + ($spare > 0);
452 ($spare > 0 ? (' ' x $spare) : '').
454 substr($whole, ($spare < 0 ? -$spare : 0));
458 my ($sz, $what, $whole, $suffix) = @_;
460 $sz -= length $suffix;
461 $included{$what} = 1 + ($sz >= length $whole);
462 return sprintf "%-${sz}.${sz}s%s", $whole, $suffix;
466 $included{$_}=0 foreach qw(Objid Count);
470 my ($form, @lines) = @_;
471 gentextmodule($form, @lines);
474 Chars => (length join '', @lines),
475 Lines => (scalar @lines),
476 Ambiguous => ($form =~ m/Full/ && !grep { m/\W/ } @lines),
477 Included => { %included },
482 sub genform_q ($$$) {
483 my ($form, $s, $lines) = @_;
486 return if $l % $lines;
490 genform($form, $s =~ m/.{$e}/g);
493 sub genform_plusq ($$) {
496 genform_q("${form}S", $s, 2);
497 genform_q("${form}T", $s, 3);
502 sub gitrun_start () {
503 open F, "-|", @gcmd or die "$gcmd[0]: start: $!";
506 sub gitrun_done (;$) {
512 die "@gcmd failed ($?)\n";
516 (@gcmd) = (qw(git), @_);
520 defined or die "@gcmd produced no output";
521 chomp or die "@gcmd produced no final newline";
526 return unless $do_git;
528 @gcmd = qw(git status --porcelain);
529 push @gcmd, qw(--untracked=no) unless $do_git_untracked;
534 if (m/^\?\?/ && $do_git_untracked) {
541 gitrun_done($git_dirty eq '*');
546 if ($do_git =~ m/c/) {
547 $git_count = gitoutput qw(rev-list --first-parent --count HEAD);
549 if ($do_git =~ m/o/) {
550 $git_object = gitoutput qw(rev-parse HEAD);
552 print STDERR join ' ', map { $_ // '?' }
553 "-- commitid", $git_object, $git_dirty, $git_count, "--\n";
555 foreach my $sz (2..10, qw(12 14 16)) {
556 gentextmodule_demo_start_batch();
558 if (defined($git_count)) {
560 my $smallstr = rjustt($sz, 'Count', $git_count, $git_dirty);
561 my $forgitobj = $sz - length($git_count) - 1;
562 if (defined($git_object) && $forgitobj >= 2) {
563 $smallstr = ljustt($forgitobj, 'Objid', $git_object).
567 genform_plusq("Small$sz", $smallstr);
571 genform_plusq("Git$sz", ljustt($sz, 'Objid', $git_object, $git_dirty))
572 if defined $git_object;
574 if (defined $git_count && defined $git_object && $sz<=10) {
576 genform("Full".($sz*2),
577 ljustt($sz, 'Objid', $git_object),
578 rjustt($sz, 'Count', $git_count, $git_dirty));
582 genform("Full".($e*3)."T",
583 ljustt($e*2, 'Objid', $git_object, $git_dirty)
585 rjustt($e, 'Count', $git_count));
590 sub do_some_best ($$) {
591 my ($bestwhat, $formre) = @_;
592 my $modname = "Best$bestwhat";
593 my $fullmodname = "Commitid_${modname}_2D";
594 my @argl = qw(max_sz margin=Commitid_pixelsz());
595 p "module $fullmodname(".argl_formal(@argl).") {\n";
596 my $mbs = '$Commitid_max_best_scale';
597 p " sc_max = $mbs ? $mbs : 2;\n";
598 p " sz = max_sz - 2*[margin,margin];\n";
602 $b->{Included}{$bestwhat} <=> $a->{Included}{$bestwhat} or
603 $b->{Chars} <=> $a->{Chars} or
604 $a->{Lines} <=> $b->{Chars}
607 $_->{Form} =~ m/$formre/ &&
612 my $form = $f->{Form};
613 p " sz_$form = Commitid_${form}_sz();\n";
614 foreach my $rot (qw(0 1)) {
615 my $id = "${form}_r${rot}";
616 p " sc_$id = min(sc_max";
617 foreach my $xy (qw(0 1)) {
618 p ",sz[$xy]/sz_$form","[",(($xy xor $rot)+0),"]";
621 push @do, " if (sc_$id >= 1.0";
622 push @do, " && sc_$id >= sc_${form}_r1" if !$rot;
624 push @do, " translate([margin,margin]) scale(sc_$id)\n";
625 push @do, " rotate(90) translate([0,-sz_$form"."[1]])\n" if $rot;
626 push @do, " Commitid_${form}_2D();\n";
632 echo("$fullmodname could not fit anything in", max_sz);
638 gen3dmodule "Commitid_$modname", 'max_sz', @argl;
642 return unless $do_git;
644 # Auto-computer for `best fit'
646 # We have two best fit approaches: with count, and git-object-id-only
648 # For `with count', we only ever include the git object id if the
649 # result would be unambigous. That means that at least one space
650 # or punctuation was generated.
652 # We sort the options by firstly number of characters
653 # (decreasing), and then by number of lines (increasing) and
654 # try each one both ways round.
656 do_some_best('Count', 'Small|Full') if $do_git =~ m/c/;
657 do_some_best('Objid', 'Git|Full') if $do_git =~ m/o/;
662 if (m/^--(no)?-git$/) {
663 $do_git = $1 ? '' : 'co';
664 } elsif (m/^---git=objid$/i) {
667 $do_git_untracked = 0;
668 } elsif (m/^-t(.*)$/) {
670 die "bad usage: -t needs string argument\n";
672 gentextmodule($form, split /\n/, $_);
675 gentextmodule("Arg$argcounter", $_);
678 die "bad usage: unknown option \`$_'\n";
682 $do_git //= defined($argcounter) ? '' : 'co';
684 gentextmodule_demo_start_batch();
685 gentextmodule('FontDemo', @demo);
690 p "module Commitid_2DDemo(){\n";
691 p " st = Commitid__scale() * [ 10, 5 ];\n";
692 p " e = Commitid_pixelsz();\n";
693 p $_ foreach @gtm_demo_o;
696 flush STDOUT or die $!;
697 close STDOUT or die $!;
711 /#\ r /#\ ##\ # # ### /#/ ### /#\ /#\
712 # # /# # # # # # # # # # # #
713 # # # /#/ ##< \## ##\ ##\ // >#< \##
714 # # # # # # # # # # # # #
715 \#/ /#\ ### ##/ # ##/ \#/ # \#/ ##/
721 /## ##\ # /## #r# ###
723 \## ##/ \## \## \#/ #