search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
59 stars 96 forks source link

clang-format: Put braces on own line in special cases #1586

Closed ChristianTackeGSI closed 3 months ago

ChristianTackeGSI commented 3 months ago

Multi-line control statements with the opening brace on the last line can be a little confusing to read:

if (auto foo = something;
    foo.extra_data.check_for(17)) {
    foo.extra_data.check_and_act(19);
}

It is not easy to see the end of the condition and the start of the "then" block.

This gets much easier when putting the opening brace on its own line:

if (auto foo = something;
    foo.extra_data.check_for(17))
{
    foo.extra_data.check_and_act(19);
}

To show the difference, a few files have been reformatted with this.

Checklist:

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent updates focus on enhancing code readability and maintainability by restructuring control flow statements and enforcing consistent brace usage across various files. These improvements aim to clarify the code structure without altering the underlying logic or functionality. Additionally, copyright years have been updated to reflect the current year, contributing to a more uniform coding style throughout the codebase. ## Changes | Files | Change Summary | |----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| | `.clang-format` | Added `AfterControlStatement: MultiLine` to enforce consistent brace usage in multi-line control statements. | | `examples/MQ/pixelDetector/src/Pixel.cxx` | Expanded `if` statement in `ProcessHits` to use braces for clarity; no logic changes. | | `examples/MQ/pixelDetector/src/PixelDigitize.cxx` | Updated copyright year and changed brace placement in `ActivatePixel` for better formatting. | | `examples/advanced/Tutorial3/simulation/FairTestDetector.cxx` | Adjusted `if` statement for track conditions to improve readability with new line brace placement; logic unchanged. | | `examples/advanced/propagator/src/FairTutPropDet.cxx` | Modified `if` statement in `ProcessHits` to a multi-line format for enhanced readability; logic remains the same. | | `fairroot/base/event/FairMultiLinkedData.cxx` | Introduced braces for conditional statements in `AddLink` for clarity without changing logic. | | `fairroot/base/steer/FairRadGridManager.cxx` | Reformatted conditional checks in `IsTrackInside` to enhance readability with new line brace placement; logic unchanged. | | `fairroot/base/steer/FairWriteoutBuffer.cxx` | Updated `for` loop and `if` statement to use braces for clarity and consistency; logic unchanged. | | `fairroot/generators/FairBoxGenerator.cxx` | Simplified multi-line condition in `Init()` to a single line with braces; logic remains unchanged. | | `fairroot/online/source/FairMbsSource.cxx` | Reformatted closing braces in `Unpack` method for improved readability; logic unchanged. | | `fairroot/online/source/FairRemoteSource.cxx` | Updated formatting in `ReadEvent` method with new line brace placement; logic remains unchanged. | | `templates/project_root_containers/NewDetector/NewDetector.cxx` | Expanded conditional statement in `ProcessHits` to multi-line format for clarity; logic unchanged. | | `templates/project_stl_containers/NewDetector/NewDetector.cxx` | Modified `ProcessHits` method to a multi-line conditional for improved readability; logic remains unchanged. | | `tests/geobase/checks_FairGeoBasicShape.h` | Restructured `check_FairGeoShape_ReadWrite` function to clarify conditional checks with new line brace placement; logic unchanged. |
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 15a57bd780fc44c18fdb1356a4d8f40af8c29052 and 9e7ff6af14855311d9ea44891e440f6799dade13.
Files selected for processing (14) * .clang-format (1 hunks) * examples/MQ/pixelDetector/src/Pixel.cxx (1 hunks) * examples/MQ/pixelDetector/src/PixelDigitize.cxx (2 hunks) * examples/advanced/Tutorial3/simulation/FairTestDetector.cxx (1 hunks) * examples/advanced/propagator/src/FairTutPropDet.cxx (1 hunks) * fairroot/base/event/FairMultiLinkedData.cxx (2 hunks) * fairroot/base/steer/FairRadGridManager.cxx (2 hunks) * fairroot/base/steer/FairWriteoutBuffer.cxx (2 hunks) * fairroot/generators/FairBoxGenerator.cxx (1 hunks) * fairroot/online/source/FairMbsSource.cxx (2 hunks) * fairroot/online/source/FairRemoteSource.cxx (2 hunks) * templates/project_root_containers/NewDetector/NewDetector.cxx (1 hunks) * templates/project_stl_containers/NewDetector/NewDetector.cxx (1 hunks) * tests/geobase/checks_FairGeoBasicShape.h (1 hunks)
Files skipped from review due to trivial changes (9) * examples/MQ/pixelDetector/src/PixelDigitize.cxx * examples/advanced/Tutorial3/simulation/FairTestDetector.cxx * fairroot/base/event/FairMultiLinkedData.cxx * fairroot/base/steer/FairRadGridManager.cxx * fairroot/base/steer/FairWriteoutBuffer.cxx * fairroot/online/source/FairMbsSource.cxx * fairroot/online/source/FairRemoteSource.cxx * templates/project_root_containers/NewDetector/NewDetector.cxx * templates/project_stl_containers/NewDetector/NewDetector.cxx
Files skipped from review as they are similar to previous changes (5) * .clang-format * examples/MQ/pixelDetector/src/Pixel.cxx * examples/advanced/propagator/src/FairTutPropDet.cxx * fairroot/generators/FairBoxGenerator.cxx * tests/geobase/checks_FairGeoBasicShape.h
--- 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.
dennisklein commented 3 months ago

I updated the brew packages on citmac008 and it now has CMake 3.30:

CMake Error (dev) at /Users/alfaci/install/FairSoft/share/faircmakemodules/modules/FairFindPackage2.cmake:214 (find_package):
  Policy CMP0167 is not set: The FindBoost module is removed.  Run "cmake
  --help-policy CMP0167" for policy details.  Use the cmake_policy command to
  set the policy and suppress this warning.

Call Stack (most recent call first):
  CMakeLists.txt:237 (find_package2)
This error is for project developers. Use -Wno-error=dev to suppress it.
dennisklein commented 3 months ago

To fix we need to update the version range here https://github.com/FairRootGroup/FairRoot/blob/84175d0291bbcd09b70e1626f7957d7bcacc6ce4/CMakeLists.txt#L9

ChristianTackeGSI commented 3 months ago

To fix we need to update the version range here

https://github.com/FairRootGroup/FairRoot/blob/84175d0291bbcd09b70e1626f7957d7bcacc6ce4/CMakeLists.txt#L9

Can you create a PR for this?

Should we backport this for 18.x then as well?