Move some helpers into util.js

Author: qu1ck

InteractiveHtmlBom/generate_interactive_bom.py

@@ -518,6 +518,7 @@ def get_file_content(file_name):
     html = html.replace('///SPLITJS///', get_file_content('split.js'))
     html = html.replace('///CONFIG///', config_js)
     html = html.replace('///PCBDATA///', pcbdata_js)
+    html = html.replace('///UTILJS///', get_file_content('util.js'))
     html = html.replace('///RENDERJS///', get_file_content('render.js'))
     html = html.replace('///IBOMJS///', get_file_content('ibom.js'))
     with open(bom_file_name, "wt") as bom:

InteractiveHtmlBom/ibom.html

@@ -21,6 +21,10 @@
 ///PCBDATA///
 ///////////////////////////////////////////////
 
+///////////////////////////////////////////////
+///UTILJS///
+///////////////////////////////////////////////
+
 ///////////////////////////////////////////////
 ///RENDERJS///
 ///////////////////////////////////////////////

InteractiveHtmlBom/ibom.js

@@ -1,7 +1,5 @@
 /* DOM manipulation and misc code */
 
-var storagePrefix = 'KiCad_HTML_BOM__' + pcbdata.metadata.title + '__' +
-  pcbdata.metadata.revision + '__';
 var bomsplit;
 var canvassplit;
 var canvaslayout = "default";
@@ -15,40 +13,8 @@ var highlightedModules = [];
 var checkboxes = [];
 var bomCheckboxes = "";
 var highlightpin1 = false;
-var storage;
 var lastClicked;
 
-function initStorage(key) {
-  try {
-    window.localStorage.getItem("blank");
-    storage = window.localStorage;
-  } catch (e) {
-    // localStorage not available
-  }
-  if (!storage) {
-    try {
-      window.sessionStorage.getItem("blank");
-      storage = window.sessionStorage;
-    } catch (e) {
-      // sessionStorage also not available
-    }
-  }
-}
-
-function readStorage(key) {
-  if (storage) {
-    return storage.getItem(storagePrefix + '#' + key);
-  } else {
-    return null;
-  }
-}
-
-function writeStorage(key, value) {
-  if (storage) {
-    storage.setItem(storagePrefix + '#' + key, value);
-  }
-}
-
 function dbg(html) {
   dbgdiv.innerHTML = html;
 }
@@ -274,23 +240,6 @@ function createColumnHeader(name, cls, comparator) {
   return th;
 }
 
