glossa-codegen 0.0.9

Generate const language localisation map code at compile time
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
use std::{
  fs::File,
  io::{self, BufWriter, Write},
};

use glossa_shared::{
  PhfTupleKey, ToCompactString, fmt_compact,
  phf_triple_key::RawTripleKey,
  tap::{Pipe, Tap},
};
use phf_codegen::OrderedMap;
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};

use crate::{
  MiniStr,
  generator::{
    Generator, MapType, flattening::L10nBTreeMap, output_bincode::create_buf_writer,
  },
};

impl<'h> Generator<'h> {
  /// Collect all localized resources into a **`const phf::OrderedMap`**
  /// function, i.e., a single table can accommodate different `language`,
  /// `map_name`, and `map_key`.
  ///
  ///
  /// ## Example
  ///
  /// ```no_run
  /// use glossa_codegen::{L10nResources, Generator, generator::MapType};
  /// use glossa_shared::tap::Pipe;
  ///
  /// let data = L10nResources::new("../../locales/")
  ///   .with_include_map_names(["error"])
  ///   .with_include_languages([
  ///     "de",
  ///     "zh-pinyin",
  ///     "zh",
  ///     "pt",
  ///     "es",
  ///     "en",
  ///     "en-GB",
  /// ]);
  ///
  /// let function_data = Generator::default()
  ///   .with_resources(data)
  ///   .output_phf_all_in_one(MapType::Regular)?;
  ///
  /// # Ok::<(), std::io::Error>(())
  /// ```
  ///
  /// ### function data:
  ///
  /// ```ignore
  /// // glossa_shared::{phf, PhfL10nAllInOneMap, PhfTripleKey};
  ///
  /// pub(crate) const fn map() -> super::PhfL10nAllInOneMap {
  ///     use super::PhfTripleKey as Key;
  ///     super::phf::OrderedMap {
  ///       key: 12913932095322966823,
  ///       disps: &[(2, 3), (2, 0)],
  ///       idxs: &[5, 4, 0, 6, 3, 2, 1],
  ///       entries: &[
  ///         (
  ///           Key(r#"de"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"Kein lokalisierter Text gefunden"#####,
  ///         ),
  ///         (
  ///           Key(r#"en"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"No localized text found"#####,
  ///         ),
  ///         (
  ///           Key(r#"en-GB"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"No localised text found"#####,
  ///         ),
  ///         (
  ///           Key(r#"es"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"No se encontró texto localizado"#####,
  ///         ),
  ///         (
  ///           Key(r#"pt"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"Nenhum texto localizado encontrado"#####,
  ///         ),
  ///         (
  ///           Key(r#"zh"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"未找到本地化文本"#####,
  ///         ),
  ///         (
  ///           Key(r#"zh-Latn-CN"#, r##"error"##, r###"text-not-found"###),
  ///           r#####"MeiYou ZhaoDao BenDiHua WenBen"#####,
  ///         ),
  ///       ],
  ///     }
  /// }
  /// ```
  ///
  /// ### Get Text
  ///
  /// ```ignore
  /// use glossa_shared::PhfTripleKey;
  ///
  /// fn test_get_text() {
  ///     let map = map();
  ///     let get_text =
  ///       |language| map.get(&PhfTripleKey(language, "error", "text-not-found"));
  ///
  ///     let zh_text = get_text("zh");
  ///     assert_eq!(zh_text, Some(&"未找到本地化文本"));
  ///
  ///     let language_chain = ["gsw", "de-CH", "de", "en"];
  ///
  ///     let text = language_chain
  ///       .into_iter()
  ///       .find_map(get_text);
  ///     assert_eq!(text, Some(&"Kein lokalisierter Text gefunden"));
  /// }
  /// ```
  pub fn output_phf_all_in_one(&'h self, non_dsl: MapType) -> io::Result<String> {
    let vis_fn = self.get_visibility().as_str();

    non_dsl
      .get_non_dsl_maps(self)?
      .iter()
      .filter(|(_, data)| !data.is_empty())
      .flat_map(|(lang, map_entry)| {
        map_entry
          .iter()
          .map(|((name, k), v)| {
            let new_key =
              RawTripleKey(lang.to_compact_string(), name.as_str(), k.as_str());
            let value = fmt_compact!(r##########"r#####"{v}"#####"##########);
            (new_key, value)
          })
      })
      .fold(OrderedMap::new(), |mut acc, (k, v)| {
        acc.entry(k, &v);
        acc
      })
      .pipe_ref_mut(|ordered_map| {
        format!(
          r#"{vis_fn} const fn map() -> super::PhfL10nAllInOneMap {{
      use super::PhfTripleKey as Key;
        {code}  }}"#,
          code = ordered_map
            .phf_path("super::phf")
            .build()
        )
      })
      .pipe(Ok)
  }

  /// Generates Perfect Hash Function (PHF) maps for localization data.
  /// => `const fn map() -> super::PhfL10nOrderedMap`
  ///
  /// # Behavior
  ///
  /// - Processes non-DSL maps in parallel
  /// - Filters out empty localization datasets
  /// - Generates PHF maps preserving insertion order
  /// - Creates individual Rust module files per language
  ///
  /// # Errors
  ///
  /// Returns [`io::Result`] for file I/O operations failures
  pub fn output_phf(&'h self, non_dsl: MapType) -> io::Result<()> {
    let vis_fn = self.get_visibility().as_str();

    non_dsl
      .get_non_dsl_maps(self)?
      .par_iter()
      .filter(|(_, data)| !data.is_empty())
      .map(|(lang, map_entry)| {
        let new_phf_map = assemble_phf_map(map_entry);
        (lang, new_phf_map)
      })
      .try_for_each(|(lang, mut map)| {
        writeln!(
          &mut self.create_rs_mod_file(lang)?,
          r##"{vis_fn} const fn map() -> super::PhfL10nOrderedMap {{
          use super::PhfTupleKey as Key;
          {code}  }}"##,
          code = map
            .phf_path("super::phf")
            .build()
        )
      })
  }

  /// Generates Perfect Hash Function (PHF) maps for localization data.
  /// => `const fn map() -> super::PhfStrMap`
  ///
  /// > Note: The generated PHF map is only for localization data where map_name
  /// > can be ignored. If map_name cannot be ignored, please use
  /// > [output_phf](Self::output_phf).
  pub fn output_phf_without_map_name(&'h self, non_dsl: MapType) -> io::Result<()> {
    let vis_fn = self.get_visibility().as_str();

    non_dsl
      .get_non_dsl_maps(self)?
      .par_iter()
      .filter(|(_, data)| !data.is_empty())
      .map(|(lang, map_entry)| {
        let new_phf_map = map_entry
          .iter()
          .map(|((_name, k), v)| {
            let value = fmt_compact!(r##########"r#####"{v}"#####"##########);
            (k.as_str(), value)
          })
          .fold(OrderedMap::new(), |mut acc, (k, v)| {
            acc.entry(k, &v);
            acc
          });
        (lang, new_phf_map)
      })
      .try_for_each(|(lang, mut map)| {
        writeln!(
          &mut self.create_rs_mod_file(lang)?,
          r##"{vis_fn} const fn map() -> super::PhfStrMap {{
          {code}  }}"##,
          code = map
            .phf_path("super::phf")
            .build()
        )
      })
  }

  /// Creates Rust module file writer with standardized naming
  ///
  /// # File Naming
  ///
  /// Generates filenames following format:
  /// `{mod_prefix}{language_snake_case}.rs`
  /// - Converts language ID to snake_case (e.g., "en-US" → "en_us")
  /// - Applies module prefix from generator configuration
  pub(crate) fn create_rs_mod_file<D: core::fmt::Display>(
    &self,
    language: &D,
  ) -> io::Result<BufWriter<File>> {
    let mod_prefix = self.get_mod_prefix();
    let feat_prefix = self.get_feature_prefix();
    let rs_file_name =
      fmt_compact!("{mod_prefix}{}.rs", to_lower_snake_case(language));
    let mod_name = rs_file_name.trim_end_matches(".rs");

    eprintln!(
      "#[cfg(feature = \"{feat_prefix}{language}\")]\n\
      mod {mod_name};\n",
    );

    let out_dir = self.get_outdir().as_deref();

    create_buf_writer(out_dir, rs_file_name)
  }
}

