only-semantic 0.3.0

Semantic analysis for the only task language.
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

use smol_str::SmolStr;
use text_size::TextRange;

use crate::SemanticSnapshot;

/// Kind of document symbol produced for editor consumers.
///
/// Args:
/// None.
///
/// Returns:
/// Stable symbol categories for namespace and task items.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DocumentSymbolKind {
    Namespace,
    Task,
}

/// Flat document symbol entry for editor consumers.
///
/// Args:
/// None.
///
/// Returns:
/// Symbol name, container and text range for one source item.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DocumentSymbol {
    pub name: SmolStr,
    pub detail: Option<SmolStr>,
    pub kind: DocumentSymbolKind,
    pub range: TextRange,
    pub container_name: Option<SmolStr>,
}

/// Builds flat document symbols from one semantic snapshot.
///
/// Args:
/// snapshot: Immutable semantic snapshot for one document version.
///
/// Returns:
/// Flat symbol list for namespaces and tasks in source order.
pub fn document_symbols(snapshot: &SemanticSnapshot) -> Vec<DocumentSymbol> {
    let namespaces = snapshot
        .document
        .namespaces
        .iter()
        .map(|namespace| DocumentSymbol {
            name: namespace.name.clone(),
            detail: namespace.doc.clone(),
            kind: DocumentSymbolKind::Namespace,
            range: namespace.range,
            container_name: None,
        });

    let tasks = snapshot.document.tasks.iter().map(|task| DocumentSymbol {
        name: task.name.clone(),
        detail: Some(task.signature()),
        kind: DocumentSymbolKind::Task,
        range: task.range,
        container_name: task.namespace.clone(),
    });

    namespaces.chain(tasks).collect()
}