[Gnash-commit] gnash ChangeLog server/vm/ActionExec.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/11/23 07:26:29

Modified files:
        .              : ChangeLog 
        server/vm      : ActionExec.h 

Log message:
        document cleanupAfterRun.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.4931&r2=1.4932
http://cvs.savannah.gnu.org/viewcvs/gnash/server/vm/ActionExec.h?cvsroot=gnash&r1=1.25&r2=1.26

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.4931
retrieving revision 1.4932
diff -u -b -r1.4931 -r1.4932
--- ChangeLog   23 Nov 2007 02:29:01 -0000      1.4931
+++ ChangeLog   23 Nov 2007 07:26:29 -0000      1.4932
@@ -1,3 +1,7 @@
+2007-11-23 Sandro Santilli <address@hidden>
+
+       * server/vm/ActionExec.h: document cleanupAfterRun.
+
 2007-11-23 Zou Lunkai <address@hidden>
 
        * testsuite/misc-ming.all/Makefile.am, loop_test10.c: file a new

Index: server/vm/ActionExec.h
===================================================================
RCS file: /sources/gnash/gnash/server/vm/ActionExec.h,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -b -r1.25 -r1.26
--- server/vm/ActionExec.h      2 Oct 2007 15:44:51 -0000       1.25
+++ server/vm/ActionExec.h      23 Nov 2007 07:26:29 -0000      1.26
@@ -118,6 +118,25 @@
 
        /// Run after a complete run, or after an run interrupted by 
        /// a bail-out exception (ActionLimitException, for example)
+       //
+       /// The method restores original target of the as_environment,
+       /// checks for stack smashing (stack contains less entries
+       /// then it had at time of execution start) or leftovers
+       /// (stack contains more entries then it had at time of execution
+       /// start) and finally gives movie_root a chance to execute
+       /// actions queued in higher priority action queues.
+       ///
+       /// The higher priority action queue flush is needed to allow
+       /// initialize/construct/initactions queued by effect of gotoFrame
+       /// calls in DOACTION block before frame actions queued by the same
+       /// cause (the latter would be pushed in the same level gotoFrame is
+       /// found)
+       ///
+       /// @param expectInconsistencies
+       ///     If true, don't print an error if stack is bigger or smaller
+       ///     then we expect. The parameter is used when calling the
+       ///     cleanup function due to a thrown ActionLimitException.
+       ///
        void cleanupAfterRun(bool expectInconsistencies=false);
 
        /// the 'with' stack associated with this execution thread