/// Constructs ordered PHF map from localization entries
///
/// # Parameter
///
/// - `map_entry`
///   - Localization data in BTreeMap format
///
/// # Note
/// Preserves insertion order using [`phf_codegen::OrderedMap`]
fn assemble_phf_map(map_entry: &L10nBTreeMap) -> OrderedMap<PhfTupleKey<'_>> {
  map_entry
    .iter()
    .map(|((name, k), v)| {
      let tuple_key = PhfTupleKey(name.as_str(), k.as_str());
      let value = fmt_compact!(r##########"r#####"{v}"#####"##########);
      (tuple_key, value)
    })
    .fold(OrderedMap::new(), |mut acc, x| {
      acc.entry(x.0, &x.1);
      acc
    })
}

/// Normalizes snake_case format
///
/// - en.US => en_us
/// - en-US => en_us
/// - en-Latn-US => en_latn_us
/// - zh-Hans-CN => zh_hans_cn
///
/// ## Conversion Rules
///
/// 1. Convert to ASCII lowercase
/// 2. Replace hyphens/dots with underscores
pub fn to_lower_snake_case<D: core::fmt::Display>(id: D) -> MiniStr {
  fmt_compact!("{id}")
    .tap_mut(|s| s.make_ascii_lowercase())
    .chars()
    .map(|c| match c {
      '-' | '.' => '_',
      c => c,
    })
    .collect()
}

