pedant-core 0.20.1

Analysis engine for pedant: IR extraction, style checks, and capability detection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Verification of unit source sets and source bytes.

use super::prelude::*;
use super::{
    SemanticSnapshotClaim, SemanticSnapshotMismatch, SemanticSourceClaim, SemanticUnitClaim,
    VerifiedSource, VerifiedUnit,
};

/// Every unit's module closure in the database must be the claimed source set.
pub(super) fn verify_units(
    context: &SemanticContext,
    claim: &SemanticSnapshotClaim,
    crates: &[Crate],
) -> Result<Box<[VerifiedUnit]>, SemanticSnapshotMismatch> {
    claim
        .units
        .iter()
        .zip(crates)
        .map(|(unit, krate)| verify_unit(context, unit, *krate))
        .collect()
}

fn verify_unit(
    context: &SemanticContext,
    unit: &SemanticUnitClaim,
    krate: Crate,
) -> Result<VerifiedUnit, SemanticSnapshotMismatch> {
    let owned = module_sources(context, krate);
    let held: BTreeSet<&str> = owned.iter().map(|path| &**path).collect();
    let claimed: BTreeSet<&str> = unit.sources.iter().map(|path| &**path).collect();
    let disagreement = claimed
        .symmetric_difference(&held)
        .next()
        .map(|path| Box::<str>::from(*path));
    match disagreement {
        Some(detail) => Err(SemanticSnapshotMismatch::PathSet {
            name: Box::from(&*unit.name),
            detail,
        }),
        None => Ok(VerifiedUnit {
            krate,
            sources: unit
                .sources
                .iter()
                .map(|path| VerifiedSource {
                    path: Arc::clone(path),
                    absolute: context.absolute(path),
                })
                .collect(),
        }),
    }
}

/// Every repository-relative source the database's module tree gives a crate.
fn module_sources(context: &SemanticContext, krate: Crate) -> BTreeSet<Box<str>> {
    let db = context.host.raw_database();
    krate
        .modules(db)
        .into_iter()
        .filter_map(|module| module.definition_source_file_id(db).file_id())
        .map(|file| file.file_id(db))
        .filter_map(|file| context.relative_path(file))
        .collect()
}

/// Every claimed source must hold the exact snapshotted bytes.
pub(super) fn check_digests(
    context: &SemanticContext,
    claim: &SemanticSnapshotClaim,
) -> Result<(), SemanticSnapshotMismatch> {
    let analysis = context.host.analysis();
    for source in &claim.sources {
        check_digest(context, &analysis, source)?;
    }
    Ok(())
}

/// One claimed source must hold the exact snapshotted bytes.
///
/// A source the database does not hold, and a source it will not hand over,
/// are each named for what they are: neither is a claim that the database
/// holds other bytes.
fn check_digest(
    context: &SemanticContext,
    analysis: &Analysis,
    source: &SemanticSourceClaim,
) -> Result<(), SemanticSnapshotMismatch> {
    let Some(file) = context.file_id(&context.absolute(&source.path)) else {
        return Err(SemanticSnapshotMismatch::SourceAbsent {
            path: Box::from(&*source.path),
        });
    };
    let Ok(text) = analysis.file_text(file) else {
        return Err(SemanticSnapshotMismatch::SourceUnreadable {
            path: Box::from(&*source.path),
        });
    };
    match crate::hash::digest_bytes(text.as_bytes()) == source.digest {
        true => Ok(()),
        false => Err(SemanticSnapshotMismatch::SourceDigest {
            path: Box::from(&*source.path),
        }),
    }
}