Skip to content

README.md

Latest commit

 

History

History
93 lines (68 loc) · 2.56 KB

README.md

File metadata and controls

93 lines (68 loc) · 2.56 KB
Raw

QGC Static Analyzers

Static analysis tools for QGroundControl C++ code.

Vehicle Null-Check Analyzer

Detects unsafe patterns where activeVehicle() or getParameter() results are used without null checks.

Usage

# Analyze specific files
python3 tools/analyzers/vehicle_null_check.py src/Vehicle/*.cc

# Analyze directory recursively
python3 tools/analyzers/vehicle_null_check.py src/

# JSON output for CI/editor integration
python3 tools/analyzers/vehicle_null_check.py --json src/

# Show help
python3 tools/analyzers/vehicle_null_check.py --help

Detected Patterns

Pattern Risk Example
unsafe_active_vehicle_direct High activeVehicle()->method()
unsafe_active_vehicle_use High Variable used after activeVehicle() without check
unsafe_get_parameter Medium getParameter(...)->rawValue()

Example Output

src/Example.cc:42:15: warning: unsafe_active_vehicle_direct
  activeVehicle()->parameterManager()->getParameter(...);
  Suggestion: Add null check before using activeVehicle():
    Vehicle *vehicle = MultiVehicleManager::instance()->activeVehicle();
    if (!vehicle) return;

JSON Output Format

[
  {
    "file": "src/Example.cc",
    "line": 42,
    "column": 15,
    "pattern": "unsafe_active_vehicle_direct",
    "code": "activeVehicle()->parameterManager()->...",
    "suggestion": "Add null check before using activeVehicle():..."
  }
]

Pre-commit Integration

Already configured in .pre-commit-config.yaml. Runs automatically on C++ files.

# Run manually on all files
pre-commit run vehicle-null-check --all-files

Suppressing False Positives

The analyzer looks back 10 lines for null checks. If you have a valid null check that isn't detected, restructure your code to have the check closer to the usage, or add a comment explaining why it's safe.

// Safe: null check is visible to analyzer
Vehicle *vehicle = MultiVehicleManager::instance()->activeVehicle();
if (!vehicle) {
    return;
}
vehicle->doSomething();  // OK - analyzer sees the check above

Shared Utilities

The analyzers use shared patterns from tools/common/:

  • patterns.py - Regex patterns for QGC code constructs
  • file_traversal.py - File discovery with proper filtering

Adding New Analyzers

  1. Create new Python script in tools/analyzers/
  2. Import shared patterns from tools.common.patterns
  3. Use find_cpp_files() from tools.common.file_traversal
  4. Support --json output for editor integration
  5. Add to .pre-commit-config.yaml if appropriate