[[ PI ]] Allow custom property editors to be packaged in extensions

Author: livecodeali

Toolset/libraries/revidedeveloperextensionlibrary.livecodescript

@@ -293,6 +293,15 @@ private function __revIDEDeveloperExtensionFetchFolderDetails pFolder, pFile
    if tDetailsA["defaultscript"] is not empty then
       put pFolder & "/support/defaultscript.livecodescript" into tDetailsA["defaultscript_file"]
    end if
+   
+   # Custom PI editors
+   local tEditorsFolder, tEditors
+   put pFolder & slash & "editors" into tEditorsFolder
+   if there is a folder tEditorsFolder then
+      put __revIDEDeveloperExtensionListResourcesRecursive(tEditorsFolder, "") into tEditors
+      put tEditors into tDetailsA["editors"]
+   end if
+   
    return tDetailsA 
 end __revIDEDeveloperExtensionFetchFolderDetails
 
@@ -882,8 +891,18 @@ private on __revIDEDeveloperExtensionBuildPackage pFolder, pTargetFolder, @rBuil
       put empty into tDefaultScript
    end if
 
+   local tEditors
+   put (pFolder & slash & "editors") into tEditors
+   if there is not a folder tEditors then
+      put empty into tEditors
+   end if
+   
    if tError is empty then
-      put __revIDEDeveloperExtensionAddSpecifiedFilesToPackage(tFullPath, pFolder, tArchive, pFolder & slash & "module.lcm", tIcon, tRetinaIcon, tGuide, tDocs, tResources, tCode, tInterfaceFile, tDefaultScript) into tError
+      put __revIDEDeveloperExtensionAddSpecifiedFilesToPackage(\
+            tFullPath, pFolder, tArchive, pFolder & slash & "module.lcm", \
+            tIcon, tRetinaIcon, tGuide, tDocs, tResources, tCode, \
+            tInterfaceFile, tDefaultScript, tEditors) \
+            into tError
    end if
 
    revZipCloseArchive tArchive
@@ -903,7 +922,10 @@ private on __revIDEDeveloperExtensionBuildPackage pFolder, pTargetFolder, @rBuil
    return empty
 end __revIDEDeveloperExtensionBuildPackage
 
-private function __revIDEDeveloperExtensionAddSpecifiedFilesToPackage pSource, pFolder, pArchive, pModule, pIcon, pRetinaIcon, pGuide, pDocs, pResourcesFolder, pCodeFolder, pInterfaceFile, pDefaultScript
+private function __revIDEDeveloperExtensionAddSpecifiedFilesToPackage \
+      pSource, pFolder, pArchive, pModule, pIcon, pRetinaIcon, pGuide, \
+      pDocs, pResourcesFolder, pCodeFolder, pInterfaceFile, \
+      pDefaultScript, pEditors
    local tError
 
    set the itemdelimiter to slash
@@ -1016,6 +1038,19 @@ private function __revIDEDeveloperExtensionAddSpecifiedFilesToPackage pSource, p
       end if
    end if
 
+   # Add editors
+   if tError is empty and pEditors is not empty then
+      local tEditors
+      put __revIDEDeveloperExtensionListResourcesRecursive(pEditors, "") into tEditors
+      repeat for each line tLine in tEditors
+         revZipAddItemWithFile pArchive, "editors/" & tLine, pEditors & slash & tLine
+         
+         if the result begins with "ziperr" then
+            __revIDEDeveloperExtensionSendWarning "couldn't add editors" && pEditors & slash & tLine
+         end if
+      end repeat
+   end if
+   
    return tError
 end __revIDEDeveloperExtensionAddSpecifiedFilesToPackage
 

Toolset/palettes/behaviors/revinspectorbehavior.livecodescript

@@ -52,15 +52,28 @@ on inspectorOpenEditor pEditor
 
    # Find the file for the editor
    local tEditorStackPath, tEditorBehaviorPath
-   put revIDEPaletteResourcePath("editors/" & pEditor & ".livecode") into tEditorStackPath
-   put revIDEPaletteResourcePath("editors/" & pEditor & ".behavior.livecodescript") into tEditorBehaviorPath
+   put revIDEPaletteResourcePath("editors/" & pEditor & ".livecode", \
+         the long id of stack "revInspector") into tEditorStackPath
+   put revIDEPaletteResourcePath("editors/" & pEditor & ".behavior.livecodescript", \
+         the long id of stack "revInspector") into tEditorBehaviorPath
+   
    # open editor stack if it exists
-   if there is a file tEditorStackPath then 
-      go invisible stack tEditorStackPath
+   if there is not a file tEditorStackPath then 
+      # check if an extension has provided its own editor
+      # it is named <id>.editor.editorName
+      local tId, tPath
+      set the itemdelimiter to "."
+      put item 1 to -3 of pEditor into tId
+      put revIDEExtensionProperty(tId, "install_path") into tPath
+      put tPath & "/editors/" & pEditor & ".livecode" into tEditorStackPath
+      put tPath & "/editors/" & pEditor & ".behavior.livecodescript" into tEditorBehaviorPath
    end if
 
+   if there is a file tEditorStackPath then 
+      get the long id of stack tEditorStackPath
+   end if
    if there is a file tEditorBehaviorPath then 
-      go invisible stack tEditorBehaviorPath
+      get the long id of stack tEditorBehaviorPath
    end if
 end inspectorOpenEditor
 

Toolset/palettes/inspector/behaviors/revinspectorgroupbehavior.livecodescript

@@ -28,11 +28,15 @@ on propertyRegister pPropertyInfo
          break
    end switch
 
+   inspectorOpenEditor tEditor
+   
    # Create the editor (need to decide if it's a classic editor (clone a group) 
    # or a new widget editor, in which case it's create control.
    if there is not a stack tEditor then
       put "com.livecode.pi.string" into tEditor
+      inspectorOpenEditor tEditor
    end if
+   
    local tEditorBehavior
    put tEditor & ".behavior" into tEditorBehavior
 

notes/feature-custom_editors.md

@@ -0,0 +1,13 @@
+# Custom property inspector editors
+Extensions may now include their own property inspector editors
+for use when editing their properties. The stack containing the 
+editor, and the behavior must be named <extension id>.editor.<name>.livecode
+and <extension id>.editor.<name>.behavior.livecodescript respectively.
+
+The editor stack must contain one group called "template", which is the 
+editor. It is cloned onto the inspector stack when any property that
+uses it as an editor is inspected. 
+
+Please see the [property inspector feature note](https://github.com/livecode/livecode-ide/blob/develop/notes/feature-property_inspector.md#editors)
+for more details on property inspector editors. 
+

notes/feature-property_inspector.md

@@ -99,9 +99,10 @@ override the defaults.
 ### Editors
 
 Currently an editor must be a stack consisting of a group named
-"template" and a button named "behavior". The property inspector looks
-up the specified editor for a given property, clones the template
-group, and sets its behavior to the long id of the button.
+"template", together with an editor behavior script-only stack. 
+The property inspector looks up the specified editor for a given 
+property, clones the template group, and sets its behavior to the 
+stack script.
 
 The behavior script must at a minimum implement the following three handlers:
 
@@ -165,3 +166,6 @@ There are also some bespoke editors for particular object properties:
 It is our intention that ultimately a widget alone will be able to
 function as a property editor, however currently this feature is not
 available.
+
+See the [editors folder of the IDE repository](https://github.com/livecode/livecode-ide/tree/develop/Toolset/palettes/inspector/editors)
+for more examples of property inspector editors.