symbolique 0.1.0

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

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

//! Linked-level symbol partitions.
//!
//! Stage 2 of the symbolique pipeline. Linking adds import bindings to a
//! file's symbols:
//!
//! - **LinkedSymbols**: Index-only partition with `SymbolEntry` index entries
//!   pointing to shapes in the shared `Symbols` partition
//!
//! Imports are file-scoped: each file has its own set of imports.

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

/// Linked-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 LinkedSymbols<V, I, P>(PhantomData<(V, I, P)>);

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

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

impl<V, I, P> Copy for LinkedSymbols<V, I, P> {}

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

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

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

/// Linked-level symbol index partition.
#[derive(Hash)]
pub struct LinkedSymbolIndex<V, I, P>(PhantomData<(V, I, P)>);

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

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

impl<V, I, P> Copy for LinkedSymbolIndex<V, I, P> {}

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

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

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

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

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

  impl crate::core::SymbolPath for TestPath {
    fn sort_key(&self) -> String {
      self.0.clone()
    }
  }

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

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

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

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

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