citum_schema_style/locale/
message_ids.rs

1/*
2SPDX-License-Identifier: MIT OR Apache-2.0
3SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus and Citum contributors
4*/
5
6//! Canonical message-ID lookups and MF2 message resolution.
7//!
8//! The mappings here connect structured term identifiers (`GeneralTerm`,
9//! `ContributorRole`, `LocatorType`) to the dotted message IDs used by the MF2
10//! evaluator, and provide the `resolve_message_text` entry point that the
11//! term-lookup API on `Locale` (in `locale/mod.rs`) uses to fall through to
12//! the MF2 layer before legacy lookups.
13
14use super::Locale;
15use super::message::MessageArgs;
16use super::types::{GeneralTerm, GrammaticalGender, MessageSyntax, TermForm};
17use crate::citation::LocatorType;
18use crate::template::ContributorRole;
19
20impl Locale {
21    /// Map a GeneralTerm to its canonical message ID suffix (e.g., GeneralTerm::EtAl → "et-al").
22    pub(super) fn general_term_to_message_id(term: &GeneralTerm) -> &str {
23        match term {
24            GeneralTerm::And => "and",
25            GeneralTerm::EtAl => "et-al",
26            GeneralTerm::AndOthers => "and-others",
27            GeneralTerm::Accessed => "accessed",
28            GeneralTerm::Cited => "cited",
29            GeneralTerm::Retrieved => "retrieved",
30            GeneralTerm::NoDate => "no-date",
31            GeneralTerm::Ibid => "ibid",
32            GeneralTerm::In => "in",
33            GeneralTerm::At => "at",
34            GeneralTerm::By => "by",
35            GeneralTerm::From => "from",
36            GeneralTerm::Of => "of",
37            GeneralTerm::To => "to",
38            GeneralTerm::Anonymous => "anonymous",
39            GeneralTerm::Circa => "circa",
40            GeneralTerm::Forthcoming => "forthcoming",
41            GeneralTerm::Online => "online",
42            GeneralTerm::AvailableAt => "available-at",
43            GeneralTerm::ReviewOf => "review-of",
44            GeneralTerm::Here => "here",
45            GeneralTerm::Deposited => "deposited",
46            GeneralTerm::Patent => "patent",
47            GeneralTerm::Issued => "issued",
48            GeneralTerm::Volume => "volume",
49            GeneralTerm::Issue => "issue",
50            GeneralTerm::Page => "page",
51            GeneralTerm::Chapter => "chapter",
52            GeneralTerm::Edition => "edition",
53            GeneralTerm::Section => "section",
54            GeneralTerm::Version => "version",
55            GeneralTerm::OriginalWorkPublished => "original-work-published",
56            GeneralTerm::PersonalCommunication => "personal-communication",
57            GeneralTerm::Unknown(s) => s.as_str(),
58        }
59    }
60
61    /// Map a GeneralTerm to its legacy CSL key string for alias lookup.
62    pub(super) fn general_term_to_legacy_key(term: &GeneralTerm) -> &str {
63        match term {
64            GeneralTerm::EtAl => "et_al",
65            GeneralTerm::NoDate => "no_date",
66            _ => Self::general_term_to_message_id(term),
67        }
68    }
69
70    pub(super) fn role_message_id(role: &ContributorRole, form: &TermForm) -> Option<&'static str> {
71        let prefix = match role {
72            ContributorRole::Editor => "role.editor",
73            ContributorRole::Translator => "role.translator",
74            ContributorRole::Guest => "role.guest",
75            _ => return None,
76        };
77
78        match *form {
79            TermForm::Long => Some(match prefix {
80                "role.editor" => "role.editor.label-long",
81                "role.translator" => "role.translator.label-long",
82                "role.guest" => "role.guest.label-long",
83                _ => return None,
84            }),
85            TermForm::Short => Some(match prefix {
86                "role.editor" => "role.editor.label",
87                "role.translator" => "role.translator.label",
88                "role.guest" => "role.guest.label",
89                _ => return None,
90            }),
91            TermForm::Verb => Some(match prefix {
92                "role.editor" => "role.editor.verb",
93                "role.translator" => "role.translator.verb",
94                "role.guest" => "role.guest.verb",
95                _ => return None,
96            }),
97            // CSL reference (scripts/locales-en-US.xml) distinguishes
98            // "verb-short" from "verb" for editor ("ed. by" vs "edited by")
99            // and translator ("trans. by" vs "translated by"). Guest has no
100            // CSL-defined short verb form, so it falls back to the long verb.
101            TermForm::VerbShort => Some(match prefix {
102                "role.editor" => "role.editor.verb-short",
103                "role.translator" => "role.translator.verb-short",
104                "role.guest" => "role.guest.verb",
105                _ => return None,
106            }),
107            _ => None,
108        }
109    }
110
111    pub(super) fn locator_message_id(
112        locator: &LocatorType,
113        form: &TermForm,
114    ) -> Option<&'static str> {
115        let prefix = match locator {
116            LocatorType::Page => "term.page-label",
117            LocatorType::Chapter => "term.chapter-label",
118            LocatorType::Volume => "term.volume-label",
119            LocatorType::Section => "term.section-label",
120            LocatorType::Figure => "term.figure-label",
121            LocatorType::Note => "term.note-label",
122            _ => return None,
123        };
124
125        match *form {
126            TermForm::Long => Some(match prefix {
127                "term.page-label" => "term.page-label-long",
128                "term.chapter-label" => "term.chapter-label-long",
129                "term.volume-label" => "term.volume-label-long",
130                "term.section-label" => "term.section-label-long",
131                "term.figure-label" => "term.figure-label-long",
132                "term.note-label" => "term.note-label-long",
133                _ => return None,
134            }),
135            TermForm::Short => Some(prefix),
136            _ => None,
137        }
138    }
139
140    pub(super) fn general_message_id(term: &GeneralTerm, form: &TermForm) -> Option<&'static str> {
141        match (term, form) {
142            (GeneralTerm::And, _) => Some("term.and"),
143            (GeneralTerm::EtAl, _) => Some("term.et-al"),
144            (GeneralTerm::AndOthers, _) => Some("term.and-others"),
145            (GeneralTerm::Accessed, _) => Some("term.accessed"),
146            (GeneralTerm::Cited, _) => Some("term.cited"),
147            (GeneralTerm::Retrieved, _) => Some("term.retrieved"),
148            (GeneralTerm::NoDate, TermForm::Long) => Some("term.no-date-long"),
149            (GeneralTerm::NoDate, _) => Some("term.no-date"),
150            (GeneralTerm::Forthcoming, _) => Some("term.forthcoming"),
151            (GeneralTerm::Circa, TermForm::Long) => Some("term.circa-long"),
152            (GeneralTerm::Circa, _) => Some("term.circa"),
153            _ => None,
154        }
155    }
156
157    pub(super) fn gender_selector_key(gender: &GrammaticalGender) -> &str {
158        match gender {
159            GrammaticalGender::Masculine => "masculine",
160            GrammaticalGender::Feminine => "feminine",
161            GrammaticalGender::Neuter => "neuter",
162            GrammaticalGender::Common => "common",
163            GrammaticalGender::Unknown(s) => s.as_str(),
164        }
165    }
166
167    /// Resolve a locale message by ID with caller-supplied MF2 arguments.
168    ///
169    /// This is the public boundary for style-template `message` components:
170    /// templates select the message ID and pass named arguments, while the
171    /// active locale owns the message body and evaluator.
172    pub fn resolve_message(&self, message_id: &str, args: &MessageArgs<'_>) -> Option<String> {
173        let message = self.messages.get(message_id)?;
174
175        if !message.contains('{') {
176            return Some(message.clone());
177        }
178
179        if self.evaluation.message_syntax == MessageSyntax::Static {
180            return None;
181        }
182
183        self.evaluator.evaluate(message, args)
184    }
185
186    /// Resolve a style-template message call, including term-backed message IDs.
187    ///
188    /// `term.*` IDs are allowed to fall through to the structured locale term
189    /// resolver so checked-in styles can use the message component surface
190    /// without duplicating legacy term data into every locale's `messages` map.
191    pub fn resolve_template_message(
192        &self,
193        message_id: &str,
194        args: &MessageArgs<'_>,
195        form: Option<&TermForm>,
196        gender: Option<GrammaticalGender>,
197    ) -> Option<String> {
198        if let Some((term, implied_form)) = Self::term_message_parts(message_id) {
199            let effective_form = form.cloned().or(implied_form).unwrap_or(TermForm::Long);
200            if let Some(value) = self.resolved_general_term(&term, &effective_form, gender) {
201                return Some(value);
202            }
203        }
204
205        self.resolve_message(message_id, args)
206    }
207
208    fn term_message_parts(message_id: &str) -> Option<(GeneralTerm, Option<TermForm>)> {
209        let key = message_id.strip_prefix("term.")?;
210        let (term_key, implied_form) = key
211            .strip_suffix("-long")
212            .map_or((key, None), |base| (base, Some(TermForm::Long)));
213        let term = Self::parse_general_term(term_key)
214            .unwrap_or_else(|| GeneralTerm::Unknown(term_key.to_string()));
215        Some((term, implied_form))
216    }
217
218    pub(super) fn resolve_message_text(
219        &self,
220        message_id: &str,
221        count: Option<u64>,
222        gender: Option<GrammaticalGender>,
223    ) -> Option<String> {
224        let args = MessageArgs {
225            count,
226            gender: gender.as_ref().map(Self::gender_selector_key),
227            ..MessageArgs::default()
228        };
229
230        self.resolve_message(message_id, &args)
231    }
232}
citum_schema_style/locale/message_ids.rs

citum_schema_style/locale/
message_ids.rs
