tools/perllib/AppearanceTemplate.pm

   1 # ======================================================================
   2 # AppearanceTemplate.pm
   3 # Copyright 2003, Sony Online Entertainment
   4 # All rights reserved.
   5 # ======================================================================
   6
   7 package AppearanceTemplate;
   8 use strict;
   9
  10 use CustomizationVariableCollector;
  11 use Iff;
  12
  13 # ======================================================================
  14 # AppearanceTemplate 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 # AppearanceTemplate private variables.
  33 # ======================================================================
  34
  35 my $debug = 0;
  36 my $treeFileRelativeName;
  37
  38 # ======================================================================
  39 # AppearanceTemplate public functions.
  40 # ======================================================================
  41
  42 sub install
  43 {
  44         # Register handler with CustomizationVariableCollector
  45         CustomizationVariableCollector::registerHandler("APT ", \&processIff);
  46 }
  47
  48 # ======================================================================
  49 # AppearanceTemplate 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 "AppearanceTemplate: processing file [$treeFileRelativeName]\n" if $debug;
  61
  62         # Ensure we're in the proper form.
  63         return 0 unless $iff->getCurrentName() eq "APT ";
  64
  65         $iff->enterForm("APT ");
  66         {
  67                 my $version = $iff->getCurrentName();
  68                 if ($version eq '0000')
  69                 {
  70                         process_0000($iff);
  71                 }
  72                 else
  73                 {
  74                         print STDERR "AppearanceTemplate: unsupported version tag [$version].";
  75                         return 0;
  76                 }
  77         }
  78         $iff->exitForm("APT ");
  79
  80         print "AppearanceTemplate: finished processing file [$treeFileRelativeName]\n" if $debug;
  81
  82         # Success.
  83         return 1;
  84 }
  85
  86 # ----------------------------------------------------------------------
  87
  88 sub process_0000
  89 {
  90         print "process_0000(): begin\n" if $debug;
  91
  92         my $iff = shift;
  93         die 'bad $iff arg' if ref($iff) ne 'Iff';
  94
  95         $iff->enterForm('0000');
  96         $iff->enterChunk('NAME');
  97
  98         my $appearanceTemplateName = $iff->read_string();
  99         CustomizationVariableCollector::logAssetLink($treeFileRelativeName, $appearanceTemplateName);
 100
 101         $iff->exitChunk('NAME');
 102         $iff->exitForm('0000');
 103
 104         print "process_0000(): end\n" if $debug;
 105 }
 106
 107 # ======================================================================
 108
 109 1;