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

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// from webkit2gtk-gir-files
// DO NOT EDIT

use crate::UserContentInjectedFrames;
use crate::UserScriptInjectionTime;
use glib::translate::*;

glib::wrapper! {
    /// A JavaScript snippet which can be injected in loaded pages.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct UserScript(Shared<ffi::WebKitUserScript>);

    match fn {
        ref => |ptr| ffi::webkit_user_script_ref(ptr),
        unref => |ptr| ffi::webkit_user_script_unref(ptr),
        type_ => || ffi::webkit_user_script_get_type(),
    }
}

impl UserScript {
    /// Creates a new user script.
    ///
    /// Scripts can be applied to some URIs
    /// only by passing non-null values for `allow_list` or `block_list`. Passing a
    /// [`None`] allow_list implies that all URIs are on the allow_list. The script
    /// is applied if an URI matches the allow_list and not the block_list.
    /// URI patterns must be of the form `[protocol]://[host]/[path]`, where the
    /// *host* and *path* components can contain the wildcard character (`*`) to
    /// represent zero or more other characters.
    /// ## `source`
    /// Source code of the user script.
    /// ## `injected_frames`
    /// A [`UserContentInjectedFrames`][crate::UserContentInjectedFrames] value
    /// ## `injection_time`
    /// A [`UserScriptInjectionTime`][crate::UserScriptInjectionTime] value
    /// ## `allow_list`
    /// An allow_list of URI patterns or [`None`]
    /// ## `block_list`
    /// A block_list of URI patterns or [`None`]
    ///
    /// # Returns
    ///
    /// A new [`UserScript`][crate::UserScript]
    #[doc(alias = "webkit_user_script_new")]
    pub fn new(
        source: &str,
        injected_frames: UserContentInjectedFrames,
        injection_time: UserScriptInjectionTime,
        allow_list: &[&str],
        block_list: &[&str],
    ) -> UserScript {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::webkit_user_script_new(
                source.to_glib_none().0,
                injected_frames.into_glib(),
                injection_time.into_glib(),
                allow_list.to_glib_none().0,
                block_list.to_glib_none().0,
            ))
        }
    }

    /// Creates a new user script for script world with name `world_name`.
    ///
    /// See [`new()`][Self::new()] for a full description.
    /// ## `source`
    /// Source code of the user script.
    /// ## `injected_frames`
    /// A [`UserContentInjectedFrames`][crate::UserContentInjectedFrames] value
    /// ## `injection_time`
    /// A [`UserScriptInjectionTime`][crate::UserScriptInjectionTime] value
    /// ## `world_name`
    /// the name of a `WebKitScriptWorld`
    /// ## `allow_list`
    /// An allow_list of URI patterns or [`None`]
    /// ## `block_list`
    /// A block_list of URI patterns or [`None`]
    ///
    /// # Returns
    ///
    /// A new [`UserScript`][crate::UserScript]
    #[cfg(any(feature = "v2_22", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_22")))]
    #[doc(alias = "webkit_user_script_new_for_world")]
    #[doc(alias = "new_for_world")]
    pub fn for_world(
        source: &str,
        injected_frames: UserContentInjectedFrames,
        injection_time: UserScriptInjectionTime,
        world_name: &str,
        allow_list: &[&str],
        block_list: &[&str],
    ) -> UserScript {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::webkit_user_script_new_for_world(
                source.to_glib_none().0,
                injected_frames.into_glib(),
                injection_time.into_glib(),
                world_name.to_glib_none().0,
                allow_list.to_glib_none().0,
                block_list.to_glib_none().0,
            ))
        }
    }
}