Merge pull request #1985 from livecode/extension-sample_snippet_support

[[ Extensions ]] Add support for snippets and sample stacks

Author: livecodepanos

Toolset/libraries/revideextensionlibrary.livecodescript

@@ -167,10 +167,10 @@ function revIDEExtensions pType, pStatus, pWithoutInvisible
 
    # Repeat over the extension array looking for elements with matching type
    local tExtensions, tExtension
-   repeat for each key tExtensionKey in sExtensions
-      put sExtensions[tExtensionKey] into tExtension
+   repeat for each key tCacheId in sExtensions
+      put sExtensions[tCacheId] into tExtension
       if tExtension["name"] is empty then 
-         delete variable sExtensions[tExtensionKey]
+         __extensionCacheRemove tCacheId
          next repeat
       end if
       if pType is not empty and tExtension["type"] is not pType then 
@@ -1049,43 +1049,48 @@ private command __MapCodeLibraryForIDE pFolder
    end repeat
 end __MapCodeLibraryForIDE
 
-private command __LoadExtension pCacheIndex, pSourceType, pSourceFile, pFolder, pStatus, @xError
+private command __LoadExtension pCacheIndex, pExtensionType, pSourceType, \
+      pSourceFile, pFolder, pStatus, @xError
+   revInternal__Log "Message", the params
    if xError is empty then
       local tFileToLoad
-      if pSourceType is "lcb" then
-         local tResources, tModule, tCode
-         put revIDEExtensionBytecodeFilename(true) into tFileToLoad
-         put pFolder & slash & tFileToLoad into tModule
-         if there is no file tModule then
-            put revIDEExtensionBytecodeFilename(false) into tFileToLoad
+      if not __extensionNeedsLoad(pExtensionType) then
+         put "installed" into pStatus
+      else
+         if pSourceType is "lcb" then
+            local tResources, tModule, tCode
+            put revIDEExtensionBytecodeFilename(true) into tFileToLoad
             put pFolder & slash & tFileToLoad into tModule
+            if there is no file tModule then
+               put revIDEExtensionBytecodeFilename(false) into tFileToLoad
+               put pFolder & slash & tFileToLoad into tModule
+            end if
+            put pFolder & slash & "resources" into tResources
+            put pFolder & slash & "code" into tCode
+            # map code before loading extension
+            if there is a folder tCode then
+               __MapCodeLibraryForIDE tCode
+            end if
+            # If we have a resources folder then load with resource path
+            if there is a folder tResources then
+               load extension from file tModule with resource path tResources
+            else
+               load extension from file tModule
+            end if
+         else
+            set the itemdelimiter to "."
+            revInternal__LoadLibrary item 1 of pSourceFile, pFolder & slash & pSourceFile
+            put pSourceFile into tFileToLoad
          end if
-         put pFolder & slash & "resources" into tResources
-         put pFolder & slash & "code" into tCode
-         # map code before loading extension
-         if there is a folder tCode then
-            __MapCodeLibraryForIDE tCode
-         end if
-         # If we have a resources folder then load with resource path
-         if there is a folder tResources then
-            load extension from file tModule with resource path tResources
+         if the result is not empty then
+            put toUpper(char 1 of the result) & \
+                  char 2 to -1 of the result into xError
+            put "error" into pStatus
          else
-            load extension from file tModule
+            put "installed" into pStatus
          end if
-      else
-         set the itemdelimiter to "."
-         revInternal__LoadLibrary item 1 of pSourceFile, pFolder & slash & pSourceFile
-         put pSourceFile into tFileToLoad
-      end if
-      if the result is not empty then
-         put toUpper(char 1 of the result) & \
-               char 2 to -1 of the result into xError
-         put "error" into pStatus
-      else
-         put "installed" into pStatus
       end if
    end if
-   
    __extensionPropertySet pCacheIndex, "status", pStatus
    __extensionPropertySet pCacheIndex, "error", xError
    __extensionPropertySet pCacheIndex, "file", tFileToLoad
