plceye 0.7.1

PLC code smell detector and static analyzer for L5X and PLCopen files
Documentation 
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! PLCopen-specific rule detectors.

use crate::analysis::PlcopenAnalysis;
use crate::config::{EmptyRoutinesConfig, UndefinedTagsConfig, UnusedTagsConfig};
use crate::report::{Report, Severity, Rule, RuleKind};

/// Detect unused variables in PLCopen projects.
pub struct PlcopenUnusedVarsDetector<'a> {
    config: &'a UnusedTagsConfig,
}

impl<'a> PlcopenUnusedVarsDetector<'a> {
    pub fn new(config: &'a UnusedTagsConfig) -> Self {
        Self { config }
    }

    pub fn detect(&self, analysis: &PlcopenAnalysis, report: &mut Report) {
        if !self.config.enabled {
            return;
        }

        for var in analysis.unused_variables() {
            // Skip if matches ignore pattern
            if self.matches_ignore_pattern(&var.name) {
                continue;
            }

            report.add(Rule::new(
                RuleKind::UnusedTag,
                Severity::Warning,
                var.pou_name.clone(),
                var.name.clone(),
                format!("Variable '{}' is defined but never used", var.name),
            ));
        }
    }

    fn matches_ignore_pattern(&self, name: &str) -> bool {
        for pattern in &self.config.ignore_patterns {
            if glob_match(pattern, name) {
                return true;
            }
        }
        false
    }
}

/// Detect undefined variables in PLCopen projects.
pub struct PlcopenUndefinedVarsDetector<'a> {
    config: &'a UndefinedTagsConfig,
}

impl<'a> PlcopenUndefinedVarsDetector<'a> {
    pub fn new(config: &'a UndefinedTagsConfig) -> Self {
        Self { config }
    }

    pub fn detect(&self, analysis: &PlcopenAnalysis, report: &mut Report) {
        if !self.config.enabled {
            return;
        }

        for var_name in analysis.undefined_variables() {
            // Skip if it's a POU name (function/FB call)
            if analysis.pou_names.contains(var_name) {
                continue;
            }

            report.add(Rule::new(
                RuleKind::UndefinedTag,
                Severity::Info,
                "project".to_string(),
                var_name.clone(),
                format!("Variable '{}' is used but not defined (may be external)", var_name),
            ));
        }
    }
}

/// Detect empty POUs in PLCopen projects.
pub struct PlcopenEmptyPousDetector<'a> {
    config: &'a EmptyRoutinesConfig,
}

impl<'a> PlcopenEmptyPousDetector<'a> {
    pub fn new(config: &'a EmptyRoutinesConfig) -> Self {
        Self { config }
    }

    pub fn detect(&self, analysis: &PlcopenAnalysis, report: &mut Report) {
        if !self.config.enabled {
            return;
        }

        for pou_name in &analysis.empty_pous {
            // Skip if matches ignore pattern
            if self.matches_ignore_pattern(pou_name) {
                continue;
            }

            report.add(Rule::new(
                RuleKind::EmptyBlock,
                Severity::Info,
                pou_name.clone(),
                pou_name.clone(),
                format!("POU '{}' has no implementation", pou_name),
            ));
        }
    }

    fn matches_ignore_pattern(&self, name: &str) -> bool {
        for pattern in &self.config.ignore_patterns {
            if glob_match(pattern, name) {
                return true;
            }
        }
        false
    }
}

/// Simple glob pattern matching (supports * and ?).
fn glob_match(pattern: &str, text: &str) -> bool {
    let mut pattern_chars = pattern.chars().peekable();
    let mut text_chars = text.chars().peekable();

    while let Some(p) = pattern_chars.next() {
        match p {
            '*' => {
                if pattern_chars.peek().is_none() {
                    return true;
                }
                let rest_pattern: String = pattern_chars.collect();
                let rest_text: String = text_chars.collect();
                for i in 0..=rest_text.len() {
                    if glob_match(&rest_pattern, &rest_text[i..]) {
                        return true;
                    }
                }
                return false;
            }
            '?' => {
                if text_chars.next().is_none() {
                    return false;
                }
            }
            c => {
                if text_chars.next() != Some(c) {
                    return false;
                }
            }
        }
    }

    text_chars.peek().is_none()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_glob_match() {
        assert!(glob_match("*", "anything"));
        assert!(glob_match("Motor*", "Motor_1"));
        assert!(glob_match("*_temp", "var_temp"));
        assert!(glob_match("?otor", "Motor"));
        assert!(!glob_match("Motor", "Pump"));
    }
}