dom/commandhandler/nsBaseCommandController.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsString.h"
   8 #include "nsIWeakReferenceUtils.h"
   9 #include "nsBaseCommandController.h"
  10 #include "nsControllerCommandTable.h"
  11
  12 NS_IMPL_ADDREF(nsBaseCommandController)
  13 NS_IMPL_RELEASE(nsBaseCommandController)
  14
  15 NS_INTERFACE_MAP_BEGIN(nsBaseCommandController)
  16   NS_INTERFACE_MAP_ENTRY(nsIController)
  17   NS_INTERFACE_MAP_ENTRY(nsICommandController)
  18   NS_INTERFACE_MAP_ENTRY(nsIControllerContext)
  19   NS_INTERFACE_MAP_ENTRY(nsIInterfaceRequestor)
  20   NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIControllerContext)
  21 NS_INTERFACE_MAP_END
  22
  23 nsBaseCommandController::nsBaseCommandController(
  24     nsControllerCommandTable* aControllerCommandTable)
  25     : mCommandContextRawPtr(nullptr), mCommandTable(aControllerCommandTable) {}
  26
  27 nsBaseCommandController::~nsBaseCommandController() = default;
  28
  29 NS_IMETHODIMP
  30 nsBaseCommandController::SetCommandContext(nsISupports* aCommandContext) {
  31   mCommandContextWeakPtr = nullptr;
  32   mCommandContextRawPtr = nullptr;
  33
  34   if (aCommandContext) {
  35     nsCOMPtr<nsISupportsWeakReference> weak =
  36         do_QueryInterface(aCommandContext);
  37     if (weak) {
  38       nsresult rv =
  39           weak->GetWeakReference(getter_AddRefs(mCommandContextWeakPtr));
  40       NS_ENSURE_SUCCESS(rv, rv);
  41     } else {
  42       mCommandContextRawPtr = aCommandContext;
  43     }
  44   }
  45
  46   return NS_OK;
  47 }
  48
  49 NS_IMETHODIMP
  50 nsBaseCommandController::GetInterface(const nsIID& aIID, void** aResult) {
  51   NS_ENSURE_ARG_POINTER(aResult);
  52
  53   if (NS_SUCCEEDED(QueryInterface(aIID, aResult))) {
  54     return NS_OK;
  55   }
  56
  57   if (aIID.Equals(NS_GET_IID(nsIControllerCommandTable))) {
  58     if (mCommandTable) {
  59       *aResult =
  60           do_AddRef(static_cast<nsIControllerCommandTable*>(mCommandTable))
  61               .take();
  62       return NS_OK;
  63     }
  64     return NS_ERROR_NOT_INITIALIZED;
  65   }
  66
  67   return NS_NOINTERFACE;
  68 }
  69
  70 /* =======================================================================
  71  * nsIController
  72  * ======================================================================= */
  73
  74 NS_IMETHODIMP
  75 nsBaseCommandController::IsCommandEnabled(const char* aCommand, bool* aResult) {
  76   NS_ENSURE_ARG_POINTER(aCommand);
  77   NS_ENSURE_ARG_POINTER(aResult);
  78   NS_ENSURE_STATE(mCommandTable);
  79
  80   nsISupports* context = mCommandContextRawPtr;
  81   nsCOMPtr<nsISupports> weak;
  82   if (!context) {
  83     weak = do_QueryReferent(mCommandContextWeakPtr);
  84     context = weak;
  85   }
  86   return mCommandTable->IsCommandEnabled(aCommand, context, aResult);
  87 }
  88
  89 NS_IMETHODIMP
  90 nsBaseCommandController::SupportsCommand(const char* aCommand, bool* aResult) {
  91   NS_ENSURE_ARG_POINTER(aCommand);
  92   NS_ENSURE_ARG_POINTER(aResult);
  93   NS_ENSURE_STATE(mCommandTable);
  94
  95   nsISupports* context = mCommandContextRawPtr;
  96   nsCOMPtr<nsISupports> weak;
  97   if (!context) {
  98     weak = do_QueryReferent(mCommandContextWeakPtr);
  99     context = weak;
 100   }
 101   return mCommandTable->SupportsCommand(aCommand, context, aResult);
 102 }
 103
 104 NS_IMETHODIMP
 105 nsBaseCommandController::DoCommand(const char* aCommand) {
 106   NS_ENSURE_ARG_POINTER(aCommand);
 107   NS_ENSURE_STATE(mCommandTable);
 108
 109   nsCOMPtr<nsISupports> context = mCommandContextRawPtr;
 110   if (!context) {
 111     context = do_QueryReferent(mCommandContextWeakPtr);
 112   }
 113   RefPtr<nsControllerCommandTable> commandTable(mCommandTable);
 114   return commandTable->DoCommand(aCommand, context);
 115 }
 116
 117 NS_IMETHODIMP
 118 nsBaseCommandController::DoCommandWithParams(const char* aCommand,
 119                                              nsICommandParams* aParams) {
 120   NS_ENSURE_ARG_POINTER(aCommand);
 121   NS_ENSURE_STATE(mCommandTable);
 122
 123   nsCOMPtr<nsISupports> context = mCommandContextRawPtr;
 124   if (!context) {
 125     context = do_QueryReferent(mCommandContextWeakPtr);
 126   }
 127   RefPtr<nsControllerCommandTable> commandTable(mCommandTable);
 128   return commandTable->DoCommandParams(aCommand, aParams, context);
 129 }
 130
 131 NS_IMETHODIMP
 132 nsBaseCommandController::GetCommandStateWithParams(const char* aCommand,
 133                                                    nsICommandParams* aParams) {
 134   NS_ENSURE_ARG_POINTER(aCommand);
 135   NS_ENSURE_STATE(mCommandTable);
 136
 137   nsISupports* context = mCommandContextRawPtr;
 138   nsCOMPtr<nsISupports> weak;
 139   if (!context) {
 140     weak = do_QueryReferent(mCommandContextWeakPtr);
 141     context = weak;
 142   }
 143   return mCommandTable->GetCommandState(aCommand, aParams, context);
 144 }
 145
 146 NS_IMETHODIMP
 147 nsBaseCommandController::OnEvent(const char* aEventName) {
 148   NS_ENSURE_ARG_POINTER(aEventName);
 149   return NS_OK;
 150 }
 151
 152 NS_IMETHODIMP
 153 nsBaseCommandController::GetSupportedCommands(nsTArray<nsCString>& aCommands) {
 154   NS_ENSURE_STATE(mCommandTable);
 155   return mCommandTable->GetSupportedCommands(aCommands);
 156 }
 157
 158 using CommandTableCreatorFn = already_AddRefed<nsControllerCommandTable> (*)();
 159
 160 static already_AddRefed<nsBaseCommandController>
 161 CreateControllerWithSingletonCommandTable(CommandTableCreatorFn aCreatorFn) {
 162   RefPtr<nsControllerCommandTable> commandTable = aCreatorFn();
 163   if (!commandTable) {
 164     return nullptr;
 165   }
 166
 167   // this is a singleton; make it immutable
 168   commandTable->MakeImmutable();
 169
 170   RefPtr<nsBaseCommandController> commandController =
 171       new nsBaseCommandController(commandTable);
 172   return commandController.forget();
 173 }
 174
 175 already_AddRefed<nsBaseCommandController>
 176 nsBaseCommandController::CreateWindowController() {
 177   return CreateControllerWithSingletonCommandTable(
 178       nsControllerCommandTable::CreateWindowCommandTable);
 179 }
 180
 181 already_AddRefed<nsBaseCommandController>
 182 nsBaseCommandController::CreateEditorController() {
 183   return CreateControllerWithSingletonCommandTable(
 184       nsControllerCommandTable::CreateEditorCommandTable);
 185 }
 186
 187 already_AddRefed<nsBaseCommandController>
 188 nsBaseCommandController::CreateEditingController() {
 189   return CreateControllerWithSingletonCommandTable(
 190       nsControllerCommandTable::CreateEditingCommandTable);
 191 }
 192
 193 already_AddRefed<nsBaseCommandController>
 194 nsBaseCommandController::CreateHTMLEditorController() {
 195   return CreateControllerWithSingletonCommandTable(
 196       nsControllerCommandTable::CreateHTMLEditorCommandTable);
 197 }
 198
 199 already_AddRefed<nsBaseCommandController>
 200 nsBaseCommandController::CreateHTMLEditorDocStateController() {
 201   return CreateControllerWithSingletonCommandTable(
 202       nsControllerCommandTable::CreateHTMLEditorDocStateCommandTable);
 203 }