UI: refactoring to allow alternative keypad layouts

Chris Warren-Smith · Chris Warren-Smith · commit 6e87d5c021ec · 2025-08-09T20:29:17.000+09:30
diff --git a/src/ui/image_codec.cpp b/src/ui/image_codec.cpp
@@ -84,22 +84,24 @@ bool ImageCodec::encode(uint8_t **data, size_t *size) const {
 void ImageCodec::resize(unsigned width, unsigned height) {
   auto *pixels = new uint8_t[width * height * 4];
 
-  for (int y = 0; y < height; y++) {
+  for (unsigned y = 0; y < height; y++) {
     float gy = ((float)y + 0.5f) * _height / height - 0.5f;
-    int y0 = (int)gy, y1 = y0 + 1;
+    unsigned y0 = (unsigned)gy;
+    unsigned y1 = y0 + 1;
     float fy = gy - y0;
     y0 = y0 < 0 ? 0 : (y0 >= _height ? _height - 1 : y0);
     y1 = y1 < 0 ? 0 : (y1 >= _height ? _height - 1 : y1);
 
-    for (int x = 0; x < width; x++) {
+    for (unsigned x = 0; x < width; x++) {
       float gx = ((float)x + 0.5f) * _width / width - 0.5f;
-      int x0 = (int)gx, x1 = x0 + 1;
+      unsigned x0 = (unsigned)gx;
+      unsigned x1 = x0 + 1;
       float fx = gx - x0;
       x0 = x0 < 0 ? 0 : (x0 >= _width ? _width - 1 : x0);
       x1 = x1 < 0 ? 0 : (x1 >= _width ? _width - 1 : x1);
 
       int offset = 4 * (y * width + x);
-      for (int c = 0; c < 4; c++) {
+      for (unsigned c = 0; c < 4; c++) {
         // A, R, G, B
         float tl = _pixels[4 * (y0 * _width + x0) + c];
         float tr = _pixels[4 * (y0 * _width + x1) + c];
diff --git a/src/ui/keypad.cpp b/src/ui/keypad.cpp
@@ -14,13 +14,10 @@
 #include "ui/keypad_icons.h"
 #include "keypad.h"
 
-constexpr int ROW_LENGTHS[] = {7, 10, 9, 9, 9};
-constexpr int MAX_ROWS = 5;
-constexpr int MAX_COLS = 10;
-constexpr int QWERTY_ROW = 1;
-constexpr int ASDF_ROW = 2;
-constexpr int SPACE_COLS = 3;
+// the size of PNGs as defined in keypad/build.sh
 constexpr int IMAGE_SIZE = 30;
+
+// PI
 constexpr double PI = 3.14159;
 
 // padding size based on character height
@@ -49,74 +46,111 @@ KeypadTheme MODERN_DARK_THEME = {
   ._funcKeyHighlight = 0x90a4ae, // Blue Grey 300 (matching accent highlight)
 };
 
-constexpr RawKey KEYS[MAX_ROWS][MAX_COLS] = {
-  // Toolbar
-  {
-    {K_CUT, K_CUT, K_CUT, K_CUT},
-    {K_COPY, K_COPY, K_COPY, K_COPY},
-    {K_PASTE, K_PASTE, K_PASTE, K_PASTE},
-    {K_SEARCH, K_SEARCH, K_SEARCH, K_SEARCH},
-    {K_SAVE, K_SAVE, K_SAVE, K_SAVE},
-    {K_RUN, K_RUN, K_RUN, K_RUN},
-    {K_HELP, K_HELP, K_HELP, K_HELP},
-    {K_NULL},
-    {K_NULL},
-    {K_NULL}
-  },
-  // QWERTY
-  {
-    {K_q, K_1, K_1, K_Q},
-    {K_w, K_2, K_2, K_W},
-    {K_e, K_3, K_3, K_E},
-    {K_r, K_4, K_4, K_R},
-    {K_t, K_5, K_5, K_T},
-    {K_y, K_6, K_6, K_Y},
-    {K_u, K_7, K_7, K_U},
-    {K_i, K_8, K_8, K_I},
-    {K_o, K_9, K_9, K_O},
-    {K_p, K_0, K_0, K_P}
-  },
-  // ASDF
-  {
-    {K_a, K_COMMA, K_HASH, K_A},
-    {K_s, K_EQUALS, K_SEMICOLON, K_S},
-    {K_d, K_LPAREN, K_QUESTION, K_D},
-    {K_f, K_RPAREN, K_AMPERSAND, K_F},
-    {K_g, K_QUOTE, K_DOLLAR, K_G},
-    {K_h, K_APOSTROPHE, K_EXCLAIM, K_H},
-    {K_j, K_PERIOD, K_AT, K_J},
-    {K_k, K_MINUS, K_SLASH, K_K},
-    {K_l, K_ASTERISK, K_BACKSLASH, K_L},
-    {K_NULL}
-  },
-  // ZXC
-  {
-    {K_TOGGLE, K_TOGGLE, K_TOGGLE, K_TOGGLE},
-    {K_z, K_UNDERSCORE, K_CARET, K_Z},
-    {K_x, K_PLUS, K_LBRACE, K_X},
-    {K_c, K_COLON, K_RBRACE, K_C},
-    {K_v, K_LBRACKET, K_PIPE, K_V},
-    {K_b, K_RBRACKET, K_PERCENT, K_B},
-    {K_n, K_LESS, K_BACKTICK, K_N},
-    {K_m, K_GREATER, K_TILDE, K_M},
-    {K_BACKSPACE, K_BACKSPACE, K_BACKSPACE, K_BACKSPACE},
-    {K_NULL}
-  },
-  // FUNCs, SPACE
-  {
-    {K_LINE_UP, K_PAGE_UP, K_LINE_UP, K_PAGE_UP},
-    {K_LINE_DOWN, K_PAGE_DOWN, K_LINE_DOWN, K_PAGE_DOWN},
-    {K_LPAREN, K_SLASH, K_COMMA, K_LBRACKET},
-    {K_SPACE, K_SPACE, K_SPACE, K_SPACE},
-    {K_RPAREN, K_HASH, K_EQUALS, K_RBRACKET},
-    {K_TAG, K_TAG, K_TAG, K_TAG},
-    {K_ENTER, K_ENTER, K_ENTER, K_ENTER},
-    {K_NULL},
-    {K_NULL},
-    {K_NULL},
-  }
+// compact layout for mobile devices in portrait mode
+namespace MobileKeypadLayout {
+  constexpr int ROW_LENGTHS[] = {7, 10, 9, 9, 9};
+  constexpr int MAX_ROWS = 5;
+  constexpr int MAX_COLS = 10;
+  constexpr int QWERTY_ROW = 1;
+  constexpr int ASDF_ROW = 2;
+  constexpr int SPACE_COLS = 3;
+  constexpr RawKey KEYS[MAX_ROWS][MAX_COLS] = {
+    // Toolbar
+    {
+      {K_CUT, K_CUT, K_CUT, K_CUT},
+      {K_COPY, K_COPY, K_COPY, K_COPY},
+      {K_PASTE, K_PASTE, K_PASTE, K_PASTE},
+      {K_SEARCH, K_SEARCH, K_SEARCH, K_SEARCH},
+      {K_SAVE, K_SAVE, K_SAVE, K_SAVE},
+      {K_RUN, K_RUN, K_RUN, K_RUN},
+      {K_HELP, K_HELP, K_HELP, K_HELP},
+      {K_NULL},
+      {K_NULL},
+      {K_NULL}
+    },
+    // QWERTY
+    {
+      {K_q, K_1, K_1, K_Q},
+      {K_w, K_2, K_2, K_W},
+      {K_e, K_3, K_3, K_E},
+      {K_r, K_4, K_4, K_R},
+      {K_t, K_5, K_5, K_T},
+      {K_y, K_6, K_6, K_Y},
+      {K_u, K_7, K_7, K_U},
+      {K_i, K_8, K_8, K_I},
+      {K_o, K_9, K_9, K_O},
+      {K_p, K_0, K_0, K_P}
+    },
+    // ASDF
+    {
+      {K_a, K_COMMA, K_HASH, K_A},
+      {K_s, K_EQUALS, K_SEMICOLON, K_S},
+      {K_d, K_LPAREN, K_QUESTION, K_D},
+      {K_f, K_RPAREN, K_AMPERSAND, K_F},
+      {K_g, K_QUOTE, K_DOLLAR, K_G},
+      {K_h, K_APOSTROPHE, K_EXCLAIM, K_H},
+      {K_j, K_PERIOD, K_AT, K_J},
+      {K_k, K_MINUS, K_SLASH, K_K},
+      {K_l, K_ASTERISK, K_BACKSLASH, K_L},
+      {K_NULL}
+    },
+    // ZXC
+    {
+      {K_TOGGLE, K_TOGGLE, K_TOGGLE, K_TOGGLE},
+      {K_z, K_UNDERSCORE, K_CARET, K_Z},
+      {K_x, K_PLUS, K_LBRACE, K_X},
+      {K_c, K_COLON, K_RBRACE, K_C},
+      {K_v, K_LBRACKET, K_PIPE, K_V},
+      {K_b, K_RBRACKET, K_PERCENT, K_B},
+      {K_n, K_LESS, K_BACKTICK, K_N},
+      {K_m, K_GREATER, K_TILDE, K_M},
+      {K_BACKSPACE, K_BACKSPACE, K_BACKSPACE, K_BACKSPACE},
+      {K_NULL}
+    },
+    // FUNCs, SPACE
+    {
+      {K_LINE_UP, K_PAGE_UP, K_LINE_UP, K_PAGE_UP},
+      {K_LINE_DOWN, K_PAGE_DOWN, K_LINE_DOWN, K_PAGE_DOWN},
+      {K_LPAREN, K_SLASH, K_COMMA, K_LBRACKET},
+      {K_SPACE, K_SPACE, K_SPACE, K_SPACE},
+      {K_RPAREN, K_HASH, K_EQUALS, K_RBRACKET},
+      {K_TAG, K_TAG, K_TAG, K_TAG},
+      {K_ENTER, K_ENTER, K_ENTER, K_ENTER},
+      {K_NULL},
+      {K_NULL},
+      {K_NULL},
+    }
+  };
+
+  struct Impl : public KeypadLayout {
+    RawKey getRawKey(int row, int col) const override {
+      return KEYS[row][col];
+    }
+
+    int getMaxRowLength() const override {
+      return ROW_LENGTHS[QWERTY_ROW];
+    }
+
+    int getMaxRows() const override {
+      return MAX_ROWS;
+    }
+
+    int getRowLength(int row) const override {
+      return ROW_LENGTHS[row];
+    };
+
+    int getSpaceCols() const override {
+      return SPACE_COLS;
+    }
+
+    bool isWideRow(int row) const override {
+      return row == QWERTY_ROW || row == ASDF_ROW;
+    }
+  };
 };
 
+KeypadLayout::~KeypadLayout() = default;
+
 //
 // KeypadImage
 //
@@ -202,6 +236,7 @@ KeyCode KeypadDrawContext::getKey(RawKey key) const {
     case kNumber: keyCode = key._number; break;
     case kSymbol: keyCode = key._symbol; break;
     case kSize: keyCode = K_NULL; break;
+    default: keyCode = K_NULL; break;
   }
   return keyCode;
 }
@@ -414,46 +449,51 @@ Keypad::Keypad(int charWidth, int charHeight, bool toolbar)
     _width(0),
     _height(0),
     _padding(static_cast<int>(charHeight * PADDING_FACTOR)),
-    _theme(&MODERN_DARK_THEME),
-    _context(charWidth, charHeight),
     _toolbar(toolbar),
-    _pressed(nullptr) {
+    _pressed(nullptr),
+    _theme(&MODERN_DARK_THEME),
+    _context(charWidth, charHeight) {
+  selectLayout();
   generateKeys();
 }
 
 void Keypad::generateKeys() {
   _keys.clear();
 
-  const int rows = _toolbar ? 1 : MAX_ROWS;
+  const int rows = _toolbar ? 1 : _layout->getMaxRows();
   for (int row = 0; row < rows; ++row) {
-    int cols = ROW_LENGTHS[row];
+    int cols = _layout->getRowLength(row);
     for (int col = 0; col < cols; col++) {
-      const RawKey &k = KEYS[row][col];
+      const RawKey &k = _layout->getRawKey(row, col);
       if (k._lower != K_NULL) {
         _keys.add(new Key(k));
       }
     }
   }
 }
 
+void Keypad::selectLayout() {
+  _layout = std::make_unique<MobileKeypadLayout::Impl>();
+}
+
 void Keypad::layout(int x, int y, int w, int h) {
   _posX = x;
   _posY = y;
   _width = w;
   _height = h;
 
   const int width = _width - _padding;
-  const int keyW = width / ROW_LENGTHS[QWERTY_ROW];
+  const int keyW = width / _layout->getMaxRowLength();
   const int keyH = _context._charHeight + _padding * 2;
   const int xStart = _posX + ((w - _width) / 2);
-  const int rows = _toolbar ? 1 : MAX_ROWS;
+  const int rows = _toolbar ? 1 : _layout->getMaxRows();
   int yPos = _posY;
   int index = 0;
 
   for (int row = 0; row < rows; ++row) {
-    const int cols = ROW_LENGTHS[row];
+    const int cols = _layout->getRowLength(row);
     int xPos = xStart;
-    if (row == QWERTY_ROW || row == ASDF_ROW) {
+    if (_layout->isWideRow(row)) {
       const int rowWidth = keyW * cols;
       xPos += (_width - rowWidth) / 2;
     }
@@ -473,7 +513,7 @@ void Keypad::layout(int x, int y, int w, int h) {
         const int numKeys = 2;
         keyWidth = (_width - ((cols - numKeys) * keyW)) / numKeys;
       } else if (key->_key._lower == K_SPACE) {
-        keyWidth = (SPACE_COLS * keyW);
+        keyWidth = (_layout->getSpaceCols() * keyW);
       }
       key->_x = xPos;
       key->_y = yPos;
@@ -491,7 +531,7 @@ int Keypad::layoutHeight(int screenHeight) {
   int charHeight = _context._charHeight;
   int maxHeight = static_cast<int>(screenHeight * MAX_HEIGHT_FACTOR);
   int padding = static_cast<int>(charHeight * PADDING_FACTOR);
-  int rows = _toolbar ? 1 : MAX_ROWS;
+  int rows = _toolbar ? 1 : _layout->getMaxRows();
   int height = rows * ((padding * 2) + charHeight);
   if (height > maxHeight) {
     // h = r(ch + 2p) -> p = (h - r * ch) / (r * 2)
diff --git a/src/ui/keypad.h b/src/ui/keypad.h
@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include <memory>
 #include "ui/strlib.h"
 #include "ui/inputs.h"
 #include "ui/image_codec.h"
@@ -100,6 +101,16 @@ struct Key {
   bool _printable;
 };
 
+struct KeypadLayout {
+  virtual ~KeypadLayout();
+  virtual RawKey getRawKey(int row, int col) const = 0;
+  virtual int getMaxRowLength() const = 0;
+  virtual int getMaxRows() const = 0;
+  virtual int getRowLength(int row) const = 0;
+  virtual int getSpaceCols() const = 0;
+  virtual bool isWideRow(int row) const = 0;
+};
+
 struct Keypad {
   Keypad(int charWidth, int charHeight, bool toolbar);
   ~Keypad() = default;
@@ -108,6 +119,7 @@ struct Keypad {
   void draw() const;
   void layout(int x, int y, int w, int h);
   int layoutHeight(int screenHeight);
+  void selectLayout();
 
 private:
   void generateKeys();
@@ -122,6 +134,7 @@ struct Keypad {
   strlib::List<Key *> _keys;
   KeypadTheme *_theme;
   KeypadDrawContext _context;
+  std::unique_ptr<KeypadLayout> _layout;
 };
 
 struct KeypadInput : public FormInput {
diff --git a/src/ui/textedit.cpp b/src/ui/textedit.cpp
