Changeset 292 in josm for src/org/openstreetmap/josm/plugins

Timestamp:

2007-07-19T23:19:21+02:00 (18 years ago)

Author:

imi

Message:

• fixed Bug Report module to work better with plugins
• fixed Plugin.getPreferenceDir and Plugin.copy
• fixed Ctrl-Q not asking for changed data
• fixed several typos in Shortcuts
• removed check for latest josm version

Location:

src/org/openstreetmap/josm/plugins

Files:

• Plugin.java (modified) (4 diffs)
• PluginInformation.java (modified) (2 diffs)
• PluginProxy.java (modified) (1 diff)

src/org/openstreetmap/josm/plugins/Plugin.java

@@ -6 +6 @@
 import java.io.IOException;
 import java.io.InputStream;
-import java.net.URL;
-import java.net.URLClassLoader;
 import java.util.List;
 
@@ -17 +15 @@
 /**
  * All plugins *must* have an standard constructor taking no arguments.
+ *
  * This constructor is called at JOSM startup, after all Main-objects have been initialized.
  * For all purposes of loading dynamic resources, the Plugin's class loader should be used
  * (or else, the plugin jar will not be within the class path).
  *
- * All plugins should have at least one class subclassing this abstract base class.
+ * A plugin may subclass this abstract base class (but it is optional).
  *
- * The actual implementation of this interface is optional, as all functions will be called
- * via reflection. This is to be able to change this interface without the need of recompiling
- * or even breaking the plugins. If your class does not provide a function here (or does
- * provide a function with a mismatching signature), it will not be called. That simple.
+ * The actual implementation of this class is optional, as all functions will be called
+ * via reflection. This is to be able to change this interface without the need of 
+ * recompiling or even breaking the plugins. If your class does not provide a
+ * function here (or does provide a function with a mismatching signature), it will not
+ * be called. That simple.
  *
- * Or in other words: See this base class as an documentation of what functions are provided.
- * Subclassing it and overriding some functions makes it easy for you to keep sync with the
- * correct actual plugin architecture of JOSM.
- *
- *
- * The pluginname provided to the constructor is also the name of the directory to
- * store the plugin's own stuff (located under the josm preferences directory)
+ * Or in other words: See this base class as an documentation of what automatic callbacks
+ * are provided (you can register yourself to more callbacks in your plugin class
+ * constructor).
+ * 
+ * Subclassing Plugin and overriding some functions makes it easy for you to keep sync
+ * with the correct actual plugin architecture of JOSM.
  *
  * @author Immanuel.Scholz
@@ -40 +39 @@
 public abstract class Plugin {
 
-        String name;
-
-        public Plugin() {
-                try {
-                URL[] urls = ((URLClassLoader)getClass().getClassLoader()).getURLs();
-                name = urls[urls.length-1].toString();
-                if (name.toLowerCase().endsWith(".jar")) {
-                        int lastSlash = name.lastIndexOf('/');
-                        name = name.substring(lastSlash+1, name.length()-4);
-                }
-        } catch (RuntimeException e) {
-                name = "unknown";
-        }
-    }
+        /**
+         * This is the info available for this plugin. You can access this from your
+         * constructor.
+         *
+         * (The actual implementation to request the info from a static variable
+         * is a bit hacky, but it works).
+         */
+        public final PluginInformation info = PluginInformation.currentPluginInitialization;
 
         /**
-         * @return The name of this plugin. This is the name of the .jar file.
-         * @deprecated Plugins have to know their name by themself.
+         * @return The directory for the plugin to store all kind of stuff.
          */
-        @Deprecated public final String getName() {
-                return name;
+        public final String getPluginDir() {
+                return Main.pref.getPreferencesDir()+"plugins/"+info.name+"/";
         }
-        /**
-         * @return The directory for the plugin to store all kind of stuff.
-         * @deprecated Use <code>Main.pref.getPreferencesDir()+"plugins/"+name+"/";</code> instead.
-         */
-        @Deprecated public final String getPluginDir() {
-                return Main.pref.getPreferencesDir()+"plugins/"+name+"/";
-        }
-
-
 
         /**
@@ -92 +75 @@
         
         /**
-         * @deprecated Use copy(String pluginName, String from, String to) instead
-         */
-        @Deprecated public void copy(String from, String to) throws FileNotFoundException, IOException {
-                copy(name, from, to);
-    }
-
-        /**
          * Copies the ressource 'from' to the file in the plugin directory named 'to'.
          */
-        public void copy(String pluginName, String from, String to) throws FileNotFoundException, IOException {
-            String pluginDirName = Main.pref.getPreferencesDir()+"plugins/"+pluginName+"/";
-                File pluginDir = new File(pluginDirName);
-                if (!pluginDir.exists())
-                        pluginDir.mkdirs();
-        FileOutputStream out = new FileOutputStream(pluginDirName+to);
-        InputStream in = getClass().getResourceAsStream(from);
-        byte[] buffer = new byte[8192];
-        for(int len = in.read(buffer); len > 0; len = in.read(buffer))
-                out.write(buffer, 0, len);
-        in.close();
-        out.close();
+        public void copy(String from, String to) throws FileNotFoundException, IOException {
+                String pluginDirName = Main.pref.getPreferencesDir()+"plugins/"+info.name+"/";
+        File pluginDir = new File(pluginDirName);
+        if (!pluginDir.exists())
+                pluginDir.mkdirs();
+        FileOutputStream out = new FileOutputStream(pluginDirName+to);
+        InputStream in = getClass().getResourceAsStream(from);
+        byte[] buffer = new byte[8192];
+        for(int len = in.read(buffer); len > 0; len = in.read(buffer))
+                out.write(buffer, 0, len);
+        in.close();
+        out.close();
     }
 }

src/org/openstreetmap/josm/plugins/PluginInformation.java

@@ -36 +36 @@
 
         public final Map<String, String> attr = new TreeMap<String, String>();
+
+        /**
+         * Used in the Plugin constructor to make the information of the plugin
+         * that is currently initializing available.
+         * 
+         * If you think this is hacky, you are probably right. But it is 
+         * convinient anyway ;-) 
+         */
+        static PluginInformation currentPluginInitialization = null;
 
         /**
@@ -102 +111 @@
         public PluginProxy load(Class<?> klass) {
                 try {
+                        currentPluginInitialization = this;
                         return new PluginProxy(klass.newInstance(), this);
                 } catch (Exception e) {

src/org/openstreetmap/josm/plugins/PluginProxy.java

@@ -19 +19 @@
         public final Object plugin;
         public final PluginInformation info;
-        public boolean misbehaving = false;
 
         public PluginProxy(Object plugin, PluginInformation info) {
                 this.plugin = plugin;
                 this.info = info;
-
-                // setting name of the plugin by reflection
-                if (plugin instanceof Plugin) {
-                        try {
-                        Plugin.class.getDeclaredField("name").set(plugin, info.name);
-                } catch (Exception e) {
-                        if (e instanceof RuntimeException)
-                                throw (RuntimeException)e;
-                        throw new RuntimeException(e);
-                }
-                }
     }