jumpcut 1.0.0

JumpCut is a library and CLI for converting Fountain-formatted text files into FDX, HTML, JSON, text, and PDF formats.
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use crate::{
    Element, ElementText, Screenplay, render_attributes::RenderAttributes, styled_text::StyledText,
};

use super::fixtures::{NormalizedElement, NormalizedScreenplay};

pub fn normalize_screenplay(
    screenplay_id: impl Into<String>,
    screenplay: &Screenplay,
) -> NormalizedScreenplay {
    let mut collector = NormalizedCollector::default();
    for element in &screenplay.elements {
        collector.expand_element(element, None, None, None, None);
    }

    NormalizedScreenplay {
        screenplay: screenplay_id.into(),
        starting_page_number: None,
        elements: collector.elements,
    }
}

#[derive(Default)]
struct NormalizedCollector {
    next_element_id: usize,
    next_block_id: usize,
    next_dual_group_id: usize,
    elements: Vec<NormalizedElement>,
}

impl NormalizedCollector {
    fn expand_element(
        &mut self,
        element: &Element,
        block_kind: Option<&str>,
        block_id: Option<&str>,
        dual_dialogue_group: Option<&str>,
        dual_dialogue_side: Option<u8>,
    ) {
        match element {
            Element::DialogueBlock(children) => {
                self.next_block_id += 1;
                let block_id = format!("block-{:05}", self.next_block_id);
                for child in children {
                    self.expand_element(
                        child,
                        Some("DialogueBlock"),
                        Some(block_id.as_str()),
                        dual_dialogue_group,
                        dual_dialogue_side,
                    );
                }
            }
            Element::DualDialogueBlock(blocks) => {
                self.next_dual_group_id += 1;
                let group_id = format!("dual-{:05}", self.next_dual_group_id);
                for (idx, child) in blocks.iter().enumerate() {
                    self.expand_element(
                        child,
                        None,
                        None,
                        Some(group_id.as_str()),
                        Some((idx + 1) as u8),
                    );
                }
            }
            _ => self.push_leaf(
                element,
                block_kind,
                block_id,
                dual_dialogue_group,
                dual_dialogue_side,
            ),
        }
    }

    fn push_leaf(
        &mut self,
        element: &Element,
        block_kind: Option<&str>,
        block_id: Option<&str>,
        dual_dialogue_group: Option<&str>,
        dual_dialogue_side: Option<u8>,
    ) {
        let (kind, text, inline_text, centered, starts_new_page, scene_number, layout_overrides) =
            match element {
                Element::Action(text, attributes)
                | Element::Character(text, attributes)
                | Element::SceneHeading(text, attributes)
                | Element::Lyric(text, attributes)
                | Element::Parenthetical(text, attributes)
                | Element::Dialogue(text, attributes)
                | Element::Transition(text, attributes)
                | Element::ColdOpening(text, attributes)
                | Element::NewAct(text, attributes)
                | Element::EndOfAct(text, attributes) => (
                    element.name().to_string(),
                    flatten_text(text),
                    StyledText::from_element_text(text),
                    attributes.centered,
                    attributes.starts_new_page,
                    attributes.scene_number.clone(),
                    attributes.layout_overrides.clone(),
                ),
                Element::Section(text, attributes, _) => (
                    "Section".to_string(),
                    flatten_text(text),
                    StyledText::from_element_text(text),
                    attributes.centered,
                    attributes.starts_new_page,
                    attributes.scene_number.clone(),
                    attributes.layout_overrides.clone(),
                ),
                Element::Synopsis(text) => (
                    "Synopsis".to_string(),
                    flatten_text(text),
                    StyledText::from_element_text(text),
                    false,
                    false,
                    None,
                    Default::default(),
                ),
                Element::DialogueBlock(_) | Element::DualDialogueBlock(_) | Element::PageBreak => {
                    return;
                }
            };

        self.next_element_id += 1;
        self.elements.push(NormalizedElement {
            element_id: format!("el-{:05}", self.next_element_id),
            kind,
            text,
            inline_text,
            render_attributes: RenderAttributes {
                centered,
                starts_new_page,
                scene_number: scene_number.clone(),
                layout_overrides,
            },
            fragment: None,
            block_kind: block_kind.map(str::to_string),
            block_id: block_id.map(str::to_string),
            dual_dialogue_group: dual_dialogue_group.map(str::to_string),
            dual_dialogue_side,
        });
    }
}

fn flatten_text(text: &ElementText) -> String {
    match text {
        ElementText::Plain(value) => value.clone(),
        ElementText::Styled(runs) => runs.iter().map(|run| run.content.as_str()).collect(),
    }
}