change up handleOpen() to better handle example sketches for different Modes

Author: benfry

app/src/processing/app/Base.java

@@ -1207,7 +1207,7 @@ public void handleNew() {
       }
 
       String path = newbieFile.getAbsolutePath();
-      handleOpen(path, true);
+      handleOpenUntitled(path);
 
     } catch (IOException e) {
       Messages.showWarning("That's new to me",
@@ -1307,7 +1307,7 @@ private Editor openSketchBundle(String path) {
         if (fileList.length == 1) {
           File sketchFile = Sketch.findMain(fileList[0], getModeList());
           if (sketchFile != null) {
-            return handleOpen(sketchFile.getAbsolutePath(), true);
+            return handleOpenUntitled(sketchFile.getAbsolutePath());
           }
         } else {
           System.err.println("Expecting one folder inside " +
@@ -1441,6 +1441,7 @@ private File moveLikeSketchFolder(File pdeFile, String baseName) throws IOExcept
     return null;
   }
 
+
   /**
    * Open a sketch from the path specified. Do not use for untitled sketches.
    * Note that the user may have selected/double-clicked any .pde in a sketch.
@@ -1516,11 +1517,11 @@ public Editor handleOpen(String path) {
             // for now, post a warning if the main was different
             System.out.println(path + " selected, but main is " + mainPath);
           }
-          return handleOpen(mainPath, false);
+          return handleOpenInternal(mainPath, false);
 
         } else {
           // if no main specified, use the passed-in path as the main
-          return handleOpen(path, false);
+          return handleOpenInternal(path, false);
         }
       } else {
         // No properties file, so do some checks to make sure the file
@@ -1603,7 +1604,7 @@ public Editor handleOpen(String path) {
           nextMode = mode;
         }
         */
-        handleOpen(pdeFile.getAbsolutePath(), false);
+        handleOpenInternal(pdeFile.getAbsolutePath(), false);
       }
     } catch (IOException e) {
       Messages.showWarning("sketch.properties",
@@ -1614,84 +1615,36 @@ public Editor handleOpen(String path) {
 
 
   /**
-   * Open a sketch in a new window.
-   * @param path Path to the pde file for the sketch in question
-   * @return the Editor object, so that properties (like 'untitled')
-   *         can be set by the caller
+   * Open a (vetted) sketch location using a particular Mode. Used by the
+   * Examples window, because Modes like Python and Android do not have
+   * "sketch.properties" files in each example folder.
    */
-  protected Editor handleOpen(String path, boolean untitled) {
-    return handleOpen(path, untitled, EditorState.nextEditor(editors));
+  public Editor handleOpen(String path, Mode mode) {
+    nextMode = mode;
+    return handleOpenInternal(path, false);
   }
 
 
-  protected Editor handleOpen(String path, boolean untitled,
-                              EditorState state) {
-    /*
-    return handleOpen(path, untitled, state, nextMode);
+  /**
+   * Open the sketch associated with this .pde file in a new window
+   * as an "Untitled" sketch.
+   * @param path Path to the pde file for the sketch in question
+   * @return the Editor object, so that properties (like 'untitled')
+   *         can be set by the caller
+   */
+  protected Editor handleOpenUntitled(String path) {
+    return handleOpenInternal(path, true);
   }
 
-  protected Editor handleOpen(String path, boolean untitled,
-                              EditorState state, Mode mode) {
-    try {
-      final File file = new File(path);
-      if (!file.exists()) {
-        return null;
-      }
-
-      // Cycle through open windows to make sure that it's not already open.
-      for (Editor editor : editors) {
-        // User may have double-clicked any PDE in the sketch folder,
-        // so we have to check each open tab (not just the main one).
-        // https://github.com/processing/processing/issues/2506
-        for (SketchCode tab : editor.getSketch().getCode()) {
-          if (tab.getFile().equals(file)) {
-            editor.toFront();
-            // move back to the top of the recent list
-            Recent.append(editor);
-            return editor;
-          }
-        }
-      }
-
-      // read the sketch.properties file if it exists
-      File parentFolder = new File(path).getParentFile();
-      Settings props = loadSketchProperties(parentFolder);
-
-      // if the Mode is set in this file, use that to determine next
-      if (props != null) {
-        String modeIdentifier = props.get("mode.id");
-        if (modeIdentifier != null) {
-          Mode mode = findMode(modeIdentifier);
-          if (mode != null) {
-            nextMode = mode;
-          } else {
-            Messages.showWarning("Missing Mode",
-                "You must first install " + props.get("mode") + " Mode to use this sketch.");
-            ContributionManager.openModes();
-            return null;
-          }
-        }
-      }
-
-      if (!Sketch.isSanitaryName(file.getName())) {
-        Messages.showWarning("You're tricky, but not tricky enough",
-                             file.getName() + " is not a valid name for a sketch.\n" +
-                             "Better to stick to ASCII, no spaces, and make sure\n" +
-                             "it doesn't start with a number.", null);
-        return null;
-      }
-
-      if (!nextMode.canEdit(file)) {
-        final Mode mode = selectMode(file);
-        if (mode == null) {
-          return null;
-        }
-        nextMode = mode;
-      }
-      */
 
+  /**
+   * Internal function to actually open the sketch. At this point, the
+   * sketch file/folder must have been vetted, and nextMode set properly.
+   */
+  protected Editor handleOpenInternal(String path, boolean untitled) {
     try {
       try {
+        EditorState state = EditorState.nextEditor(editors);
         Editor editor = nextMode.createEditor(this, path, state);
 
         // opened successfully, let's go to work

app/src/processing/app/ui/ExamplesFrame.java

@@ -117,7 +117,7 @@ public void mouseClicked(MouseEvent e) {
           //if (node != null && node.isLeaf() && node.getPath().equals(selPath)) {
           if (node != null && node.isLeaf() && selRow != -1) {
             SketchReference sketch = (SketchReference) node.getUserObject();
-            base.handleOpen(sketch.getPath());
+            base.handleOpen(sketch.getPath(), mode);
           }
         }
       }
@@ -134,7 +134,7 @@ public void keyTyped(KeyEvent e) {
             (DefaultMutableTreeNode) tree.getLastSelectedPathComponent();
           if (node != null && node.isLeaf()) {
             SketchReference sketch = (SketchReference) node.getUserObject();
-            base.handleOpen(sketch.getPath());
+            base.handleOpen(sketch.getPath(), mode);
           }
         }
       }

todo.txt

@@ -5,9 +5,14 @@ X You must first install tweak Mode to use this sketch
 X   https://github.com/processing/processing4/issues/415
 X Change straight quotes to smart quotes in the PDE.properties file
 X look for other uses of Util.deleteFile() and replace with Platform calls
-_ test with Python Mode before release
-_   opening an example throws an NPE
-_   add changes for the eawt mess?
+X change handleOpen() to take a Mode object
+X   allows Python and Android Mode to open example sketches in that Mode,
+X   without (retroactively) needing sketch.properties files in all folders
+
+python
+X add JavaFX handler
+X opening an example throws an NPE
+_ add changes for the eawt mess?
 
 sketchbook/open/deletions
 X test "obvious" sketch folder (and whether it prompts)
@@ -34,6 +39,9 @@ _ examples handling is less than ideal
 _   examples not mentioned in warning dialog when installing
 _   doesn't show in examples window for p5jsMode
 _   the extra "Contributed Examples" subfolder is awkward
+_   perhaps more important, examples need to specify their Mode
+_     not ideal for Android since there's some crossover, but ok for Example sets
+_     otherwise impossible to know how to populate the Examples window
 
 
 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .