File size: 77,838 Bytes
8c763fb | 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Management.Automation.Internal;
using System.Management.Automation.Internal.Host;
using System.Management.Automation.Language;
using System.Management.Automation.Runspaces;
using System.Runtime.CompilerServices;
using System.Runtime.Serialization;
using System.Text.RegularExpressions;
using Dbg = System.Management.Automation.Diagnostics;
#pragma warning disable 1634, 1691 // Stops compiler from warning about unknown warnings
namespace System.Management.Automation
{
#region Flow Control Exceptions
/// <summary>
/// FlowControlException, base class for flow control exceptions.
/// </summary>
public abstract class FlowControlException : SystemException
{
internal FlowControlException() { }
}
/// <summary>
/// LoopFlowException, base class for loop control exceptions.
/// </summary>
public abstract class LoopFlowException : FlowControlException
{
internal LoopFlowException(string label)
{
this.Label = label ?? string.Empty;
}
internal LoopFlowException() { }
/// <summary>
/// Label, indicates nested loop level affected by exception.
/// No label means most nested loop is affected.
/// </summary>
public string Label
{
get;
internal set;
}
internal bool MatchLabel(string loopLabel)
{
return MatchLoopLabel(Label, loopLabel);
}
internal static bool MatchLoopLabel(string flowLabel, string loopLabel)
{
// If the flow statement has no label, it always matches (because it just means, break or continue from
// the most nested loop.) Otherwise, compare the labels.
return string.IsNullOrEmpty(flowLabel) || flowLabel.Equals(loopLabel, StringComparison.OrdinalIgnoreCase);
}
}
/// <summary>
/// Flow control BreakException.
/// </summary>
public sealed class BreakException : LoopFlowException
{
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal BreakException(string label)
: base(label)
{
}
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal BreakException() { }
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal BreakException(string label, Exception innerException)
: base(label)
{
}
}
/// <summary>
/// Flow control ContinueException.
/// </summary>
public sealed class ContinueException : LoopFlowException
{
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal ContinueException(string label)
: base(label)
{
}
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal ContinueException() { }
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal ContinueException(string label, Exception innerException)
: base(label)
{
}
}
internal class ReturnException : FlowControlException
{
internal ReturnException(object argument)
{
this.Argument = argument;
}
internal object Argument { get; set; }
}
/// <summary>
/// Implements the exit keyword.
/// </summary>
public class ExitException : FlowControlException
{
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal ExitException(object argument)
{
this.Argument = argument;
}
/// <summary>
/// Argument.
/// </summary>
public object Argument { get; internal set; }
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors", Justification = "This exception should only be thrown from SMA.dll")]
internal ExitException() { }
}
/// <summary>
/// Used by InternalHost.ExitNestedPrompt() to pop out of an interpreter level...
/// </summary>
internal class ExitNestedPromptException : FlowControlException
{
}
/// <summary>
/// Used by the debugger to terminate the execution of the current command.
/// </summary>
public sealed class TerminateException : FlowControlException
{
}
/// <summary>
/// Used by Select-Object cmdlet to stop all the upstream cmdlets, but continue
/// executing downstream cmdlets. The semantics of stopping is intended to mimic
/// a user pressing Ctrl-C [but which only affects upstream cmdlets].
/// </summary>
internal class StopUpstreamCommandsException : FlowControlException
{
public StopUpstreamCommandsException(InternalCommand requestingCommand)
{
this.RequestingCommandProcessor = requestingCommand.Context.CurrentCommandProcessor;
}
public CommandProcessorBase RequestingCommandProcessor { get; }
}
#endregion Flow Control Exceptions
/// <summary>
/// A enum corresponding to the options on the -split operator.
/// </summary>
[Flags]
public enum SplitOptions
{
/// <summary>
/// Use simple string comparison when evaluating the delimiter.
/// Cannot be used with RegexMatch.
/// </summary>
SimpleMatch = 0x01,
/// <summary>
/// Use regular expression matching to evaluate the delimiter.
/// This is the default behavior. Cannot be used with SimpleMatch.
/// </summary>
RegexMatch = 0x02,
/// <summary>
/// CultureInvariant: Ignores cultural differences in language when evaluating the delimiter.
/// Valid only with RegexMatch.
/// </summary>
CultureInvariant = 0x04,
/// <summary>
/// Ignores unescaped whitespace and comments marked with #.
/// Valid only with RegexMatch.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "Whitespace")]
IgnorePatternWhitespace = 0x08,
/// <summary>
/// Regex multiline mode, which recognizes the start and end of lines,
/// as well as the start and end of strings.
/// Valid only with RegexMatch.
/// Singleline is the default.
/// </summary>
Multiline = 0x10,
/// <summary>
/// Regex Singleline mode, which recognizes only the start and end of strings.
/// Valid only with RegexMatch.
/// Singleline is the default.
/// </summary>
Singleline = 0x20,
/// <summary>
/// Forces case-insensitive matching, even if -cSplit is specified.
/// </summary>
IgnoreCase = 0x40,
/// <summary>
/// Ignores non-named match groups, so that only explicit capture groups
/// are returned in the result list.
/// </summary>
ExplicitCapture = 0x80,
}
#region ParserOps
internal delegate object PowerShellBinaryOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval);
/// <summary>
/// A static class holding various operations specific to the PowerShell interpreter such as
/// various math operations, ToString() and a routine to extract the base object from an
/// PSObject in a canonical fashion.
/// </summary>
internal static class ParserOps
{
internal const string MethodNotFoundErrorId = "MethodNotFound";
/// <summary>
/// Construct the various caching structures used by the runtime routines...
/// </summary>
static ParserOps()
{
// Cache for ints and chars to avoid overhead of boxing every time...
for (int i = 0; i < (_MaxCache - _MinCache); i++)
{
s_integerCache[i] = (object)(i + _MinCache);
}
for (char ch = (char)0; ch < 255; ch++)
{
s_chars[ch] = new string(ch, 1);
}
}
private const int _MinCache = -100;
private const int _MaxCache = 1000;
private static readonly object[] s_integerCache = new object[_MaxCache - _MinCache];
private static readonly string[] s_chars = new string[255];
internal static readonly object _TrueObject = (object)true;
internal static readonly object _FalseObject = (object)false;
internal static string CharToString(char ch)
{
if (ch < 255) return s_chars[ch];
return new string(ch, 1);
}
internal static object BoolToObject(bool value)
{
return value ? _TrueObject : _FalseObject;
}
/// <summary>
/// Convert an object into an int, avoiding boxing small integers...
/// </summary>
/// <param name="value">The int to convert.</param>
/// <returns>The reference equivalent.</returns>
internal static object IntToObject(int value)
{
if (value < _MaxCache && value >= _MinCache)
{
return s_integerCache[value - _MinCache];
}
return (object)value;
}
internal static PSObject WrappedNumber(object data, string text)
{
PSObject wrapped = new PSObject(data);
wrapped.TokenText = text;
return wrapped;
}
/// <summary>
/// A helper routine that turns the argument object into an
/// integer. It handles PSObject and conversions.
/// </summary>
/// <param name="obj"></param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <returns></returns>
/// <exception cref="RuntimeException">The result could not be represented as an integer.</exception>
internal static int FixNum(object obj, IScriptExtent errorPosition)
{
obj = PSObject.Base(obj);
if (obj == null)
return 0;
if (obj is int)
return (int)obj;
int result = ConvertTo<int>(obj, errorPosition);
return result;
}
/// <summary>
/// This is a helper function for converting an object to a particular type.
///
/// It will throw exception with information about token representing the object.
/// </summary>
internal static T ConvertTo<T>(object obj, IScriptExtent errorPosition)
{
T result;
try
{
result = (T)LanguagePrimitives.ConvertTo(obj, typeof(T), CultureInfo.InvariantCulture);
}
catch (PSInvalidCastException mice)
{
RuntimeException re = new RuntimeException(mice.Message, mice);
re.ErrorRecord.SetInvocationInfo(new InvocationInfo(null, errorPosition));
throw re;
}
return result;
}
/// <summary>
/// Private method used to call the op_* operations for the math operators.
/// </summary>
/// <param name="lval">Left operand.</param>
/// <param name="rval">Right operand.</param>
/// <param name="op">Name of the operation method to perform.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="errorOp">The string to use in error messages representing the op.</param>
/// <returns>The result of the operation.</returns>
/// <exception cref="RuntimeException">An error occurred performing the operation, see inner exception.</exception>
internal static object ImplicitOp(object lval, object rval, string op, IScriptExtent errorPosition, string errorOp)
{
// Get the base object. At somepoint, we may allow users to dynamically extend
// the implicit operators at which point, we'll need to change this to find the
// extension method...
lval = PSObject.Base(lval);
rval = PSObject.Base(rval);
Type lvalType = lval?.GetType();
Type rvalType = rval?.GetType();
Type opType;
if (lvalType == null || (lvalType.IsPrimitive))
{
// Prefer the LHS type when looking for the operator, but attempt the right
// the lhs can't have an operator.
//
// This logic is overly simplified and doesn't match other languages which
// would look for overloads in both types, but this logic covers the most common
// cases.
opType = (rvalType == null || rvalType.IsPrimitive) ? null : rvalType;
}
else
{
opType = lvalType;
}
if (opType == null)
{
throw InterpreterError.NewInterpreterException(lval, typeof(RuntimeException), errorPosition,
"NotADefinedOperationForType", ParserStrings.NotADefinedOperationForType,
lvalType == null ? "$null" : lvalType.FullName,
errorOp,
rvalType == null ? "$null" : rvalType.FullName);
}
// None of the explicit conversions worked so try and invoke a method instead...
object[] parms = new object[2];
parms[0] = lval;
parms[1] = rval;
return CallMethod(
errorPosition,
opType,
op, /* methodName */
null, /* invocationConstraints */
parms,
true,
AutomationNull.Value);
}
[Flags]
private enum SplitImplOptions
{
None = 0x00,
TrimContent = 0x01,
}
private static object[] unfoldTuple(ExecutionContext context, IScriptExtent errorPosition, object tuple)
{
List<object> result = new List<object>();
IEnumerator enumerator = LanguagePrimitives.GetEnumerator(tuple);
if (enumerator != null)
{
while (ParserOps.MoveNext(context, errorPosition, enumerator))
{
object element = ParserOps.Current(errorPosition, enumerator);
result.Add(element);
}
}
else
{
// Not a tuple at all, just a single item. Treat it
// as a 1-tuple.
result.Add(tuple);
}
return result.ToArray();
}
// uses "yield" from C# 2.0, which automatically creates
// an enumerable out of the loop code. See
// https://msdn.microsoft.com/msdnmag/issues/04/05/C20/ for
// more details.
private static IEnumerable<string> enumerateContent(ExecutionContext context, IScriptExtent errorPosition, SplitImplOptions implOptions, object tuple)
{
IEnumerator enumerator = LanguagePrimitives.GetEnumerator(tuple) ?? new object[] { tuple }.GetEnumerator();
while (ParserOps.MoveNext(context, errorPosition, enumerator))
{
string strValue = PSObject.ToStringParser(context, enumerator.Current);
if ((implOptions & SplitImplOptions.TrimContent) != 0)
strValue = strValue.Trim();
yield return strValue;
}
}
private static RegexOptions parseRegexOptions(SplitOptions options)
{
RegexOptions result = RegexOptions.None;
if ((options & SplitOptions.CultureInvariant) != 0)
{
result |= RegexOptions.CultureInvariant;
}
if ((options & SplitOptions.IgnorePatternWhitespace) != 0)
{
result |= RegexOptions.IgnorePatternWhitespace;
}
if ((options & SplitOptions.Multiline) != 0)
{
result |= RegexOptions.Multiline;
}
if ((options & SplitOptions.Singleline) != 0)
{
result |= RegexOptions.Singleline;
}
if ((options & SplitOptions.IgnoreCase) != 0)
{
result |= RegexOptions.IgnoreCase;
}
if ((options & SplitOptions.ExplicitCapture) != 0)
{
result |= RegexOptions.ExplicitCapture;
}
return result;
}
internal static object UnarySplitOperator(ExecutionContext context, IScriptExtent errorPosition, object lval)
{
// unary split does a little extra processing to make
// whitespace processing more convenient. Specifically,
// it will ignore leading/trailing whitespace.
return SplitOperatorImpl(context, errorPosition, lval, new object[] { @"\s+" }, SplitImplOptions.TrimContent, false);
}
internal static object SplitOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool ignoreCase)
{
return SplitOperatorImpl(context, errorPosition, lval, rval, SplitImplOptions.None, ignoreCase);
}
private static IReadOnlyList<string> SplitOperatorImpl(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, SplitImplOptions implOptions, bool ignoreCase)
{
IEnumerable<string> content = enumerateContent(context, errorPosition, implOptions, lval);
ScriptBlock predicate = null;
string separatorPattern = null;
int limit = 0;
SplitOptions options = 0;
object[] args = unfoldTuple(context, errorPosition, rval);
if (args.Length >= 1)
{
predicate = args[0] as ScriptBlock;
if (predicate == null)
{
separatorPattern = PSObject.ToStringParser(context, args[0]);
}
}
else
{
// The first argument to split is always required.
throw InterpreterError.NewInterpreterException(rval, typeof(RuntimeException), errorPosition,
"BadOperatorArgument", ParserStrings.BadOperatorArgument, "-split", rval);
}
if (args.Length >= 2)
limit = FixNum(args[1], errorPosition);
if (args.Length >= 3 && args[2] != null)
{
string args2asString = args[2] as string;
if (args2asString == null || !string.IsNullOrEmpty(args2asString))
{
options = ConvertTo<SplitOptions>(args[2], errorPosition);
if (predicate != null)
{
throw InterpreterError.NewInterpreterException(null, typeof(ParseException),
errorPosition, "InvalidSplitOptionWithPredicate", ParserStrings.InvalidSplitOptionWithPredicate);
}
if (ignoreCase && (options & SplitOptions.IgnoreCase) == 0)
{
options |= SplitOptions.IgnoreCase;
}
}
}
else if (ignoreCase)
{
options |= SplitOptions.IgnoreCase;
}
if (predicate == null)
{
return SplitWithPattern(context, errorPosition, content, separatorPattern, limit, options);
}
else if (limit >= 0)
{
return SplitWithPredicate(context, errorPosition, content, predicate, limit);
}
else
{
return NegativeSplitWithPredicate(context, errorPosition, content, predicate, limit);
}
}
private static IReadOnlyList<string> NegativeSplitWithPredicate(ExecutionContext context, IScriptExtent errorPosition, IEnumerable<string> content, ScriptBlock predicate, int limit)
{
var results = new List<string>();
if (limit == -1)
{
// If the user just wants 1 string
// then just return the content
return new List<string>(content);
}
foreach (string item in content)
{
var split = new List<string>();
// Used to traverse through the item
int cursor = item.Length - 1;
int subStringLength = 0;
for (int charCount = 0; charCount < item.Length; charCount++)
{
// Evaluate the predicate using the character at cursor.
object predicateResult = predicate.DoInvokeReturnAsIs(
useLocalScope: true,
errorHandlingBehavior: ScriptBlock.ErrorHandlingBehavior.WriteToExternalErrorPipe,
dollarUnder: CharToString(item[cursor]),
input: AutomationNull.Value,
scriptThis: AutomationNull.Value,
args: new object[] { item, cursor });
if (!LanguagePrimitives.IsTrue(predicateResult))
{
subStringLength++;
cursor -= 1;
continue;
}
split.Add(item.Substring(cursor + 1, subStringLength));
subStringLength = 0;
cursor -= 1;
if (System.Math.Abs(limit) == (split.Count + 1))
{
break;
}
}
if (cursor == -1)
{
// Used when the limit is negative
// and the cursor was allowed to go
// all the way to the start of the
// string.
split.Add(item.Substring(0, subStringLength));
}
else
{
// Used to get the rest of the string
// when using a negative limit and
// the cursor doesn't reach the end
// of the string.
split.Add(item.Substring(0, cursor + 1));
}
split.Reverse();
results.AddRange(split);
}
return results.ToArray();
}
private static IReadOnlyList<string> SplitWithPredicate(ExecutionContext context, IScriptExtent errorPosition, IEnumerable<string> content, ScriptBlock predicate, int limit)
{
var results = new List<string>();
if (limit == 1)
{
// If the user just wants 1 string
// then just return the content
return new List<string>(content);
}
foreach (string item in content)
{
var split = new List<string>();
// Used to traverse through the item
int cursor = 0;
// This is used to calculate how much to split from item.
int subStringLength = 0;
for (int charCount = 0; charCount < item.Length; charCount++)
{
// Evaluate the predicate using the character at cursor.
object predicateResult = predicate.DoInvokeReturnAsIs(
useLocalScope: true,
errorHandlingBehavior: ScriptBlock.ErrorHandlingBehavior.WriteToExternalErrorPipe,
dollarUnder: CharToString(item[cursor]),
input: AutomationNull.Value,
scriptThis: AutomationNull.Value,
args: new object[] { item, cursor });
// If the current character is not a delimiter
// then it must be included into a substring.
if (!LanguagePrimitives.IsTrue(predicateResult))
{
subStringLength++;
cursor += 1;
continue;
}
// Else, if the character is a delimiter
// then add a substring to the split list.
split.Add(item.Substring(cursor - subStringLength, subStringLength));
subStringLength = 0;
cursor += 1;
if (limit == (split.Count + 1))
{
break;
}
}
if (cursor == item.Length)
{
// Used to get the rest of the string
// when the limit is not negative and
// the cursor is allowed to make it to
// the end of the string.
split.Add(item.Substring(cursor - subStringLength, subStringLength));
}
else
{
// Used to get the rest of the string
// when the limit is not negative and
// the cursor is not at the end of the
// string.
split.Add(item.Substring(cursor, item.Length - cursor));
}
results.AddRange(split);
}
return results.ToArray();
}
private static IReadOnlyList<string> SplitWithPattern(ExecutionContext context, IScriptExtent errorPosition, IEnumerable<string> content, string separatorPattern, int limit, SplitOptions options)
{
// Default to Regex matching if no match specified.
if ((options & SplitOptions.SimpleMatch) == 0 &&
(options & SplitOptions.RegexMatch) == 0)
{
options |= SplitOptions.RegexMatch;
}
if ((options & SplitOptions.SimpleMatch) != 0)
{
if ((options & ~(SplitOptions.SimpleMatch | SplitOptions.IgnoreCase)) != 0)
{
throw InterpreterError.NewInterpreterException(null, typeof(ParseException),
errorPosition, "InvalidSplitOptionCombination", ParserStrings.InvalidSplitOptionCombination);
}
}
if ((options & SplitOptions.SimpleMatch) != 0)
{
separatorPattern = Regex.Escape(separatorPattern);
}
RegexOptions regexOptions = parseRegexOptions(options);
int calculatedLimit = limit;
// If the limit is negative then set Regex to read from right to left
if (calculatedLimit < 0)
{
regexOptions |= RegexOptions.RightToLeft;
calculatedLimit *= -1;
}
Regex regex = NewRegex(separatorPattern, regexOptions);
var results = new List<string>();
foreach (string item in content)
{
string[] split = regex.Split(item, calculatedLimit);
results.AddRange(split);
}
return results.ToArray();
}
/// <summary>
/// Implementation of the PowerShell unary -join operator...
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="lval">Left operand.</param>
/// <returns>The result of the operator.</returns>
internal static object UnaryJoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval)
{
return JoinOperator(context, errorPosition, lval, string.Empty);
}
/// <summary>
/// Implementation of the PowerShell binary -join operator.
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="lval">Left operand.</param>
/// <param name="rval">Right operand.</param>
/// <returns>The result of the operator.</returns>
internal static object JoinOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval)
{
string separator = PSObject.ToStringParser(context, rval);
// PSObject already has join functionality; just expose it
// as an operator.
IEnumerable enumerable = LanguagePrimitives.GetEnumerable(lval);
if (enumerable != null)
{
return PSObject.ToStringEnumerable(context, enumerable, separator, null, null);
}
else
{
return PSObject.ToStringParser(context, lval);
}
}
/// <summary>
/// The implementation of the PowerShell range operator.
/// </summary>
/// <param name="lval">The object on which to start.</param>
/// <param name="rval">The object on which to stop.</param>
/// <returns>The array of objects.</returns>
internal static object RangeOperator(object lval, object rval)
{
var lbase = PSObject.Base(lval);
var rbase = PSObject.Base(rval);
// If both arguments is [char] type or [string] type with length==1
// return objects of [char] type.
// In special case "0".."9" return objects of [int] type.
if (AsChar(lbase) is char lc && AsChar(rbase) is char rc)
{
return CharOps.Range(lc, rc);
}
// As a last resort, the range operator tries to return objects of [int] type.
// 1..10
// "1".."10"
// [int]"1"..[int]"10"
var l = Convert.ToInt32(lbase);
var r = Convert.ToInt32(rbase);
return IntOps.Range(l, r);
}
/// <summary>
/// The implementation of an enumerator for the PowerShell range operator.
/// </summary>
/// <param name="lval">The object on which to start.</param>
/// <param name="rval">The object on which to stop.</param>
/// <returns>The enumerator.</returns>
internal static IEnumerator GetRangeEnumerator(object lval, object rval)
{
var lbase = PSObject.Base(lval);
var rbase = PSObject.Base(rval);
// If both arguments is [char] type or [string] type with length==1
// return objects of [char] type.
// In special case "0".."9" return objects of [int] type.
if (AsChar(lbase) is char lc && AsChar(rbase) is char rc)
{
return new CharRangeEnumerator(lc, rc);
}
// As a last resort, the range operator tries to return objects of [int] type.
// 1..10
// "1".."10"
// [int]"1"..[int]"10"
var l = Convert.ToInt32(lbase);
var r = Convert.ToInt32(rbase);
return new RangeEnumerator(l, r);
}
// Help function for Range operator.
//
// In common case:
// for [char] type
// for [string] type and length == 1
// return objects of [char] type:
// [char]'A'..[char]'Z'
// [char]'A'..'Z'
// [char]'A'.."Z"
// 'A'..[char]'Z'
// "A"..[char]'Z'
// "A".."Z"
// [char]"A"..[string]"Z"
// "A"..[char]"Z"
// [string]"A".."Z"
// and so on.
//
// In special case:
// "0".."9"
// return objects of [int] type.
private static object AsChar(object obj)
{
if (obj is char) return obj;
if (obj is string str && str.Length == 1 && !char.IsDigit(str, 0)) return str[0];
return null;
}
/// <summary>
/// The implementation of the PowerShell -replace operator....
/// </summary>
/// <param name="context">The execution context in which to evaluate the expression.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="lval">The object on which to replace the values.</param>
/// <param name="rval">The replacement description.</param>
/// <param name="ignoreCase">True for -ireplace/-replace, false for -creplace.</param>
/// <returns>The result of the operator.</returns>
internal static object ReplaceOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool ignoreCase)
{
object pattern = string.Empty;
object substitute = string.Empty;
rval = PSObject.Base(rval);
IList rList = rval as IList;
if (rList != null)
{
if (rList.Count > 2)
{
// only allow 1 or 2 arguments to -replace
throw InterpreterError.NewInterpreterException(rval, typeof(RuntimeException), errorPosition,
"BadReplaceArgument", ParserStrings.BadReplaceArgument, errorPosition.Text, rList.Count);
}
if (rList.Count > 0)
{
pattern = rList[0];
if (rList.Count > 1)
{
substitute = PSObject.Base(rList[1]);
}
}
}
else
{
pattern = rval;
}
RegexOptions rreOptions = RegexOptions.None;
if (ignoreCase)
{
rreOptions = RegexOptions.IgnoreCase;
}
Regex rr = pattern as Regex;
if (rr == null)
{
try
{
rr = NewRegex((string)PSObject.ToStringParser(context, pattern), rreOptions);
}
catch (ArgumentException ae)
{
throw InterpreterError.NewInterpreterExceptionWithInnerException(pattern, typeof(RuntimeException),
null, "InvalidRegularExpression", ParserStrings.InvalidRegularExpression, ae, pattern);
}
}
var replacer = ReplaceOperatorImpl.Create(context, rr, substitute);
IEnumerator list = LanguagePrimitives.GetEnumerator(lval);
if (list == null)
{
string lvalString = PSObject.ToStringParser(context, lval) ?? string.Empty;
return replacer.Replace(lvalString);
}
else
{
List<object> resultList = new List<object>();
while (ParserOps.MoveNext(context, errorPosition, list))
{
string lvalString = PSObject.ToStringParser(context, ParserOps.Current(errorPosition, list));
resultList.Add(replacer.Replace(lvalString));
}
return resultList.ToArray();
}
}
private struct ReplaceOperatorImpl
{
public static ReplaceOperatorImpl Create(ExecutionContext context, Regex regex, object substitute)
{
return new ReplaceOperatorImpl(context, regex, substitute);
}
private readonly Regex _regex;
private readonly string _cachedReplacementString;
private readonly MatchEvaluator _cachedMatchEvaluator;
private ReplaceOperatorImpl(
ExecutionContext context,
Regex regex,
object substitute)
{
_regex = regex;
_cachedReplacementString = null;
_cachedMatchEvaluator = null;
switch (substitute)
{
case string replacement:
_cachedReplacementString = replacement;
break;
case ScriptBlock sb:
_cachedMatchEvaluator = GetMatchEvaluator(context, sb);
break;
case object val when LanguagePrimitives.TryConvertTo(val, out _cachedMatchEvaluator):
break;
default:
_cachedReplacementString = PSObject.ToStringParser(context, substitute);
break;
}
}
// Local helper function to avoid creating an instance of the generated delegate helper class
// every time 'ReplaceOperatorImpl' is invoked.
private static MatchEvaluator GetMatchEvaluator(ExecutionContext context, ScriptBlock sb)
{
return match =>
{
var result = sb.DoInvokeReturnAsIs(
useLocalScope: false, /* Use current scope to be consistent with 'ForEach/Where-Object {}' and 'collection.ForEach{}/Where{}' */
errorHandlingBehavior: ScriptBlock.ErrorHandlingBehavior.WriteToCurrentErrorPipe,
dollarUnder: match,
input: AutomationNull.Value,
scriptThis: AutomationNull.Value,
args: Array.Empty<object>());
return PSObject.ToStringParser(context, result);
};
}
/// <summary>
/// ReplaceOperator implementation.
/// Abstracts away conversion of the optional substitute parameter to either a string or a MatchEvaluator delegate
/// and finally returns the result of the final Regex.Replace operation.
/// </summary>
public object Replace(string input)
{
if (_cachedReplacementString is not null)
{
return _regex.Replace(input, _cachedReplacementString);
}
Dbg.Assert(_cachedMatchEvaluator is not null, "_cachedMatchEvaluator should be not null when code reach here.");
return _regex.Replace(input, _cachedMatchEvaluator);
}
}
/// <summary>
/// Implementation of the PowerShell type operators...
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="left">Left operand.</param>
/// <param name="right">Right operand.</param>
/// <returns>The result of the operator.</returns>
internal static object IsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right)
{
object lval = PSObject.Base(left);
object rval = PSObject.Base(right);
Type rType = rval as Type;
if (rType == null)
{
rType = ConvertTo<Type>(rval, errorPosition);
if (rType == null)
{
// "the right operand of '-is' must be a type"
throw InterpreterError.NewInterpreterException(rval, typeof(RuntimeException),
errorPosition, "IsOperatorRequiresType", ParserStrings.IsOperatorRequiresType);
}
}
if (rType == typeof(PSCustomObject) && lval is PSObject)
{
Diagnostics.Assert(rType.IsInstanceOfType(((PSObject)lval).ImmediateBaseObject), "Unexpect PSObject");
return _TrueObject;
}
if (rType.Equals(typeof(PSObject)) && left is PSObject)
{
return _TrueObject;
}
return BoolToObject(rType.IsInstanceOfType(lval));
}
/// <summary>
/// Implementation of the PowerShell type operators...
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="left">Left operand.</param>
/// <param name="right">Right operand.</param>
/// <returns>The result of the operator.</returns>
internal static object IsNotOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right)
{
object lval = PSObject.Base(left);
object rval = PSObject.Base(right);
Type rType = rval as Type;
if (rType == null)
{
rType = ConvertTo<Type>(rval, errorPosition);
if (rType == null)
{
// "the right operand of '-is' must be a type"
throw InterpreterError.NewInterpreterException(rval, typeof(RuntimeException),
errorPosition, "IsOperatorRequiresType", ParserStrings.IsOperatorRequiresType);
}
}
if (rType == typeof(PSCustomObject) && lval is PSObject)
{
Diagnostics.Assert(rType.IsInstanceOfType(((PSObject)lval).ImmediateBaseObject), "Unexpect PSObject");
return _FalseObject;
}
if (rType.Equals(typeof(PSObject)) && left is PSObject)
{
return _FalseObject;
}
return BoolToObject(!rType.IsInstanceOfType(lval));
}
/// <summary>
/// Implementation of the PowerShell -like operator.
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="lval">Left operand.</param>
/// <param name="rval">Right operand.</param>
/// <param name="operator">The operator.</param>
/// <returns>The result of the operator.</returns>
internal static object LikeOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, TokenKind @operator)
{
var wcp = rval as WildcardPattern;
if (wcp == null)
{
var ignoreCase = @operator == TokenKind.Ilike || @operator == TokenKind.Inotlike;
wcp = WildcardPattern.Get(PSObject.ToStringParser(context, rval),
ignoreCase ? WildcardOptions.IgnoreCase : WildcardOptions.None);
}
bool notLike = @operator == TokenKind.Inotlike || @operator == TokenKind.Cnotlike;
IEnumerator list = LanguagePrimitives.GetEnumerator(lval);
if (list == null)
{
string lvalString = lval == null ? string.Empty : PSObject.ToStringParser(context, lval);
return BoolToObject(wcp.IsMatch(lvalString) ^ notLike);
}
List<object> resultList = new List<object>();
while (ParserOps.MoveNext(context, errorPosition, list))
{
object val = ParserOps.Current(errorPosition, list);
string lvalString = val == null ? string.Empty : PSObject.ToStringParser(context, val);
if (wcp.IsMatch(lvalString) ^ notLike)
{
resultList.Add(lvalString);
}
}
return resultList.ToArray();
}
/// <summary>
/// Implementation of the PowerShell -match operator.
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="lval">Left operand.</param>
/// <param name="rval">Right operand.</param>
/// <param name="ignoreCase">Ignore case?</param>
/// <param name="notMatch">True for -notmatch, false for -match.</param>
/// <returns>The result of the operator.</returns>
internal static object MatchOperator(ExecutionContext context, IScriptExtent errorPosition, object lval, object rval, bool notMatch, bool ignoreCase)
{
RegexOptions reOptions = ignoreCase ? RegexOptions.IgnoreCase : RegexOptions.None;
// if passed an explicit regex, just use it
// otherwise compile the expression.
// In this situation, creation of Regex should not fail. We are not
// processing ArgumentException in this case.
Regex r = PSObject.Base(rval) as Regex
?? NewRegex(PSObject.ToStringParser(context, rval), reOptions);
IEnumerator list = LanguagePrimitives.GetEnumerator(lval);
if (list == null)
{
string lvalString = lval == null ? string.Empty : PSObject.ToStringParser(context, lval);
// Find a match in the string.
Match m = r.Match(lvalString);
if (m.Success)
{
GroupCollection groups = m.Groups;
if (groups.Count > 0)
{
Hashtable h = new Hashtable(StringComparer.CurrentCultureIgnoreCase);
foreach (string groupName in r.GetGroupNames())
{
Group g = groups[groupName];
if (g.Success)
{
int keyInt;
if (Int32.TryParse(groupName, out keyInt))
h.Add(keyInt, g.ToString());
else
h.Add(groupName, g.ToString());
}
}
context.SetVariable(SpecialVariables.MatchesVarPath, h);
}
}
return BoolToObject(m.Success ^ notMatch);
}
else
{
List<object> resultList = new List<object>();
int check = 0;
try
{
while (list.MoveNext())
{
object val = list.Current;
string lvalString = val == null ? string.Empty : PSObject.ToStringParser(context, val);
// Find a single match in the string.
Match m = r.Match(lvalString);
if (m.Success ^ notMatch)
{
resultList.Add(val);
}
if (check++ > 1000)
{
// Check to see if we're stopping every one in a while...
if (context != null && context.CurrentPipelineStopping)
throw new PipelineStoppedException();
check = 0;
}
}
return resultList.ToArray();
}
catch (RuntimeException)
{
throw;
}
catch (FlowControlException)
{
throw;
}
catch (ScriptCallDepthException)
{
throw;
}
catch (Exception e)
{
throw InterpreterError.NewInterpreterExceptionWithInnerException(list, typeof(RuntimeException),
errorPosition, "BadEnumeration", ParserStrings.BadEnumeration, e, e.Message);
}
}
}
// Implementation of the -contains/-in operators and case insensitive variants.
internal static bool ContainsOperatorCompiled(ExecutionContext context,
CallSite<Func<CallSite, object, IEnumerator>> getEnumeratorSite,
CallSite<Func<CallSite, object, object, object>> comparerSite,
object left,
object right)
{
IEnumerator list = getEnumeratorSite.Target.Invoke(getEnumeratorSite, left);
if (list == null || list is EnumerableOps.NonEnumerableObjectEnumerator)
{
return (bool)comparerSite.Target.Invoke(comparerSite, left, right);
}
while (EnumerableOps.MoveNext(context, list))
{
object val = EnumerableOps.Current(list);
if ((bool)comparerSite.Target.Invoke(comparerSite, val, right))
{
return true;
}
}
return false;
}
/// <summary>
/// Implementation of the PowerShell -contains/-notcontains operators (and case sensitive variants)
/// </summary>
/// <param name="context">The execution context to use.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="left">Left operand.</param>
/// <param name="right">Right operand.</param>
/// <param name="ignoreCase">Ignore case?</param>
/// <param name="contains">True for -contains, false for -notcontains.</param>
/// <returns>The result of the operator.</returns>
internal static object ContainsOperator(ExecutionContext context, IScriptExtent errorPosition, object left, object right, bool contains, bool ignoreCase)
{
IEnumerator list = LanguagePrimitives.GetEnumerator(left);
if (list == null)
{
return
BoolToObject(contains ==
LanguagePrimitives.Equals(left, right, ignoreCase, CultureInfo.InvariantCulture));
}
while (ParserOps.MoveNext(context, errorPosition, list))
{
object val = ParserOps.Current(errorPosition, list);
if (LanguagePrimitives.Equals(val, right, ignoreCase, CultureInfo.InvariantCulture))
{
return BoolToObject(contains);
}
}
return BoolToObject(!contains);
}
internal delegate bool CompareDelegate(object lhs, object rhs, bool ignoreCase);
internal static object CompareOperators(ExecutionContext context, IScriptExtent errorPosition, object left, object right, CompareDelegate compareDelegate, bool ignoreCase)
{
IEnumerator list = LanguagePrimitives.GetEnumerator(left);
if (list == null)
{
return BoolToObject(compareDelegate(left, right, ignoreCase));
}
List<object> resultList = new List<object>();
while (ParserOps.MoveNext(context, errorPosition, list))
{
object val = ParserOps.Current(errorPosition, list);
if (compareDelegate(val, right, ignoreCase))
{
resultList.Add(val);
}
}
return resultList.ToArray();
}
/// <summary>
/// Cache regular expressions.
/// </summary>
/// <param name="patternString">The string to find the pattern for.</param>
/// <param name="options">The options used to create the regex.</param>
/// <returns>New or cached Regex.</returns>
internal static Regex NewRegex(string patternString, RegexOptions options)
{
var subordinateRegexCache = s_regexCache.GetOrAdd(options, s_subordinateRegexCacheCreationDelegate);
if (subordinateRegexCache.TryGetValue(patternString, out Regex result))
{
return result;
}
else
{
if (subordinateRegexCache.Count > MaxRegexCache)
{
// TODO: it would be useful to get a notice (in telemetry?) if the cache is full.
subordinateRegexCache.Clear();
}
var regex = new Regex(patternString, options);
return subordinateRegexCache.GetOrAdd(patternString, regex);
}
}
private static readonly ConcurrentDictionary<RegexOptions, ConcurrentDictionary<string, Regex>> s_regexCache =
new ConcurrentDictionary<RegexOptions, ConcurrentDictionary<string, Regex>>();
private static readonly Func<RegexOptions, ConcurrentDictionary<string, Regex>> s_subordinateRegexCacheCreationDelegate =
key => new ConcurrentDictionary<string, Regex>(StringComparer.Ordinal);
private const int MaxRegexCache = 1000;
/// <summary>
/// A routine used to advance an enumerator and catch errors that might occur
/// performing the operation.
/// </summary>
/// <param name="context">The execution context used to see if the pipeline is stopping.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="enumerator">THe enumerator to advance.</param>
/// <exception cref="RuntimeException">An error occurred moving to the next element in the enumeration.</exception>
/// <returns>True if the move succeeded.</returns>
internal static bool MoveNext(ExecutionContext context, IScriptExtent errorPosition, IEnumerator enumerator)
{
try
{
// Check to see if we're stopping...
if (context != null && context.CurrentPipelineStopping)
throw new PipelineStoppedException();
return enumerator.MoveNext();
}
catch (RuntimeException)
{
throw;
}
catch (FlowControlException)
{
throw;
}
catch (ScriptCallDepthException)
{
throw;
}
catch (Exception e)
{
throw InterpreterError.NewInterpreterExceptionWithInnerException(enumerator, typeof(RuntimeException),
errorPosition, "BadEnumeration", ParserStrings.BadEnumeration, e, e.Message);
}
}
/// <summary>
/// Wrapper caller for enumerator.MoveNext - handles and republishes errors...
/// </summary>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="enumerator">The enumerator to read from.</param>
/// <returns></returns>
internal static object Current(IScriptExtent errorPosition, IEnumerator enumerator)
{
try
{
return enumerator.Current;
}
catch (RuntimeException)
{
throw;
}
catch (ScriptCallDepthException)
{
throw;
}
catch (FlowControlException)
{
throw;
}
catch (Exception e)
{
throw InterpreterError.NewInterpreterExceptionWithInnerException(enumerator, typeof(RuntimeException),
errorPosition, "BadEnumeration", ParserStrings.BadEnumeration, e, e.Message);
}
}
/// <summary>
/// Retrieves the obj's type full name.
/// </summary>
/// <param name="obj">The object we want to retrieve the type's full name from.</param>
/// <returns>The obj's type full name.</returns>
internal static string GetTypeFullName(object obj)
{
if (obj == null)
{
return string.Empty;
}
if (obj is not PSObject mshObj)
{
return obj.GetType().FullName;
}
if (mshObj.InternalTypeNames.Count == 0)
{
return typeof(PSObject).FullName;
}
return mshObj.InternalTypeNames[0];
}
/// <summary>
/// Launch a method on an object. This will handle .NET native methods, COM
/// methods and ScriptBlock notes. Native methods currently take precedence over notes...
/// </summary>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="target">The object to call the method on. It shouldn't be a PSObject.</param>
/// <param name="methodName">The name of the method to call.</param>
/// <param name="invocationConstraints">Invocation constraints.</param>
/// <param name="paramArray">The arguments to pass to the method.</param>
/// <param name="callStatic">Set to true if you want to call a static method.</param>
/// <param name="valueToSet">If not automation null, then this must be a settable property.</param>
/// <exception cref="RuntimeException">Wraps the exception returned from the method call.</exception>
/// <exception cref="FlowControlException">Internal exception from a flow control statement.</exception>
/// <returns></returns>
internal static object CallMethod(
IScriptExtent errorPosition,
object target,
string methodName,
PSMethodInvocationConstraints invocationConstraints,
object[] paramArray,
bool callStatic,
object valueToSet)
{
Dbg.Assert(methodName != null, "methodName was null");
PSMethodInfo targetMethod = null;
object targetBase = null;
PSObject targetAsPSObject = null;
do
{
if (LanguagePrimitives.IsNull(target))
{
// "you can't call a method on null"
throw InterpreterError.NewInterpreterException(methodName, typeof(RuntimeException), errorPosition, "InvokeMethodOnNull", ParserStrings.InvokeMethodOnNull);
}
targetBase = PSObject.Base(target);
targetAsPSObject = PSObject.AsPSObject(target);
Type targetType;
if (callStatic)
{
targetType = (Type)targetBase;
}
else
{
targetType = targetBase.GetType();
}
if (callStatic)
{
targetMethod = PSObject.GetStaticCLRMember(target, methodName) as PSMethod;
}
else
{
targetMethod = targetAsPSObject.Members[methodName] as PSMethodInfo;
}
if (targetMethod == null)
{
string typeFullName = null;
if (callStatic)
{
typeFullName = targetType.FullName;
}
else
{
typeFullName = GetTypeFullName(target);
}
if (valueToSet == AutomationNull.Value)
{
// "[{0}] doesn't contain a method named '{1}'"
throw InterpreterError.NewInterpreterException(methodName, typeof(RuntimeException), errorPosition,
MethodNotFoundErrorId, ParserStrings.MethodNotFound, typeFullName, methodName);
}
else
{
throw InterpreterError.NewInterpreterException(methodName, typeof(RuntimeException), errorPosition,
"ParameterizedPropertyAssignmentFailed", ParserStrings.ParameterizedPropertyAssignmentFailed, typeFullName, methodName);
}
}
} while (false);
try
{
// If there is a property to set, then this is a multi-parameter property assignment
// not really a method call.
if (valueToSet != AutomationNull.Value)
{
if (targetMethod is not PSParameterizedProperty propertyToSet)
{
throw InterpreterError.NewInterpreterException(methodName, typeof(RuntimeException), errorPosition,
"ParameterizedPropertyAssignmentFailed", ParserStrings.ParameterizedPropertyAssignmentFailed, GetTypeFullName(target), methodName);
}
propertyToSet.InvokeSet(valueToSet, paramArray);
return valueToSet;
}
else
{
PSMethod adaptedMethod = targetMethod as PSMethod;
if (adaptedMethod != null)
{
return adaptedMethod.Invoke(invocationConstraints, paramArray);
}
else
{
return targetMethod.Invoke(paramArray);
}
}
}
catch (MethodInvocationException mie)
{
if (mie.ErrorRecord.InvocationInfo == null)
mie.ErrorRecord.SetInvocationInfo(new InvocationInfo(null, errorPosition));
throw;
}
catch (RuntimeException rte)
{
if (rte.ErrorRecord.InvocationInfo == null)
rte.ErrorRecord.SetInvocationInfo(new InvocationInfo(null, errorPosition));
throw;
}
catch (FlowControlException)
{
throw;
}
catch (ScriptCallDepthException)
{
throw;
}
catch (Exception e)
{
// Note - we are catching all methods thrown from a method call and wrap them
// unless they are already RuntimeException. This is ok.
throw InterpreterError.NewInterpreterExceptionByMessage(typeof(RuntimeException), errorPosition,
e.Message, "MethodInvocationException", e);
}
}
}
#endregion ParserOps
#region RangeEnumerator
/// <summary>
/// This is a simple enumerator class that just enumerates of a range of numbers. It's used in enumerating
/// elements when the range operator .. is used.
/// </summary>
internal class RangeEnumerator : IEnumerator
{
private readonly int _lowerBound;
internal int LowerBound
{
get { return _lowerBound; }
}
private readonly int _upperBound;
internal int UpperBound
{
get { return _upperBound; }
}
private int _current;
object IEnumerator.Current
{
get { return Current; }
}
public virtual int Current
{
get { return _current; }
}
internal int CurrentValue
{
get { return _current; }
}
private readonly int _increment = 1;
private bool _firstElement = true;
public RangeEnumerator(int lowerBound, int upperBound)
{
_lowerBound = lowerBound;
_current = _lowerBound;
_upperBound = upperBound;
if (lowerBound > upperBound)
_increment = -1;
}
public void Reset()
{
_current = _lowerBound;
_firstElement = true;
}
public bool MoveNext()
{
if (_firstElement)
{
_firstElement = false;
return true;
}
if (_current == _upperBound)
return false;
_current += _increment;
return true;
}
}
/// <summary>
/// The simple enumerator class is used for the range operator '..'
/// in expressions like 'A'..'B' | ForEach-Object { $_ }
/// </summary>
internal class CharRangeEnumerator : IEnumerator
{
private readonly int _increment = 1;
private bool _firstElement = true;
public CharRangeEnumerator(char lowerBound, char upperBound)
{
LowerBound = lowerBound;
Current = lowerBound;
UpperBound = upperBound;
if (lowerBound > upperBound)
_increment = -1;
}
object IEnumerator.Current
{
get { return Current; }
}
internal char LowerBound { get; }
internal char UpperBound { get; }
public char Current
{
get; private set;
}
public bool MoveNext()
{
if (_firstElement)
{
_firstElement = false;
return true;
}
if (Current == UpperBound)
{
return false;
}
Current = (char)(Current + _increment);
return true;
}
public void Reset()
{
Current = LowerBound;
_firstElement = true;
}
}
#endregion RangeEnumerator
#region InterpreterError
internal static class InterpreterError
{
/// <summary>
/// Create a new instance of an interpreter exception.
/// </summary>
/// <param name="targetObject">The target object for this exception.</param>
/// <param name="exceptionType">Type of exception to build.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="resourceIdAndErrorId">
/// ResourceID to look up template message, and also ErrorID
/// </param>
/// <param name="resourceString">
/// Resource string that holds the error message
/// </param>
/// <param name="args">Insertion parameters to message.</param>
/// <returns>A new instance of the specified exception type.</returns>
internal static RuntimeException NewInterpreterException(object targetObject,
Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, params object[] args)
{
return NewInterpreterExceptionWithInnerException(targetObject, exceptionType, errorPosition, resourceIdAndErrorId, resourceString, null, args);
}
/// <summary>
/// Create a new instance of an interpreter exception.
/// </summary>
/// <param name="targetObject">The object associated with the problem.</param>
/// <param name="exceptionType">Type of exception to build.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="resourceIdAndErrorId">
/// ResourceID to look up template message, and also ErrorID
/// </param>
/// <param name="resourceString">
/// Resource string which holds the error message
/// </param>
/// <param name="innerException">Inner exception.</param>
/// <param name="args">Insertion parameters to message.</param>
/// <returns>New instance of an interpreter exception.</returns>
internal static RuntimeException NewInterpreterExceptionWithInnerException(object targetObject,
Type exceptionType, IScriptExtent errorPosition, string resourceIdAndErrorId, string resourceString, Exception innerException, params object[] args)
{
// errToken may be null
if (string.IsNullOrEmpty(resourceIdAndErrorId))
throw PSTraceSource.NewArgumentException(nameof(resourceIdAndErrorId));
// innerException may be null
// args may be null or empty
RuntimeException rte = null;
try
{
string message;
if (args == null || args.Length == 0)
{
// Don't format in case the string contains literal curly braces
message = resourceString;
}
else
{
message = StringUtil.Format(resourceString, args);
}
if (string.IsNullOrEmpty(message))
{
Dbg.Assert(false,
"Could not load text for parser exception '"
+ resourceIdAndErrorId + "'");
rte = NewBackupInterpreterException(exceptionType, errorPosition, resourceIdAndErrorId, null);
}
else
{
rte = NewInterpreterExceptionByMessage(exceptionType, errorPosition, message, resourceIdAndErrorId, innerException);
}
}
catch (InvalidOperationException e)
{
Dbg.Assert(false,
"Could not load text for parser exception '"
+ resourceIdAndErrorId
+ "' due to InvalidOperationException " + e.Message);
rte = NewBackupInterpreterException(exceptionType, errorPosition, resourceIdAndErrorId, e);
}
catch (System.Resources.MissingManifestResourceException e)
{
Dbg.Assert(false,
"Could not load text for parser exception '"
+ resourceIdAndErrorId
+ "' due to MissingManifestResourceException " + e.Message);
rte = NewBackupInterpreterException(exceptionType, errorPosition, resourceIdAndErrorId, e);
}
catch (FormatException e)
{
Dbg.Assert(false,
"Could not load text for parser exception '"
+ resourceIdAndErrorId
+ "' due to FormatException " + e.Message);
rte = NewBackupInterpreterException(exceptionType, errorPosition, resourceIdAndErrorId, e);
}
rte.SetTargetObject(targetObject);
return rte;
}
/// <summary>
/// Create a new instance of an interpreter exception.
/// </summary>
/// <param name="exceptionType">Type of exception to build.</param>
/// <param name="errorPosition">The position to use for error reporting.</param>
/// <param name="message">Message.</param>
/// <param name="errorId">ErrorID.</param>
/// <param name="innerException">Inner exception.</param>
/// <returns>New instance of ParseException.</returns>
internal static RuntimeException NewInterpreterExceptionByMessage(
Type exceptionType, IScriptExtent errorPosition, string message, string errorId, Exception innerException)
{
// errToken may be null
// only assert -- be permissive at runtime
Dbg.Assert(!string.IsNullOrEmpty(message), "message was null or empty");
Dbg.Assert(!string.IsNullOrEmpty(errorId), "errorId was null or empty");
// innerException may be null
RuntimeException e;
// Create an instance of the right exception type...
if (exceptionType == typeof(ParseException))
{
e = new ParseException(message, errorId, innerException);
}
else if (exceptionType == typeof(IncompleteParseException))
{
e = new IncompleteParseException(message, errorId, innerException);
}
else
{
e = new RuntimeException(message, innerException);
e.SetErrorId(errorId);
e.SetErrorCategory(ErrorCategory.InvalidOperation);
}
// Don't trash the existing InvocationInfo.
if (errorPosition != null)
e.ErrorRecord.SetInvocationInfo(new InvocationInfo(null, errorPosition));
return e;
}
private static RuntimeException NewBackupInterpreterException(
Type exceptionType,
IScriptExtent errorPosition,
string errorId,
Exception innerException)
{
string message;
if (innerException == null)
{
// there is no reason this string lookup should fail
message = StringUtil.Format(ParserStrings.BackupParserMessage, errorId);
}
else
{
// there is no reason this string lookup should fail
message = StringUtil.Format(ParserStrings.BackupParserMessageWithException, errorId, innerException.Message);
}
return NewInterpreterExceptionByMessage(exceptionType, errorPosition, message, errorId, innerException);
}
internal static void UpdateExceptionErrorRecordPosition(Exception exception, IScriptExtent extent)
{
if (extent == null || extent == PositionUtilities.EmptyExtent)
{
return;
}
var icer = exception as IContainsErrorRecord;
if (icer != null)
{
var errorRecord = icer.ErrorRecord;
var invocationInfo = errorRecord.InvocationInfo;
if (invocationInfo == null)
{
errorRecord.SetInvocationInfo(new InvocationInfo(null, extent));
}
else if (invocationInfo.ScriptPosition == null || invocationInfo.ScriptPosition == PositionUtilities.EmptyExtent)
{
invocationInfo.ScriptPosition = extent;
errorRecord.LockScriptStackTrace();
}
}
}
internal static void UpdateExceptionErrorRecordHistoryId(RuntimeException exception, ExecutionContext context)
{
InvocationInfo invInfo = exception.ErrorRecord.InvocationInfo;
if (invInfo is not { HistoryId: -1 })
{
return;
}
if (context?.CurrentCommandProcessor is null)
{
return;
}
invInfo.HistoryId = context.CurrentCommandProcessor.Command.MyInvocation.HistoryId;
}
}
#endregion InterpreterError
#region ScriptTrace
internal static class ScriptTrace
{
internal static void Trace(int level, string messageId, string resourceString, params object[] args)
{
// Need access to the execution context to see if we should trace. If we
// can't get it, then just return...
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
if (context == null)
return;
Trace(context, level, messageId, resourceString, args);
}
internal static void Trace(ExecutionContext context, int level, string messageId, string resourceString, params object[] args)
{
ActionPreference pref = ActionPreference.Continue;
if (context.PSDebugTraceLevel > level)
{
string message;
if (args == null || args.Length == 0)
{
// Don't format in case the string contains literal curly braces
message = resourceString;
}
else
{
message = StringUtil.Format(resourceString, args);
}
if (string.IsNullOrEmpty(message))
{
message = "Could not load text for msh script tracing message id '" + messageId + "'";
Dbg.Assert(false, message);
}
((InternalHostUserInterface)context.EngineHostInterface.UI).WriteDebugLine(message, ref pref);
}
}
}
#endregion ScriptTrace
}
|