Skip to content

Conversation

@hexaredecimal
Copy link
Contributor

@hexaredecimal hexaredecimal commented Jun 29, 2025

Summary by CodeRabbit

  • New Features

    • Added support for new keywords "use" and "return" in the PiccodeScript language.
    • Simplified the syntax for if-expressions, removing the need for braces.
    • Enhanced argument definitions to allow default values from any expression and optional "use" keyword.
  • Bug Fixes

    • Improved error messages for missing keys or values in object literals.

@coderabbitai
Copy link

coderabbitai bot commented Jun 29, 2025

Walkthrough

The PiccodeScript grammar was updated to relax argument default value restrictions, adjust expression parsing order, simplify the if expression syntax, and introduce new use and return keywords. Corresponding Java visitor logic was enhanced to handle the new RETURN_TOK and to improve error checking for object literal key-value pairs.

Changes

File(s) Change Summary
src/main/antlr4/PiccodeScript.g4 Grammar changes: relaxed arg default values, reordered expr alternatives, simplified if_expr, added USE and RETURN_TOK tokens.
src/main/java/org/piccode/ast/PiccodeVisitor.java Added handling for RETURN_TOK in unary expressions; improved error checking for object literal key-value pairs.

Sequence Diagram(s)

sequenceDiagram
    participant Parser
    participant Visitor
    participant AstNode

    Parser->>Visitor: visitUnaryExpr(ctx)
    alt ctx has RETURN_TOK
        Visitor->>AstNode: create ReturnAst(visit(ctx.expr()))
        Visitor->>Parser: return ReturnAst
    else other unary
        Visitor->>AstNode: create UnaryAst(visit(ctx.expr()))
        Visitor->>Parser: return UnaryAst
    end
Loading

Poem

In fields of code where grammars grow,
New tokens "use" and "return" now show.
Ifs are simpler, errors caught with care,
Arguments flexible, expressions laid bare.
The parser hops forward, nimble and bright—
A rabbit’s delight in the code’s new light!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/main/java/org/piccode/ast/PiccodeVisitor.java (1)

599-612: Good defensive programming with null checks.

The null checks improve robustness, though the grammar rules suggest these shouldn't be null under normal parsing. Consider using the key-value pair's start token for more precise error location instead of the parent context's start token.

-				var tok = key_val_pairs.getStart();
+				var tok = kv.getStart();
				throw new PiccodeException(fileName, tok.getLine(), tok.getCharPositionInLine(), "Missing a key in object literal");
-				var tok = key_val_pairs.getStart();
+				var tok = kv.getStart();
				throw new PiccodeException(fileName, tok.getLine(), tok.getCharPositionInLine(), "Missing expression in object literal");
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9e960a8 and fed5243.

📒 Files selected for processing (2)
  • src/main/antlr4/PiccodeScript.g4 (4 hunks)
  • src/main/java/org/piccode/ast/PiccodeVisitor.java (2 hunks)
🔇 Additional comments (5)
src/main/antlr4/PiccodeScript.g4 (4)

49-49: Good flexibility improvement for default argument values.

Allowing any expression as a default value instead of just literals provides more flexibility. The optional USE prefix adds new functionality for argument handling.


96-96: LGTM! Token rename properly implemented.

The change from RETURN to RETURN_TOK is properly implemented with both the grammar rule update and the corresponding token definition.

Also applies to: 177-177


101-101: Clean syntax improvement for if expressions.

Removing the braces simplifies the if expression syntax, making it more consistent with functional programming languages.


54-57: Verify Impact of :: and Function-Call Precedence

Automated searches did not uncover any instances of the namespace operator immediately followed by a function call (e.g. a::b(c)) in the repository. Absence of matches may simply mean files use unrecognized extensions or live outside the default search paths.

Please manually review any Piccode script examples or test cases for this pattern to ensure the grammar change doesn’t alter intended behavior.

Suggested search commands:
• rg -n '::[[:alnum:]]+\s*(' -g '.pcs' -g '.piccod' -g '*.picode'
• rg -n '::[[:alnum:]
]+\s*(' -g 'src/**/*.g4'

No changes are required in src/main/antlr4/PiccodeScript.g4 beyond the reviewed reordering, but confirm there are no upstream scripts relying on the old (a::b)(c) parse.

src/main/java/org/piccode/ast/PiccodeVisitor.java (1)

527-534: Proper implementation of RETURN_TOK handling.

The visitor correctly handles the new RETURN_TOK token by creating a ReturnAst node, which aligns with the grammar changes.

@hexaredecimal hexaredecimal merged commit 850064e into main Jun 29, 2025
2 checks passed
@hexaredecimal hexaredecimal changed the title Pr from Work Marge bug fixes back to main Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants