summaryrefslogtreecommitdiff
path: root/core/gjs/src/astalify.ts
blob: a3e5f6288b97b5212de929ae5164aa6a2d8d8c44 (plain)
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
import Binding, { kebabify, snakeify, type Connectable, type Subscribable } from "./binding.js"
import { Astal, Gtk, Gdk } from "./imports.js"
import { execAsync } from "./process.js"
import Variable from "./variable.js"

Object.defineProperty(Astal.Box.prototype, "children", {
    get() { return this.get_children() },
    set(v) { this.set_children(v) },
})

function setChildren(parent: Gtk.Widget, children: Gtk.Widget[]) {
    children = children.flat(Infinity).map(ch => ch instanceof Gtk.Widget
        ? ch
        : new Gtk.Label({ visible: true, label: String(ch) }))

    // remove
    if (parent instanceof Gtk.Bin) {
        const ch = parent.get_child()
        if (ch)
            parent.remove(ch)
    }
    else if (parent instanceof Gtk.container &&
            !(parent instanceof Astal.Box ||
              parent instanceof Astal.Stack)) {
        for(const ch of parent.get_children())
	          parent.remove(ch)
	  }

    // TODO: add more container types
    if (parent instanceof Astal.Box) {
        parent.set_children(children)
    }

    else if (parent instanceof Astal.Stack) {
        parent.set_children(children)
    }

    else if (parent instanceof Astal.CenterBox) {
        parent.startWidget = children[0]
        parent.centerWidget = children[1]
        parent.endWidget = children[2]
    }

    else if (parent instanceof Astal.Overlay) {
        const [child, ...overlays] = children
        parent.set_child(child)
        parent.set_overlays(overlays)
    }

    else if (parent instanceof Gtk.Container) {
        for (const ch of children)
            parent.add(ch)
    }
}

function mergeBindings(array: any[]) {
    function getValues(...args: any[]) {
        let i = 0
        return array.map(value => value instanceof Binding
            ? args[i++]
            : value,
        )
    }

    const bindings = array.filter(i => i instanceof Binding)

    if (bindings.length === 0)
        return array

    if (bindings.length === 1)
        return bindings[0].as(getValues)

    return Variable.derive(bindings, getValues)()
}

function setProp(obj: any, prop: string, value: any) {
    try {
        const setter = `set_${snakeify(prop)}`
        if (typeof obj[setter] === "function")
            return obj[setter](value)

        if (Object.hasOwn(obj, prop))
            return (obj[prop] = value)
    }
    catch (error) {
        console.error(`could not set property "${prop}" on ${obj}:`, error)
    }

    console.error(`could not set property "${prop}" on ${obj}`)
}

export type Widget<C extends InstanceType<typeof Gtk.Widget>> = C & {
    className: string
    css: string
    cursor: Cursor
    clickThrough: boolean
    toggleClassName(name: string, on?: boolean): void
    hook(
        object: Connectable,
        signal: string,
        callback: (self: Widget<C>, ...args: any[]) => void,
    ): Widget<C>
    hook(
        object: Subscribable,
        callback: (self: Widget<C>, ...args: any[]) => void,
    ): Widget<C>
}

function hook(
    self: Gtk.Widget,
    object: Connectable | Subscribable,
    signalOrCallback: string | ((self: Gtk.Widget, ...args: any[]) => void),
    callback?: (self: Gtk.Widget, ...args: any[]) => void,
) {
    if (typeof object.connect === "function" && callback) {
        const id = object.connect(signalOrCallback, (_: any, ...args: unknown[]) => {
            callback(self, ...args)
        })
        self.connect("destroy", () => {
            (object.disconnect as Connectable["disconnect"])(id)
        })
    }

    else if (typeof object.subscribe === "function" && typeof signalOrCallback === "function") {
        const unsub = object.subscribe((...args: unknown[]) => {
            signalOrCallback(self, ...args)
        })
        self.connect("destroy", unsub)
    }

    return self
}

function ctor(self: any, config: any = {}, children: any = []) {
    const { setup, ...props } = config
    props.visible ??= true

    // collect bindings
    const bindings = Object.keys(props).reduce((acc: any, prop) => {
        if (props[prop] instanceof Binding) {
            const binding = props[prop]
            delete props[prop]
            return [...acc, [prop, binding]]
        }
        return acc
    }, [])

    // collect signal handlers
    const onHandlers = Object.keys(props).reduce((acc: any, key) => {
        if (key.startsWith("on")) {
            const sig = kebabify(key).split("-").slice(1).join("-")
            const handler = props[key]
            delete props[key]
            return [...acc, [sig, handler]]
        }
        return acc
    }, [])

    // set children
    children = mergeBindings(children.flat(Infinity))
    if (children instanceof Binding) {
        setChildren(self, children.get())
        self.connect("destroy", children.subscribe((v) => {
            setChildren(self, v)
        }))
    }
    else {
        if (children.length > 0) {
            setChildren(self, children)
        }
    }

    // setup signal handlers
    for (const [signal, callback] of onHandlers) {
        if (typeof callback === "function") {
            self.connect(signal, callback)
        }
        else {
            self.connect(signal, () => execAsync(callback)
                .then(print).catch(console.error))
        }
    }

    // setup bindings handlers
    for (const [prop, binding] of bindings) {
        if (prop === "child" || prop === "children") {
            self.connect("destroy", binding.subscribe((v: any) => {
                setChildren(self, v)
            }))
        }
        self.connect("destroy", binding.subscribe((v: any) => {
            setProp(self, prop, v)
        }))
        setProp(self, prop, binding.get())
    }

    Object.assign(self, props)
    setup?.(self)
    return self
}