-function fancyDblClickHandler(el, onsingle, ondouble) {
-  return function() {
-    if (el.getAttribute("data-dblclick") == null) {
-      el.setAttribute("data-dblclick", 1);
-      setTimeout(function() {
-        if (el.getAttribute("data-dblclick") == 1) {
-          onsingle();
-        }
-        el.removeAttribute("data-dblclick");
-      }, 200);
-    } else {
-      el.removeAttribute("data-dblclick");
-      ondouble();
-    }
-  }
-}
-
 function populateBomHeader() {
   while (bomhead.firstChild) {
     bomhead.removeChild(bomhead.firstChild);
@@ -441,14 +390,6 @@ function populateBomBody() {
   }
 }
 
-function smoothScrollToRow(rowid) {
-  document.getElementById(rowid).scrollIntoView({
-    behavior: "smooth",
-    block: "center",
-    inline: "nearest"
-  });
-}
-
 function highlightPreviousRow() {
   if (!currentHighlightedRowId) {
     highlightHandlers[highlightHandlers.length - 1].handler();
@@ -515,55 +456,6 @@ function updateRefLookup(input) {
   populateBomTable();
 }
 
-function copyToClipboard() {
-  var text = '';
-  for (var node of bomhead.childNodes[0].childNodes) {
-    if (node.firstChild) {
-      text = text + node.firstChild.nodeValue;
-    }
-    if (node != bomhead.childNodes[0].lastChild) {
-      text += '\t';
-    }
-  }
-  text += '\n';
-  for (var row of bombody.childNodes) {
-    for (var cell of row.childNodes) {
-      for (var node of cell.childNodes) {
-        if (node.nodeName == "INPUT") {
-          if (node.checked) {
-            text = text + '✓';
-          }
-        } else if (node.nodeName == "MARK") {
-          text = text + node.firstChild.nodeValue;
-        } else {
-          text = text + node.nodeValue;
-        }
-      }
-      if (cell != row.lastChild) {
-        text += '\t';
-      }
-    }
-    text += '\n';
-  }
-  var textArea = document.createElement("textarea");
-  textArea.classList.add('clipboard-temp');
-  textArea.value = text;
-
-  document.body.appendChild(textArea);
-  textArea.focus();
-  textArea.select();
-
-  try {
-    if (document.execCommand('copy')) {
-      console.log('Bom copied to clipboard.');
-    }
-  } catch (err) {
-    console.log('Can not copy to clipboard.');
-  }
-
-  document.body.removeChild(textArea);
-}
-
 function silkscreenVisible(visible) {
   if (visible) {
     allcanvas.front.silk.style.display = "";
@@ -691,12 +583,6 @@ function changeBomLayout(layout) {
   changeCanvasLayout(canvaslayout);
 }
 
-function focusInputField(input) {
-  input.scrollIntoView(false);
-  input.focus();
-  input.select();
-}
-
 function focusFilterField() {
   focusInputField(document.getElementById("filter"));
 }
@@ -732,22 +618,6 @@ function checkBomCheckbox(bomrowid, checkboxname) {
   checkbox.onchange();
 }
 
-
-function removeGutterNode(node) {
-  for (var i = 0; i < node.childNodes.length; i++) {
-    if (node.childNodes[i].classList &&
-      node.childNodes[i].classList.contains("gutter")) {
-      node.removeChild(node.childNodes[i]);
-      break;
-    }
-  }
-}
-
-function cleanGutters() {
-  removeGutterNode(document.getElementById("bot"));
-  removeGutterNode(document.getElementById("canvasdiv"));
-}
-
 function setBomCheckboxes(value) {
   bomCheckboxes = value;
   writeStorage("bomCheckboxes", value);

InteractiveHtmlBom/util.js

@@ -0,0 +1,131 @@
+/* Utility functions */
+
+var storagePrefix = 'KiCad_HTML_BOM__' + pcbdata.metadata.title + '__' +
+  pcbdata.metadata.revision + '__';
+var storage;
+
+function initStorage(key) {
+  try {
+    window.localStorage.getItem("blank");
+    storage = window.localStorage;
+  } catch (e) {
+    // localStorage not available
+  }
+  if (!storage) {
+    try {
+      window.sessionStorage.getItem("blank");
+      storage = window.sessionStorage;
+    } catch (e) {
+      // sessionStorage also not available
+    }
+  }
+}
+
+function readStorage(key) {
+  if (storage) {
+    return storage.getItem(storagePrefix + '#' + key);
+  } else {
+    return null;
+  }
+}
+
+function writeStorage(key, value) {
+  if (storage) {
+    storage.setItem(storagePrefix + '#' + key, value);
+  }
+}
+
+function fancyDblClickHandler(el, onsingle, ondouble) {
+  return function() {
+    if (el.getAttribute("data-dblclick") == null) {
+      el.setAttribute("data-dblclick", 1);
+      setTimeout(function() {
+        if (el.getAttribute("data-dblclick") == 1) {
+          onsingle();
+        }
+        el.removeAttribute("data-dblclick");
+      }, 200);
+    } else {
+      el.removeAttribute("data-dblclick");
+      ondouble();
+    }
+  }
+}
+
+function smoothScrollToRow(rowid) {
+  document.getElementById(rowid).scrollIntoView({
+    behavior: "smooth",
+    block: "center",
+    inline: "nearest"
+  });
+}
+
+function focusInputField(input) {
+  input.scrollIntoView(false);
+  input.focus();
+  input.select();
+}
+
+function copyToClipboard() {
+  var text = '';
+  for (var node of bomhead.childNodes[0].childNodes) {
+    if (node.firstChild) {
+      text = text + node.firstChild.nodeValue;
+    }
+    if (node != bomhead.childNodes[0].lastChild) {
+      text += '\t';
+    }
+  }
+  text += '\n';
+  for (var row of bombody.childNodes) {
+    for (var cell of row.childNodes) {
+      for (var node of cell.childNodes) {
+        if (node.nodeName == "INPUT") {
+          if (node.checked) {
+            text = text + '✓';
+          }
+        } else if (node.nodeName == "MARK") {
+          text = text + node.firstChild.nodeValue;
+        } else {
+          text = text + node.nodeValue;
+        }
+      }
+      if (cell != row.lastChild) {
+        text += '\t';
+      }
+    }
+    text += '\n';
+  }
+  var textArea = document.createElement("textarea");
+  textArea.classList.add('clipboard-temp');
+  textArea.value = text;
+
+  document.body.appendChild(textArea);
+  textArea.focus();
+  textArea.select();
+
+  try {
+    if (document.execCommand('copy')) {
+      console.log('Bom copied to clipboard.');
+    }
+  } catch (err) {
+    console.log('Can not copy to clipboard.');
+  }
+
+  document.body.removeChild(textArea);
+}
+
+function removeGutterNode(node) {
+  for (var i = 0; i < node.childNodes.length; i++) {
+    if (node.childNodes[i].classList &&
+      node.childNodes[i].classList.contains("gutter")) {
+      node.removeChild(node.childNodes[i]);
+      break;
+    }
+  }
+}
+
+function cleanGutters() {
+  removeGutterNode(document.getElementById("bot"));
+  removeGutterNode(document.getElementById("canvasdiv"));
+}