From 030d2a843c486122d49b63210b1bffa1916d8f77 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Thu, 14 Jan 2016 11:10:12 -0800 Subject: [PATCH] Remove extra newlines around comments --- atom/browser/api/lib/app.js | 7 - atom/browser/api/lib/auto-updater.js | 4 - .../lib/auto-updater/squirrel-update-win.js | 6 - atom/browser/api/lib/browser-window.js | 2 - atom/browser/api/lib/dialog.js | 4 - atom/browser/api/lib/exports/electron.js | 1 - atom/browser/api/lib/ipc.js | 2 - atom/browser/api/lib/menu-item.js | 4 - atom/browser/api/lib/menu.js | 14 -- atom/browser/api/lib/navigation-controller.js | 2 - atom/browser/api/lib/protocol.js | 2 - atom/browser/api/lib/session.js | 5 - atom/browser/api/lib/tray.js | 1 - atom/browser/api/lib/web-contents.js | 1 - atom/browser/lib/chrome-extension.js | 11 -- atom/browser/lib/desktop-capturer.js | 3 - atom/browser/lib/guest-view-manager.js | 16 -- atom/browser/lib/guest-window-manager.js | 8 - atom/browser/lib/init.js | 33 ---- atom/browser/lib/objects-registry.js | 3 - atom/browser/lib/rpc-server.js | 10 -- atom/common/api/lib/callbacks-registry.js | 1 - atom/common/api/lib/clipboard.js | 1 - atom/common/api/lib/deprecate.js | 13 -- atom/common/api/lib/exports/electron.js | 3 - atom/common/api/lib/native-image.js | 2 - atom/common/lib/asar.js | 18 --- atom/common/lib/init.js | 2 - atom/common/lib/reset-search-paths.js | 6 - atom/renderer/api/lib/desktop-capturer.js | 2 - atom/renderer/api/lib/exports/electron.js | 3 - atom/renderer/api/lib/ipc-renderer.js | 2 - atom/renderer/api/lib/ipc.js | 6 - atom/renderer/api/lib/remote.js | 66 ++------ atom/renderer/lib/init.js | 23 +-- atom/renderer/lib/inspector.js | 1 - atom/renderer/lib/override.js | 19 --- .../lib/web-view/web-view-attributes.js | 77 ++-------- .../lib/web-view/web-view-constants.js | 1 - atom/renderer/lib/web-view/web-view.js | 143 +++++++++--------- 40 files changed, 103 insertions(+), 425 deletions(-) diff --git a/atom/browser/api/lib/app.js b/atom/browser/api/lib/app.js index 7d0d0694147d..560fcb8630ee 100644 --- a/atom/browser/api/lib/app.js +++ b/atom/browser/api/lib/app.js @@ -53,9 +53,7 @@ app.getAppPath = function() { return appPath; }; - // Routes the events to webContents. - ref1 = ['login', 'certificate-error', 'select-client-certificate']; fn = function(name) { return app.on(name, function() { @@ -69,7 +67,6 @@ for (i = 0, len = ref1.length; i < len; i++) { fn(name); } - // Deprecated. app.getHomeDir = deprecate('app.getHomeDir', 'app.getPath', function() { @@ -108,9 +105,7 @@ deprecate.event(app, 'activate-with-no-open-windows', 'activate', function(event deprecate.event(app, 'select-certificate', 'select-client-certificate'); - // Wrappers for native classes. - wrapDownloadItem = function(downloadItem) { // downloadItem is an EventEmitter. @@ -125,7 +120,5 @@ wrapDownloadItem = function(downloadItem) { downloadItemBindings._setWrapDownloadItem(wrapDownloadItem); - // Only one App object pemitted. - module.exports = app; diff --git a/atom/browser/api/lib/auto-updater.js b/atom/browser/api/lib/auto-updater.js index e8e447ab1802..a3ffc12e9f2d 100644 --- a/atom/browser/api/lib/auto-updater.js +++ b/atom/browser/api/lib/auto-updater.js @@ -4,11 +4,7 @@ deprecate = require('electron').deprecate; autoUpdater = process.platform === 'win32' ? require('./auto-updater/auto-updater-win') : require('./auto-updater/auto-updater-native'); - // Deprecated. - deprecate.rename(autoUpdater, 'setFeedUrl', 'setFeedURL'); - - module.exports = autoUpdater; diff --git a/atom/browser/api/lib/auto-updater/squirrel-update-win.js b/atom/browser/api/lib/auto-updater/squirrel-update-win.js index 2f68c1dace46..49d525f4a684 100644 --- a/atom/browser/api/lib/auto-updater/squirrel-update-win.js +++ b/atom/browser/api/lib/auto-updater/squirrel-update-win.js @@ -61,16 +61,12 @@ spawnUpdate = function(args, detached, callback) { }); }; - // Start an instance of the installed app. - exports.processStart = function(callback) { return spawnUpdate(['--processStart', exeName], true, function() {}); }; - // Download the releases specified by the URL and write new results to stdout. - exports.download = function(updateURL, callback) { return spawnUpdate(['--download', updateURL], false, function(error, stdout) { var error1, json, ref, ref1, update; @@ -91,14 +87,12 @@ exports.download = function(updateURL, callback) { // Update the application to the latest remote version specified by URL. - exports.update = function(updateURL, callback) { return spawnUpdate(['--update', updateURL], false, callback); }; // Is the Update.exe installed with the current application? - exports.supported = function() { var error1; try { diff --git a/atom/browser/api/lib/browser-window.js b/atom/browser/api/lib/browser-window.js index 79395250f823..df9ae1647383 100644 --- a/atom/browser/api/lib/browser-window.js +++ b/atom/browser/api/lib/browser-window.js @@ -151,7 +151,6 @@ BrowserWindow.fromDevToolsWebContents = function(webContents) { } }; - // Helpers. BrowserWindow.prototype.loadURL = function() { @@ -198,7 +197,6 @@ BrowserWindow.prototype.inspectServiceWorker = function() { return this.webContents.inspectServiceWorker(); }; - // Deprecated. deprecate.member(BrowserWindow, 'undo', 'webContents'); diff --git a/atom/browser/api/lib/dialog.js b/atom/browser/api/lib/dialog.js index 9932988216ad..9ed49738a55b 100644 --- a/atom/browser/api/lib/dialog.js +++ b/atom/browser/api/lib/dialog.js @@ -23,14 +23,12 @@ messageBoxOptions = { parseArgs = function(window, options, callback) { if (!(window === null || (window != null ? window.constructor : void 0) === BrowserWindow)) { - // Shift. callback = options; options = window; window = null; } if ((callback == null) && typeof options === 'function') { - // Shift. callback = options; options = null; @@ -165,9 +163,7 @@ module.exports = { } }; - // Mark standard asynchronous functions. - ref1 = ['showMessageBox', 'showOpenDialog', 'showSaveDialog']; for (j = 0, len = ref1.length; j < len; j++) { api = ref1[j]; diff --git a/atom/browser/api/lib/exports/electron.js b/atom/browser/api/lib/exports/electron.js index 2ec917d16eba..74ae751e0834 100644 --- a/atom/browser/api/lib/exports/electron.js +++ b/atom/browser/api/lib/exports/electron.js @@ -4,7 +4,6 @@ common = require('../../../../common/api/lib/exports/electron'); // Import common modules. - common.defineProperties(exports); Object.defineProperties(exports, { diff --git a/atom/browser/api/lib/ipc.js b/atom/browser/api/lib/ipc.js index e314f9360178..ed20e976173f 100644 --- a/atom/browser/api/lib/ipc.js +++ b/atom/browser/api/lib/ipc.js @@ -2,9 +2,7 @@ var deprecate, ipcMain, ref; ref = require('electron'), deprecate = ref.deprecate, ipcMain = ref.ipcMain; - // This module is deprecated, we mirror everything from ipcMain. - deprecate.warn('ipc module', 'require("electron").ipcMain'); module.exports = ipcMain; diff --git a/atom/browser/api/lib/menu-item.js b/atom/browser/api/lib/menu-item.js index 2e0980983c50..b8357dd34918 100644 --- a/atom/browser/api/lib/menu-item.js +++ b/atom/browser/api/lib/menu-item.js @@ -4,9 +4,7 @@ v8Util = process.atomBinding('v8_util'); nextCommandId = 0; - // Maps role to methods of webContents - rolesMap = { undo: 'undo', redo: 'redo', @@ -18,9 +16,7 @@ rolesMap = { close: 'close' }; - // Maps methods that should be called directly on the BrowserWindow instance - methodInBrowserWindow = { minimize: true, close: true diff --git a/atom/browser/api/lib/menu.js b/atom/browser/api/lib/menu.js index 69b3b3a80b73..5af39e18af32 100644 --- a/atom/browser/api/lib/menu.js +++ b/atom/browser/api/lib/menu.js @@ -8,17 +8,11 @@ v8Util = process.atomBinding('v8_util'); bindings = process.atomBinding('menu'); - // Automatically generated radio menu item's group id. - nextGroupId = 0; - // Search between seperators to find a radio menu item and return its group id, - - // otherwise generate a group id. - generateGroupId = function(items, pos) { var i, item, j, k, ref1, ref2, ref3; if (pos > 0) { @@ -45,9 +39,7 @@ generateGroupId = function(items, pos) { return ++nextGroupId; }; - // Returns the index of item according to |id|. - indexOfItemById = function(items, id) { var i, item, j, len; for (i = j = 0, len = items.length; j < len; i = ++j) { @@ -59,9 +51,7 @@ indexOfItemById = function(items, id) { return -1; }; - // Returns the index of where to insert the item according to |position|. - indexToInsertByPosition = function(items, position) { var id, insertIndex, query, ref1; if (!position) { @@ -174,7 +164,6 @@ Menu.prototype._init = function() { Menu.prototype.popup = function(window, x, y) { if ((window != null ? window.constructor : void 0) !== BrowserWindow) { - // Shift. y = x; x = window; @@ -210,7 +199,6 @@ Menu.prototype.insert = function(pos, item) { this.insertSubMenu(pos, item.commandId, item.label, item.submenu); break; case 'radio': - // Grouping radio menu items. item.overrideReadOnlyProperty('groupId', generateGroupId(this.items, pos)); if ((base = this.groupsMap)[name = item.groupId] == null) { @@ -261,7 +249,6 @@ Menu.prototype.insert = function(pos, item) { // Force menuWillShow to be called - Menu.prototype._callMenuWillShow = function() { var item, j, len, ref1, ref2, results; if ((ref1 = this.delegate) != null) { @@ -323,7 +310,6 @@ Menu.buildFromTemplate = function(template) { if (item.position) { insertIndex = indexToInsertByPosition(positionedTemplate, item.position); } else { - // If no |position| is specified, insert after last item. insertIndex++; } diff --git a/atom/browser/api/lib/navigation-controller.js b/atom/browser/api/lib/navigation-controller.js index 5e613f416f4e..5478b6dd3264 100644 --- a/atom/browser/api/lib/navigation-controller.js +++ b/atom/browser/api/lib/navigation-controller.js @@ -3,9 +3,7 @@ var NavigationController, ipcMain, ipcMain = require('electron').ipcMain; - // The history operation in renderer is redirected to browser. - ipcMain.on('ATOM_SHELL_NAVIGATION_CONTROLLER', function() { var args, event, method, ref; event = arguments[0], method = arguments[1], args = 3 <= arguments.length ? slice.call(arguments, 2) : []; diff --git a/atom/browser/api/lib/protocol.js b/atom/browser/api/lib/protocol.js index dc92c676485f..f04eab121f15 100644 --- a/atom/browser/api/lib/protocol.js +++ b/atom/browser/api/lib/protocol.js @@ -8,9 +8,7 @@ if (!app.isReady()) { protocol = process.atomBinding('protocol').protocol; - // Warn about removed APIs. - logAndThrow = function(callback, message) { console.error(message); if (callback) { diff --git a/atom/browser/api/lib/session.js b/atom/browser/api/lib/session.js index d3b889cc09d3..8ba9e61be45a 100644 --- a/atom/browser/api/lib/session.js +++ b/atom/browser/api/lib/session.js @@ -6,9 +6,7 @@ bindings = process.atomBinding('session'); PERSIST_PERFIX = 'persist:'; - // Returns the Session from |partition| string. - exports.fromPartition = function(partition) { if (partition == null) { partition = ''; @@ -23,9 +21,7 @@ exports.fromPartition = function(partition) { } }; - // Returns the default session. - Object.defineProperty(exports, 'defaultSession', { enumerable: true, get: function() { @@ -34,7 +30,6 @@ Object.defineProperty(exports, 'defaultSession', { }); wrapSession = function(session) { - // session is an EventEmitter. return session.__proto__ = EventEmitter.prototype; }; diff --git a/atom/browser/api/lib/tray.js b/atom/browser/api/lib/tray.js index db692a089372..a2b732964ea4 100644 --- a/atom/browser/api/lib/tray.js +++ b/atom/browser/api/lib/tray.js @@ -9,7 +9,6 @@ Tray = process.atomBinding('tray').Tray; Tray.prototype.__proto__ = EventEmitter.prototype; Tray.prototype._init = function() { - // Deprecated. deprecate.rename(this, 'popContextMenu', 'popUpContextMenu'); deprecate.event(this, 'clicked', 'click'); diff --git a/atom/browser/api/lib/web-contents.js b/atom/browser/api/lib/web-contents.js index b1d7ee4febd9..c507daab077e 100644 --- a/atom/browser/api/lib/web-contents.js +++ b/atom/browser/api/lib/web-contents.js @@ -65,7 +65,6 @@ const webFrameMethods = [ ]; wrapWebContents = function(webContents) { - // webContents is an EventEmitter. var controller, method, name, ref1; webContents.__proto__ = EventEmitter.prototype; diff --git a/atom/browser/lib/chrome-extension.js b/atom/browser/lib/chrome-extension.js index a6bb44e33823..44e7f947e391 100644 --- a/atom/browser/lib/chrome-extension.js +++ b/atom/browser/lib/chrome-extension.js @@ -8,9 +8,7 @@ path = require('path'); url = require('url'); - // Mapping between hostname and file path. - hostPathMap = {}; hostPathMapNextKey = 0; @@ -26,9 +24,7 @@ getPathForHost = function(host) { return hostPathMap[host]; }; - // Cache extensionInfo. - extensionInfoMap = {}; getExtensionInfoFromPath = function(srcDirectory) { @@ -54,16 +50,11 @@ getExtensionInfoFromPath = function(srcDirectory) { } }; - // The loaded extensions cache and its persistent path. - loadedExtensions = null; - loadedExtensionsPath = null; - // Persistent loaded extensions. - app = electron.app; app.on('will-quit', function() { @@ -83,9 +74,7 @@ app.on('will-quit', function() { } }); - // We can not use protocol or BrowserWindow until app is ready. - app.once('ready', function() { var BrowserWindow, chromeExtensionHandler, e, error1, i, init, len, protocol, srcDirectory; protocol = electron.protocol, BrowserWindow = electron.BrowserWindow; diff --git a/atom/browser/lib/desktop-capturer.js b/atom/browser/lib/desktop-capturer.js index 68da4e27f1e4..638d87c3af32 100644 --- a/atom/browser/lib/desktop-capturer.js +++ b/atom/browser/lib/desktop-capturer.js @@ -8,9 +8,7 @@ deepEqual = function(opt1, opt2) { return JSON.stringify(opt1) === JSON.stringify(opt2); }; - // A queue for holding all requests from renderer process. - requestsQueue = []; ipcMain.on('ATOM_BROWSER_DESKTOP_CAPTURER_GET_SOURCES', function(event, captureWindow, captureScreen, thumbnailSize, id) { @@ -37,7 +35,6 @@ ipcMain.on('ATOM_BROWSER_DESKTOP_CAPTURER_GET_SOURCES', function(event, captureW }); desktopCapturer.emit = function(event, name, sources) { - // Receiving sources result from main process, now send them back to renderer. var captureScreen, captureWindow, handledRequest, i, len, ref, ref1, ref2, request, result, source, thumbnailSize, unhandledRequestsQueue; handledRequest = requestsQueue.shift(0); diff --git a/atom/browser/lib/guest-view-manager.js b/atom/browser/lib/guest-view-manager.js index fa409f89c41b..a07803069966 100644 --- a/atom/browser/lib/guest-view-manager.js +++ b/atom/browser/lib/guest-view-manager.js @@ -3,9 +3,7 @@ var attachGuest, createGuest, destroyGuest, embedderElementsMap, getNextInstance ref = require('electron'), ipcMain = ref.ipcMain, webContents = ref.webContents; - // Doesn't exist in early initialization. - webViewManager = null; supportedWebViewEvents = ['load-commit', 'did-finish-load', 'did-fail-load', 'did-frame-finish-load', 'did-start-loading', 'did-stop-loading', 'did-get-response-details', 'did-get-redirect-request', 'dom-ready', 'console-message', 'devtools-opened', 'devtools-closed', 'devtools-focused', 'new-window', 'will-navigate', 'did-navigate', 'did-navigate-in-page', 'close', 'crashed', 'gpu-crashed', 'plugin-crashed', 'destroyed', 'page-title-updated', 'page-favicon-updated', 'enter-html-full-screen', 'leave-html-full-screen', 'media-started-playing', 'media-paused', 'found-in-page', 'did-change-theme-color']; @@ -18,23 +16,17 @@ embedderElementsMap = {}; reverseEmbedderElementsMap = {}; - // Moves the last element of array to the first one. - moveLastToFirst = function(list) { return list.unshift(list.pop()); }; - // Generate guestInstanceId. - getNextInstanceId = function(webContents) { return ++nextInstanceId; }; - // Create a new guest instance. - createGuest = function(embedder, params) { var destroy, destroyEvents, event, fn, guest, i, id, j, len, len1, listeners; if (webViewManager == null) { @@ -146,9 +138,7 @@ createGuest = function(embedder, params) { return id; }; - // Attach the guest to an element of embedder. - attachGuest = function(embedder, elementInstanceId, guestInstanceId, params) { var guest, key, oldGuestInstanceId, ref1, webPreferences; guest = guestInstances[guestInstanceId].guest; @@ -182,9 +172,7 @@ attachGuest = function(embedder, elementInstanceId, guestInstanceId, params) { return reverseEmbedderElementsMap[guestInstanceId] = key; }; - // Destroy an existing guest instance. - destroyGuest = function(embedder, id) { var key; webViewManager.removeGuest(embedder, id); @@ -219,17 +207,13 @@ ipcMain.on('ATOM_SHELL_GUEST_VIEW_MANAGER_SET_ALLOW_TRANSPARENCY', function(even return (ref1 = guestInstances[id]) != null ? ref1.guest.setAllowTransparency(allowtransparency) : void 0; }); - // Returns WebContents from its guest id. - exports.getGuest = function(id) { var ref1; return (ref1 = guestInstances[id]) != null ? ref1.guest : void 0; }; - // Returns the embedder of the guest. - exports.getEmbedder = function(id) { var ref1; return (ref1 = guestInstances[id]) != null ? ref1.embedder : void 0; diff --git a/atom/browser/lib/guest-window-manager.js b/atom/browser/lib/guest-window-manager.js index df129b4a0928..f57b8eb1327e 100644 --- a/atom/browser/lib/guest-window-manager.js +++ b/atom/browser/lib/guest-window-manager.js @@ -8,9 +8,7 @@ v8Util = process.atomBinding('v8_util'); frameToGuest = {}; - // Copy attribute of |parent| to |child| if it is not defined in |child|. - mergeOptions = function(child, parent) { var key, value; for (key in parent) { @@ -27,9 +25,7 @@ mergeOptions = function(child, parent) { return child; }; - // Merge |options| with the |embedder|'s window's options. - mergeBrowserWindowOptions = function(embedder, options) { if (embedder.browserWindowOptions != null) { @@ -46,9 +42,7 @@ mergeBrowserWindowOptions = function(embedder, options) { return options; }; - // Create a new guest created by |embedder| with |options|. - createGuest = function(embedder, url, frameName, options) { var closedByEmbedder, closedByUser, guest, guestId, ref1; guest = frameToGuest[frameName]; @@ -89,9 +83,7 @@ createGuest = function(embedder, url, frameName, options) { return guest.id; }; - // Routed window.open messages. - ipcMain.on('ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPEN', function() { var args, event, frameName, options, url; event = arguments[0], args = 2 <= arguments.length ? slice.call(arguments, 1) : []; diff --git a/atom/browser/lib/init.js b/atom/browser/lib/init.js index 9ce4e55ee3be..03e4c9c18718 100644 --- a/atom/browser/lib/init.js +++ b/atom/browser/lib/init.js @@ -9,12 +9,8 @@ util = require('util'); Module = require('module'); - // We modified the original process.argv to let node.js load the atom.js, - - // we need to restore it here. - process.argv.splice(1, 1); // Clear search paths. @@ -62,9 +58,7 @@ if (process.platform === 'win32') { }); } - // Don't quit on fatal error. - process.on('uncaughtException', function(error) { // Do nothing if the user has a custom uncaught exception handler. @@ -80,35 +74,26 @@ process.on('uncaughtException', function(error) { return dialog.showErrorBox('A JavaScript error occurred in the main process', message); }); - // Emit 'exit' event on quit. - app = require('electron').app; app.on('quit', function(event, exitCode) { return process.emit('exit', exitCode); }); - // Map process.exit to app.exit, which quits gracefully. - process.exit = app.exit; - // Load the RPC server. - require('./rpc-server'); - // Load the guest view manager. - require('./guest-view-manager'); require('./guest-window-manager'); // Now we try to load app's package.json. - packageJson = null; searchPaths = ['app', 'app.asar', 'default_app']; @@ -132,61 +117,43 @@ if (packageJson == null) { throw new Error("Unable to find a valid app"); } - // Set application's version. - if (packageJson.version != null) { app.setVersion(packageJson.version); } - // Set application's name. - if (packageJson.productName != null) { app.setName(packageJson.productName); } else if (packageJson.name != null) { app.setName(packageJson.name); } - // Set application's desktop name. - if (packageJson.desktopName != null) { app.setDesktopName(packageJson.desktopName); } else { app.setDesktopName((app.getName()) + ".desktop"); } - // Chrome 42 disables NPAPI plugins by default, reenable them here - app.commandLine.appendSwitch('enable-npapi'); - // Set the user path according to application's name. - app.setPath('userData', path.join(app.getPath('appData'), app.getName())); app.setPath('userCache', path.join(app.getPath('cache'), app.getName())); app.setAppPath(packagePath); - // Load the chrome extension support. - require('./chrome-extension'); - // Load internal desktop-capturer module. - require('./desktop-capturer'); - // Set main startup script of the app. - mainStartupScript = packageJson.main || 'index.js'; - // Finally load app's main.js and transfer control to C++. - Module._load(path.join(packagePath, mainStartupScript), Module, true); diff --git a/atom/browser/lib/objects-registry.js b/atom/browser/lib/objects-registry.js index 082f1ef3441d..a468c89219cc 100644 --- a/atom/browser/lib/objects-registry.js +++ b/atom/browser/lib/objects-registry.js @@ -65,7 +65,6 @@ ObjectsRegistry = (function(superClass) { } }; - // Clear all references to objects refrenced by the WebContents. ObjectsRegistry.prototype.clear = function(webContentsId) { var count, id, ref; @@ -81,7 +80,6 @@ ObjectsRegistry = (function(superClass) { return delete this.owners[webContentsId]; }; - // Private: Saves the object into storage and assigns an ID for it. ObjectsRegistry.prototype.saveToStorage = function(object) { var id; @@ -98,7 +96,6 @@ ObjectsRegistry = (function(superClass) { return id; }; - // Private: Dereference the object from store. ObjectsRegistry.prototype.dereference = function(id, count) { var pointer; diff --git a/atom/browser/lib/rpc-server.js b/atom/browser/lib/rpc-server.js index 13405b8ed96d..a8add74e0321 100644 --- a/atom/browser/lib/rpc-server.js +++ b/atom/browser/lib/rpc-server.js @@ -13,9 +13,7 @@ v8Util = process.atomBinding('v8_util'); IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap; - // Convert a real value into meta data. - valueToMeta = function(sender, value, optimizeSimpleObject) { var el, field, i, len, meta, name; if (optimizeSimpleObject == null) { @@ -98,9 +96,7 @@ valueToMeta = function(sender, value, optimizeSimpleObject) { return meta; }; - // Convert object to meta by value. - plainObjectToMeta = function(obj) { return Object.getOwnPropertyNames(obj).map(function(name) { return { @@ -110,9 +106,7 @@ plainObjectToMeta = function(obj) { }); }; - // Convert Error into meta data. - exceptionToMeta = function(error) { return { type: 'exception', @@ -121,9 +115,7 @@ exceptionToMeta = function(error) { }; }; - // Convert array of meta data from renderer into array of real values. - unwrapArgs = function(sender, args) { var metaToValue; metaToValue = function(meta) { @@ -157,7 +149,6 @@ unwrapArgs = function(sender, args) { return returnValue; }; case 'function': - // Cache the callbacks in renderer. if (!sender.callbacks) { sender.callbacks = new IDWeakMap; @@ -221,7 +212,6 @@ callFunction = function(event, func, caller, args) { } }; - // Send by BrowserWindow when its render view is deleted. process.on('ATOM_BROWSER_RELEASE_RENDER_VIEW', function(id) { return objectsRegistry.clear(id); diff --git a/atom/common/api/lib/callbacks-registry.js b/atom/common/api/lib/callbacks-registry.js index 5c74388ec409..e4cfe8161236 100644 --- a/atom/common/api/lib/callbacks-registry.js +++ b/atom/common/api/lib/callbacks-registry.js @@ -10,7 +10,6 @@ module.exports = CallbacksRegistry = (function() { } CallbacksRegistry.prototype.add = function(callback) { - // The callback is already added. var filenameAndLine, id, location, match, ref, regexp, stackString, x; id = v8Util.getHiddenValue(callback, 'callbackId'); diff --git a/atom/common/api/lib/clipboard.js b/atom/common/api/lib/clipboard.js index 02b3de2e0623..cd1cb53e4001 100644 --- a/atom/common/api/lib/clipboard.js +++ b/atom/common/api/lib/clipboard.js @@ -1,5 +1,4 @@ if (process.platform === 'linux' && process.type === 'renderer') { - // On Linux we could not access clipboard in renderer process. module.exports = require('electron').remote.clipboard; } else { diff --git a/atom/common/api/lib/deprecate.js b/atom/common/api/lib/deprecate.js index b588bb1af41e..dcaf5f6cf6f9 100644 --- a/atom/common/api/lib/deprecate.js +++ b/atom/common/api/lib/deprecate.js @@ -1,4 +1,3 @@ - // Deprecate a method. var deprecate, slice = [].slice; @@ -15,9 +14,7 @@ deprecate = function(oldName, newName, fn) { }; }; - // The method is renamed. - deprecate.rename = function(object, oldName, newName) { var newMethod, warned; warned = false; @@ -35,9 +32,7 @@ deprecate.rename = function(object, oldName, newName) { } }; - // Forward the method to member. - deprecate.member = function(object, method, member) { var warned; warned = false; @@ -50,9 +45,7 @@ deprecate.member = function(object, method, member) { }; }; - // Deprecate a property. - deprecate.property = function(object, property, method) { return Object.defineProperty(object, property, { get: function() { @@ -67,9 +60,7 @@ deprecate.property = function(object, property, method) { }); }; - // Deprecate an event. - deprecate.event = function(emitter, oldName, newName, fn) { var warned; warned = false; @@ -92,16 +83,12 @@ deprecate.event = function(emitter, oldName, newName, fn) { }); }; - // Print deprecation warning. - deprecate.warn = function(oldName, newName) { return deprecate.log(oldName + " is deprecated. Use " + newName + " instead."); }; - // Print deprecation message. - deprecate.log = function(message) { if (process.throwDeprecation) { throw new Error(message); diff --git a/atom/common/api/lib/exports/electron.js b/atom/common/api/lib/exports/electron.js index f818fb4cac80..178b2d1046bc 100644 --- a/atom/common/api/lib/exports/electron.js +++ b/atom/common/api/lib/exports/electron.js @@ -1,4 +1,3 @@ - // Do not expose the internal modules to `require`. exports.hideInternalModules = function() { var globalPaths; @@ -10,9 +9,7 @@ exports.hideInternalModules = function() { } }; - // Attaches properties to |exports|. - exports.defineProperties = function(exports) { return Object.defineProperties(exports, { diff --git a/atom/common/api/lib/native-image.js b/atom/common/api/lib/native-image.js index 44a4330fa894..1546cfaa7e6d 100644 --- a/atom/common/api/lib/native-image.js +++ b/atom/common/api/lib/native-image.js @@ -4,9 +4,7 @@ deprecate = require('electron').deprecate; nativeImage = process.atomBinding('native_image'); - // Deprecated. - deprecate.rename(nativeImage, 'createFromDataUrl', 'createFromDataURL'); module.exports = nativeImage; diff --git a/atom/common/lib/asar.js b/atom/common/lib/asar.js index 843b6d75aa7f..82a5139ee67e 100644 --- a/atom/common/lib/asar.js +++ b/atom/common/lib/asar.js @@ -10,9 +10,7 @@ path = require('path'); util = require('util'); - // Cache asar archive objects. - cachedArchives = {}; getOrCreateArchive = function(p) { @@ -28,9 +26,7 @@ getOrCreateArchive = function(p) { return cachedArchives[p] = archive; }; - // Clean cache on quit. - process.on('exit', function() { var archive, p, results; results = []; @@ -42,9 +38,7 @@ process.on('exit', function() { return results; }); - // Separate asar package's path from full path. - splitPath = function(p) { // shortcut to disable asar. @@ -66,9 +60,7 @@ splitPath = function(p) { return [true, p.substr(0, index + 5), p.substr(index + 6)]; }; - // Convert asar archive's Stats object to fs's Stats object. - nextInode = 0; uid = process.getuid != null ? process.getuid() : 0; @@ -115,9 +107,7 @@ asarStatsToFsStats = function(stats) { }; }; - // Create a ENOENT error. - notFoundError = function(asarPath, filePath, callback) { var error; error = new Error("ENOENT, " + filePath + " not found in " + asarPath); @@ -131,9 +121,7 @@ notFoundError = function(asarPath, filePath, callback) { }); }; - // Create a ENOTDIR error. - notDirError = function(callback) { var error; error = new Error('ENOTDIR, not a directory'); @@ -147,9 +135,7 @@ notDirError = function(callback) { }); }; - // Create invalid archive error. - invalidArchiveError = function(asarPath, callback) { var error; error = new Error("Invalid package " + asarPath); @@ -161,9 +147,7 @@ invalidArchiveError = function(asarPath, callback) { }); }; - // Override APIs that rely on passing file path instead of content to C++. - overrideAPISync = function(module, name, arg) { var old; if (arg == null) { @@ -220,9 +204,7 @@ overrideAPI = function(module, name, arg) { }; }; - // Override fs APIs. - exports.wrapFsWithAsar = function(fs) { var exists, existsSync, internalModuleReadFile, internalModuleStat, lstat, lstatSync, mkdir, mkdirSync, open, openSync, readFile, readFileSync, readdir, readdirSync, realpath, realpathSync, stat, statSync, statSyncNoException; lstatSync = fs.lstatSync; diff --git a/atom/common/lib/init.js b/atom/common/lib/init.js index dca836c7db81..2165603e87e6 100644 --- a/atom/common/lib/init.js +++ b/atom/common/lib/init.js @@ -21,7 +21,6 @@ process.atomBinding = function(name) { }; if (!process.env.ELECTRON_HIDE_INTERNAL_MODULES) { - // Add common/api/lib to module search paths. Module.globalPaths.push(path.resolve(__dirname, '..', 'api', 'lib')); } @@ -47,7 +46,6 @@ global.setImmediate = wrapWithActivateUvLoop(timers.setImmediate); global.clearImmediate = timers.clearImmediate; if (process.type === 'browser') { - // setTimeout needs to update the polling timeout of the event loop, when // called under Chromium's event loop the node's event loop won't get a chance // to update the timeout, so we have to force the node's event loop to diff --git a/atom/common/lib/reset-search-paths.js b/atom/common/lib/reset-search-paths.js index ef7a5913c205..a996cd4ceca8 100644 --- a/atom/common/lib/reset-search-paths.js +++ b/atom/common/lib/reset-search-paths.js @@ -4,21 +4,15 @@ path = require('path'); Module = require('module'); - // Clear Node's global search paths. - Module.globalPaths.length = 0; - // Clear current and parent(init.coffee)'s search paths. - module.paths = []; module.parent.paths = []; - // Prevent Node from adding paths outside this app to search paths. - Module._nodeModulePaths = function(from) { var dir, i, part, parts, paths, skipOutsidePaths, splitRe, tip; from = path.resolve(from); diff --git a/atom/renderer/api/lib/desktop-capturer.js b/atom/renderer/api/lib/desktop-capturer.js index ce9443c1ed8a..5b44bdf5f23e 100644 --- a/atom/renderer/api/lib/desktop-capturer.js +++ b/atom/renderer/api/lib/desktop-capturer.js @@ -9,9 +9,7 @@ getNextId = function() { return ++nextId; }; - // |options.type| can not be empty and has to include 'window' or 'screen'. - isValid = function(options) { return ((options != null ? options.types : void 0) != null) && Array.isArray(options.types); }; diff --git a/atom/renderer/api/lib/exports/electron.js b/atom/renderer/api/lib/exports/electron.js index a740d88bd0a4..e3fe7b335317 100644 --- a/atom/renderer/api/lib/exports/electron.js +++ b/atom/renderer/api/lib/exports/electron.js @@ -2,13 +2,10 @@ var common; common = require('../../../../common/api/lib/exports/electron'); - // Import common modules. - common.defineProperties(exports); Object.defineProperties(exports, { - // Renderer side modules, please sort with alphabet order. desktopCapturer: { enumerable: true, diff --git a/atom/renderer/api/lib/ipc-renderer.js b/atom/renderer/api/lib/ipc-renderer.js index 95e9b097d1e8..cd6b37c3db45 100644 --- a/atom/renderer/api/lib/ipc-renderer.js +++ b/atom/renderer/api/lib/ipc-renderer.js @@ -7,9 +7,7 @@ binding = process.atomBinding('ipc'); v8Util = process.atomBinding('v8_util'); - // Created by init.coffee. - ipcRenderer = v8Util.getHiddenValue(global, 'ipc'); ipcRenderer.send = function() { diff --git a/atom/renderer/api/lib/ipc.js b/atom/renderer/api/lib/ipc.js index 3578c56d3da9..1e0e703e6a84 100644 --- a/atom/renderer/api/lib/ipc.js +++ b/atom/renderer/api/lib/ipc.js @@ -5,14 +5,10 @@ ref = require('electron'), ipcRenderer = ref.ipcRenderer, deprecate = ref.deprec EventEmitter = require('events').EventEmitter; - // This module is deprecated, we mirror everything from ipcRenderer. - deprecate.warn('ipc module', 'require("electron").ipcRenderer'); - // Routes events of ipcRenderer. - ipc = new EventEmitter; ipcRenderer.emit = function() { @@ -22,9 +18,7 @@ ipcRenderer.emit = function() { return EventEmitter.prototype.emit.apply(ipcRenderer, arguments); }; - // Deprecated. - for (method in ipcRenderer) { if (method.startsWith('send')) { ipc[method] = ipcRenderer[method]; diff --git a/atom/renderer/api/lib/remote.js b/atom/renderer/api/lib/remote.js index 8eb7bc21c24e..f50fca7a2d4a 100644 --- a/atom/renderer/api/lib/remote.js +++ b/atom/renderer/api/lib/remote.js @@ -7,9 +7,7 @@ v8Util = process.atomBinding('v8_util'); callbacksRegistry = new CallbacksRegistry; - // Check for circular reference. - isCircular = function(field, visited) { if (typeof field === 'object') { if (indexOf.call(visited, field) >= 0) { @@ -20,9 +18,7 @@ isCircular = function(field, visited) { return false; }; - // Convert the arguments object into an array of meta data. - wrapArgs = function(args, visited) { var valueToMeta; if (visited == null) { @@ -90,9 +86,7 @@ wrapArgs = function(args, visited) { return Array.prototype.slice.call(args).map(valueToMeta); }; - // Convert meta data from browser into real value. - metaToValue = function(meta) { var RemoteFunction, el, i, j, len, len1, member, ref1, ref2, results, ret; switch (meta.type) { @@ -121,7 +115,6 @@ metaToValue = function(meta) { break; default: if (meta.type === 'function') { - // A shadow class to represent the remote function object. ret = RemoteFunction = (function() { function RemoteFunction() { @@ -163,10 +156,8 @@ metaToValue = function(meta) { } } - /* - Track delegate object's life time, and tell the browser to clean up - when the object is GCed. - */ + // Track delegate object's life time, and tell the browser to clean up + // when the object is GCed. v8Util.setDestructor(ret, function() { return ipcRenderer.send('ATOM_BROWSER_DEREFERENCE', meta.id); }); @@ -177,9 +168,7 @@ metaToValue = function(meta) { } }; - // Construct a plain object from the meta. - metaToPlainObject = function(meta) { var i, len, name, obj, ref1, ref2, value; obj = (function() { @@ -198,13 +187,9 @@ metaToPlainObject = function(meta) { return obj; }; - -/* - Create a RemoteMemberFunction instance. - This function's content should not be inlined into metaToValue, otherwise V8 - may consider it circular reference. - */ - +// Create a RemoteMemberFunction instance. +// This function's content should not be inlined into metaToValue, otherwise V8 +// may consider it circular reference. createRemoteMemberFunction = function(metaId, name) { var RemoteMemberFunction; return RemoteMemberFunction = (function() { @@ -228,13 +213,9 @@ createRemoteMemberFunction = function(metaId, name) { })(); }; - -/* - Create configuration for defineProperty. - This function's content should not be inlined into metaToValue, otherwise V8 - may consider it circular reference. - */ - +// Create configuration for defineProperty. +// This function's content should not be inlined into metaToValue, otherwise V8 +// may consider it circular reference. createRemoteMemberProperty = function(metaId, name) { return { enumerable: true, @@ -253,28 +234,20 @@ createRemoteMemberProperty = function(metaId, name) { }; }; - // Browser calls a callback in renderer. - ipcRenderer.on('ATOM_RENDERER_CALLBACK', function(event, id, args) { return callbacksRegistry.apply(id, metaToValue(args)); }); - // A callback in browser is released. - ipcRenderer.on('ATOM_RENDERER_RELEASE_CALLBACK', function(event, id) { return callbacksRegistry.remove(id); }); - // List all built-in modules in browser process. - browserModules = require('../../../browser/api/lib/exports/electron'); - // And add a helper receiver for each one. - fn = function(name) { return Object.defineProperty(exports, name, { get: function() { @@ -287,12 +260,9 @@ for (name in browserModules) { } -/* - Get remote module. - (Just like node's require, the modules are cached permanently, note that this - is safe leak since the object is not expected to get freed in browser) - */ - +// Get remote module. +// (Just like node's require, the modules are cached permanently, note that this +// is safe leak since the object is not expected to get freed in browser) moduleCache = {}; exports.require = function(module) { @@ -306,12 +276,10 @@ exports.require = function(module) { // Optimize require('electron'). - moduleCache.electron = exports; // Alias to remote.require('electron').xxx. - builtinCache = {}; exports.getBuiltin = function(module) { @@ -323,9 +291,7 @@ exports.getBuiltin = function(module) { return builtinCache[module] = metaToValue(meta); }; - // Get current BrowserWindow object. - windowCache = null; exports.getCurrentWindow = function() { @@ -337,9 +303,7 @@ exports.getCurrentWindow = function() { return windowCache = metaToValue(meta); }; - // Get current WebContents object. - webContentsCache = null; exports.getCurrentWebContents = function() { @@ -351,18 +315,14 @@ exports.getCurrentWebContents = function() { return webContentsCache = metaToValue(meta); }; - // Get a global object in browser. - exports.getGlobal = function(name) { var meta; meta = ipcRenderer.sendSync('ATOM_BROWSER_GLOBAL', name); return metaToValue(meta); }; - // Get the process object in browser. - processCache = null; exports.__defineGetter__('process', function() { @@ -372,9 +332,7 @@ exports.__defineGetter__('process', function() { return processCache; }); - // Create a funtion that will return the specifed value when called in browser. - exports.createFunctionWithReturnValue = function(returnValue) { var func; func = function() { @@ -384,9 +342,7 @@ exports.createFunctionWithReturnValue = function(returnValue) { return func; }; - // Get the guest WebContents from guestInstanceId. - exports.getGuestWebContents = function(guestInstanceId) { var meta; meta = ipcRenderer.sendSync('ATOM_BROWSER_GUEST_WEB_CONTENTS', guestInstanceId); diff --git a/atom/renderer/lib/init.js b/atom/renderer/lib/init.js index 0f651218ecdb..8fd0d2e25e71 100644 --- a/atom/renderer/lib/init.js +++ b/atom/renderer/lib/init.js @@ -11,21 +11,16 @@ url = require('url'); Module = require('module'); -/* - We modified the original process.argv to let node.js load the - atom-renderer.js, we need to restore it here. - */ - +// We modified the original process.argv to let node.js load the +// atom-renderer.js, we need to restore it here. process.argv.splice(1, 1); // Clear search paths. - require(path.resolve(__dirname, '..', '..', 'common', 'lib', 'reset-search-paths')); // Import common settings. - require(path.resolve(__dirname, '..', '..', 'common', 'lib', 'init')); globalPaths = Module.globalPaths; @@ -34,14 +29,10 @@ if (!process.env.ELECTRON_HIDE_INTERNAL_MODULES) { globalPaths.push(path.resolve(__dirname, '..', 'api', 'lib')); } - // Expose public APIs. - globalPaths.push(path.resolve(__dirname, '..', 'api', 'lib', 'exports')); - // The global variable will be used by ipc for event dispatching - v8Util = process.atomBinding('v8_util'); v8Util.setHiddenValue(global, 'ipc', new events.EventEmitter); @@ -55,18 +46,15 @@ electron.ipcRenderer.on('ELECTRON_INTERNAL_RENDERER_WEB_FRAME_METHOD', (event, m }); // Process command line arguments. - nodeIntegration = 'false'; ref = process.argv; for (i = 0, len = ref.length; i < len; i++) { arg = ref[i]; if (arg.indexOf('--guest-instance-id=') === 0) { - // This is a guest web view. process.guestInstanceId = parseInt(arg.substr(arg.indexOf('=') + 1)); } else if (arg.indexOf('--opener-id=') === 0) { - // This is a guest BrowserWindow. process.openerId = parseInt(arg.substr(arg.indexOf('=') + 1)); } else if (arg.indexOf('--node-integration=') === 0) { @@ -77,17 +65,14 @@ for (i = 0, len = ref.length; i < len; i++) { } if (location.protocol === 'chrome-devtools:') { - // Override some inspector APIs. require('./inspector'); nodeIntegration = 'true'; } else if (location.protocol === 'chrome-extension:') { - // Add implementations of chrome API. require('./chrome-api'); nodeIntegration = 'true'; } else { - // Override default web functions. require('./override'); @@ -99,7 +84,6 @@ if (location.protocol === 'chrome-devtools:') { } if (nodeIntegration === 'true' || nodeIntegration === 'all' || nodeIntegration === 'except-iframe' || nodeIntegration === 'manual-enable-iframe') { - // Export node bindings to global. global.require = require; global.module = module; @@ -135,7 +119,6 @@ if (nodeIntegration === 'true' || nodeIntegration === 'all' || nodeIntegration = return process.emit('exit'); }); } else { - // Delete Node's symbols after the Environment has been loaded. process.once('loaded', function() { delete global.process; @@ -145,9 +128,7 @@ if (nodeIntegration === 'true' || nodeIntegration === 'all' || nodeIntegration = }); } - // Load the script specfied by the "preload" attribute. - if (preloadScript) { try { require(preloadScript); diff --git a/atom/renderer/lib/inspector.js b/atom/renderer/lib/inspector.js index 54c02f011dc7..b37e1d3de905 100644 --- a/atom/renderer/lib/inspector.js +++ b/atom/renderer/lib/inspector.js @@ -1,7 +1,6 @@ var convertToMenuTemplate, createFileSelectorElement, createMenu, pathToHtml5FileObject, showFileChooserDialog; window.onload = function() { - // Use menu API to show context menu. InspectorFrontendHost.showContextMenuAtPoint = createMenu; diff --git a/atom/renderer/lib/override.js b/atom/renderer/lib/override.js index 27d8fdc3f210..c240281363b9 100644 --- a/atom/renderer/lib/override.js +++ b/atom/renderer/lib/override.js @@ -3,9 +3,7 @@ var BrowserWindowProxy, a, getHistoryOperation, ipcRenderer, ref, remote, resolv ref = require('electron'), ipcRenderer = ref.ipcRenderer, remote = ref.remote; - // Helper function to resolve relative url. - a = window.top.document.createElement('a'); resolveURL = function(url) { @@ -13,9 +11,7 @@ resolveURL = function(url) { return a.href; }; - // Window object returned by "window.open". - BrowserWindowProxy = (function() { BrowserWindowProxy.proxies = {}; @@ -69,16 +65,13 @@ BrowserWindowProxy = (function() { })(); if (process.guestInstanceId == null) { - // Override default window.close. window.close = function() { return remote.getCurrentWindow().close(); }; } - // Make the browser window or guest view emit "new-window" event. - window.open = function(url, frameName, features) { var feature, guestId, i, ints, j, len, len1, name, options, ref1, ref2, value; if (frameName == null) { @@ -133,9 +126,7 @@ window.open = function(url, frameName, features) { } }; - // Use the dialog API to implement alert(). - window.alert = function(message, title) { var buttons; if (title == null) { @@ -152,9 +143,7 @@ window.alert = function(message, title) { // Alert should always return undefined. }; - // And the confirm(). - window.confirm = function(message, title) { var buttons, cancelId; if (title == null) { @@ -170,9 +159,7 @@ window.confirm = function(message, title) { }); }; - // But we do not support prompt(). - window.prompt = function() { throw new Error('prompt() is and will not be supported.'); }; @@ -182,9 +169,7 @@ if (process.openerId != null) { } ipcRenderer.on('ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', function(event, sourceId, message, sourceOrigin) { - // Manually dispatch event instead of using postMessage because we also need to - // set event.source. event = document.createEvent('Event'); event.initEvent('message', false, false); @@ -194,9 +179,7 @@ ipcRenderer.on('ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', function(event, sourceId, return window.dispatchEvent(event); }); - // Forward history operations to browser. - sendHistoryOperation = function() { var args; args = 1 <= arguments.length ? slice.call(arguments, 0) : []; @@ -227,9 +210,7 @@ Object.defineProperty(window.history, 'length', { } }); - // Make document.hidden and document.visibilityState return the correct value. - Object.defineProperty(document, 'hidden', { get: function() { var currentWindow; diff --git a/atom/renderer/lib/web-view/web-view-attributes.js b/atom/renderer/lib/web-view/web-view-attributes.js index ddf17b9f9ed7..0352dc5e821d 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.js +++ b/atom/renderer/lib/web-view/web-view-attributes.js @@ -10,9 +10,7 @@ webViewConstants = require('./web-view-constants'); remote = require('electron').remote; - // Helper function to resolve url set in attribute. - a = document.createElement('a'); resolveURL = function(url) { @@ -20,12 +18,8 @@ resolveURL = function(url) { return a.href; }; - -/* - Attribute objects. - Default implementation of a WebView attribute. - */ - +// Attribute objects. +// Default implementation of a WebView attribute. WebViewAttribute = (function() { function WebViewAttribute(name, webViewImpl) { this.name = name; @@ -35,32 +29,24 @@ WebViewAttribute = (function() { this.defineProperty(); } - // Retrieves and returns the attribute's value. - WebViewAttribute.prototype.getValue = function() { return this.webViewImpl.webviewNode.getAttribute(this.name) || this.value; }; - // Sets the attribute's value. - WebViewAttribute.prototype.setValue = function(value) { return this.webViewImpl.webviewNode.setAttribute(this.name, value || ''); }; - // Changes the attribute's value without triggering its mutation handler. - WebViewAttribute.prototype.setValueIgnoreMutation = function(value) { this.ignoreMutation = true; this.setValue(value); return this.ignoreMutation = false; }; - // Defines this attribute as a property on the webview node. - WebViewAttribute.prototype.defineProperty = function() { return Object.defineProperty(this.webViewImpl.webviewNode, this.name, { get: (function(_this) { @@ -77,18 +63,14 @@ WebViewAttribute = (function() { }); }; - // Called when the attribute's value changes. - WebViewAttribute.prototype.handleMutation = function() {}; return WebViewAttribute; })(); - // An attribute that is treated as a Boolean. - BooleanAttribute = (function(superClass) { extend(BooleanAttribute, superClass); @@ -112,9 +94,7 @@ BooleanAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute that specifies whether transparency is allowed in the webview. - AllowTransparencyAttribute = (function(superClass) { extend(AllowTransparencyAttribute, superClass); @@ -133,9 +113,7 @@ AllowTransparencyAttribute = (function(superClass) { })(BooleanAttribute); - // Attribute used to define the demension limits of autosizing. - AutosizeDimensionAttribute = (function(superClass) { extend(AutosizeDimensionAttribute, superClass); @@ -168,9 +146,7 @@ AutosizeDimensionAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute that specifies whether the webview should be autosized. - AutosizeAttribute = (function(superClass) { extend(AutosizeAttribute, superClass); @@ -184,9 +160,7 @@ AutosizeAttribute = (function(superClass) { })(BooleanAttribute); - // Attribute representing the state of the storage partition. - PartitionAttribute = (function(superClass) { extend(PartitionAttribute, superClass); @@ -214,9 +188,7 @@ PartitionAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute that handles the location and navigation of the webview. - SrcAttribute = (function(superClass) { extend(SrcAttribute, superClass); @@ -236,29 +208,23 @@ SrcAttribute = (function(superClass) { SrcAttribute.prototype.setValueIgnoreMutation = function(value) { WebViewAttribute.prototype.setValueIgnoreMutation.call(this, value); - /* - takeRecords() is needed to clear queued up src mutations. Without it, it - is possible for this change to get picked up asyncronously by src's - mutation observer |observer|, and then get handled even though we do not - want to handle this mutation. - */ + // takeRecords() is needed to clear queued up src mutations. Without it, it + // is possible for this change to get picked up asyncronously by src's + // mutation observer |observer|, and then get handled even though we do not + // want to handle this mutation. return this.observer.takeRecords(); }; SrcAttribute.prototype.handleMutation = function(oldValue, newValue) { - /* - Once we have navigated, we don't allow clearing the src attribute. - Once enters a navigated state, it cannot return to a - placeholder state. - */ + // Once we have navigated, we don't allow clearing the src attribute. + // Once enters a navigated state, it cannot return to a + // placeholder state. if (!newValue && oldValue) { - /* - src attribute changes normally initiate a navigation. We suppress - the next src attribute handler call to avoid reloading the page - on every guest-initiated navigation. - */ + // src attribute changes normally initiate a navigation. We suppress + // the next src attribute handler call to avoid reloading the page + // on every guest-initiated navigation. this.setValueIgnoreMutation(oldValue); return; } @@ -266,13 +232,10 @@ SrcAttribute = (function(superClass) { }; - /* - The purpose of this mutation observer is to catch assignment to the src - attribute without any changes to its value. This is useful in the case - where the webview guest has crashed and navigating to the same address - spawns off a new process. - */ - + // The purpose of this mutation observer is to catch assignment to the src + // attribute without any changes to its value. This is useful in the case + // where the webview guest has crashed and navigating to the same address + // spawns off a new process. SrcAttribute.prototype.setupMutationObserver = function() { var params; this.observer = new MutationObserver((function(_this) { @@ -328,9 +291,7 @@ SrcAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute specifies HTTP referrer. - HttpReferrerAttribute = (function(superClass) { extend(HttpReferrerAttribute, superClass); @@ -342,9 +303,7 @@ HttpReferrerAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute specifies user agent - UserAgentAttribute = (function(superClass) { extend(UserAgentAttribute, superClass); @@ -356,9 +315,7 @@ UserAgentAttribute = (function(superClass) { })(WebViewAttribute); - // Attribute that set preload script. - PreloadAttribute = (function(superClass) { extend(PreloadAttribute, superClass); @@ -384,9 +341,7 @@ PreloadAttribute = (function(superClass) { })(WebViewAttribute); - // Sets up all of the webview attributes. - WebViewImpl.prototype.setupWebViewAttributes = function() { var attribute, autosizeAttributes, i, len, results; this.attributes = {}; diff --git a/atom/renderer/lib/web-view/web-view-constants.js b/atom/renderer/lib/web-view/web-view-constants.js index 9ca98340ced5..418083061a26 100644 --- a/atom/renderer/lib/web-view/web-view-constants.js +++ b/atom/renderer/lib/web-view/web-view-constants.js @@ -1,5 +1,4 @@ module.exports = { - // Attributes. ATTRIBUTE_ALLOWTRANSPARENCY: 'allowtransparency', ATTRIBUTE_AUTOSIZE: 'autosize', diff --git a/atom/renderer/lib/web-view/web-view.js b/atom/renderer/lib/web-view/web-view.js index 549c3d4d4795..07624b79b67a 100644 --- a/atom/renderer/lib/web-view/web-view.js +++ b/atom/renderer/lib/web-view/web-view.js @@ -12,18 +12,14 @@ guestViewInternal = require('./guest-view-internal'); webViewConstants = require('./web-view-constants'); - // ID generator. - nextId = 0; getNextId = function() { return ++nextId; }; - // Represents the internal state of the WebView node. - WebViewImpl = (function() { function WebViewImpl(webviewNode) { var shadowRoot; @@ -50,32 +46,25 @@ WebViewImpl = (function() { } WebViewImpl.prototype.createBrowserPluginNode = function() { - - /* - We create BrowserPlugin as a custom element in order to observe changes - to attributes synchronously. - */ + // We create BrowserPlugin as a custom element in order to observe changes + // to attributes synchronously. var browserPluginNode; browserPluginNode = new WebViewImpl.BrowserPlugin(); v8Util.setHiddenValue(browserPluginNode, 'internal', this); return browserPluginNode; }; - // Resets some state upon reattaching element to the DOM. - WebViewImpl.prototype.reset = function() { // Unlisten the zoom-level-changed event. webFrame.removeListener('zoom-level-changed', this.onZoomLevelChanged); - /* - If guestInstanceId is defined then the has navigated and has - already picked up a partition ID. Thus, we need to reset the initialization - state. However, it may be the case that beforeFirstNavigation is false BUT - guestInstanceId has yet to be initialized. This means that we have not - heard back from createGuest yet. We will not reset the flag in this case so - that we don't end up allocating a second guest. - */ + // If guestInstanceId is defined then the has navigated and has + // already picked up a partition ID. Thus, we need to reset the initialization + // state. However, it may be the case that beforeFirstNavigation is false BUT + // guestInstanceId has yet to be initialized. This means that we have not + // heard back from createGuest yet. We will not reset the flag in this case so + // that we don't end up allocating a second guest. if (this.guestInstanceId) { guestViewInternal.destroyGuest(this.guestInstanceId); this.webContents = null; @@ -86,9 +75,7 @@ WebViewImpl = (function() { return this.internalInstanceId = 0; }; - // Sets the .request property. - WebViewImpl.prototype.setRequestPropertyOnWebViewNode = function(request) { return Object.defineProperty(this.webviewNode, 'request', { value: request, @@ -99,12 +86,10 @@ WebViewImpl = (function() { WebViewImpl.prototype.setupFocusPropagation = function() { if (!this.webviewNode.hasAttribute('tabIndex')) { - /* - needs a tabIndex in order to be focusable. - TODO(fsamuel): It would be nice to avoid exposing a tabIndex attribute - to allow to be focusable. - See http://crbug.com/231664. - */ + // needs a tabIndex in order to be focusable. + // TODO(fsamuel): It would be nice to avoid exposing a tabIndex attribute + // to allow to be focusable. + // See http://crbug.com/231664. this.webviewNode.setAttribute('tabIndex', -1); } this.webviewNode.addEventListener('focus', (function(_this) { @@ -124,14 +109,11 @@ WebViewImpl = (function() { }; - /* - This observer monitors mutations to attributes of the and - updates the BrowserPlugin properties accordingly. In turn, updating - a BrowserPlugin property will update the corresponding BrowserPlugin - attribute, if necessary. See BrowserPlugin::UpdateDOMAttribute for more - details. - */ - + // This observer monitors mutations to attributes of the and + // updates the BrowserPlugin properties accordingly. In turn, updating + // a BrowserPlugin property will update the corresponding BrowserPlugin + // attribute, if necessary. See BrowserPlugin::UpdateDOMAttribute for more + // details. WebViewImpl.prototype.handleWebviewAttributeMutation = function(attributeName, oldValue, newValue) { if (!this.attributes[attributeName] || this.attributes[attributeName].ignoreMutation) { return; @@ -164,7 +146,6 @@ WebViewImpl = (function() { height = node.offsetHeight; // Check the current bounds to make sure we do not resize - // outside of current constraints. maxWidth = this.attributes[webViewConstants.ATTRIBUTE_MAXWIDTH].getValue() | width; maxHeight = this.attributes[webViewConstants.ATTRIBUTE_MAXHEIGHT].getValue() | width; @@ -176,16 +157,13 @@ WebViewImpl = (function() { node.style.width = newWidth + 'px'; node.style.height = newHeight + 'px'; - /* - Only fire the DOM event if the size of the has actually - changed. - */ + // Only fire the DOM event if the size of the has actually + // changed. return this.dispatchEvent(webViewEvent); } }; WebViewImpl.prototype.onElementResize = function(newSize) { - // Dispatch the 'resize' event. var resizeEvent; resizeEvent = new Event('resize', { @@ -213,12 +191,8 @@ WebViewImpl = (function() { return this.webviewNode.dispatchEvent(webViewEvent); }; - // Adds an 'on' property on the webview, which can be used to set/unset - - // an event handler. - WebViewImpl.prototype.setupEventProperty = function(eventName) { var propertyName; propertyName = 'on' + eventName.toLowerCase(); @@ -243,20 +217,16 @@ WebViewImpl = (function() { }); }; - // Updates state upon loadcommit. - WebViewImpl.prototype.onLoadCommit = function(webViewEvent) { var newValue, oldValue; oldValue = this.webviewNode.getAttribute(webViewConstants.ATTRIBUTE_SRC); newValue = webViewEvent.url; if (webViewEvent.isMainFrame && (oldValue !== newValue)) { - /* - Touching the src attribute triggers a navigation. To avoid - triggering a page reload on every guest-initiated navigation, - we do not handle this mutation. - */ + // Touching the src attribute triggers a navigation. To avoid + // triggering a page reload on every guest-initiated navigation, + // we do not handle this mutation. return this.attributes[webViewConstants.ATTRIBUTE_SRC].setValueIgnoreMutation(newValue); } }; @@ -278,13 +248,11 @@ WebViewImpl = (function() { params[attributeName] = attribute.getValue(); } - /* - When the WebView is not participating in layout (display:none) - then getBoundingClientRect() would report a width and height of 0. - However, in the case where the WebView has a fixed size we can - use that value to initially size the guest so as to avoid a relayout of - the on display:block. - */ + // When the WebView is not participating in layout (display:none) + // then getBoundingClientRect() would report a width and height of 0. + // However, in the case where the WebView has a fixed size we can + // use that value to initially size the guest so as to avoid a relayout of + // the on display:block. css = window.getComputedStyle(this.webviewNode, null); elementRect = this.webviewNode.getBoundingClientRect(); params.elementWidth = parseInt(elementRect.width) || parseInt(css.getPropertyValue('width')); @@ -305,9 +273,7 @@ WebViewImpl = (function() { })(); - // Registers browser plugin custom element. - registerBrowserPluginElement = function() { var proto; proto = Object.create(HTMLObjectElement.prototype); @@ -329,7 +295,6 @@ registerBrowserPluginElement = function() { return internal.handleBrowserPluginAttributeMutation(name, oldValue, newValue); }; proto.attachedCallback = function() { - // Load the plugin immediately. var unused; return unused = this.nonExistentAttribute; @@ -344,9 +309,7 @@ registerBrowserPluginElement = function() { return delete proto.attributeChangedCallback; }; - // Registers custom element. - registerWebViewElement = function() { var createBlockHandler, createNonBlockHandler, i, j, len, len1, m, methods, nonblockMethods, proto; proto = Object.create(HTMLObjectElement.prototype); @@ -385,7 +348,51 @@ registerWebViewElement = function() { }; // Public-facing API methods. - methods = ['getURL', 'getTitle', 'isLoading', 'isWaitingForResponse', 'stop', 'reload', 'reloadIgnoringCache', 'canGoBack', 'canGoForward', 'canGoToOffset', 'clearHistory', 'goBack', 'goForward', 'goToIndex', 'goToOffset', 'isCrashed', 'setUserAgent', 'getUserAgent', 'openDevTools', 'closeDevTools', 'isDevToolsOpened', 'isDevToolsFocused', 'inspectElement', 'setAudioMuted', 'isAudioMuted', 'undo', 'redo', 'cut', 'copy', 'paste', 'pasteAndMatchStyle', 'delete', 'selectAll', 'unselect', 'replace', 'replaceMisspelling', 'findInPage', 'stopFindInPage', 'getId', 'downloadURL', 'inspectServiceWorker', 'print', 'printToPDF']; + methods = [ + 'getURL', + 'getTitle', + 'isLoading', + 'isWaitingForResponse', + 'stop', + 'reload', + 'reloadIgnoringCache', + 'canGoBack', + 'canGoForward', + 'canGoToOffset', + 'clearHistory', + 'goBack', + 'goForward', + 'goToIndex', + 'goToOffset', + 'isCrashed', + 'setUserAgent', + 'getUserAgent', + 'openDevTools', + 'closeDevTools', + 'isDevToolsOpened', + 'isDevToolsFocused', + 'inspectElement', + 'setAudioMuted', + 'isAudioMuted', + 'undo', + 'redo', + 'cut', + 'copy', + 'paste', + 'pasteAndMatchStyle', + 'delete', + 'selectAll', + 'unselect', + 'replace', + 'replaceMisspelling', + 'findInPage', + 'stopFindInPage', + 'getId', + 'downloadURL', + 'inspectServiceWorker', + 'print', + 'printToPDF' + ]; nonblockMethods = [ 'executeJavaScript', 'insertCSS', @@ -429,10 +436,8 @@ registerWebViewElement = function() { prototype: proto }); - /* - Delete the callbacks so developers cannot call them and produce unexpected - behavior. - */ + // Delete the callbacks so developers cannot call them and produce unexpected + // behavior. delete proto.createdCallback; delete proto.attachedCallback; delete proto.detachedCallback;