Using `&` in the title for a function workflow activity results in the name being rendered wrong in quick settings

[WeiN76LQh]

Version and Platform (required):

• Binary Ninja Version: 5.3.8652-dev Ultimate (f6637a1a)
• Edition: Ultimate
• OS: macOS
• OS Version: 15.6
• CPU Architecture: M1

Bug Description:
In the JSON string thats provided when registering a function workflow activity, if the title string contains an & then in the right-click Function Settings menu in linear view, the name will be rendered wrong. For instance a title of Foo & Bar will be Foo _Bar in the function settings menu.

[bpotchik]

This is expected Qt behavior. Qt treats '&' in menu/action text as a mnemonic marker, so "Foo & Bar" becomes a shortcut and renders incorrectly. To show a literal ampersand, escape it as "Foo && Bar".

https://doc.qt.io/qt-6/qaction.html#details:~:text=Certain%20UI%20elements,a%20given%20shortcut.

[bdash]

The title is used both in the Function Settings menu (where the ampersand results in the surprising behavior that was reported here) and as the name of an auto setting that is created (where the ampersand is displayed literally).

AFAICT we don't document that this field is subject to being interpreted by Qt in this manner. The fact it is not consistently interpreted in that manner when used in different parts of the UI says to me that we should be escaping it before we use it as the label of the menu item so that it is not misinterpreted.

[bpotchik]

Good point, and '&' may not be the only issue. Qt may handle some other characters specially, so sanitizing the title before inserting it into the menu would prevent similar rendering issues.

[bpotchik]

Fixed in 5.3.8668-dev.