[[ Bug 20070 ]] Add SE preference for showing default handlers

This patch tweaks the Handler menu of the script editor to add
Go to handler..., Add default handler... submenus, and a
Show default handlers preference toggle.

Author: livecodeali

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

@@ -140,7 +140,9 @@ command update
    put the result into tHandlers
 
    local tDefaultHandlers, tIndex
-   put revSEDefaultHandlers() into tDefaultHandlers
+   if sePrefGet("editor,showDefaultHandlers") then
+      put revSEDefaultHandlers() into tDefaultHandlers
+   end if
    set the wholematches to false
 
    local tCanAdd
@@ -282,28 +284,30 @@ command jumpToHandler pHandler, pAdded
    hideGroup
 end jumpToHandler
 
-command closeAccept
-   lock screen
-   local tHandler
-   put line (the hilitedLine of field "Handlers" of me) of the cHandlers of field "Handlers" of me into tHandler
-   
+command handlerPicked pHandler
    local tAdded
    put false into tAdded
-   if the number of words in tHandler is 1 then
+   if the number of words in pHandler is 1 then
       put true into tAdded
       -- Adding a default handler
-      revSEAddDefaultHandler tHandler
+      revSEAddDefaultHandler pHandler
       update
       set the wholematches to false
       local tLine
-      put lineOffset(tHandler, the cHandlers of field "Handlers" of me) into tLine
+      put lineOffset(pHandler, the cHandlers of field "Handlers" of me) into tLine
       select line tLine of field "Handlers" of me
-      put line tLine of the cHandlers of field "Handlers" of me into tHandler
+      put line tLine of the cHandlers of field "Handlers" of me into pHandler
    end if
 
    -- Select the (now) extant handler
-   jumpToHandler tHandler, tAdded
-   
+   jumpToHandler pHandler, tAdded
+end handlerPicked
+
+command closeAccept
+   lock screen
+   local tHandler
+   put line (the hilitedLine of field "Handlers" of me) of the cHandlers of field "Handlers" of me into tHandler
+   handlerPicked tHandler
    unlock screen
 end closeAccept
 

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

@@ -275,18 +275,41 @@ private command buildHandlerMenu pContext
 
    local tFormattedHandlers
    repeat for each line tHandler in tHandlers
-      put word 2 of tHandler & return after tFormattedHandlers
+      put tab & word 2 of tHandler & return after tFormattedHandlers
    end repeat
    delete the last char of tFormattedHandlers
 
-   if the number of lines of tHandlers = 0 then
-      put "(No Handlers" into tFormattedHandlers
-      set the cHandlers of me to empty
+   local tDefaultHandlers
+   put revSEDefaultHandlers() into tDefaultHandlers
+   
+   local tFormattedDefaultHandlers
+   repeat for each line tHandler in tDefaultHandlers
+      put tab & tHandler & return after tFormattedDefaultHandlers
+   end repeat
+   delete the last char of tFormattedDefaultHandlers
+   
+   local tShowDefaultHandlers
+   dispatch function "sePrefGet" to me with "editor,showDefaultHandlers"
+   put the result into tShowDefaultHandlers
+   
+   local tMenu
+   if tHandlers is not empty then
+      put enableMenuItem("Go to handler...", true) into tMenu
+      put return & tFormattedHandlers after tMenu
    else
-      set the cHandlers of me to tHandlers
+      put enableMenuItem("Go to handler...", false) into tMenu
    end if
+   if tDefaultHandlers is not empty then
+      put return & enableMenuItem("Add default handler...", true) after tMenu
+      put return & tFormattedDefaultHandlers after tMenu
+   else
+      put return & enableMenuItem("Add default handler...", false) after tMenu
+   end if
+   put return & toggleMenuItem("Show default handlers", tShowDefaultHandlers) after tMenu
+   
+   set the cHandlers of me to tHandlers
 
-   set the text of button "Handler" of me to modifyMenu("Handler", tFormattedHandlers)
+   set the text of button "Handler" of me to modifyMenu("Handler", tMenu)
 end buildHandlerMenu
 
 on menuPick pItemName
@@ -321,15 +344,31 @@ private command handleHandlerMenuPick pItemName
       exit handleHandlerMenuPick
    end if
 
-   local tLineNumber
-   put the menuHistory of button "Handler" of me into tLineNumber
-   
-   local tHandler
-   put line tLineNumber of the cHandlers of me into tHandler
+   set the itemdelimiter to "|"
+   switch item 1 of pItemName
+      case "Go to handler..."
+         local tPick, tHandlerInfo
+         put item 2 of pItemName into tPick
+         if not matchText(the cHandlers of me, "(.* " & tPick & " .*)", \
+               tHandlerInfo) then
+            exit handleHandlerMenuPick
+         end if
+
+         dispatch "handlerPicked" to group "Left Handler List" \
+               with tHandlerInfo
+         break
+      case "Add default handler..."
+         dispatch "handlerPicked" to group "Left Handler List" \
+               with item 2 of pItemName
+         break
+      case "Show default handlers"
+         local tShowDefaultHandlers
+         dispatch function "sePrefGet" to me with "editor,showDefaultHandlers"
+         put the result into tShowDefaultHandlers
+         dispatch "sePrefSet" to me with "editor,showDefaultHandlers", not tShowDefaultHandlers
+         break
+   end switch
 
-   local tScriptLineNumber
-   put word 3 of tHandler into tScriptLineNumber
-   send "goLine tScriptLineNumber, true" to group "Editor"
    seUpdateLeftBar
    seUpdateToolbar
 end handleHandlerMenuPick
@@ -511,6 +550,20 @@ end handleHelpMenuPick
 
 #########
 
+private function toggleMenuItem pItem, pHilited
+   if pHilited then
+      return "!c" & pItem
+   end if
+   return "!n" & pItem
+end toggleMenuItem
+
+private function enableMenuItem pItem, pEnabled
+   if pEnabled then
+      return pItem
+   end if
+   return "(" & pItem
+end enableMenuItem
+
 private function modifyMenu pMenuName, pMenu
    if the last char of pMenu is not return then
       put return after pMenu

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

@@ -659,6 +659,8 @@ command sePrefGetDefaults
 
    put 7 into tPrefs["print,textSize"]
 
+   put true into tPrefs["editor,showDefaultHandlers"]
+   
    return tPrefs
 end sePrefGetDefaults
 

notes/feature-script_editor_handler_menu.md

@@ -0,0 +1,14 @@
+# Script editor handler menu
+The Handler menu of the script editor menubar has been modified
+in accordance with the default handler changes to the script
+editor handler list. It now has the following structure:
+
+Go to handler...
+   -> list of extant handlers
+Add default handler...
+   -> list of default handlers
+Show default handlers
+
+The show default handlers menu item toggles the script editor
+preference to show the default handler list, which defaults
+to true.