dom/base/BarProps.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 "mozilla/dom/BarProps.h"
   8 #include "mozilla/dom/BarPropBinding.h"
   9 #include "nsContentUtils.h"
  10 #include "nsDocShell.h"
  11 #include "nsGlobalWindowInner.h"
  12 #include "nsIWebBrowserChrome.h"
  13
  14 namespace mozilla::dom {
  15
  16 //
  17 //  Basic (virtual) BarProp class implementation
  18 //
  19 BarProp::BarProp(nsGlobalWindowInner* aWindow) : mDOMWindow(aWindow) {}
  20
  21 BarProp::~BarProp() = default;
  22
  23 nsPIDOMWindowInner* BarProp::GetParentObject() const { return mDOMWindow; }
  24
  25 JSObject* BarProp::WrapObject(JSContext* aCx,
  26                               JS::Handle<JSObject*> aGivenProto) {
  27   return BarProp_Binding::Wrap(aCx, this, aGivenProto);
  28 }
  29
  30 NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(BarProp, mDOMWindow)
  31 NS_IMPL_CYCLE_COLLECTING_ADDREF(BarProp)
  32 NS_IMPL_CYCLE_COLLECTING_RELEASE(BarProp)
  33 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(BarProp)
  34   NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
  35   NS_INTERFACE_MAP_ENTRY(nsISupports)
  36 NS_INTERFACE_MAP_END
  37
  38 bool BarProp::GetVisibleByIsPopup() {
  39   // For web content, return the value defined by the spec, instead of
  40   // the actual visibility of each bar.
  41   //
  42   // If this browsing context is created by requesting a popup, all
  43   // `BarProp.visible` should return false.
  44   RefPtr<BrowsingContext> bc = GetBrowsingContext();
  45   if (!bc || bc->IsDiscarded()) {
  46     return true;
  47   }
  48   bc = bc->Top();
  49   bool isPopup = bc->GetIsPopupRequested();
  50   return !isPopup;
  51 }
  52
  53 bool BarProp::GetVisibleByFlag(uint32_t aChromeFlag, CallerType aCallerType,
  54                                ErrorResult& aRv) {
  55   if (aCallerType != CallerType::System) {
  56     return GetVisibleByIsPopup();
  57   }
  58
  59   nsCOMPtr<nsIWebBrowserChrome> browserChrome = GetBrowserChrome();
  60   NS_ENSURE_TRUE(browserChrome, false);
  61
  62   uint32_t chromeFlags;
  63
  64   if (NS_FAILED(browserChrome->GetChromeFlags(&chromeFlags))) {
  65     aRv.Throw(NS_ERROR_FAILURE);
  66     return false;
  67   }
  68
  69   return (chromeFlags & aChromeFlag);
  70 }
  71
  72 void BarProp::SetVisibleByFlag(bool aVisible, uint32_t aChromeFlag,
  73                                CallerType aCallerType, ErrorResult& aRv) {
  74   nsCOMPtr<nsIWebBrowserChrome> browserChrome = GetBrowserChrome();
  75   NS_ENSURE_TRUE_VOID(browserChrome);
  76
  77   if (aCallerType != CallerType::System) {
  78     return;
  79   }
  80
  81   uint32_t chromeFlags;
  82
  83   if (NS_FAILED(browserChrome->GetChromeFlags(&chromeFlags))) {
  84     aRv.Throw(NS_ERROR_FAILURE);
  85     return;
  86   }
  87
  88   if (aVisible)
  89     chromeFlags |= aChromeFlag;
  90   else
  91     chromeFlags &= ~aChromeFlag;
  92
  93   if (NS_FAILED(browserChrome->SetChromeFlags(chromeFlags))) {
  94     aRv.Throw(NS_ERROR_FAILURE);
  95   }
  96 }
  97
  98 already_AddRefed<nsIWebBrowserChrome> BarProp::GetBrowserChrome() {
  99   if (!mDOMWindow) {
 100     return nullptr;
 101   }
 102
 103   return mDOMWindow->GetWebBrowserChrome();
 104 }
 105
 106 BrowsingContext* BarProp::GetBrowsingContext() {
 107   if (!mDOMWindow) {
 108     return nullptr;
 109   }
 110
 111   return mDOMWindow->GetBrowsingContext();
 112 }
 113
 114 //
 115 // MenubarProp class implementation
 116 //
 117
 118 MenubarProp::MenubarProp(nsGlobalWindowInner* aWindow) : BarProp(aWindow) {}
 119
 120 MenubarProp::~MenubarProp() = default;
 121
 122 bool MenubarProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 123   return BarProp::GetVisibleByFlag(nsIWebBrowserChrome::CHROME_MENUBAR,
 124                                    aCallerType, aRv);
 125 }
 126
 127 void MenubarProp::SetVisible(bool aVisible, CallerType aCallerType,
 128                              ErrorResult& aRv) {
 129   BarProp::SetVisibleByFlag(aVisible, nsIWebBrowserChrome::CHROME_MENUBAR,
 130                             aCallerType, aRv);
 131 }
 132
 133 //
 134 // ToolbarProp class implementation
 135 //
 136
 137 ToolbarProp::ToolbarProp(nsGlobalWindowInner* aWindow) : BarProp(aWindow) {}
 138
 139 ToolbarProp::~ToolbarProp() = default;
 140
 141 bool ToolbarProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 142   return BarProp::GetVisibleByFlag(nsIWebBrowserChrome::CHROME_TOOLBAR,
 143                                    aCallerType, aRv);
 144 }
 145
 146 void ToolbarProp::SetVisible(bool aVisible, CallerType aCallerType,
 147                              ErrorResult& aRv) {
 148   BarProp::SetVisibleByFlag(aVisible, nsIWebBrowserChrome::CHROME_TOOLBAR,
 149                             aCallerType, aRv);
 150 }
 151
 152 //
 153 // LocationbarProp class implementation
 154 //
 155
 156 LocationbarProp::LocationbarProp(nsGlobalWindowInner* aWindow)
 157     : BarProp(aWindow) {}
 158
 159 LocationbarProp::~LocationbarProp() = default;
 160
 161 bool LocationbarProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 162   return BarProp::GetVisibleByFlag(nsIWebBrowserChrome::CHROME_LOCATIONBAR,
 163                                    aCallerType, aRv);
 164 }
 165
 166 void LocationbarProp::SetVisible(bool aVisible, CallerType aCallerType,
 167                                  ErrorResult& aRv) {
 168   BarProp::SetVisibleByFlag(aVisible, nsIWebBrowserChrome::CHROME_LOCATIONBAR,
 169                             aCallerType, aRv);
 170 }
 171
 172 //
 173 // PersonalbarProp class implementation
 174 //
 175
 176 PersonalbarProp::PersonalbarProp(nsGlobalWindowInner* aWindow)
 177     : BarProp(aWindow) {}
 178
 179 PersonalbarProp::~PersonalbarProp() = default;
 180
 181 bool PersonalbarProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 182   return BarProp::GetVisibleByFlag(nsIWebBrowserChrome::CHROME_PERSONAL_TOOLBAR,
 183                                    aCallerType, aRv);
 184 }
 185
 186 void PersonalbarProp::SetVisible(bool aVisible, CallerType aCallerType,
 187                                  ErrorResult& aRv) {
 188   BarProp::SetVisibleByFlag(
 189       aVisible, nsIWebBrowserChrome::CHROME_PERSONAL_TOOLBAR, aCallerType, aRv);
 190 }
 191
 192 //
 193 // StatusbarProp class implementation
 194 //
 195
 196 StatusbarProp::StatusbarProp(nsGlobalWindowInner* aWindow) : BarProp(aWindow) {}
 197
 198 StatusbarProp::~StatusbarProp() = default;
 199
 200 bool StatusbarProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 201   return BarProp::GetVisibleByFlag(nsIWebBrowserChrome::CHROME_STATUSBAR,
 202                                    aCallerType, aRv);
 203 }
 204
 205 void StatusbarProp::SetVisible(bool aVisible, CallerType aCallerType,
 206                                ErrorResult& aRv) {
 207   return BarProp::SetVisibleByFlag(
 208       aVisible, nsIWebBrowserChrome::CHROME_STATUSBAR, aCallerType, aRv);
 209 }
 210
 211 //
 212 // ScrollbarsProp class implementation
 213 //
 214
 215 ScrollbarsProp::ScrollbarsProp(nsGlobalWindowInner* aWindow)
 216     : BarProp(aWindow) {}
 217
 218 ScrollbarsProp::~ScrollbarsProp() = default;
 219
 220 bool ScrollbarsProp::GetVisible(CallerType aCallerType, ErrorResult& aRv) {
 221   if (aCallerType != CallerType::System) {
 222     return BarProp::GetVisibleByIsPopup();
 223   }
 224
 225   if (!mDOMWindow) {
 226     return true;
 227   }
 228
 229   nsIDocShell* ds = mDOMWindow->GetDocShell();
 230   if (!ds) {
 231     return true;
 232   }
 233
 234   ScrollbarPreference pref = nsDocShell::Cast(ds)->ScrollbarPreference();
 235   return pref != ScrollbarPreference::Never;
 236 }
 237
 238 void ScrollbarsProp::SetVisible(bool aVisible, CallerType, ErrorResult&) {
 239   /* Do nothing */
 240 }
 241
 242 }  // namespace mozilla::dom