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
//! # Intro
//!
//! This document covers the usage of the crate's macros, it does
//! not delve into the detailed logic of the generated code.
//!
//! For a comprehensive understanding of the underlying
//! concepts and implementation details of the Actor Model,
//! it's recommended to read the article [Actors with Tokio](https://ryhl.io/blog/actors-with-tokio/)
//! by Alice Ryhl ( also known as _Darksonn_ ) also a great
//! talk by the same author on the same subject if a more
//! interactive explanation is prefered
//! [Actors with Tokio – a lesson in ownership - Alice Ryhl](https://www.youtube.com/watch?v=fTXuGRP1ee4)
//! (video).
//! This article not only inspired the development of the
//! `interthread` crate but serves as foundation
//! for the Actor Model implementation logic in it.
//! ## What is an Actor ?
//!
//! Despite being a fundamental concept in concurrent programming,
//! defining exactly what an actor is can be ambiguous.
//!
//! - *Carl Hewitt*, often regarded as the father of the Actor Model,
//! [The Actor Model](https://www.youtube.com/watch?v=7erJ1DV_Tlo) (video).
//!
//! - Wikipidia [Actor Model](https://en.wikipedia.org/wiki/Actor_model)
//!
//!
//! a quote from [Actors with Tokio](https://ryhl.io/blog/actors-with-tokio/):
//!
//! > "The basic idea behind an actor is to spawn a
//! self-contained task that performs some job independently
//! of other parts of the program. Typically these actors
//! communicate with the rest of the program through
//! the use of message passing channels. Since each actor
//! runs independently, programs designed using them are
//! naturally parallel."
//! > - Alice Ryhl
//!
//! ## What is the problem ?
//!
//! To achieve parallel execution of individual objects
//! within the same program, it is challenging due
//! to the need for various types that are capable of
//! working across threads. The main difficulty
//! lies in the fact that as you introduce thread-related types,
//! you can quickly lose sight of the main program
//! idea as the focus shifts to managing thread-related
//! concerns.
//!
//! It involves using constructs like threads, locks, channels,
//! and other synchronization primitives. These additional
//! types and mechanisms introduce complexity and can obscure
//! the core logic of the program.
//!
//!
//! Moreover, existing libraries like [`actix`](https://docs.rs/actix/latest/actix/), [`axiom`](https://docs.rs/axiom/latest/axiom/),
//! designed to simplify working within the Actor Model,
//! often employ specific concepts, vocabulary, traits and types that may
//! be unfamiliar to users who are less experienced with
//! asynchronous programming and futures.
//!
//! ## Solution
//!
//! The [`actor`](./attr.actor.html) macro - when applied to the
//! implementation block of a given "MyActor" object,
//! generates additional Struct types
//! that enable communication between threads.
//!
//! A notable outcome of applying this macro is the
//! creation of the `MyActorLive` struct ("ActorName" + "Live"),
//! which acts as an interface/handle to the `MyActor` object.
//! `MyActorLive` retains the exact same public method signatures
//! as `MyActor`, allowing users to interact with the actor as if
//! they were directly working with the original object.
//!
//! ### Examples
//!
//!
//! Filename: Cargo.toml
//!
//!```text
//![dependencies]
//!interthread = "2.0.0"
//!oneshot = "0.1.6"
//!```
//!
//! Filename: main.rs
//!```rust no_run
//!pub struct MyActor {
//! value: i8,
//!}
//!
//!#[interthread::actor]
//!impl MyActor {
//!
//! pub fn new( v: i8 ) -> Self {
//! Self { value: v }
//! }
//! pub fn increment(&mut self) {
//! self.value += 1;
//! }
//! pub fn add_number(&mut self, num: i8) -> i8 {
//! self.value += num;
//! self.value
//! }
//! pub fn get_value(&self) -> i8 {
//! self.value
//! }
//!}
//!
//!fn main() {
//!
//! let actor = MyActorLive::new(5);
//!
//! let mut actor_a = actor.clone();
//! let mut actor_b = actor.clone();
//!
//! let handle_a = std::thread::spawn( move || {
//! actor_a.increment();
//! });
//!
//! let handle_b = std::thread::spawn( move || {
//! actor_b.add_number(5);
//! });
//!
//! let _ = handle_a.join();
//! let _ = handle_b.join();
//!
//! assert_eq!(actor.get_value(), 11)
//!}
//!
//! ```
//!
//! An essential point to highlight is that when invoking
//! `MyActorLive::new`, not only does it return an instance
//! of `MyActorLive`, but it also spawns a new thread that
//! contains an instance of `MyActor` in it.
//! This introduces parallelism to the program.
//!
//! The code generated by the [`actor`](./attr.actor.html) takes
//! care of the underlying message routing and synchronization,
//! allowing developers to rapidly prototype their application's
//! core functionality. This fast sketching capability is
//! particularly useful when exploring different design options,
//! experimenting with concurrency models, or implementing
//! proof-of-concept systems. Not to mention, the cases where
//! the importance of the program lies in the result of its work
//! rather than its execution.
//!
//!
//! # SDPL Framework
//!
//!
//! The code generated by the [`actor`](./attr.actor.html) macro
//! can be divided into four more or less important but distinct
//! parts: [`script`](#script) ,[`direct`](#direct),
//! [`play`](#play), [`live`](#live) .
//!
//! This categorization provides an intuitive
//! and memorable way to understand the different aspects
//! of the generated code.
//!
//! Expanding the above example, uncomment the [`example`](./attr.example.html)
//! placed above the `main` function, go to `examples/inter/main.rs` in your
//! root directory and find `MyActor` along with additional SDPL parts :
//!
//! # `script`
//!
//! Think of script as a message type definition.
//!
//! The declaration of an `ActorName + Script` enum, which is
//! serving as a collection of variants that represent
//! different messages that may be sent across threads through a
//! channel.
//!
//! Each variant corresponds to a struct with fields
//! that capture the input and/or output parameters of
//! the respective public methods of the Actor.
//!
//!
//! ```rust no_run
//!
//! pub enum MyActorScript {
//! Increment {},
//! AddNumber { num: i8, inter_send: oneshot::Sender<i8> },
//! GetValue { inter_send: oneshot::Sender<i8> },
//! }
//!
//! ```
//!
//! > **Note**: Method `new` not included as a variant in the `script`.
//!
//!
//! # direct
//! The implementation block of `script`struct, specifically
//! the `direct` method which allows
//! for direct invocation of the Actor's methods by mapping
//! the enum variants to the corresponding function calls.
//!
//!
//!```rust no_run
//!impl MyActorScript {
//! pub fn direct(self, actor: &mut MyActor) {
//! match self {
//! MyActorScript::Increment {} => {
//! actor.increment();
//! }
//! MyActorScript::AddNumber { num, inter_send } => {
//! inter_send
//! .send(actor.add_number(num))
//! .unwrap_or_else(|_error| {
//! core::panic!(
//! "'MyActorScript::AddNumber.direct'. Sending on a closed channel."
//! )
//! });
//! }
//! MyActorScript::GetValue { inter_send } => {
//! inter_send
//! .send(actor.get_value())
//! .unwrap_or_else(|_error| {
//! core::panic!(
//! "'MyActorScript::GetValue.direct'. Sending on a closed channel."
//! )
//! });
//! }
//! }
//! }
//!}
//!```
//!
//! # play
//! The implementation block of `script`struct, specifically
//! the `play` associated (static) method responsible for
//! continuously receiving `script` variants from
//! a dedicated channel and `direct`ing them.
//!
//! Also this function serves as the home for the Actor itself.
//!
//!
//!```rust no_run
//!impl MyActorScript {
//! pub fn play(receiver: std::sync::mpsc::Receiver<MyActorScript>,
//! mut actor: MyActor) {
//! while let std::result::Result::Ok(msg) = receiver.recv() {
//! msg.direct(&mut actor);
//! }
//! eprintln!("MyActor the end ...");
//! }
//!}
//!```
//!
//! When using the [`edit`](./attr.actor.html#edit) argument in the [`actor`](./attr.actor.html)
//! macro, such as
//!
//!```rust no_run
//!#[interthread::actor(edit(script(imp(play))))]
//!```
//!
//! it allows for manual implementation of the `play` part, which
//! gives the flexibility to customize and modify
//! the behavior of the `play` to suit any requared logic.
//!
//! In addition the Debug trait is implemented for the `script`struct.
//!
//! ```rust no_run
//!impl std::fmt::Debug for MyActorScript {
//! fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
//! match self {
//! MyActorScript::Increment { .. } => write!(f, "MyActorScript::Increment"),
//! MyActorScript::AddNumber { .. } => write!(f, "MyActorScript::AddNumber"),
//! MyActorScript::GetValue { .. } => write!(f, "MyActorScript::GetValue"),
//! }
//! }
//!}
//! ```
//!
//!
//! # live
//! A struct `ActorName + Live`, which serves as an interface/handler
//! replicating the public method signatures of the original Actor.
//!
//! Invoking a method on a live instance, it's triggering the eventual
//! invocation of the corresponding method within the Actor.
//!
//! The special method of `live` method `new`
//! - declares a new channel
//! - initiates an instace of the Actor
//! - spawns the `play` component in a separate thread
//! - returns an instance of `Self`
//!
//!
//! ```rust no_run
//!
//!#[derive(Clone)]
//!pub struct MyActorLive {
//! sender: std::sync::mpsc::Sender<MyActorScript>,
//!}
//!impl MyActorLive {
//! pub fn new(v: i8) -> Self {
//! let actor = MyActor::new(v);
//! let (sender, receiver) = std::sync::mpsc::channel();
//! std::thread::spawn(move || { MyActorScript::play(receiver, actor) });
//! Self { sender }
//! }
//! pub fn increment(&mut self) {
//! let msg = MyActorScript::Increment {};
//! let _ = self
//! .sender
//! .send(msg)
//! .expect("'MyActorLive::method.send'. Channel is closed!");
//! }
//! pub fn add_number(&mut self, num: i8) -> i8 {
//! let (inter_send, inter_recv) = oneshot::channel();
//! let msg = MyActorScript::AddNumber {
//! num,
//! inter_send,
//! };
//! let _ = self
//! .sender
//! .send(msg)
//! .expect("'MyActorLive::method.send'. Channel is closed!");
//! inter_recv
//! .recv()
//! .unwrap_or_else(|_error| {
//! core::panic!("'MyActor::add_number' from inter_recv. Channel is closed!")
//! })
//! }
//! pub fn get_value(&self) -> i8 {
//! let (inter_send, inter_recv) = oneshot::channel();
//! let msg = MyActorScript::GetValue {
//! inter_send,
//! };
//! let _ = self
//! .sender
//! .send(msg)
//! .expect("'MyActorLive::method.send'. Channel is closed!");
//! inter_recv
//! .recv()
//! .unwrap_or_else(|_error| {
//! core::panic!("'MyActor::get_value' from inter_recv. Channel is closed!")
//! })
//! }
//!}
//!
//! ```
//! The methods of `live` type have same method signature
//! as Actor's own methods
//! - declare a `oneshot` channel
//! - declare a `msg` specific `script` variant
//! - send the `msg` via `live`'s channel
//! - receive and return the output if any
//!
//! # Panics
//!
//! The model will panic if an attempt is made to send or
//! receive on the channel after it has been dropped.
//! Generally, such issues are unlikely to occur, but
//! if the `interact` option is used, it introduces a
//! potential scenario for encountering this situation.
//!
//!
//! # Macro Implicit Dependencies
//!
//! The [`actor`](./attr.actor.html) macro generates code
//! that utilizes channels for communication. However,
//! the macro itself does not provide any channel implementations.
//! Therefore, depending on the libraries used in your project,
//! you may need to import additional crates.
//!
//!### Crate Compatibility
//!<table>
//! <thead>
//! <tr>
//! <th>lib</th>
//! <th><a href="https://docs.rs/oneshot">oneshot</a></th>
//! <th><a href="https://docs.rs/async-channel">async_channel</a></th>
//! </tr>
//! </thead>
//! <tbody>
//! <tr>
//! <td>std</td>
//! <td style="text-align: center;">✓</td>
//! <td style="text-align: center;"><b>-</b></td>
//! </tr>
//! <tr>
//! <td><a href="https://crates.io/crates/smol">smol</a></td>
//! <td style="text-align: center;">✓</td>
//! <td style="text-align: center;">✓</td>
//! </tr>
//! <tr>
//! <td><a href="https://docs.rs/tokio">tokio</a></td>
//! <td style="text-align: center;"><b>-</b></td>
//! <td style="text-align: center;"><b>-</b></td>
//! </tr>
//! <tr>
//! <td><a href="https://crates.io/crates/async-std">async-std</a></td>
//! <td style="text-align: center;">✓</td>
//! <td style="text-align: center;"><b>-</b></td>
//! </tr>
//! </tbody>
//!</table>
//!
//!
//!>**Note:** The table shows the compatibility of
//!>the macro with different libraries, indicating whether
//!>the dependencies are needed (✔) or not.
//!>The macros will provide helpful messages indicating
//!>the necessary crate imports based on your project's dependencies.
//!
//!
//! Checkout `interthread` on [![GitHub](https://img.shields.io/badge/GitHub-%2312100E.svg?&style=plastic&logo=GitHub&logoColor=white)](https://github.com/NimonSour/interthread)
//!
mod use_macro;
mod show;
mod file;
mod check;
mod error;
mod parse;
mod model;
static INTERTHREAD: &'static str = "interthread";
static INTER_EXAMPLE_DIR_NAME: &'static str = "INTER_EXAMPLE_DIR_NAME";
static INTER: &'static str = "inter";
static GROUP: &'static str = "group";
static ACTOR: &'static str = "actor";
static EXAMPLE: &'static str = "example";
static EXAMPLES: &'static str = "examples";
// vars
static INTER_SEND: &'static str = "inter_send";
static INTER_RECV: &'static str = "inter_recv";
// Some of Attributes Arguments
static EDIT: &'static str = "edit";
static FILE: &'static str = "file";
#[cfg(windows)]
const LINE_ENDING: &'static str = "\r\n";
#[cfg(not(windows))]
const LINE_ENDING: &'static str = "\n";
/// # Code transparency and exploration
///
/// The [`example`](./attr.example.html) macro serves as a
/// convenient tool for code transparency and exploration.
/// Automatically generating an expanded code file,
/// it provides developers with a tangible representation of
/// the code produced by the `interthread` macros.
///
/// Having the expanded code readily available in the `examples/inter`
/// directory offers a few key advantages:
///
/// - It provides a clear reference point for developers to inspect
/// and understand the underlying code structure.
///
/// - The generated code file serves as a starting point for
/// customization. Developers can copy and paste the generated code
/// into their own project files and make custom changes as needed.
/// This allows for easy customization of the generated actor
/// implementation to fit specific requirements or to add additional
/// functionality.
///
/// - Helps maintain a clean and focused project structure,
/// with the `examples` directory serving as a dedicated location for
/// exploring and experimenting with the generated code.
///
/// [`example`](./attr.example.html) macro helps developers to
/// actively engage with the generated code
/// and facilitates a smooth transition from the generated code to a
/// customized implementation. This approach promotes code transparency,
/// customization, and a better understanding of the generated code's
/// inner workings, ultimately enhancing the development experience
/// when working with the `interthread` macros.
///
/// Consider a macro [`actor`](./attr.actor.html) inside the project
/// in `src/my_file.rs`.
///
///Filename: my_file.rs
///```rust no_run
///use interthread::{actor,example};
///
///pub struct Number;
///
/// // you can have "example" macro in the same file
/// // #[example(path="src/my_file.rs")]
///
///#[actor]
///impl Number {
/// pub fn new(value: u32) -> Self {Self}
///}
///
///```
///
///Filename: main.rs
///```rust no_run
///use interthread::example;
///#[example(path="src/my_file.rs")]
///fn main(){
///}
///
///```
///
/// The macro will create and write to `examples/inter/my_file.rs`
/// the content of `src/my_file.rs` with the
/// [`actor`](./attr.actor.html) macro expanded.
///
///
///```text
///my_project/
///├── src/
///│ ├── my_file.rs <--- macro "actor"
///| |
///│ └── main.rs <--- macro "example"
///|
///├── examples/
/// ├── ...
/// └── inter/
/// ├── my_file.rs <--- expanded "src/my_file.rs"
///```
///
/// [`example`](./attr.example.html) macro can be placed on any
/// item in any file within your `src` directory, providing
/// flexibility in generating example code for/from different
/// parts of your project.
///
/// It provides two options for generating example code files:
/// - [`mod`](##mod) (default)
/// - [`main`](##main)
///
/// ## mod
/// The macro generates an example code file within the
/// `examples/inter` directory. For example:
///
///```rust no_run
///#[example(path="my_file.rs")]
///```
///
/// This is equivalent to:
///
///```rust no_run
///#[example(mod(path="my_file.rs"))]
///```
///
/// The generated example code file will be located at
/// `examples/inter/my_file.rs`.
///
/// This option provides developers with an easy way to
/// view and analyze the generated code, facilitating code
/// inspection and potential code reuse.
///
/// ## main
///
/// This option is used when specifying the `main` argument
/// in the `example` macro. It generates two files within
/// the `examples/inter` directory: the expanded code file
/// and an additional `main.rs` file.
///
///```rust no_run
///#[example(main(path="my_file.rs"))]
///```
///
/// This option is particularly useful for testing and
/// experimentation. It allows developers to quickly
/// run and interact with the generated code by executing:
///
///```terminal
///$ cargo run --example inter
///```
///
/// The expanded code file will be located at
/// `examples/inter/my_file.rs`, while the `main.rs` file
/// serves as an entry point for running the example.
///
/// ## Configuration Options
///```text
///
///#[interthread::example(
///
/// mod ✔
/// main
///
/// (
/// path = "path/to/file.rs" ❗️
///
/// expand(actor,group) ✔
/// )
/// )]
///
///
/// default: ✔
/// required: ❗️
///
///
///```
///
/// # Arguments
///
/// - [`path`](#path)
/// - [`expand`](#expand) (default)
///
/// # path
///
///
/// The `path` argument is a required parameter of the [`example`](./attr.example.html) macro.
/// It expects the path to the file that needs to be expanded.
///
/// This argument is essential as it specifies the target file
/// for code expansion.
///
/// ! One more time [`example`](./attr.example.html) macro can be
/// placed on any item in any file within your `src` directory.
///
///
/// # expand
///
/// This argument allows the user to specify which
/// `interthread` macros to expand.
///
/// By default, the value of `expand` includes
/// the [`actor`](./attr.actor.html) and
/// [`group`](./attr.group.html) macros.
///
/// For example, if you want to expand only the
/// [`actor`](./attr.actor.html) macro in generated
/// example code, you can use the following attribute:
///
/// ```rust no_run
/// #[example(path="my_file.rs",expand(actor))]
/// ```
/// This will generate an example code file that includes
/// the expanded code of the [`actor`](./attr.actor.html) macro,
/// while excluding other macros like
/// [`group`](./attr.group.html).
///
#[proc_macro_error::proc_macro_error]
#[proc_macro_attribute]
pub fn example( attr: proc_macro::TokenStream, _item: proc_macro::TokenStream ) -> proc_macro::TokenStream {
let mut eaa = model::attribute::ExampleAttributeArguments::default();
let aaa_parser =
syn::meta::parser(|meta| eaa.parse(meta));
syn::parse_macro_input!(attr with aaa_parser);
let (file, lib) = file::expand_macros(&eaa.get_path(),&eaa.expand);
let some_lib = if eaa.main { Some(lib)} else { None };
let path = show::example_show(file, &eaa.get_path(), some_lib );
let msg = format!("The file has been SUCCESSFULLY created at {}",path.to_string_lossy());
let note = "To avoid potential issues and improve maintainability, it is recommended to comment out the macro after its successful execution. To proceed, please comment out the macro and re-run the compilation.";
proc_macro_error::abort!( proc_macro2::Span::call_site(),msg; note = note);
}
/// ## Evolves a regular object into an actor
///
/// The macro is placed upon an implement block of an object
/// (`struct` or `enum`),
/// which has a public or restricted method named `new` returning `Self`.
///
/// In case if the initialization could potentially fail,
/// the method can be named `try_new`
/// and return `Option<Self>` or `Result<Self>`.
///
/// The macro will copy method signatures from all
/// public methods that do not consume the receiver, excluding
/// methods like `pub fn foo(self, val: u8) -> ()` where `self`
/// is consumed. Please ensure that the
/// receiver is defined as `&mut self` or `&self`.
///
/// If only a subset of methods is required to be
/// accessible across threads, split the `impl` block
/// into two parts. By applying the macro to a specific block,
/// the macro will only consider the methods within that block, also see options
/// [`include-exclude`](#include-exclude).
///
/// ## Configuration Options
///```text
///
///#[interthread::actor(
///
/// channel = 0 *
/// n (usize)
///
/// lib = "std" *
/// "smol"
/// "tokio"
/// "async_std"
///
/// edit(
/// script(..)
/// live(..)
/// )
///
/// file = "path/to/current/file.rs"
///
/// name = ""
///
/// show
///
/// include | exclude
///
/// debut(
/// legend
/// )
/// interact
///)]
///
///* - default
///
///
///```
///
/// # Arguments
///
///
/// - [`channel`](#channel)
/// - [`lib`](#lib)
/// - [`edit`](#edit)
/// - [`file`](#file)
/// - [`name`](#name)
/// - [`show`](#show)
/// - [`include|exclude`](#include|exclude)
/// - [`debut`](#debut)
/// - [`interact`](#interact)
///
///
///
/// # channel
///
/// The `channel` argument specifies the type of channel.
///
/// - `0` (default)
/// - [`usize`] ( buffer size)
///
/// The two macros
/// ```rust no_run
/// #[actor]
/// ```
/// and
/// ```rust no_run
/// #[actor(channel=0)]
/// ```
/// are in fact identical, both specifying same unbounded channel.
///
/// When specifying an [`usize`] value for the `channel` argument
/// in the [`actor`](./attr.actor.html) macro, such as
/// ```rust no_run
/// #[actor(channel=4)]
/// ```
/// the actor will use a bounded channel with a buffer size of 4.
/// This means that the channel can hold up to 4 messages in its
/// buffer before blocking/suspending the sender.
///
/// Using a bounded channel with a specific buffer size allows
/// for control over the memory usage and backpressure behavior
/// of the model. When the buffer is full, any further attempts
/// to send messages will block/suspend until there is available space.
/// This provides a natural form of backpressure, allowing the
/// sender to slow down or pause message production when the
/// buffer is near capacity.
///
/// # lib
///
/// The `lib` argument specifies the 'async' library to use.
///
/// - `"std"` (default)
/// - `"smol"`
/// - `"tokio"`
/// - `"async_std"`
///
///## Examples
///```rust no_run
///use interthread::actor;
///
///struct MyActor;
///
///#[actor(channel=10, lib ="tokio")]
///impl MyActor{
/// pub fn new() -> Self{Self}
///}
///#[tokio::main]
///async fn main(){
/// let my_act = MyActorLive::new();
///}
///```
///
/// # edit
///
/// The `edit` argument specifies the available editing options.
/// When using this argument, the macro expansion will
/// **exclude** the code related to `edit` options
/// allowing the user to manually implement and
/// customize those parts according to their specific needs.
///
///
/// The SDPL Model encompasses two main structs, namely `ActorScript` and `ActorLive`.
/// Within the `edit` statement, these are referenced as `script`
/// and `live` respectively.
///
/// Each struct comprises three distinct sections:
/// - `def` - definition
/// - `imp` - implementation block
/// - `trt` - implemented traits
///
/// ```rust no_run
/// edit(
/// script(
/// def, // <- script definition
/// imp(..), // <- list of methods in impl block
/// trt(..) // <- list of traits
/// ),
///
/// live(
/// def, // <- live definition
/// imp(..), // <- list of methods in impl block
/// trt(..) // <- list of traits
/// )
/// )
/// ```
///
/// So this option instructs the macro to:
///
/// - Exclude specified sections of code from the generated model.
///
/// Examples:
/// - `edit(script)`: Excludes the entire Script enum.
/// - `edit(live(imp))`: Excludes the entire implementation block of the Live struct.
/// - `edit(live(def, imp(new)))`: Excludes both the definition of the Live struct and the method 'new.'
/// - `edit(script(imp(play)), live(imp(new)))`: Excludes the 'play' method from the Script enum and the 'new' method from the Live struct.
///
/// Exclusion of code becomes necessary when the user has already
/// customized specific sections of the model.
/// To facilitate the exclusion of parts from the generated
/// model and enable printing them to the file for further
/// user customization, consider the [`file`](#file) option,
/// which works in conjunction with the `edit` option.
///
/// # file
/// This argument is designed to address proc macro file blindness. It requires
/// a string path to the current file as its value. Additionally, within the `edit` argument,
/// one can use the keyword `file` to specify which portion of the excluded code should be written
/// to the current module, providing the user with a starting point for customization.
///
///
/// ## Examples
///
/// Filename: main.rs
///
///```rust no_run
///pub struct MyActor(u8);
///
///#[interthread::actor(
/// file="src/main.rs",
/// edit(live(imp( file(increment) )))
///)]
///
///impl MyActor {
///
/// pub fn new() -> Self {Self(0)}
///
/// pub fn increment(&mut self){
/// self.0 += 1;
/// }
///}
///```
/// This is the output after saving:
///
/// ```rust no_run
///
///pub struct MyActor(u8);
///
///#[interthread::actor(
/// file="src/main.rs",
/// edit(live(imp(increment)))
///)]
///
///impl MyActor {
///
/// pub fn new() -> Self {Self(0)}
///
/// pub fn increment(&mut self){
/// self.0 += 1;
/// }
///}
///
/// //++++++++++++++++++[ Interthread Write to File ]+++++++++++++++++//
/// // Object Name : MyActor
/// // Initiated By : #[interthread::actor(file="src/main.rs",edit(live(imp(file(increment)))))]
///
///
/// impl MyActorLive {
/// pub fn increment(&mut self) {
/// let msg = MyActorScript::Increment {};
/// let _ = self
/// .sender
/// .send(msg)
/// .expect("'MyActorLive::method.send'. Channel is closed!");
/// }
/// }
///
/// // *///.............[ Interthread End of Write ].................//
///
/// ```
///
/// To specify the part of your model that should be written to
/// the file, simply enclose it within `file(..)` inside the `edit`
/// argument. Once the desired model parts are written,
/// the macro will automatically clean the `file` arguments,
/// adjusting itself to the correct state.
///
///
/// Attempting to nest `file` arguments like:
/// ```rust no_run
/// edit( file( script( file( def))))
/// ```
/// will result in an error.
///
///
/// A special case of the `edit` and `file` conjunction,
/// using `edit(file)` results in the macro being replaced with
/// the generated code on the file.
///
///
///
/// > **Note:** While it is possible to have multiple actor macros
/// within the same module, only one of the macro can have `file`
/// active arguments (`file` within `edit`) at a time.
///
///
/// # name
///
/// The `name` attribute allows developers to provide a
/// custom name for `actor`, overriding the default
/// naming conventions of the crate. This can be useful
/// when there are naming conflicts or when a specific
/// naming scheme is desired.
///
/// - "" (default): No name specified
///
/// ## Examples
///```rust no_run
///use interthread::actor;
///
///pub struct MyActor;
///
///#[actor(name="OtherActor")]
///impl MyActor {
///
/// pub fn new() -> Self {Self}
///}
///fn main () {
/// let other_act = OtherActorLive::new();
///}
///```
///
///
///
/// # show
///
/// The `show` option is particularly useful for users who are just starting to
/// work with this crate. When enabled, the model will generate doc comments
/// for every block of code it produces, containing the code produce, with the
/// exception of traits, which are simply listed.
///
/// Your text editor handles the rest.
///
/// By default, the model carries over the user's documentation comments from
/// the actor object methods.
/// Enabling `show` will add additional information, detailing the exact
/// code generated by the model.
/// Try hovering over `AaLive` and its `new` method to see the generated code.
///
/// ## Examples
///```rust no_run
///use interthread::actor;
///pub struct Aa;
///
///#[actor(show)]
///impl Aa {
/// /// This is my comment
/// /// Creates a new instance of AaLive.
/// pub fn new() -> Self { Self{} }
///
///}
///
///fn main() {
/// let bb = AaLive::new();
///}
///
///```
/// Disable `show` to avoid performance overhead and excessive code generation,
/// when the option is no longer needed.
///
///
/// # include-exclude
/// The include and exclude options are mutually exclusive filters that control
/// which methods are included in the generated model. Only one of these
/// options can be used at a time.
///
/// Usage
///
/// - include: Specifies the methods to include in the generated model.
/// - exclude: Specifies the methods to exclude from the generated model.
///
/// For a given list of actor's methods `[a, b, c, d]`:
///
/// - Using `include(a)` will generate a model that only includes the method `a`.
/// - Using `exclude(a,b)` will generate a model that includes the methods `c`, and `d`.
///
/// ```rust no_run
/// #[interthread::actor( exclude(foo,bar))]
/// ```
///
/// # debut
///
/// The generated code is designed to
/// compile successfully on Rust versions as early as 1.63.0.
///
/// When declared `debut`, the following additions and implementations
/// are generated:
///
///
/// Within the [`live`](index.html#live) struct definition, the following
/// fields are generated:
///
/// - `pub debut: std::time::SystemTime`
/// - `pub name: String`
///
/// The following traits are implemented for the [`live`](index.html#live) struct:
///
/// - `PartialEq`
/// - `PartialOrd`
/// - `Eq`
/// - `Ord`
///
/// These traits allow for equality and ordering
/// comparisons based on the `debut`value.
/// The `name` field is provided for user needs only and is not
/// taken into account when performing comparisons.
/// It serves as a descriptive attribute or label
/// associated with each instance of the live struct.
///
/// In the [`script`](index.html#script) struct implementation block, which
/// encapsulates the functionality of the model,
/// a static method named `debut` is generated. This
/// method returns the current system time and is commonly
/// used to set the `debut` field when initializing
/// instances of the [`live`](index.html#live) struct.
///
///
/// Use macro [`example`](./attr.example.html) to see the generated code.
///
///
/// ## Examples
///
///```rust no_run
///use std::thread::spawn;
///pub struct MyActor ;
///
///#[interthread::actor( debut )]
///impl MyActor {
/// pub fn new() -> Self { Self{} }
///}
///fn main() {
///
/// let actor_1 = MyActorLive::new();
///
/// let handle_2 = spawn( move || {
/// MyActorLive::new()
/// });
/// let actor_2 = handle_2.join().unwrap();
///
/// let handle_3 = spawn( move || {
/// MyActorLive::new()
/// });
/// let actor_3 = handle_3.join().unwrap();
///
/// // they are the same type objects
/// // but serving differrent threads
/// // different actors !
/// assert!(actor_1 != actor_2);
/// assert!(actor_2 != actor_3);
/// assert!(actor_3 != actor_1);
///
/// // since we know the order of invocation
/// // we correctly presume
/// assert_eq!(actor_1 > actor_2, true );
/// assert_eq!(actor_2 > actor_3, true );
/// assert_eq!(actor_3 < actor_1, true );
///
/// // but if we check the order by `debute` value
/// assert_eq!(actor_1.debut < actor_2.debut, true );
/// assert_eq!(actor_2.debut < actor_3.debut, true );
/// assert_eq!(actor_3.debut > actor_1.debut, true );
///
/// // This is because the 'debut'
/// // is a time record of initiation
/// // Charles S Chaplin (1889)
/// // Keanu Reeves (1964)
///
///
/// // we can count `live` instances for
/// // every model
/// use std::sync::Arc;
/// let mut a11 = actor_1.clone();
/// let mut a12 = actor_1.clone();
///
/// let mut a31 = actor_3.clone();
///
/// assert_eq!(Arc::strong_count(&actor_1.debut), 3 );
/// assert_eq!(Arc::strong_count(&actor_2.debut), 1 );
/// assert_eq!(Arc::strong_count(&actor_3.debut), 2 );
///
///
/// // or use getter `count`
/// assert_eq!(actor_1.inter_get_count(), 3 );
/// assert_eq!(actor_2.inter_get_count(), 1 );
/// assert_eq!(actor_3.inter_get_count(), 2 );
///
///
/// use std::time::SystemTime;
///
/// // getter `debut` to get its timestamp
/// let _debut1: SystemTime = actor_1.inter_get_debut();
///
///
/// // the name field is not taken
/// // into account when comparison is
/// // perfomed
/// assert!( a11 == a12);
/// assert!( a11 != a31);
///
/// a11.name = String::from("Alice");
/// a12.name = String::from("Bob");
///
/// a31.name = String::from("Alice");
///
/// assert_eq!(a11 == a12, true );
/// assert_eq!(a11 != a31, true );
///
/// // setter `name` accepts any ToString
/// a11.inter_set_name('t');
/// a12.inter_set_name(84u32);
/// a31.inter_set_name(3.14159);
///
/// // getter `name`
/// assert_eq!(a11.inter_get_name(), "t" );
/// assert_eq!(a12.inter_get_name(), "84" );
/// assert_eq!(a31.inter_get_name(), "3.14159" );
///
///}
///```
///
///
///
///
/// Using `debut` will generate fore additional
///methods in `live` implement block:
///
/// 1. `inter_set_name(s: ToString)`: Sets the value of the
/// name field.
/// 2. `inter_get_name() -> &str`: Retrieves the value of the
/// name field.
/// 3. `inter_get_debut() -> std::time::SystemTime`: Retrieves
/// the value of the debut field, which represents a timestamp.
/// 4. `inter_get_count() -> usize`: Provides the strong
/// reference count for the debut field.
///
/// > **Note:** Additional generated methods prefixed with `inter`
/// will have the same visibility as the initiating
/// method `new` or `try_new`.
///
///This convention allows
///- easy identification in text editor methods that
///solely manipulate the internal state of the live struct and/or
///methods that are added by the `interthread` macros
///- it mitigates the risk of potential naming conflicts in case if there
///is or will be a custom method `get_name`
///- helps the macro identify methods that are intended
///to be used within its context (see [`interact`](#interact))
///
///
/// While `debut` can be declared as a standalone option,
/// it can also be enhanced by adding the `legend` sub-option.
/// This sub-option introduces extra `inter` methods,
/// enabling the model to be saved on the heap upon the
/// last instance being dropped.
///
/// > **Note:** Unfortunately, while we've established a
/// consistent `inter` prefix method convention, the
/// `legend` functionality introduces an exception.
/// To maintain a coherent and orderly pattern `try_new` -> `try_old`
///
///
///# Examples
///
///```rust no_run
/// pub struct MyActor(u8);
///
///
///#[interthread::actor( debut(legend) )]
///impl MyActor {
///
/// pub fn new() -> Self { Self(0) }
///
/// pub fn set(&mut self, v: u8){
/// self.0 = v;
/// }
///
/// pub fn get_value(&self) -> u8 {
/// self.0
/// }
///}
///
///
///fn main() {
///
/// let h = std::thread::spawn( || {
/// let mut act = MyActorLive::new();
/// act.inter_set_name("Zombie");
/// act.set(121);
/// });
///
/// let _ = h.join();
///
/// let old_act = MyActorLive::try_old("Zombie").unwrap();
///
/// assert_eq!("Zombie".to_string(), old_act.inter_get_name());
/// assert_eq!(121u8, old_act.get_value());
///}
///
///```
/// When the thread scope ends, objects are dropped. Simply using
/// `drop(..)` won't suffice. To conclude the thread scope correctly,
/// use `join()`. Then, you can call `try_old` on the live struct
/// to reinitialize the old model.
///
/// # interact
///
/// The `interact` option is designed to provide the model with
/// comprehensive non-blocking functionality, along with convenient
/// internal getter calls to access the state of the `live` instance via
/// so called `inter variables` in actor methods.
///
/// ### Rules and Definitions
///
/// 1. The interact variables should be prefixed with `inter_`.
/// 2. Special interact variables are `inter_send` and `inter_recv`.
/// 3. Declaring an `inter_variable_name : Type`, within actor method
/// arguments implies that the `live` instance has a method
/// `fn inter_get_variable_name(&self) -> Type` which takes no arguments
/// and returns the `Type`. Exceptions to this rule apply for special
/// interact variables.
/// 4. If the actor method returns a type, accessing special interact variables
/// is not allowed.
/// 5. Only one end of special interact variables can be accessed at a time.
///
///
///
/// The primary purpose of `interact` is to leverage its oneshot `inter_send`
/// and `inter_recv` ends. This allows for
/// a form of non-blocking behavior: one end of the channel will be directly
/// sent into the respective method, while the other end will be returned
/// from the live instance method.
///
///
/// ## Examples
/// ```rust no_run
///
///pub struct MyActor;
///
///// opt `interact`
///#[interthread::actor( interact )]
///impl MyActor {
///
/// pub fn new() -> Self { Self{} }
///
/// // oneshot channel can be accessed
/// // in methods that do not return
/// pub fn heavy_work(&self, inter_send: oneshot::Sender<u8>){
///
/// std::thread::spawn(move||{
/// // do some havy computation
/// let _ = inter_send.send(5);
/// });
/// }
///}
///
///fn main () {
///
/// let actor = MyActorLive::new();
///
/// // the signature is different
/// let recv: oneshot::Receiver<u8> = actor.heavy_work();
/// let int = recv.recv().unwrap();
///
/// assert_eq!(5u8, int);
///}
///
/// ```
///
/// While a method that does not return a type (see original `heavy_work`)
/// typically does not require a oneshot channel, the
/// model will accommodate the user's request by instantiating
/// a channel pair.
///
///```rust no_run
///
///pub fn heavy_work(&self) -> oneshot::Receiver<u8> {
/// let (inter_send, inter_recv) = oneshot::channel::<u8>();
/// let msg = MyActorScript::HeavyWork {
/// input: (inter_send),
/// };
/// let _ = self
/// .sender
/// .send(msg)
/// .expect("'MyActorLive::method.send'. Channel is closed!");
/// inter_recv
///}
///```
///
///
/// Also `interact` will detect interact variables in actor methods
/// and subsequently call required getters within respective
/// method of the `live` instance.
///
/// ## Examples
/// ```rust no_run
/// pub struct MyActor(String);
///
/// #[interthread::actor(debut, interact )]
/// impl MyActor {
///
/// pub fn new() -> Self { Self("".to_string()) }
///
/// // We know there is a getter `inter_get_name`
/// // Using argument `inter_name` we imply
/// // we want the return type of that getter
/// pub fn set_value(&mut self, inter_name: String){
/// self.0 = inter_name;
/// }
/// pub fn get_value(&self) -> String {
/// self.0.clone()
/// }
/// }
///
/// fn main () {
///
/// let mut actor = MyActorLive::new();
///
/// // Setting name for `live` instance
/// actor.inter_set_name("cloud");
///
/// // Setting actor's value now
/// // Note the signature, it's not the same
/// actor.set_value();
///
/// assert_eq!("cloud".to_string(), actor.get_value());
/// }
/// ```
///
///
/// Here is how `live` instance method `set_value` will look like:
///
///
/// ```rust no_run
///
/// pub fn set_value(&mut self) {
/// let inter_name = self.inter_get_name();
/// let msg = MyActorScript::SetValue {
/// input: inter_name,
/// };
/// let _ = self
/// .sender
/// .send(msg)
/// .expect("'MyActorLive::method.send'. Channel is closed!");
/// }
///
/// ```
///
///
/// The signature has changed; it no longer takes arguments, as the
/// getter call is happening inside providing the required type.
/// It will work for any custom getter as long as it adheres to rule 3.
///
///
///
///
///
#[proc_macro_error::proc_macro_error]
#[proc_macro_attribute]
pub fn actor( attr: proc_macro::TokenStream, item: proc_macro::TokenStream ) -> proc_macro::TokenStream {
let item_impl = syn::parse_macro_input!(item as syn::ItemImpl);
let mut aaa = model::attribute::ActorAttributeArguments::default();
let nested = syn::parse_macro_input!(attr with syn::punctuated::Punctuated::<syn::Meta,syn::Token![,]>::parse_terminated);
aaa.parse_nested(nested);
aaa.cross_check();
check::channels_import( &aaa.lib );
let edit_attr = aaa.edit.attr.clone();
let aa = crate::model::AttributeArguments::Actor(aaa);
let model_sdpl = crate::model::generate_model( aa,&item_impl,None);
let (_,edit_sdpl) = model_sdpl.split();
if let Some( edit_attr ) = edit_attr {
parse::edit_write( &edit_attr, &item_impl, edit_sdpl);
}
let (code,_) = model_sdpl.get_code_edit();
quote::quote!{
#item_impl
#code
}.into()
}
/// ## A set of actors sharing a single thread
///
/// In the realm of concurrent programming, creating a separate thread
/// for each individual actor can sometimes incur a significant overhead.
/// In such scenarios, developers may opt to populate an `actor`'s
/// definition with complex encapsulations (potential actors),
/// effectively creating a collection of objects running within
/// a single thread. While this approach proves resource-efficient,
/// it does come with a trade-off: accessing the methods of field
/// types must be explicitly written within the main `actor`
/// implementation block.
///
/// This is where the `group` macro comes into play. A `group` is a
/// set of `actors` that share a single thread, consisting of
/// a `main-actor` and `group-actors` contained within the
/// `main-actor`'s fields. Developers can now bypass the need to rewrite
/// method wrappers, gaining direct access to `group-actor` methods via
/// dot notation, as seamlessly as if these `group-actors` were `actors`
/// in their own right.
///
/// In this scenario, the methods of the `main-actor` take on the responsibility
/// for interaction within and between `group-actors`, while the latter primarily
/// serve to export their functionality.
///
/// Before delving into further details, let's explore an example of a `group`.
/// Assuming there is a good understanding of how an `actor` operates, once the
/// `Live` instance is returned after invoking the `new` method, the `actor` is
/// already running in a separate thread. Therefore, there’s no need to
/// complicate the example with extra thread spawning just for visual clarity.
///
///
/// ## Examples
///
///```rust no_run
///
///// We have `Aa` and `Bb`
///pub struct Aa(u8);
///impl Aa {
/// pub fn add(&mut self, v: u8){
/// self.0 += v;
/// }
///}
///
///pub struct Bb(u8);
///impl Bb {
/// pub fn add(&mut self, v: u8){
/// self.0 += v;
/// }
///}
///
///// Definition of group
///pub struct AaBb {
/// pub a: Aa,
/// pub b: Bb,
///}
///
///#[interthread::group( file= "path/to/file.rs")]
///impl AaBb {
///
/// pub fn new( ) -> Self {
/// let a = Aa(0);
/// let b = Bb(0);
/// Self{ a,b}
/// }
///
/// pub fn add(&mut self, v:u8){
/// self.a.0 += v;
/// self.b.0 += v;
/// }
///
/// pub fn get_value(&mut self) -> (u8,u8) {
/// (self.a.0,self.b.0)
/// }
///}
///
///
///pub fn main(){
///
/// let mut group = AaBbGroupLive::new();
///
/// // access to group method
/// group.add(1);
/// assert_eq!((1,1),group.get_value());
///
/// // access to field `a` method
/// group.a.add(10);
/// assert_eq!((11,1),group.get_value());
///
/// // access to field `b` method
/// group.b.add(100);
/// assert_eq!((11,101),group.get_value());
///}
///
///```
///
/// Behind the scenes, the macro will generate some additional types
/// very similar to `actor`'s types, for `group-actor`
/// `NameScriptGroup` and `NameLiveGroup`:
///
///- `Aa` - `AaScriptGroup`, `AaLiveGroup`
///- `Bb` - `BbScriptGroup`, `BbLiveGroup`
///
/// For `main-actor` itself: `NameGroupScript` and `NameGroupLive`:
///- `AaBb` - `AaBbGroupScript`, `AaBbGroupLive`
///
/// In the context of the `SDPL` framework, `group-actors` are designated as `SDL`
/// (Script, Direct, Live) and will share the `play` method with the `main-actor`,
/// which is full `SDPL`.
/// The following is a type schema of the `group` model in relation
/// to the above example:
///
/// ```rust no_run
///
/// struct Aa;
/// struct Bb;
///
/// enum AaScriptGroup;
/// struct AaLiveGroup;
///
/// enum BbScriptGroup;
/// struct BbLiveGroup;
///
/// struct AaBb {
/// pub a: Aa,
/// pub b: Bb,
/// }
///
/// enum AaBbGroupScript;
/// struct AaBbGroupLive {
/// pub a: AaLiveGroup,
/// pub b: BbLiveGroup,
/// }
///
/// ```
///
/// To view all the generated code by `group`, you can either utilize
/// the [`example`](attr.example.html) macro or employ the
/// [`edit`](attr.actor.html#edit) option within the `group` macro.
/// For a convenient shortcut to see the full example using `edit`,
/// simply use `edit(file)`."
///
/// ```rust no_run
/// #[interthread::group( file="path/to/file.rs",edit(file))]
/// ```
/// To inspect the generated code for field `a` type from the
/// above example, utilize the [`edit`](attr.actor.html#edit)
/// option as `edit(a::edit(file))`, for struct `AaBb` itself
/// use `edit(self::edit(file))`.
///
/// ## Requirements for Using the `group` Macro
///
/// Much like individual actors, the `group` macro enables a
/// set of actors to run collectively within a shared thread.
/// While many requirements align with those of individual actors,
/// there are some distinctions to be aware of. Below are the
/// crucial conditions that need to be satisfied for the `group`
/// macro to operate :
///
///- The object must be a struct with named fields.
///- As an `actor` impl block must contain a method named `new`
/// returning a self-instance or `try_new` if it may fail to return.
///- The macro requires a `file` field with a file path to the
/// current file at all times.
///- Fields in the definition block that are intended to act as
/// `group-actor`s should have non-private visibility (public or restricted).
/// Private fields will not be considered as `group-actors` by the macro.
///
///
/// ## Configuration Options
/// The configuration options for a `group` are slightly different,
/// but consist of the same arguments as those used for an `actor`
/// except couple of them.
/// In some cases (see notation `(AA)` in the table below),
/// the argument is a list of the same arguments, specified as
/// `argument(field_name::argument,..)`.
/// In context of the example code from above, if we wanted to
/// include any hypothetical static (associated) methods of struct `Aa`,
/// we would use the `show` argument, like so:
/// ```rust
/// show(a::show)
/// ```
/// To include the same argument for `main-actor` itself, we would write
/// ```rust
/// show(a::show, self::show)
/// ```
///
/// The following is the full table of configuration options:
///
/// ```text
///
/// #[interthread::group(
///
/// AA channel = 0 *
/// n (usize)
///
/// AA lib = "std" *
/// "smol"
/// "tokio"
/// "async_std"
///
/// AA file = "path/to/current/file.rs"
///
/// AA debut(
/// legend
/// )
///
/// AA skip(
/// field_name
/// ..
/// )
///
/// (AA) show(
/// self::show,
/// ..
/// )
///
/// (AA) include(
/// self::include(
/// method_name,
/// ..
/// ),
/// ..
/// )
///
/// (AA) exclude(
/// self::exclude(
/// method_name,
/// ..
/// ),
/// ..
/// )
///
/// (AA) edit(
/// self::edit(
/// script(..)
/// live(..)
/// ),
/// ..
/// )
///
/// (AA) name(
/// self::name = "",
/// ..
/// )
///
/// (AA) path(
/// a::path = "path/to/type.rs",
/// ..
/// )
/// )
/// ]
///
/// * - default
/// AA - similar to `actor` attribute argument.
/// (AA) - a list of similar to `actor` attribute arguments.
///
/// ```
/// All `group` configuration options (arguments) are the same as `actor`'s arguments,
/// except for `path` and `skip`, which are unique to `group`.
/// # Arguments
///
/// - [`channel`](attr.actor.html#channel)
/// - [`lib`](attr.actor.html#lib)
/// - [`edit`](attr.actor.html#edit)
/// - [`file`](attr.actor.html#file)
/// - [`name`](attr.actor.html#name)
/// - [`show`](attr.actor.html#show)
/// - [`include|exclude`](attr.actor.html#include|exclude)
/// - [`debut`](attr.actor.html#debut)
/// - [`path`](#path)
/// - [`skip`](#skip)
/// # `path`
/// Argument `path` is used when a `group-actor` is defined in a file different from the `group` itself.
/// # `skip`
/// Argument `skip` is used when a non-private field of the `group` is necessary but should not be included
/// as a `group-actor`.
///
///
///
/// # Handling Identical Types in the `group` Model
///
/// In certain situations, the `group` model may encounter a scenario where the `main-actor`
/// possesses multiple fields of the same type. Let's consider an example:
///
/// ```rust
/// struct AaBb {
/// pub a: Aa,
/// pub a1: Aa,
/// pub b: Bb,
/// }
/// ```
///
/// Due to the model naming convention which is based on type names, both fields `a` and `a1` generate
/// identical model names for both the `Script` and `Live` components. This leads to a
/// compilation error:
///
/// ```text
/// the name `AaScriptGroup` is defined multiple times
/// `AaScriptGroup` must be defined only once in the type namespace of this module
/// ```
///
/// To resolve this scenario, adjust the names for identical types as follows:
///
///```rust no_run
/// struct AaBb {
/// pub a: Aa,
/// pub a1: Aa,
/// pub b: Bb,
/// }
///
/// // Usage of the macro may be as follows:
///
/// #[interthread::group(
/// file="path/to/file.rs",
/// name( a1::name="Aa1" )
/// )]
/// impl AaBb {
/// // ...
/// }
///
/// ```
///
///
///
#[proc_macro_error::proc_macro_error]
#[proc_macro_attribute]
pub fn group( attr: proc_macro::TokenStream, item: proc_macro::TokenStream ) -> proc_macro::TokenStream {
let item_impl = syn::parse_macro_input!(item as syn::ItemImpl);
let mut gaa = model::attribute::GroupAttributeArguments::default();
let nested = syn::parse_macro_input!(attr with syn::punctuated::Punctuated::<syn::Meta,syn::Token![,]>::parse_terminated);
gaa.parse_nested(nested);
gaa.cross_check(&item_impl);
check::channels_import( &gaa.lib );
let edit_attr = gaa.edit.attr.clone();
let aa = crate::model::AttributeArguments::Group(gaa);
let model_sdpl = crate::model::generate_model( aa,&item_impl,None);
let (_,edit_sdpl) = model_sdpl.split();
if let Some( edit_attr ) = edit_attr {
parse::edit_write( &edit_attr, &item_impl, edit_sdpl);
}
let (code,_) = model_sdpl.get_code_edit();
quote::quote!{
#item_impl
#code
}.into()
}