@@ -1112,15 +1117,17 @@ private command __revIDELCBExtensionLoad pID, pFolder, pVersion, pStatus, \
             revIDEExtensionGetLoadOnStartup(pID) into tLoadOnStartup
    end if
    if not pIsStartup or tLoadOnStartup is not false then
-      __LoadExtension tCacheIndex, "lcb", pSourceFile, pFolder, pStatus, pError
+      __LoadExtension tCacheIndex, pAdditionalInfoA["type"], "lcb", pSourceFile, \
+         pFolder, pStatus, pError
       -- If we have an error loading, try to recompile the extension
       if pError is not empty then
          if not pIsIDEExtension and pSourceFile is not empty then
             revIDEExtensionCompile pFolder, pSourceFile, tSupportFiles, pFolder, \
                   revIDEExtensionBytecodeFilename(true)
             if the result is empty then
                local tNewError
-               __LoadExtension tCacheIndex, "lcb", pSourceFile, pFolder, pStatus, tNewError
+               __LoadExtension tCacheIndex, pAdditionalInfoA["type"], "lcb", \
+                  pSourceFile, pFolder, pStatus, tNewError
                put tNewError into pError
             end if
          end if
@@ -1190,6 +1197,25 @@ private function __UseTypeToKey pUseType
    end switch
 end __UseTypeToKey
 
+private function __extensionHasID pType
+   switch pType
+      case "snippet"
+         return false
+      default
+         return true
+   end switch
+end __extensionHasID
+
+private function __extensionNeedsLoad pType
+   switch pType
+      case "snippet"
+      case "sample"
+         return false
+      default
+         return true
+   end switch
+end __extensionNeedsLoad
+
 private command __revIDELCSExtensionLoad pFullPath, pFolder, pVersion, pStatus, \
       pError, pIsIDEExtension, pSourceFile, pAdditionalInfoA, pIsStartup
 
@@ -1203,27 +1229,35 @@ private command __revIDELCSExtensionLoad pFullPath, pFolder, pVersion, pStatus,
       __extensionPropertySet tCacheIndex, "install_path", pFolder
    end if
 
+   if pAdditionalInfoA is empty then
+      put __fetchExtensionManifestData(pFolder, pSourceFile) into pAdditionalInfoA
+   end if
+   
+   local tType
+   put pAdditionalInfoA["type"] into tType
+   
    # Update name, status, error, and whether the extension comes with the IDE
    local tId
+   if __extensionHasID(tType) then
    try
       put the short name of stack (pFolder & slash & pSourceFile) into tId
    catch pError
    end try
+   else
+      # The manifest should contain an id
+      put pAdditionalInfoA["name"] into tId
+   end if
 
    local tLoadOnStartup
-   if pError is empty then
+   if pError is empty and __extensionNeedsLoad(tType) then
       put revIDEExtensionGetLoadOnStartup(tID) into tLoadOnStartup
    end if
-   if not pIsStartup or tLoadOnStartup is not false then
-      __LoadExtension tCacheIndex, "lcs", pSourceFile, pFolder, pStatus, pError
+   if not pIsStartup or (tLoadOnStartup is not false) then   
+      __LoadExtension tCacheIndex, tType, "lcs", pSourceFile, pFolder, pStatus, pError
    else
       __extensionPropertySet tCacheIndex, "status", "unloaded" 
    end if
 
-   if pAdditionalInfoA is empty then
-      put __fetchExtensionManifestData(pFolder, pSourceFile) into pAdditionalInfoA
-   end if
-   
    __extensionPropertySet tCacheIndex, "name", tId
    __extensionPropertySet tCacheIndex, "type_id", tId  & "." & pVersion 
 
@@ -1245,7 +1279,7 @@ private command __revIDELCSExtensionLoad pFullPath, pFolder, pVersion, pStatus,
    __extensionPropertySet tCacheIndex, "source_file", pSourceFile
    __extensionPropertySet tCacheIndex, "ide", pIsIDEExtension
    __extensionPropertySet tCacheIndex, "source_type", "lcs"
