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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
use super::super::{CertRule, RuleViolation};
use crate::manifest::{RuleCategory, Severity};
use crate::utility::cert_c::ast_utils;
use tree_sitter::Node;
pub struct Dcl00C;
impl CertRule for Dcl00C {
fn rule_id(&self) -> &'static str {
"DCL00-C"
}
fn description(&self) -> &'static str {
"Const-qualify immutable objects"
}
fn severity(&self) -> Severity {
Severity::Medium
}
fn category(&self) -> RuleCategory {
RuleCategory::Recommendation
}
fn cert_id(&self) -> &'static str {
"DCL00-C"
}
fn check(&self, node: &Node, source: &str) -> Vec<RuleViolation> {
let mut violations = Vec::new();
// Check init_declarators for variables that should be const
if node.kind() == "init_declarator" {
if let Some(declarator) = node.child_by_field_name("declarator") {
if let Some(value) = node.child_by_field_name("value") {
if let Some(parent_decl) = find_parent_declaration(node) {
// Skip variables declared in for-loop init clauses — these are
// loop counters modified by the update expression (++i, etc.)
if is_in_for_loop_init(&parent_decl) {
return violations;
}
// Skip if already const-qualified
if !has_const_qualifier(&parent_decl, source) {
let var_name =
ast_utils::get_identifier_from_declarator(&declarator, source);
// Check if this should be const based on various patterns
if should_be_const(&parent_decl, &declarator, &value, &var_name, source)
{
let start_point = parent_decl.start_position();
violations.push(RuleViolation {
rule_id: self.rule_id().to_string(),
severity: Severity::Medium,
message: format!(
"Variable '{}' is initialized but never modified, consider const-qualifying it",
var_name
),
file_path: String::new(),
line: start_point.row + 1,
column: start_point.column + 1,
suggestion: Some(format!("Add 'const' qualifier: const {} = ...", var_name)),
..Default::default()
});
}
}
}
}
}
}
// Recursively check child nodes
for i in 0..node.child_count() {
if let Some(child) = node.child(i) {
violations.extend(self.check(&child, source));
}
}
violations
}
}
fn find_parent_declaration<'a>(node: &'a Node<'a>) -> Option<Node<'a>> {
let mut current = node.parent();
while let Some(parent) = current {
if parent.kind() == "declaration" {
return Some(parent);
}
current = parent.parent();
}
None
}
/// Check if a declaration is inside a for-loop's initializer clause.
/// Variables declared in `for (int i = 0; ...)` are loop counters that
/// are modified by the update expression — not candidates for const.
fn is_in_for_loop_init(decl_node: &Node) -> bool {
if let Some(parent) = decl_node.parent() {
if parent.kind() == "for_statement" {
// Check if this declaration is the initializer field
if let Some(init) = parent.child_by_field_name("initializer") {
return init.id() == decl_node.id();
}
}
}
false
}
fn has_const_qualifier(node: &Node, source: &str) -> bool {
let text = &source[node.start_byte()..node.end_byte()];
text.contains("const")
}
fn should_be_const(
decl_node: &Node,
declarator_node: &Node,
value_node: &Node,
var_name: &str,
source: &str,
) -> bool {
let value_text = &source[value_node.start_byte()..value_node.end_byte()];
let decl_text = &source[decl_node.start_byte()..decl_node.end_byte()];
let var_lower = var_name.to_lowercase();
// Check if this is a char array or pointer type
let is_char_type = decl_text.contains("char");
let is_array = declarator_node.kind() == "array_declarator";
let is_pointer = is_pointer_declarator(declarator_node);
let has_string_literal = value_text.starts_with('"') && value_text.ends_with('"');
let has_brace_init = value_text.contains('{') && value_text.contains('}');
// Exclude temporary/working variables that are likely to be modified
let excluded_prefixes = ["current_", "temp_", "tmp_", "buffer_", "buf_", "work_"];
if excluded_prefixes
.iter()
.any(|prefix| var_lower.starts_with(prefix))
{
return false;
}
// Pattern 1: Char arrays with string literals (HIGH CONFIDENCE)
// Example: char config_dir[] = "/etc";
if is_char_type && is_array && has_string_literal {
return true;
}
// Pattern 2: Char pointers with string literals (HIGH CONFIDENCE)
// Example: char *str = "literal"; (should be: const char *str)
if is_char_type && is_pointer && has_string_literal {
return true;
}
// Pattern 3: Function pointer arrays (HIGH CONFIDENCE)
// Example: int (*operations[])(int, int) = {add, subtract, ...};
if is_array && has_brace_init && decl_text.contains("(*") {
return true;
}
// Pattern 4: Arrays with brace initializers and semantic naming
// Only flag arrays that have meaningful constant-like names
// Exclude generic working data names
if is_array && has_brace_init {
// Exclude generic/working data names
let excluded_patterns = [
"fibonacci",
"test",
"temp",
"tmp",
"buffer",
"buf",
"_array",
"_data",
"sort",
"work",
"example",
"demo",
];
let is_excluded = excluded_patterns
.iter()
.any(|pattern| var_lower.contains(pattern));
if !is_excluded {
// Include arrays with semantic names indicating lookup tables or constants
let semantic_patterns = [
"days",
"month",
"prime",
"color",
"command",
"lookup",
"table",
"digit",
"palette",
"rgb",
"hex",
"state",
"operation",
"function",
"menu",
];
if semantic_patterns
.iter()
.any(|pattern| var_lower.contains(pattern))
{
return true;
}
}
}
// Pattern 5: Simple int scalars with numeric literals and semantic naming
// Example: int rows = 3; (used as loop limit)
let is_int_type = decl_text.contains("int");
let is_scalar = !is_array && !is_pointer;
let is_numeric_literal = value_text
.chars()
.all(|c| c.is_numeric() || c == '-' || c == '+');
if is_int_type && is_scalar && is_numeric_literal {
// Exclude counter/accumulator variables that are typically modified
let counter_patterns = ["count", "counter", "index", "step", "iter"];
if counter_patterns
.iter()
.any(|pattern| var_lower.contains(pattern))
{
return false;
}
// Only flag if the variable has a semantic name suggesting it's a BOUND/LIMIT
let scalar_constant_patterns = [
"rows", "cols", "columns", "_size", "limit", "bound", "width", "height", "depth",
"num_", "start_", "end_", "batch_",
];
if scalar_constant_patterns
.iter()
.any(|pattern| var_lower.contains(pattern))
{
return true;
}
}
// Pattern 6: Well-known mathematical and scientific constant names
let math_physics_constants = [
"pi",
"tau",
"euler",
"e", // Mathematical constants
"gravity",
"g",
"speed_of_light",
"c",
"planck",
"h", // Physics constants
"avogadro",
"boltzmann",
"gas_constant",
"r", // Chemistry/thermodynamics
"epsilon",
"mu",
"sigma", // Greek letter constants
];
for constant in &math_physics_constants {
if var_lower == *constant || var_lower.ends_with(&format!("_{}", constant)) {
return true;
}
}
// Pattern 7: Conversion factors and rates
let conversion_patterns = [
"_per_", "_to_", "_rate", "_factor", "_ratio", "meters_", "kg_", "pounds_", "miles_",
"feet_",
];
for pattern in &conversion_patterns {
if var_lower.contains(pattern) {
return true;
}
}
// Pattern 8: ALL_CAPS naming (indicates constant intent)
if var_name.len() > 1 {
let all_caps = var_name
.chars()
.all(|c| c.is_uppercase() || c == '_' || c.is_numeric());
let has_alpha = var_name.chars().any(|c| c.is_alphabetic());
if all_caps && has_alpha {
return true;
}
}
// Pattern 9: kConstant naming convention
if var_name.starts_with("k") && var_name.len() > 1 {
if let Some(second_char) = var_name.chars().nth(1) {
if second_char.is_uppercase() {
return true;
}
}
}
// Pattern 10: Common constant suffixes
let constant_suffixes = [
"_MAX",
"_MIN",
"_SIZE",
"_COUNT",
"_LIMIT",
"_CAPACITY",
"_LENGTH",
"_WIDTH",
"_HEIGHT",
"_TIMEOUT",
"_INTERVAL",
"_THRESHOLD",
];
for suffix in &constant_suffixes {
if var_name.contains(suffix) {
return true;
}
}
// Pattern 11: File and path related names with string literals
// Only flag if it's also a char array/pointer with a string literal
if is_char_type && has_string_literal {
let path_file_patterns = [
"_dir",
"_path",
"_folder",
"_directory",
"_extension",
"_ext",
"_prefix",
"_suffix",
"_url",
"_uri",
"_pattern",
"_format",
"_template",
];
for pattern in &path_file_patterns {
if var_lower.contains(pattern) {
return true;
}
}
// Also check for common file-related words
if var_lower.contains("file") && has_string_literal {
// Only if it's a string literal assignment, not a FILE* pointer
return true;
}
}
// Pattern 12: Struct initializations with semantic names
// Example: struct Point origin = {0.0, 0.0, 0.0};
if has_brace_init && decl_text.contains("struct") {
let struct_constant_names = [
"origin",
"config",
"configuration",
"default",
"initial",
"settings",
"options",
"params",
"parameters",
];
for name in &struct_constant_names {
if var_lower.contains(name) {
return true;
}
}
}
false
}
fn is_pointer_declarator(node: &Node) -> bool {
node.kind() == "pointer_declarator" || node.to_sexp().contains("pointer_declarator")
}