Skip to content

Link readline for C and C++ #84

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

Merged
merged 2 commits into from
May 5, 2025
Merged

Link readline for C and C++ #84

merged 2 commits into from
May 5, 2025

Conversation

andy1li
Copy link
Member

@andy1li andy1li commented May 5, 2025

Summary by CodeRabbit

  • Chores
    • Updated build configuration to link the shell executable with the Readline library across C and C++ projects, ensuring improved command line input handling. No changes were made to source code or user-facing features.

@andy1li andy1li self-assigned this May 5, 2025
Copy link

coderabbitai bot commented May 5, 2025

Walkthrough

The changes update several CMake configuration files across C and C++ starter templates and solution directories. In each affected file, the executable target shell is now explicitly linked with the Readline::Readline imported library target by adding the target_link_libraries(shell PRIVATE Readline::Readline) directive. The Readline package is also required using find_package(Readline REQUIRED). No changes were made to source code files or to the declarations of exported or public entities. The modifications are limited to the build configuration, ensuring that the shell executable links against the modern CMake Readline target during the build process.

Changes

Files/Directories Change Summary
compiled_starters/c/CMakeLists.txt, compiled_starters/cpp/CMakeLists.txt Added find_package(Readline REQUIRED) and linked shell with Readline::Readline imported target.
solutions/c/01-oo8/code/CMakeLists.txt, solutions/c/02-cz2/code/CMakeLists.txt Added find_package(Readline REQUIRED) and linked shell with Readline::Readline imported target.
solutions/cpp/01-oo8/code/CMakeLists.txt, solutions/cpp/02-cz2/code/CMakeLists.txt Added find_package(Readline REQUIRED) and linked shell with Readline::Readline imported target.
starter_templates/c/code/CMakeLists.txt, starter_templates/cpp/code/CMakeLists.txt Added find_package(Readline REQUIRED) and linked shell with Readline::Readline imported target.

Poem

In the warren where code bunnies dwell,
They linked up Readline with every shell.
No source was disturbed, just build scripts aligned,
Now shells can read lines—how perfectly designed!
🐇✨
Hop, hop, hooray, for a build clean and bright,
With Readline in place, the shell feels just right!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between c4d7ed2 and 3387d7f.

