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
//! XML 节点模型 —— 对应 Java `freemarker.ext.dom.NodeModel`(roxmltree 只读 DOM)
use crate::core::Environment;
use crate::error::{Result, TemplateError};
use crate::template::{ModelKind, NodeHashModel, TModel, TemplateNodeModel};
use roxmltree::{Node, NodeId};
use std::rc::Rc;
use super::ns_prefixes::NsPrefixes;
use super::tree::XmlTree;
use super::xml_dom_string_util::{is_xml_name_like, xml_enc_nqg, xml_enc_qattr};
/// XML 节点 —— 对应 Java `NodeModel`(wrap 后的 W3C DOM 节点)。
/// roxmltree 的 `Node` 是 Copy 的轻量句柄(借树);`node_id` + `Rc<XmlTree>` 复现
/// 节点引用(Rust 无法直接持有带生命周期 Node 的 Self 引用结构)。
#[derive(Clone)]
pub struct XmlNode {
tree: Rc<XmlTree>,
node_id: NodeId,
/// Some(属性名):包装的是 node_id 元素上的属性节点(Java Attr 节点)
attr: Option<String>,
/// true: this node represents a DocumentType node
doctype: bool,
}
impl XmlNode {
/// 文档节点(Java NodeModel.wrap(Document);parse 入口)
pub fn parse(s: &str) -> Result<XmlNode> {
let tree = XmlTree::parse(s)?;
Ok(XmlNode {
node_id: tree.doc.root().id(),
tree,
attr: None,
doctype: false,
})
}
/// 取 roxmltree 节点(借用 &self → 树必然存活)
fn node(&self) -> Node<'_, 'static> {
// get_node 对根(文档节点)返回 root;NodeId 0 = root
self.tree
.doc
.get_node(self.node_id)
.expect("XmlNode 的 node_id 必然有效")
}
fn is_attr(&self) -> bool {
self.attr.is_some()
}
/// 元素/文档节点的属性迭代(xmlns:* 声明不算属性)
fn attributes(&self) -> Vec<roxmltree::Attribute<'_, 'static>> {
let n = self.node();
if !n.is_element() {
return Vec::new();
}
n.attributes()
.filter(|a| !a.name().starts_with("xmlns"))
.collect()
}
/// 子节点(Java simplify 后:注释/PI 已移除;text 与元素保留;
/// 文档节点含 doctype 时按 DOM 顺序注入 DocumentType 节点)
fn child_nodes(&self) -> Vec<XmlNode> {
let mut out = Vec::new();
// 文档节点且有 doctype 时,在第一个元素子节点前注入 DocumentType 节点
let is_root = self.node().node_type() == roxmltree::NodeType::Root;
let mut doctype_injected = false;
for c in self.node().children() {
if matches!(
c.node_type(),
roxmltree::NodeType::Comment | roxmltree::NodeType::PI
) {
continue;
}
// 在第一个元素子节点前注入 doctype 节点(DOM 顺序:doctype 在元素前)
if is_root && !doctype_injected && c.is_element() && self.tree.doctype.is_some() {
out.push(XmlNode {
tree: self.tree.clone(),
node_id: self.node_id, // 复用根节点 id(doctype 不是真实 DOM 节点)
attr: None,
doctype: true,
});
doctype_injected = true;
}
out.push(XmlNode {
tree: self.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
});
}
// 若没有元素子节点但有 doctype(如空文档),仍注入
if is_root && !doctype_injected && self.tree.doctype.is_some() {
out.push(XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: None,
doctype: true,
});
}
out
}
/// 下一兄弟节点(Java getNextSibling:simplify 后兄弟链不含注释/PI;
/// 属性节点无兄弟)
fn next_sibling_node(&self) -> Option<XmlNode> {
if self.is_attr() {
return None;
}
let mut seen_self = false;
for c in self.node().parent()?.children() {
if c.id() == self.node_id {
seen_self = true;
continue;
}
if seen_self
&& !matches!(
c.node_type(),
roxmltree::NodeType::Comment | roxmltree::NodeType::PI
)
{
return Some(XmlNode {
tree: self.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
});
}
}
None
}
/// 上一兄弟节点(Java getPreviousSibling)
fn previous_sibling_node(&self) -> Option<XmlNode> {
if self.is_attr() {
return None;
}
let mut prev = None;
for c in self.node().parent()?.children() {
if c.id() == self.node_id {
return prev;
}
if !matches!(
c.node_type(),
roxmltree::NodeType::Comment | roxmltree::NodeType::PI
) {
prev = Some(XmlNode {
tree: self.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
});
}
}
None
}
/// 子元素(Java NodeListModel 按名称过滤时只考虑元素)
fn child_elements(&self) -> Vec<XmlNode> {
self.child_nodes()
.into_iter()
.filter(|c| c.node().is_element())
.collect()
}
/// 全部后代元素(文档序;Java `**` / XPath `//*`)
fn descendant_elements(&self) -> Vec<XmlNode> {
let mut out = Vec::new();
for d in self.node().descendants() {
if d.is_element() {
out.push(XmlNode {
tree: self.tree.clone(),
node_id: d.id(),
attr: None,
doctype: false,
});
}
}
out
}
/// 元素本地名 / 文本 / 属性名(Java getNodeName 的各实现)
fn node_name(&self) -> Option<String> {
if self.doctype {
// Java DocumentTypeModel.getNodeName:"@document_type$" + name
let name = self.tree.doctype.as_ref()?.name.clone();
return Some(format!("@document_type${name}"));
}
if let Some(an) = &self.attr {
// Java AttributeNodeModel.getNodeName:localName
return Some(local_part(an));
}
let n = self.node();
match n.node_type() {
roxmltree::NodeType::Element => {
// Java ElementModel.getNodeName:getLocalName()
Some(n.tag_name().name().to_string())
}
roxmltree::NodeType::Root => Some("@document".to_string()),
roxmltree::NodeType::Text => Some("@text".to_string()),
roxmltree::NodeType::Comment => Some("@comment".to_string()),
roxmltree::NodeType::PI => {
// Java PINodeModel.getNodeName:"@pi$" + target
Some(format!("@pi${}", n.pi().map(|p| p.target).unwrap_or("")))
}
}
}
/// 节点类型(Java NodeModel.getNodeType:CDATA 也算 "text";PI = "pi";
/// doctype = "document_type")
fn node_type(&self) -> String {
if self.doctype {
return "document_type".to_string();
}
if self.is_attr() {
return "attribute".to_string();
}
match self.node().node_type() {
roxmltree::NodeType::Element => "element".to_string(),
roxmltree::NodeType::Root => "document".to_string(),
roxmltree::NodeType::Text => "text".to_string(),
roxmltree::NodeType::Comment => "comment".to_string(),
roxmltree::NodeType::PI => "pi".to_string(),
}
}
/// 节点命名空间(Java NodeModel.getNodeNamespace:元素无命名空间 → "";
/// 属性 → URI 或 null;其余节点 → null)
fn node_namespace(&self) -> Option<String> {
if self.is_attr() {
let n = self.node();
if n.is_element() {
for a in n.attributes() {
if local_part(a.name()) == self.attr.as_deref().unwrap_or("") {
let ns = a.namespace();
return match ns {
Some(ns) if !ns.is_empty() => Some(ns.to_string()),
_ => None,
};
}
}
}
return None;
}
match self.node().node_type() {
roxmltree::NodeType::Element => {
Some(self.node().tag_name().namespace().unwrap_or("").to_string())
}
_ => None,
}
}
/// 文本内容(Java NodeModel.getText:text → data;element → 子文本拼接;
/// document → 文档元素文本;其余 → "")
fn text_content(&self) -> String {
if self.is_attr() {
return self.attribute_value().unwrap_or_default();
}
let n = self.node();
match n.node_type() {
roxmltree::NodeType::Text => n.text().unwrap_or("").to_string(),
roxmltree::NodeType::Element => {
let mut out = String::new();
for c in n.children() {
if c.is_text() {
out.push_str(c.text().unwrap_or(""));
} else if c.is_element() {
// 子元素内文本(Java getText 递归;注释/PI 不产出文本)
let sub = XmlNode {
tree: self.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
};
out.push_str(&sub.text_content());
}
}
out
}
roxmltree::NodeType::Root => {
let mut out = String::new();
for c in n.children() {
if c.is_element() {
let sub = XmlNode {
tree: self.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
};
out.push_str(&sub.text_content());
}
}
out
}
_ => String::new(),
}
}
/// 标量值(Java 各模型 getAsString:元素仅允许无元素子节点;文本 = data;
/// 属性 = value;PI = data;注释 = data;doctype = 原始声明串)
fn scalar_value(&self) -> Result<String> {
// doctype 节点:返回原始声明串(Java 的 getAsString 是 ProcessingInstruction
// 误转型怪癖——按 DOM 真实语义降级为返回原始声明串)
if self.doctype {
return Ok(self
.tree
.doctype
.as_ref()
.map(|d| d.raw.clone())
.unwrap_or_default());
}
if let Some(v) = self.attribute_value() {
return Ok(v);
}
let n = self.node();
match n.node_type() {
roxmltree::NodeType::Element => {
// Java ElementModel.getAsString:子元素 → 报错
for c in n.children() {
if c.is_element() {
return Err(TemplateError::misc(format!(
"Only elements with no child elements can be processed as text.\nThis element with name \"{}\" has a child element named: {}",
self.node_name().unwrap_or_default(),
c.tag_name().name()
)));
}
}
Ok(self.text_content())
}
roxmltree::NodeType::Text | roxmltree::NodeType::Comment => {
Ok(n.text().unwrap_or("").to_string())
}
roxmltree::NodeType::PI => Ok(n
.pi()
.map(|p| p.value.unwrap_or(""))
.unwrap_or("")
.to_string()),
_ => Err(TemplateError::type_mismatch("string", "node")),
}
}
/// 属性值(仅 attr 包装 / 元素属性查询)
fn attribute_value(&self) -> Option<String> {
let an = self.attr.as_deref()?;
let n = self.node();
if !n.is_element() {
return None;
}
// Java ElementModel.getAttribute:先精确 qname,再按前缀解析命名空间
for a in n.attributes() {
if a.name() == an || attr_qualified_name(n, a) == an {
return Some(a.value().to_string());
}
}
None
}
/// 父节点(Java getParentNode:元素的父可能是 document;属性的父 = 宿主元素)
fn parent_node(&self) -> Option<XmlNode> {
if self.attr.is_some() {
// 属性节点:父 = 宿主元素
return Some(XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: None,
doctype: false,
});
}
let n = self.node();
if n.node_type() == roxmltree::NodeType::Root {
return None;
}
n.parent().map(|p| XmlNode {
tree: self.tree.clone(),
node_id: p.id(),
attr: None,
doctype: false,
})
}
/// 文档节点(Java getDocumentNodeModel)
fn document_node(&self) -> XmlNode {
XmlNode {
tree: self.tree.clone(),
node_id: self.tree.doc.root().id(),
attr: None,
doctype: false,
}
}
/// 根元素(Java DocumentModel.getRootElement / Document.getDocumentElement)
fn root_element(&self) -> Option<XmlNode> {
let n = self.node().document().root_element();
Some(XmlNode {
tree: self.tree.clone(),
node_id: n.id(),
attr: None,
doctype: false,
})
}
// -----------------------------------------------------------------------
// 哈希键访问(Java NodeModel.get / ElementModel.get / DocumentModel.get)
// -----------------------------------------------------------------------
/// 键访问入口(NodeHashModel::get)—— 返回 None = 键缺失
pub(crate) fn hash_get(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
if key.starts_with("@@") {
return Ok(Some(self.atat_key(env, key)?));
}
if self.doctype {
// Java DocumentTypeModel.get:访问 DTD 属性不支持
return Err(TemplateError::misc(
"accessing properties of a DTD is not currently supported",
));
}
if self.is_attr() {
// 属性节点:Java NodeModel.get → XPath(子集在属性节点上无意义)
return Ok(None);
}
let n = self.node();
match n.node_type() {
roxmltree::NodeType::Element => self.element_key(env, key),
roxmltree::NodeType::Root => self.document_key(env, key),
// 文本/注释/PI:Java NodeModel.get → XPath(子集对无后代节点恒空)
_ => Ok(Some(TModel::from_sequence(Vec::new()))),
}
}
/// 元素节点键(Java ElementModel.get)
fn element_key(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
match key {
"*" => {
// 全部直接子元素(NodeListModel,含空)
let kids: Vec<TModel> = self
.child_elements()
.into_iter()
.map(|c| c.into_model())
.collect();
Ok(Some(TModel::from_sequence(kids)))
}
"**" => {
// 全部后代元素(Java getElementsByTagName("*"))
let kids: Vec<TModel> = self
.descendant_elements()
.into_iter()
.map(|c| c.into_model())
.collect();
Ok(Some(TModel::from_sequence(kids)))
}
_ if key.starts_with('@') => {
// `@attr` → 属性节点(缺失 → 空序列);`@*` → 全部属性
if key == "@*" {
let attrs: Vec<TModel> = self
.attributes()
.into_iter()
.map(|a| {
XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: Some(a.name().to_string()),
doctype: false,
}
.into_model()
})
.collect();
return Ok(Some(TModel::from_sequence(attrs)));
}
let an = &key[1..];
if !is_xml_name_like(an) {
// 非 XML 名(如 "@@" 已在上层处理;其余回退 XPath 子集)
return self.xpath_subset(env, key);
}
match self.lookup_attribute(env, an) {
Some(xn) => Ok(Some(xn.into_model())),
None => Ok(Some(TModel::from_sequence(Vec::new()))),
}
}
_ if is_xml_name_like(key) => self.filter_child_by_name(env, key),
_ => self.xpath_subset(env, key),
}
}
/// 子元素按名过滤:恰 1 个 → 节点;否则序列(Java ElementModel.get 的
/// filterByName 语义,ElementModel.java:123-124)
fn filter_child_by_name(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
let matches: Vec<TModel> = self
.child_elements()
.into_iter()
.filter(|c| c.matches_name(env, key))
.map(|c| c.into_model())
.collect();
if matches.len() == 1 {
Ok(Some(matches.into_iter().next().unwrap()))
} else {
Ok(Some(TModel::from_sequence(matches)))
}
}
/// 文档节点键(Java DocumentModel.get)
fn document_key(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
match key {
"*" => {
// 文档的 `*` → 根元素(Java getRootElement())
Ok(self.root_element().map(|r| r.into_model()))
}
"**" => {
let kids: Vec<TModel> = self
.descendant_elements()
.into_iter()
.map(|c| c.into_model())
.collect();
Ok(Some(TModel::from_sequence(kids)))
}
_ if is_xml_name_like(key) => {
// 根元素名匹配(Java DocumentModel.get:matchesName → 根元素,否则空序列)
match self.root_element() {
Some(root) if root.matches_name(env, key) => Ok(Some(root.into_model())),
_ => Ok(Some(TModel::from_sequence(Vec::new()))),
}
}
_ => self.xpath_subset(env, key),
}
}
/// 属性查找(Java ElementModel.getAttribute:精确 qname 优先,
/// 带前缀时按环境 ns_prefixes 解析命名空间)
fn lookup_attribute(&self, env: &mut Environment, qname: &str) -> Option<XmlNode> {
let n = self.node();
if !n.is_element() {
return None;
}
let mut by_ns: Option<XmlNode> = None;
for a in n.attributes() {
if attr_qualified_name(n, a) == qname {
return Some(XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: Some(a.name().to_string()),
doctype: false,
});
}
// 前缀形式 `p:attr`:解析 p → URI,匹配 (URI, localName)
if let Some((prefix, local)) = qname.split_once(':') {
let uri = if prefix == "D" {
env.current_ns_prefixes()
.get_default_ns()
.map(str::to_string)
} else {
env.current_ns_prefixes()
.get_namespace_for_prefix(prefix)
.filter(|u| !u.is_empty())
.map(str::to_string)
};
if let Some(uri) = uri {
if a.namespace() == Some(uri.as_str()) && a.name() == local {
by_ns = Some(XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: Some(local.to_string()),
doctype: false,
});
}
}
}
}
by_ns
}
/// 名称匹配(Java DomStringUtil.matchesName + ElementModel.matchesName)
fn matches_name(&self, env: &mut Environment, qname: &str) -> bool {
let node_name = self.node_name().unwrap_or_default();
let ns_uri = self.node_namespace().unwrap_or_default();
let prefixes = env.current_ns_prefixes();
let default_ns = prefixes.get_default_ns();
if let Some(dns) = default_ns {
if dns == ns_uri {
return qname == node_name || qname == format!("D:{node_name}");
}
}
if ns_uri.is_empty() {
return if default_ns.is_some() {
qname == format!("N:{node_name}")
} else {
qname == node_name || qname == format!("N:{node_name}")
};
}
match prefixes.get_prefix_for_namespace(&ns_uri) {
Some(p) => qname == format!("{p}:{node_name}"),
None => false,
}
}
// -----------------------------------------------------------------------
// @@ 特殊键(Java AtAtKey 集合 + 本实现扩展键)
// -----------------------------------------------------------------------
fn atat_key(&self, env: &mut Environment, key: &str) -> Result<TModel> {
let text = |m: &XmlNode| Ok(TModel::from_scalar(m.text_content()));
let mut markup = |m: &XmlNode| Ok(TModel::from_scalar(m.markup(env)));
match key {
"@@markup" => markup(self),
"@@nested_markup" => {
// Java:children 序列化
let mut buf = String::new();
for c in self.child_nodes() {
buf.push_str(&c.markup(env));
}
Ok(TModel::from_scalar(buf))
}
"@@text" => text(self),
"@@namespace" => match self.node_namespace() {
Some(ns) if !ns.is_empty() => Ok(TModel::from_scalar(ns)),
_ => Ok(TModel::nothing()), // Java 返回 null → 缺失
},
"@@local_name" => {
let name = self.node_name().unwrap_or_default();
Ok(TModel::from_scalar(name))
}
"@@qname" => match self.qualified_name(env) {
Some(q) => Ok(TModel::from_scalar(q)),
None => Ok(TModel::nothing()),
},
// 元素专用键(Java ElementModel.get)
"@@" => {
// 属性节点序列
let attrs: Vec<TModel> = self
.attributes()
.into_iter()
.map(|a| {
XmlNode {
tree: self.tree.clone(),
node_id: self.node_id,
attr: Some(a.name().to_string()),
doctype: false,
}
.into_model()
})
.collect();
Ok(TModel::from_sequence(attrs))
}
"@@start_tag" | "@@end_tag" => {
let n = self.node();
if !n.is_element() {
return Err(TemplateError::misc(format!(
"\"{key}\" is not supported for an XML node of type \"{}\".",
self.node_type()
)));
}
let mark = self.markup(env);
if key == "@@start_tag" {
// <qname decl attrs>
let inner = mark
.strip_prefix('<')
.and_then(|s| s.split_once('>'))
.map(|(s, _)| format!("<{s}>"))
.unwrap_or(mark);
Ok(TModel::from_scalar(inner))
} else {
// </qname>
let name = self.qualified_name(env).unwrap_or_default();
Ok(TModel::from_scalar(format!("</{name}>")))
}
}
"@@attributes_markup" => {
let mut buf = String::new();
for a in self.attributes() {
buf.push(' ');
buf.push_str(&attr_qualified_name(self.node(), a));
buf.push_str("=\"");
buf.push_str(&xml_enc_qattr(a.value()));
buf.push('"');
}
Ok(TModel::from_scalar(buf.trim().to_string()))
}
"@@previous_sibling_element" | "@@next_sibling_element" => {
let n = self.node();
let target = if key == "@@previous_sibling_element" {
n.prev_sibling_element()
} else {
n.next_sibling_element()
};
match target {
Some(t) => Ok(XmlNode {
tree: self.tree.clone(),
node_id: t.id(),
attr: None,
doctype: false,
}
.into_model()),
None => Ok(TModel::from_sequence(Vec::new())),
}
}
// ---- 本实现扩展键(对应任务清单;Java 2.3.34 无这些键,报 Unsupported)----
"@@children" | "@@nested" => {
let kids: Vec<TModel> = self
.child_nodes()
.into_iter()
.map(|c| c.into_model())
.collect();
Ok(TModel::from_sequence(kids))
}
"@@tag_name" => {
let n = self.node();
if n.is_element() {
Ok(TModel::from_scalar(
self.qualified_name(env).unwrap_or_default(),
))
} else {
Ok(TModel::from_scalar(self.node_name().unwrap_or_default()))
}
}
// @@nodeName:节点名(元素标签名/文本 "@text"/文档 "@document" 等,
// 与 ?node_name 内建一致 —— Java getNodeName 语义;2.3.34 的 AtAtKey
// 无此键,本实现按任务清单作为扩展键提供,见 tests/xml_coverage.rs)
"@@nodeName" => Ok(TModel::from_scalar(self.node_name().unwrap_or_default())),
"@@name" => Ok(TModel::from_scalar(self.node_name().unwrap_or_default())),
"@@type" => Ok(TModel::from_scalar(self.node_type())),
_ => Err(TemplateError::misc(format!("Unsupported @@ key: {key}"))),
}
}
/// 限定名(Java ElementModel.getQualifiedName:nsURI 经环境前缀映射;
/// 无映射 → null)
fn qualified_name(&self, env: &mut Environment) -> Option<String> {
let node_name = self.node_name()?;
if self.is_attr() {
// Java AttributeNodeModel.getQualifiedName
let ns = self.node_namespace();
return match ns {
None => Some(node_name),
Some(ns) => {
let prefixes = env.current_ns_prefixes();
let default_ns = prefixes.get_default_ns();
let prefix = if default_ns == Some(ns.as_str()) {
"D".to_string()
} else {
prefixes.get_prefix_for_namespace(&ns)?.to_string()
};
Some(format!("{prefix}:{node_name}"))
}
};
}
let ns = self.node_namespace();
match ns {
None => Some(node_name),
Some(ns) if ns.is_empty() => Some(node_name),
Some(ns) => {
let prefixes = env.current_ns_prefixes();
let default_ns = prefixes.get_default_ns();
let prefix = if default_ns == Some(ns.as_str()) {
""
} else {
prefixes.get_prefix_for_namespace(&ns)?
};
if prefix.is_empty() {
Some(node_name)
} else {
Some(format!("{prefix}:{node_name}"))
}
}
}
}
// -----------------------------------------------------------------------
// XPath 子集(Java NodeModel.get 的非特殊键 → Xalan/Jaxen XPath 引擎;
// 本实现仅支持任务规定的子集:`/`、`//name`、`//*`、`[n]`)
// -----------------------------------------------------------------------
fn xpath_subset(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
if key == "/" {
// XPath "/":上下文节点的文档根
return Ok(Some(self.document_node().into_model()));
}
if key == "true()" {
// XPath true() 函数(default-xmlns 用例:`doc["true()"]` → 布尔 true;
// Java XPath 对常量函数求值)
return Ok(Some(TModel::from_boolean(true)));
}
if let Some(rest) = key.strip_prefix("./") {
// 相对路径 `./name`:当前节点的子元素按名过滤(XPath child::axis;
// default-xmlns 用例 `r["./D:t4"]`)
return self.filter_child_by_name(env, rest);
}
if let Some(rest) = key.strip_prefix("//") {
// 后代元素匹配(descendant-or-self::node()/child::X —— 不含自身)。
// 名称匹配用 ElementModel.matchesName(DomStringUtil.matchesName,
// DomStringUtil.java:73-90):无前缀名在元素命名空间 == 模板默认命名
// 空间(ns_prefixes 声明的 D)时匹配——Java Jaxen 的 customNamespaceContext
// 把无前缀名解析为 getNamespaceForPrefix("") = 默认 NS
// (JaxenXPathSupport.java customNamespaceContext + Template.java
// getNamespaceForPrefix(""))。`//*` 通配匹配全部元素(XPath 1.0 的
// `*` 名称测试与命名空间无关)。
let (_, _, wildcard) = split_qname(rest)?;
let mut matches = Vec::new();
for d in self.node().descendants() {
if !d.is_element() {
continue;
}
let d_node = XmlNode {
tree: self.tree.clone(),
node_id: d.id(),
attr: None,
doctype: false,
};
if wildcard || d_node.matches_name(env, rest) {
matches.push(d_node);
}
}
let models: Vec<TModel> = matches.into_iter().map(|m| m.into_model()).collect();
if models.len() == 1 {
return Ok(Some(models.into_iter().next().unwrap()));
}
return Ok(Some(TModel::from_sequence(models)));
}
if key.starts_with('[') && key.ends_with(']') {
// `[n]`:第 n 个子元素(1 起始;dom4j 风格扩展 —— 完整 XPath 不支持)
let idx: usize = match key[1..key.len() - 1].trim().parse() {
Ok(i) => i,
Err(_) => {
return Err(TemplateError::misc(format!(
"Unsupported XPath query: {key}"
)))
}
};
if idx == 0 {
return Err(TemplateError::misc(format!(
"Unsupported XPath query: {key}"
)));
}
let kids = self.child_elements();
if idx <= kids.len() {
return Ok(Some(kids[idx - 1].clone().into_model()));
}
return Ok(Some(TModel::from_sequence(Vec::new())));
}
Err(TemplateError::misc(format!(
"Unsupported XPath query: {key}"
)))
}
// -----------------------------------------------------------------------
// @@markup 序列化(Java NodeOutputter)
// -----------------------------------------------------------------------
/// XML 标记(Java NodeModel.getMarkup → NodeOutputter.outputContent(node))
fn markup(&self, env: &mut Environment) -> String {
let prefixes = env.current_ns_prefixes();
let default_ns = prefixes.get_default_ns().map(str::to_string);
let has_default_ns = default_ns.as_deref().is_some_and(|s| !s.is_empty());
// 前缀查找表(插入序):null → ""、"" → "",随后按子树节点 nsURI 填充
let mut lookup: Vec<(Option<String>, String)> = vec![(None, String::new())];
let mut next_gen = 1usize;
build_prefix_lookup(
&self.node(),
&prefixes,
has_default_ns,
default_ns.as_deref(),
&mut lookup,
&mut next_gen,
);
if let Some(dns) = &default_ns {
if !lookup
.iter()
.any(|(u, _)| u.as_deref() == Some(dns.as_str()))
{
lookup.push((Some(dns.clone()), String::new()));
}
}
// namespaceDecl(Java constructNamespaceDecl)
let mut ns_decl = String::new();
for (uri, prefix) in &lookup {
let Some(uri) = uri else { continue };
if uri.is_empty() {
continue;
}
ns_decl.push_str(" xmlns");
if !prefix.is_empty() {
ns_decl.push(':');
ns_decl.push_str(prefix);
}
ns_decl.push_str("=\"");
ns_decl.push_str(uri);
ns_decl.push('"');
}
// 序列化(Java outputContent(node))
let mut buf = String::new();
self.output_content(&prefixes, &lookup, &ns_decl, &mut buf);
buf
}
fn output_content(
&self,
prefixes: &NsPrefixes,
lookup: &[(Option<String>, String)],
ns_decl: &str,
buf: &mut String,
) {
if self.is_attr() {
// 属性(Java outputContent(Attr):` qname="value"`)
if let Some(v) = self.attribute_value() {
buf.push(' ');
buf.push_str(&self.output_qname(prefixes, lookup));
buf.push_str("=\"");
buf.push_str(&xml_enc_qattr(&v));
buf.push('"');
}
return;
}
let n = self.node();
match n.node_type() {
roxmltree::NodeType::Root => {
for c in self.child_nodes() {
c.output_content(prefixes, lookup, ns_decl, buf);
}
}
roxmltree::NodeType::Element => {
buf.push('<');
buf.push_str(&self.output_qname(prefixes, lookup));
// 上下文节点(Java NodeOutputter.contextNode)附 namespaceDecl
if Some(self.node_id) == self.tree.doc.root_element().id().into() {
buf.push_str(ns_decl);
}
// 属性(排除 xmlns:*)
for a in n.attributes() {
if a.name().starts_with("xmlns") {
continue;
}
buf.push(' ');
buf.push_str(&attr_qualified_name(self.node(), a));
buf.push_str("=\"");
buf.push_str(&xml_enc_qattr(a.value()));
buf.push('"');
}
let kids = self.child_nodes();
if kids.is_empty() {
buf.push_str(" />");
} else {
buf.push('>');
for c in kids {
c.output_content(prefixes, lookup, ns_decl, buf);
}
buf.push_str("</");
buf.push_str(&self.output_qname(prefixes, lookup));
buf.push('>');
}
}
roxmltree::NodeType::Text => {
buf.push_str(&xml_enc_nqg(n.text().unwrap_or("")));
}
roxmltree::NodeType::Comment => {
buf.push_str("<!--");
buf.push_str(n.text().unwrap_or(""));
buf.push_str("-->");
}
roxmltree::NodeType::PI => {
if let Some(pi) = n.pi() {
buf.push_str("<?");
buf.push_str(pi.target);
buf.push(' ');
buf.push_str(pi.value.unwrap_or(""));
buf.push_str("?>");
}
}
}
}
/// 限定名输出(Java NodeOutputter.outputQualifiedName:经前缀查找表)
fn output_qname(&self, _prefixes: &NsPrefixes, lookup: &[(Option<String>, String)]) -> String {
if self.is_attr() {
return self.attr.as_deref().unwrap_or_default().to_string();
}
let n = self.node();
let local = n.tag_name().name();
match n.tag_name().namespace() {
None | Some("") => local.to_string(),
Some(uri) => match lookup.iter().find(|(u, _)| u.as_deref() == Some(uri)) {
Some((_, p)) if !p.is_empty() => format!("{p}:{local}"),
_ => local.to_string(),
},
}
}
/// 构造 TModel(node + node_hash + scalar 角色;Java NodeModel 单对象多角色)
pub(crate) fn into_model(self) -> TModel {
// Java:element/text/comment/attr/PI 实现 TemplateScalarModel;document 不实现;
// doctype 实现 TemplateScalarModel(返回原始声明串)
let is_document = self.node_type() == "document" && !self.doctype;
let mut m = TModel::nothing();
m.node = Some(Rc::new(self.clone()) as Rc<dyn TemplateNodeModel>);
m.node_hash = Some(Rc::new(self.clone()) as Rc<dyn NodeHashModel>);
if !is_document {
m.scalar = Some(Rc::new(self) as Rc<dyn crate::template::TemplateScalarModel>);
}
m.type_name = "node";
m.kind = ModelKind::Node;
m
}
}
impl TemplateNodeModel for XmlNode {
fn parent(&self) -> Result<Option<TModel>> {
Ok(self.parent_node().map(|p| p.into_model()))
}
fn children(&self) -> Result<Vec<TModel>> {
if self.doctype {
// Java DocumentTypeModel.getChildren:DTD 子节点不支持
return Err(TemplateError::misc(
"entering the child nodes of a DTD node is not currently supported",
));
}
if self.is_attr() {
return Ok(Vec::new());
}
Ok(self
.child_nodes()
.into_iter()
.map(|c| c.into_model())
.collect())
}
fn next_sibling(&self) -> Result<Option<TModel>> {
Ok(self.next_sibling_node().map(|n| n.into_model()))
}
fn previous_sibling(&self) -> Result<Option<TModel>> {
Ok(self.previous_sibling_node().map(|n| n.into_model()))
}
fn name(&self) -> Result<Option<String>> {
Ok(self.node_name())
}
fn node_type(&self) -> Result<String> {
Ok(self.node_type())
}
fn namespace(&self) -> Result<Option<String>> {
Ok(self.node_namespace())
}
}
/// 标量角色(Java element/text/attr/PI/comment 的 getAsString;document 无此角色)
impl crate::template::TemplateScalarModel for XmlNode {
fn as_string(&self) -> Result<String> {
self.scalar_value()
}
}
impl NodeHashModel for XmlNode {
fn get(&self, env: &mut Environment, key: &str) -> Result<Option<TModel>> {
self.hash_get(env, key)
}
}
/// XML 解析入口 —— 对应 Java `NodeModel.parse(InputSource)`(simplify:注释/PI 移除)
pub fn parse_xml(s: &str) -> Result<TModel> {
Ok(XmlNode::parse(s)?.into_model())
}
// ---------------------------------------------------------------------------
// 工具函数
// ---------------------------------------------------------------------------
/// 本地名(去掉前缀)
fn local_part(name: &str) -> String {
match name.rsplit_once(':') {
Some((_, l)) => l.to_string(),
None => name.to_string(),
}
}
/// 属性的 qualified name(DOM4J getQualifiedName:`prefix:local` 或 `local`)。
/// roxmltree Attribute 只有本地名 + namespace URI,前缀从元素的 xmlns 声明反查。
fn attr_qualified_name(el: roxmltree::Node, attr: roxmltree::Attribute) -> String {
let local = attr.name();
let Some(ns) = attr.namespace() else {
return local.to_string();
};
// 在元素上查找 xmlns:prefix="uri" 声明,反查前缀
for a in el.attributes() {
if let Some(prefix) = a.name().strip_prefix("xmlns:") {
if a.value() == ns {
return format!("{prefix}:{local}");
}
}
}
local.to_string()
}
/// 属性/文本编码(Java StringUtil.XMLEncQAttr:< > & " → 实体;' 不转义)
fn split_qname(s: &str) -> Result<(Option<String>, String, bool)> {
if s == "*" {
return Ok((None, String::new(), true));
}
if s.is_empty() || s.starts_with('@') || s.starts_with('[') {
return Err(TemplateError::misc(format!(
"Unsupported XPath query: //{s}"
)));
}
match s.split_once(':') {
Some((p, l)) if !p.is_empty() && !l.is_empty() => {
Ok((Some(p.to_string()), l.to_string(), false))
}
Some(_) => Err(TemplateError::misc(format!(
"Unsupported XPath query: //{s}"
))),
None => Ok((None, s.to_string(), false)),
}
}
/// Java NodeOutputter.buildPrefixLookup:递归子树,nsURI → 前缀(模板映射或生成)
fn build_prefix_lookup(
n: &Node<'_, 'static>,
prefixes: &NsPrefixes,
has_default_ns: bool,
default_ns: Option<&str>,
lookup: &mut Vec<(Option<String>, String)>,
next_gen: &mut usize,
) {
let ns_uri = n.tag_name().namespace();
if let Some(uri) = ns_uri {
if !uri.is_empty() {
let prefix = match prefixes.get_prefix_for_namespace(uri) {
Some(p) => p.to_string(),
None => {
let existing = lookup
.iter()
.find(|(u, _)| u.as_deref() == Some(uri))
.map(|(_, p)| p.clone());
match existing {
Some(p) => p,
None => {
// 生成前缀(Java StringUtil.toLowerABC:a, b, ..., aa...)
loop {
let mut m = *next_gen;
*next_gen += 1;
let mut p = String::new();
while m > 0 {
m -= 1;
p.insert(0, char::from(b'a' + (m % 26) as u8));
m /= 26;
}
if prefixes.get_namespace_for_prefix(&p).is_none() {
break p;
}
}
}
}
}
};
if !lookup.iter().any(|(u, _)| u.as_deref() == Some(uri)) {
lookup.push((Some(uri.to_string()), prefix));
}
}
} else if has_default_ns {
if let Some(dns) = default_ns {
if !lookup.iter().any(|(u, _)| u.as_deref() == Some(dns)) {
// 当前节点没有命名空间时,默认命名空间仍须以空前缀声明;
// 使用字面量 "D" 会错误地把子节点序列化成 `D:book`。
lookup.push((Some(dns.to_string()), String::new()));
}
}
}
for c in n.children() {
if c.is_element() {
build_prefix_lookup(&c, prefixes, has_default_ns, default_ns, lookup, next_gen);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::template::{Configuration, Template};
use std::collections::HashMap;
fn markup_with_prefixes(doc: &XmlNode, ns_prefixes: HashMap<String, String>) -> String {
let mut template = Template::new(
"xml-test.ftl".to_string(),
Vec::new(),
HashMap::new(),
Rc::new(Configuration::new()),
);
template.ns_prefixes = ns_prefixes;
let mut out = Vec::new();
let mut env = Environment::new(&template, TModel::nothing(), &mut out);
doc.markup(&mut env)
}
#[test]
fn ns_prefixes_default_ns() {
let mut m = HashMap::new();
m.insert("D".to_string(), "http://d".to_string());
m.insert("n".to_string(), "http://n".to_string());
let p = NsPrefixes::new(m);
assert_eq!(p.get_default_ns(), Some("http://d"));
assert_eq!(p.get_namespace_for_prefix("n"), Some("http://n"));
assert_eq!(p.get_prefix_for_namespace("http://d"), Some(""));
assert_eq!(p.get_prefix_for_namespace("http://n"), Some("n"));
assert_eq!(p.get_prefix_for_namespace(""), Some("N"));
}
#[test]
fn xml_markup_document() {
let doc = XmlNode::parse("<root xmlns:n=\"http://x\"><a><b><c xmlns=\"http://x\">C<>&\"']]></c></b></a></root>").unwrap();
assert_eq!(
markup_with_prefixes(&doc, HashMap::new()),
"<root xmlns:a=\"http://x\"><a><b><a:c>C<>&\"']]></a:c></b></a></root>"
);
}
#[test]
fn xml_markup_default_ns() {
let doc = XmlNode::parse(
"<eb:book xmlns:eb=\"http://example.com/eBook\">\n <eb:title>Test Book</eb:title>\n</eb:book>",
)
.unwrap();
let mut m = HashMap::new();
m.insert("D".to_string(), "http://example.com/eBook".to_string());
assert_eq!(
markup_with_prefixes(&doc, m),
"<book xmlns=\"http://example.com/eBook\">\n <title>Test Book</title>\n</book>"
);
}
}
#[cfg(test)]
mod sibling_tests {
use super::*;
/// ?next_sibling / ?previous_sibling(BuiltInsForNodes):兄弟链不含注释/PI
#[test]
fn node_siblings() {
let doc = XmlNode::parse("<root><a/>text<b/><!--c--><c/></root>").unwrap();
// root 元素(doc 是文档节点)的 children:[a, text, b, c](注释被过滤)
let root_el = doc.node().children().next().unwrap();
let children = root_el.children().collect::<Vec<_>>();
let a = children
.iter()
.find(|n| n.tag_name().name() == "a")
.unwrap();
let b = children
.iter()
.find(|n| n.tag_name().name() == "b")
.unwrap();
let c = children
.iter()
.find(|n| n.tag_name().name() == "c")
.unwrap();
let a_node = XmlNode {
tree: doc.tree.clone(),
node_id: a.id(),
attr: None,
doctype: false,
};
let b_node = XmlNode {
tree: doc.tree.clone(),
node_id: b.id(),
attr: None,
doctype: false,
};
let c_node = XmlNode {
tree: doc.tree.clone(),
node_id: c.id(),
attr: None,
doctype: false,
};
// a 的下一个兄弟 = text 节点(不是 b;b 是 text 之后)
let nxt = a_node.next_sibling().unwrap().unwrap();
assert_eq!(nxt.node.as_ref().unwrap().node_type().unwrap(), "text");
// b 的上一兄弟 = text
let prev = b_node.previous_sibling().unwrap().unwrap();
assert_eq!(prev.node.as_ref().unwrap().node_type().unwrap(), "text");
// b 的下一兄弟 = c(注释被跳过)
let nxt = b_node.next_sibling().unwrap().unwrap();
assert_eq!(nxt.node.as_ref().unwrap().node_type().unwrap(), "element");
assert_eq!(nxt.node.as_ref().unwrap().name().unwrap().unwrap(), "c");
// c 无下一兄弟
assert!(c_node.next_sibling().unwrap().is_none());
// a 无上一兄弟
assert!(a_node.previous_sibling().unwrap().is_none());
}
}