merge loop to main for v0.11

Author: deepaksharmaongraph

.readthedocs.yaml

@@ -0,0 +1,36 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# Explicitly set the version of Python and its requirements
+python:
+  install:
+    - requirements: docs/requirements.txt

Cargo.lock

@@ -1,66 +1,75 @@
 
-# Frame Language Transpiler v0.10.0
+# Frame Language Transpiler v0.11.0
 
+This project contains the code for building the Frame Language Transpiler - the **Framepiler**.  The Framepiler is written in Rust and transpiles Frame specification documents into Python (more languages to come) as well as
+UML diagrams.
 
-Frame is a language for designing systems. It is easy to learn and can generate both UML documentation as well as code in 8 programming languages:
+## Frame Language Documentation
 
-* C++
-* C#
-* GDScript
-* Go
-* Java
-* JavaScript
-* Python
-* Rust
+To learn more about the Frame language, please find Frame's official documentation on [Read the Docs](https://docs.frame-lang.org).
 
+## New in Recent Releases
 
-## Purpose
+For details, see the [Release Notes](https://github.com/frame-lang/frame_transpiler/releases).
 
-This project contains the code for building the Frame Language Transpiler - the Framepiler.  The Framepiler is written in Rust and transpiles Frame specification documents into 8 programming languages (more to come) and UML documentation.
+### Frame v0.11.0
 
+Frame v0.11.0 brings a lot of exciting additions to the Frame language, adding both power and standardization to the notation. In addition, the transpiler now can read from stdin as well as still accepting file paths as in the past. This enables improved CI/CD processes involving Frame.
 
-## New in Recent Releases
+#### New Language Features and Updates
 
-For details, see the [Release Notes](https://github.com/frame-lang/frame_transpiler/releases).
+**Functions** - 
 
-### Frame v0.10.0
+With the introduction of functions to the Frame syntax, developers can now easily build simple Frame programs.
+Currently the syntax only permits a single **main()** function. The **v0.12** will permit general 
+use of an unlimited number of functions. 
 
-Frame v0.10.0 brings a lot of exciting additions to the Frame language, adding both power and standardization to the notation. In addition, the transpiler now can read from stdin as well as still accepting file paths as in the past. This enables improved CI/CD processes involving Frame.
+See [Frame Functions](https://docs.frame-lang.org/en/latest/intermediate_frame/functions.html) for more information. 
 
-#### New Language Features
+**System Controller Instantiation** - 
 
-Note: The new language features are now supported in Golang, Javascript, Python3. Other languages will be supported in coming releases.
+With the introduction of Frame functions, developers can now create real Frame programs and instantiate 
+and control Frame systems. This capability allows for full control over system initialization of state
+parameters, start state parameters and domain variables.
 
-* **Compartments** - v0.10 formalizes the idea of **state closures** called *Compartments*. Compartments are data structures that hold a state's local data as well as other metadata enabling new advanced features like *Event Forwarding* (see below).
-* **Deferred transitions** - deferred transitions address challenges with the previous approach of executing a transition immediately when called. Each immediate transition makes a function call and under certain situations, can blow up the stack if too many occur before returning to the caller. Deferred transitions avoid this situation and enable Frame controllers to make any number of sequential transitions. This architecture change enables Frame controllers to be launched as background daemons that run indefinitely until stopped as well as to be used to solve iterative problems.
-* **System parameters** - system parameters enable initializing the system in a more standardized, flexible and direct manner. This includes syntax for setting the start state parameters, the start state's enter parameters as well as override domain variable initialization. This change normalizes the start state to behave like all other states in the machine.
-* **Event forwarding** - event forwarding syntax enables passing events from one state to another. This capability enables system designers to easily receive events in one state and forward them on to other states that can handle them appropriately.
-* **Persistance** - A new system attribute enables code generation for Marshaling and Unmarshaling system data as JSON.
+See [Frame Systems](https://docs.frame-lang.org/en/latest/intermediate_frame/systems.html#system-with-no-parameters).
 
-#### Stdin support
-The CLI has been updated to support stdin:
+**Operations** - 
 
-`framec -language rust < HelloWorld.frm > HelloWorld.rs`
+Frame operations are publicly accessible methods that bypass the state machine and allow privileged access to the 
+system domain data. In addition, operations can optionally be designated as **static**, enabling 
+systems to provide libraries of associated functionality for complex or repetitive system management routines.
 
-or
+See [Frame Operations](https://docs.frame-lang.org/en/latest/advanced_frame/operations.html)
 
-`cat HellowWorld.frm | framec -language golang > HellowWorld.go`
+**Enums** - 
 
+Frame now supports system enumerated types. 
 
-## Resources
+See [Frame Enumerated Types](https://docs.frame-lang.org/en/latest/intermediate_frame/enums.html).
+
+**Loops** - 
 
-The Frame project is still early days but there are some resources and communities to help. You can now download [VSCode](https://marketplace.visualstudio.com/items?itemName=frame-lang-org.frame-machine-maker) and [Atom](https://atom.io/packages/frame-machine-maker) extensions to work with Frame in these popular free development applications.
+Frame now supports two types of loops: 
+
+1. For-like loops
+2. Infinite loops
+
+See [Frame Loops](https://docs.frame-lang.org/en/latest/intermediate_frame/loops.html). 
+
+
+## Resources
 
-An [online version of the Framepiler](https://framepiler.frame-lang.org) is also available and provides examples and links to other resources. You can learn more about the Frame language at [frame-lang.org](https://frame-lang.org) as well as find general resources about programming with automata at Reddit ![re](https://www.google.com/s2/favicons?domain_url=https://reddit.com) on the [r/statemachines](https://www.reddit.com/r/statemachines/) subreddit.
+The Frame project is still early days but there are some resources and communities to help. You can download the [VSCode](https://marketplace.visualstudio.com/items?itemName=frame-lang-org.frame-machine-maker) extension to develop 
+Frame programs on your desktop or experiment with Frame online at the [Frame Playground](https://playground.frame-lang.org). You can learn more about the Frame language using the  [online documentation ](https://docs.frame-lang.org) as well as find general resources about programming with automata at Reddit ![re](https://www.google.com/s2/favicons?domain_url=https://reddit.com) on the [r/statemachines](https://www.reddit.com/r/statemachines/) subreddit.
 
-Communities exist at [Gitter](https://gitter.im/frame-language/community) and [Discord](https://discord.com/invite/CfbU4QCbSD).
+There is also a [Discord](https://discord.com/invite/CfbU4QCbSD) channel to connect with other Frame enthusiasts.
 
 ### Frame Examples
-The [Framepiler](https://framepiler.frame-lang.org/example/aHR0cHM6Ly9naXN0LmdpdGh1Yi5jb20vZnJhbWUtbGFuZy8wZGFmMDMzOGU0YTkyYjc1NWViMTQ2NGM3YzVjMTM3Zg==) itself has a number of examples baked into it but I also have started a [Gitter Frame Examples](https://gitter.im/frame-language/frame-examples) channel for contributions. The Framepiler supports links to Gists so please create and share!
 
-The [Frame Solution Depot](https://github.com/frame-lang/frame_solution_depot) is a Github repo and growing body of examples and test specifications. This is useful in conjunction with the [VSCode](https://marketplace.visualstudio.com/items?itemName=frame-lang-org.frame-machine-maker) and [Atom](https://atom.io/packages/frame-machine-maker) extensions.
+The [Frame Solution Depot](https://github.com/frame-lang/frame_solution_depot) is a Github repo and contains a growing body of examples and test specifications. 
 
-## Bugs and Problems
+## Reporting Bugs and Problems 
 
 For now please report issues to the [Gitter Bug Channel](https://gitter.im/frame-language/bug-reports) while we get a better system in place. If you have a recommendation please let me know there!
 
@@ -77,20 +86,15 @@ These instructions will get you a copy of the project up and running on your loc
 2. Navigate to the framepiler/framec directory.
 3. Type `cargo build`.
 	3.a You will see a bunch of warnings. Apologies but this is pre-alpha code.
-4. Type `./target/debug/framec ../examples/HelloWorld.frm c_sharp`.
+4. Type `./target/debug/framec ../examples/HelloWorld.frm python_3`.
 	4.a You should see a base class for a Frame controller generated to stdout.
 5. If you want to generate a release build:
 	5.a Type `cargo build --release`
-	5.b Type `./target/release/framec ../examples/HelloWorld.frm c_sharp`
+	5.b Type `./target/release/framec ../examples/HelloWorld.frm python_3`
 6. You now have working debug and release Framepilers. Congratulations!
-7. You can try 6 other languages + Plant UML. Replace the `c_sharp` above with any of these:
-	7.a `javascript`
-	7.b `cpp`
-	7.c `gdscript`
-	7.d `java_8`
-	7.e `plantuml` (try output at [PlantUml site](http://www.plantuml.com/))
-	7.f `python_3`
-	7.g `rust` (experimental - only partially implemented)
+7. You can try 6 other languages + Plant UML. Replace the `python_3` above with any of these:
+	7.a `python_3`
+	7.b `plantuml` (try output at [PlantUml site](http://www.plantuml.com/))
 
 #### Linux
 

README.md

@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'Frame Transpiler'
+copyright = '2021, Mark Truluck'
+author = 'Mark Truluck'
+
+release = '0.1'
+version = '0.1.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'sphinx_rtd_theme',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = "sphinx_rtd_theme"
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

docs/conf.py

@@ -1,6 +1,6 @@
-Frame v0.10.0 Documentation
+Frame v0.11.0 Documentation
 =======================================================
-Welcome! Here you will find the official v0.10.0 documentation for the **Frame System Design Language**.
+Welcome! Here you will find the official v0.11.0 documentation for the **Frame System Design Language**.
 
 What is Frame?
 --------------
@@ -102,28 +102,28 @@ The true power of Frame, however, is realized by the ability to generate both do
     :caption: General
     :name: sec-about
 
-    about/introduction
+    source/about/introduction
 
 .. toctree::
     :caption: Getting Started
     :name: sec-getting-started
 
-    getting_started/introduction/index
+    source/getting_started/introduction/index
 
 .. toctree::
     :caption: Intermediate Frame
     :name: sec-intermediate-frame
 
-    intermediate_frame/index
+    source/intermediate_frame/index
 
 .. toctree::
     :caption: Advanced Frame
     :name: sec-advanced-frame
 
-    advanced_frame/index
+    source/advanced_frame/index
 
 .. toctree::
     :caption: Language
     :name: sec-language
 
-    language/index
+    source/language/index

docs/source/index.rst renamed to docs/index.rst

@@ -0,0 +1,4 @@
+# Defining the exact version will make sure things don't break
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1
+readthedocs-sphinx-search==0.1.1

docs/requirements.txt

@@ -1,6 +1,6 @@
 [package]
 name = "frame_build"
-version = "0.8.0"
+version = "0.11.0"
 authors = ["Eric Walkingshaw <[email protected]>"]
 edition = "2018"
 

frame_build/Cargo.toml

@@ -252,7 +252,7 @@ impl FrameBuild {
             let entry = entry?;
             let input_path = entry.path();
             if input_path.extension().unwrap_or_default() == "frm"
-                && (&self.input_filter)(input_path)
+                && (self.input_filter)(input_path)
             {
                 // tell Cargo this is a source file
                 println!("cargo:rerun-if-changed={:?}", &input_path);

frame_build/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "frame_runtime"
-version = "0.10.0"
+version = "0.11.0"
 authors = ["Eric Walkingshaw <[email protected]>"]
 edition = "2018"
 

frame_runtime/Cargo.toml

@@ -247,7 +247,7 @@ impl<S: Style> Renderer<S> {
     ) {
         let mut state_iter = states.iter().peekable();
         while let Some(state) = state_iter.next() {
-            let style = self.style.node(*state, active == Some(state.name));
+            let style = self.style.node(state, active == Some(state.name));
             let children = state.children();
             output.push_str(&"  ".repeat(indent));
             output.push_str(&format!("{}{}", state.name, style));