backhopper-xref-reader 0.32.0

Erlang source to call-graph reader for backhopper-xref
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

// Copyright (C) 2026 Michael S. Klishin and Contributors
// SPDX-License-Identifier: Apache-2.0 OR MIT
// See LICENSE-APACHE and LICENSE-MIT for details.

//! `ModuleData`, `CallSite`, and `ReadOutput` aggregate types.

use std::collections::{BTreeMap, BTreeSet};

use backhopper_core::{BehaviourName, Mfa, ModuleName};
use backhopper_xref_graph::{
    CallKind, CallTarget, Deprecation, FunctionSig, Loc, PathInterner, UnresolvedCallSite,
};

use crate::application::ApplicationAssignment;
use crate::errors::ReadWarning;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CallSite {
    pub caller: FunctionSig,
    pub callee: CallTarget,
    pub kind: CallKind,
    pub loc: Loc,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ModuleData {
    pub module: ModuleName,
    pub application: ApplicationAssignment,

    pub exports: BTreeSet<FunctionSig>,
    pub locals: BTreeSet<FunctionSig>,
    pub external_calls: Vec<CallSite>,
    pub local_calls: Vec<CallSite>,
    pub unresolved: BTreeSet<UnresolvedCallSite>,

    pub on_load: Option<FunctionSig>,
    pub deprecated: BTreeMap<FunctionSig, Deprecation>,

    pub behaviours: BTreeSet<BehaviourName>,
    pub callbacks: BTreeSet<FunctionSig>,
    pub optional_callbacks: BTreeSet<FunctionSig>,

    pub imports: BTreeMap<ModuleName, BTreeSet<FunctionSig>>,
    pub definitions: BTreeMap<FunctionSig, Loc>,
}

impl ModuleData {
    pub fn function_mfa(&self, sig: &FunctionSig) -> Mfa {
        Mfa {
            module: self.module.clone(),
            function: sig.name.clone(),
            arity: sig.arity,
        }
    }
}

#[derive(Debug, Clone, Default)]
pub struct ReadOutput {
    pub modules: Vec<ModuleData>,
    pub warnings: Vec<ReadWarning>,
    pub paths: PathInterner,
}