glance-widgets-sdk 1.0.0

data/lib/glance_widgets/data/schemas.json

@@ -0,0 +1,418 @@
+{
+  "pixel": {
+    "color": "color",
+    "opacity": "number",
+    "cornerRadius": "number",
+    "rotation": "number",
+    "halo": "number",
+    "empty": "boolean"
+  },
+  "layout": {
+    "gapMode": {
+      "enum": [
+        "zero",
+        "near",
+        "default",
+        "far",
+        "extraFar"
+      ]
+    },
+    "edgeInsetRatio": "number",
+    "cellAspectRatio": "number",
+    "columnGapRatio": "number",
+    "rowGapRatio": "number"
+  },
+  "layers": {
+    "text": {
+      "content": {
+        "text": "textValue"
+      },
+      "style": {
+        "effectType": {
+          "enum": [
+            "none",
+            "mask",
+            "vignette",
+            "readability"
+          ]
+        },
+        "backgroundColor": "color",
+        "opacity": "number",
+        "cornerRadiusRatio": "number",
+        "borderColor": "color",
+        "borderOpacity": "number",
+        "borderWidth": "number",
+        "gradientEnabled": "boolean",
+        "gradientColors": {
+          "arrayOf": "color"
+        },
+        "gradientStops": {
+          "arrayOf": "number"
+        },
+        "gradientAngle": "number",
+        "maskColor": "color",
+        "maskOpacity": "number",
+        "vignetteIntensity": "number",
+        "readabilityGradient": {
+          "enum": [
+            "none",
+            "top",
+            "bottom",
+            "left",
+            "right",
+            "both",
+            "topLeftDiagonal",
+            "topRightDiagonal"
+          ]
+        },
+        "color": "color",
+        "textOpacity": "number",
+        "fontSizeRatio": "number",
+        "fontWeight": {
+          "enum": [
+            "300",
+            "400",
+            "500",
+            "600",
+            "700"
+          ]
+        },
+        "fontFamily": {
+          "enum": [
+            "system",
+            "systemMonospace",
+            "monospace"
+          ]
+        },
+        "fontFamilyFallback": {
+          "arrayOf": "string"
+        },
+        "letterSpacing": "number",
+        "baselineRatio": "number",
+        "horizontalAlignment": {
+          "enum": [
+            "left",
+            "center",
+            "right"
+          ]
+        },
+        "verticalAlignment": {
+          "enum": [
+            "top",
+            "center",
+            "bottom"
+          ]
+        },
+        "autoWrap": "boolean",
+        "paddingRatio": "number"
+      }
+    },
+    "line": {
+      "content": {
+        "direction": {
+          "enum": [
+            "horizontal",
+            "vertical"
+          ]
+        }
+      },
+      "style": {
+        "color": "color",
+        "opacity": "number",
+        "strokeWidth": "number",
+        "pattern": {
+          "enum": [
+            "solid",
+            "dashed",
+            "dotted"
+          ]
+        },
+        "cap": {
+          "enum": [
+            "round",
+            "butt"
+          ]
+        },
+        "dashLength": "number",
+        "dashGap": "number",
+        "gradientEnabled": "boolean",
+        "gradientColors": {
+          "arrayOf": "color"
+        },
+        "gradientStops": {
+          "arrayOf": "number"
+        }
+      }
+    },
+    "shape": {
+      "content": {},
+      "style": {
+        "effectType": {
+          "enum": [
+            "none",
+            "mask",
+            "vignette",
+            "readability"
+          ]
+        },
+        "backgroundColor": "color",
+        "opacity": "number",
+        "cornerRadiusRatio": "number",
+        "borderColor": "color",
+        "borderOpacity": "number",
+        "borderWidth": "number",
+        "gradientEnabled": "boolean",
+        "gradientColors": {
+          "arrayOf": "color"
+        },
+        "gradientStops": {
+          "arrayOf": "number"
+        },
+        "gradientAngle": "number",
+        "maskColor": "color",
+        "maskOpacity": "number",
+        "vignetteIntensity": "number",
+        "readabilityGradient": {
+          "enum": [
+            "none",
+            "top",
+            "bottom",
+            "left",
+            "right",
+            "both",
+            "topLeftDiagonal",
+            "topRightDiagonal"
+          ]
+        },
+        "color": "color"
+      }
+    },
+    "icon": {
+      "content": {
+        "icon": "string",
+        "iconCodePoint": "integer",
+        "iconFont": {
+          "enum": [
+            "material",
+            "phosphorBold",
+            "devicon",
+            "simpleIcons"
+          ]
+        },
+        "url": "string"
+      },
+      "style": {
+        "color": "color",
+        "textOpacity": "number",
+        "iconGlowEnabled": "boolean",
+        "iconGlowColor": "color",
+        "iconGlowOpacity": "number",
+        "iconGlowRadius": "number"
+      }
+    },
+    "image": {
+      "content": {
+        "url": "string"
+      },
+      "style": {
+        "effectType": {
+          "enum": [
+            "none",
+            "mask",
+            "vignette",
+            "readability"
+          ]
+        },
+        "backgroundColor": "color",
+        "opacity": "number",
+        "cornerRadiusRatio": "number",
+        "borderColor": "color",
+        "borderOpacity": "number",
+        "borderWidth": "number",
+        "gradientEnabled": "boolean",
+        "gradientColors": {
+          "arrayOf": "color"
+        },
+        "gradientStops": {
+          "arrayOf": "number"
+        },
+        "gradientAngle": "number",
+        "maskColor": "color",
+        "maskOpacity": "number",
+        "vignetteIntensity": "number",
+        "readabilityGradient": {
+          "enum": [
+            "none",
+            "top",
+            "bottom",
+            "left",
+            "right",
+            "both",
+            "topLeftDiagonal",
+            "topRightDiagonal"
+          ]
+        },
+        "color": "color"
+      }
+    },
+    "matrix": {
+      "content": {
+        "pixels": {
+          "arrayOf": {
+            "arrayOf": {
+              "object": {
+                "color": "color",
+                "opacity": "number",
+                "cornerRadius": "number",
+                "rotation": "number",
+                "halo": "number",
+                "empty": "boolean"
+              }
+            }
+          }
+        },
+        "default": {
+          "object": {
+            "color": "color",
+            "opacity": "number",
+            "cornerRadius": "number",
+            "rotation": "number",
+            "halo": "number",
+            "empty": "boolean"
+          }
+        },
+        "batch": {
+          "arrayOf": {
+            "object": {}
+          }
+        },
+        "layout": {
+          "object": {
+            "gapMode": {
+              "enum": [
+                "zero",
+                "near",
+                "default",
+                "far",
+                "extraFar"
+              ]
+            },
+            "edgeInsetRatio": "number",
+            "cellAspectRatio": "number",
+            "columnGapRatio": "number",
+            "rowGapRatio": "number"
+          }
+        }
+      },
+      "style": {}
+    },
+    "curve": {
+      "content": {
+        "mode": {
+          "enum": [
+            "samples",
+            "function"
+          ]
+        },
+        "points": {
+          "arrayOf": {
+            "arrayOf": "number",
+            "length": 2
+          }
+        },
+        "expression": "string",
+        "parameters": {
+          "record": "number"
+        },
+        "domain": {
+          "arrayOf": "number",
+          "length": 2
+        },
+        "yDomain": {
+          "arrayOf": "number",
+          "length": 2
+        },
+        "interpolation": {
+          "enum": [
+            "linear",
+            "stepAfter",
+            "monotone"
+          ]
+        },
+        "markers": {
+          "arrayOf": {
+            "object": {
+              "at": {
+                "object": {
+                  "x": "number",
+                  "sampleIndex": "integer",
+                  "offsetPt": {
+                    "arrayOf": "number",
+                    "length": 2
+                  }
+                }
+              },
+              "symbol": {
+                "object": {
+                  "radiusPt": "number",
+                  "fill": "color"
+                }
+              },
+              "label": "string",
+              "labelStyle": {
+                "object": {
+                  "color": "color",
+                  "fontSizePt": "number",
+                  "position": {
+                    "enum": [
+                      "top",
+                      "bottom",
+                      "left",
+                      "right"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "style": {
+        "color": "color",
+        "opacity": "number",
+        "strokeWidth": "number",
+        "lineCap": {
+          "enum": [
+            "round",
+            "butt",
+            "square"
+          ]
+        },
+        "lineJoin": {
+          "enum": [
+            "round",
+            "bevel",
+            "miter"
+          ]
+        },
+        "dashLength": "number",
+        "dashGap": "number",
+        "fillColor": "color",
+        "fillOpacity": "number",
+        "plotPadding": "number"
+      }
+    }
+  },
+  "frame": {
+    "left": "number",
+    "top": "number",
+    "right": "number",
+    "bottom": "number",
+    "width": "number",
+    "height": "number"
+  },
+  "transform": {
+    "translateX": "number",
+    "translateY": "number"
+  }
+}

data/lib/glance_widgets/data/text-advances.json

@@ -0,0 +1,120 @@
+{
+  "ascii": [
+    282,
+    357,
+    569,
+    672,
+    672,
+    1036,
+    745,
+    348,
+    429,
+    429,
+    485,
+    672,
+    348,
+    485,
+    348,
+    335,
+    685,
+    512,
+    644,
+    669,
+    688,
+    664,
+    684,
+    605,
+    694,
+    684,
+    348,
+    348,
+    672,
+    672,
+    672,
+    558,
+    928,
+    733,
+    694,
+    742,
+    748,
+    623,
+    598,
+    761,
+    784,
+    319,
+    602,
+    710,
+    595,
+    907,
+    769,
+    787,
+    674,
+    787,
+    695,
+    676,
+    661,
+    761,
+    722,
+    1010,
+    730,
+    709,
+    676,
+    429,
+    335,
+    429,
+    672,
+    628,
+    500,
+    590,
+    652,
+    588,
+    652,
+    602,
+    409,
+    646,
+    633,
+    288,
+    288,
+    602,
+    295,
+    933,
+    628,
+    620,
+    647,
+    648,
+    436,
+    567,
+    413,
+    628,
+    584,
+    848,
+    581,
+    598,
+    567,
+    429,
+    300,
+    429,
+    672
+  ],
+  "extra": {
+    "°": 485,
+    "±": 672,
+    "×": 672,
+    "÷": 672,
+    "·": 348,
+    "•": 485,
+    "●": 952,
+    "–": 628,
+    "—": 907,
+    "…": 955,
+    "€": 702,
+    "£": 672,
+    "¥": 672,
+    "←": 944,
+    "→": 944,
+    "↑": 816,
+    "↓": 816,
+    "▲": 779,
+    "▼": 779
+  }
+}

data/lib/glance_widgets/font.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module GlanceWidgets
+  DEFAULT_FONT_NAME = '3x5'
+  DEFAULT_LETTER_SPACING = 1
+  DEFAULT_LINE_SPACING = 1
+  ANCHOR_BOX_WIDTH = 1
+
+  class PixelFont
+    attr_reader :name, :height, :descent, :spacing, :line_height
+
+    def initialize(definition)
+      @name = definition.fetch('name')
+      @height = definition.fetch('height')
+      @descent, @spacing = DataValues.fetch_or(definition, 'descent', 0), DataValues.fetch_or(definition, 'spacing', 1)
+      Raster.integers('Font dimensions', [height, descent, spacing])
+      raise ArgumentError, 'Invalid font height/descent' unless height >= 1 && descent >= 0
+      @line_height = height + descent
+      @fallback, @glyphs = definition['fallback'], {}
+      fixed = definition['advance']
+      Raster.integers('Font advance', [fixed]) unless fixed.nil?
+      definition.fetch('glyphs').each { |character, glyph| compile(character, glyph, fixed) }
+      DataValues.fetch_or(definition, 'aliases', {}).each do |alias_name, target|
+        unless alias_name.each_char.count == 1 && @glyphs.key?(target)
+          raise ArgumentError, 'Invalid font alias'
+        end
+        @glyphs[alias_name] ||= @glyphs[target]
+      end
+      raise ArgumentError, 'Font fallback has no glyph' if @fallback && !@glyphs.key?(@fallback)
+    end
+
+    def monospace_advance
+      @glyphs.values.map { |g| [g['width'], g['advance']].max }.max || 0
+    end
+
+    def has_glyph(character)
+      @glyphs.key?(character)
+    end
+
+    def glyph_for(character)
+      glyph = @glyphs[character] || @glyphs[@fallback]
+      raise ArgumentError, "Font #{name} has no glyph for #{character.inspect}" unless glyph
+      DataValues.copy(glyph)
+    end
+
+    private
+
+    def compile(character, definition, fixed)
+      raise ArgumentError, 'Glyph key must be one Unicode code point' unless character.each_char.count == 1
+      rows = DataValues.copy(definition.is_a?(Array) ? definition : definition.fetch('rows'))
+      width = rows.empty? ? 0 : rows[0].length
+      unless rows.length <= line_height && rows.all? { |row| row.length == width && /\A[#.]*\z/.match(row) }
+        raise ArgumentError, 'Invalid glyph rows'
+      end
+      advance = fixed || (definition.is_a?(Hash) ? DataValues.fetch_or(definition, 'advance', width) : width)
+      if rows.empty? && fixed.nil? && (!definition.is_a?(Hash) || !DataValues.set?(definition, 'advance'))
+        raise ArgumentError, 'Glyph without rows requires an advance'
+      end
+      Raster.integers('Glyph advance', [advance])
+      raise ArgumentError, 'Invalid glyph advance' if advance < 0 || (fixed && width > fixed)
+      rows += Array.new([0, height - rows.length].max, '.' * width)
+      ink_bottom = rows.each_index.select { |i| rows[i].include?('#') }.map { |i| i + 1 }.max || 0
+      @glyphs[character] = { 'rows' => rows, 'width' => width, 'advance' => advance, 'inkBottom' => ink_bottom }
+    end
+  end
+
+  FONT_REGISTRY = {}
+
+  def define_font(definition)
+    raise ArgumentError, 'Font already defined' if FONT_REGISTRY.key?(definition.fetch('name'))
+    font = PixelFont.new(definition)
+    FONT_REGISTRY[font.name] = font
+  end
+
+  def get_font(name)
+    FONT_REGISTRY.fetch(name) { raise ArgumentError, "Unknown font: #{name}" }
+  end
+
+  def resolve_font(font = nil)
+    font ||= DEFAULT_FONT_NAME
+    return get_font(font) if font.is_a?(String)
+    font.is_a?(PixelFont) ? font : PixelFont.new(font)
+  end
+
+  module TextLayout
+    module_function
+
+    def width(text, font, spacing, fixed = nil)
+      characters = text.each_char.to_a
+      return 0 if characters.empty?
+      characters.sum { |char| fixed || font.glyph_for(char)['advance'] } + spacing * (characters.length - 1)
+    end
+
+    def wrap(paragraph, font, spacing, max_width, fixed = nil)
+      return [paragraph] unless max_width
+      result, current = [], nil
+      paragraph.split(/ /, -1).each do |word|
+        rest = word.each_char.to_a
+        candidate = current.nil? ? word : current + ' ' + word
+        if width(candidate, font, spacing, fixed) <= max_width
+          current = candidate
+          next
+        end
+        result << current unless current.nil?
+        while rest.length > 1 && width(rest.join, font, spacing, fixed) > max_width
+          length = 1
+          length += 1 while length < rest.length && width(rest[0..length].join, font, spacing, fixed) <= max_width
+          result << rest.shift(length).join
+        end
+        current = rest.join
+      end
+      result << (current || '')
+    end
+  end
+
+  def layout_text(content, options = {})
+    font = resolve_font(options['font'])
+    fixed = options['monospace'] ? font.monospace_advance : nil
+    spacing, line_spacing = DataValues.fetch_or(options, 'letterSpacing', font.spacing), DataValues.fetch_or(options, 'lineSpacing', 1)
+    max_width = options['maxWidth']
+    box_width = DataValues.fetch_or(options, 'boxWidth', max_width || 1)
+    Raster.integers('Text layout spacing', [spacing, line_spacing, box_width])
+    if max_width
+      Raster.integers('maxWidth', [max_width])
+      raise ArgumentError, 'maxWidth must be positive' if max_width < 1
+    end
+    align = DataValues.fetch_or(options, 'align', 'left')
+    raise ArgumentError, 'Invalid text alignment' unless %w[left center right].include?(align)
+    lines = content.split(/\n/, -1).flat_map { |line| TextLayout.wrap(line, font, spacing, max_width, fixed) }
+    lines = [''] if lines.empty?
+    glyphs, widest = [], 0
+    pitch = font.line_height + line_spacing
+    lines.each_with_index do |line, index|
+      line_width = TextLayout.width(line, font, spacing, fixed)
+      widest = [widest, line_width].max
+      pen = case align
+            when 'left' then 0
+            when 'right' then box_width - line_width
+            else ((box_width - line_width) / 2.0).floor
+            end
+      line.each_char do |character|
+        glyph = font.glyph_for(character)
+        glyphs << { 'glyph' => glyph, 'x' => pen + (fixed ? (fixed - glyph['width']) / 2 : 0), 'y' => index * pitch }
+        pen += (fixed || glyph['advance']) + spacing
+      end
+    end
+    bottom = [font.height, *lines.last.each_char.map { |c| font.glyph_for(c)['inkBottom'] }].max
+    { 'width' => widest, 'height' => (lines.length - 1) * pitch + bottom, 'lines' => lines, 'glyphs' => glyphs }
+  end
+
+  def measure_text(content, font = nil, options = {})
+    layout_text(content, options.merge('font' => font)).select { |key, _| %w[width height lines].include?(key) }
+  end
+
+  def text_matrix(content, options = {})
+    metrics = measure_text(content, options['font'], options)
+    matrix = Matrix.new([1, metrics['width']].max, [1, metrics['height']].max, options)
+    drawing = options.merge('boxWidth' => metrics['width'])
+    drawing['style'] = options['color'] if DataValues.set?(options, 'color')
+    matrix.text(content, 0, 0, drawing)
+  end
+
+  FONT_3X5 = define_font(DataValues.load('fonts/font-3x5.json'))
+  FONT_5X7 = define_font(DataValues.load('fonts/font-5x7.json'))
+end