Merge pull request #1671 from livecode/bugfix-20046

[Bug 20046]  Interactive Tutorial: Make copy script / apply script into separate steps

Author: livecodepanos

Toolset/palettes/script editor/behaviors/revsestackbehavior.livecodescript

@@ -797,6 +797,17 @@ end seGetObjectState
 #   Stores the specified state for the object for later use. And updates any
 #   script editor components that may depend on this information.
 command seSetObjectState pObject, pState
+   if pState is "edited" then
+      local tObj
+      put the long id of pObject into tObj
+      if not revIDEObjectIsOnIDEStack(tObj) then
+         local tParams
+         put the text of field "Script" into tParams[1]
+         put tObj into tParams[2]
+         send "ideMessageSendWithParameters" && "ideScriptEdited, tObj, tParams" to stack "revIDELibrary" in 0 milliseconds
+      end if
+   end if
+   
    # Small optimization, if pState is equal to the current state, don't do anything
    if pState is sObjectStates[seGetRuggedId(pObject)] then
       exit seSetObjectState

Toolset/palettes/tutorial/revtutorial.livecodescript

@@ -2111,11 +2111,11 @@ on revTutorialDoLoad pLesson
    revTutorialRunTutorial tTutorialInfo["course"], tTutorialInfo["tutorial"], pLesson, tTutorialInfo["location"]
 end revTutorialDoLoad
 
-on revTutorialSetText pStep
-   revTutorialConfigureMessage sSteps[pStep]
+on revTutorialSetText pStep, pTopLeft
+   revTutorialConfigureMessage sSteps[pStep], pTopLeft
 end revTutorialSetText
 
-on revTutorialConfigureMessage pData
+on revTutorialConfigureMessage pData, pTopLeft
    local tWidthOverride
    put kMessageWidth into tWidthOverride
    set the width of field "Message" of stack "revTutorial" to kMessageWidth
@@ -2170,7 +2170,7 @@ on revTutorialConfigureMessage pData
       end if
    end if
 
-   revTutorialPositionStack "", "", tWidthOverride, false
+   revTutorialPositionStackForHighlight pTopLeft, tWidthOverride
 end revTutorialConfigureMessage
 
 function revTutorialImageForScreenSize pImage
@@ -2447,21 +2447,26 @@ function revTutorialCheckWaitCondition pActionData, pBeforeDisplay
                end if
                break
             case "scripted"
-               # If the script hasn't changed then don't do anything.
-               if revTutorialScriptIs(the script of tObject, sWait["current script"]) then
+               # This code path is triggered by any propertyChanged message,
+               # so if the script hasn't changed then don't do anything.
+               local tScript
+               put the script of tObject into tScript
+               if tScript is sWait["current script"] then
                   break
                end if
-               if revTutorialObjectPropertyIsValue(tObject, "script", pActionData["script"], false) then
+               local tMistake
+               revTutorialCompareScript tScript, pActionData["script"]
+               put the result into tMistake
+               if tMistake is empty then
                   return true
-               else if sWait["current script"] is not empty then
-                  add 1 to sWait["incorrect attempts"]
-                  put the script of tObject into sWait["current script"]
-                  # Show the current script and the target script in the tip stack
-                  local tData
-                  put revTutorialScriptRetry(sWait["current script"]) into tData["text"]
-                  put pActionData["script"] into tData["script"]
-                  revTutorialConfigureMessage tData
                end if
+               put tScript into sWait["current script"]
+               add 1 to sWait["incorrect attempts"]
+               # Show the current script and the target script in the tip stack
+               local tData
+               put revTutorialScriptRetry(tMistake) into tData["text"]
+               put pActionData["script"] into tData["script"]
+               revTutorialConfigureMessage tData, revTutorialGetEffectiveTopLeft()
                break
          end switch
          break
@@ -2483,6 +2488,7 @@ on revTutorialWaitUntilObjectIsScripted pTaggedObject
    revTutorialSetSEPreference "explicitVariables", false
 
    revIDESubscribe "idePropertyChanged", tObjID
+   revIDESubscribe "ideScriptEdited"
 end revTutorialWaitUntilObjectIsScripted
 
 on revTutorialWaitUntilObjectIsClicked
