citum-engine 0.61.0

Citum citation and bibliography processor
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

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus and Citum contributors
*/

//! Rendering logic for list components with configurable delimiters.
//!
//! This module handles rendering of lists of template items, with support for
//! different delimiters between items (commas, semicolons, etc.) and rendering modes.

use crate::reference::Reference;
use crate::values::{ComponentValues, ProcHints, ProcValues, RenderOptions};
use citum_schema::template::{DelimiterPunctuation, TemplateGroup};

impl ComponentValues for TemplateGroup {
    /// Returns the resolved list of component values for rendering.
    fn values<F: crate::render::format::OutputFormat<Output = String>>(
        &self,
        reference: &Reference,
        hints: &ProcHints,
        options: &RenderOptions<'_>,
    ) -> Option<ProcValues<F::Output>> {
        let mut has_content = false;
        let fmt = F::default();

        // Collect values from all items, applying their rendering
        let mut values = Vec::with_capacity(self.group.len());
        for item in &self.group {
            let Some(v) = item.values::<F>(reference, hints, options) else {
                continue;
            };
            if v.value.is_empty() {
                continue;
            }

            // Track if we have any "meaningful" content (not just a term)
            if !is_term_based(item) {
                has_content = true;
            }

            // Use the central rendering logic to apply global config, local settings, and overrides
            let proc_item = crate::render::ProcTemplateComponent {
                template_component: item.clone(),
                template_index: options.current_template_index,
                value: v.value,
                prefix: v.prefix,
                suffix: v.suffix,
                url: v.url,
                ref_type: Some(reference.ref_type().clone()),
                config: Some(options.config.clone()),
                bibliography_config: options.bibliography_config.clone(),
                item_language: crate::values::effective_component_language(reference, item),
                sentence_initial: false,
                pre_formatted: v.pre_formatted,
            };

            let rendered = crate::render::render_component_with_format_and_renderer::<F>(
                &proc_item,
                &fmt,
                options.show_semantics,
            );
            if !rendered.is_empty() {
                values.push(rendered);
            }
        }

        if values.is_empty() || !has_content {
            return None;
        }

        // Join with delimiter
        let delimiter = self
            .delimiter
            .as_ref()
            .unwrap_or(&DelimiterPunctuation::Comma)
            .to_string_with_space();

        Some(ProcValues {
            value: fmt.join(values, &delimiter),
            prefix: None,
            suffix: None,
            url: None,
            substituted_key: None,
            pre_formatted: true,
        })
    }
}

/// Returns true if the component value is derived from a locale term rather than a data field.
fn is_term_based(component: &citum_schema::template::TemplateComponent) -> bool {
    use citum_schema::template::TemplateComponent;
    match component {
        TemplateComponent::Term(_) => true,
        TemplateComponent::Group(l) => l.group.iter().all(is_term_based),
        _ => false,
    }
}