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

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

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

pub struct DocumentFoldingRange;

impl PartitionKey for DocumentFoldingRange {
  const KEY: Ident = Ident::new("laburnum::document_folding_range");
}
/// To write folding ranges, create a wrapper partition with
/// [`impl_partition_for_dyn!`]:
///
/// ```rust,ignore
/// use laburnum::{impl_partition_for_dyn, partitions::DocumentFoldingRange};
///
/// // Your record type must implement FoldingRangeRecord + Record
/// impl_partition_for_dyn!(MyFoldingRangePartition, DocumentFoldingRange, MyRange);
///
/// // Then write using the wrapper partition
/// let sort_key = FoldingRangeSortKey::Range {
///   source_key, start_line, end_line, start_character, end_character
/// };
/// writer.write::<MyFoldingRangePartition>(sort_key, range.into());
/// ```
///
/// [`impl_partition_for_dyn!`]: crate::impl_partition_for_dyn
impl DynPartition for DocumentFoldingRange {
  type DynSortKey = FoldingRangeSortKey;
  type RecordConstraint = dyn FoldingRangeRecord;
}

impl<R: FoldingRangeRecord + crate::record::Record>
  crate::database::DynPartitionRecord<DocumentFoldingRange> for R
{
}

#[derive(Debug, Clone)]
pub enum FoldingRangeSortKey {
  Range {
    source_key:      SourceKey,
    start_line:      u32,
    end_line:        u32,
    start_character: u32,
    end_character:   u32,
  },
  All,
  FilePrefix {
    source_key: SourceKey,
  },
}

impl std::fmt::Display for FoldingRangeSortKey {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      | FoldingRangeSortKey::Range {
        source_key,
        start_line,
        end_line,
        start_character,
        end_character,
      } => {
        write!(
          f,
          "{}|{:010}|{:010}|{:010}|{:010}",
          source_key, start_line, end_line, start_character, end_character
        )
      },
      | FoldingRangeSortKey::All => Ok(()),
      | FoldingRangeSortKey::FilePrefix { source_key } => {
        write!(f, "{}", source_key)
      },
    }
  }
}

pub trait FoldingRangeRecord: Send + Sync + std::fmt::Debug {
  fn source_key(&self) -> SourceKey;

  fn to_folding_range(&self) -> FoldingRange;
}