Remove extra ways for references to be included

joelmoniz · joelmoniz · commit cc68c83923ac · 2014-11-18T05:26:34.000+05:30
diff --git a/app/src/processing/app/Editor.java b/app/src/processing/app/Editor.java
@@ -1279,12 +1279,8 @@ public void showReferenceFile(File file) {
       e.printStackTrace();
     }
 
-    if (file.toString().endsWith(".txt"))
-      // To enable readme.txt files to open as well
-      Base.openFolder(file);
-    else
-      // Prepend with file:// and also encode spaces & other characters
-      Base.openURL(file.toURI().toString());
+    // Prepend with file:// and also encode spaces & other characters
+    Base.openURL(file.toURI().toString());
   }
 
 
diff --git a/app/src/processing/app/Library.java b/app/src/processing/app/Library.java
@@ -13,7 +13,7 @@ public class Library extends LocalContribution {
   //protected File folder;          // /path/to/shortname
   protected File libraryFolder;   // shortname/library
   protected File examplesFolder;  // shortname/examples
-  protected File referenceFile;   // shortname/reference/index.html is one possible path
+  protected File referenceFile;   // shortname/reference/index.html
 
   /**
    * Subfolder for grouping libraries in a menu. Basic subfolder support
@@ -212,8 +212,6 @@ private Library(File folder, String groupName) {
 
     // get the path for all .jar files in this code folder
     packageList = Base.packageListFromClassPath(getClassPath());
-    
-    referenceFile = loadReferenceIndexFile(folder);
   }
 
 
@@ -518,27 +516,6 @@ public ContributionType getType() {
   }
 
 
-  /**
-   * @param folder
-   *          The file object representing the base folder of the contribution
-   * @return Returns a file object representing the index file of the reference
-   */
-  protected File loadReferenceIndexFile(File folder) {
-    final String potentialFileList[] = {
-      "reference/index.html", "reference/index.htm",
-      "documentation/index.html", "documentation/index.htm", "docs/index.html",
-      "docs/index.htm", "documentation.html", "documentation.htm",
-      "reference.html", "reference.htm", "docs.html", "docs.htm", "readme.txt" };
-
-    int i = 0;
-    File potentialRef = new File(folder, potentialFileList[i]);
-    while (!potentialRef.exists() && ++i < potentialFileList.length) {
-      potentialRef = new File(folder, potentialFileList[i]);
-    }
-    return potentialRef;
-  }
-
-
   /**
    * Returns the object stored in the referenceFile field, which contains an
    * instance of the file object representing the index file of the reference
diff --git a/app/src/processing/app/contrib/ToolContribution.java b/app/src/processing/app/contrib/ToolContribution.java
@@ -35,7 +35,7 @@
 public class ToolContribution extends LocalContribution implements Tool {
   private Tool tool;
 
-  private File referenceFile; // shortname/reference/index.html is one possible path
+  private File referenceFile; // shortname/reference/index.html
 
   static public ToolContribution load(File folder) {
     try {
@@ -61,7 +61,7 @@ private ToolContribution(File folder) throws Exception {
       tool = (Tool) toolClass.newInstance();
     }
 
-    referenceFile = loadReferenceIndexFile(folder);
+    referenceFile = new File(folder, "reference/index.html");
   }
 
 
@@ -158,27 +158,6 @@ public ContributionType getType() {
   }
 
 
-  /**
-   * @param folder
-   *          The file object representing the base folder of the contribution
-   * @return Returns a file object representing the index file of the reference
-   */
-  protected File loadReferenceIndexFile(File folder) {
-    final String potentialFileList[] = {
-      "reference/index.html", "reference/index.htm",
-      "documentation/index.html", "documentation/index.htm", "docs/index.html",
-      "docs/index.htm", "documentation.html", "documentation.htm",
-      "reference.html", "reference.htm", "docs.html", "docs.htm", "readme.txt" };
-
-    int i = 0;
-    File potentialRef = new File(folder, potentialFileList[i]);
-    while (!potentialRef.exists() && ++i < potentialFileList.length) {
-      potentialRef = new File(folder, potentialFileList[i]);
-    }
-    return potentialRef;
-  }
-
-
   /**
    * Returns the object stored in the referenceFile field, which contains an
    * instance of the file object representing the index file of the reference
diff --git a/app/src/processing/mode/java/JavaEditor.java b/app/src/processing/mode/java/JavaEditor.java
@@ -340,8 +340,8 @@ private boolean addToolReferencesToSubMenu(ArrayList<ToolContribution> toolsList
     Iterator<ToolContribution> iter = toolsList.iterator();
     while (iter.hasNext()) {
       final ToolContribution toolContrib = iter.next();
-      if (toolContrib.hasReference()) {
-        final File toolRef = toolContrib.getReferenceIndexFile();
+      final File toolRef = new File(toolContrib.getFolder(), "reference/index.html");
+      if (toolRef.exists()) {
         JMenuItem libRefItem = new JMenuItem(toolContrib.getName());
         libRefItem.addActionListener(new ActionListener() {
 

Original file line number	Diff line number	Diff line change
`@@ -1279,12 +1279,8 @@ public void showReferenceFile(File file) {`
`1279`	`1279`	`e.printStackTrace();`
`1280`	`1280`	`}`
`1281`	`1281`
`1282`		`- if (file.toString().endsWith(".txt"))`
`1283`		`- // To enable readme.txt files to open as well`
`1284`		`- Base.openFolder(file);`
`1285`		`- else`
`1286`		`- // Prepend with file:// and also encode spaces & other characters`
`1287`		`- Base.openURL(file.toURI().toString());`
	`1282`	`+ // Prepend with file:// and also encode spaces & other characters`
	`1283`	`+ Base.openURL(file.toURI().toString());`
`1288`	`1284`	`}`
`1289`	`1285`
`1290`	`1286`