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

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

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

pub struct UseGGnucFlagEnum;

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

    fn description(&self) -> &'static str {
        "Use G_GNUC_FLAG_ENUM for enums that represent bit flags"
    }

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

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

    fn min_glib_version(&self) -> Option<(u32, u32)> {
        Some((2, 87))
    }

    fn check_enum(
        &self,
        _ast_context: &AstContext,
        _config: &Config,
        enum_info: &EnumInfo,
        file: &FileModel,
        violations: &mut Vec<Violation>,
    ) {
        let Some(ref enum_name) = enum_info.name else {
            return;
        };

        if !enum_info.is_flags_enum() {
            return;
        }

        if enum_info.has_attribute("G_GNUC_FLAG_ENUM") {
            return;
        }

        let fix = self.generate_fix(enum_info, enum_name);

        violations.push(self.violation_with_fix_at(
            &file.path,
            &enum_info.location,
            format!(
                "Enum '{}' appears to be a flags enum but is missing G_GNUC_FLAG_ENUM attribute",
                enum_name
            ),
            fix,
        ));
    }
}

impl UseGGnucFlagEnum {
    fn generate_fix(&self, enum_info: &EnumInfo, enum_name: &str) -> Fix {
        let typedef_text = enum_info.location.as_str().unwrap_or("");

        if let Some(closing_brace_pos) = typedef_text.rfind('}') {
            let after_brace = &typedef_text[closing_brace_pos + 1..];

            if let Some(name_offset) = after_brace.find(enum_name) {
                let insert_pos =
                    enum_info.location.start_byte + closing_brace_pos + 1 + name_offset;

                return Fix::new(insert_pos, insert_pos, "G_GNUC_FLAG_ENUM ".to_string());
            }
        }

        Fix::new(
            enum_info.location.end_byte - 1,
            enum_info.location.end_byte - 1,
            " G_GNUC_FLAG_ENUM".to_string(),
        )
    }
}