[[ Revert Command ]] Add revert stack syntax

livecodeali · livecodeali · commit 535a1ba7c167 · 2016-06-06T11:13:09.000+01:00
diff --git a/docs/dictionary/command/revert.lcdoc b/docs/dictionary/command/revert.lcdoc
@@ -2,9 +2,10 @@ Name: revert
 
 Type: command
 
-Syntax: revert
+Syntax: revert [<targetStack>]
 
-Summary: Restores the <current stack> to its state when last saved, deleting all changes made since the last save.
+Summary: Restores a stack to its state when last saved, deleting all 
+changes made since the last save.
 
 Introduced: 1.0
 
@@ -16,13 +17,28 @@ Example:
 revert
 
 Example:
-if it is "Don't Save" then revert
+revert stack "MyStack"
 
-Description:
-Use the <revert> <command> to back out of any changes made to the <current stack> since the last save.
+Parameters:
 
-The <revert> <command> also <undo|undoes> changes made to other <stacks> stored in the same <stack file>. That is, if you <revert> a <main stack>, all <substacks> of that <stack> also revert to the last save, and if you revert a <substack>, its <main stack> and any other <substacks> also revert.
+targetStack: An optional stack reference.
 
-References: substacks (property), mainStack (property), revRollBackDatabase (command), reset paint (command), revdb_rollback (function), stacks (function), substack (glossary), stack file (glossary), current stack (glossary), command (glossary), undo (glossary), main stack (glossary), stack (object)
+Description:
+Use the <revert> <command> to back out of any changes made to a stack 
+since the last save.
+
+If no <targetStack> is specified, the <revert> command acts on the 
+<current stack>.
+
+The <revert> <command> also <undo|undoes> changes made to other <stacks> 
+stored in the same <stack file>. That is, if you <revert> a <main stack>, 
+all <substacks> of that <stack> also revert to the last save, and if you 
+revert a <substack>, its <main stack> and any other <substacks> also 
+revert.
+
+References: substacks (property), mainStack (property), 
+stacks (function), substack (glossary), 
+stack file (glossary), current stack (glossary), command (glossary), 
+undo (glossary), main stack (glossary), stack (object)
 
 Tags: file system
diff --git a/engine/src/cmds.h b/engine/src/cmds.h
@@ -871,9 +871,13 @@ class MCReplace : public MCStatement
 
 class MCRevert : public MCStatement
 {
+    MCChunk *stack;
 public:
-	virtual void exec_ctxt(MCExecContext &);
-	virtual void compile(MCSyntaxFactoryRef);
+    MCRevert() : stack(NULL) {}
+    virtual ~MCRevert();
+    virtual Parse_stat parse(MCScriptPoint &);
+    virtual void exec_ctxt(MCExecContext &ctxt);
+    virtual void compile(MCSyntaxFactoryRef);
 };
 
 class MCRotate : public MCStatement
diff --git a/engine/src/cmdsc.cpp b/engine/src/cmdsc.cpp
@@ -3590,6 +3590,31 @@ void MCReplace::compile(MCSyntaxFactoryRef ctxt)
 	MCSyntaxFactoryEndStatement(ctxt);
 }
 
+MCRevert::~MCRevert()
+{
+    delete stack;
+}
+
+Parse_stat MCRevert::parse(MCScriptPoint &sp)
+{
+    initpoint(sp);
+    Symbol_type type;
+    if (sp.next(type) == PS_EOL)
+        return PS_NORMAL;
+    
+    // Otherwise backup and parse a chunk
+    sp.backup();
+    stack = new MCChunk(False);
+    if (stack->parse(sp, False) != PS_NORMAL)
+    {
+        MCperror->add(PE_REVERT_BADSTACK, sp);
+        return PS_ERROR;
+    }
+    
+    return PS_NORMAL;
+}
+
+
 void MCRevert::exec_ctxt(MCExecContext& ctxt)
 {
 #ifdef /* MCRevert */ LEGACY_EXEC
@@ -3621,15 +3646,36 @@ void MCRevert::exec_ctxt(MCExecContext& ctxt)
 	}
 	return ES_NORMAL;
 #endif /* MCRevert */
-
-	MCInterfaceExecRevert(ctxt);
+    
+    if (stack != nil)
+    {
+        MCObject *t_object;
+        uint4 parid;
+        
+        if (!stack->getobj(ctxt, t_object, parid, True))
+        {
+            ctxt . LegacyThrow(EE_SAVE_NOTARGET);
+            return;
+        }
+        
+        MCInterfaceExecRevertStack(ctxt, t_object);
+    }
+    else
+        MCInterfaceExecRevert(ctxt);
 }
 
 void MCRevert::compile(MCSyntaxFactoryRef ctxt)
 {
 	MCSyntaxFactoryBeginStatement(ctxt, line, pos);
 
-	MCSyntaxFactoryExecMethod(ctxt, kMCInterfaceExecRevertMethodInfo);
+    if (stack != nil)
+    {
+        stack -> compile_object_ptr(ctxt);
+        
+        MCSyntaxFactoryExecMethod(ctxt, kMCInterfaceExecRevertStackMethodInfo);
+    }
+    else
+        MCSyntaxFactoryExecMethod(ctxt, kMCInterfaceExecRevertMethodInfo);
 
 	MCSyntaxFactoryEndStatement(ctxt);
 }
diff --git a/engine/src/exec-interface.cpp b/engine/src/exec-interface.cpp
@@ -162,6 +162,7 @@ MC_EXEC_DEFINE_EXEC_METHOD(Interface, RemoveGroupFromCard, 2)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, ResetCursors, 0)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, ResetTemplate, 1)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, Revert, 0)
+MC_EXEC_DEFINE_EXEC_METHOD(Interface, RevertStack, 1)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, SelectEmpty, 0)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, SelectAllTextOfField, 1)
 MC_EXEC_DEFINE_EXEC_METHOD(Interface, SelectAllTextOfButton, 1)