function proxify<
    C extends typeof Gtk.Widget,
>(klass: C) {
    Object.defineProperty(klass.prototype, "className", {
        get() { return Astal.widget_get_class_names(this).join(" ") },
        set(v) { Astal.widget_set_class_names(this, v.split(/\s+/)) },
    })

    Object.defineProperty(klass.prototype, "css", {
        get() { return Astal.widget_get_css(this) },
        set(v) { Astal.widget_set_css(this, v) },
    })

    Object.defineProperty(klass.prototype, "cursor", {
        get() { return Astal.widget_get_cursor(this) },
        set(v) { Astal.widget_set_cursor(this, v) },
    })

    Object.defineProperty(klass.prototype, "clickThrough", {
        get() { return Astal.widget_get_click_through(this) },
        set(v) { Astal.widget_set_click_through(this, v) },
    })

    Object.assign(klass.prototype, {
        hook: function (obj: any, sig: any, callback: any) {
            return hook(this as InstanceType<C>, obj, sig, callback)
        },
        toggleClassName: function name(cn: string, cond = true) {
            Astal.widget_toggle_class_name(this as InstanceType<C>, cn, cond)
        },
        set_class_name: function (name: string) {
            // @ts-expect-error unknown key
            this.className = name
        },
        set_css: function (css: string) {
            // @ts-expect-error unknown key
            this.css = css
        },
        set_cursor: function (cursor: string) {
            // @ts-expect-error unknown key
            this.cursor = cursor
        },
        set_click_through: function (clickThrough: boolean) {
            // @ts-expect-error unknown key
            this.clickThrough = clickThrough
        },
    })

    const proxy = new Proxy(klass, {
        construct(_, [conf, ...children]) {
            // @ts-expect-error abstract class
            return ctor(new klass(), conf, children)
        },
        apply(_t, _a, [conf, ...children]) {
            // @ts-expect-error abstract class
            return ctor(new klass(), conf, children)
        },
    })

    return proxy
}

export default function astalify<
    C extends typeof Gtk.Widget,
    P extends Record<string, any>,
    N extends string = "Widget",
>(klass: C) {
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    type Astal<N> = Omit<C, "new"> & {
        new(props?: P, ...children: Gtk.Widget[]): Widget<InstanceType<C>>
        (props?: P, ...children: Gtk.Widget[]): Widget<InstanceType<C>>
    }

    return proxify(klass) as unknown as Astal<N>
}

type BindableProps<T> = {
    [K in keyof T]: Binding<T[K]> | T[K];
}

type SigHandler<
    W extends InstanceType<typeof Gtk.Widget>,
    Args extends Array<unknown>,
> = ((self: Widget<W>, ...args: Args) => unknown) | string | string[]

export type ConstructProps<
    Self extends InstanceType<typeof Gtk.Widget>,
    Props extends Gtk.Widget.ConstructorProps,
    Signals extends Record<`on${string}`, Array<unknown>> = Record<`on${string}`, any[]>,
> = Partial<{
    // @ts-expect-error can't assign to unknown, but it works as expected though
    [S in keyof Signals]: SigHandler<Self, Signals[S]>
}> & Partial<{
    [Key in `on${string}`]: SigHandler<Self, any[]>
}> & BindableProps<Partial<Props> & {
    className?: string
    css?: string
    cursor?: string
    clickThrough?: boolean
}> & {
    onDestroy?: (self: Widget<Self>) => unknown
    onDraw?: (self: Widget<Self>) => unknown
    onKeyPressEvent?: (self: Widget<Self>, event: Gdk.Event) => unknown
    onKeyReleaseEvent?: (self: Widget<Self>, event: Gdk.Event) => unknown
    onButtonPressEvent?: (self: Widget<Self>, event: Gdk.Event) => unknown
    onButtonReleaseEvent?: (self: Widget<Self>, event: Gdk.Event) => unknown
    onRealize?: (self: Widget<Self>) => unknown
    setup?: (self: Widget<Self>) => void
}

type Cursor =
    | "default"
    | "help"
    | "pointer"
    | "context-menu"
    | "progress"
    | "wait"
    | "cell"
    | "crosshair"
    | "text"
    | "vertical-text"
    | "alias"
    | "copy"
    | "no-drop"
    | "move"
    | "not-allowed"
    | "grab"
    | "grabbing"
    | "all-scroll"
    | "col-resize"
    | "row-resize"
    | "n-resize"
    | "e-resize"
    | "s-resize"
    | "w-resize"
    | "ne-resize"
    | "nw-resize"
    | "sw-resize"
    | "se-resize"
    | "ew-resize"
    | "ns-resize"
    | "nesw-resize"
    | "nwse-resize"
    | "zoom-in"
    | "zoom-out"