7 use Getopt::Long 2.33 qw(HelpMessage :config bundling);
12 'raw|r', # full output
13 'version=i', # force version
14 ) or HelpMessage(-exitval => 2);
17 package Shiar_Parse::WormEdit;
22 use Parse::Binary::Nested;
25 "WormEdit053\000LVL" => 53,
26 "WormEdit\34195\000LVL" => 95,
27 "WormEdit\34194\000LVL" => 94,
28 "WormEdit\34193\000LVL" => 93,
35 description => 'Ca64x256',
44 map { (start => $_, end => $_) } [1,
65 levels => ['*', # levelcount->total actually
103 my ($self, $input) = @_;
104 my ($id, $version) = (substr($input, 0, 15), ord substr($input, 15, 1));
105 my $fileversion = $MAGICID{$id}
106 or die "File does not match any known WormEdit level header\n";
109 warn "Override version $version to $opt{version}\n";
110 $version = $opt{version};
112 elsif ($version != $fileversion) {
113 warn "Unexpected version $version (expecting $fileversion)\n";
115 elsif ($version == 95) {
116 # auto-detect exact variant
117 if (ord substr($input, 70, 1) ~~ [1 .. 8]) {
118 # valid sprite length instead of description byte
119 # (which is usually a letter or nul)
122 elsif (ord substr($input, 147, 1) == 0) {
123 # nul of finish type is 2 bytes later (unlike first char of message)
126 warn "Ambiguous file version 95; guessing subversion $version\n";
129 $fileversion += 100 if $fileversion < 90; # 93..95 came before 50..53
130 given ($fileversion) {
131 when (153) { } # current @FORMAT
132 $FORMAT[7] = 'Ca64'; # no reserved space after description
133 $FORMAT[15]->[-1] = 'Ca255'; # enddata
134 $FORMAT[-1]->[-1]->[0] = '32C'; # less objects
135 when ($version == 96) {
136 ref $_ and $_->[-1] = 'C' for @{ $FORMAT[11] }; # 9 moderefs
138 ref $_ and pop @$_ for @{ $FORMAT[11] }; # only 8 moderefs
139 splice @FORMAT, 6, 2 if $version <= 94; # earlier version without description
141 splice @{ $FORMAT[7] }, 4, 2; # no race
142 splice @{ $FORMAT[13] }, 4, 2; # no enddata
143 splice @{ $FORMAT[-1] }, 1, 2; # no name
145 splice @FORMAT, 14, 2; # no hiname
146 $FORMAT[-1]->[0] = 64; # constant amount of levels
149 die "Cannot parse data for Wormedit $fileversion/$version\n";
153 # convert to an easily accessible hash
154 push @FORMAT, -trail => 'a*';
155 my $data = Parse::Binary::Nested->new(\@FORMAT)->unpackf($input);
156 warn "Trailing data left unparsed\n" if length delete $data->{-trail};
157 $data->{format} = 'WormEdit';
162 package Shiar_Parse::WormyLevel;
167 use List::Util qw(sum min max);
169 use Parse::Binary::Nested;
172 my ($self, $input) = @_;
173 my ($psize, $ptype, $size, $type, $vsize, $dsize, $id, $version) = unpack q{
174 x11 x42 # file signature and comment
175 S a2 S a2 # file size, type; data size, type
177 S S # var size; content size
181 or die "Not a calculator string, thus cannot be a Wormy level file\n";
183 or warn "File size ($size) does not correspond with data size ($psize)\n";
185 or die "Not a calculator string, thus cannot be a Wormy level file\n";
186 $size == $vsize and $vsize == $dsize+2
187 or warn "Mismatch in string data size declarations\n";
188 # substr($input, -2) eq $CHECKSUM
190 $input = substr $input, 73, -2;
192 or die "Wormy level identifier not found\n";
195 warn "Override version $version to $opt{version}\n";
196 $version = $opt{version};
198 elsif ($version == 95) {
199 # level offset instead of description byte
200 $version-- if (unpack('x2Z*x2xC', $input))[1] == 0xF4;
201 warn "Ambiguous file version 95; guessing subversion $version\n";
214 offset => [1, map {$_ => 'S'} @$_], # byte location of start
215 end => [1, map {$_ => 'C'} @$_],
217 [qw/single peaworm tron deathmatch foodmatch multifood timematch race ctf/]
219 theanswer => 'C', # 42
261 my $offsetbase = 0xF080;
267 $offsetbase = 0xF400;
269 ref $_ and splice(@$_, -8, 2) for @{ $FORMAT[11] }; # no multifood
270 splice @FORMAT, 12, 2; # no reserved byte
272 splice @FORMAT, 6, 2; # no description
275 $FORMAT[5] = 'C/a'; # length-preceding name
276 splice @FORMAT, 10, 2; # no default sprite
278 $_->[5] = $_->[7]; # no tron; deathmatch instead
279 $_->[7] = $_->[9]; # foodmatch instead
280 $_->[9] = 'linkmatch'; # replaces timematch
281 $_->[11] = $_->[13]; # race
282 $_->[13] = $_->[15]; # ctf
283 $_->[15] = 'domination';
284 } for @{ $FORMAT[9] }; # no multifood
285 push @LEVELFORM, "object$_" => ['C',
286 map {$_ => 'C'} qw(x1 y1 x2 y2)
287 ] for qw(lines boxes);
290 die "Unsupported level version $version\n";
294 my $data = Parse::Binary::Nested->new(\@FORMAT)->unpackf($input);
296 $offsetbase += 1 + @{ $data->{sprite} } if $data->{sprite};
297 $data->{moderef}->{offset}->{single} == $offsetbase
298 or warn "First singleplayer level is not in front\n";
301 $data->{moderef}->{end}->{single} > 0, # singleplayer slot if any levels
302 $data->{moderef}->{end}->{peaworm}, # one for each peaworm arena
303 $data->{moderef}->{end}->{tron}, # idem for tron
305 $data->{hinames} = [ unpack '(x2a3)*', substr($data->{leveldata}, -5 * $slots) ];
306 $data->{format} = '86s';
310 [qw'multi peaworm tron deathmatch foodmatch multifood timematch'],
315 $data->{levels} = [];
316 for my $modes (@VARMODES) {
317 my $variant = shift @$modes;
318 my @modeoffsets = grep {defined} #TODO: comment
319 map { $data->{moderef}->{offset}->{$_} } @$modes;
320 @modeoffsets or next;
321 $data->{levelcount}->{$variant} = 0;
322 $offset = min(grep {$_} @modeoffsets) or next;
323 $offset -= $offsetbase;
324 my $amount = $variant eq 'single' ? 100
325 : max(grep {defined} map { $data->{moderef}->{end}->{$_} } @$modes);
327 my @varform = @LEVELFORM;
328 $varform[13]->[0] = $variant eq 'single' ? 1 : 4;
329 unshift @varform, name => 'Z*' unless $variant eq 'single' or $version <= 91;
330 $varform[-1]->[0] = 1 if $variant eq 'race' and $version > 91;
331 $varform[-1]->[0] = 2 if $variant eq 'ctf';
332 my $parselevel = Parse::Binary::Nested->new(\@varform);
334 while ($offset < length $data->{leveldata}) {
335 last if substr($data->{leveldata}, $offset, 1) eq chr(255);
337 # find references to this level offset, and set start number to matching modes
338 while (my ($mode, $location) = each %{ $data->{moderef}->{offset} }) {
339 $location == $offset + $offsetbase or next;
340 $data->{moderef}->{start}->{$mode} = 1 + scalar @{ $data->{levels} };
343 my $level = $parselevel->unpackf(substr $data->{leveldata}, $offset);
344 my $size = 8 # unpack length (ugh, ugly recalculation)
345 + (defined $level->{name} ? 1 + length $level->{name} : 0)
346 + 3 * (ref $level->{worms} eq 'ARRAY' ? scalar @{$level->{worms}} : 1)
347 + 2 * ($level->{flags} ? ref $level->{flags} eq 'ARRAY' ? scalar @{$level->{flags}} : 1 : 0)
348 + ($level->{sprite} ? scalar @{$level->{sprite}} : 0)
349 + ($level->{balls} ? 3 * scalar @{$level->{balls}} : 0);
350 $level->{size} = $size;
351 $level->{offset} = $offset + $offsetbase;
353 # add objects until terminator
354 $level->{objects} = [];
355 if ($version <= 91) {
356 push @{ $level->{objects} }, { %$_, type => 2 } for map { $level->{$_} ? @{ $level->{$_} } : () } qw(objectlines);
357 push @{ $level->{objects} }, { %$_, type => 3 } for map { $level->{$_} ? @{ $level->{$_} } : () } qw(objectboxes);
358 $size += 1 + 4 * scalar @{ $level->{objects} };
361 while (my $object = ord substr($data->{leveldata}, $offset+$size, 1)) {
362 push @{ $level->{objects} }, Parse::Binary::Nested->new([@OBJECTFORM])->unpackf(
363 substr $data->{leveldata}, $offset+$size, 5
369 # add parsed level and advance
370 push @{ $data->{levels} }, $level;
372 last if ++$data->{levelcount}->{$variant} >= $amount;
375 if ($variant eq 'single') {
377 $data->{finish}->{code} =
378 my $code = substr $data->{leveldata}, $offset, -5*$slots;
383 chr 0x21, # ld hl, MESSAGE
384 pack('v', $offsetbase + $offset + 9),
386 0xCD, 0x37, 0x4A, # call _puts
387 0xC3, 0xAA, 0x55, # jp _getkey
392 0x21, 0, 0x1C, # ld hl, $POS
393 0x22, 0x7C, 0xC3, # ld (_penCol), hl
394 0x21, # ld hl, MESSAGE
396 pack('v', $offsetbase + $offset + 15),
398 0xCD, 0xA5, 0x4A, # call _vputs
399 0xC3, 0xAA, 0x55, # jp _getkey
403 while (my ($finish, $match) = each %FINISHCODE) {
404 $match eq substr $code, 0, length $match or next;
405 $data->{finish}->{type} = $finish and
406 $data->{finish}->{message} = unpack 'Z*', substr($code, length $match);
418 my @OBJTYPE = ('none', 'line', 'fat line', 'bar', 'circle');
419 my @ENDTYPE = ('none', 'message', 'small message');
423 my @objtypes = map { $_->{type} } @$objects;
425 $count{$_}++ for @objtypes;
426 return (@objtypes > 1 && keys %count == 1 && 'all ') . join(', ',
427 map { $OBJTYPE[$_] ? $OBJTYPE[$_] . ($count{$_} > 1 && 's') : $_ }
432 # read and parse all input data
435 my $rawdata = readline;
436 if (substr($rawdata, 0, 11) eq "**TI86**\032\012\000") {
437 # compiled calculator file
438 $data = Shiar_Parse::WormyLevel->read($rawdata);
440 elsif (substr($rawdata, 0, 8) eq 'WormEdit') {
441 # original wormedit source
442 $data = Shiar_Parse::WormEdit->read($rawdata);
445 die "Unrecognised file type\n";
448 # output with user-preferred formatting
450 # full data in yaml (human-readable) formatting
452 local $YAML::CompressSeries;
453 $YAML::CompressSeries = 0;
454 my $yml = "# Wormy levelset\n" . YAML::Dump($data);
456 # inline format of short hashes
458 ^(\ *) - \n # array indicator
459 ((?:\1\ \ [a-z0-9]{1,5}:\ *\d+\n)+) # simple hash declaration
460 (?!\1\ ) # no further children
462 my ($indent, $value) = ($1, $2);
466 "$indent- {$value}\n";
473 print " ($data->{description})" if defined $data->{description};
475 printf "File version: %s\n", "$data->{format} v$data->{version}";
476 printf "Defaults: %s\n", join('; ',
477 $data->{sprite} ? 'sprite ' . scalar @{ $data->{sprite} } : (),
478 defined $data->{hiname} ? 'hiscore by ' . $data->{hiname} : (),
482 for my $variant (qw/single multi race ctf/) {
483 my $count = $data->{levelcount}->{$variant};
485 printf '%s (%s)', ucfirst $variant, $count // 'invalid';
488 for (0 .. $count - 1) {
489 my $level = $data->{levels}->[$_ + $startnr];
490 printf("\n- %-22s%4s:%3s+%2s%3s %3sx%-3s%s",
491 $level->{id} || $level->{name} || '#'.($_+1),
492 @$level{qw/size bsize growth/},
493 $variant eq 'single' && "x$level->{peas}",
494 @$level{qw/width height/},
495 join(';', map {" $_"} grep {$_}
496 @{$level->{objects}} && sprintf('%2d object%s (%s)',
497 scalar @{$level->{objects}}, @{$level->{objects}} != 1 && 's',
498 objsummary($level->{objects}),
500 $level->{sprite} && @{$level->{sprite}} && sprintf('sprite %d',
501 scalar @{$level->{sprite}},
503 $level->{balls} && @{$level->{balls}} && sprintf('%d bounc%s',
504 scalar @{$level->{balls}}, @{$level->{balls}} == 1 ? 'y' : 'ies',
513 printf("-- %-21s%4s: %s (%s)\n",
515 defined $data->{finish}->{code}
516 ? length $data->{finish}->{code} : '?',
517 defined $data->{finish}->{type}
518 ? $ENDTYPE[$data->{finish}->{type}] || 'unknown' : 'code',
519 $data->{finish}->{message} // '?',
520 ) if $variant eq 'single';
528 parse-wormedit - Wormy level data parser
532 parse-wormedit [--raw] <input.lvl>
536 Reads Wormy levels (either original WormEdit source or compiled TI-86 string)
537 from STDIN or given file, and outputs contents, summarised or in full.
541 Mischa POSLAWSKY <wormy@shiar.org>