magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
64 stars 3 forks source link

Migrate to our own Signal type #367

Closed magicant closed 3 months ago

magicant commented 3 months ago

This is part of #353, and rework of #365.

This PR removes the use of nix::signal::Signal in the yash_env::System API. The definition of Signal is dependent on the underlying system, so it should not be used outside RealSystem. Instead, new neutral items are added in the yash_env::signal module.

The new Number type replaces the most use of Signal. The RealSystem and VirtualSystem now have different Number spaces so that the VirtualSystem no longer has to depend on the RealSystem's signal number. The other uses of Signals are replaced by Names, which is more abstract than Numbers.

This PR also adds (partial) support for real-time signals.

To fully support real-time signals, we also need to eliminate the use of SigSet, which is not the scope of this pull request.


Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes in the yash-builtin and yash-env modules primarily focus on enhancing signal handling. This involves adding new signal-related functionalities, refactoring existing signal logic, and updating function signatures and structures to accommodate these improvements. Key updates include new methods for signal validation, mapping, and handling, along with modifications to job control, trap, kill, and wait mechanisms to use these new signal handling capabilities.

Changes

File(s) Change Summary
yash-builtin/CHANGELOG.md Summarized changes in version 0.2.0, highlighting additions, modifications, and removals.
yash-builtin/src/bg.rs, fg.rs Updated signal handling logic, replacing direct signal usage with signal names.
yash-builtin/src/jobs.rs Modified job control mechanisms, renamed fields, and updated method signatures.
yash-builtin/src/kill.rs, print.rs, send.rs, signal.rs, syntax.rs Refactored signal handling, parsing, and execution logic, introduced new structures and methods.
yash-builtin/src/set.rs Updated signal references to use new modules and structures.
yash-builtin/src/trap.rs, cond.rs, syntax.rs Enhanced trap handling with new condition specifications and error handling improvements.
yash-builtin/src/wait/core.rs Adjusted error handling and signal references in wait mechanisms.
yash-env/src/system.rs Introduced new methods for signal validation, mapping, and handling, modified existing methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant yash-builtin
    participant yash-env

    User->>yash-builtin: Send signal via kill command
    yash-builtin->>yash-env: Validate and parse signal
    yash-env-->>yash-builtin: Return signal number
    yash-builtin->>yash-env: Execute signal handling
    yash-env-->>yash-builtin: Signal action performed
    yash-builtin-->>User: Confirmation of signal execution

Poem

In the code where signals play,
A rabbit hops through night and day.
With traps and kills, it deftly weaves,
Ensuring all the bugs it leaves.
Signals parsed with utmost care,
In yash, a system rare.
Hooray for changes, hip and bright,
The rabbit's code, a shining light! πŸŒŸπŸ‡


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 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.