#!/usr/bin/env perl # # ctdb_y2h - convert CTDB info from YAML to HTML # # Generates: # # ndx_*.html packet index pages # tc_*.html telecommand packet summary pages # tm_*.html telemetry packet summary pages # # Note: ctdb_y2t is VERY similar, but generates tbl/troff, instead. # # Written by Rich Morin, rdm@slac.stanford.edu use Data::Dumper; use strict; use warnings; require 'fsw_docs.pl'; { my (@DIV, @desc, %CHAP, %HEP, %TITLE, %desc, %desc2, %h, %pkt, %type, $CTDB, $D, $HDR, $O, $b_hi, $b_lo, $bd, $chap, $count, $field, $ftf, $last, $ndx, $offset, $out, $p_desc, $p_field, $p_len, $p_pkt, $p_type, $pkt, $r_ctdb, $r1, $r2, $r3, $r4, $sect, $size, $t0, $t1, $t2, $t3, $t4, $type); $CTDB = 'edit/ctdb.yml'; $D = 40; $O = 50; $HDR = <

GLAST/LAT > DAQ and FSW > FSW > EOT @DIV = ('A' .. 'Z'); %CHAP = (tc => 'Telecommand', tm => 'Telemetry' ); # Hand-Edited Pages %HEP = (tc => '../edit/ctdb_tc_hdr.html', tm => '../edit/ctdb_tm_hdr.html' ); %TITLE = (name => 'name', field_name => 'name, within field', sect_name => 'name, within manual section', type_name => 'name, within type' ); # Get CTDB information. $r_ctdb = load_ctdb($CTDB); # Write tele{command,metry} pages. foreach $chap qw(tc tm) { foreach $type (sort(keys(%{ $r_ctdb->{ $CHAP{$chap} } }))) { $r1 = $r_ctdb->{ $CHAP{$chap} }{$type}; $type{ $r1->{Section} } = $type; $r2 = $r1->{Header}; ($p_type = $type) =~ s|_| |g; next unless (defined($r2->[4])); # KLUDGE undef %h; $h{Version} = (split(/,/, $r2->[0]))[1]; $h{T} = (split(/,/, $r2->[1]))[1]; $h{SH} = (split(/,/, $r2->[2]))[1]; if ($chap eq 'tc') { $h{APID} = (split(/,/, $r2->[3]))[1]; $h{SF} = 'SF = ' . (split(/,/, $r2->[4]))[1]; } foreach $pkt (sort(keys(%{ $r1->{Packets} }))) { ($p_pkt = $pkt) =~ s|_| |g; $r2 = $r1->{Packets}{$pkt}; $sect = $r2->{Section}; if ($chap eq 'tm') { $h{APID} = $r2->{APID}; $h{SF} = (defined($r2->{SF})) ? "SF = $r2->{SF}" : 'SF'; } $p_desc = ($r2->{Name} ne $p_pkt) ? "$r2->{Name}." : ''; $p_desc .= " $r2->{Description_0}" if (defined($r2->{Description_0})); $p_desc .= "

\n $r2->{Description_1}" if (defined($r2->{Description_1})); $t1 = $r2->{Packet_Length}; $p_len = ($t1 =~ m|^\d+$|) ? " = $t1" : ": $t1"; $t2 = " offset\n"; for ($t3=15; $t3>=0; $t3--) { $t2 .= " $t3\n"; } chomp($p_desc); chomp($t2); $out = < "$p_pkt" $CHAP{$chap} Packet $HDR "$p_pkt" $CHAP{$chap} Packet

$sect    $p_pkt

Packet Type: $p_type $CHAP{$chap}

Description:

Layout:

