gobject-linter 0.1.2

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
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

use gobject_ast::model::{FileModel, FunctionDefItem};

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

const RENAMES: &[FunctionRename] = &[
    FunctionRename {
        from: "tolower",
        to: Some("g_ascii_tolower"),
        message: "Use g_ascii_tolower() instead of tolower() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "toupper",
        to: Some("g_ascii_toupper"),
        message: "Use g_ascii_toupper() instead of toupper() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isdigit",
        to: Some("g_ascii_isdigit"),
        message: "Use g_ascii_isdigit() instead of isdigit() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isalpha",
        to: Some("g_ascii_isalpha"),
        message: "Use g_ascii_isalpha() instead of isalpha() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isalnum",
        to: Some("g_ascii_isalnum"),
        message: "Use g_ascii_isalnum() instead of isalnum() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isspace",
        to: Some("g_ascii_isspace"),
        message: "Use g_ascii_isspace() instead of isspace() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isupper",
        to: Some("g_ascii_isupper"),
        message: "Use g_ascii_isupper() instead of isupper() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "islower",
        to: Some("g_ascii_islower"),
        message: "Use g_ascii_islower() instead of islower() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isxdigit",
        to: Some("g_ascii_isxdigit"),
        message: "Use g_ascii_isxdigit() instead of isxdigit() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "ispunct",
        to: Some("g_ascii_ispunct"),
        message: "Use g_ascii_ispunct() instead of ispunct() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isprint",
        to: Some("g_ascii_isprint"),
        message: "Use g_ascii_isprint() instead of isprint() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "isgraph",
        to: Some("g_ascii_isgraph"),
        message: "Use g_ascii_isgraph() instead of isgraph() — C ctype functions are locale-dependent",
    },
    FunctionRename {
        from: "iscntrl",
        to: Some("g_ascii_iscntrl"),
        message: "Use g_ascii_iscntrl() instead of iscntrl() — C ctype functions are locale-dependent",
    },
];

pub struct UseGAsciiFunctions;

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

    fn description(&self) -> &'static str {
        "Use g_ascii_* functions instead of locale-dependent C ctype functions"
    }

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

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

    fn check_func_impl(
        &self,
        _ast_context: &AstContext,
        config: &Config,
        func: &FunctionDefItem,
        file: &FileModel,
        violations: &mut Vec<Violation>,
    ) {
        self.check_function_renames(func, file, config, violations, RENAMES);
    }
}