Fixes issue 0003604: Ternary away states

Change-Id: Iad1585549ff0853ab20ab0f2e7ff0dfe98e2164b
Reviewed-on: http://gerrit.dmdirc.com/612
Automatic-Compile: Shane Mc Cormack <shane@dmdirc.com>
Automatic-Compile: Chris Smith <chris@dmdirc.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/parser/common/AwayState.java

@@ -0,0 +1,38 @@
+/*
+ *  Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ * 
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ */
+
+package com.dmdirc.parser.common;
+
+/**
+ * Away states.
+ *
+ * @author Shane
+ * @since 0.6.3
+ */
+public enum AwayState {
+    /** State is unknown. */
+    UNKNOWN,
+    /** User is here. */
+    HERE,
+    /** User is away. */
+    AWAY;
+}

src/com/dmdirc/parser/interfaces/callbacks/AwayStateListener.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.interfaces.callbacks;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.Parser;
 
 /**
@@ -33,9 +34,10 @@ public interface AwayStateListener extends CallbackInterface {
 	 * Called when we go away, or come back.
 	 *
 	 * @param tParser Reference to the parser object that made the callback.
-	 * @param currentState Set to true if we are now away, else false.
+         * @param oldState Old Away State
+	 * @param currentState Current Away State
 	 * @param reason Best guess at away reason
 	 * @see com.dmdirc.parser.irc.ProcessAway#callAwayState
 	 */
-	void onAwayState(Parser tParser, boolean currentState, String reason);
+	void onAwayState(Parser tParser, AwayState oldState, AwayState currentState, String reason);
 }

src/com/dmdirc/parser/interfaces/callbacks/ChannelOtherAwayStateListener.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.interfaces.callbacks;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.Parser;
@@ -38,8 +39,9 @@ public interface ChannelOtherAwayStateListener extends CallbackInterface {
 	 * @param tParser Reference to the parser object that made the callback.
 	 * @param channel Channel this is for
 	 * @param channelClient Client this is for
-	 * @param state Away State (true if away, false if here)
+         * @param oldState Old Away State
+	 * @param state Current Away State
 	 * @see com.dmdirc.parser.irc.ProcessAway#callChannelAwayStateOther
 	 */
-	void onChannelAwayStateOther(Parser tParser, ChannelInfo channel, ChannelClientInfo channelClient, boolean state);
+	void onChannelAwayStateOther(Parser tParser, ChannelInfo channel, ChannelClientInfo channelClient, AwayState oldState, AwayState state);
 }

src/com/dmdirc/parser/interfaces/callbacks/OtherAwayStateListener.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.interfaces.callbacks;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.ClientInfo;
 import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.interfaces.SpecificCallback;
@@ -36,8 +37,9 @@ public interface OtherAwayStateListener extends CallbackInterface {
 	 *
 	 * @param tParser Reference to the parser object that made the callback.
 	 * @param client Client this is for
-	 * @param state Away State (true if away, false if here)
+         * @param oldState Old Away State
+	 * @param state Current Away State
 	 * @see com.dmdirc.parser.irc.ProcessAway#callAwayStateOther
 	 */
-	void onAwayStateOther(Parser tParser, ClientInfo client, boolean state);
+	void onAwayStateOther(Parser tParser, ClientInfo client, AwayState oldState, AwayState state);
 }

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

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.irc;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.ClientInfo;
 import com.dmdirc.parser.interfaces.LocalClientInfo;
 import com.dmdirc.parser.interfaces.Parser;
