cairo-lang-filesystem 2.18.0

Virtual filesystem for the compiler.
Documentation
use cairo_lang_utils::Intern;

use super::TextOffset;
use crate::ids::{FileId, FileKind, FileLongId, SmolStrId, VirtualFile};
use crate::span::{TextPosition, TextWidth};
use crate::test_utils::FilesDatabaseForTesting;

const TEST_STRING: &str = "01\n23\u{1230}\r\n456\n\n\r\n789";

fn test_db() -> FilesDatabaseForTesting {
    FilesDatabaseForTesting::default()
}

fn test_file<'db>(db: &'db FilesDatabaseForTesting) -> FileId<'db> {
    FileLongId::Virtual(VirtualFile {
        parent: None,
        name: SmolStrId::from(db, "name"),
        content: SmolStrId::from(db, TEST_STRING),
        code_mappings: [].into(),
        kind: FileKind::Module,
        original_item_removed: false,
    })
    .intern(db)
}

#[test]
fn test_span() {
    let db = test_db();
    let file = test_file(&db);
    assert_eq!(
        TextOffset(TextWidth(0)).position_in_file(&db, file),
        Some(TextPosition { line: 0, col: 0 })
    );
    assert_eq!(
        TextOffset(TextWidth(1)).position_in_file(&db, file),
        Some(TextPosition { line: 0, col: 1 })
    );
    assert_eq!(
        TextOffset(TextWidth(2)).position_in_file(&db, file),
        Some(TextPosition { line: 0, col: 2 })
    );
    assert_eq!(
        TextOffset(TextWidth(3)).position_in_file(&db, file),
        Some(TextPosition { line: 1, col: 0 })
    );
    // Offsets 6,7 are inside a unicode char.
    assert_eq!(
        TextOffset(TextWidth(8)).position_in_file(&db, file),
        Some(TextPosition { line: 1, col: 3 })
    );
    assert_eq!(
        TextOffset(TextWidth(9)).position_in_file(&db, file),
        Some(TextPosition { line: 1, col: 4 })
    );
    assert_eq!(
        TextOffset(TextWidth(10)).position_in_file(&db, file),
        Some(TextPosition { line: 2, col: 0 })
    );
    assert_eq!(
        TextOffset(TextWidth(14)).position_in_file(&db, file),
        Some(TextPosition { line: 3, col: 0 })
    );
    assert_eq!(
        TextOffset(TextWidth(15)).position_in_file(&db, file),
        Some(TextPosition { line: 4, col: 0 })
    );
    assert_eq!(
        TextOffset(TextWidth(16)).position_in_file(&db, file),
        Some(TextPosition { line: 4, col: 1 })
    );
    assert_eq!(
        TextOffset(TextWidth(17)).position_in_file(&db, file),
        Some(TextPosition { line: 5, col: 0 })
    );
    assert_eq!(
        TextOffset(TextWidth(19)).position_in_file(&db, file),
        Some(TextPosition { line: 5, col: 2 })
    );
    assert_eq!(
        TextOffset(TextWidth(20)).position_in_file(&db, file),
        Some(TextPosition { line: 5, col: 3 })
    );
}

#[test]
#[should_panic(expected = "TextOffset out of range. TextWidth(21) > TextWidth(20).")]
fn should_panic_test_span_out_of_range() {
    let db = test_db();
    let file = test_file(&db);
    TextOffset(TextWidth(TEST_STRING.len() as u32 + 1)).position_in_file(&db, file);
}

#[test]
fn test_position_offset_in_file() {
    let db = test_db();
    let file = test_file(&db);
    // Happy cases.
    assert_eq!(
        TextPosition { line: 0, col: 0 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(0)))
    );
    assert_eq!(
        TextPosition { line: 0, col: 1 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(1)))
    );
    assert_eq!(
        TextPosition { line: 0, col: 2 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(2)))
    );
    assert_eq!(
        TextPosition { line: 1, col: 0 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(3)))
    );
    // `col` larger than the line length should clamp.
    assert_eq!(
        TextPosition { line: 0, col: 3 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(2)))
    );
    assert_eq!(
        TextPosition { line: 3, col: usize::MAX }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(14)))
    );
    // `line` larger than the line count should clamp.
    assert_eq!(
        TextPosition { line: 6, col: 0 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(TEST_STRING.len() as u32)))
    );
    assert_eq!(
        TextPosition { line: usize::MAX, col: 0 }.offset_in_file(&db, file),
        Some(TextOffset(TextWidth(TEST_STRING.len() as u32)))
    );
}