[[ Bug 20851 ]] Fix case/break completion

This patch fixes the completion of `case` statements with `break` where
an existing `break` statement already exists. The depth was not being
calculated correctly so that if multiple `switch` structures were in the
same script the second and subsequent structures added extra `break`
statements when hitting return after the `case` statement.

Additionally this patch ensures that `case` is only completed with `break`
if there is no other code for the case as it is unhelpful to put `break`
before the code under any circumstances.

Author: montegoulding

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

@@ -1807,6 +1807,11 @@ private function autoCompleteSearchContext @pScript, pLineNumber, pStructureType
       return 1
    end if
 
+   -- case can't be nested except within another switch so return 0
+   if pStructureType is "case" then
+      return 1
+   end if
+   
    local tDepth
    put 0 into tDepth
    repeat with x = pLineNumber down to 1
@@ -1854,6 +1859,19 @@ function autoCompleteCompletionRequired pLineNumber, pStructureType, pStructureN
             # The structure is already completed
             return false
          end if
+      else if pStructureType is "case" then
+         # special case `case` so it behaves sensibly
+         if (token 1 of tLine is "end" and token 2 of tLine is "switch") or \
+               token 1 of tLine is "case" or \
+               token 1 of tLine is "default" then
+            # if the switch structure ends then we need a break
+            return true
+         else if token 1 of tLine is not empty then
+            # if there's existing code within the case then we
+            # can reasonably assume that they don't want to put a break
+            # above it
+            return false
+         end if
       else if token 1 of tLine is "end" and token 2 of tLine is not among the items of autoCompleteUnnamedStructures() and token 2 of tLine is not "if" then
          # If a named structure is ending, but it doesn't match the structure we are looking for
          # then if the structure we're looking for is un-named, we return true

notes/bugfix-20851.md

@@ -0,0 +1 @@
+# Fix adding `break` after `case` in switch control structure when one exists