search

magicant / yash-rs

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

Redefine FdFlag #393

Closed magicant closed 3 months ago

magicant commented 3 months ago

This pull request is part of https://github.com/magicant/yash-rs/issues/353 and replaces the FdFlag type with a platform-independent definition.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update enhances the yash-env project by reworking the handling of file descriptor flags, transitioning from singular flag types to an EnumSet<FdFlag> model. This change promotes more flexible and extensible flag management, allowing multiple flags to be used simultaneously. The modifications span various modules, improving clarity, functionality, and maintaining consistency throughout the codebase.

Changes

Files Change Summary
yash-builtin/src/source/semantics.rs Updated assertions in tests to utilize EnumSet<FdFlag> for flag handling.
yash-env/CHANGELOG.md Documented major type redefinitions and method signature changes for FdFlag and Mode.
yash-env/src/system.rs Updated System trait methods to use EnumSet<FdFlag> for handling flags instead of FdFlag.
yash-env/src/system/fd_flag.rs Introduced a new FdFlag enum with EnumSetType, enhancing flag management capabilities.
yash-env/src/system/real.rs Altered RealSystem methods to accept and return EnumSet<FdFlag> for file descriptor operations.
yash-env/src/system/shared.rs Updated SharedSystem to use EnumSet<FdFlag> in various file descriptor-related methods.
yash-env/src/system/virtual.rs Adjusted VirtualSystem to replace FdFlag with EnumSet<FdFlag> in flag handling.
yash-env/src/system/virtual/io.rs Changed FdBody structure to hold flags: EnumSet<FdFlag> instead of a single FdFlag.
yash-env/src/system/virtual/process.rs Renamed flag to flags in FdBody, updating logic to handle multiple flags.
yash-semantics/src/command/pipeline.rs Modified flag checks and assertions to utilize EnumSet for improved file descriptor management.
yash-semantics/src/redir.rs Renamed FD_CLOEXEC to CloseOnExec, updating function calls to reflect the new naming.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant FdFlag
    participant EnumSet

    User->>System: Request file descriptor operation
    System->>FdFlag: Check flags
    FdFlag->>EnumSet: Convert to EnumSet<FdFlag>
    System->>EnumSet: Process multiple flags
    EnumSet-->>System: Return flag status
    System-->>User: Respond with operation result

🐇 In a world of flags so bright,
The rabbit hops with pure delight.
With EnumSet, we can now play,
Managing bits in a clever way!
Hooray for changes, let’s all cheer,
For clearer code and less to fear! 🌟

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