#[cfg(test)]
mod tests {
  use anyhow::Result as AnyResult;
  use glossa_shared::{PhfL10nAllInOneMap, PhfL10nOrderedMap, PhfTripleKey};

  use super::*;
  use crate::generator::dbg_generator::{
    de_en_fr_pt_zh_generator, en_gb_generator, es_generator, new_generator,
  };

  #[ignore]
  #[test]
  fn test_build_en_gb_phf() -> AnyResult<()> {
    en_gb_generator().output_phf(MapType::Regular)?;
    Ok(())
  }

  #[ignore]
  #[test]
  fn test_build_es_phf() -> AnyResult<()> {
    es_generator().output_phf(MapType::Regular)?;
    Ok(())
  }

  #[ignore]
  #[test]
  fn test_build_all_phf() -> AnyResult<()> {
    new_generator().output_phf(MapType::Regular)?;
    Ok(())
  }

  #[ignore]
  #[test]
  fn test_build_all_in_one_phf() -> AnyResult<()> {
    let function_data = new_generator().output_phf_all_in_one(MapType::Regular)?;
    println!("{function_data}");
    Ok(())
  }

  #[ignore]
  #[test]
  fn test_build_de_zh_fr_pt_phf_all_in_one() -> AnyResult<()> {
    let function_data =
      de_en_fr_pt_zh_generator().output_phf_all_in_one(MapType::Regular)?;
    println!("{function_data}");
    Ok(())
  }

  pub(crate) const fn en_gb_map() -> PhfL10nOrderedMap {
    use PhfTupleKey as Key;
    // use glossa_shared::phf;
    use lang_id::maps::phf;

    phf::OrderedMap {
      key: 12913932095322966823,
      disps: &[(0, 0)],
      idxs: &[0],
      entries: &[(
        Key(r#"error"#, r##"text-not-found"##),
        r#####"No localised text found"#####,
      )],
    }
  }

  pub(crate) const fn all_in_one_map() -> PhfL10nAllInOneMap {
    use PhfTripleKey as Key;
    use lang_id::maps::phf;

    phf::OrderedMap {
      key: 12913932095322966823,
      disps: &[(2, 3), (2, 0)],
      idxs: &[5, 4, 0, 6, 3, 2, 1],
      entries: &[
        (
          Key(r#"de"#, r##"error"##, r###"text-not-found"###),
          r#####"Kein lokalisierter Text gefunden"#####,
        ),
        (
          Key(r#"en"#, r##"error"##, r###"text-not-found"###),
          r#####"No localized text found"#####,
        ),
        (
          Key(r#"en-GB"#, r##"error"##, r###"text-not-found"###),
          r#####"No localised text found"#####,
        ),
        (
          Key(r#"es"#, r##"error"##, r###"text-not-found"###),
          r#####"No se encontró texto localizado"#####,
        ),
        (
          Key(r#"pt"#, r##"error"##, r###"text-not-found"###),
          r#####"Nenhum texto localizado encontrado"#####,
        ),
        (
          Key(r#"zh"#, r##"error"##, r###"text-not-found"###),
          r#####"未找到本地化文本"#####,
        ),
        (
          Key(r#"zh-Latn-CN"#, r##"error"##, r###"text-not-found"###),
          r#####"MeiYou ZhaoDao BenDiHua WenBen"#####,
        ),
      ],
    }
  }

  #[ignore]
  #[test]
  fn test_get_phf_en_map() {
    let map = en_gb_map();
    let v = map.get(&PhfTupleKey("error", "text-not-found"));
    dbg!(v);
  }

  #[ignore]
  #[test]
  fn doc_test_get_all_in_one_map() {
    let map = all_in_one_map();
    let get_text =
      |language| map.get(&PhfTripleKey(language, "error", "text-not-found"));

    let zh_text = get_text("zh");
    assert_eq!(zh_text, Some(&"未找到本地化文本"));

    let language_chain = ["gsw", "de-CH", "de", "en"];

    let text = language_chain
      .into_iter()
      .find_map(get_text);
    assert_eq!(text, Some(&"Kein lokalisierter Text gefunden"));
  }
}