Use a ModeManager for boolean user modes.

Change-Id: Ia4b9a93b529e734b4d7c9194ee4db6f9c2175590
Reviewed-on: http://gerrit.dmdirc.com/3963
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/parser/irc/IRCClientInfo.java

@@ -27,6 +27,7 @@ import com.dmdirc.parser.interfaces.LocalClientInfo;
 import com.dmdirc.parser.interfaces.Parser;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
@@ -46,7 +47,7 @@ public class IRCClientInfo implements LocalClientInfo {
     /** Known host of client. */
     private String host = "";
     /** Known user modes of client. */
-    private long modes;
+    private String modes;
     /** Known Away Reason of client. */
     private String awayReason = "";
     /** Known Account name of client. */
@@ -64,7 +65,7 @@ public class IRCClientInfo implements LocalClientInfo {
     /** List of ChannelClientInfos that point to this. */
     private final Map<String, IRCChannelClientInfo> clients = new HashMap<>();
     /** Modes waiting to be sent to the server. */
-    private final List<String> modeQueue = new LinkedList<>();
+    private final Collection<String> modeQueue = new LinkedList<>();
 
     /**
      * Create a new client object from a hostmask.
@@ -136,7 +137,6 @@ public class IRCClientInfo implements LocalClientInfo {
      */
     public static String[] parseHostFull(final String hostmask) {
         String[] sTemp;
-        final String[] result = new String[3];
 
         if (!hostmask.isEmpty() && hostmask.charAt(0) == ':') {
             sTemp = hostmask.substring(1).split("@", 2);
@@ -144,6 +144,7 @@ public class IRCClientInfo implements LocalClientInfo {
             sTemp = hostmask.split("@", 2);
         }
 
+        final String[] result = new String[3];
         result[2] = sTemp.length == 1 ? "" : sTemp[1];
         sTemp = sTemp[0].split("!", 2);
         result[1] = sTemp.length == 1 ? "" : sTemp[1];
@@ -193,7 +194,7 @@ public class IRCClientInfo implements LocalClientInfo {
      */
     @Override
     public String toString() {
-        return nickname + "!" + ident + "@" + host;
+        return nickname + '!' + ident + '@' + host;
     }
 
     /**
@@ -206,7 +207,7 @@ public class IRCClientInfo implements LocalClientInfo {
     public String getNickname() {
         // If this is the localClient then do what we are supposed to do, and ask
         // the parser using parser.getNickname()
-        if (this.equals(parser.getLocalClient())) {
+        if (equals(parser.getLocalClient())) {
             return parser.getMyNickname();
         } else {
             return nickname;
@@ -295,37 +296,26 @@ public class IRCClientInfo implements LocalClientInfo {
     }
 
     /**
-     * Set the user modes (as an integer).
+     * Set the user modes.
      *
-     * @param newMode new long representing channel modes. (Boolean only)
+     * @param newMode new string containing boolean channel modes.
      */
-    public void setUserMode(final long newMode) {
+    public void setUserMode(final String newMode) {
         modes = newMode;
     }
 
     /**
-     * Get the user modes (as an integer).
+     * Get the user modes.
      *
      * @return long representing channel modes. (Boolean only)
      */
-    public long getUserMode() {
+    public String getUserMode() {
         return modes;
     }
 
     @Override
     public String getModes() {
-        final StringBuilder sModes = new StringBuilder("+");
-        final long nChanModes = this.getUserMode();
-
-        for (char cTemp : parser.userModes.keySet()) {
-            final long nTemp = parser.userModes.get(cTemp);
-
-            if ((nChanModes & nTemp) == nTemp) {
-                sModes.append(cTemp);
-            }
-        }
-
-        return sModes.toString();
+        return '+' + modes;
     }
 
     /**
@@ -336,8 +326,7 @@ public class IRCClientInfo implements LocalClientInfo {
      * @return True/False if this client appears to be an oper
      */
     public boolean isOper() {
-        final String modestr = getModes();
-        return modestr.indexOf('o') > -1 || modestr.indexOf('O') > -1;
+        return modes.indexOf('o') > -1 || modes.indexOf('O') > -1;
     }
 
     /**
@@ -389,7 +378,7 @@ public class IRCClientInfo implements LocalClientInfo {
 
     @Override
     public void alterMode(final boolean add, final Character mode) {
-        if (isFake() || !parser.userModes.containsKey(mode)) {
+        if (isFake() || !parser.userModes.isMode(mode)) {
             return;
         }
 

src/com/dmdirc/parser/irc/IRCParser.java

@@ -168,10 +168,8 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     private int connectTimeout = 5000;
     /** Manager used to handle prefix modes. */
     public final PrefixModeManager prefixModes = new PrefixModeManager();
-    /** Hashtable storing known user modes (owxis etc). */
-    public final Map<Character, Long> userModes = new HashMap<>();
-    /** Integer representing the next avaliable integer value of a User mode. */
-    public long nNextKeyUser = 1;
+    /** Manager used to handle user modes (owxis etc). */
+    public final ModeManager userModes = new ModeManager();
     /**
      * Hashtable storing known boolean chan modes (cntmi etc).
      * Valid Boolean Modes are stored as Hashtable.pub('m',1); where 'm' is the mode and 1 is a numeric value.<br><br>
@@ -716,7 +714,6 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
         }
         // Reset the mode indexes
         nextKeyCMBool = 1;
-        nNextKeyUser = 1;
         setServerName("");
         networkName = "";
         lastLine = null;
@@ -1650,19 +1647,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
             h005Info.put("USERMODES", sDefaultModes);
         }
 
-        // resetState
-        userModes.clear();
-        nNextKeyUser = 1;
-
-        // Boolean Mode
-        for (int i = 0; i < modeStr.length(); ++i) {
-            final Character cMode = modeStr.charAt(i);
-            callDebugInfo(DEBUG_INFO, "Found User Mode: %c [%d]", cMode, nNextKeyUser);
-            if (!userModes.containsKey(cMode)) {
-                userModes.put(cMode, nNextKeyUser);
-                nNextKeyUser *= 2;
-            }
-        }
+        userModes.set(modeStr);
     }
 
     /**

src/com/dmdirc/parser/irc/processors/ProcessMode.java

@@ -283,51 +283,44 @@ public class ProcessMode extends IRCProcessor {
      * @param clearOldModes Clear old modes before applying these modes (used by 221)
      */
     private void processUserMode(final String sParam, final String[] token, final String[] sModestr, final boolean clearOldModes) {
-        long nCurrent, nValue;
-        boolean bPositive = true;
-
         final IRCClientInfo iClient = getClientInfo(token[2]);
 
         if (iClient == null) {
             return;
         }
 
+        String nCurrent;
         if (clearOldModes) {
-            nCurrent = 0;
+            nCurrent = "";
         } else {
             nCurrent = iClient.getUserMode();
         }
 
+        boolean bPositive = true;
         for (int i = 0; i < sModestr[0].length(); ++i) {
             final Character cMode = sModestr[0].charAt(i);
             if (cMode.equals("+".charAt(0))) {
                 bPositive = true;
             } else if (cMode.equals("-".charAt(0))) {
                 bPositive = false;
-            } else if (cMode.equals(":".charAt(0))) {
-                continue;
-            } else {
-                if (parser.userModes.containsKey(cMode)) {
-                    nValue = parser.userModes.get(cMode);
-                } else {
+            } else if (!cMode.equals(":".charAt(0))) {
+                if (!parser.userModes.isMode(cMode)) {
                     // Unknown mode
                     callErrorInfo(new ParserError(ParserError.ERROR_WARNING, "Got unknown user mode " + cMode + " - Added", parser.getLastLine()));
-                    parser.userModes.put(cMode, parser.nNextKeyUser);
-                    nValue = parser.nNextKeyUser;
-                    parser.nNextKeyUser = parser.nNextKeyUser * 2;
+                    parser.userModes.add(cMode);
                 }
                 // Usermodes are always boolean
-                callDebugInfo(IRCParser.DEBUG_INFO, "User Mode: %c [%d] {Positive: %b}", cMode, nValue, bPositive);
+                callDebugInfo(IRCParser.DEBUG_INFO, "User Mode: %c {Positive: %b}", cMode, bPositive);
                 if (bPositive) {
-                    nCurrent = nCurrent | nValue;
+                    nCurrent = parser.userModes.insertMode(nCurrent, cMode);
                 } else {
-                    nCurrent = nCurrent ^ (nCurrent & nValue);
+                    nCurrent = parser.userModes.removeMode(nCurrent, cMode);
                 }
             }
         }
 
         iClient.setUserMode(nCurrent);
-        if (sParam.equals("221")) {
+        if ("221".equals(sParam)) {
             callUserModeDiscovered(iClient, sModestr[0]);
         } else {
             callUserModeChanged(iClient, token[0], sModestr[0]);
@@ -337,7 +330,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelModeChanged Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.ChannelModeChangeListener
+     * @see ChannelModeChangeListener
      * @param cChannel Channel where modes were changed
      * @param cChannelClient Client chaning the modes (null if server)
      * @param sHost Host doing the mode changing (User host or server name)
@@ -351,7 +344,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelUserModeChanged Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.ChannelUserModeChangeListener
+     * @see ChannelUserModeChangeListener
      * @param cChannel Channel where modes were changed
      * @param cChangedClient Client being changed
      * @param cSetByClient Client chaning the modes (null if server)
@@ -366,7 +359,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the UserModeChanged Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.UserModeChangeListener
+     * @see UserModeChangeListener
      * @param cClient Client that had the mode changed (almost always us)
      * @param sSetby Host that set the mode (us or servername)
      * @param sModes The modes set.
@@ -379,7 +372,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the UserModeDiscovered Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.UserModeDiscoveryListener
+     * @see UserModeDiscoveryListener
      * @param cClient Client that had the mode changed (almost always us)
      * @param sModes The modes set.
      * @return true if a method was called, false otherwise