Merge pull request #280 from AneesHl/main

fixed various minor errors

Author: lhstrh

docs/assets/code/rs/src/SlowingClock.lf

@@ -4,7 +4,7 @@ main reactor SlowingClock(start: time = 100 ms, incr: time = 100 ms) {
   state start = start
   state incr = incr
   state interval: time = start
-  state expected_time: time()
+  state expected_time: time
   logical action a
 
   reaction(startup) -> a {=

docs/reference/target-declaration.mdx

@@ -599,7 +599,7 @@ This parameter takes a non-negative integer and specifies the number of worker t
 </ShowIf>
 </ShowIfs>
 
-# Command-Line Arguments
+## Command-Line Arguments
 
 <ShowIfs>
 <ShowIf ts >

docs/reference/target-language-details.mdx

@@ -148,7 +148,7 @@ You can use a development version of the runtime library by setting the LFC opti
 <ShowIfs>
 <ShowIf c>
 
-- The C target does make any distinction between `private` and `public` `preamble`.
+- The C target does not make any distinction between `private` and `public` `preamble`.
 
 </ShowIf>
 <ShowIf cpp>

docs/writing-reactors/a-first-reactor.mdx

@@ -94,13 +94,14 @@ The general structure of a reactor definition is as follows:
         timer <name>([<offset>[, <period>]])
         logical action <name>[: <type>]
         physical action <name>[: <type>]
+        [const] method <name>(parameters):<type> {= ... body ...=}
         reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
         <instance-name> = new <class-name>([<parameter-assignments>])
         <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
     }
     ```
   </ShowIf>
-  <ShowIf cpp rs>
+  <ShowIf cpp>
     ```lf
     [main] reactor <class-name> [(parameters)] {
         input <name>: <type>
@@ -116,6 +117,21 @@ The general structure of a reactor definition is as follows:
     }
     ```
   </ShowIf>
+  <ShowIf rs>
+    ```lf
+    [main] reactor <class-name> [(parameters)] {
+        input <name>: <type>
+        output <name>: <type>
+        state <name>: <type> [= <value>]
+        timer <name>([<offset>[, <period>]])
+        logical action <name>[: <type>]
+        physical action <name>[: <type>]
+        reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
+        <instance-name> = new <class-name>([<parameter-assignments>])
+        <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
+    }
+    ```
+  </ShowIf>
   <ShowIf py>
     ```lf
     [main or federated] reactor <class-name> [(parameters)] {

docs/writing-reactors/multiports-and-banks.mdx

@@ -65,8 +65,10 @@ In `Destination`, the reaction is triggered by `in`, not by some individual chan
   c="if (in[i]->is_present) ..." 
   cpp="if (in[i]->is_present()) ..."
   py="if port.is_present: ..."
-  rs="if (val) ..."
-  ts="if let Some(v) = ctx.get(&i) ..."
+  ts="if (val) ..."
+  rs="if let Some(v) = ctx.get(&i) ... 
+  // Or using is_present() 
+  if ctx.is_present(&inp[0]) ..."
 />
 :::
 

docs/writing-reactors/reaction-declarations.mdx

@@ -88,7 +88,7 @@ directory.
 ## The Generated Header Files
 
 The generated header files are necessary in order to separate your C code from your LF code because
-the describe the signatures of the reaction functions that you must implement.
+they describe the signatures of the reaction functions that you must implement.
 
 In addition, they define structs that will be referenced by the reaction bodies. This includes the
 `self` struct of the reactor to which the header file corresponds, as well as structs for its ports,

docs/writing-reactors/time-and-timers.mdx

@@ -15,7 +15,7 @@ import {
 
 A key property of Lingua Franca is **logical time**. All events occur at an instant in logical time. By default, the runtime system does its best to align logical time with **physical time**, which is some measurement of time on the execution platform. The **lag** is defined to be physical time minus logical time, and the goal of the runtime system is maintain a small non-negative lag.
 
-The **lag** is allowed to go negative only if the [`fast` target property](<../introduction.md#fast>) or the [`--fast`](<../introduction.md#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
+The **lag** is allowed to go negative only if the [`fast`](<../reference/target-declaration#fast>) target property or the [`--fast`](<../reference/target-declaration#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
 
 <ShowOnly c cpp rs>
 
@@ -93,8 +93,8 @@ import TS_Timer from '../assets/code/ts/src/Timer.lf';
 This specifies a timer named `t` that will first trigger at the start of execution and then repeatedly trigger at intervals of one second. Notice that the time units can be left off if the value is zero.
 
 This target provides a built-in function for retrieving the logical time at which the reaction is invoked, 
-<ShowOnly c inline>`get_logical_time()`</ShowOnly>
-<ShowOnly cpp inline>`FIXME`</ShowOnly>
+<ShowOnly c inline>`lf_time_logical()`</ShowOnly>
+<ShowOnly cpp inline>`get_logical_time()`</ShowOnly>
 <ShowOnly py inline>`lf.time.logical()`</ShowOnly>
 <ShowOnly ts inline>`util.getCurrentLogicalTime()`</ShowOnly>
 <ShowOnly rs inline>`get_logical_time()`</ShowOnly>

versioned_docs/version-0.5.0/assets/code/rs/src/SlowingClock.lf

@@ -4,7 +4,7 @@ main reactor SlowingClock(start: time = 100 ms, incr: time = 100 ms) {
   state start = start
   state incr = incr
   state interval: time = start
-  state expected_time: time()
+  state expected_time: time
   logical action a
 
   reaction(startup) -> a {=

versioned_docs/version-0.5.0/reference/target-declaration.mdx

@@ -684,7 +684,7 @@ This parameter takes a non-negative integer and specifies the number of worker t
 </ShowIf>
 </ShowIfs>
 
-# Command-Line Arguments
+## Command-Line Arguments
 
 <ShowIfs>
 <ShowIf ts >

versioned_docs/version-0.5.0/reference/target-language-details.mdx

@@ -148,7 +148,7 @@ You can use a development version of the runtime library by setting the LFC opti
 <ShowIfs>
 <ShowIf c>
 
-- The C target does make any distinction between `private` and `public` `preamble`.
+- The C target does not make any distinction between `private` and `public` `preamble`.
 
 </ShowIf>
 <ShowIf cpp>

versioned_docs/version-0.5.0/writing-reactors/a-first-reactor.mdx

@@ -94,13 +94,14 @@ The general structure of a reactor definition is as follows:
         timer <name>([<offset>[, <period>]])
         logical action <name>[: <type>]
         physical action <name>[: <type>]
+        [const] method <name>(parameters):<type> {= ... body ...=}
         reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
         <instance-name> = new <class-name>([<parameter-assignments>])
         <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
     }
     ```
   </ShowIf>
-  <ShowIf cpp rs>
+  <ShowIf cpp>
     ```lf
     [main] reactor <class-name> [(parameters)] {
         input <name>: <type>
@@ -116,6 +117,21 @@ The general structure of a reactor definition is as follows:
     }
     ```
   </ShowIf>
+  <ShowIf rs>
+    ```lf
+    [main] reactor <class-name> [(parameters)] {
+        input <name>: <type>
+        output <name>: <type>
+        state <name>: <type> [= <value>]
+        timer <name>([<offset>[, <period>]])
+        logical action <name>[: <type>]
+        physical action <name>[: <type>]
+        reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
+        <instance-name> = new <class-name>([<parameter-assignments>])
+        <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
+    }
+    ```
+  </ShowIf>
   <ShowIf py>
     ```lf
     [main or federated] reactor <class-name> [(parameters)] {

versioned_docs/version-0.5.0/writing-reactors/multiports-and-banks.mdx

@@ -65,8 +65,10 @@ In `Destination`, the reaction is triggered by `in`, not by some individual chan
   c="if (in[i]->is_present) ..." 
   cpp="if (in[i]->is_present()) ..."
   py="if port.is_present: ..."
-  rs="if (val) ..."
-  ts="if let Some(v) = ctx.get(&i) ..."
+  ts="if (val) ..."
+  rs="if let Some(v) = ctx.get(&i) ... 
+  // Or using is_present() 
+  if ctx.is_present(&inp[0]) ..."
 />
 :::
 

versioned_docs/version-0.5.0/writing-reactors/reaction-declarations.mdx

@@ -88,7 +88,7 @@ directory.
 ## The Generated Header Files
 
 The generated header files are necessary in order to separate your C code from your LF code because
-the describe the signatures of the reaction functions that you must implement.
+they describe the signatures of the reaction functions that you must implement.
 
 In addition, they define structs that will be referenced by the reaction bodies. This includes the
 `self` struct of the reactor to which the header file corresponds, as well as structs for its ports,

versioned_docs/version-0.5.0/writing-reactors/time-and-timers.mdx

@@ -15,7 +15,7 @@ import {
 
 A key property of Lingua Franca is **logical time**. All events occur at an instant in logical time. By default, the runtime system does its best to align logical time with **physical time**, which is some measurement of time on the execution platform. The **lag** is defined to be physical time minus logical time, and the goal of the runtime system is maintain a small non-negative lag.
 
-The **lag** is allowed to go negative only if the [`fast` target property](<../introduction.md#fast>) or the [`--fast`](<../introduction.md#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
+The **lag** is allowed to go negative only if the [`fast`](<../reference/target-declaration#fast>) target property or the [`--fast`](<../reference/target-declaration#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
 
 <ShowOnly c cpp rs>
 
@@ -93,8 +93,8 @@ import TS_Timer from '../assets/code/ts/src/Timer.lf';
 This specifies a timer named `t` that will first trigger at the start of execution and then repeatedly trigger at intervals of one second. Notice that the time units can be left off if the value is zero.
 
 This target provides a built-in function for retrieving the logical time at which the reaction is invoked, 
-<ShowOnly c inline>`get_logical_time()`</ShowOnly>
-<ShowOnly cpp inline>`FIXME`</ShowOnly>
+<ShowOnly c inline>`lf_time_logical()`</ShowOnly>
+<ShowOnly cpp inline>`get_logical_time()`</ShowOnly>
 <ShowOnly py inline>`lf.time.logical()`</ShowOnly>
 <ShowOnly ts inline>`util.getCurrentLogicalTime()`</ShowOnly>
 <ShowOnly rs inline>`get_logical_time()`</ShowOnly>

versioned_docs/version-0.6.0/assets/code/rs/src/SlowingClock.lf

@@ -4,7 +4,7 @@ main reactor SlowingClock(start: time = 100 ms, incr: time = 100 ms) {
   state start = start
   state incr = incr
   state interval: time = start
-  state expected_time: time()
+  state expected_time: time
   logical action a
 
   reaction(startup) -> a {=

versioned_docs/version-0.6.0/reference/target-declaration.mdx

@@ -625,7 +625,7 @@ This parameter takes a non-negative integer and specifies the number of worker t
 </ShowIf>
 </ShowIfs>
 
-# Command-Line Arguments
+## Command-Line Arguments
 
 <ShowIfs>
 <ShowIf ts >

versioned_docs/version-0.6.0/reference/target-language-details.mdx

@@ -148,7 +148,7 @@ You can use a development version of the runtime library by setting the LFC opti
 <ShowIfs>
 <ShowIf c>
 
-- The C target does make any distinction between `private` and `public` `preamble`.
+- The C target does not make any distinction between `private` and `public` `preamble`.
 
 </ShowIf>
 <ShowIf cpp>

versioned_docs/version-0.6.0/writing-reactors/a-first-reactor.mdx

@@ -94,13 +94,14 @@ The general structure of a reactor definition is as follows:
         timer <name>([<offset>[, <period>]])
         logical action <name>[: <type>]
         physical action <name>[: <type>]
+        [const] method <name>(parameters):<type> {= ... body ...=}
         reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
         <instance-name> = new <class-name>([<parameter-assignments>])
         <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
     }
     ```
   </ShowIf>
-  <ShowIf cpp rs>
+  <ShowIf cpp>
     ```lf
     [main] reactor <class-name> [(parameters)] {
         input <name>: <type>
@@ -116,6 +117,21 @@ The general structure of a reactor definition is as follows:
     }
     ```
   </ShowIf>
+  <ShowIf rs>
+    ```lf
+    [main] reactor <class-name> [(parameters)] {
+        input <name>: <type>
+        output <name>: <type>
+        state <name>: <type> [= <value>]
+        timer <name>([<offset>[, <period>]])
+        logical action <name>[: <type>]
+        physical action <name>[: <type>]
+        reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
+        <instance-name> = new <class-name>([<parameter-assignments>])
+        <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
+    }
+    ```
+  </ShowIf>
   <ShowIf py>
     ```lf
     [main or federated] reactor <class-name> [(parameters)] {

versioned_docs/version-0.6.0/writing-reactors/multiports-and-banks.mdx

@@ -65,8 +65,10 @@ In `Destination`, the reaction is triggered by `in`, not by some individual chan
   c="if (in[i]->is_present) ..." 
   cpp="if (in[i]->is_present()) ..."
   py="if port.is_present: ..."
-  rs="if (val) ..."
-  ts="if let Some(v) = ctx.get(&i) ..."
+  ts="if (val) ..."
+  rs="if let Some(v) = ctx.get(&i) ... 
+  // Or using is_present() 
+  if ctx.is_present(&inp[0]) ..."
 />
 :::
 

versioned_docs/version-0.6.0/writing-reactors/reaction-declarations.mdx

@@ -88,7 +88,7 @@ directory.
 ## The Generated Header Files
 
 The generated header files are necessary in order to separate your C code from your LF code because
-the describe the signatures of the reaction functions that you must implement.
+they describe the signatures of the reaction functions that you must implement.
 
 In addition, they define structs that will be referenced by the reaction bodies. This includes the
 `self` struct of the reactor to which the header file corresponds, as well as structs for its ports,

versioned_docs/version-0.6.0/writing-reactors/time-and-timers.mdx

@@ -15,7 +15,7 @@ import {
 
 A key property of Lingua Franca is **logical time**. All events occur at an instant in logical time. By default, the runtime system does its best to align logical time with **physical time**, which is some measurement of time on the execution platform. The **lag** is defined to be physical time minus logical time, and the goal of the runtime system is maintain a small non-negative lag.
 
-The **lag** is allowed to go negative only if the [`fast` target property](<../introduction.md#fast>) or the [`--fast`](<../introduction.md#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
+The **lag** is allowed to go negative only if the [`fast`](<../reference/target-declaration#fast>) target property or the [`--fast`](<../reference/target-declaration#command-line-arguments>) command-line argument is set to `true`. In that case, the program will execute as fast as possible with no regard to physical time.
 
 <ShowOnly c cpp rs>
 
@@ -93,8 +93,8 @@ import TS_Timer from '../assets/code/ts/src/Timer.lf';
 This specifies a timer named `t` that will first trigger at the start of execution and then repeatedly trigger at intervals of one second. Notice that the time units can be left off if the value is zero.
 
 This target provides a built-in function for retrieving the logical time at which the reaction is invoked, 
-<ShowOnly c inline>`get_logical_time()`</ShowOnly>
-<ShowOnly cpp inline>`FIXME`</ShowOnly>
+<ShowOnly c inline>`lf_time_logical()`</ShowOnly>
+<ShowOnly cpp inline>`get_logical_time()`</ShowOnly>
 <ShowOnly py inline>`lf.time.logical()`</ShowOnly>
 <ShowOnly ts inline>`util.getCurrentLogicalTime()`</ShowOnly>
 <ShowOnly rs inline>`get_logical_time()`</ShowOnly>

versioned_docs/version-0.7.0/assets/code/rs/src/SlowingClock.lf

@@ -4,7 +4,7 @@ main reactor SlowingClock(start: time = 100 ms, incr: time = 100 ms) {
   state start = start
   state incr = incr
   state interval: time = start
-  state expected_time: time()
+  state expected_time: time
   logical action a
 
   reaction(startup) -> a {=

versioned_docs/version-0.7.0/reference/target-declaration.mdx

@@ -599,7 +599,7 @@ This parameter takes a non-negative integer and specifies the number of worker t
 </ShowIf>
 </ShowIfs>
 
-# Command-Line Arguments
+## Command-Line Arguments
 
 <ShowIfs>
 <ShowIf ts >

versioned_docs/version-0.7.0/reference/target-language-details.mdx

@@ -148,7 +148,7 @@ You can use a development version of the runtime library by setting the LFC opti
 <ShowIfs>
 <ShowIf c>
 
-- The C target does make any distinction between `private` and `public` `preamble`.
+- The C target does not make any distinction between `private` and `public` `preamble`.
 
 </ShowIf>
 <ShowIf cpp>

versioned_docs/version-0.7.0/writing-reactors/a-first-reactor.mdx

@@ -94,13 +94,14 @@ The general structure of a reactor definition is as follows:
         timer <name>([<offset>[, <period>]])
         logical action <name>[: <type>]
         physical action <name>[: <type>]
+        [const] method <name>(parameters):<type> {= ... body ...=}
         reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
         <instance-name> = new <class-name>([<parameter-assignments>])
         <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
     }
     ```
   </ShowIf>
-  <ShowIf cpp rs>
+  <ShowIf cpp>
     ```lf
     [main] reactor <class-name> [(parameters)] {
         input <name>: <type>
@@ -116,6 +117,21 @@ The general structure of a reactor definition is as follows:
     }
     ```
   </ShowIf>
+  <ShowIf rs>
+    ```lf
+    [main] reactor <class-name> [(parameters)] {
+        input <name>: <type>
+        output <name>: <type>
+        state <name>: <type> [= <value>]
+        timer <name>([<offset>[, <period>]])
+        logical action <name>[: <type>]
+        physical action <name>[: <type>]
+        reaction [<name>] (triggers) [<uses>] [-> <effects>] [{= ... body ...=}]
+        <instance-name> = new <class-name>([<parameter-assignments>])
+        <port-name> [, ...] -> <port-name> [, ...] [after <delay>]
+    }
+    ```
+  </ShowIf>
   <ShowIf py>
     ```lf
     [main or federated] reactor <class-name> [(parameters)] {

versioned_docs/version-0.7.0/writing-reactors/multiports-and-banks.mdx

@@ -65,8 +65,10 @@ In `Destination`, the reaction is triggered by `in`, not by some individual chan
   c="if (in[i]->is_present) ..." 
   cpp="if (in[i]->is_present()) ..."
   py="if port.is_present: ..."
-  rs="if (val) ..."
-  ts="if let Some(v) = ctx.get(&i) ..."
+  ts="if (val) ..."
+  rs="if let Some(v) = ctx.get(&i) ... 
+  // Or using is_present() 
+  if ctx.is_present(&inp[0]) ..."
 />
 :::