language-server: when looking for playerglobal.swc or airglobal.swc documentation, prefer playerglobal_rb.swc

Previously, we always used our bundled playerglobal XML docs. However, these are not necessarily complete for the newest AIR SDKs because Apache Flex didn't receive new updates from Adobe after a certain point.

Includes a special case that checks for airglobal and selects playerglobal_rb.swc as a fallback for airglobal_rb.swc, which doesn't usually exist.

Author: joshtynjala

language-server/src/main/java/com/as3mxml/vscode/asdoc/VSCodePackageDITAParser.java

@@ -382,7 +382,20 @@ private InputStream getPackageDITAStream(String packageName) {
 				}
 				InputStream stream = null;
 				String fileName = new File(swcFilePath).getName();
-				if (fileName.endsWith(".swc")
+				String filePath = "docs/" + packageName + ".xml";
+				ISWC swc = workspace.getSWCManager().get(new File(swcFilePath));
+				if (swc == null) {
+					return null;
+				}
+				try {
+					ZipFile zipFile = new ZipFile(swc.getSWCFile());
+					stream = SWCReader.getInputStream(zipFile, filePath);
+				} catch (ZipException e) {
+					return null;
+				} catch (IOException e) {
+					return null;
+				}
+				if (stream == null && fileName.endsWith(".swc")
 						&& (fileName.contains("playerglobal") || fileName.contains("airglobal"))) {
 					try {
 						File jarPath = new File(VSCodePackageDITAParser.class.getProtectionDomain().getCodeSource()
@@ -395,20 +408,6 @@ private InputStream getPackageDITAStream(String packageName) {
 					} catch (FileNotFoundException e) {
 						return null;
 					}
-				} else {
-					String filePath = "docs/" + packageName + ".xml";
-					ISWC swc = workspace.getSWCManager().get(new File(swcFilePath));
-					if (swc == null) {
-						return null;
-					}
-					try {
-						ZipFile zipFile = new ZipFile(swc.getSWCFile());
-						stream = SWCReader.getInputStream(zipFile, filePath);
-					} catch (ZipException e) {
-						return null;
-					} catch (IOException e) {
-						return null;
-					}
 				}
 				return stream;
 			}

language-server/src/main/java/com/as3mxml/vscode/utils/DefinitionDocumentationUtils.java

@@ -47,6 +47,12 @@
 public class DefinitionDocumentationUtils {
     private static final String SDK_LIBRARY_PATH_SIGNATURE_UNIX = "/frameworks/libs/";
     private static final String SDK_LIBRARY_PATH_SIGNATURE_WINDOWS = "\\frameworks\\libs\\";
+    private static final String LOCALE_EN_US = "locale/en_US/";
+    private static final String PLAYERGLOBAL = "playerglobal";
+    private static final String AIRGLOBAL = "airglobal";
+    private static final String RB_SWC_SUFFIX = "_rb.swc";
+    private static final String FRAMEWORKS = "frameworks";
+    private static final String FILE_EXTENSION_SWC = ".swc";
 
     public static String getDocumentationForDefinition(IDefinition definition, boolean useMarkdown,
             ICompilerProject project, boolean allowDITA) {
@@ -96,7 +102,8 @@ private static VSCodeASDocComment getCommentForDefinition(IDocumentableDefinitio
             boolean useMarkdown, IWorkspace workspace, boolean allowDITA) {
         VSCodeASDocComment comment = (VSCodeASDocComment) documentableDefinition.getExplicitSourceComment();
         String definitionFilePath = documentableDefinition.getContainingFilePath();
-        if (allowDITA && comment == null && definitionFilePath != null && definitionFilePath.endsWith(".swc")) {
+        if (allowDITA && comment == null && definitionFilePath != null
+                && definitionFilePath.endsWith(FILE_EXTENSION_SWC)) {
             IDITAList ditaList = null;
             File swcFile = new File(definitionFilePath);
             if (swcFile.exists()) {
@@ -105,24 +112,34 @@ private static VSCodeASDocComment getCommentForDefinition(IDocumentableDefinitio
                 String fileName = swcFile.getName();
                 ditaList = swc.getDITAList();
 
-                // next, if it's a SDK/framework liberary, check for an
+                // next, if it's a SDK/framework library, check for an
                 // associated resource bundle .swc
                 if (ditaList == null && (definitionFilePath.contains(SDK_LIBRARY_PATH_SIGNATURE_UNIX)
                         || definitionFilePath.contains(SDK_LIBRARY_PATH_SIGNATURE_WINDOWS))) {
-                    String rbName = fileName.substring(0, fileName.length() - 4) + "_rb.swc";
+                    String swcBaseName = fileName.substring(0, fileName.length() - 4);
+                    String rbName = swcBaseName + RB_SWC_SUFFIX;
                     File frameworksDir = swcFile.getParentFile();
-                    while (!frameworksDir.getName().equals("frameworks")) {
+                    while (!frameworksDir.getName().equals(FRAMEWORKS)) {
                         frameworksDir = frameworksDir.getParentFile();
                     }
-                    File rbSwcFile = new File(frameworksDir, "locale/en_US/" + rbName);
+                    File rbSwcFile = new File(frameworksDir, LOCALE_EN_US + rbName);
                     if (rbSwcFile.exists()) {
                         ISWC rbSwc = workspace.getSWCManager().get(rbSwcFile);
                         ditaList = rbSwc.getDITAList();
+                    } else if (fileName.contains(AIRGLOBAL)) {
+                        // airglobal_rb.swc may not exist, but
+                        // playerglobal_rb.swc may be used as a fallback
+                        rbName = PLAYERGLOBAL + RB_SWC_SUFFIX;
+                        rbSwcFile = new File(frameworksDir, LOCALE_EN_US + rbName);
+                        if (rbSwcFile.exists()) {
+                            ISWC rbSwc = workspace.getSWCManager().get(rbSwcFile);
+                            ditaList = rbSwc.getDITAList();
+                        }
                     }
                 }
                 // finally, fall back to the bundled documentation for
                 // playerglobal or airglobal, if the filename matches
-                if (ditaList == null && (fileName.contains("playerglobal") || fileName.contains("airglobal"))) {
+                if (ditaList == null && (fileName.contains(PLAYERGLOBAL) || fileName.contains(AIRGLOBAL))) {
                     try {
                         File jarPath = new File(DefinitionDocumentationUtils.class.getProtectionDomain().getCodeSource()
                                 .getLocation().toURI());