rc-swag commented 2 weeks ago

Fixes: #10933 This change is to check the number of fonts found for the keyboard to guard against trying to index it when there are no fonts.

In the procedure FormatGrid check the font count if it is zero exit straight away.

          for i := 0 to grid.RowCount - 1 do
                 m := System.Math.Max(m, Canvas.TextWidth(FSelectedKeyboard.Fonts[i].FontName) + 6)

Update the procedure DisplayKeyboardFonts to let the user know that no fonts were found as a suggestion.

Note: This line in DisplayKeyboardFonts

grid.RowCount := FKeyboard.Fonts.Count;

grid.RowCount cannot be less than 1. Therefore if font count is 0 the row count value will be 1 after this assignment.

User Testing

TEST_KEYBOARD_WITH_FONTS

Install Keyman for Windows build artifact
Using Keyman Configuration install Simplified Chinese, Tamil 99 Basic, and Ahom Star keyboards
Start Keyman
From the language selector in the taskbar menu select Tamil_99
Right-click on the keyman icon to bring up the context menu and select the "Font Helper"
It should load some suggested fonts with the characters in a grid display
Exit the Font helper

TEST_KEYBOARD_WITHOUT_FONTS

Now select the cs_pinyin keyboard from the language selector in the taskbar menu
Right-click on the keyman icon to bring up the context menu and select the "Font Helper"
It should display the following message in the font helper window No fonts have been found as suggestions for Keyboard %1$s.

TEST_KEYBOARD_FONT_HELPER_SELECT_KEYBOARDS

From the language selector in the taskbar menu select a non keyman keyboard
Right-click on the keyman icon to bring up the context menu and select the "Font Helper"
From the font helper select keyboard cs_pinyin.
It should display the following message in the font helper window No fonts have been found as suggestions for Keyboard %1$s.
Now select Tamil_99
Observe the suggested fonts are loaded with the characters in a grid format.
Now Select Ahom Star
Observe the suggested fonts are loaded with the characters in a grid format or if not found the message No fonts have been found as suggestions for Keyboard %1$s. is displayed

keymanapp-test-bot[bot] commented 2 weeks ago

User Test Results

Test specification and instructions

✅ TEST_KEYBOARD_WITH_FONTS (PASSED): Tested with the attached PR build (keyman 17.0.312-beta-test-11282) on Windows 10 OS and here is my observation: 1. Installed Simplified Chinese, Tamil99 Basic and Ahom Star keyboards. 2. Started Keyman app. 3. Selected Tamil_99 from the language selector. 4. Right-clicked on the keyman icon to bring up the context menu. Selected the "Font Helper". Verified that it loads some suggested fonts with the characters in a grid display. Seems to be working as expected. (notes)
✅ TEST_KEYBOARD_WITHOUT_FONTS (PASSED): Retested as per Ross's suggestion and here is my observation: 1. Removed some installed languages from the Windows Language settings menu. 2. Downloaded and installed cs_pinyin keyboard from keyman site. 3. Select cs_pinyin keyboard from Keyman menu list. 4. Clicked the Font Helper window. Verified that it displays 'No fonts have found as suggestions for cs-pinyin". (notes)
✅ TEST_KEYBOARD_FONT_HELPER_SELECT_KEYBOARDS (PASSED): 1. Selected the non keyman keyboard. 2. Clicked the Font helper option. 3. From the font helper window, selected the cs_pinyin keyboard. Verified that the message displayed 'No fonts have been found as suggestions for keyboard'. 4. Then, selected Tami_99. Verified that the suggested fonts are loaded with the characters in a grid format. 5. Then, selected Ahom Star keyboard. Verified that the suggestion fonts are loaded with the characters in a grid format. Seems to be working as expected. (notes)