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
//! Module defining external-loaded modules for Rhai. use crate::any::{Dynamic, Variant}; use crate::calc_fn_hash; use crate::engine::Engine; use crate::fn_native::{CallableFunction as Func, FnCallArgs, IteratorFn, SendSync}; use crate::parser::{FnAccess, FnAccess::Public, ScriptFnDef}; use crate::result::EvalAltResult; use crate::token::{Position, Token}; use crate::utils::{StaticVec, StraightHasherBuilder}; #[cfg(not(feature = "no_function"))] use crate::fn_native::Shared; #[cfg(not(feature = "no_module"))] use crate::{ engine::Imports, parser::AST, scope::{Entry as ScopeEntry, Scope}, }; #[cfg(not(feature = "no_index"))] #[cfg(not(feature = "no_object"))] use crate::engine::{FN_IDX_GET, FN_IDX_SET}; #[cfg(not(feature = "no_object"))] use crate::engine::{make_getter, make_setter}; use crate::stdlib::{ any::TypeId, boxed::Box, collections::HashMap, fmt, format, iter::empty, mem, num::NonZeroUsize, ops::{Deref, DerefMut}, string::{String, ToString}, vec::Vec, }; #[cfg(not(feature = "no_std"))] #[cfg(not(feature = "no_module"))] #[cfg(not(feature = "sync"))] use crate::stdlib::cell::RefCell; #[cfg(not(feature = "no_std"))] #[cfg(not(feature = "no_module"))] #[cfg(feature = "sync")] use crate::stdlib::sync::RwLock; /// Return type of module-level Rust function. pub type FuncReturn<T> = Result<T, Box<EvalAltResult>>; /// An imported module, which may contain variables, sub-modules, /// external Rust functions, and script-defined functions. /// /// Not available under the `no_module` feature. #[derive(Default)] pub struct Module { /// Sub-modules. modules: HashMap<String, Module>, /// Module variables. variables: HashMap<String, Dynamic>, /// Flattened collection of all module variables, including those in sub-modules. all_variables: HashMap<u64, Dynamic, StraightHasherBuilder>, /// External Rust functions. functions: HashMap<u64, (String, FnAccess, StaticVec<TypeId>, Func), StraightHasherBuilder>, /// Iterator functions, keyed by the type producing the iterator. type_iterators: HashMap<TypeId, IteratorFn>, /// Flattened collection of all external Rust functions, native or scripted, /// including those in sub-modules. all_functions: HashMap<u64, Func, StraightHasherBuilder>, /// Is the module indexed? indexed: bool, } impl fmt::Debug for Module { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!( f, "Module(\n modules: {}\n vars: {}\n functions: {}\n)", self.modules .keys() .map(|k| k.as_str()) .collect::<Vec<_>>() .join(", "), self.variables .iter() .map(|(k, v)| format!("{}={:?}", k, v)) .collect::<Vec<_>>() .join(", "), self.functions .values() .map(|(_, _, _, f)| f.to_string()) .collect::<Vec<_>>() .join(", "), ) } } impl Clone for Module { fn clone(&self) -> Self { // Only clone the index at the top level Self { all_variables: self.all_variables.clone(), all_functions: self.all_functions.clone(), indexed: self.indexed, ..self.do_clone(false) } } } impl AsRef<Module> for Module { fn as_ref(&self) -> &Module { self } } impl Module { /// Create a new module. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42); /// ``` pub fn new() -> Self { Default::default() } /// Create a new module with a specified capacity for native Rust functions. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42); /// ``` pub fn new_with_capacity(capacity: usize) -> Self { Self { functions: HashMap::with_capacity_and_hasher(capacity, StraightHasherBuilder), ..Default::default() } } /// Clone the module, optionally skipping the index. fn do_clone(&self, clone_index: bool) -> Self { Self { modules: if clone_index { self.modules.clone() } else { self.modules .iter() .map(|(k, m)| (k.clone(), m.do_clone(clone_index))) .collect() }, variables: self.variables.clone(), functions: self.functions.clone(), type_iterators: self.type_iterators.clone(), ..Default::default() } } /// Does a variable exist in the module? /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert!(module.contains_var("answer")); /// ``` pub fn contains_var(&self, name: &str) -> bool { self.variables.contains_key(name) } /// Get the value of a module variable. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42); /// ``` pub fn get_var_value<T: Variant + Clone>(&self, name: &str) -> Option<T> { self.get_var(name).and_then(Dynamic::try_cast::<T>) } /// Get a module variable as a `Dynamic`. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert_eq!(module.get_var("answer").unwrap().cast::<i64>(), 42); /// ``` pub fn get_var(&self, name: &str) -> Option<Dynamic> { self.variables.get(name).cloned() } /// Set a variable into the module. /// /// If there is an existing variable of the same name, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// module.set_var("answer", 42_i64); /// assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42); /// ``` pub fn set_var(&mut self, name: impl Into<String>, value: impl Variant + Clone) -> &mut Self { self.variables.insert(name.into(), Dynamic::from(value)); self.indexed = false; self } /// Get a mutable reference to a modules-qualified variable. /// Name and Position in `EvalAltResult` are None and must be set afterwards. /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash`. pub(crate) fn get_qualified_var_mut( &mut self, hash_var: u64, ) -> Result<&mut Dynamic, Box<EvalAltResult>> { self.all_variables.get_mut(&hash_var).ok_or_else(|| { EvalAltResult::ErrorVariableNotFound(String::new(), Position::none()).into() }) } /// Set a script-defined function into the module. /// /// If there is an existing function of the same name and number of arguments, it is replaced. pub(crate) fn set_script_fn(&mut self, fn_def: ScriptFnDef) -> &mut Self { // None + function name + number of arguments. let hash_script = calc_fn_hash(empty(), &fn_def.name, fn_def.params.len(), empty()); self.functions.insert( hash_script, ( fn_def.name.to_string(), fn_def.access, Default::default(), fn_def.into(), ), ); self.indexed = false; self } /// Does a sub-module exist in the module? /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let sub_module = Module::new(); /// module.set_sub_module("question", sub_module); /// assert!(module.contains_sub_module("question")); /// ``` pub fn contains_sub_module(&self, name: &str) -> bool { self.modules.contains_key(name) } /// Get a sub-module. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let sub_module = Module::new(); /// module.set_sub_module("question", sub_module); /// assert!(module.get_sub_module("question").is_some()); /// ``` pub fn get_sub_module(&self, name: &str) -> Option<&Module> { self.modules.get(name) } /// Get a mutable reference to a sub-module. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let sub_module = Module::new(); /// module.set_sub_module("question", sub_module); /// assert!(module.get_sub_module_mut("question").is_some()); /// ``` pub fn get_sub_module_mut(&mut self, name: &str) -> Option<&mut Module> { self.modules.get_mut(name) } /// Set a sub-module into the module. /// /// If there is an existing sub-module of the same name, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let sub_module = Module::new(); /// module.set_sub_module("question", sub_module); /// assert!(module.get_sub_module("question").is_some()); /// ``` pub fn set_sub_module(&mut self, name: impl Into<String>, sub_module: Module) -> &mut Self { self.modules.insert(name.into(), sub_module.into()); self.indexed = false; self } /// Does the particular Rust function exist in the module? /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash`. /// It is also returned by the `set_fn_XXX` calls. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_fn_0("calc", || Ok(42_i64)); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn contains_fn(&self, hash_fn: u64, public_only: bool) -> bool { if public_only { self.functions .get(&hash_fn) .map(|(_, access, _, _)| match access { FnAccess::Public => true, FnAccess::Private => false, }) .unwrap_or(false) } else { self.functions.contains_key(&hash_fn) } } /// Set a Rust function into the module, returning a hash key. /// /// If there is an existing Rust function of the same hash, it is replaced. /// /// ## WARNING - Low Level API /// /// This function is very low level. pub fn set_fn( &mut self, name: impl Into<String>, access: FnAccess, arg_types: &[TypeId], func: Func, ) -> u64 { let name = name.into(); let hash_fn = calc_fn_hash(empty(), &name, arg_types.len(), arg_types.iter().cloned()); let params = arg_types.into_iter().cloned().collect(); self.functions .insert(hash_fn, (name, access, params, func.into())); self.indexed = false; hash_fn } /// Set a Rust function taking a reference to the scripting `Engine`, the current set of functions, /// plus a list of mutable `Dynamic` references into the module, returning a hash key. /// /// Use this to register a built-in function which must reference settings on the scripting /// `Engine` (e.g. to prevent growing an array beyond the allowed maximum size), or to call a /// script-defined function in the current evaluation context. /// /// If there is a similar existing Rust function, it is replaced. /// /// ## WARNING - Low Level API /// /// This function is very low level. /// /// A list of `TypeId`'s is taken as the argument types. /// /// Arguments are simply passed in as a mutable array of `&mut Dynamic`, /// which is guaranteed to contain enough arguments of the correct types. /// /// To access a primary parameter value (i.e. cloning is cheap), use: `args[n].clone().cast::<T>()` /// /// To access a parameter value and avoid cloning, use `std::mem::take(args[n]).cast::<T>()`. /// Notice that this will _consume_ the argument, replacing it with `()`. /// /// To access the first mutable parameter, use `args.get_mut(0).unwrap()` /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_raw_fn("double_or_not", /// // Pass parameter types via a slice with TypeId's /// &[std::any::TypeId::of::<i64>(), std::any::TypeId::of::<bool>()], /// // Fixed closure signature /// |engine, lib, args| { /// // 'args' is guaranteed to be the right length and of the correct types /// /// // Get the second parameter by 'consuming' it /// let double = std::mem::take(args[1]).cast::<bool>(); /// // Since it is a primary type, it can also be cheaply copied /// let double = args[1].clone().cast::<bool>(); /// // Get a mutable reference to the first argument. /// let mut x = args[0].write_lock::<i64>().unwrap(); /// /// let orig = *x; /// /// if double { /// *x *= 2; // the first argument can be mutated /// } /// /// Ok(orig) // return Result<T, Box<EvalAltResult>> /// }); /// /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_raw_fn<T: Variant + Clone>( &mut self, name: impl Into<String>, arg_types: &[TypeId], func: impl Fn(&Engine, &Module, &mut [&mut Dynamic]) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |engine: &Engine, lib: &Module, args: &mut FnCallArgs| { func(engine, lib, args).map(Dynamic::from) }; self.set_fn(name, Public, arg_types, Func::from_method(Box::new(f))) } /// Set a Rust function taking no parameters into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_fn_0("calc", || Ok(42_i64)); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_0<T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn() -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, _: &mut FnCallArgs| func().map(Dynamic::from); let arg_types = []; self.set_fn(name, Public, &arg_types, Func::from_pure(Box::new(f))) } /// Set a Rust function taking one parameter into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_fn_1("calc", |x: i64| Ok(x + 1)); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_1<A: Variant + Clone, T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(A) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { func(mem::take(args[0]).cast::<A>()).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>()]; self.set_fn(name, Public, &arg_types, Func::from_pure(Box::new(f))) } /// Set a Rust function taking one mutable parameter into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_fn_1_mut("calc", |x: &mut i64| { *x += 1; Ok(*x) }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_1_mut<A: Variant + Clone, T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(&mut A) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { func(&mut args[0].write_lock::<A>().unwrap()).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>()]; self.set_fn(name, Public, &arg_types, Func::from_method(Box::new(f))) } /// Set a Rust getter function taking one mutable parameter, returning a hash key. /// /// If there is a similar existing Rust getter function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::Module; /// /// let mut module = Module::new(); /// let hash = module.set_getter_fn("value", |x: &mut i64| { Ok(*x) }); /// assert!(module.contains_fn(hash, true)); /// ``` #[cfg(not(feature = "no_object"))] pub fn set_getter_fn<A: Variant + Clone, T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(&mut A) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { self.set_fn_1_mut(make_getter(&name.into()), func) } /// Set a Rust function taking two parameters into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_2("calc", |x: i64, y: ImmutableString| { /// Ok(x + y.len() as i64) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_2<A: Variant + Clone, B: Variant + Clone, T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(A, B) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let a = mem::take(args[0]).cast::<A>(); let b = mem::take(args[1]).cast::<B>(); func(a, b).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>(), TypeId::of::<B>()]; self.set_fn(name, Public, &arg_types, Func::from_pure(Box::new(f))) } /// Set a Rust function taking two parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_2_mut("calc", |x: &mut i64, y: ImmutableString| { /// *x += y.len() as i64; Ok(*x) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_2_mut<A: Variant + Clone, B: Variant + Clone, T: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(&mut A, B) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let b = mem::take(args[1]).cast::<B>(); let a = &mut args[0].write_lock::<A>().unwrap(); func(a, b).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>(), TypeId::of::<B>()]; self.set_fn(name, Public, &arg_types, Func::from_method(Box::new(f))) } /// Set a Rust setter function taking two parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing setter Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_setter_fn("value", |x: &mut i64, y: ImmutableString| { /// *x = y.len() as i64; /// Ok(()) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` #[cfg(not(feature = "no_object"))] pub fn set_setter_fn<A: Variant + Clone, B: Variant + Clone>( &mut self, name: impl Into<String>, func: impl Fn(&mut A, B) -> FuncReturn<()> + SendSync + 'static, ) -> u64 { self.set_fn_2_mut(make_setter(&name.into()), func) } /// Set a Rust index getter taking two parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing setter Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_indexer_get_fn(|x: &mut i64, y: ImmutableString| { /// Ok(*x + y.len() as i64) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` #[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_index"))] pub fn set_indexer_get_fn<A: Variant + Clone, B: Variant + Clone, T: Variant + Clone>( &mut self, func: impl Fn(&mut A, B) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { self.set_fn_2_mut(FN_IDX_GET, func) } /// Set a Rust function taking three parameters into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_3("calc", |x: i64, y: ImmutableString, z: i64| { /// Ok(x + y.len() as i64 + z) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_3< A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, T: Variant + Clone, >( &mut self, name: impl Into<String>, func: impl Fn(A, B, C) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let a = mem::take(args[0]).cast::<A>(); let b = mem::take(args[1]).cast::<B>(); let c = mem::take(args[2]).cast::<C>(); func(a, b, c).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>(), TypeId::of::<B>(), TypeId::of::<C>()]; self.set_fn(name, Public, &arg_types, Func::from_pure(Box::new(f))) } /// Set a Rust function taking three parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_3_mut("calc", |x: &mut i64, y: ImmutableString, z: i64| { /// *x += y.len() as i64 + z; Ok(*x) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_3_mut< A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, T: Variant + Clone, >( &mut self, name: impl Into<String>, func: impl Fn(&mut A, B, C) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let b = mem::take(args[1]).cast::<B>(); let c = mem::take(args[2]).cast::<C>(); let a = &mut args[0].write_lock::<A>().unwrap(); func(a, b, c).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>(), TypeId::of::<B>(), TypeId::of::<C>()]; self.set_fn(name, Public, &arg_types, Func::from_method(Box::new(f))) } /// Set a Rust index setter taking three parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_indexer_set_fn(|x: &mut i64, y: ImmutableString, value: i64| { /// *x = y.len() as i64 + value; /// Ok(()) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` #[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_index"))] pub fn set_indexer_set_fn<A: Variant + Clone, B: Variant + Clone, C: Variant + Clone>( &mut self, func: impl Fn(&mut A, B, C) -> FuncReturn<()> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let b = mem::take(args[1]).cast::<B>(); let c = mem::take(args[2]).cast::<C>(); let a = &mut args[0].write_lock::<A>().unwrap(); func(a, b, c).map(Dynamic::from) }; let arg_types = [TypeId::of::<A>(), TypeId::of::<B>(), TypeId::of::<C>()]; self.set_fn( FN_IDX_SET, Public, &arg_types, Func::from_method(Box::new(f)), ) } /// Set a pair of Rust index getter and setter functions, returning both hash keys. /// This is a shorthand for `set_indexer_get_fn` and `set_indexer_set_fn`. /// /// If there are similar existing Rust functions, they are replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let (hash_get, hash_set) = module.set_indexer_get_set_fn( /// |x: &mut i64, y: ImmutableString| { /// Ok(*x + y.len() as i64) /// }, /// |x: &mut i64, y: ImmutableString, value: i64| { /// *x = y.len() as i64 + value; /// Ok(()) /// } /// ); /// assert!(module.contains_fn(hash_get, true)); /// assert!(module.contains_fn(hash_set, true)); /// ``` #[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_index"))] pub fn set_indexer_get_set_fn<A: Variant + Clone, B: Variant + Clone, T: Variant + Clone>( &mut self, getter: impl Fn(&mut A, B) -> FuncReturn<T> + SendSync + 'static, setter: impl Fn(&mut A, B, T) -> FuncReturn<()> + SendSync + 'static, ) -> (u64, u64) { ( self.set_indexer_get_fn(getter), self.set_indexer_set_fn(setter), ) } /// Set a Rust function taking four parameters into the module, returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_4("calc", |x: i64, y: ImmutableString, z: i64, _w: ()| { /// Ok(x + y.len() as i64 + z) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_4< A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, T: Variant + Clone, >( &mut self, name: impl Into<String>, func: impl Fn(A, B, C, D) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let a = mem::take(args[0]).cast::<A>(); let b = mem::take(args[1]).cast::<B>(); let c = mem::take(args[2]).cast::<C>(); let d = mem::take(args[3]).cast::<D>(); func(a, b, c, d).map(Dynamic::from) }; let arg_types = [ TypeId::of::<A>(), TypeId::of::<B>(), TypeId::of::<C>(), TypeId::of::<D>(), ]; self.set_fn(name, Public, &arg_types, Func::from_pure(Box::new(f))) } /// Set a Rust function taking four parameters (the first one mutable) into the module, /// returning a hash key. /// /// If there is a similar existing Rust function, it is replaced. /// /// # Examples /// /// ``` /// use rhai::{Module, ImmutableString}; /// /// let mut module = Module::new(); /// let hash = module.set_fn_4_mut("calc", |x: &mut i64, y: ImmutableString, z: i64, _w: ()| { /// *x += y.len() as i64 + z; Ok(*x) /// }); /// assert!(module.contains_fn(hash, true)); /// ``` pub fn set_fn_4_mut< A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, T: Variant + Clone, >( &mut self, name: impl Into<String>, func: impl Fn(&mut A, B, C, D) -> FuncReturn<T> + SendSync + 'static, ) -> u64 { let f = move |_: &Engine, _: &Module, args: &mut FnCallArgs| { let b = mem::take(args[1]).cast::<B>(); let c = mem::take(args[2]).cast::<C>(); let d = mem::take(args[3]).cast::<D>(); let a = &mut args[0].write_lock::<A>().unwrap(); func(a, b, c, d).map(Dynamic::from) }; let arg_types = [ TypeId::of::<A>(), TypeId::of::<B>(), TypeId::of::<C>(), TypeId::of::<C>(), ]; self.set_fn(name, Public, &arg_types, Func::from_method(Box::new(f))) } /// Get a Rust function. /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash`. /// It is also returned by the `set_fn_XXX` calls. pub(crate) fn get_fn(&self, hash_fn: u64, public_only: bool) -> Option<&Func> { self.functions .get(&hash_fn) .and_then(|(_, access, _, f)| match access { _ if !public_only => Some(f), FnAccess::Public => Some(f), FnAccess::Private => None, }) } /// Get a modules-qualified function. /// Name and Position in `EvalAltResult` are None and must be set afterwards. /// /// The `u64` hash is calculated by the function `crate::calc_fn_hash` and must match /// the hash calculated by `index_all_sub_modules`. pub(crate) fn get_qualified_fn(&self, hash_qualified_fn: u64) -> Option<&Func> { self.all_functions.get(&hash_qualified_fn) } /// Combine another module into this module. /// The other module is consumed to merge into this module. pub fn combine(&mut self, other: Self) -> &mut Self { self.variables.extend(other.variables.into_iter()); self.functions.extend(other.functions.into_iter()); self.type_iterators.extend(other.type_iterators.into_iter()); self.all_functions.clear(); self.all_variables.clear(); self.indexed = false; self } /// Merge another module into this module. pub fn merge(&mut self, other: &Self) -> &mut Self { self.merge_filtered(other, |_, _, _| true) } /// Merge another module into this module, with only selected script-defined functions based on a filter predicate. pub(crate) fn merge_filtered( &mut self, other: &Self, _filter: impl Fn(FnAccess, &str, usize) -> bool, ) -> &mut Self { self.variables .extend(other.variables.iter().map(|(k, v)| (k.clone(), v.clone()))); self.functions.extend( other .functions .iter() .filter(|(_, (_, _, _, v))| match v { #[cfg(not(feature = "no_function"))] Func::Script(ref f) => _filter(f.access, f.name.as_str(), f.params.len()), _ => true, }) .map(|(&k, v)| (k, v.clone())), ); self.type_iterators .extend(other.type_iterators.iter().map(|(&k, v)| (k, v.clone()))); self.all_functions.clear(); self.all_variables.clear(); self.indexed = false; self } /// Filter out the functions, retaining only some based on a filter predicate. #[cfg(not(feature = "no_function"))] pub(crate) fn retain_functions( &mut self, filter: impl Fn(FnAccess, &str, usize) -> bool, ) -> &mut Self { self.functions.retain(|_, (_, _, _, v)| match v { Func::Script(ref f) => filter(f.access, f.name.as_str(), f.params.len()), _ => true, }); self.all_functions.clear(); self.all_variables.clear(); self.indexed = false; self } /// Get the number of variables in the module. pub fn num_var(&self) -> usize { self.variables.len() } /// Get the number of functions in the module. pub fn num_fn(&self) -> usize { self.variables.len() } /// Get the number of type iterators in the module. pub fn num_iter(&self) -> usize { self.variables.len() } /// Get an iterator to the variables in the module. pub fn iter_var(&self) -> impl Iterator<Item = (&String, &Dynamic)> { self.variables.iter() } /// Get an iterator to the functions in the module. pub(crate) fn iter_fn( &self, ) -> impl Iterator<Item = &(String, FnAccess, StaticVec<TypeId>, Func)> { self.functions.values() } /// Get an iterator over all script-defined functions in the module. #[cfg(not(feature = "no_function"))] pub fn iter_script_fn<'a>(&'a self) -> impl Iterator<Item = Shared<ScriptFnDef>> + 'a { self.functions .values() .map(|(_, _, _, f)| f) .filter(|f| f.is_script()) .map(|f| f.get_shared_fn_def()) } /// Create a new `Module` by evaluating an `AST`. /// /// # Examples /// /// ``` /// # fn main() -> Result<(), Box<rhai::EvalAltResult>> { /// use rhai::{Engine, Module, Scope}; /// /// let engine = Engine::new(); /// let ast = engine.compile("let answer = 42; export answer;")?; /// let module = Module::eval_ast_as_new(Scope::new(), &ast, &engine)?; /// assert!(module.contains_var("answer")); /// assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42); /// # Ok(()) /// # } /// ``` #[cfg(not(feature = "no_module"))] pub fn eval_ast_as_new(mut scope: Scope, ast: &AST, engine: &Engine) -> FuncReturn<Self> { let mut mods = Imports::new(); // Run the script engine.eval_ast_with_scope_raw(&mut scope, &mut mods, &ast)?; // Create new module let mut module = Module::new(); scope .into_iter() .for_each(|ScopeEntry { value, alias, .. }| { // Variables with an alias left in the scope become module variables if alias.is_some() { module.variables.insert(*alias.unwrap(), value); } }); // Modules left in the scope become sub-modules mods.into_iter().for_each(|(alias, m)| { module.modules.insert(alias.to_string(), m); }); module.merge(ast.lib()); Ok(module) } /// Scan through all the sub-modules in the module build an index of all /// variables and external Rust functions via hashing. #[cfg(not(feature = "no_module"))] pub(crate) fn index_all_sub_modules(&mut self) { // Collect a particular module. fn index_module<'a>( module: &'a Module, qualifiers: &mut Vec<&'a str>, variables: &mut Vec<(u64, Dynamic)>, functions: &mut Vec<(u64, Func)>, ) { for (name, m) in &module.modules { // Index all the sub-modules first. qualifiers.push(name); index_module(m, qualifiers, variables, functions); qualifiers.pop(); } // Index all variables for (var_name, value) in &module.variables { // Qualifiers + variable name let hash_var = calc_fn_hash(qualifiers.iter().map(|&v| v), var_name, 0, empty()); variables.push((hash_var, value.clone())); } // Index all Rust functions for (name, access, params, func) in module.functions.values() { match access { // Private functions are not exported FnAccess::Private => continue, FnAccess::Public => (), } #[cfg(not(feature = "no_function"))] if func.is_script() { let fn_def = func.get_shared_fn_def(); // Qualifiers + function name + number of arguments. let hash_qualified_script = calc_fn_hash( qualifiers.iter().map(|&v| v), &fn_def.name, fn_def.params.len(), empty(), ); functions.push((hash_qualified_script, fn_def.into())); continue; } // Qualified Rust functions are indexed in two steps: // 1) Calculate a hash in a similar manner to script-defined functions, // i.e. qualifiers + function name + number of arguments. let hash_qualified_script = calc_fn_hash(qualifiers.iter().map(|&v| v), name, params.len(), empty()); // 2) Calculate a second hash with no qualifiers, empty function name, // zero number of arguments, and the actual list of argument `TypeId`'.s let hash_fn_args = calc_fn_hash(empty(), "", 0, params.iter().cloned()); // 3) The final hash is the XOR of the two hashes. let hash_qualified_fn = hash_qualified_script ^ hash_fn_args; functions.push((hash_qualified_fn, func.clone())); } } if self.indexed { return; } let mut qualifiers: Vec<_> = Default::default(); let mut variables: Vec<_> = Default::default(); let mut functions: Vec<_> = Default::default(); qualifiers.push("root"); index_module(self, &mut qualifiers, &mut variables, &mut functions); self.all_variables = variables.into_iter().collect(); self.all_functions = functions.into_iter().collect(); self.indexed = true; } /// Does a type iterator exist in the module? pub fn contains_iter(&self, id: TypeId) -> bool { self.type_iterators.contains_key(&id) } /// Set a type iterator into the module. pub fn set_iter(&mut self, typ: TypeId, func: IteratorFn) -> &mut Self { self.type_iterators.insert(typ, func); self.indexed = false; self } /// Get the specified type iterator. pub(crate) fn get_iter(&self, id: TypeId) -> Option<IteratorFn> { self.type_iterators.get(&id).cloned() } } /// [INTERNALS] A chain of module names to qualify a variable or function call. /// Exported under the `internals` feature only. /// /// A `u64` hash key is cached for quick search purposes. /// /// A `StaticVec` is used because most module-level access contains only one level, /// and it is wasteful to always allocate a `Vec` with one element. /// /// ## WARNING /// /// This type is volatile and may change. #[derive(Clone, Eq, PartialEq, Default, Hash)] pub struct ModuleRef(StaticVec<(String, Position)>, Option<NonZeroUsize>); impl fmt::Debug for ModuleRef { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Debug::fmt(&self.0, f)?; if let Some(index) = self.1 { write!(f, " -> {}", index) } else { Ok(()) } } } impl Deref for ModuleRef { type Target = StaticVec<(String, Position)>; fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for ModuleRef { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl fmt::Display for ModuleRef { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { for (m, _) in self.0.iter() { write!(f, "{}{}", m, Token::DoubleColon.syntax())?; } Ok(()) } } impl From<StaticVec<(String, Position)>> for ModuleRef { fn from(modules: StaticVec<(String, Position)>) -> Self { Self(modules, None) } } impl ModuleRef { pub(crate) fn index(&self) -> Option<NonZeroUsize> { self.1 } pub(crate) fn set_index(&mut self, index: Option<NonZeroUsize>) { self.1 = index } } /// Trait that encapsulates a module resolution service. pub trait ModuleResolver: SendSync { /// Resolve a module based on a path string. fn resolve(&self, _: &Engine, path: &str, pos: Position) -> Result<Module, Box<EvalAltResult>>; } /// Re-export module resolvers. #[cfg(not(feature = "no_module"))] pub mod resolvers { pub use super::collection::ModuleResolversCollection; #[cfg(not(feature = "no_std"))] #[cfg(not(target_arch = "wasm32"))] pub use super::file::FileModuleResolver; pub use super::stat::StaticModuleResolver; } #[cfg(feature = "no_module")] pub mod resolvers {} /// Script file-based module resolver. #[cfg(not(feature = "no_module"))] #[cfg(not(feature = "no_std"))] #[cfg(not(target_arch = "wasm32"))] mod file { use super::*; use crate::stdlib::path::PathBuf; /// Module resolution service that loads module script files from the file system. /// /// Script files are cached so they are are not reloaded and recompiled in subsequent requests. /// /// The `new_with_path` and `new_with_path_and_extension` constructor functions /// allow specification of a base directory with module path used as a relative path offset /// to the base directory. The script file is then forced to be in a specified extension /// (default `.rhai`). /// /// # Examples /// /// ``` /// use rhai::Engine; /// use rhai::module_resolvers::FileModuleResolver; /// /// // Create a new 'FileModuleResolver' loading scripts from the 'scripts' subdirectory /// // with file extension '.x'. /// let resolver = FileModuleResolver::new_with_path_and_extension("./scripts", "x"); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` #[derive(Debug)] pub struct FileModuleResolver { path: PathBuf, extension: String, #[cfg(not(feature = "sync"))] cache: RefCell<HashMap<PathBuf, AST>>, #[cfg(feature = "sync")] cache: RwLock<HashMap<PathBuf, AST>>, } impl Default for FileModuleResolver { fn default() -> Self { Self::new_with_path(PathBuf::default()) } } impl FileModuleResolver { /// Create a new `FileModuleResolver` with a specific base path. /// /// # Examples /// /// ``` /// use rhai::Engine; /// use rhai::module_resolvers::FileModuleResolver; /// /// // Create a new 'FileModuleResolver' loading scripts from the 'scripts' subdirectory /// // with file extension '.rhai' (the default). /// let resolver = FileModuleResolver::new_with_path("./scripts"); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` pub fn new_with_path<P: Into<PathBuf>>(path: P) -> Self { Self::new_with_path_and_extension(path, "rhai") } /// Create a new `FileModuleResolver` with a specific base path and file extension. /// /// The default extension is `.rhai`. /// /// # Examples /// /// ``` /// use rhai::Engine; /// use rhai::module_resolvers::FileModuleResolver; /// /// // Create a new 'FileModuleResolver' loading scripts from the 'scripts' subdirectory /// // with file extension '.x'. /// let resolver = FileModuleResolver::new_with_path_and_extension("./scripts", "x"); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` pub fn new_with_path_and_extension<P: Into<PathBuf>, E: Into<String>>( path: P, extension: E, ) -> Self { Self { path: path.into(), extension: extension.into(), cache: Default::default(), } } /// Create a new `FileModuleResolver` with the current directory as base path. /// /// # Examples /// /// ``` /// use rhai::Engine; /// use rhai::module_resolvers::FileModuleResolver; /// /// // Create a new 'FileModuleResolver' loading scripts from the current directory /// // with file extension '.rhai' (the default). /// let resolver = FileModuleResolver::new(); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` pub fn new() -> Self { Default::default() } /// Create a `Module` from a file path. pub fn create_module<P: Into<PathBuf>>( &self, engine: &Engine, path: &str, ) -> Result<Module, Box<EvalAltResult>> { self.resolve(engine, path, Default::default()) } } impl ModuleResolver for FileModuleResolver { fn resolve( &self, engine: &Engine, path: &str, pos: Position, ) -> Result<Module, Box<EvalAltResult>> { // Construct the script file path let mut file_path = self.path.clone(); file_path.push(path); file_path.set_extension(&self.extension); // Force extension let scope = Default::default(); // See if it is cached let (module, ast) = { #[cfg(not(feature = "sync"))] let c = self.cache.borrow(); #[cfg(feature = "sync")] let c = self.cache.read().unwrap(); match c.get(&file_path) { Some(ast) => ( Module::eval_ast_as_new(scope, ast, engine) .map_err(|err| err.new_position(pos))?, None, ), None => { // Load the file and compile it if not found let ast = engine .compile_file(file_path.clone()) .map_err(|err| err.new_position(pos))?; ( Module::eval_ast_as_new(scope, &ast, engine) .map_err(|err| err.new_position(pos))?, Some(ast), ) } } }; if let Some(ast) = ast { // Put it into the cache #[cfg(not(feature = "sync"))] self.cache.borrow_mut().insert(file_path, ast); #[cfg(feature = "sync")] self.cache.write().unwrap().insert(file_path, ast); } Ok(module) } } } /// Static module resolver. #[cfg(not(feature = "no_module"))] mod stat { use super::*; /// Module resolution service that serves modules added into it. /// /// # Examples /// /// ``` /// use rhai::{Engine, Module}; /// use rhai::module_resolvers::StaticModuleResolver; /// /// let mut resolver = StaticModuleResolver::new(); /// /// let module = Module::new(); /// resolver.insert("hello".to_string(), module); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` #[derive(Debug, Clone, Default)] pub struct StaticModuleResolver(HashMap<String, Module>); impl StaticModuleResolver { /// Create a new `StaticModuleResolver`. /// /// # Examples /// /// ``` /// use rhai::{Engine, Module}; /// use rhai::module_resolvers::StaticModuleResolver; /// /// let mut resolver = StaticModuleResolver::new(); /// /// let module = Module::new(); /// resolver.insert("hello", module); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(resolver)); /// ``` pub fn new() -> Self { Default::default() } } impl StaticModuleResolver { /// Add a module keyed by its path. pub fn insert<S: Into<String>>(&mut self, path: S, mut module: Module) { module.index_all_sub_modules(); self.0.insert(path.into(), module); } /// Remove a module given its path. pub fn remove(&mut self, path: &str) -> Option<Module> { self.0.remove(path) } /// Does the path exist? pub fn contains_path(&self, path: &str) -> bool { self.0.contains_key(path) } /// Get an iterator of all the modules. pub fn iter(&self) -> impl Iterator<Item = (&str, &Module)> { self.0.iter().map(|(k, v)| (k.as_str(), v)) } /// Get a mutable iterator of all the modules. pub fn iter_mut(&mut self) -> impl Iterator<Item = (&str, &mut Module)> { self.0.iter_mut().map(|(k, v)| (k.as_str(), v)) } /// Get an iterator of all the module paths. pub fn paths(&self) -> impl Iterator<Item = &str> { self.0.keys().map(String::as_str) } /// Get an iterator of all the modules. pub fn values(&self) -> impl Iterator<Item = &Module> { self.0.values() } /// Get a mutable iterator of all the modules. pub fn values_mut(&mut self) -> impl Iterator<Item = &mut Module> { self.0.values_mut() } /// Remove all modules. pub fn clear(&mut self) { self.0.clear(); } } impl ModuleResolver for StaticModuleResolver { fn resolve( &self, _: &Engine, path: &str, pos: Position, ) -> Result<Module, Box<EvalAltResult>> { self.0 .get(path) .cloned() .ok_or_else(|| EvalAltResult::ErrorModuleNotFound(path.into(), pos).into()) } } } /// Module resolver collection. #[cfg(not(feature = "no_module"))] mod collection { use super::*; /// Module resolution service that holds a collection of module resolves, /// to be searched in sequential order. /// /// # Examples /// /// ``` /// use rhai::{Engine, Module}; /// use rhai::module_resolvers::{StaticModuleResolver, ModuleResolversCollection}; /// /// let mut collection = ModuleResolversCollection::new(); /// /// let resolver = StaticModuleResolver::new(); /// collection.push(resolver); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(collection)); /// ``` #[derive(Default)] pub struct ModuleResolversCollection(Vec<Box<dyn ModuleResolver>>); impl ModuleResolversCollection { /// Create a new `ModuleResolversCollection`. /// /// # Examples /// /// ``` /// use rhai::{Engine, Module}; /// use rhai::module_resolvers::{StaticModuleResolver, ModuleResolversCollection}; /// /// let mut collection = ModuleResolversCollection::new(); /// /// let resolver = StaticModuleResolver::new(); /// collection.push(resolver); /// /// let mut engine = Engine::new(); /// engine.set_module_resolver(Some(collection)); /// ``` pub fn new() -> Self { Default::default() } } impl ModuleResolversCollection { /// Add a module keyed by its path. pub fn push(&mut self, resolver: impl ModuleResolver + 'static) { self.0.push(Box::new(resolver)); } /// Get an iterator of all the module resolvers. pub fn iter(&self) -> impl Iterator<Item = &dyn ModuleResolver> { self.0.iter().map(|v| v.as_ref()) } /// Remove all module resolvers. pub fn clear(&mut self) { self.0.clear(); } } impl ModuleResolver for ModuleResolversCollection { fn resolve( &self, engine: &Engine, path: &str, pos: Position, ) -> Result<Module, Box<EvalAltResult>> { for resolver in self.0.iter() { if let Ok(module) = resolver.resolve(engine, path, pos) { return Ok(module); } } EvalAltResult::ErrorModuleNotFound(path.into(), pos).into() } } }