Merge pull request #1903 from livecode/bugfix-module_versioning

[[ Bug 20929 ]] Output to module.<module_version>.lcm when compiling

Author: livecodepanos

Toolset/libraries/revidedeveloperextensionlibrary.livecodescript

@@ -37,7 +37,7 @@ private function __revIDEDeveloperExtensionShouldRecompile pFolder, pFile
    put pFolder & slash & pFile into tCompileInputs[1]
 
    put pFolder & slash & "manifest.xml" into tCompileOutputs[1]
-   put pFolder & slash & "module.lcm" into tCompileOutputs[2]
+   put pFolder & slash & revIDEExtensionBytecodeFilename(true) into tCompileOutputs[2]
 
    put revIDEIsFilesetStale(tCompileInputs, tCompileOutputs, false, tError) \
          into tNeedUpdate
@@ -366,7 +366,7 @@ private function __revIDEDeveloperExtensionDetailsFromFile pFolder, pFile, pSupp
       if not __revIDEDeveloperExtensionShouldRecompile(pFolder, pFile) then
 
          __revIDEDeveloperExtensionLog "Skipping recompilation of" && \
-               pFolder & slash & "module.lcm - module is up to date"
+               pFolder & slash & pFile && "- module is up to date"
          # The stored info is up to date.
          if sExtensionDetailsA[pFolder] is not empty then
             union tDetailsA with sExtensionDetailsA[pFolder]
@@ -474,8 +474,9 @@ command revIDEDeveloperExtensionTest pPath
       exit revIDEDeveloperExtensionTest
    end if
 
-   if tDetailsA["source_type"] is "lcb" and \
-         there is not a file (pPath & slash & "module.lcm") then
+   if tDetailsA["source_type"] is "lcb" \
+         and there is not a file \
+         (pPath & slash & revIDEExtensionBytecodeFilename(true)) then
       __revIDEDeveloperExtensionSendError "No compiled module in" && pPath
       exit revIDEDeveloperExtensionTest
    end if
@@ -624,7 +625,8 @@ on revIDEDeveloperExtensionInstall pFolder
    local tPackage
    __revIDEDeveloperExtensionBuildPackage pFolder, "", tPackage
    revIDEExtensionInstall tPackage
-   put pFolder & slash & "module.lcm" into sInstalledExtension
+   put pFolder & slash & revIDEExtensionBytecodeFilename(true) \
+         into sInstalledExtension
 end revIDEDeveloperExtensionInstall
 
 on revIDEDeveloperExtensionUninstall pPath
@@ -751,7 +753,8 @@ private command __revIDEDeveloperCompileModule pFile, pSupportFiles, pTargetFold
 
    __revIDEDeveloperExtensionLog it
 
-   if there is not a file (pTargetFolder & slash & "module.lcm") then
+   if there is not a file \
+         (pTargetFolder & slash & revIDEExtensionBytecodeFilename(true)) then
       return "failed to compile module"
    end if
 
@@ -782,6 +785,18 @@ private command __revIDEDeveloperExtensionBuildPackage pFolder, pTargetFolder, @
       return "Error: missing file" && tFullPath
    end if
 
+   local tManifestFile
+   put pFolder & slash & "manifest.xml" into tManifestFile
+   
+   if tDetailsA["source_type"] is "lcs" then
+      revIDEExtensionGenerateManifestForLCSExtension \
+            tDetailsA["source_file"], pFolder
+   end if
+   
+   if there is no file tManifestFile then
+      return "Error: missing manifest" && tManifestFile
+   end if
+   
    local tTargetFolder
    if pTargetFolder is empty then
       put pFolder into tTargetFolder
@@ -899,9 +914,15 @@ private command __revIDEDeveloperExtensionBuildPackage pFolder, pTargetFolder, @
    local tSupportFiles
    put tDetailsA["support_files"] into tSupportFiles
 