-   __extensionPropertySet tCacheIndex, "type", "library"
+   __extensionPropertySet tCacheIndex, "type", pAdditionalInfoA["type"]
    __extensionPropertySet tCacheIndex, "uservisible", true
    __extensionPropertySet tCacheIndex, "support_files", pAdditionalInfoA["support_files"]
 
@@ -1261,6 +1295,14 @@ private command __revIDELCSExtensionLoad pFullPath, pFolder, pVersion, pStatus,
       end if
    end if
 
+   # If this is not startup, then auto-launch snippet or sample stack
+   if not pIsStartup then
+      if tType is "snippet" then
+         revIDEExtensionShowSnippet pFolder & slash & pSourceFile
+      else if tType is "sample" then
+         revIDEExtensionOpenSample pFolder & slash & pSourceFile
+      end if
+   end if
    return pError
 end __revIDELCSExtensionLoad
 
@@ -1273,7 +1315,7 @@ command revIDEExtensionReload pTypeId
    end if
    local tError, tDataA
    put sExtensions[tCacheIndex] into tDataA
-   __LoadExtension tCacheIndex, tDataA["source_type"], \
+   __LoadExtension tCacheIndex, tDataA["type"], tDataA["source_type"], \
          tDataA["source_file"], tDataA["install_path"], \
          "", tError
    if tError is not empty then
@@ -1547,3 +1589,46 @@ command revIDEExtensionIconFromType pType, pID, @rIconName, @rIconPath
          break
    end switch
 end revIDEExtensionIconFromType
+
+command revIDEExtensionShowSnippet pSourceFile
+   local tSnippet
+   put revIDEUTF8FileContents(pSourceFile) into tSnippet
+   lock screen
+   revIDEOpenPalette("snippet viewer")
+   dispatch "revIDESnippetViewerSetSnippet" to stack \
+      revIDEPaletteToStackName("snippet viewer") with tSnippet
+   unlock screen
+end revIDEExtensionShowSnippet
+
+local sSampleFileName
+local sOpenedStacksA
+on ideOpenStack pCard
+   local tStack
+   put the long id of the owner of pCard into tStack
+   if tStack is the long id of stack sSampleFileName then
+      ## Clear the filename to force the user to choose save location if saving the stack
+      put the short name of tStack into sOpenedStacksA[sSampleFileName]
+      set the filename of tStack to empty
+      put empty into sSampleFileName
+      revIDEUnsubscribe "ideOpenStack"
+   end if
+end ideOpenStack
+
+command revIDEExtensionLaunchSampleStack pSampleStack
+    // Check if the sample stack has already been opened,
+    // i.e. if its name is mapped in the array. If so, just
+    // open it.
+    if there is a stack (sOpenedStacksA[pSampleStack]) then
+        open stack sOpenedStacksA[pSampleStack]
+        exit revIDEExtensionLaunchSampleStack
+    end if
+    
+    // Otherwise open the stack from the file. Wait until we
+    // get the openStack message before emptying the filename
+    // otherwise we will get a long id clash
+    revIDESubscribe "ideOpenStack"
+    put pSampleStack into sSampleFileName
+    
+    ## Open the sample stack
+    open stack pSampleStack
+end revIDEExtensionLaunchSampleStack

Toolset/libraries/revidelibrary.8.livecodescript

@@ -4348,7 +4348,7 @@ Returns a list of all the display names of stacks recognised by the IDE as a pal
 */
 function revIDEAvailablePalettes
    return "Menubar,Tools,Inspector,Message Box,Project Browser,Extension Manager,Extension Builder,Start Center,Welcome,Menu Builder,Message Watcher,Plugin Preferences," \
-   & "Standalone Settings,About,Dictionary,Guide,Resource Center,Preferences,Search"	
+   & "Standalone Settings,About,Dictionary,Guide,Resource Center,Preferences,Search,Snippet Viewer"
 end revIDEAvailablePalettes
 
 function revIDEPaletteToStackName pPalette
@@ -4397,6 +4397,8 @@ function revIDEPaletteToStackName pPalette
          return "revDictionary"
       case "resource center"
          return "revResourceCenter"
+      case "snippet viewer"
+         return "revIDESnippetViewer"
    end switch
 end revIDEPaletteToStackName
 
@@ -4624,6 +4626,7 @@ command revIDEOpenPalette pPaletteName
       case "standalone settings"
       case "message watcher"
       case "tools"
+      case "snippet viewer"
          palette stack tStackName
          break
       case "search"

Toolset/palettes/extension manager/revideextensionmanagerbehavior.livecodescript

@@ -12,6 +12,8 @@ on preOpenStack
    # Navigation
    addFrameItem "widget","header", "navigation", "Widgets", "", "","showList", the long id of me,"widget"
    addFrameItem "library","header", "navigation", "Libraries", "", "","showList", the long id of me,"library"
+   addFrameItem "sample","header", "navigation", "Sample Stacks", "", "","showList", the long id of me,"sample"
+   addFrameItem "snippet","header", "navigation", "Snippets", "", "","showList", the long id of me,"snippet"
    addFrameItem "store","header", "navigation", "Store", "", "","showExtensionStore", the long id of me,"store"
    addFrameItem "install", "header", "action", "Install extension", "plus", "","installNew", the long id of me
 

Toolset/palettes/extension manager/revideextensionmanagerlistbehavior.livecodescript

@@ -186,38 +186,19 @@ on cancelExtensionInstall pExtensionIdentifier
    revIDECancelInstallExtension pExtensionIdentifier
 end cancelExtensionInstall
 
-local sSampleFileName
-local sOpenedStacksA
-on launchExtensionSampleStack pSampleStack
-   // Check if the sample stack has already been opened, 
-   // i.e. if its name is mapped in the array. If so, just
-   // open it.
-   if there is a stack (sOpenedStacksA[pSampleStack]) then
-      open stack sOpenedStacksA[pSampleStack]
-      exit launchExtensionSampleStack
-   end if
-   
-   // Otherwise open the stack from the file. Wait until we
-   // get the openStack message before emptying the filename
-   // otherwise we will get a long id clash
-   revIDESubscribe "ideOpenStack"
-   put pSampleStack into sSampleFileName
-   
-   ## Open the sample stack
-   open stack pSampleStack
+on launchExtensionSampleStack pExtensionId
+   local tSourceFolder, tSourceFile
+   put revIDEExtensionProperty(pExtensionId, "install_path") into tSourceFolder
+   put revIDEExtensionProperty(pExtensionId, "source_file") into tSourceFile
+   revIDEExtensionLaunchSampleStack tSourceFolder & slash & tSourceFile
 end launchExtensionSampleStack
 
-on ideOpenStack pCard
-   local tStack
-   put the long id of the owner of pCard into tStack
-   if tStack is the long id of stack sSampleFileName then
-      ## Clear the filename to force the user to choose save location if saving the stack
-      put the short name of tStack into sOpenedStacksA[sSampleFileName]
-      set the filename of tStack to empty
-      put empty into sSampleFileName
-      revIDEUnsubscribe "ideOpenStack"
-   end if
-end ideOpenStack
+on showExtensionSnippet pExtensionId
+   local tSourceFolder, tSourceFile
+   put revIDEExtensionProperty(pExtensionId, "install_path") into tSourceFolder
+   put revIDEExtensionProperty(pExtensionId, "source_file") into tSourceFile
+   revIDEExtensionShowSnippet tSourceFolder & slash & tSourceFile
+end showExtensionSnippet
 
 on ideExtensionStatusChanged pStatus
    local tElement, tRow, tIdentifier, tStatus, tProgress