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
use crate::{
lite_parser::LiteCommand,
parse_helpers::{PERCENT_FORCED_BUILTIN_PARSER_INFO, extract_spread_list, garbage},
parse_source::find_dirs_var,
type_check::type_compatible,
};
use log::trace;
use nu_engine::DIR_VAR_PARSER_INFO;
use nu_protocol::{
DeclId, Flag, IntoSpanned, ParseError, PositionalArg, ShellError, Signature, Span, Spanned,
SyntaxShape, Type, TypeSet,
ast::*,
did_you_mean,
engine::{CommandType, StateWorkingSet},
};
use std::str;
/// Return type of `check_call`
#[derive(Debug, PartialEq, Eq)]
pub(crate) enum CallKind {
Help,
Valid,
Invalid,
}
pub(crate) fn check_call(
working_set: &mut StateWorkingSet,
command: Span,
sig: &Signature,
call: &Call,
) -> CallKind {
// Allow the call to pass if they pass in the help flag
if call.named_iter().any(|(n, _, _)| n.item == "help") {
return CallKind::Help;
}
if call.positional_iter().count() < sig.required_positional.len() {
let end_offset = call
.positional_iter()
.last()
.map(|last| last.span.end)
.unwrap_or(command.end);
// Comparing the types of all signature positional arguments against the parsed
// expressions found in the call. If one type is not found then it could be assumed
// that positional argument is missing from the parsed call
for argument in &sig.required_positional {
let found = call.positional_iter().fold(false, |ac, expr| {
if argument.shape.to_type() == expr.ty || argument.shape == SyntaxShape::Any {
true
} else {
ac
}
});
if !found {
working_set.error(ParseError::MissingPositional(
argument.name.clone(),
Span::new(end_offset, end_offset),
sig.call_signature(),
));
return CallKind::Invalid;
}
}
let missing = &sig.required_positional[call.positional_iter().count()];
working_set.error(ParseError::MissingPositional(
missing.name.clone(),
Span::new(end_offset, end_offset),
sig.call_signature(),
));
return CallKind::Invalid;
} else {
for req_flag in sig.named.iter().filter(|x| x.required) {
if call.named_iter().all(|(n, _, _)| n.item != req_flag.long) {
working_set.error(ParseError::MissingRequiredFlag(
req_flag.long.clone(),
command,
));
return CallKind::Invalid;
}
}
}
CallKind::Valid
}
fn parse_unknown_arg(
working_set: &mut StateWorkingSet,
span: Span,
signature: &Signature,
) -> Expression {
let shape = signature
.rest_positional
.as_ref()
.map(|arg| arg.shape.clone())
.unwrap_or(SyntaxShape::Any);
crate::parser::parse_value(working_set, span, &shape, None)
}
fn parse_external_string(working_set: &mut StateWorkingSet, span: Span) -> Expression {
let contents = working_set.get_span_contents(span);
if contents.starts_with(b"r#") {
crate::parser::parse_raw_string(working_set, span)
} else if contents
.iter()
.any(|b| matches!(b, b'"' | b'\'' | b'(' | b')' | b'`'))
{
enum State {
Bare {
from: usize,
},
BackTickQuote {
from: usize,
},
Quote {
from: usize,
quote_char: u8,
escaped: bool,
},
Parenthesized {
from: usize,
depth: usize,
},
}
// Find the spans of parts of the string that can be parsed as their own strings for
// concatenation.
//
// By passing each of these parts to `parse_string()`, we can eliminate the quotes and also
// handle string interpolation.
let make_span = |from: usize, index: usize| Span {
start: span.start + from,
end: span.start + index,
};
let mut spans = vec![];
let mut state = State::Bare { from: 0 };
let mut index = 0;
while index < contents.len() {
let ch = contents[index];
match &mut state {
State::Bare { from } => match ch {
b'"' | b'\'' => {
// Push bare string
if index != *from {
spans.push(make_span(*from, index));
}
// then transition to other state
state = State::Quote {
from: index,
quote_char: ch,
escaped: false,
};
}
b'$' => {
if let Some("e_char @ (b'"' | b'\'')) = contents.get(index + 1) {
// Start a dollar quote (interpolated string)
if index != *from {
spans.push(make_span(*from, index));
}
state = State::Quote {
from: index,
quote_char,
escaped: false,
};
// Skip over two chars (the dollar sign and the quote)
index += 2;
continue;
}
}
b'`' => {
if index != *from {
spans.push(make_span(*from, index))
}
state = State::BackTickQuote { from: index }
}
b'(' => {
if index != *from {
spans.push(make_span(*from, index))
}
state = State::Parenthesized {
from: index,
depth: 1,
}
}
// Continue to consume
_ => (),
},
State::Quote {
from,
quote_char,
escaped,
} => match ch {
ch if ch == *quote_char && !*escaped => {
// quoted string ended, just make a new span for it.
spans.push(make_span(*from, index + 1));
// go back to Bare state.
state = State::Bare { from: index + 1 };
}
b'\\' if !*escaped && *quote_char == b'"' => {
// The next token is escaped so it doesn't count (only for double quote)
*escaped = true;
}
_ => {
*escaped = false;
}
},
State::BackTickQuote { from } => {
if ch == b'`' {
spans.push(make_span(*from, index + 1));
state = State::Bare { from: index + 1 };
}
}
State::Parenthesized { from, depth } => {
if ch == b')' {
if *depth == 1 {
spans.push(make_span(*from, index + 1));
state = State::Bare { from: index + 1 };
} else {
*depth -= 1;
}
} else if ch == b'(' {
*depth += 1;
}
}
}
index += 1;
}
// Add the final span
match state {
State::Bare { from }
| State::Quote { from, .. }
| State::Parenthesized { from, .. }
| State::BackTickQuote { from, .. } => {
if from < contents.len() {
spans.push(make_span(from, contents.len()));
}
}
}
// Log the spans that will be parsed
if log::log_enabled!(log::Level::Trace) {
let contents = spans
.iter()
.map(|span| String::from_utf8_lossy(working_set.get_span_contents(*span)))
.collect::<Vec<_>>();
trace!("parsing: external string, parts: {contents:?}")
}
// Check if the whole thing is quoted. If not, it should be a glob
let quoted =
(contents.len() >= 3 && contents.starts_with(b"$\"") && contents.ends_with(b"\""))
|| is_quoted(contents);
// Parse each as its own string
let exprs: Vec<Expression> = spans
.into_iter()
.map(|span| crate::parser::parse_string(working_set, span))
.collect();
if exprs
.iter()
.all(|expr| matches!(expr.expr, Expr::String(..)))
{
// If the exprs are all strings anyway, just collapse into a single string.
let string = exprs
.into_iter()
.map(|expr| {
let Expr::String(contents) = expr.expr else {
unreachable!("already checked that this was a String")
};
contents
})
.collect::<String>();
if quoted {
Expression::new(working_set, Expr::String(string), span, Type::String)
} else {
Expression::new(
working_set,
Expr::GlobPattern(string, false),
span,
Type::Glob,
)
}
} else {
// Flatten any string interpolations contained with the exprs.
let exprs = exprs
.into_iter()
.flat_map(|expr| match expr.expr {
Expr::StringInterpolation(subexprs) => subexprs,
_ => vec![expr],
})
.collect();
// Make an interpolation out of the expressions. Use `GlobInterpolation` if it's a bare
// word, so that the unquoted state can get passed through to `run-external`.
if quoted {
Expression::new(
working_set,
Expr::StringInterpolation(exprs),
span,
Type::String,
)
} else {
Expression::new(
working_set,
Expr::GlobInterpolation(exprs, false),
span,
Type::Glob,
)
}
}
} else {
crate::parser::parse_glob_pattern(working_set, span)
}
}
fn is_quoted(bytes: &[u8]) -> bool {
matches!(bytes, [b'\'', .., b'\''] | [b'"', .., b'"'])
}
fn parse_external_arg(working_set: &mut StateWorkingSet, span: Span) -> ExternalArgument {
let contents = working_set.get_span_contents(span);
if let Some(Spanned { item: _, span }) = extract_spread_list(contents.into_spanned(span)) {
ExternalArgument::Spread(crate::parser::parse_value(
working_set,
span,
&SyntaxShape::List(Box::new(SyntaxShape::Any)),
None,
))
} else {
ExternalArgument::Regular(parse_regular_external_arg(working_set, span))
}
}
pub(crate) fn parse_regular_external_arg(
working_set: &mut StateWorkingSet,
span: Span,
) -> Expression {
match working_set.get_span_contents(span) {
[b'$', ..] => crate::parser::parse_dollar_expr(working_set, span, &SyntaxShape::Any, None),
[b'(', ..] => crate::parser::parse_paren_expr(working_set, span, &SyntaxShape::Any),
[b'[', ..] => crate::parser::parse_list_expression(working_set, span, &SyntaxShape::Any),
_ => parse_external_string(working_set, span),
}
}
pub fn parse_external_call(
working_set: &mut StateWorkingSet,
spans: &[Span],
call_span: Span,
) -> Expression {
trace!("parse external");
let head_span = spans[0];
let head_contents = working_set.get_span_contents(head_span);
let head = if let [b'$' | b'(', ..] = head_contents {
// the expression is inside external_call, so it's a subexpression
let arg = crate::parser::parse_expression(working_set, &[head_span], None);
Box::new(arg)
} else {
Box::new(parse_external_string(working_set, head_span))
};
let args = spans[1..]
.iter()
.map(|&span| parse_external_arg(working_set, span))
.collect();
Expression::new(
working_set,
Expr::ExternalCall(head, args),
call_span,
Type::Any,
)
}
fn ensure_flag_arg_type(
working_set: &mut StateWorkingSet,
arg_name: String,
arg: Expression,
arg_shape: &SyntaxShape,
long_name_span: Span,
) -> (Spanned<String>, Expression) {
if !type_compatible(&arg_shape.to_type(), &arg.ty) {
working_set.error(ParseError::TypeMismatch(
arg_shape.to_type(),
arg.ty,
arg.span,
));
(
Spanned {
item: arg_name,
span: long_name_span,
},
Expression::garbage(working_set, arg.span),
)
} else {
(
Spanned {
item: arg_name,
span: long_name_span,
},
arg,
)
}
}
/// Result of attempting to parse a long flag.
///
/// This tri-state enum indicates whether a long flag was found, no flag was found,
/// or the end-of-options delimiter `--` was found (which stops all flag parsing).
enum LongFlagParseResult {
/// A long flag was successfully parsed: (flag_name, value_expression)
FoundFlag(Spanned<String>, Option<Expression>),
/// No long flag found at this position
NoFlag,
/// End-of-options delimiter `--` found; stop flag parsing
EndOfOptions,
}
fn parse_long_flag(
working_set: &mut StateWorkingSet,
spans: &[Span],
spans_idx: &mut usize,
sig: &Signature,
) -> LongFlagParseResult {
let arg_span = spans[*spans_idx];
let arg_contents = working_set.get_span_contents(arg_span);
if arg_contents.starts_with(b"--") {
// Check for end-of-options delimiter: exactly "--"
if arg_contents == b"--" {
return LongFlagParseResult::EndOfOptions;
}
// FIXME: only use the first flag you find?
let split: Vec<_> = arg_contents.split(|x| *x == b'=').collect();
let long_name = String::from_utf8(split[0].into());
if let Ok(long_name) = long_name {
let long_name = long_name[2..].to_string();
if let Some(flag) = sig.get_long_flag(&long_name) {
if let Some(arg_shape) = &flag.arg {
if split.len() > 1 {
// and we also have the argument
let long_name_len = long_name.len();
let mut span = arg_span;
span.start += long_name_len + 3; //offset by long flag and '='
let arg = crate::parser::parse_value(working_set, span, arg_shape, None);
let (arg_name, val_expression) = ensure_flag_arg_type(
working_set,
long_name,
arg,
arg_shape,
Span::new(arg_span.start, arg_span.start + long_name_len + 2),
);
LongFlagParseResult::FoundFlag(arg_name, Some(val_expression))
} else if let Some(arg) = spans.get(*spans_idx + 1) {
let arg = crate::parser::parse_value(working_set, *arg, arg_shape, None);
*spans_idx += 1;
let (arg_name, val_expression) =
ensure_flag_arg_type(working_set, long_name, arg, arg_shape, arg_span);
LongFlagParseResult::FoundFlag(arg_name, Some(val_expression))
} else {
working_set.error(ParseError::MissingFlagParam(
arg_shape.to_string(),
arg_span,
));
// NOTE: still need to cover this incomplete flag in the final expression
// see https://github.com/nushell/nushell/issues/16375
LongFlagParseResult::FoundFlag(
Spanned {
item: long_name,
span: arg_span,
},
None,
)
}
} else {
// A flag with no argument
// It can also takes a boolean value like --x=true
if split.len() > 1 {
// and we also have the argument
let long_name_len = long_name.len();
let mut span = arg_span;
span.start += long_name_len + 3; //offset by long flag and '='
let arg = crate::parser::parse_value(
working_set,
span,
&SyntaxShape::Boolean,
None,
);
let (arg_name, val_expression) = ensure_flag_arg_type(
working_set,
long_name,
arg,
&SyntaxShape::Boolean,
Span::new(arg_span.start, arg_span.start + long_name_len + 2),
);
LongFlagParseResult::FoundFlag(arg_name, Some(val_expression))
} else {
LongFlagParseResult::FoundFlag(
Spanned {
item: long_name,
span: arg_span,
},
None,
)
}
}
} else {
let suggestion = did_you_mean(sig.get_names(), &long_name)
.map(|name| format!("Did you mean: `--{name}`?"))
.unwrap_or("Use `--help` to see available flags".to_owned());
working_set.error(ParseError::UnknownFlag(
sig.name.clone(),
long_name.clone(),
arg_span,
suggestion,
));
LongFlagParseResult::FoundFlag(
Spanned {
item: long_name.clone(),
span: arg_span,
},
None,
)
}
} else {
working_set.error(ParseError::NonUtf8(arg_span));
LongFlagParseResult::FoundFlag(
Spanned {
item: "--".into(),
span: arg_span,
},
None,
)
}
} else {
LongFlagParseResult::NoFlag
}
}
fn parse_short_flags(
working_set: &mut StateWorkingSet,
spans: &[Span],
spans_idx: &mut usize,
positional_idx: usize,
sig: &Signature,
) -> Option<Vec<Flag>> {
let arg_span = spans[*spans_idx];
let arg_contents = working_set.get_span_contents(arg_span);
if let Ok(arg_contents_uft8_ref) = str::from_utf8(arg_contents) {
if arg_contents_uft8_ref.starts_with('-') && arg_contents_uft8_ref.len() > 1 {
let short_flags = &arg_contents_uft8_ref[1..];
let num_chars = short_flags.chars().count();
let mut found_short_flags = vec![];
let mut unmatched_short_flags = vec![];
for (offset, short_flag) in short_flags.char_indices() {
let short_flag_span = Span::new(
arg_span.start + 1 + offset,
arg_span.start + 1 + offset + short_flag.len_utf8(),
);
if let Some(flag) = sig.get_short_flag(short_flag) {
// Allow args in short flag batches as long as it is the last flag.
if flag.arg.is_some() && offset < num_chars - 1 {
working_set
.error(ParseError::OnlyLastFlagInBatchCanTakeArg(short_flag_span));
break;
}
found_short_flags.push(flag);
} else {
unmatched_short_flags.push(short_flag_span);
}
}
if found_short_flags.is_empty()
// check to see if we have a negative number
&& matches!(
sig.get_positional(positional_idx),
Some(PositionalArg {
shape: SyntaxShape::Int | SyntaxShape::Number | SyntaxShape::Float,
..
})
)
&& String::from_utf8_lossy(working_set.get_span_contents(arg_span))
.parse::<f64>()
.is_ok()
{
return None;
} else if let Some(first) = unmatched_short_flags.first() {
let contents = working_set.get_span_contents(*first);
working_set.error(ParseError::UnknownFlag(
sig.name.clone(),
format!("-{}", String::from_utf8_lossy(contents)),
*first,
"Use `--help` to see available flags".to_owned(),
));
}
Some(found_short_flags)
} else {
None
}
} else {
working_set.error(ParseError::NonUtf8(arg_span));
None
}
}
fn first_kw_idx(
working_set: &StateWorkingSet,
signature: &Signature,
spans: &[Span],
spans_idx: usize,
positional_idx: usize,
) -> (Option<usize>, usize) {
for idx in (positional_idx + 1)..signature.num_positionals() {
if let Some(PositionalArg {
shape: SyntaxShape::Keyword(kw, ..),
..
}) = signature.get_positional(idx)
{
for (span_idx, &span) in spans.iter().enumerate().skip(spans_idx) {
let contents = working_set.get_span_contents(span);
if contents == kw {
return (Some(idx), span_idx);
}
}
}
}
(None, spans.len())
}
fn calculate_end_span(
working_set: &StateWorkingSet,
signature: &Signature,
spans: &[Span],
spans_idx: usize,
positional_idx: usize,
) -> usize {
if signature.rest_positional.is_some() {
spans.len()
} else {
let (kw_pos, kw_idx) =
first_kw_idx(working_set, signature, spans, spans_idx, positional_idx);
if let Some(kw_pos) = kw_pos {
// We found a keyword. Keywords, once found, create a guidepost to
// show us where the positionals will lay into the arguments. Because they're
// keywords, they get to set this by being present
let positionals_between = kw_pos - positional_idx - 1;
if positionals_between >= (kw_idx - spans_idx) {
kw_idx
} else {
kw_idx - positionals_between
}
} else {
// Make space for the remaining require positionals, if we can
// spans_idx < spans.len() is an invariant
let remaining_spans = spans.len() - (spans_idx + 1);
// positional_idx can be larger than required_positional.len() if we have optional args
let remaining_positional = signature
.required_positional
.len()
.saturating_sub(positional_idx + 1);
// Saturates to 0 when we have too few args
let extra_spans = remaining_spans.saturating_sub(remaining_positional);
spans_idx + 1 + extra_spans
}
}
}
pub(crate) fn parse_oneof(
working_set: &mut StateWorkingSet,
spans: &[Span],
spans_idx: &mut usize,
possible_shapes: &Vec<SyntaxShape>,
multispan: bool,
input_type: Option<&Type>,
) -> Expression {
let starting_spans_idx = *spans_idx;
let mut best_guess = None;
let mut best_guess_errors = Vec::new();
let mut max_first_error_offset = 0;
let mut propagate_error = false;
for shape in possible_shapes {
let starting_error_count = working_set.parse_errors.len();
*spans_idx = starting_spans_idx;
let value = match multispan {
true => parse_multispan_value(working_set, spans, spans_idx, shape, input_type),
false => crate::parser::parse_value(working_set, spans[*spans_idx], shape, input_type),
};
let new_errors = &working_set.parse_errors[starting_error_count..];
// no new errors found means success
let Some(first_error_offset) = new_errors.iter().map(|e| e.span().start).min() else {
return value;
};
if first_error_offset > max_first_error_offset {
// while trying the possible shapes, ignore Expected type errors
// unless they're inside a block, closure, or expression
propagate_error = match working_set.parse_errors.last() {
Some(ParseError::Expected(_, error_span))
| Some(ParseError::ExpectedWithStringMsg(_, error_span)) => {
matches!(
shape,
SyntaxShape::Block | SyntaxShape::Closure(_) | SyntaxShape::Expression
) && *error_span != spans[*spans_idx]
}
_ => true,
};
max_first_error_offset = first_error_offset;
best_guess = Some(value);
best_guess_errors.clear();
best_guess_errors.extend_from_slice(new_errors);
}
working_set.parse_errors.truncate(starting_error_count);
}
// if best_guess results in new errors further than current span, then accept it
// or propagate_error is marked as true for it
if max_first_error_offset > spans[starting_spans_idx].start || propagate_error {
working_set.parse_errors.extend(best_guess_errors);
best_guess.expect("best_guess should not be None here!")
} else {
working_set.error(ParseError::ExpectedWithStringMsg(
format!("one of a list of accepted shapes: {possible_shapes:?}"),
spans[starting_spans_idx],
));
Expression::garbage(working_set, spans[starting_spans_idx])
}
}
pub fn parse_multispan_value(
working_set: &mut StateWorkingSet,
spans: &[Span],
spans_idx: &mut usize,
shape: &SyntaxShape,
input_type: Option<&Type>,
) -> Expression {
trace!("parse multispan value");
match shape {
SyntaxShape::VarWithOptType => {
trace!("parsing: var with opt type");
crate::parser::parse_var_with_opt_type(working_set, spans, spans_idx, false, input_type)
.0
}
SyntaxShape::RowCondition => {
trace!("parsing: row condition");
let arg = crate::parser::parse_row_condition(working_set, &spans[*spans_idx..]);
*spans_idx = spans.len() - 1;
arg
}
SyntaxShape::MathExpression => {
trace!("parsing: math expression");
let arg = crate::parser::parse_math_expression(
working_set,
&spans[*spans_idx..],
None,
input_type,
);
*spans_idx = spans.len() - 1;
arg
}
SyntaxShape::OneOf(possible_shapes) => parse_oneof(
working_set,
spans,
spans_idx,
possible_shapes,
true,
input_type,
),
SyntaxShape::Expression => {
trace!("parsing: expression");
// is it subexpression?
// Not sure, but let's make it not, so the behavior is the same as previous version of nushell.
let arg =
crate::parser::parse_expression(working_set, &spans[*spans_idx..], input_type);
*spans_idx = spans.len().saturating_sub(1);
arg
}
SyntaxShape::Signature => {
trace!("parsing: signature");
let sig = crate::parser::parse_full_signature(working_set, &spans[*spans_idx..], false);
*spans_idx = spans.len().saturating_sub(1);
sig
}
SyntaxShape::ExternalSignature => {
trace!("parsing: external signature");
let sig = crate::parser::parse_full_signature(working_set, &spans[*spans_idx..], true);
*spans_idx = spans.len().saturating_sub(1);
sig
}
SyntaxShape::Keyword(keyword, arg) => {
trace!(
"parsing: keyword({}) {:?}",
String::from_utf8_lossy(keyword),
arg
);
let arg_span = spans[*spans_idx];
let arg_contents = working_set.get_span_contents(arg_span);
if arg_contents != keyword {
// When keywords mismatch, this is a strong indicator of something going wrong.
// We won't often override the current error, but as this is a strong indicator
// go ahead and override the current error and tell the user about the missing
// keyword/literal.
working_set.error(ParseError::ExpectedKeyword(
String::from_utf8_lossy(keyword).into(),
arg_span,
))
}
*spans_idx += 1;
if *spans_idx >= spans.len() {
working_set.error(ParseError::KeywordMissingArgument(
arg.to_string(),
String::from_utf8_lossy(keyword).into(),
Span::new(spans[*spans_idx - 1].end, spans[*spans_idx - 1].end),
));
let keyword = Keyword {
keyword: keyword.as_slice().into(),
span: spans[*spans_idx - 1],
expr: Expression::garbage(working_set, arg_span),
};
return Expression::new(
working_set,
Expr::Keyword(Box::new(keyword)),
arg_span,
Type::Any,
);
}
let keyword = Keyword {
keyword: keyword.as_slice().into(),
span: spans[*spans_idx - 1],
expr: parse_multispan_value(working_set, spans, spans_idx, arg, input_type),
};
Expression::new(
working_set,
Expr::Keyword(Box::new(keyword.clone())),
keyword.span.merge(keyword.expr.span),
keyword.expr.ty,
)
}
_ => {
// All other cases are single-span values
let arg_span = spans[*spans_idx];
crate::parser::parse_value(working_set, arg_span, shape, input_type)
}
}
}
pub struct ParsedInternalCall {
pub call: Box<Call>,
pub output: Type,
pub call_kind: CallKind,
}
/// Sometimes the arguments of an internal command need to be parsed in dedicated functions, e.g. `parse_module`.
/// If so, `parse_internal_call` should be called with the appropriate parsing level to avoid repetition.
///
/// Defaults to `ArgumentParsingLevel::Full`
#[derive(Default)]
pub enum ArgumentParsingLevel {
#[default]
Full,
/// Parse only the first `k` arguments
FirstK { k: usize },
}
pub fn parse_internal_call(
working_set: &mut StateWorkingSet,
command_span: Span,
spans: &[Span],
decl_id: DeclId,
arg_parsing_level: ArgumentParsingLevel,
input_type: Option<&Type>,
) -> ParsedInternalCall {
trace!("parsing: internal call (decl id: {})", decl_id.get());
let mut call = Call::new(command_span);
call.decl_id = decl_id;
call.head = command_span;
let _ = working_set.add_span(call.head);
let decl = working_set.get_decl(decl_id);
let signature = working_set.get_signature(decl);
enum SpecialCmd {
Let,
Def,
Match,
If,
}
impl SpecialCmd {
fn from_str(s: &str) -> Option<Self> {
Some(match s {
"let" => Self::Let,
"def" => Self::Def,
"match" => Self::Match,
"if" => Self::If,
_ => return None,
})
}
}
let special_cmd = decl
.is_keyword()
.then(|| decl.name())
.and_then(SpecialCmd::from_str);
// TODO: Throw an actual error here, instead of leaning on later type checking code
//
// `Type::Nothing` is added to inputs to allow uses like:
// `ls | sort-by { open -r $in.name | lines | length }`
// see https://github.com/nushell/nushell/pull/14922
// Incorrect behavior this may cause will be handled by
// `check_pipeline_type` in crates/nu-parser/src/type_check.rs
let output = signature
.get_output_type(
input_type
.map(|ty| ty.clone().union(Type::Nothing))
.as_ref(),
)
.unwrap_or(Type::Error);
// This is necessary for some keywords to have proper expression types.
// `2 | let x | let y`
// - `$x` should be `int`
// - `$y` should also be `int`, but for that `let x` as an expression must have the type `int`
let mut output_override = None;
let deprecation = decl.deprecation_info();
// storing the var ID for later due to borrowing issues
let lib_dirs_var_id = match decl.name() {
"use" | "overlay use" | "source-env" if decl.is_keyword() => {
find_dirs_var(working_set, crate::parse_source::LIB_DIRS_VAR)
}
"nu-check" if decl.is_builtin() => {
find_dirs_var(working_set, crate::parse_source::LIB_DIRS_VAR)
}
_ => None,
};
// The index into the positional parameter in the definition
let mut positional_idx = 0;
// The index into the spans of argument data given to parse
// Starting at the first argument
let mut spans_idx = 0;
if let Some(alias) = decl.as_alias() {
if let Expression {
expr: Expr::Call(wrapped_call),
..
} = &alias.wrapped_call
{
// Replace this command's call with the aliased call, but keep the alias name
call = *wrapped_call.clone();
call.head = command_span;
// Skip positionals passed to aliased call
positional_idx = call.positional_iter().count();
} else {
working_set.error(ParseError::UnknownState(
"Alias does not point to internal call.".to_string(),
command_span,
));
return ParsedInternalCall {
call: Box::new(call),
output: Type::Any,
call_kind: CallKind::Invalid,
};
}
}
if let Some(var_id) = lib_dirs_var_id {
call.set_parser_info(
DIR_VAR_PARSER_INFO.to_owned(),
Expression::new(working_set, Expr::Var(var_id), call.head, Type::Any),
);
}
if signature.creates_scope {
working_set.enter_scope();
}
let mut end_of_options = false;
while spans_idx < spans.len() {
let arg_span = spans[spans_idx];
let starting_error_count = working_set.parse_errors.len();
// If we've seen --, skip all flag parsing and go straight to positional parsing
if !end_of_options {
// Check if we're on a long flag, if so, parse
let flag_parse_result = parse_long_flag(working_set, spans, &mut spans_idx, &signature);
match flag_parse_result {
LongFlagParseResult::EndOfOptions => {
// Switch to positional-only mode so subsequent flags aren't parsed.
end_of_options = true;
if signature.allows_unknown_args {
// For commands that pass through unknown args (extern, def --wrapped,
// exec, etc.), -- itself must be forwarded to the underlying program.
let arg = parse_unknown_arg(working_set, arg_span, &signature);
call.add_unknown(arg);
}
spans_idx += 1;
continue;
}
LongFlagParseResult::FoundFlag(long_name, arg) => {
// We found a long flag, like --bar
if working_set.parse_errors[starting_error_count..]
.iter()
.any(|x| matches!(x, ParseError::UnknownFlag(_, _, _, _)))
&& signature.allows_unknown_args
{
working_set.parse_errors.truncate(starting_error_count);
let arg = parse_unknown_arg(working_set, arg_span, &signature);
call.add_unknown(arg);
} else {
call.add_named((long_name, None, arg));
}
spans_idx += 1;
continue;
}
LongFlagParseResult::NoFlag => {
// No long flag found, continue to short flag parsing
}
}
}
// Only try short flag parsing if we haven't seen -- yet
if !end_of_options {
let starting_error_count = working_set.parse_errors.len();
// Check if we're on a short flag or group of short flags, if so, parse
let short_flags = parse_short_flags(
working_set,
spans,
&mut spans_idx,
positional_idx,
&signature,
);
if let Some(mut short_flags) = short_flags {
if short_flags.is_empty() {
// workaround for completions (PR #6067)
short_flags.push(Flag {
long: "".to_string(),
short: Some('a'),
arg: None,
required: false,
desc: "".to_string(),
var_id: None,
default_value: None,
completion: None,
})
}
if working_set.parse_errors[starting_error_count..]
.iter()
.any(|x| matches!(x, ParseError::UnknownFlag(_, _, _, _)))
&& signature.allows_unknown_args
{
working_set.parse_errors.truncate(starting_error_count);
let arg = parse_unknown_arg(working_set, arg_span, &signature);
call.add_unknown(arg);
} else {
for flag in short_flags {
let _ = working_set.add_span(spans[spans_idx]);
if let Some(arg_shape) = flag.arg {
if let Some(arg) = spans.get(spans_idx + 1) {
let arg =
crate::parser::parse_value(working_set, *arg, &arg_shape, None);
let (arg_name, val_expression) = ensure_flag_arg_type(
working_set,
flag.long.clone(),
arg.clone(),
&arg_shape,
spans[spans_idx],
);
if flag.long.is_empty() {
if let Some(short) = flag.short {
call.add_named((
arg_name,
Some(Spanned {
item: short.to_string(),
span: spans[spans_idx],
}),
Some(val_expression),
));
}
} else {
call.add_named((arg_name, None, Some(val_expression)));
}
spans_idx += 1;
} else {
working_set.error(ParseError::MissingFlagParam(
arg_shape.to_string(),
arg_span,
));
// NOTE: still need to cover this incomplete flag in the final expression
// see https://github.com/nushell/nushell/issues/16375
call.add_named((
Spanned {
item: String::new(),
span: spans[spans_idx],
},
None,
None,
));
}
} else if flag.long.is_empty() {
if let Some(short) = flag.short {
call.add_named((
Spanned {
item: String::new(),
span: spans[spans_idx],
},
Some(Spanned {
item: short.to_string(),
span: spans[spans_idx],
}),
None,
));
}
} else {
call.add_named((
Spanned {
item: flag.long.clone(),
span: spans[spans_idx],
},
None,
None,
));
}
}
}
spans_idx += 1;
continue;
}
} // end if !end_of_options (short flags)
{
let contents = working_set.get_span_contents(spans[spans_idx]);
if let Some(Spanned {
span: spread_arg_span,
..
}) = extract_spread_list(contents.into_spanned(spans[spans_idx]))
{
if signature.rest_positional.is_none() && !signature.allows_unknown_args {
working_set.error(ParseError::UnexpectedSpreadArg(
signature.call_signature(),
arg_span,
));
call.add_positional(Expression::garbage(working_set, arg_span));
} else if positional_idx < signature.required_positional.len() {
working_set.error(ParseError::MissingPositional(
signature.required_positional[positional_idx].name.clone(),
Span::new(spans[spans_idx].start, spans[spans_idx].start),
signature.call_signature(),
));
call.add_positional(Expression::garbage(working_set, arg_span));
} else {
let rest_shape = match &signature.rest_positional {
Some(arg) if matches!(arg.shape, SyntaxShape::ExternalArgument) => {
// External args aren't parsed inside lists in spread position.
SyntaxShape::Any
}
Some(arg) => arg.shape.clone(),
None => SyntaxShape::Any,
};
// Parse list of arguments to be spread
let args = crate::parser::parse_value(
working_set,
spread_arg_span,
&SyntaxShape::List(Box::new(rest_shape)),
None,
);
call.add_spread(args);
// Let the parser know that it's parsing rest arguments now
positional_idx =
signature.required_positional.len() + signature.optional_positional.len();
}
spans_idx += 1;
continue;
}
}
// Parse a positional arg if there is one
if let Some(positional) = signature.get_positional(positional_idx) {
let end = calculate_end_span(working_set, &signature, spans, spans_idx, positional_idx);
// Missing arguments before next keyword
if end == spans_idx {
let prev_span = if spans_idx == 0 {
command_span
} else {
spans[spans_idx - 1]
};
let whitespace_span = Span::new(prev_span.end, spans[spans_idx].start);
working_set.error(ParseError::MissingPositional(
positional.name.clone(),
whitespace_span,
signature.call_signature(),
));
call.add_positional(Expression::garbage(working_set, whitespace_span));
positional_idx += 1;
continue;
}
debug_assert!(end <= spans.len());
if spans[..end].is_empty() || spans_idx == end {
working_set.error(ParseError::MissingPositional(
positional.name.clone(),
Span::new(spans[spans_idx].end, spans[spans_idx].end),
signature.call_signature(),
));
positional_idx += 1;
continue;
}
let compile_error_count = working_set.compile_errors.len();
// HACK: avoid repeated parsing of argument values in special cases
// see https://github.com/nushell/nushell/issues/16398
let arg = match arg_parsing_level {
ArgumentParsingLevel::FirstK { k } if k <= positional_idx => {
Expression::garbage(working_set, spans[spans_idx])
}
_ => {
let input_type: Option<Type> = match special_cmd {
// `let` can assigned from pipeline input, input type is necessary to infer
// the variable's type correctly
Some(SpecialCmd::Let)
if let SyntaxShape::VarWithOptType = &positional.shape =>
{
output_override = input_type.cloned();
input_type.cloned()
}
// in a def block, the pipeline input type should be inferred based on the
// command input-output signature
Some(SpecialCmd::Def) if &positional.name == "block" => {
// if we're parsing the `block`, the previous item is the signature
match call.arguments.last() {
Some(Argument::Positional(Expression {
expr: Expr::Signature(sig),
..
})) => Some(sig.get_input_type()),
_ => None,
}
}
Some(SpecialCmd::If) if positional_idx >= 1 => input_type.cloned(),
Some(SpecialCmd::Match) if &positional.name == "match_block" => {
input_type.cloned()
}
_ => None,
};
let expr = parse_multispan_value(
working_set,
&spans[..end],
&mut spans_idx,
&positional.shape,
input_type.as_ref(),
);
match special_cmd {
Some(SpecialCmd::Match) if &positional.name == "match_block" => {
output_override = Some(expr.ty.clone());
}
Some(SpecialCmd::If)
if positional_idx == 1
&& let Expr::Block(block_id) = &expr.expr =>
{
let block = working_set.get_block(*block_id);
let ty = match block.pipelines.is_empty() {
false => block.output_type(),
true => input_type.unwrap_or(Type::Any),
};
output_override = Some(match output_override {
Some(existing_ty) => existing_ty.union(ty),
None => ty,
});
}
Some(SpecialCmd::If)
if positional_idx == 2
&& let Expr::Keyword(kw) = &expr.expr =>
{
let ty = match &kw.expr.expr {
Expr::Block(block_id) => {
let block = working_set.get_block(*block_id);
match block.pipelines.is_empty() {
false => block.output_type(),
true => input_type.unwrap_or(Type::Any),
}
}
_ => kw.expr.ty.clone(),
};
output_override = Some(match output_override {
Some(existing_ty) => existing_ty.union(ty),
None => ty,
});
}
_ => {}
};
expr
}
};
// HACK: try-catch's signature defines the catch block as a Closure, even though it's
// used like a Block. Because closures are compiled eagerly, this ends up making the
// following code technically invalid:
// ```nu
// loop { try { } catch {|e| break } }
// ```
// Thus, we discard the compilation error here
if let SyntaxShape::OneOf(ref shapes) = positional.shape {
for one_shape in shapes {
if let SyntaxShape::Keyword(keyword, ..) = one_shape
&& keyword == b"catch"
&& let [nu_protocol::CompileError::NotInALoop { .. }] =
&working_set.compile_errors[compile_error_count..]
{
working_set.compile_errors.truncate(compile_error_count);
}
}
}
let arg = if !type_compatible(&positional.shape.to_type(), &arg.ty) {
working_set.error(ParseError::TypeMismatch(
positional.shape.to_type(),
arg.ty,
arg.span,
));
Expression::garbage(working_set, arg.span)
} else {
arg
};
call.add_positional(arg);
positional_idx += 1;
} else if signature.allows_unknown_args {
let arg = parse_unknown_arg(working_set, arg_span, &signature);
call.add_unknown(arg);
} else {
call.add_positional(Expression::garbage(working_set, arg_span));
working_set.error(ParseError::ExtraPositional(
signature.call_signature(),
arg_span,
))
}
spans_idx += 1;
}
// TODO: Inline `check_call`,
// move missing positional checking into the while loop above with two pointers.
// Maybe more `CallKind::Invalid` if errors found during argument parsing.
let call_kind = check_call(working_set, command_span, &signature, &call);
deprecation
.into_iter()
.filter_map(|entry| entry.parse_warning(&signature.name, &call))
.for_each(|warning| {
// FIXME: if two flags are deprecated and both are used in one command,
// the second flag's deprecation won't show until the first flag is removed
// (but it won't be flagged as reported until it is actually reported)
working_set.warning(warning);
});
if signature.creates_scope {
working_set.exit_scope();
}
match special_cmd {
// Not having an else branch means the output can be `nothing`
Some(SpecialCmd::If) if call.arguments.len() < 3 => {
output_override = output_override.map(|ty| ty.union(Type::Nothing))
}
_ => {}
}
let output = output_override.unwrap_or(output);
ParsedInternalCall {
call: Box::new(call),
output,
call_kind,
}
}
pub fn parse_call(
working_set: &mut StateWorkingSet,
spans: &[Span],
head: Span,
input_type: Option<&Type>,
) -> Expression {
trace!("parsing: call");
let call_span = Span::concat(spans);
if spans.is_empty() {
working_set.error(ParseError::UnknownState(
"Encountered command with zero spans".into(),
call_span,
));
return garbage(working_set, head);
}
let call_sigil = match working_set.get_span_contents(spans[0]).first() {
Some(b'^') => Some(b'^'),
Some(b'%') => Some(b'%'),
_ => None,
};
let mut adjusted_spans = Vec::new();
let resolution_spans = match call_sigil {
Some(b'^') | Some(b'%') => {
adjusted_spans.reserve(spans.len());
adjusted_spans.push(Span::new(spans[0].start + 1, spans[0].end));
adjusted_spans.extend_from_slice(&spans[1..]);
adjusted_spans.as_slice()
}
_ => spans,
};
// `^` always forces external command parsing and must bypass declaration
// resolution, even when an internal command with the same name exists.
if call_sigil == Some(b'^') {
trace!("parsing: forced external call");
return parse_external_call(working_set, resolution_spans, call_span);
}
// Check if we have a percent sigil with a dynamic head (variable or expression).
// Supports two token layouts:
// - single token: `%$cmd` or `%($cmd)` — stripping `%` leaves `$cmd` / `($cmd)` in [0]
// - two tokens: `%` and `($cmd)` — stripping `%` leaves an empty span in [0]; head is [1]
// If so, defer builtin validation to runtime (the IR compiler will rewrite to `run-internal`).
if call_sigil == Some(b'%') && !resolution_spans.is_empty() {
// Locate the actual head span, skipping an empty leading span.
let (head_idx, head_span) = {
let first = working_set.get_span_contents(resolution_spans[0]);
if first.is_empty() && resolution_spans.len() > 1 {
(1, resolution_spans[1])
} else {
(0, resolution_spans[0])
}
};
let dynamic_head_contents = working_set.get_span_contents(head_span);
let is_dynamic_head = !dynamic_head_contents.is_empty()
&& (dynamic_head_contents[0] == b'$' || dynamic_head_contents[0] == b'(');
if is_dynamic_head {
trace!("parsing: dynamic percent builtin dispatch");
let head_expr = crate::parser::parse_expression(working_set, &[head_span], input_type);
// Create a placeholder call; the IR compiler will rewrite this to `run-internal`.
let mut call = Call::new(call_span);
call.decl_id = DeclId::new(0);
// Store the head expression for the IR compiler to pick up.
call.set_parser_info(PERCENT_FORCED_BUILTIN_PARSER_INFO.to_string(), head_expr);
// Mirror the dynamic external-call path by preserving `...expr` as an explicit spread
// argument so runtime dispatch can forward it without flattening first.
for arg_span in resolution_spans.iter().skip(head_idx + 1) {
let contents = working_set.get_span_contents(*arg_span);
if let Some(Spanned { span: arg_span, .. }) =
extract_spread_list(contents.into_spanned(*arg_span))
{
let spread_expr = crate::parser::parse_value(
working_set,
arg_span,
&SyntaxShape::List(Box::new(SyntaxShape::Any)),
None,
);
call.arguments.push(Argument::Spread(spread_expr));
} else {
let arg_expr =
crate::parser::parse_value(working_set, *arg_span, &SyntaxShape::Any, None);
call.arguments.push(Argument::Positional(arg_expr));
}
}
return Expression::new(
working_set,
Expr::Call(Box::new(call)),
call_span,
Type::Any,
);
}
}
let (cmd_start, pos, _name, maybe_decl_id) = if call_sigil == Some(b'%') {
find_longest_decl_with_command_type(working_set, resolution_spans, CommandType::Builtin)
} else {
find_longest_decl(working_set, resolution_spans)
};
if let Some(decl_id) = maybe_decl_id {
// Before the internal parsing we check if there is no let or alias declarations
// that are missing their name, e.g.: let = 1 or alias = 2
if resolution_spans.len() > 1 {
let test_equal = working_set.get_span_contents(resolution_spans[1]);
if test_equal == [b'='] {
trace!("incomplete statement");
working_set.error(ParseError::UnknownState(
"Incomplete statement".into(),
call_span,
));
return garbage(working_set, call_span);
}
}
let decl = working_set.get_decl(decl_id);
let parsed_call = if let Some(alias) = decl.as_alias() {
if let Expression {
expr: Expr::ExternalCall(head, args),
span: _,
span_id: _,
ty,
} = &alias.clone().wrapped_call
{
trace!("parsing: alias of external call");
let mut head = head.clone();
head.span = Span::concat(&resolution_spans[cmd_start..pos]); // replacing the spans preserves syntax highlighting
let mut final_args = args.clone().into_vec();
for arg_span in &resolution_spans[pos..] {
let arg = parse_external_arg(working_set, *arg_span);
final_args.push(arg);
}
let expression = Expression::new(
working_set,
Expr::ExternalCall(head, final_args.into()),
Span::concat(spans),
ty.clone(),
);
return expression;
} else {
trace!("parsing: alias of internal call");
parse_internal_call(
working_set,
Span::concat(&resolution_spans[cmd_start..pos]),
&resolution_spans[pos..],
decl_id,
ArgumentParsingLevel::Full,
input_type,
)
}
} else {
trace!("parsing: internal call");
parse_internal_call(
working_set,
Span::concat(&resolution_spans[cmd_start..pos]),
&resolution_spans[pos..],
decl_id,
ArgumentParsingLevel::Full,
input_type,
)
};
Expression::new(
working_set,
Expr::Call(parsed_call.call),
call_span,
parsed_call.output,
)
} else {
if call_sigil == Some(b'%') {
working_set.error(ParseError::LabeledErrorWithHelp {
error: "percent sigil requires a built-in command".into(),
label: "unknown built-in command".into(),
help:
"remove `%` to use normal resolution, or use `^` to run an external command explicitly".into(),
span: resolution_spans[0],
});
// Preserve expression shape for features like completion while retaining the parse error.
return parse_external_call(working_set, spans, call_span);
}
// We might be parsing left-unbounded range ("..10")
let bytes = working_set.get_span_contents(spans[0]);
trace!("parsing: range {bytes:?}");
if let (Some(b'.'), Some(b'.')) = (bytes.first(), bytes.get(1)) {
trace!("-- found leading range indicator");
let starting_error_count = working_set.parse_errors.len();
if let Some(range_expr) = crate::parser::parse_range(working_set, spans[0]) {
trace!("-- successfully parsed range");
return range_expr;
}
working_set.parse_errors.truncate(starting_error_count);
}
trace!("parsing: external call");
// Otherwise, try external command
parse_external_call(working_set, spans, call_span)
}
}
fn find_decl_with_command_type(
working_set: &StateWorkingSet<'_>,
name: &[u8],
command_type: CommandType,
) -> Option<DeclId> {
// Search all known declarations so `%cmd` can still resolve a built-in even when
// a custom command with the same name shadows it in normal visibility lookup.
for idx in (0..working_set.num_decls()).rev() {
let decl_id = DeclId::new(idx);
let decl = working_set.get_decl(decl_id);
if decl.command_type() == command_type && decl.name().as_bytes() == name {
return Some(decl_id);
}
}
None
}
fn command_name_from_spans(
working_set: &StateWorkingSet<'_>,
spans: &[Span],
prefix: &[u8],
) -> Vec<u8> {
let mut name = Vec::with_capacity(prefix.len() + spans.len() * 2);
name.extend(prefix);
for span in spans {
let name_part = working_set.get_span_contents(*span);
if name.is_empty() {
name.extend(name_part);
} else {
name.push(b' ');
name.extend(name_part);
}
}
name
}
fn find_longest_decl_with_command_type(
working_set: &StateWorkingSet<'_>,
spans: &[Span],
command_type: CommandType,
) -> (
usize,
usize,
Vec<u8>,
Option<nu_protocol::Id<nu_protocol::marker::Decl>>,
) {
let mut pos = spans.len();
let cmd_start = 0;
let mut name_spans = spans.to_vec();
let mut name = command_name_from_spans(working_set, &name_spans, b"");
let mut maybe_decl_id = find_decl_with_command_type(working_set, &name, command_type);
while maybe_decl_id.is_none() {
if name_spans.len() <= 1 {
break;
}
name_spans.pop();
pos -= 1;
name = command_name_from_spans(working_set, &name_spans, b"");
maybe_decl_id = find_decl_with_command_type(working_set, &name, command_type);
}
(cmd_start, pos, name, maybe_decl_id)
}
pub fn find_longest_decl(
working_set: &mut StateWorkingSet<'_>,
spans: &[Span],
) -> (
usize,
usize,
Vec<u8>,
Option<nu_protocol::Id<nu_protocol::marker::Decl>>,
) {
find_longest_decl_with_prefix(working_set, spans, b"")
}
pub fn find_longest_decl_with_prefix(
working_set: &mut StateWorkingSet<'_>,
spans: &[Span],
prefix: &[u8],
) -> (
usize,
usize,
Vec<u8>,
Option<nu_protocol::Id<nu_protocol::marker::Decl>>,
) {
let mut pos = 0;
let cmd_start = pos;
let mut name_spans = vec![];
for word_span in spans[cmd_start..].iter() {
// Find the longest group of words that could form a command
name_spans.push(*word_span);
pos += 1;
}
let mut name = command_name_from_spans(working_set, &name_spans, prefix);
let mut maybe_decl_id = working_set.find_decl(&name);
while maybe_decl_id.is_none() {
// Find the longest command match
if name_spans.len() <= 1 {
// Keep the first word even if it does not match -- could be external command
break;
}
name_spans.pop();
pos -= 1;
name = command_name_from_spans(working_set, &name_spans, prefix);
maybe_decl_id = working_set.find_decl(&name);
}
// If there is a declaration and there are remaining spans, check if it's an alias.
// If it is, try to see if there are sub commands
if let Some(decl_id) = maybe_decl_id
&& pos < spans.len()
{
let decl = working_set.get_decl(decl_id);
if let Some(alias) = decl.as_alias() {
// Extract the command name from the alias
// The wrapped_call should be a Call expression for internal commands
if let Expression {
expr: Expr::Call(call),
..
} = &alias.wrapped_call
{
let aliased_decl_id = call.decl_id;
let aliased_name = working_set.get_decl(aliased_decl_id).name().to_string();
// Try to find a longer match using the aliased command name with remaining spans
let (_, new_pos, new_name, new_decl_id) = find_longest_decl_with_prefix(
working_set,
&spans[pos..],
aliased_name.as_bytes(),
);
// If we find a sub command, use it instead.
if new_decl_id.is_some() && new_pos > 0 {
let total_pos = pos + new_pos;
return (cmd_start, total_pos, new_name, new_decl_id);
}
}
}
}
(cmd_start, pos, name, maybe_decl_id)
}
pub fn parse_attribute(
working_set: &mut StateWorkingSet,
lite_command: &LiteCommand,
) -> (Attribute, Option<String>) {
let _ = lite_command
.parts
.first()
.filter(|s| working_set.get_span_contents(**s).starts_with(b"@"))
.expect("Attributes always start with an `@`");
assert!(
lite_command.attribute_idx.is_empty(),
"attributes can't have attributes"
);
let mut spans = lite_command.parts.clone();
if let Some(first) = spans.first_mut() {
first.start += 1;
}
let spans = spans.as_slice();
let attr_span = Span::concat(spans);
let (cmd_start, cmd_end, mut name, decl_id) =
find_longest_decl_with_prefix(working_set, spans, b"attr");
debug_assert!(name.starts_with(b"attr "));
let _ = name.drain(..(b"attr ".len()));
let name_span = Span::concat(&spans[cmd_start..cmd_end]);
let Ok(name) = String::from_utf8(name) else {
working_set.error(ParseError::NonUtf8(name_span));
return (
Attribute {
expr: garbage(working_set, attr_span),
},
None,
);
};
let Some(decl_id) = decl_id else {
working_set.error(ParseError::UnknownCommand(name_span));
return (
Attribute {
expr: garbage(working_set, attr_span),
},
None,
);
};
let decl = working_set.get_decl(decl_id);
let parsed_call = match decl.as_alias() {
// TODO: Once `const def` is available, we should either disallow aliases as attributes OR
// allow them but rather than using the aliases' name, use the name of the aliased command
Some(alias) => match &alias.clone().wrapped_call {
Expression {
expr: Expr::ExternalCall(..),
..
} => {
let shell_error = ShellError::NotAConstCommand { span: name_span };
working_set.error(shell_error.wrap(working_set, attr_span));
return (
Attribute {
expr: garbage(working_set, Span::concat(spans)),
},
None,
);
}
_ => {
trace!("parsing: alias of internal call");
parse_internal_call(
working_set,
name_span,
&spans[cmd_end..],
decl_id,
ArgumentParsingLevel::Full,
None,
)
}
},
None => {
trace!("parsing: internal call");
parse_internal_call(
working_set,
name_span,
&spans[cmd_end..],
decl_id,
ArgumentParsingLevel::Full,
None,
)
}
};
(
Attribute {
expr: Expression::new(
working_set,
Expr::Call(parsed_call.call),
Span::concat(spans),
parsed_call.output,
),
},
Some(name),
)
}