📒 Files selected for processing (8)
  • compiled_starters/c/CMakeLists.txt (1 hunks)
  • compiled_starters/cpp/CMakeLists.txt (1 hunks)
  • solutions/c/01-oo8/code/CMakeLists.txt (1 hunks)
  • solutions/c/02-cz2/code/CMakeLists.txt (1 hunks)
  • solutions/cpp/01-oo8/code/CMakeLists.txt (1 hunks)
  • solutions/cpp/02-cz2/code/CMakeLists.txt (1 hunks)
  • starter_templates/c/code/CMakeLists.txt (1 hunks)
  • starter_templates/cpp/code/CMakeLists.txt (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (8)
  • solutions/cpp/02-cz2/code/CMakeLists.txt
  • starter_templates/c/code/CMakeLists.txt
  • compiled_starters/cpp/CMakeLists.txt
  • starter_templates/cpp/code/CMakeLists.txt
  • compiled_starters/c/CMakeLists.txt
  • solutions/c/01-oo8/code/CMakeLists.txt
  • solutions/c/02-cz2/code/CMakeLists.txt
  • solutions/cpp/01-oo8/code/CMakeLists.txt
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: test_course_definition / test (zig)
  • GitHub Check: test_course_definition / test (rust)
  • GitHub Check: test_course_definition / test (kotlin)
  • GitHub Check: test_course_definition / test (java)
  • GitHub Check: test_course_definition / test (go)
  • GitHub Check: test_course_definition / test (csharp)
  • GitHub Check: test_course_definition / test (cpp)
  • GitHub Check: test_course_definition / test (c)

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

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 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: 1

♻️ Duplicate comments (6)
starter_templates/cpp/code/CMakeLists.txt (1)

10-11: Duplicate suggestion: use find_package(Readline)
See the recommendation in solutions/cpp/02-cz2/code/CMakeLists.txt:10-11 for using find_package(Readline REQUIRED) and linking ${READLINE_LIBRARIES} with target_include_directories.

starter_templates/c/code/CMakeLists.txt (1)

10-11: Duplicate suggestion: use find_package(Readline)
See the recommendation in solutions/cpp/02-cz2/code/CMakeLists.txt:10-11 for invoking find_package(Readline REQUIRED) and linking ${READLINE_LIBRARIES}/imported target instead of hard-coding readline.

solutions/c/02-cz2/code/CMakeLists.txt (1)

10-11: Duplicate suggestion: use find_package(Readline)
Refer to solutions/cpp/02-cz2/code/CMakeLists.txt:10-11 for guidance on using CMake’s find_package(Readline REQUIRED) and consuming ${READLINE_LIBRARIES} and ${READLINE_INCLUDE_DIRS}.

solutions/cpp/01-oo8/code/CMakeLists.txt (1)

10-11: Duplicate suggestion: use find_package(Readline)
As noted in solutions/cpp/02-cz2/code/CMakeLists.txt:10-11, consider adding:

find_package(Readline REQUIRED)
target_link_libraries(shell PRIVATE ${READLINE_LIBRARIES})
target_include_directories(shell PRIVATE ${READLINE_INCLUDE_DIRS})

to enhance portability.

compiled_starters/c/CMakeLists.txt (1)

11-11: Duplicate: Ensure portable discovery of the readline library.

Same suggestion applies here—invoke find_package(Readline REQUIRED) and link against Readline::Readline instead of hardcoding readline.

compiled_starters/cpp/CMakeLists.txt (1)

11-11: Duplicate: Ensure portable discovery of the readline library.

Same suggestion applies here—invoke find_package(Readline REQUIRED) and link against Readline::Readline instead of hardcoding readline.

🧹 Nitpick comments (1)
solutions/cpp/02-cz2/code/CMakeLists.txt (1)

10-11: Add readline linkage to shell target
Linking readline is essential for interactive line-editing support. For improved portability and automatic discovery of headers and libraries, consider invoking CMake’s package finder before linking:

+ find_package(Readline REQUIRED)
+ target_link_libraries(shell
+   PRIVATE
+     ${READLINE_LIBRARIES}
+ )
+ target_include_directories(shell
+   PRIVATE
+     ${READLINE_INCLUDE_DIRS}
+ )

This ensures CMake errors out if readline isn’t available and correctly sets include paths.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1f92ba3 and cd7814b.

📒 Files selected for processing (8)
  • compiled_starters/c/CMakeLists.txt (1 hunks)
  • compiled_starters/cpp/CMakeLists.txt (1 hunks)
  • solutions/c/01-oo8/code/CMakeLists.txt (1 hunks)
  • solutions/c/02-cz2/code/CMakeLists.txt (1 hunks)
  • solutions/cpp/01-oo8/code/CMakeLists.txt (1 hunks)
  • solutions/cpp/02-cz2/code/CMakeLists.txt (1 hunks)
  • starter_templates/c/code/CMakeLists.txt (1 hunks)
  • starter_templates/cpp/code/CMakeLists.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: test_course_definition / test (zig)
  • GitHub Check: test_course_definition / test (rust)
  • GitHub Check: test_course_definition / test (kotlin)
  • GitHub Check: test_course_definition / test (java)
  • GitHub Check: test_course_definition / test (go)
  • GitHub Check: test_course_definition / test (csharp)
  • GitHub Check: test_course_definition / test (cpp)
  • GitHub Check: test_course_definition / test (c)

@andy1li andy1li merged commit 1e79b3d into main May 5, 2025
53 checks passed
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.

1 participant