symbolique 0.1.1

Symbol table pipeline for language servers — parse, link, merge, and resolve symbols across files, built on the laburnum LSP framework.
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

// Copyright Two Neutron Stars Incorporated and contributors
// SPDX-License-Identifier: BlueOak-1.0.0

//! Merged-level symbol partitions.
//!
//! Stage 3 of the symbolique pipeline. Merging combines symbols from multiple
//! files into a single workspace-wide symbol table:
//!
//! - **MergedSymbols**: Index-only partition with `SymbolEntry` index entries
//!   pointing to shapes in the shared `Symbols` partition

use {
  super::records::SymbolEntry,
  crate::core::{
    Ident, SymbolPath, SymbolVisibility, Value, Visibility,
  },
  laburnum::{
    Ident as LaburnumIdent,
    database::{Partition, PartitionKey},
  },
  std::{hash::Hash, marker::PhantomData},
};

/// Merged-level symbol index partition (index-only).
///
/// Stores only index entries that reference shapes in the shared `Symbols`
/// partition. Each entry contains a span and a handle to the symbol shape.
#[derive(Hash)]
pub struct MergedSymbols<V, I, P, S = SymbolVisibility>(
  PhantomData<(V, I, P, S)>,
);

impl<V, I, P, S> Default for MergedSymbols<V, I, P, S> {
  fn default() -> Self {
    Self(PhantomData)
  }
}

impl<V, I, P, S> Clone for MergedSymbols<V, I, P, S> {
  fn clone(&self) -> Self {
    *self
  }
}

impl<V, I, P, S> Copy for MergedSymbols<V, I, P, S> {}

impl<V, I, P, S> std::fmt::Debug for MergedSymbols<V, I, P, S> {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    f.debug_struct("MergedSymbols").finish()
  }
}

impl<V, I, P, S> PartitionKey for MergedSymbols<V, I, P, S>
where
  V: Value<I>,
  I: Ident,
  P: SymbolPath,
  S: Visibility,
{
  const KEY: LaburnumIdent = LaburnumIdent::new("symbolique::merged_symbols");
}

impl<V, I, P, S> Partition for MergedSymbols<V, I, P, S>
where
  V: Value<I>,
  I: Ident,
  P: SymbolPath,
  S: Visibility,
{
  type Record = (); // Index-only
  type IndexEntry = SymbolEntry<V, I, P, S>;
  type SortKey = P;
}

/// Merged-level symbol index partition.
#[derive(Hash)]
pub struct MergedSymbolIndex<V, I, P, S = SymbolVisibility>(
  PhantomData<(V, I, P, S)>,
);

impl<V, I, P, S> Default for MergedSymbolIndex<V, I, P, S> {
  fn default() -> Self {
    Self(PhantomData)
  }
}

impl<V, I, P, S> Clone for MergedSymbolIndex<V, I, P, S> {
  fn clone(&self) -> Self {
    *self
  }
}

impl<V, I, P, S> Copy for MergedSymbolIndex<V, I, P, S> {}

impl<V, I, P, S> std::fmt::Debug for MergedSymbolIndex<V, I, P, S> {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    f.debug_struct("MergedSymbolIndex").finish()
  }
}

impl<V, I, P, S> PartitionKey for MergedSymbolIndex<V, I, P, S>
where
  V: Value<I>,
  I: Ident,
  P: SymbolPath,
  S: Visibility,
{
  const KEY: LaburnumIdent =
    LaburnumIdent::new("symbolique::merged_symbol_index");
}

impl<V, I, P, S> Partition for MergedSymbolIndex<V, I, P, S>
where
  V: Value<I>,
  I: Ident,
  P: SymbolPath,
  S: Visibility,
{
  type Record = (); // Index-only
  type IndexEntry = SymbolEntry<V, I, P, S>;
  type SortKey = P;
}

#[cfg(test)]
mod tests {
  use super::*;

  #[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
  struct TestPath(String);

  impl laburnum::PartitionSortKey for TestPath {
    fn is_prefix_of(&self, other: &Self) -> bool {
      other.0.starts_with(&self.0)
    }

    fn resolve(&self, _resolver: &dyn laburnum::SourceResolver) -> String {
      self.0.clone()
    }
  }

  #[test]
  fn merged_symbols_partition_key() {
    use crate::core::{DefaultValue, StringIdent};

    let key = MergedSymbols::<DefaultValue, StringIdent, TestPath>::KEY;
    let key2 = MergedSymbolIndex::<DefaultValue, StringIdent, TestPath>::KEY;
    assert_ne!(key, key2);
  }

  #[test]
  fn merged_symbols_is_index_only() {
    use crate::core::{DefaultValue, StringIdent};

    fn assert_record_is_unit<P: Partition<Record = ()>>() {}

    assert_record_is_unit::<MergedSymbols<DefaultValue, StringIdent, TestPath>>(
    );
  }
}