@@ -3058,6 +3064,52 @@ on idePropertyChanged pObject
    end if
 end idePropertyChanged
 
+local sScriptCheck
+on revTutorialCheckScript pScript, pObject
+   if revTutorialObjectIsTaggedObject(pObject, sWait["object"]) then
+      if sWait["wait condition"] is "state" and \
+            sWait["state"] is "scripted" then
+         revTutorialCompareScript pScript, sWait["script"]
+         lock screen
+         if the result is empty and sWait["correct script"] is not true then
+            -- If the currently typed script is correct, then
+            -- remind about clicking Apply
+            -- Remember the chosen location
+            put revTutorialGetEffectiveTopLeft() into sScriptCheck["topleft"]
+            put true into sScriptCheck["correct script"]
+            put "Apply" into sHighlight["object"]
+            put "object" into sHighlight["type"]
+            local tData
+            put "Click 'Apply' to apply the script" into tData["text"]
+            revTutorialConfigureMessage tData
+         else if sScriptCheck["correct script"] is true then
+            -- Otherwise, the script has been changed from the correct one
+            put false into sScriptCheck["correct script"]
+            -- Reset the highlight
+            put "stack" into sHighlight["type"]
+            -- Reset the text
+            revTutorialSetText sStepName, sScriptCheck["topleft"]
+         end if
+         unlock screen
+      end if
+   end if
+end revTutorialCheckScript
+
+local sCheckScriptMsg
+constant kCheckBufferMS = 800
+on ideScriptEdited pScript, pObject
+   -- In order to mitigate against forgetting to press the
+   -- apply button, we subscribe to ideScriptEdited and check
+   -- to see if the script entered is correct. However, we 
+   -- don't want to interrupt the flow of typing, so add a
+   -- buffer
+   if sCheckScriptMsg is not empty then
+      cancel sCheckScriptMsg
+   end if
+   send "revTutorialCheckScript pScript, pObject" to me in kCheckBufferMS millisecs
+   put the result into sCheckScriptMsg
+end ideScriptEdited
+
 on ideStackMoved pStack
    local tStack
    put revIDEStackOfObject(pStack) into tStack
@@ -3345,32 +3397,32 @@ function revTutorialObjectIsHighlighted pObject
    return false
 end revTutorialObjectIsHighlighted
 
-on revTutorialPositionStackForHighlight pTopLeft
+on revTutorialPositionStackForHighlight pTopLeft, pWidthOverride
    lock screen
    switch sHighlight["type"]
       case "guide"
-         revTutorialPositionStack "", sGuides[sHighlight["guide"]], "", "", pTopLeft
+         revTutorialPositionStack "", sGuides[sHighlight["guide"]], pWidthOverride, "", pTopLeft
          break
       case "property"        
-         revTutorialPositionStack "inspector", sHighlight, "", "", pTopLeft
+         revTutorialPositionStack "inspector", sHighlight, pWidthOverride, "", pTopLeft
          break
       case "menu"
-         revTutorialPositionStack "menubar", sHighlight["menu"], "", "", pTopLeft
+         revTutorialPositionStack "menubar", sHighlight["menu"], pWidthOverride, "", pTopLeft
          break
       case "toolbar"
-         revTutorialPositionStack "menubar", sHighlight["item"], "", "", pTopLeft
+         revTutorialPositionStack "menubar", sHighlight["item"], pWidthOverride, "", pTopLeft
          break
       case "tool"
-         revTutorialPositionStack "tools", sHighlight["tool"], "", "", pTopLeft
+         revTutorialPositionStack "tools", sHighlight["tool"], pWidthOverride, "", pTopLeft
          break
       case "object"  
-         revTutorialPositionStack sHighlight["stack"], sHighlight["object"], "", sHighlight["line"] is not empty, pTopLeft
+         revTutorialPositionStack sHighlight["stack"], sHighlight["object"], pWidthOverride, sHighlight["line"] is not empty, pTopLeft
          break
       case "stack"
-         revTutorialPositionStack sHighlight["stack"], "", "", "", pTopLeft
+         revTutorialPositionStack sHighlight["stack"], "", pWidthOverride, "", pTopLeft
          break
       default
