Overhaul Clipboard: Now uses the system clipboard.

This is a major change that was a long time coming. ModuleSim now uses the system's clipboard, so you can Copy/Paste between documents / open ModuleSim windows.

This utilises XML in the clipboard as plain text.

Other changes:
- Labels are now copied
- You can copy a file into a new one. Just copy the file in your file manager (e.g. Windows Explorer) and paste it into the new module sim file.

Author: Ed Nutting

src/com/modsim/modules/BaseModule.java

@@ -704,15 +704,33 @@ public void propagateDirectionality(BidirPort root) {
      * Called by XMLReader and copy routines. Default behaviour is no-op.
      * @param data Structure containing state to load (module-defined elements)
      */
-    public void dataIn(HashMap<String, String> data) {}
+    public void dataIn(HashMap<String, String> data) {
+        if (data.containsKey("label")) {
+            label = data.get("label");
+        }
+        if (data.containsKey("label_size")) {
+            String sizeStr = data.get("label_size");
+            try {
+                labelSize = Integer.parseInt(sizeStr);
+            } catch (NumberFormatException e) {
+                System.err.println("Warning: unable to parse label_size:");
+                e.printStackTrace();
+            }
+        }
+    }
 
     /**
      * Fill a string-string hash map with module-specific data for retrieval with dataIn.
      * Called by XMLWriter and the copy routines. Default behaviour is to return null, indicating that no relevant
      * data is contained in the module.
      * @return A filled hash map structure, or null if no state is stored
      */
-    public HashMap<String, String> dataOut() { return null; }
+    public HashMap<String, String> dataOut() {
+        HashMap<String, String> dataMap = new HashMap<>();
+        dataMap.put("label", label);
+        dataMap.put("label_size", Integer.toString(labelSize));
+        return dataMap;
+     }
 
     public enum AvailableModules {
         // Enum members should not be renamed!

src/com/modsim/modules/Clock.java

@@ -118,6 +118,8 @@ public void propagate() {
 
     @Override
     public void dataIn(HashMap<String, String> data) {
+        super.dataIn(data);
+
         if (data.containsKey("clock_phase")) {
             String phaseStr = data.get("clock_phase");
             try {
@@ -131,7 +133,7 @@ public void dataIn(HashMap<String, String> data) {
 
     @Override
     public HashMap<String, String> dataOut() {
-        HashMap<String, String> dataMap = new HashMap<>();
+        HashMap<String, String> dataMap = super.dataOut();
         dataMap.put("clock_phase", String.valueOf(step));
         return dataMap;
     }

src/com/modsim/modules/LEDMatrix.java

@@ -124,16 +124,18 @@ public boolean isPersistEnabled(){
 
 	@Override
     public HashMap<String, String> dataOut() {
-        if (!isPersistEnabled()) return null;
+        if (!isPersistEnabled()) return super.dataOut();
 
-        HashMap<String, String> data = new HashMap<>();
+        HashMap<String, String> data = super.dataOut();
         data.put("persist", "1");
 
         return data;
     }
 
 	@Override
     public void dataIn(HashMap<String, String> data) {
+        super.dataIn(data);
+
         if (data.containsKey("persist")) {
             String storeStr = data.get("persist");
             try{

src/com/modsim/modules/NRAM.java

@@ -175,6 +175,8 @@ public void clear() {
 
     @Override
     public void dataIn(HashMap<String, String> data) {
+        super.dataIn(data);
+
         if (data.containsKey("memory_store")) {
             String storeStr = data.get("memory_store");
             HexReader.readString(storeStr, this);
@@ -192,9 +194,9 @@ public void dataIn(HashMap<String, String> data) {
     @Override
     public HashMap<String, String> dataOut() {
         String storeStr = HexWriter.hexString(this, false);
-        if (storeStr.isEmpty()) return null;
+        if (storeStr.isEmpty()) return super.dataOut();
 
-        HashMap<String, String> data = new HashMap<>();
+        HashMap<String, String> data = super.dataOut();
         data.put("memory_store", storeStr);
         data.put("write_jumper", (writeJumper.getEnabled()) ? "1" : "0");
 

src/com/modsim/modules/Register.java

@@ -109,14 +109,16 @@ public void clear() {
 
     @Override
     public HashMap<String, String> dataOut() {
-        HashMap<String, String> dataMap = new HashMap<>();
+        HashMap<String, String> dataMap = super.dataOut();
         String latched = myData.toString();
         dataMap.put("latched_value", latched);
         return dataMap;
     }
 
     @Override
     public void dataIn(HashMap<String, String> data) {
+        super.dataIn(data);
+
         if (data.containsKey("latched_value")) {
             // Parse latched value
             String str = data.get("latched_value");

src/com/modsim/modules/SwitchInput.java

@@ -98,6 +98,8 @@ public void propagate() {
 
 	@Override
 	public void dataIn(HashMap<String, String> data) {
+        super.dataIn(data);
+
 		if (data.containsKey("switch_set")) {
 			// Parse switch setting
 			String str = data.get("switch_set");
@@ -121,7 +123,7 @@ public void dataIn(HashMap<String, String> data) {
 
 	@Override
 	public HashMap<String, String> dataOut() {
-		HashMap<String, String> data = new HashMap<>();
+		HashMap<String, String> data = super.dataOut();
 		String setting;
 		setting  = s1.getEnabled() ? "1" : "0";
 		setting += s2.getEnabled() ? "1" : "0";

src/com/modsim/operations/Ops.java

@@ -187,7 +187,13 @@ public static void fileNew() {
             Main.ui.view.cancelTool();
 
             if (!Main.clipboard.isEmpty()) {
-                Main.ui.view.setTool(new PlaceTool(Main.clipboard));
+                try {
+                    Main.ui.view.setTool(new PlaceTool(Main.clipboard));
+                }
+                catch (Exception e) {
+                    // Clipboard contents may not be valid
+                    System.out.println(e.getMessage());
+                }
             }
             else {
                 System.out.println("Nothing to paste");

src/com/modsim/tools/PlaceTool.java

@@ -34,9 +34,11 @@ public PlaceTool(PickableEntity e) {
 
     /**
      * Acts as a 'pasteInto' tool for the given clipboard
+     * 
      * @param clipboard Clipboard containing com.modsim.modules to 'pasteInto'
+     * @throws Exception
      */
-    public PlaceTool(ModuleClipboard clipboard) {
+    public PlaceTool(ModuleClipboard clipboard) throws Exception {
         Main.opStack.beginCompoundOp();
         entities = clipboard.paste();