iced-code-editor 0.4.2

A custom code editor widget for the Iced GUI framework with syntax highlighting, line numbers, and scrolling support.
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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
//! Internationalization support for the code editor.
//!
//! This module provides translation support for UI text in the search dialog.
//!
//! # Using `Translations`
//!
//! The translations are available in YAML files in the `locales` directory,
//! loaded through the `rust-i18n` crate. Application code does not call
//! `rust-i18n`'s `t!` macro directly — it is not part of this crate's public
//! API. Instead, look up translated strings through [`Translations`]:
//!
//! ```
//! use iced_code_editor::{Language, Translations};
//!
//! let translations = Translations::new(Language::English);
//! assert_eq!(translations.search_placeholder(), "Search...");
//! ```

/// Supported languages for the code editor UI.
///
/// # Examples
///
/// ```
/// use iced_code_editor::Language;
///
/// let lang = Language::English;
/// assert_eq!(lang, Language::default());
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum Language {
    /// English language
    #[default]
    English,
    /// French language
    French,
    /// Spanish language
    Spanish,
    /// German language
    German,
    /// Italian language
    Italian,
    /// Portuguese (Brazilian) language
    PortugueseBR,
    /// Portuguese (European) language
    PortuguesePT,
    /// Simplified Chinese language
    ChineseSimplified,
}

impl Language {
    /// Returns the locale code for this language.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::Language;
    ///
    /// assert_eq!(Language::English.to_locale(), "en");
    /// assert_eq!(Language::French.to_locale(), "fr");
    /// assert_eq!(Language::Spanish.to_locale(), "es");
    /// assert_eq!(Language::German.to_locale(), "de");
    /// assert_eq!(Language::Italian.to_locale(), "it");
    /// assert_eq!(Language::PortugueseBR.to_locale(), "pt-BR");
    /// assert_eq!(Language::PortuguesePT.to_locale(), "pt-PT");
    /// ```
    #[must_use]
    pub const fn to_locale(self) -> &'static str {
        match self {
            Self::English => "en",
            Self::French => "fr",
            Self::Spanish => "es",
            Self::German => "de",
            Self::Italian => "it",
            Self::PortugueseBR => "pt-BR",
            Self::PortuguesePT => "pt-PT",
            Self::ChineseSimplified => "zh-CN",
        }
    }
}

/// Provides translated text strings for UI elements.
///
/// This struct contains all UI text translations used in the search dialog,
/// including placeholders, tooltips, and labels.
///
/// # Examples
///
/// ```
/// use iced_code_editor::{Language, Translations};
///
/// let translations = Translations::new(Language::French);
/// assert_eq!(translations.search_placeholder(), "Rechercher...");
/// ```
#[derive(Debug, Clone, Copy, Default)]
pub struct Translations {
    language: Language,
}

impl Translations {
    /// Creates a new `Translations` instance with the specified language.
    ///
    /// This sets the global rust-i18n locale to the specified language.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let translations = Translations::new(Language::Spanish);
    /// assert_eq!(translations.language(), Language::Spanish);
    /// ```
    #[must_use]
    pub fn new(language: Language) -> Self {
        rust_i18n::set_locale(language.to_locale());
        Self { language }
    }

    /// Returns the current language.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let translations = Translations::new(Language::French);
    /// assert_eq!(translations.language(), Language::French);
    /// ```
    #[must_use]
    pub const fn language(&self) -> Language {
        self.language
    }

    /// Sets the language for translations.
    ///
    /// This updates the global rust-i18n locale.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let mut translations = Translations::new(Language::English);
    /// translations.set_language(Language::Spanish);
    /// assert_eq!(translations.language(), Language::Spanish);
    /// ```
    pub fn set_language(&mut self, language: Language) {
        self.language = language;
        rust_i18n::set_locale(language.to_locale());
    }