-         revTutorialPositionStack "", "", "", "", pTopLeft
+         revTutorialPositionStack "", "", pWidthOverride, "", pTopLeft
          break
    end switch
    unlock screen
@@ -3534,7 +3586,8 @@ function revTutorialObjectPropertyIsValue pObjectIDs, pProperty, pValue, pIsNot
             return false
          end if
       else if pProperty is "script" then
-         if revTutorialScriptIs(the script of tObject, pValue) is pIsNot then
+         revTutorialCompareScript the script of tObject, pValue
+         if (the result is empty) is pIsNot then
             return false
          end if
       else if pProperty is "name" then
@@ -3595,19 +3648,61 @@ on revTutorialSnapObjectToGuide pObject, pGuide
    unlock screen
 end revTutorialSnapObjectToGuide
 
+private function revTutorialGetMistake pObjScript, pTokenNum, pReadToken, pTargetToken
+   lock messages
+   local tDefaultStack
+   put the defaultStack into tDefaultStack
+   set the defaultStack to "revTutorial"
+   create invisible field "script_tester"
+   put pObjScript into field "script_tester"
+   
+   local tCharIndex, tLineIndex, tLineChars
+   put the lineIndex of token pTokenNum of field "script_tester" into tLineIndex
+   put the charIndex of token pTokenNum of field "script_tester" into tCharIndex
+   put the number of chars in line 0 to tLineIndex - 1 \ 
+         of field "script_tester" into tLineChars
+   subtract tLineChars from tCharIndex
+   
+   local tMistake
+   if pTargetToken is not empty then 
+      put merge(quote & "[[pReadToken]]" & quote && \
+            "instead of" && quote & "[[pTargetToken]]" & quote && \
+            "at char [[tCharIndex]] of line [[tLineIndex]]") into tMistake
+   else
+      put merge("Unexpected additional script" && \
+            quote & "[[pReadToken]]" & quote && \
+            "at char [[tCharIndex]] of line [[tLineIndex]]") into tMistake
+   end if
+   delete field "script_tester"
+   set the defaultStack to tDefaultStack
+   unlock messages
+   return tMistake
+end revTutorialGetMistake
+
 // In the future we might want to add a bit more "approximity" to this.
-function revTutorialScriptIs pObjScript, pTargetScript
-   local tObjTokens, tTargetTokens
-   repeat for each token tToken in pObjScript
-      put tToken & " " after tObjTokens
+command revTutorialCompareScript pObjScript, pTargetScript
+   local tTokenNum, tMistake, tToken
+   repeat for each token tTargetToken in pTargetScript
+      add 1 to tTokenNum
+      put token tTokenNum of pObjScript into tToken
+      if tTargetToken is not tToken then
+         put revTutorialGetMistake(pObjScript, tTokenNum, tToken, tTargetToken) \
+               into tMistake
+         exit repeat
+      end if
    end repeat
 
-   repeat for each token tToken in pTargetScript
-      put tToken & " " after tTargetTokens
-   end repeat
+   if tMistake is empty then
+      add 1 to tTokenNum
+      put token tTokenNum of pObjScript into tToken
+      if tToken is not empty then
+         put revTutorialGetMistake(pObjScript, tTokenNum, tToken, empty) \
+               into tMistake
+      end if
+   end if
 
-   return tObjTokens is tTargetTokens
-end revTutorialScriptIs
+   return tMistake
+end revTutorialCompareScript
 
 constant kColorTolerance = 10
 function revTutorialColorIs pColor, pTarget

notes/bugfix-20044.md

@@ -0,0 +1 @@
+# Detect specific errors in user scripts in tutorial

notes/bugfix-20046.md

@@ -0,0 +1 @@
+# Ensure there are separate scripting / apply steps in tutorial

notes/feature-ide_script_edited.md

@@ -0,0 +1,10 @@
+# ideScriptEdited message
+
+A new IDE message has been added:
+
+    ideScriptEdited pScript, pObj
+
+This message is sent when the script of an object as displayed
+in the script editor is changed. pScript contains the current
+contents of the script editor field for pObj, which, until applied, 
+is not necessarily the same as `the script of pObj`.