cairo-lang-filesystem 2.18.0

Virtual filesystem for the compiler.
Documentation
use cairo_lang_test_utils::test;
use cairo_lang_utils::Intern;
use indoc::indoc;
use pretty_assertions::assert_eq;

use crate::db::FilesGroup;
use crate::ids::{FileKind, FileLongId, SmolStrId, SpanInFile, VirtualFile};
use crate::location_marks::get_location_marks;
use crate::span::{TextSpan, TextWidth};
use crate::test_utils::FilesDatabaseForTesting;

#[test]
fn test_location_marks() {
    let content = indoc! {"
        First liné,
        Second liné.
        Third liné."};
    // Note that content does not end with '\n'.

    let db = FilesDatabaseForTesting::default();
    let file = FileLongId::Virtual(VirtualFile {
        parent: None,
        name: SmolStrId::from(&db, "name"),
        content: SmolStrId::from(&db, content),
        code_mappings: [].into(),
        kind: FileKind::Module,
        original_item_removed: false,
    })
    .intern(&db);
    let summary = db.file_summary(file).unwrap();
    let second_line = summary.line_offsets[1];
    let third_line = summary.line_offsets[2];

    // Empty span.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::cursor(second_line.add_width(TextWidth::new_for_testing(13))),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Second liné.
                        ^
        "}
    );

    // Span of length 1.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::new(
            third_line.add_width(TextWidth::new_for_testing(3)),
            third_line.add_width(TextWidth::new_for_testing(4)),
        ),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Third liné.
               ^
        "}
    );

    // Span of length 2.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::new(
            third_line.add_width(TextWidth::new_for_testing(3)),
            third_line.add_width(TextWidth::new_for_testing(5)),
        ),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Third liné.
               ^^
        "}
    );

    // Span of length > 1.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::new(
            second_line.add_width(TextWidth::new_for_testing(7)),
            second_line.add_width(TextWidth::new_for_testing(12)),
        ),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Second liné.
                   ^^^^
        "}
    );

    // Multiline span.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::new(
            second_line.add_width(TextWidth::new_for_testing(7)),
            third_line.add_width(TextWidth::new_for_testing(2)),
        ),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
              Second liné.
             ________^
            | Third liné.
            |__^
        "}
    );

    // Span that ends past the end of the file.
    let location = SpanInFile {
        file_id: file,
        span: TextSpan::new(
            third_line.add_width(TextWidth::new_for_testing(7)),
            summary.last_offset.add_width(TextWidth::from_char('\n')),
        ),
    };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Third liné.
                   ^^^^
        "}
    );

    // Empty span past the end of the file.
    let location = SpanInFile { file_id: file, span: TextSpan::cursor(summary.last_offset) };

    assert_eq!(
        get_location_marks(&db, &location, true) + "\n",
        indoc! {"
            Third liné.
                       ^
        "}
    );
}