gelisam / klister

an implementation of stuck macros
BSD 3-Clause "New" or "Revised" License
128 stars 11 forks source link

execute macro actions in phase 1 #240

Open gelisam opened 1 month ago

gelisam commented 1 month ago

As discussed here, if my-macro is a user-defined macro whose (-> Syntax (Macro Syntax)) is myMacroImpl and (my-macro) is encountered at phase 0, then the current code will evaluate (myMacroImpl '(my-macro)) at phase 1 but will execute the resulting (Macro Syntax) at phase 0. This seems wrong to me, I think it should also execute at phase 1.

I have changed the code so that the (Macro Syntax) is also executed at phase 1. The only consequence of this change which was found by the test suite was to break free-identifier=?. Consider this code:

(define my-keyword ...)
(define-macros
  ([my-macro
    (lambda (stx)
      (case (open-syntax stx)
        [(list-contents (list _ x))
         (>>= (free-identifier=? x 'my-keyword)
           ...)]))]))

When the (free-identifier=? x 'my-keyword) action is executed, then the current implementation will look up "my-keyword" and "my-keyword" in the current phase (previously phase 0, now phase 1) and determine whether they point to the same binding. In phase 0, they do point to the same binding, so free-identifier=? return true, but at phase 1 there is no binding for "my-keyword", so free-identifier=? returns false.

Now, we do want free-identifier=? to return true, so I have changed free-identifier=? so that instead of looking up "my-keyword" in the current phase (now phase 1), it now looks it up in phase 0, thus resolving the issue. This change makes sense to me: if e.g. the macro had a local variable named "my-keyword", we would not want x to resolve to that local variable, we still want x to resolve to the top-level define. So free-identifier=? should look up the variables in the environment of the macro's call site, not in the current environment.

Does this make sense? Did I find and fix a bug, or is my intuition completely wrong?

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes introduce significant restructuring and renaming of data types and patterns across multiple modules. Key modifications include splitting TypePattern into TypeCtorPattern and TypePatternVar, renaming ConstructorPatternF to DataCtorPattern, and updating various functions and modules to accommodate these changes. Additionally, new primitives and macros have been added, and error handling has been improved by utilizing non-empty lists. Instances of ShortShow have been removed from several modules.

Changes

Files Change Summary
src/Core.hs, src/Evaluator.hs Renamed and restructured data types and patterns, updated functions to reflect these changes.
src/Expander.hs, src/Expander/Error.hs, src/Expander/Monad.hs, src/Expander/Primitives.hs Added new primitives and macros, adjusted existing functions and error handling to use non-empty lists.
src/Binding.hs, src/Binding/Info.hs, src/Datatype.hs, src/Expander/Task.hs, src/Expander/Syntax.hs, src/Syntax/Syntax.hs, src/Type.hs Removed ShortShow instances and related imports.
tests/Test.hs Updated function signatures and type references to reflect new data type structures.
stdlib/prelude.kl, toy.kl Updated datatype definitions and refined macro behaviors.

Sequence Diagram(s) (Beta)

No sequence diagrams are needed for these changes as they primarily involve renaming, restructuring, and minor functional updates.

Poem

In the code where patterns play,
New names and types now hold sway.
Constructors dance in a fresh array,
Primitives and macros lead the way.
Errors handled with non-empty flair,
ShortShow bids farewell, everywhere.
Hail to the changes, with a rabbit’s care! 🐇✨


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): > :bangbang: **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.
gelisam commented 1 month ago

Thinking about this more, I am even more convinced that I am right: in Racket, there is no separation between the pure function and the Macro effects, they happen at the same time. So of course they run in the same phase.

gelisam commented 1 month ago

@coderabbitai review

coderabbitai[bot] commented 1 month ago
Actions Performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.