qmk/qmk_firmware

[Bug] UCIS input not cleared after resolving mnemonic

Open

#22,438 opened on Nov 10, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

After resolving a unicode mnemonic, successfully or not, the input buffer should be cleared. In the current code the old input is kept in the buffer, potentially leading to incorrect resolution of future inputs.

Ex. enter the mnemonic "alpha", input is now "alpha". If you then enter the mnemonic "beta", input contains "betaa", which is incorrect.

I suggest using memset to zero out the input buffer at the end of ucis_finish.

Am I missing something important?

Keyboard Used

No response

Link to product page (if applicable)

No response

Operating System

No response

qmk doctor Output

No response

Is AutoHotKey / Karabiner installed

  • AutoHotKey (Windows)
  • Karabiner (macOS)

Other keyboard-related software installed

No response

Additional Context

No response

Contributor guide

Research direction
Examine the ucis finish function in the QMK codebase to understand the current behavior. Add a memset to clear the input buffer after mnemonic resolution. Ensure no other parts of the code rely on the buffer being preserved. Test with multiple mnemonics in sequence.
Tech stack
c
Domain
embedded iot
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CGitQMK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70