Remove extension API v1 compatibility

Legacy compatibility is much more work than to upgrade an extension
music-encoding · Mar 12, 2024 · c9e0fbf · c9e0fbf
1 parent 3c3ed49
commit c9e0fbf
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 198 deletions.
diff --git a/lib/sibmei4_legacy_extension_api_v1_test.plg b/lib/sibmei4_legacy_extension_api_v1_test.plg
diff --git a/src/Extensions.mss b/src/Extensions.mss
@@ -37,10 +37,6 @@ function RegisterAvailableExtensions (availableExtensions, extensionsInfo, plugi
                 {
                     error = null;
                 }
-                case (extensionSemver[0] = '1') {
-                    // It's O.K., we're giving it a legacy version of the API
-                    error = null;
-                }
                 case (
                     (apiSemver[0] < extensionSemver[0])
                     or (apiSemver[0] = extensionSemver[0] and apiSemver[1] < extensionSemver[1])
@@ -184,40 +180,20 @@ function CreateApiObject (extensionInfo) {
         'LyricText', LyricText
     );
 
-    switch (extensionInfo.apiVersion)
+    if (extensionInfo.apiVersion != 2)
     {
-        case (2)
-        {
-            // Current version
-            apiObject.SetMethod('RegisterSymbolHandlers', Self, 'ExtensionAPI_RegisterSymbolHandlers');
-            apiObject.SetMethod('RegisterTextHandlers', Self, 'ExtensionAPI_RegisterTextHandlers');
-            apiObject.SetMethod('RegisterLineHandlers', Self, 'ExtensionAPI_RegisterLineHandlers');
-            apiObject.SetMethod('RegisterLyricHandlers', Self, 'ExtensionAPI_RegisterLyricHandlers');
-            apiObject.SetMethod('MeiFactory', Self, 'ExtensionAPI_MeiFactory');
-            apiObject.SetMethod('AddFormattedText', Self, 'AddFormattedText');
-            apiObject.SetMethod('GenerateControlEvent', Self, 'ExtensionAPI_GenerateControlEvent');
-            apiObject.SetMethod('GenerateModifier', Self, 'ExtensionAPI_GenerateModifier');
-            apiObject.SetMethod('AsModifier', Self, 'ExtensionAPI_AsModifier');
-        }
-        case (1) {
-            // Legacy version
-            apiObject.SetMethod('RegisterSymbolHandlers', Self, 'LegacyExtensionAPIv1_RegisterSymbolHandlers');
-            apiObject.SetMethod('RegisterTextHandlers', Self, 'LegacyExtensionAPIv1_RegisterTextHandlers');
-            apiObject.SetMethod('RegisterLineHandlers', Self, 'LegacyExtensionAPIv1_RegisterLineHandlers');
-            apiObject.SetMethod('HandleControlEvent', Self, 'LegacyExtensionAPIv1_HandleControlEvent');
-            apiObject.SetMethod('HandleModifier', Self, 'LegacyExtensionAPIv1_HandleModifier');
-            apiObject.SetMethod('AddFormattedText', Self, 'AddFormattedText');
-            apiObject.SetMethod('GenerateControlEvent', Self, 'LegacyExtensionAPIv1_GenerateControlEvent');
-            apiObject.SetMethod('AddControlEventAttributes', Self, 'LegacyExtensionAPIv1_AddControlEventAttributes');
-            apiObject.SetMethod('HandleLineTemplate', Self, 'LegacyExtensionAPIv1_HandleLineTemplate');
-            apiObject.SetMethod('MeiFactory', Self, 'LegacyExtensionAPIv1_MeiFactory');
-        }
-        default
-        {
-            StopPlugin('Unsupported extension API version: ' & apiVersion);
-        }
+        StopPlugin('Unsupported extension API version: ' & extensionInfo.apiVersion);
     }
 
+    apiObject.SetMethod('RegisterSymbolHandlers', Self, 'ExtensionAPI_RegisterSymbolHandlers');
+    apiObject.SetMethod('RegisterTextHandlers', Self, 'ExtensionAPI_RegisterTextHandlers');
+    apiObject.SetMethod('RegisterLineHandlers', Self, 'ExtensionAPI_RegisterLineHandlers');
+    apiObject.SetMethod('RegisterLyricHandlers', Self, 'ExtensionAPI_RegisterLyricHandlers');
+    apiObject.SetMethod('MeiFactory', Self, 'ExtensionAPI_MeiFactory');
+    apiObject.SetMethod('AddFormattedText', Self, 'AddFormattedText');
+    apiObject.SetMethod('GenerateControlEvent', Self, 'ExtensionAPI_GenerateControlEvent');
+    apiObject.SetMethod('GenerateModifier', Self, 'ExtensionAPI_GenerateModifier');
+
     return apiObject;
 }  //$end
 
@@ -253,73 +229,3 @@ function ExtensionAPI_GenerateControlEvent (this, bobj, element) {
 function ExtensionAPI_GenerateModifier (this, bobj, element) {
     GenerateModifier(bobj, element);
 }   //$end
-
-function ExtensionAPI_AsModifier (this, templateObject) {
-    return AsModifier(templateObject);
-}   //$end
-
-
-
-/////  Legacy methods
-
-function LegacyExtensionAPIv1_RegisterHandlers (pluginInfo, handlers, handlerDict) {
-    for each Name idProperty in symbolHandlerDict
-    {
-        handlersById = symbolHandlerDict[idProperty];
-        for each Name id in handlersById
-        {
-            if (IsObject(handlersById[id]))
-            {
-                handlerMethod = handlersById[id];
-                template = null;
-            }
-            else
-            {
-                handlerMethod = defaultHandlerMethod;
-                template = handlersById[id];
-            }
-
-            RegisterHandlers(this, handlers, idProperty, handlerMethod, CreateDictionary(
-                id, template
-            ));
-        }
-    }
-}  //$end
-
-
-function LegacyExtensionAPIv1_RegisterSymbolHandlers (this, symbolHandlerDict, plugin) {
-    LegacyExtensionAPIv1_RegisterHandlers(this, SymbolHandlers, symbolHandlerDict);
-} //$end
-
-function LegacyExtensionAPIv1_RegisterTextHandlers (this, textHandlerDict, plugin) {
-    LegacyExtensionAPIv1_RegisterHandlers(this, TextHandlers, symbolHandlerDict);
-} //$end
-
-function LegacyExtensionAPIv1_RegisterLineHandlers (this, lineHandlerDict, plugin) {
-    LegacyExtensionAPIv1_RegisterHandlers(this, LineHandlers, symbolHandlerDict);
-} //$end
-
-
-function LegacyExtensionAPIv1_HandleControlEvent (this, bobj, template) {
-    return GenerateControlEvent(bobj, MeiFactory(template));
-} //$end
-
-function LegacyEtensionAPIv1_HandleModifier (this, bobj, template) {
-    return GenerateModifier(bobj, MeiFactory(template));
-} //$end
-
-function LegacyExtensionAPIv1_GenerateControlEvent (this, bobj, elementName) {
-    return AddControlEventAttributes(bobj, libmei.@elementName());
-} //$end
-
-function LegacyExtensionAPIv1_AddControlEventAttributes (this, bobj, element) {
-    return AddControlEventAttributes(bobj, element);
-} //$end
-
-function LegacyExtensionAPIv1_HandleLineTemplate (this, lobj, template) {
-    return GenerateControlEvent(lobj, MeiFactory(template));
-} //$end
-
-function LegacyExtensionAPIv1_MeiFactory (this, templateObject, bobj) {
-    return MeiFactory(templateObject, bobj);
-}  //$end
diff --git a/test/sib-test/Run.mss b/test/sib-test/Run.mss
@@ -41,21 +41,6 @@ function Run() {
 
     CloseAllWindows();
 
-    // Export with legacy API before batch exporting all the test files because
-    // batch export shows a dialog, and we'd rather have that dialog pop up
-    // when everything is finished.
-    sibmei4.InitGlobals(CreateSparseArray('sibmei4_legacy_extension_api_v1_test'));
-    score = sibmei4.GetScore(_SibTestFileDirectory & 'extensions.sib');
-    sibmei4.DoExport(score, _SibTestFileDirectory & 'legacy_extensions_api_v1.mei');
-
-    testFolder = Sibelius.GetFolder(_SibTestFileDirectory);
-    testFiles = CreateSparseArray();
-    for each SIB file in testFolder
-    {
-        testFiles.Push(file);
-    }
-    sibmei4.ExportBatch(testFiles, CreateSparseArray('sibmei4_extension_test'));
-
     if (Sibelius.PathSeparator = '/') {
         mochaScript = pluginDir & 'test.sh';
     } else {