FairRoot icon indicating copy to clipboard operation
FairRoot copied to clipboard

Remove sprintf

Open karabowi opened this issue 1 year ago • 1 comments

Remove sprintf from generators, geobase and parbase directories.

Mostly replaced by fmt::format, only in FairRtdbRun replaced by TString::Form.


Checklist:

Summary by CodeRabbit

  • New Features

    • Enhanced string formatting across multiple modules using modern techniques for better performance and reliability.
  • Refactor

    • Transitioned from traditional C-style string manipulation to modern C++ string formatting in various classes and methods, improving code readability and maintainability.
  • Documentation

    • Updated internal code documentation to reflect changes in string handling practices.
  • Bug Fixes

    • Addressed potential buffer overflow issues by replacing fixed-size character arrays with dynamically sized std::string.

karabowi avatar May 03 '24 14:05 karabowi

Walkthrough

Walkthrough

The overall change involves modernizing string formatting across various files in the FairRoot project by replacing the usage of the sprintf function with the fmt::format function from the fmt library. This update enhances code readability, safety, and maintainability. Additionally, some buffer handling has been updated from C-style arrays to C++ std::string, and minor readability improvements have been made to certain functions.

Changes

Files Change Summary
fairroot/generators/FairIonGenerator.cxx, fairroot/generators/FairShieldGenerator.cxx Added #include <fmt/core.h>, replaced sprintf with fmt::format, and improved readability by adding newlines.
fairroot/geobase/FairGeoAssembly.cxx, fairroot/geobase/FairGeoBasicShape.cxx, fairroot/geobase/FairGeoCone.cxx, fairroot/geobase/FairGeoCons.cxx, fairroot/geobase/FairGeoEltu.cxx, fairroot/geobase/FairGeoInterface.cxx, fairroot/geobase/FairGeoPcon.cxx, fairroot/geobase/FairGeoTorus.cxx, fairroot/geobase/FairGeoTube.cxx, fairroot/geobase/FairGeoTubs.cxx Added #include <fmt/core.h>, changed Text_t buffers to std::string, replaced sprintf with fmt::format, and updated file writing methods to use std::string.
fairroot/parbase/FairDetParAsciiFileIo.cxx, fairroot/parbase/FairDetParRootFileIo.cxx, fairroot/parbase/FairRuntimeDb.cxx Added #include <fmt/core.h>, replaced sprintf with fmt::format, and improved string handling.
fairroot/parbase/FairRtdbRun.h Modified setRefRun method to use Form instead of sprintf for setting refRun.

Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between ceedd7904f12feb824fd52f7b1803f7671e01fb5 and cba8fbf31da346805d552f05723ad688e7069768.
Files selected for processing (5)
  • fairroot/parbase/FairDetParAsciiFileIo.cxx (3 hunks)
  • fairroot/parbase/FairDetParRootFileIo.cxx (4 hunks)
  • fairroot/parbase/FairRtdbRun.cxx (3 hunks)
  • fairroot/parbase/FairRtdbRun.h (1 hunks)
  • fairroot/parbase/FairRuntimeDb.cxx (3 hunks)
Files skipped from review as they are similar to previous changes (5)
  • fairroot/parbase/FairDetParAsciiFileIo.cxx
  • fairroot/parbase/FairDetParRootFileIo.cxx
  • fairroot/parbase/FairRtdbRun.cxx
  • fairroot/parbase/FairRtdbRun.h
  • fairroot/parbase/FairRuntimeDb.cxx

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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 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.

coderabbitai[bot] avatar May 03 '24 14:05 coderabbitai[bot]

FYI: Check https://www.conventionalcommits.org/en/v1.0.0/#summary (That is where the fix: comes from when @ChristianTackeGSI or I use them)

e.g.

  • fix(generators): Remove sprintf
  • fix(geobase): Remove sprintf
  • fix(parbase): Remove sprintf

dennisklein avatar May 06 '24 20:05 dennisklein

This time I hope I didn't forget the #include <string>s.

karabowi avatar May 07 '24 12:05 karabowi