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
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
| | ;;; nxml-mode.el --- a new XML mode -*- lexical-binding:t -*-
;; Copyright (C) 2003-2004, 2007-2018 Free Software Foundation, Inc.
;; Author: James Clark
;; Keywords: wp, hypermedia, languages, XML
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; See nxml-rap.el for description of parsing strategy.
;;; Code:
(eval-when-compile (require 'cl-lib))
(require 'xmltok)
(require 'nxml-enc)
(require 'nxml-util)
(require 'nxml-rap)
(require 'nxml-outln)
;; nxml-mode calls rng-nxml-mode-init, which is autoloaded from rng-nxml.
;; So we might as well just require it and silence the compiler.
(provide 'nxml-mode) ; avoid recursive require
(require 'rng-nxml)
(require 'sgml-mode)
;;; Customization
(defgroup nxml nil
"New XML editing mode."
:link '(custom-manual "(nxml-mode) Top")
:group 'languages)
(defgroup nxml-faces nil
"Faces for XML syntax highlighting."
:group 'nxml)
(defcustom nxml-char-ref-display-glyph-flag t
"Non-nil means display glyph following character reference.
The glyph is displayed in face `nxml-glyph'."
:group 'nxml
:type 'boolean)
(defcustom nxml-sexp-element-flag t
"Non-nil means sexp commands treat an element as a single expression."
:version "27.1" ; nil -> t
:group 'nxml
:type 'boolean)
(defcustom nxml-slash-auto-complete-flag nil
"Non-nil means typing a slash automatically completes the end-tag.
This is used by `nxml-electric-slash'."
:group 'nxml
:type 'boolean)
(defcustom nxml-child-indent 2
"Indentation for the children of an element relative to the start-tag.
This only applies when the line or lines containing the start-tag contains
nothing else other than that start-tag."
:group 'nxml
:type 'integer)
(defcustom nxml-attribute-indent 4
"Indentation for the attributes of an element relative to the start-tag.
This only applies when the first attribute of a tag starts a line.
In other cases, the first attribute on one line is indented the same
as the first attribute on the previous line."
:group 'nxml
:type 'integer)
(defcustom nxml-bind-meta-tab-to-complete-flag t
"Non-nil means to use nXML completion in \\[completion-at-point]."
:group 'nxml
:type 'boolean)
(defcustom nxml-prefer-utf-16-to-utf-8-flag nil
"Non-nil means prefer UTF-16 to UTF-8 when saving a buffer.
This is used only when a buffer does not contain an encoding declaration
and when its current `buffer-file-coding-system' specifies neither UTF-16
nor UTF-8."
:group 'nxml
:type 'boolean)
(defcustom nxml-prefer-utf-16-little-to-big-endian-flag (eq system-type
'windows-nt)
"Non-nil means prefer little-endian to big-endian byte-order for UTF-16.
This is used only for saving a buffer; when reading the byte-order is
auto-detected. It may be relevant both when there is no encoding declaration
and when the encoding declaration specifies `UTF-16'."
:group 'nxml
:type 'boolean)
(defcustom nxml-default-buffer-file-coding-system nil
"Default value for `buffer-file-coding-system' for a buffer for a new file.
A value of nil means use the default value of `buffer-file-coding-system' as normal.
A buffer's `buffer-file-coding-system' affects what \\[nxml-insert-xml-declaration] inserts."
:group 'nxml
:type 'coding-system)
(defcustom nxml-auto-insert-xml-declaration-flag nil
"Non-nil means automatically insert an XML declaration in a new file.
The XML declaration is inserted using `nxml-insert-xml-declaration'."
:group 'nxml
:type 'boolean)
(defface nxml-delimited-data
'((t (:inherit font-lock-doc-face)))
"Face used to highlight data enclosed between delimiters.
This is not used directly, but only via inheritance by other faces."
:group 'nxml-faces)
(defface nxml-name
'((t (:inherit font-lock-builtin-face)))
"Face used to highlight various names.
This includes element and attribute names, processing
instruction targets and the CDATA keyword in a CDATA section.
This is not used directly, but only via inheritance by other faces."
:group 'nxml-faces)
(defface nxml-ref
'((t (:inherit font-lock-constant-face)))
"Face used to highlight character and entity references.
This is not used directly, but only via inheritance by other faces."
:group 'nxml-faces)
(defface nxml-delimiter
nil
"Face used to highlight delimiters.
This is not used directly, but only via inheritance by other faces."
:group 'nxml-faces)
(defface nxml-text
nil
"Face used to highlight text."
:group 'nxml-faces)
(defface nxml-processing-instruction-delimiter
'((t (:inherit nxml-delimiter)))
"Face used for the delimiters of processing instructions, i.e., <? and ?>."
:group 'nxml-faces)
(defface nxml-processing-instruction-target
'((t (:inherit font-lock-keyword-face)))
"Face used for the target of processing instructions."
:group 'nxml-faces)
(defface nxml-processing-instruction-content
'((t (:inherit nxml-delimited-data)))
"Face used for the content of processing instructions."
:group 'nxml-faces)
(defface nxml-cdata-section-delimiter
'((t (:inherit nxml-delimiter)))
"Face used for the delimiters of CDATA sections, i.e., <![, [, and ]]>."
:group 'nxml-faces)
(defface nxml-cdata-section-CDATA
'((t (:inherit nxml-name)))
"Face used for the CDATA keyword in CDATA sections."
:group 'nxml-faces)
(defface nxml-cdata-section-content
'((t (:inherit nxml-text)))
"Face used for the content of CDATA sections."
:group 'nxml-faces)
(defface nxml-char-ref-number
'((t (:inherit nxml-ref)))
"Face used for the number in character references.
This includes ths `x' in hex references."
:group 'nxml-faces)
(defface nxml-char-ref-delimiter
'((t (:inherit nxml-ref)))
"Face used for the delimiters of character references, i.e., &# and ;."
:group 'nxml-faces)
(defface nxml-entity-ref-name
'((t (:inherit nxml-ref)))
"Face used for the entity name in general entity references."
:group 'nxml-faces)
(defface nxml-entity-ref-delimiter
'((t (:inherit nxml-ref)))
"Face used for the delimiters of entity references, i.e., & and ;."
:group 'nxml-faces)
(defface nxml-tag-delimiter
'((t (:inherit nxml-delimiter)))
"Face used for the angle brackets delimiting tags.
`nxml-tag-slash' is used for slashes."
:group 'nxml-faces)
(defface nxml-tag-slash
'((t (:inherit nxml-tag-delimiter)))
"Face used for slashes in tags, both in end-tags and empty-elements."
:group 'nxml-faces)
(defface nxml-element-prefix
'((t (:inherit nxml-name)))
"Face used for the prefix of elements."
:group 'nxml-faces)
(defface nxml-element-colon
nil
"Face used for the colon in element names."
:group 'nxml-faces)
(defface nxml-element-local-name
'((t (:inherit font-lock-function-name-face)))
"Face used for the local name of elements."
:group 'nxml-faces)
(defface nxml-attribute-prefix
'((t (:inherit nxml-name)))
"Face used for the prefix of attributes."
:group 'nxml-faces)
(defface nxml-attribute-colon
'((t (:inherit nxml-delimiter)))
"Face used for the colon in attribute names."
:group 'nxml-faces)
(defface nxml-attribute-local-name
'((t (:inherit font-lock-variable-name-face)))
"Face used for the local name of attributes."
:group 'nxml-faces)
(defface nxml-namespace-attribute-xmlns
'((t (:inherit nxml-attribute-prefix)))
"Face used for `xmlns' in namespace attributes."
:group 'nxml-faces)
(defface nxml-namespace-attribute-colon
'((t (:inherit nxml-attribute-colon)))
"Face used for the colon in namespace attributes."
:group 'nxml-faces)
(defface nxml-namespace-attribute-prefix
'((t (:inherit nxml-attribute-local-name)))
"Face used for the prefix declared in namespace attributes."
:group 'nxml-faces)
(defface nxml-attribute-value
'((t (:inherit font-lock-string-face)))
"Face used for the value of attributes."
:group 'nxml-faces)
(defface nxml-attribute-value-delimiter
'((t (:inherit nxml-attribute-value)))
"Face used for the delimiters of attribute values."
:group 'nxml-faces)
(defface nxml-prolog-literal-delimiter
'((t (:inherit nxml-delimited-data)))
"Face used for the delimiters of literals in the prolog."
:group 'nxml-faces)
(defface nxml-prolog-literal-content
'((t (:inherit nxml-delimited-data)))
"Face used for the content of literals in the prolog."
:group 'nxml-faces)
(defface nxml-prolog-keyword
'((t (:inherit font-lock-keyword-face)))
"Face used for keywords in the prolog."
:group 'nxml-faces)
(defface nxml-markup-declaration-delimiter
'((t (:inherit nxml-delimiter)))
"Face used for the delimiters of markup declarations in the prolog.
The delimiters are <! and >."
:group 'nxml-faces)
(defface nxml-hash
'((t (:inherit nxml-name)))
"Face used for # before a name in the prolog."
:group 'nxml-faces)
(defface nxml-glyph
'((((type x))
(:family
"misc-fixed"
:background
"light grey"
:foreground
"black"
:weight
normal
:slant
normal))
(t
(:background
"light grey"
:foreground
"black"
:weight
normal
:slant
normal)))
"Face used for glyph for char references."
:group 'nxml-faces)
;;; Global variables
(defvar-local nxml-parent-document nil
"The parent document for a part of a modular document.
Use `nxml-parent-document-set' to set it.")
(put 'nxml-parent-document 'safe-local-variable 'stringp)
(defvar-local nxml-prolog-regions nil
"List of regions in the prolog to be fontified.
See the function `xmltok-forward-prolog' for more information.")
(defvar-local nxml-degraded nil
"Non-nil if currently operating in degraded mode.
Degraded mode is enabled when an internal error is encountered in the
fontification or after-change functions.")
(defvar nxml-completion-hook nil
"Hook run by `nxml-complete'.
This hook is run until success.")
(defvar nxml-in-mixed-content-hook nil
"Hook to determine whether point is in mixed content.
The hook is called without arguments. It should return nil if it is
definitely not mixed; non-nil otherwise. The hook will be run until
one of the functions returns nil.")
(defvar nxml-mixed-scan-distance 4000
"Maximum distance from point to scan when checking for mixed content.")
(defvar nxml-end-tag-indent-scan-distance 4000
"Maximum distance from point to scan backwards when indenting end-tag.")
(defvar-local nxml-char-ref-extra-display t
"Non-nil means display extra information for character references.
The extra information consists of a tooltip with the character name
and, if `nxml-char-ref-display-glyph-flag' is non-nil, a glyph
corresponding to the referenced character following the character
reference.")
(defvar nxml-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\M-\C-u" 'nxml-backward-up-element)
(define-key map "\M-\C-d" 'nxml-down-element)
(define-key map "\M-\C-n" 'nxml-forward-element)
(define-key map "\M-\C-p" 'nxml-backward-element)
(define-key map "\M-{" 'nxml-backward-paragraph)
(define-key map "\M-}" 'nxml-forward-paragraph)
(define-key map "\M-h" 'nxml-mark-paragraph)
(define-key map "\C-c\C-f" 'nxml-finish-element)
(define-key map "\C-c]" 'nxml-finish-element)
(define-key map "\C-c/" 'nxml-finish-element)
(define-key map "\C-c\C-m" 'nxml-split-element)
(define-key map "\C-c\C-b" 'nxml-balanced-close-start-tag-block)
(define-key map "\C-c\C-i" 'nxml-balanced-close-start-tag-inline)
(define-key map "\C-c\C-x" 'nxml-insert-xml-declaration)
(define-key map "\C-c\C-d" 'nxml-dynamic-markup-word)
;; u is for Unicode
(define-key map "\C-c\C-u" 'nxml-insert-named-char)
(define-key map "\C-c\C-o" nxml-outline-prefix-map)
(define-key map [S-mouse-2] 'nxml-mouse-hide-direct-text-content)
(define-key map "/" 'nxml-electric-slash)
(define-key map "\M-\t" 'completion-at-point)
map)
"Keymap for nxml-mode.")
(defvar nxml-font-lock-keywords
'(nxml-fontify-matcher)
"Default font lock keywords for nxml-mode.")
(defsubst nxml-set-face (start end face)
(when (and face (< start end))
;; Prepend, so the character reference highlighting takes precedence over
;; the string highlighting applied syntactically.
(font-lock-prepend-text-property start end 'face face)))
(defun nxml-parent-document-set (parent-document)
"Set `nxml-parent-document' and inherit the DTD &c."
;; FIXME: this does not work.
;; the idea is that by inheriting some variables from the parent,
;; `rng-validate-mode' will validate entities declared in the parent.
;; alas, the most interesting variables (`rng-compile-table' et al)
;; are circular and cannot be printed even with `print-circle'.
(interactive "fParent document")
(let (dtd current-schema current-schema-file-name compile-table
ipattern-table last-ipattern-index)
(when (string= (file-truename parent-document)
(file-truename buffer-file-name))
(error "Parent document cannot be the same as the document"))
(with-current-buffer (find-file-noselect parent-document)
(setq dtd rng-dtd
current-schema rng-current-schema
current-schema-file-name rng-current-schema-file-name
compile-table rng-compile-table
ipattern-table rng-ipattern-table
last-ipattern-index rng-last-ipattern-index
parent-document buffer-file-name))
(setq rng-dtd dtd
rng-current-schema current-schema
rng-current-schema-file-name current-schema-file-name
rng-compile-table compile-table
rng-ipattern-table ipattern-table
rng-last-ipattern-index last-ipattern-index
nxml-parent-document parent-document)
(message "Set parent document to %s" parent-document)
(when rng-validate-mode
(rng-validate-while-idle (current-buffer)))))
(defvar tildify-space-string)
(defvar tildify-foreach-region-function)
;;;###autoload
(define-derived-mode nxml-mode text-mode "nXML"
;; We use C-c C-i instead of \\[nxml-balanced-close-start-tag-inline]
;; because Emacs turns C-c C-i into C-c TAB which is hard to type and
;; not mnemonic.
"Major mode for editing XML.
\\[nxml-finish-element] finishes the current element by inserting an end-tag.
C-c C-i closes a start-tag with `>' and then inserts a balancing end-tag
leaving point between the start-tag and end-tag.
\\[nxml-balanced-close-start-tag-block] is similar but for block rather than inline elements:
the start-tag, point, and end-tag are all left on separate lines.
If `nxml-slash-auto-complete-flag' is non-nil, then inserting a `</'
automatically inserts the rest of the end-tag.
\\[completion-at-point] performs completion on the symbol preceding point.
\\[nxml-dynamic-markup-word] uses the contents of the current buffer
to choose a tag to put around the word preceding point.
Sections of the document can be displayed in outline form. The
variable `nxml-section-element-name-regexp' controls when an element
is recognized as a section. The same key sequences that change
visibility in outline mode are used except that they start with C-c C-o
instead of C-c.
Validation is provided by the related minor-mode `rng-validate-mode'.
This also makes completion schema- and context- sensitive. Element
names, attribute names, attribute values and namespace URIs can all be
completed. By default, `rng-validate-mode' is automatically enabled.
You can toggle it using \\[rng-validate-mode] or change the default by
customizing `rng-nxml-auto-validate-flag'.
\\[indent-for-tab-command] indents the current line appropriately.
This can be customized using the variable `nxml-child-indent'
and the variable `nxml-attribute-indent'.
\\[nxml-insert-named-char] inserts a character reference using
the character's name (by default, the Unicode name).
\\[universal-argument] \\[nxml-insert-named-char] inserts the character directly.
The Emacs commands that normally operate on balanced expressions will
operate on XML markup items. Thus \\[forward-sexp] will move forward
across one markup item; \\[backward-sexp] will move backward across
one markup item; \\[kill-sexp] will kill the following markup item;
\\[mark-sexp] will mark the following markup item. By default, the
complete element is treated as a single markup item; to make each tag be
treated as a separate markup item, set the variable `nxml-sexp-element-flag'
to nil. For more details, see the function `nxml-forward-balanced-item'.
\\[nxml-backward-up-element] and \\[nxml-down-element] move up and down the element structure.
Many aspects this mode can be customized using
\\[customize-group] nxml RET."
;; (kill-all-local-variables)
;; If encoding does not allow non-break space character, use reference.
;; FIXME: This duplicates code from sgml-mode, perhaps derive from it?
;; FIXME: Perhaps use if possible (e.g. XHTML)?
(setq-local tildify-space-string
(if (equal (decode-coding-string
(encode-coding-string " " buffer-file-coding-system)
buffer-file-coding-system) " ")
" " " "))
;; FIXME: Use the fact that we're parsing the document already
;; rather than using regex-based filtering.
(setq-local tildify-foreach-region-function
(apply-partially 'tildify-foreach-ignore-environments
'(("<! *--" . "-- *>") ("<" . ">"))))
(setq-local mode-line-process '((nxml-degraded "/degraded")))
;; We'll determine the fill prefix ourselves
(setq-local adaptive-fill-mode nil)
(setq-local forward-sexp-function #'nxml-forward-balanced-item)
(setq-local indent-line-function #'nxml-indent-line)
(setq-local fill-paragraph-function #'nxml-do-fill-paragraph)
;; Comment support
;; This doesn't seem to work too well;
;; I think we should probably roll our own nxml-comment-dwim function.
(setq-local comment-indent-function #'nxml-indent-line)
(setq-local comment-start "<!--")
(setq-local comment-start-skip "<!--[ \t\r\n]*")
(setq-local comment-end "-->")
(setq-local comment-end-skip "[ \t\r\n]*-->")
(setq-local comment-line-break-function #'nxml-newline-and-indent)
(setq-local comment-quote-nested-function #'nxml-comment-quote-nested)
(save-excursion
(save-restriction
(widen)
(with-silent-modifications
(nxml-with-invisible-motion
(nxml-scan-prolog)))))
(setq-local syntax-ppss-table sgml-tag-syntax-table)
(setq-local syntax-propertize-function #'sgml-syntax-propertize)
(add-hook 'change-major-mode-hook #'nxml-cleanup nil t)
;; Emacs 23 handles the encoding attribute on the xml declaration
;; transparently to nxml-mode, so there is no longer a need for the below
;; hook. The hook also had the drawback of overriding explicit user
;; instruction to save as some encoding other than utf-8.
;;(add-hook 'write-contents-hooks #'nxml-prepare-to-save)
(when (not (and (buffer-file-name) (file-exists-p (buffer-file-name))))
(when (and nxml-default-buffer-file-coding-system
(not (local-variable-p 'buffer-file-coding-system)))
(setq buffer-file-coding-system nxml-default-buffer-file-coding-system))
(when nxml-auto-insert-xml-declaration-flag
(nxml-insert-xml-declaration)))
(setq font-lock-defaults
'(nxml-font-lock-keywords
nil ; highlight comments and strings based on syntax-tables
nil ; font-lock-keywords-case-fold-search. XML is case sensitive
nil ; no special syntax table
(font-lock-extend-region-functions . (nxml-extend-region))
(jit-lock-contextually . t)
(font-lock-unfontify-region-function . nxml-unfontify-region)))
(with-demoted-errors (rng-nxml-mode-init)))
(defun nxml-cleanup ()
"Clean up after nxml-mode."
;; Disable associated minor modes.
(rng-validate-mode -1)
;; Clean up fontification.
(save-excursion
(widen)
(with-silent-modifications
(nxml-with-invisible-motion
(remove-text-properties (point-min) (point-max) '(face)))))
(remove-hook 'change-major-mode-hook #'nxml-cleanup t))
(defun nxml-degrade (context err)
(message "Internal nXML mode error in %s (%s), degrading"
context
(error-message-string err))
(ding)
(setq nxml-degraded t)
(setq nxml-prolog-end 1))
;;; Change management
(defvar font-lock-beg) (defvar font-lock-end)
(defun nxml-debug-region (start end)
(interactive "r")
(let ((font-lock-beg start)
(font-lock-end end))
(nxml-extend-region)
(goto-char font-lock-beg)
(set-mark font-lock-end)))
;;; Encodings
(defun nxml-insert-xml-declaration ()
"Insert an XML declaration at the beginning of buffer.
The XML declaration will declare an encoding depending on the buffer's
`buffer-file-coding-system'."
(interactive "*")
(let ((coding-system
(if (and buffer-file-coding-system
(coding-system-p buffer-file-coding-system)
(coding-system-get buffer-file-coding-system
'mime-charset))
buffer-file-coding-system
(nxml-choose-utf-coding-system))))
(goto-char (point-min))
(insert (format "<?xml version=\"1.0\" encoding=\"%s\"?>\n"
(nxml-coding-system-name coding-system)))))
(defun nxml-prepare-to-save ()
(unless (and (not enable-multibyte-characters)
(local-variable-p 'buffer-file-coding-system)
buffer-file-coding-system
(or (eq (coding-system-type buffer-file-coding-system) 5)
(eq buffer-file-coding-system 'no-conversion)))
(save-excursion
(setq buffer-file-coding-system (nxml-select-coding-system))))
;; nil from a function in `write-contents-hooks' means
;; to continue and write the file as normal
nil)
(defun nxml-select-coding-system ()
(let* ((suitable-coding-systems
(find-coding-systems-region (point-min) (point-max)))
(enc-pos (progn
(goto-char (point-min))
(xmltok-get-declared-encoding-position)))
(enc-name
(and (consp enc-pos)
(buffer-substring-no-properties (car enc-pos)
(cdr enc-pos))))
(coding-system
(cond (enc-name
(if (string= (downcase enc-name) "utf-16")
(nxml-choose-utf-16-coding-system)
(nxml-mime-charset-coding-system enc-name)))
(enc-pos (nxml-choose-utf-coding-system)))))
;; Make sure we have a coding-system
(unless coding-system
(setq coding-system
(and (not buffer-read-only)
(nxml-choose-suitable-coding-system
suitable-coding-systems)))
(let ((message
(if enc-name
(format "Unknown encoding %s" enc-name)
"XML declaration is not well-formed")))
(cond ((not coding-system)
(error "%s" message))
((y-or-n-p
(concat message
". "
(format (if enc-name
"Save with %s"
"Modify and save with encoding %s")
(nxml-coding-system-name coding-system))
" "))
(nxml-fix-encoding-declaration enc-pos coding-system))
(t (signal 'quit nil)))))
;; Make sure it can encode all the characters in the buffer
(unless (or (memq (coding-system-base coding-system)
suitable-coding-systems)
(equal suitable-coding-systems '(undecided)))
(let ((message
(nxml-unsuitable-coding-system-message coding-system
enc-name)))
(setq coding-system
(and (not buffer-read-only)
(nxml-choose-suitable-coding-system
suitable-coding-systems)))
(cond ((not coding-system) (error "%s" message))
((y-or-n-p (concat message
(format ". Save with %s "
(nxml-coding-system-name
coding-system))))
(nxml-fix-encoding-declaration enc-pos coding-system))
(t (signal 'quit nil)))))
;; Merge the newline type of our existing encoding
(let ((current-eol-type
(coding-system-eol-type buffer-file-coding-system)))
(when (and current-eol-type (integerp current-eol-type))
(setq coding-system
(coding-system-change-eol-conversion coding-system
current-eol-type))))
coding-system))
(defun nxml-unsuitable-coding-system-message (coding-system &optional enc-name)
(if (nxml-coding-system-unicode-p coding-system)
"Cannot translate some characters to Unicode"
(format "Cannot encode some characters with %s"
(or enc-name
(nxml-coding-system-name coding-system)))))
(defconst nxml-utf-16-coding-systems (and (coding-system-p 'utf-16-be)
(coding-system-p 'utf-16-le)
'(utf-16-be utf-16-le)))
(defconst nxml-utf-coding-systems (cons 'utf-8 nxml-utf-16-coding-systems))
(defun nxml-coding-system-unicode-p (coding-system)
(nxml-coding-system-member (coding-system-base coding-system)
nxml-utf-coding-systems))
(defun nxml-coding-system-name (coding-system)
(setq coding-system (coding-system-base coding-system))
(symbol-name
(if (nxml-coding-system-member coding-system nxml-utf-16-coding-systems)
'utf-16
(or (coding-system-get coding-system 'mime-charset)
coding-system))))
(defun nxml-fix-encoding-declaration (enc-pos coding-system)
(let ((charset (nxml-coding-system-name coding-system)))
(cond ((consp enc-pos)
(delete-region (car enc-pos) (cdr enc-pos))
(goto-char (car enc-pos))
(insert charset))
((integerp enc-pos)
(goto-char enc-pos)
(insert " encoding=\"" charset ?\"))
(t
(goto-char (point-min))
(insert "<?xml version=\"1.0\" encoding=\""
charset
"\"?>\n")
(when (and (not enc-pos)
(let ((case-fold-search t))
(looking-at xmltok-bad-xml-decl-regexp)))
(delete-region (point) (match-end 0)))))))
(defun nxml-choose-suitable-coding-system (suitable-coding-systems)
(let (ret coding-system)
(if (and buffer-file-coding-system
(memq (coding-system-base buffer-file-coding-system)
suitable-coding-systems))
buffer-file-coding-system
(while (and suitable-coding-systems (not ret))
(setq coding-system (car suitable-coding-systems))
(if (coding-system-get coding-system 'mime-charset)
(setq ret coding-system)
(setq suitable-coding-systems (cdr suitable-coding-systems))))
ret)))
(defun nxml-choose-utf-coding-system ()
(let ((cur (and (local-variable-p 'buffer-file-coding-system)
buffer-file-coding-system
(coding-system-base buffer-file-coding-system))))
(cond ((car (nxml-coding-system-member cur nxml-utf-coding-systems)))
((and nxml-prefer-utf-16-to-utf-8-flag
(coding-system-p 'utf-16-le)
(coding-system-p 'utf-16-be))
(if nxml-prefer-utf-16-little-to-big-endian-flag
'utf-16-le
'utf-16-be))
(t 'utf-8))))
(defun nxml-choose-utf-16-coding-system ()
(let ((cur (and (local-variable-p 'buffer-file-coding-system)
buffer-file-coding-system
(coding-system-base buffer-file-coding-system))))
(cond ((car (nxml-coding-system-member cur nxml-utf-16-coding-systems)))
(nxml-prefer-utf-16-little-to-big-endian-flag
(and (coding-system-p 'utf-16-le) 'utf-16-le))
(t (and (coding-system-p 'utf-16-be) 'utf-16-be)))))
(defun nxml-coding-system-member (coding-system coding-systems)
(let (ret)
(while (and coding-systems (not ret))
(if (coding-system-equal coding-system
(car coding-systems))
(setq ret coding-systems)
(setq coding-systems (cdr coding-systems))))
ret))
;;; Fontification
(defun nxml-unfontify-region (start end)
(font-lock-default-unfontify-region start end)
(nxml-clear-char-ref-extra-display start end))
(defun nxml-extend-region ()
"Extend the region to hold the minimum area we can fontify with nXML.
Called with `font-lock-beg' and `font-lock-end' dynamically bound."
(let ((start font-lock-beg)
(end font-lock-end))
(nxml-debug-change "nxml-extend-region(input)" start end)
(when (< start nxml-prolog-end)
(setq start (point-min)))
(cond ((<= end nxml-prolog-end)
(setq end nxml-prolog-end))
(t
(goto-char start)
;; some font-lock backends (like Emacs 22 jit-lock) snap
;; the region to the beginning of the line no matter what
;; we say here. To mitigate the resulting excess
;; fontification, ignore leading whitespace.
(skip-syntax-forward " ")
;; find the beginning of the previous tag
(when (not (equal (char-after) ?\<))
(search-backward "<" nxml-prolog-end t))
(nxml-ensure-scan-up-to-date)
(nxml-move-outside-backwards)
(setq start (point))
(while (< (point) end)
(nxml-tokenize-forward))
(setq end (point))))
(when (or (< start font-lock-beg)
(> end font-lock-end))
(setq font-lock-beg start
font-lock-end end)
(nxml-debug-change "nxml-extend-region" start end)
t)))
(defun nxml-fontify-matcher (bound)
"Called as font-lock keyword matcher."
(syntax-propertize bound)
(unless nxml-degraded
(nxml-debug-change "nxml-fontify-matcher" (point) bound)
(when (< (point) nxml-prolog-end)
;; Prolog needs to be fontified in one go, and
;; nxml-extend-region makes sure we start at BOB.
(cl-assert (bobp))
(nxml-fontify-prolog)
(goto-char nxml-prolog-end))
(let (xmltok-errors)
(while (and (nxml-tokenize-forward)
(<= (point) bound)) ; Intervals are open-ended.
(nxml-apply-fontify-rule)))
)
;; Since we did the fontification internally, tell font-lock to not
;; do anything itself.
nil)
(defun nxml-fontify-prolog ()
"Fontify the prolog.
The buffer is assumed to be prepared for fontification.
This does not set the fontified property, but it does clear
faces appropriately."
(let ((regions nxml-prolog-regions))
(while regions
(let ((region (car regions)))
(nxml-apply-fontify-rule (aref region 0)
(aref region 1)
(aref region 2)))
(setq regions (cdr regions)))))
;; Vectors identify a substring of the token to be highlighted in some face.
;; Token types returned by xmltok-forward.
(put 'start-tag
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
[-1 nil nxml-tag-delimiter]
(element-qname . 1)
attributes))
(put 'partial-start-tag
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
(element-qname . 1)
attributes))
(put 'end-tag
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
[1 2 nxml-tag-slash]
[-1 nil nxml-tag-delimiter]
(element-qname . 2)))
(put 'partial-end-tag
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
[1 2 nxml-tag-slash]
(element-qname . 2)))
(put 'empty-element
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
[-2 -1 nxml-tag-slash]
[-1 nil nxml-tag-delimiter]
(element-qname . 1)
attributes))
(put 'partial-empty-element
'nxml-fontify-rule
'([nil 1 nxml-tag-delimiter]
[-1 nil nxml-tag-slash]
(element-qname . 1)
attributes))
(put 'char-ref
'nxml-fontify-rule
'([nil 2 nxml-char-ref-delimiter]
[2 -1 nxml-char-ref-number]
[-1 nil nxml-char-ref-delimiter]
char-ref))
(put 'entity-ref
'nxml-fontify-rule
'([nil 1 nxml-entity-ref-delimiter]
[1 -1 nxml-entity-ref-name]
[-1 nil nxml-entity-ref-delimiter]))
;; (put 'comment
;; 'nxml-fontify-rule
;; '([nil 4 nxml-comment-delimiter]
;; [4 -3 nxml-comment-content]
;; [-3 nil nxml-comment-delimiter]))
(put 'processing-instruction
'nxml-fontify-rule
'([nil 2 nxml-processing-instruction-delimiter]
[-2 nil nxml-processing-instruction-delimiter]
processing-instruction-content))
(put 'cdata-section
'nxml-fontify-rule
'([nil 3 nxml-cdata-section-delimiter] ; <![
[3 8 nxml-cdata-section-CDATA] ; CDATA
[8 9 nxml-cdata-section-delimiter] ; [
[9 -3 nxml-cdata-section-content] ; ]]>
[-3 nil nxml-cdata-section-delimiter]))
(put 'data
'nxml-fontify-rule
'([nil nil nxml-text]))
;; Prolog region types in list returned by xmltok-forward-prolog.
(put 'xml-declaration
'nxml-fontify-rule
'([nil 2 nxml-processing-instruction-delimiter]
[2 5 nxml-processing-instruction-target]
[-2 nil nxml-processing-instruction-delimiter]))
(put 'xml-declaration-attribute-name
'nxml-fontify-rule
'([nil nil nxml-attribute-local-name]))
(put 'xml-declaration-attribute-value ;FIXME: What is this for?
'nxml-fontify-rule
'([nil 1 nxml-attribute-value-delimiter]
[1 -1 nxml-attribute-value]
[-1 nil nxml-attribute-value-delimiter]))
(put 'processing-instruction-left
'nxml-fontify-rule
'([nil 2 nxml-processing-instruction-delimiter]
[2 nil nxml-processing-instruction-target]))
(put 'processing-instruction-right
'nxml-fontify-rule
'([nil -2 nxml-processing-instruction-content]
[-2 nil nxml-processing-instruction-delimiter]))
(put 'literal
'nxml-fontify-rule
'([nil 1 nxml-prolog-literal-delimiter]
[1 -1 nxml-prolog-literal-content]
[-1 nil nxml-prolog-literal-delimiter]))
(put 'keyword
'nxml-fontify-rule
'([nil nil nxml-prolog-keyword]))
(put 'markup-declaration-open
'nxml-fontify-rule
'([0 2 nxml-markup-declaration-delimiter]
[2 nil nxml-prolog-keyword]))
(put 'markup-declaration-close
'nxml-fontify-rule
'([nil nil nxml-markup-declaration-delimiter]))
(put 'internal-subset-open
'nxml-fontify-rule
'([nil nil nxml-markup-declaration-delimiter]))
(put 'internal-subset-close
'nxml-fontify-rule
'([nil 1 nxml-markup-declaration-delimiter]
[-1 nil nxml-markup-declaration-delimiter]))
(put 'hash-name
'nxml-fontify-rule
'([nil 1 nxml-hash]
[1 nil nxml-prolog-keyword]))
(defun nxml-apply-fontify-rule (&optional type start end)
(let ((rule (get (or type xmltok-type) 'nxml-fontify-rule)))
(unless start (setq start xmltok-start))
(unless end (setq end (point)))
(while rule
(let* ((action (car rule)))
(setq rule (cdr rule))
(cond ((vectorp action)
(nxml-set-face (let ((offset (aref action 0)))
(cond ((not offset) start)
((< offset 0) (+ end offset))
(t (+ start offset))))
(let ((offset (aref action 1)))
(cond ((not offset) end)
((< offset 0) (+ end offset))
(t (+ start offset))))
(aref action 2)))
((and (consp action)
(eq (car action) 'element-qname))
(when xmltok-name-end ; maybe nil in partial-end-tag case
(nxml-fontify-qname (+ start (cdr action))
xmltok-name-colon
xmltok-name-end
'nxml-element-prefix
'nxml-element-colon
'nxml-element-local-name)))
((eq action 'attributes)
(nxml-fontify-attributes))
((eq action 'processing-instruction-content)
(nxml-set-face (+ start 2)
xmltok-name-end
'nxml-processing-instruction-target)
(nxml-set-face (save-excursion
(goto-char xmltok-name-end)
(skip-chars-forward " \t\r\n")
(point))
(- end 2)
'nxml-processing-instruction-content))
((eq action 'char-ref)
(nxml-char-ref-display-extra start
end
(xmltok-char-number start end)))
(t (error "Invalid nxml-fontify-rule action %s" action)))))))
(defun nxml-fontify-attributes ()
(while xmltok-namespace-attributes
(nxml-fontify-attribute (car xmltok-namespace-attributes)
'namespace)
(setq xmltok-namespace-attributes
(cdr xmltok-namespace-attributes)))
(while xmltok-attributes
(nxml-fontify-attribute (car xmltok-attributes))
(setq xmltok-attributes
(cdr xmltok-attributes))))
(defun nxml-fontify-attribute (att &optional namespace-declaration)
(if namespace-declaration
(nxml-fontify-qname (xmltok-attribute-name-start att)
(xmltok-attribute-name-colon att)
(xmltok-attribute-name-end att)
'nxml-namespace-attribute-xmlns
'nxml-namespace-attribute-colon
'nxml-namespace-attribute-prefix
'nxml-namespace-attribute-xmlns)
(nxml-fontify-qname (xmltok-attribute-name-start att)
(xmltok-attribute-name-colon att)
(xmltok-attribute-name-end att)
'nxml-attribute-prefix
'nxml-attribute-colon
'nxml-attribute-local-name))
(dolist (ref (xmltok-attribute-refs att))
(let* ((ref-type (aref ref 0))
(ref-start (aref ref 1))
(ref-end (aref ref 2)))
(nxml-apply-fontify-rule ref-type ref-start ref-end))))
(defun nxml-fontify-qname (start
colon
end
prefix-face
colon-face
local-name-face
&optional
unprefixed-face)
(cond (colon (nxml-set-face start colon prefix-face)
(nxml-set-face colon (1+ colon) colon-face)
(nxml-set-face (1+ colon) end local-name-face))
(t (nxml-set-face start end (or unprefixed-face
local-name-face)))))
;;; Editing
(defun nxml-electric-slash (arg)
"Insert a slash.
With a prefix ARG, do nothing other than insert the slash.
Otherwise, if `nxml-slash-auto-complete-flag' is non-nil, insert the
rest of the end-tag or empty-element if the slash is potentially part
of an end-tag or the close of an empty-element.
If the slash is part of an end-tag that is the first non-whitespace
on the line, reindent the line."
(interactive "*P")
(nxml-ensure-scan-up-to-date)
(let* ((slash-pos (point))
(end-tag-p (and (eq (char-before slash-pos) ?<)
(not (nxml-get-inside slash-pos))))
(at-indentation (save-excursion
(back-to-indentation)
(eq (point) (1- slash-pos)))))
(self-insert-command (prefix-numeric-value arg))
(unless arg
(if nxml-slash-auto-complete-flag
(if end-tag-p
(condition-case nil
(let ((start-tag-end
(nxml-scan-element-backward (1- slash-pos) t)))
(when start-tag-end
(insert (xmltok-start-tag-qname) ">")
;; copy the indentation of the start-tag
(when (and at-indentation
(save-excursion
(goto-char xmltok-start)
(back-to-indentation)
(eq (point) xmltok-start)))
(save-excursion
(indent-line-to (save-excursion
(goto-char xmltok-start)
(current-column)))))))
(nxml-scan-error nil))
(when (and (eq (nxml-token-before) (point))
(eq xmltok-type 'partial-empty-element))
(insert ">"))))
(when (and end-tag-p at-indentation)
(nxml-indent-line)))))
(defun nxml-balanced-close-start-tag-block ()
"Close the start-tag before point with `>' and insert a balancing end-tag.
Point is left between the start-tag and the end-tag.
If there is nothing but whitespace before the `<' that opens the
start-tag, then put point on a blank line, and put the end-tag on
another line aligned with the start-tag."
(interactive "*")
(nxml-balanced-close-start-tag 'block))
(defun nxml-balanced-close-start-tag-inline ()
"Close the start-tag before point with `>' and insert a balancing end-tag.
Point is left between the start-tag and the end-tag.
No extra whitespace is inserted."
(interactive "*")
(nxml-balanced-close-start-tag 'inline))
(defun nxml-balanced-close-start-tag (block-or-inline)
(let ((token-end (nxml-token-before))
(pos (1+ (point)))
(token-start xmltok-start))
(unless (or (eq xmltok-type 'partial-start-tag)
(and (memq xmltok-type '(start-tag
empty-element
partial-empty-element))
(>= token-end pos)))
(error "Not in a start-tag"))
;; Note that this insertion changes xmltok-start.
(insert "></"
(buffer-substring-no-properties (+ xmltok-start 1)
(min xmltok-name-end (point)))
">")
(if (eq block-or-inline 'inline)
(goto-char pos)
(goto-char token-start)
(back-to-indentation)
(if (= (point) token-start)
(let ((indent (current-column)))
(goto-char pos)
(insert "\n")
(indent-line-to indent)
(goto-char pos)
(insert "\n")
(indent-line-to (+ nxml-child-indent indent)))
(goto-char pos)))))
(defun nxml-finish-element ()
"Finish the current element by inserting an end-tag."
(interactive "*")
(nxml-finish-element-1 nil))
(defvar nxml-last-split-position nil
"Position where `nxml-split-element' split the current element.")
(defun nxml-split-element ()
"Split the current element by inserting an end-tag and a start-tag.
Point is left after the newly inserted start-tag. When repeated,
split immediately before the previously inserted start-tag and leave
point unchanged."
(interactive "*")
(setq nxml-last-split-position
(if (and (eq last-command this-command)
nxml-last-split-position)
(save-excursion
(goto-char nxml-last-split-position)
(nxml-finish-element-1 t))
(nxml-finish-element-1 t))))
(defun nxml-finish-element-1 (startp)
"Insert an end-tag for the current element and optionally a start-tag.
The start-tag is inserted if STARTP is non-nil. Return the position
of the inserted start-tag or nil if none was inserted."
(interactive "*")
(let* ((token-end (nxml-token-before))
(start-tag-end
(save-excursion
(when (and (< (point) token-end)
(memq xmltok-type
'(cdata-section
processing-instruction
comment
start-tag
end-tag
empty-element)))
(error "Point is inside a %s"
(nxml-token-type-friendly-name xmltok-type)))
(nxml-scan-element-backward token-end t)))
(starts-line
(save-excursion
(unless (eq xmltok-type 'start-tag)
(error "No matching start-tag"))
(goto-char xmltok-start)
(back-to-indentation)
(eq (point) xmltok-start)))
(ends-line
(save-excursion
(goto-char start-tag-end)
(looking-at "[ \t\r\n]*$")))
(start-tag-indent (save-excursion
(goto-char xmltok-start)
(current-column)))
(qname (xmltok-start-tag-qname))
inserted-start-tag-pos)
(when (and starts-line ends-line)
;; start-tag is on a line by itself
;; => put the end-tag on a line by itself
(unless (<= (point)
(save-excursion
(back-to-indentation)
(point)))
(insert "\n"))
(indent-line-to start-tag-indent))
(insert "</" qname ">")
(when startp
(when starts-line
(insert "\n")
(indent-line-to start-tag-indent))
(setq inserted-start-tag-pos (point))
(insert "<" qname ">")
(when (and starts-line ends-line)
(insert "\n")
(indent-line-to (save-excursion
(goto-char xmltok-start)
(forward-line 1)
(back-to-indentation)
(if (= (current-column)
(+ start-tag-indent nxml-child-indent))
(+ start-tag-indent nxml-child-indent)
start-tag-indent)))))
inserted-start-tag-pos))
(defun nxml-comment-quote-nested (_cs _ce unp)
"Quote nested comments in buffer.
See `comment-quote-nested-function' for more information."
(goto-char (point-min))
(save-match-data
(while (re-search-forward "-[\\]*-" nil t)
(goto-char (match-beginning 0))
(forward-char 1)
(if unp
(delete-char 1)
(insert "\\")))))
;;; Indentation
(defun nxml-indent-line ()
"Indent current line as XML."
(let* ((savep (point))
(indent (condition-case nil
(save-excursion
(forward-line 0)
(skip-chars-forward " \t")
(if (>= (point) savep) (setq savep nil))
(or (nxml-compute-indent) 0))
(error 0))))
(if (not (numberp indent))
;; If something funny is used (e.g. `noindent'), return it.
indent
(if (< indent 0) (setq indent 0)) ;Just in case.
(if savep
(save-excursion (indent-line-to indent))
(indent-line-to indent)))))
(defun nxml-compute-indent ()
"Return the indent for the line containing point."
(or (nxml-compute-indent-from-matching-start-tag)
(nxml-compute-indent-from-previous-line)))
(defun nxml-compute-indent-from-matching-start-tag ()
"Compute the indent for a line with an end-tag using the matching start-tag.
When the line containing point ends with an end-tag and does not start
in the middle of a token, return the indent of the line containing the
matching start-tag, if there is one and it occurs at the beginning of
its line. Otherwise return nil."
(save-excursion
(back-to-indentation)
(let ((bol (point)))
(let ((inhibit-field-text-motion t))
(end-of-line))
(skip-chars-backward " \t")
(and (= (nxml-token-before) (point))
(memq xmltok-type '(end-tag partial-end-tag))
;; start of line must not be inside a token
(or (= xmltok-start bol)
(save-excursion
(goto-char bol)
(nxml-token-after)
(= xmltok-start bol))
(eq xmltok-type 'data))
(condition-case nil
(nxml-scan-element-backward
(point)
nil
(- (point)
nxml-end-tag-indent-scan-distance))
(nxml-scan-error nil))
(< xmltok-start bol)
(progn
(goto-char xmltok-start)
(skip-chars-backward " \t")
(bolp))
(current-indentation)))))
(defun nxml-compute-indent-from-previous-line ()
"Compute the indent for a line using the indentation of a previous line."
(save-excursion
(end-of-line)
(let ((eol (point))
bol prev-bol ref
before-context after-context)
(back-to-indentation)
(setq bol (point))
(catch 'indent
;; Move backwards until the start of a non-blank line that is
;; not inside a token.
(while (progn
(when (= (forward-line -1) -1)
(throw 'indent 0))
(back-to-indentation)
(if (looking-at "[ \t]*$")
t
(or prev-bol
(setq prev-bol (point)))
(nxml-token-after)
(not (or (= xmltok-start (point))
(eq xmltok-type 'data))))))
(setq ref (point))
;; Now scan over tokens until the end of the line to be indented.
;; Determine the context before and after the beginning of the
;; line.
(while (< (point) eol)
(nxml-tokenize-forward)
(cond ((<= bol xmltok-start)
(setq after-context
(nxml-merge-indent-context-type after-context)))
((and (<= (point) bol)
(not (and (eq xmltok-type 'partial-start-tag)
(= (point) bol))))
(setq before-context
(nxml-merge-indent-context-type before-context)))
((eq xmltok-type 'data)
(setq before-context
(nxml-merge-indent-context-type before-context))
(setq after-context
(nxml-merge-indent-context-type after-context)))
;; If in the middle of a token that looks inline,
;; then indent relative to the previous non-blank line
((eq (nxml-merge-indent-context-type before-context)
'mixed)
(goto-char prev-bol)
(throw 'indent (current-column)))
(t
(throw 'indent
(nxml-compute-indent-in-token bol))))
(skip-chars-forward " \t\r\n"))
(goto-char ref)
(message "bc=%s ac=%s" before-context after-context)
(cond ((and (eq before-context 'mixed)
(eq after-context 'markup))
(+ (current-column) nxml-child-indent))
((and (eq before-context 'markup)
(eq after-context 'markup))
(current-column))
(t (+ (current-column)
(* nxml-child-indent
(+ (if (eq before-context 'start-tag) 1 0)
(if (eq after-context 'end-tag) -1 0))))))))))
(defun nxml-merge-indent-context-type (context)
"Merge the indent context type CONTEXT with the token in `xmltok-type'.
Return the merged indent context type. An indent context type is
either nil or one of the symbols `start-tag', `end-tag', `markup',
`comment', `mixed'."
(cond ((memq xmltok-type '(start-tag partial-start-tag))
(if (memq context '(nil start-tag comment))
'start-tag
'mixed))
((memq xmltok-type '(end-tag partial-end-tag))
(if (memq context '(nil end-tag comment))
'end-tag
'mixed))
((eq xmltok-type 'comment)
(cond ((memq context '(start-tag end-tag comment))
context)
(context 'mixed)
(t 'comment)))
(context 'mixed)
(t 'markup)))
(defun nxml-compute-indent-in-token (pos)
"Return the indent for a line that starts inside a token.
POS is the position of the first non-whitespace character of the line.
This expects the xmltok-* variables to be set up as by `xmltok-forward'."
(cond ((memq xmltok-type '(start-tag
partial-start-tag
empty-element
partial-empty-element))
(nxml-compute-indent-in-start-tag pos))
((eq xmltok-type 'comment)
(nxml-compute-indent-in-delimited-token pos "<!--" "-->"))
((eq xmltok-type 'cdata-section)
(nxml-compute-indent-in-delimited-token pos "<![CDATA[" "]]>"))
((eq xmltok-type 'processing-instruction)
(nxml-compute-indent-in-delimited-token pos "<?" "?>"))
(t
(goto-char pos)
(if (and (= (forward-line -1) 0)
(< xmltok-start (point)))
(back-to-indentation)
(goto-char xmltok-start))
(current-column))))
(defun nxml-compute-indent-in-start-tag (pos)
"Return the indent for a line that starts inside a start-tag.
Also for a line that starts inside an empty element.
POS is the position of the first non-whitespace character of the line.
This expects the xmltok-* variables to be set up as by `xmltok-forward'."
(let ((value-boundary (nxml-attribute-value-boundary pos))
(off 0))
(if value-boundary
;; inside an attribute value
(let ((value-start (car value-boundary)))
(goto-char pos)
(forward-line -1)
(if (< (point) value-start)
(goto-char value-start)
(back-to-indentation)))
;; outside an attribute value
(goto-char pos)
(while (and (= (forward-line -1) 0)
(nxml-attribute-value-boundary (point))))
(cond ((<= (point) xmltok-start)
(goto-char xmltok-start)
(setq off nxml-attribute-indent)
(let ((atts (xmltok-merge-attributes)))
(when atts
(let* ((att (car atts))
(start (xmltok-attribute-name-start att)))
(when (< start pos)
(goto-char start)
(setq off 0))))))
(t
(back-to-indentation))))
(+ (current-column) off)))
(defun nxml-attribute-value-boundary (pos)
"Return a pair (START . END) if POS is inside an attribute value.
Otherwise return nil. START and END are the positions of the start
and end of the attribute value containing POS. This expects the
xmltok-* variables to be set up as by `xmltok-forward'."
(let ((atts (xmltok-merge-attributes))
att value-start value-end value-boundary)
(while atts
(setq att (car atts))
(setq value-start (xmltok-attribute-value-start att))
(setq value-end (xmltok-attribute-value-end att))
(cond ((and value-start (< pos value-start))
(setq atts nil))
((and value-start value-end (<= pos value-end))
(setq value-boundary (cons value-start value-end))
(setq atts nil))
(t (setq atts (cdr atts)))))
value-boundary))
(defun nxml-compute-indent-in-delimited-token (pos open-delim close-delim)
"Return the indent for a line that starts inside a token with delimiters.
OPEN-DELIM and CLOSE-DELIM are strings giving the opening and closing
delimiters. POS is the position of the first non-whitespace character
of the line. This expects the xmltok-* variables to be set up as by
`xmltok-forward'."
(cond ((let ((end (+ pos (length close-delim))))
(and (<= end (point-max))
(string= (buffer-substring-no-properties pos end)
close-delim)))
(goto-char xmltok-start))
((progn
(goto-char pos)
(forward-line -1)
(<= (point) xmltok-start))
(goto-char (+ xmltok-start (length open-delim)))
(when (and (string= open-delim "<!--")
(looking-at " "))
(goto-char (1+ (point)))))
(t (back-to-indentation)))
(current-column))
(define-obsolete-function-alias 'nxml-complete #'completion-at-point "26.1")
;;; Movement
(defun nxml-forward-balanced-item (&optional arg)
"Move forward across one balanced item.
With ARG, do it that many times. Negative arg -N means
move backward across N balanced expressions.
This is the equivalent of `forward-sexp' for XML.
An element is by default treated as a single markup item.
However, if the variable `nxml-sexp-element-flag' is nil, then an
element contains as items strings with no markup, tags,
processing instructions, comments, CDATA sections, entity
references and character references. A start-tag contains an
element name followed by one or more attributes. An end-tag
contains just an element name. An attribute value literals
contains strings with no markup, entity references and character
references. A processing instruction consists of a target and a
content string. A comment or a CDATA section contains a single
string. An entity reference contains a single name. A character
reference contains a character number."
(interactive "^p")
(or arg (setq arg 1))
(cond ((> arg 0)
(while (progn
(nxml-forward-single-balanced-item)
(> (setq arg (1- arg)) 0))))
((< arg 0)
(while (progn
(nxml-backward-single-balanced-item)
(< (setq arg (1+ arg)) 0))))))
(defun nxml-forward-single-balanced-item ()
(condition-case err
(goto-char (let ((end (nxml-token-after)))
(save-excursion
(while (eq xmltok-type 'space)
(goto-char end)
(setq end (nxml-token-after)))
(cond ((/= (point) xmltok-start)
(nxml-scan-forward-within end))
((and nxml-sexp-element-flag
(eq xmltok-type 'start-tag))
;; can't ever return nil here
(nxml-scan-element-forward xmltok-start))
((and nxml-sexp-element-flag
(memq xmltok-type
'(end-tag partial-end-tag)))
(error "Already at end of element"))
(t end)))))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err)))))
(defun nxml-backward-single-balanced-item ()
(condition-case err
(goto-char (let ((end (nxml-token-before)))
(save-excursion
(while (eq xmltok-type 'space)
(goto-char xmltok-start)
(setq end (nxml-token-before)))
(cond ((/= (point) end)
(nxml-scan-backward-within end))
((and nxml-sexp-element-flag
(eq xmltok-type 'end-tag))
;; can't ever return nil here
(nxml-scan-element-backward end)
xmltok-start)
((and nxml-sexp-element-flag
(eq xmltok-type 'start-tag))
(error "Already at start of element"))
(t xmltok-start)))))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err)))))
(defun nxml-scan-forward-within (end)
(setq end (- end (nxml-end-delimiter-length xmltok-type)))
(when (<= end (point))
(error "Already at end of %s"
(nxml-token-type-friendly-name xmltok-type)))
(cond ((memq xmltok-type '(start-tag
empty-element
partial-start-tag
partial-empty-element))
(if (< (point) xmltok-name-end)
xmltok-name-end
(let ((att (nxml-find-following-attribute)))
(cond ((not att) end)
((and (xmltok-attribute-value-start att)
(<= (xmltok-attribute-value-start att)
(point)))
(nxml-scan-forward-in-attribute-value att))
((xmltok-attribute-value-end att)
(1+ (xmltok-attribute-value-end att)))
((save-excursion
(goto-char (xmltok-attribute-name-end att))
(looking-at "[ \t\r\n]*="))
(match-end 0))
(t (xmltok-attribute-name-end att))))))
((and (eq xmltok-type 'processing-instruction)
(< (point) xmltok-name-end))
xmltok-name-end)
(t end)))
(defun nxml-scan-backward-within (_end)
(setq xmltok-start
(+ xmltok-start
(nxml-start-delimiter-length xmltok-type)))
(when (<= (point) xmltok-start)
(error "Already at start of %s"
(nxml-token-type-friendly-name xmltok-type)))
(cond ((memq xmltok-type '(start-tag
empty-element
partial-start-tag
partial-empty-element))
(let ((att (nxml-find-preceding-attribute)))
(cond ((not att) xmltok-start)
((and (xmltok-attribute-value-start att)
(<= (xmltok-attribute-value-start att)
(point))
(<= (point)
(xmltok-attribute-value-end att)))
(nxml-scan-backward-in-attribute-value att))
(t (xmltok-attribute-name-start att)))))
((and (eq xmltok-type 'processing-instruction)
(let ((content-start (save-excursion
(goto-char xmltok-name-end)
(skip-chars-forward " \r\t\n")
(point))))
(and (< content-start (point))
content-start))))
(t xmltok-start)))
(defun nxml-scan-forward-in-attribute-value (att)
(when (= (point) (xmltok-attribute-value-end att))
(error "Already at end of attribute value"))
(let ((refs (xmltok-attribute-refs att))
ref)
(while refs
(setq ref (car refs))
(if (< (point) (aref ref 2))
(setq refs nil)
(setq ref nil)
(setq refs (cdr refs))))
(cond ((not ref)
(xmltok-attribute-value-end att))
((< (point) (aref ref 1))
(aref ref 1))
((= (point) (aref ref 1))
(aref ref 2))
(t
(let ((end (- (aref ref 2)
(nxml-end-delimiter-length (aref ref 0)))))
(if (< (point) end)
end
(error "Already at end of %s"
(nxml-token-type-friendly-name (aref ref 0)))))))))
(defun nxml-scan-backward-in-attribute-value (att)
(when (= (point) (xmltok-attribute-value-start att))
(error "Already at start of attribute value"))
(let ((refs (reverse (xmltok-attribute-refs att)))
ref)
(while refs
(setq ref (car refs))
(if (< (aref ref 1) (point))
(setq refs nil)
(setq ref nil)
(setq refs (cdr refs))))
(cond ((not ref)
(xmltok-attribute-value-start att))
((< (aref ref 2) (point))
(aref ref 2))
((= (point) (aref ref 2))
(aref ref 1))
(t
(let ((start (+ (aref ref 1)
(nxml-start-delimiter-length (aref ref 0)))))
(if (< start (point))
start
(error "Already at start of %s"
(nxml-token-type-friendly-name (aref ref 0)))))))))
(defun nxml-find-following-attribute ()
(let ((ret nil)
(atts (or xmltok-attributes xmltok-namespace-attributes))
(more-atts (and xmltok-attributes xmltok-namespace-attributes)))
(while atts
(let* ((att (car atts))
(name-start (xmltok-attribute-name-start att)))
(cond ((and (<= name-start (point))
(xmltok-attribute-value-end att)
;; <= because end is before quote
(<= (point) (xmltok-attribute-value-end att)))
(setq atts nil)
(setq ret att))
((and (< (point) name-start)
(or (not ret)
(< name-start
(xmltok-attribute-name-start ret))))
(setq ret att))))
(setq atts (cdr atts))
(unless atts
(setq atts more-atts)
(setq more-atts nil)))
ret))
(defun nxml-find-preceding-attribute ()
(let ((ret nil)
(atts (or xmltok-attributes xmltok-namespace-attributes))
(more-atts (and xmltok-attributes xmltok-namespace-attributes)))
(while atts
(let* ((att (car atts))
(name-start (xmltok-attribute-name-start att)))
(cond ((and (< name-start (point))
(xmltok-attribute-value-end att)
;; <= because end is before quote
(<= (point) (xmltok-attribute-value-end att)))
(setq atts nil)
(setq ret att))
((and (< name-start (point))
(or (not ret)
(< (xmltok-attribute-name-start ret)
name-start)))
(setq ret att))))
(setq atts (cdr atts))
(unless atts
(setq atts more-atts)
(setq more-atts nil)))
ret))
(defun nxml-up-element (&optional arg)
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-backward-up-element (- arg))
(condition-case err
(while (and (> arg 0)
(< (point) (point-max)))
(let ((token-end (nxml-token-after)))
(goto-char (cond ((or (memq xmltok-type '(end-tag
partial-end-tag))
(and (memq xmltok-type
'(empty-element
partial-empty-element))
(< xmltok-start (point))))
token-end)
((nxml-scan-element-forward
(if (and (eq xmltok-type 'start-tag)
(= (point) xmltok-start))
xmltok-start
token-end)
t))
(t (error "No parent element")))))
(setq arg (1- arg)))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err))))))
(defun nxml-backward-up-element (&optional arg)
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-up-element (- arg))
(condition-case err
(while (and (> arg 0)
(< (point-min) (point)))
(let ((token-end (nxml-token-before)))
(goto-char (cond ((or (memq xmltok-type '(start-tag
partial-start-tag))
(and (memq xmltok-type
'(empty-element
partial-empty-element))
(< (point) token-end)))
xmltok-start)
((nxml-scan-element-backward
(if (and (eq xmltok-type 'end-tag)
(= (point) token-end))
token-end
xmltok-start)
t)
xmltok-start)
(t (error "No parent element")))))
(setq arg (1- arg)))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err))))))
(defun nxml-down-element (&optional arg)
"Move forward down into the content of an element.
With ARG, do this that many times.
Negative ARG means move backward but still down."
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-backward-down-element (- arg))
(while (> arg 0)
(goto-char
(let ((token-end (nxml-token-after)))
(save-excursion
(goto-char token-end)
(while (progn
(when (memq xmltok-type '(nil end-tag partial-end-tag))
(error "No following start-tags in this element"))
(not (memq xmltok-type '(start-tag partial-start-tag))))
(nxml-tokenize-forward))
(point))))
(setq arg (1- arg)))))
(defun nxml-backward-down-element (&optional arg)
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-down-element (- arg))
(while (> arg 0)
(goto-char
(save-excursion
(nxml-token-before)
(goto-char xmltok-start)
(while (progn
(when (memq xmltok-type '(start-tag
partial-start-tag
prolog
nil))
(error "No preceding end-tags in this element"))
(not (memq xmltok-type '(end-tag partial-end-tag))))
(if (or (<= (point) nxml-prolog-end)
(not (search-backward "<" nxml-prolog-end t)))
(setq xmltok-type nil)
(nxml-move-outside-backwards)
(xmltok-forward)))
xmltok-start))
(setq arg (1- arg)))))
(defun nxml-forward-element (&optional arg)
"Move forward over one element.
With ARG, do it that many times.
Negative ARG means move backward."
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-backward-element (- arg))
(condition-case err
(while (and (> arg 0)
(< (point) (point-max)))
(goto-char
(or (nxml-scan-element-forward (nxml-token-before))
(error "No more elements")))
(setq arg (1- arg)))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err))))))
(defun nxml-backward-element (&optional arg)
"Move backward over one element.
With ARG, do it that many times.
Negative ARG means move forward."
(interactive "^p")
(or arg (setq arg 1))
(if (< arg 0)
(nxml-forward-element (- arg))
(condition-case err
(while (and (> arg 0)
(< (point-min) (point)))
(goto-char
(or (and (nxml-scan-element-backward (progn
(nxml-token-after)
xmltok-start))
xmltok-start)
(error "No preceding elements")))
(setq arg (1- arg)))
(nxml-scan-error
(goto-char (cadr err))
(apply #'error (cddr err))))))
(defun nxml-mark-token-after ()
(interactive)
(push-mark (nxml-token-after) nil t)
(goto-char xmltok-start)
(message "Marked %s" xmltok-type))
;;; Paragraphs
(defun nxml-mark-paragraph ()
"Put point at beginning of this paragraph, mark at end.
The paragraph marked is the one that contains point or follows point."
(interactive)
(nxml-forward-paragraph)
(push-mark nil t t)
(nxml-backward-paragraph))
(defun nxml-forward-paragraph (&optional arg)
(interactive "^p")
(or arg (setq arg 1))
(cond ((< arg 0)
(nxml-backward-paragraph (- arg)))
((> arg 0)
(forward-line 0)
(while (and (nxml-forward-single-paragraph)
(> (setq arg (1- arg)) 0))))))
(defun nxml-backward-paragraph (&optional arg)
(interactive "^p")
(or arg (setq arg 1))
(cond ((< arg 0)
(nxml-forward-paragraph (- arg)))
((> arg 0)
(unless (bolp)
(let ((inhibit-field-text-motion t))
(end-of-line)))
(while (and (nxml-backward-single-paragraph)
(> (setq arg (1- arg)) 0))))))
(defun nxml-forward-single-paragraph ()
"Move forward over a single paragraph.
Return nil at end of buffer, t otherwise."
(let* ((token-end (nxml-token-after))
(offset (- (point) xmltok-start))
pos had-data)
(goto-char token-end)
(while (and (< (point) (point-max))
(not (setq pos
(nxml-paragraph-end-pos had-data offset))))
(when (nxml-token-contains-data-p offset)
(setq had-data t))
(nxml-tokenize-forward)
(setq offset 0))
(when pos (goto-char pos))))
(defun nxml-backward-single-paragraph ()
"Move backward over a single paragraph.
Return nil at start of buffer, t otherwise."
(let* ((token-end (nxml-token-before))
(offset (- token-end (point)))
(last-tag-pos xmltok-start)
pos had-data last-data-pos)
(goto-char token-end)
(unless (setq pos (nxml-paragraph-start-pos nil offset))
(setq had-data (nxml-token-contains-data-p nil offset))
(goto-char xmltok-start)
(while (and (not pos) (< (point-min) (point)))
(cond ((search-backward "<" nxml-prolog-end t)
(nxml-move-outside-backwards)
(save-excursion
(while (< (point) last-tag-pos)
(xmltok-forward)
(when (and (not had-data) (nxml-token-contains-data-p))
(setq pos nil)
(setq last-data-pos xmltok-start))
(let ((tem (nxml-paragraph-start-pos had-data 0)))
(when tem (setq pos tem)))))
(when (and (not had-data) last-data-pos (not pos))
(setq had-data t)
(save-excursion
(while (< (point) last-data-pos)
(xmltok-forward))
(let ((tem (nxml-paragraph-start-pos had-data 0)))
(when tem (setq pos tem)))))
(setq last-tag-pos (point)))
(t (goto-char (point-min))))))
(when pos (goto-char pos))))
(defun nxml-token-contains-data-p (&optional start end)
(setq start (+ xmltok-start (or start 0)))
(setq end (- (point) (or end 0)))
(when (eq xmltok-type 'cdata-section)
(setq start (max start (+ xmltok-start 9)))
(setq end (min end (- (point) 3))))
(or (and (eq xmltok-type 'data)
(eq start xmltok-start)
(eq end (point)))
(eq xmltok-type 'char-ref)
(and (memq xmltok-type '(data cdata-section))
(< start end)
(save-excursion
(goto-char start)
(re-search-forward "[^ \t\r\n]" end t)))))
(defun nxml-paragraph-end-pos (had-data offset)
"Return the position of the paragraph end if contained in the current token.
Return nil if the current token does not contain the paragraph end.
Only characters after OFFSET from the start of the token are eligible.
HAD-DATA says whether there have been non-whitespace data characters yet."
(cond ((not had-data)
(cond ((memq xmltok-type '(data cdata-section))
(save-excursion
(let ((end (point)))
(goto-char (+ xmltok-start
(max (if (eq xmltok-type 'cdata-section)
9
0)
offset)))
(and (re-search-forward "[^ \t\r\n]" end t)
(re-search-forward "^[ \t]*$" end t)
(match-beginning 0)))))
((and (eq xmltok-type 'comment)
(nxml-token-begins-line-p)
(nxml-token-ends-line-p))
(save-excursion
(let ((end (point)))
(goto-char (+ xmltok-start (max 4 offset)))
(when (re-search-forward "[^ \t\r\n]" (- end 3) t)
(if (re-search-forward "^[ \t]*$" end t)
(match-beginning 0)
(goto-char (- end 3))
(skip-chars-backward " \t")
(unless (bolp)
(beginning-of-line 2))
(point))))))))
((memq xmltok-type '(data space cdata-section))
(save-excursion
(let ((end (point)))
(goto-char (+ xmltok-start offset))
(and (re-search-forward "^[ \t]*$" end t)
(match-beginning 0)))))
((and (memq xmltok-type '(start-tag
end-tag
empty-element
comment
processing-instruction
entity-ref))
(nxml-token-begins-line-p)
(nxml-token-ends-line-p))
(save-excursion
(goto-char xmltok-start)
(skip-chars-backward " \t")
(point)))
((and (eq xmltok-type 'end-tag)
(looking-at "[ \t]*$")
(not (nxml-in-mixed-content-p t)))
(save-excursion
(or (search-forward "\n" nil t)
(point-max))))))
(defun nxml-paragraph-start-pos (had-data offset)
"Return the position of the paragraph start if contained in the current token.
Return nil if the current token does not contain the paragraph start.
Only characters before OFFSET from the end of the token are eligible.
HAD-DATA says whether there have been non-whitespace data characters yet."
(cond ((not had-data)
(cond ((memq xmltok-type '(data cdata-section))
(save-excursion
(goto-char (- (point)
(max (if (eq xmltok-type 'cdata-section)
3
0)
offset)))
(and (re-search-backward "[^ \t\r\n]" xmltok-start t)
(re-search-backward "^[ \t]*$" xmltok-start t)
(match-beginning 0))))
((and (eq xmltok-type 'comment)
(nxml-token-ends-line-p)
(nxml-token-begins-line-p))
(save-excursion
(goto-char (- (point) (max 3 offset)))
(when (and (< (+ xmltok-start 4) (point))
(re-search-backward "[^ \t\r\n]"
(+ xmltok-start 4)
t))
(if (re-search-backward "^[ \t]*$" xmltok-start t)
(match-beginning 0)
(goto-char xmltok-start)
(if (looking-at "<!--[ \t]*\n")
(match-end 0)
(skip-chars-backward " \t")
(point))))))))
((memq xmltok-type '(data space cdata-section))
(save-excursion
(goto-char (- (point) offset))
(and (re-search-backward "^[ \t]*$" xmltok-start t)
(match-beginning 0))))
((and (memq xmltok-type '(start-tag
end-tag
empty-element
comment
processing-instruction
entity-ref))
(nxml-token-ends-line-p)
(nxml-token-begins-line-p))
(or (search-forward "\n" nil t)
(point-max)))
((and (eq xmltok-type 'start-tag)
(nxml-token-begins-line-p)
(not (save-excursion
(goto-char xmltok-start)
(nxml-in-mixed-content-p nil))))
(save-excursion
(goto-char xmltok-start)
(skip-chars-backward " \t")
;; include any blank line before
(or (and (eq (char-before) ?\n)
(save-excursion
(goto-char (1- (point)))
(skip-chars-backward " \t")
(and (bolp) (point))))
(point))))))
(defun nxml-token-ends-line-p () (looking-at "[ \t]*$"))
(defun nxml-token-begins-line-p ()
(save-excursion
(goto-char xmltok-start)
(skip-chars-backward " \t")
(bolp)))
(defun nxml-in-mixed-content-p (endp)
"Return non-nil if point is in mixed content.
Point must be after an end-tag or before a start-tag.
ENDP is t in the former case, nil in the latter."
(let (matching-tag-pos)
(cond ((not (run-hook-with-args-until-failure
'nxml-in-mixed-content-hook))
nil)
;; See if the matching tag does not start or end a line.
((condition-case nil
(progn
(setq matching-tag-pos
(xmltok-save
(if endp
(and (nxml-scan-element-backward (point))
xmltok-start)
(nxml-scan-element-forward (point)))))
(and matching-tag-pos
(save-excursion
(goto-char matching-tag-pos)
(not (if endp
(progn
(skip-chars-backward " \t")
(bolp))
(looking-at "[ \t]*$"))))))
(nxml-scan-error nil))
t)
;; See if there's data at the same level.
((let (start end)
(if endp
(setq start matching-tag-pos
end (point))
(setq start (point)
end matching-tag-pos))
(save-excursion
(or (when start
(goto-char start)
(nxml-preceding-sibling-data-p))
(when end
(goto-char end)
(nxml-following-sibling-data-p)))))
t)
;; Otherwise, treat as not mixed
(t nil))))
(defun nxml-preceding-sibling-data-p ()
"Return non-nil if there is a previous sibling that is data."
(let ((lim (max (- (point) nxml-mixed-scan-distance)
nxml-prolog-end))
(level 0)
found end)
(xmltok-save
(save-excursion
(while (and (< lim (point))
(>= level 0)
(not found)
(progn
(setq end (point))
(search-backward "<" lim t)))
(nxml-move-outside-backwards)
(save-excursion
(xmltok-forward)
(let ((prev-level level))
(cond ((eq xmltok-type 'end-tag)
(setq level (1+ level)))
((eq xmltok-type 'start-tag)
(setq level (1- level))))
(when (eq prev-level 0)
(while (and (< (point) end) (not found))
(xmltok-forward)
(when (memq xmltok-type '(data cdata-section char-ref))
(setq found t)))))))))
found))
(defun nxml-following-sibling-data-p ()
(let ((lim (min (+ (point) nxml-mixed-scan-distance)
(point-max)))
(level 0)
found)
(xmltok-save
(save-excursion
(while (and (< (point) lim)
(>= level 0)
(nxml-tokenize-forward)
(not found))
(cond ((eq xmltok-type 'start-tag)
(setq level (1+ level)))
((eq xmltok-type 'end-tag)
(setq level (1- level)))
((and (eq level 0)
(memq xmltok-type '(data cdata-section char-ref)))
(setq found t))))))
found))
;;; Filling
(defun nxml-do-fill-paragraph (arg)
(let (fill-paragraph-function
fill-prefix
start end)
(save-excursion
(nxml-forward-paragraph)
(setq end (point))
(nxml-backward-paragraph)
(skip-chars-forward " \t\r\n")
(setq start (point))
(beginning-of-line)
(setq fill-prefix (buffer-substring-no-properties (point) start))
(when (and (not (nxml-get-inside (point)))
(looking-at "[ \t]*<!--"))
(setq fill-prefix (concat fill-prefix " ")))
(fill-region-as-paragraph start end arg))
(skip-line-prefix fill-prefix)
fill-prefix))
(defun nxml-newline-and-indent (soft)
(delete-horizontal-space)
(if soft (insert-and-inherit ?\n) (newline 1))
(nxml-indent-line))
;;; Dynamic markup
(defvar nxml-dynamic-markup-prev-pos nil)
(defvar nxml-dynamic-markup-prev-lengths nil)
(defvar nxml-dynamic-markup-prev-found-marker nil)
(defvar nxml-dynamic-markup-prev-start-tags (make-hash-table :test 'equal))
(defun nxml-dynamic-markup-word ()
"Dynamically markup the word before point.
This attempts to find a tag to put around the word before point based
on the contents of the current buffer. The end-tag will be inserted at
point. The start-tag will be inserted at or before the beginning of
the word before point; the contents of the current buffer is used to
decide where.
It works in a similar way to \\[dabbrev-expand]. It searches first
backwards from point, then forwards from point for an element whose
content is a string which matches the contents of the buffer before
point and which includes at least the word before point. It then
copies the start- and end-tags from that element and uses them to
surround the matching string before point.
Repeating \\[nxml-dynamic-markup-word] immediately after successful
\\[nxml-dynamic-markup-word] removes the previously inserted markup
and attempts to find another possible way to do the markup."
(interactive "*")
(let (search-start-pos)
(if (and (integerp nxml-dynamic-markup-prev-pos)
(= nxml-dynamic-markup-prev-pos (point))
(eq last-command this-command)
nxml-dynamic-markup-prev-lengths)
(let* ((end-tag-open-pos
(- nxml-dynamic-markup-prev-pos
(nth 2 nxml-dynamic-markup-prev-lengths)))
(start-tag-close-pos
(- end-tag-open-pos
(nth 1 nxml-dynamic-markup-prev-lengths)))
(start-tag-open-pos
(- start-tag-close-pos
(nth 0 nxml-dynamic-markup-prev-lengths))))
(delete-region end-tag-open-pos nxml-dynamic-markup-prev-pos)
(delete-region start-tag-open-pos start-tag-close-pos)
(setq search-start-pos
(marker-position nxml-dynamic-markup-prev-found-marker)))
(clrhash nxml-dynamic-markup-prev-start-tags))
(setq nxml-dynamic-markup-prev-pos nil)
(setq nxml-dynamic-markup-prev-lengths nil)
(setq nxml-dynamic-markup-prev-found-marker nil)
(goto-char
(save-excursion
(let* ((pos (point))
(word (progn
(backward-word 1)
(unless (< (point) pos)
(error "No word to markup"))
(buffer-substring-no-properties (point) pos)))
(search (concat word "</"))
done)
(when search-start-pos
(goto-char search-start-pos))
(while (and (not done)
(or (and (< (point) pos)
(or (search-backward search nil t)
(progn (goto-char pos) nil)))
(search-forward search nil t)))
(goto-char (- (match-end 0) 2))
(setq done (nxml-try-copy-markup pos)))
(or done
(error (if (zerop (hash-table-count
nxml-dynamic-markup-prev-start-tags))
"No possible markup found for `%s'"
"No more markup possibilities found for `%s'")
word)))))))
(defun nxml-try-copy-markup (word-end-pos)
(save-excursion
(let ((end-tag-pos (point)))
(when (and (not (nxml-get-inside end-tag-pos))
(search-backward "<" nil t)
(not (nxml-get-inside (point))))
(xmltok-forward)
(when (and (eq xmltok-type 'start-tag)
(< (point) end-tag-pos))
(let* ((start-tag-close-pos (point))
(start-tag
(buffer-substring-no-properties xmltok-start
start-tag-close-pos))
(words
(nreverse
(split-string
(buffer-substring-no-properties start-tag-close-pos
end-tag-pos)
"[ \t\r\n]+"))))
(goto-char word-end-pos)
(while (and words
(re-search-backward (concat
(regexp-quote (car words))
"\\=")
nil
t))
(setq words (cdr words))
(skip-chars-backward " \t\r\n"))
(when (and (not words)
(progn
(skip-chars-forward " \t\r\n")
(not (gethash (cons (point) start-tag)
nxml-dynamic-markup-prev-start-tags)))
(or (< end-tag-pos (point))
(< word-end-pos xmltok-start)))
(setq nxml-dynamic-markup-prev-found-marker
(copy-marker end-tag-pos t))
(puthash (cons (point) start-tag)
t
nxml-dynamic-markup-prev-start-tags)
(setq nxml-dynamic-markup-prev-lengths
(list (- start-tag-close-pos xmltok-start)
(- word-end-pos (point))
(+ (- xmltok-name-end xmltok-start) 2)))
(let ((name (xmltok-start-tag-qname)))
(insert start-tag)
(goto-char (+ word-end-pos
(- start-tag-close-pos xmltok-start)))
(insert "</" name ">")
(setq nxml-dynamic-markup-prev-pos (point))))))))))
;;; Character names
(defun nxml-insert-named-char (arg)
"Insert a character using its name.
The name is read from the minibuffer.
Normally, inserts the character as a numeric character reference.
With a prefix argument, inserts the character directly."
(interactive "*P")
(let ((code (read-char-by-name "Character name: ")))
(when code
(insert (if arg code (format "&#x%X;" code))))))
(defun nxml-toggle-char-ref-extra-display (arg)
"Toggle the display of extra information for character references."
(interactive "P")
(let ((new (if (null arg)
(not nxml-char-ref-extra-display)
(> (prefix-numeric-value arg) 0))))
(when (not (eq new nxml-char-ref-extra-display))
(setq nxml-char-ref-extra-display new)
(font-lock-flush))))
(put 'nxml-char-ref 'evaporate t)
(defun nxml-char-ref-display-extra (start end n)
(when nxml-char-ref-extra-display
(let ((name (or (get-char-code-property n 'name)
(get-char-code-property n 'old-name)))
(glyph-string (and nxml-char-ref-display-glyph-flag
(char-displayable-p n)
(string n)))
ov)
(when (or name glyph-string)
(setq ov (make-overlay start end nil t))
(overlay-put ov 'category 'nxml-char-ref)
(when name
(overlay-put ov 'help-echo name))
(when glyph-string
(overlay-put ov
'after-string
(propertize glyph-string 'face 'nxml-glyph)))))))
(defun nxml-clear-char-ref-extra-display (start end)
(let ((ov (overlays-in start end)))
(while ov
(when (eq (overlay-get (car ov) 'category) 'nxml-char-ref)
(delete-overlay (car ov)))
(setq ov (cdr ov)))))
(defun nxml-start-delimiter-length (type)
(or (get type 'nxml-start-delimiter-length)
0))
(put 'cdata-section 'nxml-start-delimiter-length 9)
(put 'comment 'nxml-start-delimiter-length 4)
(put 'processing-instruction 'nxml-start-delimiter-length 2)
(put 'start-tag 'nxml-start-delimiter-length 1)
(put 'empty-element 'nxml-start-delimiter-length 1)
(put 'partial-empty-element 'nxml-start-delimiter-length 1)
(put 'entity-ref 'nxml-start-delimiter-length 1)
(put 'char-ref 'nxml-start-delimiter-length 2)
(defun nxml-end-delimiter-length (type)
(or (get type 'nxml-end-delimiter-length)
0))
(put 'cdata-section 'nxml-end-delimiter-length 3)
(put 'comment 'nxml-end-delimiter-length 3)
(put 'processing-instruction 'nxml-end-delimiter-length 2)
(put 'start-tag 'nxml-end-delimiter-length 1)
(put 'empty-element 'nxml-end-delimiter-length 2)
(put 'partial-empty-element 'nxml-end-delimiter-length 1)
(put 'entity-ref 'nxml-end-delimiter-length 1)
(put 'char-ref 'nxml-end-delimiter-length 1)
(defun nxml-token-type-friendly-name (type)
(or (get type 'nxml-friendly-name)
(symbol-name type)))
(put 'cdata-section 'nxml-friendly-name "CDATA section")
(put 'processing-instruction 'nxml-friendly-name "processing instruction")
(put 'entity-ref 'nxml-friendly-name "entity reference")
(put 'char-ref 'nxml-friendly-name "character reference")
;; Only do this in loaddefs, so that if someone defines a different
;; alias in .emacs, loading this file afterwards does not clobber it.
;;;###autoload(defalias 'xml-mode 'nxml-mode)
(provide 'nxml-mode)
;;; nxml-mode.el ends here
|