sqc 0.4.13

Software Code Quality - CERT C compliance checker
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2024 Ryan Urchick

use super::super::{CertRule, RuleViolation};
use crate::manifest::{RuleCategory, Severity};
use tree_sitter::Node;

pub struct Pre06C;

impl CertRule for Pre06C {
    fn rule_id(&self) -> &'static str {
        "PRE06-C"
    }
    fn description(&self) -> &'static str {
        "Enclose header files in an include guard"
    }
    fn severity(&self) -> Severity {
        Severity::Low
    }
    fn category(&self) -> RuleCategory {
        RuleCategory::Rule
    }
    fn cert_id(&self) -> &'static str {
        "PRE06-C"
    }

    fn applies_to_file(&self, file_path: &str) -> bool {
        matches!(
            std::path::Path::new(file_path)
                .extension()
                .and_then(|e| e.to_str()),
            Some("h" | "hpp" | "hh" | "hxx")
        )
    }

    fn check(&self, _node: &Node, source: &str) -> Vec<RuleViolation> {
        let mut violations = Vec::new();

        // Check if source has #ifndef, #define, #endif pattern
        let has_ifndef = source.contains("#ifndef");
        let has_define = source.contains("#define");
        let has_endif = source.contains("#endif");

        if !has_ifndef || !has_define || !has_endif {
            violations.push(RuleViolation {
                rule_id: self.rule_id().to_string(),
                severity: self.severity(),
                line: 1,
                column: 1,
                file_path: String::new(),
                message: "Header file missing include guard".to_string(),
                suggestion: Some(
                    "Add #ifndef HEADER_H / #define HEADER_H / #endif guard".to_string(),
                ),
                requires_manual_review: None,
            });
        }

        violations
    }
}