    /// Returns the placeholder text for the search input field.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.search_placeholder(), "Search...");
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.search_placeholder(), "Rechercher...");
    /// ```
    #[must_use]
    pub fn search_placeholder(&self) -> String {
        rust_i18n::t!("search.placeholder", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the placeholder text for the replace input field.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let es = Translations::new(Language::Spanish);
    /// assert_eq!(es.replace_placeholder(), "Reemplazar...");
    /// ```
    #[must_use]
    pub fn replace_placeholder(&self) -> String {
        rust_i18n::t!("replace.placeholder", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the label text for the case sensitive checkbox.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.case_sensitive_label(), "Sensible à la casse");
    /// ```
    #[must_use]
    pub fn case_sensitive_label(&self) -> String {
        rust_i18n::t!(
            "settings.case_sensitive_label",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the tooltip text for the previous match button.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.previous_match_tooltip(), "Previous match (Shift+F3)");
    /// ```
    #[must_use]
    pub fn previous_match_tooltip(&self) -> String {
        rust_i18n::t!(
            "search.previous_match_tooltip",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the tooltip text for the next match button.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let es = Translations::new(Language::Spanish);
    /// assert_eq!(es.next_match_tooltip(), "Siguiente coincidencia (F3 / Enter)");
    /// ```
    #[must_use]
    pub fn next_match_tooltip(&self) -> String {
        rust_i18n::t!(
            "search.next_match_tooltip",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the tooltip text for the close search dialog button.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.close_search_tooltip(), "Fermer la recherche (Échap)");
    /// ```
    #[must_use]
    pub fn close_search_tooltip(&self) -> String {
        rust_i18n::t!(
            "search.close_tooltip",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the tooltip text for the replace current match button.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.replace_current_tooltip(), "Replace current match");
    /// ```
    #[must_use]
    pub fn replace_current_tooltip(&self) -> String {
        rust_i18n::t!(
            "replace.current_tooltip",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the tooltip text for the replace all matches button.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let es = Translations::new(Language::Spanish);
    /// assert_eq!(es.replace_all_tooltip(), "Reemplazar todo");
    /// ```
    #[must_use]
    pub fn replace_all_tooltip(&self) -> String {
        rust_i18n::t!("replace.all_tooltip", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for undo.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_undo(), "Undo");
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.context_menu_undo(), "Annuler");
    /// ```
    #[must_use]
    pub fn context_menu_undo(&self) -> String {
        rust_i18n::t!("context_menu.undo", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for redo.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_redo(), "Redo");
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.context_menu_redo(), "Rétablir");
    /// ```
    #[must_use]
    pub fn context_menu_redo(&self) -> String {
        rust_i18n::t!("context_menu.redo", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for cut.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_cut(), "Cut");
    ///
    /// let de = Translations::new(Language::German);
    /// assert_eq!(de.context_menu_cut(), "Ausschneiden");
    /// ```
    #[must_use]
    pub fn context_menu_cut(&self) -> String {
        rust_i18n::t!("context_menu.cut", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for copy.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_copy(), "Copy");
    ///
    /// let it = Translations::new(Language::Italian);
    /// assert_eq!(it.context_menu_copy(), "Copia");
    /// ```
    #[must_use]
    pub fn context_menu_copy(&self) -> String {
        rust_i18n::t!("context_menu.copy", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for paste.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_paste(), "Paste");
    ///
    /// let es = Translations::new(Language::Spanish);
    /// assert_eq!(es.context_menu_paste(), "Pegar");
    /// ```
    #[must_use]
    pub fn context_menu_paste(&self) -> String {
        rust_i18n::t!("context_menu.paste", locale = self.language.to_locale())
            .into_owned()
    }

    /// Returns the context-menu label for select all.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_select_all(), "Select All");
    ///
    /// let fr = Translations::new(Language::French);
    /// assert_eq!(fr.context_menu_select_all(), "Tout sélectionner");
    /// ```
    #[must_use]
    pub fn context_menu_select_all(&self) -> String {
        rust_i18n::t!(
            "context_menu.select_all",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the macOS context-menu label for revealing a file.
    ///
    /// Prefer [`Self::context_menu_reveal_in_file_manager`], which picks the
    /// right one of the three platform wordings for you.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.context_menu_reveal_in_finder(), "Reveal in Finder");
    /// ```
    #[must_use]
    pub fn context_menu_reveal_in_finder(&self) -> String {
        rust_i18n::t!(
            "context_menu.reveal_in_finder",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the Windows context-menu label for revealing a file.
    ///
    /// Prefer [`Self::context_menu_reveal_in_file_manager`], which picks the
    /// right one of the three platform wordings for you.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(
    ///     en.context_menu_reveal_in_file_explorer(),
    ///     "Reveal in File Explorer"
    /// );
    /// ```
    #[must_use]
    pub fn context_menu_reveal_in_file_explorer(&self) -> String {
        rust_i18n::t!(
            "context_menu.reveal_in_file_explorer",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the Linux context-menu label for opening a file's parent folder.
    ///
    /// Worded as "open the containing folder" rather than "reveal", matching
    /// how Linux file managers describe the action.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(
    ///     en.context_menu_open_containing_folder(),
    ///     "Open Containing Folder"
    /// );
    /// ```
    #[must_use]
    pub fn context_menu_open_containing_folder(&self) -> String {
        rust_i18n::t!(
            "context_menu.open_containing_folder",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the platform-appropriate label for revealing a file.
    ///
    /// Resolves to "Reveal in Finder" on macOS, "Reveal in File Explorer" on
    /// Windows, and "Open Containing Folder" elsewhere, so the menu matches
    /// the wording users already know from their own file manager.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// let label = en.context_menu_reveal_in_file_manager();
    ///
    /// // Whichever platform this runs on, it matches that platform's wording.
    /// #[cfg(target_os = "macos")]
    /// assert_eq!(label, en.context_menu_reveal_in_finder());
    /// #[cfg(target_os = "windows")]
    /// assert_eq!(label, en.context_menu_reveal_in_file_explorer());
    /// #[cfg(not(any(target_os = "macos", target_os = "windows")))]
    /// assert_eq!(label, en.context_menu_open_containing_folder());
    /// ```
    #[must_use]
    pub fn context_menu_reveal_in_file_manager(&self) -> String {
        if cfg!(target_os = "macos") {
            self.context_menu_reveal_in_finder()
        } else if cfg!(target_os = "windows") {
            self.context_menu_reveal_in_file_explorer()
        } else {
            self.context_menu_open_containing_folder()
        }
    }
    /// Returns the command-palette label for the filter input's placeholder.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_placeholder(), "Type a command...");
    /// ```
    #[must_use]
    pub fn command_palette_placeholder(&self) -> String {
        rust_i18n::t!(
            "command_palette.placeholder",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for the empty-result message.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_no_results(), "No matching command");
    /// ```
    #[must_use]
    pub fn command_palette_no_results(&self) -> String {
        rust_i18n::t!(
            "command_palette.no_results",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for saving the document.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_save(), "Save");
    /// ```
    #[must_use]
    pub fn command_palette_save(&self) -> String {
        rust_i18n::t!(
            "command_palette.save",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for toggling the line comment.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_toggle_comment(), "Toggle Line Comment");
    /// ```
    #[must_use]
    pub fn command_palette_toggle_comment(&self) -> String {
        rust_i18n::t!(
            "command_palette.toggle_comment",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for moving the current line up.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_move_line_up(), "Move Line Up");
    /// ```
    #[must_use]
    pub fn command_palette_move_line_up(&self) -> String {
        rust_i18n::t!(
            "command_palette.move_line_up",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for moving the current line down.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_move_line_down(), "Move Line Down");
    /// ```
    #[must_use]
    pub fn command_palette_move_line_down(&self) -> String {
        rust_i18n::t!(
            "command_palette.move_line_down",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for duplicating the current line above.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_duplicate_line_up(), "Duplicate Line Up");
    /// ```
    #[must_use]
    pub fn command_palette_duplicate_line_up(&self) -> String {
        rust_i18n::t!(
            "command_palette.duplicate_line_up",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for duplicating the current line below.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_duplicate_line_down(), "Duplicate Line Down");
    /// ```
    #[must_use]
    pub fn command_palette_duplicate_line_down(&self) -> String {
        rust_i18n::t!(
            "command_palette.duplicate_line_down",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for jumping to a line.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_goto_line(), "Go to Line");
    /// ```
    #[must_use]
    pub fn command_palette_goto_line(&self) -> String {
        rust_i18n::t!(
            "command_palette.goto_line",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for adding a cursor on the line above.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_add_cursor_above(), "Add Cursor Above");
    /// ```
    #[must_use]
    pub fn command_palette_add_cursor_above(&self) -> String {
        rust_i18n::t!(
            "command_palette.add_cursor_above",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for adding a cursor on the line below.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_add_cursor_below(), "Add Cursor Below");
    /// ```
    #[must_use]
    pub fn command_palette_add_cursor_below(&self) -> String {
        rust_i18n::t!(
            "command_palette.add_cursor_below",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for selecting the next occurrence.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_select_next_occurrence(), "Select Next Occurrence");
    /// ```
    #[must_use]
    pub fn command_palette_select_next_occurrence(&self) -> String {
        rust_i18n::t!(
            "command_palette.select_next_occurrence",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for toggling Vim mode.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_toggle_vim_mode(), "Toggle Vim Mode");
    /// ```
    #[must_use]
    pub fn command_palette_toggle_vim_mode(&self) -> String {
        rust_i18n::t!(
            "command_palette.toggle_vim_mode",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for opening the search dialog.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_find(), "Find");
    /// ```
    #[must_use]
    pub fn command_palette_find(&self) -> String {
        rust_i18n::t!(
            "command_palette.find",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for opening the search-and-replace dialog.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_replace(), "Replace");
    /// ```
    #[must_use]
    pub fn command_palette_replace(&self) -> String {
        rust_i18n::t!(
            "command_palette.replace",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for folding the block at the cursor.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_fold_at_cursor(), "Toggle Fold at Cursor");
    /// ```
    #[must_use]
    pub fn command_palette_fold_at_cursor(&self) -> String {
        rust_i18n::t!(
            "command_palette.fold_at_cursor",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for folding every block.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_fold_all(), "Fold All");
    /// ```
    #[must_use]
    pub fn command_palette_fold_all(&self) -> String {
        rust_i18n::t!(
            "command_palette.fold_all",
            locale = self.language.to_locale()
        )
        .into_owned()
    }

    /// Returns the command-palette label for unfolding every block.
    ///
    /// # Examples
    ///
    /// ```
    /// use iced_code_editor::{Language, Translations};
    ///
    /// let en = Translations::new(Language::English);
    /// assert_eq!(en.command_palette_unfold_all(), "Unfold All");
    /// ```
    #[must_use]
    pub fn command_palette_unfold_all(&self) -> String {
        rust_i18n::t!(
            "command_palette.unfold_all",
            locale = self.language.to_locale()
        )
        .into_owned()
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeSet;

    use super::*;

    /// Every locale file, paired with the name used in failure messages.
    ///
    /// English comes first: it is the reference every other file is compared
    /// against, and the fallback `rust_i18n` resolves a missing key through.
    const LOCALE_FILES: [(&str, &str); 8] = [
        ("en", include_str!("../locales/en.yml")),
        ("fr", include_str!("../locales/fr.yml")),
        ("es", include_str!("../locales/es.yml")),
        ("de", include_str!("../locales/de.yml")),
        ("it", include_str!("../locales/it.yml")),
        ("pt-BR", include_str!("../locales/pt-BR.yml")),
        ("pt-PT", include_str!("../locales/pt-PT.yml")),
        ("zh-CN", include_str!("../locales/zh-CN.yml")),
    ];

    /// Collects the `section.key` paths a locale file defines.
    ///
    /// Deliberately a five-line reader rather than a YAML dependency: the
    /// files are a flat list of `section:` headers with two-space-indented
    /// entries under them, and reading them structurally is the whole point —
    /// going through `rust_i18n` is exactly what cannot see a missing key.
    fn locale_keys(yaml: &str) -> BTreeSet<String> {
        let mut keys = BTreeSet::new();
        let mut section = String::new();

        for line in yaml.lines() {
            let line = line.trim_end();
            if line.trim_start().is_empty()
                || line.trim_start().starts_with('#')
            {
                continue;
            }

            match line.strip_prefix("  ") {
                // Indented: an entry belonging to the current section.
                Some(entry) => {
                    if let Some((name, _)) = entry.split_once(':') {
                        keys.insert(format!("{section}.{}", name.trim()));
                    }
                }
                // Flush left: a new section header.
                None => {
                    if let Some((name, _)) = line.split_once(':') {
                        section = name.trim().to_string();
                    }
                }
            }
        }

        keys
    }

    #[test]
    fn test_locale_keys_reads_the_section_and_entry_layout() {
        // Guards the guard: a reader that silently returned nothing would make
        // every comparison below pass on an empty set.
        let keys = locale_keys(
            "# a comment\nsearch:\n  placeholder: \"Search...\"\n\nreplace:\n  all_tooltip: \"Replace all matches\"\n",
        );

        assert_eq!(
            keys.iter().map(String::as_str).collect::<Vec<_>>(),
            ["replace.all_tooltip", "search.placeholder"]
        );
    }

    #[test]
    fn test_every_locale_defines_exactly_the_keys_english_defines() {
        // The structural check the runtime ones cannot perform: with
        // `fallback = "en"`, a key present in `en.yml` and missing from
        // `fr.yml` resolves to the *English* string, so no assertion made
        // through `Translations` can tell the two apart. Comparing the files
        // themselves is what catches a translator skipping an entry.
        let (_, english_source) = LOCALE_FILES[0];
        let english = locale_keys(english_source);
        assert!(
            english.contains("command_palette.fold_all"),
            "en.yml did not parse as expected"
        );

        for (name, source) in LOCALE_FILES {
            let keys = locale_keys(source);
            let missing: Vec<&String> = english.difference(&keys).collect();
            let extra: Vec<&String> = keys.difference(&english).collect();

            assert!(missing.is_empty(), "{name}.yml is missing {missing:?}");
            assert!(
                extra.is_empty(),
                "{name}.yml defines {extra:?}, which en.yml does not"
            );
        }
    }

    #[test]
    fn test_default_language() {
        let translations = Translations::default();
        assert_eq!(translations.language(), Language::English);
    }

    #[test]
    fn test_new_with_language() {
        let translations = Translations::new(Language::French);
        assert_eq!(translations.language(), Language::French);
    }

    #[test]
    fn test_set_language() {
        let mut translations = Translations::new(Language::English);
        translations.set_language(Language::Spanish);
        assert_eq!(translations.language(), Language::Spanish);
    }

    #[test]
    fn test_english_translations() {
        let t = Translations::new(Language::English);
        assert_eq!(t.search_placeholder(), "Search...");
        assert_eq!(t.replace_placeholder(), "Replace...");
        assert_eq!(t.case_sensitive_label(), "Case sensitive");
        assert_eq!(t.previous_match_tooltip(), "Previous match (Shift+F3)");
        assert_eq!(t.next_match_tooltip(), "Next match (F3 / Enter)");
        assert_eq!(t.close_search_tooltip(), "Close search dialog (Esc)");
        assert_eq!(t.replace_current_tooltip(), "Replace current match");
        assert_eq!(t.replace_all_tooltip(), "Replace all matches");
    }

    #[test]
    fn test_french_translations() {
        let t = Translations::new(Language::French);
        assert_eq!(t.search_placeholder(), "Rechercher...");
        assert_eq!(t.replace_placeholder(), "Remplacer...");
        assert_eq!(t.case_sensitive_label(), "Sensible à la casse");
        assert_eq!(t.previous_match_tooltip(), "Résultat précédent (Maj+F3)");
        assert_eq!(t.next_match_tooltip(), "Résultat suivant (F3 / Entrée)");
        assert_eq!(t.close_search_tooltip(), "Fermer la recherche (Échap)");
        assert_eq!(
            t.replace_current_tooltip(),
            "Remplacer l'occurrence actuelle"
        );
        assert_eq!(t.replace_all_tooltip(), "Tout remplacer");
    }

    #[test]
    fn test_spanish_translations() {
        let t = Translations::new(Language::Spanish);
        assert_eq!(t.search_placeholder(), "Buscar...");
        assert_eq!(t.replace_placeholder(), "Reemplazar...");
        assert_eq!(t.case_sensitive_label(), "Distinguir mayúsculas");
        assert_eq!(
            t.previous_match_tooltip(),
            "Coincidencia anterior (Mayús+F3)"
        );
        assert_eq!(
            t.next_match_tooltip(),
            "Siguiente coincidencia (F3 / Enter)"
        );
        assert_eq!(t.close_search_tooltip(), "Cerrar búsqueda (Esc)");
        assert_eq!(
            t.replace_current_tooltip(),
            "Reemplazar coincidencia actual"
        );
        assert_eq!(t.replace_all_tooltip(), "Reemplazar todo");
    }

    #[test]
    fn test_german_translations() {
        let t = Translations::new(Language::German);
        assert_eq!(t.search_placeholder(), "Suchen...");
        assert_eq!(t.replace_placeholder(), "Ersetzen...");
        assert_eq!(t.case_sensitive_label(), "Groß-/Kleinschreibung");
        assert_eq!(
            t.previous_match_tooltip(),
            "Vorheriger Treffer (Umschalt+F3)"
        );
        assert_eq!(t.next_match_tooltip(), "Nächster Treffer (F3 / Enter)");
        assert_eq!(t.close_search_tooltip(), "Suchdialog schließen (Esc)");
        assert_eq!(t.replace_current_tooltip(), "Aktuellen Treffer ersetzen");
        assert_eq!(t.replace_all_tooltip(), "Alle ersetzen");
    }

    #[test]
    fn test_italian_translations() {
        let t = Translations::new(Language::Italian);
        assert_eq!(t.search_placeholder(), "Cerca...");
        assert_eq!(t.replace_placeholder(), "Sostituisci...");
        assert_eq!(t.case_sensitive_label(), "Distingui maiuscole");
        assert_eq!(
            t.previous_match_tooltip(),
            "Risultato precedente (Maiusc+F3)"
        );
        assert_eq!(t.next_match_tooltip(), "Risultato successivo (F3 / Invio)");
        assert_eq!(
            t.close_search_tooltip(),
            "Chiudi finestra di ricerca (Esc)"
        );
        assert_eq!(
            t.replace_current_tooltip(),
            "Sostituisci risultato corrente"
        );
        assert_eq!(t.replace_all_tooltip(), "Sostituisci tutto");
    }

    #[test]
    fn test_portuguese_br_translations() {
        let t = Translations::new(Language::PortugueseBR);
        assert_eq!(t.search_placeholder(), "Pesquisar...");
        assert_eq!(t.replace_placeholder(), "Substituir...");
        assert_eq!(t.case_sensitive_label(), "Diferenciar maiúsculas");
        assert_eq!(
            t.previous_match_tooltip(),
            "Correspondência anterior (Shift+F3)"
        );
        assert_eq!(
            t.next_match_tooltip(),
            "Próxima correspondência (F3 / Enter)"
        );
        assert_eq!(
            t.close_search_tooltip(),
            "Fechar diálogo de pesquisa (Esc)"
        );
        assert_eq!(
            t.replace_current_tooltip(),
            "Substituir correspondência atual"
        );
        assert_eq!(t.replace_all_tooltip(), "Substituir tudo");
    }

    #[test]
    fn test_portuguese_pt_translations() {
        let t = Translations::new(Language::PortuguesePT);
        assert_eq!(t.search_placeholder(), "Pesquisar...");
        assert_eq!(t.replace_placeholder(), "Substituir...");
        assert_eq!(t.case_sensitive_label(), "Diferenciar maiúsculas");
        assert_eq!(
            t.previous_match_tooltip(),
            "Correspondência anterior (Shift+F3)"
        );
        assert_eq!(
            t.next_match_tooltip(),
            "Próxima correspondência (F3 / Enter)"
        );
        assert_eq!(
            t.close_search_tooltip(),
            "Fechar diálogo de pesquisa (Esc)"
        );
        assert_eq!(
            t.replace_current_tooltip(),
            "Substituir correspondência actual"
        );
        assert_eq!(t.replace_all_tooltip(), "Substituir tudo");
    }

    #[test]
    fn test_language_switching() {
        let mut t = Translations::new(Language::English);
        assert_eq!(t.search_placeholder(), "Search...");

        t.set_language(Language::French);
        assert_eq!(t.search_placeholder(), "Rechercher...");

        t.set_language(Language::Spanish);
        assert_eq!(t.search_placeholder(), "Buscar...");

        t.set_language(Language::German);
        assert_eq!(t.search_placeholder(), "Suchen...");

        t.set_language(Language::Italian);
        assert_eq!(t.search_placeholder(), "Cerca...");

        t.set_language(Language::PortugueseBR);
        assert_eq!(t.search_placeholder(), "Pesquisar...");

        t.set_language(Language::PortuguesePT);
        assert_eq!(t.search_placeholder(), "Pesquisar...");

        t.set_language(Language::ChineseSimplified);
        assert_eq!(t.search_placeholder(), "搜索...");
    }

    #[test]
    fn test_context_menu_translations_cover_all_locales() {
        let cases = [
            (
                Language::English,
                [
                    "Undo",
                    "Redo",
                    "Cut",
                    "Copy",
                    "Paste",
                    "Select All",
                    "Reveal in Finder",
                    "Reveal in File Explorer",
                    "Open Containing Folder",
                ],
            ),
            (
                Language::French,
                [
                    "Annuler",
                    "Rétablir",
                    "Couper",
                    "Copier",
                    "Coller",
                    "Tout sélectionner",
                    "Révéler dans le Finder",
                    "Afficher dans l'Explorateur de fichiers",
                    "Ouvrir le dossier contenant",
                ],
            ),
            (
                Language::Spanish,
                [
                    "Deshacer",
                    "Rehacer",
                    "Cortar",
                    "Copiar",
                    "Pegar",
                    "Seleccionar todo",
                    "Mostrar en Finder",
                    "Mostrar en el Explorador de archivos",
                    "Abrir carpeta contenedora",
                ],
            ),
            (
                Language::German,
                [
                    "Rückgängig",
                    "Wiederholen",
                    "Ausschneiden",
                    "Kopieren",
                    "Einfügen",
                    "Alle auswählen",
                    "Im Finder anzeigen",
                    "Im Datei-Explorer anzeigen",
                    "Übergeordneten Ordner öffnen",
                ],
            ),
            (
                Language::Italian,
                [
                    "Annulla azione",
                    "Ripeti",
                    "Taglia",
                    "Copia",
                    "Incolla",
                    "Seleziona tutto",
                    "Visualizza in Finder",
                    "Visualizza in Esplora file",
                    "Apri cartella superiore",
                ],
            ),
            (
                Language::PortugueseBR,
                [
                    "Desfazer",
                    "Refazer",
                    "Recortar",
                    "Copiar",
                    "Colar",
                    "Selecionar Tudo",
                    "Revelar no Finder",
                    "Revelar no Explorador de Arquivos",
                    "Abrir a Pasta Que Contém",
                ],
            ),
            (
                Language::PortuguesePT,
                [
                    "Anular",
                    "Refazer",
                    "Cortar",
                    "Copiar",
                    "Colar",
                    "Selecionar tudo",
                    "Mostrar no Finder",
                    "Mostrar no Explorador de Ficheiros",
                    "Abrir pasta contentora",
                ],
            ),
            (
                Language::ChineseSimplified,
                [
                    "撤消",
                    "恢复",
                    "剪切",
                    "复制",
                    "粘贴",
                    "选择全部",
                    "在访达中显示",
                    "在文件资源管理器中显示",
                    "打开所在的文件夹",
                ],
            ),
        ];

        for (language, expected) in cases {
            let translations = Translations::new(language);
            assert_eq!(translations.context_menu_undo(), expected[0]);
            assert_eq!(translations.context_menu_redo(), expected[1]);
            assert_eq!(translations.context_menu_cut(), expected[2]);
            assert_eq!(translations.context_menu_copy(), expected[3]);
            assert_eq!(translations.context_menu_paste(), expected[4]);
            assert_eq!(translations.context_menu_select_all(), expected[5]);
            assert_eq!(
                translations.context_menu_reveal_in_finder(),
                expected[6]
            );
            assert_eq!(
                translations.context_menu_reveal_in_file_explorer(),
                expected[7]
            );
            assert_eq!(
                translations.context_menu_open_containing_folder(),
                expected[8]
            );
        }
    }

    #[test]
    fn test_every_command_palette_accessor_resolves_to_a_defined_key() {
        // What this can catch: a typo in an accessor's `t!` key path. rust-i18n
        // echoes the path back when it resolves to nothing, so the label comes
        // out starting with "command_palette.".
        //
        // What it cannot: a key missing from one locale. `fallback = "en"`
        // makes that resolve to the English string, which is neither empty nor
        // a key path. Locale completeness is checked structurally instead, by
        // `test_every_locale_defines_exactly_the_keys_english_defines`; the
        // loop over all eight languages here is what proves every accessor is
        // reachable in each of them, not that each has its own wording.
        let languages = [
            Language::English,
            Language::French,
            Language::Spanish,
            Language::German,
            Language::Italian,
            Language::PortugueseBR,
            Language::PortuguesePT,
            Language::ChineseSimplified,
        ];

        for language in languages {
            let t = Translations::new(language);
            let labels = [
                t.command_palette_placeholder(),
                t.command_palette_no_results(),
                t.command_palette_save(),
                t.command_palette_toggle_comment(),
                t.command_palette_move_line_up(),
                t.command_palette_move_line_down(),
                t.command_palette_duplicate_line_up(),
                t.command_palette_duplicate_line_down(),
                t.command_palette_goto_line(),
                t.command_palette_add_cursor_above(),
                t.command_palette_add_cursor_below(),
                t.command_palette_select_next_occurrence(),
                t.command_palette_toggle_vim_mode(),
                t.command_palette_find(),
                t.command_palette_replace(),
                t.command_palette_fold_at_cursor(),
                t.command_palette_fold_all(),
                t.command_palette_unfold_all(),
            ];

            for label in labels {
                assert!(!label.is_empty(), "empty label for {language:?}");
                assert!(
                    !label.starts_with("command_palette."),
                    "missing translation {label} for {language:?}"
                );
            }
        }
    }

    #[test]
    fn test_command_palette_labels_are_localized() {
        let cases = [
            (Language::English, "Fold All", "Go to Line"),
            (Language::French, "Tout replier", "Aller à la ligne"),
            (Language::Spanish, "Plegar todo", "Ir a la línea"),
            (Language::German, "Alles falten", "Gehe zu Zeile"),
            (Language::Italian, "Comprimi tutto", "Vai alla riga"),
            (Language::PortugueseBR, "Dobrar tudo", "Ir para a linha"),
            (Language::PortuguesePT, "Dobrar tudo", "Ir para a linha"),
            (Language::ChineseSimplified, "全部折叠", "转到行"),
        ];

        for (language, fold_all, goto_line) in cases {
            let t = Translations::new(language);
            assert_eq!(t.command_palette_fold_all(), fold_all);
            assert_eq!(t.command_palette_goto_line(), goto_line);
        }
    }
}