[[ SosBehavior ]] Serialize behavior in script-only-stack format

runrevmark · runrevmark · commit 15140707897b · 2018-01-23T10:29:00.000Z
This patch adds a 'with behavior' clause to the header of a script
only stack.

The clause is emitted if the stack has a behavior property which
references a stack.

When a script-only-stack with such a clause is loaded, the behavior
is set as part of the loading.
diff --git a/engine/src/dispatch.cpp b/engine/src/dispatch.cpp
@@ -56,6 +56,7 @@ along with LiveCode.  If not see <http://www.gnu.org/licenses/>.  */
 #include "stacksecurity.h"
 #include "scriptpt.h"
 #include "widget-events.h"
+#include "parentscript.h"
 
 #include "exec.h"
 #include "exec-interface.h"
@@ -716,6 +717,28 @@ static MCStack* script_only_stack_from_bytes(uint8_t *p_bytes,
         return nullptr;
     }
     
+    // If 'with' is next then parse the behavior reference.
+    MCNewAutoNameRef t_behavior_name;
+    if (sp.skip_token(SP_REPEAT, TT_UNDEFINED, RF_WITH) == PS_NORMAL)
+    {
+        // Ensure 'behavior' is next 
+        if (sp.skip_token(SP_FACTOR, TT_PROPERTY, P_PARENT_SCRIPT) != PS_NORMAL)
+        {
+            return nullptr;
+        }
+        
+        // Read the behavior name
+        if (sp.next(t_type) != PS_NORMAL || t_type != ST_LIT)
+        {
+            return nullptr;
+        }
+        
+        if (!MCNameClone(sp.gettoken_nameref(), &t_behavior_name))
+        {
+            return nullptr;
+        }
+    }
+
     // Parse end of line.
     Parse_stat t_stat;
     t_stat = sp . next(t_type);
@@ -763,6 +786,12 @@ static MCStack* script_only_stack_from_bytes(uint8_t *p_bytes,
     // Set its name.
     t_stack -> setname(*t_script_name);
     
+    // If we parsed a behavior reference, then set it.
+    if (*t_behavior_name != nullptr)
+    {
+        t_stack->setparentscript_onload(0, *t_behavior_name);
+    }
+    
     return t_stack;
 }
 
@@ -1142,8 +1171,22 @@ IO_stat MCDispatch::dosavescriptonlystack(MCStack *sptr, const MCStringRef p_fna
         // Ensure script isn't encrypted if a password was removed in session
         sptr -> unsecurescript(sptr);
         
-        // Write out the standard script stack header, and then the script itself
-		MCStringFormat(&t_script_body, "script \"%@\"\n%@", sptr -> getname(), sptr->_getscript());
+        // Write out the standard script stack header with behavior reference 
+        // (if applicable) and then the script itself
+        MCParentScript *t_parent_script = sptr->getparentscript();
+        if (t_parent_script != nullptr &&
+            t_parent_script->GetObjectId() == 0)
+        {
+            MCStringFormat(&t_script_body,
+                           "script \"%@\" with behavior \"%@\"\n%@",
+                           sptr->getname(),
+                           t_parent_script->GetObjectStack(),
+                           sptr->_getscript());
+        }
+        else
+        {
+            MCStringFormat(&t_script_body, "script \"%@\"\n%@", sptr -> getname(), sptr->_getscript());
+        }
 
 		// Convert line endings - but only if the native line ending isn't CR!
 #ifndef __CR__
diff --git a/engine/src/object.cpp b/engine/src/object.cpp
@@ -4051,12 +4051,11 @@ IO_stat MCObject::extendedload(MCObjectInputStream& p_stream, uint32_t version,
 
 		if (t_stat == IO_NORMAL)
 		{
-			parent_script = MCParentScript::Acquire(this, t_id, t_stack);
-			if (parent_script == NULL)
-				t_stat = IO_ERROR;
-
-			s_loaded_parent_script_reference = true;
-		}
+            if (!setparentscript_onload(t_id, t_stack))
+            {
+                t_stat = IO_ERROR;
+            }
+        }
 
 		MCNameDelete(t_stack);
 	}
@@ -4134,6 +4133,18 @@ IO_stat MCObject::extendedload(MCObjectInputStream& p_stream, uint32_t version,
 	return t_stat;
 }
 
+bool MCObject::setparentscript_onload(uint32_t p_id, MCNameRef p_stack)
+{
+    parent_script = MCParentScript::Acquire(this, p_id, p_stack);
+    if (parent_script == NULL)
+    {
+        return false;
+    }
+    
+    s_loaded_parent_script_reference = true;
+    
+    return true;
+}
 
 // MW-2008-10-28: [[ ParentScripts ]] This method attempts to resolve the
 //   parentscript reference for this object (if any).
diff --git a/engine/src/object.h b/engine/src/object.h
@@ -971,6 +971,10 @@ class MCObject :
 	// is no parentScript, it returns NULL - note that this is an MCParentScript,
 	// not an MCParentScriptUse.
 	MCParentScript *getparentscript(void) const;
+    
+    // Set the parentScript of the object at load time of it (used by the script
+    // only stack loader).
+    bool setparentscript_onload(uint32_t p_id, MCNameRef p_stack);
 
 	// MW-2009-01-28: [[ Inherited parentScripts ]]
 	// This method returns false if there was not enough memory to complete the