$t2 EOT if ($chap eq 'tc') { $out .= <0 EOT $offset = 0x08; } else { # tm $out .= <Timestamp Seconds MSW EOT $offset = 0x0e; } $count = 0; undef @desc; if ($r2->{Fields} ne '') { foreach $field (@{ $r2->{Fields} }) { if ($field !~ m|^\?|) { $r3 = $r_ctdb->{Common}{Fields}{$field}; $t1 = ($chap eq 'tm' and defined($r3->{Description_tm})) ? $r3->{Description_tm} : $r3->{Description}; push(@desc, $field) if (defined($t1)); $t2 = "$chap:$field"; if (defined($r3)) { if (not defined($desc{$t2})) { $desc{$t2} = (defined($t1)) ? $t1 : '? - no description'; } } else { if (not defined($desc{$t2})) { $desc{$t2} = '? - no entry'; } } $desc2{$field} = $desc{$t2} unless (defined($desc2{$field})); } if ($count%16 == 0) { $offset += 2 * ($count/16); $t1 = sprintf("0x%02x", $offset); $count = 0; $out .= < EOT } $bd = ""; ($p_field = $field) =~ s|_| |g; if ($field =~ m|^[A-Z]|) { $size = $r_ctdb->{Common}{Fields}{$field}{Size}; $size = 16 unless (defined($size)); } elsif ($field =~ m|^\?(\w+):(\d+)$|) { ($p_field, $size) = ($1, $2); } else { print "???: field='$field'\n"; # DEBUG } if ($size !~ m|^\d+$|) { # Not numeric if ($size =~ m|^L *= *(\d+)$|) { ($b_lo, $b_hi) = ($1, $1); } elsif ($size =~ m|^L *<= *(\d+)$|) { ($b_lo, $b_hi) = (1, $1); } elsif ($size =~ m|^(\d+) *<= *L *<= *(\d+)$|) { ($b_lo, $b_hi) = ($1, $2); } else { print "???: size='$size'\n"; # DEBUG ($b_lo, $b_hi) = (-1, -1); } if ($b_lo == -1) { $size = 16; $t1 = 'TBD'; } else { $size = 8 * $b_hi; $t1 = ($b_lo eq $b_hi) ? "D = $b_hi" : "D <= $b_hi"; } $t2 = 16 - $count; $out .= <$bd$p_field ($t1) EOT } elsif ($size > 16) { # Oversize $t1 = $size - 16; $t2 = sprintf("0x%02x", $offset+2); $out .= <$bd$p_field MSW EOT } else { # "Normal" $out .= <$bd$p_field EOT } $count += $size; $pkt{field_name}{$p_field}{"$p_pkt:$chap"} = $pkt unless ($field =~ m|^\?|); } } $offset += 2 * (int(($count+15)/16)); $t1 = sprintf("0x%02x", $offset); $out .= < 8); EOT $out .= <
0x00 Version = $h{Version} T=$h{T} SH=$h{SH} APID = $h{APID}
0x02 $h{SF} Sequence Count
0x04 Packet Length $p_len
0x06Function Code = $r2->{Function_Code}
0x08 Timestamp Seconds LSW
0x0a Timestamp Sub-Seconds MSW
0x0c Timestamp Sub-Seconds LSW
$t1
$t2 $bd$p_field LSW
$t1 Packet Checksum
EOT if ($#desc >= 0) { $out .= <Fields:

\n"; } $out .= < EOT $t1 = "${chap}_$pkt.html"; open(OUT, ">a_cat/$t1") or die "can't open '$t1'"; print OUT $out; close(OUT); $pkt{name }{ "$p_pkt:$chap"} = $pkt; $pkt{sect_name}{ "$sect $p_pkt:$chap"} = $pkt; $pkt{type_name}{"$p_type $CHAP{$chap}"}{"$p_pkt:$chap"} = $pkt; } } } # Write index pages. # print Dumper(%pkt); # DEBUG foreach $ndx (sort(keys(%TITLE))) { $out = < Index by $TITLE{$ndx} $HDR Index by $TITLE{$ndx}

EOT $t2 = "

See Also:

\n" . " \n"; $out .= $t2; $out .= "\n"; if ($ndx eq 'name') { # $pkt{name}{"$p_pkt:$chap"} = $pkt; $last = ''; $out .= "

Packets:

\n\n" . " 
\n";
            $r3   =  $pkt{name};
            foreach $t0 (sort(keys(%$r3))) {
                ($p_pkt, $chap) =  split(/:/, $t0);

                $pkt = $r3->{$t0};
                ($t1 = $pkt)  =~ s|_.*||;

                $out .= "\n" if ($t1 ne $last and $last ne '');
                $last = $t1;
                $out .= "  $p_pkt";

                $out .= ($chap eq 'tm') ? " (tm)\n"
                                        : "\n";
            }
            $out  .= "
\n"; } elsif ($ndx eq 'field_name') { # $pkt{field_name}{$p_field}{"$p_pkt:$chap"} = $pkt; $last = ' '; $out .= "

\n"; $r3 = $pkt{field_name}; foreach $p_field (sort(keys(%$r3))) { $r4 = $r3->{$p_field}; ($field = $p_field) =~ s| |_|g; print "p_field='$p_field'\n" # DEBUG unless (defined($desc2{$field})); $t1 = uc(substr($field, 0, 1)); if ($t1 ne $last) { foreach $t2 (@DIV) { if ($t2 gt $last and $t2 le $t1) { $out .= "

\n"; foreach $t3 (@DIV) { if ($t3 eq $t2) { $out .= "  " . "$t3 \n"; } else { $out .= " " . "$t3\n"; } } } } } $last = $t1; $t2 = $desc2{$field}; chomp($t2); $out .= <$p_field

    $t2

    EOT foreach $t0 (sort(keys(%$r4))) { ($p_pkt, $chap) = split(/:/, $t0); $pkt = $r4->{$t0}; ($t1 = $pkt) =~ s|_.*||; $out .= " $p_pkt"; $out .= ($chap eq 'tm') ? " (tm)
    \n" : "
    \n"; } $out .= "

\n\n"; } foreach $t2 (@DIV) { if ($t2 gt $last and $t2 le 'Z') { $out .= "


\n"; foreach $t3 (@DIV) { if ($t3 eq $t2) { $out .= "  " . " $t3 \n"; } else { $out .= " $t3\n"; } } } } } elsif ($ndx eq 'sect_name') { # $pkt{sect_name}{"$sect $p_pkt:chap"} = $pkt; $last = ''; $r3 = $pkt{sect_name}; foreach $t0 (sort by_sect (keys(%$r3))) { ($sect, $chap) = split(/:/, $t0); $pkt = $r3->{$t0}; ($t1 = $pkt) =~ s|_.*||; ($t1 = $sect) =~ s|^(\d+\.\d+)\..*$|$1|; if ($t1 ne $last) { $out .= " \n\n" if ($last ne ''); ($t2 = $type{$t1}) =~ s|_| |g; $t3 = ($chap eq 'tc') ? ' Telecommands' : ' Telemetry'; $t4 = ' ' x 4; $out .= "

$t1$t4$t2 $t3

\n"; $out .= " 
\n";
                }
                $last = $t1;
                $out .= "  $sect";
                $out .= ($chap eq 'tm') ? " (tm)\n"
                                        : "\n";
            }
            $out .= "
\n\n"; } elsif ($ndx eq 'type_name') { # $pkt{type_name}{$p_type}{"$p_pkt:$chap"} = $pkt; $ftf = 0; $r3 = $pkt{type_name}; foreach $p_type (sort(keys(%$r3))) { $r4 = $r3->{$p_type}; $out .= "\n" if (++$ftf != 1); $out .= " $p_type\n
    \n"; foreach $t0 (sort(keys(%$r4))) { ($p_pkt, $chap) = split(/:/, $t0); $pkt = $r4->{$t0}; $out .= " " . "$p_pkt
    \n"; } $out .= "
\n"; } } $out .= < EOT $t1 = "ndx_$ndx.html"; open(OUT, ">a_cat/$t1") or die "can't open '$t1'"; print OUT $out; close(OUT); } # Print out "starter description entries" for any undefined fields. foreach $t1 (sort {lc($a) cmp lc($b)} (keys(%desc))) { if ($desc{$t1} =~ m|^\?|) { ($t2, $t3) = split(/:/, $t1); print <