Work in progress for command handling APIs. Not part of the build

git-svn-id: svn://10.0.0.236/trunk@91540 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/embedding/components/commandhandler/src/nsControllerCommandManager.cpp

@@ -0,0 +1,204 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public
+ * License Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the License is distributed on an "AS
+ * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * rights and limitations under the License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+#include "nsString.h"
+#include "nsControllerCommandManager.h"
+
+// prototype;
+nsresult
+NS_NewControllerCommandManager(nsIControllerCommandManager** aResult);
+
+
+// this value is used to size the hash table. Just a sensible upper bound
+#define NUM_COMMANDS_BOUNDS       64
+
+
+nsControllerCommandManager::nsControllerCommandManager()
+: mCommandsTable(NUM_COMMANDS_BOUNDS, PR_FALSE)
+{
+  NS_INIT_REFCNT();
+}
+
+
+nsControllerCommandManager::~nsControllerCommandManager()
+{
+
+}
+
+NS_IMPL_ISUPPORTS2(nsControllerCommandManager, nsIControllerCommandManager, nsISupportsWeakReference);
+
+
+NS_IMETHODIMP
+nsControllerCommandManager::RegisterCommand(const nsAReadableString & aCommandName, nsIControllerCommand *aCommand)
+{
+  nsStringKey commandKey(aCommandName);
+  
+  if (mCommandsTable.Put (&commandKey, aCommand))
+  {
+#if DEBUG
+    nsCAutoString msg("Replacing existing command -- ");
+    msg.AppendWithConversion(aCommandName);
+    NS_WARNING(msg);
+#endif
+  }  
+  return NS_OK;
+}
+
+
+NS_IMETHODIMP
+nsControllerCommandManager::UnregisterCommand(const nsAReadableString & aCommandName, nsIControllerCommand *aCommand)
+{
+  nsStringKey commandKey(aCommandName);
+
+  PRBool wasRemoved = mCommandsTable.Remove (&commandKey);
+  return wasRemoved ? NS_OK : NS_ERROR_FAILURE;
+}
+
+
+NS_IMETHODIMP
+nsControllerCommandManager::FindCommandHandler(const nsAReadableString & aCommandName, nsIControllerCommand **outCommand)
+{
+  NS_ENSURE_ARG_POINTER(outCommand);
+  
+  *outCommand = NULL;
+  
+  nsStringKey commandKey(aCommandName);
+  nsISupports* foundCommand = mCommandsTable.Get(&commandKey);   // this does the addref
+  if (!foundCommand) return NS_ERROR_FAILURE;
+  
+  *outCommand = NS_REINTERPRET_CAST(nsIControllerCommand*, foundCommand);
+  return NS_OK;
+}
+
+
+
+/* boolean isCommandEnabled (in wstring command); */
+NS_IMETHODIMP
+nsControllerCommandManager::IsCommandEnabled(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon, PRBool *aResult)
+{
+  NS_ENSURE_ARG_POINTER(aResult);
+
+  *aResult = PR_FALSE;
+      
+  // find the command  
+  nsCOMPtr<nsIControllerCommand> commandHandler;
+  FindCommandHandler(aCommandName, getter_AddRefs(commandHandler));  
+  if (!commandHandler)
+  {
+#if DEBUG
+    nsCAutoString msg("Controller command manager asked about a command that it does not handle -- ");
+    msg.AppendWithConversion(aCommandName);
+    NS_WARNING(msg);
+#endif
+    return NS_OK;    // we don't handle this command
+  }
+  
+  return commandHandler->IsCommandEnabled(aCommandName, aCommandRefCon, aResult);
+}
+
+
+NS_IMETHODIMP
+nsControllerCommandManager::UpdateCommandState(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon)
+{
+  // find the command  
+  nsCOMPtr<nsIControllerCommand> commandHandler;
+  FindCommandHandler(aCommandName, getter_AddRefs(commandHandler));  
+  if (!commandHandler)
+  {
+#if DEBUG
+    nsCAutoString msg("Controller command manager asked to update the state of a command that it does not handle -- ");
+    msg.AppendWithConversion(aCommandName);
+    NS_WARNING(msg);
+#endif
+    return NS_OK;    // we don't handle this command
+  }
+  
+  nsCOMPtr<nsIStateUpdatingControllerCommand> stateCommand = do_QueryInterface(commandHandler);
+  if (!stateCommand)
+  {
+#if DEBUG
+    nsCAutoString msg("Controller command manager asked to update the state of a command that doesn't do state updating -- ");
+    msg.AppendWithConversion(aCommandName);
+    NS_WARNING(msg);
+#endif
+    return NS_ERROR_NO_INTERFACE;
+  }
+  
+  return stateCommand->UpdateCommandState(aCommandName, aCommandRefCon);
+}
+
+NS_IMETHODIMP
+nsControllerCommandManager::SupportsCommand(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon, PRBool *aResult)
+{
+  NS_ENSURE_ARG_POINTER(aResult);
+
+  // XXX: need to check the readonly and disabled states
+
+  *aResult = PR_FALSE;
+  
+  // find the command  
+  nsCOMPtr<nsIControllerCommand> commandHandler;
+  FindCommandHandler(aCommandName, getter_AddRefs(commandHandler));
+
+  *aResult = (commandHandler.get() != nsnull);
+  return NS_OK;
+}
+
+/* void doCommand (in wstring command); */
+NS_IMETHODIMP
+nsControllerCommandManager::DoCommand(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon)
+{
+  // find the command  
+  nsCOMPtr<nsIControllerCommand> commandHandler;
+ FindCommandHandler(aCommandName, getter_AddRefs(commandHandler));
+  if (!commandHandler)
+  {
+#if DEBUG
+    nsCAutoString msg("Controller command manager asked to do a command that it does not handle -- ");
+    msg.AppendWithConversion(aCommandName);
+    NS_WARNING(msg);
+#endif
+    return NS_OK;    // we don't handle this command
+  }
+  
+  return commandHandler->DoCommand(aCommandName, aCommandRefCon);
+}
+
+
+nsresult
+NS_NewControllerCommandManager(nsIControllerCommandManager** aResult)
+{
+  NS_PRECONDITION(aResult != nsnull, "null ptr");
+  if (! aResult)
+    return NS_ERROR_NULL_POINTER;
+
+  nsControllerCommandManager* newCommandManager = new nsControllerCommandManager();
+  if (! newCommandManager)
+    return NS_ERROR_OUT_OF_MEMORY;
+
+  NS_ADDREF(newCommandManager);
+  *aResult = newCommandManager;
+  return NS_OK;
+}
+
+
+