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

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

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

pub struct UseExplicitDefaultFlags;

/// Mapping of (function_name, arg_position, replacement_constant)
/// arg_position is 0-indexed
const FLAG_REPLACEMENTS: &[(&str, usize, &str)] = &[
    // GApplication
    ("g_application_new", 1, "G_APPLICATION_DEFAULT_FLAGS"),
    // GTK bindings
    ("gtk_widget_class_add_binding", 2, "GDK_NO_MODIFIER_MASK"),
    (
        "gtk_widget_class_add_binding_signal",
        2,
        "GDK_NO_MODIFIER_MASK",
    ),
    (
        "gtk_widget_class_add_binding_action",
        2,
        "GDK_NO_MODIFIER_MASK",
    ),
    // GtkShortcut
    ("gtk_shortcut_new", 1, "GDK_NO_MODIFIER_MASK"),
    // GDBus
    ("g_dbus_connection_new", 1, "G_DBUS_CONNECTION_FLAGS_NONE"),
    (
        "g_dbus_connection_new_for_address",
        1,
        "G_DBUS_CONNECTION_FLAGS_NONE",
    ),
    ("g_dbus_proxy_new", 2, "G_DBUS_PROXY_FLAGS_NONE"),
    ("g_dbus_proxy_new_for_bus", 2, "G_DBUS_PROXY_FLAGS_NONE"),
    // GFile
    ("g_file_query_info", 2, "G_FILE_QUERY_INFO_NONE"),
    ("g_file_query_info_async", 2, "G_FILE_QUERY_INFO_NONE"),
    ("g_file_enumerate_children", 1, "G_FILE_QUERY_INFO_NONE"),
    (
        "g_file_enumerate_children_async",
        1,
        "G_FILE_QUERY_INFO_NONE",
    ),
    // GSubprocess
    ("g_subprocess_new", 0, "G_SUBPROCESS_FLAGS_NONE"),
    ("g_subprocess_launcher_new", 0, "G_SUBPROCESS_FLAGS_NONE"),
    // GSettings
    (
        "g_settings_new_with_backend_and_path",
        3,
        "G_SETTINGS_BIND_DEFAULT",
    ),
    // GtkApplication
    ("gtk_application_new", 1, "G_APPLICATION_DEFAULT_FLAGS"),
    // AdwApplication (libadwaita)
    ("adw_application_new", 1, "G_APPLICATION_DEFAULT_FLAGS"),
    // GtkIconTheme (GTK 4.18+)
    ("gtk_icon_theme_lookup_icon", 6, "GTK_ICON_LOOKUP_NONE"),
    ("gtk_icon_theme_lookup_by_gicon", 5, "GTK_ICON_LOOKUP_NONE"),
    // GtkDropTargetAsync (GTK 4.20+)
    ("gtk_drop_target_async_new", 1, "GDK_ACTION_NONE"),
    ("gtk_drop_target_new", 1, "GDK_ACTION_NONE"),
];

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

    fn description(&self) -> &'static str {
        "Use explicit default flag constants (e.g., G_APPLICATION_DEFAULT_FLAGS) instead of 0"
    }

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

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

    fn check_func_impl(
        &self,
        _ast_context: &AstContext,
        _config: &Config,
        func: &FunctionDefItem,
        file: &FileModel,
        violations: &mut Vec<Violation>,
    ) {
        // Collect all function names from FLAG_REPLACEMENTS
        let function_names: Vec<&str> = FLAG_REPLACEMENTS.iter().map(|(name, ..)| *name).collect();

        for call in func.find_calls(&function_names) {
            self.check_call(file, call, violations);
        }
    }
}

impl UseExplicitDefaultFlags {
    fn check_call(&self, file: &FileModel, call: &CallExpression, violations: &mut Vec<Violation>) {
        // Find the matching replacement rule
        for &(target_func, arg_pos, replacement_const) in FLAG_REPLACEMENTS {
            if call.is_function(target_func) {
                if let Some(arg_expr) = call.get_arg(arg_pos)
                    && arg_expr.is_zero()
                {
                    let fix = Fix::new(
                        arg_expr.location().start_byte,
                        arg_expr.location().end_byte,
                        replacement_const.to_string(),
                    );

                    violations.push(self.violation_with_fix_at(
                        &file.path,
                        &call.location,
                        format!(
                            "Use {} instead of 0 for {}() flags parameter",
                            replacement_const, target_func
                        ),
                        fix,
                    ));
                }
                break;
            }
        }
    }
}