Feature/state machine phase 2

[2lambda123]

Description

The changes in this pull request add several new files and modify existing files in the FPP compiler project related to the state machine analysis. Here is a summary of the changes:

Modified Files:

• compiler/lib/src/main/scala/analysis/Analysis.scala:

  • Added a new function getQualifiedNameFromMap to compute the qualified name of a symbol from a parent-symbol map.

• compiler/lib/src/main/scala/analysis/Semantics/Symbol.scala:

  • Modified to define the SymbolInterface trait for symbols to implement.

• compiler/lib/src/main/scala/ast/Ast.scala:

  • Modified the definition of DefStateMachine to include a list of StateMachineMembers representing the contents of the state machine.

Added Files:

• compiler/lib/src/main/scala/analysis/Analyzers/StateMachine/StateAnalyzer.scala:

  • A state analyzer implementing the state machine analysis visitor.

• compiler/lib/src/main/scala/analysis/Analyzers/StateMachine/StateMachineAnalysisVisitor.scala:

  • A generic analysis visitor for state machine semantics.

• compiler/lib/src/main/scala/analysis/Analyzers/StateMachine/StateMachineUseAnalyzer.scala:

  • Analyzes state machine uses.

• compiler/lib/src/main/scala/analysis/Analyzers/StateMachine/StateMachineAnalyzer.scala:

  • Analyzes state machine members.

• compiler/lib/src/main/scala/analysis/CheckSemantics/CheckUsesHelpers.scala:

  • Helper functions for checking symbol uses.

• compiler/lib/src/main/scala/analysis/CheckSemantics/StateMachine/:

  • Package containing various state machine semantic checking classes.

• compiler/lib/src/main/scala/analysis/Semantics/StateMachine/:

  • Package containing various state machine semantic analysis classes.

• compiler/lib/src/main/scala/analysis/Semantics/GenericScope/:

  • Packages with generic scope classes used in semantic analysis.

• compiler/lib/src/main/scala/analysis/Semantics/StateMachine/StateMachine.scala:

  • Defines the StateMachine class for state machine analysis.

• compiler/lib/src/main/scala/analysis/Semantics/StateMachine/StateMachineScope.scala:

  • Defines the StateMachineScope class for state machine analysis.

• compiler/lib/src/main/scala/analysis/Semantics/StateMachine/SmNameSymbolMap.scala:

  • Defines the SmNameSymbolMap class for name-symbol mappings in state machine analysis.

These changes introduce a new set of analysis tools specific to state machines, including analyzers, semantic checkers, and symbols for various elements of state machines. This enhanced analysis capability will allow for more detailed and accurate processing of state machine definitions.

Description by Korbit AI

### What change is being made?

Implement phase 2 of the state machine feature, which includes adding state machine analysis, semantic checks, and code generation support for state machine constructs.

### Why are these changes being made?

These changes are part of the ongoing development to support state machine semantics in the compiler, allowing for more complex and structured state management within the language. This phase introduces the ability to define and analyze state machines, ensuring correct usage and transitions, and prepares the groundwork for further enhancements in state machine handling. The approach leverages existing analysis patterns and introduces new constructs to handle state-specific semantics effectively.

Summary by Sourcery

Implement phase 2 of the state machine feature, introducing new constructs such as actions, guards, signals, states, and transitions. Update the parser, AST, and code generation components to support these constructs. Enhance the documentation and add comprehensive tests to ensure the correctness and robustness of the new features.

New Features:

• Introduce a comprehensive state machine feature with support for actions, guards, signals, states, and transitions, including initial, entry, exit, and state transitions.
• Add support for defining and using junctions within state machines, allowing for conditional transitions based on guards.

Enhancements:

• Refactor the parser to include new definitions for actions, guards, signals, states, and transitions, enhancing the language's expressiveness for state machine modeling.
• Update the AST (Abstract Syntax Tree) to accommodate new state machine constructs, including actions, guards, signals, and transitions.
• Enhance the code generation components to support the new state machine constructs, ensuring proper translation from AST to code.

Documentation:

• Update the FPP language specification to include detailed documentation on the new state machine constructs, including syntax and semantics for actions, guards, signals, states, and transitions.

Tests:

• Add extensive test coverage for the new state machine features, including tests for valid and invalid state machine definitions, transitions, and uses of actions, guards, and signals.

[performance-testing-bot[bot]]

Unable to locate .performanceTestingBot config file

[cr-gpt[bot]]

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

[code-companion-ai[bot]]

Processing PR updates...

[git-greetings[bot]]

