From 06c76ed1c3602fc76b9d7c3794e837e0f99ecebf Mon Sep 17 00:00:00 2001
From: Rob Greene <robgreene@gmail.com>
Date: Sat, 25 Jun 2022 20:04:27 -0500
Subject: [PATCH] Adding support for GS/OS mixed case names. #84

---
 .../storage/os/prodos/ProdosFileEntry.java    | 160 ++++++++++--------
 .../os/prodos/ProdosFileEntryTest.java        |  69 ++++++++
 2 files changed, 159 insertions(+), 70 deletions(-)
 create mode 100644 lib/ac-api/src/test/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntryTest.java

diff --git a/lib/ac-api/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntry.java b/lib/ac-api/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntry.java
index 060391d..d2e10e6 100644
--- a/lib/ac-api/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntry.java
+++ b/lib/ac-api/src/main/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntry.java
@@ -24,6 +24,7 @@ import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
+import java.util.function.Function;
 
 import com.webcodepro.applecommander.storage.DiskFullException;
 import com.webcodepro.applecommander.storage.FileEntry;
@@ -61,13 +62,14 @@ public class ProdosFileEntry extends ProdosCommonEntry implements FileEntry {
 	
 	/**
 	 * Return the name of this file.
-	 * This handles normal files, deleted files, and AppleWorks files - which use
-	 * the AUXTYPE attribute to indicate upper/lowercase in the filename.
+	 * This handles normal files, deleted files, AppleWorks files - which use
+	 * the AUXTYPE attribute to indicate upper/lowercase in the filename, and
+	 * GS/OS casing which is in the ProDOS version flags.
+	 * Note that we don't do mixed case for deleted files.
 	 */
 	public String getFilename() {
-		String fileName;
 		if (isDeleted()) {
-			fileName = AppleUtil.getString(readFileEntry(), 1, 15);
+			String fileName = AppleUtil.getString(readFileEntry(), 1, 15);
 			StringBuffer buf = new StringBuffer();
 			for (int i=0; i<fileName.length(); i++) {
 				char ch = fileName.charAt(i);
@@ -77,55 +79,53 @@ public class ProdosFileEntry extends ProdosCommonEntry implements FileEntry {
 					break;
 				}
 			}
-			fileName = buf.toString();
-		} else {
-			fileName = AppleUtil.getProdosString(readFileEntry(), 0);
-		}
-		if (isAppleWorksFile()) {
-			int auxtype = getAuxiliaryType();
-			StringBuffer mixedCase = new StringBuffer(fileName);
-			// the highest bit of the least significant byte is the first
-			// character through the 2nd bit of the most significant byte
-			// being the 15th character.  Bit is on indicates lower-case or
-			// a space if a "." is present.
-			for (int i=0; i<16 && i<fileName.length(); i++) {
-				boolean lowerCase;
-				if (i < 8) {
-					lowerCase = AppleUtil.isBitSet((byte)auxtype, 7-i);
-				} else {
-					lowerCase = AppleUtil.isBitSet((byte)(auxtype >> 8), 7-(i%8));
-				}
-				if (lowerCase) {
-					char ch = mixedCase.charAt(i);
-					if (ch == '.') {
-						mixedCase.setCharAt(i, ' ');
-					} else {
-						mixedCase.setCharAt(i, Character.toLowerCase(ch));
-					}
-				}
-			}
-			fileName = mixedCase.toString();
-		}
-		// GS/OS upper/lower case mix
-		if ((getMinimumProdosVersion() & 0x80) != 0) {
-		    int flags = getMinimumProdosVersion() << 8 | getProdosVersion();
-			int bit = 1 << 14;   // 1st bit in 16 bit number is enablement flag, so skipping it
-			StringBuffer mixedCase = new StringBuffer(fileName);
-			for (int i=0; i<16 && i<fileName.length(); i++) {
-			    boolean lowerCase = (flags & bit) != 0;
-                if (lowerCase) {
-                    char ch = mixedCase.charAt(i);
-                    if (ch == '.') {
-                        mixedCase.setCharAt(i, ' ');
-                    } else {
-                        mixedCase.setCharAt(i, Character.toLowerCase(ch));
-                    }
+			return buf.toString();
+		} 
+		else {
+			String fileName = AppleUtil.getProdosString(readFileEntry(), 0);
+	        if (isAppleWorksFile()) {
+	            int auxtype = getAuxiliaryType();
+	            fileName = getMixedCaseName(fileName, auxtype, ProdosFileEntry::calculateAppleWorksBit);
+	        }
+	        // GS/OS upper/lower case mix
+	        else if ((getMinimumProdosVersion() & 0x80) != 0) {
+	            int flags = getMinimumProdosVersion() << 8 | getProdosVersion();
+	            fileName = getMixedCaseName(fileName, flags, ProdosFileEntry::calculateGSOSBit);
+	        }
+	        return fileName;
+	    }
+	}
+	/**
+     * the highest bit of the least significant byte is the first
+     * character through the 2nd bit of the most significant byte
+     * being the 15th character.  Bit is on indicates lower-case or
+     * a space if a "." is present.
+     */
+    static int calculateAppleWorksBit(int pos) {
+        final int[] bitTest = { 7, 6, 5, 4, 3, 2, 1, 0, 15, 14, 13, 12, 11, 10, 9 };
+        return 1 << bitTest[pos];
+    }
+    /**
+     * 1st bit in 16 bit number is enablement flag, so skipping it
+     * flags = e01234567 89ABCDEF  (e = enablement flag; hex digits = character index)
+     */
+    static int calculateGSOSBit(int pos) {
+        return 1 << (14-pos);
+    }	
+	static String getMixedCaseName(final String original, final int bits, 
+	        final Function<Integer,Integer> bitPosition) {
+	    StringBuffer mixedCase = new StringBuffer(original);
+	    for (int i=0; i<mixedCase.length(); i++) {
+	        if ((bits & bitPosition.apply(i)) != 0) {
+	            char ch = mixedCase.charAt(i);
+                if (ch == '.') {
+                    mixedCase.setCharAt(i, ' ');
+                } else {
+                    mixedCase.setCharAt(i, Character.toLowerCase(ch));
                 }
-                bit >>= 1;
-			}
-			fileName = mixedCase.toString();
-		}
-		return fileName;
+	        }
+	    }
+	    return mixedCase.toString();
 	}
 
 	/**
@@ -137,31 +137,51 @@ public class ProdosFileEntry extends ProdosCommonEntry implements FileEntry {
 
 	/**
 	 * Set the name of this file.
+     * This handles normal files, deleted files, AppleWorks files - which use
+     * the AUXTYPE attribute to indicate upper/lowercase in the filename, and
+     * GS/OS casing which is in the ProDOS version flags.
 	 */
 	public void setFilename(String filename) {
-		byte[] fileEntry = readFileEntry();
-		if (isDeleted()) {
-			AppleUtil.setString(fileEntry, 1, filename.toUpperCase(), 15);
-		} else {
-			AppleUtil.setProdosString(fileEntry, 0, filename.toUpperCase(), 15);
-		}
+	    // 1. Set the upper/lowercase flags
 		if (isAppleWorksFile()) {
-			byte lowByte = 0;
-			byte highByte = 0;
-			for (int i=0; i<filename.length(); i++) {
-				if (Character.isLowerCase(filename.charAt(i))) {
-					if (i < 8) {
-						lowByte = AppleUtil.setBit(lowByte, 7-i);
-					} else if (i < 16) {
-						highByte = AppleUtil.setBit(highByte, 7-(i%8));
-					}
-				}
-			}
-			setAuxiliaryType(fileEntry, lowByte, highByte);
+		    // Since we are ALWAYS doing the GSOS filename, we just have a temp holder here.
+		    StringBuilder tempFilename = new StringBuilder(filename);
+		    int auxtype = setMixedCaseFlags(tempFilename, ProdosFileEntry::calculateAppleWorksBit);
+		    setAuxiliaryType(auxtype);
 		}
+		StringBuilder alternateFilename = new StringBuilder(filename);
+		int flags = setMixedCaseFlags(alternateFilename, ProdosFileEntry::calculateGSOSBit);
+		if (flags != 0) {
+		    // high bit signals mixed case
+		    flags |= 0x8000;  
+		}
+		filename = alternateFilename.toString();
+		setMinimumProdosVersion(flags >> 8);
+		setProdosVersion(flags);
+
+		// 2. Set the filename details as the result should be all uppercase.
+		byte[] fileEntry = readFileEntry();
+        if (isDeleted()) {
+            AppleUtil.setString(fileEntry, 1, filename.toUpperCase(), 15);
+        } else {
+            AppleUtil.setProdosString(fileEntry, 0, filename.toUpperCase(), 15);
+        }
 		writeFileEntry(fileEntry);
 	}
+	static int setMixedCaseFlags(StringBuilder filename, Function<Integer,Integer> bitPosition) {
+	    int flags = 0;
+	    for (int i=0; i<filename.length(); i++) {
+	        char ch = filename.charAt(i);
+	        if (Character.isLowerCase(ch) || ch == ' ') {
+	            flags |= bitPosition.apply(i);
+	            if (ch == ' ') ch = '.';
+	            filename.setCharAt(i, Character.toUpperCase(ch));
+	        }
+	    }
+	    return flags;
+	}
 
+	
 	/**
 	 * Copy GEOS-specific metadata to the directory entry verbatim:
 	 * Bytes $00-$10 ($11 bytes)
diff --git a/lib/ac-api/src/test/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntryTest.java b/lib/ac-api/src/test/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntryTest.java
new file mode 100644
index 0000000..8a20102
--- /dev/null
+++ b/lib/ac-api/src/test/java/com/webcodepro/applecommander/storage/os/prodos/ProdosFileEntryTest.java
@@ -0,0 +1,69 @@
+/*
+ * AppleCommander - An Apple ][ image utility.
+ * Copyright (C) 2002-2022 by Robert Greene and others
+ * robgreene at users.sourceforge.net
+ *
+ * This program is free software; you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License as published by the 
+ * Free Software Foundation; either version 2 of the License, or (at your 
+ * option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with this program; if not, write to the Free Software Foundation, Inc., 
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+package com.webcodepro.applecommander.storage.os.prodos;
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class ProdosFileEntryTest {
+    @Test
+    public void testGetMixedCaseName_GSOS() {
+        final String originalName = "DESK.ACCS";
+        final int flags = 0xb9c0;
+        final String expectedName = "Desk.Accs";
+        
+        assertEquals(expectedName, ProdosFileEntry.getMixedCaseName(originalName, flags, 
+                ProdosFileEntry::calculateGSOSBit));
+    }
+    
+    @Test
+    public void testSetMixedCaseName_GSOS() {
+        final String originalName = "Desk.Accs";
+        final int expectedFlags = 0xb9c0 & 0x7fff;  // the flag is set outside this method
+        final String expectedName = "DESK.ACCS";
+        
+        StringBuilder sb = new StringBuilder(originalName);
+        int actualFlags = ProdosFileEntry.setMixedCaseFlags(sb, ProdosFileEntry::calculateGSOSBit);
+        assertEquals(expectedName, sb.toString());
+        assertEquals(expectedFlags, actualFlags);
+    }
+
+    @Test
+    public void testGetMixedCaseName_AppleWorks() {
+        final String originalName = "MOUSEFIXER.DOCS";
+        final int auxtype = 0xee7b;
+        final String expectedName = "MouseFixer Docs";
+        
+        assertEquals(expectedName, ProdosFileEntry.getMixedCaseName(originalName, auxtype, 
+                ProdosFileEntry::calculateAppleWorksBit));
+    }
+    
+    @Test
+    public void testSetMixedCaseName_AppleWorks() {
+        final String originalName = "MouseFixer Docs";
+        final int expectedFlags = 0xee7b;
+        final String expectedName = "MOUSEFIXER.DOCS";
+        
+        StringBuilder sb = new StringBuilder(originalName);
+        int actualFlags = ProdosFileEntry.setMixedCaseFlags(sb, ProdosFileEntry::calculateAppleWorksBit);
+        assertEquals(expectedName, sb.toString());
+        assertEquals(expectedFlags, actualFlags);
+    }
+}