+   local tModuleFiles
+   if tDetailsA["source_type"] is "lcb" then
+      put files(pFolder) into tModuleFiles
+      filter tModuleFiles with regex pattern "^module(\.[0-9]+)?\.lcm$"
+   end if
+   
    if tError is empty then
       put __revIDEDeveloperExtensionAddSpecifiedFilesToPackage(\
-            tFullPath, tSupportFiles, pFolder, tArchive, pFolder & slash & "module.lcm", \
+            tFullPath, tSupportFiles, pFolder, tArchive, tModuleFiles, \
             tIcon, tRetinaIcon, tGuide, tDocs, tResources, tCode, \
             tSamples, tInterfaceFile, tDefaultScript, tEditors) \
             into tError
@@ -925,7 +946,7 @@ private command __revIDEDeveloperExtensionBuildPackage pFolder, pTargetFolder, @
 end __revIDEDeveloperExtensionBuildPackage
 
 private function __revIDEDeveloperExtensionAddSpecifiedFilesToPackage \
-      pSource, pSupportFiles, pFolder, pArchive, pModule, pIcon,  \
+      pSource, pSupportFiles, pFolder, pArchive, pModuleFiles, pIcon,  \
       pRetinaIcon, pGuide, pDocs, pResourcesFolder, pCodeFolder, \
       pSamplesFolder, pInterfaceFile, pDefaultScript, pEditors
 
@@ -940,20 +961,28 @@ private function __revIDEDeveloperExtensionAddSpecifiedFilesToPackage \
    end if
 
    # Add support files into package
-   repeat for each line tSupport in pSupportFiles
-      put pFolder & slash & tSupport into tSupport
-      revZipAddItemWithFile pArchive, item -1 of tSupport, tSupport
+   if tError is empty then
+      repeat for each line tSupport in pSupportFiles
+         put pFolder & slash & tSupport into tSupport
+         revZipAddItemWithFile pArchive, item -1 of tSupport, tSupport
 
-      if the result begins with "ziperr" then
-         put "couldn't add support file" && tSupport into tError
-      end if
-   end repeat
-   
-   # Add module into package
-   revZipAddItemWithFile pArchive, "module.lcm", pModule
+         if the result begins with "ziperr" then
+            put "couldn't add support file" && tSupport into tError
+            exit repeat
+         end if
+      end repeat
+   end if
 
-   if the result begins with "ziperr" then
-      put "couldn't add module" into tError
+   # Add modules into package
+   if tError is empty then
+      repeat for each line tModuleFile in pModuleFiles
+         put pFolder & slash & tModuleFile into tModuleFile
+         revZipAddItemWithFile pArchive, item -1 of tModuleFile, tModuleFile
+         if the result begins with "ziperr" then
+            put "couldn't add module" && tModuleFile into tError
+            exit repeat
+         end if
+      end repeat
    end if
 
    # Add manifest into package

Toolset/libraries/revideextensionlibrary.livecodescript

@@ -13,6 +13,52 @@ on extensionFinalize
    end if
 end extensionFinalize
 
+local sModuleVersion
+private command __EnsureModuleVersion
+   if sModuleVersion is not empty then
+      exit __EnsureModuleVersion
+   end if
+   local tTempFile, tModule, tFolder
+   put the tempname into tTempFile
+   set the itemdelimiter to slash
+   put item 1 to -2 of tTempFile into tFolder
+   put "module com.livecode.dummy" into tModule
+   put return & "end module" after tModule
+   put tModule into url("file:" & tTempFile)
+   revIDEExtensionCompile tTempFile, "", tFolder, "module.lcm"
+   put __CompiledModuleVersion(tFolder & slash & "module.lcm") \
+         into sModuleVersion
+end __EnsureModuleVersion
+
+private function __CompiledModuleVersion pModule
+   local tBytes
+   put url("binfile:" & pModule) into tBytes
+   return byteToNum(byte 4 of tBytes) * 256 + \
+         byteToNum(byte 3 of tBytes)
+end __CompiledModuleVersion
+
+private function __CheckModuleVersion pModule
+   return __CompiledModuleVersion(pModule) is \
+         __ModuleVersion()
+end __CheckModuleVersion
+
+private function __ModuleVersion
+   __EnsureModuleVersion
+   return sModuleVersion
+end __ModuleVersion
+
+function revIDEExtensionBytecodeFilename pUseVersion
+   if pUseVersion is empty then 
+      put true into pUseVersion
+   end if
+   
+   if pUseVersion then
+      return "module." & __ModuleVersion() & ".lcm"
+   else
+      return "module.lcm"
+   end if
+end revIDEExtensionBytecodeFilename
+
 # Called at startup. Loads all the extensions ready for use
 on revIDEInitialiseExtensions
    # Load all the extensions ready for use
