wdl-ast 0.26.1

An abstract syntax tree for Workflow Description Language (WDL) documents
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

//! Provides rich documentation for WDL definitions used by LSP hovers and
//! completions.
//!
//! TODO: This functionality can be shared with `wdl-doc` ? It might make
//! sense to fold this into wdl-analysis maybe?

use std::fmt;

use crate::AstToken;
use crate::TreeNode;
use crate::v1::MetadataArray;
use crate::v1::MetadataObjectItem;
use crate::v1::MetadataValue;
use crate::v1::ParameterMetadataSection;

/// Formats a metadata value.
pub fn format_meta_value<N: TreeNode>(
    f: &mut impl fmt::Write,
    value: &MetadataValue<N>,
    indent: usize,
) -> fmt::Result {
    let prefix = " ".repeat(indent);
    match value {
        MetadataValue::Boolean(b) => writeln!(f, "{prefix}- `{}`", b.value()),
        MetadataValue::Integer(i) => writeln!(f, "{prefix}- `{}`", i.value().unwrap_or(0)),
        MetadataValue::Float(fl) => {
            writeln!(f, "{prefix}- `{}`", fl.value().unwrap_or(0.0))
        }
        MetadataValue::String(s) => {
            if let Some(text) = s.text() {
                writeln!(f, "{prefix}- `{}`", text.text())?
            }
            Ok(())
        }
        MetadataValue::Null(_) => writeln!(f, "{prefix}- `null`"),
        MetadataValue::Object(obj) => write_meta_object(f, obj.items(), indent),
        MetadataValue::Array(arr) => write_meta_array(f, arr, indent),
    }
}

/// Formats a metadata object.
pub fn write_meta_object<N: TreeNode, Items: Iterator<Item = MetadataObjectItem<N>>>(
    f: &mut impl fmt::Write,
    items: Items,
    indent: usize,
) -> fmt::Result {
    let prefix = " ".repeat(indent);
    for item in items {
        write!(f, "{prefix}- **{}**", item.name().text())?;
        format_meta_value(f, &item.value(), indent + 2)?;
    }
    Ok(())
}

/// Formats a metadata array.
fn write_meta_array<N: TreeNode>(
    f: &mut impl fmt::Write,
    arr: &MetadataArray<N>,
    indent: usize,
) -> fmt::Result {
    for value in arr.elements() {
        format_meta_value(f, &value, indent)?;
    }
    Ok(())
}

/// Gets the entire metadata value for a given parameter name.
pub fn get_param_meta<N: TreeNode>(
    name: &str,
    param_meta: Option<&ParameterMetadataSection<N>>,
) -> Option<MetadataValue<N>> {
    param_meta
        .and_then(|pm| pm.items().find(|i| i.name().text() == name))
        .map(|item| item.value())
}