gobject-linter 0.1.1

A fast tree-sitter-based linter for GObject/C code
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

use crate::{
    ast_context::AstContext,
    config::Config,
    rules::{Rule, Violation},
};

pub struct UseGStrlcpy;

impl Rule for UseGStrlcpy {
    fn name(&self) -> &'static str {
        "use_g_strlcpy"
    }

    fn description(&self) -> &'static str {
        "Use g_strlcpy/g_strlcat instead of unsafe strcpy/strcat/strncat"
    }

    fn category(&self) -> crate::rules::Category {
        crate::rules::Category::Correctness
    }

    fn fixable(&self) -> bool {
        false
    }

    fn check_func_impl(
        &self,
        _ast_context: &AstContext,
        _config: &Config,
        func: &gobject_ast::top_level::FunctionDefItem,
        file: &gobject_ast::FileModel,
        violations: &mut Vec<Violation>,
    ) {
        for call in func.find_calls(&["strcpy", "strcat", "strncat"]) {
            let Some(func_name) = call.function_name_str() else {
                continue;
            };
            let message = match func_name {
                "strcpy" => {
                    "Use g_strlcpy(dst, src, sizeof(dst)) instead of strcpy — no bounds checking"
                }
                "strcat" => {
                    "Use g_strlcat(dst, src, sizeof(dst)) instead of strcat — no bounds checking"
                }
                "strncat" => {
                    "Use g_strlcat(dst, src, sizeof(dst)) instead of strncat — strncat's n parameter is the max to append, not the buffer size, which is error-prone"
                }
                _ => continue,
            };

            violations.push(self.violation(
                &file.path,
                call.location.line,
                call.location.column,
                message.to_string(),
            ));
        }
    }
}