Better error handling

[robamu]

Just a small attempt to make svd2rust print more useful information if something goes wrong in the TokenStream generation, or in general

• More debug output in case something goes wrong in the TokenStream generation
• Some info output in the main

I like how the svd XML parser handles errors by passing an Error Enum with a node ID up which can be used by one central error handler to print diagnostic information. I don't think it can be done like that here, so I simply print out some locally available information (peripheral name, register name etc.) as the error is propagated

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @burrbull (or someone else) soon.

Please see the contribution instructions for more information.

[Emilgardis]

nicely done! Some suggestions.

Tracing would be nice to have, but not necessary to implement right now

[burrbull]

Instead of log::error! it is enough to use anyhow::with_context here

[Emilgardis]

Instead of log::error! it is enough to use anyhow::with_context here

Indeed, however some of these functions return syn::Error, so those would have to be changed as well, but that would bring some better usability like with_context 👍

[robamu]

I integrated most suggestions. Sample output on failure:

[INFO  svd2rust] Parsing device from SVD file
[INFO  svd2rust] Rendering devices
[ERROR svd2rust] Error rendering devices
    
    Caused by:
        0: Rendering error at peripheral IRQSEL
           Description: Interrupt Selector Peripheral
           Group: No group name
        1: Issue expanding register or cluster block
        2: Error expanding register
           Name: PORTA[%s]
           Description: PORTA Interrupt Redirect Selection
        3: syn error occured
        4: Error converting info name PORTA[%s]
        5: Determining syn::TypePath from ident "crate::Reg<porta%s::PORTA%S_SPEC>" failed
        6: expected `,`

[burrbull]

Looks good!

[robamu]

I'm tweaking the output a bit:

[INFO  svd2rust] Parsing device from SVD file
[INFO  svd2rust] Rendering devices
[ERROR svd2rust] Error rendering devices
    
    Caused by:
        0: Rendering error at peripheral
           Name: IRQSEL
           Description: Interrupt Selector Peripheral
           Group: No group name
        1: Issue expanding register or cluster block
        2: Error expanding register
           Name: PORTA[%s]
           Description: PORTA Interrupt Redirect Selection
        3: syn error occured
        4: Error converting info name PORTA[%s]
        5: Determining syn::TypePath from ident "crate::Reg<porta%s::PORTA%S_SPEC>" failed
        6: expected `,`

[robamu]

I think its always just one device which is parsed so I might tweak that output too

[burrbull]

Squash commits, please.

[robamu]

I'll run rustfmt and clippy and then squash again

[Emilgardis]

Lgtm! Thank you!

bors r+

[Emilgardis]

bors r-

Sorry, minor nit

[bors]

Canceled.

fixed

[burrbull]

bors r+

[bors]

Build succeeded:

• CI