add CLI font converter tool

Author: gfwilliams

cli/fontconverter.js

@@ -0,0 +1,80 @@
+#!/usr/bin/node
+
+var fontconverter = require("../fontconverter.js");
+var RANGES = fontconverter.getRanges();
+
+var fontInfo = {};
+var options = {};
+
+// Scan Args
+for (var i=2;i<process.argv.length;i++) {
+  var arg = process.argv[i];
+  console.log(arg);
+  if (arg=="--help") {
+    console.log(`Espruino Font Converter CLI (BETA)
+-------------------------------
+
+USAGE:
+
+cli/fontconverter.js sourceFile
+       --help       - show this message
+       --debug      - print debug info for loaded font
+       --height #   - set the height of the font
+       --range ${Object.keys(RANGES).join("|")} (default=ASCII)
+                    - which range of characters should be included
+
+       --ojs fn.js   - save the font as JS - only works for <1000 chars
+       --oh  fn.h    - save the font as a C header file (uses data for each char including blank ones)
+       --opbf fn.pbf - save a binary PBF file
+                      //  eg. require("fs").writeFileSync("font.pbf", Buffer.from(font.getPBF()))
+       --opbfc fn    - save a binary PBF file, but as a C file that can be included in Espruino
+                       (fn.c and fn.h are written)
+
+Input font can be:
+      ...json       -  font made using https://www.pentacom.jp/pentacom/bitfontmaker2/
+      ...pbff       -  pebble font format (text mode)
+      ...png        -  8x8 font map
+      ...bdf        -  Linux font format
+      `);
+  } else if (arg=="--debug") {
+    options.debug = true;
+  } else if (arg=="--height") {
+    fontInfo.height = 0|process.argv[++i];
+  } else if (arg=="--range") {
+    options.rangeId = process.argv[++i];
+    var range = RANGES[options.rangeId];
+    if (!range) throw new Error(`Range ID ${options.rangeId} not found`);
+    fontInfo.range = range.range;
+  } else if (arg=="--ojs") {
+    options.ojs = process.argv[++i];
+  } else if (arg=="--oh") {
+    options.oh = process.argv[++i];
+  } else if (arg=="--opbf") {
+    options.opbf = process.argv[++i];
+  } else if (arg=="--opbfc") {
+    options.opbfc = process.argv[++i];
+  } else if (arg.startsWith("-")) {
+    throw new Error(`Unknown argument '${arg}'`);
+  } else {
+    if (fontInfo.fn) throw new Error(`Source file already specified (${fontInfo.fn})`);
+    fontInfo.fn = arg;
+  }
+}
+
+
+// Checks
+if (!fontInfo.fn) throw new Error("No font source file specified");
+// Do stuff
+var font = fontconverter.load(fontInfo);
+if (options.debug) {
+  font.debugChars();
+  font.debugPixelsUsed();
+}
+if (options.ojs)
+  require("fs").writeFileSync(options.ojs, Buffer.from(font.getJS()))
+if (options.oh)
+  require("fs").writeFileSync(options.oh, Buffer.from(font.getHeaderFile()))
+if (options.opbf)
+  require("fs").writeFileSync(options.opbf, Buffer.from(font.getPBF()))
+if (options.opbfc)
+  font.getPBFAsC({filename:options.opbfc});

fontconverter.js

@@ -94,14 +94,13 @@ function Font(info) {
   this.name = info.name;
   this.id = this.name ? this.name.replace(/[^A-Za-z0-9]/g,"") : "Unknown";
   this.fn = info.fn;
-  this.height = info.height;
+  this.height = 0|info.height;
   this.bpp = info.bpp||1;
 
   this.range = info.range;
   if (!this.range)
     this.range = getRanges().ASCII.range;
 
-
   this.fixedWidth = !!info.fixedWidth;
   this.fullHeight = !!info.fullHeight; // output fonts at the full height available
   this.glyphPadX = 1; // padding at the end of glyphs (needed for old-style JS fonts)
@@ -324,6 +323,8 @@ function loadPBFF(fontInfo) {
     if (l.startsWith("version")) {
     } else if (l.startsWith("fallback")) {
     } else if (l.startsWith("line-height")) {
+      if (!fontInfo.fmHeight) // if no height specified
+        fontInfo.fmHeight = 0|l.split(" ")[1];
     } else if (l.startsWith("glyph")) {
       current = {};
       current.idx = parseInt(l.trim().split(" ")[1]);
@@ -749,6 +750,8 @@ Font.prototype.getPBF = function() {
 */
 Font.prototype.getPBFAsC = function(options) {
   var pbf = this.getPBF();
+  options = options||{};
+  if (!options.path) options.path="";
   require("fs").writeFileSync(options.path+options.filename+".h", `/*
  * This file is part of Espruino, a JavaScript interpreter for Microcontrollers
  *
@@ -893,7 +896,12 @@ function getRanges() {
     fn : "renaissance_28.pbff",
     height : 28, // actual used height of font map
     range : [ min:32, max:255 ]
-    yOffset : 4,
+  }
+
+  or:
+
+  {
+    fn : "font.bdf",  // Linux bitmap font format
   }
 
   or for a font made using https://www.pentacom.jp/pentacom/bitfontmaker2/