significant cleanup; all tests still passing

This commit is contained in:
Shelley Vohr 2017-10-23 20:04:22 -04:00
parent 3fc5d51a96
commit 9038987e1d
No known key found for this signature in database
GPG key ID: F13993A75599653C

View file

@ -1,39 +1,66 @@
const {BrowserWindow, MenuItem} = require('electron')
const {EventEmitter} = require('events')
//const _ = require('lodash')
'use strict'
const {BrowserWindow, MenuItem, webContents} = require('electron')
const EventEmitter = require('events').EventEmitter
const v8Util = process.atomBinding('v8_util')
const bindings = process.atomBinding('menu')
const { Menu } = bindings
const {Menu} = bindings
let applicationMenu = null
let nextGroupId = 0
Menu.prototype.__proto__ = EventEmitter.prototype
Object.setPrototypeOf(Menu.prototype, EventEmitter.prototype)
Menu.prototype._init = function () {
this.commandsMap = {}
this.groupsMap = {}
this.items = []
return this.delegate = {
isCommandIdChecked: id => (this.commandsMap[id] ? this.commandsMap[id].checked : undefined),
isCommandIdEnabled: id => (this.commandsMap[id] ? this.commandsMap[id].enabled : undefined),
isCommandIdVisible: id => (this.commandsMap[id] ? this.commandsMap[id].visible : undefined),
getAcceleratorForCommandId: id => (this.commandsMap[id] ? this.commandsMap[id].accelerator : undefined),
getIconForCommandId: id => (this.commandsMap[id] ? this.commandsMap[id].icon : undefined),
executeCommand: (id) => {
const command = this.commandsMap[id]
return command ? this.commandsMap[id].click(BrowserWindow.getFocusedWindow()) : undefined
this.delegate = {
isCommandIdChecked: (commandId) => {
var command = this.commandsMap[commandId]
return command != null ? command.checked : undefined
},
isCommandIdEnabled: (commandId) => {
var command = this.commandsMap[commandId]
return command != null ? command.enabled : undefined
},
isCommandIdVisible: (commandId) => {
var command = this.commandsMap[commandId]
return command != null ? command.visible : undefined
},
getAcceleratorForCommandId: (commandId, useDefaultAccelerator) => {
const command = this.commandsMap[commandId]
if (command == null) return
if (command.accelerator != null) return command.accelerator
if (useDefaultAccelerator) return command.getDefaultRoleAccelerator()
},
getIconForCommandId: (commandId) => {
var command = this.commandsMap[commandId]
return command != null ? command.icon : undefined
},
executeCommand: (event, commandId) => {
const command = this.commandsMap[commandId]
if (command == null) return
command.click(event, BrowserWindow.getFocusedWindow(), webContents.getFocusedWebContents())
},
menuWillShow: () => {
for (let id in this.groupsMap) {
const group = this.groupsMap[id]
let checked = false
for (let radioItem in group) {
if (radioItem.checked) {
checked = true
break
// Make sure radio groups have at least one menu item seleted.
var checked, group, id, j, len, radioItem, ref1
ref1 = this.groupsMap
for (id in ref1) {
group = ref1[id]
checked = false
for (j = 0, len = group.length; j < len; j++) {
radioItem = group[j]
if (!radioItem.checked) {
continue
}
checked = true
break
}
if (!checked) {
v8Util.setHiddenValue(group[0], 'checked', true)
}
if (!checked) v8Util.setHiddenValue(group[0], 'checked', true)
}
}
}
@ -60,79 +87,29 @@ Menu.prototype.popup = function (window, x, y, positioningItem) {
asyncPopup = options.async
}
// Default to showing in focused window.
if (window == null) window = BrowserWindow.getFocusedWindow()
// Default to showing under mouse location.
if (typeof x !== 'number') x = -1
if (typeof y !== 'number') y = -1
// Default to not highlighting any item.
if (typeof positioningItem !== 'number') positioningItem = -1
// Default to synchronous for backwards compatibility.
if (typeof asyncPopup !== 'boolean') asyncPopup = false
this.popupAt(window, x, y, positioningItem, asyncPopup)
}
Menu.prototype.append = function (item) {
return this.insert(this.getItemCount(), item)
}
Menu.prototype.insert = function (pos, item) {
if ((item != null ? item.constructor : undefined) !== MenuItem) {
throw new TypeError('Invalid item')
Menu.prototype.closePopup = function (window) {
if (window == null || window.constructor !== BrowserWindow) {
window = BrowserWindow.getFocusedWindow()
}
switch (item.type) {
case 'normal':
this.insertItem(pos, item.commandId, item.label)
break
case 'checkbox':
this.insertCheckItem(pos, item.commandId, item.label)
break
case 'separator':
this.insertSeparator(pos)
break
case 'submenu':
this.insertSubMenu(pos, item.commandId, item.label, item.submenu)
break
case 'radio':
/* Grouping radio menu items. */
item.overrideReadOnlyProperty('groupId', generateGroupId(this.items, pos))
if (this.groupsMap[item.groupId] == null) this.groupsMap[item.groupId] = []
this.groupsMap[item.groupId].push(item)
/* Setting a radio menu item should flip other items in the group. */
v8Util.setHiddenValue(item, 'checked', item.checked)
Object.defineProperty(item, 'checked', {
enumerable: true,
get() { return v8Util.getHiddenValue(item, 'checked') },
set: val => {
for (let otherItem in this.groupsMap[item.groupId]) {
if (otherItem !== item) v8Util.setHiddenValue(otherItem, 'checked', false)
}
return v8Util.setHiddenValue(item, 'checked', true)
}
})
this.insertRadioItem(pos, item.commandId, item.label, item.groupId)
break
if (window != null) {
this.closePopupAt(window.id)
}
if (item.sublabel != null) this.setSublabel(pos, item.sublabel)
if (item.icon != null) this.setIcon(pos, item.icon)
if (item.role != null) this.setRole(pos, item.role)
/* Make menu accessable to items. */
item.overrideReadOnlyProperty('menu', this)
/* Remember the items. */
this.items.splice(pos, 0, item)
return this.commandsMap[item.commandId] = item
}
/* Force menuWillShow to be called */
Menu.prototype._callMenuWillShow = function () {
if (this.delegate != null) this.delegate.menuWillShow()
this.items.forEach(item => {
if (item.submenu != null) item.submenu._callMenuWillShow()
})
}
Menu.prototype.getMenuItemById = function (id) {
@ -147,8 +124,83 @@ Menu.prototype.getMenuItemById = function (id) {
return found
}
//cleaned up
Menu.prototype.append = function (item) {
return this.insert(this.getItemCount(), item)
}
Menu.prototype.insert = function (pos, item) {
var base, name
if ((item != null ? item.constructor : void 0) !== MenuItem) {
throw new TypeError('Invalid item')
}
switch (item.type) {
case 'normal':
this.insertItem(pos, item.commandId, item.label)
break
case 'checkbox':
this.insertCheckItem(pos, item.commandId, item.label)
break
case 'separator':
this.insertSeparator(pos)
break
case 'submenu':
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) {
base[name] = []
}
this.groupsMap[item.groupId].push(item)
// Setting a radio menu item should flip other items in the group.
v8Util.setHiddenValue(item, 'checked', item.checked)
Object.defineProperty(item, 'checked', {
enumerable: true,
get: function () {
return v8Util.getHiddenValue(item, 'checked')
},
set: () => {
var j, len, otherItem, ref1
ref1 = this.groupsMap[item.groupId]
for (j = 0, len = ref1.length; j < len; j++) {
otherItem = ref1[j]
if (otherItem !== item) {
v8Util.setHiddenValue(otherItem, 'checked', false)
}
}
return v8Util.setHiddenValue(item, 'checked', true)
}
})
this.insertRadioItem(pos, item.commandId, item.label, item.groupId)
}
if (item.sublabel != null) this.setSublabel(pos, item.sublabel)
if (item.icon != null) this.setIcon(pos, item.icon)
if (item.role != null) this.setRole(pos, item.role)
// Make menu accessable to items.
item.overrideReadOnlyProperty('menu', this)
// Remember the items.
this.items.splice(pos, 0, item)
this.commandsMap[item.commandId] = item
}
// Force menuWillShow to be called
// cleaned up
Menu.prototype._callMenuWillShow = function () {
if (this.delegate != null) this.delegate.menuWillShow()
this.items.forEach(item => {
if (item.submenu != null) item.submenu._callMenuWillShow()
})
}
// cleaned up
Menu.setApplicationMenu = function (menu) {
if (menu !== null && menu.constructor !== Menu) {
if (!(menu === null || menu.constructor === Menu)) {
throw new TypeError('Invalid menu')
}
@ -156,32 +208,35 @@ Menu.setApplicationMenu = function (menu) {
if (process.platform === 'darwin') {
if (menu === null) return
menu._callMenuWillShow()
return bindings.setApplicationMenu(menu)
bindings.setApplicationMenu(menu)
} else {
const windows = BrowserWindow.getAllWindows()
return windows.map((w) => w.setMenu(menu))
return windows.map(w => w.setMenu(menu))
}
}
// cleaned up
Menu.getApplicationMenu = () => applicationMenu
Menu.sendActionToFirstResponder = bindings.sendActionToFirstResponder
// build menu from a template
// cleaned up
Menu.buildFromTemplate = function (template) {
if (!(template instanceof Array)) {
throw new TypeError('Invalid template for Menu')
}
const menu = new Menu
const menu = new Menu()
const positioned = []
let idx = 0
// sort template by position
template.forEach(item => {
idx = (item.position) ? indexToInsertByPosition(positioned, item.position) : idx++
idx = (item.position) ? indexToInsertByPosition(positioned, item.position) : idx += 1
positioned.splice(idx, 0, item)
})
// add each item from positioned menu to application menu
positioned.forEach((item) => {
if (typeof item !== 'object') {
throw new TypeError('Invalid template for MenuItem')
@ -192,78 +247,76 @@ Menu.buildFromTemplate = function (template) {
return menu
}
// Automatically generated radio menu item's group id.
let nextGroupId = 0
let applicationMenu = null
/* Helper Methods */
/* Search between seperators to find a radio menu item and return its group id */
const generateGroupId = function(items, pos) {
let i, item
// Search between separators to find a radio menu item and return its group id,
function generateGroupId (items, pos) {
var i, item, j, k, ref1, ref2, ref3
if (pos > 0) {
let asc, start
for (start = pos - 1, i = start, asc = start <= 0; asc ? i <= 0 : i >= 0; asc ? i++ : i--) {
for (i = j = ref1 = pos - 1; ref1 <= 0 ? j <= 0 : j >= 0; i = ref1 <= 0 ? ++j : --j) {
item = items[i]
if (item.type === 'radio') { return item.groupId }
if (item.type === 'separator') { break }
if (item.type === 'radio') {
return item.groupId
}
if (item.type === 'separator') {
break
}
}
} else if (pos < items.length) {
let asc1, end
for (i = pos, end = items.length - 1, asc1 = pos <= end; asc1 ? i <= end : i >= end; asc1 ? i++ : i--) {
for (i = k = ref2 = pos, ref3 = items.length - 1; ref2 <= ref3 ? k <= ref3 : k >= ref3; i = ref2 <= ref3 ? ++k : --k) {
item = items[i]
if (item.type === 'radio') { return item.groupId }
if (item.type === 'separator') { break }
if (item.type === 'radio') {
return item.groupId
}
if (item.type === 'separator') {
break
}
}
}
return ++nextGroupId
}
/* Returns the index of item according to |id|. */
const indexOfItemById = function (items, id) {
for (let i = 0; i < items.length; i++) {
const item = items[i]
if (item.id === id) return i
}
return -1
// Returns the index of item according to |id|.
// cleaned up
function indexOfItemById (items, id) {
const foundItem = items.find(item => item.id === id) || null
return items.indexOf(foundItem)
}
/* Returns the index of where to insert the item according to |position|. */
// Returns the index of where to insert the item according to |position|
function indexToInsertByPosition (items, position) {
if (!position) return items.length
const [query, id] = position.split('=')
let idx = indexOfItemById(items, id)
const [query, id] = position.split('=') // parse query and id from position
const idx = indexOfItemById(items, id) // calculate initial index of item
// warn if query doesn't exist
if (idx === -1 && query !== 'endof') {
console.warn(`Item with id '${id}' is not found`)
console.warn("Item with id '" + id + "' is not found")
return items.length
}
// compute new index based on query
const queries = {
'after': () => idx++,
'endof': () => {
if (idx === -1) {
'after': (index) => index += 1,
'endof': (index) => {
if (index === -1) {
items.push({id, type: 'separator'})
idx = items.length - 1
index = items.length - 1
}
idx++
while (idx < items.length && items[idx].type !== 'separator') {
idx++
}
index += 1
while (index < items.length && items[index].type !== 'separator') index += 1
return index
}
}
queries[query]()
return idx
// return new index if needed, or original indexOfItemById
return (query in queries) ? queries[query](idx) : idx
}
// WIP, need to figure out how to pass current menu group to this method
function isOuterSeparator (current, item) {
current.filter(item => { !item.visible })
const idx = current.indexof(item)
if (idx === 0 || idx === current.length) {
return true
}
return false
function computeNewIndexOnQuery(idx, query) {
}
module.exports = Menu