@@ -1930,32 +1931,55 @@ void MCInterfaceExecUndo(MCExecContext& ctxt)
 
 ////////////////////////////////////////////////////////////////////////////////
 
+static void MCInterfaceRevertStack(MCExecContext& ctxt, MCStack *p_stack)
+{
+    MCAssert(p_stack != nil);
+    
+    Window_mode oldmode = p_stack->getmode();
+    MCRectangle oldrect = p_stack->getrect();
+    
+    if (!MCdispatcher->ismainstack(p_stack))
+        p_stack = (MCStack *)p_stack->getparent();
+    if (p_stack == MCdispatcher->gethome())
+    {
+        ctxt . LegacyThrow(EE_REVERT_HOME);
+        return;
+    }
+    
+    MCAutoStringRef t_filename;
+    p_stack -> getstringprop(ctxt, 0, P_FILE_NAME, False, &t_filename);
+    
+    MCNewAutoNameRef t_name;
+    if (!MCNameCreate(*t_filename, &t_name))
+        return;
+    
+    Boolean oldlock = MClockmessages;
+    MClockmessages = True;
+    MCerrorlock++;
+    if (p_stack->del())
+        p_stack -> scheduledelete();
+    MCerrorlock--;
+    MClockmessages = oldlock;
+
+    p_stack = MCdispatcher->findstackname(*t_name);
+    if (p_stack != NULL)
+        p_stack->openrect(oldrect, oldmode, NULL, WP_DEFAULT, OP_NONE);
+}
+
 void MCInterfaceExecRevert(MCExecContext& ctxt)
 {
-	Window_mode oldmode = MCtopstackptr->getmode();
-	MCRectangle oldrect = MCtopstackptr->getrect();
-	MCStack *t_sptr = MCtopstackptr;
-	if (!MCdispatcher->ismainstack(t_sptr))
-		t_sptr = (MCStack *)t_sptr->getparent();
-	if (t_sptr == MCdispatcher->gethome())
-	{
-		ctxt . LegacyThrow(EE_REVERT_HOME);
-		return;
-	}
-	MCAutoStringRef t_filename;
-	t_sptr->getstringprop(ctxt, 0, P_FILE_NAME, False, &t_filename);
-	Boolean oldlock = MClockmessages;
-	MClockmessages = True;
-	MCerrorlock++;
-    if (t_sptr->del())
-        t_sptr -> scheduledelete();
-	MCerrorlock--;
-	MClockmessages = oldlock;
-	MCNewAutoNameRef t_name;
-	/* UNCHECKED */ MCNameCreate(*t_filename, &t_name);
-	t_sptr = MCdispatcher->findstackname(*t_name);
-	if (t_sptr != NULL)
-		t_sptr->openrect(oldrect, oldmode, NULL, WP_DEFAULT, OP_NONE);
+    MCInterfaceRevertStack(ctxt, MCtopstackptr);
+}
+
+void MCInterfaceExecRevertStack(MCExecContext& ctxt, MCObject *p_stack)
+{
+    if (p_stack == nil || p_stack->gettype() != CT_STACK)
+    {
+        ctxt . LegacyThrow(EE_REVERT_NOSTACK);
+        return;
+    }
+
+    MCInterfaceRevertStack(ctxt, (MCStack *)p_stack);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
diff --git a/engine/src/exec.h b/engine/src/exec.h
@@ -2494,6 +2494,7 @@ extern MCExecMethodInfo *kMCInterfaceExecRemoveGroupFromCardMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecResetCursorsMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecResetTemplateMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecRevertMethodInfo;
+extern MCExecMethodInfo *kMCInterfaceExecRevertStackMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecSelectEmptyMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecSelectAllTextOfFieldMethodInfo;
 extern MCExecMethodInfo *kMCInterfaceExecSelectAllTextOfButtonMethodInfo;
@@ -3008,6 +3009,7 @@ void MCInterfaceExecResetCursors(MCExecContext& ctxt);
 void MCInterfaceExecResetTemplate(MCExecContext& ctxt, Reset_type type);
 
 void MCInterfaceExecRevert(MCExecContext& ctxt);
+void MCInterfaceExecRevertStack(MCExecContext& ctxt, MCObject *p_stack);
 
 void MCInterfaceExecSelectEmpty(MCExecContext& ctxt);
 void MCInterfaceExecSelectAllTextOfField(MCExecContext& ctxt, MCObjectPtr target);
diff --git a/engine/src/executionerrors.h b/engine/src/executionerrors.h
@@ -2709,7 +2709,10 @@ enum Exec_errors
 	EE_INVOKE_TOOMANYARGS,
     
     // {EE-0887} Stack: script only stacks can not be password protected
-    EE_SCRIPT_ONLY_STACK_NOPASSWORD
+    EE_SCRIPT_ONLY_STACK_NOPASSWORD,
+    
+    // {EE-0888} revert: can't find stack
+    EE_REVERT_NOSTACK
 };
 
 extern const char *MCexecutionerrors;
diff --git a/engine/src/parseerrors.h b/engine/src/parseerrors.h
@@ -1756,6 +1756,9 @@ enum Parse_errors
 	
 	// {PE-0569} replace: missing 'styles'
 	PE_REPLACE_NOSTYLES,
+    
+    // {PE-0570} revert: bad stack expression
+    PE_REVERT_BADSTACK,
 	
 };
 
