Skip to content

Fix uncrustify C++ formatting failures in marine_charts #2

Description

@rolker

Issue: Fix uncrustify C++ formatting failures in marine_charts

Summary

The CI tests are failing with 13 uncrustify (C++ code formatting) violations in the marine_charts package.

Test Failures (from PR rolker/unh_marine_autonomy#34)

Total: 13 failures

  • Uncrustify (C++ formatting): 13 files with code style divergence

Files Affected

Header Files

  • include/marine_charts/grid_creation_context.h (46 lines diff)
  • include/marine_charts/s57_catalog.h (34 lines diff)
  • include/marine_charts/s57_dataset.h (53 lines diff)

Source Files

  • src/grid_creation_context.cpp (307 lines diff)
  • src/s57_catalog.cpp (102 lines diff)
  • src/s57_dataset.cpp (330 lines diff)

ISO8211 Library Files

  • src/iso8211/ddffield.cpp (367 lines diff)
  • src/iso8211/ddffielddefn.cpp (1367 lines diff)
  • src/iso8211/ddfmodule.cpp (882 lines diff)
  • src/iso8211/ddfrecord.cpp (2181 lines diff)
  • src/iso8211/ddfsubfielddefn.cpp (1297 lines diff)
  • src/iso8211/ddfutils.cpp (84 lines diff)
  • src/iso8211/iso8211.h (646 lines diff)

Issue Details

Uncrustify is reporting code style divergence from the project's C++ formatting standards. Common issues include:

  • Brace placement and spacing
  • Indentation inconsistencies
  • Spacing around operators and control structures
  • Line breaks and wrapping

The ISO8211 library files have extensive formatting issues (646-2181 lines of diff each), suggesting they may have been imported from an external source with different formatting conventions.

Steps to Fix

  1. Run uncrustify locally to see violations:

    ament_uncrustify --reformat src/ include/
  2. Review auto-formatted changes, especially for ISO8211 files (may need manual review)

  3. Verify fixes:

    colcon test --packages-select marine_charts
    colcon test-result --verbose

Considerations

  • ISO8211 files appear to be a library with extensive formatting differences
  • May want to exclude external library code from formatting checks if it's maintained separately
  • Or apply formatting once and maintain going forward

Related

  • Identified in unh_marine_autonomy PR #34
  • Part of automated testing infrastructure rollout
  • Not functional bugs - code style only

CI Log Reference

Workflow run: https://github.com/rolker/unh_marine_autonomy/actions/runs/21611917952

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions