wdl_format/v1/

task.rs

//! Formatting for tasks.

use std::rc::Rc;

use wdl_ast::SyntaxKind;
use wdl_ast::v1::StrippedCommandPart;

use crate::Config;
use crate::PreToken;
use crate::TokenStream;
use crate::Trivia;
use crate::Writable as _;
use crate::element::FormatElement;

/// Formats a [`TaskDefinition`](wdl_ast::v1::TaskDefinition).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_task_definition(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("task definition children");

    stream.ignore_trailing_blank_lines();

    let task_keyword = children.next().expect("task keyword");
    assert!(task_keyword.element().kind() == SyntaxKind::TaskKeyword);
    (&task_keyword).write(stream, config);
    stream.end_word();

    let name = children.next().expect("task name");
    assert!(name.element().kind() == SyntaxKind::Ident);
    (&name).write(stream, config);
    stream.end_word();

    let open_brace = children.next().expect("open brace");
    assert!(open_brace.element().kind() == SyntaxKind::OpenBrace);
    (&open_brace).write(stream, config);
    stream.end_line();
    stream.increment_indent();

    let mut meta = None;
    let mut parameter_meta = None;
    let mut input = None;
    let mut body = Vec::new();
    let mut command = None;
    let mut output = None;
    let mut requirements = None;
    let mut runtime = None;
    let mut hints = None;
    let mut close_brace = None;

    for child in children {
        match child.element().kind() {
            SyntaxKind::InputSectionNode => {
                input = Some(child.clone());
            }
            SyntaxKind::MetadataSectionNode => {
                meta = Some(child.clone());
            }
            SyntaxKind::ParameterMetadataSectionNode => {
                parameter_meta = Some(child.clone());
            }
            SyntaxKind::BoundDeclNode => {
                body.push(child.clone());
            }
            SyntaxKind::CommandSectionNode => {
                command = Some(child.clone());
            }
            SyntaxKind::OutputSectionNode => {
                output = Some(child.clone());
            }
            SyntaxKind::RequirementsSectionNode => {
                requirements = Some(child.clone());
            }
            SyntaxKind::RuntimeSectionNode => {
                runtime = Some(child.clone());
            }
            SyntaxKind::TaskHintsSectionNode => {
                hints = Some(child.clone());
            }
            SyntaxKind::CloseBrace => {
                close_brace = Some(child.clone());
            }
            _ => {
                unreachable!(
                    "unexpected child in task definition: {:?}",
                    child.element().kind()
                );
            }
        }
    }

    if let Some(meta) = meta {
        (&meta).write(stream, config);
        stream.blank_line();
    }

    if let Some(parameter_meta) = parameter_meta {
        (&parameter_meta).write(stream, config);
        stream.blank_line();
    }

    if let Some(input) = input {
        (&input).write(stream, config);
        stream.blank_line();
    }

    stream.allow_blank_lines();
    let body_empty = body.is_empty();
    for child in body {
        (&child).write(stream, config);
    }
    stream.ignore_trailing_blank_lines();
    if !body_empty {
        stream.blank_line();
    }

    if let Some(command) = command {
        (&command).write(stream, config);
        stream.blank_line();
    }

    if let Some(output) = output {
        (&output).write(stream, config);
        stream.blank_line();
    }

    match requirements {
        Some(requirements) => {
            (&requirements).write(stream, config);
            stream.blank_line();
        }
        _ => {
            if let Some(runtime) = runtime {
                (&runtime).write(stream, config);
                stream.blank_line();
            }
        }
    }

    if let Some(hints) = hints {
        (&hints).write(stream, config);
        stream.blank_line();
    }

    stream.trim_while(|t| matches!(t, PreToken::BlankLine | PreToken::Trivia(Trivia::BlankLine)));

    stream.decrement_indent();
    (&close_brace.expect("task close brace")).write(stream, config);
    stream.end_line();
}

