tools/perllib/DetailAppearanceTemplate.pm

   1 # ======================================================================
   2 # DetailAppearanceTemplate.pm
   3 # Copyright 2003, Sony Online Entertainment
   4 # All rights reserved.
   5 # ======================================================================
   6
   7 package DetailAppearanceTemplate;
   8 use strict;
   9
  10 use CustomizationVariableCollector;
  11 use Iff;
  12
  13 # ======================================================================
  14 # DetailAppearanceTemplate potentially-public variables.
  15 # ======================================================================
  16
  17 # our $relativePathName;
  18
  19 # ======================================================================
  20 # Setup variables that can be imported by Exporter into user modules.
  21 # ======================================================================
  22
  23 use vars qw(@ISA @EXPORT_OK $VERSION);
  24 use Exporter;
  25 $VERSION = 1.00;
  26 @ISA     = qw(Exporter);
  27
  28 # These symbols are okay to export if specifically requested.
  29 @EXPORT_OK = qw(&install);
  30
  31 # ======================================================================
  32 # DetailAppearanceTemplate private variables.
  33 # ======================================================================
  34
  35 my $debug = 0;
  36 my $treeFileRelativeName;
  37
  38 # ======================================================================
  39 # DetailAppearanceTemplate public functions.
  40 # ======================================================================
  41
  42 sub install
  43 {
  44         # Register handler with CustomizationVariableCollector
  45         CustomizationVariableCollector::registerHandler("DTLA", \&processIff);
  46 }
  47
  48 # ======================================================================
  49 # DetailAppearanceTemplate private functions
  50 # ======================================================================
  51
  52 sub processIff
  53 {
  54         # Process args.
  55         my $iff = shift;
  56         die "bad iff arg specified" if ref($iff) ne "Iff";
  57
  58         $treeFileRelativeName = shift;
  59         die "bad tree file relative name" if !defined($treeFileRelativeName);
  60         print "DetailAppearanceTemplate: processing file [$treeFileRelativeName]\n" if $debug;
  61
  62         # Ensure we're in the proper form.
  63         return 0 unless $iff->getCurrentName() eq "DTLA";
  64
  65         $iff->enterForm("DTLA");
  66         {
  67                 my $version = $iff->getCurrentName();
  68                 if ($version =~ m/^000[1-8]$/)
  69                 {
  70                         process_0001_0008($iff);
  71                 }
  72                 else
  73                 {
  74                         print STDERR "DetailAppearanceTemplate: unsupported version tag [$version].";
  75                         return 0;
  76                 }
  77         }
  78         $iff->exitForm("DTLA");
  79
  80         print "DetailAppearanceTemplate: finished processing file [$treeFileRelativeName]\n" if $debug;
  81
  82         # Success.
  83         return 1;
  84 }
  85
  86 # ----------------------------------------------------------------------
  87
  88 sub process_0001_0008
  89 {
  90         print "process_0001_0008(): begin\n" if $debug;
  91
  92         my $iff = shift;
  93         die 'bad $iff arg' if ref($iff) ne 'Iff';
  94
  95         $iff->enterForm();
  96
  97         $iff->walkIff(\&iffWalker_0001_0008);
  98
  99         $iff->exitForm();
 100
 101         print "process_0001_0008(): end\n" if $debug;
 102 }
 103
 104 # ----------------------------------------------------------------------
 105
 106 sub iffWalker_0001_0008
 107 {
 108         my $iff           = shift;
 109         die 'bad iff arg' if ref($iff) ne 'Iff';
 110
 111         my $blockName = shift;
 112         my $isChunk       = shift;
 113
 114         printf("iffWalker_0001_0008(): %s=[%s]\n", $isChunk ? "chunk" : "form", $blockName) if $debug;
 115
 116         # Process blocks we understand.
 117         if ($isChunk)
 118         {
 119                 if ($blockName eq 'CHLD')
 120                 {
 121                         # Handle specifying linked appearance template assets.
 122                         $iff->skipBytes(4);
 123
 124                         # NOTE: this is sneaky: appearances are missing the leading 'appearance/'.
 125                         #       This burned me first time around.
 126                         my $appearanceTemplateName = 'appearance/' . $iff->read_string();
 127                         CustomizationVariableCollector::logAssetLink($treeFileRelativeName, $appearanceTemplateName);
 128                 }
 129         }
 130
 131         # Keep traversing.
 132         return 1;
 133 }
 134
 135 # ======================================================================
 136
 137 1;