Thanks @2lambda123 for opening this PR!

For COLLABORATOR only :

• To add labels, comment on the issue /label add label1,label2,label3

• To remove labels, comment on the issue /label remove label1,label2,label3

[korbit-ai[bot]]

My review is in progress :book: - I will have feedback for you in a few minutes!

[quine-bot[bot]]

👋 Figuring out if a PR is useful is hard, hopefully this will help.

• @2lambda123 has been on GitHub since 2019 and in that time has had 2665 public PRs merged
• Don't you recognize them? They've been here before 🎉
• Here's a good example of their work: black-forest-labs-flux
• From looking at their profile, they seem to be good with Python and Shell.

Their most recently public accepted PR is: https://github.com/2lambda123/nasa-fpp/pull/5

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This pull request implements the second phase of state machine support in the FPP (F Prime Prime) language. It adds internal state machine definitions, including actions, guards, signals, states, and transitions. The changes involve updates to the parser, AST, code generation, and semantic checking components of the compiler.

File-Level Changes

Change	Details	Files
Added support for internal state machine definitions	Updated AST structures to represent state machine components Modified parser to handle new state machine syntax Implemented semantic checking for state machine definitions Added code generation for state machine structures	compiler/lib/src/main/scala/ast/Ast.scala compiler/lib/src/main/scala/syntax/Parser.scala compiler/lib/src/main/scala/codegen/AstWriter.scala compiler/lib/src/main/scala/codegen/FppWriter.scala compiler/lib/src/main/scala/analysis/CheckSemantics/CheckSemantics.scala compiler/lib/src/main/scala/analysis/CheckSemantics/CheckStateMachineDefs.scala
Refactored scope and symbol handling to be more generic	Created generic versions of NestedScope, Scope, and NameSymbolMap Implemented StateMachineScope and StateMachineNestedScope using generic structures Added StateMachineSymbol and StateMachineNameGroup for state machine-specific symbol handling	compiler/lib/src/main/scala/analysis/Semantics/GenericScope/GenericNestedScope.scala compiler/lib/src/main/scala/analysis/Semantics/GenericScope/GenericScope.scala compiler/lib/src/main/scala/analysis/Semantics/GenericScope/GenericNameSymbolMap.scala compiler/lib/src/main/scala/analysis/Semantics/StateMachine/StateMachineSymbol.scala compiler/lib/src/main/scala/analysis/Semantics/StateMachine/StateMachineNameGroup.scala
Implemented state machine-specific analysis and checking	Created StateMachineAnalysis data structure Implemented EnterStateMachineSymbols for symbol entry Added CheckStateMachineUses for checking symbol uses Implemented CheckInitialTransitions for validating initial transitions	compiler/lib/src/main/scala/analysis/Semantics/StateMachine/StateMachineAnalysis.scala compiler/lib/src/main/scala/analysis/CheckSemantics/StateMachine/EnterStateMachineSymbols.scala compiler/lib/src/main/scala/analysis/CheckSemantics/StateMachine/CheckStateMachineUses.scala compiler/lib/src/main/scala/analysis/CheckSemantics/StateMachine/CheckInitialTransitions.scala
Updated FPP language specification	Added new sections for state machine behavior elements Updated table of contents to reflect new state machine sections Modified existing sections to accommodate state machine changes	docs/fpp-spec.html
Added new test cases for state machine functionality	Created tests for undefined symbols in state machines Added tests for redefined symbols in state machines Implemented tests for initial transition validation Created tests for state machine type checking	compiler/tools/fpp-check/test/state_machine/undef/tests.sh compiler/tools/fpp-check/test/state_machine/redef/tests.sh compiler/tools/fpp-check/test/state_machine/initial_transitions/tests.sh compiler/tools/fpp-check/test/state_machine/types/tests.sh

---

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

[git-greetings[bot]]

PR Details of @2lambda123 in nasa-fpp :	OPEN	CLOSED	TOTAL
1	5	6

[code-companion-ai[bot]]

Description has been updated!

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

78 files out of 201 files are above the max files limit of 100. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[penify-dev[bot]]

Failed to generate code suggestions for PR

[codeautopilot[bot]]

Your organization has reached the subscribed usage limit. You can upgrade your account by purchasing a subscription at Stripe payment link

_Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect._ Current plan usage: 117.00% **Have feedback or need help?** [Discord](https://discord.gg/r72ykfvyx7) [Documentation](https://docs.codeautopilot.com/) [support@codeautopilot.com](mailto:support@codeautopilot.com)