onoma 0.0.13

A fast, language-agnostic semantic symbol indexer and typo-resistant fuzzy finder, enabling real-time search across virtually unlimited code symbols without the need for language servers.
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

use std::hash::Hash;

use crate::models::{self, parsed::SymbolRole};

/// A symbol which has been parsed out of a source file.
///
/// Generally speaking, parsing will have likely happened through a parser
/// ([`crate::parser`]).
#[derive(Debug, Eq, PartialOrd, Ord)]
pub struct Symbol {
    /// The kind of symbol.
    pub kind: models::parsed::SymbolKind,

    /// The name of the symbol.
    ///
    /// Exactly what the name is will depend on what kind of symbol it is.
    pub name: String,

    /// The occurrence of the definition of this symbol in the source files.
    pub definition: Option<models::parsed::Occurrence>,

    /// The occurrences in different source files of this symbol.
    pub occurrences: Vec<models::parsed::Occurrence>,
}

impl Symbol {
    /// Create a new symbol, of a particular kind.
    ///
    /// This symbol will not yet have any occurrences.
    #[must_use]
    pub fn new(kind: models::parsed::SymbolKind, name: &str) -> Self {
        Self {
            kind,
            name: name.to_string(),
            occurrences: Vec::default(),
            definition: None,
        }
    }

    /// Append one of more occurrences from different source files of the symbol.
    pub fn add_occurrence(&mut self, occurrence: models::parsed::Occurrence) {
        if self.definition.is_none() && occurrence.roles.contains(&SymbolRole::Definition) {
            let _ = self.definition.insert(occurrence);

            return;
        }

        self.occurrences.push(occurrence);
    }
}

impl Hash for Symbol {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        // Don't check the symbol kind here, as its possible we'll see duplicate symbols of
        // different kinds (i.e. method vs function)

        self.name.hash(state);

        if let Some(definition) = &self.definition {
            definition.hash(state);
        } else {
            self.occurrences.hash(state);
        }
    }
}

impl PartialEq for Symbol {
    fn eq(&self, other: &Self) -> bool {
        // Don't check the symbol kind here, as its possible we'll see duplicate symbols of
        // different kinds (i.e. method vs function)

        if let Some(self_definition) = &self.definition
            && let Some(other_definition) = &other.definition
        {
            self.name == other.name && self_definition == other_definition
        } else {
            self.name == other.name && self.occurrences == other.occurrences
        }
    }
}