laburnum 1.17.1

An LSP framework for building language servers and compilers, powered by an incremental query tree with content-addressed storage, task-based dataflow, and parallel queries.
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
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

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

use crate::{
  Ident,
  SourceKey,
  database::{
    DynPartition,
    PartitionKey,
  },
  protocol::lsp::SymbolKind,
};

pub struct DocumentSymbols;

impl PartitionKey for DocumentSymbols {
  const KEY: Ident = Ident::new("laburnum::document_symbols");
}
/// To write document symbols, create a wrapper partition with
/// [`impl_partition_for_dyn!`]:
///
/// ```rust,ignore
/// use laburnum::{impl_partition_for_dyn, partitions::DocumentSymbols};
///
/// // Your record type must implement DocumentSymbolRecord + Record
/// impl_partition_for_dyn!(MyDocumentSymbolsPartition, DocumentSymbols, MySymbol);
///
/// // Then write using the wrapper partition
/// let sort_key = DocumentSymbolSortKey::Symbol { source_key, symbol_kind, ident };
/// writer.write::<MyDocumentSymbolsPartition>(sort_key, symbol.into());
/// ```
///
/// [`impl_partition_for_dyn!`]: crate::impl_partition_for_dyn
impl DynPartition for DocumentSymbols {
  type DynSortKey = DocumentSymbolSortKey;
  type RecordConstraint = dyn DocumentSymbolRecord;
}

impl<R: DocumentSymbolRecord + crate::record::Record>
  crate::database::DynPartitionRecord<DocumentSymbols> for R
{
}

#[derive(Debug, Clone)]
pub enum DocumentSymbolSortKey {
  Symbol {
    source_key:  SourceKey,
    symbol_kind: SymbolKind,
    ident:       Ident,
  },
  All,
  FilePrefix {
    source_key: SourceKey,
  },
}

impl std::fmt::Display for DocumentSymbolSortKey {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      | DocumentSymbolSortKey::Symbol {
        source_key,
        symbol_kind,
        ident,
      } => write!(f, "{}|{}|{}", source_key, symbol_kind, ident),
      | DocumentSymbolSortKey::All => Ok(()),
      | DocumentSymbolSortKey::FilePrefix { source_key } => {
        write!(f, "{}", source_key)
      },
    }
  }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SymbolKindVariant {
  Symbol,
  Reference,
}

pub trait DocumentSymbolRecord: Send + Sync + std::fmt::Debug {
  fn get_ident(&self) -> Ident;

  fn get_ident_path(&self) -> Vec<Ident>;

  fn get_ident_range(&self) -> crate::protocol::lsp::Range;

  fn source_key(&self) -> SourceKey;

  fn span(&self) -> crate::source::Span;

  fn symbol_kind(&self) -> SymbolKind;

  fn target_source_key(&self) -> Option<SourceKey> {
    None
  }

  fn symbol_kind_variant(&self) -> SymbolKindVariant {
    SymbolKindVariant::Symbol
  }

  fn to_document_symbol(
    &self,
    source_cache: &crate::source::cache::reporter::SourceCacheReader,
    encoding: &crate::protocol::lsp::PositionEncodingKind,
  ) -> crate::protocol::lsp::DocumentSymbol;

  fn definition_location(
    &self,
    _source_cache: &crate::source::cache::reporter::SourceCacheReader,
    _encoding: &crate::protocol::lsp::PositionEncodingKind,
  ) -> Option<crate::protocol::lsp::Location> {
    None
  }

  fn hover_info(
    &self,
    _source_cache: &crate::source::cache::reporter::SourceCacheReader,
    _encoding: &crate::protocol::lsp::PositionEncodingKind,
  ) -> Option<crate::protocol::lsp::Hover> {
    None
  }

  fn rename_range(
    &self,
    _source_cache: &crate::source::cache::reporter::SourceCacheReader,
    _encoding: &crate::protocol::lsp::PositionEncodingKind,
  ) -> Option<crate::protocol::lsp::Range> {
    None
  }
}