/// Formats a [`CommandSection`](wdl_ast::v1::CommandSection).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_command_section(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("command section children");

    let command_keyword = children.next().expect("command keyword");
    assert!(command_keyword.element().kind() == SyntaxKind::CommandKeyword);
    (&command_keyword).write(stream, config);
    stream.end_word();

    let open_delimiter = children.next().expect("open delimiter");
    match open_delimiter.element().kind() {
        SyntaxKind::OpenBrace => {
            stream.push_literal_in_place_of_token(
                open_delimiter
                    .element()
                    .as_token()
                    .expect("open brace should be token"),
                "<<<".to_string(),
            );
        }
        SyntaxKind::OpenHeredoc => {
            (&open_delimiter).write(stream, config);
        }
        _ => {
            unreachable!(
                "unexpected open delimiter in command section: {:?}",
                open_delimiter.element().kind()
            );
        }
    }

    let parts = element
        .element()
        .as_node()
        .expect("command section node")
        .as_command_section()
        .expect("command section")
        .strip_whitespace();
    match parts {
        None => {
            // The command section has mixed indentation, so we format it as is.
            // TODO: We may want to format this differently in the future, but for now
            // we can say "ugly input, ugly output".
            for child in children {
                match child.element().kind() {
                    SyntaxKind::CloseBrace => {
                        stream.push_literal_in_place_of_token(
                            child
                                .element()
                                .as_token()
                                .expect("close brace should be token"),
                            ">>>".to_string(),
                        );
                    }
                    SyntaxKind::CloseHeredoc => {
                        (&child).write(stream, config);
                    }
                    SyntaxKind::LiteralCommandText | SyntaxKind::PlaceholderNode => {
                        (&child).write(stream, config);
                    }
                    _ => {
                        unreachable!(
                            "unexpected child in command section: {:?}",
                            child.element().kind()
                        );
                    }
                }
            }
        }
        Some(parts) => {
            // Now we parse the stripped command section and format it.
            // End the line after the open delimiter and increment indent.
            stream.increment_indent();

            let mut bash_indent: Option<Rc<String>> = None;
            for (part, child) in parts.iter().zip(children.by_ref()) {
                match part {
                    StrippedCommandPart::Text(text) => {
                        // Manually format the text and ignore the child.
                        let mut lines = text.lines().enumerate().peekable();
                        while let Some((i, line)) = lines.next() {
                            if i > 0 {
                                bash_indent = None;
                                stream.end_line();
                                if lines.peek().is_none() {
                                    // save the leading whitespace to use as temporary indent
                                    bash_indent = Some(
                                        line.chars()
                                            .take_while(|c| matches!(c, ' ' | '\t'))
                                            .collect::<String>()
                                            .into(),
                                    );
                                }
                            }
                            stream.push_literal(line.to_owned(), SyntaxKind::LiteralCommandText);
                        }

                        if text.ends_with('\n') {
                            bash_indent = None;
                            stream.end_line();
                        }
                    }
                    StrippedCommandPart::Placeholder(_) => {
                        if let Some(ref temp_indent) = bash_indent
                            && !temp_indent.is_empty()
                        {
                            stream.push(PreToken::TempIndentStart(temp_indent.clone()));
                            (&child).write(stream, config);
                            stream.push(PreToken::TempIndentEnd);
                        } else {
                            (&child).write(stream, config);
                        }
                    }
                }
            }

            stream.decrement_indent();

            for child in children {
                match child.element().kind() {
                    SyntaxKind::CloseBrace => {
                        stream.push_literal_in_place_of_token(
                            child
                                .element()
                                .as_token()
                                .expect("close brace should be token"),
                            ">>>".to_string(),
                        );
                    }
                    SyntaxKind::CloseHeredoc => {
                        (&child).write(stream, config);
                    }
                    _ => {
                        unreachable!(
                            "unexpected child in command section: {:?}",
                            child.element().kind()
                        );
                    }
                }
            }
        }
    }
    stream.end_line();
}

/// Formats a [`RequirementsItem`](wdl_ast::v1::RequirementsItem).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_requirements_item(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("requirements item children");

    let name = children.next().expect("requirements item name");
    assert!(name.element().kind() == SyntaxKind::Ident);
    (&name).write(stream, config);

    let colon = children.next().expect("requirements item colon");
    assert!(colon.element().kind() == SyntaxKind::Colon);
    (&colon).write(stream, config);
    stream.end_word();

    let value = children.next().expect("requirements item value");
    (&value).write(stream, config);
}

/// Formats a [`RequirementsSection`](wdl_ast::v1::RequirementsSection).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_requirements_section(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("requirements section children");

    let requirements_keyword = children.next().expect("requirements keyword");
    assert!(requirements_keyword.element().kind() == SyntaxKind::RequirementsKeyword);
    (&requirements_keyword).write(stream, config);
    stream.end_word();

    let open_brace = children.next().expect("open brace");
    assert!(open_brace.element().kind() == SyntaxKind::OpenBrace);
    (&open_brace).write(stream, config);
    stream.increment_indent();

    let mut items = Vec::new();
    let mut close_brace = None;

    for child in children {
        match child.element().kind() {
            SyntaxKind::RequirementsItemNode => {
                items.push(child.clone());
            }
            SyntaxKind::CloseBrace => {
                close_brace = Some(child.clone());
            }
            _ => {
                unreachable!(
                    "unexpected child in requirements section: {:?}",
                    child.element().kind()
                );
            }
        }
    }

    for item in items {
        (&item).write(stream, config);
        stream.end_line();
    }

    stream.decrement_indent();
    (&close_brace.expect("requirements close brace")).write(stream, config);
    stream.end_line();
}

/// Formats a [`TaskHintsItem`](wdl_ast::v1::TaskHintsItem).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_task_hints_item(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("task hints item children");

    let name = children.next().expect("task hints item name");
    assert!(name.element().kind() == SyntaxKind::Ident);
    (&name).write(stream, config);

    let colon = children.next().expect("task hints item colon");
    assert!(colon.element().kind() == SyntaxKind::Colon);
    (&colon).write(stream, config);
    stream.end_word();

    let value = children.next().expect("task hints item value");
    (&value).write(stream, config);

    assert!(children.next().is_none());
}

/// Formats a [`RuntimeItem`](wdl_ast::v1::RuntimeItem).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_runtime_item(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("runtime item children");

    let name = children.next().expect("runtime item name");
    assert!(name.element().kind() == SyntaxKind::Ident);
    (&name).write(stream, config);

    let colon = children.next().expect("runtime item colon");
    assert!(colon.element().kind() == SyntaxKind::Colon);
    (&colon).write(stream, config);
    stream.end_word();

    let value = children.next().expect("runtime item value");
    (&value).write(stream, config);
}

/// Formats a [`RuntimeSection`](wdl_ast::v1::RuntimeSection).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_runtime_section(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("runtime section children");

    let runtime_keyword = children.next().expect("runtime keyword");
    assert!(runtime_keyword.element().kind() == SyntaxKind::RuntimeKeyword);
    (&runtime_keyword).write(stream, config);
    stream.end_word();

    let open_brace = children.next().expect("open brace");
    assert!(open_brace.element().kind() == SyntaxKind::OpenBrace);
    (&open_brace).write(stream, config);
    stream.increment_indent();

    let mut items = Vec::new();
    let mut close_brace = None;

    for child in children {
        match child.element().kind() {
            SyntaxKind::RuntimeItemNode => {
                items.push(child.clone());
            }
            SyntaxKind::CloseBrace => {
                close_brace = Some(child.clone());
            }
            _ => {
                unreachable!(
                    "unexpected child in runtime section: {:?}",
                    child.element().kind()
                );
            }
        }
    }

    for item in items {
        (&item).write(stream, config);
        stream.end_line();
    }

    stream.decrement_indent();
    (&close_brace.expect("runtime close brace")).write(stream, config);
    stream.end_line();
}

/// Formats a [`TaskHintsSection`](wdl_ast::v1::TaskHintsSection).
///
/// # Panics
///
/// This will panic if the element does not have the expected children.
pub fn format_task_hints_section(
    element: &FormatElement,
    stream: &mut TokenStream<PreToken>,
    config: &Config,
) {
    let mut children = element.children().expect("task hints section children");

    let hints_keyword = children.next().expect("hints keyword");
    assert!(hints_keyword.element().kind() == SyntaxKind::HintsKeyword);
    (&hints_keyword).write(stream, config);
    stream.end_word();

    let open_brace = children.next().expect("open brace");
    assert!(open_brace.element().kind() == SyntaxKind::OpenBrace);
    (&open_brace).write(stream, config);
    stream.increment_indent();

    let mut items = Vec::new();
    let mut close_brace = None;

    for child in children {
        match child.element().kind() {
            SyntaxKind::TaskHintsItemNode => {
                items.push(child.clone());
            }
            SyntaxKind::CloseBrace => {
                close_brace = Some(child.clone());
            }
            _ => {
                unreachable!(
                    "unexpected child in task hints section: {:?}",
                    child.element().kind()
                );
            }
        }
    }

    for item in items {
        (&item).write(stream, config);
        stream.end_line();
    }

    stream.decrement_indent();
    (&close_brace.expect("task hints close brace")).write(stream, config);
    stream.end_line();
}