@@ -53,7 +54,7 @@ public class IRCClientInfo implements LocalClientInfo {
     /** Known RealName of client. */
     private String sRealName = "";
     /** Known away state for client. */
-    private boolean bIsAway;
+    private AwayState away;
     /** Is this a fake client created just for a callback? */
     private boolean bIsFake;
     /** Reference to the parser object that owns this channel, Used for modes. */
@@ -205,21 +206,21 @@ public class IRCClientInfo implements LocalClientInfo {
     
     /**
      * Set the away state of a user.
-     * Automatically sets away reason to "" if set to false
+     * Automatically sets away reason to "" if not set to AwayState.AWAY
      *
-     * @param bNewState Boolean representing state. true = away, false = here
+     * @param bNewState AwayState representing new away state.
      */    
-    protected void setAwayState(final boolean bNewState) {
-        bIsAway = bNewState;
-        if (!bIsAway) { myAwayReason = ""; }
+    protected void setAwayState(final AwayState bNewState) {
+        away = bNewState;
+        if (away != AwayState.AWAY) { myAwayReason = ""; }
     }
     
     /**
      * Get the away state of a user.
      *
-     * @return Boolean representing state. true = away, false = here
+     * @return AwayState of the user.
      */    
-    public boolean getAwayState() { return bIsAway; }
+    public AwayState getAwayState() { return away; }
     
     /**
      * Get the Away Reason for this user.

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

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.irc;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.callbacks.AwayStateListener;
 
 /**
@@ -40,8 +41,9 @@ public class ProcessAway extends IRCProcessor {
             IRCClientInfo iClient = getClientInfo(token[3]);
             if (iClient != null) { iClient.setAwayReason(token[token.length-1]); }
         } else {
-            myParser.getLocalClient().setAwayState(sParam.equals("306"));
-            callAwayState(myParser.getLocalClient().getAwayState(), myParser.getLocalClient().getAwayReason());
+            final AwayState oldState = myParser.getLocalClient().getAwayState();
+            myParser.getLocalClient().setAwayState(sParam.equals("306") ? AwayState.AWAY : AwayState.HERE) ;
+            callAwayState(oldState, myParser.getLocalClient().getAwayState(), myParser.getLocalClient().getAwayReason());
         }
     }
     
@@ -49,12 +51,13 @@ public class ProcessAway extends IRCProcessor {
      * Callback to all objects implementing the onAwayState Callback.
      *
      * @see IAwayState
-     * @param currentState Set to true if we are now away, else false.
+     * @param oldState Old Away State
+     * @param currentState Current Away State
      * @param reason Best guess at away reason
      * @return true if a method was called, false otherwise
      */
-    protected boolean callAwayState(boolean currentState, String reason) {
-        return myParser.getCallbackManager().getCallbackType(AwayStateListener.class).call(currentState, reason);
+    protected boolean callAwayState(final AwayState oldState, final AwayState currentState, final String reason) {
+        return getCallbackManager().getCallbackType(AwayStateListener.class).call(oldState, currentState, reason);
     }
     
     /**

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

@@ -22,6 +22,7 @@
 
 package com.dmdirc.parser.irc;
 
+import com.dmdirc.parser.common.AwayState;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.ClientInfo;
@@ -61,20 +62,20 @@ public class ProcessWho extends IRCProcessor {
             }
             // Update away state
             final String mode = token[8];
-            final boolean isAway = mode.indexOf('G') != -1;
+            final AwayState isAway = (mode.indexOf('G') == -1) ? AwayState.HERE : AwayState.AWAY;
             if (client.getAwayState() != isAway) {
+                final AwayState oldState = client.getAwayState();
                 client.setAwayState(isAway);
-                if (!isAway) { client.setAwayReason(""); }
                 if (client == myParser.getLocalClient()) {
-                    callAwayState(client.getAwayState(), client.getAwayReason());
+                    callAwayState(oldState, client.getAwayState(), client.getAwayReason());
                 } else {
-                    callAwayStateOther(client, isAway);
+                    callAwayStateOther(client, oldState, isAway);
                     
                     ChannelClientInfo iChannelClient;
                     for (ChannelInfo iChannel : myParser.getChannels()) {
                         iChannelClient = iChannel.getChannelClient(client);
                         if (iChannelClient != null) {
-                            callChannelAwayStateOther(iChannel,iChannelClient,isAway);
+                            callChannelAwayStateOther(iChannel,iChannelClient,oldState,isAway);
                         }
                     }
                 }
@@ -86,12 +87,13 @@ public class ProcessWho extends IRCProcessor {
      * Callback to all objects implementing the onAwayState Callback.
      *
      * @see IAwayState
-     * @param currentState Set to true if we are now away, else false.
+     * @param oldState Old Away State
+     * @param currentState Current Away State
      * @param reason Best guess at away reason
      * @return true if a method was called, false otherwise
      */
-    protected boolean callAwayState(boolean currentState, String reason) {
-        return getCallbackManager().getCallbackType(AwayStateListener.class).call(currentState, reason);
+    protected boolean callAwayState(final AwayState oldState, final AwayState currentState, final String reason) {
+        return getCallbackManager().getCallbackType(AwayStateListener.class).call(oldState, currentState, reason);
     }
     
     /**
@@ -99,11 +101,12 @@ public class ProcessWho extends IRCProcessor {
      *
      * @see IAwayStateOther
      * @param client Client this is for
-     * @param state Away State (true if away, false if here)
+     * @param oldState Old Away State
+     * @param state Current Away State
      * @return true if a method was called, false otherwise
      */
-    protected boolean callAwayStateOther(final ClientInfo client, final boolean state) {
-        return getCallbackManager().getCallbackType(OtherAwayStateListener.class).call(client, state);
+    protected boolean callAwayStateOther(final ClientInfo client, final AwayState oldState, final AwayState state) {
+        return getCallbackManager().getCallbackType(OtherAwayStateListener.class).call(client, oldState, state);
     }
     
     /**
@@ -112,11 +115,12 @@ public class ProcessWho extends IRCProcessor {
      * @see IAwayStateOther
      * @param channel Channel this is for
      * @param channelClient ChannelClient this is for
-     * @param state Away State (true if away, false if here)
+     * @param oldState Old Away State
+     * @param state Current Away State
      * @return true if a method was called, false otherwise
      */
-    protected boolean callChannelAwayStateOther(final ChannelInfo channel, final ChannelClientInfo channelClient, final boolean state) {
-        return getCallbackManager().getCallbackType(ChannelOtherAwayStateListener.class).call(channel, channelClient, state);
+    protected boolean callChannelAwayStateOther(final ChannelInfo channel, final ChannelClientInfo channelClient, final AwayState oldState, final AwayState state) {
+        return getCallbackManager().getCallbackType(ChannelOtherAwayStateListener.class).call(channel, channelClient, oldState, state);
     }
     
     /**