element.c File Reference

#include "container.h"
#include "element.h"
#include "input.h"
#include "util.h"
#include <math.h>
#include <stdlib.h>
#include <wayland-util.h>
#include <wlr/types/wlr_keyboard.h>
#include <wlr/types/wlr_scene.h>
#include <wlr/util/box.h>
#include <libbase/libbase.h>

Include dependency graph for element.c:

Functions
static bool	_wlmtk_element_pointer_button (wlmtk_element_t *element_ptr, const wlmtk_button_event_t *button_event_ptr)
static bool	_wlmtk_element_pointer_axis (wlmtk_element_t *element_ptr, struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
static void	_wlmtk_element_keyboard_blur (wlmtk_element_t *element_ptr)
static bool	_wlmtk_element_keyboard_event (wlmtk_element_t *element_ptr, struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr)
static bool	_wlmtk_element_keyboard_sym (wlmtk_element_t *element_ptr, xkb_keysym_t keysym, enum xkb_key_direction direction, uint32_t modifiers)
static void	handle_wlr_scene_node_destroy (struct wl_listener *listener_ptr, void *data_ptr)
bool	wlmtk_element_init (wlmtk_element_t *element_ptr)
wlmtk_element_vmt_t	wlmtk_element_extend (wlmtk_element_t *element_ptr, const wlmtk_element_vmt_t *element_vmt_ptr)
void	wlmtk_element_fini (wlmtk_element_t *element_ptr)
bs_dllist_node_t *	wlmtk_dlnode_from_element (wlmtk_element_t *element_ptr)
wlmtk_element_t *	wlmtk_element_from_dlnode (bs_dllist_node_t *dlnode_ptr)
void	wlmtk_element_set_parent_container (wlmtk_element_t *element_ptr, wlmtk_container_t *parent_container_ptr)
void	wlmtk_element_attach_to_scene_graph (wlmtk_element_t *element_ptr)
void	wlmtk_element_set_visible (wlmtk_element_t *element_ptr, bool visible)
void	wlmtk_element_get_position (wlmtk_element_t *element_ptr, int *x_ptr, int *y_ptr)
void	wlmtk_element_set_position (wlmtk_element_t *element_ptr, int x, int y)
bool	wlmtk_element_pointer_motion (wlmtk_element_t *element_ptr, wlmtk_pointer_motion_event_t *motion_event_ptr)
bool	wlmtk_element_pointer_button (wlmtk_element_t *element_ptr, const wlmtk_button_event_t *button_event_ptr)
bool	wlmtk_element_pointer_axis (wlmtk_element_t *element_ptr, struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
bool	wlmtk_element_pointer_focus (wlmtk_element_t *element_ptr, wlmtk_pointer_motion_event_t *motion_event_ptr)
void	wlmtk_element_pointer_blur (wlmtk_element_t *element_ptr)
void	wlmtk_element_pointer_grab_cancel (wlmtk_element_t *element_ptr)
static void	fake_destroy (wlmtk_element_t *element_ptr)
static struct wlr_scene_node *	fake_create_scene_node (wlmtk_element_t *element_ptr, struct wlr_scene_tree *wlr_scene_tree_ptr)
static void	fake_get_dimensions (wlmtk_element_t *element_ptr, int *left_ptr, int *top_ptr, int *right_ptr, int *bottom_ptr)
static bool	fake_pointer_accepts_motion (wlmtk_element_t *element_ptr, wlmtk_pointer_motion_event_t *motion_event_ptr)
static bool	fake_pointer_button (wlmtk_element_t *element_ptr, const wlmtk_button_event_t *button_event_ptr)
static bool	fake_pointer_axis (wlmtk_element_t *element_ptr, struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
static void	fake_pointer_grab_cancel (wlmtk_element_t *element_ptr)
static void	fake_keyboard_blur (wlmtk_element_t *element_ptr)
static bool	fake_keyboard_event (wlmtk_element_t *element_ptr, struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr)
static bool	fake_keyboard_sym (wlmtk_element_t *element_ptr, xkb_keysym_t keysym, enum xkb_key_direction direction, uint32_t modifiers)
wlmtk_fake_element_t *	wlmtk_fake_element_create (void)
void	wlmtk_fake_element_grab_keyboard (wlmtk_fake_element_t *fake_element_ptr)
static void	test_init_fini (bs_test_t *test_ptr)
static void	test_set_parent_container (bs_test_t *test_ptr)
static void	test_set_get_position (bs_test_t *test_ptr)
static void	test_get_dimensions (bs_test_t *test_ptr)
static void	test_pointer_motion (bs_test_t *test_ptr)
static void	test_pointer_button (bs_test_t *test_ptr)
static void	test_pointer_axis (bs_test_t *test_ptr)
static void	test_keyboard_focus (bs_test_t *test_ptr)
static void	test_keyboard_activity (bs_test_t *test_ptr)

Variables
static const wlmtk_element_vmt_t	element_vmt
static const wlmtk_element_vmt_t	fake_element_vmt
const bs_test_case_t	wlmtk_element_test_cases []

Detailed Description

Copyright

Copyright 2023 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Function Documentation

_wlmtk_element_keyboard_blur()

void _wlmtk_element_keyboard_blur ( wlmtk_element_t *  element_ptr )

static

Handler for losing keyboard focus. Nothing for default impl.

_wlmtk_element_keyboard_event()

bool _wlmtk_element_keyboard_event ( wlmtk_element_t *  element_ptr, struct wlr_keyboard_key_event *  wlr_keyboard_key_event_ptr  )

static

Handler for keyboard events. By default: Nothing is handled.

_wlmtk_element_keyboard_sym()

static bool _wlmtk_element_keyboard_sym ( wlmtk_element_t *  element_ptr, xkb_keysym_t  keysym, enum xkb_key_direction  direction, uint32_t  modifiers  )

static

Handler for translated keys. By default: Nothing is handled.

_wlmtk_element_pointer_axis()

bool _wlmtk_element_pointer_axis ( wlmtk_element_t *  element_ptr, struct wlr_pointer_axis_event *  wlr_pointer_axis_event_ptr  )

static

Does nothing, returns false.

_wlmtk_element_pointer_button()

bool _wlmtk_element_pointer_button ( wlmtk_element_t *  element_ptr, const wlmtk_button_event_t *  button_event_ptr  )

static

Does nothing, returns false.

fake_create_scene_node()

struct wlr_scene_node * fake_create_scene_node ( wlmtk_element_t *  element_ptr, struct wlr_scene_tree *  wlr_scene_tree_ptr  )

static

A "fake" 'create_scene_node': Creates a non-attached buffer node.

fake_destroy()

void fake_destroy ( wlmtk_element_t *  element_ptr )

static

dtor for the "fake" element used for tests.

fake_get_dimensions()

void fake_get_dimensions ( wlmtk_element_t *  element_ptr, int *  left_ptr, int *  top_ptr, int *  right_ptr, int *  bottom_ptr  )

static

A "fake" 'get_dimensions'.

fake_keyboard_blur()

void fake_keyboard_blur ( wlmtk_element_t *  element_ptr )

static

Registers losing keyboard focus.

fake_keyboard_event()

bool fake_keyboard_event ( wlmtk_element_t *  element_ptr, struct wlr_keyboard_key_event *  wlr_keyboard_key_event_ptr  )

static

Handles 'keyboard_event' events for the fake element.

fake_keyboard_sym()

bool fake_keyboard_sym ( wlmtk_element_t *  element_ptr, xkb_keysym_t  keysym, enum xkb_key_direction  direction, uint32_t  modifiers  )

static

Handles 'keyboard_sym' events for the fake element.

fake_pointer_accepts_motion()

bool fake_pointer_accepts_motion ( wlmtk_element_t *  element_ptr, wlmtk_pointer_motion_event_t *  motion_event_ptr  )

static

Implements wlmtk_element_vmt_t::pointer_accepts_motion.

fake_pointer_axis()

bool fake_pointer_axis ( wlmtk_element_t *  element_ptr, struct wlr_pointer_axis_event *  wlr_pointer_axis_event_ptr  )

static

Handles 'axis' events for the fake element.

fake_pointer_button()

bool fake_pointer_button ( wlmtk_element_t *  element_ptr, const wlmtk_button_event_t *  button_event_ptr  )

static

Handles 'button' events for the fake element.

fake_pointer_grab_cancel()

void fake_pointer_grab_cancel ( wlmtk_element_t *  element_ptr )

static

Records calls to wlmtk_element_vmt_t::pointer_grab_cancel.

handle_wlr_scene_node_destroy()

void handle_wlr_scene_node_destroy ( struct wl_listener *  listener_ptr, void *  data_ptr  )

static

Handles the 'destroy' callback of the wlr_scene_node.

A call here indicates that teardown was not executed properly!

Parameters

listener_ptr
data_ptr

test_get_dimensions()

void test_get_dimensions ( bs_test_t *  test_ptr )

static

Tests get_dimensions.

test_init_fini()

void test_init_fini ( bs_test_t *  test_ptr )

static

Exercises init() and fini() methods, verifies dtor forwarding.

test_keyboard_activity()

void test_keyboard_activity ( bs_test_t *  test_ptr )

static

Exercises "keyboard_event" and "keyboard_sym" methods.

test_keyboard_focus()

void test_keyboard_focus ( bs_test_t *  test_ptr )

static

Exercises keyboard grab & blur methods.

test_pointer_axis()

void test_pointer_axis ( bs_test_t *  test_ptr )

static

Exercises "pointer_axis" method.

test_pointer_button()

void test_pointer_button ( bs_test_t *  test_ptr )

static

Exercises "pointer_button" method.

test_pointer_motion()

void test_pointer_motion ( bs_test_t *  test_ptr )

static

Verifies that wlmtk_element_pointer_motion raises signals.

test_set_get_position()

void test_set_get_position ( bs_test_t *  test_ptr )

static

Tests get_position and set_position, and that scene graph follows.

test_set_parent_container()

void test_set_parent_container ( bs_test_t *  test_ptr )

static

Tests set_parent_container, and that scene graph follows.

wlmtk_dlnode_from_element()

bs_dllist_node_t * wlmtk_dlnode_from_element

(

wlmtk_element_t *

element_ptr

)

Gets the dlnode from the element.

wlmtk_element_attach_to_scene_graph()

void wlmtk_element_attach_to_scene_graph

(

wlmtk_element_t *

element_ptr

)

Attaches or detaches the element to the parent's wlroots scene tree.

If the element has a parent, and that parent is itself attached to the wlroots scene tree, this will either re-parent an already existing node, or invoke wlmtk_element_vmt_t::create_scene_node to create and attach a new node to the paren'ts tree. Otherwise, it will clear any existing node.

The function is idempotent.

Private: Should only called by wlmtk_container_t methods, when there are changes to wlmtk_container_t::wlr_scene_tree.

Parameters

element_ptr

wlmtk_element_extend()

wlmtk_element_vmt_t wlmtk_element_extend	(	wlmtk_element_t *	element_ptr,
		const wlmtk_element_vmt_t *	element_vmt_ptr
	)

Extends the element's virtual methods.

Parameters

element_ptr
element_vmt_ptr

Returns

The previous virtual method table.

wlmtk_element_fini()

void wlmtk_element_fini

(

wlmtk_element_t *

element_ptr

)

Cleans up the element.

Parameters

element_ptr

wlmtk_element_from_dlnode()

wlmtk_element_t * wlmtk_element_from_dlnode

(

bs_dllist_node_t *

dlnode_ptr

)

Gets the element from the dlnode.

wlmtk_element_get_position()

void wlmtk_element_get_position	(	wlmtk_element_t *	element_ptr,
		int *	x_ptr,
		int *	y_ptr
	)

Returns the position of the element.

Parameters

element_ptr
x_ptr	Optional, may be NULL.
y_ptr	Optional, may be NULL.

wlmtk_element_init()

bool wlmtk_element_init

(

wlmtk_element_t *

element_ptr

)

Initializes the element.

Parameters

element_ptr

Returns

true on success.

wlmtk_element_pointer_axis()

bool wlmtk_element_pointer_axis	(	wlmtk_element_t *	element_ptr,
		struct wlr_pointer_axis_event *	wlr_pointer_axis_event_ptr
	)

Processes the axis event. Calls wlmtk_element_vmt_t::pointer_axis.

Parameters

element_ptr
wlr_pointer_axis_event_ptr

Returns

true if the axis event was consumed.

wlmtk_element_pointer_blur()

void wlmtk_element_pointer_blur

(

wlmtk_element_t *

element_ptr

)

Informs the element that it does not (or no longer) have pointer focus.

Raises wlmtk_element_events_t::pointer_leave, if it had pointer focus, and calls wlmtk_element_pointer_blur on the parent (if available).

Parameters

element_ptr

wlmtk_element_pointer_button()

bool wlmtk_element_pointer_button	(	wlmtk_element_t *	element_ptr,
		const wlmtk_button_event_t *	button_event_ptr
	)

Processes the button event. Calls wlmtk_element_vmt_t::pointer_button.

Parameters

element_ptr
button_event_ptr

Returns

true if the button event was consumed.

wlmtk_element_pointer_focus()

bool wlmtk_element_pointer_focus	(	wlmtk_element_t *	element_ptr,
		wlmtk_pointer_motion_event_t *	motion_event_ptr
	)

Sets pointer focus for the element.

If not focussed already: Request pointer focus from the parent through wlmtk_container_request_pointer_focus. If that succeeds, will raise wlmtk_element_events_t::pointer_enter.

Parameters

element_ptr
motion_event_ptr

Returns

true if the element obtained focus.

wlmtk_element_pointer_grab_cancel()

void wlmtk_element_pointer_grab_cancel

(

wlmtk_element_t *

element_ptr

)

Cancels pointer grab. Calls wlmtk_element_vmt_t::pointer_grab_cancel.

Parameters

element_ptr

wlmtk_element_pointer_motion()

bool wlmtk_element_pointer_motion	(	wlmtk_element_t *	element_ptr,
		wlmtk_pointer_motion_event_t *	pointer_motion_ptr
	)

Moves the pointer to the new position.

Calls wlmtk_element_vmt_t::pointer_accepts_motion, if the element is visible. Triggers wlmtk_element_events_t::pointer_enter or wlmtk_element_events_t::pointer_leave if the motion is accepted.

Returns

true if the element is visible and the motion is within the element's "pointer focus area", ie. in the area it accepts pointer events.

wlmtk_element_set_parent_container()

void wlmtk_element_set_parent_container	(	wlmtk_element_t *	element_ptr,
		wlmtk_container_t *	parent_container_ptr
	)

Sets the parent container for the element.

Will call wlmtk_element_attach_to_scene_graph to align the scene graph with the new (or deleted) parent.

Private: Should only be called by wlmtk_container_add_element, respectively wlmtk_container_remove_element ("friends").

Parameters

element_ptr
parent_container_ptr	Pointer to the parent container, or NULL if the parent should be cleared.

wlmtk_element_set_position()

void wlmtk_element_set_position	(	wlmtk_element_t *	element_ptr,
		int	x,
		int	y
	)

Sets the position of the element.

Parameters

element_ptr
x
y

wlmtk_element_set_visible()

void wlmtk_element_set_visible	(	wlmtk_element_t *	element_ptr,
		bool	visible
	)

Sets the element's visibility.

Parameters

element_ptr
visible

wlmtk_fake_element_create()

wlmtk_fake_element_t * wlmtk_fake_element_create

(

void

)

Ctor for the fake element, useful for tests.

Returns

A pointer to wlmtk_fake_element_t. Should be destroyed via wlmtk_element_destroy, by passing the pointer to wlmtk_fake_element_t::element as argument.

wlmtk_fake_element_grab_keyboard()

void wlmtk_fake_element_grab_keyboard

(

wlmtk_fake_element_t *

fake_element_ptr

)

Sets wlmtk_fake_element_t::has_keyboard_focus and calls wlmtk_container_set_keyboard_focus_element for the parent (if set).

Parameters

fake_element_ptr

Variable Documentation

element_vmt

const wlmtk_element_vmt_t element_vmt

static

Initial value:

= {
    .pointer_button = _wlmtk_element_pointer_button,
    .pointer_axis = _wlmtk_element_pointer_axis,
    .keyboard_blur = _wlmtk_element_keyboard_blur,
    .keyboard_event = _wlmtk_element_keyboard_event,
    .keyboard_sym = _wlmtk_element_keyboard_sym,
}

Default virtual method table. Initializes the non-abstract methods.

fake_element_vmt

const wlmtk_element_vmt_t fake_element_vmt

static

Initial value:

= {
    .destroy = fake_destroy,
    .create_scene_node = fake_create_scene_node,
    .get_dimensions = fake_get_dimensions,
    .pointer_accepts_motion = fake_pointer_accepts_motion,
    .pointer_button = fake_pointer_button,
    .pointer_axis = fake_pointer_axis,
    .pointer_grab_cancel = fake_pointer_grab_cancel,
    .keyboard_blur = fake_keyboard_blur,
    .keyboard_event = fake_keyboard_event,
    .keyboard_sym = fake_keyboard_sym,
}

Virtual method table for the fake element.

wlmtk_element_test_cases

const bs_test_case_t wlmtk_element_test_cases[]

Initial value:

= {
    { 1, "init_fini", test_init_fini },
    { 1, "set_parent_container", test_set_parent_container },
    { 1, "set_get_position", test_set_get_position },
    { 1, "get_dimensions", test_get_dimensions },
    { 1, "pointer_motion", test_pointer_motion },
    { 1, "pointer_button", test_pointer_button },
    { 1, "pointer_axis", test_pointer_axis },
    { 1, "keyboard_focus", test_keyboard_focus },
    { 1, "keyboard_activity", test_keyboard_activity },
    { 0, NULL, NULL }
}

Unit tests for the element.