refactor: convert browser window state fns to props (#18618)

electron · Jun 5, 2019 · a0b1f4f · a0b1f4f
1 parent 164cc43
commit a0b1f4f
Show file tree

Hide file tree

Showing 10 changed files with 260 additions and 60 deletions.
diff --git a/atom/browser/api/atom_api_system_preferences.cc b/atom/browser/api/atom_api_system_preferences.cc
@@ -102,9 +102,9 @@ void SystemPreferences::BuildPrototype(
                  &SystemPreferences::IsSwipeTrackingFromScrollEventsEnabled)
       .SetMethod("getEffectiveAppearance",
                  &SystemPreferences::GetEffectiveAppearance)
-      .SetMethod("getAppLevelAppearance",
+      .SetMethod("_getAppLevelAppearance",
                  &SystemPreferences::GetAppLevelAppearance)
-      .SetMethod("setAppLevelAppearance",
+      .SetMethod("_setAppLevelAppearance",
                  &SystemPreferences::SetAppLevelAppearance)
       .SetProperty("appLevelAppearance",
                    &SystemPreferences::GetAppLevelAppearance,

diff --git a/atom/browser/api/atom_api_top_level_window.cc b/atom/browser/api/atom_api_top_level_window.cc
@@ -1070,19 +1070,31 @@ void TopLevelWindow::BuildPrototype(v8::Isolate* isolate,
       .SetMethod("setMaximumSize", &TopLevelWindow::SetMaximumSize)
       .SetMethod("getMaximumSize", &TopLevelWindow::GetMaximumSize)
       .SetMethod("setSheetOffset", &TopLevelWindow::SetSheetOffset)
-      .SetMethod("setResizable", &TopLevelWindow::SetResizable)
-      .SetMethod("isResizable", &TopLevelWindow::IsResizable)
-      .SetMethod("setMovable", &TopLevelWindow::SetMovable)
       .SetMethod("moveTop", &TopLevelWindow::MoveTop)
-      .SetMethod("isMovable", &TopLevelWindow::IsMovable)
-      .SetMethod("setMinimizable", &TopLevelWindow::SetMinimizable)
-      .SetMethod("isMinimizable", &TopLevelWindow::IsMinimizable)
-      .SetMethod("setMaximizable", &TopLevelWindow::SetMaximizable)
-      .SetMethod("isMaximizable", &TopLevelWindow::IsMaximizable)
-      .SetMethod("setFullScreenable", &TopLevelWindow::SetFullScreenable)
-      .SetMethod("isFullScreenable", &TopLevelWindow::IsFullScreenable)
-      .SetMethod("setClosable", &TopLevelWindow::SetClosable)
-      .SetMethod("isClosable", &TopLevelWindow::IsClosable)
+      .SetMethod("_setResizable", &TopLevelWindow::SetResizable)
+      .SetMethod("_isResizable", &TopLevelWindow::IsResizable)
+      .SetProperty("resizable", &TopLevelWindow::IsResizable,
+                   &TopLevelWindow::SetResizable)
+      .SetMethod("_setMovable", &TopLevelWindow::SetMovable)
+      .SetMethod("_isMovable", &TopLevelWindow::IsMovable)
+      .SetProperty("movable", &TopLevelWindow::IsMovable,
+                   &TopLevelWindow::SetMovable)
+      .SetMethod("_setMinimizable", &TopLevelWindow::SetMinimizable)
+      .SetMethod("_isMinimizable", &TopLevelWindow::IsMinimizable)
+      .SetProperty("minimizable", &TopLevelWindow::IsMinimizable,
+                   &TopLevelWindow::SetMinimizable)
+      .SetMethod("_setMaximizable", &TopLevelWindow::SetMaximizable)
+      .SetMethod("_isMaximizable", &TopLevelWindow::IsMaximizable)
+      .SetProperty("maximizable", &TopLevelWindow::IsMaximizable,
+                   &TopLevelWindow::SetMaximizable)
+      .SetMethod("_setFullScreenable", &TopLevelWindow::SetFullScreenable)
+      .SetMethod("_isFullScreenable", &TopLevelWindow::IsFullScreenable)
+      .SetProperty("fullScreenable", &TopLevelWindow::IsFullScreenable,
+                   &TopLevelWindow::SetFullScreenable)
+      .SetMethod("_setClosable", &TopLevelWindow::SetClosable)
+      .SetMethod("_isClosable", &TopLevelWindow::IsClosable)
+      .SetProperty("closable", &TopLevelWindow::IsClosable,
+                   &TopLevelWindow::SetClosable)
       .SetMethod("setAlwaysOnTop", &TopLevelWindow::SetAlwaysOnTop)
       .SetMethod("isAlwaysOnTop", &TopLevelWindow::IsAlwaysOnTop)
       .SetMethod("center", &TopLevelWindow::Center)

diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -1009,72 +1009,96 @@ Returns `Integer[]` - Contains the window's maximum width and height.
 
 Sets whether the window can be manually resized by user.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isResizable()`
 
 Returns `Boolean` - Whether the window can be manually resized by user.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setMovable(movable)` _macOS_ _Windows_
 
 * `movable` Boolean
 
 Sets whether the window can be moved by user. On Linux does nothing.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isMovable()` _macOS_ _Windows_
 
 Returns `Boolean` - Whether the window can be moved by user.
 
 On Linux always returns `true`.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setMinimizable(minimizable)` _macOS_ _Windows_
 
 * `minimizable` Boolean
 
 Sets whether the window can be manually minimized by user. On Linux does
 nothing.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isMinimizable()` _macOS_ _Windows_
 
 Returns `Boolean` - Whether the window can be manually minimized by user
 
 On Linux always returns `true`.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setMaximizable(maximizable)` _macOS_ _Windows_
 
 * `maximizable` Boolean
 
 Sets whether the window can be manually maximized by user. On Linux does
 nothing.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isMaximizable()` _macOS_ _Windows_
 
 Returns `Boolean` - Whether the window can be manually maximized by user.
 
 On Linux always returns `true`.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setFullScreenable(fullscreenable)`
 
 * `fullscreenable` Boolean
 
 Sets whether the maximize/zoom window button toggles fullscreen mode or
 maximizes the window.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isFullScreenable()`
 
 Returns `Boolean` - Whether the maximize/zoom window button toggles fullscreen mode or
 maximizes the window.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setClosable(closable)` _macOS_ _Windows_
 
 * `closable` Boolean
 
 Sets whether the window can be manually closed by user. On Linux does nothing.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.isClosable()` _macOS_ _Windows_
 
 Returns `Boolean` - Whether the window can be manually closed by user.
 
 On Linux always returns `true`.
 
+**[Deprecated](modernization/property-updates.md)**
+
 #### `win.setAlwaysOnTop(flag[, level][, relativeLevel])`
 
 * `flag` Boolean
@@ -1653,6 +1677,39 @@ A `Boolean` property that determines whether the window menu bar should hide its
 If the menu bar is already visible, setting this property to `true` won't
 hide it immediately.
 
+#### `win.minimizable`
+
+A `Boolean` property that determines whether the window can be manually minimized by user.
+
+On Linux the setter is a no-op, although the getter returns `true`.
+
+#### `win.maximizable`
+
+A `Boolean` property that determines whether the window can be manually maximized by user.
+
+On Linux the setter is a no-op, although the getter returns `true`.
+
+#### `win.fullScreenable`
+
+A `Boolean` property that determines whether the maximize/zoom window button toggles fullscreen mode or
+maximizes the window.
+
+#### `win.resizable`
+
+A `Boolean` property that determines whether the window can be manually resized by user.
+
+#### `win.closable`
+
+A `Boolean` property that determines whether the window can be manually closed by user.
+
+On Linux the setter is a no-op, although the getter returns `true`.
+
+#### `win.movable`
+
+A `Boolean` property that determines Whether the window can be moved by user.
+
+On Linux the setter is a no-op, although the getter returns `true`.
+
 #### `win.excludedFromShownWindowsMenu` _macOS_
 
 A `Boolean` property that determines whether the window is excluded from the application’s Windows menu. `false` by default.

diff --git a/docs/api/modernization/property-updates.md b/docs/api/modernization/property-updates.md
@@ -12,12 +12,6 @@ The Electron team is currently undergoing an initiative to convert separate gett
 * `BrowserWindow`
   * `fullscreen`
   * `simpleFullscreen`
-  * `movable`
-  * `resizable`
-  * `maximizable`
-  * `minimizable`
-  * `fullscreenable`
-  * `closable`
   * `alwaysOnTop`
   * `title`
   * `documentEdited`
@@ -55,6 +49,12 @@ The Electron team is currently undergoing an initiative to convert separate gett
   * `name`
 * `BrowserWindow` module
   * `autohideMenuBar`
+  * `resizable`
+  * `maximizable`
+  * `minimizable`
+  * `fullscreenable`
+  * `movable`
+  * `closable`
 * `NativeImage`
   * `isMacTemplateImage`
 * `SystemPreferences` module

diff --git a/lib/browser/api/app.ts b/lib/browser/api/app.ts
@@ -77,9 +77,9 @@ for (const name of events) {
 }
 
 // Property Deprecations
-deprecate.fnToProperty(app, 'accessibilitySupportEnabled', '_isAccessibilitySupportEnabled', '_setAccessibilitySupportEnabled')
-deprecate.fnToProperty(app, 'badgeCount', '_getBadgeCount', '_setBadgeCount')
-deprecate.fnToProperty(app, 'name', '_getName', '_setName')
+deprecate.fnToProperty(App.prototype, 'accessibilitySupportEnabled', '_isAccessibilitySupportEnabled', '_setAccessibilitySupportEnabled')
+deprecate.fnToProperty(App.prototype, 'badgeCount', '_getBadgeCount', '_setBadgeCount')
+deprecate.fnToProperty(App.prototype, 'name', '_getName', '_setName')
 
 // Wrappers for native classes.
 const { DownloadItem } = process.electronBinding('download_item')

diff --git a/lib/browser/api/browser-window.js b/lib/browser/api/browser-window.js
@@ -193,5 +193,11 @@ Object.assign(BrowserWindow.prototype, {
 
 // Deprecations
 deprecate.fnToProperty(BrowserWindow.prototype, 'autoHideMenuBar', '_isMenuBarAutoHide', '_setAutoHideMenuBar')
+deprecate.fnToProperty(BrowserWindow.prototype, 'minimizable', '_isMinimizable', '_setMinimizable')
+deprecate.fnToProperty(BrowserWindow.prototype, 'maximizable', '_isMaximizable', '_setMaximizable')
+deprecate.fnToProperty(BrowserWindow.prototype, 'resizable', '_isResizable', '_setResizable')
+deprecate.fnToProperty(BrowserWindow.prototype, 'fullScreenable', '_isFullScreenable', '_setFullScreenable')
+deprecate.fnToProperty(BrowserWindow.prototype, 'closable', '_isClosable', '_setClosable')
+deprecate.fnToProperty(BrowserWindow.prototype, 'movable', '_isMovable', '_setMovable')
 
 module.exports = BrowserWindow
diff --git a/lib/browser/api/system-preferences.js b/lib/browser/api/system-preferences.js
@@ -9,7 +9,7 @@ Object.setPrototypeOf(SystemPreferences.prototype, EventEmitter.prototype)
 EventEmitter.call(systemPreferences)
 
 if ('appLevelAppearance' in systemPreferences) {
-  deprecate.fnToProperty(systemPreferences, 'appLevelAppearance', '_getAppLevelAppearance', '_setAppLevelAppearance')
+  deprecate.fnToProperty(SystemPreferences.prototype, 'appLevelAppearance', '_getAppLevelAppearance', '_setAppLevelAppearance')
 }
 
 module.exports = systemPreferences
diff --git a/lib/common/api/deprecate.ts b/lib/common/api/deprecate.ts
@@ -57,17 +57,18 @@ const deprecate: ElectronInternal.DeprecationUtil = {
   },
 
   // deprecate a getter/setter function pair in favor of a property
-  fnToProperty: (module: any, prop: string, getter: string, setter: string) => {
-    const withWarnOnce = (obj: any, key: any, oldName: string, newName: string) => {
+  fnToProperty: (prototype: any, prop: string, getter: string, setter: string) => {
+    const withWarnOnce = function (obj: any, key: any, oldName: string, newName: string) {
       const warn = warnOnce(oldName, newName)
-      return (...args: any) => {
+      const method = obj[key]
+      return function (this: any, ...args: any) {
         warn()
-        return obj[key](...args)
+        return method.apply(this, args)
       }
     }
 
-    module[getter.substr(1)] = withWarnOnce(module, getter, `${getter.substr(1)} function`, `${prop} property`)
-    module[setter.substr(1)] = withWarnOnce(module, setter, `${setter.substr(1)} function`, `${prop} property`)
+    prototype[getter.substr(1)] = withWarnOnce(prototype, getter, `${getter.substr(1)} function`, `${prop} property`)
+    prototype[setter.substr(1)] = withWarnOnce(prototype, setter, `${setter.substr(1)} function`, `${prop} property`)
   },
 
   // remove a property with no replacement