Consider having a more friendly way to display errors and warnings

[pvdrz]

This is more of a proposal than a proper issue report.

I've considered using a crate like miette or annotate-snippets to build something similar to how rustc stores and emit diagnostic messages.

Some of the warning log entries that bindgen currently emits could be displayed as diagnostics for both the library and CLI and I think this would seriously improve the user experience. In particular when those diagnostics could include the actual c code that triggered it when possible.

Of course this would require some effort and I'd volunteer to do it myself if you consider this is worth it.

cc: @emilio @kulp @fitzgen @amanjeev

[amanjeev]

I am always up for improving ergonomics of error and warning reporting. I wonder if we can do some work to identify which major areas we need this? Then, it makes easier for us to see get a project roadmap, create issues for the work to be done etc.

[pvdrz]

Linking this to keep track of issues mentioning this topic: #1768 (comment)