@@ -926,8 +972,11 @@ command revIDEExtensionFetchSourceFromFolder pFolder, @rSource, @rSupportFiles,
    local tExtFiles, tType
    filter tFiles with regex pattern \
          __RegexPatternForSource("lcb") into tExtFiles
-   if there is a file (pFolder & slash & "module.lcm") \
-         or tExtFiles is not empty then
+   if tExtFiles is not empty \
+         or there is a file \
+         (pFolder & slash & revIDEExtensionBytecodeFilename(true)) \
+         or there is a file \
+         (pFolder & slash & revIDEExtensionBytecodeFilename(false)) then
       put "lcb" into tType
    end if
 
@@ -1188,10 +1237,16 @@ end __MapCodeLibraryForIDE
 
 private command __LoadExtension pCacheIndex, pSourceType, pSourceFile, pFolder, pStatus, @xError
    if xError is empty then
+      local tFileToLoad
       if pSourceType is "lcb" then
          local tResources, tModule, tCode
+         put pFolder & slash & revIDEExtensionBytecodeFilename(true) \
+               into tModule
+         if there is no file tModule then
+            put pFolder & slash & revIDEExtensionBytecodeFilename(false) \
+                  into tModule
+         end if
          put pFolder & slash & "resources" into tResources
-         put pFolder & slash & "module.lcm" into tModule
          put pFolder & slash & "code" into tCode
          # map code before loading extension
          if there is a folder tCode then
@@ -1203,9 +1258,11 @@ private command __LoadExtension pCacheIndex, pSourceType, pSourceFile, pFolder,
          else
             load extension from file tModule
          end if
+         put tModule into tFileToLoad
       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) & \
@@ -1218,6 +1275,7 @@ private command __LoadExtension pCacheIndex, pSourceType, pSourceFile, pFolder,
 
    __extensionPropertySet pCacheIndex, "status", pStatus
    __extensionPropertySet pCacheIndex, "error", xError
+   __extensionPropertySet pCacheIndex, "file", tFileToLoad
    __extensionsChanged
 end __LoadExtension
 
@@ -1244,7 +1302,8 @@ private command __revIDELCBExtensionLoad pID, pFolder, pVersion, pStatus, \
       -- 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 & slash & pSourceFile, tSupportFiles, pFolder
+            revIDEExtensionCompile pFolder & slash & pSourceFile, tSupportFiles, pFolder, \
+                  revIDEExtensionBytecodeFilename(true)
             if the result is empty then
                local tNewError
                __LoadExtension tCacheIndex, "lcb", pSourceFile, pFolder, pStatus, tNewError
@@ -1357,6 +1416,8 @@ private command __revIDELCSExtensionLoad pFullPath, pFolder, pVersion, pStatus,
    __extensionPropertySet tCacheIndex, "author", pAdditionalInfoA["author"]
    __extensionPropertySet tCacheIndex, "title", pAdditionalInfoA["display name"]
    __extensionPropertySet tCacheIndex, "svgicon", pAdditionalInfoA["svgicon"]
+   __extensionPropertySet tCacheIndex, "version", pAdditionalInfoA["version"]
+   
    repeat for each key tKey in pAdditionalInfoA["uses"]
       local tSettingString
       put empty into tSettingString
@@ -1634,7 +1695,11 @@ private function shellFormat pArg, pSwitch
    return tOutput & quote & pArg & quote & " "
 end shellFormat
 
