Skip to content

Annotation is incorrectly offset when overly long source line that contains non-ASCII characters is elided #330

@fmease

Description

@fmease

For additional context: rust-lang/rust#132860.

Given the following setup:

use annotate_snippets::{AnnotationKind, Group, Level, Renderer, Snippet};

fn main() {
    /***** (A): ASCII only *****/
    // let source = "/*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/?";
    // let highlight = "?";

    /***** (B): non-ASCII prefix, ASCII highlight *****/
    // let source = "/*这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。*/?";
    // let highlight = "?";

    /***** (C): non-ASCII everything *****/
    // let source = "/*这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。*/好";
    // let highlight = "好";

    let start = source.find(&highlight).unwrap();
    let range = start..start + highlight.len();

    let group = Group::with_level(Level::ERROR).element(
        Snippet::source(source).annotation(AnnotationKind::Primary.span(range).label("label")),
    );
    eprintln!("{}", Renderer::styled().render(&[group]));
}

Case (A): The annotation / highlight / underline / caret is correctly placed below the ?:

  |
1 | ...aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/?
  |                                                                 ^ label

Case (B): The annotation / … / caret is incorrectly offset by +1 (points one past the ?):

  |
1 | ... 是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。*/?
  |                                                                  ^ label

Case (C): Similarly offset by +1 (1st ^ points at the 2nd half of , 2nd ^ points into nothingness):

  |
1 | ... 是宽的。这是宽的。这是宽的。这是宽的。这是宽的。这是宽的。*/好
  |                                                                  ^^ label

Important

Your browser probably renders these labeled annotations "way off". If so, that's only because it renders the Hanzi characters with a "width" of <2 (however, it probably also depends on your system fonts) whereas terminal emulators conventionally render Hanzi characters using two "blocks".

So, here's a screenshot of my terminal output to further clarify that it's a +1 offset only:

Image

Again, if your browser renders is like in the image below, don't be misled, only the terminal emulator's output matters!

Click to expand image of my browser Image

Meta

I'm using annotate-snippets v0.11.5, git revision 74964e9 (i.e., latest master at the time of writing).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions