Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove MSVC legacy behaviour in ModelicaInternal_stat #4483

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

beutlich
Copy link
Member

@beutlich beutlich commented Oct 20, 2024

Closes #4473.

Summary by CodeRabbit

  • Documentation
    • Clarified internal guidance for file path input formatting.
  • Refactor
    • Removed outdated handling to ensure compatibility with modern Microsoft development tools.

These internal improvements streamline behavior under current Visual Studio versions, enhancing overall consistency without affecting public functionality.

@beutlich beutlich added the L: C-Sources Issue addresses Modelica/Resources/C-Sources label Oct 20, 2024
@beutlich beutlich added this to the MSL4.2.0 milestone Oct 27, 2024
@beutlich beutlich enabled auto-merge (squash) November 16, 2024 09:45
Copy link
Contributor

@HansOlsson HansOlsson left a comment

Choose a reason for hiding this comment

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

Looking good

@beutlich beutlich force-pushed the update-stat branch 2 times, most recently from 1e00c3c to 66cc90b Compare January 2, 2025 20:07
@beutlich beutlich requested a review from AHaumer January 15, 2025 20:04
@beutlich beutlich force-pushed the update-stat branch 2 times, most recently from 575d95a to b3c0dc6 Compare January 20, 2025 20:15
@beutlich beutlich requested review from casella, AHaumer and DagBruck and removed request for casella, AHaumer, christoff-buerger and DagBruck March 18, 2025 19:32
Copy link

coderabbitai bot commented Apr 9, 2025

Walkthrough

This pull request updates the comments and removes legacy behavior in the Internal_stat function of ModelicaInternal.c. The modifications clarify the expected path format for the _stat function by specifying "a:" instead of "a:" and introduce conditional compilation for MSVC versions. The legacy support for Visual Studio 2013 and earlier has been removed while the overall function logic remains intact.

Changes

Files Change Summary
Modelica/.../ModelicaInternal.c Updated comments to clarify _stat path requirements; removed legacy handling for pre-VS2015; added conditional directives based on MSVC version.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Internal_stat
    participant _stat

    Caller->>Internal_stat: Call Internal_stat()
    Internal_stat->>Internal_stat: Check MSVC version
    alt MSVC version is 2015 or later
        Internal_stat->>_stat: Call _stat("a:\\")
    else Legacy version handling (removed)
        Internal_stat-->>Caller: (No legacy processing)
    end
    _stat-->>Internal_stat: Return status
    Internal_stat-->>Caller: Return result
Loading

Assessment against linked issues

Objective Addressed Explanation
Revisit _stat for MSVC 14.0 (Visual Studio 2015) [#4473]

Poem

I’m a rabbit coding through the night,
Hopping through changes with pure delight.
Legacy code has scampered away,
MSVC now leads the way.
With whiskers twitching, bugs take flight!
CodeRabbit Inc. cheers every byte!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between be949b2 and 8b29b0a.

📒 Files selected for processing (1)
  • Modelica/Resources/C-Sources/ModelicaInternal.c (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: external_c_checks_cmake_windows-msvc
🔇 Additional comments (3)
Modelica/Resources/C-Sources/ModelicaInternal.c (3)

33-35: Correctly documented the changelog.

The changelog entry clearly documents the purpose of the PR and specifies compatibility information for MSVC Visual Studio versions.


409-409: Improved comment clarity.

The updated comment clearly and succinctly explains the path format required for the _stat function.


423-428: Well-implemented conditional compilation for MSVC versions.

Good use of conditional compilation to handle different MSVC versions. The code now:

  1. Uses _MSC_VER >= 1900 to correctly target Visual Studio 2015 and later
  2. Includes clear comments describing the behavior differences
  3. Retains compatibility for older VS versions while removing legacy handling for newer ones

This implementation properly addresses issue #4473 as mentioned in the PR objectives.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • 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 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 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L: C-Sources Issue addresses Modelica/Resources/C-Sources
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revisit _stat for MSVC 14.0 (Visual Studio 2015)
2 participants