oak_folding/
lib.rs

1#![feature(new_range_api)]
2#![warn(missing_docs)]
3//! Code folding support for the Oak language framework.
4//!
5//! This crate provides traits and structures for identifying collapsible
6//! regions in source code, such as functions, comments, or imports.
7use core::range::Range;
8use oak_core::{language::Language, tree::RedNode};
9use serde::{Deserialize, Serialize};
10
11/// Enum of folding range kinds.
12#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
13#[serde(rename_all = "lowercase")]
14pub enum FoldingRangeKind {
15    /// A comment block.
16    Comment,
17    /// An import section.
18    Imports,
19    /// A custom defined region.
20    Region,
21}
22
23/// Represents a folding range in a document.
24#[derive(Debug, Clone, Serialize, Deserialize)]
25pub struct FoldingRange {
26    /// The span of the range to fold.
27    #[serde(with = "oak_core::serde_range", bound(serialize = "", deserialize = ""))]
28    pub range: Range<usize>,
29    /// The kind of folding range (e.g., 'comment', 'imports').
30    pub kind: Option<FoldingRangeKind>,
31}
32
33/// Trait for languages that support code folding.
34pub trait FoldingProvider<L: Language> {
35    /// Returns all folding ranges for the given document.
36    fn folding_ranges(&self, root: &RedNode<L>) -> Vec<FoldingRange> {
37        let _ = root;
38        Vec::new()
39    }
40}
oak_folding/lib.rs

oak_folding/
lib.rs
