From b053d4bd267e4ddf4ad6cc3693e02f9ac90d5b31 Mon Sep 17 00:00:00 2001 From: Jaidyn Ann <10477760+JadedCtrl@users.noreply.github.com> Date: Wed, 5 Apr 2023 16:49:13 -0500 Subject: [PATCH] Stylistic changes, commenting; no functional changes --- common.js | 6 +- pages/popup.src.js | 294 +++++++++++++++++++++++++-------------------- 2 files changed, 168 insertions(+), 132 deletions(-) diff --git a/common.js b/common.js index 4e16e34..e52c166 100644 --- a/common.js +++ b/common.js @@ -1,13 +1,13 @@ // Saves a search-group of the given `name`, containing all search-engines of // `preset` (which is an array of search-engine display-names truncated to 7 chars). -function savepreset(preset, name) { +function savePreset(preset, name) { let presets = Array(); let presetName = name.replace(',', ' '); try { presets = localStorage.getItem('presets').split(','); } catch {} try { localStorage.removeItem('preset_' + presetName); } catch {} - presets = removefromarray(removeredundantitems(presets), presetName); + presets = removeFromArray(removeRedundantItems(presets), presetName); presets.push(presetName); localStorage.setItem('preset_' + presetName, preset); @@ -16,6 +16,6 @@ function savepreset(preset, name) { // Load an array of all saved preset's names. -function loadpresets() { +function loadPresets() { try { return localStorage.getItem('presets').split(','); } catch { return []; } } diff --git a/pages/popup.src.js b/pages/popup.src.js index b36989a..166d47d 100644 --- a/pages/popup.src.js +++ b/pages/popup.src.js @@ -1,180 +1,216 @@ document.getElementById("searchbox").focus(); -const populateengines = (engines) => { - for (engine of engines) { - let checkbox = document.createElement("INPUT"); - checkbox.type = "checkbox"; - checkbox.setAttribute('value', 'engine ' + engine.name); - checkbox.id = engine.name.replace(' ', '-'); - let label = document.createElement('label'); - label.appendChild(document.createTextNode(engine.name)); - document.getElementById("boxes").appendChild(checkbox); - document.getElementById("boxes").appendChild(label); - document.getElementById("boxes").appendChild(document.createElement("BR")) - } +// Populates the .boxes div in popup.html with a list of available search-engines, +// adding a corresponding checkbox and label for each. +function populateEngines(engines) { + for (engine of engines) { + let checkbox = document.createElement("INPUT"); + checkbox.type = "checkbox"; + checkbox.setAttribute('value', 'engine ' + engine.name); + checkbox.id = engine.name.replace(' ', '-'); + let label = document.createElement('label'); + label.appendChild(document.createTextNode(engine.name)); + document.getElementById("boxes").appendChild(checkbox); + document.getElementById("boxes").appendChild(label); + document.getElementById("boxes").appendChild(document.createElement("BR")); + } - populatepresets(); - try { enablepresetbyname(localStorage.getItem('defaultPreset')); } catch {} + populatePresets(); + try { enablePresetByName(localStorage.getItem('defaultPreset')); } catch {} } -const populatepresets = () => { - let presetDropdown = document.getElementById("presets"); - let presets = loadpresets() - while (presetDropdown.firstChild) { - presetDropdown.removeChild(presetDropdown.lastChild); - } +// Populate the .presets selection input (drop-down menu) with all currently-saved +// search-groups (presets). +function populatePresets() { + let presetDropdown = document.getElementById("presets"); + let presets = loadPresets(); - let noPreset = document.createElement("OPTION"); - noPreset.setAttribute('value', 'noPreset'); - noPreset.innerText = '—'; - presetDropdown.appendChild(noPreset); + while (presetDropdown.firstChild) { + presetDropdown.removeChild(presetDropdown.lastChild); + } - for (presetName of presets) { - let option = document.createElement("OPTION"); - option.setAttribute('value', presetName); - option.innerText = presetName; - presetDropdown.appendChild(option); - } + let noPreset = document.createElement("OPTION"); + noPreset.setAttribute('value', 'noPreset'); + noPreset.innerText = '—'; + presetDropdown.appendChild(noPreset); - let newPreset = document.createElement("OPTION"); - newPreset.setAttribute('value', 'newPreset'); - newPreset.innerText = 'Create new preset…'; - presetDropdown.appendChild(newPreset); + for (presetName of presets) { + let option = document.createElement("OPTION"); + option.setAttribute('value', presetName); + option.innerText = presetName; + presetDropdown.appendChild(option); + } + + let newPreset = document.createElement("OPTION"); + newPreset.setAttribute('value', 'newPreset'); + newPreset.innerText = 'Create new preset…'; + presetDropdown.appendChild(newPreset); } -const search = tab => { - browser.tabs.query({active: true, currentWindow: true}) - .then(() => { - for (selected of engineselection()) { - browser.search.search({ - query: document.getElementById("searchbox").value, - engine: selected, - }); - } - } - ); + +// Search the input search-term on all enabled engines. +function search(tab) { + browser.tabs.query({active: true, currentWindow: true}) + .then(() => + { + for (selected of engineSelection()) { + browser.search.search({ + query: document.getElementById("searchbox").value, + engine: selected, + }); + } + } + ); } -const enablepresetbyname = (name) => { - document.getElementById("presets").value = name; - try { enablepreset(localStorage.getItem('preset_' + name)); } - catch {} + +// Enable a preset's corresponding search engines, by the preset's name. +function enablePresetByName(name) { + document.getElementById("presets").value = name; + try { enablePreset(localStorage.getItem('preset_' + name)); } + catch {} } -const enablepreset = (preset) => { - deselectengines(); - for (engine of preset.split(",")) { - let checkbox = document.getElementById(engine.replace(' ', '-')); - checkbox.checked = true; - } + +// Check all search engines' check boxes by name, in a comma-delimited list. +function enablePreset(preset) { + deselectEngines(); + for (engine of preset.split(",")) { + let checkbox = document.getElementById(engine.replace(' ', '-')); + checkbox.checked = true; + } } -const removecurrentpreset = () => { - let presetName = document.getElementById("presets").value; - if (presetName == "noPreset" || presetName == "newPreset") - return; - try { - let presets = localStorage.getItem('presets').split(','); - localStorage.removeItem('preset_' + presetName); - localStorage.setItem('presets', removefromarray(presets, presetName)); - } - catch {} +// Delete the currently-selected preset. +function removeCurrentPreset() { + let presetName = document.getElementById("presets").value; + if (presetName == "noPreset" || presetName == "newPreset") + return; - deselectengines(); - populatepresets(); - document.getElementById("presets").value = "noPreset"; + try { + let presets = localStorage.getItem('presets').split(','); + localStorage.removeItem('preset_' + presetName); + localStorage.setItem('presets', removeFromArray(presets, presetName)); + } + catch {} + + deselectEngines(); + populatePresets(); + document.getElementById("presets").value = "noPreset"; } // Search-box is also used for setting the name of new // presets; this sets the placeholder accordingly -const searchboxaspresetname = () => { - let textbox = document.getElementById("searchbox"); - textbox.setAttribute("placeholder", "New preset name…"); - deselectengines(); - document.getElementById("searchbox").focus(); +function searchBoxAsPresetName() { + let textbox = document.getElementById("searchbox"); + textbox.setAttribute("placeholder", "New preset name…"); + deselectengines(); + document.getElementById("searchbox").focus(); } -const resetsearchbox = (clearText = false) => { - let textbox = document.getElementById("searchbox"); - textbox.setAttribute("placeholder", "Search…"); - if (clearText) - textbox.value = ''; + +// Clear the search-box, and reset the placeholder. +function resetSearchBox(clearText = false) { + let textbox = document.getElementById("searchbox"); + textbox.setAttribute("placeholder", "Search…"); + if (clearText) + textbox.value = ''; } -const deselectengines = () => { - for (checkbox of document.getElementsByTagName("INPUT")) - checkbox.checked = false; + +// Deselect all engines in the list. +function deselectEngines() { + for (checkbox of document.getElementsByTagName("INPUT")) + checkbox.checked = false; } -const engineselection = () => { - let selection = []; - for (engine of document.getElementsByTagName('INPUT')) { - if (engine.value.includes("engine") && engine.checked) selection.push(engine.value.slice(7)); - } - return selection; + +// Return a list of all selected search-engines, in a comma-delimited list. +function engineSelection() { + let selection = []; + for (engine of document.getElementsByTagName('INPUT')) { + if (engine.value.includes("engine") && engine.checked) selection.push(engine.value.slice(7)); + } + return selection; } -const saveselection = () => { - let textbox = document.getElementById("searchbox"); - let selection = document.getElementById("presets").value; - let name = selection; - if (selection == "newPreset") - name = textbox.value; - savepreset(engineselection(), name); - // Update UI & listed presets - resetsearchbox(true); - populatepresets(); - enablepresetbyname(name); +// Save all selected engines into a present; whether new or old. +function saveSelection() { + let textbox = document.getElementById("searchbox"); + let selection = document.getElementById("presets").value; + let name = selection; + + if (selection == "newPreset") + name = textbox.value; + savePreset(engineSelection(), name); + // Update UI & listed presets + resetSearchBox(true); + populatePresets(); + enablePresetByName(name); } -const onpresetselected = (event) => { - let value = document.getElementById("presets").value; - if (value != "newPreset") - localStorage.setItem("defaultPreset", value); - resetsearchbox(); - if (value == "noPreset") - deselectengines(); - else if (value == "newPreset") - searchboxaspresetname(); - else - enablepresetbyname(value); +// An event handler that corrects engine-selection whenever the preset is changed. +function onPresetSelected(event) { + let value = document.getElementById("presets").value; + if (value != "newPreset") + localStorage.setItem("defaultPreset", value); + resetSearchBox(); + + if (value == "noPreset") + deselectEngines(); + else if (value == "newPreset") + searchBoxAsPresetName(); + else + enablePresetByName(value); } -const removefromarray = (array, item) => { - return array.filter((testItem, index) => - { - return testItem != item; - }); + +// Remove a specific item from the given array. +function removeFromArray(array, item) { + return array.filter((testItem, index) => + { + return testItem != item; + }); } -const removeredundantitems = (array) => { - return array.filter((item, index) => - { - return (array.indexOf(item) === index); - }) + +// Remove all repeated items from an array. +function removeRedundantItems(array) { + return array.filter((item, index) => + { + return (array.indexOf(item) === index); + }) } -browser.search.get().then(populateengines); +// Populate the list of selectable search-engines. +browser.search.get().then(populateEngines); + + +// Watch for the user hitting RETURN and triggering a result. document.getElementById("searchbox").addEventListener("keypress", key => { - if (event.key == "Enter") search(); + if (event.key == "Enter") search(); }); + +// Wait for a preset to be selected, so that we can change search-engine selections. document.addEventListener("change", e => { - if (e.target.id == "presets") - onpresetselected(); + if (e.target.id == "presets") + onPresetSelected(); }) + +// Handle searches, as well and save/removal of search presets. document.addEventListener("click", e => { - if (e.target.classList.contains("search")) - search(); - else if (e.target.classList.contains("save")) - saveselection(); - else if (e.target.classList.contains("remove")) - removecurrentpreset(); + if (e.target.classList.contains("search")) + search(); + else if (e.target.classList.contains("save")) + saveSelection(); + else if (e.target.classList.contains("remove")) + removeCurrentPreset(); });