Skip to content

Include default text examples in the "C Syntax" dialog #3256

@plafosse

Description

@plafosse

Leaving the old description but summarizing a more concise list of features we'd still like to add (some have already been addressed):

  • Link to documentation for the types (which includes the additional expressions beyond standard C)
  • Include default text in the "C Syntax" dialog (default text that disappears as soon as any manual text is entered)
  • Clarify the default base for the structure size dialog is hexadecimal (tracked now in Inconsistent hex/integer input boxes #5836)

Current problem is that its not super intuitive how to add new structures to the TypeView. You have to select one of the following menu items:
image
Its not clear that one of these is for creating types with C syntax and the others will create a type of a given size.
Its also not clear how to create an enumeration.

Additionally once the "Create Types" is selected it prompts you with an empty box and tells you C Syntax which though descriptive isn't exactly helpful.

Here are a number of suggestions on how to remedy:

  1. Combine the "Create Types" and "Create Structure/Union" dialogs
  2. The default text in the "C Syntax" should provide examples.
  3. There needs to be some indicator that what is being parsed is more expressive than C and what those expressions are
  • __offset, __packed, ` escaping, emoji, etc
  1. Perhaps a sidebar with links to additional documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Component: UIIssue needs changes to the user interfaceEffort: MediumIssues require < 1 month of workImpact: MediumIssue is impactful with a bad, or no, workaround

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions