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

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

//! File-level symbol reader extension trait.
//!
//! This module provides [`SymboliqueReadExt`], for querying file-level symbols
//! from `QueryClient`.
//!
//! # Architecture (ADR0003)
//!
//! Queries go through the `FileSymbols` index to find `SymbolEntry` values,
//! then optionally follow the handle to retrieve the full `Symbol` shape from
//! the shared `Symbols` partition.
//!
//! ```text
//! query_client.file_symbol_at_path()
//!     │
//!     ├─► index_get::<FileSymbols>(sort_key) → SymbolEntry { span, handle }
//!     │
//!     └─► get::<Symbols>(handle.content_hash()) → Symbol shape
//! ```

use {
  crate::{
    core::{Ident, SymbolPath, Value},
    partitions::{file::FileSymbols, records::SymbolEntry, symbols::Symbols},
  },
  laburnum::database::{
    HasPartition, RecordRef,
    query::QueryClient,
    storage::Partitions,
  },
};

/// Extension trait for reading file-level symbols from partitions.
///
/// Provides typed methods for querying symbols written during the file parsing
/// stage. Methods query the `FileSymbols` index and optionally follow handles
/// to the shared `Symbols` partition.
pub trait SymboliqueReadExt<P: Partitions> {
  /// Look up a file-level symbol by exact sort key.
  ///
  /// Returns the index entry if found. Use `resolve_file_symbol` to follow
  /// the handle to the full symbol shape.
  fn file_symbol_at_path<V, I, Path>(
    &self,
    sort_key: &str,
  ) -> Option<SymbolEntry<V, I, Path>>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    P::Stores: HasPartition<FileSymbols<V, I, Path>>;

  /// Query file-level symbols with a sort key prefix.
  ///
  /// Returns all index entries whose sort key starts with `prefix`.
  fn file_symbols_with_prefix<V, I, Path>(
    &self,
    prefix: &str,
  ) -> Vec<(String, SymbolEntry<V, I, Path>)>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    P::Stores: HasPartition<FileSymbols<V, I, Path>>;

  /// Follow a symbol entry's handle to retrieve the full symbol shape.
  fn resolve_file_symbol<V, I, Path>(
    &self,
    entry: &SymbolEntry<V, I, Path>,
  ) -> Option<RecordRef<'_, Symbols<V, I, Path>>>
  where
    V: Value<I> + 'static,
    I: Ident,
    Path: SymbolPath + 'static,
    P::Stores: HasPartition<Symbols<V, I, Path>>;
}

impl<P: Partitions> SymboliqueReadExt<P> for QueryClient<P> {
  fn file_symbol_at_path<V, I, Path>(
    &self,
    sort_key: &str,
  ) -> Option<SymbolEntry<V, I, Path>>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    P::Stores: HasPartition<FileSymbols<V, I, Path>>,
  {
    self.index_get::<FileSymbols<V, I, Path>>(sort_key)
  }

  fn file_symbols_with_prefix<V, I, Path>(
    &self,
    prefix: &str,
  ) -> Vec<(String, SymbolEntry<V, I, Path>)>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    P::Stores: HasPartition<FileSymbols<V, I, Path>>,
  {
    self.index_range::<FileSymbols<V, I, Path>>(prefix)
  }

  fn resolve_file_symbol<V, I, Path>(
    &self,
    entry: &SymbolEntry<V, I, Path>,
  ) -> Option<RecordRef<'_, Symbols<V, I, Path>>>
  where
    V: Value<I> + 'static,
    I: Ident,
    Path: SymbolPath + 'static,
    P::Stores: HasPartition<Symbols<V, I, Path>>,
  {
    self.get::<Symbols<V, I, Path>>(entry.symbol.content_hash())
  }
}