-command revIDEExtensionCompile pFile, pSupportFiles, pTargetFolder
+command revIDEExtensionCompile pFile, pSupportFiles, pTargetFolder, pOutputFilename
+   if pOutputFilename is empty then
+      put revIDEExtensionBytecodeFilename() into pOutputFilename
+   end if
+   
    # The manifest is currently always generated from the source
    if there is a file (pTargetFolder & slash & "manifest.xml") then
       delete file (pTargetFolder & slash & "manifest.xml")
@@ -1657,7 +1722,7 @@ command revIDEExtensionCompile pFile, pSupportFiles, pTargetFolder
    put shellFormat(pTargetFolder & slash & "manifest.xml", "manifest") after tShellCommand
 
    # The output
-   put shellFormat(pTargetFolder & slash & "module.lcm", "output") after tShellCommand
+   put shellFormat(pTargetFolder & slash & pOutputFilename, "output") after tShellCommand
 
    # Support files must be dependency-ordered
    repeat for each line tSupport in revIDEExtensionsOrderByDependency(pSupportFiles)
@@ -1810,18 +1875,14 @@ function revIDEExtensionFileData pID
    local tCacheIndex
    put __extensionCacheID("name", pID) into tCacheIndex
 
-   local tSourceType, tFolder, tSourceFile
+   local tSourceType, tFolder, tFile
    put __extensionPropertyGet(tCacheIndex, "install_path") into tFolder
    put __extensionPropertyGet(tCacheIndex, "source_type") into tSourceType
-   put __extensionPropertyGet(tCacheIndex, "source_file") into tSourceFile
+   put __extensionPropertyGet(tCacheIndex, "file") into tFile
 
    local tDataA
    put tSourceType into tDataA["type"]
-   if tSourceType is "lcb" then
-      put tFolder & slash & "module.lcm" into tDataA["file"]
-   else
-      put tFolder & slash & tSourceFile into tDataA["file"]
-   end if
+   put tFolder & slash & tFile into tDataA["file"]
    return tDataA
 end revIDEExtensionFileData
 
@@ -1890,3 +1951,55 @@ command revIDEExtensionIconFromType pType, pID, @rIconName, @rIconPath
          break
    end switch
 end revIDEExtensionIconFromType
+
+private command addXML @xXML, pDepth, pTag, pContent, pAttributesA
+   repeat pDepth
+      put space after xXML
+   end repeat
+   put "<" & pTag after xXML
+   repeat for each key tKey in pAttributesA
+      put " " & tKey & "=" & quote & pAttributesA[tKey] & quote \
+            after xXML
+   end repeat
+   if pContent is empty then
+      put " />" after xXML
+   else
+      put ">" & pContent & "</" & pTag & ">" after xXML
+   end if
+   put return after xXML
+end addXML
+
+command revIDEExtensionGenerateManifestForLCSExtension pSource, pFolder
+   local tDataA
+   put __fetchScriptLibraryData(pFolder, pSource) into tDataA
+   
+   local tPackageXML, tAttrA
+   repeat for each item tTag in "name,title,author,version,type"
+      addXML tPackageXML, 1, tTag, tDataA[tTag]
+   end repeat
+   
+   addXML tPackageXML, 1, "license", "community"
+   
+   // TODO: This will only work for loaded lcs libraries
+   repeat for each line tRequirement in revSBGetExtensionDependenciesForExtension(tDataA["name"])
+      put tRequirement into tAttrA["name"]
+      addXML tPackageXML, 1, "requires", "", tAttrA
+      put empty into tAttrA
+   end repeat
+   
+   repeat for each item tMetadata in "svgicon"
+      local tValue
+      put tDataA[tMetadata] into tValue
+      if tValue is empty then
+         next repeat
+      end if
+      put tMetadata into tAttrA["key"]
+      addXML tPackageXML, 1, "metadata", tValue, tAttrA
+      put empty into tAttrA
+   end repeat
+   
+   local tXML
+   put "0.0" into tAttrA["version"]
+   addXML tXML, 0, "package", return & tPackageXML, tAttrA
+   put textEncode(tXML, "utf-8") into url("binfile:" & pFolder & slash & "manifest.xml")
+end revIDEExtensionGenerateManifestForLCSExtension