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

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

//! File-level symbol partitions.
//!
//! Stage 1 of the symbolique pipeline. Parsing a single source file produces:
//!
//! - **FileSymbols**: Index-only partition with `SymbolEntry` index entries
//!   pointing to shapes in the shared `Symbols` partition
//!
//! This stage is parallelizable across files.

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

/// File-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.
///
/// # Type Parameters
///
/// - `V`: Value type for literals
/// - `I`: Identifier type for names
/// - `P`: Symbol path type (used for index sort keys)
///
/// # Sort Key
///
/// Uses [`SymbolSortKey`] as the sort key. Sort keys are produced by
/// [`SymbolPath::sort_key`] and structured such that parent paths are
/// prefixes of child paths (for hierarchical queries to work).
#[derive(Hash)]
pub struct FileSymbols<V, I, P>(PhantomData<(V, I, P)>);

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

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

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

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

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

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

/// File-level symbol index partition.
///
/// Stores path-keyed index entries that link hierarchical paths to symbol
/// shapes. The path serves as the sort key, enabling `begins_with` queries
/// for scope traversal.
#[derive(Hash)]
pub struct FileSymbolIndex<V, I, P>(PhantomData<(V, I, P)>);

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

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

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

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

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

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

impl<V, I, P> Record for Symbol<V, I, P>
where
  V: Value<I>,
  I: Ident,
  P: SymbolPath,
{
  fn content_hash(&self) -> ContentHash {
    hash_record(self)
  }
}