libcore/swf/DoInitActionTag.h

   1 //
   2 //   Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   3 //
   4 // This program is free software; you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation; either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 #ifndef GNASH_SWF_DOINITACTIONTAG_H
  19 #define GNASH_SWF_DOINITACTIONTAG_H
  20
  21 #include "ControlTag.h" // for inheritance
  22 #include "SWF.h" // for TagType definition
  23 #include "action_buffer.h" // for composition
  24 #include "MovieClip.h" // for inlines
  25 #include "SWFStream.h" // for inlines
  26
  27 // Forward declarations
  28 namespace gnash {
  29     class movie_definition;
  30 }
  31
  32 namespace gnash {
  33 namespace SWF {
  34
  35 /// SWF Tag DoInitAction (59)
  36 //
  37 /// Thin wrapper around action_buffer.
  38 ///
  39 class DoInitActionTag : public ControlTag
  40 {
  41 public:
  42
  43     DoInitActionTag(SWFStream& in, movie_definition& md, int cid)
  44         :
  45         _buf(md),
  46         _cid(cid)
  47     {
  48         read(in);
  49     }
  50
  51     /// Execute 'state' tags.
  52     //
  53     /// State tags change the current state of a MovieClip. They are executed
  54     /// even for skipped frames to ensure that the state is consistent.
  55     //
  56     /// Even though DoInitAction tags contain ActionScript, they are considered
  57     /// to be state tags. They are executed only once.
  58     virtual void executeState(MovieClip* m, DisplayList& /*dlist*/) const {
  59         m->execute_init_action_buffer(_buf, _cid);
  60     }
  61
  62     static void loader(SWFStream& in, TagType tag, movie_definition& m,
  63             const RunResources& /*r*/)
  64     {
  65         if (m.isAS3()) {
  66             IF_VERBOSE_MALFORMED_SWF(
  67                 log_swferror("SWF contains DoInitAction tag, but is an "
  68                 "AS3 SWF!");
  69             );
  70             throw ParserException("DoInitAction tag found in AS3 SWF!");
  71         }
  72
  73         in.ensureBytes(2);
  74         const boost::uint16_t cid = in.read_u16();
  75
  76         IF_VERBOSE_PARSE(
  77             log_parse(_("  tag %d: do_init_action_loader"), tag);
  78             log_parse(_("  -- init actions for sprite %d"), cid);
  79         );
  80
  81         // TODO: Currently, tags are only be executed for already parsed
  82         // character ids. This is known to be wrong: a more accurate
  83         // description is:
  84         //
  85         // The DoInitAction tag is executed only for characters on the stage
  86         // or exported characters. It is only executed once.
  87         //
  88         // It's not known whether characters that were placed on the stage
  89         // but then removed before the InitAction tag is encountered cause
  90         // the actions to be executed.
  91         //
  92         // Gnash currently doesn't know which characters are on the stage, or
  93         // which IDs have been exported.
  94         boost::intrusive_ptr<ControlTag> da(new DoInitActionTag(in, m, cid));
  95         m.addControlTag(da); // ownership transferred
  96     }
  97
  98 private:
  99
 100     /// Read a DoInitAction block from the SWFStream
 101     //
 102     void read(SWFStream& in)
 103     {
 104         _buf.read(in, in.get_tag_end_position());
 105     }
 106
 107
 108     action_buffer _buf;
 109
 110     // id of referenced DisplayObject definition
 111     int _cid;
 112 };
 113
 114 } // namespace gnash::SWF
 115 } // namespace gnash
 116
 117
 118 #endif // GNASH_SWF_DOINITACTIONTAG_H
 119
 120
 121 // Local Variables:
 122 // mode: C++
 123 // indent-tabs-mode: t
 124 // End:
 125