pax_global_header 0000666 0000000 0000000 00000000064 14641446446 0014527 g ustar 00root root 0000000 0000000 52 comment=bebd8742fcf68bdd8804f50aa33aedad2169c207
wlmaker-0.3/ 0000775 0000000 0000000 00000000000 14641446446 0013033 5 ustar 00root root 0000000 0000000 wlmaker-0.3/.github/ 0000775 0000000 0000000 00000000000 14641446446 0014373 5 ustar 00root root 0000000 0000000 wlmaker-0.3/.github/workflows/ 0000775 0000000 0000000 00000000000 14641446446 0016430 5 ustar 00root root 0000000 0000000 wlmaker-0.3/.github/workflows/build-for-linux.yml 0000664 0000000 0000000 00000005541 14641446446 0022200 0 ustar 00root root 0000000 0000000 name: Build for Linux
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
env:
INSTALL_PATH: "${HOME}/wlmaker"
INSTALL_LIBRARY_PATH: "${HOME}/wlmaker/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)"
INSTALL_PKGCONFIG_PATH: "${HOME}/wlmaker/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/wlmaker/share/pkgconfig/"
jobs:
build_matrix:
strategy:
matrix:
compiler: [ "gcc", "clang" ]
runs-on: ubuntu-latest
container:
image: debian:bookworm
steps:
- name: Install package dependencies.
run: |
apt-get update
apt-get install -y \
bison \
clang \
cmake \
doxygen \
flex \
foot \
git \
glslang-dev \
glslang-tools \
graphviz \
libcairo2-dev \
libgbm-dev \
libinput-dev \
libncurses-dev \
libseat-dev \
libudev-dev \
libvulkan-dev \
libwayland-dev \
libxcb-composite0-dev \
libxcb-dri3-dev \
libxcb-ewmh-dev \
libxcb-icccm4-dev \
libxcb-present-dev \
libxcb-render-util0-dev \
libxcb-res0-dev \
libxcb-xinput-dev \
libxkbcommon-dev \
libxml2-dev \
meson \
plantuml \
seatd \
wayland-protocols \
xmlto \
xsltproc \
xwayland
- name: Checkout code including submodule dependencies.
uses: actions/checkout@v3
with:
submodules: recursive
- name: Configure and build submodule dependencies.
run: |
export CC="${{ matrix.compiler }}"
export PKG_CONFIG_PATH="${{ env.INSTALL_PKGCONFIG_PATH }}"
export LD_LIBRARY_PATH="${{ env.INSTALL_LIBRARY_PATH }}"
export PATH="${PATH}:${{ env.INSTALL_PATH }}/bin"
cmake -DCMAKE_INSTALL_PREFIX:PATH=${{ env.INSTALL_PATH }} dependencies/ -B dependencies/build/
cmake --build dependencies/build
- name: Configure wlmaker through CMake.
run: |
export CC="${{ matrix.compiler }}"
export PKG_CONFIG_PATH="${{ env.INSTALL_PKGCONFIG_PATH }}"
export LD_LIBRARY_PATH="${{ env.INSTALL_LIBRARY_PATH }}"
export PATH="${PATH}:${{ env.INSTALL_PATH }}/bin"
cmake -DCMAKE_INSTALL_PREFIX:PATH=${{ env.INSTALL_PATH }} -B build/
- name: Build wlmaker.
run: |
export CC="${{ matrix.compiler }}"
export LD_LIBRARY_PATH="${{ env.INSTALL_LIBRARY_PATH }}"
export PATH="${PATH}:${{ env.INSTALL_PATH }}/bin"
cmake --build build/
- name: Build documentation.
run: cmake --build build/ --target doc
- name: Run all tests
run: |
export LD_LIBRARY_PATH="${{ env.INSTALL_LIBRARY_PATH }}"
ctest --test-dir build/ --build-run-dir build/ -V
wlmaker-0.3/.gitignore 0000664 0000000 0000000 00000000174 14641446446 0015025 0 ustar 00root root 0000000 0000000 **/*~
**/CMakeFiles/*
**/CMakeCache.txt
**/build/*
**/build-clang/*
TAGS
cscope.files
cscope.in.out
cscope.out
cscope.po.out wlmaker-0.3/.gitmodules 0000664 0000000 0000000 00000003100 14641446446 0015202 0 ustar 00root root 0000000 0000000 [submodule "submodules/libbase"]
path = submodules/libbase
url = ../libbase
branch = main
update = rebase
[submodule "dependencies/drm"]
path = dependencies/drm
url = https://gitlab.freedesktop.org/mesa/drm.git
branch = main
update = rebase
[submodule "dependencies/pixman"]
path = dependencies/pixman
url = https://gitlab.freedesktop.org/pixman/pixman.git
branch = master
update = rebase
[submodule "dependencies/wayland"]
path = dependencies/wayland
url = https://gitlab.freedesktop.org/wayland/wayland.git
branch = main
update = rebase
[submodule "dependencies/wayland-protocols"]
path = dependencies/wayland-protocols
url = https://gitlab.freedesktop.org/wayland/wayland-protocols.git
branch = main
update = rebase
[submodule "dependencies/hwdata"]
path = dependencies/hwdata
url = https://github.com/vcrhonek/hwdata.git
branch = master
ignore = dirty
update = rebase
[submodule "dependencies/libdisplay-info"]
path = dependencies/libdisplay-info
url = https://gitlab.freedesktop.org/emersion/libdisplay-info.git
branch = main
update = rebase
[submodule "dependencies/wlroots"]
path = dependencies/wlroots
url = https://gitlab.freedesktop.org/wlroots/wlroots.git
branch = master
update = rebase
[submodule "examples/gtk-layer-shell"]
path = examples/gtk-layer-shell
url = https://github.com/wmww/gtk-layer-shell.git
wlmaker-0.3/CMakeLists.txt 0000664 0000000 0000000 00000006476 14641446446 0015610 0 ustar 00root root 0000000 0000000 # 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.
#
# Default arguments:
# cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local -Dconfig_DOXYGEN_CRITICAL=ON -B build
# CC=clang cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local -Dconfig_DOXYGEN_CRITICAL=ON -B build-clang
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
PROJECT(wlmaker VERSION 0.1
DESCRIPTION "Wayland Maker - A Wayland compositor inspired by Window Maker"
LANGUAGES C)
# Requires out-of-source builds.
FILE(TO_CMAKE_PATH "${PROJECT_BINARY_DIR}/CMakeLists.txt" LOCATION_PATH)
IF(EXISTS "${LOCATION_PATH}")
MESSAGE(
FATAL_ERROR
"You cannot build into a source directory (containing a CMakeLists.txt file).\n"
"Please make a build subdirectory, for example:\n"
"cmake -B build\n"
"(cd build && make)")
ENDIF()
# Defaults to /usr/local/lib for installation.
INCLUDE(GNUInstallDirs)
INCLUDE(CTest)
FIND_PACKAGE(PkgConfig REQUIRED)
# Further dependency versions, as submodules:
# * drm at libdrm-2.4.117
# * hwdata at v0.371
# * libdisplay-info at 0.2.0
# * pixman at pixman-0.43.0
PKG_CHECK_MODULES(CAIRO REQUIRED IMPORTED_TARGET cairo>=1.16.0)
PKG_CHECK_MODULES(
WAYLAND REQUIRED IMPORTED_TARGET
wayland-client>=1.22.91
wayland-protocols>=1.32
wayland-server>=1.22.91)
PKG_GET_VARIABLE(WAYLAND_PROTOCOL_DIR wayland-protocols pkgdatadir)
PKG_CHECK_MODULES(WLROOTS REQUIRED IMPORTED_TARGET wlroots>=0.17.4)
PKG_CHECK_MODULES(XCB REQUIRED IMPORTED_TARGET xcb>=1.15)
PKG_CHECK_MODULES(XKBCOMMON REQUIRED IMPORTED_TARGET xkbcommon>=1.5.0)
# XWayland considered optional.
PKG_CHECK_MODULES(XWAYLAND xwayland>=22.1.9)
# Configuration. Remove CMakeCache.txt to rerun...
OPTION(config_DEBUG "Include debugging information" ON)
OPTION(config_OPTIM "Optimizations" OFF)
OPTION(config_DOXYGEN_CRITICAL "Whether to fail on doxygen warnings" OFF)
# Toplevel compile options, for GCC and clang.
IF(CMAKE_C_COMPILER_ID MATCHES "Clang|GNU")
ADD_COMPILE_OPTIONS(-Wall -Wextra -Werror)
IF(config_DEBUG)
ADD_COMPILE_OPTIONS(-ggdb -DDEBUG)
ENDIF(config_DEBUG)
IF(config_OPTIM)
ADD_COMPILE_OPTIONS(-O2)
ELSE (config_OPTIM)
ADD_COMPILE_OPTIONS(-O0)
ENDIF(config_OPTIM)
# CMake provides absolute paths to GCC, hence the __FILE__ macro includes the
# full path. This option resets it to a path relative to project source.
ADD_COMPILE_OPTIONS(-fmacro-prefix-map=${PROJECT_SOURCE_DIR}=.)
ENDIF(CMAKE_C_COMPILER_ID MATCHES "Clang|GNU")
SET(CMAKE_C_STANDARD 11)
LIST(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
ADD_SUBDIRECTORY(apps)
ADD_SUBDIRECTORY(doc)
ADD_SUBDIRECTORY(icons)
ADD_SUBDIRECTORY(protocols)
ADD_SUBDIRECTORY(third_party/protocols)
ADD_SUBDIRECTORY(share)
ADD_SUBDIRECTORY(src)
ADD_SUBDIRECTORY(src/conf)
ADD_SUBDIRECTORY(src/toolkit)
# Adds submodules last, to permit checking on already-existing targets.
ADD_SUBDIRECTORY(submodules/libbase)
wlmaker-0.3/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000010623 14641446446 0015634 0 ustar 00root root 0000000 0000000 # Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This Code of Conduct also applies outside the project spaces when the Project
Steward has a reasonable belief that an individual's behavior may have a
negative impact on the project or its community.
## Conflict Resolution
We do not believe that all conflict is bad; healthy debate and disagreement
often yield positive results. However, it is never okay to be disrespectful or
to engage in behavior that violates the project’s code of conduct.
If you see someone violating the code of conduct, you are encouraged to address
the behavior directly with those involved. Many issues can be resolved quickly
and easily, and this gives people more control over the outcome of their
dispute. If you are unable to resolve the matter for any reason, or if the
behavior is threatening or harassing, report it. We are dedicated to providing
an environment where participants feel welcome and safe.
Reports should be directed to *[PROJECT STEWARD NAME(s) AND EMAIL(s)]*, the
Project Steward(s) for *[PROJECT NAME]*. It is the Project Steward’s duty to
receive and address reported violations of the code of conduct. They will then
work with a committee consisting of representatives from the Open Source
Programs Office and the Google Open Source Strategy team. If for any reason you
are uncomfortable reaching out to the Project Steward, please email
opensource@google.com.
We will investigate every complaint, but you may not receive a direct response.
We will use our discretion in determining when and how to follow up on reported
incidents, which may range from not taking action to permanent expulsion from
the project and project-sponsored spaces. We will notify the accused of the
report and provide them an opportunity to discuss it before any action is taken.
The identity of the reporter will be omitted from the details of the report
supplied to the accused. In potentially harmful situations, such as ongoing
harassment or threats to anyone's safety, we may take action without notice.
## Attribution
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct/
wlmaker-0.3/CONTRIBUTING.md 0000664 0000000 0000000 00000002054 14641446446 0015265 0 ustar 00root root 0000000 0000000 # How to Contribute
We would love to accept your patches and contributions to this project.
## Before you begin
### Sign our Contributor License Agreement
Contributions to this project must be accompanied by a
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
You (or your employer) retain the copyright to your contribution; this simply
gives us permission to use and redistribute your contributions as part of the
project.
If you or your current employer have already signed the Google CLA (even if it
was for a different project), you probably don't need to do it again.
Visit
#include
#include
#include
#include
#include
#include
/* == Declarations ========================================================= */
/** Actual buffer. TODO(kaeser@gubbe.ch): Clean this up. */
typedef struct {
/** Points to the data area, ie. the pixels. */
uint32_t *data_ptr;
/** Corresponding wayland buffer. */
struct wl_buffer *wl_buffer_ptr;
/** Corresponding (unmanaged) `bs_gfxbuf_t`. */
bs_gfxbuf_t *bs_gfxbuf_ptr;
/** Indicates that the buffer is committed, and not ready to draw into. */
bool committed;
/** Back-link to the client buffer state. */
wlclient_buffer_t *client_buffer_ptr;
} buffer_t;
/** All elements contributing to a wl_buffer. */
struct _wlclient_buffer_t {
/** Mapped data. */
void *data_ptr;
/** Shared memory pool. */
struct wl_shm_pool *wl_shm_pool_ptr;
/** Width of the buffer, in pixels. */
unsigned width;
/** Height of the buffer, in pixels. */
unsigned height;
/** Actual buffer. */
buffer_t *buffer_ptr;
/** Callback to indicate the buffer is ready to draw into. */
wlclient_buffer_ready_callback_t ready_callback;
/** Argument to said callback. */
void *ready_callback_ud_ptr;
};
static void handle_wl_buffer_release(
void *data_ptr,
struct wl_buffer *wl_buffer_ptr);
static int shm_creat(const char *app_id_ptr, size_t size);
static buffer_t *create_buffer(
struct wl_shm_pool *wl_shm_pool_ptr,
void *data_base_ptr,
size_t ofs,
unsigned width,
unsigned height,
unsigned bytes_per_line);
static void buffer_destroy(buffer_t *buffer_ptr);
/* == Data ================================================================= */
/** How many attempts to try shm_open before giving up. */
static const uint32_t SHM_OPEN_RETRIES = 256;
/** Listener implementation for the `wl_buffer`. */
static const struct wl_buffer_listener wl_buffer_listener = {
.release = handle_wl_buffer_release,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlclient_buffer_t *wlclient_buffer_create(
const wlclient_t *wlclient_ptr,
unsigned width,
unsigned height,
wlclient_buffer_ready_callback_t ready_callback,
void *ready_callback_ud_ptr)
{
wlclient_buffer_t *client_buffer_ptr = logged_calloc(
1, sizeof(wlclient_buffer_t));
if (NULL == client_buffer_ptr) return NULL;
client_buffer_ptr->ready_callback = ready_callback;
client_buffer_ptr->ready_callback_ud_ptr = ready_callback_ud_ptr;
client_buffer_ptr->width = width;
client_buffer_ptr->height = height;
size_t shm_pool_size = width * height * sizeof(uint32_t);
int fd = shm_creat(
wlclient_attributes(wlclient_ptr)->app_id_ptr, shm_pool_size);
if (0 >= fd) {
wlclient_buffer_destroy(client_buffer_ptr);
return NULL;
}
client_buffer_ptr->data_ptr = mmap(
NULL, shm_pool_size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
if (MAP_FAILED == client_buffer_ptr->data_ptr) {
bs_log(BS_ERROR | BS_ERRNO, "Failed mmap(NULL, %zu, "
"PROT_READ|PROT_WRITE, MAP_SHARED, %d, 0)",
shm_pool_size, fd);
close(fd);
wlclient_buffer_destroy(client_buffer_ptr);
return NULL;
}
struct wl_shm_pool *wl_shm_pool_ptr = wl_shm_create_pool(
wlclient_attributes(wlclient_ptr)->wl_shm_ptr, fd, shm_pool_size);
close(fd);
if (NULL == wl_shm_pool_ptr) {
bs_log(BS_ERROR, "Failed wl_shm_create_pool(%p, %d, %zu)",
wlclient_attributes(wlclient_ptr)->wl_shm_ptr,
fd, shm_pool_size);
wlclient_buffer_destroy(client_buffer_ptr);
return NULL;
}
client_buffer_ptr->buffer_ptr = create_buffer(
wl_shm_pool_ptr,
client_buffer_ptr->data_ptr,
0,
width,
height,
width * sizeof(uint32_t));
if (NULL == client_buffer_ptr->buffer_ptr) {
wlclient_buffer_destroy(client_buffer_ptr);
return NULL;
}
client_buffer_ptr->buffer_ptr->client_buffer_ptr = client_buffer_ptr;
wl_shm_pool_destroy(wl_shm_pool_ptr);
if (NULL != client_buffer_ptr->ready_callback) {
client_buffer_ptr->ready_callback(
client_buffer_ptr->ready_callback_ud_ptr);
}
return client_buffer_ptr;
}
/* ------------------------------------------------------------------------- */
void wlclient_buffer_destroy(wlclient_buffer_t *client_buffer_ptr)
{
if (NULL != client_buffer_ptr->buffer_ptr) {
buffer_destroy(client_buffer_ptr->buffer_ptr);
client_buffer_ptr->buffer_ptr = NULL;
}
bs_log(BS_WARNING, "Destroyed %p", client_buffer_ptr);
free(client_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
bs_gfxbuf_t *bs_gfxbuf_from_wlclient_buffer(
wlclient_buffer_t *client_buffer_ptr)
{
return client_buffer_ptr->buffer_ptr->bs_gfxbuf_ptr;
}
/* ------------------------------------------------------------------------- */
void wlclient_buffer_attach_to_surface_and_commit(
wlclient_buffer_t *client_buffer_ptr,
struct wl_surface *wl_surface_ptr)
{
BS_ASSERT(!client_buffer_ptr->buffer_ptr->committed);
wl_surface_attach(
wl_surface_ptr,
client_buffer_ptr->buffer_ptr->wl_buffer_ptr,
0, 0);
client_buffer_ptr->buffer_ptr->committed = true;
wl_surface_commit(wl_surface_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Handles the `release` notification of the wl_buffer interface.
*
* @param data_ptr
* @param wl_buffer_ptr
*/
static void handle_wl_buffer_release(
void *data_ptr,
__UNUSED__ struct wl_buffer *wl_buffer_ptr)
{
buffer_t *buffer_ptr = data_ptr;
buffer_ptr->committed = false;
// Signal a potential user that this buffer is ready to draw into.
if (NULL != buffer_ptr->client_buffer_ptr->ready_callback) {
buffer_ptr->client_buffer_ptr->ready_callback(
buffer_ptr->client_buffer_ptr->ready_callback_ud_ptr);
}
}
/* ------------------------------------------------------------------------- */
/**
* Creates a POSIX shared memory object and allocates `size` bytes to it.
*
* @param app_id_ptr
* @param size
*
* @return The file descriptor (a non-negative integer) on success, or -1 on
* failure. The file descriptor must be closed with close(2).
*/
int shm_creat(const char *app_id_ptr, size_t size)
{
char shm_name[NAME_MAX];
int fd = -1;
shm_name[0] = '\0';
for (uint32_t sequence = 0; sequence < SHM_OPEN_RETRIES; ++sequence) {
snprintf(shm_name, NAME_MAX, "/%s_%"PRIdMAX"_shm_%"PRIx64"_%"PRIu32,
app_id_ptr ? app_id_ptr : "wlclient",
(intmax_t)getpid(), bs_usec(), sequence);
fd = shm_open(shm_name, O_RDWR|O_CREAT|O_EXCL, 0600);
if (0 > fd && errno == EEXIST) continue;
if (0 < fd) break;
bs_log(BS_WARNING | BS_ERRNO,
"Failed shm_open(%s, O_RDWR|O_CREAT|O_EXCL, 0600)",
shm_name);
return -1;
}
if (0 != shm_unlink(shm_name)) {
bs_log(BS_ERROR | BS_ERRNO, "Failed shm_unlink(%s)", shm_name);
close(fd);
return -1;
}
while (0 != ftruncate(fd, size)) {
if (EINTR == errno) continue; // try again...
bs_log(BS_ERROR | BS_ERRNO, "Failed ftruncate(%d, %zu)", fd, size);
close(fd);
return -1;
}
return fd;
}
/* ------------------------------------------------------------------------- */
/** Creates the actual buffer. */
buffer_t *create_buffer(struct wl_shm_pool *wl_shm_pool_ptr,
void *data_base_ptr,
size_t ofs,
unsigned width,
unsigned height,
unsigned bytes_per_line)
{
buffer_t *buffer_ptr = logged_calloc(1, sizeof(buffer_t));
if (NULL == buffer_ptr) return buffer_ptr;
buffer_ptr->data_ptr = (uint32_t*)((uint8_t*)data_base_ptr + ofs);
buffer_ptr->wl_buffer_ptr = wl_shm_pool_create_buffer(
wl_shm_pool_ptr, ofs, width, height, bytes_per_line,
WL_SHM_FORMAT_ARGB8888);
if (NULL == buffer_ptr->wl_buffer_ptr) {
buffer_destroy(buffer_ptr);
return NULL;
}
buffer_ptr->bs_gfxbuf_ptr = bs_gfxbuf_create_unmanaged(
width, height, bytes_per_line / sizeof(uint32_t), buffer_ptr->data_ptr);
if (NULL == buffer_ptr->bs_gfxbuf_ptr) {
buffer_destroy(buffer_ptr);
return NULL;
}
wl_buffer_add_listener(
buffer_ptr->wl_buffer_ptr,
&wl_buffer_listener,
buffer_ptr);
return buffer_ptr;
}
/* ------------------------------------------------------------------------- */
/** Destroys the actual buffer. */
void buffer_destroy(buffer_t *buffer_ptr)
{
if (NULL != buffer_ptr->bs_gfxbuf_ptr) {
bs_gfxbuf_destroy(buffer_ptr->bs_gfxbuf_ptr);
buffer_ptr->bs_gfxbuf_ptr = NULL;
}
if (NULL != buffer_ptr->wl_buffer_ptr) {
wl_buffer_destroy(buffer_ptr->wl_buffer_ptr);
buffer_ptr->wl_buffer_ptr = NULL;
}
free(buffer_ptr);
}
/* == End of buffer.c ====================================================== */
wlmaker-0.3/apps/libwlclient/buffer.h 0000664 0000000 0000000 00000005052 14641446446 0017732 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file buffer.h
*
* @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.
*/
#ifndef __WLCLIENT_BUFFER_H__
#define __WLCLIENT_BUFFER_H__
#include "libwlclient.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration of the buffer state. */
typedef struct _wlclient_buffer_t wlclient_buffer_t;
/** Forward declaration of a wayland surface. */
struct wl_surface;
/** Callback to report that a buffer is ready to draw into. */
typedef void (*wlclient_buffer_ready_callback_t)(void *ud_ptr);
/**
* Creates a wlclient wayland buffer with the given dimensions.
*
* @param wlclient_ptr
* @param width
* @param height
* @param ready_callback
* @param ready_callback_ud_ptr
*
* @return A pointer to the created client buffer, or NULL on error. The
* buffer must be destroyed by calling @ref wlclient_buffer_destroy.
*/
wlclient_buffer_t *wlclient_buffer_create(
const wlclient_t *wlclient_ptr,
unsigned width,
unsigned height,
wlclient_buffer_ready_callback_t ready_callback,
void *ready_callback_ud_ptr);
/**
* Destroys the wlclient wayland buffer.
*
* @param buffer_ptr
*/
void wlclient_buffer_destroy(
wlclient_buffer_t *buffer_ptr);
/**
* Attaches the buffer to the surface and commits it.
*
* @param buffer_ptr
* @param wl_surface_ptr
*/
void wlclient_buffer_attach_to_surface_and_commit(
wlclient_buffer_t *buffer_ptr,
struct wl_surface *wl_surface_ptr);
/**
* Returns the`bs_gfxbuf_t` corresponding to the client buffer.
*
* @param buffer_ptr
*
* @return Pointer to the `bs_gfxbuf_t`. The `bs_gfxbuf_t` remains valid
* throughout the lifetime of buffer_ptr, and does not need to be
* released by the caller.
*/
bs_gfxbuf_t *bs_gfxbuf_from_wlclient_buffer(
wlclient_buffer_t *buffer_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLCLIENT_BUFFER_H__ */
/* == End of buffer.h ====================================================== */
wlmaker-0.3/apps/libwlclient/client.c 0000664 0000000 0000000 00000042146 14641446446 0017737 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file client.c
*
* @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.
*/
#include "libwlclient.h"
#include
#include
#include
#include
#include
#include
#include "wlmaker-icon-unstable-v1-client-protocol.h"
#include "xdg-shell-client-protocol.h"
/* == Declarations ========================================================= */
/** State of the wayland client. */
struct _wlclient_t {
/** Shareable attributes. */
wlclient_attributes_t attributes;
/** Registry singleton for the above connection. */
struct wl_registry *wl_registry_ptr;
/** List of registered timers. TODO(kaeser@gubbe.ch): Replace with HEAP. */
bs_dllist_t timers;
/** File descriptor to monitor SIGINT. */
int signal_fd;
/** Whether to keep the client running. */
volatile bool keep_running;
};
/** State of a registered timer. */
typedef struct {
/** Node within the list of timers, see `wlclient_t.timers`. */
bs_dllist_node_t dlnode;
/** Target time, in usec since epoch. */
uint64_t target_usec;
/** Callback once the timer is triggered. */
wlclient_callback_t callback;
/** Argument to the callback. */
void *callback_ud_ptr;
} wlclient_timer_t;
/** Descriptor for a wayland object to bind to. */
typedef struct {
/** The interface definition. */
const struct wl_interface *wl_interface_ptr;
/** Version desired to bind to. */
uint32_t desired_version;
/** Offset of the bound interface, relative to `wlclient_t`. */
size_t bound_ptr_offset;
} object_t;
static void wl_to_bs_log(
const char *fmt,
va_list args);
static void handle_global_announce(
void *data_ptr,
struct wl_registry *wl_registry_ptr,
uint32_t name,
const char *interface_ptr,
uint32_t version);
static void handle_global_remove(
void *data_ptr,
struct wl_registry *registry,
uint32_t name);
static wlclient_timer_t *wlc_timer_create(
wlclient_t *client_ptr,
uint64_t target_usec,
wlclient_callback_t callback,
void *callback_ud_ptr);
static void wlc_timer_destroy(
wlclient_timer_t *timer_ptr);
/* == Data ================================================================= */
/** Listener for the registry, taking note of registry updates. */
static const struct wl_registry_listener registry_listener = {
.global = handle_global_announce,
.global_remove = handle_global_remove,
};
/** List of wayland objects we want to bind to. */
static const object_t objects[] = {
{ &wl_compositor_interface, 4,
offsetof(wlclient_attributes_t, wl_compositor_ptr) },
{ &wl_shm_interface, 1,
offsetof(wlclient_attributes_t, wl_shm_ptr) },
{ &xdg_wm_base_interface, 1,
offsetof(wlclient_attributes_t, xdg_wm_base_ptr) },
{ &zwlmaker_icon_manager_v1_interface, 1,
offsetof(wlclient_attributes_t, icon_manager_ptr) },
{ NULL, 0, 0 } // sentinel.
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlclient_t *wlclient_create(const char *app_id_ptr)
{
wlclient_t *wlclient_ptr = logged_calloc(1, sizeof(wlclient_t));
if (NULL == wlclient_ptr) return NULL;
wl_log_set_handler_client(wl_to_bs_log);
if (NULL != app_id_ptr) {
wlclient_ptr->attributes.app_id_ptr = logged_strdup(app_id_ptr);
if (NULL == wlclient_ptr->attributes.app_id_ptr) {
wlclient_destroy(wlclient_ptr);
return NULL;
}
}
sigset_t signal_set;
if (sigemptyset(&signal_set)) {
bs_log(BS_ERROR | BS_ERRNO, "Failed sigemptyset(%p)", &signal_set);
wlclient_destroy(wlclient_ptr);
return NULL;
}
if (sigaddset(&signal_set, SIGINT)) {
bs_log(BS_ERROR | BS_ERRNO, "Failed sigemptyset(%p, %d)",
&signal_set, SIGINT);
wlclient_destroy(wlclient_ptr);
return NULL;
}
if (sigprocmask(SIG_BLOCK, &signal_set, NULL) == -1) {
bs_log(BS_ERROR | BS_ERRNO, "Failed sigprocmask(SIG_BLOCK, %p, NULL)",
&signal_set);
wlclient_destroy(wlclient_ptr);
return NULL;
}
wlclient_ptr->signal_fd = signalfd(-1, &signal_set, SFD_NONBLOCK);
if (0 >= wlclient_ptr->signal_fd) {
bs_log(BS_ERROR | BS_ERRNO, "Failed signalfd(-1, %p, SFD_NONBLOCK)",
&signal_set);
wlclient_destroy(wlclient_ptr);
return NULL;
}
wlclient_ptr->attributes.wl_display_ptr = wl_display_connect(NULL);
if (NULL == wlclient_ptr->attributes.wl_display_ptr) {
bs_log(BS_ERROR, "Failed wl_display_connect(NULL).");
wlclient_destroy(wlclient_ptr);
return NULL;
}
wlclient_ptr->wl_registry_ptr = wl_display_get_registry(
wlclient_ptr->attributes.wl_display_ptr);
if (NULL == wlclient_ptr->wl_registry_ptr) {
bs_log(BS_ERROR, "Failed wl_display_get_registry(%p).",
wlclient_ptr->wl_registry_ptr);
wlclient_destroy(wlclient_ptr);
return NULL;
}
if (0 != wl_registry_add_listener(
wlclient_ptr->wl_registry_ptr,
®istry_listener,
&wlclient_ptr->attributes)) {
bs_log(BS_ERROR, "Failed wl_registry_add_listener(%p, %p, %p).",
wlclient_ptr->wl_registry_ptr,
®istry_listener,
&wlclient_ptr->attributes);
wlclient_destroy(wlclient_ptr);
return NULL;
}
wl_display_roundtrip(wlclient_ptr->attributes.wl_display_ptr);
if (NULL == wlclient_ptr->attributes.wl_compositor_ptr) {
bs_log(BS_ERROR, "'wl_compositor' interface not found on Wayland.");
wlclient_destroy(wlclient_ptr);
return NULL;
}
if (NULL == wlclient_ptr->attributes.wl_shm_ptr) {
bs_log(BS_ERROR, "'wl_shm' interface not found on Wayland.");
wlclient_destroy(wlclient_ptr);
return NULL;
}
if (NULL == wlclient_ptr->attributes.xdg_wm_base_ptr) {
bs_log(BS_ERROR, "'xdg_wm_base' interface not found on Wayland.");
wlclient_destroy(wlclient_ptr);
return NULL;
}
return wlclient_ptr;
}
/* ------------------------------------------------------------------------- */
void wlclient_destroy(wlclient_t *wlclient_ptr)
{
bs_dllist_node_t *dlnode_ptr;
while (NULL != (dlnode_ptr = bs_dllist_pop_front(&wlclient_ptr->timers))) {
wlc_timer_destroy((wlclient_timer_t*)dlnode_ptr);
}
if (NULL != wlclient_ptr->wl_registry_ptr) {
wl_registry_destroy(wlclient_ptr->wl_registry_ptr);
wlclient_ptr->wl_registry_ptr = NULL;
}
if (NULL != wlclient_ptr->attributes.wl_display_ptr) {
wl_display_disconnect(wlclient_ptr->attributes.wl_display_ptr);
wlclient_ptr->attributes.wl_display_ptr = NULL;
}
if (0 < wlclient_ptr->signal_fd) {
close(wlclient_ptr->signal_fd);
wlclient_ptr->signal_fd = 0;
}
if (NULL != wlclient_ptr->attributes.app_id_ptr) {
// Cheated when saying it's const...
free((char*)wlclient_ptr->attributes.app_id_ptr);
wlclient_ptr->attributes.app_id_ptr = NULL;
}
free(wlclient_ptr);
}
/* ------------------------------------------------------------------------- */
const wlclient_attributes_t *wlclient_attributes(
const wlclient_t *wlclient_ptr)
{
return &wlclient_ptr->attributes;
}
/* ------------------------------------------------------------------------- */
// TODO(kaeser@gubbe.ch): Clean up.
void wlclient_run(wlclient_t *wlclient_ptr)
{
wlclient_ptr->keep_running = true;
do {
while (0 != wl_display_prepare_read(wlclient_ptr->attributes.wl_display_ptr)) {
if (0 > wl_display_dispatch_pending(wlclient_ptr->attributes.wl_display_ptr)) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed wl_display_dispatch_pending(%p)",
wlclient_ptr->attributes.wl_display_ptr);
break; // Error (?)
}
}
if (0 > wl_display_flush(wlclient_ptr->attributes.wl_display_ptr)) {
if (EAGAIN != errno) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed wl_display_flush(%p)", wlclient_ptr->attributes.wl_display_ptr);
wl_display_cancel_read(wlclient_ptr->attributes.wl_display_ptr);
break; // Error!
}
}
struct pollfd pollfds[2];
pollfds[0].fd = wl_display_get_fd(wlclient_ptr->attributes.wl_display_ptr);
pollfds[0].events = POLLIN;
pollfds[0].revents = 0;
pollfds[1].fd = wlclient_ptr->signal_fd;
pollfds[1].events = POLLIN;
pollfds[1].revents = 0;
int rv = poll(&pollfds[0], 2, 100);
if (0 > rv && EINTR != errno) {
bs_log(BS_ERROR | BS_ERRNO, "Failed poll(%p, 1, 100)", &pollfds);
wl_display_cancel_read(wlclient_ptr->attributes.wl_display_ptr);
break; // Error!
}
if (pollfds[0].revents & POLLIN) {
if (0 > wl_display_read_events(wlclient_ptr->attributes.wl_display_ptr)) {
bs_log(BS_ERROR | BS_ERRNO, "Failed wl_display_read_events(%p)",
wlclient_ptr->attributes.wl_display_ptr);
break; // Error!
}
} else {
wl_display_cancel_read(wlclient_ptr->attributes.wl_display_ptr);
}
if (pollfds[1].revents & POLLIN) {
struct signalfd_siginfo siginfo;
ssize_t rd = read(wlclient_ptr->signal_fd, &siginfo, sizeof(siginfo));
if (0 > rd) {
bs_log(BS_ERROR, "Failed read(%d, %p, %zu)",
wlclient_ptr->signal_fd, &siginfo, sizeof(siginfo));
break;
} else if ((size_t)rd != sizeof(siginfo)) {
bs_log(BS_ERROR, "Bytes read from signal_fd %zu != %zd",
sizeof(siginfo), rd);
break;
}
bs_log(BS_ERROR, "Signal caught: %d", siginfo.ssi_signo);
wlclient_ptr->keep_running = false;
}
if (0 > wl_display_dispatch_pending(wlclient_ptr->attributes.wl_display_ptr)) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed wl_display_dispatch_queue_pending(%p)",
wlclient_ptr->attributes.wl_display_ptr);
int err = wl_display_get_error(wlclient_ptr->attributes.wl_display_ptr);
if (0 != err) {
bs_log(BS_ERROR, "Display error %d", err);
}
uint32_t id;
const struct wl_interface *wl_interface_ptr;
uint32_t perr = wl_display_get_protocol_error(
wlclient_ptr->attributes.wl_display_ptr, &wl_interface_ptr, &id);
if (0 != perr) {
bs_log(BS_ERROR,
"Protocol error %"PRIu32", interface %s id %"PRIu32,
perr, wl_interface_ptr->name, id);
}
break; // Error!
}
// Flush the timer queue.
uint64_t current_usec = bs_usec();
bs_dllist_node_t *dlnode_ptr;
while (NULL != (dlnode_ptr = wlclient_ptr->timers.head_ptr) &&
((wlclient_timer_t*)dlnode_ptr)->target_usec <= current_usec) {
bs_dllist_pop_front(&wlclient_ptr->timers);
wlclient_timer_t *timer_ptr = (wlclient_timer_t*)dlnode_ptr;
timer_ptr->callback(wlclient_ptr, timer_ptr->callback_ud_ptr);
wlc_timer_destroy(timer_ptr);
}
} while (wlclient_ptr->keep_running);
}
/* ------------------------------------------------------------------------- */
bool wlclient_register_timer(
wlclient_t *wlclient_ptr,
uint64_t target_usec,
wlclient_callback_t callback,
void *callback_ud_ptr)
{
wlclient_timer_t *timer_ptr = wlc_timer_create(
wlclient_ptr, target_usec, callback, callback_ud_ptr);
return (timer_ptr != NULL);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Redirects a wayland log call into s_log.
*
* @param fmt_ptr
* @param args
*/
void wl_to_bs_log(
const char *fmt_ptr,
va_list args)
{
bs_log_vwrite(BS_ERROR, __FILE__, __LINE__, fmt_ptr, args);
}
/* ------------------------------------------------------------------------- */
/**
* Handles the announcement of a global object.
*
* Called by `struct wl_registry_listener` `global` callback, invoked to notify
* clients of global objects.
*
* @param data_ptr Points to a @ref wlclient_t.
* @param wl_registry_ptr The `struct wl_registry` this is invoked for.
* @param name Numeric name of the global object.
* @param interface_name_ptr Name of the interface implemented by the object.
* @param version Interface version.
*/
void handle_global_announce(
void *data_ptr,
struct wl_registry *wl_registry_ptr,
uint32_t name,
const char *interface_name_ptr,
uint32_t version)
{
for (const object_t *object_ptr = &objects[0];
NULL != object_ptr->wl_interface_ptr;
++object_ptr) {
// Proceed, if the interface name doesn't match.
if (0 != strcmp(interface_name_ptr,
object_ptr->wl_interface_ptr->name)) {
continue;
}
void *bound_ptr = wl_registry_bind(
wl_registry_ptr, name,
object_ptr->wl_interface_ptr,
object_ptr->desired_version);
if (NULL == bound_ptr) {
bs_log(BS_ERROR,
"Failed wl_registry_bind(%p, %"PRIu32", %p, %"PRIu32") "
"for interface %s, version %"PRIu32".",
wl_registry_ptr, name,
object_ptr->wl_interface_ptr,
object_ptr->desired_version,
interface_name_ptr, version);
continue;
}
((void**)((uint8_t*)data_ptr + object_ptr->bound_ptr_offset))[0] =
bound_ptr;
bs_log(BS_DEBUG, "Bound interface %s to %p",
interface_name_ptr, bound_ptr);
}
}
/* ------------------------------------------------------------------------- */
/**
* Handles the removal of a wayland global object.
*
* Called by `struct wl_registry_listener` `global_remove`, invoked to notify
* clients of removed global objects.
*
* @param data_ptr Points to a @ref wlclient_t.
* @param wl_registry_ptr The `struct wl_registry` this is invoked for.
* @param name Numeric name of the global object.
*/
void handle_global_remove(
void *data_ptr,
struct wl_registry *wl_registry_ptr,
uint32_t name)
{
// TODO(kaeser@gubbe.ch): Add implementation.
bs_log(BS_INFO, "handle_global_remove(%p, %p, %"PRIu32").",
data_ptr, wl_registry_ptr, name);
}
/* ------------------------------------------------------------------------- */
/**
* Creates a timer and registers it with the client.
*
* @param client_ptr
* @param target_usec
* @param callback
* @param callback_ud_ptr
*
* @return A pointer to the created timer, or NULL on error. The pointer must
* be destroyed by @ref wlc_timer_destroy.
*/
wlclient_timer_t *wlc_timer_create(
wlclient_t *client_ptr,
uint64_t target_usec,
wlclient_callback_t callback,
void *callback_ud_ptr)
{
wlclient_timer_t *timer_ptr = logged_calloc(1, sizeof(wlclient_timer_t));
if (NULL == timer_ptr) return NULL;
timer_ptr->target_usec = target_usec;
timer_ptr->callback = callback;
timer_ptr->callback_ud_ptr = callback_ud_ptr;
// TODO(kaeser@gubbe.ch): This should be a HEAP.
bs_dllist_node_t *dlnode_ptr = client_ptr->timers.head_ptr;
for (; dlnode_ptr != NULL; dlnode_ptr = dlnode_ptr->next_ptr) {
wlclient_timer_t *ref_timer_ptr = (wlclient_timer_t *)dlnode_ptr;
if (timer_ptr->target_usec > ref_timer_ptr->target_usec) continue;
bs_dllist_insert_node_before(
&client_ptr->timers, dlnode_ptr, &timer_ptr->dlnode);
}
if (NULL == dlnode_ptr) {
bs_dllist_push_back(&client_ptr->timers, &timer_ptr->dlnode);
}
return timer_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the timer. Note: The timer will NOT be unregistered first.
*
* @param timer_ptr
*/
void wlc_timer_destroy(wlclient_timer_t *timer_ptr)
{
free(timer_ptr);
}
/* == End of client.c ====================================================== */
wlmaker-0.3/apps/libwlclient/icon.c 0000664 0000000 0000000 00000021712 14641446446 0017405 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file icon.c
*
* @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.
*/
#include "icon.h"
#include "buffer.h"
#include "wlmaker-icon-unstable-v1-client-protocol.h"
#include
/* == Declarations ========================================================= */
/** State of the icon. */
typedef struct _wlclient_icon_t {
/** Back-link to the client. */
wlclient_t *wlclient_ptr;
/** Surface. */
struct wl_surface *wl_surface_ptr;
/** The icon interface. */
struct zwlmaker_toplevel_icon_v1 *toplevel_icon_ptr;
/** Width of the icon, once suggested by the server. */
unsigned width;
/** Height of the icon, once suggested by the server. */
unsigned height;
/** Callback for when the icon's buffer is ready to be drawn into. */
wlclient_icon_gfxbuf_callback_t buffer_ready_callback;
/** Argument to that callback. */
void *buffer_ready_callback_ud_ptr;
/** The buffer backing the icon. */
wlclient_buffer_t *buffer_ptr;
/** Outstanding frames to display. Considered ready to draw when zero. */
int pending_frames;
/** Whether the buffer was reported as ready. */
bool buffer_ready;
/** Whether there is currently a callback in progress. */
bool callback_in_progress;
} wlclient_icon_t;
static void handle_toplevel_icon_configure(
void *data_ptr,
struct zwlmaker_toplevel_icon_v1 *zwlmaker_toplevel_icon_v1_ptr,
int32_t width,
int32_t height,
uint32_t serial);
static void handle_frame_done(
void *data_ptr,
struct wl_callback *callback,
uint32_t time);
static void handle_buffer_ready(void *data_ptr);
static void state(wlclient_icon_t *icon_ptr);
/* == Data ================================================================= */
/** Listener implementation for toplevel icon. */
static const struct zwlmaker_toplevel_icon_v1_listener toplevel_icon_listener={
.configure = handle_toplevel_icon_configure,
};
/** Listener implementation for the frame. */
static const struct wl_callback_listener frame_listener = {
.done = handle_frame_done
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlclient_icon_t *wlclient_icon_create(wlclient_t *wlclient_ptr)
{
if (!wlclient_icon_supported(wlclient_ptr)) {
bs_log(BS_ERROR, "Icon manager is not supported.");
return NULL;
}
wlclient_icon_t *icon_ptr = logged_calloc(1, sizeof(wlclient_icon_t));
if (NULL == icon_ptr) return NULL;
icon_ptr->wlclient_ptr = wlclient_ptr;
icon_ptr->wl_surface_ptr = wl_compositor_create_surface(
wlclient_attributes(wlclient_ptr)->wl_compositor_ptr);
if (NULL == icon_ptr->wl_surface_ptr) {
bs_log(BS_ERROR, "Failed wl_compositor_create_surface(%p).",
wlclient_attributes(wlclient_ptr)->wl_compositor_ptr);
wlclient_icon_destroy(icon_ptr);
return NULL;
}
icon_ptr->toplevel_icon_ptr = zwlmaker_icon_manager_v1_get_toplevel_icon(
wlclient_attributes(wlclient_ptr)->icon_manager_ptr,
NULL,
icon_ptr->wl_surface_ptr);
if (NULL == icon_ptr->toplevel_icon_ptr) {
bs_log(BS_ERROR, "Failed zwlmaker_icon_manager_v1_get_toplevel_icon"
"(%p, NULL, %p).",
wlclient_attributes(wlclient_ptr)->icon_manager_ptr,
icon_ptr->wl_surface_ptr);
wlclient_icon_destroy(icon_ptr);
return NULL;
}
zwlmaker_toplevel_icon_v1_add_listener(
icon_ptr->toplevel_icon_ptr,
&toplevel_icon_listener,
icon_ptr);
wl_surface_commit(icon_ptr->wl_surface_ptr);
return icon_ptr;
}
/* ------------------------------------------------------------------------- */
void wlclient_icon_destroy(wlclient_icon_t *icon_ptr)
{
if (NULL != icon_ptr->toplevel_icon_ptr) {
// TODO(kaeser@gubbe.ch): Destroy the icon!
icon_ptr->toplevel_icon_ptr = NULL;
}
if (NULL != icon_ptr->wl_surface_ptr) {
wl_surface_destroy(icon_ptr->wl_surface_ptr);
icon_ptr->wl_surface_ptr = NULL;
}
free(icon_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlclient_icon_supported(
wlclient_t *wlclient_ptr)
{
return (NULL != wlclient_attributes(wlclient_ptr)->icon_manager_ptr);
}
/* ------------------------------------------------------------------------ */
void wlclient_icon_callback_when_ready(
wlclient_icon_t *icon_ptr,
wlclient_icon_gfxbuf_callback_t callback,
void *ud_ptr)
{
icon_ptr->buffer_ready_callback = callback;
icon_ptr->buffer_ready_callback_ud_ptr = ud_ptr;
state(icon_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Handles the 'configure' event: Creates appropriately sized buffer.
*
* @param data_ptr
* @param zwlmaker_toplevel_icon_v1_ptr
* @param width
* @param height
* @param serial
*/
void handle_toplevel_icon_configure(
void *data_ptr,
struct zwlmaker_toplevel_icon_v1 *zwlmaker_toplevel_icon_v1_ptr,
int32_t width,
int32_t height,
uint32_t serial)
{
wlclient_icon_t *icon_ptr = data_ptr;
icon_ptr->width = width;
icon_ptr->height = height;
bs_log(BS_DEBUG, "Configured icon to %"PRId32" x %"PRId32, width, height);
zwlmaker_toplevel_icon_v1_ack_configure(
zwlmaker_toplevel_icon_v1_ptr, serial);
wlclient_t *wlclient_ptr = icon_ptr->wlclient_ptr;
icon_ptr->buffer_ptr = wlclient_buffer_create(
wlclient_ptr, icon_ptr->width, icon_ptr->height,
handle_buffer_ready, icon_ptr);
if (NULL == icon_ptr->buffer_ptr) {
bs_log(BS_FATAL, "Failed wlclient_buffer_create(%p, %u, %u)",
wlclient_ptr, icon_ptr->width, icon_ptr->height);
// TODO(kaeser@gubbe.ch): Error handling.
return;
}
state(icon_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Updates the information that there is a buffer ready to be drawn into.
*
* @param data_ptr
*/
void handle_buffer_ready(void *data_ptr)
{
wlclient_icon_t *icon_ptr = data_ptr;
icon_ptr->buffer_ready = true;
state(icon_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Registers the frame got displayed, potentially triggers the callback.
*
* @param data_ptr
* @param callback
* @param time
*/
void handle_frame_done(
void *data_ptr,
struct wl_callback *callback,
__UNUSED__ uint32_t time)
{
wl_callback_destroy(callback);
wlclient_icon_t *icon_ptr = data_ptr;
icon_ptr->pending_frames--;
state(icon_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Runs the ready callback, if due.
*
* @param icon_ptr
*/
void state(wlclient_icon_t *icon_ptr)
{
// Not fully initialized, skip this attempt.
if (NULL == icon_ptr->buffer_ptr) return;
// ... or, no callback...
if (NULL == icon_ptr->buffer_ready_callback) return;
// ... or, actually not ready.
if (0 < icon_ptr->pending_frames || !icon_ptr->buffer_ready) return;
// ... or, a callback is currently in progress.
if (icon_ptr->callback_in_progress) return;
wlclient_icon_gfxbuf_callback_t callback = icon_ptr->buffer_ready_callback;
void *ud_ptr = icon_ptr->buffer_ready_callback_ud_ptr;
icon_ptr->buffer_ready_callback = NULL;
icon_ptr->buffer_ready_callback_ud_ptr = NULL;
icon_ptr->callback_in_progress = true;
bool rv = callback(
icon_ptr, bs_gfxbuf_from_wlclient_buffer(icon_ptr->buffer_ptr), ud_ptr);
icon_ptr->callback_in_progress = false;
if (!rv) return;
struct wl_callback *wl_callback = wl_surface_frame(
icon_ptr->wl_surface_ptr);
wl_callback_add_listener(wl_callback, &frame_listener, icon_ptr);
wl_surface_damage_buffer(
icon_ptr->wl_surface_ptr,
0, 0, INT32_MAX, INT32_MAX);
icon_ptr->pending_frames++;
icon_ptr->buffer_ready = false;
wlclient_buffer_attach_to_surface_and_commit(
icon_ptr->buffer_ptr,
icon_ptr->wl_surface_ptr);
}
/* == End of icon.c ======================================================== */
wlmaker-0.3/apps/libwlclient/icon.h 0000664 0000000 0000000 00000005323 14641446446 0017412 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file icon.h
*
* @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.
*/
#ifndef __LIBWLCLIENT_ICON_H__
#define __LIBWLCLIENT_ICON_H__
#include "libwlclient.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration of an icon's state. */
typedef struct _wlclient_icon_t wlclient_icon_t;
/**
* Type of the callback for @ref wlclient_icon_callback_when_ready.
*
* @param icon_ptr
* @param gfxbuf_ptr
* @param ud_ptr
*/
typedef bool (*wlclient_icon_gfxbuf_callback_t)(
wlclient_icon_t *icon_ptr,
bs_gfxbuf_t *gfxbuf_ptr,
void *ud_ptr);
/**
* Creates an icon.
*
* @param wlclient_ptr
*
* @return An icon state or NULL on error. The state must be free'd by calling
* @ref wlclient_icon_destroy.
*/
wlclient_icon_t *wlclient_icon_create(
wlclient_t *wlclient_ptr);
/**
* Destroys the icon.
*
* @param icon_ptr
*/
void wlclient_icon_destroy(
wlclient_icon_t *icon_ptr);
/**
* Returns whether the icon protocol is supported on the client.
*
* @param wlclient_ptr
*/
bool wlclient_icon_supported(wlclient_t *wlclient_ptr);
/**
* Sets a callback to invoke when the background buffer is ready for drawing.
*
* If the background buffer is already ready, the callback will get executed
* right away. Otherwise, the callback will be registered for the icon, and
* executed as the background buffer becomes available.
*
* The callback will be invoked once only. If repeated calls are desired,
* the callee should call @ref wlclient_icon_callback_when_ready again from
* within the `callback` method.
*
* Only one callback may be active at any time. Any further invocation will
* replace the already-registered callback. To unregister a callback, call
* the function with callback == NULL.
*
* @param icon_ptr
* @param callback
* @param ud_ptr
*/
void wlclient_icon_callback_when_ready(
wlclient_icon_t *icon_ptr,
wlclient_icon_gfxbuf_callback_t callback,
void *ud_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LIBWLCLIENT_ICON_H__ */
/* == End of icon.h ======================================================== */
wlmaker-0.3/apps/libwlclient/libwlclient.h 0000664 0000000 0000000 00000006420 14641446446 0020771 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file libwlclient.h
*
* @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.
*/
#ifndef __LIBWLCLIENT_H__
#define __LIBWLCLIENT_H__
#include
#include
#include
/** Forward declaration: Wayland client handle. */
typedef struct _wlclient_t wlclient_t;
#include "icon.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* A client's callback, as used in @ref wlclient_register_timer.
*
* @param wlclient_ptr
* @param ud_ptr
*/
typedef void (*wlclient_callback_t)(
wlclient_t *wlclient_ptr,
void *ud_ptr);
/** Accessor to 'public' client attributes. */
typedef struct {
/** Wayland display connection. */
struct wl_display *wl_display_ptr;
/** The bound compositor interface. */
struct wl_compositor *wl_compositor_ptr;
/** The bound SHM interface. */
struct wl_shm *wl_shm_ptr;
/** The bound XDG wm_base interface. */
struct xdg_wm_base *xdg_wm_base_ptr;
/** The bound Toplevel Icon Manager. Will be NULL if not supported. */
struct zwlmaker_icon_manager_v1 *icon_manager_ptr;
/** Application ID, as a string. Or NULL, if not set. */
const char *app_id_ptr;
} wlclient_attributes_t;
/**
* Creates a wayland client for simple buffer interactions.
*
* @param app_id_ptr Application ID or NULL if not set.
*
* @return The client state, or NULL on error. The state needs to be free'd
* via @ref wlclient_destroy.
*/
wlclient_t *wlclient_create(const char *app_id_ptr);
/**
* Destroys the wayland client, as created by @ref wlclient_create.
*
* @param wlclient_ptr
*/
void wlclient_destroy(wlclient_t *wlclient_ptr);
/**
* Gets the client attributes.
*
* @param wlclient_ptr
*
* @return A pointer to the attributes.
*/
const wlclient_attributes_t *wlclient_attributes(
const wlclient_t *wlclient_ptr);
/**
* Runs the client's mainloop.
*
* @param wlclient_ptr
*/
void wlclient_run(wlclient_t *wlclient_ptr);
/**
* Registers a timer with the client.
*
* Once the system clock reaches (or has passed) `target_usec`, `callback` will
* be called with the provided arguments. This is a one-time registration. For
* repeated calls, clients need to re-register.
*
* @param wlclient_ptr
* @param target_usec
* @param callback
* @param callback_ud_ptr
*
* @return true on success.
*/
bool wlclient_register_timer(
wlclient_t *wlclient_ptr,
uint64_t target_usec,
wlclient_callback_t callback,
void *callback_ud_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LIBWLCLIENT_H__ */
/* == End of libwlclient.h ================================================= */
wlmaker-0.3/apps/primitives/ 0000775 0000000 0000000 00000000000 14641446446 0016171 5 ustar 00root root 0000000 0000000 wlmaker-0.3/apps/primitives/CMakeLists.txt 0000664 0000000 0000000 00000002403 14641446446 0020730 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
ADD_LIBRARY(primitives STATIC)
TARGET_SOURCES(
primitives PRIVATE
primitives.h primitives.c
segment_display.h segment_display.c)
TARGET_INCLUDE_DIRECTORIES(
primitives PRIVATE)
TARGET_LINK_LIBRARIES(
primitives
base)
ADD_EXECUTABLE(segment_display_test
segment_display_test.c
segment_display.c
segment_display.h)
TARGET_COMPILE_DEFINITIONS(
segment_display_test PRIVATE
TEST_DATA_DIR="${CMAKE_CURRENT_SOURCE_DIR}")
TARGET_INCLUDE_DIRECTORIES(
segment_display_test PRIVATE
${CAIRO_INCLUDE_DIRS})
TARGET_LINK_LIBRARIES(
segment_display_test PRIVATE
base
PkgConfig::CAIRO)
ADD_TEST(
NAME segment_display_test
COMMAND segment_display_test)
wlmaker-0.3/apps/primitives/primitives.c 0000664 0000000 0000000 00000005155 14641446446 0020536 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file primitives.c
*
* @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.
*/
#include "primitives.h"
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
void wlm_primitives_set_bezel_color(
cairo_t *cairo_ptr,
bool illuminated)
{
if (illuminated) {
cairo_set_source_rgba(cairo_ptr, 1.0, 1.0, 1.0, 0.6);
} else {
cairo_set_source_rgba(cairo_ptr, 0.0, 0.0, 0.0, 0.4);
}
}
/* ------------------------------------------------------------------------- */
void wlm_primitives_draw_bezel_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
double bezel_width,
bool raised)
{
cairo_save(cairo_ptr);
cairo_set_line_width(cairo_ptr, 0);
// Northwestern corner is illuminted when raised.
wlm_primitives_set_bezel_color(cairo_ptr, raised);
cairo_move_to(cairo_ptr, x, y);
cairo_line_to(cairo_ptr, x + width, y + 0);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + 0, y + height);
cairo_line_to(cairo_ptr, x + 0, y + 0);
cairo_fill(cairo_ptr);
// Southeastern corner is illuminated when sunken.
wlm_primitives_set_bezel_color(cairo_ptr, !raised);
cairo_move_to(cairo_ptr, x + width, y + height);
cairo_line_to(cairo_ptr, x + 0, y + height);
cairo_line_to(cairo_ptr, x + bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + width, y + 0);
cairo_line_to(cairo_ptr, x + width, y + height);
cairo_fill(cairo_ptr);
cairo_restore(cairo_ptr);
}
/* == End of primitives.c ================================================== */
wlmaker-0.3/apps/primitives/primitives.h 0000664 0000000 0000000 00000004077 14641446446 0020545 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file primitives.h
*
* @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.
*/
#ifndef __WLM_PRIMITIVES_H__
#define __WLM_PRIMITIVES_H__
#include
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Sets the bezel color.
*
* Note: Window Maker draws the bezel by adding 80 (0x50) to each R, G, B of
* the underlying title for the illuminated side; respectively by subtracting
* 40 (0x28) on the non-illuminated side.
* We are using cairo's overlaying with the respective "alpha" values below,
* which leads to different results.
*
* @param cairo_ptr
* @param illuminated
*/
void wlm_primitives_set_bezel_color(
cairo_t *cairo_ptr,
bool illuminated);
/**
* Draws a bezel into the cairo, at specified position and width/height.
*
* TODO(kaeser@gubbe.ch): Share this code with the server.
*
* @param cairo_ptr A cairo, backed by an image surface.
* @param x
* @param y
* @param width
* @param height
* @param bezel_width
* @param raised Whether the bezel is to highlight a raised (true)
* or pressed (false) state.
*/
void wlm_primitives_draw_bezel_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
double bezel_width,
bool raised);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLM_PRIMITIVES_H__ */
/* == End of primitives.h ================================================== */
wlmaker-0.3/apps/primitives/segment_display.c 0000664 0000000 0000000 00000024511 14641446446 0021527 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file segment_display.c
*
* @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.
*/
#include "segment_display.h"
#include
#include
#include
/* == Declarations ========================================================= */
static void draw_segment(
cairo_t *cairo_ptr,
const bs_vector_2f_t origin,
const bs_vector_2f_t longitudinal,
const bs_vector_2f_t lateral,
const wlm_cairo_7segment_param_t *param_ptr,
const double length);
/**
* Encoding bits to indicate coloring of segments for each digit.
*
* The sequence follows https://en.wikipedia.org/wiki/Seven-segment_display,
* as follows:
```
<- 0 ->
^ ^
5 1
v v
<- 6 ->
^ ^
4 2
v v
<- 3 ->
```
*/
static const uint8_t seven_segment_encoding[10] = {
// 6543210 <-- segment.
0b00111111, // 0
0b00000110, // 1
0b01011011, // 2
0b01001111, // 3
0b01100110, // 4
0b01101101, // 5
0b01111101, // 6
0b00000111, // 7
0b01111111, // 8
0b01101111 // 9
};
const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_6x8 = {
.offset = 0.6,
.width = 1.0,
.hlength = 4.0,
.vlength = 3.0
};
const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_7x10 = {
.offset = 0.6,
.width = 1.0,
.hlength = 5.0,
.vlength = 4.0
};
const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_8x12 = {
.offset = 0.8,
.width = 1.0,
.hlength = 6,
.vlength = 5
};
const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_16x24 = {
.offset = 1.2,
.width = 2.0,
.hlength = 12.0,
.vlength = 10.0
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
void wlm_cairo_7segment_display_digit(
cairo_t *cairo_ptr,
const wlm_cairo_7segment_param_t *pptr,
uint32_t x,
uint32_t y,
uint32_t color_on,
uint32_t color_off,
uint8_t digit)
{
BS_ASSERT(digit < UINT8_C(10));
uint8_t segments = seven_segment_encoding[digit];
// Vectors spanning up a segment.
bs_vector_2f_t longitudinal = { .x = 1.0, .y = 0.0 };
bs_vector_2f_t lateral = { .x = 0.0, .y = 1.0 };
bs_vector_2f_t origin = BS_VECTOR_2F(
x + pptr->width / 2.0, y - 2 * pptr->vlength - pptr->width / 2.0);
bs_vector_2f_t pos;
cairo_save(cairo_ptr);
// Segment 0.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 0) ? color_on : color_off);
pos = origin;
draw_segment(cairo_ptr, pos, longitudinal, lateral, pptr, pptr->hlength);
// Segment 1.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 1) ? color_on : color_off);
pos = bs_vec_add_2f(origin, BS_VECTOR_2F(pptr->hlength, 0));
draw_segment(cairo_ptr, pos, lateral, longitudinal, pptr, pptr->vlength);
// Segment 2.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 2) ? color_on : color_off);
pos = bs_vec_add_2f(origin, BS_VECTOR_2F(pptr->hlength, pptr->vlength));
draw_segment(cairo_ptr, pos, lateral, longitudinal, pptr, pptr->vlength);
// Segment 3.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 3) ? color_on : color_off);
pos = bs_vec_add_2f(origin, BS_VECTOR_2F(0, 2 * pptr->vlength));
draw_segment(cairo_ptr, pos, longitudinal, lateral, pptr, pptr->hlength);
// Segment 4.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 4) ? color_on : color_off);
pos = bs_vec_add_2f(origin, BS_VECTOR_2F(0, pptr->vlength));
draw_segment(cairo_ptr, pos, lateral, longitudinal, pptr, pptr->vlength);
// Segment 5.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 5) ? color_on : color_off);
pos = origin;
draw_segment(cairo_ptr, pos, lateral, longitudinal, pptr, pptr->vlength);
// Segment 6.
cairo_set_source_argb8888(
cairo_ptr, segments & (0x01 << 6) ? color_on : color_off);
pos = bs_vec_add_2f(origin, BS_VECTOR_2F(0, pptr->vlength));
draw_segment(cairo_ptr, pos, longitudinal, lateral, pptr, pptr->hlength);
cairo_restore(cairo_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Draws a segment, from `origin` along `longitudinal`/`lateral` direction.
*
* A segment spans from the point `origin` along the `longitudinal` vector,
* and expands by (width/2) along `lateral` direction. It will use the current
* cairo source color to fill the segment.
*
```
+---------------------+
/ \
+--+ + + +--+ ^
\ / | width/2
+---------------------+ v
<----> offset <----> offset
<-> width/2 <-> width/2
<-------------------------------> length
```
*
* @param cairo_ptr
* @param origin
* @param longitudinal
* @param lateral
* @param param_ptr
* @param length
*/
void draw_segment(
cairo_t *cairo_ptr,
const bs_vector_2f_t origin,
const bs_vector_2f_t longitudinal,
const bs_vector_2f_t lateral,
const wlm_cairo_7segment_param_t *param_ptr,
const double length)
{
bs_vector_2f_t rel;
rel = bs_vec_mul_2f(param_ptr->offset - param_ptr->width/2, longitudinal);
cairo_move_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_add_2f(
bs_vec_mul_2f(param_ptr->offset, longitudinal),
bs_vec_mul_2f(param_ptr->width / 2, lateral));
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_add_2f(
bs_vec_mul_2f(length - param_ptr->offset, longitudinal),
bs_vec_mul_2f(param_ptr->width / 2, lateral));
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_mul_2f(length - param_ptr->offset + param_ptr->width/2,
longitudinal);
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_add_2f(
bs_vec_mul_2f(length - param_ptr->offset, longitudinal),
bs_vec_mul_2f(-param_ptr->width / 2, lateral));
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_add_2f(
bs_vec_mul_2f(param_ptr->offset, longitudinal),
bs_vec_mul_2f(-param_ptr->width / 2, lateral));
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
rel = bs_vec_mul_2f(param_ptr->offset - param_ptr->width/2, longitudinal);
cairo_line_to(cairo_ptr, origin.x + rel.x, origin.y + rel.y);
cairo_fill(cairo_ptr);
cairo_stroke(cairo_ptr);
}
/* == Unit tests =========================================================== */
static void test_6x8(bs_test_t *test_ptr);
static void test_7x10(bs_test_t *test_ptr);
static void test_16x24(bs_test_t *test_ptr);
const bs_test_case_t wlm_cairo_segment_display_test_cases[] = {
{ 1, "6x8", test_6x8 },
{ 1, "7x10", test_7x10 },
{ 1, "16x24", test_16x24 },
{ 0, NULL, NULL } // sentinel.
};
/* ------------------------------------------------------------------------- */
/** Test for the 6x8-sized digits. */
void test_6x8(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(60, 8);
if (NULL == gfxbuf_ptr) {
BS_TEST_FAIL(test_ptr, "Failed bs_gfxbuf_create(60, 8)");
return;
}
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
if (NULL == cairo_ptr) {
BS_TEST_FAIL(test_ptr, "Failed cairo_create_from_bs_gfxbuf.");
bs_gfxbuf_destroy(gfxbuf_ptr);
return;
}
for (int i = 0; i < 10; i++) {
wlm_cairo_7segment_display_digit(
cairo_ptr, &wlm_cairo_7segment_param_6x8, i * 6, 8,
0xffc0c0ff, 0xff202040, i);
}
cairo_destroy(cairo_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "segment_display_6x8.png");
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/* ------------------------------------------------------------------------- */
/** Test for the 7x10-sized digits. */
void test_7x10(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(70, 10);
if (NULL == gfxbuf_ptr) {
BS_TEST_FAIL(test_ptr, "Failed bs_gfxbuf_create(70, 10)");
return;
}
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
if (NULL == cairo_ptr) {
BS_TEST_FAIL(test_ptr, "Failed cairo_create_from_bs_gfxbuf.");
bs_gfxbuf_destroy(gfxbuf_ptr);
return;
}
for (int i = 0; i < 10; i++) {
wlm_cairo_7segment_display_digit(
cairo_ptr, &wlm_cairo_7segment_param_7x10, i * 7, 10,
0xffc0c0ff, 0xff202040, i);
}
cairo_destroy(cairo_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "segment_display_7x10.png");
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/* ------------------------------------------------------------------------- */
/** Test for the 16x24-sized digits. */
void test_16x24(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(160, 24);
if (NULL == gfxbuf_ptr) {
BS_TEST_FAIL(test_ptr, "Failed bs_gfxbuf_create(160, 24)");
return;
}
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
if (NULL == cairo_ptr) {
BS_TEST_FAIL(test_ptr, "Failed cairo_create_from_bs_gfxbuf.");
bs_gfxbuf_destroy(gfxbuf_ptr);
return;
}
for (int i = 0; i < 10; i++) {
wlm_cairo_7segment_display_digit(
cairo_ptr, &wlm_cairo_7segment_param_16x24, i * 16, 24,
0xffc0c0ff, 0xff202040, i);
}
cairo_destroy(cairo_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "segment_display_16x24.png");
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/* == End of segment_display.c ============================================= */
wlmaker-0.3/apps/primitives/segment_display.h 0000664 0000000 0000000 00000005606 14641446446 0021540 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file segment_display.h
*
* @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.
*/
#ifndef __WLM_SEGMENT_DISPLAY_H__
#define __WLM_SEGMENT_DISPLAY_H__
#include
#include
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Parameters to describe segment properties. */
typedef struct {
/** Offset distance, from origin to start of segment. */
double offset;
/** Full width of the segment, along the lateral direction. */
double width;
/** Length of a horizontal segment, along longitudinal direction. */
double hlength;
/** Length of a vertical segment, along longitudinal direction. */
double vlength;
} wlm_cairo_7segment_param_t;
/** Parameters for a 6x8-pixel-sized 7-segment digit display. */
extern const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_6x8;
/** Parameters for a 7x10-pixel-sized 7-segment digit display. */
extern const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_7x10;
/** Parameters for a 8x12-pixel-sized 7-segment digit display. */
extern const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_8x12;
/** Parameters for a 16x24-pixel-sized 7-segment digit display. */
extern const wlm_cairo_7segment_param_t wlm_cairo_7segment_param_16x24;
/**
* Draws a digit using 7-segment visualization.
*
* @param cairo_ptr The `cairo_t` target to draw the digits to.
* @param param_ptr Visualization parameters for the segments.
* @param x X coordinate of lower left corner.
* @param y Y coordinate of lower left corner.
* @param color_on An ARGB32 value for an illuminated segment.
* @param color_off An ARGB32 value for a non-illuminated segment.
* @param digit Digit to draw. Must be 0 <= digit < 10.
*/
void wlm_cairo_7segment_display_digit(
cairo_t *cairo_ptr,
const wlm_cairo_7segment_param_t *param_ptr,
uint32_t x,
uint32_t y,
uint32_t color_on,
uint32_t color_off,
uint8_t digit);
/** Unit test cases. */
extern const bs_test_case_t wlm_cairo_segment_display_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLM_SEGMENT_DISPLAY_H__ */
/* == End of segment_display.h ============================================= */
wlmaker-0.3/apps/primitives/segment_display_16x24.png 0000664 0000000 0000000 00000001174 14641446446 0022735 0 ustar 00root root 0000000 0000000 PNG
IHDR }V5 bKGD 1IDATh홱j@+4ج\%1IW s66k@7w9?ؓF|p+a?hbAXW f l,Yό8` k gt7ͿK Kd x fq8~3Q~?89<ظY̊oc&ɅRh< i93 ρ,;Qrhd }> ?8xQjO.3:iʭ77gg_o{U
hdƢoc(N۟L~\gk֫b8 W4弜^-Hȯ4ko;܄/7!"(8EPp @)r"ON&Ť~E 1z ~ x=`ƻD3m6W_~Ӱ# IENDB` wlmaker-0.3/apps/primitives/segment_display_6x8.png 0000664 0000000 0000000 00000000542 14641446446 0022574 0 ustar 00root root 0000000 0000000 PNG
IHDR < bKGD IDAT81k1J&P\J_Mp?Z
RIp 4m.[y/ofK)Y֢]n4!gG5< >>ȧ\w>Sq>_>N}qټ<{I֕1+M/1+ <^tuKt:wz0H~sh4tiQ9Nr_?e_uώ T_EZsV#4
l>xIw0Oi?
s.qZ IENDB` wlmaker-0.3/apps/primitives/segment_display_7x10.png 0000664 0000000 0000000 00000000634 14641446446 0022650 0 ustar 00root root 0000000 0000000 PNG
IHDR F
( bKGD QIDATH1k1 J&P\J_Mp?Z"nQ9& .VLf:_B_Ŕ2X VZCtll^G,3j8|h=]fo"MIFQoZ[sr/+5m . s1V+4@;L F幘|ZC,ZJ}%ɋlov8[@s'3 |#s|#
,tR{)SC& fLݞ1ZC `ǽ;Է^ {R>u>* 32+ IENDB` wlmaker-0.3/apps/primitives/segment_display_test.c 0000664 0000000 0000000 00000002522 14641446446 0022564 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file cairo_segment_display_test.c
*
* @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.
*/
#include "segment_display.h"
/** Unit tests. */
const bs_test_set_t tests[] = {
{ 1, "segment_dipslay", wlm_cairo_segment_display_test_cases },
{ 0, NULL, NULL }
};
#if !defined(TEST_DATA_DIR)
/** Directory root for looking up test data. See `bs_test_resolve_path`. */
#define TEST_DATA_DIR "./"
#endif // TEST_DATA_DIR
/** Main program, runs the unit tests. */
int main(int argc, const char **argv)
{
const bs_test_param_t params = {
.test_data_dir_ptr = TEST_DATA_DIR
};
return bs_test(tests, argc, argv, ¶ms);
}
/* == End of segment_display_test.c ======================================== */
wlmaker-0.3/apps/wlmclock.c 0000664 0000000 0000000 00000015521 14641446446 0015761 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file wlmclock.c
*
* Demonstrator for using the icon protocol.
*
* @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.
*/
#include
#include
#include
#include
#include
#include
/** Foreground color of a LED in the VFD-style display. */
static const uint32_t color_led = 0xff55ffff;
/** Color of a turned-off element in the VFD-style display. */
static const uint32_t color_off = 0xff114444;
/** Background color in the VFD-style display. */
static const uint32_t color_background = 0xff111111;
/* ------------------------------------------------------------------------- */
/** Returns the next full second for when to draw the clock. */
uint64_t next_draw_time(void)
{
return (bs_usec() / 1000000 + 1) * 1000000;
}
/* ------------------------------------------------------------------------- */
/**
* Draws contents into the icon buffer.
*
* @param icon_ptr
* @param gfxbuf_ptr
* @param ud_ptr
*/
bool icon_callback(
__UNUSED__ wlclient_icon_t *icon_ptr,
bs_gfxbuf_t *gfxbuf_ptr,
__UNUSED__ void *ud_ptr)
{
bs_gfxbuf_clear(gfxbuf_ptr, 0);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
if (NULL == cairo_ptr) {
bs_log(BS_ERROR, "Failed cairo_create_from_bs_gfxbuf(%p)", gfxbuf_ptr);
return false;
}
float r, g, b, alpha;
bs_gfxbuf_argb8888_to_floats(color_background, &r, &g, &b, &alpha);
cairo_pattern_t *pattern_ptr = cairo_pattern_create_rgba(r, g, b, alpha);
BS_ASSERT(NULL != pattern_ptr);
cairo_set_source(cairo_ptr, pattern_ptr);
cairo_pattern_destroy(pattern_ptr);
cairo_rectangle(cairo_ptr, 5, 46, 54, 14);
cairo_fill(cairo_ptr);
wlm_primitives_draw_bezel_at(cairo_ptr, 4, 45, 56, 15, 1.0, false);
struct timeval tv;
if (0 != gettimeofday(&tv, NULL)) {
memset(&tv, 0, sizeof(tv));
}
struct tm *tm_ptr = localtime(&tv.tv_sec);
char time_buf[7];
snprintf(time_buf, sizeof(time_buf), "%02d%02d%02d",
tm_ptr->tm_hour, tm_ptr->tm_min, tm_ptr->tm_sec);
for (int i = 0; i < 6; ++i) {
wlm_cairo_7segment_display_digit(
cairo_ptr,
&wlm_cairo_7segment_param_8x12,
6 + i * 8 + (i / 2) * 2, 58,
color_led,
color_off,
time_buf[i] - '0');
}
cairo_set_source_argb8888(cairo_ptr, color_led);
cairo_rectangle(cairo_ptr, 22, 50, 1, 1.25);
cairo_rectangle(cairo_ptr, 22, 54, 1, 1.25);
cairo_rectangle(cairo_ptr, 40, 50, 1, 1.25);
cairo_rectangle(cairo_ptr, 40, 54, 1, 1.25);
cairo_fill(cairo_ptr);
wlm_primitives_draw_bezel_at(cairo_ptr, 4, 4, 56, 41, 1.0, false);
cairo_set_source_argb8888(cairo_ptr, color_background);
cairo_rectangle(cairo_ptr, 5, 5, 54, 39);
cairo_fill(cairo_ptr);
// Draws a clock face, with small ticks every hour.
double center_x = 31.5;
double center_y = 24.5;
double radius = 19;
cairo_set_source_argb8888(cairo_ptr, color_led);
for (int i = 0; i < 12; ++i) {
// ... and larer ticks every 3 hours.
double ratio = 0.9;
if (i % 3 == 0) {
ratio = 0.85;
cairo_set_line_width(cairo_ptr, 2.0);
} else {
cairo_set_line_width(cairo_ptr, 1.0);
}
cairo_move_to(cairo_ptr,
center_x + ratio * radius * sin(i * 2*M_PI / 12.0),
center_y - ratio * radius * cos(i * 2*M_PI / 12.0));
cairo_line_to(cairo_ptr,
center_x + radius * sin(i * 2*M_PI / 12.0),
center_y - radius * cos(i * 2*M_PI / 12.0));
cairo_stroke(cairo_ptr);
}
// Seconds pointer.
double angle = tm_ptr->tm_sec * 2*M_PI / 60.0;
cairo_set_line_width(cairo_ptr, 0.5);
cairo_move_to(cairo_ptr, center_x, center_y);
cairo_line_to(cairo_ptr,
center_x + 0.7 * radius * sin(angle),
center_y - 0.7 * radius * cos(angle));
cairo_stroke(cairo_ptr);
// Minutes pointer.
angle = tm_ptr->tm_min * 2*M_PI / 60.0 + (
tm_ptr->tm_sec / 60.0 * 2*M_PI / 60.0);
cairo_set_line_width(cairo_ptr, 1.0);
cairo_move_to(cairo_ptr, center_x, center_y);
cairo_line_to(cairo_ptr,
center_x + 0.7 * radius * sin(angle),
center_y - 0.7 * radius * cos(angle));
cairo_stroke(cairo_ptr);
// Hours pointer.
angle = tm_ptr->tm_hour * 2*M_PI / 12.0 + (
tm_ptr->tm_min / 60.0 * 2*M_PI / 12.0);
cairo_set_line_width(cairo_ptr, 2.0);
cairo_move_to(cairo_ptr, center_x, center_y);
cairo_line_to(cairo_ptr,
center_x + 0.5 * radius * sin(angle),
center_y - 0.5 * radius * cos(angle));
cairo_stroke(cairo_ptr);
cairo_destroy(cairo_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
/** Called once per second. */
void timer_callback(wlclient_t *client_ptr, void *ud_ptr)
{
wlclient_icon_t *icon_ptr = ud_ptr;
wlclient_icon_callback_when_ready(icon_ptr, icon_callback, NULL);
wlclient_register_timer(
client_ptr, next_draw_time(), timer_callback, icon_ptr);
}
/* == Main program ========================================================= */
/** Main program. */
int main(__UNUSED__ int argc, __UNUSED__ char **argv)
{
bs_log_severity = BS_DEBUG;
wlclient_t *wlclient_ptr = wlclient_create("wlmclock");
if (NULL == wlclient_ptr) return EXIT_FAILURE;
if (wlclient_icon_supported(wlclient_ptr)) {
wlclient_icon_t *icon_ptr = wlclient_icon_create(wlclient_ptr);
if (NULL == icon_ptr) {
bs_log(BS_ERROR, "Failed wlclient_icon_create(%p)", wlclient_ptr);
} else {
wlclient_icon_callback_when_ready(icon_ptr, icon_callback, NULL);
wlclient_register_timer(
wlclient_ptr, next_draw_time(), timer_callback, icon_ptr);
wlclient_run(wlclient_ptr);
wlclient_icon_destroy(icon_ptr);
}
} else {
bs_log(BS_ERROR, "icon protocol is not supported.");
}
wlclient_destroy(wlclient_ptr);
return EXIT_SUCCESS;
}
/* == End of wlmclock.c ==================================================== */
wlmaker-0.3/build-cscope-index.sh 0000775 0000000 0000000 00000001022 14641446446 0017043 0 ustar 00root root 0000000 0000000 #! /bin/sh
# Generates Cscope index for wlmaker and all dependencies.
set -o errexit
SUBPATHS="\
dependencies \
src \
submodules"
base_path="$(readlink -f "$(dirname "${0}")")"
rm -f "${base_path}/cscope.files"
for p in ${SUBPATHS} ; do
echo "Processing ${base_path}/${p} ..."
find "${base_path}/${p}" -name "*.h" -o -name "*.c" -o -name "*.cpp" | xargs etags
find "${base_path}/${p}" -name "*.h" -o -name "*.c" -o -name "*.cpp" >> cscope.files
done
cscope -Rbkq -i cscope.files 2>/dev/null
echo "Done."
exit 0
wlmaker-0.3/cmake/ 0000775 0000000 0000000 00000000000 14641446446 0014113 5 ustar 00root root 0000000 0000000 wlmaker-0.3/cmake/EmbedBinary.cmake 0000664 0000000 0000000 00000004456 14641446446 0017307 0 ustar 00root root 0000000 0000000 # Copyright 2024 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
# During the INCLUDE() call, CMAKE_CURRENT_LIST_DIR is this file's path.
# Store it for later, during the FUNCTION() call it'll be the caller's path.
SET(EMBED_BINARY_TEMPLATE_DIR ${CMAKE_CURRENT_LIST_DIR})
# Adds a static C library to embed the binary file with the specified prefix.
#
# Generates a C source and header file from the contents of `binary_file`, and
# adds both of these to a new library target `library_target`.
#
# The embedded data can then be accessed as external variables:
#
# #include ".h"
#
# * uint8_t embedded_binary__data[];
# * const size_t embedded_binary__size;
FUNCTION(EmbedBinary_ADD_LIBRARY library_target prefix binary_file)
SET(output_basename "${CMAKE_CURRENT_BINARY_DIR}/${prefix}")
SET(output_source "${output_basename}.c")
SET(output_header "${output_basename}.h")
SET(generated_cmake "${output_basename}.cmake")
SET(template_header "${EMBED_BINARY_TEMPLATE_DIR}/embed_binary.h.in")
SET(template_source "${EMBED_BINARY_TEMPLATE_DIR}/embed_binary.c.in")
CONFIGURE_FILE(
"${EMBED_BINARY_TEMPLATE_DIR}/embed.cmake.in"
"${generated_cmake}"
@ONLY)
ADD_CUSTOM_COMMAND(
OUTPUT "${output_source}" "${output_header}"
COMMAND ${CMAKE_COMMAND} -P "${generated_cmake}"
MAIN_DEPENDENCY "${binary_file}"
DEPENDS "${generated_cmake}" "${template_header}" "${template_source}"
)
ADD_LIBRARY(${library_target} STATIC)
TARGET_SOURCES(
${library_target} PRIVATE
"${output_source}"
"${output_header}")
TARGET_INCLUDE_DIRECTORIES(
${library_target} PUBLIC "${CMAKE_CURRENT_BINARY_DIR}")
SET_TARGET_PROPERTIES(
${library_target}
PROPERTIES VERSION 1.0
PUBLIC_HEADER "${output_header}")
ENDFUNCTION()
wlmaker-0.3/cmake/WaylandProtocol.cmake 0000664 0000000 0000000 00000004755 14641446446 0020251 0 ustar 00root root 0000000 0000000 # 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.
FIND_PROGRAM(
WaylandScanner_EXECUTABLE
NAMES wayland-scanner)
MARK_AS_ADVANCED(WaylandScanner_EXECUTABLE)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(
WaylandScanner
FOUND_VAR WaylandScanner_FOUND
REQUIRED_VARS WaylandScanner_EXECUTABLE)
# -----------------------------------------------------------------------------
# Adds the wayland protocol's header and glue code to .
FUNCTION(WaylandProtocol_ADD target_var)
IF(NOT WaylandScanner_EXECUTABLE)
MESSAGE(FATAL_ERROR "'wayland-scanner' executable required, not found.")
ENDIF()
# Parse and verify arguments.
SET(oneValueArgs PROTOCOL_FILE BASE_NAME SIDE)
CMAKE_PARSE_ARGUMENTS(ARGS "" "${oneValueArgs}" "" ${ARGN})
IF(NOT ${ARGS_SIDE} STREQUAL "client" AND NOT ${ARGS_SIDE} STREQUAL "server")
MESSAGE(FATAL_ERROR "SIDE arg must be \"client\" or \"server\".")
ENDIF()
IF(ARGS_UNPARSED_ARGUMENTS)
MESSAGE(FATAL_ERROR "Unknown args passed to _wayland_protocol_add: \"${ARGS_UNPARSED_ARGUMENTS}\"")
ENDIF(ARGS_UNPARSED_ARGUMENTS)
GET_FILENAME_COMPONENT(_protocol_file ${ARGS_PROTOCOL_FILE} ABSOLUTE)
# Generate the client header.
SET(_header "${CMAKE_CURRENT_BINARY_DIR}/${ARGS_BASE_NAME}-${ARGS_SIDE}-protocol.h")
SET_SOURCE_FILES_PROPERTIES(${_header} GENERATED)
ADD_CUSTOM_COMMAND(
OUTPUT ${_header}
COMMAND ${WaylandScanner_EXECUTABLE} "${ARGS_SIDE}-header" ${_protocol_file} ${_header}
DEPENDS ${WaylandScanner_EXECUTABLE} ${_protocol_file}
VERBATIM)
# Generate the glue code.
SET(_glue_code "${CMAKE_CURRENT_BINARY_DIR}/${ARGS_BASE_NAME}-protocol.c")
SET_SOURCE_FILES_PROPERTIES(${_glue_code} GENERATED)
ADD_CUSTOM_COMMAND(
OUTPUT ${_glue_code}
COMMAND ${WaylandScanner_EXECUTABLE} private-code ${_protocol_file} ${_glue_code}
DEPENDS ${WaylandScanner_EXECUTABLE} ${_protocol_file}
VERBATIM)
LIST(APPEND ${target_var} "${_header}" "${_glue_code}")
SET(${target_var} ${${target_var}} PARENT_SCOPE)
ENDFUNCTION()
wlmaker-0.3/cmake/embed.cmake.in 0000664 0000000 0000000 00000002603 14641446446 0016577 0 ustar 00root root 0000000 0000000 # -*- cmake -*-
# Copyright 2024 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.
FILE(READ "@binary_file@" binary_content HEX)
STRING(REGEX MATCHALL "([A-Fa-f0-9][A-Fa-f0-9])" separated_content ${binary_content})
SET(prefix "@prefix@")
STRING(TOUPPER "@prefix@" prefix_uppercase)
SET(binary_file "@binary_file@")
SET(output_header "@output_header@")
SET(output_source "@output_source@")
SET(output_data "")
SET(bytes 0)
FOREACH(token IN LISTS separated_content)
IF(NOT bytes EQUAL 0)
STRING(APPEND output_data ", ")
ENDIF()
MATH(EXPR line_pos "${bytes} & 0xF")
IF(line_pos EQUAL 0)
STRING(APPEND output_data "\n ")
ENDIF()
STRING(APPEND output_data "0x${token}")
MATH(EXPR bytes "${bytes} + 1")
ENDFOREACH()
CONFIGURE_FILE("@template_header@" "@output_header@" @ONLY)
CONFIGURE_FILE("@template_source@" "@output_source@" @ONLY)
FILE(WRITE @OUTPUT_BASENAME@.c "${output}")
wlmaker-0.3/cmake/embed_binary.c.in 0000664 0000000 0000000 00000001765 14641446446 0017315 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file @output_source@
* Generated from "@binary_file@"
*
* @copyright
* Copyright 2024 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.
*/
#include "@output_header@"
const uint8_t embedded_binary_@prefix@_data[] = {@output_data@};
const size_t embedded_binary_@prefix@_size = sizeof(
embedded_binary_@prefix@_data);
/* == End of @output_source ================================================ */
wlmaker-0.3/cmake/embed_binary.h.in 0000664 0000000 0000000 00000002236 14641446446 0017314 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file @output_header@
* Generated from "@binary_file@"
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __EMBEDDED_@prefix_uppercase@_H__
#define __EMBEDDED_@prefix_uppercase@_H__
#include
#include
/** Embedded content of "@binary_file@". */
extern const uint8_t embedded_binary_@prefix@_data[];
/** Size of "@binary_file@". */
extern const size_t embedded_binary_@prefix@_size;
#endif // __EMBEDDED_@prefix_uppercase@_H__
/* == End of @output_header ================================================ */
wlmaker-0.3/dependencies/ 0000775 0000000 0000000 00000000000 14641446446 0015461 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/CMakeLists.txt 0000664 0000000 0000000 00000010176 14641446446 0020226 0 ustar 00root root 0000000 0000000 # 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.
#
# Default arguments:
# cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local -B build
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
PROJECT(wlmaker VERSION 0.1
DESCRIPTION "Wayland Maker - Dependencies"
LANGUAGES C)
# TODO(kaeser@gubbe.ch): Add a target for refreshing all submodules.
# See https://cliutils.gitlab.io/modern-cmake/chapters/projects/submodule.html
# If not found: Try 'pip3 install --user meson'
FIND_PROGRAM(MESON_EXECUTABLE NAMES meson REQUIRED)
FIND_PROGRAM(NINJA_EXECUTABLE NAMES ninja REQUIRED)
FIND_PACKAGE(PkgConfig REQUIRED)
# https://github.com/phkaeser/libbase
# Initialize: git submodule update --init --recursive --merge
# Checkout: git submodule update --checkout --recursive --merge
# Update: git submodule update --remote --merge
# Update: (cd libbase && git pull)
# ADD_SUBDIRECTORY(libbase)
# wlroots -- build and configure from the git submodule.
# Note: This will *NOT* automatically install the library.
INCLUDE(ExternalProject)
ExternalProject_Add(drm
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/drm"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix=
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
)
ExternalProject_Add(pixman
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/pixman"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix=
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
)
ExternalProject_Add(wayland
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/wayland"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix=
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
)
ExternalProject_Add(wayland_protocols
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/wayland-protocols"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix=
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
)
ExternalProject_Add(hwdata
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/hwdata"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ./configure --prefix= --datadir=/share --datarootdir=/share
BUILD_COMMAND make
INSTALL_COMMAND make install
BUILD_IN_SOURCE 1
)
ExternalProject_Add(libdisplay_info
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/libdisplay-info"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix=
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
DEPENDS hwdata
)
# XWayland as optional dependency, configure wlroots accordingly.
PKG_CHECK_MODULES(XWAYLAND xwayland>=22.1.9)
IF(XWAYLAND_FOUND)
SET(WLROOTS_XWAYLAND "-Dxwayland=enabled")
ELSE(XWAYLAND_FOUND)
SET(WLROOTS_XWAYLAND "-Dxwayland=disabled")
ENDIF(XWAYLAND_FOUND)
ExternalProject_Add(wlroots
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/wlroots"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix= -Dexamples=true -Dbackends=drm,libinput,x11 ${WLROOTS_XWAYLAND}
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
DEPENDS drm wayland pixman wayland_protocols hwdata libdisplay_info
)
wlmaker-0.3/dependencies/drm/ 0000775 0000000 0000000 00000000000 14641446446 0016243 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/hwdata/ 0000775 0000000 0000000 00000000000 14641446446 0016731 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/libdisplay-info/ 0000775 0000000 0000000 00000000000 14641446446 0020546 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/pixman/ 0000775 0000000 0000000 00000000000 14641446446 0016755 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/wayland/ 0000775 0000000 0000000 00000000000 14641446446 0017120 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/wayland-protocols/ 0000775 0000000 0000000 00000000000 14641446446 0021142 5 ustar 00root root 0000000 0000000 wlmaker-0.3/dependencies/wlroots/ 0000775 0000000 0000000 00000000000 14641446446 0017172 5 ustar 00root root 0000000 0000000 wlmaker-0.3/doc/ 0000775 0000000 0000000 00000000000 14641446446 0013600 5 ustar 00root root 0000000 0000000 wlmaker-0.3/doc/BUILD.md 0000664 0000000 0000000 00000005642 14641446446 0014770 0 ustar 00root root 0000000 0000000 # Build Wayland Maker
## Install required packages
Wayland Maker is developed and tested on Debian, hence we're using package
names and versions as found on that distribution. You need to run:
```
apt-get install -y \
bison \
clang \
cmake \
doxygen \
flex \
foot \
git \
glslang-dev \
glslang-tools \
graphviz \
libcairo2-dev \
libgbm-dev \
libinput-dev \
libncurses-dev \
libseat-dev \
libudev-dev \
libvulkan-dev \
libwayland-dev \
libxcb-composite0-dev \
libxcb-dri3-dev \
libxcb-ewmh-dev \
libxcb-icccm4-dev \
libxcb-present-dev \
libxcb-render-util0-dev \
libxcb-res0-dev \
libxcb-xinput-dev \
libxkbcommon-dev \
libxml2-dev \
meson \
plantuml \
seatd \
wayland-protocols \
xmlto \
xsltproc \
xwayland
```
See the [github build workflow](../.github/workflows/build-for-linux.yml) as reference.
## Get Wayland Maker
```
git clone https://github.com/phkaeser/wlmaker.git
```
Run the commands below from the directory you cloned the source into.
## Get, build and install dependencies
Wayland Maker is still in development and is depending on a set of rapidly
evolving libraries. To keep the API between code and dependencies synchronized,
some dependencies are included as github submodules. Here's how to configure
and build these.
The dependencies will be installed to `${HOME}/.local`:
``` bash
git submodule update --init --checkout --recursive --merge
(cd dependencies &&
LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local -B build &&
cd build &&
LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
make)
```
## Configure, build and install Wayland Maker
```bash
LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
cmake -DCMAKE_INSTALL_PREFIX="${HOME}/.local" -B build/
```
``` bash
(cd build && \
LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
make && \
make install)
```
Now you have an installed binary, and can run it with the appropriate
environment. See [running instructions](RUN.md) for more details.
```bash
LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
${HOME}/.local/bin/wlmaker
```
Please report if something doesn´t work for you.
wlmaker-0.3/doc/CMakeLists.txt 0000664 0000000 0000000 00000003623 14641446446 0016344 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
FIND_PACKAGE(Doxygen)
IF(DOXYGEN_FOUND)
FIND_FILE(PLANTUML_JAR
NAMES plantuml.jar
HINTS ENV{PLANTUML_JAR_PATH}
PATHS
/usr/global/share/java/plantuml/
/usr/local/share/java/plantuml/
/usr/share/java/
/usr/local/share/java/
/usr/share/plantuml/)
IF(PLANTUML_JAR)
SET(DOXYGEN_PLANTUML_JAR_FILE ${PLANTUML_JAR})
ELSE()
SET(DOXYGEN_PLANTUML_JAR_FILE "")
MESSAGE(
NOTICE
"Did not find plantuml.jar -- Will not generate class diagrams.")
ENDIF(PLANTUML_JAR)
IF(config_DOXYGEN_CRITICAL)
SET(DOXYGEN_WARN_AS_ERROR "YES")
ELSE(config_DOXYGEN_CRITICAL)
SET(DOXYGEN_WARN_AS_ERROR "NO")
ENDIF(config_DOXYGEN_CRITICAL)
# set input and output files
SET(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
# request to configure the file
CONFIGURE_FILE(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
MESSAGE(NOTICE "Doxygen available, adding 'doc' target.")
ADD_CUSTOM_TARGET(
doc
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
DEPENDS ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen."
VERBATIM)
ELSE()
MESSAGE(NOTICE "Doxygen not found. Not adding 'doc' target to generate API documentation.")
ENDIF(DOXYGEN_FOUND)
wlmaker-0.3/doc/Doxyfile.in 0000664 0000000 0000000 00000340461 14641446446 0015723 0 ustar 00root root 0000000 0000000 # Doxyfile 1.9.1
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the configuration
# file that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
# The default value is: UTF-8.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = "wlmaker"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.
CREATE_SUBDIRS = NO
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.
ALLOW_UNICODE_NAMES = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
# /***************
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
# Javadoc-style will behave just like regular comments and it will not be
# interpreted by doxygen.
# The default value is: NO.
JAVADOC_BANNER = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# By default Python docstrings are displayed as preformatted text and doxygen's
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
# doxygen's special commands can be used and the contents of the docstring
# documentation blocks is shown as doxygen documentation.
# The default value is: YES.
PYTHON_DOCSTRING = YES
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 4
# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines (in the resulting output). You can put ^^ in the value part of an
# alias to insert a newline as if a physical newline was in the original file.
# When you need a literal { or } or , in the value part of an alias you have to
# escape them by means of a backslash (\), this can lead to conflicts with the
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
# sources only. Doxygen will then generate output that is more tailored for that
# language. For instance, namespaces will be presented as modules, types will be
# separated into more groups, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_SLICE = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files). For instance to make doxygen treat .inc files
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen. When specifying no_extension you should add
# * to the FILE_PATTERNS.
#
# Note see also the list of default file extension mappings.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See https://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 5
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
# during processing. When set to 0 doxygen will based this on the number of
# cores available in the system. You can set it explicitly to a value larger
# than 0 to get more control over the balance between CPU load and processing
# speed. At this moment only the input processing can be done using multiple
# threads. Since this is still an experimental feature the default is set to 1,
# which efficively disables parallel processing. Please report any issues you
# encounter. Generating dot graphs in parallel is controlled by the
# DOT_NUM_THREADS setting.
# Minimum value: 0, maximum value: 32, default value: 1.
NUM_PROC_THREADS = 1
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
# documentation are documented, even if no documentation was available. Private
# class members and static file members will be hidden unless the
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Note: This will also disable the warnings about undocumented members that are
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.
EXTRACT_PRIV_VIRTUAL = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If this flag is set to YES, the name of an unnamed parameter in a declaration
# will be determined by the corresponding definition. By default unnamed
# parameters remain unnamed in the output.
# The default value is: YES.
RESOLVE_UNNAMED_PARAMS = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# declarations. If set to NO, these declarations will be included in the
# documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
# able to match the capabilities of the underlying filesystem. In case the
# filesystem is case sensitive (i.e. it supports files in the same directory
# whose names only differ in casing), the option must be set to YES to properly
# deal with such files in case they appear in the input. For filesystems that
# are not case sensitive the option should be be set to NO to properly deal with
# output files written for symbols that only differ in casing, such as for two
# classes, one named CLASS and the other named Class, and to also support
# references to files without having to specify the exact matching casing. On
# Windows (including Cygwin) and MacOS, users should typically set this option
# to NO, whereas on Linux or other Unix flavors it should typically be set to
# YES.
# The default value is: system dependent.
CASE_SENSE_NAMES = YES
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
# their full class and namespace scopes in the documentation. If set to YES, the
# scope will be hidden.
# The default value is: NO.
HIDE_SCOPE_NAMES = NO
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
# YES the compound reference will be hidden.
# The default value is: NO.
HIDE_COMPOUND_REFERENCE= NO
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if ... \endif and \cond
# ... \endcond blocks.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
# documentation. If the initializer consists of more lines than specified here
# it will be hidden. Use a value of 0 to hide initializers completely. The
# appearance of the value of individual variables and macros / defines can be
# controlled using \showinitializer or \hideinitializer command in the
# documentation regardless of this setting.
# Minimum value: 0, maximum value: 10000, default value: 30.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
# the bottom of the documentation of classes and structs. If set to YES, the
# list will mention the files that were used to generate the documentation.
# The default value is: YES.
SHOW_USED_FILES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
# (if specified).
# The default value is: YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the
# Folder Tree View (if specified).
# The default value is: YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
# extension is automatically appended if omitted. This requires the bibtex tool
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
# For LaTeX the style of the bibliography can be controlled using
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
# search path. See also \cite for info how to create references.
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated to
# standard output by doxygen. If QUIET is set to YES this implies that the
# messages are off.
# The default value is: NO.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
# this implies that the warnings are on.
#
# Tip: Turn warnings on while writing the documentation.
# The default value is: YES.
WARNINGS = YES
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
# in a documented function, or documenting parameters that don't exist or using
# markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
# are documented, but have no documentation for their parameters or return
# value. If set to NO, doxygen will only warn about wrong or incomplete
# parameter documentation, but not about the absence of documentation. If
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
# at the end of the doxygen process doxygen will return with a non-zero status.
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
# The default value is: NO.
WARN_AS_ERROR = @DOXYGEN_WARN_AS_ERROR@
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
# will be replaced by the file and line number from which the warning originated
# and the warning text. Optionally the format may contain $version, which will
# be replaced by the version of the file (if it could be obtained via
# FILE_VERSION_FILTER)
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
# messages should be written. If left blank the output is written to standard
# error (stderr).
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @PROJECT_SOURCE_DIR@/src \
@PROJECT_SOURCE_DIR@/src/conf \
@PROJECT_SOURCE_DIR@/src/toolkit \
@PROJECT_SOURCE_DIR@/apps/ \
@PROJECT_SOURCE_DIR@/apps/libwlclient
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see:
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# Note the list of default checked file patterns might differ from the list of
# default file extension mappings.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
# *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f18 \
*.f \
*.for \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.ice
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
# from the input.
# The default value is: NO.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
#
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command:
#
#
#
# where is the value of the INPUT_FILTER tag, and is the
# name of an input file. Doxygen will then use the output that the filter
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
# will be ignored.
#
# Note that the filter must not add or remove lines; it is applied before the
# code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
# The default value is: NO.
FILTER_SOURCE_FILES = NO
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
# it is also possible to disable source filtering for a specific pattern using
# *.ext= (so without naming a filter).
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
FILTER_SOURCE_PATTERNS =
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
# is part of the input, its contents will be placed on the main page
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
# generated. Documented entities will be cross-referenced with these sources.
#
# Note: To get rid of all source code in the generated output, make sure that
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.
INLINE_SOURCES = NO
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
# Fortran comments will always remain visible.
# The default value is: YES.
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
# The default value is: NO.
REFERENCES_RELATION = NO
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
# link to the documentation.
# The default value is: YES.
REFERENCES_LINK_SOURCE = YES
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
# source code will show a tooltip with additional information such as prototype,
# brief description and links to the definition and documentation. Since this
# will make the HTML file larger and loading of large files a bit slower, you
# can opt to disable this feature.
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
# source browser. The htags tool is part of GNU's global source tagging system
# (see https://www.gnu.org/software/global/global.html). You will need version
# 4.8.6 or higher.
#
# To use it do the following:
# - Install the latest version of global
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
# - Make sure the INPUT points to the root of the source tree
# - Run doxygen as normal
#
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
# tools must be available from the command line (i.e. in the search path).
#
# The result: instead of the source browser generated by doxygen, the links to
# source code will now point to the output of htags.
# The default value is: NO.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
# verbatim copy of the header file for each class for which an include is
# specified. Set to NO to disable this.
# See also: Section \class.
# The default value is: YES.
VERBATIM_HEADERS = YES
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see:
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
# performance. This can be particularly helpful with template rich C++ code for
# which doxygen's built-in parser lacks the necessary type information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
# YES then doxygen will add the directory of each input to the include path.
# The default value is: YES.
CLANG_ADD_INC_PATHS = YES
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the directory containing a file called compile_commands.json. This
# file is the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
# options used when the source files were built. This is equivalent to
# specifying the -p option to a clang tool, such as clang-check. These options
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
# will be added as well.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
# while generating the index headers.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
# The default value is: .html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
# each generated HTML page. If the tag is left blank doxygen will generate a
# standard header.
#
# To get valid HTML the header file that includes any scripts and style sheets
# that doxygen needs, which is dependent on the configuration options used (e.g.
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
# default header using
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
# YourConfigFile
# and then modify the file new_header.html. See also section "Doxygen usage"
# for information on how to generate the default header that doxygen normally
# uses.
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. For a description
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
# footer. See HTML_HEADER for more information on how to generate a default
# footer and what special commands can be used inside the footer. See also
# section "Doxygen usage" for information on how to generate the default footer
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
# the HTML output. If left blank doxygen will generate a default style sheet.
# See also section "Doxygen usage" for information on how to generate the style
# sheet that doxygen normally uses.
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
# created by doxygen. Using this option one can overrule certain style aspects.
# This is preferred over using HTML_STYLESHEET since it does not replace the
# standard style sheet and is therefore more robust against future updates.
# Doxygen will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_FILES =
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
# this color. Hue is specified as an angle on a colorwheel, see
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# purple, and 360 is red again.
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
# value of 255 will produce the most vivid colors.
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
# gradually make the output lighter, whereas values above 100 make the output
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
# change the gamma.
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
# to YES can help to show when doxygen was last run and thus if the
# documentation is up to date.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via JavaScript. If disabled, the navigation index will
# consists of multiple levels of tabs that are statically embedded in every HTML
# page. Disable this option to support browsers that do not have JavaScript,
# like the Qt help browser.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_MENUS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to
# such a level that at most the specified number of entries are visible (unless
# a fully collapsed tree already exceeds this amount). So setting the number of
# entries 1 will produce a full collapsed tree by default. 0 is a special value
# representing an infinite number of entries and will result in a full expanded
# tree by default.
# Minimum value: 0, maximum value: 9999, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_INDEX_NUM_ENTRIES = 100
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
# generated that can be used as input for Apple's Xcode 3 integrated development
# environment (see:
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
# create a documentation set, doxygen will generate a Makefile in the HTML
# output directory. Running make will produce the docset in that directory and
# running make install will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
# genXcode/_index.html for more information.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_DOCSET = NO
# This tag determines the name of the docset feed. A documentation feed provides
# an umbrella under which multiple documentation sets from a single provider
# (such as a company or product suite) can be grouped.
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDNAME = "Doxygen generated docs"
# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_BUNDLE_ID = org.doxygen.Project
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_PUBLISHER_NAME = Publisher
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
# (see:
# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the main .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location (absolute path
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
# run qhelpgenerator on the generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine-tune the look of the index. As an example, the default style
# sheet generated by doxygen has an example that shows how to put an image at
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# the same information as the tab index, you could consider setting
# DISABLE_INDEX to YES when enabling this option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
#
# Note that a value of 0 will completely suppress the enum values from appearing
# in the overview section.
# Minimum value: 0, maximum value: 20, default value: 4.
# This tag requires that the tag GENERATE_HTML is set to YES.
ENUM_VALUES_PER_LINE = 4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
# to set the initial width (in pixels) of the frame in which the tree is shown.
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
TREEVIEW_WIDTH = 250
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
EXT_LINKS_IN_WINDOW = NO
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
# the HTML output. These images will generally look nicer at scaled resolutions.
# Possible values are: png (the default) and svg (looks nicer but requires the
# pdf2svg or inkscape tool).
# The default value is: png.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FORMULA_FORMAT = png
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
# Note that when changing this option you need to delete any form_*.png files in
# the HTML output directory before the changes have effect.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_TRANSPARENT = YES
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
# to create new LaTeX commands to be used in formulas as building blocks. See
# the section "Including formulas" for details.
FORMULA_MACROFILE =
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# https://www.mathjax.org) which uses client side JavaScript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
# to it using the MATHJAX_RELPATH option.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
USE_MATHJAX = NO
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility), NativeMML (i.e. MathML) and SVG.
# The default value is: HTML-CSS.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_FORMAT = HTML-CSS
# When MathJax is enabled you need to specify the location relative to the HTML
# output directory using the MATHJAX_RELPATH option. The destination directory
# should contain the MathJax.js script. For instance, if the mathjax directory
# is located at the same level as the HTML output directory, then
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
# Content Delivery Network so you can quickly see the result without installing
# MathJax. However, it is strongly recommended to install a local copy of
# MathJax from https://www.mathjax.org before deployment.
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use + S
# (what the is depends on the OS and browser, but it is typically
# , /, or both). Inside the search box use the to jump into the search results window, the results can be navigated
# using the . Press to select an item or to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing +. Also here use the
# to select a filter and or to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using JavaScript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/). See the section "External Indexing and Searching" for
# details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first
# chapter. If it is left blank doxygen will generate a standard header. See
# section "Doxygen usage" for information on how to let doxygen write the
# default header to a separate file.
#
# Note: Only use a user-defined header if you know what you are doing! The
# following commands have a special meaning inside the header: $title,
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
# string, for the replacement values of the other commands the user is referred
# to HTML_HEADER.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
# generated LaTeX document. The footer should contain everything after the last
# chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
# special commands can be used inside the footer.
#
# Note: Only use a user-defined footer if you know what you are doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
# will copy the style sheet files to the output directory.
# Note: The order of the extra style sheet files is of importance (e.g. the last
# style sheet in the list overrules the setting of the previous ones in the
# list).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
# files. Set this option to YES, to get a higher quality PDF documentation.
#
# See also section LATEX_CMD_NAME for selecting the engine.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
# command to the generated LaTeX files. This will instruct LaTeX to keep running
# if errors occur, instead of asking the user for help. This option is also used
# when generating formulas in HTML.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
# page will contain the date and time when the page was generated. Setting this
# to NO can help when comparing the output of multiple runs.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_TIMESTAMP = NO
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it.
# The default directory is: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
# front of it.
# The default directory is: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
WLMAKER_HAVE_XWAYLAND=1 \
__UNUSED__= \
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be
# listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: YES.
HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# When you want a differently looking font in the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag UML_LOOK is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, doxygen will add type and arguments for attributes and
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
# will not generate fields with class member information in the UML graphs. The
# class diagrams will look similar to the default class diagrams but using UML
# notation for the relationships.
# Possible values are: NO, YES and NONE.
# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.
DOT_UML_DETAILS = NO
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
# significantly it will wrapped across multiple lines. Some heuristics are apply
# to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_WRAP_THRESHOLD = 17
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# http://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file. If left blank, it is assumed
# PlantUML is not used or called during a preprocessing step. Doxygen will
# generate a warning when it encounters a \startuml command in this case and
# will not generate output for the diagram.
PLANTUML_JAR_PATH = @DOXYGEN_PLANTUML_JAR_FILE@
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not seem
# to support this out of the box.
#
# Warning: Depending on the platform used, enabling this option may lead to
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
# read).
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
# files that are used to generate the various graphs.
#
# Note: This setting is not only used for dot files but also for msc and
# plantuml temporary files.
# The default value is: YES.
DOT_CLEANUP = YES
wlmaker-0.3/doc/ROADMAP.md 0000664 0000000 0000000 00000032727 14641446446 0015220 0 ustar 00root root 0000000 0000000 # wlmaker - Roadmap
Vision: A lightweight and fast Wayland compositor, visually inspired by Window
Maker, and fully theme-able and configurable.
Support for visual effects to improve usability, but not for pure show.
## 0.1 - MVP milestone
### Features
* [done] Support `xdg_shell`.
* [done] Support `layer_shell`.
* [done] Support window decoration protocol.
* [done] Style of title bar, iconify and close buttons similar to Window Maker.
* [done] Window menu, with basic window actions (not required to adapt to state).
* [done] Multiple workspaces
* [done] Navigate via keys (ctrl-window-alt-arrows, hardcoded).
* [done] Dock, visible across workspaces.
* [done] Style similar to Window Maker.
* [done] With application launchers (hardcoded).
* [done] Clip
* [done] Display the current workspace.
* [done] Buttons to switch between workspaces.
* [done] Application launchers
* [done] Display an icon.
* [done] Display application status (*starting*, *running*).
* [done] Configurable (in code).
* [done] Window actions
* [done] Move (drag via title bar, or window-alt-click)
* [done] Resize windows, including a resize bar.
* [done] Fullscreen windows.
* [done] Maximize windows.
* [done] Minimize (*iconify*) windows.
* [done] Roll up (*shade*) windows.
* [done] Raise window when activated.
* [done] Visualization of iconified applications.
* [done] Task list (window-alt-esc), cycling through windows.
* [done] Auto-start of configured applications.
* [done] Configurable in code.
* [done] Verify minimal application set to run:
* [done] Terminal: `foot`
* [done] Google Chrome
* [done] Mozilla Firefox
* [done] Works as a X11 window, Wayland client or standalone compositor.
### Internals and code organization
* [done] git submodule for direct and critical dependencies.
* [done] CMake as build system.
* [done] `test` and `doc` targets.
* [done] Published as open source.
## Plan for 0.2
* [done] Issues to fix:
* [done] Fix out-of-sync display of server-side decoration and window content when resizing.
* [done] Fix assertion crash when mouse is pressed, then moved to another toplevel, then released.
* [done] Hide window border when not having server-side decoration.
* [done] Fix issue with Chrome: Enabling "Use system title and boders" will pick a slightly small decoration.
* [done] Fix resize issue with Chrome & Firefox: The content size and actual window size can differ, which led to jumpy resizes as get_size and request_size operations did not base on the same.
* [not reproducible] Fix issue on resizing: When moving the mouse too quickly, focus is lost and the resizing stops.
* [done] Experimental support for Dock Apps
* [done] Experimental wayland protocol for Apps to declare icon surfaces.
* [done] Surfaces will be shown in either tile container, clip or dock area,
depending from where the app was started.
* [done] Demo DockApps included (digital clock)
* [done] Initial XWayland support
* [done] Cover enough functionality to support xterm
* [done] Enough functionality to support emacs in X11.
* [done] Support for child surfaces.
* [done] Positioning of popups
* [done] Ensure stacking order is respected and used.
* [done] Popups do not contribute to window extensions (no border hops)
* [done] Cursor set appropriately.
* [done] Set DISPLAY env variable appropriately.
* [done] Handling of modal windows: Should have decorations, stay on top.
* [done] Configurable keyboard map (in code ~or commandline arg~)
* Support `xdg_shell`, based on toolkit.
* [done] XDG Popups.
* [done] Move and Resize, compliant with asynchronous ops.
* [done] Maximize.
* [done] Set title.
* [done] fullscreen.
* [done] Fix positioning of popups.
* [regression, not supported] show window menu.
* [done] Support window decoration protocol, based on toolkit.
* [done] Style of title bar, iconify and close buttons similar to Window Maker.
* [done] No border shown when windows are not decorated (eg. chrome, firefox)
* [done] Task List
* [done] Listing windows, rather than views.
* [done] Window actions, based on toolkit.
* [done] Move ([done] drag via title bar, or [done] window-alt-click)
* [done] Resize windows, including a resize bar.
* [done] Fullscreen windows.
* [done] Maximize windows.
* [done] Roll up (*shade*) windows.
* [done] Raise window when activated.
* [done] App Launcher: Update status for wlmtk_window_t, instead of
wlmaker_view_t.
### Internals and code organization
* [done] Design a toolkit and re-factor the codebase to make use of it.
* Ensure the main features (eg. all explicit actions and features above) are
tested.
## Plan for 0.3
* Bugfixes
* [done] Fix issue on fullscreen: The window border is kept, having the window off by 1 pixel.
* [done] Add commandline flag to enable/disable XWayland start.
* [done] Verify startup on console works.
* [done] Screensaver support.
* [done] Implement ext-session-lock-v1 protocol.
* [done] Verify screen lock works with eg. swaylock.
* [done] Implement timer for lock, and support zwp_idle_inhibit_manager_v1 to inhibit.
* [done] Verify this still works after the to-toolkit move.
* [done] Configuration file support
* [done] Pick or implement parser for configuration file.
* [done] File for basic configuration: Keyboard map & config, auto-started apps.
* [done] Configure idle monitor and screensaver command via config file.
* [done] Configurable key combinations for basic window actions (minimize, ...).
* [done] File for visual style (theme): decoration style, background.
* [done] File to define workspaces and dock, falling back to default if not provided.
* [done] Include at least one additional theme.
* [done] Theme details
* [done] Style for resizebar.
* [done] Style for the window's margin.
* [done] Style for the window border.
* [done] Titlebar icons centered.
* [done] Titlebar icons with text color, blurred or focussed.
* ~~Bezel 'off' color so it is visible on black (not doing).~~
* [done] Titlebar font and size.
* [done] Style for clip.
* [done] Style for task list fill and text color.
* [done] Support `layer_shell`, based on toolkit.
* [done] XDG Popups.
* [done] Multiple workspaces, based on toolkit.
* [done] Remove the earlier non-toolkit code.
* [done] Background color for separate workspaces, configured in state.
* [done] Default background color, picked up from style file.
* [done] Navigate via keys (ctrl-window-alt-arrows, configurable in plist).
* [done] Dock, visible across workspaces, based on toolkit.
* [done] Keep track of subprocesses and the corresponding windows.
* [done] Style similar to Window Maker.
* [done] With application launchers (configurable in file).
* [done] Clip, based on toolkit.
* [done] Display the current workspace.
* [done] Buttons to switch between workspaces.
* [done] Application launchers, based on toolkit.
* [done] Display an icon.
* [done] Display application status (*starting*, *running*).
* [done] Configurable (in code).
* [done] Task list (window-alt-esc), cycling through windows.
* [done] Migrate implementation to wlmtk.
* [done]Key combination configurable in the config file.
* [done] Build & compile off released dependency versions.
## Plan for 0.4
**Focus**: Add menus & make it ready for "Early-Access".
* Thorough tests of both pointer and keyboard state.
* Fix bug: When switching workspace, pointer state appears to be reset.
* Issue found when killing saylock that keyboard focus is incorrect.
* Re-activate workspace & windows after lock.
* Menu, based on toolkit.
* Available as window menu in windows.
* Available as (hardcoded) application menu.
* Root menu.
* Menu with submenus.
* Window menu adapting to window state.
(Eg. "Maximize" shown when not maximized, otherwise: "restore".)
* Screensaver support.
* Magic corner to lock immediately.
* Magic corner to inhibit locking.
* Configurable corners, timeout and visualization.
* Documentation updates
* Update README to reflect "early-access" vs. "early development".
* Screenshots included. (can we script these?)
* Update build system to use libraries from the base system rather than
the `dependencies/` subdirectory, if versions are avaialble.
## Plan for 0.5
* Support for dynamic output configurations.
* Multiple monitors, with output mirrored across.
* Per-monitor fractional scale.
## Pending
### Major feature milestones
* Initial multi-monitor support: Mirrored.
* Toplevel windows represented as icons & minimized (iconified) windows.
* Drag-n-drop of icons into & from dock & clip.
### Features for further versions, not ordered by priority nor timeline.
* Wayland protocol adherence.
* Support XDG `wm_capabilities` and advertise the compositor features.
* Fullscreen: Hide all other visuals when a window takes fullscreen.
* `xdg-shell`: set_parent, by child wlmtk_window_t.
* Test `idle-inhibit-unstable-v1`. Didn't have a tool when adding.xs
* Add `ext-idle-notify-v1` support.
* Add `xdg-activation-v1` support.
* Add `wlr-foreign-toplevel-management-unstable-v1` support.
* Support `keyboard_interactivity` for `wlr-layer-shell-unstable-v1`.
* XWayland support (X11 clients).
* Proper handling of modal windows: Should be a child wlmtk_window_t to itself.
* Permit identifying the real X client, not the XWayland connection.
* Have a test matrix build that verifies the build works without XWayland.
* Fix bug with emacs hanging on saving clipboard (observed once).
* Dock Apps.
* Attached to dock (visible across workspaces) or clip (per workspace).
* Configurable to show permanently also in clip.
* Drag-and-drop between clip and dock.
* Ideally: With a Wayland protocol that permits running the dock and clip as
separate binary, independent of the compositor.
* Second Demo DockApp (julia set).
* Visualization / icons for running apps.
* Re-build this unsing wlmtk.
* Show in 'iconified' area.
* Drag-and-drop into clip or dock area.
* Consider running this as task selector, as separate binary.
* Window attributes
* Determine how to detect client preferences.
* Configurable and overridable (titlebar, resizebar, buttons, ...).
* Scaling factor per application.
* Build and test a clear model for `organic`/`maximized`/`fullscreen` state
switches and precedence.
* Window menu, adapting to state (eg. no "maximize" when maximized).
* Application support.
* Icons retrieved and used for iconified windows. See [themes](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html).
* Make use of XDG Desktop Entry [specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
* XDG Complianace
* Review and define what to support from https://specifications.freedesktop.org.
* Autostart.
* System Tray (potentially through a Dock App)
* Icon Themes
* Notifications (potentially through a Dock App)
* Application launcher
* Show icon from XDG desktop entry.
* For running apps, consider showing the surface on the tile.
* Configuration menu: Commandline, and further settings.
* A logo and info panel.
* Window actions
* Send to another workspace, using menu or key combinations.
* Window *shade* triggered by double-click, and animated.
* Minimize (*iconify*) windows, using wlmtk.
* Window menu.
* Application ID (from XDG shell and/or X11).
* Configuration file, for:
* Application launchers of the dock.
* Application launchers for the clip.
* Workspace configuration.
* Background.
* Theme.
* Look into swapping the diagonal gradient to follow window maker style (not cairo).
* Auto-started applications.
* Configurable keyboard map.
* Verify support of multi-layout configurations (eg. `shift_caps_toggle`)
* Window placement
* Automatic placement on a free spot.
* Gravity to snap to and stick to borders.
* Mouse pull to sides or corners will set window to half or quarter screen.
* Configuration tool, similar to WPrefs.
* Compositor features
* Bindable hotkeys.
* Pointer position, to support apps like wmscreen or xeyes.
* Internationalization and solid font support
* Move from cairo toy interface to using pango proper.
* All text strings to be configurable and swappable.
* Commandline flags to support:
* icon lookup paths beyond the hardcoded defaults.
* Reduce Technical Debt
* Move the setenv calls for DISPLAY and WAYLAND_DISPLAY into subprocess
creation, just after fork. These should not impact the parent process.
* Exploratory ideas
* Stretch: Consider supporting XScreenSaver (or visualization modules).
## Visualization and effects
* Animations
* Launching applications, when *starting*.
* Size changes (maximize, minimize, fullscreen).
* Task switcher
* Application icons or minimized surfaces to visualize applications.
* Animations when switching focus.
* Clean up signal handling (emit on task switch, enable, disable).
* Resizing & moving
* Consider visualizing windows partially transparent when resizing or moving.
## Dock Apps
* Sensors.
* Clock
* System tray.
* CPU load.
* Network monitor.
* Laptop battery status.
* Julia set.
## Build, compile, deployment
* Run static checks and enforce them on pull requests (eg. https://www.kitware.com/static-checks-with-cmake-cdash-iwyu-clang-tidy-lwyu-cpplint-and-cppcheck/).
* Provide binary package of wlmaker.
* Run github workflows to build with GCC and Clang, x86_64 and arm64, and Linux + *BSD.
## Non-Goals
* Do not (re)create a GNUStep environment.
* Creating a dedicated toolkit.
wlmaker-0.3/doc/RUN.md 0000664 0000000 0000000 00000005746 14641446446 0014602 0 ustar 00root root 0000000 0000000 # Running Wayland Maker
If not done yet, please follow the [detailled build instructions](BUILD.md) to
build and install from source.
The commands below assume that dependencies and `wlmaker` were installed to
`${HOME}/.local`.
Once running: Press `Ctrl-Window-Alt+T` to open a terminal (`foot`), or
`Ctrl-Window-Alt+Q` to exit.
## Option 1: Run in a window
The most accessible option is to run Wayland Maker in a window in your
already-running graphical environment. It can run both on a X11 or a Wayland
session. Easiest is to run it via the wrapper script:
```bash
${HOME}/.local/bin/wrap-wlmaker.sh
```
## Option 2: Run from a Linux virtual terminal
> [!IMPORTANT]
> Make sure your distribution has `seatd` installed and running.
```
${HOME}/.local/bin/wrap-wlmaker.sh
```
Note: You may need to `su -c "pkill seatd"` to stop `seatd` after you're done.
## Option 3: Run as wayland session
> [!IMPORTANT]
> It is not recommended to run wlmaker as your main compositor. This approach
> will not work if dependencies are not all operating correctly, and is hardest
> to debug.
* Copy `${HOME}/.local/share/wlmaker.desktop` to `/usr/share/wayland-sessions/wlmaker.desktop`
* Restart your session manager, to reload the sessions.
The desktop entry will execute `${HOME}/.local/bin/wrap-wlmaker.sh`.
## Make it run for you!
* [etc/wlmaker.plist](../etc/wlmaker.plist) is the where keyboard options, key
bindings, screensaver details and more can be configured. That file in the
source tree is the compiled-in default.
To extend: Create a copy of the file to `~/.wlmaker.plist` and modify it
according to your needs. Or, move it somewhere else and call `wlmaker` with
the `--config_file=...` arugment.
* To run X11 applications in Wayland Maker, XWayland must be enabled. It is
compiled in, if the `xwayland` package is installed. In that case, use the
`--start_xwayland` option. The `DISPLAY` environment variable will be set
suitably.
* [etc/style-default.plist](../etc/style-default.plist) is the compiled-in
default theme. With [etc/style-debian.plist](../etc/style-debian.plist),
there is an alternative theme you can use -- or extend it on your own.
Run `wlmaker` with `--style_file=...` to use an alternative style.
# Debugging issues
1. `wlmaker` fails with an *ERROR* log of `Could not initialize renderer`.
This indicates that `wlroots` was unable to pick a suitable renderer. For
triaging & debugging, try the following:
1. Verify whether another `wlroots`-based compositor [^1] starts up. If
not, it's a `wlroots` issue, please follow up there.
2. Try using a different renderer, eg. by setting `WLR_RENDERER=pixman` [^2].
If that does not help: Please file an issue, including a full paste of your
the configuration & build log, and of the startup attempt.
[^1]: https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/Projects-which-use-wlroots#compositors
[^2]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/docs/env_vars.md?ref_type=heads
wlmaker-0.3/etc/ 0000775 0000000 0000000 00000000000 14641446446 0013606 5 ustar 00root root 0000000 0000000 wlmaker-0.3/etc/style-debian.plist 0000664 0000000 0000000 00000003062 14641446446 0017244 0 ustar 00root root 0000000 0000000 // Following the 'Debian' theme of Window Maker.
{
BackgroundColor = "argb32:ff77aac4";
Dock = {
Margin = {
Width = 1;
Color = "argb32:c0000000";
};
};
Tile = {
Size = 64;
BezelWidth = 2;
Fill = {
From = "argb32:ffa6a6b6";
To = "argb32:ff515561";
Type = DGRADIENT;
};
};
Clip = {
Font = {
Face = Helvetica;
Weight = Bold;
Size = 12;
};
TextColor = "argb32:ff000000";
};
Window = {
TitleBar = {
FocussedFill = {
From = "argb32:ff505a5e";
To = "argb32:ff202a2e";
Type = HGRADIENT;
};
FocussedTextColor = "argb32:ffffffff";
BlurredFill = {
From = "argb32:ffc2c0c5";
To = "argb32:ff828085";
Type = HGRADIENT;
};
BlurredTextColor = "argb32:ff000000";
Height = 22;
BezelWidth = 1;
Margin = {
Width = 1;
Color = "argb32:ff000000" ;
};
Font = {
Face = Helvetica;
Weight = Bold;
Size = 15;
};
};
ResizeBar = {
Fill = {
Color = "argb32:ffc2c0c5";
Type = SOLID;
};
Height = 7;
BezelWidth = 1;
CornerWidth = 29;
};
Border = {
Width = 1;
Color = "argb32:ff000000";
};
Margin = {
Width = 1;
Color = "argb32:ff000000";
};
};
TaskList = {
Fill = {
Color = "argb32:c0202020";
Type = SOLID;
};
Font = {
Face = Helvetica;
Weight = Bold;
Size = 18;
};
TextColor = "argb32:ffffffff";
};
}
wlmaker-0.3/etc/style-default.plist 0000664 0000000 0000000 00000003013 14641446446 0017442 0 ustar 00root root 0000000 0000000 // Style oriented on Window Maker's default.
{
BackgroundColor = "argb32:ff505080";
Dock = {
Margin = {
Width = 1;
Color = "argb32:ff000000";
};
};
Tile = {
Size = 64;
BezelWidth = 2;
Fill = {
From = "argb32:ffa6a6b6";
To = "argb32:ff515561";
Type = DGRADIENT;
};
};
Clip = {
Font = {
Face = Helvetica;
Weight = Bold;
Size = 12;
};
TextColor = "argb32:ff000000";
};
Window = {
TitleBar = {
FocussedFill = {
From = "argb32:ff000010";
To = "argb32:ff202070";
Type = DGRADIENT;
};
FocussedTextColor = "argb32:ffffffff";
BlurredFill = {
Color = "argb32:ff666666";
Type = SOLID;
};
BlurredTextColor = "argb32:ff000000";
Height = 22;
BezelWidth = 1;
Margin = {
Width = 1;
Color = "argb32:ff000000" ;
};
Font = {
Face = Helvetica;
Weight = Bold;
Size = 15;
};
};
ResizeBar = {
Fill = {
Color = "argb32:ffc2c0c5";
Type = SOLID;
};
Height = 7;
CornerWidth = 29;
BezelWidth = 1;
};
Border = {
Width = 1;
Color = "argb32:ff000000";
};
Margin = {
Width = 1;
Color = "argb32:ff000000";
};
};
TaskList = {
Fill = {
Color = "argb32:c0202020";
Type = SOLID;
};
Font = {
Face = Helvetica;
Weight = Bold;
Size = 18;
};
TextColor = "argb32:ffffffff";
};
}
wlmaker-0.3/etc/wlmaker-home.plist 0000664 0000000 0000000 00000002003 14641446446 0017246 0 ustar 00root root 0000000 0000000 // Base configuration for wlmaker: Keyboard and autostarted applications.
{
Keyboard = {
XkbRMLVO = {
Rules = "evdev";
Model = "pc105";
Layout = "ch";
Variant = "de_nodeadkeys";
Options = ""
};
Repeat = {
// Delay before initiating repeats, in milliseconds.
Delay = 300;
// Repeats per second.
Rate = 25
}
};
KeyBindings = {
"Ctrl+Alt+Logo+Q" = Quit;
"Ctrl+Alt+Logo+L" = LockScreen;
"Ctrl+Alt+Logo+T" = LaunchTerminal;
"Ctrl+Alt+Logo+Left" = WorkspacePrevious;
"Ctrl+Alt+Logo+Right" = WorkspaceNext;
"Ctrl+Alt+Logo+Escape" = TaskNext;
"Shift+Ctrl+Alt+Logo+Escape" = TaskPrevious;
"Alt+Logo+Up" = WindowRaise;
"Alt+Logo+Down" = WindowLower;
"Ctrl+Alt+Logo+F" = WindowFullscreen;
"Ctrl+Alt+Logo+M" = WindowMaximize;
};
ScreenLock = {
IdleSeconds = 300;
Command = "/usr/bin/swaylock"
};
// Optional array: Commands to start once wlmaker is running.
Autostart = (
"/usr/bin/foot"
)
} wlmaker-0.3/etc/wlmaker-state.plist 0000664 0000000 0000000 00000001406 14641446446 0017444 0 ustar 00root root 0000000 0000000 {
Dock = {
Edge = RIGHT;
Anchor = TOP;
Launchers = (
{
CommandLine = "/usr/bin/foot";
Icon = "terminal-48x48.png";
},
{
CommandLine = "/usr/bin/google-chrome --enable-features=UseOzonePlatform --ozone-platform=wayland --user-data-dir=/tmp/chrome-wayland";
Icon = "chrome-48x48.png";
},
{
CommandLine = "MOZ_ENABLE_WAYLAND=1 /usr/bin/firefox";
Icon = "firefox-48x48.png";
}
)
};
Clip = {
Edge = BOTTOM;
Anchor = RIGHT;
};
Workspaces = (
{
Name = Main;
},
{
Name = Second;
},
{
Name = Third;
// Color is optional here, overrides the style's BackgroundColor.
Color = "argb32:ff508050";
},
);
} wlmaker-0.3/etc/wlmaker.plist 0000664 0000000 0000000 00000001772 14641446446 0016334 0 ustar 00root root 0000000 0000000 // Base configuration for wlmaker: Keyboard and autostarted applications.
{
Keyboard = {
XkbRMLVO = {
Rules = "evdev";
Model = "pc105";
Layout = "us";
Variant = "intl";
Options = ""
};
Repeat = {
// Delay before initiating repeats, in milliseconds.
Delay = 300;
// Repeats per second.
Rate = 25
}
};
KeyBindings = {
"Ctrl+Alt+Logo+Q" = Quit;
"Ctrl+Alt+Logo+L" = LockScreen;
"Ctrl+Alt+Logo+T" = LaunchTerminal;
"Ctrl+Alt+Logo+Left" = WorkspacePrevious;
"Ctrl+Alt+Logo+Right" = WorkspaceNext;
"Ctrl+Alt+Logo+Escape" = TaskNext;
"Shift+Ctrl+Alt+Logo+Escape" = TaskPrevious;
"Alt+Logo+Up" = WindowRaise;
"Alt+Logo+Down" = WindowLower;
"Ctrl+Alt+Logo+F" = WindowFullscreen;
"Ctrl+Alt+Logo+M" = WindowMaximize;
};
ScreenLock = {
IdleSeconds = 300;
Command = "/usr/bin/swaylock"
};
// Optional array: Commands to start once wlmaker is running.
Autostart = (
"/usr/bin/foot"
)
} wlmaker-0.3/examples/ 0000775 0000000 0000000 00000000000 14641446446 0014651 5 ustar 00root root 0000000 0000000 wlmaker-0.3/examples/CMakeLists.txt 0000664 0000000 0000000 00000003522 14641446446 0017413 0 ustar 00root root 0000000 0000000 # Copyright 2024 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.
#
# Default arguments:
# cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local . -B build
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
PROJECT(wlmaker VERSION 0.1
DESCRIPTION "Wayland Maker - Examples & Tools")
# Requires out-of-source builds.
FILE(TO_CMAKE_PATH "${PROJECT_BINARY_DIR}/CMakeLists.txt" LOCATION_PATH)
IF(EXISTS "${LOCATION_PATH}")
MESSAGE(
FATAL_ERROR
"You cannot build into a source directory (containing a CMakeLists.txt file).\n"
"Please make a build subdirectory, for example:\n"
"cmake -B build\n"
"(cd build && make)")
ENDIF()
# If not found: Try 'pip3 install --user meson'
FIND_PROGRAM(MESON_EXECUTABLE NAMES meson REQUIRED)
FIND_PROGRAM(NINJA_EXECUTABLE NAMES ninja REQUIRED)
INCLUDE(ExternalProject)
# Extra packages required on Debian:
#
# libgtk-3-dev
# libgirepository1.0-dev
# valac
#
# Hm. Could also have installed gtk-layer-shell-examples ?
# Also, there is https://github.com/wmww/gtk4-layer-shell.
ExternalProject_Add(gtk_layer_shell
SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/gtk-layer-shell"
INSTALL_DIR ${CMAKE_INSTALL_PREFIX}
CONFIGURE_COMMAND ${MESON_EXECUTABLE} --prefix= -Dexamples=true
BUILD_COMMAND ${NINJA_EXECUTABLE} -C
INSTALL_COMMAND ${NINJA_EXECUTABLE} -C install
)
wlmaker-0.3/examples/README.md 0000664 0000000 0000000 00000000656 14641446446 0016137 0 ustar 00root root 0000000 0000000 # Examples or tools suitable for wlmaker
Through git submodules, this directory points to various tools for using with,
or for experimenting with wlmaker.
These tools are not built by default. See `CMakeLists.txt` for potential
further package dependencies.
```
git submodule update --init --recursive --merge
git submodule update --checkout --recursive --merge
cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local . -B build
```
wlmaker-0.3/examples/gtk-layer-shell/ 0000775 0000000 0000000 00000000000 14641446446 0017655 5 ustar 00root root 0000000 0000000 wlmaker-0.3/icons/ 0000775 0000000 0000000 00000000000 14641446446 0014146 5 ustar 00root root 0000000 0000000 wlmaker-0.3/icons/CMakeLists.txt 0000664 0000000 0000000 00000001340 14641446446 0016704 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
INSTALL(FILES
chrome-48x48.png
clip-48x48.png
firefox-48x48.png
terminal-48x48.png
DESTINATION share/icons/wlmaker)
wlmaker-0.3/icons/README.md 0000664 0000000 0000000 00000002066 14641446446 0015431 0 ustar 00root root 0000000 0000000 Icons that are re-distributable with wlmaker, respecting the various
licenses below:
* chrome-48x48.png : MIT License [SuperTinyIcons](https://github.com/edent/SuperTinyIcons/blob/master/LICENSE))
* https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/chrome.svg
* Resized using gimp.
* firefox-48x48.png : MIT License [SuperTinyIcons](https://github.com/edent/SuperTinyIcons/blob/master/LICENSE))
* https://raw.githubusercontent.com/edent/SuperTinyIcons/master/images/svg/firefox.svg
* Edited to remove background, resized using gimp.
* terminal-48x48.png : Public Domain [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Terminalicon2.png)
* https://upload.wikimedia.org/wikipedia/commons/b/b3/Terminalicon2.png
* convert -resize 48x48^ Terminalicon2.png terminal-48x48.png
* clip-48x48.png : Public domain [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Ryanlerch_green_paperclip.svg)
* https://upload.wikimedia.org/wikipedia/commons/0/0c/Ryanlerch_green_paperclip.svg
* Edited for size in gimp, resized.
wlmaker-0.3/icons/chrome-48x48.png 0000664 0000000 0000000 00000005047 14641446446 0016734 0 ustar 00root root 0000000 0000000 PNG
IHDR 0 0 W iCCPICC profile (}=HPO["A;8d,VBЪKIC( Y:8*? .N.R}IE {e cYF*2U!.ЏD%fsg}S/]gyYJdO eaoOmZ:}0+J
9A$~~6ҩy0PhcYP'#Q?yZ= C9me봆" B*J(Bv):{ H.\%0r,߳5nR(t5> xR?Iз
\\4ytɐ )@˟gMY`Ys<Y%oC Zuwwߞ~ rNv bKGD pHYs
B(x tIME;Jp "IDAThYipS}ix`01 Nb(^,dPHZ ]I!Mmh I)!a
ē`2B fH\Mb05dlɲ'Y{?dR,[O)矞9:;~gAV4>SfrIg;MCxM( P-9x ev1&*v{V-O3 T)Ouoo/ d 4hDSR'6~9$ XYe$F{D3wbdծo,\ R$Q=2q`*
#y 6s:cE#@۪;]LG6˷7h[5nx^貼K?r
֤y p}Zd]!E&}1MBUf }4lN89 O-ihT 5R P6s#k.Ϋrdhs >i^ Xw#$8i#t ɩo jGl =yƋ_I0O<~xAMƾz rfc @ r_Fe ZLn&V*އ6GK0Pd
)J"䚗Q."Sɜ&+ M 83&O^1Ԋ%[U ƀ/yS'4 I#xjӁfl|`MK,P Uoߝn< E !r3,)vۃ: {v,- Pб+ zpڣ}) ̿.Aj,̈́d ^C ITN0'SD P6Q/ƀ1g{슝?V |t($G7o}{~RJmS5ްU]5P(Mo0&Ch2w3^zqqr'M bt O;$쀟#9x7{r?b |huT=:eD(-G |H [[DTDE:mns tFoiYii(-t}W AH,XNi;ˈN
{ HזUR)TQy s# k5 ٩[]TNTrz#:4s @ä|g02.#RZ} i [@O֭1-&Y]&"}DӘ.\( Ij<ZOO*aP奆}n`Ąd4!ǶŁ"`MqC3E24]x[bM^CxE;QۉʌDի!7*p̩k 0VDq#V_{ ;`BHa k ^nu~[5_zk}cwZQkJA W 7R6#r>6kN CxH3+;
S*D:3^ 7 IO ,7aC_}rY58 I
GA 䎚$$& Nߪg {YZqp2 Gm
YƑ]oߏ%w vlLj
o*rw37-иCXm .akba14l PXoExpRNZLT N,6 ILJ$ /o6_twϿd5+ 4TVF:m8<Lks+6K(x\¼XEE_" ?sw;0<|@PzYdP°% |ȋ.
hwА/z}6[ 5!
'`i8Z^
]ܒCO% ] 3?"@6Ho`ɮ xK]zƥBk[4:`oN }c9~}[S/ 15F sx
l/h Ǐp fUf7N?eNp2B7'5sb ]6BY c!?8{j owZ IENDB` wlmaker-0.3/icons/clip-48x48.png 0000664 0000000 0000000 00000010061 14641446446 0016376 0 ustar 00root root 0000000 0000000 PNG
IHDR 0 0 W ~iCCPicc (}=HPO[*vqPVBЪKIC( Y:8*? .N.R}IE {e 〪YF*2U!.(z$fsg}S/]gyY}JdO eaoOoZ:}+J
9A$~~1ҩyPhcYPQ?yZ= C9me봆" B*J(Bv):{ H.\%0r,߳5nR(t05> xRf>Iп
\\4ytɐ )@˟gMY | skHӬ7!0Ruwwߞ~ -%rqI cHRM z& u0 ` : pQ< bKGD pHYs
B(x tIME+([
IDAThilǟg8Cx ")R("Al[t8m6-:fE\ u7q6Mc@jǵ [e˒hɢÒ, ΐ ǍƱ އ<;mi!%^ .~h< `(X50c cVj%XU% ]
sP yh]`9Uj"Xj9uJ=L(|JHgM y V $!Ht&bJ27ĚT
Z&M̝x؞cI V `6X (0LG$meV,$Kp ޥZT, }з{g. (L p /(JUxlub^ 4f'<,]9| okӳgՎ8t3 @h.HB
I-])>cwt9^^2߿ hcUM_jzЌٸrS:MF$F\)w(jR[o}VU.)
ܙ3b "l B"R;L l{n?~镗?1e 1P (UKlվ^7
p*t=[oxě}z\5Mr%\C4P ѐӃ
"ѺD3P)w#Laya +"]TTzƏ{j 2"i 8"o 8IzQN)FUn箹'ǎ勖+4X^Vc`GKY4tlpF\JG5Fd ^>S"),-fV0F gu&>ЛCk_1="+ht w~{gr'!̐LNJJYg)z)Z,_SQMmU}VͺZ]A=;>8~d+=ν_lS[1߸XKG^:*v[E1RB-/S_r/{ޯK IK[{˰I2eb21wG~o# K XLzr_iH`1!*(_ $
6.4 [i>Ĝ?:1eMp `A hzk9S6d"~?s ˄1ԨYS,_bL=ݬn3dm <78&V ƃq~R :=TT8nlkwe\{<揋9ڪF}!3/8Hw+ԂJ ])!M&$NUlVl$qZgCiկѱFl{5RI^ m g2$C..K]\[fӍӹ&gn'8y}|Xȉ(YN+;$a~Ҙ0.p=¾|=?]^op*^N[*c=>}߫qj mv `"Nf9v@"i(7n FJn_I甃*//6 S8%ָH)PX*300@ \ieJp_FlN 2%kN;u@\,?[e @
Uh6r k77]ø/4Ng*g' #bCT/];|
1 Ki!B%$NhvT(<;>-fJR]% 'z CМQfߛݭ5j:]0&h|o `hbiXYYZjsSGNÓbd5e?jo}8]Ve4Z
[yq
zAFQ"/-"VKxo6X0v k?pb~ @@SjiZ- Bi -,L 㸨# uiPIK K fx;D]I=n`Sl:m}^ |uDd}P`$<>Y@kI$I O].ebنZcgBl1|0}5 \Ʈ @C" EBa=n;4sv*dжĶ J
s{y[lPox O^oybM1>7s (r] 6c"T?,hy!bBY6λ}Ш046ɄͭW 29IJ.γ~5o1 2ô77m>qdx̤ ?r]segFLz8J,;X`V25)☪/d=V9oq*5ֺ'a8,s0X$PPC؈Ӯb!M ȥ FTAv{VarK
'B@8ǎ<W';붦;!+i ~Fߔ"@ߚ79N *u E^ywoir|j} bKGD pHYs
B(x tIME4?
sIDATh՚yl\x Ivi $ %4,2P *Z(Vj(j)j"U
)
EUagi,$^=oY=IhHG3o||g>*?S%ˎu ?P ";G;_V T" ]rD{۟[5x x: y .9
sԮkJīqk 3\զ\ur0{z犕 K^GϪD P/KTQ,o~
? ǧMcST" 9& K~T`kį=,."16g jҴ;yP;*o 0w03{`y oc ,<8aъXA kQ.i7DBhR.4$ /xʿ"y Q"k ,8֮G6!R ˁ!a|i @fE ) EKVy= %Ch ';wiK7+uG.@euo@ W7E{ xݬճBHʵ;
PVF|֥/! '< < ';7[ނcYB zѱߤu6Hq^^;P @~lFEbZ0-[(pKJ%<ߟ4=kZx~ۀ;n#r
B,\!"EX+g JI=ykWf%qń6>?yoW ق Ĝ5JYq J R ZuV(z^tzf&zw 4P" }hs
6%_]E] i#TVgJ ~C[w ϺO] G`fX|@^IKݨ7{h6M "hi'Gb b䞇ǀ-)6i4 Q|I U@{VAK%4(Iɻ]؋i)
} |xbO@&
_d9僀qU!8aiWcd,==D2J; :Y16ӇU ZlGg
g
Z\BOo5N Wˆ [#* , hxQY9C!Naj *J&=Po6ێ#:dӖNgasb3RϹ-, Y
aQ\ 6k dߑj)^JsD!TЛ@ /,=ؑWȆ` @[m ZG? [q
oR*v_\\+q|Mq$,w,c)_Tphua\`o8i$$Wr?U<=AL
N_Ŝ/3 {GT3b?_*TjiN~l(D ܠ&wd DP
.ÊeY|p=I9<{1tT8 3'N r/k
]7'^QʛԸz]b TZP1wp:N,9:4ܞjP!A
kK8
x70*7Bx[/1cIktDN ;KV"B J |Zr](Ai4MQjMP]!XTw?]XzihJ &J3*َ,hQ{=1U] \pn1%8x
4MMiּ\RdW/ga!G= TX4HN~R%hVζ#O+<Ҥ6t
@h>jjG1l`t0(+?yT :n4 #fS? H䖛c) N
Ɂ\+B~i5AW9&|hoQ">3jO!1si =$':. :f GM% KRJb#Hit,'eF0Q#aAq*Lj!m <1p7t\wPM P x]B KNw?3ݩOСW g 8Y GHN3xPj>IM3 :f`_jxx:6gU q1ZV`V _)s єX IENDB` wlmaker-0.3/icons/terminal-48x48.png 0000664 0000000 0000000 00000004232 14641446446 0017265 0 ustar 00root root 0000000 0000000 PNG
IHDR 0 0 W gAMA a cHRM z& u0 ` : pQ< bKGD pHYs % %IR$ tIME5C!. IDAThYmlS~ιNHj& ,)c l?jmS0u 1mjD24
QM E1Q)%D2@іHx`/ۍ;H㑬k{ xx9|I^RӹscN)}0|f蛦T "@(2uog[foŻhv~531ág' BNJ1Ibm4o Fs2tC-ȏ>^oCC ֬ ?=_s&.Ժz797rE|>x w0 f8Ʀ b0Mtaaq1jowϯ\jE&l*k'}'cjτ¹m}TRR/>NQQ
tfOkw;{eV&nߺp?ˇHd ap84
ޘRR"jYB@p:x_ n0p}sIS -^e8oۯv{w#<^/
n2#`6FLPe#MXMWԼ%M˫0כ&ɍ`o; z壿x|u J)lm
1 !9}+)gM
/}+V~ j>O aSv JJJfp!cI<*0Pv0 ՎKbzվB痚a 8΄狋؈}
DTU ]p: ݇\&;Q h8~:zqAڵ EEEsV "1)gԲra0 ى;wbBѣu F|XuJ)WFJJ"ū,//ǶmP__漤: mR)Τa ǶR
8p 0pD"sxRBI;~Ϥ@"| cǎiB4hHqs]FҶLYpy". [nK`W\y|(%l; RBIt 2yLi~?JKK8Q"()T@1i 8 :47ʏIY(If㷇y9&Pv
4
̥ (]$gPJBYP$_Hg
HY%\bIR$ RFW fDJ!'tLRigCHnR y 4/h!$mRJͧ KeYFDp m;űI*D9<_d` )vb(96!@>קR
ql[XӭI"pmXEg2su DHZ]ס뚈D"w'@8 tF ,ر$ǰmQ pf8|)NJ)~܌X 1ĩ\1"iB XltqsO.]`0ڳnO" D
c-e.o6PP
@T_OƏ
Memcheck:Leak
match-leak-kinds: definite
fun:malloc
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
fun:FcPatternDuplicate
obj:/usr/lib/x86_64-linux-gnu/libcairo.so.2.11600.0
obj:/usr/lib/x86_64-linux-gnu/libcairo.so.2.11600.0
fun:cairo_toy_font_face_create
fun:cairo_select_font_face
fun:_wlmaker_clip_update_overlay
fun:wlmaker_clip_create
fun:main
}
{
Memcheck:Leak
match-leak-kinds: definite
fun:malloc
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libexpat.so.1.8.10
obj:/usr/lib/x86_64-linux-gnu/libexpat.so.1.8.10
obj:/usr/lib/x86_64-linux-gnu/libexpat.so.1.8.10
fun:XML_ParseBuffer
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
obj:/usr/lib/x86_64-linux-gnu/libfontconfig.so.1.12.0
}
wlmaker-0.3/libdrm.supp 0000664 0000000 0000000 00000000107 14641446446 0015213 0 ustar 00root root 0000000 0000000 {
Memcheck:Leak
...
obj:/usr/lib/*/dri/*
...
}
wlmaker-0.3/protocols/ 0000775 0000000 0000000 00000000000 14641446446 0015057 5 ustar 00root root 0000000 0000000 wlmaker-0.3/protocols/CMakeLists.txt 0000664 0000000 0000000 00000002342 14641446446 0017620 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
INCLUDE(WaylandProtocol)
SET(SOURCES)
WaylandProtocol_ADD(
SOURCES
BASE_NAME wlmaker-icon-unstable-v1
PROTOCOL_FILE wlmaker-icon-unstable-v1.xml
SIDE server)
PKG_GET_VARIABLE(WAYLAND_PROTOCOLDIR wayland-protocols pkgdatadir)
# Needing XDG Shell, since the toplevel icon protocol refers to it.
WaylandProtocol_ADD(
SOURCES
BASE_NAME xdg-shell
PROTOCOL_FILE "${WAYLAND_PROTOCOLDIR}/stable/xdg-shell/xdg-shell.xml"
SIDE server)
ADD_LIBRARY(wlmaker_protocols STATIC)
TARGET_SOURCES(
wlmaker_protocols PRIVATE
${SOURCES})
TARGET_COMPILE_OPTIONS(
wlmaker_protocols PRIVATE
${WAYLAND_CFLAGS}
${WAYLAND_CFLAGS_OTHER})
wlmaker-0.3/protocols/wlmaker-icon-unstable-v1.xml 0000664 0000000 0000000 00000006367 14641446446 0022344 0 ustar 00root root 0000000 0000000
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.
This interface permits clients to register an icon surface for a
toplevel. Compositors can use this to present the toplevel in
iconified state.
Destroys the Toplevel Icon Manager.
Creates a new icon object associated with the given XDG toplevel.
This interface permits clients to configure a surface representing
the toplevel in iconified state.
Destroys the Toplevel Icon.
Acknowledges configuration sequence.
Suggests size for the icon surface.
After creating the toplevel icon, the client is required to commit a
surface with a NULL buffer. This will trigger the `configure` event,
informing the client of the recommended icon size.
The client may chose a different icon size. The compositor may chose
to scale icons of non-recommended size as desired.
Once received, the client must send an `ack_configure` with the serial.
Once done, the client may proceed committring surfaces with attached
buffers.
wlmaker-0.3/share/ 0000775 0000000 0000000 00000000000 14641446446 0014135 5 ustar 00root root 0000000 0000000 wlmaker-0.3/share/CMakeLists.txt 0000664 0000000 0000000 00000002147 14641446446 0016701 0 ustar 00root root 0000000 0000000 # Copyright 2024 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
CONFIGURE_FILE(
${CMAKE_CURRENT_SOURCE_DIR}/wrap-wlmaker.sh.in
${CMAKE_CURRENT_BINARY_DIR}/wrap-wlmaker.sh
@ONLY)
INSTALL(
FILES ${CMAKE_CURRENT_BINARY_DIR}/wrap-wlmaker.sh
TYPE BIN
PERMISSIONS OWNER_WRITE OWNER_READ OWNER_EXECUTE
GROUP_READ GROUP_EXECUTE
WORLD_READ WORLD_EXECUTE)
CONFIGURE_FILE(
${CMAKE_CURRENT_SOURCE_DIR}/wlmaker.desktop.in
${CMAKE_CURRENT_BINARY_DIR}/wlmaker.desktop
@ONLY)
INSTALL(
FILES ${CMAKE_CURRENT_BINARY_DIR}/wlmaker.desktop
TYPE DATA)
wlmaker-0.3/share/wlmaker.desktop.in 0000664 0000000 0000000 00000000231 14641446446 0017573 0 ustar 00root root 0000000 0000000 [Desktop Entry]
Name=WaylandMaker
Comment=A Wayland compositor inspired by Window Maker
Exec=@CMAKE_INSTALL_PREFIX@/bin/wrap-wlmaker.sh
Type=Application
wlmaker-0.3/share/wrap-wlmaker.sh.in 0000664 0000000 0000000 00000001665 14641446446 0017517 0 ustar 00root root 0000000 0000000 #! /bin/sh
#
# 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.
#
# Sets environment to run wlmaker with locally-installed dependencies, and
# executes the binary.
LD_LIBRARY_PATH="@CMAKE_INSTALL_PREFIX@/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
PKG_CONFIG_PATH="@CMAKE_INSTALL_PREFIX@/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:@CMAKE_INSTALL_PREFIX@/share/pkgconfig/" \
@CMAKE_INSTALL_PREFIX@/bin/wlmaker
wlmaker-0.3/src/ 0000775 0000000 0000000 00000000000 14641446446 0013622 5 ustar 00root root 0000000 0000000 wlmaker-0.3/src/CMakeLists.txt 0000664 0000000 0000000 00000006566 14641446446 0016377 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
INCLUDE(EmbedBinary)
SET(PUBLIC_HEADER_FILES
action.h
background.h
clip.h
config.h
cursor.h
dock.h
icon_manager.h
idle.h
keyboard.h
layer_panel.h
layer_shell.h
launcher.h
lock_mgr.h
output.h
server.h
subprocess_monitor.h
task_list.h
xdg_decoration.h
xdg_popup.h
xdg_shell.h
xdg_toplevel.h
xwl.h
xwl_content.h
xwl_popup.h
xwl_toplevel.h)
ADD_LIBRARY(wlmaker_lib STATIC)
TARGET_SOURCES(wlmaker_lib PRIVATE
action.c
background.c
clip.c
config.c
cursor.c
dock.c
icon_manager.c
idle.c
keyboard.c
launcher.c
layer_panel.c
layer_shell.c
lock_mgr.c
output.c
server.c
subprocess_monitor.c
task_list.c
xdg_decoration.c
xdg_popup.c
xdg_shell.c
xdg_toplevel.c
x11_cursor.xpm
xwl.c
xwl_content.c
xwl_popup.c
xwl_toplevel.c
)
SET_TARGET_PROPERTIES(
wlmaker_lib PROPERTIES
VERSION 1.0
PUBLIC_HEADER "${PUBLIC_HEADER_FILES}")
EmbedBinary_ADD_LIBRARY(
embedded_configuration
"default_configuration"
"${PROJECT_SOURCE_DIR}/etc/wlmaker.plist")
EmbedBinary_ADD_LIBRARY(
embedded_state
"default_state"
"${PROJECT_SOURCE_DIR}/etc/wlmaker-state.plist")
EmbedBinary_ADD_LIBRARY(
embedded_style
"style_default"
"${PROJECT_SOURCE_DIR}/etc/style-default.plist")
ADD_DEPENDENCIES(
wlmaker_lib
protocol_headers
conf
toolkit
embedded_configuration
embedded_state
embedded_style
wlmaker_lib)
TARGET_LINK_LIBRARIES(
wlmaker_lib
base
conf
toolkit
embedded_configuration
embedded_state
embedded_style
wlmaker_protocols
PkgConfig::CAIRO
PkgConfig::WAYLAND
PkgConfig::WLROOTS
PkgConfig::XCB
PkgConfig::XKBCOMMON)
TARGET_INCLUDE_DIRECTORIES(
wlmaker_lib PUBLIC
${PROJECT_BINARY_DIR}/third_party/protocols
${PROJECT_BINARY_DIR}/protocols
${CAIRO_INCLUDE_DIRS}
${WAYLAND_INCLUDE_DIRS}
${WLROOTS_INCLUDE_DIRS}
${XCB_INCLUDE_DIRS}
${XKBCOMMON_INCLUDE_DIRS}
)
TARGET_COMPILE_DEFINITIONS(
wlmaker_lib PRIVATE
WLMAKER_ICON_DATA_DIR="${CMAKE_INSTALL_FULL_DATAROOTDIR}/icons/wlmaker")
TARGET_COMPILE_DEFINITIONS(
wlmaker_lib PRIVATE WLMAKER_SOURCE_DIR="${PROJECT_SOURCE_DIR}")
IF(XWAYLAND_FOUND)
TARGET_COMPILE_DEFINITIONS(wlmaker_lib PUBLIC WLMAKER_HAVE_XWAYLAND)
ENDIF(XWAYLAND_FOUND)
ADD_EXECUTABLE(wlmaker wlmaker.c)
ADD_DEPENDENCIES(wlmaker wlmaker_lib)
IF(XWAYLAND_FOUND)
ENDIF(XWAYLAND_FOUND)
TARGET_COMPILE_OPTIONS(
wlmaker PRIVATE
${WAYLAND_CFLAGS}
${WAYLAND_CFLAGS_OTHER})
TARGET_LINK_LIBRARIES(wlmaker PRIVATE base conf wlmaker_lib)
ADD_EXECUTABLE(wlmaker_test wlmaker_test.c)
ADD_DEPENDENCIES(wlmaker_test wlmaker_lib)
TARGET_LINK_LIBRARIES(wlmaker_test PRIVATE wlmaker_lib)
TARGET_COMPILE_DEFINITIONS(
wlmaker_test PUBLIC TEST_DATA_DIR="${PROJECT_SOURCE_DIR}/testdata")
ADD_TEST(NAME wlmaker_test COMMAND wlmaker_test)
INSTALL(TARGETS wlmaker DESTINATION bin)
wlmaker-0.3/src/action.c 0000664 0000000 0000000 00000035336 14641446446 0015255 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file action.c
*
* @copyright
* Copyright 2024 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.
*/
#include "action.h"
#include "default_configuration.h"
#include "server.h"
#include "conf/decode.h"
#include "conf/plist.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the bound actions. */
struct _wlmaker_action_handle_t {
/** Bindings, linked by @ref _wlmaker_action_binding_t::qnode. */
bs_dequeue_t bindings;
/** Back-link to server state. */
wlmaker_server_t *server_ptr;
};
/** Key binding for a standard action. */
typedef struct {
/** Node of @ref wlmaker_action_handle_t::bindings. */
bs_dequeue_node_t qnode;
/** The key binding. */
wlmaker_key_combo_t key_combo;
/** The associated action. */
wlmaker_action_t action;
/** The key binding it to this node. */
wlmaker_key_binding_t *key_binding_ptr;
/** State of the bound actions. */
wlmaker_action_handle_t *handle_ptr;
} _wlmaker_action_binding_t;
static bool _wlmaker_keybindings_parse(
const char *string_ptr,
uint32_t *modifiers_ptr,
xkb_keysym_t *keysym_ptr);
static bool _wlmaker_keybindings_bind_item(
const char *key_ptr,
wlmcfg_object_t *object_ptr,
void *userdata_ptr);
static bool _wlmaker_action_bound_callback(
const wlmaker_key_combo_t *binding_ptr);
/* == Data ================================================================= */
/** Key to lookup the dict from the config dictionary. */
const char *wlmaker_action_config_dict_key = "KeyBindings";
/** Supported modifiers for key bindings. */
static const wlmcfg_enum_desc_t _wlmaker_keybindings_modifiers[] = {
WLMCFG_ENUM("Shift", WLR_MODIFIER_SHIFT),
// Caps? Maybe not: WLMCFG_ENUM("Caps", WLR_MODIFIER_CAPS),
WLMCFG_ENUM("Ctrl", WLR_MODIFIER_CTRL),
WLMCFG_ENUM("Alt", WLR_MODIFIER_ALT),
WLMCFG_ENUM("Mod2", WLR_MODIFIER_MOD2),
WLMCFG_ENUM("Mod3", WLR_MODIFIER_MOD3),
WLMCFG_ENUM("Logo", WLR_MODIFIER_LOGO),
WLMCFG_ENUM("Mod5", WLR_MODIFIER_MOD5),
WLMCFG_ENUM_SENTINEL(),
};
/** The actions that can be bound. */
static const wlmcfg_enum_desc_t wlmaker_action_desc[] = {
WLMCFG_ENUM("Quit", WLMAKER_ACTION_QUIT),
WLMCFG_ENUM("LockScreen", WLMAKER_ACTION_LOCK_SCREEN),
WLMCFG_ENUM("LaunchTerminal", WLMAKER_ACTION_LAUNCH_TERMINAL),
WLMCFG_ENUM("WorkspacePrevious", WLMAKER_ACTION_WORKSPACE_TO_PREVIOUS),
WLMCFG_ENUM("WorkspaceNext", WLMAKER_ACTION_WORKSPACE_TO_NEXT),
WLMCFG_ENUM("TaskPrevious", WLMAKER_ACTION_TASK_TO_PREVIOUS),
WLMCFG_ENUM("TaskNext", WLMAKER_ACTION_TASK_TO_NEXT),
WLMCFG_ENUM("WindowRaise", WLMAKER_ACTION_WINDOW_RAISE),
WLMCFG_ENUM("WindowLower", WLMAKER_ACTION_WINDOW_LOWER),
WLMCFG_ENUM("WindowFullscreen", WLMAKER_ACTION_WINDOW_TOGGLE_FULLSCREEN),
WLMCFG_ENUM("WindowMaximize", WLMAKER_ACTION_WINDOW_TOGGLE_MAXIMIZED),
WLMCFG_ENUM_SENTINEL(),
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_action_handle_t *wlmaker_action_bind_keys(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *keybindings_dict_ptr)
{
wlmaker_action_handle_t *handle_ptr = logged_calloc(
1, sizeof(wlmaker_action_handle_t));
if (NULL == handle_ptr) return NULL;
handle_ptr->server_ptr = server_ptr;
if (wlmcfg_dict_foreach(
keybindings_dict_ptr,
_wlmaker_keybindings_bind_item,
handle_ptr)) {
return handle_ptr;
}
wlmaker_action_unbind_keys(handle_ptr);
return NULL;
}
/* ------------------------------------------------------------------------- */
void wlmaker_action_unbind_keys(wlmaker_action_handle_t *handle_ptr)
{
bs_dequeue_node_t *qnode_ptr = handle_ptr->bindings.head_ptr;
while (NULL != qnode_ptr) {
_wlmaker_action_binding_t *binding_ptr = BS_CONTAINER_OF(
qnode_ptr, _wlmaker_action_binding_t, qnode);
qnode_ptr = qnode_ptr->next_ptr;
wlmaker_server_unbind_key(
handle_ptr->server_ptr,
binding_ptr->key_binding_ptr);
free(binding_ptr);
}
free(handle_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_action_execute(wlmaker_server_t *server_ptr,
wlmaker_action_t action)
{
wlmtk_workspace_t *wlmtk_workspace_ptr;
wlmtk_window_t *window_ptr;
switch (action) {
case WLMAKER_ACTION_QUIT:
wl_display_terminate(server_ptr->wl_display_ptr);
break;
case WLMAKER_ACTION_LOCK_SCREEN:
if (NULL != server_ptr->idle_monitor_ptr) {
wlmaker_idle_monitor_lock(server_ptr->idle_monitor_ptr);
}
break;
case WLMAKER_ACTION_LAUNCH_TERMINAL:
if (0 == fork()) {
execl("/bin/sh", "/bin/sh", "-c", "/usr/bin/foot", (void *)NULL);
}
break;
case WLMAKER_ACTION_WORKSPACE_TO_PREVIOUS:
wlmtk_root_switch_to_previous_workspace(server_ptr->root_ptr);
break;
case WLMAKER_ACTION_WORKSPACE_TO_NEXT:
wlmtk_root_switch_to_next_workspace(server_ptr->root_ptr);
break;
case WLMAKER_ACTION_TASK_TO_PREVIOUS:
wlmtk_workspace_activate_previous_window(
wlmtk_root_get_current_workspace(server_ptr->root_ptr));
wlmaker_server_activate_task_list(server_ptr);
break;
case WLMAKER_ACTION_TASK_TO_NEXT:
wlmtk_workspace_activate_next_window(
wlmtk_root_get_current_workspace(server_ptr->root_ptr));
wlmaker_server_activate_task_list(server_ptr);
break;
case WLMAKER_ACTION_WINDOW_RAISE:
// TODO(kaeser@gubbe.ch): (re)implement using toolkit.
bs_log(BS_WARNING, "Raise window: Unimplemented.");
break;
case WLMAKER_ACTION_WINDOW_LOWER:
// TODO(kaeser@gubbe.ch): (re)implement using toolkit.
bs_log(BS_WARNING, "Lower window: Unimplemented.");
break;
case WLMAKER_ACTION_WINDOW_TOGGLE_FULLSCREEN:
wlmtk_workspace_ptr = wlmtk_root_get_current_workspace(
server_ptr->root_ptr);
window_ptr = wlmtk_workspace_get_activated_window(wlmtk_workspace_ptr);
if (NULL != window_ptr) {
wlmtk_window_request_fullscreen(
window_ptr, !wlmtk_window_is_fullscreen(window_ptr));
}
break;
case WLMAKER_ACTION_WINDOW_TOGGLE_MAXIMIZED:
wlmtk_workspace_ptr = wlmtk_root_get_current_workspace(
server_ptr->root_ptr);
window_ptr = wlmtk_workspace_get_activated_window(wlmtk_workspace_ptr);
if (NULL != window_ptr) {
wlmtk_window_request_maximized(
window_ptr, !wlmtk_window_is_maximized(window_ptr));
}
break;
default:
bs_log(BS_WARNING, "Unhandled action %d.", action);
break;
}
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Binds an action for one item of the 'KeyBindings' dict.
*
* @param key_ptr Name of the action to bind the key to.
* @param object_ptr Configuration object, must be a string and
* contain a parse-able modifier + keysym.
* @param userdata_ptr Points to @ref wlmaker_server_t.
*
* @return true on success.
*/
bool _wlmaker_keybindings_bind_item(
const char *key_ptr,
wlmcfg_object_t *object_ptr,
void *userdata_ptr)
{
wlmaker_action_handle_t *handle_ptr = userdata_ptr;
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(object_ptr);
if (NULL == string_ptr) {
bs_log(BS_WARNING, "Action must be a string for key binding \"%s\"",
key_ptr);
return false;
}
uint32_t modifiers;
xkb_keysym_t keysym;
if (!_wlmaker_keybindings_parse(key_ptr, &modifiers, &keysym)) {
bs_log(BS_WARNING,
"Failed to parse binding '%s' for keybinding action '%s'",
key_ptr, wlmcfg_string_value(string_ptr));
return false;
}
int action;
if (!wlmcfg_enum_name_to_value(
wlmaker_action_desc, wlmcfg_string_value(string_ptr), &action)) {
bs_log(BS_WARNING, "Not a valid keybinding action: '%s'",
wlmcfg_string_value(string_ptr));
return false;
}
_wlmaker_action_binding_t *action_binding_ptr = logged_calloc(
1, sizeof(_wlmaker_action_binding_t));
if (NULL == action_binding_ptr) return false;
action_binding_ptr->handle_ptr = handle_ptr;
action_binding_ptr->action = action;
action_binding_ptr->key_combo.keysym = keysym;
action_binding_ptr->key_combo.ignore_case = true;
action_binding_ptr->key_combo.modifiers = modifiers;
action_binding_ptr->key_combo.modifiers_mask =
wlmaker_modifier_default_mask;
action_binding_ptr->key_binding_ptr = wlmaker_server_bind_key(
handle_ptr->server_ptr,
&action_binding_ptr->key_combo,
_wlmaker_action_bound_callback);
if (NULL != action_binding_ptr->key_binding_ptr) {
bs_dequeue_push_back(
&handle_ptr->bindings, &action_binding_ptr->qnode);
return true;
}
free(action_binding_ptr);
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Parses a keybinding string: Tokenizes into modifiers and keysym.
*
* @param string_ptr
* @param modifiers_ptr
* @param keysym_ptr
*
* @return true on success.
*/
bool _wlmaker_keybindings_parse(
const char *string_ptr,
uint32_t *modifiers_ptr,
xkb_keysym_t *keysym_ptr)
{
*keysym_ptr = XKB_KEY_NoSymbol;
*modifiers_ptr = 0;
bool rv = true;
// Tokenize along '+', then lookup each of the keys.
for (const char *start_ptr = string_ptr; *start_ptr != '\0'; ++start_ptr) {
const char *end_ptr = start_ptr;
while (*end_ptr != '\0' && *end_ptr != '+') ++end_ptr;
size_t len = end_ptr - start_ptr;
char *token_ptr = malloc(len + 1);
memcpy(token_ptr, start_ptr, len);
token_ptr[len] = '\0';
start_ptr = end_ptr;
int new_modifier;
if (wlmcfg_enum_name_to_value(
_wlmaker_keybindings_modifiers, token_ptr, &new_modifier)) {
*modifiers_ptr |= new_modifier;
} else if (*keysym_ptr == XKB_KEY_NoSymbol) {
*keysym_ptr = xkb_keysym_to_upper(
xkb_keysym_from_name(token_ptr, XKB_KEYSYM_CASE_INSENSITIVE));
} else {
rv = false;
}
free(token_ptr);
if (!*start_ptr) break;
}
return rv && (XKB_KEY_NoSymbol != *keysym_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for when the bound key is triggered: Executes the corresponding
* action.
*
* @param key_combo_ptr
*
* @return true always.
*/
bool _wlmaker_action_bound_callback(const wlmaker_key_combo_t *key_combo_ptr)
{
_wlmaker_action_binding_t *action_binding_ptr = BS_CONTAINER_OF(
key_combo_ptr, _wlmaker_action_binding_t, key_combo);
wlmaker_action_execute(
action_binding_ptr->handle_ptr->server_ptr,
action_binding_ptr->action);
return true;
}
/* == Unit tests =========================================================== */
static void test_keybindings_parse(bs_test_t *test_ptr);
static void test_default_keybindings(bs_test_t *test_ptr);
/** Test cases for key bindings. */
const bs_test_case_t wlmaker_action_test_cases[] = {
{ 1, "parse", test_keybindings_parse },
{ 1, "default_keybindings", test_default_keybindings },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests @ref _wlmaker_keybindings_parse. */
void test_keybindings_parse(bs_test_t *test_ptr)
{
uint32_t m;
xkb_keysym_t ks;
// Lower- and upper case.
BS_TEST_VERIFY_TRUE(test_ptr, _wlmaker_keybindings_parse("A", &m, &ks));
BS_TEST_VERIFY_EQ(test_ptr, 0, m);
BS_TEST_VERIFY_EQ(test_ptr, XKB_KEY_A, ks);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmaker_keybindings_parse("a", &m, &ks));
BS_TEST_VERIFY_EQ(test_ptr, 0, m);
BS_TEST_VERIFY_EQ(test_ptr, XKB_KEY_A, ks);
// Modifier.
BS_TEST_VERIFY_TRUE(
test_ptr, _wlmaker_keybindings_parse("Ctrl+Logo+Q", &m, &ks));
BS_TEST_VERIFY_EQ(test_ptr, WLR_MODIFIER_CTRL | WLR_MODIFIER_LOGO, m);
BS_TEST_VERIFY_EQ(test_ptr, XKB_KEY_Q, ks);
// Test some fancier keys.
BS_TEST_VERIFY_TRUE(
test_ptr, _wlmaker_keybindings_parse("Escape", &m, &ks));
BS_TEST_VERIFY_EQ(test_ptr, XKB_KEY_Escape, ks);
BS_TEST_VERIFY_TRUE(
test_ptr, _wlmaker_keybindings_parse("XF86AudioLowerVolume", &m, &ks));
BS_TEST_VERIFY_EQ(test_ptr, XKB_KEY_XF86AudioLowerVolume, ks);
// Not peritted: Empty, just modifiers, more than one keysym.
BS_TEST_VERIFY_FALSE(
test_ptr, _wlmaker_keybindings_parse("", &m, &ks));
BS_TEST_VERIFY_FALSE(
test_ptr, _wlmaker_keybindings_parse("A+B", &m, &ks));
BS_TEST_VERIFY_FALSE(
test_ptr, _wlmaker_keybindings_parse("Shift+Ctrl", &m, &ks));
}
/* ------------------------------------------------------------------------- */
/** Tests the default configuration's 'KeyBindings' section. */
void test_default_keybindings(bs_test_t *test_ptr)
{
wlmaker_server_t server = {};
wlmcfg_object_t *obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_default_configuration_data,
embedded_binary_default_configuration_size);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlmcfg_dict_from_object(obj_ptr));
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_get_dict(
wlmcfg_dict_from_object(obj_ptr), wlmaker_action_config_dict_key);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
wlmaker_action_handle_t *handle_ptr = wlmaker_action_bind_keys(
&server, dict_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, handle_ptr);
wlmcfg_object_unref(obj_ptr);
wlmaker_action_unbind_keys(handle_ptr);
}
/* == End of action.c ====================================================== */
wlmaker-0.3/src/action.h 0000664 0000000 0000000 00000004607 14641446446 0015257 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file action.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMAKER_ACTION_H__
#define __WLMAKER_ACTION_H__
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** wlmaker actions. Can be bound to keys. Also @see wlmaker_action_desc. */
typedef enum {
WLMAKER_ACTION_QUIT,
WLMAKER_ACTION_LOCK_SCREEN,
WLMAKER_ACTION_LAUNCH_TERMINAL,
WLMAKER_ACTION_WORKSPACE_TO_PREVIOUS,
WLMAKER_ACTION_WORKSPACE_TO_NEXT,
WLMAKER_ACTION_TASK_TO_PREVIOUS,
WLMAKER_ACTION_TASK_TO_NEXT,
WLMAKER_ACTION_WINDOW_RAISE,
WLMAKER_ACTION_WINDOW_LOWER,
WLMAKER_ACTION_WINDOW_TOGGLE_FULLSCREEN,
WLMAKER_ACTION_WINDOW_TOGGLE_MAXIMIZED,
} wlmaker_action_t;
extern const char *wlmaker_action_config_dict_key;
/** Forward declaration: Handle for bound actions. */
typedef struct _wlmaker_action_handle_t wlmaker_action_handle_t;
/**
* Binds the actions specified in the config dictionary.
*
* @param server_ptr
* @param keybindings_dict_ptr
*
* @return A bound action handle, or NULL on error.
*/
wlmaker_action_handle_t *wlmaker_action_bind_keys(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *keybindings_dict_ptr);
/**
* Unbinds actions previously bound by @ref wlmaker_action_bind_keys.
*
* @param handle_ptr
*/
void wlmaker_action_unbind_keys(wlmaker_action_handle_t *handle_ptr);
/**
* Executes the given action on wlmaker.
*
* @param server_ptr
* @param action
*/
void wlmaker_action_execute(
wlmaker_server_t *server_ptr,
wlmaker_action_t action);
/** Unit test cases. */
extern const bs_test_case_t wlmaker_action_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __ACTION_H__ */
/* == End of action.h ====================================================== */
wlmaker-0.3/src/background.c 0000664 0000000 0000000 00000012570 14641446446 0016112 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file background.c
*
* @copyright
* Copyright 2024 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.
*/
#include "background.h"
#include
/* == Declarations ========================================================= */
/** Background state. */
struct _wlmaker_background_t {
/** The background is a panel. */
wlmtk_panel_t super_panel;
/** Initial implementation: The background is a uni-color rectangle. */
wlmtk_rectangle_t *rectangle_ptr;
};
static void _wlmaker_background_element_destroy(
wlmtk_element_t *element_ptr);
static uint32_t _wlmaker_background_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height);
/* == Data ================================================================= */
/** The background panel's element superclass virtual method. */
static const wlmtk_element_vmt_t _wlmaker_background_element_vmt = {
.destroy = _wlmaker_background_element_destroy,
};
/** The background panels' virtual method table. */
static const wlmtk_panel_vmt_t _wlmaker_background_panel_vmt = {
.request_size = _wlmaker_background_request_size
};
/** Panel's position: Anchored to all 4 edges, and auto-sized. */
static const wlmtk_panel_positioning_t _wlmaker_background_panel_position = {
.desired_width = 0,
.desired_height = 0,
.anchor = WLR_EDGE_LEFT | WLR_EDGE_TOP | WLR_EDGE_RIGHT | WLR_EDGE_BOTTOM,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_background_t *wlmaker_background_create(
uint32_t color,
wlmtk_env_t *env_ptr)
{
wlmaker_background_t *background_ptr = logged_calloc(
1, sizeof(wlmaker_background_t));
if (NULL == background_ptr) return NULL;
if (!wlmtk_panel_init(&background_ptr->super_panel,
&_wlmaker_background_panel_position,
env_ptr)) {
wlmaker_background_destroy(background_ptr);
return NULL;
}
wlmtk_element_extend(
&background_ptr->super_panel.super_container.super_element,
&_wlmaker_background_element_vmt);
wlmtk_panel_extend(&background_ptr->super_panel,
&_wlmaker_background_panel_vmt);
background_ptr->rectangle_ptr = wlmtk_rectangle_create(
env_ptr, 0, 0, color);
if (NULL == background_ptr->rectangle_ptr) {
wlmaker_background_destroy(background_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_rectangle_element(background_ptr->rectangle_ptr),
true);
wlmtk_container_add_element(
&background_ptr->super_panel.super_container,
wlmtk_rectangle_element(background_ptr->rectangle_ptr));
wlmtk_element_set_visible(
wlmtk_panel_element(&background_ptr->super_panel),
true);
return background_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_background_destroy(wlmaker_background_t *background_ptr)
{
if (NULL != background_ptr->rectangle_ptr) {
wlmtk_container_remove_element(
&background_ptr->super_panel.super_container,
wlmtk_rectangle_element(background_ptr->rectangle_ptr));
wlmtk_rectangle_destroy(background_ptr->rectangle_ptr);
background_ptr->rectangle_ptr = NULL;
}
wlmtk_panel_fini(&background_ptr->super_panel);
free(background_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_panel_t *wlmaker_background_panel(wlmaker_background_t *background_ptr)
{
return &background_ptr->super_panel;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Implements @ref wlmtk_element_vmt_t::destroy. Dtor for the background. */
void _wlmaker_background_element_destroy(
wlmtk_element_t *element_ptr)
{
wlmaker_background_t *background_ptr = BS_CONTAINER_OF(
element_ptr,
wlmaker_background_t,
super_panel.super_container.super_element);
wlmaker_background_destroy(background_ptr);
}
/* ------------------------------------------------------------------------- */
/** Implements @ref wlmtk_panel_vmt_t::request_size. Updates the panel size. */
uint32_t _wlmaker_background_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height)
{
wlmaker_background_t *background_ptr = BS_CONTAINER_OF(
panel_ptr, wlmaker_background_t, super_panel);
wlmtk_rectangle_set_size(background_ptr->rectangle_ptr, width, height);
wlmtk_panel_commit(
&background_ptr->super_panel, 0, &_wlmaker_background_panel_position);
return 0;
}
/* == End of background.c ================================================== */
wlmaker-0.3/src/background.h 0000664 0000000 0000000 00000003207 14641446446 0016114 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file background.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __BACKGROUND_H__
#define __BACKGROUND_H__
#include "toolkit/toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Background state. */
typedef struct _wlmaker_background_t wlmaker_background_t;
/**
* Creates a background, derived from a @ref wlmtk_panel_t.
*
* @param color
* @param env_ptr
*
* @return A handle for the background, or NULL on error.
*/
wlmaker_background_t *wlmaker_background_create(
uint32_t color,
wlmtk_env_t *env_ptr);
/**
* Destroys the background.
*
* @param background_ptr
*/
void wlmaker_background_destroy(wlmaker_background_t *background_ptr);
/** Returns a pointer to @ref wlmaker_background_t::super_panel. */
wlmtk_panel_t *wlmaker_background_panel(wlmaker_background_t *background_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __BACKGROUND_H__ */
/* == End of background.h ================================================== */
wlmaker-0.3/src/clip.c 0000664 0000000 0000000 00000067323 14641446446 0014730 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file clip.c
*
* @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.
*/
#include "clip.h"
#include
#include "toolkit/toolkit.h"
/* == Declarations ========================================================= */
/** Clip handle. */
struct _wlmaker_clip_t {
/** The clip happens to be derived from a tile. */
wlmtk_tile_t super_tile;
/** Original virtual method table fo the superclass' element. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Backlink to the server. */
wlmaker_server_t *server_ptr;
/** The toolkit dock, holding the clip tile. */
wlmtk_dock_t *wlmtk_dock_ptr;
/** The tile's texture buffer without any buttons pressed */
struct wlr_buffer *tile_buffer_ptr;
/** The tile's texture buffer with the 'Next' buttons pressed. */
struct wlr_buffer *next_pressed_tile_buffer_ptr;
/** The tile's texture buffer with the 'Previous' buttons pressed. */
struct wlr_buffer *prev_pressed_tile_buffer_ptr;
/** Overlay buffer element: Contains the workspace's title and number. */
wlmtk_buffer_t overlay_buffer;
/** Clip image. */
wlmtk_image_t *image_ptr;
/** Whether the pointer is currently inside the 'prev' button. */
bool pointer_inside_prev_button;
/** Whether the pointer is currently inside the 'next' button. */
bool pointer_inside_next_button;
/** Whether the 'prev' button had been pressed. */
bool prev_button_pressed;
/** Whether the 'next' button had been pressed. */
bool next_button_pressed;
/** Listener for @ref wlmtk_root_events_t::workspace_changed. */
struct wl_listener workspace_changed_listener;
/** The clip's style. */
wlmaker_config_clip_style_t style;
};
static bool _wlmaker_clip_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static bool _wlmaker_clip_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static bool _wlmaker_clip_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
static void _wlmaker_clip_pointer_leave(
wlmtk_element_t *element_ptr);
static void _wlmaker_clip_update_buttons(wlmaker_clip_t *clip_ptr);
static void _wlmaker_clip_update_overlay(wlmaker_clip_t *clip_ptr);
static struct wlr_buffer *_wlmaker_clip_create_tile(
const wlmtk_tile_style_t *style_ptr,
bool prev_pressed,
bool next_pressed);
static void _wlmaker_clip_handle_workspace_changed(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** The clip's extension to @ref wlmtk_element_t virtual method table. */
static const wlmtk_element_vmt_t _wlmaker_clip_element_vmt = {
.pointer_axis = _wlmaker_clip_pointer_axis,
.pointer_button = _wlmaker_clip_pointer_button,
.pointer_motion = _wlmaker_clip_pointer_motion,
.pointer_leave = _wlmaker_clip_pointer_leave,
};
/** TODO: Replace this. */
typedef struct {
/** Positioning data. */
wlmtk_dock_positioning_t positioning;
} parse_args;
/** Enum descriptor for `enum wlr_edges`. */
static const wlmcfg_enum_desc_t _wlmaker_clip_edges[] = {
WLMCFG_ENUM("TOP", WLR_EDGE_TOP),
WLMCFG_ENUM("BOTTOM", WLR_EDGE_BOTTOM),
WLMCFG_ENUM("LEFT", WLR_EDGE_LEFT),
WLMCFG_ENUM("RIGHT", WLR_EDGE_RIGHT),
WLMCFG_ENUM_SENTINEL(),
};
/** Descriptor for the clip's plist. */
const wlmcfg_desc_t _wlmaker_clip_desc[] = {
WLMCFG_DESC_ENUM("Edge", true, parse_args, positioning.edge,
WLR_EDGE_NONE, _wlmaker_clip_edges),
WLMCFG_DESC_ENUM("Anchor", true, parse_args, positioning.anchor,
WLR_EDGE_NONE, _wlmaker_clip_edges),
WLMCFG_DESC_SENTINEL(),
};
/** Lookup paths for icons -- FIXME: de-duplicate this! */
static const char *lookup_paths[] = {
"/usr/share/icons/wlmaker",
"/usr/local/share/icons/wlmaker",
#if defined(WLMAKER_SOURCE_DIR)
WLMAKER_SOURCE_DIR "/icons",
#endif // WLMAKER_SOURCE_DIR
#if defined(WLMAKER_ICON_DATA_DIR)
WLMAKER_ICON_DATA_DIR,
#endif // WLMAKER_ICON_DATA_DIR
NULL
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_clip_t *wlmaker_clip_create(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *state_dict_ptr,
const wlmaker_config_style_t *style_ptr)
{
wlmaker_clip_t *clip_ptr = logged_calloc(1, sizeof(wlmaker_clip_t));
if (NULL == clip_ptr) return NULL;
clip_ptr->server_ptr = server_ptr;
clip_ptr->style = style_ptr->clip;
clip_ptr->tile_buffer_ptr = _wlmaker_clip_create_tile(
&style_ptr->tile, false, false);
clip_ptr->prev_pressed_tile_buffer_ptr = _wlmaker_clip_create_tile(
&style_ptr->tile, true, false);
clip_ptr->next_pressed_tile_buffer_ptr = _wlmaker_clip_create_tile(
&style_ptr->tile, false, true);
if (NULL == clip_ptr->tile_buffer_ptr ||
NULL == clip_ptr->prev_pressed_tile_buffer_ptr ||
NULL == clip_ptr->next_pressed_tile_buffer_ptr) {
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
parse_args args = {};
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_get_dict(state_dict_ptr, "Clip");
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "No 'Clip' dict found in state.");
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
wlmcfg_decode_dict(dict_ptr, _wlmaker_clip_desc, &args);
clip_ptr->wlmtk_dock_ptr = wlmtk_dock_create(
&args.positioning, &style_ptr->dock, server_ptr->env_ptr);
wlmtk_element_set_visible(
wlmtk_dock_element(clip_ptr->wlmtk_dock_ptr),
true);
if (!wlmtk_tile_init(
&clip_ptr->super_tile,
&style_ptr->tile,
server_ptr->env_ptr)) {
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
clip_ptr->orig_super_element_vmt = wlmtk_element_extend(
wlmtk_tile_element(&clip_ptr->super_tile),
&_wlmaker_clip_element_vmt);
wlmtk_element_set_visible(
wlmtk_tile_element(&clip_ptr->super_tile), true);
wlmtk_tile_set_background_buffer(
&clip_ptr->super_tile, clip_ptr->tile_buffer_ptr);
wlmtk_dock_add_tile(clip_ptr->wlmtk_dock_ptr, &clip_ptr->super_tile);
if (!wlmtk_buffer_init(
&clip_ptr->overlay_buffer, server_ptr->env_ptr)) {
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_buffer_element(&clip_ptr->overlay_buffer), true);
wlmtk_workspace_t *wlmtk_workspace_ptr =
wlmtk_root_get_current_workspace(server_ptr->root_ptr);
wlmtk_layer_t *layer_ptr = wlmtk_workspace_get_layer(
wlmtk_workspace_ptr, WLMTK_WORKSPACE_LAYER_TOP);
wlmtk_layer_add_panel(
layer_ptr,
wlmtk_dock_panel(clip_ptr->wlmtk_dock_ptr));
char full_path[PATH_MAX];
char *path_ptr = bs_file_resolve_and_lookup_from_paths(
"clip-48x48.png", lookup_paths, 0, full_path);
if (NULL == path_ptr) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed bs_file_resolve_and_lookup_from_paths(\"clip-48x48.png\" ...)");
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
clip_ptr->image_ptr = wlmtk_image_create(path_ptr, server_ptr->env_ptr);
if (NULL == clip_ptr->image_ptr) {
wlmaker_clip_destroy(clip_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_image_element(clip_ptr->image_ptr), true);
wlmtk_tile_set_content(
&clip_ptr->super_tile,
wlmtk_image_element(clip_ptr->image_ptr));
_wlmaker_clip_update_overlay(clip_ptr);
wlmtk_tile_set_overlay(
&clip_ptr->super_tile,
wlmtk_buffer_element(&clip_ptr->overlay_buffer));
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->workspace_changed,
&clip_ptr->workspace_changed_listener,
_wlmaker_clip_handle_workspace_changed);
server_ptr->clip_dock_ptr = clip_ptr->wlmtk_dock_ptr;
bs_log(BS_INFO, "Created clip %p", clip_ptr);
return clip_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_clip_destroy(wlmaker_clip_t *clip_ptr)
{
if (NULL != clip_ptr->server_ptr) {
clip_ptr->server_ptr->clip_dock_ptr = NULL;
}
wlmtk_util_disconnect_listener(&clip_ptr->workspace_changed_listener);
if (wlmtk_tile_element(&clip_ptr->super_tile)->parent_container_ptr) {
wlmtk_tile_set_content(&clip_ptr->super_tile, NULL);
wlmtk_tile_set_overlay(&clip_ptr->super_tile, NULL);
wlmtk_dock_remove_tile(
clip_ptr->wlmtk_dock_ptr,
&clip_ptr->super_tile);
}
wlmtk_tile_fini(&clip_ptr->super_tile);
wlmtk_buffer_fini(&clip_ptr->overlay_buffer);
if (NULL != clip_ptr->image_ptr) {
wlmtk_image_destroy(clip_ptr->image_ptr);
clip_ptr->image_ptr = NULL;
}
if (NULL != clip_ptr->wlmtk_dock_ptr) {
wlmtk_layer_remove_panel(
wlmtk_panel_get_layer(wlmtk_dock_panel(clip_ptr->wlmtk_dock_ptr)),
wlmtk_dock_panel(clip_ptr->wlmtk_dock_ptr));
wlmtk_dock_destroy(clip_ptr->wlmtk_dock_ptr);
clip_ptr->wlmtk_dock_ptr = NULL;
}
if (NULL != clip_ptr->tile_buffer_ptr) {
wlr_buffer_drop(clip_ptr->tile_buffer_ptr);
clip_ptr->tile_buffer_ptr = NULL;
}
if (NULL != clip_ptr->prev_pressed_tile_buffer_ptr) {
wlr_buffer_drop(clip_ptr->prev_pressed_tile_buffer_ptr);
clip_ptr->prev_pressed_tile_buffer_ptr = NULL;
}
if (NULL != clip_ptr->next_pressed_tile_buffer_ptr) {
wlr_buffer_drop(clip_ptr->next_pressed_tile_buffer_ptr);
clip_ptr->next_pressed_tile_buffer_ptr = NULL;
}
free(clip_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_axis.
*
* Moves to the next or previous workspace, depending on the axis (scroll-
* wheel) direction.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return true
*/
bool _wlmaker_clip_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmaker_clip_t *clip_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_clip_t,
super_tile.super_container.super_element);
if (0 > wlr_pointer_axis_event_ptr->delta_discrete) {
// Scroll wheel "up" -> next.
wlmtk_root_switch_to_next_workspace(clip_ptr->server_ptr->root_ptr);
} else if (0 < wlr_pointer_axis_event_ptr->delta_discrete) {
// Scroll wheel "down" -> next.
wlmtk_root_switch_to_previous_workspace(clip_ptr->server_ptr->root_ptr);
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_button.
*
* Checks if the button press is on either 'next' or 'prev' button area,
* updates visualization if pressed, and switches workspace if needed.
*
* @param element_ptr
* @param button_event_ptr
*
* @return true.
*/
bool _wlmaker_clip_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmaker_clip_t *clip_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_clip_t,
super_tile.super_container.super_element);
if (BTN_LEFT != button_event_ptr->button) return true;
switch (button_event_ptr->type) {
case WLMTK_BUTTON_DOWN:
// Pointer button tressed. Translate to button press if in area.
if (clip_ptr->pointer_inside_next_button) {
clip_ptr->next_button_pressed = true;
clip_ptr->prev_button_pressed = false;
} else if (clip_ptr->pointer_inside_prev_button) {
clip_ptr->next_button_pressed = false;
clip_ptr->prev_button_pressed = true;
}
break;
case WLMTK_BUTTON_UP:
// Button is released (closed the click). If we're within the area of
// the pressed button: Trigger the action.
if (clip_ptr->pointer_inside_next_button &&
clip_ptr->next_button_pressed) {
clip_ptr->next_button_pressed = false;
wlmtk_root_switch_to_next_workspace(
clip_ptr->server_ptr->root_ptr);
} else if (clip_ptr->pointer_inside_prev_button &&
clip_ptr->prev_button_pressed) {
clip_ptr->prev_button_pressed = false;
wlmtk_root_switch_to_previous_workspace(
clip_ptr->server_ptr->root_ptr);
}
break;
case WLMTK_BUTTON_CLICK:
default:
break;
}
_wlmaker_clip_update_buttons(clip_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_motion.
*
* Tracks whether the pointer is within any of the 'Next' or 'Previous' button
* areas, and triggers an update to the tile's texture.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*
* @return See @ref wlmtk_element_vmt_t::pointer_motion.
*/
bool _wlmaker_clip_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec)
{
wlmaker_clip_t *clip_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_clip_t,
super_tile.super_container.super_element);
clip_ptr->pointer_inside_prev_button = false;
clip_ptr->pointer_inside_next_button = false;
double tile_size = clip_ptr->super_tile.style.size;
double button_size = (22.0 / 64.0) * tile_size;
if (x >= tile_size - button_size && x < tile_size &&
y >= 0 && y < button_size) {
// Next button.
clip_ptr->pointer_inside_next_button = true;
} else if (x >= 0 && x < button_size &&
y >= tile_size - button_size && y < tile_size) {
// Prev button.
clip_ptr->pointer_inside_prev_button = true;
}
_wlmaker_clip_update_buttons(clip_ptr);
return clip_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
}
/* ------------------------------------------------------------------------- */
/** Implements @ref wlmtk_element_vmt_t::pointer_leave. Updates texture. */
void _wlmaker_clip_pointer_leave(
wlmtk_element_t *element_ptr)
{
wlmaker_clip_t *clip_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_clip_t,
super_tile.super_container.super_element);
clip_ptr->pointer_inside_prev_button = false;
clip_ptr->pointer_inside_next_button = false;
_wlmaker_clip_update_buttons(clip_ptr);
clip_ptr->orig_super_element_vmt.pointer_leave(element_ptr);
}
/* ------------------------------------------------------------------------- */
/** Updates the button textures, based on current state what's pressed. */
static void _wlmaker_clip_update_buttons(wlmaker_clip_t *clip_ptr)
{
struct wlr_buffer *wlr_buffer_ptr = clip_ptr->tile_buffer_ptr;
if (clip_ptr->pointer_inside_next_button &&
clip_ptr->next_button_pressed) {
wlr_buffer_ptr = clip_ptr->next_pressed_tile_buffer_ptr;
} else if (clip_ptr->pointer_inside_prev_button &&
clip_ptr->prev_button_pressed) {
wlr_buffer_ptr = clip_ptr->prev_pressed_tile_buffer_ptr;
}
wlmtk_tile_set_background_buffer(&clip_ptr->super_tile, wlr_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
/** Updates the overlay buffer's content with workspace name and index. */
void _wlmaker_clip_update_overlay(wlmaker_clip_t *clip_ptr)
{
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
clip_ptr->super_tile.style.size, clip_ptr->super_tile.style.size);
if (NULL == wlr_buffer_ptr) return;
int index = 0;
const char *name_ptr = NULL;
wlmtk_workspace_get_details(
wlmtk_root_get_current_workspace(clip_ptr->server_ptr->root_ptr),
&name_ptr, &index);
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return;
}
cairo_select_font_face(
cairo_ptr,
clip_ptr->style.font.face,
CAIRO_FONT_SLANT_NORMAL,
wlmtk_style_font_weight_cairo_from_wlmtk(clip_ptr->style.font.weight));
cairo_set_font_size(cairo_ptr, clip_ptr->style.font.size);
cairo_set_source_argb8888(cairo_ptr, clip_ptr->style.text_color);
cairo_move_to(cairo_ptr, 4, 2 + clip_ptr->style.font.size);
cairo_show_text(cairo_ptr, name_ptr);
cairo_move_to(cairo_ptr, 50, 56);
char buf[10];
snprintf(buf, sizeof(buf), "%d", index);
cairo_show_text(cairo_ptr, buf);
cairo_destroy(cairo_ptr);
wlmtk_buffer_set(&clip_ptr->overlay_buffer, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Creates a wlr_buffer with texture suitable to show the 'next' and 'prev'
* buttons in each raised or pressed state.
*
* @param style_ptr
* @param prev_pressed
* @param next_pressed
*
* @return A wlr buffer.
*/
struct wlr_buffer *_wlmaker_clip_create_tile(
const wlmtk_tile_style_t *style_ptr,
bool prev_pressed,
bool next_pressed)
{
struct wlr_buffer* wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
style_ptr->size, style_ptr->size);
if (NULL == wlr_buffer_ptr) return NULL;
double tsize = style_ptr->size;
double bsize = 22.0 / 64.0 * style_ptr->size;
double margin = style_ptr->bezel_width;
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
wlmaker_primitives_cairo_fill(cairo_ptr, &style_ptr->fill);
// Northern + Western sides. Drawn clock-wise.
wlmaker_primitives_set_bezel_color(cairo_ptr, true);
cairo_move_to(cairo_ptr, 0, 0);
cairo_line_to(cairo_ptr, tsize - bsize, 0);
cairo_line_to(cairo_ptr, tsize - bsize, margin);
cairo_line_to(cairo_ptr, margin, margin);
cairo_line_to(cairo_ptr, margin, tsize - bsize);
cairo_line_to(cairo_ptr, 0, tsize - bsize);
cairo_line_to(cairo_ptr, 0, 0);
cairo_fill(cairo_ptr);
// Southern + Eastern sides. Also drawn Also clock-wise.
wlmaker_primitives_set_bezel_color(cairo_ptr, false);
cairo_move_to(cairo_ptr, tsize, tsize);
cairo_line_to(cairo_ptr, bsize, tsize);
cairo_line_to(cairo_ptr, bsize, tsize - margin);
cairo_line_to(cairo_ptr, tsize - margin, tsize - margin);
cairo_line_to(cairo_ptr, tsize - margin, bsize);
cairo_line_to(cairo_ptr, tsize, bsize);
cairo_line_to(cairo_ptr, tsize, tsize);
cairo_fill(cairo_ptr);
// Diagonal at the north-eastern corner. Drawn clockwise.
wlmaker_primitives_set_bezel_color(cairo_ptr, true);
cairo_move_to(cairo_ptr, tsize - bsize, 0);
cairo_line_to(cairo_ptr, tsize, bsize);
cairo_line_to(cairo_ptr, tsize - margin, bsize);
cairo_line_to(cairo_ptr, tsize - bsize, margin);
cairo_line_to(cairo_ptr, tsize - bsize, 0);
cairo_fill(cairo_ptr);
// Diagonal at south-western corner. Drawn clockwise.
wlmaker_primitives_set_bezel_color(cairo_ptr, false);
cairo_move_to(cairo_ptr, 0, tsize - bsize);
cairo_line_to(cairo_ptr, margin, tsize - bsize);
cairo_line_to(cairo_ptr, bsize, tsize - margin);
cairo_line_to(cairo_ptr, bsize, tsize);
cairo_line_to(cairo_ptr, 0, tsize - bsize);
cairo_fill(cairo_ptr);
// The "Next" button, north-eastern corner.
// Northern edge, illuminated when raised
wlmaker_primitives_set_bezel_color(cairo_ptr, !next_pressed);
cairo_move_to(cairo_ptr, tsize - bsize, 0);
cairo_line_to(cairo_ptr, tsize, 0);
cairo_line_to(cairo_ptr, tsize - margin, margin);
cairo_line_to(cairo_ptr, tsize - bsize + 2 * margin, margin);
cairo_line_to(cairo_ptr, tsize - bsize , 0);
cairo_fill(cairo_ptr);
// Eastern edge, illuminated when pressed
wlmaker_primitives_set_bezel_color(cairo_ptr, next_pressed);
cairo_move_to(cairo_ptr, tsize, 0);
cairo_line_to(cairo_ptr, tsize, bsize);
cairo_line_to(cairo_ptr, tsize - margin, bsize - 2 * margin);
cairo_line_to(cairo_ptr, tsize - margin, margin);
cairo_line_to(cairo_ptr, tsize, 0);
cairo_fill(cairo_ptr);
// Diagonal, illuminated when pressed.
wlmaker_primitives_set_bezel_color(cairo_ptr, next_pressed);
cairo_move_to(cairo_ptr, tsize - bsize, 0);
cairo_line_to(cairo_ptr, tsize - bsize + 2 * margin, margin);
cairo_line_to(cairo_ptr, tsize - margin, bsize - 2 *margin);
cairo_line_to(cairo_ptr, tsize, bsize);
cairo_line_to(cairo_ptr, tsize - bsize, 0);
cairo_fill(cairo_ptr);
// The black triangle. Use relative sizes.
double tpad = bsize * 5.0 / 22.0;
double trsize = bsize * 7.0 / 22.0;
double tmargin = bsize * 1.0 / 22.0;
cairo_set_source_rgba(cairo_ptr, 0, 0, 0, 1.0);
cairo_move_to(cairo_ptr, tsize - tpad, tpad);
cairo_line_to(cairo_ptr, tsize - tpad, trsize + tpad);
cairo_line_to(cairo_ptr, tsize - tpad - trsize, tpad);
cairo_line_to(cairo_ptr, tsize - tpad, tpad);
cairo_fill(cairo_ptr);
// Northern edge of triangle, not illuminated.
wlmaker_primitives_set_bezel_color(cairo_ptr, false);
cairo_move_to(cairo_ptr, tsize - tpad, tpad);
cairo_line_to(cairo_ptr, tsize - tpad - trsize, tpad);
cairo_line_to(cairo_ptr, tsize - tpad - trsize - tmargin, tpad - tmargin);
cairo_line_to(cairo_ptr, tsize - tpad + tmargin, tpad - tmargin);
cairo_line_to(cairo_ptr, tsize - tpad, tpad);
cairo_fill(cairo_ptr);
// Eastern side of triangle, illuminated.
wlmaker_primitives_set_bezel_color(cairo_ptr, true);
cairo_move_to(cairo_ptr, tsize - tpad, tpad);
cairo_line_to(cairo_ptr, tsize - tpad + tmargin, tpad - tmargin);
cairo_line_to(cairo_ptr, tsize - tpad + tmargin, tpad + trsize + tmargin);
cairo_line_to(cairo_ptr, tsize - tpad, tpad + trsize);
cairo_line_to(cairo_ptr, tsize - tpad, tpad);
cairo_fill(cairo_ptr);
// The "Prev" button, south-western corner.
// Southern edge, illuminated when pressed.
wlmaker_primitives_set_bezel_color(cairo_ptr, prev_pressed);
cairo_move_to(cairo_ptr, 0, tsize);
cairo_line_to(cairo_ptr, margin, tsize - margin);
cairo_line_to(cairo_ptr, bsize - 2 * margin, tsize - margin);
cairo_line_to(cairo_ptr, bsize, tsize);
cairo_line_to(cairo_ptr, 0, tsize);
cairo_fill(cairo_ptr);
// Western edge, illuminated when raised.
wlmaker_primitives_set_bezel_color(cairo_ptr, !prev_pressed);
cairo_move_to(cairo_ptr, 0, tsize);
cairo_line_to(cairo_ptr, 0, tsize - bsize + 0);
cairo_line_to(cairo_ptr, margin, tsize - bsize + 2 * margin);
cairo_line_to(cairo_ptr, margin, tsize - margin);
cairo_line_to(cairo_ptr, 0, tsize);
cairo_fill(cairo_ptr);
// Diagonal, illuminated when raised.
wlmaker_primitives_set_bezel_color(cairo_ptr, !prev_pressed);
cairo_move_to(cairo_ptr, 0, tsize - bsize + 0);
cairo_line_to(cairo_ptr, bsize, tsize);
cairo_line_to(cairo_ptr, bsize - 2 * margin, tsize - margin);
cairo_line_to(cairo_ptr, margin, tsize - bsize + 2 * margin);
cairo_line_to(cairo_ptr, 0, tsize - bsize + 0);
cairo_fill(cairo_ptr);
// The black triangle. Use relative sizes.
cairo_set_source_rgba(cairo_ptr, 0, 0, 0, 1.0);
cairo_move_to(cairo_ptr, tpad, tsize - tpad);
cairo_line_to(cairo_ptr, tpad, tsize - trsize - tpad);
cairo_line_to(cairo_ptr, tpad + trsize, tsize - tpad);
cairo_line_to(cairo_ptr, tpad, tsize - tpad);
cairo_fill(cairo_ptr);
// Southern edge of triangle, illuminated.
wlmaker_primitives_set_bezel_color(cairo_ptr, true);
cairo_move_to(cairo_ptr, tpad, tsize - tpad);
cairo_line_to(cairo_ptr, tpad + trsize, tsize - tpad);
cairo_line_to(cairo_ptr, tpad + trsize + tmargin, tsize - tpad + tmargin);
cairo_line_to(cairo_ptr, tpad - tmargin, tsize - tpad + tmargin);
cairo_line_to(cairo_ptr, tpad, tsize - tpad);
cairo_fill(cairo_ptr);
// Eastern side of triangle, not illuminated.
wlmaker_primitives_set_bezel_color(cairo_ptr, false);
cairo_move_to(cairo_ptr, tpad, tsize - tpad);
cairo_line_to(cairo_ptr, tpad - tmargin, tsize - tpad + tmargin);
cairo_line_to(cairo_ptr, tpad - tmargin, tsize - tpad - trsize - tmargin);
cairo_line_to(cairo_ptr, tpad, tsize - tpad - trsize);
cairo_line_to(cairo_ptr, tpad, tsize - tpad);
cairo_fill(cairo_ptr);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* -------------------------------------------------------------------------- */
/**
* Handler for the `workspace_changed` signal of `wlmaker_server_t`.
*
* Will redraw the clip contents with the current workspace, and re-map the
* clip to the new workspace.
*
* @param listener_ptr
* @param data_ptr Points to the new `wlmtk_workspace_t`.
*/
void _wlmaker_clip_handle_workspace_changed(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_clip_t *clip_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_clip_t, workspace_changed_listener);
wlmtk_panel_t *panel_ptr = wlmtk_dock_panel(clip_ptr->wlmtk_dock_ptr);
wlmtk_layer_t *current_layer_ptr = wlmtk_panel_get_layer(panel_ptr);
wlmtk_workspace_t *wlmtk_workspace_ptr =
wlmtk_root_get_current_workspace(clip_ptr->server_ptr->root_ptr);
wlmtk_layer_t *new_layer_ptr = wlmtk_workspace_get_layer(
wlmtk_workspace_ptr, WLMTK_WORKSPACE_LAYER_TOP);
if (current_layer_ptr == new_layer_ptr) return;
if (NULL != current_layer_ptr) {
wlmtk_layer_remove_panel(current_layer_ptr, panel_ptr);
}
wlmtk_layer_add_panel(new_layer_ptr, panel_ptr);
_wlmaker_clip_update_overlay(clip_ptr);
}
/* == Unit tests =========================================================== */
static void test_draw_tile(bs_test_t *test_ptr);
const bs_test_case_t wlmaker_clip_test_cases[] = {
{ 1, "draw_tile", test_draw_tile },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests that the clip tile is drawn correctly. */
void test_draw_tile(bs_test_t *test_ptr)
{
static const wlmtk_tile_style_t style = {
.fill = {
.type = WLMTK_STYLE_COLOR_DGRADIENT,
.param = { .dgradient = { .from = 0xffa6a6b6, .to = 0xff515561 } }
},
.bezel_width = 2,
.size = 64
};
struct wlr_buffer* wlr_buffer_ptr;
bs_gfxbuf_t *gfxbuf_ptr;
wlr_buffer_ptr = _wlmaker_clip_create_tile(&style, false, false);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlr_buffer_ptr);
gfxbuf_ptr = bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "clip_raised.png");
wlr_buffer_drop(wlr_buffer_ptr);
wlr_buffer_ptr = _wlmaker_clip_create_tile(&style, true, true);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlr_buffer_ptr);
gfxbuf_ptr = bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "clip_pressed.png");
wlr_buffer_drop(wlr_buffer_ptr);
}
/* == End of clip.c ======================================================== */
wlmaker-0.3/src/clip.h 0000664 0000000 0000000 00000003522 14641446446 0014724 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file clip.h
*
* @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.
*
* Creates the wlmaker clip. A view, with server-bound surfaces, that act
* as a workspace-local dock and a workspace pager.
*
* Corresponding Window Maker documentation:
* http://www.windowmaker.org/docs/guidedtour/clip.html
*/
#ifndef __CLIP_H__
#define __CLIP_H__
/** Forward definition: Clip handle. */
typedef struct _wlmaker_clip_t wlmaker_clip_t;
#include "config.h"
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates the Clip. Needs the server to be up with workspaces running.
*
* @param server_ptr
* @param state_dict_ptr
* @param style_ptr
*
* @return Pointer to the Clip handle, or NULL on error.
*/
wlmaker_clip_t *wlmaker_clip_create(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *state_dict_ptr,
const wlmaker_config_style_t *style_ptr);
/**
* Destroys the Clip.
*
* @param clip_ptr
*/
void wlmaker_clip_destroy(wlmaker_clip_t *clip_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmaker_clip_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __CLIP_H__ */
/* == End of clip.h ======================================================== */
wlmaker-0.3/src/conf/ 0000775 0000000 0000000 00000000000 14641446446 0014547 5 ustar 00root root 0000000 0000000 wlmaker-0.3/src/conf/CMakeLists.txt 0000664 0000000 0000000 00000003606 14641446446 0017314 0 ustar 00root root 0000000 0000000 # Copyright 2024 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
FIND_PACKAGE(FLEX 2.6 REQUIRED)
FLEX_TARGET(
analyzer
analyzer.l
${CMAKE_CURRENT_BINARY_DIR}/analyzer.c
DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/analyzer.h)
FIND_PACKAGE(BISON 3.0 REQUIRED)
BISON_TARGET(
grammar
grammar.y
${CMAKE_CURRENT_BINARY_DIR}/grammar.c
DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/grammar.h)
ADD_FLEX_BISON_DEPENDENCY(analyzer grammar)
SET(PUBLIC_HEADER_FILES
decode.h
model.h
plist.h)
ADD_LIBRARY(conf STATIC)
TARGET_SOURCES(conf PRIVATE
decode.c
model.c
plist.c
${CMAKE_CURRENT_BINARY_DIR}/analyzer.c
${CMAKE_CURRENT_BINARY_DIR}/grammar.c)
TARGET_INCLUDE_DIRECTORIES(conf PRIVATE ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/)
# TODO(kaeser@gubbe.ch):Remove, once updating post bison 3.8.2 (Aug 2022).
# See: https://github.com/phkaeser/wlmaker/issues/53
TARGET_COMPILE_OPTIONS(conf PRIVATE -Wno-unused-but-set-variable)
TARGET_LINK_LIBRARIES(conf base)
SET_TARGET_PROPERTIES(
conf
PROPERTIES VERSION 1.0
PUBLIC_HEADER "${PUBLIC_HEADER_FILES}")
ADD_EXECUTABLE(conf_test conf_test.c)
TARGET_LINK_LIBRARIES(conf_test base conf)
TARGET_INCLUDE_DIRECTORIES(conf_test PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/)
TARGET_COMPILE_DEFINITIONS(
conf_test PUBLIC TEST_DATA_DIR="${PROJECT_SOURCE_DIR}/testdata")
ADD_TEST(NAME conf_test COMMAND conf_test)
wlmaker-0.3/src/conf/analyzer.l 0000664 0000000 0000000 00000005406 14641446446 0016556 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file analyzer.l
*
* See https://westes.github.io/flex/manual/.
*
* @copyright
* Copyright 2024 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.
*/
%{
#include
#include "grammar.h"
/** Addresses valgrind unitialized memory warnings. */
#define YY_USER_INIT do { \
yylineno = 1; yycolumn = 0; yyleng = 0; \
memset(yylloc, 0, sizeof(*yylloc)); \
} while (0);
/** Permits location tracking, for positioned error reports. */
#define YY_USER_ACTION \
do { \
yylloc->first_line = yylloc->last_line = yylineno; \
yylloc->first_column = yycolumn - 1; \
yylloc->last_column = yycolumn + yyleng - 1; \
yycolumn += yyleng; \
} while (0);
%}
/* == Definitions section ===================================================*/
%option batch
%option bison-bridge
%option bison-locations
%option never-interactive
%option nodefault
%option noinput
%option nounput
%option noyywrap
%option reentrant
%option yylineno
ws [[:blank:]\r\n]
/* == Rules section ======================================================== */
%%
{ws}+ { /* whitespace */ }
"//".* { /* comment. */ }
\"[^\"]*\" { yylval->string = logged_strdup(yytext);
return TK_QUOTED_STRING; }
[a-zA-Z0-9_.$]+ { yylval->string = logged_strdup(yytext);
return TK_STRING; }
"(" { return TK_LPAREN; }
")" { return TK_RPAREN; }
"{" { return TK_LBRACE; }
"}" { return TK_RBRACE; }
"," { return TK_COMMA; }
"=" { return TK_EQUAL; }
";" { return TK_SEMICOLON; }
. { char msg[256];
snprintf(msg, sizeof(msg), "Unexpected character: '%s'",
yytext);
yyerror(yylloc, yyscanner, yyextra, msg);
return YYerror; }
%%
/* == User code section ==================================================== */
/* == End of analyzer.l ==================================================== */
wlmaker-0.3/src/conf/conf.md 0000664 0000000 0000000 00000002263 14641446446 0016021 0 ustar 00root root 0000000 0000000
# Configuration Files {#conf_page}
Configuration files are in *text plist* (or: *ASCII plist*) format:
https://code.google.com/archive/p/networkpx/wikis/PlistSpec.wiki
```plantuml
class Object {
{abstract}#void destroy()
}
class Dict {
Object get(String key);
#void destroy()
}
Dict <|-- Object
class Array {
size_t size()
Object get(size_t idx)
#void destroy()
}
Array <|-- Object
class String {
const char *get_value();
#void destroy()
}
String <|-- Object
class DictItem {
-String key
-Object value
}
class ArrayElement {
Object value
}
```
wlmaker-0.3/src/conf/conf_test.c 0000664 0000000 0000000 00000003004 14641446446 0016674 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file conf_test.c
*
* @copyright
* Copyright 2024 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.
*/
#include
#include
#include "decode.h"
#include "model.h"
#include "plist.h"
/** Conf module unit tests. */
const bs_test_set_t conf_tests[] = {
{ 1, "decode", wlmcfg_decode_test_cases },
{ 1, "model", wlmcfg_model_test_cases },
{ 1, "plist", wlmcfg_plist_test_cases },
{ 0, NULL, NULL },
};
#if !defined(TEST_DATA_DIR)
/** Directory root for looking up test data. See `bs_test_resolve_path`. */
#define TEST_DATA_DIR "./"
#endif // TEST_DATA_DIR
/** Main program, runs the unit tests. */
int main(__UNUSED__ int argc, __UNUSED__ const char **argv)
{
const bs_test_param_t params = {
.test_data_dir_ptr = TEST_DATA_DIR
};
return bs_test(conf_tests, argc, argv, ¶ms);
}
/* == End of conf_test.c =================================================== */
wlmaker-0.3/src/conf/decode.c 0000664 0000000 0000000 00000071225 14641446446 0016145 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file decode.c
*
* @copyright
* Copyright 2024 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.
*
* Configurables for wlmaker. Currently, this file lists hardcoded entities,
* and mainly serves as a catalog about which entities should be dynamically
* configurable.
*/
#include "decode.h"
#include "plist.h"
/* == Declarations ========================================================= */
/** A pointer of type `value_type`, at `offset` behind `base_ptr`. */
#define BS_VALUE_AT(_value_type, _base_ptr, _offset) \
((_value_type*)((uint8_t*)(_base_ptr) + (_offset)))
static bool _wlmcfg_init_defaults(
const wlmcfg_desc_t *desc_ptr,
void *dest_ptr);
static bool _wlmcfg_decode_uint64(
wlmcfg_object_t *obj_ptr,
uint64_t *uint64_ptr);
static bool _wlmcfg_decode_int64(
wlmcfg_object_t *obj_ptr,
int64_t *int64_ptr);
static bool _wlmcfg_decode_argb32(
wlmcfg_object_t *obj_ptr,
uint32_t *argb32_ptr);
static bool _wlmcfg_decode_bool(
wlmcfg_object_t *obj_ptr,
bool *bool_ptr);
static bool _wlmcfg_decode_enum(
wlmcfg_object_t *obj_ptr,
const wlmcfg_enum_desc_t *enum_desc_ptr,
int *enum_value_ptr);
static bool _wlmcfg_decode_string(
wlmcfg_object_t *obj_ptr,
char **str_ptr_ptr);
static bool _wlmcfg_decode_charbuf(
wlmcfg_object_t *obj_ptr,
char *str_ptr,
size_t len);
/** Enum descriptor for decoding bool. */
static const wlmcfg_enum_desc_t _wlmcfg_bool_desc[] = {
WLMCFG_ENUM("True", true),
WLMCFG_ENUM("False", false),
WLMCFG_ENUM("Yes", true),
WLMCFG_ENUM("No", false),
WLMCFG_ENUM("Enabled", true),
WLMCFG_ENUM("Disabled", false),
WLMCFG_ENUM("On", true),
WLMCFG_ENUM("Off", false),
WLMCFG_ENUM_SENTINEL()
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmcfg_decode_dict(
wlmcfg_dict_t *dict_ptr,
const wlmcfg_desc_t *desc_ptr,
void *dest_ptr)
{
if (!_wlmcfg_init_defaults(desc_ptr, dest_ptr)) {
wlmcfg_decoded_destroy(desc_ptr, dest_ptr);
return false;
}
for (const wlmcfg_desc_t *iter_desc_ptr = desc_ptr;
iter_desc_ptr->key_ptr != NULL;
++iter_desc_ptr) {
wlmcfg_object_t *obj_ptr = wlmcfg_dict_get(
dict_ptr, iter_desc_ptr->key_ptr);
if (NULL == obj_ptr) {
if (iter_desc_ptr->required) {
bs_log(BS_ERROR, "Key \"%s\" not found in dict %p.",
iter_desc_ptr->key_ptr, dict_ptr);
wlmcfg_decoded_destroy(desc_ptr, dest_ptr);
return false;
}
continue;
}
bool rv = false;
switch (iter_desc_ptr->type) {
case WLMCFG_TYPE_UINT64:
rv = _wlmcfg_decode_uint64(
obj_ptr,
BS_VALUE_AT(uint64_t, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_INT64:
rv = _wlmcfg_decode_int64(
obj_ptr,
BS_VALUE_AT(int64_t, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_ARGB32:
rv = _wlmcfg_decode_argb32(
obj_ptr,
BS_VALUE_AT(uint32_t, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_BOOL:
rv = _wlmcfg_decode_bool(
obj_ptr,
BS_VALUE_AT(bool, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_ENUM:
rv = _wlmcfg_decode_enum(
obj_ptr,
iter_desc_ptr->v.v_enum.desc_ptr,
BS_VALUE_AT(int, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_STRING:
rv = _wlmcfg_decode_string(
obj_ptr,
BS_VALUE_AT(char*, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_CHARBUF:
rv = _wlmcfg_decode_charbuf(
obj_ptr,
BS_VALUE_AT(char, dest_ptr, iter_desc_ptr->field_offset),
iter_desc_ptr->v.v_charbuf.len);
break;
case WLMCFG_TYPE_DICT:
rv = wlmcfg_decode_dict(
wlmcfg_dict_from_object(obj_ptr),
iter_desc_ptr->v.v_dict_desc_ptr,
BS_VALUE_AT(void*, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_CUSTOM:
rv = iter_desc_ptr->v.v_custom.decode(
obj_ptr,
BS_VALUE_AT(void*, dest_ptr, iter_desc_ptr->field_offset));
break;
default:
bs_log(BS_ERROR, "Unsupported type %d.", iter_desc_ptr->type);
rv = false;
break;
}
if (!rv) {
wlmcfg_decoded_destroy(desc_ptr, dest_ptr);
return false;
}
}
return true;
}
/* ------------------------------------------------------------------------- */
void wlmcfg_decoded_destroy(
const wlmcfg_desc_t *desc_ptr,
void *dest_ptr)
{
char **str_ptr_ptr;
for (const wlmcfg_desc_t *iter_desc_ptr = desc_ptr;
iter_desc_ptr->key_ptr != NULL;
++iter_desc_ptr) {
switch (iter_desc_ptr->type) {
case WLMCFG_TYPE_STRING:
str_ptr_ptr = BS_VALUE_AT(
char*, dest_ptr, iter_desc_ptr->field_offset);
if (NULL != *str_ptr_ptr) {
free(*str_ptr_ptr);
*str_ptr_ptr = NULL;
}
break;
case WLMCFG_TYPE_DICT:
wlmcfg_decoded_destroy(
iter_desc_ptr->v.v_dict_desc_ptr,
BS_VALUE_AT(
void*, dest_ptr, iter_desc_ptr->field_offset));
break;
case WLMCFG_TYPE_CUSTOM:
if (NULL != iter_desc_ptr->v.v_custom.fini) {
iter_desc_ptr->v.v_custom.fini(
BS_VALUE_AT(void*, dest_ptr, iter_desc_ptr->field_offset));
}
break;
default:
// Nothing.
break;
}
}
}
/* ------------------------------------------------------------------------- */
bool wlmcfg_enum_name_to_value(
const wlmcfg_enum_desc_t *enum_desc_ptr,
const char *name_ptr,
int *value_ptr)
{
for (; NULL != enum_desc_ptr->name_ptr; ++enum_desc_ptr) {
if (0 == strcmp(enum_desc_ptr->name_ptr, name_ptr)) {
*value_ptr = enum_desc_ptr->value;
return true;
}
}
return false;
}
/* ------------------------------------------------------------------------- */
bool wlmcfg_enum_value_to_name(
const wlmcfg_enum_desc_t *enum_desc_ptr,
int value,
const char **name_ptr_ptr)
{
for (; NULL != enum_desc_ptr->name_ptr; ++enum_desc_ptr) {
if (value == enum_desc_ptr->value) {
*name_ptr_ptr = enum_desc_ptr->name_ptr;
return true;
}
}
return false;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Initializes default values at the destination, as described.
*
* @param desc_ptr
* @param dest_ptr
*/
bool _wlmcfg_init_defaults(const wlmcfg_desc_t *desc_ptr,
void *dest_ptr)
{
char **str_ptr_ptr;
char *str_ptr;
for (const wlmcfg_desc_t *iter_desc_ptr = desc_ptr;
iter_desc_ptr->key_ptr != NULL;
++iter_desc_ptr) {
switch (iter_desc_ptr->type) {
case WLMCFG_TYPE_UINT64:
*BS_VALUE_AT(uint64_t, dest_ptr, iter_desc_ptr->field_offset) =
iter_desc_ptr->v.v_uint64.default_value;
break;
case WLMCFG_TYPE_INT64:
*BS_VALUE_AT(int64_t, dest_ptr, iter_desc_ptr->field_offset) =
iter_desc_ptr->v.v_int64.default_value;
break;
case WLMCFG_TYPE_ARGB32:
*BS_VALUE_AT(uint32_t, dest_ptr, iter_desc_ptr->field_offset) =
iter_desc_ptr->v.v_argb32.default_value;
break;
case WLMCFG_TYPE_BOOL:
*BS_VALUE_AT(bool, dest_ptr, iter_desc_ptr->field_offset) =
iter_desc_ptr->v.v_bool.default_value;
break;
case WLMCFG_TYPE_ENUM:
*BS_VALUE_AT(int, dest_ptr, iter_desc_ptr->field_offset) =
iter_desc_ptr->v.v_enum.default_value;
break;
case WLMCFG_TYPE_STRING:
str_ptr_ptr = BS_VALUE_AT(
char*, dest_ptr, iter_desc_ptr->field_offset);
if (NULL != *str_ptr_ptr) free(*str_ptr_ptr);
*str_ptr_ptr = logged_strdup(
iter_desc_ptr->v.v_string.default_value_ptr);
if (NULL == *str_ptr_ptr) return false;
break;
case WLMCFG_TYPE_CHARBUF:
str_ptr = BS_VALUE_AT(
char, dest_ptr, iter_desc_ptr->field_offset);
if (NULL == iter_desc_ptr->v.v_charbuf.default_value_ptr) break;
if (iter_desc_ptr->v.v_charbuf.len <
strlen(iter_desc_ptr->v.v_charbuf.default_value_ptr) + 1) {
bs_log(BS_ERROR,
"Buffer size %zu < %zu + 1, default charbuf (\"%s\")",
iter_desc_ptr->v.v_charbuf.len,
strlen(iter_desc_ptr->v.v_charbuf.default_value_ptr),
iter_desc_ptr->v.v_charbuf.default_value_ptr);
return false;
}
strcpy(str_ptr, iter_desc_ptr->v.v_charbuf.default_value_ptr);
break;
case WLMCFG_TYPE_DICT:
if (!_wlmcfg_init_defaults(
iter_desc_ptr->v.v_dict_desc_ptr,
BS_VALUE_AT(void*, dest_ptr,
iter_desc_ptr->field_offset))) {
return false;
}
break;
case WLMCFG_TYPE_CUSTOM:
if (NULL != iter_desc_ptr->v.v_custom.init &&
!iter_desc_ptr->v.v_custom.init(
BS_VALUE_AT(void*, dest_ptr, iter_desc_ptr->field_offset))) {
return false;
}
break;
default:
bs_log(BS_ERROR, "Unsupported type %d.", iter_desc_ptr->type);
return false;
}
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Decodes an unsigned number, using uint64_t as carry-all. */
bool _wlmcfg_decode_uint64(wlmcfg_object_t *obj_ptr, uint64_t *uint64_ptr)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
return bs_strconvert_uint64(value_ptr, uint64_ptr, 10);
}
/* ------------------------------------------------------------------------- */
/** Decodes a signed number, using int64_t as carry-all. */
bool _wlmcfg_decode_int64(wlmcfg_object_t *obj_ptr, int64_t *int64_ptr)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
return bs_strconvert_int64(value_ptr, int64_ptr, 10);
}
/* ------------------------------------------------------------------------- */
/** Deocdes an ARGB32 value from the config object. */
bool _wlmcfg_decode_argb32(wlmcfg_object_t *obj_ptr, uint32_t *argb32_ptr)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
int rv = sscanf(value_ptr, "argb32:%"PRIx32, argb32_ptr);
if (1 != rv) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed sscanf(\"%s\", \"argb32:%%"PRIx32", %p)",
value_ptr, argb32_ptr);
return false;
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Translates a bool value from the string. */
bool _wlmcfg_decode_bool(
wlmcfg_object_t *obj_ptr,
bool *bool_ptr)
{
int bool_value;
bool rv = _wlmcfg_decode_enum(obj_ptr, _wlmcfg_bool_desc, &bool_value);
if (rv) *bool_ptr = bool_value;
return rv;
}
/* ------------------------------------------------------------------------- */
/** Translates a enum value from the string, using the provided descriptor. */
bool _wlmcfg_decode_enum(
wlmcfg_object_t *obj_ptr,
const wlmcfg_enum_desc_t *enum_desc_ptr,
int *enum_value_ptr)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
for (; NULL != enum_desc_ptr->name_ptr; ++enum_desc_ptr) {
if (0 == strcmp(enum_desc_ptr->name_ptr, value_ptr)) {
*enum_value_ptr = enum_desc_ptr->value;
return true;
}
}
return false;
}
/* ------------------------------------------------------------------------- */
/** Translates (ie. duplicates) a string value from the plist string. */
bool _wlmcfg_decode_string(
wlmcfg_object_t *obj_ptr,
char **str_ptr_ptr)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
if (NULL != *str_ptr_ptr) free(*str_ptr_ptr);
*str_ptr_ptr = logged_strdup(value_ptr);
return (NULL != *str_ptr_ptr);
}
/* ------------------------------------------------------------------------- */
/** Translates (ie. duplicates) a char buf from the plist string. */
bool _wlmcfg_decode_charbuf(
wlmcfg_object_t *obj_ptr,
char *str_ptr,
size_t len)
{
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(obj_ptr);
if (NULL == string_ptr) return false;
const char *value_ptr = wlmcfg_string_value(string_ptr);
if (NULL == value_ptr) return false;
if (len < strlen(value_ptr) + 1) {
bs_log(BS_WARNING, "Charbuf size %zu < %zu + 1 for \"%s\"",
len, strlen(value_ptr), value_ptr);
return false;
}
strcpy(str_ptr, value_ptr);
return true;
}
/* == Unit tests =========================================================== */
static void test_init_defaults(bs_test_t *test_ptr);
static void test_enum_translate(bs_test_t *test_ptr);
static void test_decode_dict(bs_test_t *test_ptr);
static void test_decode_number(bs_test_t *test_ptr);
static void test_decode_argb32(bs_test_t *test_ptr);
static void test_decode_bool(bs_test_t *test_ptr);
static void test_decode_enum(bs_test_t *test_ptr);
static void test_decode_string(bs_test_t *test_ptr);
static void test_decode_charbuf(bs_test_t *test_ptr);
const bs_test_case_t wlmcfg_decode_test_cases[] = {
{ 1, "init_defaults", test_init_defaults },
{ 1, "enum_translate", test_enum_translate },
{ 1, "dict", test_decode_dict },
{ 1, "number", test_decode_number },
{ 1, "argb32", test_decode_argb32 },
{ 1, "bool", test_decode_bool },
{ 1, "enum", test_decode_enum },
{ 1, "string", test_decode_string },
{ 1, "charbuf", test_decode_charbuf },
{ 0, NULL, NULL },
};
static bool _wlmcfg_test_custom_decode(wlmcfg_object_t *o_ptr, void *dst_ptr);
static bool _wlmcfg_test_custom_init(void *dst_ptr);
static void _wlmcfg_test_custom_fini(void *dst_ptr);
/** Structure with test values. */
typedef struct {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
char *value;
#endif // DOXYGEN_SHOULD_SKIP_THIS
} _test_subdict_value_t;
/** Structure with test values. */
typedef struct {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
uint64_t v_uint64;
int64_t v_int64;
uint32_t v_argb32;
bool v_bool;
int v_enum;
char *v_string;
char v_charbuf[10];
_test_subdict_value_t subdict;
void *v_custom_ptr;
#endif // DOXYGEN_SHOULD_SKIP_THIS
} _test_value_t;
/** An enum descriptor. */
static const wlmcfg_enum_desc_t _test_enum_desc[] = {
WLMCFG_ENUM("enum1", 1),
WLMCFG_ENUM("enum2", 2),
WLMCFG_ENUM_SENTINEL()
};
/** Descriptor of a contained dict. */
static const wlmcfg_desc_t _wlmcfg_decode_test_subdesc[] = {
WLMCFG_DESC_STRING("string", true, _test_subdict_value_t, value,
"Other String"),
WLMCFG_DESC_SENTINEL(),
};
/** Test descriptor. */
static const wlmcfg_desc_t _wlmcfg_decode_test_desc[] = {
WLMCFG_DESC_UINT64("u64", true, _test_value_t, v_uint64, 1234),
WLMCFG_DESC_INT64("i64", true, _test_value_t, v_int64, -1234),
WLMCFG_DESC_ARGB32("argb32", true, _test_value_t, v_argb32, 0x01020304),
WLMCFG_DESC_BOOL("bool", true, _test_value_t, v_bool, true),
WLMCFG_DESC_ENUM("enum", true, _test_value_t, v_enum, 3, _test_enum_desc),
WLMCFG_DESC_STRING("string", true, _test_value_t, v_string, "The String"),
WLMCFG_DESC_CHARBUF("charbuf", true, _test_value_t, v_charbuf, 10, "CharBuf"),
WLMCFG_DESC_DICT("subdict", true, _test_value_t, subdict,
_wlmcfg_decode_test_subdesc),
WLMCFG_DESC_CUSTOM("custom", true, _test_value_t, v_custom_ptr,
_wlmcfg_test_custom_decode,
_wlmcfg_test_custom_init,
_wlmcfg_test_custom_fini),
WLMCFG_DESC_SENTINEL(),
};
/* ------------------------------------------------------------------------- */
/** A custom decoding function. Here: just decode a string. */
bool _wlmcfg_test_custom_decode(wlmcfg_object_t *o_ptr,
void *dst_ptr)
{
char** str_ptr_ptr = dst_ptr;
_wlmcfg_test_custom_fini(dst_ptr);
wlmcfg_string_t *string_ptr = wlmcfg_string_from_object(o_ptr);
if (NULL == string_ptr) return false;
*str_ptr_ptr = logged_strdup(wlmcfg_string_value(string_ptr));
return *str_ptr_ptr != NULL;
}
/* ------------------------------------------------------------------------- */
/** A custom decoding initializer. Here: Just create a string. */
bool _wlmcfg_test_custom_init(void *dst_ptr)
{
char** str_ptr_ptr = dst_ptr;
_wlmcfg_test_custom_fini(dst_ptr);
*str_ptr_ptr = logged_strdup("Custom Init");
return *str_ptr_ptr != NULL;
}
/* ------------------------------------------------------------------------- */
/** A custom decoding cleanup method. Frees the string. */
void _wlmcfg_test_custom_fini(void *dst_ptr)
{
char** str_ptr_ptr = dst_ptr;
if (NULL != *str_ptr_ptr) {
free(*str_ptr_ptr);
*str_ptr_ptr = NULL;
}
}
/* ------------------------------------------------------------------------- */
/** Tests initialization of default values. */
void test_init_defaults(bs_test_t *test_ptr)
{
_test_value_t val = {};
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmcfg_init_defaults(_wlmcfg_decode_test_desc, &val));
BS_TEST_VERIFY_EQ(test_ptr, 1234, val.v_uint64);
BS_TEST_VERIFY_EQ(test_ptr, -1234, val.v_int64);
BS_TEST_VERIFY_EQ(test_ptr, 0x01020304, val.v_argb32);
BS_TEST_VERIFY_EQ(test_ptr, true, val.v_bool);
BS_TEST_VERIFY_EQ(test_ptr, 3, val.v_enum);
BS_TEST_VERIFY_STREQ(test_ptr, "The String", val.v_string);
BS_TEST_VERIFY_STREQ(test_ptr, "Other String", val.subdict.value);
BS_TEST_VERIFY_STREQ(test_ptr, "Custom Init", val.v_custom_ptr);
wlmcfg_decoded_destroy(_wlmcfg_decode_test_desc, &val);
}
/* ------------------------------------------------------------------------- */
/** Tests @ref wlmcfg_enum_name_to_value and @ref wlmcfg_enum_value_to_name. */
void test_enum_translate(bs_test_t *test_ptr)
{
const wlmcfg_enum_desc_t *d = _wlmcfg_bool_desc;
int v;
BS_TEST_VERIFY_TRUE(test_ptr, wlmcfg_enum_name_to_value(d, "True", &v));
BS_TEST_VERIFY_EQ(test_ptr, 1, v);
BS_TEST_VERIFY_TRUE(test_ptr, wlmcfg_enum_name_to_value(d, "On", &v));
BS_TEST_VERIFY_EQ(test_ptr, 1, v);
BS_TEST_VERIFY_TRUE(test_ptr, wlmcfg_enum_name_to_value(d, "Off", &v));
BS_TEST_VERIFY_EQ(test_ptr, 0, v);
BS_TEST_VERIFY_FALSE(test_ptr, wlmcfg_enum_name_to_value(d, "Bad", &v));
const char *n_ptr;
BS_TEST_VERIFY_TRUE(test_ptr, wlmcfg_enum_value_to_name(d, true, &n_ptr));
BS_TEST_VERIFY_STREQ(test_ptr, "True", n_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, wlmcfg_enum_value_to_name(d, false, &n_ptr));
BS_TEST_VERIFY_STREQ(test_ptr, "False", n_ptr);
BS_TEST_VERIFY_FALSE(test_ptr, wlmcfg_enum_value_to_name(d, 42, &n_ptr));
}
/* ------------------------------------------------------------------------- */
/** Tests dict decoding. */
void test_decode_dict(bs_test_t *test_ptr)
{
_test_value_t val = {};
const char *plist_string_ptr = ("{"
"u64 = \"100\";"
"i64 = \"-101\";"
"argb32 = \"argb32:0204080c\";"
"bool = Disabled;"
"enum = enum1;"
"string = TestString;"
"charbuf = TestBuf;"
"subdict = { string = OtherTestString };"
"custom = CustomThing"
"}");
wlmcfg_dict_t *dict_ptr;
dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_string(plist_string_ptr));
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, dict_ptr);
BS_TEST_VERIFY_TRUE_OR_RETURN(
test_ptr,
wlmcfg_decode_dict(dict_ptr, _wlmcfg_decode_test_desc, &val));
BS_TEST_VERIFY_EQ(test_ptr, 100, val.v_uint64);
BS_TEST_VERIFY_EQ(test_ptr, -101, val.v_int64);
BS_TEST_VERIFY_EQ(test_ptr, 0x0204080c, val.v_argb32);
BS_TEST_VERIFY_EQ(test_ptr, false, val.v_bool);
BS_TEST_VERIFY_EQ(test_ptr, 1, val.v_enum);
BS_TEST_VERIFY_STREQ(test_ptr, "TestString", val.v_string);
BS_TEST_VERIFY_STREQ(test_ptr, "TestBuf", val.v_charbuf);
BS_TEST_VERIFY_STREQ(test_ptr, "CustomThing", val.v_custom_ptr);
wlmcfg_dict_unref(dict_ptr);
wlmcfg_decoded_destroy(_wlmcfg_decode_test_desc, &val);
dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_string("{anything=value}"));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmcfg_decode_dict(dict_ptr, _wlmcfg_decode_test_desc, &val));
wlmcfg_dict_unref(dict_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests number decoding. */
void test_decode_number(bs_test_t *test_ptr)
{
wlmcfg_object_t *obj_ptr;
int64_t i64;
uint64_t u64;
obj_ptr = wlmcfg_create_object_from_plist_string("42");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_uint64(obj_ptr, &u64));
BS_TEST_VERIFY_EQ(test_ptr, 42, u64);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("\"-1234\"");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_FALSE(test_ptr, _wlmcfg_decode_uint64(obj_ptr, &u64));
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("42");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_int64(obj_ptr, &i64));
BS_TEST_VERIFY_EQ(test_ptr, 42, i64);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("\"-1234\"");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_int64(obj_ptr, &i64));
BS_TEST_VERIFY_EQ(test_ptr, -1234, i64);
wlmcfg_object_unref(obj_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests argb32 decoding. */
void test_decode_argb32(bs_test_t *test_ptr)
{
wlmcfg_object_t *obj_ptr = wlmcfg_create_object_from_plist_string(
"\"argb32:01020304\"");
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, obj_ptr);
uint32_t argb32;
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_argb32(obj_ptr, &argb32));
BS_TEST_VERIFY_EQ(test_ptr, 0x01020304, argb32);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string(
"{c=\"argb32:ffa0b0c0\"}");
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, obj_ptr);
_test_value_t v;
wlmcfg_desc_t desc[] = {
WLMCFG_DESC_ARGB32("c", false, _test_value_t , v_argb32, 0x01020304),
WLMCFG_DESC_ARGB32("d", false, _test_value_t , v_argb32, 0x01020304),
WLMCFG_DESC_SENTINEL()
};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_decode_dict(wlmcfg_dict_from_object(obj_ptr), desc, &v));
wlmcfg_object_unref(obj_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests bool decoding. */
void test_decode_bool(bs_test_t *test_ptr)
{
bool value;
wlmcfg_object_t *obj_ptr;
obj_ptr = wlmcfg_create_object_from_plist_string("Yes");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_bool(obj_ptr, &value));
BS_TEST_VERIFY_TRUE(test_ptr, value);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("Disabled");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_bool(obj_ptr, &value));
BS_TEST_VERIFY_FALSE(test_ptr, value);
wlmcfg_object_unref(obj_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests enum decoding. */
void test_decode_enum(bs_test_t *test_ptr)
{
int value;
wlmcfg_object_t *obj_ptr;
obj_ptr = wlmcfg_create_object_from_plist_string("enum2");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmcfg_decode_enum(obj_ptr, _test_enum_desc, &value));
BS_TEST_VERIFY_EQ(test_ptr, 2, value);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("\"enum2\"");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmcfg_decode_enum(obj_ptr, _test_enum_desc, &value));
BS_TEST_VERIFY_EQ(test_ptr, 2, value);
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_string("INVALID");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_FALSE(
test_ptr,
_wlmcfg_decode_enum(obj_ptr, _test_enum_desc, &value));
wlmcfg_object_unref(obj_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests string decoding. */
void test_decode_string(bs_test_t *test_ptr)
{
char *v_ptr = NULL;
wlmcfg_object_t *obj_ptr;
obj_ptr = wlmcfg_create_object_from_plist_string("TheString");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_string(obj_ptr, &v_ptr));
BS_TEST_VERIFY_STREQ(test_ptr, "TheString", v_ptr);
wlmcfg_object_unref(obj_ptr);
free(v_ptr);
v_ptr = NULL;
obj_ptr = wlmcfg_create_object_from_plist_string("1234");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_string(obj_ptr, &v_ptr));
BS_TEST_VERIFY_STREQ(test_ptr, "1234", v_ptr);
wlmcfg_object_unref(obj_ptr);
// Not free-ing v_ptr => the next 'decode' call has to do that.
obj_ptr = wlmcfg_create_object_from_plist_string("\"quoted string\"");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, obj_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_string(obj_ptr, &v_ptr));
BS_TEST_VERIFY_STREQ(test_ptr, "quoted string", v_ptr);
wlmcfg_object_unref(obj_ptr);
free(v_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests string decoding into a char buf. */
void test_decode_charbuf(bs_test_t *test_ptr)
{
char b[10];
wlmcfg_object_t *o;
o = wlmcfg_create_object_from_plist_string("123456789");
BS_TEST_VERIFY_TRUE(test_ptr, _wlmcfg_decode_charbuf(o, b, sizeof(b)));
BS_TEST_VERIFY_STREQ(test_ptr, b, "123456789");
wlmcfg_object_unref(o);
o = wlmcfg_create_object_from_plist_string("1234567890");
BS_TEST_VERIFY_FALSE(test_ptr, _wlmcfg_decode_charbuf(o, b, sizeof(b)));
wlmcfg_object_unref(o);
}
/* == End of decode.c ====================================================== */
wlmaker-0.3/src/conf/decode.h 0000664 0000000 0000000 00000025173 14641446446 0016153 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file decode.h
*
* @copyright
* Copyright 2024 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.
*
* Configurables for wlmaker. Currently, this file lists hardcoded entities,
* and mainly serves as a catalog about which entities should be dynamically
* configurable.
*/
#ifndef __WLMCFG_DECODE_H__
#define __WLMCFG_DECODE_H__
#include
#include
#include
#include "model.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Descriptor. */
typedef struct _wlmcfg_desc_t wlmcfg_desc_t;
/** Enum descriptor. */
typedef struct {
/** The string representation of the enum. */
const char *name_ptr;
/** The corresponding numeric value. */
int value;
} wlmcfg_enum_desc_t;
/** Sentinel for an enum descriptor sequence. */
#define WLMCFG_ENUM_SENTINEL() { .name_ptr = NULL }
/** Helper to define an enum descriptor. */
#define WLMCFG_ENUM(_name, _value) { .name_ptr = (_name), .value = (_value) }
/** Supported types to decode from a plist dict. */
typedef enum {
WLMCFG_TYPE_UINT64,
WLMCFG_TYPE_INT64,
WLMCFG_TYPE_ARGB32,
WLMCFG_TYPE_BOOL,
WLMCFG_TYPE_ENUM,
WLMCFG_TYPE_STRING,
WLMCFG_TYPE_CHARBUF,
WLMCFG_TYPE_DICT,
WLMCFG_TYPE_CUSTOM,
} wlmcfg_decode_type_t;
/** A signed 64-bit integer. */
typedef struct {
/** The default value, if not in the dict. */
int64_t default_value;
} wlmcfg_desc_int64_t;
/** An unsigned 64-bit integer. */
typedef struct {
/** The default value, if not in the dict. */
uint64_t default_value;
} wlmcfg_desc_uint64_t;
/** A color, encoded as string in format 'argb32:aarrggbb'. */
typedef struct {
/** The default value, if not in the dict. */
uint32_t default_value;
} wlmcfg_desc_argb32_t;
/** A boolean value. */
typedef struct {
/** The default value, if not in the dict. */
bool default_value;
} wlmcfg_desc_bool_t;
/** An enum. */
typedef struct {
/** The default value, if not in the dict. */
int default_value;
/** The enum descriptor. */
const wlmcfg_enum_desc_t *desc_ptr;
} wlmcfg_desc_enum_t;
/** A string. Will be (re)created and must be free'd. */
typedef struct {
/** The default value, if not in the dict. */
const char *default_value_ptr;
} wlmcfg_desc_string_t;
/** A char buffer. Fixed size, no need to create. */
typedef struct {
/** Size of the char buffer at the specified offset. */
size_t len;
/** The default value, if not in the dict. */
const char *default_value_ptr;
} wlmcfg_desc_charbuf_t;
/** A custom decoder. */
typedef struct {
/** Decoding method: From obhect into `dest_ptr`. */
bool (*decode)(wlmcfg_object_t *obj_ptr, void *dest_ptr);
/** Initializer method: Allocate or prepare `dest_ptr`. May be NULL. */
bool (*init)(void *dest_ptr);
/** Cleanup method: Frees `dest_ptr`. May be NULL.. */
void (*fini)(void *dest_ptr);
} wlmcfg_desc_custom_t;
/** Descriptor to decode a plist dict. */
struct _wlmcfg_desc_t {
/** Type of the value. */
wlmcfg_decode_type_t type;
/** The key used for the described value in the plist dict. */
const char *key_ptr;
/** Whether the field is required. */
bool required;
/** Offset of the field where to store the value. */
size_t field_offset;
/** And the descriptor of the value. */
union {
wlmcfg_desc_int64_t v_int64;
wlmcfg_desc_uint64_t v_uint64;
wlmcfg_desc_argb32_t v_argb32;
wlmcfg_desc_bool_t v_bool;
wlmcfg_desc_enum_t v_enum;
wlmcfg_desc_string_t v_string;
wlmcfg_desc_charbuf_t v_charbuf;
const wlmcfg_desc_t *v_dict_desc_ptr;
wlmcfg_desc_custom_t v_custom;
} v;
};
/** Descriptor sentinel. Put at end of a @ref wlmcfg_desc_t sequence. */
#define WLMCFG_DESC_SENTINEL() { .key_ptr = NULL }
/** Descriptor for an unsigned int64. */
#define WLMCFG_DESC_UINT64(_key, _required, _base, _field, _default) { \
.type = WLMCFG_TYPE_UINT64, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_uint64.default_value = _default \
}
/** Descriptor for an signed int64. */
#define WLMCFG_DESC_INT64(_key, _required, _base, _field, _default) { \
.type = WLMCFG_TYPE_INT64, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_int64.default_value = _default \
}
/** Descriptor for an ARGB32 value. */
#define WLMCFG_DESC_ARGB32(_key, _required, _base, _field, _default) { \
.type = WLMCFG_TYPE_ARGB32, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_argb32.default_value = _default \
}
/** Descriptor for a bool value. */
#define WLMCFG_DESC_BOOL(_key, _required, _base, _field, _default) { \
.type = WLMCFG_TYPE_BOOL, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_bool.default_value = _default \
}
/** Descriptor for an enum value. */
#define WLMCFG_DESC_ENUM(_key, _required, _base, _field, _default, _desc_ptr) \
{ \
.type = WLMCFG_TYPE_ENUM, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_enum.default_value = _default, \
.v.v_enum.desc_ptr = _desc_ptr \
}
/** Descriptor for a string value value. */
#define WLMCFG_DESC_STRING(_key, _required, _base, _field, _default) { \
.type = WLMCFG_TYPE_STRING, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_string.default_value_ptr = _default, \
}
/** Descriptor for a char buffer. */
#define WLMCFG_DESC_CHARBUF(_key, _required, _base, _field, _len, _default) { \
.type = WLMCFG_TYPE_CHARBUF, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_charbuf.len = _len, \
.v.v_charbuf.default_value_ptr = _default, \
}
/** Descriptor for a dict sub-value. */
#define WLMCFG_DESC_DICT(_key, _required, _base, _field, _desc) { \
.type = WLMCFG_TYPE_DICT, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_dict_desc_ptr = _desc \
}
/** Descriptor for a custom object decoder. */
#define WLMCFG_DESC_CUSTOM(_key, _required, _base, _field, _d ,_i, _f) { \
.type = WLMCFG_TYPE_CUSTOM, \
.key_ptr = (_key), \
.required = _required, \
.field_offset = offsetof(_base, _field), \
.v.v_custom.decode = _d, \
.v.v_custom.init = _i, \
.v.v_custom.fini = _f, \
}
/**
* Decodes the plist `dict_ptr` into `dest_ptr` as described.
*
* @param dict_ptr
* @param desc_ptr
* @param dest_ptr
*
* @return true on success.
*/
bool wlmcfg_decode_dict(
wlmcfg_dict_t *dict_ptr,
const wlmcfg_desc_t *desc_ptr,
void *dest_ptr);
/**
* Destroys resources that were allocated during @ref wlmcfg_decode_dict.
*
* @param desc_ptr
* @param dest_ptr
*/
void wlmcfg_decoded_destroy(
const wlmcfg_desc_t *desc_ptr,
void *dest_ptr);
/**
* Translates from the given name of an enum to it's value.
*
* @param enum_desc_ptr
* @param name_ptr
* @param value_ptr
*
* @return true if `name_ptr` was a valid enum name.
*/
bool wlmcfg_enum_name_to_value(
const wlmcfg_enum_desc_t *enum_desc_ptr,
const char *name_ptr,
int *value_ptr);
/**
* Translates from the given value of an enum to it's name.
*
* @param enum_desc_ptr
* @param value
* @param name_ptr_ptr
*
* @return true if `name_ptr` was a valid enum name.
*/
bool wlmcfg_enum_value_to_name(
const wlmcfg_enum_desc_t *enum_desc_ptr,
int value,
const char **name_ptr_ptr);
/** Unit tests. */
extern const bs_test_case_t wlmcfg_decode_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMCFG_DECODE_H__ */
/* == End of decode.h ====================================================== */
wlmaker-0.3/src/conf/grammar.y 0000664 0000000 0000000 00000011412 14641446446 0016366 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file grammar.y
*
* See https://www.gnu.org/software/bison/manual/bison.html.
*
* @copyright
* Copyright 2024 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.
*/
/* == Prologue ============================================================= */
%{
#include "grammar.h"
#include "analyzer.h"
#include
#include "model.h"
%}
/* == Bison declarations =================================================== */
%union{
char *string;
}
%locations
%define parse.error verbose
%define api.pure full
%parse-param { void* scanner }
%parse-param { wlmcfg_parser_context_t *ctx_ptr }
%lex-param { yyscan_t scanner }
%code requires {
#include "parser.h"
}
%code provides {
extern int yyerror(
YYLTYPE *loc_ptr,
void* scanner,
wlmcfg_parser_context_t *ctx_ptr,
const char* msg_ptr);
}
%token TK_LPAREN
%token TK_RPAREN
%token TK_LBRACE
%token TK_RBRACE
%token TK_COMMA
%token TK_EQUAL
%token TK_SEMICOLON
%token TK_STRING
%token TK_QUOTED_STRING
%destructor { free($$); }
%%
/* == Grammar rules ======================================================== */
/* See https://code.google.com/archive/p/networkpx/wikis/PlistSpec.wiki. */
start: object;
object: string
| dict
| array;
string: TK_STRING {
wlmcfg_string_t *string_ptr = wlmcfg_string_create($1);
free($1);
bs_ptr_stack_push(&ctx_ptr->object_stack,
wlmcfg_object_from_string(string_ptr)); }
| TK_QUOTED_STRING {
size_t len = strlen($1);
BS_ASSERT(2 <= len); // It is supposed to be quoted.
$1[len - 1] = '\0';
wlmcfg_string_t *string_ptr = wlmcfg_string_create($1 + 1);
free($1);
bs_ptr_stack_push(&ctx_ptr->object_stack,
wlmcfg_object_from_string(string_ptr)); };
dict: TK_LBRACE {
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_create();
bs_ptr_stack_push(
&ctx_ptr->object_stack,
wlmcfg_object_from_dict(dict_ptr));
} kv_list TK_RBRACE;
kv_list: kv TK_SEMICOLON kv_list
| kv
| %empty;
kv: string TK_EQUAL object {
wlmcfg_object_t *object_ptr = bs_ptr_stack_pop(&ctx_ptr->object_stack);
wlmcfg_string_t *key_string_ptr = wlmcfg_string_from_object(
bs_ptr_stack_pop(&ctx_ptr->object_stack));
const char *key_ptr = wlmcfg_string_value(key_string_ptr);
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(
bs_ptr_stack_peek(&ctx_ptr->object_stack, 0));
bool rv = wlmcfg_dict_add(dict_ptr, key_ptr, object_ptr);
if (!rv) {
// TODO(kaeser@gubbe.ch): Keep this as error in context.
bs_log(BS_WARNING, "Failed wlmcfg_dict_add(%p, %s, %p)",
dict_ptr, key_ptr, object_ptr);
}
wlmcfg_object_unref(object_ptr);
wlmcfg_string_unref(key_string_ptr);
if (!rv) return -1; };
array: TK_LPAREN {
wlmcfg_array_t *array_ptr = wlmcfg_array_create();
bs_ptr_stack_push(
&ctx_ptr->object_stack,
wlmcfg_object_from_array(array_ptr));
} element_list TK_RPAREN;
element_list: element TK_COMMA element_list
| element
| %empty;
element: object {
wlmcfg_array_t *array_ptr = wlmcfg_array_from_object(
bs_ptr_stack_peek(&ctx_ptr->object_stack, 1));
wlmcfg_object_t *object_ptr = bs_ptr_stack_pop(&ctx_ptr->object_stack);
bool rv = wlmcfg_array_push_back(array_ptr, object_ptr);
if (!rv) {
// TODO(kaeser@gubbe.ch): Keep this as error in context.
bs_log(BS_WARNING, "Failed wlmcfg_array_push_back(%p, %p)",
array_ptr, object_ptr);
}
wlmcfg_object_unref(object_ptr);
};
%%
/* == Epilogue ============================================================= */
#include
int yyerror(
YYLTYPE *loc_ptr,
__UNUSED__ void* scanner,
__UNUSED__ wlmcfg_parser_context_t *ctx_ptr,
const char* msg_ptr)
{
bs_log(BS_ERROR, "Parse error at %d,%d: %s",
loc_ptr->first_line, loc_ptr->first_column,
msg_ptr);
return -1;
}
/* == End of grammar.y ===================================================== */
wlmaker-0.3/src/conf/model.c 0000664 0000000 0000000 00000043576 14641446446 0016032 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file model.c
*
* @copyright
* Copyright 2024 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.
*/
#include "model.h"
#include
/* == Declarations ========================================================= */
/** Base type of a config object. */
struct _wlmcfg_object_t {
/** Type of this object. */
wlmcfg_type_t type;
/** References held to this object. */
int references;
/** Abstract virtual method: Destroys the object. */
void (*destroy_fn)(wlmcfg_object_t *object_ptr);
};
/** Config object: A string. */
struct _wlmcfg_string_t {
/** The string's superclass: An object. */
wlmcfg_object_t super_object;
/** Value of the string. */
char *value_ptr;
};
/** Config object: A dict. */
struct _wlmcfg_dict_t {
/** The dict's superclass: An object. */
wlmcfg_object_t super_object;
/** Implemented as a tree. Benefit: Keeps sorting order. */
bs_avltree_t *tree_ptr;
};
/** An item in the dict. Internal class. */
typedef struct {
/** Node in the tree. */
bs_avltree_node_t avlnode;
/** The lookup key. */
char *key_ptr;
/** The value, is an object. */
wlmcfg_object_t *value_object_ptr;
} wlmcfg_dict_item_t;
/** Array object. A vector of pointers to the objects. */
struct _wlmcfg_array_t {
/** The array's superclass: An object. */
wlmcfg_object_t super_object;
/** Vector holding pointers to each object. */
bs_ptr_vector_t object_vector;
};
static bool _wlmcfg_object_init(
wlmcfg_object_t *object_ptr,
wlmcfg_type_t type,
void (*destroy_fn)(wlmcfg_object_t *object_ptr));
static void _wlmcfg_string_object_destroy(wlmcfg_object_t *object_ptr);
static void _wlmcfg_dict_object_destroy(wlmcfg_object_t *object_ptr);
static void _wlmcfg_array_object_destroy(wlmcfg_object_t *object_ptr);
static wlmcfg_dict_item_t *_wlmcfg_dict_item_create(
const char *key_ptr,
wlmcfg_object_t *object_ptr);
static void _wlmcfg_dict_item_destroy(
wlmcfg_dict_item_t *item_ptr);
static int _wlmcfg_dict_item_node_cmp(
const bs_avltree_node_t *node_ptr,
const void *key_ptr);
static void _wlmcfg_dict_item_node_destroy(
bs_avltree_node_t *node_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_object_ref(wlmcfg_object_t *object_ptr)
{
++object_ptr->references;
return object_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmcfg_object_unref(wlmcfg_object_t *object_ptr)
{
if (NULL == object_ptr) return;
// Check references. Warn on potential double-free.
BS_ASSERT(0 < object_ptr->references);
if (0 < --object_ptr->references) return;
object_ptr->destroy_fn(object_ptr);
}
/* ------------------------------------------------------------------------- */
wlmcfg_string_t *wlmcfg_string_create(const char *value_ptr)
{
BS_ASSERT(NULL != value_ptr);
wlmcfg_string_t *string_ptr = logged_calloc(1, sizeof(wlmcfg_string_t));
if (NULL == string_ptr) return NULL;
if (!_wlmcfg_object_init(&string_ptr->super_object,
WLMCFG_STRING,
_wlmcfg_string_object_destroy)) {
free(string_ptr);
return NULL;
}
string_ptr->value_ptr = logged_strdup(value_ptr);
if (NULL == string_ptr->value_ptr) {
_wlmcfg_string_object_destroy(wlmcfg_object_from_string(string_ptr));
return NULL;
}
return string_ptr;
}
/* ------------------------------------------------------------------------- */
const char *wlmcfg_string_value(const wlmcfg_string_t *string_ptr)
{
return string_ptr->value_ptr;
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_object_from_string(wlmcfg_string_t *string_ptr)
{
if (NULL == string_ptr) return NULL;
return &string_ptr->super_object;
}
/* ------------------------------------------------------------------------- */
wlmcfg_string_t *wlmcfg_string_from_object(wlmcfg_object_t *object_ptr)
{
if (NULL == object_ptr || WLMCFG_STRING != object_ptr->type) return NULL;
return BS_CONTAINER_OF(object_ptr, wlmcfg_string_t, super_object);
}
/* ------------------------------------------------------------------------- */
wlmcfg_dict_t *wlmcfg_dict_create(void)
{
wlmcfg_dict_t *dict_ptr = logged_calloc(1, sizeof(wlmcfg_dict_t));
if (NULL == dict_ptr) return NULL;
if (!_wlmcfg_object_init(&dict_ptr->super_object,
WLMCFG_DICT,
_wlmcfg_dict_object_destroy)) {
free(dict_ptr);
return NULL;
}
dict_ptr->tree_ptr = bs_avltree_create(
_wlmcfg_dict_item_node_cmp,
_wlmcfg_dict_item_node_destroy);
if (NULL == dict_ptr->tree_ptr) {
_wlmcfg_dict_object_destroy(wlmcfg_object_from_dict(dict_ptr));
return NULL;
}
return dict_ptr;
}
/* ------------------------------------------------------------------------- */
bool wlmcfg_dict_add(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr,
wlmcfg_object_t *object_ptr)
{
wlmcfg_dict_item_t *item_ptr = _wlmcfg_dict_item_create(
key_ptr, object_ptr);
if (NULL == item_ptr) return false;
bool rv = bs_avltree_insert(
dict_ptr->tree_ptr, item_ptr->key_ptr, &item_ptr->avlnode, false);
if (!rv) _wlmcfg_dict_item_destroy(item_ptr);
return rv;
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_dict_get(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr)
{
bs_avltree_node_t *node_ptr = bs_avltree_lookup(
dict_ptr->tree_ptr, key_ptr);
if (NULL == node_ptr) return NULL;
wlmcfg_dict_item_t *item_ptr = BS_CONTAINER_OF(
node_ptr, wlmcfg_dict_item_t, avlnode);
return item_ptr->value_object_ptr;
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_object_from_dict(wlmcfg_dict_t *dict_ptr)
{
if (NULL == dict_ptr) return NULL;
return &dict_ptr->super_object;
}
/* ------------------------------------------------------------------------- */
wlmcfg_dict_t *wlmcfg_dict_from_object(wlmcfg_object_t *object_ptr)
{
if (NULL == object_ptr || WLMCFG_DICT != object_ptr->type) return NULL;
return BS_CONTAINER_OF(object_ptr, wlmcfg_dict_t, super_object);
}
/* ------------------------------------------------------------------------- */
bool wlmcfg_dict_foreach(
wlmcfg_dict_t *dict_ptr,
bool (*fn)(const char *key_ptr,
wlmcfg_object_t *object_ptr,
void *userdata_ptr),
void *userdata_ptr)
{
for (bs_avltree_node_t *node_ptr = bs_avltree_min(dict_ptr->tree_ptr);
NULL != node_ptr;
node_ptr = bs_avltree_node_next(dict_ptr->tree_ptr, node_ptr)) {
wlmcfg_dict_item_t *item_ptr = BS_CONTAINER_OF(
node_ptr, wlmcfg_dict_item_t, avlnode);
if (!fn(item_ptr->key_ptr, item_ptr->value_object_ptr, userdata_ptr)) {
return false;
}
}
return true;
}
/* == Array methods ======================================================== */
/* ------------------------------------------------------------------------- */
wlmcfg_array_t *wlmcfg_array_create(void)
{
wlmcfg_array_t *array_ptr = logged_calloc(1, sizeof(wlmcfg_array_t));
if (NULL == array_ptr) return NULL;
if (!_wlmcfg_object_init(&array_ptr->super_object,
WLMCFG_ARRAY,
_wlmcfg_array_object_destroy)) {
free(array_ptr);
return NULL;
}
if (!bs_ptr_vector_init(&array_ptr->object_vector)) {
_wlmcfg_array_object_destroy(wlmcfg_object_from_array(array_ptr));
return NULL;
}
return array_ptr;
}
/* ------------------------------------------------------------------------- */
bool wlmcfg_array_push_back(
wlmcfg_array_t *array_ptr,
wlmcfg_object_t *object_ptr)
{
wlmcfg_object_t *new_object_ptr = wlmcfg_object_ref(object_ptr);
if (NULL == new_object_ptr) return false;
return bs_ptr_vector_push_back(&array_ptr->object_vector, new_object_ptr);
}
/* ------------------------------------------------------------------------- */
size_t wlmcfg_array_size(wlmcfg_array_t *array_ptr)
{
return bs_ptr_vector_size(&array_ptr->object_vector);
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_array_at(
wlmcfg_array_t *array_ptr,
size_t index)
{
return bs_ptr_vector_at(&array_ptr->object_vector, index);
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_object_from_array(wlmcfg_array_t *array_ptr)
{
if (NULL == array_ptr) return NULL;
return &array_ptr->super_object;
}
/* ------------------------------------------------------------------------- */
wlmcfg_array_t *wlmcfg_array_from_object(wlmcfg_object_t *object_ptr)
{
if (NULL == object_ptr || WLMCFG_ARRAY != object_ptr->type) return NULL;
return BS_CONTAINER_OF(object_ptr, wlmcfg_array_t, super_object);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Initializes the object base class.
*
* @param object_ptr
* @param type
* @param destroy_fn
*
* @return true on success.
*/
bool _wlmcfg_object_init(
wlmcfg_object_t *object_ptr,
wlmcfg_type_t type,
void (*destroy_fn)(wlmcfg_object_t *object_ptr))
{
BS_ASSERT(NULL != object_ptr);
BS_ASSERT(NULL != destroy_fn);
object_ptr->type = type;
object_ptr->destroy_fn = destroy_fn;
object_ptr->references = 1;
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of @ref wlmcfg_object_t::destroy_fn. Destroys the string.
*
* @param object_ptr
*/
void _wlmcfg_string_object_destroy(wlmcfg_object_t *object_ptr)
{
wlmcfg_string_t *string_ptr = BS_ASSERT_NOTNULL(
wlmcfg_string_from_object(object_ptr));
if (NULL != string_ptr->value_ptr) {
free(string_ptr->value_ptr);
string_ptr->value_ptr = NULL;
}
free(string_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of @ref wlmcfg_object_t::destroy_fn. Destroys the dict,
* including all contained elements.
*
* @param object_ptr
*/
void _wlmcfg_dict_object_destroy(wlmcfg_object_t *object_ptr)
{
wlmcfg_dict_t *dict_ptr = BS_ASSERT_NOTNULL(
wlmcfg_dict_from_object(object_ptr));
if (NULL != dict_ptr->tree_ptr) {
bs_avltree_destroy(dict_ptr->tree_ptr);
dict_ptr->tree_ptr = NULL;
}
free(dict_ptr);
}
/* ------------------------------------------------------------------------- */
/** Ctor: Creates a dict item. Copies the key, and duplicates the object. */
wlmcfg_dict_item_t *_wlmcfg_dict_item_create(
const char *key_ptr,
wlmcfg_object_t *object_ptr)
{
wlmcfg_dict_item_t *item_ptr = logged_calloc(
1, sizeof(wlmcfg_dict_item_t));
if (NULL == item_ptr) return NULL;
item_ptr->key_ptr = logged_strdup(key_ptr);
if (NULL == item_ptr->key_ptr) {
_wlmcfg_dict_item_destroy(item_ptr);
return NULL;
}
item_ptr->value_object_ptr = wlmcfg_object_ref(object_ptr);
if (NULL == item_ptr->value_object_ptr) {
_wlmcfg_dict_item_destroy(item_ptr);
return NULL;
}
return item_ptr;
}
/* ------------------------------------------------------------------------- */
/** Dtor: Destroys the dict item. */
void _wlmcfg_dict_item_destroy(wlmcfg_dict_item_t *item_ptr)
{
if (NULL != item_ptr->value_object_ptr) {
wlmcfg_object_unref(item_ptr->value_object_ptr);
item_ptr->value_object_ptr = NULL;
}
if (NULL != item_ptr->key_ptr) {
free(item_ptr->key_ptr);
item_ptr->key_ptr = NULL;
}
free(item_ptr);
}
/* ------------------------------------------------------------------------- */
/** Comparator for the dictionary item with another key. */
int _wlmcfg_dict_item_node_cmp(const bs_avltree_node_t *node_ptr,
const void *key_ptr)
{
wlmcfg_dict_item_t *item_ptr = BS_CONTAINER_OF(
node_ptr, wlmcfg_dict_item_t, avlnode);
return strcmp(item_ptr->key_ptr, key_ptr);
}
/* ------------------------------------------------------------------------- */
/** Destroy dict item by avlnode. Forward to @ref _wlmcfg_dict_item_destroy. */
void _wlmcfg_dict_item_node_destroy(bs_avltree_node_t *node_ptr)
{
wlmcfg_dict_item_t *item_ptr = BS_CONTAINER_OF(
node_ptr, wlmcfg_dict_item_t, avlnode);
_wlmcfg_dict_item_destroy(item_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of @ref wlmcfg_object_t::destroy_fn. Destroys the array,
* including all contained elements.
*
* @param object_ptr
*/
void _wlmcfg_array_object_destroy(wlmcfg_object_t *object_ptr)
{
wlmcfg_array_t *array_ptr = BS_ASSERT_NOTNULL(
wlmcfg_array_from_object(object_ptr));
while (0 < bs_ptr_vector_size(&array_ptr->object_vector)) {
wlmcfg_object_t *object_ptr = bs_ptr_vector_at(
&array_ptr->object_vector,
bs_ptr_vector_size(&array_ptr->object_vector) - 1);
bs_ptr_vector_erase(
&array_ptr->object_vector,
bs_ptr_vector_size(&array_ptr->object_vector) - 1);
wlmcfg_object_unref(object_ptr);
}
bs_ptr_vector_fini(&array_ptr->object_vector);
free(array_ptr);
}
/* == Unit tests =========================================================== */
static void test_string(bs_test_t *test_ptr);
static void test_dict(bs_test_t *test_ptr);
static void test_array(bs_test_t *test_ptr);
const bs_test_case_t wlmcfg_model_test_cases[] = {
{ 1, "string", test_string },
{ 1, "dict", test_dict },
{ 1, "array", test_array },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Test helper: A callback for @ref wlmcfg_dict_foreach. */
static bool foreach_callback(
const char *key_ptr,
__UNUSED__ wlmcfg_object_t *object_ptr,
void *userdata_ptr)
{
int *map = userdata_ptr;
if (strcmp(key_ptr, "key0") == 0) {
*map |= 1;
} else if (strcmp(key_ptr, "key1") == 0) {
*map |= 2;
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Tests the wlmcfg_string_t methods. */
void test_string(bs_test_t *test_ptr)
{
wlmcfg_string_t *string_ptr;
string_ptr = wlmcfg_string_create("a test");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, string_ptr);
BS_TEST_VERIFY_STREQ(test_ptr, "a test", string_ptr->value_ptr);
wlmcfg_object_t *object_ptr = wlmcfg_object_from_string(string_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
string_ptr,
wlmcfg_string_from_object(object_ptr));
wlmcfg_object_unref(object_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests the wlmcfg_dict_t methods. */
void test_dict(bs_test_t *test_ptr)
{
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_create();
wlmcfg_object_t *obj0_ptr = BS_ASSERT_NOTNULL(
wlmcfg_object_from_string(wlmcfg_string_create("val0")));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_dict_add(dict_ptr, "key0", obj0_ptr));
wlmcfg_object_unref(obj0_ptr);
wlmcfg_object_t *obj1_ptr = BS_ASSERT_NOTNULL(
wlmcfg_object_from_string(wlmcfg_string_create("val1")));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmcfg_dict_add(dict_ptr, "key0", obj1_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_dict_add(dict_ptr, "key1", obj1_ptr));
wlmcfg_object_unref(obj1_ptr);
BS_TEST_VERIFY_STREQ(
test_ptr,
"val0",
wlmcfg_string_value(wlmcfg_string_from_object(
wlmcfg_dict_get(dict_ptr, "key0"))));
BS_TEST_VERIFY_STREQ(
test_ptr,
"val1",
wlmcfg_string_value(wlmcfg_string_from_object(
wlmcfg_dict_get(dict_ptr, "key1"))));
int val = 0;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_dict_foreach(dict_ptr, foreach_callback, &val));
BS_TEST_VERIFY_EQ(test_ptr, 3, val);
wlmcfg_dict_unref(dict_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests the wlmcfg_array_t methods. */
void test_array(bs_test_t *test_ptr)
{
wlmcfg_array_t *array_ptr = wlmcfg_array_create();
wlmcfg_object_t *obj0_ptr = BS_ASSERT_NOTNULL(
wlmcfg_object_from_string(wlmcfg_string_create("val0")));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_array_push_back(array_ptr, obj0_ptr));
wlmcfg_object_unref(obj0_ptr);
wlmcfg_object_t *obj1_ptr = BS_ASSERT_NOTNULL(
wlmcfg_object_from_string(wlmcfg_string_create("val1")));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_array_push_back(array_ptr, obj1_ptr));
wlmcfg_object_unref(obj1_ptr);
BS_TEST_VERIFY_EQ(test_ptr, obj0_ptr, wlmcfg_array_at(array_ptr, 0));
BS_TEST_VERIFY_EQ(test_ptr, obj1_ptr, wlmcfg_array_at(array_ptr, 1));
wlmcfg_array_unref(array_ptr);
}
/* == End of model.c ======================================================= */
wlmaker-0.3/src/conf/model.h 0000664 0000000 0000000 00000016301 14641446446 0016021 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file model.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMCFG_MODEL_H__
#define __WLMCFG_MODEL_H__
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Base object type. */
typedef struct _wlmcfg_object_t wlmcfg_object_t;
/** Forward declaration: A string. */
typedef struct _wlmcfg_string_t wlmcfg_string_t;
/** Forward declaration: A dict (key/value store for objects). */
typedef struct _wlmcfg_dict_t wlmcfg_dict_t;
/** Forward declaration: An array (sequential store for objects). */
typedef struct _wlmcfg_array_t wlmcfg_array_t;
/** Type of the object. */
typedef enum {
WLMCFG_STRING,
WLMCFG_DICT,
WLMCFG_ARRAY
} wlmcfg_type_t;
/**
* Gets a reference to the object. Increases the reference count.
*
* The reference should be released by calling @ref wlmcfg_object_unref.
*
* @param object_ptr
*
* @return Same as "object_ptr".
*/
wlmcfg_object_t *wlmcfg_object_ref(wlmcfg_object_t *object_ptr);
/**
* Removes reference to the object.
*
* Once no more references are pending, will call all into the virtual dtor of
* the implementation.
*
* @param object_ptr
*/
void wlmcfg_object_unref(wlmcfg_object_t *object_ptr);
/**
* Creates a string object.
*
* @param value_ptr
*
* @return The string object, or NULL on error.
*/
wlmcfg_string_t *wlmcfg_string_create(const char *value_ptr);
/** Gets the superclass @ref wlmcfg_object_t from the string. */
wlmcfg_object_t *wlmcfg_object_from_string(wlmcfg_string_t *string_ptr);
/** Gets the @ref wlmcfg_string_t for `object_ptr`. NULL if not a string. */
wlmcfg_string_t *wlmcfg_string_from_object(wlmcfg_object_t *object_ptr);
/**
* Returns the value of the string.
*
* @param string_ptr
*
* @return Pointer to the string's value.
*/
const char *wlmcfg_string_value(const wlmcfg_string_t *string_ptr);
/**
* Creates a dict object.
*
* @return The dict object, or NULL on error.
*/
wlmcfg_dict_t *wlmcfg_dict_create(void);
/** @return the superclass @ref wlmcfg_object_t of the dict. */
wlmcfg_object_t *wlmcfg_object_from_dict(wlmcfg_dict_t *dict_ptr);
/** @return the @ref wlmcfg_dict_t for `object_ptr`. NULL if not a dict. */
wlmcfg_dict_t *wlmcfg_dict_from_object(wlmcfg_object_t *object_ptr);
/**
* Adds an object to the dict.
*
* @param dict_ptr
* @param key_ptr
* @param object_ptr The object to add. It will be duplicated by
* calling @ref wlmcfg_object_ref.
*
* @return true on success. Adding the object can fail if the key already
* exists, or if memory could not get allocated.
*/
bool wlmcfg_dict_add(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr,
wlmcfg_object_t *object_ptr);
/** @return the given object from the dict. */
wlmcfg_object_t *wlmcfg_dict_get(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr);
/**
* Executes `fn` for each key and object of the dict.
*
* @param dict_ptr
* @param fn
* @param userdata_ptr
*
* @return true if all calls to `fn` returned true. The iteration will be
* aborted on the first failed call to `fn`.
*/
bool wlmcfg_dict_foreach(
wlmcfg_dict_t *dict_ptr,
bool (*fn)(const char *key_ptr,
wlmcfg_object_t *object_ptr,
void *userdata_ptr),
void *userdata_ptr);
/**
* Creates an array object.
*
* @return The array object, or NULL on error.
*/
wlmcfg_array_t *wlmcfg_array_create(void);
/** @return the superclass @ref wlmcfg_object_t of the array. */
wlmcfg_object_t *wlmcfg_object_from_array(wlmcfg_array_t *array_ptr);
/** @return the @ref wlmcfg_array_t for `object_ptr`. NULL if not an array. */
wlmcfg_array_t *wlmcfg_array_from_object(wlmcfg_object_t *object_ptr);
/**
* Adds an object to the end of the array.
*
* @param array_ptr
* @param object_ptr
*
* @return true on success. Adding the object can fail if the array does not
* have space and fails to grow.
*/
bool wlmcfg_array_push_back(
wlmcfg_array_t *array_ptr,
wlmcfg_object_t *object_ptr);
/** @return Size of the array, ie. the number of contained objects. */
size_t wlmcfg_array_size(wlmcfg_array_t *array_ptr);
/**
* Returns the object at the position `index` of the array.
*
* @param array_ptr
* @param index
*
* @return Pointer to the object at the specified position in the array.
* Returns NULL if index is out of bounds.
*/
wlmcfg_object_t *wlmcfg_array_at(
wlmcfg_array_t *array_ptr,
size_t index);
/* -- Static & inlined methods: Convenience wrappers ----------------------- */
/** Unreferences the string. Wraps to @ref wlmcfg_object_unref. */
static inline void wlmcfg_string_unref(wlmcfg_string_t *string_ptr)
{
wlmcfg_object_unref(wlmcfg_object_from_string(string_ptr));
}
/** Gets a reference to `dict_ptr`. */
static inline wlmcfg_dict_t *wlmcfg_dict_ref(wlmcfg_dict_t *dict_ptr) {
return wlmcfg_dict_from_object(
wlmcfg_object_ref(wlmcfg_object_from_dict(dict_ptr)));
}
/** Unreferences the dict. Wraps to @ref wlmcfg_object_unref. */
static inline void wlmcfg_dict_unref(wlmcfg_dict_t *dict_ptr) {
wlmcfg_object_unref(wlmcfg_object_from_dict(dict_ptr));
}
/** @return the dict value of the specified object, or NULL on error. */
static inline wlmcfg_dict_t *wlmcfg_dict_get_dict(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr) {
return wlmcfg_dict_from_object(wlmcfg_dict_get(dict_ptr, key_ptr));
}
/** @return the array value of the specified object, or NULL on error. */
static inline wlmcfg_array_t *wlmcfg_dict_get_array(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr) {
return wlmcfg_array_from_object(wlmcfg_dict_get(dict_ptr, key_ptr));
}
/** @return the string value of the specified object, or NULL on error. */
static inline const char *wlmcfg_dict_get_string_value(
wlmcfg_dict_t *dict_ptr,
const char *key_ptr) {
return wlmcfg_string_value(
wlmcfg_string_from_object(wlmcfg_dict_get(dict_ptr, key_ptr)));
}
/** Unreferences the array. Wraps to @ref wlmcfg_object_unref. */
static inline void wlmcfg_array_unref(wlmcfg_array_t *array_ptr) {
wlmcfg_object_unref(wlmcfg_object_from_array(array_ptr));
}
/** @return the value of the string object at `idx`, or NULL on error. */
static inline const char *wlmcfg_array_string_value_at(
wlmcfg_array_t *array_ptr, size_t idx) {
return wlmcfg_string_value(
wlmcfg_string_from_object(wlmcfg_array_at(array_ptr, idx)));
}
/** Unit tests for the config data model. */
extern const bs_test_case_t wlmcfg_model_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMCFG_MODEL_H__ */
/* == End of model.h ================================================== */
wlmaker-0.3/src/conf/parser.h 0000664 0000000 0000000 00000002277 14641446446 0016224 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file parser.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMCFG_PARSER_H__
#define __WLMCFG_PARSER_H__
#include "model.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Context for parser, to be used in the grammar file. */
typedef struct {
/** Stack of objects, used throughout parsing. */
bs_ptr_stack_t object_stack;
} wlmcfg_parser_context_t;
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMCFG_PARSER_H__ */
/* == End of parser.h ====================================================== */
wlmaker-0.3/src/conf/plist.c 0000664 0000000 0000000 00000022573 14641446446 0016057 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file plist.c
*
* @copyright
* Copyright 2024 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.
*/
#include "plist.h"
#include "grammar.h"
#include "analyzer.h"
#include "parser.h"
/* == Declarations ========================================================= */
static wlmcfg_object_t *_wlmcfg_create_object_from_plist_scanner(
yyscan_t scanner);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_create_object_from_plist_string(const char *buf_ptr)
{
yyscan_t scanner;
yylex_init(&scanner);
YY_BUFFER_STATE buf_state;
buf_state = yy_scan_string(buf_ptr, scanner);
yy_switch_to_buffer(buf_state, scanner);
wlmcfg_object_t *obj = _wlmcfg_create_object_from_plist_scanner(scanner);
yy_delete_buffer(buf_state, scanner);
yylex_destroy(scanner);
return obj;
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_create_object_from_plist_data(
const uint8_t *data_ptr, size_t data_size)
{
yyscan_t scanner;
yylex_init(&scanner);
YY_BUFFER_STATE buf_state;
buf_state = yy_scan_bytes((const char*)data_ptr, data_size, scanner);
yy_switch_to_buffer(buf_state, scanner);
wlmcfg_object_t *obj = _wlmcfg_create_object_from_plist_scanner(scanner);
yy_delete_buffer(buf_state, scanner);
yylex_destroy(scanner);
return obj;
}
/* ------------------------------------------------------------------------- */
wlmcfg_object_t *wlmcfg_create_object_from_plist_file(const char *fname_ptr)
{
FILE *file_ptr = fopen(fname_ptr, "r");
if (NULL == file_ptr) {
bs_log(BS_ERROR | BS_ERRNO, "Failed fopen(%s, 'r')", fname_ptr);
return NULL;
}
yyscan_t scanner;
yylex_init(&scanner);
YY_BUFFER_STATE buf_state;
buf_state = yy_create_buffer(file_ptr, YY_BUF_SIZE, scanner);
yy_switch_to_buffer(buf_state, scanner);
wlmcfg_object_t *obj = _wlmcfg_create_object_from_plist_scanner(scanner);
yy_delete_buffer(buf_state, scanner);
yylex_destroy(scanner);
fclose(file_ptr);
return obj;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Does a parser run, from the initialized scanner. */
wlmcfg_object_t *_wlmcfg_create_object_from_plist_scanner(yyscan_t scanner)
{
wlmcfg_parser_context_t ctx = {};
if (!bs_ptr_stack_init(&ctx.object_stack)) return NULL;
// TODO(kaeser@gubbe.ch): Clean up stack on error!
yyset_extra(&ctx, scanner);
int rv = yyparse(scanner, &ctx);
wlmcfg_object_t *object_ptr = bs_ptr_stack_pop(&ctx.object_stack);
bs_ptr_stack_fini(&ctx.object_stack);
if (0 != rv) {
wlmcfg_object_unref(object_ptr);
object_ptr = NULL;
}
return object_ptr;
}
/* == Unit tests =========================================================== */
static void test_from_string(bs_test_t *test_ptr);
static void test_from_file(bs_test_t *test_ptr);
static void test_from_data(bs_test_t *test_ptr);
const bs_test_case_t wlmcfg_plist_test_cases[] = {
{ 1, "from_string", test_from_string },
{ 1, "from_file", test_from_file },
{ 1, "from_data", test_from_data },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests plist object creation from string. */
void test_from_string(bs_test_t *test_ptr)
{
wlmcfg_object_t *object_ptr, *v_ptr;
wlmcfg_array_t *array_ptr;
wlmcfg_dict_t *dict_ptr;
// A string.
object_ptr = wlmcfg_create_object_from_plist_string("value");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_STREQ(
test_ptr,
"value",
wlmcfg_string_value(wlmcfg_string_from_object(object_ptr)));
wlmcfg_object_unref(object_ptr);
// A string that should be quoted.
object_ptr = wlmcfg_create_object_from_plist_string("va:lue");
BS_TEST_VERIFY_EQ(test_ptr, NULL, object_ptr);
// A dict.
object_ptr = wlmcfg_create_object_from_plist_string(
"{key1=dict_value1;key2=dict_value2}");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
dict_ptr = wlmcfg_dict_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
v_ptr = wlmcfg_dict_get(dict_ptr, "key1");
BS_TEST_VERIFY_STREQ(
test_ptr,
"dict_value1",
wlmcfg_string_value(wlmcfg_string_from_object(v_ptr)));
v_ptr = wlmcfg_dict_get(dict_ptr, "key2");
BS_TEST_VERIFY_STREQ(
test_ptr,
"dict_value2",
wlmcfg_string_value(wlmcfg_string_from_object(v_ptr)));
wlmcfg_object_unref(object_ptr);
// A dict, with semicolon at the end.
object_ptr = wlmcfg_create_object_from_plist_string(
"{key1=dict_value1;key2=dict_value2;}");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlmcfg_dict_from_object(object_ptr));
wlmcfg_object_unref(object_ptr);
// A dict with a duplicate key. Will return NULL, no need to unref.
object_ptr = wlmcfg_create_object_from_plist_string(
"{key1=dict_value1;key1=dict_value2}");
BS_TEST_VERIFY_EQ(test_ptr, NULL, object_ptr);
// An empty dict.
object_ptr = wlmcfg_create_object_from_plist_string("{}");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
wlmcfg_object_unref(object_ptr);
// An array.
object_ptr = wlmcfg_create_object_from_plist_string(
"(elem0,elem1)");
array_ptr = wlmcfg_array_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, array_ptr);
if (NULL != array_ptr) {
BS_TEST_VERIFY_STREQ(
test_ptr,
"elem0",
wlmcfg_string_value(wlmcfg_string_from_object(
wlmcfg_array_at(array_ptr, 0))));
BS_TEST_VERIFY_STREQ(
test_ptr,
"elem1",
wlmcfg_string_value(wlmcfg_string_from_object(
wlmcfg_array_at(array_ptr, 1))));
}
wlmcfg_object_unref(object_ptr);
// An array with a comma at the end.
object_ptr = wlmcfg_create_object_from_plist_string(
"(elem0,elem1,)");
array_ptr = wlmcfg_array_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, array_ptr);
wlmcfg_object_unref(object_ptr);
// An empty array.
object_ptr = wlmcfg_create_object_from_plist_string("()");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
array_ptr = wlmcfg_array_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, array_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmcfg_array_size(array_ptr));
wlmcfg_object_unref(object_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests plist object creation from string. */
void test_from_file(bs_test_t *test_ptr)
{
wlmcfg_object_t *object_ptr, *v_ptr;
object_ptr = wlmcfg_create_object_from_plist_file(
bs_test_resolve_path("conf/string.plist"));
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_STREQ(
test_ptr,
"file_value",
wlmcfg_string_value(wlmcfg_string_from_object(object_ptr)));
wlmcfg_object_unref(object_ptr);
object_ptr = wlmcfg_create_object_from_plist_file(
bs_test_resolve_path("conf/dict.plist"));
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
v_ptr = BS_ASSERT_NOTNULL(wlmcfg_dict_get(dict_ptr, "key0"));
BS_TEST_VERIFY_STREQ(
test_ptr,
"value0",
wlmcfg_string_value(wlmcfg_string_from_object(v_ptr)));
v_ptr = BS_ASSERT_NOTNULL(wlmcfg_dict_get(dict_ptr, "quoted+key"));
BS_TEST_VERIFY_STREQ(
test_ptr,
"value",
wlmcfg_string_value(wlmcfg_string_from_object(v_ptr)));
wlmcfg_object_unref(object_ptr);
object_ptr = wlmcfg_create_object_from_plist_file(
bs_test_resolve_path("conf/array.plist"));
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
wlmcfg_array_t *array_ptr = wlmcfg_array_from_object(object_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, array_ptr);
wlmcfg_object_unref(object_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests plist object creation from a sized data buffer. */
void test_from_data(bs_test_t *test_ptr)
{
const uint8_t data[] = { 'v', 'a', 'l', 'u', 'e' };
// A string.
wlmcfg_object_t *object_ptr = wlmcfg_create_object_from_plist_data(
data, sizeof(data));
BS_TEST_VERIFY_NEQ(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_STREQ(
test_ptr,
"value",
wlmcfg_string_value(wlmcfg_string_from_object(object_ptr)));
wlmcfg_object_unref(object_ptr);
}
/* == End of plist.c ======================================================= */
wlmaker-0.3/src/conf/plist.h 0000664 0000000 0000000 00000003604 14641446446 0016056 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file plist.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMCFG_PLIST_H__
#define __WLMCFG_PLIST_H__
#include
#include "model.h"
#include "decode.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Parses the plist string `buf_ptr` and returns the de-serialized object.
*
* @param buf_ptr
*
* @return The de-serialized object, or NULL on error.
*/
wlmcfg_object_t *wlmcfg_create_object_from_plist_string(const char *buf_ptr);
/**
* Parses the plist data with given size and returns the de-serialized object.
*
* @param data_ptr
* @param data_size
*
* @return The de-serialized object, or NULL on error.
*/
wlmcfg_object_t *wlmcfg_create_object_from_plist_data(
const uint8_t *data_ptr, size_t data_size);
/**
* Parses the file `fname_ptr` and returns the de-serialized object.
*
* @param fname_ptr
*
* @return The de-serialized object, or NULL on error.
*/
wlmcfg_object_t *wlmcfg_create_object_from_plist_file(const char *fname_ptr);
/** Unit tests for the plist parser. */
extern const bs_test_case_t wlmcfg_plist_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMCFG_PLIST_H__ */
/* == End of plist.h ======================================================= */
wlmaker-0.3/src/config.c 0000664 0000000 0000000 00000053441 14641446446 0015242 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file config.c
*
* @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.
*
* Configurables for wlmaker. Currently, this file lists hardcoded entities,
* and mainly serves as a catalog about which entities should be dynamically
* configurable.
*/
#include "config.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
#include "default_configuration.h"
#include "default_state.h"
#include "style_default.h"
/* == Declarations ========================================================= */
static wlmcfg_dict_t *_wlmaker_config_from_plist(const char *fname_ptr);
static bool _wlmaker_config_decode_fill_style(
wlmcfg_object_t *object_ptr,
void *dest_ptr);
/* == Data ================================================================= */
/** Name of the xcursor theme. NULL picks the default. */
const char *config_xcursor_theme_name = NULL;
/** Base size for the xcursor theme (when scale==1.0). */
const uint32_t config_xcursor_theme_size = 24;
/** Overall scale of output. */
const float config_output_scale = 1.0;
/** Whether to always request server-side decorations. */
const wlmaker_config_decoration_t config_decoration =
WLMAKER_CONFIG_DECORATION_SUGGEST_SERVER;
/** Modifiers for moving the window with the cursor. */
const uint32_t wlmaker_config_window_drag_modifiers =
WLR_MODIFIER_ALT | WLR_MODIFIER_LOGO;
/** Visual theme. */
const wlmaker_config_theme_t wlmaker_config_theme = {
.window_margin_color = 0xff000000, // Pich black, opaque.
.window_margin_width = 1,
.tile_fill = {
.type = WLMTK_STYLE_COLOR_DGRADIENT,
.param = { .hgradient = { .from = 0xffa6a6b6,.to = 0xff515561 }}
},
.menu_fill = {
.type = WLMTK_STYLE_COLOR_HGRADIENT,
.param = { .hgradient = { .from = 0xffc2c0c5, .to = 0xff828085 }}
},
.menu_margin_color = 0xff000000, // Pitch black, opaque.
.menu_margin_width = 1,
.menu_padding_width = 1,
.menu_item_enabled_fill = {
.type = WLMTK_STYLE_COLOR_SOLID,
.param = { .solid = { .color = 0x00000000 }} // Transparent.
},
.menu_item_enabled_text_color = 0xff000000, // Black, opaque.
.menu_item_selected_fill = {
.type = WLMTK_STYLE_COLOR_SOLID,
.param = { .solid = { .color = 0xffffffff }} // White, opaque..
},
.menu_item_selected_text_color = 0xff000000, // Black, opaque.
};
/** Plist decoding descriptor of the fill type. */
static const wlmcfg_enum_desc_t _wlmaker_config_fill_type_desc[] = {
WLMCFG_ENUM("SOLID", WLMTK_STYLE_COLOR_SOLID),
WLMCFG_ENUM("HGRADIENT", WLMTK_STYLE_COLOR_HGRADIENT),
WLMCFG_ENUM("DGRADIENT", WLMTK_STYLE_COLOR_DGRADIENT),
WLMCFG_ENUM_SENTINEL()
};
/** Plist decoding descriptor for font weight. */
static const wlmcfg_enum_desc_t _wlmaker_config_font_weight_desc[] = {
WLMCFG_ENUM("Normal", WLMTK_FONT_WEIGHT_NORMAL),
WLMCFG_ENUM("Bold", WLMTK_FONT_WEIGHT_BOLD),
WLMCFG_ENUM_SENTINEL()
};
/** Plist decoding descriptor of the fill style. */
static const wlmcfg_desc_t _wlmaker_config_fill_style_desc[] = {
WLMCFG_DESC_ENUM("Type", true, wlmtk_style_fill_t, type,
WLMTK_STYLE_COLOR_SOLID,
_wlmaker_config_fill_type_desc),
WLMCFG_DESC_SENTINEL()
};
/** Plist decoding descriptor of the solid color. */
static const wlmcfg_desc_t _wlmaker_config_style_color_solid_desc[] = {
WLMCFG_DESC_ARGB32(
"Color", true, wlmtk_style_color_solid_data_t, color, 0),
WLMCFG_DESC_SENTINEL()
};
/** Plist decoding descriptor of a color gradient. */
static const wlmcfg_desc_t _wlmaker_config_style_color_gradient_desc[] = {
WLMCFG_DESC_ARGB32(
"From", true, wlmtk_style_color_gradient_data_t, from, 0),
WLMCFG_DESC_ARGB32(
"To", true, wlmtk_style_color_gradient_data_t, to, 0),
WLMCFG_DESC_SENTINEL()
};
/** Plist decoding descriptor of a tile style. */
static const wlmcfg_desc_t _wlmaker_config_tile_style_desc[] = {
WLMCFG_DESC_UINT64(
"Size", true, wlmtk_tile_style_t, size, 64),
WLMCFG_DESC_UINT64(
"BezelWidth", true, wlmtk_tile_style_t, bezel_width, 2),
WLMCFG_DESC_CUSTOM(
"Fill", true, wlmtk_tile_style_t, fill,
_wlmaker_config_decode_fill_style, NULL, NULL),
WLMCFG_DESC_SENTINEL()
};
/** Plist decoding descriptor of a margin's style. */
static const wlmcfg_desc_t _wlmaker_config_margin_style_desc[] = {
WLMCFG_DESC_UINT64(
"Width", true, wlmtk_margin_style_t, width, 0),
WLMCFG_DESC_ARGB32(
"Color", true, wlmtk_margin_style_t, color, 0xff000000),
WLMCFG_DESC_SENTINEL()
};
/** Plist decoding descriptor of the dock's style. */
static const wlmcfg_desc_t _wlmaker_config_dock_style_desc[] = {
WLMCFG_DESC_DICT(
"Margin", true, wlmtk_dock_style_t, margin,
_wlmaker_config_margin_style_desc),
WLMCFG_DESC_SENTINEL()
};
/** Descriptor for decoding "Font" sections. */
static const wlmcfg_desc_t _wlmaker_config_font_style_desc[] = {
WLMCFG_DESC_CHARBUF(
"Face", true, wlmtk_style_font_t, face,
WLMTK_STYLE_FONT_FACE_LENGTH, NULL),
WLMCFG_DESC_ENUM(
"Weight", true, wlmtk_style_font_t, weight,
WLMTK_FONT_WEIGHT_NORMAL, _wlmaker_config_font_weight_desc),
WLMCFG_DESC_UINT64(
"Size", true, wlmtk_style_font_t, size, 10),
WLMCFG_DESC_SENTINEL()
};
/** Descroptor for decoding the "TitleBar" dict below "Window". */
static const wlmcfg_desc_t _wlmaker_config_window_titlebar_style_desc[] = {
WLMCFG_DESC_CUSTOM(
"FocussedFill", true, wlmtk_titlebar_style_t, focussed_fill,
_wlmaker_config_decode_fill_style, NULL, NULL),
WLMCFG_DESC_ARGB32(
"FocussedTextColor", true, wlmtk_titlebar_style_t,
focussed_text_color, 0),
WLMCFG_DESC_CUSTOM(
"BlurredFill", true, wlmtk_titlebar_style_t, blurred_fill,
_wlmaker_config_decode_fill_style, NULL, NULL),
WLMCFG_DESC_ARGB32(
"BlurredTextColor", true, wlmtk_titlebar_style_t,
blurred_text_color, 0),
WLMCFG_DESC_UINT64(
"Height", true, wlmtk_titlebar_style_t, height, 22),
WLMCFG_DESC_UINT64(
"BezelWidth", true, wlmtk_titlebar_style_t, bezel_width, 1),
WLMCFG_DESC_DICT(
"Margin", true, wlmtk_titlebar_style_t, margin,
_wlmaker_config_margin_style_desc),
WLMCFG_DESC_DICT(
"Font", true, wlmtk_titlebar_style_t, font,
_wlmaker_config_font_style_desc),
WLMCFG_DESC_SENTINEL()
};
/** Descroptor for decoding the "TitleBar" dict below "Window". */
static const wlmcfg_desc_t _wlmaker_config_window_resize_style_desc[] = {
WLMCFG_DESC_CUSTOM(
"Fill", true, wlmtk_resizebar_style_t, fill,
_wlmaker_config_decode_fill_style, NULL, NULL),
WLMCFG_DESC_UINT64(
"Height", true, wlmtk_resizebar_style_t, height, 7),
WLMCFG_DESC_UINT64(
"BezelWidth", true, wlmtk_resizebar_style_t, bezel_width, 1),
WLMCFG_DESC_UINT64(
"CornerWidth", true, wlmtk_resizebar_style_t, corner_width, 1),
WLMCFG_DESC_SENTINEL()
};
/** Descriptor for decoding the "Window" dictionary. */
static const wlmcfg_desc_t _wlmaker_config_window_style_desc[] = {
WLMCFG_DESC_DICT(
"TitleBar", true, wlmtk_window_style_t, titlebar,
_wlmaker_config_window_titlebar_style_desc),
WLMCFG_DESC_DICT(
"ResizeBar", true, wlmtk_window_style_t, resizebar,
_wlmaker_config_window_resize_style_desc),
WLMCFG_DESC_DICT(
"Border", true, wlmtk_window_style_t, border,
_wlmaker_config_margin_style_desc),
WLMCFG_DESC_DICT(
"Margin", true, wlmtk_window_style_t, margin,
_wlmaker_config_margin_style_desc),
WLMCFG_DESC_SENTINEL()
};
/** Descriptor for decoding the "TaskList" dictionary. */
static const wlmcfg_desc_t _wlmaker_task_list_style_desc[] = {
WLMCFG_DESC_CUSTOM(
"Fill", true, wlmaker_config_task_list_style_t, fill,
_wlmaker_config_decode_fill_style, NULL, NULL),
WLMCFG_DESC_DICT(
"Font", true, wlmaker_config_task_list_style_t, font,
_wlmaker_config_font_style_desc),
WLMCFG_DESC_ARGB32(
"TextColor", true, wlmaker_config_task_list_style_t,
text_color, 0),
WLMCFG_DESC_SENTINEL()
};
/** Descriptor for decoding the "Clip" dictionary. */
static const wlmcfg_desc_t _wlmaker_clip_style_desc[] = {
WLMCFG_DESC_DICT(
"Font", true, wlmaker_config_clip_style_t, font,
_wlmaker_config_font_style_desc),
WLMCFG_DESC_ARGB32(
"TextColor", true, wlmaker_config_clip_style_t,
text_color, 0),
WLMCFG_DESC_SENTINEL()
};
/** Desciptor for decoding the style information from a plist. */
const wlmcfg_desc_t wlmaker_config_style_desc[] = {
WLMCFG_DESC_ARGB32(
"BackgroundColor", true, wlmaker_config_style_t, background_color, 0),
WLMCFG_DESC_DICT(
"Tile", true, wlmaker_config_style_t, tile,
_wlmaker_config_tile_style_desc),
WLMCFG_DESC_DICT(
"Dock", true, wlmaker_config_style_t, dock,
_wlmaker_config_dock_style_desc),
WLMCFG_DESC_DICT(
"Window", true, wlmaker_config_style_t, window,
_wlmaker_config_window_style_desc),
WLMCFG_DESC_DICT(
"TaskList", true, wlmaker_config_style_t, task_list,
_wlmaker_task_list_style_desc),
WLMCFG_DESC_DICT(
"Clip", true, wlmaker_config_style_t, clip,
_wlmaker_clip_style_desc),
WLMCFG_DESC_SENTINEL()
};
/** Lookup paths for the configuration file. */
static const char *_wlmaker_config_fname_ptrs[] = {
"~/.wlmaker.plist",
NULL // Sentinel.
};
/** Lookup paths for the configuration file. */
static const char *_wlmaker_state_fname_ptrs[] = {
"~/.wlmaker-state.plist",
NULL // Sentinel.
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmcfg_dict_t *wlmaker_config_load(const char *fname_ptr)
{
// If a file was provided, we try only that.
if (NULL != fname_ptr) {
return _wlmaker_config_from_plist(fname_ptr);
}
for (const char **fname_ptr_ptr = _wlmaker_config_fname_ptrs;
*fname_ptr_ptr != NULL;
fname_ptr_ptr++) {
char full_path[PATH_MAX];
char *path_ptr = bs_file_resolve_path(*fname_ptr_ptr, full_path);
if (NULL == path_ptr) {
bs_log(BS_INFO | BS_ERRNO, "Failed bs_file_resolve_path(%s, %p)",
*fname_ptr_ptr, full_path);
continue;
}
// If we get here, there was a resolved item at the path. A load
// failure indicates an issue with an existing file, and we should
// fali here.
bs_log(BS_INFO, "Loading configuration from \"%s\"", *fname_ptr_ptr);
return _wlmaker_config_from_plist(*fname_ptr_ptr);
}
// Hardcoded configuration. Failing to load that is an error.
bs_log(BS_INFO, "No configuration file found, using embedded default.");
wlmcfg_object_t *obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_default_configuration_data,
embedded_binary_default_configuration_size);
return BS_ASSERT_NOTNULL(wlmcfg_dict_from_object(obj_ptr));
}
/* ------------------------------------------------------------------------- */
wlmcfg_dict_t *wlmaker_state_load(const char *fname_ptr)
{
// If a file was provided, we try only that.
if (NULL != fname_ptr) {
return _wlmaker_config_from_plist(fname_ptr);
}
for (const char **fname_ptr_ptr = _wlmaker_state_fname_ptrs;
*fname_ptr_ptr != NULL;
fname_ptr_ptr++) {
char full_path[PATH_MAX];
char *path_ptr = bs_file_resolve_path(*fname_ptr_ptr, full_path);
if (NULL == path_ptr) {
bs_log(BS_INFO | BS_ERRNO, "Failed bs_file_resolve_path(%s, %p)",
*fname_ptr_ptr, full_path);
continue;
}
// If we get here, there was a resolved item at the path. A load
// failure indicates an issue with an existing file, and we should
// fali here.
bs_log(BS_INFO, "Loading state from \"%s\"", *fname_ptr_ptr);
return _wlmaker_config_from_plist(*fname_ptr_ptr);
}
// Hardcoded configuration. Failing to load that is an error.
bs_log(BS_INFO, "No state file found, using embedded default.");
wlmcfg_object_t *obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_default_state_data,
embedded_binary_default_state_size);
return BS_ASSERT_NOTNULL(wlmcfg_dict_from_object(obj_ptr));
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Loads a plist dict from fname_ptr. Returns NULL on error. */
wlmcfg_dict_t *_wlmaker_config_from_plist(const char *fname_ptr)
{
wlmcfg_object_t *obj_ptr = wlmcfg_create_object_from_plist_file(fname_ptr);
if (NULL == obj_ptr) {
bs_log(BS_ERROR, "Failed wlmcfg_create_object_from_plist(%s)",
fname_ptr);
return NULL;
}
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(obj_ptr);
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "Not a plist dict in %s", fname_ptr);
wlmcfg_object_unref(obj_ptr);
return NULL;
}
return dict_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Custom decoder for fill style struct from a plist dict.
*
* @param object_ptr
* @param dest_ptr
*
* @return true on success.
*/
bool _wlmaker_config_decode_fill_style(
wlmcfg_object_t *object_ptr,
void *dest_ptr)
{
wlmtk_style_fill_t *fill_ptr = dest_ptr;
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(object_ptr);
if (NULL == dict_ptr) return false;
if (!wlmcfg_decode_dict(
dict_ptr,
_wlmaker_config_fill_style_desc,
fill_ptr)) return false;
switch (fill_ptr->type) {
case WLMTK_STYLE_COLOR_SOLID:
return wlmcfg_decode_dict(
dict_ptr,
_wlmaker_config_style_color_solid_desc,
&fill_ptr->param.solid);
case WLMTK_STYLE_COLOR_DGRADIENT:
return wlmcfg_decode_dict(
dict_ptr,
_wlmaker_config_style_color_gradient_desc,
&fill_ptr->param.dgradient);
case WLMTK_STYLE_COLOR_HGRADIENT:
return wlmcfg_decode_dict(
dict_ptr,
_wlmaker_config_style_color_gradient_desc,
&fill_ptr->param.hgradient);
default:
bs_log(BS_ERROR, "Unhandled fill type %d", fill_ptr->type);
return false;
}
bs_log(BS_FATAL, "Uh... no idea how this got here.");
return false;
}
/* == Unit tests =========================================================== */
static void test_embedded(bs_test_t *test_ptr);
static void test_file(bs_test_t *test_ptr);
static void test_style_file(bs_test_t *test_ptr);
static void test_decode_fill(bs_test_t *test_ptr);
static void test_decode_font(bs_test_t *test_ptr);
const bs_test_case_t wlmaker_config_test_cases[] = {
{ 1, "embedded", test_embedded },
{ 1, "file", test_file },
{ 1, "style_file", test_style_file },
{ 1, "decode_fill", test_decode_fill },
{ 1, "decode_font", test_decode_font },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Verifies that the embedded config loads. */
// TODO(kaeser@gubbe.ch): For now, this just verifies that the configuration
// **parses**. There is no further verification of the dict contents. Would
// be great to extend this.
void test_embedded(bs_test_t *test_ptr)
{
wlmcfg_object_t *obj_ptr;
obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_default_configuration_data,
embedded_binary_default_configuration_size);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlmcfg_dict_from_object(obj_ptr));
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_default_state_data,
embedded_binary_default_state_size);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlmcfg_dict_from_object(obj_ptr));
wlmcfg_object_unref(obj_ptr);
obj_ptr = wlmcfg_create_object_from_plist_data(
embedded_binary_style_default_data,
embedded_binary_style_default_size);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, wlmcfg_dict_from_object(obj_ptr));
wlmcfg_object_unref(obj_ptr);
}
/* ------------------------------------------------------------------------- */
/** Verifies that the (example) config files are loading. */
// TODO(kaeser@gubbe.ch): For now, this just verifies that the configuration
// file **parses**. There is no further verification of the dict contents.
// Would be great to extend this.
void test_file(bs_test_t *test_ptr)
{
wlmcfg_dict_t *dict_ptr;
#ifndef WLMAKER_SOURCE_DIR
#error "Missing definition of WLMAKER_SOURCE_DIR!"
#endif
dict_ptr = _wlmaker_config_from_plist(
WLMAKER_SOURCE_DIR "/etc/wlmaker.plist");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
wlmcfg_dict_unref(dict_ptr);
dict_ptr = _wlmaker_config_from_plist(
WLMAKER_SOURCE_DIR "/etc/wlmaker-home.plist");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
wlmcfg_dict_unref(dict_ptr);
dict_ptr = _wlmaker_config_from_plist(
WLMAKER_SOURCE_DIR "/etc/wlmaker-state.plist");
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
wlmcfg_dict_unref(dict_ptr);
}
/* ------------------------------------------------------------------------- */
/** Loads and decodes the style file. */
void test_style_file(bs_test_t *test_ptr)
{
wlmcfg_dict_t *dict_ptr;
wlmaker_config_style_t config_style;
#ifndef WLMAKER_SOURCE_DIR
#error "Missing definition of WLMAKER_SOURCE_DIR!"
#endif
dict_ptr = _wlmaker_config_from_plist(
WLMAKER_SOURCE_DIR "/etc/style-default.plist");
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, dict_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_decode_dict(
dict_ptr, wlmaker_config_style_desc, &config_style));
wlmcfg_dict_unref(dict_ptr);
dict_ptr = _wlmaker_config_from_plist(
WLMAKER_SOURCE_DIR "/etc/style-debian.plist");
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, dict_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_decode_dict(
dict_ptr, wlmaker_config_style_desc, &config_style));
wlmcfg_dict_unref(dict_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests the decoder for the fill style. */
void test_decode_fill(bs_test_t *test_ptr)
{
const char *s = ("{"
"Type = DGRADIENT;"
"From = \"argb32:0x01020304\";"
"To = \"argb32:0x0204080c\""
"}");
wlmtk_style_fill_t fill;
wlmcfg_object_t *object_ptr;
object_ptr = wlmcfg_create_object_from_plist_string(s);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmaker_config_decode_fill_style(object_ptr, &fill));
BS_TEST_VERIFY_EQ(test_ptr, WLMTK_STYLE_COLOR_DGRADIENT, fill.type);
BS_TEST_VERIFY_EQ(test_ptr, 0x01020304, fill.param.dgradient.from);
BS_TEST_VERIFY_EQ(test_ptr, 0x0204080c, fill.param.dgradient.to);
wlmcfg_object_unref(object_ptr);
s = ("{"
"Type = HGRADIENT;"
"From = \"argb32:0x04030201\";"
"To = \"argb32:0x40302010\""
"}");
object_ptr = wlmcfg_create_object_from_plist_string(s);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmaker_config_decode_fill_style(object_ptr, &fill));
BS_TEST_VERIFY_EQ(test_ptr, WLMTK_STYLE_COLOR_HGRADIENT, fill.type);
BS_TEST_VERIFY_EQ(test_ptr, 0x04030201, fill.param.hgradient.from);
BS_TEST_VERIFY_EQ(test_ptr, 0x40302010, fill.param.hgradient.to);
wlmcfg_object_unref(object_ptr);
s = ("{"
"Type = SOLID;"
"Color = \"argb32:0x11223344\""
"}");
object_ptr = wlmcfg_create_object_from_plist_string(s);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, object_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
_wlmaker_config_decode_fill_style(object_ptr, &fill));
BS_TEST_VERIFY_EQ(test_ptr, WLMTK_STYLE_COLOR_SOLID, fill.type);
BS_TEST_VERIFY_EQ(test_ptr, 0x11223344, fill.param.solid.color);
wlmcfg_object_unref(object_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests the decoder for a font descriptor. */
void test_decode_font(bs_test_t *test_ptr)
{
wlmcfg_object_t *object_ptr;
const char *s = ("{"
"Face = Helvetica;"
"Weight = Bold;"
"Size = 12;"
"}");
object_ptr = wlmcfg_create_object_from_plist_string(s);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, object_ptr);
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(object_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, dict_ptr);
wlmtk_style_font_t font = {};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmcfg_decode_dict(dict_ptr, _wlmaker_config_font_style_desc, &font));
BS_TEST_VERIFY_STREQ(test_ptr, "Helvetica", font.face);
BS_TEST_VERIFY_EQ(test_ptr, WLMTK_FONT_WEIGHT_BOLD, font.weight);
BS_TEST_VERIFY_EQ(test_ptr, 12, font.size);
wlmcfg_object_unref(object_ptr);
}
/* == End of config.c ====================================================== */
wlmaker-0.3/src/config.h 0000664 0000000 0000000 00000012153 14641446446 0015242 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file config.h
*
* @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 iLicense.
*/
#ifndef __CONFIG_H__
#define __CONFIG_H__
#include
#include
#include
#include "conf/plist.h"
#include "toolkit/toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Preference for decoration. */
typedef enum {
/** Mode NONE will be set to CLIENT; but other modes left unchanged. */
WLMAKER_CONFIG_DECORATION_SUGGEST_CLIENT,
/** Mode NONE will be set to SERVER; but other modes left unchanged. */
WLMAKER_CONFIG_DECORATION_SUGGEST_SERVER,
/** Will set all windows to CLIENT, no matter what they requested. */
WLMAKER_CONFIG_DECORATION_ENFORCE_CLIENT,
/** Will set all windows to SERVER, no matter what they requested. */
WLMAKER_CONFIG_DECORATION_ENFORCE_SERVER
} wlmaker_config_decoration_t;
/** Style of the task list overlay. */
typedef struct {
/** Fill style. */
wlmtk_style_fill_t fill;
/** Font to use. */
wlmtk_style_font_t font;
/** Text color for tasks listed. */
uint32_t text_color;
} wlmaker_config_task_list_style_t;
/** Style of the clip's configurables. */
typedef struct {
/** Font to use. */
wlmtk_style_font_t font;
/** Text color for tasks listed. */
uint32_t text_color;
} wlmaker_config_clip_style_t;
/** Style information. Replaces @ref wlmaker_config_theme_t. */
typedef struct {
/** Background color, unless overriden in "Workspace" state. */
uint32_t background_color;
/** The tile. */
wlmtk_tile_style_t tile;
/** Dock optics: Margin. */
wlmtk_dock_style_t dock;
/** Window style. */
wlmtk_window_style_t window;
/** Clip style. */
wlmaker_config_clip_style_t clip;
/** Task list style. */
wlmaker_config_task_list_style_t task_list;
} wlmaker_config_style_t;
/** The theme. */
typedef struct {
/** Color of the window margin. */
uint32_t window_margin_color;
/** Width of the window margin, in pixels. */
uint32_t window_margin_width;
/** Fill style of a tile. */
wlmtk_style_fill_t tile_fill;
/** Fill style of the menu's background. */
wlmtk_style_fill_t menu_fill;
/** Color of the menu's margin and padding. */
uint32_t menu_margin_color;
/** Width of the menu's margin. */
uint32_t menu_margin_width;
/** Width of the paddin between menu elements. In `menu_margin_color. */
uint32_t menu_padding_width;
/** Fill style of a menu item when enabled. */
wlmtk_style_fill_t menu_item_enabled_fill;
/** Text color of menu item when enabled. */
uint32_t menu_item_enabled_text_color;
/** Fill style of a menu item when selected. */
wlmtk_style_fill_t menu_item_selected_fill;
/** Text color of menu item when selected. */
uint32_t menu_item_selected_text_color;
} wlmaker_config_theme_t;
extern const char *config_xcursor_theme_name;
extern const uint32_t config_xcursor_theme_size;
extern const float config_output_scale;
extern const wlmaker_config_decoration_t config_decoration;
extern const uint32_t wlmaker_config_window_drag_modifiers;
extern const wlmaker_config_theme_t wlmaker_config_theme;
/**
* Loads the configuration for wlmaker.
*
* If `fname_ptr` is give, it will attempt to load the configuration from the
* specified file. Otherwise, it will attempt to load the files specified in
* @ref _wlmaker_config_fname_ptrs, or (at last) use the built-in default.
*
* @param fname_ptr Optional: Name of the file to load it from. May
* be NULL.
*
* @return A dict object, or NULL on error. Errors will already be logged.
* The caller must free the associated resources by calling
* @ref wlmcfg_object_unref.
*/
wlmcfg_dict_t *wlmaker_config_load(const char *fname_ptr);
/**
* Loads the state for wlmaker.
*
* Behaviour is similar to @ref wlmaker_config_load.
*
* @param fname_ptr
*
* @return A dict object or NULL on error.
*/
wlmcfg_dict_t *wlmaker_state_load(const char *fname_ptr);
extern const wlmcfg_desc_t wlmaker_config_style_desc[];
/** Unit test cases. */
extern const bs_test_case_t wlmaker_config_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __CONFIG_H__ */
/* == End of config.h ====================================================== */
wlmaker-0.3/src/cursor.c 0000664 0000000 0000000 00000027277 14641446446 0015322 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file cursor.c
*
* @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.
*/
#include "cursor.h"
#include "config.h"
#include "toolkit/toolkit.h"
#include
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static void handle_motion(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_motion_absolute(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_button(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_axis(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_frame(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_seat_request_set_cursor(
struct wl_listener *listener_ptr,
void *data_ptr);
static void process_motion(wlmaker_cursor_t *cursor_ptr, uint32_t time_msec);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_cursor_t *wlmaker_cursor_create(wlmaker_server_t *server_ptr)
{
wlmaker_cursor_t *cursor_ptr = logged_calloc(1, sizeof(wlmaker_cursor_t));
if (NULL == cursor_ptr) return NULL;
cursor_ptr->server_ptr = server_ptr;
// tinywl: wlr_cursor is a utility tracking the cursor image shown on
// screen.
cursor_ptr->wlr_cursor_ptr = wlr_cursor_create();
if (NULL == cursor_ptr->wlr_cursor_ptr) {
bs_log(BS_ERROR, "Failed wlr_cursor_create()");
wlmaker_cursor_destroy(cursor_ptr);
return NULL;
}
// Must be initialized after wlr_output_layout_ptr.
BS_ASSERT(NULL != server_ptr->wlr_output_layout_ptr);
wlr_cursor_attach_output_layout(cursor_ptr->wlr_cursor_ptr,
server_ptr->wlr_output_layout_ptr);
cursor_ptr->wlr_xcursor_manager_ptr = wlr_xcursor_manager_create(
config_xcursor_theme_name,
config_xcursor_theme_size);
if (NULL == cursor_ptr->wlr_xcursor_manager_ptr) {
bs_log(BS_ERROR, "Failed wlr_xcursor_manager_create(%s, %"PRIu32")",
config_xcursor_theme_name, config_xcursor_theme_size);
wlmaker_cursor_destroy(cursor_ptr);
return NULL;
}
if (!wlr_xcursor_manager_load(cursor_ptr->wlr_xcursor_manager_ptr,
config_output_scale)) {
bs_log(BS_ERROR, "Failed wlr_xcursor_manager_load() for %s, %"PRIu32,
config_xcursor_theme_name, config_xcursor_theme_size);
wlmaker_cursor_destroy(cursor_ptr);
return NULL;
}
// tinywl: wlr_cursor *only* displays an image on screen. It does not move
// around when the pointer moves. However, we can attach input devices to
// it, and it will generate aggregate events for all of them. In these
// events, we can choose how we want to process them, forwarding them to
// clients and moving the cursor around. More detail on this process is
// described in the input handling blog post:
//
// https://drewdevault.com/2018/07/17/Input-handling-in-wlroots.html
wlmtk_util_connect_listener_signal(
&cursor_ptr->wlr_cursor_ptr->events.motion,
&cursor_ptr->motion_listener,
handle_motion);
wlmtk_util_connect_listener_signal(
&cursor_ptr->wlr_cursor_ptr->events.motion_absolute,
&cursor_ptr->motion_absolute_listener,
handle_motion_absolute);
wlmtk_util_connect_listener_signal(
&cursor_ptr->wlr_cursor_ptr->events.button,
&cursor_ptr->button_listener,
handle_button);
wlmtk_util_connect_listener_signal(
&cursor_ptr->wlr_cursor_ptr->events.axis,
&cursor_ptr->axis_listener,
handle_axis);
wlmtk_util_connect_listener_signal(
&cursor_ptr->wlr_cursor_ptr->events.frame,
&cursor_ptr->frame_listener,
handle_frame);
wlmtk_util_connect_listener_signal(
&cursor_ptr->server_ptr->wlr_seat_ptr->events.request_set_cursor,
&cursor_ptr->seat_request_set_cursor_listener,
handle_seat_request_set_cursor);
return cursor_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_cursor_destroy(wlmaker_cursor_t *cursor_ptr)
{
if (NULL != cursor_ptr->wlr_xcursor_manager_ptr) {
wlr_xcursor_manager_destroy(cursor_ptr->wlr_xcursor_manager_ptr);
cursor_ptr->wlr_xcursor_manager_ptr = NULL;
}
if (NULL != cursor_ptr->wlr_cursor_ptr) {
wlr_cursor_destroy(cursor_ptr->wlr_cursor_ptr);
cursor_ptr->wlr_cursor_ptr = NULL;
}
free(cursor_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_cursor_attach_input_device(
wlmaker_cursor_t *cursor_ptr,
struct wlr_input_device *wlr_input_device_ptr)
{
wlr_cursor_attach_input_device(
cursor_ptr->wlr_cursor_ptr,
wlr_input_device_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_cursor_get_position(
const wlmaker_cursor_t *cursor_ptr,
double *x_ptr,
double *y_ptr)
{
if (NULL != x_ptr) *x_ptr = cursor_ptr->wlr_cursor_ptr->x;
if (NULL != y_ptr) *y_ptr = cursor_ptr->wlr_cursor_ptr->y;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Handler for the `motion` event of `wlr_cursor`.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_pointer_motion_event`.
*/
void handle_motion(struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, motion_listener);
struct wlr_pointer_motion_event *wlr_pointer_motion_event_ptr = data_ptr;
wlmaker_idle_monitor_reset(cursor_ptr->server_ptr->idle_monitor_ptr);
wlr_cursor_move(
cursor_ptr->wlr_cursor_ptr,
&wlr_pointer_motion_event_ptr->pointer->base,
wlr_pointer_motion_event_ptr->delta_x,
wlr_pointer_motion_event_ptr->delta_y);
process_motion(
cursor_ptr,
wlr_pointer_motion_event_ptr->time_msec);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `motion_absolute` event of `wlr_cursor`.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_pointer_motion_absolute_event`.
*/
void handle_motion_absolute(struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, motion_absolute_listener);
struct wlr_pointer_motion_absolute_event
*wlr_pointer_motion_absolute_event_ptr = data_ptr;
wlmaker_idle_monitor_reset(cursor_ptr->server_ptr->idle_monitor_ptr);
wlr_cursor_warp_absolute(
cursor_ptr->wlr_cursor_ptr,
&wlr_pointer_motion_absolute_event_ptr->pointer->base,
wlr_pointer_motion_absolute_event_ptr->x,
wlr_pointer_motion_absolute_event_ptr->y);
process_motion(
cursor_ptr,
wlr_pointer_motion_absolute_event_ptr->time_msec);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `button` event of `wlr_cursor`.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_pointer_button_event`.
*/
void handle_button(struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, button_listener);
struct wlr_pointer_button_event *wlr_pointer_button_event_ptr = data_ptr;
wlmaker_idle_monitor_reset(cursor_ptr->server_ptr->idle_monitor_ptr);
wlmtk_root_pointer_button(
cursor_ptr->server_ptr->root_ptr,
wlr_pointer_button_event_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `axis` event of `wlr_cursor`.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_pointer_axis_event`.
*/
void handle_axis(struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, axis_listener);
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr = data_ptr;
wlmaker_idle_monitor_reset(cursor_ptr->server_ptr->idle_monitor_ptr);
wlmtk_root_pointer_axis(
cursor_ptr->server_ptr->root_ptr,
wlr_pointer_axis_event_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `frame` event of `wlr_cursor`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_frame(struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, frame_listener);
/* Notify the client with pointer focus of the frame event. */
wlr_seat_pointer_notify_frame(cursor_ptr->server_ptr->wlr_seat_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `request_set_cursor` event of `wlr_seat`.
*
* This event is raised when a client provides a cursor image. It is accepted
* only if the client also has the pointer focus.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_seat_pointer_request_set_cursor_event`.
*/
void handle_seat_request_set_cursor(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_cursor_t *cursor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_cursor_t, seat_request_set_cursor_listener);
struct wlr_seat_pointer_request_set_cursor_event
*wlr_seat_pointer_request_set_cursor_event_ptr = data_ptr;
struct wlr_seat_client *focused_wlr_seat_client_ptr =
cursor_ptr->server_ptr->wlr_seat_ptr->pointer_state.focused_client;
if (focused_wlr_seat_client_ptr ==
wlr_seat_pointer_request_set_cursor_event_ptr->seat_client) {
wlr_cursor_set_surface(
cursor_ptr->wlr_cursor_ptr,
wlr_seat_pointer_request_set_cursor_event_ptr->surface,
wlr_seat_pointer_request_set_cursor_event_ptr->hotspot_x,
wlr_seat_pointer_request_set_cursor_event_ptr->hotspot_y);
} else {
bs_log(BS_WARNING, "request_set_cursor called without pointer focus.");
}
}
/* ------------------------------------------------------------------------- */
/**
* Processes the cursor motion: Lookups up the view & surface under the
* pointer and sets (respectively: clears) the pointer focus. Also sets the
* default cursor image, if no view is given (== no client-side cursor).
*
* @param cursor_ptr
* @param time_msec
*/
void process_motion(wlmaker_cursor_t *cursor_ptr, uint32_t time_msec)
{
wlmtk_root_pointer_motion(
cursor_ptr->server_ptr->root_ptr,
cursor_ptr->wlr_cursor_ptr->x,
cursor_ptr->wlr_cursor_ptr->y,
time_msec);
}
/* == End of cursor.c ====================================================== */
wlmaker-0.3/src/cursor.h 0000664 0000000 0000000 00000005712 14641446446 0015315 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file cursor.h
*
* @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.
*/
#ifndef __CURSOR_H__
#define __CURSOR_H__
/** Forward declaration of wlmaker cursor state. */
typedef struct _wlmaker_cursor_t wlmaker_cursor_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** State and tools for handling wlmaker cursors. */
struct _wlmaker_cursor_t {
/** Back-link to wlmaker_server_t. */
wlmaker_server_t *server_ptr;
/** Points to a `wlr_cursor`. */
struct wlr_cursor *wlr_cursor_ptr;
/** Points to a `wlr_xcursor_manager`. */
struct wlr_xcursor_manager *wlr_xcursor_manager_ptr;
/** Listener for the `motion` event of `wlr_cursor`. */
struct wl_listener motion_listener;
/** Listener for the `motion_absolute` event of `wlr_cursor`. */
struct wl_listener motion_absolute_listener;
/** Listener for the `button` event of `wlr_cursor`. */
struct wl_listener button_listener;
/** Listener for the `axis` event of `wlr_cursor`. */
struct wl_listener axis_listener;
/** Listener for the `frame` event of `wlr_cursor`. */
struct wl_listener frame_listener;
/** Listener for the `request_set_cursor` event of `wlr_seat`. */
struct wl_listener seat_request_set_cursor_listener;
};
/**
* Creates the cursor handlers.
*
* @param server_ptr
*
* @return The cursor handler or NULL on error.
*/
wlmaker_cursor_t *wlmaker_cursor_create(wlmaker_server_t *server_ptr);
/**
* Destroys the cursor handlers.
*
* @param cursor_ptr
*/
void wlmaker_cursor_destroy(wlmaker_cursor_t *cursor_ptr);
/**
* Attaches the input device. May be a pointer, touch or tablet_tool device.
*
* @param cursor_ptr
* @param wlr_input_device_ptr
*/
void wlmaker_cursor_attach_input_device(
wlmaker_cursor_t *cursor_ptr,
struct wlr_input_device *wlr_input_device_ptr);
/**
* Retrieves the current pointer's position into |*x_ptr|, |*y_ptr|.
*
* @param cursor_ptr
* @param x_ptr May be NULL.
* @param y_ptr May be NULL.
*/
void wlmaker_cursor_get_position(
const wlmaker_cursor_t *cursor_ptr,
double *x_ptr,
double *y_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __CURSOR_H__ */
/* == End of cursor.h ====================================================== */
wlmaker-0.3/src/dock.c 0000664 0000000 0000000 00000021443 14641446446 0014712 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file dock.c
*
* @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.
*/
#include "dock.h"
#include
#include
#include "config.h"
#include "launcher.h"
#include "default_state.h"
/* == Declarations ========================================================= */
/** Dock handle. */
struct _wlmaker_dock_t {
/** Toolkit dock. */
wlmtk_dock_t *wlmtk_dock_ptr;
/** Back-link to server. */
wlmaker_server_t *server_ptr;
/** Listener for @ref wlmtk_root_events_t::workspace_changed. */
struct wl_listener workspace_changed_listener;
};
static bool _wlmaker_dock_decode_launchers(
wlmcfg_object_t *object_ptr,
void *dest_ptr);
static void _wlmaker_dock_handle_workspace_changed(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** TODO: Replace this. */
typedef struct {
/** Positioning data. */
wlmtk_dock_positioning_t positioning;
/** Launchers. */
wlmcfg_array_t *launchers_array_ptr;
} parse_args;
/** Enum descriptor for `enum wlr_edges`. */
static const wlmcfg_enum_desc_t _wlmaker_dock_edges[] = {
WLMCFG_ENUM("TOP", WLR_EDGE_TOP),
WLMCFG_ENUM("BOTTOM", WLR_EDGE_BOTTOM),
WLMCFG_ENUM("LEFT", WLR_EDGE_LEFT),
WLMCFG_ENUM("RIGHT", WLR_EDGE_RIGHT),
WLMCFG_ENUM_SENTINEL(),
};
/** Descriptor for the dock's plist. */
const wlmcfg_desc_t _wlmaker_dock_desc[] = {
WLMCFG_DESC_ENUM("Edge", true, parse_args, positioning.edge,
WLR_EDGE_NONE, _wlmaker_dock_edges),
WLMCFG_DESC_ENUM("Anchor", true, parse_args, positioning.anchor,
WLR_EDGE_NONE, _wlmaker_dock_edges),
WLMCFG_DESC_CUSTOM("Launchers", true, parse_args, launchers_array_ptr,
_wlmaker_dock_decode_launchers, NULL, NULL),
WLMCFG_DESC_SENTINEL(),
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_dock_t *wlmaker_dock_create(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *state_dict_ptr,
const wlmaker_config_style_t *style_ptr)
{
wlmaker_dock_t *dock_ptr = logged_calloc(1, sizeof(wlmaker_dock_t));
if (NULL == dock_ptr) return NULL;
dock_ptr->server_ptr = server_ptr;
parse_args args = {};
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_get_dict(state_dict_ptr, "Dock");
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "No 'Dock' dict found in configuration.");
wlmaker_dock_destroy(dock_ptr);
return NULL;
}
wlmcfg_decode_dict(dict_ptr, _wlmaker_dock_desc, &args);
dock_ptr->wlmtk_dock_ptr = wlmtk_dock_create(
&args.positioning, &style_ptr->dock, server_ptr->env_ptr);
if (NULL == dock_ptr->wlmtk_dock_ptr) {
wlmaker_dock_destroy(dock_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_dock_element(dock_ptr->wlmtk_dock_ptr),
true);
wlmtk_workspace_t *wlmtk_workspace_ptr =
wlmtk_root_get_current_workspace(server_ptr->root_ptr);
wlmtk_layer_t *layer_ptr = wlmtk_workspace_get_layer(
wlmtk_workspace_ptr, WLMTK_WORKSPACE_LAYER_TOP);
wlmtk_layer_add_panel(
layer_ptr,
wlmtk_dock_panel(dock_ptr->wlmtk_dock_ptr));
for (size_t i = 0;
i < wlmcfg_array_size(args.launchers_array_ptr);
++i) {
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(
wlmcfg_array_at(args.launchers_array_ptr, i));
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "Elements of 'Launchers' must be dicts.");
wlmaker_dock_destroy(dock_ptr);
return NULL;
}
wlmaker_launcher_t *launcher_ptr = wlmaker_launcher_create_from_plist(
&style_ptr->tile, dict_ptr,
server_ptr->monitor_ptr, server_ptr->env_ptr);
if (NULL == launcher_ptr) {
wlmaker_dock_destroy(dock_ptr);
return NULL;
}
wlmtk_dock_add_tile(
dock_ptr->wlmtk_dock_ptr,
wlmaker_launcher_tile(launcher_ptr));
}
// FIXME: This is leaky.
if (NULL != args.launchers_array_ptr) {
wlmcfg_array_unref(args.launchers_array_ptr);
args.launchers_array_ptr = NULL;
}
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->workspace_changed,
&dock_ptr->workspace_changed_listener,
_wlmaker_dock_handle_workspace_changed);
bs_log(BS_INFO, "Created dock %p", dock_ptr);
return dock_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_dock_destroy(wlmaker_dock_t *dock_ptr)
{
wlmtk_util_disconnect_listener(&dock_ptr->workspace_changed_listener);
if (NULL != dock_ptr->wlmtk_dock_ptr) {
wlmtk_layer_remove_panel(
wlmtk_panel_get_layer(wlmtk_dock_panel(dock_ptr->wlmtk_dock_ptr)),
wlmtk_dock_panel(dock_ptr->wlmtk_dock_ptr));
wlmtk_dock_destroy(dock_ptr->wlmtk_dock_ptr);
dock_ptr->wlmtk_dock_ptr = NULL;
}
free(dock_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Decoder for the "Launchers" array. Currently just stores a reference. */
bool _wlmaker_dock_decode_launchers(
wlmcfg_object_t *object_ptr,
void *dest_ptr)
{
wlmcfg_array_t **array_ptr_ptr = dest_ptr;
*array_ptr_ptr = wlmcfg_array_from_object(object_ptr);
if (NULL == *array_ptr_ptr) return false;
wlmcfg_object_ref(wlmcfg_object_from_array(*array_ptr_ptr));
return true;
}
/* ------------------------------------------------------------------------- */
/** Re-attaches the dock to the new "current" workspace. */
void _wlmaker_dock_handle_workspace_changed(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_dock_t *dock_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_dock_t, workspace_changed_listener);
wlmtk_panel_t *panel_ptr = wlmtk_dock_panel(dock_ptr->wlmtk_dock_ptr);
wlmtk_layer_t *current_layer_ptr = wlmtk_panel_get_layer(panel_ptr);
wlmtk_workspace_t *wlmtk_workspace_ptr =
wlmtk_root_get_current_workspace(dock_ptr->server_ptr->root_ptr);
wlmtk_layer_t *new_layer_ptr = wlmtk_workspace_get_layer(
wlmtk_workspace_ptr, WLMTK_WORKSPACE_LAYER_TOP);
if (current_layer_ptr == new_layer_ptr) return;
if (NULL != current_layer_ptr) {
wlmtk_layer_remove_panel(current_layer_ptr, panel_ptr);
}
wlmtk_layer_add_panel(new_layer_ptr, panel_ptr);
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
const bs_test_case_t wlmaker_dock_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests ctor and dtor; to help fix leaks. */
void test_create_destroy(bs_test_t *test_ptr)
{
struct wlr_scene *wlr_scene_ptr = wlr_scene_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, wlr_scene_ptr);
wlmtk_root_t *root_ptr = wlmtk_root_create(wlr_scene_ptr, NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, root_ptr);
wlmtk_workspace_t *ws_ptr = wlmtk_workspace_create("1", 0);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, ws_ptr);
wlmtk_root_add_workspace(root_ptr, ws_ptr);
wlmaker_server_t server = { .root_ptr = root_ptr };
wlmaker_config_style_t style = {};
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_data(
embedded_binary_default_state_data,
embedded_binary_default_state_size));
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, dict_ptr);
wlmaker_dock_t *dock_ptr = wlmaker_dock_create(&server, dict_ptr, &style);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dock_ptr);
wlmaker_dock_destroy(dock_ptr);
wlmcfg_dict_unref(dict_ptr);
wlmtk_root_remove_workspace(root_ptr, ws_ptr);
wlmtk_workspace_destroy(ws_ptr);
wlmtk_root_destroy(root_ptr);
}
/* == End of dock.c ======================================================== */
wlmaker-0.3/src/dock.h 0000664 0000000 0000000 00000003506 14641446446 0014717 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file dock.h
*
* @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.
*
* Creates the wlmaker dock: A view, with server-bound surfaces, that acts as
* launcher for Apps.
*
* Corresponding Window Maker documentation:
* http://www.windowmaker.org/docs/guidedtour/dock.html
*/
#ifndef __DOCK_H__
#define __DOCK_H__
/** Forward definition: Dock handle. */
typedef struct _wlmaker_dock_t wlmaker_dock_t;
#include "config.h"
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates the Dock handle. Needs the server to be up with workspaces running.
*
* @param server_ptr
* @param state_dict_ptr
* @param style_ptr
*
* @return Pointer to the Dock handle, or NULL on error.
*/
wlmaker_dock_t *wlmaker_dock_create(
wlmaker_server_t *server_ptr,
wlmcfg_dict_t *state_dict_ptr,
const wlmaker_config_style_t *style_ptr);
/**
* Destroys the Dock handle.
*
* @param dock_ptr
*/
void wlmaker_dock_destroy(wlmaker_dock_t *dock_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmaker_dock_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __DOCK_H__ */
/* == End of dock.h ======================================================== */
wlmaker-0.3/src/icon_manager.c 0000664 0000000 0000000 00000045415 14641446446 0016421 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file icon_manager.c
*
* @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.
*/
#include "icon_manager.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
#include "toolkit/toolkit.h"
#include "wlmaker-icon-unstable-v1-server-protocol.h"
/* == Declarations ========================================================= */
/** State of the toplevel icon manager. */
struct _wlmaker_icon_manager_t {
/** Back-link to the server. */
wlmaker_server_t *server_ptr;
/** Back-link to the wayland Display. */
struct wl_display *wl_display_ptr;
/** The global holding the icon manager's interface. */
struct wl_global *wl_global_ptr;
};
/** State of a toplevel icon. */
struct _wlmaker_toplevel_icon_t {
/** The icon is also a toolkit tile. */
wlmtk_tile_t super_tile;
/** The surface element, being the content of the tile. */
wlmtk_surface_t *content_surface_ptr;
/** Back-link to the client requesting the toplevel. */
struct wl_client *wl_client_ptr;
/** Back-link to the icon manager. */
wlmaker_icon_manager_t *icon_manager_ptr;
/** The provided ID. */
uint32_t id;
/** The XDG toplevel for which the icon is specified. */
struct wlr_xdg_toplevel *wlr_xdg_toplevel_ptr;
/** The surface to use for the icon of this toplevel. */
struct wlr_surface *wlr_surface_ptr;
/** The resource associated with this icon. */
struct wl_resource *wl_resource_ptr;
/** Whether the configuration sequence was acknowledged. */
bool acknowledged;
/** Serial that needs to be acknowledged. */
uint32_t pending_serial;
/** Listener for the `commit` event of `wlr_surface_ptr`. */
struct wl_listener surface_commit_listener;
/** Listener for the `destroy` event of `wlr_surface_ptr`. */
struct wl_listener surface_destroy_listener;
};
static wlmaker_icon_manager_t *icon_manager_from_resource(
struct wl_resource *wl_resource_ptr);
static wlmaker_toplevel_icon_t *wlmaker_toplevel_icon_from_resource(
struct wl_resource *wl_resource_ptr);
static void bind_icon_manager(
struct wl_client *wl_client_ptr,
void *data_ptr,
uint32_t version,
uint32_t id);
static void handle_resource_destroy(
struct wl_client *wl_client_ptr,
struct wl_resource *wl_resource_ptr);
static void handle_get_toplevel_icon(
struct wl_client *wl_client_ptr,
struct wl_resource *wl_icon_manager_resource_ptr,
uint32_t id,
struct wl_resource *wl_toplevel_resource_ptr,
struct wl_resource *wl_surface_resource_ptr);
static wlmaker_toplevel_icon_t *wlmaker_toplevel_icon_create(
struct wl_client *wl_client_ptr,
wlmaker_icon_manager_t *icon_manager_ptr,
uint32_t id,
int version,
struct wlr_xdg_toplevel *wlr_xdg_toplevel_ptr,
struct wlr_surface *wlr_surface_ptr);
static void wlmaker_toplevel_icon_destroy(
wlmaker_toplevel_icon_t *toplevel_icon_ptr);
static void toplevel_icon_resource_destroy(
struct wl_resource *wl_resource_ptr);
static void handle_icon_ack_configure(
struct wl_client *wl_client_ptr,
struct wl_resource *wl_resource_ptr,
uint32_t serial);
static void handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_surface_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_toplevel_icon_element_destroy(
wlmtk_element_t *element_ptr);
/* == Data ================================================================= */
/** Implementation of the toplevel icon manager interface. */
static const struct zwlmaker_icon_manager_v1_interface
icon_manager_v1_implementation = {
.destroy = handle_resource_destroy,
.get_toplevel_icon = handle_get_toplevel_icon
};
/** Implementation of the toplevel icon interface. */
static const struct zwlmaker_toplevel_icon_v1_interface
toplevel_icon_v1_implementation = {
.destroy = handle_resource_destroy,
.ack_configure = handle_icon_ack_configure,
};
/** The icon's extension to @ref wlmtk_element_t virtual method table. */
static const wlmtk_element_vmt_t _wlmaker_toplevel_icon_element_vmt = {
.destroy = _wlmaker_toplevel_icon_element_destroy,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_icon_manager_t *wlmaker_icon_manager_create(
struct wl_display *wl_display_ptr,
wlmaker_server_t *server_ptr)
{
wlmaker_icon_manager_t *icon_manager_ptr =
logged_calloc(1, sizeof(wlmaker_icon_manager_t));
if (NULL == icon_manager_ptr) return NULL;
icon_manager_ptr->server_ptr = server_ptr;
icon_manager_ptr->wl_display_ptr = wl_display_ptr;
icon_manager_ptr->wl_global_ptr = wl_global_create(
wl_display_ptr,
&zwlmaker_icon_manager_v1_interface,
1,
icon_manager_ptr,
bind_icon_manager);
if (NULL == icon_manager_ptr->wl_global_ptr) {
wlmaker_icon_manager_destroy(icon_manager_ptr);
return NULL;
}
return icon_manager_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_icon_manager_destroy(
wlmaker_icon_manager_t *icon_manager_ptr)
{
if (NULL != icon_manager_ptr->wl_global_ptr) {
wl_global_destroy(icon_manager_ptr->wl_global_ptr);
icon_manager_ptr->wl_global_ptr = NULL;
}
free(icon_manager_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Returns the toplevel icon manager from the resource, with type check.
*
* @param wl_resource_ptr
*
* @return Pointer to the @ref wlmaker_icon_manager_t.
*/
wlmaker_icon_manager_t *icon_manager_from_resource(
struct wl_resource *wl_resource_ptr)
{
BS_ASSERT(wl_resource_instance_of(
wl_resource_ptr,
&zwlmaker_icon_manager_v1_interface,
&icon_manager_v1_implementation));
return wl_resource_get_user_data(wl_resource_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Returns the toplevel icon from the resource, with type check.
*
* @param wl_resource_ptr
*
* @return Pointer to the @ref wlmaker_toplevel_icon_t.
*/
wlmaker_toplevel_icon_t *wlmaker_toplevel_icon_from_resource(
struct wl_resource *wl_resource_ptr)
{
BS_ASSERT(wl_resource_instance_of(
wl_resource_ptr,
&zwlmaker_toplevel_icon_v1_interface,
&toplevel_icon_v1_implementation));
return wl_resource_get_user_data(wl_resource_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Binds an icon manager for the client.
*
* @param wl_client_ptr
* @param data_ptr
* @param version
* @param id
*/
void bind_icon_manager(
struct wl_client *wl_client_ptr,
void *data_ptr,
uint32_t version,
uint32_t id)
{
struct wl_resource *wl_resource_ptr = wl_resource_create(
wl_client_ptr,
&zwlmaker_icon_manager_v1_interface,
version, id);
if (NULL == wl_resource_ptr) {
wl_client_post_no_memory(wl_client_ptr);
return;
}
wlmaker_icon_manager_t *icon_manager_ptr = data_ptr;
wl_resource_set_implementation(
wl_resource_ptr,
&icon_manager_v1_implementation, // implementation.
icon_manager_ptr, // data
NULL); // dtor. We don't have an explicit one.
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the 'destroy' method: Destroys the resource.
*
* @param wl_client_ptr
* @param wl_resource_ptr
*/
void handle_resource_destroy(
__UNUSED__ struct wl_client *wl_client_ptr,
struct wl_resource *wl_resource_ptr)
{
wl_resource_destroy(wl_resource_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the 'get_toplevel_icon' method.
*
* @param wl_client_ptr
* @param wl_icon_manager_resource_ptr
* @param id
* @param wl_toplevel_resource_ptr
* @param wl_surface_resource_ptr
*/
void handle_get_toplevel_icon(
struct wl_client *wl_client_ptr,
struct wl_resource *wl_icon_manager_resource_ptr,
uint32_t id,
struct wl_resource *wl_toplevel_resource_ptr,
struct wl_resource *wl_surface_resource_ptr)
{
wlmaker_icon_manager_t *icon_manager_ptr =
icon_manager_from_resource(
wl_icon_manager_resource_ptr);
struct wlr_xdg_toplevel *wlr_xdg_toplevel_ptr = NULL;
if (NULL != wl_toplevel_resource_ptr) {
wlr_xdg_toplevel_ptr = wlr_xdg_toplevel_from_resource(
wl_toplevel_resource_ptr);
}
struct wlr_surface *wlr_surface_ptr =
wlr_surface_from_resource(wl_surface_resource_ptr);
wlmaker_toplevel_icon_t *toplevel_icon_ptr = wlmaker_toplevel_icon_create(
wl_client_ptr,
icon_manager_ptr,
id,
wl_resource_get_version(wl_icon_manager_resource_ptr),
wlr_xdg_toplevel_ptr,
wlr_surface_ptr);
if (NULL == toplevel_icon_ptr) {
wl_client_post_no_memory(wl_client_ptr);
return;
}
}
/* ------------------------------------------------------------------------- */
/**
* Creates a new toplevel icon.
*
* @param wl_client_ptr
* @param icon_manager_ptr
* @param id
* @param version
* @param wlr_xdg_toplevel_ptr
* @param wlr_surface_ptr
*
* @return A pointer to the new toplevel icon or NULL on error. The toplevel
* icon's resources must be free'd via @ref wlmaker_toplevel_icon_destroy.
*/
wlmaker_toplevel_icon_t *wlmaker_toplevel_icon_create(
struct wl_client *wl_client_ptr,
wlmaker_icon_manager_t *icon_manager_ptr,
uint32_t id,
int version,
struct wlr_xdg_toplevel *wlr_xdg_toplevel_ptr,
struct wlr_surface *wlr_surface_ptr)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr = logged_calloc(
1, sizeof(wlmaker_toplevel_icon_t));
if (NULL == toplevel_icon_ptr) return NULL;
toplevel_icon_ptr->wl_client_ptr = wl_client_ptr;
toplevel_icon_ptr->icon_manager_ptr = icon_manager_ptr;
toplevel_icon_ptr->id = id;
toplevel_icon_ptr->wlr_xdg_toplevel_ptr = wlr_xdg_toplevel_ptr;
toplevel_icon_ptr->wlr_surface_ptr = wlr_surface_ptr;
toplevel_icon_ptr->wl_resource_ptr = wl_resource_create(
wl_client_ptr,
&zwlmaker_toplevel_icon_v1_interface,
version,
id);
if (NULL == toplevel_icon_ptr->wl_resource_ptr) {
bs_log(BS_ERROR, "Failed wl_resource_create(%p, %p, %d, %"PRIu32")",
wl_client_ptr, &zwlmaker_toplevel_icon_v1_interface, version,
id);
wlmaker_toplevel_icon_destroy(toplevel_icon_ptr);
return NULL;
}
wl_resource_set_implementation(
toplevel_icon_ptr->wl_resource_ptr,
&toplevel_icon_v1_implementation,
toplevel_icon_ptr,
toplevel_icon_resource_destroy);
if (!wlmtk_tile_init(
&toplevel_icon_ptr->super_tile,
&icon_manager_ptr->server_ptr->style.tile,
icon_manager_ptr->server_ptr->env_ptr)) {
wlmaker_toplevel_icon_destroy(toplevel_icon_ptr);
return NULL;
}
wlmtk_element_extend(
wlmtk_tile_element(&toplevel_icon_ptr->super_tile),
&_wlmaker_toplevel_icon_element_vmt);
wlmtk_element_set_visible(
wlmtk_tile_element(&toplevel_icon_ptr->super_tile),
true);
wlmtk_dock_add_tile(
icon_manager_ptr->server_ptr->clip_dock_ptr,
&toplevel_icon_ptr->super_tile);
toplevel_icon_ptr->content_surface_ptr = wlmtk_surface_create(
wlr_surface_ptr,
icon_manager_ptr->server_ptr->env_ptr);
if (NULL == toplevel_icon_ptr->content_surface_ptr) {
wlmaker_toplevel_icon_destroy(toplevel_icon_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_surface_element(toplevel_icon_ptr->content_surface_ptr),
true);
// Hack: Connect this listener after wlmtk_surface creation, so that the
// surface knows it's size before added...
wlmtk_util_connect_listener_signal(
&toplevel_icon_ptr->wlr_surface_ptr->events.commit,
&toplevel_icon_ptr->surface_commit_listener,
handle_surface_commit);
wlmtk_util_connect_listener_signal(
&toplevel_icon_ptr->wlr_surface_ptr->events.destroy,
&toplevel_icon_ptr->surface_destroy_listener,
handle_surface_destroy);
bs_log(BS_INFO,
"created toplevel icon %p for toplevel %p, surface %p, "
"wlmtk surface %p",
toplevel_icon_ptr, wlr_xdg_toplevel_ptr, wlr_surface_ptr,
toplevel_icon_ptr->content_surface_ptr);
return toplevel_icon_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the toplevel icon.
*
* @param toplevel_icon_ptr
*/
void wlmaker_toplevel_icon_destroy(
wlmaker_toplevel_icon_t *toplevel_icon_ptr)
{
bs_log(BS_INFO, "Destroying toplevel icon %p", toplevel_icon_ptr);
_wlmaker_toplevel_icon_element_destroy(
wlmtk_tile_element(&toplevel_icon_ptr->super_tile));
wlmtk_tile_fini(&toplevel_icon_ptr->super_tile);
// Note: Not destroying toplevel_icon_ptr->resource, since that causes
// cycles...
free(toplevel_icon_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Destructor for the toplevel icon's resource.
*
* @param wl_resource_ptr
*/
void toplevel_icon_resource_destroy(struct wl_resource *wl_resource_ptr)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr =
wlmaker_toplevel_icon_from_resource(wl_resource_ptr);
wlmaker_toplevel_icon_destroy(toplevel_icon_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handles the `ack_configure` request by the icon.
*
* @param wl_client_ptr
* @param wl_resource_ptr
* @param serial
*/
void handle_icon_ack_configure(
__UNUSED__ struct wl_client *wl_client_ptr,
struct wl_resource *wl_resource_ptr,
uint32_t serial)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr =
wlmaker_toplevel_icon_from_resource(wl_resource_ptr);
if (serial == toplevel_icon_ptr->pending_serial) {
toplevel_icon_ptr->acknowledged = true;
toplevel_icon_ptr->pending_serial = 0;
}
}
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `commit` signal of the icon's surface.
*
* The protocol expects a first `commit` with a NULL-buffer attached to the
* surface. This will trigger a `configure` event, informing the client of the
* suggested icon size.
*
* Only when the configuration was suggested and acknowledged a first time,
* will we accept `commit` with attached buffers.
*
* @param listener_ptr
* @param data_ptr Points to the `struct wlr_surface` of the icon.
*/
void handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_toplevel_icon_t, surface_commit_listener);
struct wlr_surface *wlr_surface_ptr = data_ptr;
BS_ASSERT(toplevel_icon_ptr->wlr_surface_ptr == wlr_surface_ptr);
if (NULL == wlr_surface_ptr->buffer) {
// An initial commit is expected with a NULL buffer, so we can
// respond with a `configure` event.
toplevel_icon_ptr->pending_serial = wl_display_next_serial(
toplevel_icon_ptr->icon_manager_ptr->wl_display_ptr);
zwlmaker_toplevel_icon_v1_send_configure(
toplevel_icon_ptr->wl_resource_ptr,
64, 64,
toplevel_icon_ptr->pending_serial);
return;
}
BS_ASSERT(NULL != wlr_surface_ptr->buffer);
if (!toplevel_icon_ptr->acknowledged) {
wl_resource_post_error(
toplevel_icon_ptr->wl_resource_ptr,
1,
"Commit non-NULL buffer without configure sequence.");
return;
}
wlmtk_tile_set_content(
&toplevel_icon_ptr->super_tile,
wlmtk_surface_element(toplevel_icon_ptr->content_surface_ptr));
}
/* ------------------------------------------------------------------------- */
/** Handles when the surface is destroyed. */
static void handle_surface_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_toplevel_icon_t, surface_destroy_listener);
_wlmaker_toplevel_icon_element_destroy(
wlmtk_tile_element(&toplevel_icon_ptr->super_tile));
}
/* ------------------------------------------------------------------------- */
/**
* Destructor of the icon's corresponding tile element.
*
* This is a hack: The `wlmaker_toplevel_icon_t` is owned by the wl_resource
* and must only be freed when that dtor is caller. But, the element dtor may
* be called on wlmaker shutdown, when eg. an icon app is still running.
* So, for that case, we just detach the icon here.
*
* Leaving as is, since the icon model will need to be revamped anyway, to
* line up with the new XDG icon protocol.
*
* @param element_ptr
*/
void _wlmaker_toplevel_icon_element_destroy(wlmtk_element_t *element_ptr)
{
wlmaker_toplevel_icon_t *toplevel_icon_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_toplevel_icon_t,
super_tile.super_container.super_element);
if (NULL != toplevel_icon_ptr->content_surface_ptr) {
wlmtk_util_disconnect_listener(
&toplevel_icon_ptr->surface_destroy_listener);
wlmtk_util_disconnect_listener(
&toplevel_icon_ptr->surface_commit_listener);
wlmtk_tile_set_content(&toplevel_icon_ptr->super_tile, NULL);
wlmtk_surface_destroy(toplevel_icon_ptr->content_surface_ptr);
toplevel_icon_ptr->content_surface_ptr = NULL;
}
if (wlmtk_tile_element(&toplevel_icon_ptr->super_tile
)->parent_container_ptr) {
wlmtk_dock_remove_tile(
toplevel_icon_ptr->icon_manager_ptr->server_ptr->clip_dock_ptr,
&toplevel_icon_ptr->super_tile);
}
}
/* == End of icon_manager.c ================================================ */
wlmaker-0.3/src/icon_manager.h 0000664 0000000 0000000 00000003355 14641446446 0016423 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file icon_manager.h
*
* @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.
*/
#ifndef __ICON_MANAGER_H__
#define __ICON_MANAGER_H__
#include
/** Forward declaration: Icon Manager handle. */
typedef struct _wlmaker_icon_manager_t wlmaker_icon_manager_t;
/** Forward declaration: Toplevel icon handle. */
typedef struct _wlmaker_toplevel_icon_t wlmaker_toplevel_icon_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates an icon manager.
*
* @param wl_display_ptr
* @param server_ptr
*
* @return The handle of the icon manager or NULL on error. Must be destroyed
* by calling @ref wlmaker_icon_manager_destroy.
*/
wlmaker_icon_manager_t *wlmaker_icon_manager_create(
struct wl_display *wl_display_ptr,
wlmaker_server_t *server_ptr);
/**
* Destroys the Icon Manager.
*
* @param icon_manager_ptr
*/
void wlmaker_icon_manager_destroy(
wlmaker_icon_manager_t *icon_manager_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __ICON_MANAGER_H__ */
/* == End of icon_manager.h ================================================ */
wlmaker-0.3/src/idle.c 0000664 0000000 0000000 00000033062 14641446446 0014707 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file idle.c
*
* @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.
*/
#include "idle.h"
#include "config.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** Forward declaration: Handle of an idle inhibitor. */
typedef struct _wlmaker_idle_inhibitor_t wlmaker_idle_inhibitor_t;
/** State of the idle monitor. */
struct _wlmaker_idle_monitor_t {
/** Back-link to the server. */
wlmaker_server_t *server_ptr;
/** Dictionnary holding the 'ScreenLock' configuration. */
wlmcfg_dict_t *lock_config_dict_ptr;
/** Reference to the event loop. */
struct wl_event_loop *wl_event_loop_ptr;
/** The timer's event source. */
struct wl_event_source *timer_event_source_ptr;
/** Listener for `new_inhibitor` of wlr_idle_inhibit_manager_v1`. */
struct wl_listener new_inhibitor_listener;
/** Lists registered inhibitors: @ref wlmaker_idle_inhibitor_t::dlnode. */
bs_dllist_t idle_inhibitors;
/** Listener for @ref wlmtk_root_events_t::unlock_event. */
struct wl_listener unlock_listener;
/** The wlroots idle inhibit manager. */
struct wlr_idle_inhibit_manager_v1 *wlr_idle_inhibit_manager_v1_ptr;
/** Whether the idle monitor is locked. Prevents timer registry. */
bool locked;
};
/** State of an idle inhibitor. */
struct _wlmaker_idle_inhibitor_t {
/** Back-link to the idle monitor. */
wlmaker_idle_monitor_t *idle_monitor_ptr;
/** The idle inhibitor tied to this inhibitor. */
struct wlr_idle_inhibitor_v1 *wlr_idle_inhibitor_v1_ptr;
/** List node, part of @ref wlmaker_idle_monitor_t::idle_inhibitors. */
bs_dllist_node_t dlnode;
/** Listener for the `destroy` signal of `wlr_idle_inhibitor_v1`. */
struct wl_listener destroy_listener;
};
static int _wlmaker_idle_monitor_timer(void *data_ptr);
static int _wlmaker_idle_msec(wlmaker_idle_monitor_t *idle_monitor_ptr);
static bool _wlmaker_idle_monitor_add_inhibitor(
wlmaker_idle_monitor_t *idle_monitor_ptr,
struct wlr_idle_inhibitor_v1 *wlr_idle_inhibitor_v1_ptr);
static void _wlmaker_idle_monitor_handle_destroy_inhibitor(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_idle_monitor_handle_new_inhibitor(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_idle_monitor_handle_unlock(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_idle_monitor_t *wlmaker_idle_monitor_create(
wlmaker_server_t *server_ptr)
{
wlmaker_idle_monitor_t *monitor_ptr = logged_calloc(
1, sizeof(wlmaker_idle_monitor_t));
if (NULL == monitor_ptr) return NULL;
monitor_ptr->server_ptr = server_ptr;
monitor_ptr->wl_event_loop_ptr = wl_display_get_event_loop(
server_ptr->wl_display_ptr);
monitor_ptr->lock_config_dict_ptr = wlmcfg_dict_ref(
wlmcfg_dict_get_dict(server_ptr->config_dict_ptr, "ScreenLock"));
if (NULL == monitor_ptr->lock_config_dict_ptr) {
bs_log(BS_ERROR, "No 'ScreenLock' dict found in config.");
wlmaker_idle_monitor_destroy(monitor_ptr);
return NULL;
}
monitor_ptr->wlr_idle_inhibit_manager_v1_ptr =
wlr_idle_inhibit_v1_create(server_ptr->wl_display_ptr);
if (NULL == monitor_ptr->wlr_idle_inhibit_manager_v1_ptr) {
bs_log(BS_ERROR, "Failed wlr_idle_inhibit_v1_create(%p)",
server_ptr->wl_display_ptr);
wlmaker_idle_monitor_destroy(monitor_ptr);
return NULL;
}
wlmtk_util_connect_listener_signal(
&monitor_ptr->wlr_idle_inhibit_manager_v1_ptr->events.new_inhibitor,
&monitor_ptr->new_inhibitor_listener,
_wlmaker_idle_monitor_handle_new_inhibitor);
monitor_ptr->timer_event_source_ptr = wl_event_loop_add_timer(
monitor_ptr->wl_event_loop_ptr,
_wlmaker_idle_monitor_timer,
monitor_ptr);
if (NULL == monitor_ptr->timer_event_source_ptr) {
bs_log(BS_ERROR, "Failed wl_event_loop_add_timer(%p, %p, %p)",
monitor_ptr->wl_event_loop_ptr,
_wlmaker_idle_monitor_timer,
monitor_ptr);
wlmaker_idle_monitor_destroy(monitor_ptr);
return NULL;
}
if (0 != wl_event_source_timer_update(
monitor_ptr->timer_event_source_ptr,
_wlmaker_idle_msec(monitor_ptr))) {
bs_log(BS_ERROR, "Failed wl_event_source_timer_update(%p, 1000)",
monitor_ptr->timer_event_source_ptr);
wlmaker_idle_monitor_destroy(monitor_ptr);
return NULL;
}
return monitor_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_idle_monitor_destroy(wlmaker_idle_monitor_t *idle_monitor_ptr)
{
if (NULL != idle_monitor_ptr->unlock_listener.link.prev) {
wl_list_remove(&idle_monitor_ptr->unlock_listener.link);
}
if (NULL != idle_monitor_ptr->timer_event_source_ptr) {
wl_event_source_remove(idle_monitor_ptr->timer_event_source_ptr);
idle_monitor_ptr->timer_event_source_ptr = NULL;
}
if (NULL != idle_monitor_ptr->lock_config_dict_ptr) {
wlmcfg_dict_unref(idle_monitor_ptr->lock_config_dict_ptr);
idle_monitor_ptr->lock_config_dict_ptr = NULL;
}
// Note: The idle inhibit manager does not have a dtor.
free(idle_monitor_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_idle_monitor_reset(wlmaker_idle_monitor_t *idle_monitor_ptr)
{
if (idle_monitor_ptr->locked) return;
int rv = wl_event_source_timer_update(
idle_monitor_ptr->timer_event_source_ptr,
_wlmaker_idle_msec(idle_monitor_ptr));
BS_ASSERT(0 == rv);
}
/* ------------------------------------------------------------------------- */
bool wlmaker_idle_monitor_lock(wlmaker_idle_monitor_t *idle_monitor_ptr)
{
const char *cmd_ptr = wlmcfg_dict_get_string_value(
idle_monitor_ptr->lock_config_dict_ptr, "Command");
if (NULL == cmd_ptr) {
bs_log(BS_WARNING, "No 'Command' configured in 'ScreenLock' config.");
return false;
}
bs_subprocess_t *subprocess_ptr = bs_subprocess_create_cmdline(cmd_ptr);
if (NULL == subprocess_ptr) {
bs_log(BS_WARNING, "Failed bs_subprocess_create_cmdline(\"%s\")",
cmd_ptr);
return false;
}
if (!bs_subprocess_start(subprocess_ptr)) {
bs_log(BS_WARNING, "Failed bs_subprocess_start(%p) for \"%s\".",
subprocess_ptr, cmd_ptr);
bs_subprocess_destroy(subprocess_ptr);
return false;
}
wlmaker_subprocess_handle_t *handle_ptr =
wlmaker_subprocess_monitor_entrust(
idle_monitor_ptr->server_ptr->monitor_ptr,
subprocess_ptr,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL);
if (NULL != handle_ptr) {
wlmaker_subprocess_monitor_cede(
idle_monitor_ptr->server_ptr->monitor_ptr, handle_ptr);
}
return true;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Timer function for the wayland event loop.
*
* @param data_ptr Untyped pointer to @ref wlmaker_idle_monitor_t.
*
* @return Whether the event source is registered for re-check with
* wl_event_source_check(): 0 for all done, 1 for needing a re-check. If
* not registered, the return value is ignored and should be zero.
*/
int _wlmaker_idle_monitor_timer(void *data_ptr)
{
wlmaker_idle_monitor_t *idle_monitor_ptr = data_ptr;
if (!wlmaker_idle_monitor_lock(idle_monitor_ptr)) return 0;
wlmtk_root_t *root_ptr = idle_monitor_ptr->server_ptr->root_ptr;
idle_monitor_ptr->locked = true;
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(root_ptr)->unlock_event,
&idle_monitor_ptr->unlock_listener,
_wlmaker_idle_monitor_handle_unlock);
return 0;
}
/* ------------------------------------------------------------------------- */
/**
* Returnss the idle timeout time in milliseconds.
*
* @param idle_monitor_ptr
*
* @return The idle timeout, read from the config dictionnary. If no or a
* negative value was configured, 0 is returned, indicating the timer
* to NOT be armed.
*/
int _wlmaker_idle_msec(wlmaker_idle_monitor_t *idle_monitor_ptr)
{
const char *idle_seconds_ptr = wlmcfg_dict_get_string_value(
idle_monitor_ptr->lock_config_dict_ptr, "IdleSeconds");
if (NULL == idle_seconds_ptr) return 0;
uint64_t seconds;
if (!bs_strconvert_uint64(idle_seconds_ptr, &seconds, 10) ||
seconds >= (INT32_MAX / 1000)) {
bs_log(BS_WARNING, "Bad value for 'IdleSeconds': %s",
idle_seconds_ptr);
return 0;
}
if (0 >= seconds) return 0;
return 1000 * seconds;
}
/* ------------------------------------------------------------------------- */
/**
* Creates and adds a new inhibitor to the monitor.
*
* @param idle_monitor_ptr
* @param wlr_idle_inhibitor_v1_ptr
*
* @return true on success.
*/
bool _wlmaker_idle_monitor_add_inhibitor(
wlmaker_idle_monitor_t *idle_monitor_ptr,
struct wlr_idle_inhibitor_v1 *wlr_idle_inhibitor_v1_ptr)
{
wlmaker_idle_inhibitor_t *idle_inhibitor_ptr = logged_calloc(
1, sizeof(wlmaker_idle_inhibitor_t));
if (NULL == idle_inhibitor_ptr) return false;
idle_inhibitor_ptr->idle_monitor_ptr = idle_monitor_ptr;
idle_inhibitor_ptr->wlr_idle_inhibitor_v1_ptr = wlr_idle_inhibitor_v1_ptr;
wlmtk_util_connect_listener_signal(
&wlr_idle_inhibitor_v1_ptr->events.destroy,
&idle_inhibitor_ptr->destroy_listener,
_wlmaker_idle_monitor_handle_destroy_inhibitor);
bs_dllist_push_back(&idle_monitor_ptr->idle_inhibitors,
&idle_inhibitor_ptr->dlnode);
// Coming here: We know to have at least 1 inhibitor.
if (0 != wl_event_source_timer_update(
idle_monitor_ptr->timer_event_source_ptr, 0)) {
// Huh. Failed. We'll keep the inhibitor nonetheless. Yes?
bs_log(BS_WARNING, "Failed wl_event_source_timer_update(%p, 0)",
idle_monitor_ptr->timer_event_source_ptr);
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of the inhibitor. Destroys it.
*
* @param listener_ptr
* @param data_ptr Unused.
*/
void _wlmaker_idle_monitor_handle_destroy_inhibitor(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_idle_inhibitor_t *idle_inhibitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_idle_inhibitor_t, destroy_listener);
bs_dllist_remove(
&idle_inhibitor_ptr->idle_monitor_ptr->idle_inhibitors,
&idle_inhibitor_ptr->dlnode);
if (bs_dllist_empty(
&idle_inhibitor_ptr->idle_monitor_ptr->idle_inhibitors)) {
wlmaker_idle_monitor_reset(idle_inhibitor_ptr->idle_monitor_ptr);
}
wl_list_remove(&idle_inhibitor_ptr->destroy_listener.link);
free(idle_inhibitor_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `new_inhibitor` signal of the inhibit manager: Registers
* the inhibitor.
*
* @param listener_ptr
* @param data_ptr Pointer to struct wlr_idle_inhibitor_v1.
*/
static void _wlmaker_idle_monitor_handle_new_inhibitor(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_idle_monitor_t *idle_monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_idle_monitor_t, new_inhibitor_listener);
struct wlr_idle_inhibitor_v1 *wlr_idle_inhibitor_v1_ptr = data_ptr;
if (!_wlmaker_idle_monitor_add_inhibitor(
idle_monitor_ptr,
wlr_idle_inhibitor_v1_ptr)) {
wl_resource_post_error(
wlr_idle_inhibitor_v1_ptr->resource,
WL_DISPLAY_ERROR_NO_MEMORY,
"Failed _wlmaker_idle_monitor_add_inhibitor(%p, %p)",
idle_monitor_ptr,
wlr_idle_inhibitor_v1_ptr);
return;
}
}
/* ------------------------------------------------------------------------- */
/**
* Handler for @ref wlmtk_root_events_t::unlock_event. Re-arms the timer.
*
* @param listener_ptr
* @param data_ptr unused.
*/
void _wlmaker_idle_monitor_handle_unlock(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_idle_monitor_t *idle_monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_idle_monitor_t, unlock_listener);
wl_list_remove(&idle_monitor_ptr->unlock_listener.link);
idle_monitor_ptr->locked = false;
wlmaker_idle_monitor_reset(idle_monitor_ptr);
}
/* == End of idle.c ======================================================== */
wlmaker-0.3/src/idle.h 0000664 0000000 0000000 00000003441 14641446446 0014712 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file idle.h
*
* @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.
*/
#ifndef __IDLE_H__
#define __IDLE_H__
/** Forward declaration: Idle monitor handle. */
typedef struct _wlmaker_idle_monitor_t wlmaker_idle_monitor_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates the idle monitor.
*
* @param server_ptr
*
* @return Handle of the idle monitor or NULL on error.
*/
wlmaker_idle_monitor_t *wlmaker_idle_monitor_create(
wlmaker_server_t *server_ptr);
/**
* Destroys the idle monitor.
*
* @param idle_monitor_ptr
*/
void wlmaker_idle_monitor_destroy(wlmaker_idle_monitor_t *idle_monitor_ptr);
/**
* Resets the idle monitor: For example, when a key is pressed.
*
* @param idle_monitor_ptr
*/
void wlmaker_idle_monitor_reset(wlmaker_idle_monitor_t *idle_monitor_ptr);
/**
* Executes the configured 'Command' for locking.
*
* @param idle_monitor_ptr
*
* @return true on success.
*/
bool wlmaker_idle_monitor_lock(wlmaker_idle_monitor_t *idle_monitor_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __IDLE_H__ */
/* == End of idle.h ======================================================== */
wlmaker-0.3/src/keyboard.c 0000664 0000000 0000000 00000024737 14641446446 0015603 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file keyboard.c
*
* @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.
*/
#include "keyboard.h"
#include "config.h"
#include "toolkit/toolkit.h"
#include "server.h"
/* == Declarations ========================================================= */
/** Keyboard handle. */
struct _wlmaker_keyboard_t {
/** Configuration dictionnary, just the "Keyboard" section. */
wlmcfg_dict_t *config_dict_ptr;
/** Back-link to the server. */
wlmaker_server_t *server_ptr;
/** The wlroots keyboard structure. */
struct wlr_keyboard *wlr_keyboard_ptr;
/** The wlroots seat. */
struct wlr_seat *wlr_seat_ptr;
/** Listener for the `modifiers` signal of `wl_keyboard`. */
struct wl_listener modifiers_listener;
/** Listener for the `key` signal of `wl_keyboard`. */
struct wl_listener key_listener;
};
static bool _wlmaker_keyboard_populate_rules(
wlmcfg_dict_t *dict_ptr,
struct xkb_rule_names *rules_ptr);
static bool _wlmaker_keyboard_populate_repeat(
wlmcfg_dict_t *dict_ptr,
int32_t *rate_ptr,
int32_t *delay_ptr);
static void handle_key(struct wl_listener *listener_ptr, void *data_ptr);
static void handle_modifiers(struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_keyboard_t *wlmaker_keyboard_create(
wlmaker_server_t *server_ptr,
struct wlr_keyboard *wlr_keyboard_ptr,
struct wlr_seat *wlr_seat_ptr)
{
wlmaker_keyboard_t *keyboard_ptr = logged_calloc(
1, sizeof(wlmaker_keyboard_t));
if (NULL == keyboard_ptr) return NULL;
keyboard_ptr->server_ptr = server_ptr;
keyboard_ptr->wlr_keyboard_ptr = wlr_keyboard_ptr;
keyboard_ptr->wlr_seat_ptr = wlr_seat_ptr;
// Retrieve configuration.
wlmcfg_dict_t *config_dict_ptr = wlmcfg_dict_get_dict(
server_ptr->config_dict_ptr, "Keyboard");
if (NULL == config_dict_ptr) {
bs_log(BS_ERROR, "Failed to retrieve \"Keyboard\" dict from config.");
wlmaker_keyboard_destroy(keyboard_ptr);
return NULL;
}
keyboard_ptr->config_dict_ptr = BS_ASSERT_NOTNULL(
wlmcfg_dict_ref(config_dict_ptr));
struct xkb_rule_names xkb_rule;
if (!_wlmaker_keyboard_populate_rules(
keyboard_ptr->config_dict_ptr, &xkb_rule)) {
bs_log(BS_ERROR, "No rule data found in 'Keyboard' dict.");
wlmaker_keyboard_destroy(keyboard_ptr);
return NULL;
}
// Set keyboard layout.
struct xkb_context *xkb_context_ptr = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
struct xkb_keymap *xkb_keymap_ptr = xkb_keymap_new_from_names(
xkb_context_ptr, &xkb_rule, XKB_KEYMAP_COMPILE_NO_FLAGS);
if (NULL == xkb_keymap_ptr) {
bs_log(BS_ERROR, "Failed xkb_keymap_new_from_names(%p, { .rules = %s, "
".model = %s, .layout = %s, variant = %s, .options = %s }, "
"XKB_KEYMAP_COMPILE_NO_NO_FLAGS)",
xkb_context_ptr,
xkb_rule.rules,
xkb_rule.model,
xkb_rule.layout,
xkb_rule.variant,
xkb_rule.options);
wlmaker_keyboard_destroy(keyboard_ptr);
return NULL;
}
wlr_keyboard_set_keymap(keyboard_ptr->wlr_keyboard_ptr, xkb_keymap_ptr);
xkb_keymap_unref(xkb_keymap_ptr);
xkb_context_unref(xkb_context_ptr);
// Repeat rate and delay.
int32_t rate, delay;
if (!_wlmaker_keyboard_populate_repeat(
keyboard_ptr->config_dict_ptr, &rate, &delay)) {
bs_log(BS_ERROR, "No repeat data found in 'Keyboard' dict.");
wlmaker_keyboard_destroy(keyboard_ptr);
return NULL;
}
wlr_keyboard_set_repeat_info(keyboard_ptr->wlr_keyboard_ptr, rate, delay);
wlmtk_util_connect_listener_signal(
&keyboard_ptr->wlr_keyboard_ptr->events.key,
&keyboard_ptr->key_listener,
handle_key);
wlmtk_util_connect_listener_signal(
&keyboard_ptr->wlr_keyboard_ptr->events.modifiers,
&keyboard_ptr->modifiers_listener,
handle_modifiers);
wlr_seat_set_keyboard(wlr_seat_ptr, keyboard_ptr->wlr_keyboard_ptr);
return keyboard_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_keyboard_destroy(wlmaker_keyboard_t *keyboard_ptr)
{
wl_list_remove(&keyboard_ptr->key_listener.link);
wl_list_remove(&keyboard_ptr->modifiers_listener.link);
if (NULL != keyboard_ptr->config_dict_ptr) {
wlmcfg_dict_unref(keyboard_ptr->config_dict_ptr);
keyboard_ptr->config_dict_ptr = NULL;
}
free(keyboard_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Populates the XKB rules struct from the config dict.
*
* @param dict_ptr
* @param rules_ptr
*
* @return true on success
*/
bool _wlmaker_keyboard_populate_rules(
wlmcfg_dict_t *dict_ptr,
struct xkb_rule_names *rules_ptr)
{
dict_ptr = wlmcfg_dict_get_dict(dict_ptr, "XkbRMLVO");
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "No 'XkbRMLVO' dict in 'Keyboard' dict.");
return false;
}
rules_ptr->rules = wlmcfg_dict_get_string_value(dict_ptr, "Rules");
rules_ptr->model = wlmcfg_dict_get_string_value(dict_ptr, "Model");
rules_ptr->layout = wlmcfg_dict_get_string_value(dict_ptr, "Layout");
rules_ptr->variant = wlmcfg_dict_get_string_value(dict_ptr, "Variant");
rules_ptr->options = wlmcfg_dict_get_string_value(dict_ptr, "Options");
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Retrieves and converts the 'Repeat' parameters from the config dict.
*
* @param dict_ptr
* @param rate_ptr
* @param delay_ptr
*
* @return true on success.
*/
bool _wlmaker_keyboard_populate_repeat(
wlmcfg_dict_t *dict_ptr,
int32_t *rate_ptr,
int32_t *delay_ptr)
{
dict_ptr = wlmcfg_dict_get_dict(dict_ptr, "Repeat");
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "No 'Repeat' dict in 'Keyboard' dict.");
return false;
}
uint64_t value;
if (!bs_strconvert_uint64(
wlmcfg_dict_get_string_value(dict_ptr, "Delay"),
&value, 10) ||
value > INT32_MAX) {
bs_log(BS_ERROR, "Invalid value for 'Delay': %s",
wlmcfg_dict_get_string_value(dict_ptr, "Delay"));
return false;
}
*delay_ptr = value;
if (!bs_strconvert_uint64(
wlmcfg_dict_get_string_value(dict_ptr, "Rate"),
&value, 10) ||
value > INT32_MAX) {
bs_log(BS_ERROR, "Invalid value for 'Rate': %s",
wlmcfg_dict_get_string_value(dict_ptr, "Rate"));
return false;
}
*rate_ptr = value;
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Handles `key` signals, ie. key presses.
*
* @param listener_ptr
* @param data_ptr Points to a `wlr_keyboard_key_event`.
*/
void handle_key(struct wl_listener *listener_ptr, void *data_ptr)
{
wlmaker_keyboard_t *keyboard_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_keyboard_t, key_listener);
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr = data_ptr;
wlmaker_idle_monitor_reset(keyboard_ptr->server_ptr->idle_monitor_ptr);
// TODO(kaeser@gubbe.ch): Omit consumed modifiers, see xkbcommon.h.
uint32_t modifiers = wlr_keyboard_get_modifiers(
keyboard_ptr->wlr_keyboard_ptr);
// TODO(kaeser@gubbe.ch): Handle this better -- should respect the
// modifiers of the task list actions, and be more generalized.
if ((modifiers & WLR_MODIFIER_ALT) != WLR_MODIFIER_ALT &&
keyboard_ptr->server_ptr->task_list_enabled) {
wlmaker_server_deactivate_task_list(keyboard_ptr->server_ptr);
}
// For key presses: Pass them on to the server, for potential key bindings.
bool processed = false;
if (WL_KEYBOARD_KEY_STATE_PRESSED == wlr_keyboard_key_event_ptr->state) {
// Translates libinput keycode -> xkbcommon.
uint32_t keycode = wlr_keyboard_key_event_ptr->keycode + 8;
// A key may have multiple syms associated; get them here.
const xkb_keysym_t *key_syms;
int key_syms_count = xkb_state_key_get_syms(
keyboard_ptr->wlr_keyboard_ptr->xkb_state, keycode, &key_syms);
for (int i = 0; i < key_syms_count; ++i) {
processed = wlmaker_keyboard_process_bindings(
keyboard_ptr->server_ptr, key_syms[i], modifiers);
}
}
if (processed) return;
wlmtk_element_keyboard_event(
wlmtk_root_element(keyboard_ptr->server_ptr->root_ptr),
wlr_keyboard_key_event_ptr,
NULL,
0,
modifiers);
}
/* ------------------------------------------------------------------------- */
/**
* Handles `modifiers` signals, ie. updates to the modifiers.
*
* @param listener_ptr
* @param data_ptr Points to wlr_keyboard.
*/
void handle_modifiers(struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_keyboard_t *keyboard_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_keyboard_t, modifiers_listener);
wlmaker_idle_monitor_reset(keyboard_ptr->server_ptr->idle_monitor_ptr);
uint32_t modifiers = wlr_keyboard_get_modifiers(
keyboard_ptr->wlr_keyboard_ptr);
if ((modifiers & WLR_MODIFIER_ALT) != WLR_MODIFIER_ALT) {
wlmaker_server_deactivate_task_list(keyboard_ptr->server_ptr);
}
wlr_seat_set_keyboard(
keyboard_ptr->wlr_seat_ptr,
keyboard_ptr->wlr_keyboard_ptr);
wlr_seat_keyboard_notify_modifiers(
keyboard_ptr->wlr_seat_ptr,
&keyboard_ptr->wlr_keyboard_ptr->modifiers);
}
/* == End of keyboard.c ==================================================== */
wlmaker-0.3/src/keyboard.h 0000664 0000000 0000000 00000003256 14641446446 0015601 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file keyboard.h
*
* @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.
*/
#ifndef __WLMAKER_KEYBOARD_H__
#define __WLMAKER_KEYBOARD_H__
#include "server.h"
#include
#define WLR_USE_UNSTABLE
#include
#include
#undef WLR_USE_UNSTABLE
/** Type of the keyboard handle. */
typedef struct _wlmaker_keyboard_t wlmaker_keyboard_t;
/**
* Creates a handle for a registered keyboard.
*
* @param server_ptr
* @param wlr_keyboard_ptr
* @param wlr_seat_ptr
*
* @return The handle or NULL on error. Free via wlmaker_keyboard_destroy().
*/
wlmaker_keyboard_t *wlmaker_keyboard_create(
wlmaker_server_t *server_ptr,
struct wlr_keyboard *wlr_keyboard_ptr,
struct wlr_seat *wlr_seat_ptr);
/**
* Destroys the keyboard handle.
*
* @param keyboard_ptr
*/
void wlmaker_keyboard_destroy(wlmaker_keyboard_t *keyboard_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMAKER_KEYBOARD_H__ */
/* == End of keyboard.h ==================================================== */
wlmaker-0.3/src/launcher.c 0000664 0000000 0000000 00000046415 14641446446 0015601 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file launcher.c
* Copyright (c) 2024 by Philipp Kaeser
*/
#include "launcher.h"
#include
#include
#include
#include "conf/decode.h"
#include "conf/plist.h"
/* == Declarations ========================================================= */
/** State of a launcher. */
struct _wlmaker_launcher_t {
/** The launcher is derived from a @ref wlmtk_tile_t. */
wlmtk_tile_t super_tile;
/** Original virtual method table fo the element. */
wlmtk_element_vmt_t orig_element_vmt;
/** Image element. One element of @ref wlmaker_launcher_t::super_tile. */
wlmtk_image_t *image_ptr;
/** Overlay element. Atop on the tile. */
wlmtk_buffer_t overlay_buffer;
/** Subprocess monitor to register launched processes to. */
wlmaker_subprocess_monitor_t *monitor_ptr;
/** Commandline to launch the associated application. */
char *cmdline_ptr;
/** Path to the icon. */
char *icon_path_ptr;
/** Windows that are running from subprocesses of this App (launcher). */
bs_ptr_set_t *created_windows_ptr;
/** Windows that are mapped from subprocesses of this App (launcher). */
bs_ptr_set_t *mapped_windows_ptr;
/** Subprocesses that were created by this launcher. */
bs_ptr_set_t *subprocesses_ptr;
};
/** Plist descroptor for a launcher. */
static const wlmcfg_desc_t _wlmaker_launcher_plist_desc[] = {
WLMCFG_DESC_STRING(
"CommandLine", true, wlmaker_launcher_t, cmdline_ptr, ""),
WLMCFG_DESC_STRING(
"Icon", true, wlmaker_launcher_t, icon_path_ptr, ""),
WLMCFG_DESC_SENTINEL(),
};
/** Lookup paths for icons. */
static const char *lookup_paths[] = {
"/usr/share/icons/wlmaker",
"/usr/local/share/icons/wlmaker",
#if defined(WLMAKER_SOURCE_DIR)
WLMAKER_SOURCE_DIR "/icons",
#endif // WLMAKER_SOURCE_DIR
#if defined(WLMAKER_ICON_DATA_DIR)
WLMAKER_ICON_DATA_DIR,
#endif // WLMAKER_ICON_DATA_DIR
NULL
};
static void _wlmaker_launcher_update_overlay(wlmaker_launcher_t *launcher_ptr);
static struct wlr_buffer *_wlmaker_launcher_create_overlay_buffer(
wlmaker_launcher_t *launcher_ptr);
static void _wlmaker_launcher_element_destroy(
wlmtk_element_t *element_ptr);
static bool _wlmaker_launcher_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void _wlmaker_launcher_start(wlmaker_launcher_t *launcher_ptr);
static void _wlmaker_launcher_handle_terminated(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
int state,
int code);
static void _wlmaker_launcher_handle_window_created(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr);
static void _wlmaker_launcher_handle_window_mapped(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr);
static void _wlmaker_launcher_handle_window_unmapped(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr);
static void _wlmaker_launcher_handle_window_destroyed(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr);
/* == Data ================================================================= */
/** The launcher's extension to @ref wlmtk_element_t virtual method table. */
static const wlmtk_element_vmt_t _wlmaker_launcher_element_vmt = {
.destroy = _wlmaker_launcher_element_destroy,
.pointer_button = _wlmaker_launcher_pointer_button,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_launcher_t *wlmaker_launcher_create_from_plist(
const wlmtk_tile_style_t *style_ptr,
wlmcfg_dict_t *dict_ptr,
wlmaker_subprocess_monitor_t *monitor_ptr,
wlmtk_env_t *env_ptr)
{
wlmaker_launcher_t *launcher_ptr = logged_calloc(
1, sizeof(wlmaker_launcher_t));
if (NULL == launcher_ptr) return NULL;
launcher_ptr->monitor_ptr = monitor_ptr;
if (!wlmtk_tile_init(&launcher_ptr->super_tile, style_ptr, env_ptr)) {
return NULL;
}
launcher_ptr->orig_element_vmt = wlmtk_element_extend(
wlmtk_tile_element(&launcher_ptr->super_tile),
&_wlmaker_launcher_element_vmt);
wlmtk_element_set_visible(
wlmtk_tile_element(&launcher_ptr->super_tile), true);
launcher_ptr->created_windows_ptr = bs_ptr_set_create();
if (NULL == launcher_ptr->created_windows_ptr) {
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
launcher_ptr->mapped_windows_ptr = bs_ptr_set_create();
if (NULL == launcher_ptr->mapped_windows_ptr) {
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
launcher_ptr->subprocesses_ptr = bs_ptr_set_create();
if (NULL == launcher_ptr->subprocesses_ptr) {
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
if (!wlmtk_buffer_init(&launcher_ptr->overlay_buffer, env_ptr)) {
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_buffer_element(&launcher_ptr->overlay_buffer), true);
_wlmaker_launcher_update_overlay(launcher_ptr);
wlmtk_tile_set_overlay(
&launcher_ptr->super_tile,
wlmtk_buffer_element(&launcher_ptr->overlay_buffer));
if (!wlmcfg_decode_dict(
dict_ptr, _wlmaker_launcher_plist_desc, launcher_ptr)) {
bs_log(BS_ERROR, "Failed to create launcher from plist dict.");
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
// Resolves to a full path, and verifies the icon file exists.
char full_path[PATH_MAX];
char *path_ptr = bs_file_resolve_and_lookup_from_paths(
BS_ASSERT_NOTNULL(launcher_ptr->icon_path_ptr),
lookup_paths, 0, full_path);
if (NULL == path_ptr) {
bs_log(BS_ERROR | BS_ERRNO,
"Failed bs_file_resolve_and_lookup_from_paths(\"%s\" ...)",
launcher_ptr->icon_path_ptr);
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
launcher_ptr->image_ptr = wlmtk_image_create(path_ptr, env_ptr);
if (NULL == launcher_ptr->image_ptr) {
wlmaker_launcher_destroy(launcher_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_image_element(launcher_ptr->image_ptr), true);
wlmtk_tile_set_content(
&launcher_ptr->super_tile,
wlmtk_image_element(launcher_ptr->image_ptr));
return launcher_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_launcher_destroy(wlmaker_launcher_t *launcher_ptr)
{
if (NULL != launcher_ptr->image_ptr) {
wlmtk_tile_set_content(&launcher_ptr->super_tile, NULL);
wlmtk_image_destroy(launcher_ptr->image_ptr);
launcher_ptr->image_ptr = NULL;
}
wlmtk_tile_set_overlay(&launcher_ptr->super_tile, NULL);
wlmtk_buffer_fini(&launcher_ptr->overlay_buffer);
if (NULL != launcher_ptr->subprocesses_ptr) {
wlmaker_subprocess_handle_t *subprocess_handle_ptr;
while (NULL != (subprocess_handle_ptr = bs_ptr_set_any(
launcher_ptr->subprocesses_ptr))) {
wlmaker_subprocess_monitor_cede(
launcher_ptr->monitor_ptr,
subprocess_handle_ptr);
bs_ptr_set_erase(launcher_ptr->subprocesses_ptr,
subprocess_handle_ptr);
}
bs_ptr_set_destroy(launcher_ptr->subprocesses_ptr);
launcher_ptr->subprocesses_ptr = NULL;
}
if (NULL != launcher_ptr->mapped_windows_ptr) {
bs_ptr_set_destroy(launcher_ptr->mapped_windows_ptr);
launcher_ptr->mapped_windows_ptr = NULL;
}
if (NULL != launcher_ptr->created_windows_ptr) {
bs_ptr_set_destroy(launcher_ptr->created_windows_ptr);
launcher_ptr->created_windows_ptr = NULL;
}
if (NULL != launcher_ptr->cmdline_ptr) {
free(launcher_ptr->cmdline_ptr);
launcher_ptr->cmdline_ptr = NULL;
}
if (NULL != launcher_ptr->icon_path_ptr) {
free(launcher_ptr->icon_path_ptr);
launcher_ptr->icon_path_ptr = NULL;
}
wlmtk_tile_fini(&launcher_ptr->super_tile);
free(launcher_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_tile_t *wlmaker_launcher_tile(wlmaker_launcher_t *launcher_ptr)
{
return &launcher_ptr->super_tile;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Redraws the overlay element. */
void _wlmaker_launcher_update_overlay(wlmaker_launcher_t *launcher_ptr)
{
struct wlr_buffer *wlr_buffer_ptr = _wlmaker_launcher_create_overlay_buffer(
launcher_ptr);
if (NULL == wlr_buffer_ptr) return;
wlmtk_buffer_set(&launcher_ptr->overlay_buffer, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
/** Creates an overlay wlr_buffer. */
struct wlr_buffer *_wlmaker_launcher_create_overlay_buffer(
wlmaker_launcher_t *launcher_ptr)
{
int s = launcher_ptr->super_tile.style.size;
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(s, s);
if (NULL == wlr_buffer_ptr) return NULL;
const char *status_ptr = NULL;
if (!bs_ptr_set_empty(launcher_ptr->mapped_windows_ptr)) {
status_ptr = "Running";
} else if (!bs_ptr_set_empty(launcher_ptr->created_windows_ptr)) {
status_ptr = "Started";
}
if (NULL == status_ptr) return wlr_buffer_ptr;
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
float r, g, b, alpha;
bs_gfxbuf_argb8888_to_floats(0xff12905a, &r, &g, &b, &alpha);
cairo_pattern_t *cairo_pattern_ptr = cairo_pattern_create_rgba(
r, g, b, alpha);
cairo_set_source(cairo_ptr, cairo_pattern_ptr);
cairo_pattern_destroy(cairo_pattern_ptr);
cairo_rectangle(cairo_ptr, 0, s - 12, s, 12);
cairo_fill(cairo_ptr);
cairo_stroke(cairo_ptr);
cairo_select_font_face(cairo_ptr, "Helvetica",
CAIRO_FONT_SLANT_NORMAL,
CAIRO_FONT_WEIGHT_NORMAL);
cairo_set_font_size(cairo_ptr, 10.0);
cairo_set_source_argb8888(cairo_ptr, 0xffffffff);
cairo_move_to(cairo_ptr, 4, s - 2);
cairo_show_text(cairo_ptr, status_ptr);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::destroy. Calls
* @ref wlmaker_launcher_destroy.
*
* @param element_ptr
*/
void _wlmaker_launcher_element_destroy(
wlmtk_element_t *element_ptr)
{
wlmaker_launcher_t *launcher_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_launcher_t,
super_tile.super_container.super_element);
wlmaker_launcher_destroy(launcher_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_button.
*
* @param element_ptr
* @param button_event_ptr
*
* @return true always.
*/
bool _wlmaker_launcher_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmaker_launcher_t *launcher_ptr = BS_CONTAINER_OF(
element_ptr, wlmaker_launcher_t,
super_tile.super_container.super_element);
if (BTN_LEFT != button_event_ptr->button) return true;
if (WLMTK_BUTTON_CLICK != button_event_ptr->type) return true;
_wlmaker_launcher_start(launcher_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Starts the application, called when the launcher is clicked.
*
* @param launcher_ptr
*/
void _wlmaker_launcher_start(wlmaker_launcher_t *launcher_ptr)
{
bs_subprocess_t *subprocess_ptr = bs_subprocess_create_cmdline(
launcher_ptr->cmdline_ptr);
if (NULL == subprocess_ptr) {
bs_log(BS_ERROR, "Failed bs_subprocess_create_cmdline(%s)",
launcher_ptr->cmdline_ptr);
return;
}
if (!bs_subprocess_start(subprocess_ptr)) {
bs_log(BS_ERROR, "Failed bs_subprocess_start for %s",
launcher_ptr->cmdline_ptr);
bs_subprocess_destroy(subprocess_ptr);
return;
}
wlmaker_subprocess_handle_t *subprocess_handle_ptr;
subprocess_handle_ptr = wlmaker_subprocess_monitor_entrust(
launcher_ptr->monitor_ptr,
subprocess_ptr,
_wlmaker_launcher_handle_terminated,
launcher_ptr,
_wlmaker_launcher_handle_window_created,
_wlmaker_launcher_handle_window_mapped,
_wlmaker_launcher_handle_window_unmapped,
_wlmaker_launcher_handle_window_destroyed);
if (!bs_ptr_set_insert(launcher_ptr->subprocesses_ptr,
subprocess_handle_ptr)) {
bs_log(BS_WARNING, "Launcher %p: Failed bs_ptr_set_insert(%p, %p). "
"Will not show status of subprocess in App.",
launcher_ptr, launcher_ptr->subprocesses_ptr,
subprocess_handle_ptr);
wlmaker_subprocess_monitor_cede(
launcher_ptr->monitor_ptr,
subprocess_handle_ptr);
}
}
/* ------------------------------------------------------------------------- */
/**
* Callback handler for when the registered subprocess terminates.
*
* @param userdata_ptr Points to @ref wlmaker_launcher_t.
* @param subprocess_handle_ptr
* @param exit_status
* @param signal_number
*/
void _wlmaker_launcher_handle_terminated(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
int exit_status,
int signal_number)
{
wlmaker_launcher_t *launcher_ptr = userdata_ptr;
const char *format_ptr;
int code;
if (0 == signal_number) {
format_ptr = "App '%s' (%p) terminated, status code %d.";
code = exit_status;
} else {
format_ptr = "App '%s' (%p) killed by signal %d.";
code = signal_number;
}
bs_log(BS_INFO, format_ptr,
launcher_ptr->cmdline_ptr,
launcher_ptr,
code);
// TODO(kaeser@gubbe.ch): Keep exit status and latest output available
// for visualization.
wlmaker_subprocess_monitor_cede(
launcher_ptr->monitor_ptr,
subprocess_handle_ptr);
bs_ptr_set_erase(launcher_ptr->subprocesses_ptr,
subprocess_handle_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for then a window from the launched subprocess is created.
*
* Registers the windows as "created", and will then redraw the launcher tile
* to reflect potential status changes.
*
* @param userdata_ptr Points to the @ref wlmaker_launcher_t.
* @param subprocess_handle_ptr
* @param window_ptr
*/
void _wlmaker_launcher_handle_window_created(
void *userdata_ptr,
__UNUSED__ wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr)
{
wlmaker_launcher_t *launcher_ptr = userdata_ptr;
bool rv = bs_ptr_set_insert(launcher_ptr->created_windows_ptr, window_ptr);
if (!rv) bs_log(BS_ERROR, "Failed bs_ptr_set_insert(%p)", window_ptr);
_wlmaker_launcher_update_overlay(launcher_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for then a window from the launched subprocess is mapped.
*
* Registers the window as "mapped", and will then redraw the launcher tile
* to reflect potential status changes.
*
* @param userdata_ptr Points to the @ref wlmaker_launcher_t.
* @param subprocess_handle_ptr
* @param window_ptr
*/
void _wlmaker_launcher_handle_window_mapped(
void *userdata_ptr,
__UNUSED__ wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr)
{
wlmaker_launcher_t *launcher_ptr = userdata_ptr;
// TODO(kaeser@gubbe.ch): Appears we do encounter this scenario. File this
// as a bug and fix it.
// BS_ASSERT(bs_ptr_set_contains(launcher_ptr->created_windows_ptr, window_ptr));
bool rv = bs_ptr_set_insert(launcher_ptr->mapped_windows_ptr, window_ptr);
if (!rv) bs_log(BS_ERROR, "Failed bs_ptr_set_insert(%p)", window_ptr);
_wlmaker_launcher_update_overlay(launcher_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for then a window from the launched subprocess is unmapped.
*
* Removes the window from the set of "mapped" windows, and will then redraw
* the launcher tile to reflect potential status changes.
*
* @param userdata_ptr Points to the @ref wlmaker_launcher_t.
* @param subprocess_handle_ptr
* @param window_ptr
*/
void _wlmaker_launcher_handle_window_unmapped(
void *userdata_ptr,
__UNUSED__ wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr)
{
wlmaker_launcher_t *launcher_ptr = userdata_ptr;
bs_ptr_set_erase(launcher_ptr->mapped_windows_ptr, window_ptr);
_wlmaker_launcher_update_overlay(launcher_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for then a window from the launched subprocess is destroyed.
*
* Removes the window from the set of "created" windows, and will then redraw
* the launcher tile to reflect potential status changes.
*
* @param userdata_ptr Points to the @ref wlmaker_launcher_t.
* @param subprocess_handle_ptr
* @param window_ptr
*/
void _wlmaker_launcher_handle_window_destroyed(
void *userdata_ptr,
__UNUSED__ wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr)
{
wlmaker_launcher_t *launcher_ptr = userdata_ptr;
bs_ptr_set_erase(launcher_ptr->created_windows_ptr, window_ptr);
_wlmaker_launcher_update_overlay(launcher_ptr);
}
/* == Unit tests =========================================================== */
static void test_create_from_plist(bs_test_t *test_ptr);
const bs_test_case_t wlmaker_launcher_test_cases[] = {
{ 1, "create_from_plist", test_create_from_plist },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises plist parser. */
void test_create_from_plist(bs_test_t *test_ptr)
{
static const wlmtk_tile_style_t style = { .size = 96 };
static const char *plist_ptr =
"{CommandLine = \"a\"; Icon = \"chrome-48x48.png\";}";
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_string(plist_ptr));
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dict_ptr);
wlmaker_launcher_t *launcher_ptr = wlmaker_launcher_create_from_plist(
&style, dict_ptr, NULL, NULL);
wlmcfg_dict_unref(dict_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, launcher_ptr);
BS_TEST_VERIFY_STREQ(test_ptr, "a", launcher_ptr->cmdline_ptr);
BS_TEST_VERIFY_STREQ(
test_ptr, "chrome-48x48.png", launcher_ptr->icon_path_ptr);
wlmaker_launcher_destroy(launcher_ptr);
}
/* == End of launcher.c ==================================================== */
wlmaker-0.3/src/launcher.h 0000664 0000000 0000000 00000003614 14641446446 0015600 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file launcher.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __LAUNCHER_H__
#define __LAUNCHER_H__
#include "subprocess_monitor.h"
#include "toolkit/toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Launcher handle. */
typedef struct _wlmaker_launcher_t wlmaker_launcher_t;
/**
* Creates an application launcher, configured from a plist dict.
*
* @param style_ptr
* @param dict_ptr
* @param monitor_ptr
* @param env_ptr
*
* @return Pointer to the launcher handle or NULL on error.
*/
wlmaker_launcher_t *wlmaker_launcher_create_from_plist(
const wlmtk_tile_style_t *style_ptr,
wlmcfg_dict_t *dict_ptr,
wlmaker_subprocess_monitor_t *monitor_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the application launcher.
*
* @param launcher_ptr
*/
void wlmaker_launcher_destroy(wlmaker_launcher_t *launcher_ptr);
/** @return A pointer to the @ref wlmtk_tile_t superclass of `launcher_ptr`. */
wlmtk_tile_t *wlmaker_launcher_tile(wlmaker_launcher_t *launcher_ptr);
/** Unit tests. */
extern const bs_test_case_t wlmaker_launcher_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LAUNCHER_H__ */
/* == End of launcher.h ==================================================== */
wlmaker-0.3/src/layer_panel.c 0000664 0000000 0000000 00000044100 14641446446 0016260 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer_panel.c
*
* @copyright
* Copyright 2024 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.
*/
#include "layer_panel.h"
#include "wlr-layer-shell-unstable-v1-protocol.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
#include "xdg_popup.h"
/* == Declarations ========================================================= */
/** State of a layer panel. */
struct _wlmaker_layer_panel_t {
/** We're deriving this from a @ref wlmtk_panel_t as superclass. */
wlmtk_panel_t super_panel;
/** Links to the wlroots layer surface for this panel. */
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr;
/** Back-link to @ref wlmaker_server_t. */
wlmaker_server_t *server_ptr;
/** The wrapped surface, will be the principal element of the panel. */
wlmtk_surface_t *wlmtk_surface_ptr;
/** Listener for the `map` signal raised by `wlmtk_surface_t`. */
struct wl_listener surface_map_listener;
/** Listener for the `unmap` signal raised by `wlmtk_surface_t`. */
struct wl_listener surface_unmap_listener;
/** Listener for the `commit` signal raised by `wlr_surface`. */
struct wl_listener surface_commit_listener;
/** Listener for the `destroy` signal raised by `wlr_layer_surface_v1`. */
struct wl_listener destroy_listener;
/** Listener for `new_popup` signal raised by `wlr_layer_surface_v1`. */
struct wl_listener new_popup_listener;
};
static wlmaker_layer_panel_t *_wlmaker_layer_panel_create_injected(
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr,
wlmaker_server_t *server_ptr,
wlmtk_surface_create_t wlmtk_surface_create_fn);
static void _wlmaker_layer_panel_destroy(
wlmaker_layer_panel_t *layer_panel_ptr);
static bool _wlmaker_layer_panel_apply_keyboard(
wlmaker_layer_panel_t *layer_panel_ptr,
enum zwlr_layer_surface_v1_keyboard_interactivity interactivity);
static bool _wlmaker_layer_panel_apply_layer(
wlmaker_layer_panel_t *layer_panel_ptr,
enum zwlr_layer_shell_v1_layer zwlr_layer);
static void _wlmaker_layer_panel_set_positioning(
wlmtk_panel_positioning_t *positioning_ptr,
const struct wlr_layer_surface_v1_state *state_ptr);
static uint32_t _wlmaker_layer_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height);
static void _wlmaker_layer_panel_handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_layer_panel_handle_surface_map(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_layer_panel_handle_surface_unmap(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_layer_panel_handle_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_layer_panel_handle_new_popup(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** Virtual method table for the layer panel. */
static const wlmtk_panel_vmt_t _wlmtk_layer_panel_vmt = {
.request_size = _wlmaker_layer_panel_request_size,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_layer_panel_t *wlmaker_layer_panel_create(
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr,
wlmaker_server_t *server_ptr)
{
return _wlmaker_layer_panel_create_injected(
wlr_layer_surface_v1_ptr,
server_ptr,
wlmtk_surface_create);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Constructor for the layer panel, with injectable methods.
*
* @param wlr_layer_surface_v1_ptr
* @param server_ptr
* @param wlmtk_surface_create_fn
*
* @return The handler for the layer surface or NULL on error.
*/
wlmaker_layer_panel_t *_wlmaker_layer_panel_create_injected(
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr,
wlmaker_server_t *server_ptr,
wlmtk_surface_create_t wlmtk_surface_create_fn)
{
wlmaker_layer_panel_t *layer_panel_ptr = logged_calloc(
1, sizeof(wlmaker_layer_panel_t));
if (NULL == layer_panel_ptr) return NULL;
layer_panel_ptr->wlr_layer_surface_v1_ptr = wlr_layer_surface_v1_ptr;
layer_panel_ptr->server_ptr = server_ptr;
wlmtk_panel_positioning_t pos;
_wlmaker_layer_panel_set_positioning(
&pos, &layer_panel_ptr->wlr_layer_surface_v1_ptr->pending);
if (!wlmtk_panel_init(
&layer_panel_ptr->super_panel, &pos, server_ptr->env_ptr)) {
_wlmaker_layer_panel_destroy(layer_panel_ptr);
return NULL;
}
wlmtk_panel_extend(
&layer_panel_ptr->super_panel,
&_wlmtk_layer_panel_vmt);
layer_panel_ptr->wlmtk_surface_ptr = wlmtk_surface_create_fn(
wlr_layer_surface_v1_ptr->surface,
server_ptr->env_ptr);
if (NULL == layer_panel_ptr->wlmtk_surface_ptr) {
_wlmaker_layer_panel_destroy(layer_panel_ptr);
return NULL;
}
wlmtk_container_add_element_atop(
&layer_panel_ptr->super_panel.super_container,
NULL,
wlmtk_surface_element(layer_panel_ptr->wlmtk_surface_ptr));
wlmtk_element_set_visible(
wlmtk_surface_element(layer_panel_ptr->wlmtk_surface_ptr), true);
wlmtk_surface_connect_map_listener_signal(
layer_panel_ptr->wlmtk_surface_ptr,
&layer_panel_ptr->surface_map_listener,
_wlmaker_layer_panel_handle_surface_map);
wlmtk_surface_connect_unmap_listener_signal(
layer_panel_ptr->wlmtk_surface_ptr,
&layer_panel_ptr->surface_unmap_listener,
_wlmaker_layer_panel_handle_surface_unmap);
wlmtk_util_connect_listener_signal(
&wlr_layer_surface_v1_ptr->surface->events.commit,
&layer_panel_ptr->surface_commit_listener,
_wlmaker_layer_panel_handle_surface_commit);
wlmtk_util_connect_listener_signal(
&wlr_layer_surface_v1_ptr->events.destroy,
&layer_panel_ptr->destroy_listener,
_wlmaker_layer_panel_handle_destroy);
wlmtk_util_connect_listener_signal(
&wlr_layer_surface_v1_ptr->events.new_popup,
&layer_panel_ptr->new_popup_listener,
_wlmaker_layer_panel_handle_new_popup);
if (!_wlmaker_layer_panel_apply_keyboard(
layer_panel_ptr,
wlr_layer_surface_v1_ptr->pending.keyboard_interactive) ||
!_wlmaker_layer_panel_apply_layer(
layer_panel_ptr,
layer_panel_ptr->wlr_layer_surface_v1_ptr->pending.layer)) {
_wlmaker_layer_panel_destroy(layer_panel_ptr);
return NULL;
}
bs_log(BS_INFO, "Created layer panel %p with wlmtk surface %p",
layer_panel_ptr, layer_panel_ptr->wlmtk_surface_ptr);
return layer_panel_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the layer panel and frees up all associated resources.
*
* @param layer_panel_ptr
*/
void _wlmaker_layer_panel_destroy(wlmaker_layer_panel_t *layer_panel_ptr)
{
bs_log(BS_INFO, "Destroying layer panel %p with wlmtk surface %p",
layer_panel_ptr, layer_panel_ptr->wlmtk_surface_ptr);
wlmtk_layer_t *layer_ptr = wlmtk_panel_get_layer(
&layer_panel_ptr->super_panel);
if (NULL != layer_ptr) {
wlmtk_layer_remove_panel(layer_ptr, &layer_panel_ptr->super_panel);
}
wlmtk_util_disconnect_listener(&layer_panel_ptr->new_popup_listener);
wlmtk_util_disconnect_listener(&layer_panel_ptr->destroy_listener);
wlmtk_util_disconnect_listener(&layer_panel_ptr->surface_commit_listener);
wlmtk_util_disconnect_listener(&layer_panel_ptr->surface_unmap_listener);
wlmtk_util_disconnect_listener(&layer_panel_ptr->surface_map_listener);
if (NULL != layer_panel_ptr->wlmtk_surface_ptr) {
wlmtk_container_remove_element(
&layer_panel_ptr->super_panel.super_container,
wlmtk_surface_element(layer_panel_ptr->wlmtk_surface_ptr));
wlmtk_surface_destroy(layer_panel_ptr->wlmtk_surface_ptr);
layer_panel_ptr->wlmtk_surface_ptr = NULL;
}
wlmtk_panel_fini(&layer_panel_ptr->super_panel);
free(layer_panel_ptr);
}
/* ------------------------------------------------------------------------- */
/** @return Layer number, translated from protocol value. -1 on error. */
wlmtk_workspace_layer_t _wlmaker_layer_from_zwlr_layer(
enum zwlr_layer_shell_v1_layer zwlr_layer)
{
wlmtk_workspace_layer_t layer;
switch (zwlr_layer) {
case ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND:
layer = WLMTK_WORKSPACE_LAYER_BACKGROUND;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_BOTTOM:
layer = WLMTK_WORKSPACE_LAYER_BOTTOM;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_TOP:
layer = WLMTK_WORKSPACE_LAYER_TOP;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY:
layer = WLMTK_WORKSPACE_LAYER_OVERLAY;
break;
default:
layer = -1;
break;
}
return layer;
}
/* ------------------------------------------------------------------------- */
/** Applies the requested keyboard setting. Currently warns on non-zero. */
bool _wlmaker_layer_panel_apply_keyboard(
wlmaker_layer_panel_t *layer_panel_ptr,
enum zwlr_layer_surface_v1_keyboard_interactivity interactivity)
{
if (ZWLR_LAYER_SURFACE_V1_KEYBOARD_INTERACTIVITY_NONE != interactivity) {
wl_resource_post_error(
layer_panel_ptr->wlr_layer_surface_v1_ptr->resource,
WL_DISPLAY_ERROR_IMPLEMENTATION,
"Unsupported setting for keyboard interactivity: %d",
interactivity);
return false;
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Updates the layer this panel is part of. Posts an error if invalid. */
bool _wlmaker_layer_panel_apply_layer(
wlmaker_layer_panel_t *layer_panel_ptr,
enum zwlr_layer_shell_v1_layer zwlr_layer)
{
wlmtk_workspace_layer_t layer;
switch (zwlr_layer) {
case ZWLR_LAYER_SHELL_V1_LAYER_BACKGROUND:
layer = WLMTK_WORKSPACE_LAYER_BACKGROUND;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_BOTTOM:
layer = WLMTK_WORKSPACE_LAYER_BOTTOM;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_TOP:
layer = WLMTK_WORKSPACE_LAYER_TOP;
break;
case ZWLR_LAYER_SHELL_V1_LAYER_OVERLAY:
layer = WLMTK_WORKSPACE_LAYER_OVERLAY;
break;
default:
wl_resource_post_error(
layer_panel_ptr->wlr_layer_surface_v1_ptr->resource,
WL_DISPLAY_ERROR_INVALID_METHOD,
"Invalid value for for zwlr_layer value: %d",
layer_panel_ptr->wlr_layer_surface_v1_ptr->pending.layer);
return false;
}
wlmtk_workspace_t *workspace_ptr =
wlmtk_root_get_current_workspace(layer_panel_ptr->server_ptr->root_ptr);
wlmtk_layer_t *layer_ptr = wlmtk_workspace_get_layer(workspace_ptr, layer);
wlmtk_layer_t *current_layer_ptr = wlmtk_panel_get_layer(
&layer_panel_ptr->super_panel);
if (layer_ptr == current_layer_ptr) return true;
if (NULL != current_layer_ptr) {
wlmtk_layer_remove_panel(
current_layer_ptr, &layer_panel_ptr->super_panel);
}
if (NULL != layer_ptr) {
wlmtk_layer_add_panel(
layer_ptr, &layer_panel_ptr->super_panel);
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Updates `positioning_ptr` from the given surface state. */
void _wlmaker_layer_panel_set_positioning(
wlmtk_panel_positioning_t *positioning_ptr,
const struct wlr_layer_surface_v1_state *state_ptr)
{
positioning_ptr->anchor = state_ptr->anchor;
positioning_ptr->desired_width = state_ptr->desired_width;
positioning_ptr->desired_height = state_ptr->desired_height;
positioning_ptr->margin_left = state_ptr->margin.left;
positioning_ptr->margin_top = state_ptr->margin.top;
positioning_ptr->margin_right = state_ptr->margin.right;
positioning_ptr->margin_bottom = state_ptr->margin.bottom;
positioning_ptr->exclusive_zone = state_ptr->exclusive_zone;
}
/* ------------------------------------------------------------------------- */
/** Implements wlmtk_panel_vmt_t::request_size. */
uint32_t _wlmaker_layer_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
panel_ptr, wlmaker_layer_panel_t, super_panel);
return wlr_layer_surface_v1_configure(
layer_panel_ptr->wlr_layer_surface_v1_ptr, width, height);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `commit` signal of `wlr_surface`.
*
* Updates positioning and layer of the panel, as required.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_layer_panel_handle_surface_commit(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_panel_t, surface_commit_listener);
struct wlr_layer_surface_v1_state *state_ptr =
&layer_panel_ptr->wlr_layer_surface_v1_ptr->pending;
wlmtk_panel_positioning_t pos;
_wlmaker_layer_panel_set_positioning(&pos, state_ptr);
wlmtk_panel_commit(
&layer_panel_ptr->super_panel,
state_ptr->configure_serial,
&pos);
// Updates keyboard and layer values. Ignore failures here.
_wlmaker_layer_panel_apply_keyboard(
layer_panel_ptr,
state_ptr->keyboard_interactive);
_wlmaker_layer_panel_apply_layer(
layer_panel_ptr,
state_ptr->layer);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `map` signal of `wlmtk_surface_t`: Maps the panel to layer.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_layer_panel_handle_surface_map(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_panel_t, surface_map_listener);
wlmtk_element_set_visible(
wlmtk_panel_element(&layer_panel_ptr->super_panel), true);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `unmap` signal of `wlmtk_surface_t`: Unmaps the panel.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_layer_panel_handle_surface_unmap(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_panel_t, surface_unmap_listener);
wlmtk_element_set_visible(
wlmtk_panel_element(&layer_panel_ptr->super_panel), false);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of the `wlr_layer_surface_v1`: Destroys
* the panel.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_layer_panel_handle_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_panel_t, destroy_listener);
_wlmaker_layer_panel_destroy(layer_panel_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `new_popup` signal of the `wlr_layer_surface_v1`: Creates
* a new popup for this panel.
*
* @param listener_ptr
* @param data_ptr Points to the new `struct wlr_xdg_popup`.
*/
void _wlmaker_layer_panel_handle_new_popup(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_layer_panel_t *layer_panel_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_panel_t, new_popup_listener);
struct wlr_xdg_popup *wlr_xdg_popup_ptr = data_ptr;
wlmaker_xdg_popup_t *popup_ptr = wlmaker_xdg_popup_create(
wlr_xdg_popup_ptr,
layer_panel_ptr->server_ptr->env_ptr);
if (NULL == popup_ptr) {
wl_resource_post_error(
wlr_xdg_popup_ptr->resource,
WL_DISPLAY_ERROR_NO_MEMORY,
"Failed wlmtk_xdg_popup2_create.");
return;
}
wlmtk_element_set_visible(
wlmtk_popup_element(&popup_ptr->super_popup), true);
wlmtk_container_add_element(
&layer_panel_ptr->super_panel.popup_container,
wlmtk_popup_element(&popup_ptr->super_popup));
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
const bs_test_case_t wlmaker_layer_panel_test_cases[] = {
{ 0, "create_destroy", test_create_destroy },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises creation and teardown. */
void test_create_destroy(bs_test_t *test_ptr)
{
struct wlr_layer_surface_v1 wlr_layer_surface_v1 = {};
wlmaker_server_t server = {};
// Inject: wlmtk_surface_create - fake_surface_create.
wl_signal_init(&wlr_layer_surface_v1.events.destroy);
wl_signal_init(&wlr_layer_surface_v1.events.new_popup);
wlmaker_layer_panel_t *layer_panel_ptr =
_wlmaker_layer_panel_create_injected(
&wlr_layer_surface_v1,
&server,
wlmtk_fake_surface_create_inject);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, layer_panel_ptr);
wl_signal_emit(&wlr_layer_surface_v1.events.destroy, NULL);
}
/* == End of layer_panel.c ================================================== */
wlmaker-0.3/src/layer_panel.h 0000664 0000000 0000000 00000003417 14641446446 0016273 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer_panel.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __LAYER_PANEL_H__
#define __LAYER_PANEL_H__
/** Handler for a layer panel. */
typedef struct _wlmaker_layer_panel_t wlmaker_layer_panel_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration for wlroots layer surface. */
struct wlr_layer_surface_v1;
/**
* Creates a layer panel for the given layer surface.
*
* A layer panel is the implementation of a WLroots layer shell surface.
*
* @param wlr_layer_surface_v1_ptr
* @param server_ptr
*
* @return The handler for the layer surface or NULL on error. The associated
* resources will be destroyed once `wlr_layer_surface_v1_ptr` is
* destroyed.
*/
wlmaker_layer_panel_t *wlmaker_layer_panel_create(
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr,
wlmaker_server_t *server_ptr);
/** Unit test cases of layer panel. */
extern const bs_test_case_t wlmaker_layer_panel_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LAYER_PANEL_H__ */
/* == End of layer_panel.h ================================================= */
wlmaker-0.3/src/layer_shell.c 0000664 0000000 0000000 00000010772 14641446446 0016300 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer_shell.c
*
* @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.
*/
#include "layer_panel.h"
#include "layer_shell.h"
#include "toolkit/toolkit.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of Layer Shell handler. */
struct _wlmaker_layer_shell_t {
/** wlroots Layer Shell v1 handler. */
struct wlr_layer_shell_v1 *wlr_layer_shell_v1_ptr;
/** Back-link to the server. */
wlmaker_server_t *server_ptr;
/** Listener for the `new_surface` signal raised by `wlr_layer_shell_v1`. */
struct wl_listener new_surface_listener;
/** Listener for the `destroy` signal raised by `wlr_layer_shell_v1`. */
struct wl_listener destroy_listener;
};
static void handle_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_new_surface(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_layer_shell_t *wlmaker_layer_shell_create(wlmaker_server_t *server_ptr)
{
wlmaker_layer_shell_t *layer_shell_ptr = logged_calloc(
1, sizeof(wlmaker_layer_shell_t));
if (NULL == layer_shell_ptr) return NULL;
layer_shell_ptr->server_ptr = server_ptr;
layer_shell_ptr->wlr_layer_shell_v1_ptr = wlr_layer_shell_v1_create(
server_ptr->wl_display_ptr, 4 /* version */);
if (NULL == layer_shell_ptr->wlr_layer_shell_v1_ptr) {
bs_log(BS_ERROR, "Failed wlr_layer_shell_v1_create()");
return NULL;
}
wlmtk_util_connect_listener_signal(
&layer_shell_ptr->wlr_layer_shell_v1_ptr->events.new_surface,
&layer_shell_ptr->new_surface_listener,
handle_new_surface);
wlmtk_util_connect_listener_signal(
&layer_shell_ptr->wlr_layer_shell_v1_ptr->events.destroy,
&layer_shell_ptr->destroy_listener,
handle_destroy);
return layer_shell_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_layer_shell_destroy(wlmaker_layer_shell_t *layer_shell_ptr)
{
wl_list_remove(&layer_shell_ptr->destroy_listener.link);
wl_list_remove(&layer_shell_ptr->new_surface_listener.link);
free(layer_shell_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `destroy` signal raised by `wlr_layer_shell_v1`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_layer_shell_t *layer_shell_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_shell_t, destroy_listener);
wlmaker_layer_shell_destroy(layer_shell_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `new_surface` signal raised by `wlr_layer_shell_v1`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_new_surface(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_layer_shell_t *layer_shell_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_layer_shell_t, new_surface_listener);
struct wlr_layer_surface_v1 *wlr_layer_surface_v1_ptr = data_ptr;
if (NULL == wlr_layer_surface_v1_ptr->output) {
wlr_layer_surface_v1_ptr->output = wlmaker_server_get_output_at_cursor(
layer_shell_ptr->server_ptr);
}
__UNUSED__ wlmaker_layer_panel_t *layer_panel_ptr =
wlmaker_layer_panel_create(
wlr_layer_surface_v1_ptr,
layer_shell_ptr->server_ptr);
}
/* == End of layer_shell.c ================================================= */
wlmaker-0.3/src/layer_shell.h 0000664 0000000 0000000 00000002711 14641446446 0016277 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer_shell.h
*
* @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.
*/
#ifndef __LAYER_SHELL_H__
#define __LAYER_SHELL_H__
/** Handle for the layer shell. */
typedef struct _wlmaker_layer_shell_t wlmaker_layer_shell_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a layer shell handler.
*
* @param server_ptr
*
* @return A handle to the layer shell handler, or NULL on error.
*/
wlmaker_layer_shell_t *wlmaker_layer_shell_create(
wlmaker_server_t *server_ptr);
/**
* Destroys the layer shell handler.
*
* @param layer_shell_ptr
*/
void wlmaker_layer_shell_destroy(wlmaker_layer_shell_t *layer_shell_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LAYER_SHELL_H__ */
/* == End of layer_shell.h ================================================= */
wlmaker-0.3/src/lock_mgr.c 0000664 0000000 0000000 00000012275 14641446446 0015572 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file lock_mgr.c
*
* @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.
*/
#include "lock_mgr.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the session lock manager. */
struct _wlmaker_lock_mgr_t {
/** The wlroots session lock manager. */
struct wlr_session_lock_manager_v1 *wlr_session_lock_manager_v1_ptr;
/** Reference to the wlmaker server. */
wlmaker_server_t *server_ptr;
/** Listener for the `new_lock` signal of `wlr_session_lock_manager_v1`. */
struct wl_listener new_lock_listener;
/** Listener for the `destroy` signal of `wlr_session_lock_manager_v1`. */
struct wl_listener destroy_listener;
};
static void _wlmaker_lock_mgr_handle_new_lock(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_lock_mgr_handle_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_lock_mgr_t *wlmaker_lock_mgr_create(
wlmaker_server_t *server_ptr)
{
wlmaker_lock_mgr_t *lock_mgr_ptr = logged_calloc(
1, sizeof(wlmaker_lock_mgr_t));
if (NULL == lock_mgr_ptr) return NULL;
lock_mgr_ptr->server_ptr = server_ptr;
lock_mgr_ptr->wlr_session_lock_manager_v1_ptr =
wlr_session_lock_manager_v1_create(server_ptr->wl_display_ptr);
if (NULL == lock_mgr_ptr->wlr_session_lock_manager_v1_ptr) {
bs_log(BS_ERROR, "Failed wlr_session_lock_manager_v1_create(%p)",
server_ptr->wl_display_ptr);
wlmaker_lock_mgr_destroy(lock_mgr_ptr);
return NULL;
}
wlmtk_util_connect_listener_signal(
&lock_mgr_ptr->wlr_session_lock_manager_v1_ptr->events.new_lock,
&lock_mgr_ptr->new_lock_listener,
_wlmaker_lock_mgr_handle_new_lock);
wlmtk_util_connect_listener_signal(
&lock_mgr_ptr->wlr_session_lock_manager_v1_ptr->events.destroy,
&lock_mgr_ptr->destroy_listener,
_wlmaker_lock_mgr_handle_destroy);
return lock_mgr_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_lock_mgr_destroy(wlmaker_lock_mgr_t *lock_mgr_ptr)
{
wlmtk_util_disconnect_listener(&lock_mgr_ptr->destroy_listener);
wlmtk_util_disconnect_listener(&lock_mgr_ptr->new_lock_listener);
// Note: No destroy method for wlr_session_lock_manager_v1_ptr.
free(lock_mgr_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Handler for the `new_lock` signal of `wlr_session_lock_manager_v1`: creates
* the corresponding lock.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_lock_mgr_handle_new_lock(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_lock_mgr_t *lock_mgr_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_lock_mgr_t, new_lock_listener);
struct wlr_session_lock_v1 *wlr_session_lock_v1_ptr = data_ptr;
wlmtk_lock_t *lock_ptr = wlmtk_lock_create(
wlr_session_lock_v1_ptr,
lock_mgr_ptr->server_ptr->root_ptr,
lock_mgr_ptr->server_ptr->env_ptr);
if (NULL == lock_ptr) {
wl_resource_post_error(
wlr_session_lock_v1_ptr->resource,
WL_DISPLAY_ERROR_NO_MEMORY,
"Failed wlmt_lock_create(%p, %p, %p)",
wlr_session_lock_v1_ptr,
lock_mgr_ptr->server_ptr->root_ptr,
lock_mgr_ptr->server_ptr->env_ptr);
bs_log(BS_WARNING, "Failed wlmt_lock_create(%p, %p, %p)",
wlr_session_lock_v1_ptr,
lock_mgr_ptr->server_ptr->root_ptr,
lock_mgr_ptr->server_ptr->env_ptr);
return;
}
bs_log(BS_INFO, "Lock manager %p: New lock %p", lock_mgr_ptr, lock_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of `wlr_session_lock_manager_v1`: Cleans
* up associated resources.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_lock_mgr_handle_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_lock_mgr_t *lock_mgr_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_lock_mgr_t, destroy_listener);
wlmaker_lock_mgr_destroy(lock_mgr_ptr);
}
/* == End of lock_mgr.c ==================================================== */
wlmaker-0.3/src/lock_mgr.h 0000664 0000000 0000000 00000002737 14641446446 0015601 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file lock_mgr.h
*
* @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.
*/
#ifndef __LOCK_MGR_H__
#define __LOCK_MGR_H__
#include "toolkit/toolkit.h"
/** Forward declaration: State of the session lock manager. */
typedef struct _wlmaker_lock_mgr_t wlmaker_lock_mgr_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates the session lock manager.
*
* @param server_ptr
*
* @return The session lock manager handler or NULL on error.
*/
wlmaker_lock_mgr_t *wlmaker_lock_mgr_create(
wlmaker_server_t *server_ptr);
/**
* Destroys the session lock manager.
*
* @param lock_mgr_ptr
*/
void wlmaker_lock_mgr_destroy(wlmaker_lock_mgr_t *lock_mgr_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __LOCK_MGR_H__ */
/* == End of lock_mgr.h ==================================================== */
wlmaker-0.3/src/output.c 0000664 0000000 0000000 00000013673 14641446446 0015340 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file output.c
*
* @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.
*/
/// clock_gettime(2) is a POSIX extension, needs this macro.
#define _POSIX_C_SOURCE 199309L
#include "output.h"
#include "toolkit/toolkit.h"
#include
/* == Declarations ========================================================= */
static void handle_output_destroy(struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_output_frame(struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_request_state(struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported Methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_output_t *wlmaker_output_create(
struct wlr_output *wlr_output_ptr,
struct wlr_allocator *wlr_allocator_ptr,
struct wlr_renderer *wlr_renderer_ptr,
struct wlr_scene *wlr_scene_ptr,
wlmaker_server_t *server_ptr)
{
wlmaker_output_t *output_ptr = logged_calloc(1, sizeof(wlmaker_output_t));
if (NULL == output_ptr) return NULL;
output_ptr->wlr_output_ptr = wlr_output_ptr;
output_ptr->wlr_allocator_ptr = wlr_allocator_ptr;
output_ptr->wlr_renderer_ptr = wlr_renderer_ptr;
output_ptr->wlr_scene_ptr = wlr_scene_ptr;
output_ptr->server_ptr = server_ptr;
wlmtk_util_connect_listener_signal(
&output_ptr->wlr_output_ptr->events.destroy,
&output_ptr->output_destroy_listener,
handle_output_destroy);
wlmtk_util_connect_listener_signal(
&output_ptr->wlr_output_ptr->events.frame,
&output_ptr->output_frame_listener,
handle_output_frame);
wlmtk_util_connect_listener_signal(
&output_ptr->wlr_output_ptr->events.request_state,
&output_ptr->output_request_state_listener,
handle_request_state);
// From tinwywl: Configures the output created by the backend to use our
// allocator and our renderer. Must be done once, before commiting the
// output.
if (!wlr_output_init_render(
output_ptr->wlr_output_ptr,
output_ptr->wlr_allocator_ptr,
output_ptr->wlr_renderer_ptr)) {
bs_log(BS_ERROR, "Failed wlr_output_init_renderer()");
wlmaker_output_destroy(output_ptr);
return NULL;
}
// Set modes for backends that have them.
if (!wl_list_empty(&output_ptr->wlr_output_ptr->modes)) {
struct wlr_output_mode *mode_ptr = wlr_output_preferred_mode(output_ptr->wlr_output_ptr);
wlr_output_set_mode(output_ptr->wlr_output_ptr, mode_ptr);
}
// Enable the output and commit.
wlr_output_enable(output_ptr->wlr_output_ptr, true);
if (!wlr_output_commit(output_ptr->wlr_output_ptr)) {
bs_log(BS_ERROR, "Failed wlr_output_commit()");
wlmaker_output_destroy(output_ptr);
return NULL;
}
return output_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_output_destroy(wlmaker_output_t *output_ptr)
{
wl_list_remove(&output_ptr->output_request_state_listener.link);
wl_list_remove(&output_ptr->output_frame_listener.link);
wl_list_remove(&output_ptr->output_destroy_listener.link);
free(output_ptr);
}
/* == Local Methods ======================================================== */
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `destroy` signal raised by `wlr_output`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_output_destroy(struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_output_t *output_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_output_t, output_destroy_listener);
wlmaker_server_output_remove(output_ptr->server_ptr, output_ptr);
wlmaker_output_destroy(output_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `frame` signal raised by `wlr_output`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_output_frame(struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_output_t *output_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_output_t, output_frame_listener);
struct wlr_scene_output *wlr_scene_output_ptr = wlr_scene_get_scene_output(
output_ptr->wlr_scene_ptr,
output_ptr->wlr_output_ptr);
wlr_scene_output_commit(wlr_scene_output_ptr, NULL);
struct timespec now;
clock_gettime(CLOCK_MONOTONIC, &now);
wlr_scene_output_send_frame_done(wlr_scene_output_ptr, &now);
}
/* ------------------------------------------------------------------------- */
/**
* Event handler for the `request_state` signal raised by `wlr_output`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_request_state(struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_output_t *output_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_output_t, output_request_state_listener);
const struct wlr_output_event_request_state *event_ptr = data_ptr;
wlr_output_commit_state(output_ptr->wlr_output_ptr, event_ptr->state);
}
/* == End of output.c ====================================================== */
wlmaker-0.3/src/output.h 0000664 0000000 0000000 00000005703 14641446446 0015340 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file output.h
*
* @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.
*/
#ifndef __WLMAKER_OUTPUT_H__
#define __WLMAKER_OUTPUT_H__
#include
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/** Handle for a compositor output device. */
typedef struct _wlmaker_output_t wlmaker_output_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Handle for a compositor output device. */
struct _wlmaker_output_t {
/** List node for insertion to server's list of outputs. */
bs_dllist_node_t node;
/** Back-link to the server this output belongs to. */
wlmaker_server_t *server_ptr;
/** Refers to the compositor output region, from wlroots. */
struct wlr_output *wlr_output_ptr;
/** Refers to the allocator of the server. */
struct wlr_allocator *wlr_allocator_ptr;
/** Refers to the renderer used for the server. */
struct wlr_renderer *wlr_renderer_ptr;
/** Refers to the scene graph used. */
struct wlr_scene *wlr_scene_ptr;
/** Listener for `destroy` signals raised by `wlr_output`. */
struct wl_listener output_destroy_listener;
/** Listener for `frame` signals raised by `wlr_output`. */
struct wl_listener output_frame_listener;
/** Listener for `request_state` signals raised by `wlr_output`. */
struct wl_listener output_request_state_listener;
};
/**
* Creates an output device from |wlr_output_ptr|.
*
* @param wlr_output_ptr
* @param wlr_allocator_ptr
* @param wlr_renderer_ptr
* @param wlr_scene_ptr
* @param server_ptr
*
* @return The output device handle or NULL on error.
*/
wlmaker_output_t *wlmaker_output_create(
struct wlr_output *wlr_output_ptr,
struct wlr_allocator *wlr_allocator_ptr,
struct wlr_renderer *wlr_renderer_ptr,
struct wlr_scene *wlr_scene_ptr,
wlmaker_server_t *server_ptr);
/**
* Destroys the output device handle, as created by wlmaker_output_create().
*
* @param output_ptr
*/
void wlmaker_output_destroy(wlmaker_output_t *output_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMAKER_OUTPUT_H__ */
/* == End of output.h ====================================================== */
wlmaker-0.3/src/server.c 0000664 0000000 0000000 00000067514 14641446446 0015311 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file server.c
*
* @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.
*/
#include "server.h"
#include "config.h"
#include "output.h"
#include "toolkit/toolkit.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** Name of the "seat". */
static const char *seat_name_ptr = "seat0";
/** Wraps an input device. */
typedef struct {
/** List node, as an element of `wlmaker_server_t.input_devices`. */
bs_dllist_node_t node;
/** Back-link to the server this belongs. */
wlmaker_server_t *server_ptr;
/** The input device. */
struct wlr_input_device *wlr_input_device_ptr;
/** Handle to the wlmaker actual device. */
void *handle_ptr;
/** Listener for the `destroy` signal of `wlr_input_device`. */
struct wl_listener destroy_listener;
} wlmaker_input_device_t;
/** Internal struct holding a keybinding. */
struct _wlmaker_key_binding_t {
/** Node within @ref wlmaker_server_t::bindings. */
bs_dllist_node_t dlnode;
/** The key binding: Modifier and keysym to bind to. */
const wlmaker_key_combo_t *key_combo_ptr;
/** Callback for when this modifier + key is encountered. */
wlmaker_keybinding_callback_t callback;
};
static bool register_input_device(
wlmaker_server_t *server_ptr,
struct wlr_input_device *wlr_input_device_ptr,
void *handle_ptr);
static void handle_new_output(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_new_input_device(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_destroy_input_device(
struct wl_listener *listener_ptr,
void *data_ptr);
static void handle_output_layout_change(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
const uint32_t wlmaker_modifier_default_mask = (
WLR_MODIFIER_SHIFT |
// Excluding: WLR_MODIFIER_CAPS.
WLR_MODIFIER_CTRL |
WLR_MODIFIER_ALT |
WLR_MODIFIER_MOD2 |
WLR_MODIFIER_MOD3 |
WLR_MODIFIER_LOGO |
WLR_MODIFIER_MOD5);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_server_t *wlmaker_server_create(
wlmcfg_dict_t *config_dict_ptr,
const wlmaker_server_options_t *options_ptr)
{
wlmaker_server_t *server_ptr = logged_calloc(1, sizeof(wlmaker_server_t));
if (NULL == server_ptr) return NULL;
server_ptr->options_ptr = options_ptr;
server_ptr->config_dict_ptr = wlmcfg_dict_ref(config_dict_ptr);
if (NULL == server_ptr->config_dict_ptr) {
wlmaker_server_destroy(server_ptr);
return NULL;
}
wl_signal_init(&server_ptr->task_list_enabled_event);
wl_signal_init(&server_ptr->task_list_disabled_event);
wl_signal_init(&server_ptr->window_created_event);
wl_signal_init(&server_ptr->window_destroyed_event);
// Prepare display and socket.
server_ptr->wl_display_ptr = wl_display_create();
if (NULL == server_ptr->wl_display_ptr) {
bs_log(BS_ERROR, "Failed wl_display_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->wl_socket_name_ptr = wl_display_add_socket_auto(
server_ptr->wl_display_ptr);
if (NULL == server_ptr->wl_socket_name_ptr) {
bs_log(BS_ERROR, "Failed wl_display_add_socket_auto()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Configure the seat, which is the potential set of input devices operated
// by one user at a computer's "seat".
server_ptr->wlr_seat_ptr = wlr_seat_create(
server_ptr->wl_display_ptr, seat_name_ptr);
if (NULL == server_ptr->wlr_seat_ptr) {
bs_log(BS_ERROR, "Failed wlr_seat_create()");
wlmaker_server_destroy(server_ptr);
}
// Auto-create the wlroots backend. Can be X11 or direct.
server_ptr->wlr_backend_ptr = wlr_backend_autocreate(
server_ptr->wl_display_ptr, NULL /* struct wlr_session */);
if (NULL == server_ptr->wlr_backend_ptr) {
bs_log(BS_ERROR, "Failed wlr_backend_autocreate()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Listen for new (or newly recognized) output and input devices.
wlmtk_util_connect_listener_signal(
&server_ptr->wlr_backend_ptr->events.new_output,
&server_ptr->backend_new_output_listener,
handle_new_output);
wlmtk_util_connect_listener_signal(
&server_ptr->wlr_backend_ptr->events.new_input,
&server_ptr->backend_new_input_device_listener,
handle_new_input_device);
// Auto-create a renderer. Can be specified using WLR_RENDERER env var.
server_ptr->wlr_renderer_ptr = wlr_renderer_autocreate(
server_ptr->wlr_backend_ptr);
if (NULL == server_ptr->wlr_renderer_ptr) {
bs_log(BS_ERROR, "Failed wlr_renderer_autocreate()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
if (!wlr_renderer_init_wl_display(
server_ptr->wlr_renderer_ptr, server_ptr->wl_display_ptr)) {
bs_log(BS_ERROR, "Failed wlr_render_init_wl_display()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Auto-create allocator, suitable to backend and renderer.
server_ptr->wlr_allocator_ptr = wlr_allocator_autocreate(
server_ptr->wlr_backend_ptr, server_ptr->wlr_renderer_ptr);
if (NULL == server_ptr->wlr_allocator_ptr) {
bs_log(BS_ERROR, "Failed wlr_allocator_autocreate()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
// The output layout.
server_ptr->wlr_output_layout_ptr = wlr_output_layout_create();
if (NULL == server_ptr->wlr_output_layout_ptr) {
bs_log(BS_ERROR, "Failed wlr_output_layout_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
wlmtk_util_connect_listener_signal(
&server_ptr->wlr_output_layout_ptr->events.change,
&server_ptr->output_layout_change_listener,
handle_output_layout_change);
// The scene graph.
server_ptr->wlr_scene_ptr = wlr_scene_create();
if (NULL == server_ptr->wlr_scene_ptr) {
bs_log(BS_ERROR, "Failed wlr_scene_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->wlr_scene_output_layout_ptr = wlr_scene_attach_output_layout(
server_ptr->wlr_scene_ptr,
server_ptr->wlr_output_layout_ptr);
if (NULL == server_ptr->wlr_scene_output_layout_ptr) {
bs_log(BS_ERROR, "Failed wlr_scene_attach_output_layout()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->cursor_ptr = wlmaker_cursor_create(server_ptr);
if (NULL == server_ptr->cursor_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_cursor_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->env_ptr = wlmtk_env_create(
server_ptr->cursor_ptr->wlr_cursor_ptr,
server_ptr->cursor_ptr->wlr_xcursor_manager_ptr,
server_ptr->wlr_seat_ptr);
if (NULL == server_ptr->env_ptr) {
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Root element.
server_ptr->root_ptr = wlmtk_root_create(
server_ptr->wlr_scene_ptr,
server_ptr->env_ptr);
if (NULL == server_ptr->root_ptr) {
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Session lock manager.
server_ptr->lock_mgr_ptr = wlmaker_lock_mgr_create(server_ptr);
if (NULL == server_ptr->lock_mgr_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_lock_mgr_create(%p)", server_ptr);
wlmaker_server_destroy(server_ptr);
return NULL;
}
// Idle monitor.
server_ptr->idle_monitor_ptr = wlmaker_idle_monitor_create(server_ptr);
if (NULL == server_ptr->idle_monitor_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_idle_monitor_create(%p)", server_ptr);
return NULL;
}
// The below helpers all setup a listener |display_destroy| for freeing the
// assets held via the respective create() calls. Hence no need to call a
// clean-up method from our end.
server_ptr->wlr_compositor_ptr = wlr_compositor_create(
server_ptr->wl_display_ptr, 5, server_ptr->wlr_renderer_ptr);
if (NULL == server_ptr->wlr_compositor_ptr) {
bs_log(BS_ERROR, "Failed wlr_compositor_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->wlr_subcompositor_ptr = wlr_subcompositor_create(
server_ptr->wl_display_ptr);
if (NULL == server_ptr->wlr_subcompositor_ptr) {
bs_log(BS_ERROR, "Failed wlr_subcompositor_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->wlr_data_device_manager_ptr = wlr_data_device_manager_create(
server_ptr->wl_display_ptr);
if (NULL == server_ptr->wlr_data_device_manager_ptr) {
bs_log(BS_ERROR, "Failed wlr_data_device_manager_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->xdg_shell_ptr = wlmaker_xdg_shell_create(server_ptr);
if (NULL == server_ptr->xdg_shell_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_xdg_shell_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->xdg_decoration_manager_ptr =
wlmaker_xdg_decoration_manager_create(server_ptr);
if (NULL == server_ptr->xdg_decoration_manager_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_xdg_decoration_manager_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->layer_shell_ptr = wlmaker_layer_shell_create(server_ptr);
if (NULL == server_ptr->layer_shell_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_layer_shell_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
server_ptr->icon_manager_ptr = wlmaker_icon_manager_create(
server_ptr->wl_display_ptr, server_ptr);
if (NULL == server_ptr->icon_manager_ptr) {
wlmaker_server_destroy(server_ptr);
return NULL;
}
if (server_ptr->options_ptr->start_xwayland) {
server_ptr->xwl_ptr = wlmaker_xwl_create(server_ptr);
if (NULL == server_ptr->xwl_ptr) {
wlmaker_server_destroy(server_ptr);
return NULL;
}
}
server_ptr->monitor_ptr = wlmaker_subprocess_monitor_create(server_ptr);
if (NULL == server_ptr->monitor_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_subprocess_monitor_create()");
wlmaker_server_destroy(server_ptr);
return NULL;
}
return server_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_destroy(wlmaker_server_t *server_ptr)
{
// We don't destroy a few of the handlers, since wlroots will crash if
// they are destroyed -- and apparently, wlroots cleans them up anyway.
// These are:
// * server_ptr->wlr_seat_ptr
// * server_ptr->wlr_backend_ptr
// * server_ptr->wlr_scene_ptr (there is no "destroy" function)
{
bs_dllist_node_t *dlnode_ptr = server_ptr->bindings.head_ptr;
while (NULL != dlnode_ptr) {
wlmaker_key_binding_t *key_binding_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmaker_key_binding_t, dlnode);
dlnode_ptr = dlnode_ptr->next_ptr;
wlmaker_server_unbind_key(server_ptr, key_binding_ptr);
}
}
if (NULL != server_ptr->monitor_ptr) {
wlmaker_subprocess_monitor_destroy(server_ptr->monitor_ptr);
server_ptr->monitor_ptr =NULL;
}
if (NULL != server_ptr->xwl_ptr) {
wlmaker_xwl_destroy(server_ptr->xwl_ptr);
server_ptr->xwl_ptr = NULL;
}
if (NULL != server_ptr->icon_manager_ptr) {
wlmaker_icon_manager_destroy(server_ptr->icon_manager_ptr);
server_ptr->icon_manager_ptr = NULL;
}
if (NULL != server_ptr->layer_shell_ptr) {
wlmaker_layer_shell_destroy(server_ptr->layer_shell_ptr);
server_ptr->layer_shell_ptr = NULL;
}
if (NULL != server_ptr->xdg_decoration_manager_ptr) {
wlmaker_xdg_decoration_manager_destroy(
server_ptr->xdg_decoration_manager_ptr);
server_ptr->xdg_decoration_manager_ptr = NULL;
}
if (NULL != server_ptr->xdg_shell_ptr) {
wlmaker_xdg_shell_destroy(server_ptr->xdg_shell_ptr);
server_ptr->xdg_shell_ptr = NULL;
}
if (NULL != server_ptr->wl_display_ptr) {
wl_display_destroy_clients(server_ptr->wl_display_ptr);
server_ptr->wl_display_ptr = NULL;
}
if (NULL != server_ptr->root_ptr) {
wlmtk_root_destroy(server_ptr->root_ptr);
server_ptr->root_ptr = NULL;
}
if (NULL != server_ptr->lock_mgr_ptr) {
wlmaker_lock_mgr_destroy(server_ptr->lock_mgr_ptr);
server_ptr->lock_mgr_ptr = NULL;
}
if (NULL != server_ptr->env_ptr) {
wlmtk_env_destroy(server_ptr->env_ptr);
server_ptr->env_ptr = NULL;
}
if (NULL != server_ptr->cursor_ptr) {
wlmaker_cursor_destroy(server_ptr->cursor_ptr);
server_ptr->cursor_ptr = NULL;
}
if (NULL != server_ptr->wlr_output_layout_ptr) {
wlr_output_layout_destroy(server_ptr->wlr_output_layout_ptr);
server_ptr->wlr_output_layout_ptr = NULL;
}
if (NULL != server_ptr->wlr_renderer_ptr) {
wlr_renderer_destroy(server_ptr->wlr_renderer_ptr);
server_ptr->wlr_renderer_ptr = NULL;
}
if (NULL != server_ptr->wl_display_ptr) {
wl_display_destroy(server_ptr->wl_display_ptr);
server_ptr->wl_display_ptr = NULL;
}
if (NULL != server_ptr->idle_monitor_ptr) {
wlmaker_idle_monitor_destroy(server_ptr->idle_monitor_ptr);
server_ptr->idle_monitor_ptr = NULL;
}
if (NULL != server_ptr->wlr_allocator_ptr) {
wlr_allocator_destroy(server_ptr->wlr_allocator_ptr);
server_ptr->wlr_allocator_ptr = NULL;
}
if (NULL != server_ptr->config_dict_ptr) {
wlmcfg_dict_unref(server_ptr->config_dict_ptr);
server_ptr->config_dict_ptr = NULL;
}
free(server_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_output_add(wlmaker_server_t *server_ptr,
wlmaker_output_t *output_ptr)
{
// tinywl: Adds this to the output layout. The add_auto function arranges
// outputs from left-to-right in the order they appear. A sophisticated
// compositor would let the user configure the arrangement of outputs in
// the layout.
struct wlr_output_layout_output *wlr_output_layout_output_ptr =
wlr_output_layout_add_auto(server_ptr->wlr_output_layout_ptr,
output_ptr->wlr_output_ptr);
struct wlr_scene_output *wlr_scene_output_ptr =
wlr_scene_output_create(server_ptr->wlr_scene_ptr,
output_ptr->wlr_output_ptr);
wlr_scene_output_layout_add_output(
server_ptr->wlr_scene_output_layout_ptr,
wlr_output_layout_output_ptr,
wlr_scene_output_ptr);
bs_dllist_push_back(&server_ptr->outputs, &output_ptr->node);
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_output_remove(wlmaker_server_t *server_ptr,
wlmaker_output_t *output_ptr)
{
bs_dllist_remove(&server_ptr->outputs, &output_ptr->node);
wlr_output_layout_remove(server_ptr->wlr_output_layout_ptr,
output_ptr->wlr_output_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_activate_task_list(wlmaker_server_t *server_ptr)
{
server_ptr->task_list_enabled = true;
wl_signal_emit(&server_ptr->task_list_enabled_event, NULL);
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_deactivate_task_list(wlmaker_server_t *server_ptr)
{
if (!server_ptr->task_list_enabled) return;
server_ptr->task_list_enabled = false;
wl_signal_emit(&server_ptr->task_list_disabled_event, NULL);
wlmtk_workspace_t *workspace_ptr =
wlmtk_root_get_current_workspace(server_ptr->root_ptr);
wlmtk_window_t *window_ptr =
wlmtk_workspace_get_activated_window(workspace_ptr);
if (NULL != window_ptr) {
wlmtk_workspace_raise_window(workspace_ptr, window_ptr);
}
}
/* ------------------------------------------------------------------------- */
struct wlr_output *wlmaker_server_get_output_at_cursor(
wlmaker_server_t *server_ptr)
{
return wlr_output_layout_output_at(
server_ptr->wlr_output_layout_ptr,
server_ptr->cursor_ptr->wlr_cursor_ptr->x,
server_ptr->cursor_ptr->wlr_cursor_ptr->y);
}
/* ------------------------------------------------------------------------- */
wlmaker_key_binding_t *wlmaker_server_bind_key(
wlmaker_server_t *server_ptr,
const wlmaker_key_combo_t *key_combo_ptr,
wlmaker_keybinding_callback_t callback)
{
wlmaker_key_binding_t *key_binding_ptr = logged_calloc(
1, sizeof(wlmaker_key_binding_t));
if (NULL == key_binding_ptr) return NULL;
key_binding_ptr->key_combo_ptr = key_combo_ptr;
key_binding_ptr->callback = callback;
bs_dllist_push_back(&server_ptr->bindings, &key_binding_ptr->dlnode);
return key_binding_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_server_unbind_key(
wlmaker_server_t *server_ptr,
wlmaker_key_binding_t *key_binding_ptr)
{
bs_dllist_remove(&server_ptr->bindings, &key_binding_ptr->dlnode);
free(key_binding_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmaker_keyboard_process_bindings(
wlmaker_server_t *server_ptr,
xkb_keysym_t keysym,
uint32_t modifiers)
{
for (bs_dllist_node_t *dlnode_ptr = server_ptr->bindings.head_ptr;
NULL != dlnode_ptr;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmaker_key_binding_t *key_binding_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmaker_key_binding_t, dlnode);
const wlmaker_key_combo_t *key_combo_ptr =
key_binding_ptr->key_combo_ptr;
uint32_t mask = key_combo_ptr->modifiers_mask;
if (!mask) mask = UINT32_MAX;
if ((modifiers & mask) != key_combo_ptr->modifiers) continue;
xkb_keysym_t bound_ks = key_combo_ptr->keysym;
if (!key_combo_ptr->ignore_case && keysym != bound_ks) continue;
if (key_combo_ptr->ignore_case &&
keysym != xkb_keysym_to_lower(bound_ks) &&
keysym != xkb_keysym_to_upper(bound_ks)) continue;
if (key_binding_ptr->callback(key_combo_ptr)) return true;
}
return false;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Registers the input device at |handle_ptr| with |server_ptr|.
*
* @param server_ptr
* @param wlr_input_device_ptr
* @param handle_ptr
*
* @return true on success.
*/
bool register_input_device(wlmaker_server_t *server_ptr,
struct wlr_input_device *wlr_input_device_ptr,
void *handle_ptr)
{
wlmaker_input_device_t *input_device_ptr = logged_calloc(
1, sizeof(wlmaker_input_device_t));
if (NULL == input_device_ptr) return false;
input_device_ptr->server_ptr = server_ptr;
input_device_ptr->wlr_input_device_ptr = wlr_input_device_ptr;
input_device_ptr->handle_ptr = handle_ptr;
wlmtk_util_connect_listener_signal(
&wlr_input_device_ptr->events.destroy,
&input_device_ptr->destroy_listener,
handle_destroy_input_device);
bs_dllist_push_back(&server_ptr->input_devices, &input_device_ptr->node);
return true;
}
/* ------------------------------------------------------------------------- */
/** Handler for the `new_output` signal raised by `wlr_backend`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_new_output(struct wl_listener *listener_ptr, void *data_ptr)
{
struct wlr_output *wlr_output_ptr = data_ptr;
wlmaker_server_t *server_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_server_t, backend_new_output_listener);
wlmaker_output_t *output_ptr = wlmaker_output_create(
wlr_output_ptr,
server_ptr->wlr_allocator_ptr,
server_ptr->wlr_renderer_ptr,
server_ptr->wlr_scene_ptr,
server_ptr);
if (NULL == output_ptr) {
bs_log(BS_INFO, "Failed wlmaker_output_create for server %p",
server_ptr);
return;
}
wlmaker_server_output_add(server_ptr, output_ptr);
bs_log(BS_INFO, "Server %p: Added output %p", server_ptr, output_ptr);
}
/* ------------------------------------------------------------------------- */
/** Handler for the `new_input` signal raised by `wlr_backend`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_new_input_device(struct wl_listener *listener_ptr, void *data_ptr)
{
struct wlr_input_device *wlr_input_device_ptr = data_ptr;
wlmaker_server_t *server_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_server_t, backend_new_input_device_listener);
wlmaker_keyboard_t *keyboard_ptr;
switch (wlr_input_device_ptr->type) {
case WLR_INPUT_DEVICE_KEYBOARD:
keyboard_ptr = wlmaker_keyboard_create(
server_ptr,
wlr_keyboard_from_input_device(wlr_input_device_ptr),
server_ptr->wlr_seat_ptr);
if (NULL != keyboard_ptr) {
if (!register_input_device(
server_ptr, wlr_input_device_ptr, (void*)keyboard_ptr)) {
bs_log(BS_ERROR, "Failed wlmaker_server_keyboard_register()");
wlmaker_keyboard_destroy(keyboard_ptr);
}
}
break;
case WLR_INPUT_DEVICE_POINTER:
case WLR_INPUT_DEVICE_TOUCH:
case WLR_INPUT_DEVICE_TABLET_TOOL:
wlmaker_cursor_attach_input_device(
server_ptr->cursor_ptr,
wlr_input_device_ptr);
break;
default:
bs_log(BS_INFO, "Server %p: Unhandled new input device type %d",
server_ptr, wlr_input_device_ptr->type);
}
// If the KEYBOARD capability isn't set, keys won't be forwarded...
uint32_t capabilities = WL_SEAT_CAPABILITY_POINTER;
for (bs_dllist_node_t *node_ptr = server_ptr->input_devices.head_ptr;
node_ptr != NULL;
node_ptr = node_ptr->next_ptr) {
if (((wlmaker_input_device_t*)node_ptr)->wlr_input_device_ptr->type ==
WLR_INPUT_DEVICE_KEYBOARD) {
capabilities |= WL_SEAT_CAPABILITY_KEYBOARD;
}
}
wlr_seat_set_capabilities(server_ptr->wlr_seat_ptr, capabilities);
}
/* ------------------------------------------------------------------------- */
/** Handler for the `destroy` signal raised by `wlr_input_device`.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_destroy_input_device(struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_input_device_t *input_device_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_input_device_t, destroy_listener);
wlmaker_keyboard_t *keyboard_ptr;
switch (input_device_ptr->wlr_input_device_ptr->type) {
case WLR_INPUT_DEVICE_KEYBOARD:
keyboard_ptr = (wlmaker_keyboard_t*)input_device_ptr->handle_ptr;
wlmaker_keyboard_destroy(keyboard_ptr);
break;
default:
break;
}
wl_list_remove(&input_device_ptr->destroy_listener.link);
bs_dllist_remove(&input_device_ptr->server_ptr->input_devices,
&input_device_ptr->node);
free(input_device_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Signal handler for `change` event of `wlr_output_layout`.
*
* Is emitted whenever the output layout changes. For us, this means each
* workspace should consider re-arranging views suitably.
*
* @param listener_ptr
* @param data_ptr Points to a `struct wlr_output_layout`.
*/
void handle_output_layout_change(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_server_t *server_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_server_t, output_layout_change_listener);
struct wlr_output_layout *wlr_output_layout_ptr = data_ptr;
if (wlr_output_layout_ptr != server_ptr->wlr_output_layout_ptr) {
// OK, this is unexpected...
bs_log(BS_ERROR, "Unexpected output layer mismatch: %p vs %p",
wlr_output_layout_ptr, server_ptr->wlr_output_layout_ptr);
return;
}
struct wlr_box extents;
wlr_output_layout_get_box(wlr_output_layout_ptr, NULL, &extents);
bs_log(BS_INFO, "Output layout change: Pos %d, %d (%d x %d).",
extents.x, extents.y, extents.width, extents.height);
wlmtk_root_set_extents(server_ptr->root_ptr, &extents);
}
/* == Unit tests =========================================================== */
static void test_bind(bs_test_t *test_ptr);
/** Test cases for the server. */
const bs_test_case_t wlmaker_server_test_cases[] = {
{ 1, "bind", test_bind },
{ 0, NULL, NULL }
};
/** Test helper: Callback for a keybinding. */
bool test_binding_callback(
__UNUSED__ const wlmaker_key_combo_t *key_combo_ptr) {
return true;
}
/* ------------------------------------------------------------------------- */
/** Tests key bindings. */
void test_bind(bs_test_t *test_ptr)
{
wlmaker_server_t srv = {};
wlmaker_key_combo_t binding_a = {
.modifiers = WLR_MODIFIER_CTRL,
.modifiers_mask = WLR_MODIFIER_CTRL | WLR_MODIFIER_SHIFT,
.keysym = XKB_KEY_A,
.ignore_case = true
};
wlmaker_key_combo_t binding_b = {
.keysym = XKB_KEY_b
};
wlmaker_key_binding_t *kb1_ptr = wlmaker_server_bind_key(
&srv, &binding_a, test_binding_callback);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, kb1_ptr);
wlmaker_key_binding_t *kb2_ptr = wlmaker_server_bind_key(
&srv, &binding_b, test_binding_callback);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, kb2_ptr);
// First binding. Ctrl-A, permitting other modifiers except Ctrl.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmaker_keyboard_process_bindings(&srv, XKB_KEY_A, WLR_MODIFIER_CTRL));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmaker_keyboard_process_bindings(&srv, XKB_KEY_a, WLR_MODIFIER_CTRL));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmaker_keyboard_process_bindings(
&srv, XKB_KEY_a, WLR_MODIFIER_CTRL | WLR_MODIFIER_ALT));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmaker_keyboard_process_bindings(
&srv, XKB_KEY_a, WLR_MODIFIER_CTRL | WLR_MODIFIER_SHIFT));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmaker_keyboard_process_bindings(&srv, XKB_KEY_A, 0));
// Second binding. Triggers only on lower-case 'b'.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmaker_keyboard_process_bindings(&srv, XKB_KEY_b, 0));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmaker_keyboard_process_bindings(&srv, XKB_KEY_B, 0));
wlmaker_server_unbind_key(&srv, kb2_ptr);
wlmaker_server_unbind_key(&srv, kb1_ptr);
}
/* == End of server.c ====================================================== */
wlmaker-0.3/src/server.h 0000664 0000000 0000000 00000023224 14641446446 0015304 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file server.h
*
* @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.
*/
#ifndef __WLMAKER_SERVER_H__
#define __WLMAKER_SERVER_H__
#include
#include
#include "toolkit/toolkit.h"
#define WLR_USE_UNSTABLE
#include
#include
#include
#include
#include
#include
#include
#include
#include
#undef WLR_USE_UNSTABLE
/** A handle for a wlmaker server. */
typedef struct _wlmaker_server_t wlmaker_server_t;
/** A key combination. */
typedef struct _wlmaker_key_combo_t wlmaker_key_combo_t;
/** Handle for a key binding. */
typedef struct _wlmaker_key_binding_t wlmaker_key_binding_t;
/**
* Callback for a key binding.
*
* @param kc The key combo that triggered the callback.
*
* @return true if the key can be considered "consumed".
*/
typedef bool (*wlmaker_keybinding_callback_t)(const wlmaker_key_combo_t *kc);
#include "config.h"
#include "cursor.h"
#include "idle.h"
#include "output.h"
#include "keyboard.h"
#include "layer_shell.h"
#include "lock_mgr.h"
#include "subprocess_monitor.h"
#include "icon_manager.h"
#include "xdg_decoration.h"
#include "xdg_shell.h"
#include "xwl.h"
#include "conf/model.h"
#include "toolkit/toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Options for the Wayland server. */
typedef struct {
/** Whether to start XWayland. */
bool start_xwayland;
} wlmaker_server_options_t;
/** State of the Wayland server. */
struct _wlmaker_server_t {
/** Configuration dictionnary. */
wlmcfg_dict_t *config_dict_ptr;
/** Copy of the options. */
const wlmaker_server_options_t *options_ptr;
/** Wayland display. */
struct wl_display *wl_display_ptr;
/** Name of the socket for clients to connect. */
const char *wl_socket_name_ptr;
/** Session lock manager. */
wlmaker_lock_mgr_t *lock_mgr_ptr;
/** Idle monitor. */
wlmaker_idle_monitor_t *idle_monitor_ptr;
/** wlroots allocator. */
struct wlr_allocator *wlr_allocator_ptr;
/** wlroots backend. */
struct wlr_backend *wlr_backend_ptr;
/** wlroots output layout helper. */
struct wlr_output_layout *wlr_output_layout_ptr;
/** wlroots renderer. */
struct wlr_renderer *wlr_renderer_ptr;
/** wlroots seat. */
struct wlr_seat *wlr_seat_ptr;
/** The scene graph API. */
struct wlr_scene *wlr_scene_ptr;
/** The scene output layout. */
struct wlr_scene_output_layout *wlr_scene_output_layout_ptr;
/** Listener for `new_output` signals raised by `wlr_backend`. */
struct wl_listener backend_new_output_listener;
/** Listener for `new_input` signals raised by `wlr_backend`. */
struct wl_listener backend_new_input_device_listener;
/** Listener for `change` signals raised by `wlr_output_layout`. */
struct wl_listener output_layout_change_listener;
// From tinywl.c: A few hands-off wlroots interfaces.
/** The compositor is necessary for clients to allocate surfaces. */
struct wlr_compositor *wlr_compositor_ptr;
/**
* The subcompositor allows to assign the role of subsurfaces to
* surfaces.
*/
struct wlr_subcompositor *wlr_subcompositor_ptr;
/** The data device manager handles the clipboard. */
struct wlr_data_device_manager *wlr_data_device_manager_ptr;
/** The cursor handler. */
wlmaker_cursor_t *cursor_ptr;
/** The XDG Shell handler. */
wlmaker_xdg_shell_t *xdg_shell_ptr;
/** The XDG decoration manager. */
wlmaker_xdg_decoration_manager_t *xdg_decoration_manager_ptr;
/** Layer shell handler. */
wlmaker_layer_shell_t *layer_shell_ptr;
/** Icon manager. */
wlmaker_icon_manager_t *icon_manager_ptr;
/**
* XWayland interface. Will be set only if compiled with XWayland, through
* WLMAKER_HAVE_XWAYLAND defined.
* And through setting @ref wlmaker_server_options_t::start_xwayland.
*/
wlmaker_xwl_t *xwl_ptr;
/** The list of outputs. */
bs_dllist_t outputs;
/** The list of input devices. */
bs_dllist_t input_devices;
/** Toolkit environment. */
wlmtk_env_t *env_ptr;
/** The root element. */
wlmtk_root_t *root_ptr;
/** Whether the task list is currently shown. */
bool task_list_enabled;
/** Signal: When the task list is enabled. (to be shown) */
struct wl_signal task_list_enabled_event;
/** Signal: When the task list is disabled. (to be hidden) */
struct wl_signal task_list_disabled_event;
/** List of all bound keys, see @ref wlmaker_key_binding_t::dlnode. */
bs_dllist_t bindings;
/** Clients for this server. */
bs_dllist_t clients;
/** Subprocess monitoring. */
wlmaker_subprocess_monitor_t *monitor_ptr;
// TODO(kaeser@gubbe.ch): Move these events into a 'registry' struct, so
// it can be more easily shared throughout the code.
/** Signal: Triggered whenever a window is created. */
struct wl_signal window_created_event;
/** Signal: Triggered whenever a window is destroyed. */
struct wl_signal window_destroyed_event;
/** Temporary: Points to the @ref wlmtk_dock_t of the clip. */
wlmtk_dock_t *clip_dock_ptr;
/** The current configuration style. */
wlmaker_config_style_t style;
};
/** Specifies the key + modifier to bind. */
struct _wlmaker_key_combo_t {
/** Modifiers required. See `enum wlr_keyboard_modifiers`. */
uint32_t modifiers;
/** Modifier mask: Only masked modifiers are considered. */
uint32_t modifiers_mask;
/** XKB Keysym to trigger on. */
xkb_keysym_t keysym;
/** Whether to ignore case when matching. */
bool ignore_case;
};
/**
* Creates the server and initializes all needed sub-modules.
*
* @param config_dict_ptr Configuration, as dictionary object. The server
* will keep a reference on it until destroyed.
* @param options_ptr Options for the server. The server expects the
* pointed area to outlive the server.
*
* @return The server handle or NULL on failure. The handle must be freed by
* calling wlmaker_server_destroy().
*/
wlmaker_server_t *wlmaker_server_create(
wlmcfg_dict_t *config_dict_ptr,
const wlmaker_server_options_t *options_ptr);
/**
* Destroys the server handle, as created by wlmaker_server_create().
*
* @param server_ptr
*/
void wlmaker_server_destroy(wlmaker_server_t *server_ptr);
/**
* Adds the output.
*
* @param server_ptr
* @param output_ptr
*/
void wlmaker_server_output_add(wlmaker_server_t *server_ptr,
wlmaker_output_t *output_ptr);
/**
* Removes the output.
*
* @param server_ptr
* @param output_ptr
*/
void wlmaker_server_output_remove(wlmaker_server_t *server_ptr,
wlmaker_output_t *output_ptr);
/**
* Binds a particular key to a callback.
*
* @param server_ptr
* @param key_combo_ptr
* @param callback
*
* @return The key binding handle or NULL on error.
*/
wlmaker_key_binding_t *wlmaker_server_bind_key(
wlmaker_server_t *server_ptr,
const wlmaker_key_combo_t *key_combo_ptr,
wlmaker_keybinding_callback_t callback);
/**
* Releases a key binding. @see wlmaker_bind_key.
*
* @param server_ptr
* @param key_binding_ptr
*/
void wlmaker_server_unbind_key(
wlmaker_server_t *server_ptr,
wlmaker_key_binding_t *key_binding_ptr);
/**
* Processes key bindings: Call back if a matching binding is found.
*
* @param server_ptr
* @param keysym
* @param modifiers
*
* @return true if a binding was found AND the callback returned true.
*/
bool wlmaker_keyboard_process_bindings(
wlmaker_server_t *server_ptr,
xkb_keysym_t keysym,
uint32_t modifiers);
/**
* Activates the task list.
*
* @param server_ptr
*/
void wlmaker_server_activate_task_list(wlmaker_server_t *server_ptr);
/**
* De-activates the task list.
*
* @param server_ptr
*/
void wlmaker_server_deactivate_task_list(wlmaker_server_t *server_ptr);
/**
* Looks up which output serves the current cursor coordinates and returns that.
*
* @param server_ptr
*
* @return Pointer to the output at the seat's cursor position.
*/
struct wlr_output *wlmaker_server_get_output_at_cursor(
wlmaker_server_t *server_ptr);
/** All modifiers to use by default. */
extern const uint32_t wlmaker_modifier_default_mask;
/** Unit test cases. */
extern const bs_test_case_t wlmaker_server_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMAKER_SERVER_H__ */
/* == End of server.h ================================================== */
wlmaker-0.3/src/subprocess_monitor.c 0000664 0000000 0000000 00000071564 14641446446 0017742 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file subprocess_monitor.c
*
* @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.
*/
#include "subprocess_monitor.h"
#include "toolkit/toolkit.h"
#include
#include
/* == Declarations ========================================================= */
/** State of the subprocess monitor. */
struct _wlmaker_subprocess_monitor_t {
/** Reference to the event loop. */
struct wl_event_loop *wl_event_loop_ptr;
/** Event source used for monitoring SIGCHLD. */
struct wl_event_source *sigchld_event_source_ptr;
/** Listener: Receives a signal whenever a window is created. */
struct wl_listener window_created_listener;
/** Listener: Receives a signal whenever a window is mapped. */
struct wl_listener window_mapped_listener;
/** Listener: Receives a signal whenever a window is unmapped. */
struct wl_listener window_unmapped_listener;
/** Listener: Receives a signal whenever a window is destroyed. */
struct wl_listener window_destroyed_listener;
/** Monitored subprocesses. */
bs_dllist_t subprocesses;
/** Windows for monitored subprocesses. */
bs_avltree_t *window_tree_ptr;
};
/** A subprocess. */
struct _wlmaker_subprocess_handle_t {
/** Element of @ref wlmaker_subprocess_monitor_t `subprocesses`. */
bs_dllist_node_t dlnode;
/** Points to the subprocess. */
bs_subprocess_t *subprocess_ptr;
/** File descriptor of the subprocess' stdout. */
int stdout_read_fd;
/** Event source corresponding to events related to reading stdout. */
struct wl_event_source *stdout_wl_event_source_ptr;
/** File descriptor of the subprocess' strderr. */
int stderr_read_fd;
/** Event source corresponding to events related to reading stderr. */
struct wl_event_source *stderr_wl_event_source_ptr;
/** Callback: The subprocess was terminated. */
wlmaker_subprocess_terminated_callback_t terminated_callback;
/** Argument to all the callbacks. */
void *userdata_ptr;
/** Subprocess's windows. @ref wlmaker_subprocess_window_t::dlnode. */
bs_dllist_t windows;
/** Callback: A window was created from this subprocess. */
wlmaker_subprocess_window_callback_t window_created_callback;
/** Callback: Window was mapped from this subprocess. */
wlmaker_subprocess_window_callback_t window_mapped_callback;
/** Callback: Window was unmapped from this subprocess. */
wlmaker_subprocess_window_callback_t window_unmapped_callback;
/** Callback: Window was destroyed from this subprocess. */
wlmaker_subprocess_window_callback_t window_destroyed_callback;
};
/** Registry entry for @ref wlmtk_window_t and subprocesses. */
typedef struct {
/** See @ref wlmaker_subprocess_monitor_t::window_tree_ptr. */
bs_avltree_node_t avlnode;
/** The window registered here. Also the tree lookup key. */
wlmtk_window_t *window_ptr;
/** See @ref wlmaker_subprocess_handle_t::windows. */
bs_dllist_node_t dlnode;
/** The subprocess that the window is mapped to, or NULL. */
wlmaker_subprocess_handle_t *subprocess_handle_ptr;
/** Whether the window was reported as mapped. */
bool mapped;
} wlmaker_subprocess_window_t;
static wlmaker_subprocess_handle_t *wlmaker_subprocess_handle_create(
bs_subprocess_t *subprocess_ptr,
struct wl_event_loop *wl_event_loop_ptr);
static void wlmaker_subprocess_handle_destroy(
wlmaker_subprocess_handle_t *sp_handle_ptr);
static int _wlmaker_subprocess_monitor_handle_read_stdout(
int fd, uint32_t mask, void *data_ptr);
static int _wlmaker_subprocess_monitor_handle_read_stderr(
int fd, uint32_t mask, void *data_ptr);
static int _wlmaker_subprocess_monitor_process_fd(
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
struct wl_event_source **wl_event_source_ptr_ptr,
int fd,
uint32_t mask,
const char *fd_name_ptr);
static int _wlmaker_subprocess_monitor_handle_sigchld(int signum, void *data_ptr);
static void _wlmaker_subprocess_monitor_handle_window_created(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_subprocess_monitor_handle_window_mapped(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_subprocess_monitor_handle_window_unmapped(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_subprocess_monitor_handle_window_destroyed(
struct wl_listener *listener_ptr,
void *data_ptr);
static wlmaker_subprocess_handle_t *subprocess_handle_from_window(
wlmaker_subprocess_monitor_t *monitor_ptr,
wlmtk_window_t *window_ptr);
static wlmaker_subprocess_window_t *wlmaker_subprocess_window_create(
wlmtk_window_t *window_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr);
static void wlmaker_subprocess_window_destroy(
wlmaker_subprocess_window_t *ws_window_ptr);
static int wlmaker_subprocess_window_node_cmp(
const bs_avltree_node_t *node_ptr,
const void *key_ptr);
static void wlmaker_subprocess_window_node_destroy(
bs_avltree_node_t *node_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_subprocess_monitor_t* wlmaker_subprocess_monitor_create(
wlmaker_server_t *server_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = logged_calloc(
1, sizeof(wlmaker_subprocess_monitor_t));
if (NULL == monitor_ptr) return NULL;
monitor_ptr->window_tree_ptr = bs_avltree_create(
wlmaker_subprocess_window_node_cmp,
wlmaker_subprocess_window_node_destroy);
if (NULL == monitor_ptr->window_tree_ptr) {
bs_log(BS_ERROR, "Failed bs_avltree_create(%p, %p)",
wlmaker_subprocess_window_node_cmp,
wlmaker_subprocess_window_node_destroy);
wlmaker_subprocess_monitor_destroy(monitor_ptr);
return NULL;
}
monitor_ptr->wl_event_loop_ptr = wl_display_get_event_loop(
server_ptr->wl_display_ptr);
if (NULL == monitor_ptr->wl_event_loop_ptr) {
bs_log(BS_ERROR, "Failed wl_display_get_event_loop().");
wlmaker_subprocess_monitor_destroy(monitor_ptr);
return NULL;
}
monitor_ptr->sigchld_event_source_ptr = wl_event_loop_add_signal(
monitor_ptr->wl_event_loop_ptr,
SIGCHLD,
_wlmaker_subprocess_monitor_handle_sigchld,
monitor_ptr);
wlmtk_util_connect_listener_signal(
&server_ptr->window_created_event,
&monitor_ptr->window_created_listener,
_wlmaker_subprocess_monitor_handle_window_created);
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->window_mapped,
&monitor_ptr->window_mapped_listener,
_wlmaker_subprocess_monitor_handle_window_mapped);
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->window_unmapped,
&monitor_ptr->window_unmapped_listener,
_wlmaker_subprocess_monitor_handle_window_unmapped);
wlmtk_util_connect_listener_signal(
&server_ptr->window_destroyed_event,
&monitor_ptr->window_destroyed_listener,
_wlmaker_subprocess_monitor_handle_window_destroyed);
return monitor_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_subprocess_monitor_destroy(
wlmaker_subprocess_monitor_t *monitor_ptr)
{
wl_list_remove(&monitor_ptr->window_destroyed_listener.link);
wl_list_remove(&monitor_ptr->window_unmapped_listener.link);
wl_list_remove(&monitor_ptr->window_mapped_listener.link);
wl_list_remove(&monitor_ptr->window_created_listener.link);
if (NULL != monitor_ptr->sigchld_event_source_ptr) {
wl_event_source_remove(monitor_ptr->sigchld_event_source_ptr);
monitor_ptr->sigchld_event_source_ptr = NULL;
}
if (NULL != monitor_ptr->window_tree_ptr) {
bs_avltree_destroy(monitor_ptr->window_tree_ptr);
monitor_ptr->window_tree_ptr = NULL;
}
monitor_ptr->wl_event_loop_ptr = NULL;
free(monitor_ptr);
}
/* ------------------------------------------------------------------------- */
wlmaker_subprocess_handle_t *wlmaker_subprocess_monitor_entrust(
wlmaker_subprocess_monitor_t *monitor_ptr,
bs_subprocess_t *subprocess_ptr,
wlmaker_subprocess_terminated_callback_t terminated_callback,
void *userdata_ptr,
wlmaker_subprocess_window_callback_t window_created_callback,
wlmaker_subprocess_window_callback_t window_mapped_callback,
wlmaker_subprocess_window_callback_t window_unmapped_callback,
wlmaker_subprocess_window_callback_t window_destroyed_callback)
{
wlmaker_subprocess_handle_t *subprocess_handle_ptr =
wlmaker_subprocess_handle_create(
subprocess_ptr, monitor_ptr->wl_event_loop_ptr);
if (NULL == subprocess_handle_ptr) return NULL;
bs_dllist_push_back(&monitor_ptr->subprocesses,
&subprocess_handle_ptr->dlnode);
subprocess_handle_ptr->terminated_callback = terminated_callback;
subprocess_handle_ptr->userdata_ptr = userdata_ptr;
subprocess_handle_ptr->window_created_callback = window_created_callback;
subprocess_handle_ptr->window_mapped_callback = window_mapped_callback;
subprocess_handle_ptr->window_unmapped_callback = window_unmapped_callback;
subprocess_handle_ptr->window_destroyed_callback =
window_destroyed_callback;
return subprocess_handle_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_subprocess_monitor_cede(
__UNUSED__ wlmaker_subprocess_monitor_t *monitor_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr)
{
bs_dllist_node_t *dlnode_ptr;
while (NULL != (dlnode_ptr = bs_dllist_pop_front(
&subprocess_handle_ptr->windows))) {
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmaker_subprocess_window_t, dlnode);
BS_ASSERT(ws_window_ptr->subprocess_handle_ptr ==
subprocess_handle_ptr) ;
if (NULL != subprocess_handle_ptr->window_unmapped_callback) {
subprocess_handle_ptr->window_unmapped_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
ws_window_ptr->mapped = false;
}
if (NULL != subprocess_handle_ptr->window_destroyed_callback) {
subprocess_handle_ptr->window_destroyed_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
}
ws_window_ptr->subprocess_handle_ptr = NULL;
}
subprocess_handle_ptr->terminated_callback = NULL;
}
/* ------------------------------------------------------------------------- */
bs_subprocess_t *wlmaker_subprocess_from_subprocess_handle(
wlmaker_subprocess_handle_t *subprocess_handle_ptr)
{
return subprocess_handle_ptr->subprocess_ptr;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Creates a @ref wlmaker_subprocess_handle_t and connects to subprocess_ptr.
*
* @param subprocess_ptr
* @param wl_event_loop_ptr
*
* @return The subprocess handle or NULL on error.
*/
wlmaker_subprocess_handle_t *wlmaker_subprocess_handle_create(
bs_subprocess_t *subprocess_ptr,
struct wl_event_loop *wl_event_loop_ptr)
{
wlmaker_subprocess_handle_t *subprocess_handle_ptr = logged_calloc(
1, sizeof(wlmaker_subprocess_handle_t));
if (NULL == subprocess_handle_ptr) return NULL;
subprocess_handle_ptr->subprocess_ptr = subprocess_ptr;
bs_subprocess_get_fds(
subprocess_ptr,
NULL, // no interest in stdin.
&subprocess_handle_ptr->stdout_read_fd,
&subprocess_handle_ptr->stderr_read_fd);
subprocess_handle_ptr->stdout_wl_event_source_ptr = wl_event_loop_add_fd(
wl_event_loop_ptr,
subprocess_handle_ptr->stdout_read_fd,
WL_EVENT_READABLE,
_wlmaker_subprocess_monitor_handle_read_stdout,
subprocess_handle_ptr);
subprocess_handle_ptr->stderr_wl_event_source_ptr = wl_event_loop_add_fd(
wl_event_loop_ptr,
subprocess_handle_ptr->stderr_read_fd,
WL_EVENT_READABLE,
_wlmaker_subprocess_monitor_handle_read_stderr,
subprocess_handle_ptr);
return subprocess_handle_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the subprocess handle and frees up associated resources.
*
* @param sp_handle_ptr
*/
void wlmaker_subprocess_handle_destroy(
wlmaker_subprocess_handle_t *sp_handle_ptr)
{
BS_ASSERT(NULL == sp_handle_ptr->dlnode.prev_ptr);
int exit_status, signal_number;
if (!bs_subprocess_terminated(
sp_handle_ptr->subprocess_ptr, &exit_status, &signal_number)) {
bs_log(BS_FATAL, "Destroying subprocess handle, but still running: "
"subprocess %p (pid: %"PRIdMAX")",
sp_handle_ptr->subprocess_ptr,
(intmax_t)bs_subprocess_pid(sp_handle_ptr->subprocess_ptr));
}
bs_log(BS_DEBUG, "Terminated subprocess %p. Status %d, signal %d.",
sp_handle_ptr->subprocess_ptr, exit_status, signal_number);
if (NULL != sp_handle_ptr->terminated_callback) {
sp_handle_ptr->terminated_callback(
sp_handle_ptr->userdata_ptr,
sp_handle_ptr,
exit_status,
signal_number);
sp_handle_ptr->terminated_callback = NULL;
}
if (NULL != sp_handle_ptr->subprocess_ptr) {
bs_subprocess_destroy(sp_handle_ptr->subprocess_ptr);
sp_handle_ptr->subprocess_ptr = NULL;
}
if (NULL != sp_handle_ptr->stdout_wl_event_source_ptr) {
wl_event_source_remove(sp_handle_ptr->stdout_wl_event_source_ptr);
sp_handle_ptr->stdout_wl_event_source_ptr = NULL;
}
if (NULL != sp_handle_ptr->stderr_wl_event_source_ptr) {
wl_event_source_remove(sp_handle_ptr->stderr_wl_event_source_ptr);
sp_handle_ptr->stderr_wl_event_source_ptr = NULL;
}
free(sp_handle_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for activity on stdout file descriptor, as prescribed by
* wl_event_loop_fd_func_t.
*
* @param fd
* @param mask A bitmask of WL_EVENT_READABLE, WL_EVENT_HANGUP
* or WL_EVENT_ERROR.
* @param data_ptr Points ot a @ref wlmaker_subprocess_handle_t.
*
* @return 0.
*/
int _wlmaker_subprocess_monitor_handle_read_stdout(
int fd, uint32_t mask, void *data_ptr)
{
wlmaker_subprocess_handle_t *subprocess_handle_ptr = data_ptr;
BS_ASSERT(fd == subprocess_handle_ptr->stdout_read_fd);
return _wlmaker_subprocess_monitor_process_fd(
subprocess_handle_ptr,
&subprocess_handle_ptr->stdout_wl_event_source_ptr,
subprocess_handle_ptr->stdout_read_fd,
mask,
"stdout");
}
/* ------------------------------------------------------------------------- */
/**
* Handler for activity on stderr file descriptor, as prescribed by
* wl_event_loop_fd_func_t.
*
* @param fd
* @param mask A bitmask of WL_EVENT_READABLE, WL_EVENT_HANGUP
* or WL_EVENT_ERROR.
* @param data_ptr Points to a @ref wlmaker_subprocess_handle_t.
*
* @return 0.
*/
int _wlmaker_subprocess_monitor_handle_read_stderr(
int fd, uint32_t mask, void *data_ptr)
{
wlmaker_subprocess_handle_t *subprocess_handle_ptr = data_ptr;
BS_ASSERT(fd == subprocess_handle_ptr->stderr_read_fd);
return _wlmaker_subprocess_monitor_process_fd(
subprocess_handle_ptr,
&subprocess_handle_ptr->stderr_wl_event_source_ptr,
subprocess_handle_ptr->stderr_read_fd,
mask,
"stderr");
}
/* ------------------------------------------------------------------------- */
/**
* Processes activity on a file descriptor, matches wl_event_loop_fd_func_t.
*
* @param subprocess_handle_ptr
* @param wl_event_source_ptr_ptr
* @param fd
* @param mask
* @param fd_name_ptr
*
* @return 0.
*/
int _wlmaker_subprocess_monitor_process_fd(
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
struct wl_event_source **wl_event_source_ptr_ptr,
int fd,
uint32_t mask,
const char *fd_name_ptr)
{
// Convenience copy.
intmax_t pid = bs_subprocess_pid(subprocess_handle_ptr->subprocess_ptr);
if (mask & WL_EVENT_READABLE) {
ssize_t read_bytes;
char buf[1024];
read_bytes = read(fd, buf, sizeof(buf));
buf[BS_MIN(read_bytes, 1023)] = '\0';
if (0 < read_bytes) {
// TODO(kaeser@gubbe.ch): Find a way to log this appropriately.
// We'd want to have STDERR logged as WARN, and STDOUT in INFO.
bs_log(BS_DEBUG, "subprocess %"PRIdMAX" %s: %s",
pid, fd_name_ptr, buf);
} else if (0 > read_bytes) {
bs_log(BS_WARNING | BS_ERRNO,
"subprocess %"PRIdMAX" %s: Failed raad(%d, ...)",
pid, fd_name_ptr, fd);
}
return 0;
}
if (mask & (WL_EVENT_HANGUP | WL_EVENT_ERROR) &&
NULL != *wl_event_source_ptr_ptr) {
bs_log(BS_DEBUG, "subprocess %"PRIdMAX" %s: Mask 0x%x, removing.",
pid, fd_name_ptr, mask);
wl_event_source_remove(*wl_event_source_ptr_ptr);
*wl_event_source_ptr_ptr = NULL;
return 0;
}
bs_log(BS_WARNING, "subprocess %"PRIdMAX" %s: Unexpected event, mask 0x%x",
pid, fd_name_ptr, mask);
return 0;
}
/* ------------------------------------------------------------------------- */
/**
* Handles SIGCHLD. Callback for Wayland event loop.
*
* @param signum
*
* @param data_ptr Points to @ref wlmaker_subprocess_monitor_t.
*/
int _wlmaker_subprocess_monitor_handle_sigchld(
__UNUSED__ int signum, void *data_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = data_ptr;
bs_dllist_node_t *dlnode_ptr = monitor_ptr->subprocesses.head_ptr;
while (NULL != dlnode_ptr) {
wlmaker_subprocess_handle_t *subprocess_handle_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmaker_subprocess_handle_t, dlnode);
dlnode_ptr = dlnode_ptr->next_ptr;
int exit_status, signal_number;
if (bs_subprocess_terminated(subprocess_handle_ptr->subprocess_ptr,
&exit_status, &signal_number)) {
bs_dllist_remove(
&monitor_ptr->subprocesses,
&subprocess_handle_ptr->dlnode);
wlmaker_subprocess_handle_destroy(subprocess_handle_ptr);
}
}
return 0;
}
/* ------------------------------------------------------------------------- */
/**
* Handles window creation: Will see if there's a subprocess mapping to the
* corresponding client's PID, and call the "created" callback, if registered.
*
* Note: A client may have an arbitrary number of windows created.
*
* @param listener_ptr
* @param data_ptr Points to a @ref wlmaker_subprocess_monitor_t.
*/
void _wlmaker_subprocess_monitor_handle_window_created(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_subprocess_monitor_t, window_created_listener);
wlmtk_window_t *window_ptr = data_ptr;
wlmaker_subprocess_handle_t *subprocess_handle_ptr =
subprocess_handle_from_window(monitor_ptr, window_ptr);
if (NULL == subprocess_handle_ptr) return;
wlmaker_subprocess_window_t *ws_window_ptr =
wlmaker_subprocess_window_create(window_ptr, subprocess_handle_ptr);
if (NULL == ws_window_ptr) return;
bs_avltree_insert(
monitor_ptr->window_tree_ptr,
ws_window_ptr->window_ptr,
&ws_window_ptr->avlnode,
true);
}
/* ------------------------------------------------------------------------- */
/**
* Handles window mapping: Will see if there's a window and corresponding
* subprocess, and calls the "mapped" callback, if registered.
*
* @param listener_ptr
* @param data_ptr Points to a @ref wlmaker_subprocess_monitor_t.
*/
void _wlmaker_subprocess_monitor_handle_window_mapped(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_subprocess_monitor_t, window_mapped_listener);
wlmtk_window_t *window_ptr = data_ptr;
bs_avltree_node_t *avlnode_ptr = bs_avltree_lookup(
monitor_ptr->window_tree_ptr, window_ptr);
if (NULL == avlnode_ptr) return;
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
avlnode_ptr, wlmaker_subprocess_window_t, avlnode);
wlmaker_subprocess_handle_t *subprocess_handle_ptr =
ws_window_ptr->subprocess_handle_ptr;
if (NULL == subprocess_handle_ptr) return;
if (NULL != subprocess_handle_ptr->window_mapped_callback) {
subprocess_handle_ptr->window_mapped_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
}
ws_window_ptr->mapped = true;
}
/* ------------------------------------------------------------------------- */
/**
* Handles window unmapping: Will see if there's a window and corresponding
* subprocess, and calls the "unmapped" callback, if registered.
*
* @param listener_ptr
* @param data_ptr Points to a @ref wlmaker_subprocess_monitor_t.
*/
void _wlmaker_subprocess_monitor_handle_window_unmapped(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_subprocess_monitor_t, window_unmapped_listener);
wlmtk_window_t *window_ptr = data_ptr;
bs_avltree_node_t *avlnode_ptr = bs_avltree_lookup(
monitor_ptr->window_tree_ptr, window_ptr);
if (NULL == avlnode_ptr) return;
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
avlnode_ptr, wlmaker_subprocess_window_t, avlnode);
wlmaker_subprocess_handle_t *subprocess_handle_ptr =
ws_window_ptr->subprocess_handle_ptr;
if (NULL == subprocess_handle_ptr) return;
if (NULL != subprocess_handle_ptr->window_unmapped_callback) {
subprocess_handle_ptr->window_unmapped_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
}
ws_window_ptr->mapped = false;
}
/* ------------------------------------------------------------------------- */
/**
* Handles window destruction: Will retrieve the wlmaker_subprocess_window_t
* structure for tracking windows for subprocesses, call the respective
* callbacks and destroy the associated window tracking structure.
*
* @param listener_ptr
* @param data_ptr Points to a @ref wlmaker_subprocess_monitor_t.
*/
void _wlmaker_subprocess_monitor_handle_window_destroyed(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmaker_subprocess_monitor_t *monitor_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_subprocess_monitor_t, window_destroyed_listener);
wlmtk_window_t *window_ptr = data_ptr;
bs_avltree_node_t *avlnode_ptr = bs_avltree_delete(
monitor_ptr->window_tree_ptr, window_ptr);
if (NULL == avlnode_ptr) return;
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
avlnode_ptr, wlmaker_subprocess_window_t, avlnode);
wlmaker_subprocess_window_destroy(ws_window_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Returns the subprocess matching the window's client, if any.
*
* Practically, there should only ever be one subprocess matching, since the
* PID of a subprocess is supposed to be unique.
*
* @param monitor_ptr
* @param window_ptr
*
* @return A pointer to the subprocess handle corresponding to the window's
* client, or NULL if not found.
*/
wlmaker_subprocess_handle_t *subprocess_handle_from_window(
wlmaker_subprocess_monitor_t *monitor_ptr,
wlmtk_window_t *window_ptr)
{
const wlmtk_util_client_t *client_ptr = wlmtk_window_get_client_ptr(
window_ptr);
// TODO(kaeser@gubbe.ch): Should be a O(1) or O(log(n)) structure.
for (bs_dllist_node_t *dlnode_ptr = monitor_ptr->subprocesses.head_ptr;
NULL != dlnode_ptr;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmaker_subprocess_handle_t *subprocess_handle_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmaker_subprocess_handle_t, dlnode);
if (client_ptr->pid ==
bs_subprocess_pid(subprocess_handle_ptr->subprocess_ptr)) {
return subprocess_handle_ptr;
}
}
return NULL;
}
/* ------------------------------------------------------------------------- */
/**
* Creates a structure to track windows for subprocesses.
*
* Also calls the `window_created_callback`, if given.
*
* @param window_ptr
* @param subprocess_handle_ptr
*
* @return A pointer to @ref wlmaker_subprocess_window_t or NULL on error.
*/
wlmaker_subprocess_window_t *wlmaker_subprocess_window_create(
wlmtk_window_t *window_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr)
{
// Guard clause: No need for window handle, if no window nor process.
if (NULL == window_ptr || NULL == subprocess_handle_ptr) return NULL;
wlmaker_subprocess_window_t *ws_window_ptr = logged_calloc(
1, sizeof(wlmaker_subprocess_window_t));
if (NULL == ws_window_ptr) return NULL;
ws_window_ptr->window_ptr = window_ptr;
ws_window_ptr->subprocess_handle_ptr = subprocess_handle_ptr;
if (NULL != subprocess_handle_ptr->window_created_callback) {
subprocess_handle_ptr->window_created_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
}
bs_dllist_push_back(&subprocess_handle_ptr->windows,
&ws_window_ptr->dlnode);
return ws_window_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the structure for tracking windows for subprocesses.
*
* Calls the `window_destroyed_callback`, if given.
*
* @param ws_window_ptr
*/
void wlmaker_subprocess_window_destroy(
wlmaker_subprocess_window_t *ws_window_ptr)
{
wlmaker_subprocess_handle_t *subprocess_handle_ptr =
ws_window_ptr->subprocess_handle_ptr;
if (ws_window_ptr->mapped &&
NULL != subprocess_handle_ptr &&
NULL != subprocess_handle_ptr->window_unmapped_callback) {
subprocess_handle_ptr->window_unmapped_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
ws_window_ptr->mapped = false;
}
if (NULL != subprocess_handle_ptr &&
NULL != subprocess_handle_ptr->window_destroyed_callback) {
subprocess_handle_ptr->window_destroyed_callback(
subprocess_handle_ptr->userdata_ptr,
subprocess_handle_ptr,
ws_window_ptr->window_ptr);
}
if (NULL != ws_window_ptr->subprocess_handle_ptr) {
bs_dllist_remove(
&ws_window_ptr->subprocess_handle_ptr->windows,
&ws_window_ptr->dlnode);
ws_window_ptr->subprocess_handle_ptr = NULL;
}
free(ws_window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Comparator for window registry tree nodes. */
int wlmaker_subprocess_window_node_cmp(const bs_avltree_node_t *node_ptr,
const void *key_ptr)
{
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
node_ptr, wlmaker_subprocess_window_t, avlnode);
return bs_avltree_cmp_ptr(ws_window_ptr->window_ptr, key_ptr);
}
/* ------------------------------------------------------------------------- */
/** Destructor for window registry tree nodes. */
void wlmaker_subprocess_window_node_destroy(bs_avltree_node_t *node_ptr)
{
wlmaker_subprocess_window_t *ws_window_ptr = BS_CONTAINER_OF(
node_ptr, wlmaker_subprocess_window_t, avlnode);
wlmaker_subprocess_window_destroy(ws_window_ptr);
}
/* == End of subprocess_monitor.c ========================================== */
wlmaker-0.3/src/subprocess_monitor.h 0000664 0000000 0000000 00000007720 14641446446 0017740 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file subprocess_monitor.h
*
* @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.
*/
#ifndef __SUBPROCESS_MONITOR_H__
#define __SUBPROCESS_MONITOR_H__
#include
/** Forward definition for the subprocess monitor. */
typedef struct _wlmaker_subprocess_monitor_t wlmaker_subprocess_monitor_t;
/** Forward definition for a subprocess handle. */
typedef struct _wlmaker_subprocess_handle_t wlmaker_subprocess_handle_t;
#include "server.h"
#include "toolkit/toolkit.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Callback for then the subprocess is terminated.
*
* @param userdata_ptr
* @param subprocess_handle_ptr
* @param state
* @param code
*/
typedef void (*wlmaker_subprocess_terminated_callback_t)(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
int state,
int code);
/**
* Callback for when window events happened for the subprocess.
*
* @param userdata_ptr
* @param subprocess_handle_ptr
* @param window_ptr
*/
typedef void (*wlmaker_subprocess_window_callback_t)(
void *userdata_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr,
wlmtk_window_t *window_ptr);
/**
* Creates the subprocess monitor
*
* @param server_ptr
*
* @return Pointer to the subprocess monitor or NULL on error.
*/
wlmaker_subprocess_monitor_t* wlmaker_subprocess_monitor_create(
wlmaker_server_t *server_ptr);
/**
* Destroys the subprocess monitor.
*
* @param monitor_ptr
*/
void wlmaker_subprocess_monitor_destroy(
wlmaker_subprocess_monitor_t *monitor_ptr);
/**
* Passes ownership of the started `subprocess_ptr` to `monitor_ptr`.
*
* Also registers a set of callbacks that will be triggered. Permits to keep
* a central register of all started sub-processes, to monitor for termination,
* and to link up connecting clients with the sub-processes.
*
* @param monitor_ptr
* @param subprocess_ptr
* @param terminated_callback
* @param userdata_ptr
* @param window_created_callback
* @param window_mapped_callback
* @param window_unmapped_callback
* @param window_destroyed_callback
*
* @return A pointer to the created subprocess handle or NULL on error.
*/
wlmaker_subprocess_handle_t *wlmaker_subprocess_monitor_entrust(
wlmaker_subprocess_monitor_t *monitor_ptr,
bs_subprocess_t *subprocess_ptr,
wlmaker_subprocess_terminated_callback_t terminated_callback,
void *userdata_ptr,
wlmaker_subprocess_window_callback_t window_created_callback,
wlmaker_subprocess_window_callback_t window_mapped_callback,
wlmaker_subprocess_window_callback_t window_unmapped_callback,
wlmaker_subprocess_window_callback_t window_destroyed_callback);
/**
* Releases the reference held on `subprocess_handle_ptr`. Once the subprocess
* terminates, all corresponding resources will be freed.
*
* @param monitor_ptr
* @param subprocess_handle_ptr
*/
void wlmaker_subprocess_monitor_cede(
wlmaker_subprocess_monitor_t *monitor_ptr,
wlmaker_subprocess_handle_t *subprocess_handle_ptr);
/** Returns the `bs_subprocess_t` from the @ref wlmaker_subprocess_handle_t. */
bs_subprocess_t *wlmaker_subprocess_from_subprocess_handle(
wlmaker_subprocess_handle_t *subprocess_handle_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __SUBPROCESS_MONITOR_H__ */
/* == End of subprocess_monitor.h ========================================== */
wlmaker-0.3/src/task_list.c 0000664 0000000 0000000 00000040740 14641446446 0015770 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file task_list.c
*
* @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.
*/
/// for PATH_MAX.
#define _POSIX_C_SOURCE 1
#include "task_list.h"
#include "config.h"
#include "toolkit/toolkit.h"
#include
#include
/// Include unstable interfaces of wlroots.
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the task list. */
struct _wlmaker_task_list_t {
/** Derived from a toolkit panel. */
wlmtk_panel_t super_panel;
/** Buffer that shows the tasklist's content. */
wlmtk_buffer_t buffer;
/** Backlink to the server. */
wlmaker_server_t *server_ptr;
/** Listener for the `task_list_enabled` signal by `wlmaker_server_t`. */
struct wl_listener task_list_enabled_listener;
/** Listener for the `task_list_disabled` signal by `wlmaker_server_t`. */
struct wl_listener task_list_disabled_listener;
/** Listener for `window_mapped_event` signal by `wlmaker_server_t`. */
struct wl_listener window_mapped_listener;
/** Listener for `window_unmapped_event` signal by `wlmaker_server_t`. */
struct wl_listener window_unmapped_listener;
/** Whether the task list is currently enabled (mapped). */
bool enabled;
/** Visual style. */
wlmaker_config_task_list_style_t style;
};
static void _wlmaker_task_list_refresh(
wlmaker_task_list_t *task_list_ptr);
static struct wlr_buffer *create_wlr_buffer(
wlmtk_workspace_t *workspace_ptr,
wlmaker_config_task_list_style_t *style_ptr);
static void _wlmaker_task_list_draw_into_cairo(
cairo_t *cairo_ptr,
wlmaker_config_task_list_style_t *style_ptr,
wlmtk_workspace_t *workspace_ptr);
static void _wlmaker_task_list_draw_window_into_cairo(
cairo_t *cairo_ptr,
wlmtk_style_font_t *font_style_ptr,
uint32_t color,
wlmtk_window_t *window_ptr,
bool active,
int pos_y);
static const char *_wlmaker_task_list_window_name(
wlmtk_window_t *window_ptr);
static uint32_t _wlmaker_task_list_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height);
static void _wlmaker_task_list_handle_task_list_enabled(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_task_list_handle_task_list_disabled(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_task_list_handle_window_mapped(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmaker_task_list_handle_window_unmapped(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** Task list positioning: Fixed dimensions, at center of layer. */
static const wlmtk_panel_positioning_t _wlmaker_task_list_positioning = {
.desired_width = 400,
.desired_height = 200,
.anchor = WLR_EDGE_BOTTOM | WLR_EDGE_TOP | WLR_EDGE_LEFT | WLR_EDGE_RIGHT
};
/** Virtual method table for the task list. */
static const wlmtk_panel_vmt_t _wlmaker_task_list_vmt = {
.request_size = _wlmaker_task_list_request_size
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmaker_task_list_t *wlmaker_task_list_create(
wlmaker_server_t *server_ptr,
const wlmaker_config_style_t *style_ptr)
{
wlmaker_task_list_t *task_list_ptr = logged_calloc(
1, sizeof(wlmaker_task_list_t));
task_list_ptr->server_ptr = server_ptr;
task_list_ptr->style = style_ptr->task_list;
if (!wlmtk_panel_init(&task_list_ptr->super_panel,
&_wlmaker_task_list_positioning,
server_ptr->env_ptr)) {
wlmaker_task_list_destroy(task_list_ptr);
return NULL;
}
wlmtk_panel_extend(&task_list_ptr->super_panel,
&_wlmaker_task_list_vmt);
wlmtk_element_set_visible(
wlmtk_panel_element(&task_list_ptr->super_panel), true);
if (!wlmtk_buffer_init(&task_list_ptr->buffer, server_ptr->env_ptr)) {
wlmaker_task_list_destroy(task_list_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_buffer_element(&task_list_ptr->buffer), true);
wlmtk_container_add_element(
&task_list_ptr->super_panel.super_container,
wlmtk_buffer_element(&task_list_ptr->buffer));
wlmtk_util_connect_listener_signal(
&server_ptr->task_list_enabled_event,
&task_list_ptr->task_list_enabled_listener,
_wlmaker_task_list_handle_task_list_enabled);
wlmtk_util_connect_listener_signal(
&server_ptr->task_list_disabled_event,
&task_list_ptr->task_list_disabled_listener,
_wlmaker_task_list_handle_task_list_disabled);
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->window_mapped,
&task_list_ptr->window_mapped_listener,
_wlmaker_task_list_handle_window_mapped);
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(server_ptr->root_ptr)->window_unmapped,
&task_list_ptr->window_unmapped_listener,
_wlmaker_task_list_handle_window_unmapped);
return task_list_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmaker_task_list_destroy(wlmaker_task_list_t *task_list_ptr)
{
wl_list_remove(&task_list_ptr->window_unmapped_listener.link);
wl_list_remove(&task_list_ptr->window_mapped_listener.link);
wl_list_remove(&task_list_ptr->task_list_disabled_listener.link);
wl_list_remove(&task_list_ptr->task_list_enabled_listener.link);
if (wlmtk_buffer_element(&task_list_ptr->buffer)->parent_container_ptr) {
wlmtk_container_remove_element(
&task_list_ptr->super_panel.super_container,
wlmtk_buffer_element(&task_list_ptr->buffer));
}
wlmtk_buffer_fini(&task_list_ptr->buffer);
wlmtk_panel_fini(&task_list_ptr->super_panel);
free(task_list_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Refreshes the task list. Should be done whenever a list is mapped/unmapped.
*
* @param task_list_ptr
*/
void _wlmaker_task_list_refresh(wlmaker_task_list_t *task_list_ptr)
{
wlmtk_workspace_t *workspace_ptr =
wlmtk_root_get_current_workspace(task_list_ptr->server_ptr->root_ptr);
struct wlr_buffer *wlr_buffer_ptr = create_wlr_buffer(
workspace_ptr, &task_list_ptr->style);
wlmtk_buffer_set(&task_list_ptr->buffer, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Creates a `struct wlr_buffer` with windows of `workspace_ptr` drawn into.
*
* @param workspace_ptr
* @param style_ptr
*
* @return A pointer to the `struct wlr_buffer` with the list of windows
* (tasks), or NULL on error.
*/
struct wlr_buffer *create_wlr_buffer(
wlmtk_workspace_t *workspace_ptr,
wlmaker_config_task_list_style_t *style_ptr)
{
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
_wlmaker_task_list_positioning.desired_width,
_wlmaker_task_list_positioning.desired_height);
if (NULL == wlr_buffer_ptr) return NULL;
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
_wlmaker_task_list_draw_into_cairo(cairo_ptr, style_ptr, workspace_ptr);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Draws all tasks of `workspace_ptr` into `cairo_ptr`.
*
* @param cairo_ptr
* @param style_ptr
* @param workspace_ptr
*/
void _wlmaker_task_list_draw_into_cairo(
cairo_t *cairo_ptr,
wlmaker_config_task_list_style_t *style_ptr,
wlmtk_workspace_t *workspace_ptr)
{
wlmaker_primitives_cairo_fill(cairo_ptr, &style_ptr->fill);
// Not tied to a workspace? We're done, all set.
if (NULL == workspace_ptr) return;
const bs_dllist_t *windows_ptr = wlmtk_workspace_get_windows_dllist(
workspace_ptr);
// No windows at all? Done here.
if (bs_dllist_empty(windows_ptr)) return;
// Find node of the active window, for centering the task list.
bs_dllist_node_t *centered_dlnode_ptr = windows_ptr->head_ptr;
bs_dllist_node_t *active_dlnode_ptr = windows_ptr->head_ptr;
while (NULL != active_dlnode_ptr &&
wlmtk_workspace_get_activated_window(workspace_ptr) !=
wlmtk_window_from_dlnode(active_dlnode_ptr)) {
active_dlnode_ptr = active_dlnode_ptr->next_ptr;
}
if (NULL != active_dlnode_ptr) centered_dlnode_ptr = active_dlnode_ptr;
int pos_y = _wlmaker_task_list_positioning.desired_height / 2 + 10;
_wlmaker_task_list_draw_window_into_cairo(
cairo_ptr,
&style_ptr->font,
style_ptr->text_color,
wlmtk_window_from_dlnode(centered_dlnode_ptr),
centered_dlnode_ptr == active_dlnode_ptr,
pos_y);
bs_dllist_node_t *dlnode_ptr = centered_dlnode_ptr->prev_ptr;
for (int further_windows = 1;
NULL != dlnode_ptr && further_windows <= 3;
dlnode_ptr = dlnode_ptr->prev_ptr, ++further_windows) {
_wlmaker_task_list_draw_window_into_cairo(
cairo_ptr,
&style_ptr->font,
style_ptr->text_color,
wlmtk_window_from_dlnode(dlnode_ptr),
false,
pos_y - further_windows * 26);
}
dlnode_ptr = centered_dlnode_ptr->next_ptr;
for (int further_windows = 1;
NULL != dlnode_ptr && further_windows <= 3;
dlnode_ptr = dlnode_ptr->next_ptr, ++further_windows) {
_wlmaker_task_list_draw_window_into_cairo(
cairo_ptr,
&style_ptr->font,
style_ptr->text_color,
wlmtk_window_from_dlnode(dlnode_ptr),
false,
pos_y + further_windows * 26);
}
}
/* ------------------------------------------------------------------------- */
/**
* Draws one window (task) into `cairo_ptr`.
*
* @param cairo_ptr
* @param font_style_ptr
* @param color
* @param window_ptr
* @param active Whether this window is currently active.
* @param pos_y Y position within the `cairo_ptr`.
*/
void _wlmaker_task_list_draw_window_into_cairo(
cairo_t *cairo_ptr,
wlmtk_style_font_t *font_style_ptr,
uint32_t color,
wlmtk_window_t *window_ptr,
bool active,
int pos_y)
{
cairo_set_source_argb8888(cairo_ptr, color);
cairo_set_font_size(cairo_ptr, font_style_ptr->size);
cairo_select_font_face(
cairo_ptr,
font_style_ptr->face,
CAIRO_FONT_SLANT_NORMAL,
active ? CAIRO_FONT_WEIGHT_BOLD : CAIRO_FONT_WEIGHT_NORMAL);
cairo_move_to(cairo_ptr, 10, pos_y);
cairo_show_text(cairo_ptr, _wlmaker_task_list_window_name(window_ptr));
}
/* ------------------------------------------------------------------------- */
/**
* Constructs a comprehensive name for the window.
*
* @param window_ptr
*
* @return Pointer to the constructed name. This is a static buffer that does
* not require to be free'd, but will be re-used upon next call to
* window_name.
*/
const char *_wlmaker_task_list_window_name(wlmtk_window_t *window_ptr)
{
static char name[256];
size_t pos = 0;
const char *title_ptr = wlmtk_window_get_title(window_ptr);
if (NULL != title_ptr) {
pos = bs_strappendf(name, sizeof(name), pos, "%s", title_ptr);
}
const wlmtk_util_client_t *client_ptr = wlmtk_window_get_client_ptr(
window_ptr);
if (NULL != client_ptr && 0 != client_ptr->pid) {
if (0 < pos) pos = bs_strappendf(name, sizeof(name), pos, " ");
pos = bs_strappendf(name, sizeof(name), pos, "[%"PRIdMAX,
(intmax_t)client_ptr->pid);
char fname[PATH_MAX], cmdline[PATH_MAX];
snprintf(fname, sizeof(fname), "/proc/%"PRIdMAX"/cmdline",
(intmax_t)client_ptr->pid);
ssize_t read_bytes = bs_file_read_buffer(
fname, cmdline, sizeof(cmdline));
if (0 < read_bytes) {
pos = bs_strappendf(name, sizeof(name), pos, ": %s", cmdline);
}
pos = bs_strappendf(name, sizeof(name), pos, "]");
}
if (0 < pos) pos = bs_strappendf(name, sizeof(name), pos, " ");
pos = bs_strappendf(name, sizeof(name), pos, "(%p)", window_ptr);
return &name[0];
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_panel_vmt_t::request_size.
*
* @param panel_ptr
* @param width
* @param height
*
* @return 0 always.
*/
uint32_t _wlmaker_task_list_request_size(
wlmtk_panel_t *panel_ptr,
__UNUSED__ int width,
__UNUSED__ int height)
{
wlmtk_panel_commit(panel_ptr, 0, &_wlmaker_task_list_positioning);
return 0;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `task_list_enabled_listener`.
*
* Enables the task listener: Creates the task list for the currently-active
* workspace and enables the task list on that workspace.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_task_list_handle_task_list_enabled(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_task_list_t *task_list_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_task_list_t, task_list_enabled_listener);
_wlmaker_task_list_refresh(task_list_ptr);
if (task_list_ptr->enabled) {
BS_ASSERT(NULL != wlmtk_panel_get_layer(&task_list_ptr->super_panel));
return;
}
wlmtk_workspace_t *workspace_ptr =
wlmtk_root_get_current_workspace(task_list_ptr->server_ptr->root_ptr);
wlmtk_layer_t *layer_ptr = wlmtk_workspace_get_layer(
workspace_ptr, WLMTK_WORKSPACE_LAYER_OVERLAY);
wlmtk_layer_add_panel(layer_ptr, &task_list_ptr->super_panel);
task_list_ptr->enabled = true;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `task_list_disabled_listener`: Hides the list.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_task_list_handle_task_list_disabled(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_task_list_t *task_list_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_task_list_t, task_list_disabled_listener);
BS_ASSERT(NULL != wlmtk_panel_get_layer(&task_list_ptr->super_panel));
wlmtk_layer_remove_panel(
wlmtk_panel_get_layer(&task_list_ptr->super_panel),
&task_list_ptr->super_panel);
task_list_ptr->enabled = false;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `window_mapped_listener`: Refreshes the list (if enabled).
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_task_list_handle_window_mapped(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_task_list_t *task_list_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_task_list_t, window_mapped_listener);
if (task_list_ptr->enabled) {
_wlmaker_task_list_refresh(task_list_ptr);
}
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `window_unmapped_listener`: Refreshes the list (if enabled).
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmaker_task_list_handle_window_unmapped(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmaker_task_list_t *task_list_ptr = BS_CONTAINER_OF(
listener_ptr, wlmaker_task_list_t, window_unmapped_listener);
if (task_list_ptr->enabled) {
_wlmaker_task_list_refresh(task_list_ptr);
}
}
/* == End of task_list.c =================================================== */
wlmaker-0.3/src/task_list.h 0000664 0000000 0000000 00000005324 14641446446 0015774 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file task_list.h
*
* @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.
*/
#ifndef __TASK_LIST_H__
#define __TASK_LIST_H__
/** Forward definition: Task list handle. */
typedef struct _wlmaker_task_list_t wlmaker_task_list_t;
#include "server.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
// TODO(kaeser@gubbe.ch): Move this to wlmaker_keyboard.
// Taskswitch:
// modifer = ALT, and PRESSED is TAB enables it, and will switch focus
// to the next-open View.
//
// - TAB will switch focus one further
// - Shift-TAB will switch focus one back
// (- Cursor left/right will also switch focus further/one back)
// - Esc will restore focus of the view that has it before switcher.
//
// will remain active until:
// - ALT is released
// - any key outside the handled keys are pressed
// - mouse is presset outside the task switch window
// - workspace is switched.
//
// Means: It needs a means of...
// - grabbing keyboard focus and holding it until release.
// - grabbing mouse focus and holding it until release.
// - not losing focus and top-of-stack until release.
// => Should be atop each layer -> have it's own layer? or OVERLAY ?
// (likely go with overlay)
//
// => means, this is like a "layer view" except the extra focus constraints.
/**
* Creates a task list for the server.
*
* Will allocate the task list handle, and register signal handlers so the task
* list reacts to `task_list_enabled_event` and `task_list_disabled_event` of
* the `wlmaker_server_t`.
*
* @param server_ptr
* @param style_ptr
*
* @return The task list handle or NULL on error. Must be released by calling
* @ref wlmaker_task_list_destroy.
*/
wlmaker_task_list_t *wlmaker_task_list_create(
wlmaker_server_t *server_ptr,
const wlmaker_config_style_t *style_ptr);
/**
* Destroys the task list, as created by @ref wlmaker_task_list_create.
*
* @param task_list_ptr
*/
void wlmaker_task_list_destroy(
wlmaker_task_list_t *task_list_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __TASK_LIST_H__ */
/* == End of task_list.h =================================================== */
wlmaker-0.3/src/toolkit/ 0000775 0000000 0000000 00000000000 14641446446 0015307 5 ustar 00root root 0000000 0000000 wlmaker-0.3/src/toolkit/CMakeLists.txt 0000664 0000000 0000000 00000004132 14641446446 0020047 0 ustar 00root root 0000000 0000000 # 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.
CMAKE_MINIMUM_REQUIRED(VERSION 3.13)
SET(PUBLIC_HEADER_FILES
bordered.h
box.h
buffer.h
button.h
container.h
content.h
dock.h
element.h
env.h
fsm.h
gfxbuf.h
image.h
input.h
layer.h
lock.h
panel.h
popup.h
primitives.h
rectangle.h
resizebar.h
resizebar_area.h
root.h
style.h
surface.h
tile.h
titlebar.h
titlebar_button.h
titlebar_title.h
toolkit.h
util.h
window.h
workspace.h
)
ADD_LIBRARY(toolkit STATIC)
TARGET_SOURCES(toolkit PRIVATE
bordered.c
box.c
buffer.c
button.c
container.c
content.c
dock.c
element.c
env.c
fsm.c
gfxbuf.c
image.c
layer.c
lock.c
panel.c
popup.c
primitives.c
rectangle.c
resizebar.c
resizebar_area.c
root.c
style.c
surface.c
tile.c
titlebar.c
titlebar_button.c
titlebar_title.c
util.c
window.c
workspace.c
)
TARGET_INCLUDE_DIRECTORIES(
toolkit PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/..
${WLROOTS_INCLUDE_DIRS})
SET_TARGET_PROPERTIES(
toolkit PROPERTIES
VERSION 1.0
PUBLIC_HEADER "${PUBLIC_HEADER_FILES}")
TARGET_COMPILE_OPTIONS(
toolkit PRIVATE
${WAYLAND_CFLAGS}
${WAYLAND_CFLAGS_OTHER}
)
TARGET_INCLUDE_DIRECTORIES(
toolkit PRIVATE
${CAIRO_INCLUDE_DIRS}
)
TARGET_LINK_LIBRARIES(
toolkit
base
PkgConfig::CAIRO
PkgConfig::WAYLAND
PkgConfig::WLROOTS
)
ADD_EXECUTABLE(toolkit_test toolkit_test.c)
TARGET_LINK_LIBRARIES(toolkit_test toolkit)
TARGET_COMPILE_DEFINITIONS(
toolkit_test PUBLIC TEST_DATA_DIR="${PROJECT_SOURCE_DIR}/testdata")
ADD_TEST(NAME toolkit_test COMMAND toolkit_test)
wlmaker-0.3/src/toolkit/bordered.c 0000664 0000000 0000000 00000026406 14641446446 0017251 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file bordered.c
*
* @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.
*/
#include "bordered.h"
/* == Declarations ========================================================= */
static void _wlmtk_bordered_container_update_layout(
wlmtk_container_t *container_ptr);
static wlmtk_rectangle_t * _wlmtk_bordered_create_border_rectangle(
wlmtk_bordered_t *bordered_ptr,
wlmtk_env_t *env_ptr);
static void _wlmtk_bordered_destroy_border_rectangle(
wlmtk_bordered_t *bordered_ptr,
wlmtk_rectangle_t **rectangle_ptr_ptr);
static void _wlmtk_bordered_set_positions(wlmtk_bordered_t *bordered_ptr);
/* == Data ================================================================= */
/** Virtual method table: @ref wlmtk_container_t at @ref wlmtk_bordered_t. */
static const wlmtk_container_vmt_t bordered_container_vmt = {
.update_layout = _wlmtk_bordered_container_update_layout,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_bordered_init(wlmtk_bordered_t *bordered_ptr,
wlmtk_env_t *env_ptr,
wlmtk_element_t *element_ptr,
const wlmtk_margin_style_t *style_ptr)
{
BS_ASSERT(NULL != bordered_ptr);
memset(bordered_ptr, 0, sizeof(wlmtk_bordered_t));
if (!wlmtk_container_init(&bordered_ptr->super_container, env_ptr)) {
return false;
}
bordered_ptr->orig_super_container_vmt = wlmtk_container_extend(
&bordered_ptr->super_container, &bordered_container_vmt);
memcpy(&bordered_ptr->style, style_ptr, sizeof(wlmtk_margin_style_t));
bordered_ptr->element_ptr = element_ptr;
wlmtk_container_add_element(&bordered_ptr->super_container,
bordered_ptr->element_ptr);
bordered_ptr->northern_border_rectangle_ptr =
_wlmtk_bordered_create_border_rectangle(bordered_ptr, env_ptr);
bordered_ptr->eastern_border_rectangle_ptr =
_wlmtk_bordered_create_border_rectangle(bordered_ptr, env_ptr);
bordered_ptr->southern_border_rectangle_ptr =
_wlmtk_bordered_create_border_rectangle(bordered_ptr, env_ptr);
bordered_ptr->western_border_rectangle_ptr =
_wlmtk_bordered_create_border_rectangle(bordered_ptr, env_ptr);
if (NULL == bordered_ptr->northern_border_rectangle_ptr ||
NULL == bordered_ptr->eastern_border_rectangle_ptr ||
NULL == bordered_ptr->southern_border_rectangle_ptr ||
NULL == bordered_ptr->western_border_rectangle_ptr) {
wlmtk_bordered_fini(bordered_ptr);
return false;
}
_wlmtk_bordered_set_positions(bordered_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_bordered_fini(wlmtk_bordered_t *bordered_ptr)
{
_wlmtk_bordered_destroy_border_rectangle(
bordered_ptr, &bordered_ptr->western_border_rectangle_ptr);
_wlmtk_bordered_destroy_border_rectangle(
bordered_ptr, &bordered_ptr->southern_border_rectangle_ptr);
_wlmtk_bordered_destroy_border_rectangle(
bordered_ptr, &bordered_ptr->eastern_border_rectangle_ptr);
_wlmtk_bordered_destroy_border_rectangle(
bordered_ptr, &bordered_ptr->northern_border_rectangle_ptr);
wlmtk_container_remove_element(&bordered_ptr->super_container,
bordered_ptr->element_ptr);
wlmtk_container_fini(&bordered_ptr->super_container);
memset(bordered_ptr, 0, sizeof(wlmtk_bordered_t));
}
/* ------------------------------------------------------------------------- */
void wlmtk_bordered_set_style(wlmtk_bordered_t *bordered_ptr,
const wlmtk_margin_style_t *style_ptr)
{
memcpy(&bordered_ptr->style, style_ptr, sizeof(wlmtk_margin_style_t));
_wlmtk_bordered_container_update_layout(&bordered_ptr->super_container);
// Guard clause. Actually, if *any* of the rectangles was not created.
if (NULL == bordered_ptr->western_border_rectangle_ptr) return;
wlmtk_rectangle_set_color(
bordered_ptr->northern_border_rectangle_ptr, style_ptr->color);
wlmtk_rectangle_set_color(
bordered_ptr->eastern_border_rectangle_ptr, style_ptr->color);
wlmtk_rectangle_set_color(
bordered_ptr->southern_border_rectangle_ptr, style_ptr->color);
wlmtk_rectangle_set_color(
bordered_ptr->western_border_rectangle_ptr, style_ptr->color);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Updates the layout of the bordered element.
*
* @param container_ptr
*/
void _wlmtk_bordered_container_update_layout(
wlmtk_container_t *container_ptr)
{
wlmtk_bordered_t *bordered_ptr = BS_CONTAINER_OF(
container_ptr, wlmtk_bordered_t, super_container);
_wlmtk_bordered_set_positions(bordered_ptr);
bordered_ptr->orig_super_container_vmt.update_layout(container_ptr);
}
/* ------------------------------------------------------------------------- */
/** Creates a border rectangle and adds it to `bordered_ptr`. */
wlmtk_rectangle_t * _wlmtk_bordered_create_border_rectangle(
wlmtk_bordered_t *bordered_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = wlmtk_rectangle_create(
env_ptr, 0, 0, bordered_ptr->style.color);
if (NULL == rectangle_ptr) return NULL;
wlmtk_element_set_visible(wlmtk_rectangle_element(rectangle_ptr), true);
wlmtk_container_add_element_atop(
&bordered_ptr->super_container,
NULL,
wlmtk_rectangle_element(rectangle_ptr));
return rectangle_ptr;
}
/* ------------------------------------------------------------------------- */
/** Removes the rectangle from `bordered_ptr`, destroys it and NULLs it. */
void _wlmtk_bordered_destroy_border_rectangle(
wlmtk_bordered_t *bordered_ptr,
wlmtk_rectangle_t **rectangle_ptr_ptr)
{
if (NULL == *rectangle_ptr_ptr) return;
wlmtk_container_remove_element(
&bordered_ptr->super_container,
wlmtk_rectangle_element(*rectangle_ptr_ptr));
wlmtk_rectangle_destroy(*rectangle_ptr_ptr);
*rectangle_ptr_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
/**
* Updates the position of all 4 border elements.
*
* Retrieves the position and dimensions of @ref wlmtk_bordered_t::element_ptr
* and arranges the 4 border elements around it.
*
* @param bordered_ptr
*/
void _wlmtk_bordered_set_positions(wlmtk_bordered_t *bordered_ptr)
{
int x1, y1, x2, y2;
int x_pos, y_pos;
if (NULL == bordered_ptr->western_border_rectangle_ptr) return;
int margin = bordered_ptr->style.width;
wlmtk_element_get_dimensions(
bordered_ptr->element_ptr, &x1, &y1, &x2, &y2);
x_pos = -x1 + margin;
y_pos = -y1 + margin;
int width = x2 - x1;
int height = y2 - y1;
wlmtk_element_set_position(bordered_ptr->element_ptr, x_pos, y_pos);
wlmtk_element_set_position(
wlmtk_rectangle_element(bordered_ptr->northern_border_rectangle_ptr),
x_pos - margin, y_pos - margin);
wlmtk_rectangle_set_size(
bordered_ptr->northern_border_rectangle_ptr,
width + 2 * margin, margin);
wlmtk_element_set_position(
wlmtk_rectangle_element(bordered_ptr->eastern_border_rectangle_ptr),
x_pos + width, y_pos);
wlmtk_rectangle_set_size(
bordered_ptr->eastern_border_rectangle_ptr,
margin, height);
wlmtk_element_set_position(
wlmtk_rectangle_element(bordered_ptr->southern_border_rectangle_ptr),
x_pos - margin, y_pos + height);
wlmtk_rectangle_set_size(
bordered_ptr->southern_border_rectangle_ptr,
width + 2 * margin, margin);
wlmtk_element_set_position(
wlmtk_rectangle_element(bordered_ptr->western_border_rectangle_ptr),
x_pos - margin, y_pos);
wlmtk_rectangle_set_size(
bordered_ptr->western_border_rectangle_ptr,
margin, height);
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_bordered_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 0, NULL, NULL }
};
/** Style used for tests. */
static const wlmtk_margin_style_t test_style = {
.width = 2,
.color = 0xff000000
};
/** Helper: Tests that the rectangle is positioned as specified. */
void test_rectangle_pos(bs_test_t *test_ptr, wlmtk_rectangle_t *rect_ptr,
int x, int y, int width, int height)
{
wlmtk_element_t *elem_ptr = wlmtk_rectangle_element(rect_ptr);
BS_TEST_VERIFY_EQ(test_ptr, x, elem_ptr->x);
BS_TEST_VERIFY_EQ(test_ptr, y, elem_ptr->y);
int x1, y1, x2, y2;
wlmtk_element_get_dimensions(elem_ptr, &x1, &y1, &x2, &y2);
BS_TEST_VERIFY_EQ(test_ptr, 0, x1);
BS_TEST_VERIFY_EQ(test_ptr, 0, y1);
BS_TEST_VERIFY_EQ(test_ptr, width, x2 - x1);
BS_TEST_VERIFY_EQ(test_ptr, height, y2 - y1);
}
/* ------------------------------------------------------------------------- */
/** Exercises setup and teardown. */
void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fe_ptr = wlmtk_fake_element_create();
fe_ptr->dimensions.width = 100;
fe_ptr->dimensions.height = 20;
wlmtk_element_set_position(&fe_ptr->element, -10, -4);
wlmtk_bordered_t bordered;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_bordered_init(
&bordered, NULL, &fe_ptr->element, &test_style));
// Positions of border elements.
test_rectangle_pos(
test_ptr, bordered.northern_border_rectangle_ptr,
0, 0, 104, 2);
test_rectangle_pos(
test_ptr, bordered.eastern_border_rectangle_ptr,
102, 2, 2, 20);
test_rectangle_pos(
test_ptr, bordered.southern_border_rectangle_ptr,
0, 22, 104, 2);
test_rectangle_pos(
test_ptr, bordered.western_border_rectangle_ptr,
0, 2, 2, 20);
// Update layout, test updated positions.
fe_ptr->dimensions.width = 200;
fe_ptr->dimensions.height = 120;
wlmtk_container_update_layout(&bordered.super_container);
test_rectangle_pos(
test_ptr, bordered.northern_border_rectangle_ptr,
0, 0, 204, 2);
test_rectangle_pos(
test_ptr, bordered.eastern_border_rectangle_ptr,
202, 2, 2, 120);
test_rectangle_pos(
test_ptr, bordered.southern_border_rectangle_ptr,
0, 122, 204, 2);
test_rectangle_pos(
test_ptr, bordered.western_border_rectangle_ptr,
0, 2, 2, 120);
wlmtk_bordered_fini(&bordered);
wlmtk_element_destroy(&fe_ptr->element);
}
/* == End of bordered.c ==================================================== */
wlmaker-0.3/src/toolkit/bordered.h 0000664 0000000 0000000 00000005760 14641446446 0017256 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file bordered.h
*
* @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.
*/
#ifndef __WLMTK_BORDERED_H__
#define __WLMTK_BORDERED_H__
#include "container.h"
#include "rectangle.h"
#include "style.h"
/** Forward declaration: Bordered container state. */
typedef struct _wlmtk_bordered_t wlmtk_bordered_t;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** State of the bordered container. */
struct _wlmtk_bordered_t {
/** Super class of the bordered. */
wlmtk_container_t super_container;
/** Virtual method table of the super container before extending it. */
wlmtk_container_vmt_t orig_super_container_vmt;
/** Points to the element that will be enclosed by the border. */
wlmtk_element_t *element_ptr;
/** Style of the border. */
wlmtk_margin_style_t style;
/** Border element at the northern side. Includes east + west corners. */
wlmtk_rectangle_t *northern_border_rectangle_ptr;
/** Border element at the eastern side. */
wlmtk_rectangle_t *eastern_border_rectangle_ptr;
/** Border element at the southern side. Includes east + west corners. */
wlmtk_rectangle_t *southern_border_rectangle_ptr;
/** Border element at the western side. */
wlmtk_rectangle_t *western_border_rectangle_ptr;
};
/**
* Initializes the bordered element.
*
* The bordered element positions the element within such that north-western
* corner is at (0, 0).
*
* @param bordered_ptr
* @param env_ptr
* @param element_ptr
* @param style_ptr
*
* @return true on success.
*/
bool wlmtk_bordered_init(wlmtk_bordered_t *bordered_ptr,
wlmtk_env_t *env_ptr,
wlmtk_element_t *element_ptr,
const wlmtk_margin_style_t *style_ptr);
/**
* Un-initializes the bordered element.
*
* @param bordered_ptr
*/
void wlmtk_bordered_fini(wlmtk_bordered_t *bordered_ptr);
/**
* Updates the style.
*
* @param bordered_ptr
* @param style_ptr
*/
void wlmtk_bordered_set_style(wlmtk_bordered_t *bordered_ptr,
const wlmtk_margin_style_t *style_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_bordered_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_BORDERED_H__ */
/* == End of bordered.h ==================================================== */
wlmaker-0.3/src/toolkit/box.c 0000664 0000000 0000000 00000034123 14641446446 0016246 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file box.c
*
* @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.
*/
#include "box.h"
#include "rectangle.h"
/* == Declarations ========================================================= */
static void _wlmtk_box_container_update_layout(
wlmtk_container_t *container_ptr);
static bs_dllist_node_t *create_margin(wlmtk_box_t *box_ptr);
/* == Data ================================================================= */
/** Virtual method table: @ref wlmtk_container_t at @ref wlmtk_box_t level. */
static const wlmtk_container_vmt_t box_container_vmt = {
.update_layout = _wlmtk_box_container_update_layout,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_box_init(
wlmtk_box_t *box_ptr,
wlmtk_env_t *env_ptr,
wlmtk_box_orientation_t orientation,
const wlmtk_margin_style_t *style_ptr)
{
BS_ASSERT(NULL != box_ptr);
memset(box_ptr, 0, sizeof(wlmtk_box_t));
if (!wlmtk_container_init(&box_ptr->super_container, env_ptr)) {
return false;
}
box_ptr->orig_super_container_vmt = wlmtk_container_extend(
&box_ptr->super_container, &box_container_vmt);
box_ptr->env_ptr = env_ptr;
memcpy(&box_ptr->style, style_ptr, sizeof(wlmtk_margin_style_t));
if (!wlmtk_container_init(&box_ptr->element_container, env_ptr)) {
wlmtk_box_fini(box_ptr);
return false;
}
wlmtk_element_set_visible(&box_ptr->element_container.super_element, true);
wlmtk_container_add_element(&box_ptr->super_container,
&box_ptr->element_container.super_element);
if (!wlmtk_container_init(&box_ptr->margin_container, env_ptr)) {
wlmtk_box_fini(box_ptr);
return false;
}
wlmtk_element_set_visible(&box_ptr->margin_container.super_element, true);
// Keep margins behind the box's elements.
wlmtk_container_add_element_atop(
&box_ptr->super_container,
NULL,
&box_ptr->margin_container.super_element);
box_ptr->orientation = orientation;
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_box_fini(wlmtk_box_t *box_ptr)
{
if (NULL != box_ptr->element_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&box_ptr->super_container,
&box_ptr->element_container.super_element);
wlmtk_container_fini(&box_ptr->element_container);
}
if (NULL != box_ptr->margin_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&box_ptr->super_container,
&box_ptr->margin_container.super_element);
wlmtk_container_fini(&box_ptr->margin_container);
}
wlmtk_container_fini(&box_ptr->super_container);
memset(box_ptr, 0, sizeof(wlmtk_box_t));
}
/* ------------------------------------------------------------------------- */
void wlmtk_box_add_element_front(
wlmtk_box_t *box_ptr,
wlmtk_element_t *element_ptr)
{
wlmtk_container_add_element(&box_ptr->element_container, element_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_box_add_element_back(
wlmtk_box_t *box_ptr,
wlmtk_element_t *element_ptr)
{
wlmtk_container_add_element_atop(
&box_ptr->element_container, NULL, element_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_box_remove_element(wlmtk_box_t *box_ptr, wlmtk_element_t *element_ptr)
{
wlmtk_container_remove_element(&box_ptr->element_container, element_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_box_element(wlmtk_box_t *box_ptr)
{
return &box_ptr->super_container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Updates the layout of the box.
*
* Steps through all visible elements, and sets their position to be
* left-to-right. Also updates and repositions all margin elements.
*
* @param container_ptr
*/
void _wlmtk_box_container_update_layout(
wlmtk_container_t *container_ptr)
{
wlmtk_box_t *box_ptr = BS_CONTAINER_OF(
container_ptr, wlmtk_box_t, super_container);
wlmtk_element_t *margin_element_ptr = NULL;
int margin_x = 0;
int margin_y = 0;
int margin_width = box_ptr->style.width;
int margin_height = box_ptr->style.width;
size_t visible_elements = 0;
for (bs_dllist_node_t *dlnode_ptr = box_ptr->element_container.elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
if (element_ptr->visible) visible_elements++;
}
int position = 0;
bs_dllist_node_t *margin_dlnode_ptr = box_ptr->margin_container.elements.head_ptr;
for (bs_dllist_node_t *dlnode_ptr = box_ptr->element_container.elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
if (!element_ptr->visible) continue;
int left, top, right, bottom;
wlmtk_element_get_dimensions(element_ptr, &left, &top, &right, &bottom);
int x, y;
wlmtk_element_get_position(element_ptr, &x, &y);
switch (box_ptr->orientation) {
case WLMTK_BOX_HORIZONTAL:
x = position - left;
margin_x = position + right - left;
margin_height = bottom - top;
position = margin_x + box_ptr->style.width;
break;
case WLMTK_BOX_VERTICAL:
y = position - top;
margin_y = position + bottom - top;
margin_width = right - left;
position = margin_y + box_ptr->style.width;
break;
default:
bs_log(BS_FATAL, "Weird orientation %d.", box_ptr->orientation);
}
wlmtk_element_set_position(element_ptr, x, y);
visible_elements--;
// Early exit: No margin needed, if there's no next element.
if (NULL == dlnode_ptr->next_ptr || 0 >= visible_elements) break;
// If required: Create new margin, then position the margin element.
if (NULL == margin_dlnode_ptr) {
margin_dlnode_ptr = create_margin(box_ptr);
}
margin_element_ptr = wlmtk_element_from_dlnode(margin_dlnode_ptr);
wlmtk_element_set_position(margin_element_ptr, margin_x, margin_y);
wlmtk_rectangle_set_size(
wlmtk_rectangle_from_element(margin_element_ptr),
margin_width, margin_height);
margin_dlnode_ptr = margin_dlnode_ptr->next_ptr;
}
// Remove excess margin nodes.
while (NULL != margin_dlnode_ptr) {
margin_element_ptr = wlmtk_element_from_dlnode(margin_dlnode_ptr);
margin_dlnode_ptr = margin_dlnode_ptr->next_ptr;
wlmtk_container_remove_element(
&box_ptr->margin_container, margin_element_ptr);
wlmtk_element_destroy(margin_element_ptr);
}
// Run the base class' update layout; may update pointer focus.
// We do this only after having updated the position of the elements.
box_ptr->orig_super_container_vmt.update_layout(container_ptr);
// configure parent container.
if (NULL != container_ptr->super_element.parent_container_ptr) {
wlmtk_container_update_layout(
container_ptr->super_element.parent_container_ptr);
}
}
/* ------------------------------------------------------------------------- */
/** Creates a new margin element, and returns the dlnode. */
bs_dllist_node_t *create_margin(wlmtk_box_t *box_ptr)
{
wlmtk_rectangle_t *rect_ptr = wlmtk_rectangle_create(
box_ptr->env_ptr, 0, 0, box_ptr->style.color);
BS_ASSERT(NULL != rect_ptr);
wlmtk_container_add_element_atop(
&box_ptr->margin_container,
NULL,
wlmtk_rectangle_element(rect_ptr));
wlmtk_element_set_visible(
wlmtk_rectangle_element(rect_ptr), true);
return wlmtk_dlnode_from_element(wlmtk_rectangle_element(rect_ptr));
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
static void test_layout_horizontal(bs_test_t *test_ptr);
static void test_layout_vertical(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_box_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 1, "layout_horizontal", test_layout_horizontal },
{ 1, "layout_vertical", test_layout_vertical },
{ 0, NULL, NULL }
};
/** Style used for tests. */
static const wlmtk_margin_style_t test_style = {
.width = 2,
.color = 0xff000000
};
/* ------------------------------------------------------------------------- */
/** Exercises setup and teardown. */
void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_box_t box;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_box_init(
&box, NULL, WLMTK_BOX_HORIZONTAL, &test_style));
BS_TEST_VERIFY_EQ(
test_ptr,
&box.super_container.super_element,
wlmtk_box_element(&box));
wlmtk_box_fini(&box);
}
/* ------------------------------------------------------------------------- */
/** Tests layouting horizontally */
void test_layout_horizontal(bs_test_t *test_ptr)
{
wlmtk_box_t box;
wlmtk_box_init(&box, NULL, WLMTK_BOX_HORIZONTAL, &test_style);
wlmtk_fake_element_t *e1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&e1_ptr->element, true);
e1_ptr->dimensions.width = 10;
e1_ptr->dimensions.height = 1;
wlmtk_fake_element_t *e2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&e2_ptr->element, false);
e2_ptr->dimensions.width = 20;
e1_ptr->dimensions.height = 2;
wlmtk_fake_element_t *e3_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&e3_ptr->element, true);
e3_ptr->dimensions.width = 40;
e3_ptr->dimensions.height = 4;
// Note: Elements are added "in front" == left.
wlmtk_box_add_element_front(&box, &e1_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 0, bs_dllist_size(&box.margin_container.elements));
wlmtk_box_add_element_front(&box, &e2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 0, bs_dllist_size(&box.margin_container.elements));
wlmtk_box_add_element_front(&box, &e3_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 1, bs_dllist_size(&box.margin_container.elements));
// Layout: e3 | e1 (e2 is invisible).
BS_TEST_VERIFY_EQ(test_ptr, 42, e1_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e1_ptr->element.y);
BS_TEST_VERIFY_EQ(test_ptr, 0, e2_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e2_ptr->element.y);
BS_TEST_VERIFY_EQ(test_ptr, 0, e3_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e3_ptr->element.y);
// Make e2 visible, now we should have: e3 | e2 | e1.
wlmtk_element_set_visible(&e2_ptr->element, true);
BS_TEST_VERIFY_EQ(test_ptr, 64, e1_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 42, e2_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e3_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 2, bs_dllist_size(&box.margin_container.elements));
wlmtk_element_set_visible(&e1_ptr->element, false);
BS_TEST_VERIFY_EQ(test_ptr, 1, bs_dllist_size(&box.margin_container.elements));
wlmtk_element_set_visible(&e1_ptr->element, true);
// Remove elements. Must update each.
wlmtk_box_remove_element(&box, &e3_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 22, e1_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e2_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 1, bs_dllist_size(&box.margin_container.elements));
wlmtk_box_remove_element(&box, &e2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 0, e1_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, bs_dllist_size(&box.margin_container.elements));
wlmtk_box_remove_element(&box, &e1_ptr->element);
wlmtk_element_destroy(&e3_ptr->element);
wlmtk_element_destroy(&e2_ptr->element);
wlmtk_element_destroy(&e1_ptr->element);
wlmtk_box_fini(&box);
}
/* ------------------------------------------------------------------------- */
/** Tests layouting vertically */
void test_layout_vertical(bs_test_t *test_ptr)
{
wlmtk_box_t box;
wlmtk_box_init(&box, NULL, WLMTK_BOX_VERTICAL, &test_style);
wlmtk_fake_element_t *e1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&e1_ptr->element, true);
e1_ptr->dimensions.width = 100;
e1_ptr->dimensions.height = 10;
wlmtk_fake_element_t *e2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&e2_ptr->element, true);
e2_ptr->dimensions.width = 200;
e2_ptr->dimensions.height = 20;
// Note: Elements are added "in front" == left.
wlmtk_box_add_element_front(&box, &e1_ptr->element);
wlmtk_box_add_element_front(&box, &e2_ptr->element);
// Layout: e2 | e1.
BS_TEST_VERIFY_EQ(test_ptr, 0, e1_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 22, e1_ptr->element.y);
BS_TEST_VERIFY_EQ(test_ptr, 0, e2_ptr->element.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, e2_ptr->element.y);
// Remove elements. Must update each.
wlmtk_box_remove_element(&box, &e2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, 0, e1_ptr->element.y);
wlmtk_box_remove_element(&box, &e1_ptr->element);
wlmtk_element_destroy(&e2_ptr->element);
wlmtk_element_destroy(&e1_ptr->element);
wlmtk_box_fini(&box);
}
/* == End of box.c ========================================================= */
wlmaker-0.3/src/toolkit/box.h 0000664 0000000 0000000 00000006266 14641446446 0016262 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file box.h
*
* @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.
*/
#ifndef __WLMTK_BOX_H__
#define __WLMTK_BOX_H__
/** Forward declaration: Box. */
typedef struct _wlmtk_box_t wlmtk_box_t;
#include "container.h"
#include "style.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Orientation of the box. */
typedef enum {
/** Horizontal box layout. The container's "front" is on the left. */
WLMTK_BOX_HORIZONTAL,
/** Vertical box layout. The container's "front" is the top. */
WLMTK_BOX_VERTICAL,
} wlmtk_box_orientation_t;
/** State of the box. */
struct _wlmtk_box_t {
/** Super class of the box. */
wlmtk_container_t super_container;
/** Virtual method table of the superclass' container. */
wlmtk_container_vmt_t orig_super_container_vmt;
/** Orientation of the box. */
wlmtk_box_orientation_t orientation;
/** Environment. */
wlmtk_env_t *env_ptr;
/** Container for the box's elements. */
wlmtk_container_t element_container;
/** Container for margin elements. */
wlmtk_container_t margin_container;
/** Margin style. */
wlmtk_margin_style_t style;
};
/**
* Initializes the box with the provided virtual method table.
*
* @param box_ptr
* @param orientation
* @param env_ptr
* @param style_ptr
*
* @return true on success.
*/
bool wlmtk_box_init(
wlmtk_box_t *box_ptr,
wlmtk_env_t *env_ptr,
wlmtk_box_orientation_t orientation,
const wlmtk_margin_style_t *style_ptr);
/**
* Un-initializes the box.
*
* @param box_ptr
*/
void wlmtk_box_fini(wlmtk_box_t *box_ptr);
/**
* Adds `element_ptr` to the front of the box.
*
* @param box_ptr
* @param element_ptr
*/
void wlmtk_box_add_element_front(wlmtk_box_t *box_ptr, wlmtk_element_t *element_ptr);
/**
* Adds `element_ptr` to the back of the box.
*
* @param box_ptr
* @param element_ptr
*/
void wlmtk_box_add_element_back(wlmtk_box_t *box_ptr, wlmtk_element_t *element_ptr);
/**
* Removes `element_ptr` from the box.
*
* Requires that element_ptr is an element of the box.
*
* @param box_ptr
* @param element_ptr
*/
void wlmtk_box_remove_element(wlmtk_box_t *box_ptr, wlmtk_element_t *element_ptr);
/** @return Pointer to the superclass' @ref wlmtk_element_t of `box_ptr`. */
wlmtk_element_t *wlmtk_box_element(wlmtk_box_t *box_ptr);
/** Unit tests. */
extern const bs_test_case_t wlmtk_box_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_BOX_H__ */
/* == End of box.h ========================================================= */
wlmaker-0.3/src/toolkit/buffer.c 0000664 0000000 0000000 00000014656 14641446446 0016740 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file buffer.c
*
* @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.
*/
#include "buffer.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static struct wlr_scene_node *element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
static void element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static void handle_wlr_scene_buffer_node_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** Method table for the buffer's virtual methods. */
static const wlmtk_element_vmt_t buffer_element_vmt = {
.create_scene_node = element_create_scene_node,
.get_dimensions = element_get_dimensions,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_buffer_init(wlmtk_buffer_t *buffer_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != buffer_ptr);
memset(buffer_ptr, 0, sizeof(wlmtk_buffer_t));
if (!wlmtk_element_init(&buffer_ptr->super_element, env_ptr)) {
return false;
}
buffer_ptr->orig_super_element_vmt = wlmtk_element_extend(
&buffer_ptr->super_element, &buffer_element_vmt);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_buffer_fini(wlmtk_buffer_t *buffer_ptr)
{
if (NULL != buffer_ptr->wlr_buffer_ptr) {
wlr_buffer_unlock(buffer_ptr->wlr_buffer_ptr);
buffer_ptr->wlr_buffer_ptr = NULL;
}
if (NULL != buffer_ptr->wlr_scene_buffer_ptr) {
wlr_scene_node_destroy(&buffer_ptr->wlr_scene_buffer_ptr->node);
buffer_ptr->wlr_scene_buffer_ptr = NULL;
}
wlmtk_element_fini(&buffer_ptr->super_element);
}
/* ------------------------------------------------------------------------- */
void wlmtk_buffer_set(
wlmtk_buffer_t *buffer_ptr,
struct wlr_buffer *wlr_buffer_ptr)
{
if (wlr_buffer_ptr == buffer_ptr->wlr_buffer_ptr) return;
if (NULL != buffer_ptr->wlr_buffer_ptr) {
wlr_buffer_unlock(buffer_ptr->wlr_buffer_ptr);
}
if (NULL != wlr_buffer_ptr) {
buffer_ptr->wlr_buffer_ptr = wlr_buffer_lock(wlr_buffer_ptr);
} else {
buffer_ptr->wlr_buffer_ptr = NULL;
}
if (NULL != buffer_ptr->wlr_scene_buffer_ptr) {
wlr_scene_buffer_set_buffer(
buffer_ptr->wlr_scene_buffer_ptr,
buffer_ptr->wlr_buffer_ptr);
}
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_buffer_element(wlmtk_buffer_t *buffer_ptr)
{
return &buffer_ptr->super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Implementation of the superclass wlmtk_element_t::create_scene_node method.
*
* Creates a `struct wlr_scene_buffer` attached to `wlr_scene_tree_ptr`.
*
* @param element_ptr
* @param wlr_scene_tree_ptr
*/
struct wlr_scene_node *element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
wlmtk_buffer_t *buffer_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_buffer_t, super_element);
BS_ASSERT(NULL == buffer_ptr->wlr_scene_buffer_ptr);
buffer_ptr->wlr_scene_buffer_ptr = wlr_scene_buffer_create(
wlr_scene_tree_ptr,
buffer_ptr->wlr_buffer_ptr);
BS_ASSERT(NULL != buffer_ptr->wlr_scene_buffer_ptr);
wlmtk_util_connect_listener_signal(
&buffer_ptr->wlr_scene_buffer_ptr->node.events.destroy,
&buffer_ptr->wlr_scene_buffer_node_destroy_listener,
handle_wlr_scene_buffer_node_destroy);
return &buffer_ptr->wlr_scene_buffer_ptr->node;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's get_dimensions method: Return dimensions.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
void element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_buffer_t *buffer_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_buffer_t, super_element);
if (NULL != left_ptr) *left_ptr = 0;
if (NULL != top_ptr) *top_ptr = 0;
if (NULL == buffer_ptr->wlr_buffer_ptr) {
if (NULL != right_ptr) *right_ptr = 0;
if (NULL != bottom_ptr) *bottom_ptr = 0;
return;
}
if (NULL != right_ptr) *right_ptr = buffer_ptr->wlr_buffer_ptr->width;
if (NULL != bottom_ptr) *bottom_ptr = buffer_ptr->wlr_buffer_ptr->height;
}
/* ------------------------------------------------------------------------- */
/**
* Handles the 'destroy' callback of wlr_scene_buffer_ptr->node.
*
* Will reset the wlr_scene_buffer_ptr value. Destruction of the node had
* been triggered (hence the callback).
*
* @param listener_ptr
* @param data_ptr
*/
void handle_wlr_scene_buffer_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_buffer_t *buffer_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_buffer_t, wlr_scene_buffer_node_destroy_listener);
buffer_ptr->wlr_scene_buffer_ptr = NULL;
wl_list_remove(&buffer_ptr->wlr_scene_buffer_node_destroy_listener.link);
}
/* == End of buffer.c ====================================================== */
wlmaker-0.3/src/toolkit/buffer.h 0000664 0000000 0000000 00000005231 14641446446 0016732 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file buffer.h
*
* @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.
*/
#ifndef __WLMTK_BUFFER_H__
#define __WLMTK_BUFFER_H__
#include
/** Forward declaration: Buffer state. */
typedef struct _wlmtk_buffer_t wlmtk_buffer_t;
#include "element.h"
/** Forward declaration. */
struct wlr_buffer;
/** Forward declaration. */
struct wlr_scene_buffer;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** State of a texture-backed buffer. */
struct _wlmtk_buffer_t {
/** Super class of the buffer: An element. */
wlmtk_element_t super_element;
/** Virtual method table of the super element before extending it. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** WLR buffer holding the contents. */
struct wlr_buffer *wlr_buffer_ptr;
/** Scene graph API node. Only set after calling `create_scene_node`. */
struct wlr_scene_buffer *wlr_scene_buffer_ptr;
/** Listener for the `destroy` signal of `wlr_scene_buffer_ptr->node`. */
struct wl_listener wlr_scene_buffer_node_destroy_listener;
};
/**
* Initializes the buffer.
*
* @param buffer_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_buffer_init(wlmtk_buffer_t *buffer_ptr,
wlmtk_env_t *env_ptr);
/**
* Cleans up the buffer.
*
* @param buffer_ptr
*/
void wlmtk_buffer_fini(wlmtk_buffer_t *buffer_ptr);
/**
* Sets (or updates) buffer contents.
*
* @param buffer_ptr
* @param wlr_buffer_ptr A WLR buffer to use for the update. That buffer
* will get locked by @ref wlmtk_buffer_t for the
* duration of it's use.
*/
void wlmtk_buffer_set(
wlmtk_buffer_t *buffer_ptr,
struct wlr_buffer *wlr_buffer_ptr);
/** @return the superclass' @ref wlmtk_element_t of `buffer_ptr`. */
wlmtk_element_t *wlmtk_buffer_element(wlmtk_buffer_t *buffer_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_BUFFER_H__ */
/* == End of buffer.h ====================================================== */
wlmaker-0.3/src/toolkit/button.c 0000664 0000000 0000000 00000032514 14641446446 0016773 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file button.c
*
* @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.
*/
#include "button.h"
#include "gfxbuf.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static void _wlmtk_button_clicked(wlmtk_button_t *button_ptr);
static bool _wlmtk_button_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void _wlmtk_button_element_pointer_enter(
wlmtk_element_t *element_ptr);
static void _wlmtk_button_element_pointer_leave(
wlmtk_element_t *element_ptr);
static void apply_state(wlmtk_button_t *button_ptr);
/* == Data ================================================================= */
/** Virtual method table for the button's element super class. */
static const wlmtk_element_vmt_t button_element_vmt = {
.pointer_button = _wlmtk_button_element_pointer_button,
.pointer_enter = _wlmtk_button_element_pointer_enter,
.pointer_leave = _wlmtk_button_element_pointer_leave,
};
/** Virtual method table for the button. */
static const wlmtk_button_vmt_t button_vmt = {
.clicked = _wlmtk_button_clicked,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_button_init(
wlmtk_button_t *button_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != button_ptr);
memset(button_ptr, 0, sizeof(wlmtk_button_t));
button_ptr->vmt = button_vmt;
if (!wlmtk_buffer_init(&button_ptr->super_buffer, env_ptr)) {
wlmtk_button_fini(button_ptr);
return false;
}
button_ptr->orig_super_element_vmt = wlmtk_element_extend(
&button_ptr->super_buffer.super_element,
&button_element_vmt);
return true;
}
/* ------------------------------------------------------------------------- */
wlmtk_button_vmt_t wlmtk_button_extend(
wlmtk_button_t *button_ptr,
const wlmtk_button_vmt_t *button_vmt_ptr)
{
wlmtk_button_vmt_t orig_vmt = button_ptr->vmt;
if (NULL != button_vmt_ptr->clicked) {
button_ptr->vmt.clicked = button_vmt_ptr->clicked;
}
return orig_vmt;
}
/* ------------------------------------------------------------------------- */
void wlmtk_button_fini(wlmtk_button_t *button_ptr)
{
if (NULL != button_ptr->pressed_wlr_buffer_ptr) {
wlr_buffer_unlock(button_ptr->pressed_wlr_buffer_ptr);
button_ptr->pressed_wlr_buffer_ptr = NULL;
}
if (NULL != button_ptr->released_wlr_buffer_ptr) {
wlr_buffer_unlock(button_ptr->released_wlr_buffer_ptr);
button_ptr->released_wlr_buffer_ptr = NULL;
}
wlmtk_buffer_fini(&button_ptr->super_buffer);
}
/* ------------------------------------------------------------------------- */
void wlmtk_button_set(
wlmtk_button_t *button_ptr,
struct wlr_buffer *released_wlr_buffer_ptr,
struct wlr_buffer *pressed_wlr_buffer_ptr )
{
if (NULL == released_wlr_buffer_ptr) {
BS_ASSERT(NULL == pressed_wlr_buffer_ptr);
} else {
BS_ASSERT(released_wlr_buffer_ptr->width ==
pressed_wlr_buffer_ptr->width);
BS_ASSERT(released_wlr_buffer_ptr->height ==
pressed_wlr_buffer_ptr->height);
}
if (NULL != button_ptr->released_wlr_buffer_ptr) {
wlr_buffer_unlock(button_ptr->released_wlr_buffer_ptr);
}
button_ptr->released_wlr_buffer_ptr = wlr_buffer_lock(
released_wlr_buffer_ptr);
if (NULL != button_ptr->pressed_wlr_buffer_ptr) {
wlr_buffer_unlock(button_ptr->pressed_wlr_buffer_ptr);
}
button_ptr->pressed_wlr_buffer_ptr = wlr_buffer_lock(
pressed_wlr_buffer_ptr);
apply_state(button_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Default implementation of @ref wlmtk_button_vmt_t::clicked. Nothing. */
void _wlmtk_button_clicked(__UNUSED__ wlmtk_button_t *button_ptr)
{
// Nothing.
}
/* ------------------------------------------------------------------------- */
/** See @ref wlmtk_element_vmt_t::pointer_button. */
bool _wlmtk_button_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_button_t *button_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_button_t, super_buffer.super_element);
if (button_event_ptr->button != BTN_LEFT) return false;
switch (button_event_ptr->type) {
case WLMTK_BUTTON_DOWN:
button_ptr->pressed = true;
apply_state(button_ptr);
break;
case WLMTK_BUTTON_UP:
button_ptr->pressed = false;
apply_state(button_ptr);
break;
case WLMTK_BUTTON_CLICK:
button_ptr->vmt.clicked(button_ptr);
break;
default:
break;
}
return true;
}
/* ------------------------------------------------------------------------- */
/** Pointer enters the area: We may need to update visualization. */
void _wlmtk_button_element_pointer_enter(
wlmtk_element_t *element_ptr)
{
wlmtk_button_t *button_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_button_t, super_buffer.super_element);
button_ptr->orig_super_element_vmt.pointer_enter(element_ptr);
apply_state(button_ptr);
}
/* ------------------------------------------------------------------------- */
/** Pointer leaves the area: We may need to update visualization. */
void _wlmtk_button_element_pointer_leave(
wlmtk_element_t *element_ptr)
{
wlmtk_button_t *button_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_button_t, super_buffer.super_element);
button_ptr->orig_super_element_vmt.pointer_leave(element_ptr);
apply_state(button_ptr);
}
/* ------------------------------------------------------------------------- */
/** Sets the appropriate texture for the button. */
void apply_state(wlmtk_button_t *button_ptr)
{
if (button_ptr->super_buffer.super_element.pointer_inside &&
button_ptr->pressed) {
wlmtk_buffer_set(
&button_ptr->super_buffer,
button_ptr->pressed_wlr_buffer_ptr);
} else {
wlmtk_buffer_set(
&button_ptr->super_buffer,
button_ptr->released_wlr_buffer_ptr);
}
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_press_release(bs_test_t *test_ptr);
static void test_press_release_outside(bs_test_t *test_ptr);
static void test_press_right(bs_test_t *test_ptr);
/** Test case definition. */
const bs_test_case_t wlmtk_button_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "press_release", test_press_release },
{ 1, "press_release_outside", test_press_release_outside },
{ 1, "press_right", test_press_right },
{ 0, NULL, NULL }
};
/** Test outcome: Whether 'clicked' was called. */
static bool fake_button_got_clicked = false;
/** Fake 'clicked' handler. */
static void fake_button_clicked(__UNUSED__ wlmtk_button_t *button_ptr) {
fake_button_got_clicked = true;
}
/** Virtual method table of fake button. */
static const wlmtk_button_vmt_t fake_button_vmt = {
.clicked = fake_button_clicked,
};
/* ------------------------------------------------------------------------- */
/** Exercises @ref wlmtk_button_init and @ref wlmtk_button_fini. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_button_t button;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_button_init(&button, NULL));
wlmtk_button_fini(&button);
}
/* ------------------------------------------------------------------------- */
/** Tests button pressing & releasing. */
void test_press_release(bs_test_t *test_ptr)
{
wlmtk_button_t button;
BS_ASSERT(wlmtk_button_init(&button, NULL));
wlmtk_button_extend(&button, &fake_button_vmt);
struct wlr_buffer *p_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
struct wlr_buffer *r_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
wlmtk_button_set(&button, r_ptr, p_ptr);
wlmtk_button_event_t event = { .button = BTN_LEFT, .time_msec = 42 };
wlmtk_element_t *element_ptr = &button.super_buffer.super_element;
fake_button_got_clicked = false;
// Initial state: released.
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 0, 0, 41));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
// Button down: pressed.
event.type = WLMTK_BUTTON_DOWN;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, p_ptr);
// Pointer leaves the area: released.
wlmtk_element_pointer_motion(element_ptr, NAN, NAN, 41);
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
// Pointer re-enters the area: pressed.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 0, 0, 41));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, p_ptr);
// Button up: released.
event.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
event.type = WLMTK_BUTTON_CLICK;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, fake_button_got_clicked);
wlr_buffer_drop(r_ptr);
wlr_buffer_drop(p_ptr);
wlmtk_button_fini(&button);
}
/* ------------------------------------------------------------------------- */
/** Tests button when releasing outside the pointer focus. */
void test_press_release_outside(bs_test_t *test_ptr)
{
wlmtk_button_t button;
BS_ASSERT(wlmtk_button_init(&button, NULL));
struct wlr_buffer *p_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
struct wlr_buffer *r_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
wlmtk_button_set(&button, r_ptr, p_ptr);
wlmtk_button_event_t event = { .button = BTN_LEFT, .time_msec = 42 };
wlmtk_element_t *element_ptr = &button.super_buffer.super_element;
// Enter the ara. Released.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 0, 0, 41));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
// Button down: pressed.
event.type = WLMTK_BUTTON_DOWN;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, p_ptr);
// Pointer leaves the area: released.
wlmtk_element_pointer_motion(element_ptr, NAN, NAN, 41);
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
// Button up, outside the area. Then, re-enter: Still released.
event.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 0, 0, 41));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
wlr_buffer_drop(r_ptr);
wlr_buffer_drop(p_ptr);
wlmtk_button_fini(&button);
}
/* ------------------------------------------------------------------------- */
/** Tests button when releasing outside the pointer focus. */
void test_press_right(bs_test_t *test_ptr)
{
wlmtk_button_t button;
BS_ASSERT(wlmtk_button_init(&button, NULL));
struct wlr_buffer *p_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
struct wlr_buffer *r_ptr = bs_gfxbuf_create_wlr_buffer(1, 1);
wlmtk_button_set(&button, r_ptr, p_ptr);
wlmtk_button_event_t event = {
.button = BTN_RIGHT, .type = WLMTK_BUTTON_DOWN, .time_msec = 42,
};
wlmtk_element_t *element_ptr = &button.super_buffer.super_element;
// Enter the ara. Released.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 0, 0, 41));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
// Right button down: Not claimed, and remains released.
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &event));
BS_TEST_VERIFY_EQ(test_ptr, button.super_buffer.wlr_buffer_ptr, r_ptr);
wlr_buffer_drop(r_ptr);
wlr_buffer_drop(p_ptr);
wlmtk_button_fini(&button);
}
/* == End of button.c ====================================================== */
wlmaker-0.3/src/toolkit/button.h 0000664 0000000 0000000 00000005575 14641446446 0017007 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file button.h
*
* @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.
*/
#ifndef __WLMTK_BUTTON_H__
#define __WLMTK_BUTTON_H__
#include "buffer.h"
#include "element.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: State of a button. */
typedef struct _wlmtk_button_t wlmtk_button_t;
/** Virtual method table of the button. */
typedef struct {
/** Optional: Called when the button has been clicked. */
void (*clicked)(wlmtk_button_t *button_ptr);
} wlmtk_button_vmt_t;
/** State of a button. */
struct _wlmtk_button_t {
/** Super class of the button: A buffer. */
wlmtk_buffer_t super_buffer;
/** Original virtual method table of the superclass element. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** The virtual method table. */
wlmtk_button_vmt_t vmt;
/** WLR buffer holding the button in released state. */
struct wlr_buffer *released_wlr_buffer_ptr;
/** WLR buffer holding the button in pressed state. */
struct wlr_buffer *pressed_wlr_buffer_ptr;
/** Whether the button is currently pressed. */
bool pressed;
};
/**
* Initializes the button.
*
* @param button_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_button_init(wlmtk_button_t *button_ptr,
wlmtk_env_t *env_ptr);
/**
* Extends the button's virtual methods.
*
* @param button_ptr
* @param button_vmt_ptr
*
* @return The original virtual method table.
*/
wlmtk_button_vmt_t wlmtk_button_extend(
wlmtk_button_t *button_ptr,
const wlmtk_button_vmt_t *button_vmt_ptr);
/**
* Cleans up the button.
*
* @param button_ptr
*/
void wlmtk_button_fini(wlmtk_button_t *button_ptr);
/**
* Sets (or updates) the button textures.
*
* @param button_ptr
* @param released_wlr_buffer_ptr
* @param pressed_wlr_buffer_ptr
*/
void wlmtk_button_set(
wlmtk_button_t *button_ptr,
struct wlr_buffer *released_wlr_buffer_ptr,
struct wlr_buffer *pressed_wlr_buffer_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_button_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_BUTTON_H__ */
/* == End of button.h ====================================================== */
wlmaker-0.3/src/toolkit/container.c 0000664 0000000 0000000 00000173713 14641446446 0017451 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file container.c
*
* @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.
*/
#include "container.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static struct wlr_scene_node *_wlmtk_container_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
static void _wlmtk_container_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static void _wlmtk_container_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static bool _wlmtk_container_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
static bool _wlmtk_container_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static bool _wlmtk_container_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static void _wlmtk_container_element_pointer_enter(
wlmtk_element_t *element_ptr);
static bool _wlmtk_container_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
static void handle_wlr_scene_tree_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr);
static bool update_pointer_focus_at(
wlmtk_container_t *container_ptr,
double x,
double y,
uint32_t time_msec);
static void _wlmtk_container_update_layout(wlmtk_container_t *container_ptr);
/** Virtual method table for the container's super class: Element. */
static const wlmtk_element_vmt_t container_element_vmt = {
.create_scene_node = _wlmtk_container_element_create_scene_node,
.get_dimensions = _wlmtk_container_element_get_dimensions,
.get_pointer_area = _wlmtk_container_element_get_pointer_area,
.pointer_motion = _wlmtk_container_element_pointer_motion,
.pointer_button = _wlmtk_container_element_pointer_button,
.pointer_axis = _wlmtk_container_element_pointer_axis,
.pointer_enter = _wlmtk_container_element_pointer_enter,
.keyboard_event = _wlmtk_container_element_keyboard_event,
};
/** Default virtual method table. Initializes non-abstract methods. */
static const wlmtk_container_vmt_t container_vmt = {
.update_layout = _wlmtk_container_update_layout,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_container_init(
wlmtk_container_t *container_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != container_ptr);
memset(container_ptr, 0, sizeof(wlmtk_container_t));
container_ptr->vmt = container_vmt;
if (!wlmtk_element_init(&container_ptr->super_element, env_ptr)) {
return false;
}
container_ptr->orig_super_element_vmt = wlmtk_element_extend(
&container_ptr->super_element, &container_element_vmt);
return true;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_container_init_attached(
wlmtk_container_t *container_ptr,
wlmtk_env_t *env_ptr,
struct wlr_scene_tree *root_wlr_scene_tree_ptr)
{
if (!wlmtk_container_init(container_ptr, env_ptr)) return false;
container_ptr->super_element.wlr_scene_node_ptr =
_wlmtk_container_element_create_scene_node(
&container_ptr->super_element, root_wlr_scene_tree_ptr);
if (NULL == container_ptr->super_element.wlr_scene_node_ptr) {
wlmtk_container_fini(container_ptr);
return false;
}
BS_ASSERT(NULL != container_ptr->super_element.wlr_scene_node_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
wlmtk_container_vmt_t wlmtk_container_extend(
wlmtk_container_t *container_ptr,
const wlmtk_container_vmt_t *container_vmt_ptr)
{
wlmtk_container_vmt_t orig_vmt = container_ptr->vmt;
if (NULL != container_vmt_ptr->update_layout) {
container_ptr->vmt.update_layout = container_vmt_ptr->update_layout;
}
return orig_vmt;
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_fini(wlmtk_container_t *container_ptr)
{
bs_dllist_node_t *dlnode_ptr;
while (NULL != (dlnode_ptr = container_ptr->elements.head_ptr)) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
wlmtk_container_remove_element(container_ptr, element_ptr);
BS_ASSERT(container_ptr->elements.head_ptr != dlnode_ptr);
wlmtk_element_destroy(element_ptr);
}
// For containers created with wlmtk_container_init_attached(): We also
// need to remove references to the WLR scene tree.
if (NULL != container_ptr->wlr_scene_tree_ptr) {
BS_ASSERT(NULL == container_ptr->super_element.parent_container_ptr);
wlr_scene_node_destroy(&container_ptr->wlr_scene_tree_ptr->node);
container_ptr->wlr_scene_tree_ptr = NULL;
container_ptr->super_element.wlr_scene_node_ptr = NULL;
}
wlmtk_element_fini(&container_ptr->super_element);
memset(container_ptr, 0, sizeof(wlmtk_container_t));
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_add_element(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr)
{
BS_ASSERT(NULL == element_ptr->parent_container_ptr);
BS_ASSERT(NULL == element_ptr->wlr_scene_node_ptr);
bs_dllist_push_front(
&container_ptr->elements,
wlmtk_dlnode_from_element(element_ptr));
wlmtk_element_set_parent_container(element_ptr, container_ptr);
wlmtk_container_update_layout(container_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_add_element_atop(
wlmtk_container_t *container_ptr,
wlmtk_element_t *reference_element_ptr,
wlmtk_element_t *element_ptr)
{
BS_ASSERT(NULL == element_ptr->parent_container_ptr);
BS_ASSERT(NULL == element_ptr->wlr_scene_node_ptr);
BS_ASSERT(
NULL == reference_element_ptr ||
container_ptr == reference_element_ptr->parent_container_ptr);
if (NULL == reference_element_ptr) {
bs_dllist_push_back(
&container_ptr->elements,
wlmtk_dlnode_from_element(element_ptr));
} else {
bs_dllist_insert_node_before(
&container_ptr->elements,
wlmtk_dlnode_from_element(reference_element_ptr),
wlmtk_dlnode_from_element(element_ptr));
}
wlmtk_element_set_parent_container(element_ptr, container_ptr);
if (NULL != element_ptr->wlr_scene_node_ptr) {
if (NULL == reference_element_ptr) {
wlr_scene_node_lower_to_bottom(element_ptr->wlr_scene_node_ptr);
} else {
BS_ASSERT(NULL != reference_element_ptr->wlr_scene_node_ptr);
wlr_scene_node_place_above(
element_ptr->wlr_scene_node_ptr,
reference_element_ptr->wlr_scene_node_ptr);
}
}
wlmtk_container_update_layout(container_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_remove_element(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr)
{
BS_ASSERT(element_ptr->parent_container_ptr == container_ptr);
wlmtk_element_set_parent_container(element_ptr, NULL);
bs_dllist_remove(
&container_ptr->elements,
wlmtk_dlnode_from_element(element_ptr));
if (container_ptr->left_button_element_ptr == element_ptr) {
container_ptr->left_button_element_ptr = NULL;
}
if (container_ptr->keyboard_focus_element_ptr == element_ptr) {
wlmtk_container_update_keyboard_focus(container_ptr, NULL);
}
wlmtk_container_update_layout(container_ptr);
wlmtk_container_update_pointer_focus(container_ptr);
// TODO(kaeser@gube.ch): Test this -- when the container becomes empty, it
// seems to happen the focus isn't cleared.
if (bs_dllist_empty(&container_ptr->elements)) {
container_ptr->pointer_focus_element_ptr = NULL;
container_ptr->keyboard_focus_element_ptr = NULL;
}
BS_ASSERT(element_ptr != container_ptr->pointer_focus_element_ptr);
BS_ASSERT(element_ptr != container_ptr->keyboard_focus_element_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_raise_element_to_top(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr)
{
BS_ASSERT(element_ptr->parent_container_ptr == container_ptr);
// Already at the top? Nothing to do.
if (wlmtk_dlnode_from_element(element_ptr) ==
container_ptr->elements.head_ptr) return;
bs_dllist_remove(
&container_ptr->elements,
wlmtk_dlnode_from_element(element_ptr));
bs_dllist_push_front(
&container_ptr->elements,
wlmtk_dlnode_from_element(element_ptr));
if (NULL != element_ptr->wlr_scene_node_ptr) {
wlr_scene_node_raise_to_top(element_ptr->wlr_scene_node_ptr);
}
wlmtk_container_update_layout(container_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_update_pointer_focus(wlmtk_container_t *container_ptr)
{
if (NULL != container_ptr->super_element.parent_container_ptr) {
wlmtk_container_update_pointer_focus(
container_ptr->super_element.parent_container_ptr);
} else {
update_pointer_focus_at(
container_ptr,
container_ptr->super_element.last_pointer_x,
container_ptr->super_element.last_pointer_y,
container_ptr->super_element.last_pointer_time_msec);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_update_keyboard_focus(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr)
{
// TODO(kaeser@gubbech): Re-establish guard clause: Nothing to do.
// Disabled, because keyboard focus re-establishement is not all done
// well after screen lock. Needs a bigger revamp.
// if (container_ptr->keyboard_focus_element_ptr == element_ptr) return;
if (NULL != element_ptr) {
BS_ASSERT(element_ptr->parent_container_ptr == container_ptr);
}
container_ptr->keyboard_focus_element_ptr = element_ptr;
// Propagate to parent containers.
if (NULL != container_ptr->super_element.parent_container_ptr) {
wlmtk_element_t *parent_kbfocus_element_ptr =
(NULL == element_ptr) ? NULL : &container_ptr->super_element;
wlmtk_container_update_keyboard_focus(
container_ptr->super_element.parent_container_ptr,
parent_kbfocus_element_ptr);
}
}
/* ------------------------------------------------------------------------- */
struct wlr_scene_tree *wlmtk_container_wlr_scene_tree(
wlmtk_container_t *container_ptr)
{
return container_ptr->wlr_scene_tree_ptr;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Implementation of the superclass wlmtk_element_t::create_scene_node method.
*
* Creates the wlroots scene graph tree for the container, and will attach all
* already-contained elements to the scene graph, as well.
*
* @param element_ptr
* @param wlr_scene_tree_ptr
*
* @return Pointer to the scene graph API node.
*/
struct wlr_scene_node *_wlmtk_container_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
BS_ASSERT(NULL == container_ptr->wlr_scene_tree_ptr);
container_ptr->wlr_scene_tree_ptr = wlr_scene_tree_create(
wlr_scene_tree_ptr);
BS_ASSERT(NULL != container_ptr->wlr_scene_tree_ptr);
// Build the nodes from tail to head: Adding an element to the scene graph
// will always put it on top, so this adds the elements in desired order.
for (bs_dllist_node_t *dlnode_ptr = container_ptr->elements.tail_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->prev_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
BS_ASSERT(NULL == element_ptr->wlr_scene_node_ptr);
wlmtk_element_attach_to_scene_graph(element_ptr);
}
wlmtk_util_connect_listener_signal(
&container_ptr->wlr_scene_tree_ptr->node.events.destroy,
&container_ptr->wlr_scene_tree_node_destroy_listener,
handle_wlr_scene_tree_node_destroy);
return &container_ptr->wlr_scene_tree_ptr->node;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's get_dimensions method: Return dimensions.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
void _wlmtk_container_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
int left = INT32_MAX, top = INT32_MAX;
int right = INT32_MIN, bottom = INT32_MIN;
for (bs_dllist_node_t *dlnode_ptr = container_ptr->elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
if (!element_ptr->visible) continue;
int x_pos, y_pos;
wlmtk_element_get_position(element_ptr, &x_pos, &y_pos);
int x1, y1, x2, y2;
wlmtk_element_get_dimensions(element_ptr, &x1, &y1, &x2, &y2);
left = BS_MIN(left, x_pos + x1);
top = BS_MIN(top, y_pos + y1);
right = BS_MAX(right, x_pos + x2);
bottom = BS_MAX(bottom, y_pos + y2);
}
if (left >= right) { left = 0; right = 0; }
if (top >= bottom) { top = 0; bottom = 0; }
if (NULL != left_ptr) *left_ptr = left;
if (NULL != top_ptr) *top_ptr = top;
if (NULL != right_ptr) *right_ptr = right;
if (NULL != bottom_ptr) *bottom_ptr = bottom;
}
/* ------------------------------------------------------------------------- */
/**
* Returns the minimal rectangle covering all element's pointer areas.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
void _wlmtk_container_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
int left = INT32_MAX, top = INT32_MAX;
int right = INT32_MIN, bottom = INT32_MIN;
for (bs_dllist_node_t *dlnode_ptr = container_ptr->elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
if (!element_ptr->visible) continue;
int x_pos, y_pos;
wlmtk_element_get_position(element_ptr, &x_pos, &y_pos);
int x1, y1, x2, y2;
wlmtk_element_get_pointer_area(element_ptr, &x1, &y1, &x2, &y2);
left = BS_MIN(left, x_pos + x1);
top = BS_MIN(top, y_pos + y1);
right = BS_MAX(right, x_pos + x2);
bottom = BS_MAX(bottom, y_pos + y2);
}
if (left >= right) { left = 0; right = 0; }
if (top >= bottom) { top = 0; bottom = 0; }
if (NULL != left_ptr) *left_ptr = left;
if (NULL != top_ptr) *top_ptr = top;
if (NULL != right_ptr) *right_ptr = right;
if (NULL != bottom_ptr) *bottom_ptr = bottom;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's motion method: Handle pointer moves.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*
* @return Whether this container has an element that accepts the emotion.
*/
bool _wlmtk_container_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
container_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
return update_pointer_focus_at(container_ptr, x, y, time_msec);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's pointer_button() method. Forwards it to the
* element currently having pointer focus.
*
* @param element_ptr
* @param button_event_ptr
*
* @return true if the button was handled.
*/
bool _wlmtk_container_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
bool accepted = false;
// TODO: Generalize this for non-LEFT buttons.
if (BTN_LEFT == button_event_ptr->button) {
switch (button_event_ptr->type) {
case WLMTK_BUTTON_DOWN:
// Forward to the pointer focus element, if any. If it
// was accepted: remember the element.
if (NULL != container_ptr->pointer_focus_element_ptr) {
accepted = wlmtk_element_pointer_button(
container_ptr->pointer_focus_element_ptr,
button_event_ptr);
if (accepted) {
container_ptr->left_button_element_ptr =
container_ptr->pointer_focus_element_ptr;
} else {
container_ptr->left_button_element_ptr = NULL;
}
}
break;
case WLMTK_BUTTON_UP:
// Forward to the element that received the DOWN, if any.
if (NULL != container_ptr->left_button_element_ptr) {
accepted = wlmtk_element_pointer_button(
container_ptr->left_button_element_ptr,
button_event_ptr);
}
break;
case WLMTK_BUTTON_CLICK:
case WLMTK_BUTTON_DOUBLE_CLICK:
// Will only be forwarded, if the element still (or again)
// has pointer focus.
if (NULL != container_ptr->left_button_element_ptr &&
container_ptr->left_button_element_ptr ==
container_ptr->pointer_focus_element_ptr) {
accepted = wlmtk_element_pointer_button(
container_ptr->left_button_element_ptr,
button_event_ptr);
}
break;
default: // Uh, don't know about this...
bs_log(BS_FATAL, "Unhandled button type %d",
button_event_ptr->type);
}
return accepted;
}
if (NULL == container_ptr->pointer_focus_element_ptr) return false;
return wlmtk_element_pointer_button(
container_ptr->pointer_focus_element_ptr,
button_event_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's axis method: Handles axis events, by
* forwarding it to the element having pointer focus.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return true if the axis event was handled.
*/
bool _wlmtk_container_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
if (NULL == container_ptr->pointer_focus_element_ptr) return false;
return wlmtk_element_pointer_axis(
container_ptr->pointer_focus_element_ptr,
wlr_pointer_axis_event_ptr);
}
/* ------------------------------------------------------------------------- */
/** Handler for when the pointer enters the area. Nothing for container. */
void _wlmtk_container_element_pointer_enter(
__UNUSED__ wlmtk_element_t *element_ptr)
{
// Nothing. Do not call parent.
}
/* ------------------------------------------------------------------------- */
/** Handler for keyboard events: Pass to keyboard-focussed element, if any. */
bool _wlmtk_container_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_container_t, super_element);
// Guard clause: No focus here, return right away.
if (NULL == container_ptr->keyboard_focus_element_ptr) return false;
return wlmtk_element_keyboard_event(
container_ptr->keyboard_focus_element_ptr,
wlr_keyboard_key_event_ptr,
key_syms,
key_syms_count,
modifiers);
}
/* ------------------------------------------------------------------------- */
/**
* Handles the 'destroy' callback of wlr_scene_tree_ptr->node.
*
* Will also detach (but not destroy) each of the still-contained elements.
*
* @param listener_ptr
* @param data_ptr
*/
void handle_wlr_scene_tree_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_container_t *container_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_container_t, wlr_scene_tree_node_destroy_listener);
container_ptr->wlr_scene_tree_ptr = NULL;
for (bs_dllist_node_t *dlnode_ptr = container_ptr->elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
// Will read the parent container's wlr_scene_tree_ptr == NULL.
wlmtk_element_attach_to_scene_graph(element_ptr);
}
// Since this is a callback from the tree node dtor, the tree is going to
// be destroyed. We are using this to reset the container's reference.
wl_list_remove(&container_ptr->wlr_scene_tree_node_destroy_listener.link);
}
/* ------------------------------------------------------------------------- */
/**
* Updates pointer focus of container for position (x, y).
*
* Updates wlmtk_container_t::pointer_focus_element_ptr.
*
* @param container_ptr
* @param x
* @param y
* @param time_msec
*
* @return Whether there was an element acception the motion at (x, y).
*/
bool update_pointer_focus_at(
wlmtk_container_t *container_ptr,
double x,
double y,
uint32_t time_msec)
{
for (bs_dllist_node_t *dlnode_ptr = container_ptr->elements.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
if (!element_ptr->visible) continue;
int x_pos, y_pos;
wlmtk_element_get_position(element_ptr, &x_pos, &y_pos);
int x1, y1, x2, y2;
wlmtk_element_get_pointer_area(element_ptr, &x1, &y1, &x2, &y2);
if (x_pos + x1 <= x && x < x_pos + x2 &&
y_pos + y1 <= y && y < y_pos + y2) {
if (!wlmtk_element_pointer_motion(
element_ptr, x - x_pos, y - y_pos, time_msec)) {
continue;
}
// There is a focus change. Invalidate coordinates in old element.
if (container_ptr->pointer_focus_element_ptr != element_ptr &&
NULL != container_ptr->pointer_focus_element_ptr) {
wlmtk_element_pointer_motion(
container_ptr->pointer_focus_element_ptr,
NAN, NAN, time_msec);
}
container_ptr->pointer_focus_element_ptr = element_ptr;
return true;
}
}
// Getting here implies we didn't have an element catching the motion,
// so it must have happened outside our araea. We also should reset
// pointer focus element now.
if (NULL != container_ptr->pointer_focus_element_ptr) {
wlmtk_element_pointer_motion(
container_ptr->pointer_focus_element_ptr,
NAN, NAN, time_msec);
container_ptr->pointer_focus_element_ptr = NULL;
}
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Base implementation of wlmtk_container_vmt_t::update_layout. If there's
* a parent, will call @ref wlmtk_container_update_layout. Otherwise, will
* update the pointer focus.
*
* @param container_ptr
*/
void _wlmtk_container_update_layout(wlmtk_container_t *container_ptr)
{
if (NULL != container_ptr->super_element.parent_container_ptr) {
wlmtk_container_update_layout(
container_ptr->super_element.parent_container_ptr);
} else {
wlmtk_container_update_pointer_focus(container_ptr);
}
}
/* == Helper for unit tests: A fake container with a tree, as parent ======= */
/** State of the "fake" parent container. Refers to a scene graph. */
typedef struct {
/** The actual container */
wlmtk_container_t container;
/** A scene graph. Not attached to any output, */
struct wlr_scene *wlr_scene_ptr;
} fake_parent_container_t;
/* ------------------------------------------------------------------------- */
wlmtk_container_t *wlmtk_container_create_fake_parent(void)
{
fake_parent_container_t *fake_parent_container_ptr = logged_calloc(
1, sizeof(fake_parent_container_t));
if (NULL == fake_parent_container_ptr) return NULL;
fake_parent_container_ptr->wlr_scene_ptr = wlr_scene_create();
if (NULL == fake_parent_container_ptr->wlr_scene_ptr) {
wlmtk_container_destroy_fake_parent(
&fake_parent_container_ptr->container);
return NULL;
}
if (!wlmtk_container_init_attached(
&fake_parent_container_ptr->container,
NULL,
&fake_parent_container_ptr->wlr_scene_ptr->tree)) {
wlmtk_container_destroy_fake_parent(
&fake_parent_container_ptr->container);
return NULL;
}
return &fake_parent_container_ptr->container;
}
/* ------------------------------------------------------------------------- */
void wlmtk_container_destroy_fake_parent(wlmtk_container_t *container_ptr)
{
fake_parent_container_t *fake_parent_container_ptr = BS_CONTAINER_OF(
container_ptr, fake_parent_container_t, container);
wlmtk_container_fini(&fake_parent_container_ptr->container);
if (NULL != fake_parent_container_ptr->wlr_scene_ptr) {
// Note: There is no "wlr_scene_destroy()" method; as of 2023-09-02,
// this is just a flat allocated struct.
free(fake_parent_container_ptr->wlr_scene_ptr);
fake_parent_container_ptr->wlr_scene_ptr = NULL;
}
free(fake_parent_container_ptr);
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
static void test_add_remove(bs_test_t *test_ptr);
static void test_add_remove_with_scene_graph(bs_test_t *test_ptr);
static void test_add_with_raise(bs_test_t *test_ptr);
static void test_pointer_motion(bs_test_t *test_ptr);
static void test_pointer_focus(bs_test_t *test_ptr);
static void test_pointer_focus_move(bs_test_t *test_ptr);
static void test_pointer_focus_layered(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_event(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_container_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 1, "add_remove", test_add_remove },
{ 1, "add_remove_with_scene_graph", test_add_remove_with_scene_graph },
{ 1, "add_with_raise", test_add_with_raise },
{ 1, "pointer_motion", test_pointer_motion },
{ 1, "pointer_focus", test_pointer_focus },
{ 1, "pointer_focus_move", test_pointer_focus_move },
{ 1, "pointer_focus_layered", test_pointer_focus_layered },
{ 1, "pointer_button", test_pointer_button },
{ 1, "pointer_axis", test_pointer_axis },
{ 1, "keyboard_event", test_keyboard_event },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises init() and fini() methods, verifies dtor forwarding. */
void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_container_init(&container, NULL));
// Also expect the super element to be initialized.
BS_TEST_VERIFY_NEQ(
test_ptr, NULL, container.super_element.vmt.pointer_motion);
wlmtk_container_fini(&container);
// Also expect the super element to be un-initialized.
BS_TEST_VERIFY_EQ(
test_ptr, NULL, container.super_element.vmt.pointer_motion);
}
/* ------------------------------------------------------------------------- */
/** Exercises adding and removing elements, verifies destruction on fini. */
void test_add_remove(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_container_init(&container, NULL));
wlmtk_fake_element_t *elem1_ptr, *elem2_ptr, *elem3_ptr;
elem1_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != elem1_ptr);
elem2_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != elem2_ptr);
elem3_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != elem3_ptr);
// Build sequence: 3 -> 2 -> 1.
wlmtk_container_add_element(&container, &elem1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr, &container, elem1_ptr->element.parent_container_ptr);
wlmtk_container_add_element(&container, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr, &container, elem2_ptr->element.parent_container_ptr);
wlmtk_container_add_element(&container, &elem3_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr, &container, elem3_ptr->element.parent_container_ptr);
// Remove 2, then add at the bottom: 3 -> 1 -> 2.
wlmtk_container_remove_element(&container, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, elem2_ptr->element.parent_container_ptr);
wlmtk_container_add_element_atop(&container, NULL, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, &container, elem2_ptr->element.parent_container_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_element(&elem1_ptr->element)->next_ptr,
wlmtk_dlnode_from_element(&elem2_ptr->element));
// Remove elem3 and add atop elem2: 1 -> 3 -> 2.
wlmtk_container_remove_element(&container, &elem3_ptr->element);
wlmtk_container_add_element_atop(
&container, &elem2_ptr->element, &elem3_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_element(&elem3_ptr->element)->next_ptr,
wlmtk_dlnode_from_element(&elem2_ptr->element));
wlmtk_container_remove_element(&container, &elem2_ptr->element);
wlmtk_element_destroy(&elem2_ptr->element);
// Will destroy contained elements.
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that elements are attached, resp. detached from scene graph. */
void test_add_remove_with_scene_graph(bs_test_t *test_ptr)
{
wlmtk_container_t *fake_parent_ptr = wlmtk_container_create_fake_parent();
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fake_parent_ptr);
wlmtk_container_t container;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_container_init(&container, NULL));
wlmtk_fake_element_t *fe3_ptr = wlmtk_fake_element_create();
wlmtk_container_add_element(&container, &fe3_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe3_ptr->element.wlr_scene_node_ptr);
wlmtk_fake_element_t *fe2_ptr = wlmtk_fake_element_create();
wlmtk_container_add_element(&container, &fe2_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe2_ptr->element.wlr_scene_node_ptr);
wlmtk_element_set_parent_container(
&container.super_element, fake_parent_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fe3_ptr->element.wlr_scene_node_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fe2_ptr->element.wlr_scene_node_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
container.elements.head_ptr, &fe2_ptr->element.dlnode);
BS_TEST_VERIFY_EQ(
test_ptr,
container.elements.tail_ptr, &fe3_ptr->element.dlnode);
// The top is at parent->children.prev (see wlr_scene_node_raise_to_top).
// Seems counter-intuitive, since wayhland-util.h denotes `prev` to refer
// to the last element in the list.
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev,
&fe3_ptr->element.wlr_scene_node_ptr->link);
// Want to have the node.
BS_TEST_VERIFY_NEQ(
test_ptr, NULL, container.super_element.wlr_scene_node_ptr);
// Fresh element: No scene graph node yet.
wlmtk_fake_element_t *fe0_ptr = wlmtk_fake_element_create();
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe0_ptr->element.wlr_scene_node_ptr);
// Add to container with attached graph: Element now has a graph node.
wlmtk_container_add_element(&container, &fe0_ptr->element);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fe0_ptr->element.wlr_scene_node_ptr);
// Now fe0 has to be on top, followed by fe2 and fe3.
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev,
&fe0_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev->prev,
&fe3_ptr->element.wlr_scene_node_ptr->link);
// One more element, but we add this atop of fe2.
wlmtk_fake_element_t *fe1_ptr = wlmtk_fake_element_create();
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe1_ptr->element.wlr_scene_node_ptr);
wlmtk_container_add_element_atop(
&container, &fe2_ptr->element, &fe1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev,
&fe0_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev,
&fe1_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev->prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
container.wlr_scene_tree_ptr->children.prev->prev->prev->prev,
&fe3_ptr->element.wlr_scene_node_ptr->link);
// Remove: The element's graph node must be destroyed & cleared..
wlmtk_container_remove_element(&container, &fe0_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe0_ptr->element.wlr_scene_node_ptr);
wlmtk_element_destroy(&fe0_ptr->element);
wlmtk_element_set_parent_container(&container.super_element, NULL);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe3_ptr->element.wlr_scene_node_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fe2_ptr->element.wlr_scene_node_ptr);
wlmtk_container_remove_element(&container, &fe3_ptr->element);
wlmtk_element_destroy(&fe3_ptr->element);
wlmtk_container_remove_element(&container, &fe2_ptr->element);
wlmtk_element_destroy(&fe2_ptr->element);
wlmtk_container_fini(&container);
wlmtk_container_destroy_fake_parent(fake_parent_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests that elements inserted at position are also placed in scene graph. */
void test_add_with_raise(bs_test_t *test_ptr)
{
wlmtk_container_t *c_ptr = wlmtk_container_create_fake_parent();
BS_TEST_VERIFY_NEQ(test_ptr, NULL, c_ptr);
// fe1 added. Sole element, is the top.
wlmtk_fake_element_t *fe1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&fe1_ptr->element, true);
wlmtk_container_add_element(c_ptr, &fe1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev,
&fe1_ptr->element.wlr_scene_node_ptr->link);
wlmtk_element_pointer_motion(&c_ptr->super_element, 0, 0, 7);
BS_TEST_VERIFY_TRUE(test_ptr, fe1_ptr->pointer_motion_called);
fe1_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_EQ(
test_ptr, &fe1_ptr->element, c_ptr->pointer_focus_element_ptr);
// fe2 placed atop 'NULL', goes to back.
wlmtk_fake_element_t *fe2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&fe2_ptr->element, true);
wlmtk_container_add_element_atop(c_ptr, NULL, &fe2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev->prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
// Raise fe2.
wlmtk_container_raise_element_to_top(c_ptr, &fe2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev->prev,
&fe1_ptr->element.wlr_scene_node_ptr->link);
// Must also update pointer focus.
BS_TEST_VERIFY_EQ(
test_ptr, &fe2_ptr->element, c_ptr->pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, fe2_ptr->pointer_motion_called);
fe2_ptr->pointer_motion_called = false;
// Now remove fe1 and add on top of fe2. Ensure scene graph has fe1 on top
// and pointer focus is on it, too.
wlmtk_container_remove_element(c_ptr, &fe1_ptr->element);
wlmtk_container_add_element_atop(c_ptr, &fe2_ptr->element, &fe1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev,
&fe1_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr,
c_ptr->wlr_scene_tree_ptr->children.prev->prev,
&fe2_ptr->element.wlr_scene_node_ptr->link);
BS_TEST_VERIFY_EQ(
test_ptr, &fe1_ptr->element, c_ptr->pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, fe1_ptr->pointer_motion_called);
wlmtk_container_remove_element(c_ptr, &fe2_ptr->element);
wlmtk_element_destroy(&fe2_ptr->element);
wlmtk_container_remove_element(c_ptr, &fe1_ptr->element);
wlmtk_element_destroy(&fe1_ptr->element);
wlmtk_container_destroy_fake_parent(c_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests the 'motion' method for container. */
void test_pointer_motion(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
wlmtk_element_set_visible(&container.super_element, true);
// Note: pointer area extends by (-1, -2, 3, 4) on each fake element.
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_position(&elem1_ptr->element, -20, -40);
elem1_ptr->dimensions.width = 10;
elem1_ptr->dimensions.height = 5;
wlmtk_element_set_visible(&elem1_ptr->element, false);
wlmtk_container_add_element(&container, &elem1_ptr->element);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_position(&elem2_ptr->element, 100, 200);
elem2_ptr->dimensions.width = 10;
elem2_ptr->dimensions.height = 5;
wlmtk_element_set_visible(&elem2_ptr->element, true);
wlmtk_container_add_element(&container, &elem2_ptr->element);
// Verify 'dimensions' and 'pointer_area', derived from children.
int l, t, r, b;
wlmtk_element_get_dimensions(&container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, 100, l);
BS_TEST_VERIFY_EQ(test_ptr, 200, t);
BS_TEST_VERIFY_EQ(test_ptr, 110, r);
BS_TEST_VERIFY_EQ(test_ptr, 205, b);
wlmtk_element_set_visible(&elem1_ptr->element, true);
wlmtk_element_get_dimensions(&container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, -20, l);
BS_TEST_VERIFY_EQ(test_ptr, -40, t);
BS_TEST_VERIFY_EQ(test_ptr, 110, r);
BS_TEST_VERIFY_EQ(test_ptr, 205, b);
wlmtk_element_set_visible(&elem1_ptr->element, false);
wlmtk_element_get_pointer_area(&container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, 99, l);
BS_TEST_VERIFY_EQ(test_ptr, 198, t);
BS_TEST_VERIFY_EQ(test_ptr, 113, r);
BS_TEST_VERIFY_EQ(test_ptr, 209, b);
wlmtk_element_set_visible(&elem1_ptr->element, true);
wlmtk_element_get_pointer_area(&container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, -21, l);
BS_TEST_VERIFY_EQ(test_ptr, -42, t);
BS_TEST_VERIFY_EQ(test_ptr, 113, r);
BS_TEST_VERIFY_EQ(test_ptr, 209, b);
// Same must hold for the parent container.
wlmtk_container_t parent_container;
BS_ASSERT(wlmtk_container_init(&parent_container, NULL));
wlmtk_container_add_element(&parent_container,
&container.super_element);
wlmtk_element_get_dimensions(
&parent_container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, -20, l);
BS_TEST_VERIFY_EQ(test_ptr, -40, t);
BS_TEST_VERIFY_EQ(test_ptr, 110, r);
BS_TEST_VERIFY_EQ(test_ptr, 205, b);
wlmtk_element_get_pointer_area(
&parent_container.super_element, &l, &t, &r, &b);
BS_TEST_VERIFY_EQ(test_ptr, -21, l);
BS_TEST_VERIFY_EQ(test_ptr, -42, t);
BS_TEST_VERIFY_EQ(test_ptr, 113, r);
BS_TEST_VERIFY_EQ(test_ptr, 209, b);
// There's nothing at (0, 0).
wlmtk_element_pointer_motion(&container.super_element, 0, 0, 7);
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_motion_called);
BS_TEST_VERIFY_FALSE(test_ptr, elem2_ptr->pointer_motion_called);
wlmtk_element_pointer_motion(&parent_container.super_element, 0, 0, 7);
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_motion_called);
BS_TEST_VERIFY_FALSE(test_ptr, elem2_ptr->pointer_motion_called);
// elem1 is at (-20, -40).
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, -20, -40, 7));
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_enter_called);
elem1_ptr->pointer_enter_called = false;
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_motion_called);
elem1_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_FALSE(test_ptr, elem2_ptr->pointer_motion_called);
BS_TEST_VERIFY_EQ(test_ptr, 0, elem1_ptr->element.last_pointer_x);
BS_TEST_VERIFY_EQ(test_ptr, 0, elem1_ptr->element.last_pointer_y);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(
&parent_container.super_element, -20, -40, 7));
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_enter_called);
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_motion_called);
elem1_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_FALSE(test_ptr, elem2_ptr->pointer_motion_called);
BS_TEST_VERIFY_EQ(test_ptr, 0, elem1_ptr->element.last_pointer_x);
BS_TEST_VERIFY_EQ(test_ptr, 0, elem1_ptr->element.last_pointer_y);
// elem2 is covering the area at (107, 302).
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(
&parent_container.super_element, 107, 203, 7));
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_motion_called);
BS_TEST_VERIFY_TRUE(test_ptr, isnan(elem1_ptr->element.last_pointer_x));
elem1_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_leave_called);
elem1_ptr->pointer_leave_called = false;
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_enter_called);
elem2_ptr->pointer_enter_called = false;
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_motion_called);
elem2_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_EQ(test_ptr, 7, elem2_ptr->element.last_pointer_x);
BS_TEST_VERIFY_EQ(test_ptr, 3, elem2_ptr->element.last_pointer_y);
// The pointer area of elem2 is covering the area at (112, 208).
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(
&parent_container.super_element, 112, 208, 7));
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_leave_called);
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_motion_called);
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_motion_called);
elem2_ptr->pointer_motion_called = false;
BS_TEST_VERIFY_EQ(test_ptr, 12, elem2_ptr->element.last_pointer_x);
BS_TEST_VERIFY_EQ(test_ptr, 8, elem2_ptr->element.last_pointer_y);
// The pointer area of elem2 does not include (113, 209).
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_motion(
&parent_container.super_element, 113, 209, 7));
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_motion_called);
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_motion_called);
BS_TEST_VERIFY_TRUE(test_ptr, isnan(elem2_ptr->element.last_pointer_x));
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_leave_called);
elem2_ptr->pointer_leave_called = false;
// All set. clean it up.
wlmtk_container_remove_element(&container, &elem1_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
wlmtk_container_remove_element(&container, &elem2_ptr->element);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_container_remove_element(&parent_container,
&container.super_element);
wlmtk_container_fini(&parent_container);
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that pointer focus is updated when elements are updated. */
void test_pointer_focus(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem1_ptr->element, true);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem2_ptr->element, true);
// Case 1: An empty container, will not have a pointer-focussed element.
BS_TEST_VERIFY_EQ(test_ptr, NULL, container.pointer_focus_element_ptr);
// Case 2: Adding a visible element at (0, 0): Focus remains NULL, since
// motion() was not called yet and we don't have known pointer position.
wlmtk_container_add_element(&container, &elem1_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, container.pointer_focus_element_ptr);
wlmtk_container_remove_element(&container, &elem1_ptr->element);
// Case 3: Call motion() first, then add a visible element at (0, 0). Focus
// should switch there.
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, 0, 0, 7));
wlmtk_container_add_element(&container, &elem1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container.pointer_focus_element_ptr);
// Case 4: Add another visible element. Focus changes, since on top.
wlmtk_container_add_element(&container, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem2_ptr->element,
container.pointer_focus_element_ptr);
// Case 5: Elem2 (added last = on top) becomes invisible. Focus changes.
wlmtk_element_set_visible(&elem2_ptr->element, false);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container.pointer_focus_element_ptr);
// Case 6: Elem1 becomes invisible. Focus changes to NULL.
wlmtk_element_set_visible(&elem1_ptr->element, false);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container.pointer_focus_element_ptr);
// Case 7: Elem1 becomes visible. Focus changes to elem1 again.
wlmtk_element_set_visible(&elem1_ptr->element, true);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container.pointer_focus_element_ptr);
// Case 8: Remove Elem1. Focus changes to NULL.
wlmtk_container_remove_element(&container, &elem1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container.pointer_focus_element_ptr);
// Case 9: Elem2 becomes visible, focus changes there.
wlmtk_element_set_visible(&elem2_ptr->element, true);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem2_ptr->element,
container.pointer_focus_element_ptr);
// Case 10: Elem2 is removed. Focus is now NULL, and leave() is called for
// the element that was removed.
elem2_ptr->pointer_leave_called = false;
wlmtk_container_remove_element(&container, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container.pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
elem2_ptr->pointer_leave_called);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that pointer focus is updated when elements are moved. */
void test_pointer_focus_move(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
// Setup to span an area where the container catches pointer coordinates.
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem1_ptr->element, true);
wlmtk_element_set_position(&elem1_ptr->element, -20, 0);
wlmtk_container_add_element(&container, &elem1_ptr->element);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem2_ptr->element, true);
wlmtk_element_set_position(&elem2_ptr->element, 20, 0);
wlmtk_container_add_element(&container, &elem2_ptr->element);
// Need the container to pick up the cursor position.
wlmtk_element_pointer_motion(&container.super_element, 0, 0, 7);
// Is off the cursor, will get focus.
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container.pointer_focus_element_ptr);
// Now moves below the cursor, will get focus.
wlmtk_element_set_position(&elem1_ptr->element, 0, 0);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container.pointer_focus_element_ptr);
wlmtk_container_remove_element(&container, &elem2_ptr->element);
wlmtk_container_remove_element(&container, &elem1_ptr->element);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that pointer focus is updated across layers of containers. */
void test_pointer_focus_layered(bs_test_t *test_ptr)
{
wlmtk_container_t container1;
BS_ASSERT(wlmtk_container_init(&container1, NULL));
wlmtk_container_t container2;
BS_ASSERT(wlmtk_container_init(&container2, NULL));
wlmtk_element_set_visible(&container2.super_element, true);
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem1_ptr->element, true);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem2_ptr->element, true);
// Prepare: Motion was called, will not have any focus.
wlmtk_element_pointer_motion(&container1.super_element, 0, 0, 7);
BS_TEST_VERIFY_EQ(test_ptr, NULL, container1.pointer_focus_element_ptr);
// Case 1: Add element 2 to second container, then add this container.
// this must re-trigger focus and pass it to elem2.
wlmtk_container_add_element(&container2, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container1.pointer_focus_element_ptr);
wlmtk_container_add_element(&container1, &container2.super_element);
BS_TEST_VERIFY_EQ(
test_ptr,
&container2.super_element,
container1.pointer_focus_element_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem2_ptr->element, container2.pointer_focus_element_ptr);
// Case 2: Add elem1 to container1. Must change focus there, and call
// leave for container2 and elem2.
elem2_ptr->pointer_leave_called = false;
wlmtk_container_add_element(&container1, &elem1_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container1.pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_leave_called);
// Case 3: Bring container2 to top. Now elem2 has focus.
elem1_ptr->pointer_leave_called = false;
wlmtk_container_remove_element(&container1, &container2.super_element);
wlmtk_container_add_element(&container1, &container2.super_element);
BS_TEST_VERIFY_EQ(
test_ptr,
&container2.super_element,
container1.pointer_focus_element_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem2_ptr->element,
container2.pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_leave_called);
// Case 4: Remove elem2, drop focus back to elem1.
elem2_ptr->pointer_leave_called = false;
wlmtk_container_remove_element(&container2, &elem2_ptr->element);
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container1.pointer_focus_element_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_leave_called);
wlmtk_container_remove_element(&container1, &elem1_ptr->element);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
wlmtk_container_remove_element(&container1, &container2.super_element);
wlmtk_container_fini(&container2);
wlmtk_container_fini(&container1);
}
/* ------------------------------------------------------------------------- */
/** Tests that pointer DOWN is forwarded to element with pointer focus. */
void test_pointer_button(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem1_ptr->element, true);
elem1_ptr->dimensions.width = 1;
elem1_ptr->dimensions.height = 1;
wlmtk_container_add_element(&container, &elem1_ptr->element);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_position(&elem2_ptr->element, 10, 10);
wlmtk_element_set_visible(&elem2_ptr->element, true);
wlmtk_container_add_element_atop(&container, NULL, &elem2_ptr->element);
wlmtk_button_event_t button = {
.button = BTN_LEFT, .type = WLMTK_BUTTON_DOWN
};
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
// DOWN events go to the focussed element.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, 0, 0, 7));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_EQ(
test_ptr,
&elem1_ptr->element,
container.left_button_element_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr, elem1_ptr->pointer_button_called);
// Moves, pointer focus is now on elem2.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, 10, 10, 7));
BS_TEST_VERIFY_EQ(
test_ptr,
&elem2_ptr->element,
container.pointer_focus_element_ptr);
// The UP event is still received by elem1.
elem1_ptr->pointer_button_called = false;
button.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_TRUE(
test_ptr, elem1_ptr->pointer_button_called);
// Click will be ignored
button.type = WLMTK_BUTTON_CLICK;
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
// New DOWN event goes to elem2, though.
elem2_ptr->pointer_button_called = false;
button.type = WLMTK_BUTTON_DOWN;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_TRUE(
test_ptr, elem2_ptr->pointer_button_called);
// And UP event now goes to elem2.
elem2_ptr->pointer_button_called = false;
button.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_TRUE(
test_ptr, elem2_ptr->pointer_button_called);
// Here, CLICK goes to elem2.
elem2_ptr->pointer_button_called = false;
button.type = WLMTK_BUTTON_CLICK;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_TRUE(
test_ptr, elem2_ptr->pointer_button_called);
// After removing, further UP events won't be accidentally sent there.
wlmtk_container_remove_element(&container, &elem1_ptr->element);
wlmtk_container_remove_element(&container, &elem2_ptr->element);
button.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_button(&container.super_element, &button));
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
container.left_button_element_ptr);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that axis events are forwarded to element with pointer focus. */
void test_pointer_axis(bs_test_t *test_ptr)
{
struct wlr_pointer_axis_event event = {};
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
wlmtk_fake_element_t *elem1_ptr = wlmtk_fake_element_create();
wlmtk_element_set_visible(&elem1_ptr->element, true);
elem1_ptr->dimensions.width = 1;
elem1_ptr->dimensions.height = 1;
wlmtk_container_add_element(&container, &elem1_ptr->element);
wlmtk_fake_element_t *elem2_ptr = wlmtk_fake_element_create();
wlmtk_element_set_position(&elem2_ptr->element, 10, 10);
wlmtk_element_set_visible(&elem2_ptr->element, true);
wlmtk_container_add_element_atop(&container, NULL, &elem2_ptr->element);
// Pointer on elem1, axis goes there.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, 0, 0, 7));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_axis(&container.super_element, &event));
BS_TEST_VERIFY_TRUE(test_ptr, elem1_ptr->pointer_axis_called);
elem1_ptr->pointer_axis_called = false;
BS_TEST_VERIFY_FALSE(test_ptr, elem2_ptr->pointer_axis_called);
// Pointer on elem2, axis goes there.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(&container.super_element, 10, 10, 7));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_axis(&container.super_element, &event));
BS_TEST_VERIFY_FALSE(test_ptr, elem1_ptr->pointer_axis_called);
BS_TEST_VERIFY_TRUE(test_ptr, elem2_ptr->pointer_axis_called);
wlmtk_container_remove_element(&container, &elem1_ptr->element);
wlmtk_container_remove_element(&container, &elem2_ptr->element);
wlmtk_element_destroy(&elem2_ptr->element);
wlmtk_element_destroy(&elem1_ptr->element);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_axis(&container.super_element, &event));
wlmtk_container_fini(&container);
}
/* ------------------------------------------------------------------------- */
/** Tests that keyboard event are forwarded to element with keyboard focus. */
void test_keyboard_event(bs_test_t *test_ptr)
{
wlmtk_container_t container;
BS_ASSERT(wlmtk_container_init(&container, NULL));
wlmtk_container_t parent;
BS_ASSERT(wlmtk_container_init(&parent, NULL));
wlmtk_container_add_element(&parent, &container.super_element);
struct wlr_keyboard_key_event event = {};
wlmtk_element_t *parent_elptr = &parent.super_element;
wlmtk_fake_element_t *fe_ptr = wlmtk_fake_element_create();
wlmtk_container_add_element(&container, &fe_ptr->element);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_keyboard_event(parent_elptr, &event, NULL, 0, 0));
BS_TEST_VERIFY_FALSE(test_ptr, fe_ptr->keyboard_event_called);
wlmtk_container_update_keyboard_focus(&container, &fe_ptr->element);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_keyboard_event(parent_elptr, &event, NULL, 0, 0));
BS_TEST_VERIFY_TRUE(test_ptr, fe_ptr->keyboard_event_called);
fe_ptr->keyboard_event_called = false;
wlmtk_container_update_keyboard_focus(&container, NULL);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_keyboard_event(parent_elptr, &event, NULL, 0, 0));
BS_TEST_VERIFY_FALSE(test_ptr, fe_ptr->keyboard_event_called);
wlmtk_container_remove_element(&container, &fe_ptr->element);
wlmtk_element_destroy(&fe_ptr->element);
wlmtk_container_remove_element(&parent, &container.super_element);
wlmtk_container_fini(&parent);
wlmtk_container_fini(&container);
}
/* == End of container.c =================================================== */
wlmaker-0.3/src/toolkit/container.h 0000664 0000000 0000000 00000015616 14641446446 0017453 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file container.h
*
* @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.
*/
#ifndef __WLMTK_CONTAINER_H__
#define __WLMTK_CONTAINER_H__
#include
#include
/** Forward declaration: Container. */
typedef struct _wlmtk_container_t wlmtk_container_t;
/** Forward declaration: Container virtual method table. */
typedef struct _wlmtk_container_vmt_t wlmtk_container_vmt_t;
#include "element.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Virtual method table of the container. */
struct _wlmtk_container_vmt_t {
/**
* Updates the layout of the container elements.
*
* Will be called by this, when an element is added or removed.
* Additionally, this should be invoked by contained elements when
* the visibility or dimensions change.
*
* Each container will propagate a
* @ref wlmtk_container_vmt_t::update_layout call
* upwards to it's parent container. The root container will then trigger
* an update to pointer focus (since by then, the layout is updated).
*/
void (*update_layout)(wlmtk_container_t *container_ptr);
};
/** State of the container. */
struct _wlmtk_container_t {
/** Super class of the container. */
wlmtk_element_t super_element;
/** Virtual method table of the super element before extending it. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Virtual method table for the container. */
wlmtk_container_vmt_t vmt;
/**
* Elements contained here.
*
* `head_ptr` is the topmost element, and `tail_ptr` the bottom-most one.
*/
bs_dllist_t elements;
/** Scene tree. */
struct wlr_scene_tree *wlr_scene_tree_ptr;
/** Listener for the `destroy` signal of `wlr_scene_tree_ptr->node`. */
struct wl_listener wlr_scene_tree_node_destroy_listener;
/** Stores the element with current pointer focus. May be NULL. */
wlmtk_element_t *pointer_focus_element_ptr;
/** Stores the element which received WLMTK_BUTTON_DOWN for BTN_LEFT. */
wlmtk_element_t *left_button_element_ptr;
/** Stores the element with current keyboard focus. May be NULL. */
wlmtk_element_t *keyboard_focus_element_ptr;
};
/**
* Initializes the container with the provided virtual method table.
*
* @param container_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_container_init(wlmtk_container_t *container_ptr,
wlmtk_env_t *env_ptr);
/**
* Extends the container's virtual methods.
*
* @param container_ptr
* @param container_vmt_ptr
*
* @return The previous virtual method table.
*/
wlmtk_container_vmt_t wlmtk_container_extend(
wlmtk_container_t *container_ptr,
const wlmtk_container_vmt_t *container_vmt_ptr);
/**
* Initializes the container, and attach to WLR sene graph.
*
* @param container_ptr
* @param env_ptr
* @param root_wlr_scene_tree_ptr
*
* @return true on success.
*/
bool wlmtk_container_init_attached(
wlmtk_container_t *container_ptr,
wlmtk_env_t *env_ptr,
struct wlr_scene_tree *root_wlr_scene_tree_ptr);
/**
* Un-initializes the container.
*
* Any element still in `elements` will be destroyed.
*
* @param container_ptr
*/
void wlmtk_container_fini(
wlmtk_container_t *container_ptr);
/**
* Adds `element_ptr` to the container.
*
* Requires that `element_ptr` is not added to a container yet. The element
* will be added at the top of the container.
*
* @param container_ptr
* @param element_ptr
*/
void wlmtk_container_add_element(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr);
/**
* Adds `element_ptr` to the container atop the reference's position.
*
* If reference_element_ptr is NULL, the element will be added at the back.
*
* @param container_ptr
* @param reference_element_ptr Must be an element of this container.
* @param element_ptr
*/
void wlmtk_container_add_element_atop(
wlmtk_container_t *container_ptr,
wlmtk_element_t *reference_element_ptr,
wlmtk_element_t *element_ptr);
/**
* Removes `element_ptr` from the container.
*
* Expects that `container_ptr` is `element_ptr`'s parent container.
*
* @param container_ptr
* @param element_ptr
*/
void wlmtk_container_remove_element(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr);
/**
* Places `element_ptr` at the top (head) of the container.
*
* Expects that `container_ptr` is `element_ptr`'s parent container.
*
* @param container_ptr
* @param element_ptr
*/
void wlmtk_container_raise_element_to_top(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr);
/**
* Updates pointer focus of the container.
*
* @param container_ptr
*/
void wlmtk_container_update_pointer_focus(wlmtk_container_t *container_ptr);
/**
* Updates the container's keyboard focus to be at `element_ptr`.
*
* @param container_ptr
* @param element_ptr The element that will get keyboard focus. Must
* be contained in @ref wlmtk_container_t::elements.
* A value of NULL clears the focus.
*/
void wlmtk_container_update_keyboard_focus(
wlmtk_container_t *container_ptr,
wlmtk_element_t *element_ptr);
/**
* Updates the layout of the container.
*
* @param container_ptr Container to update. NULL implies a no-op.
*/
static inline void wlmtk_container_update_layout(
wlmtk_container_t *container_ptr)
{
container_ptr->vmt.update_layout(container_ptr);
}
/**
* Returns the wlroots scene graph tree for this node.
*
* Private: Should be called only by wlmtk_element_t.
*
* @param container_ptr
*
* @return The scene tree, or NULL if not attached to a scene graph.
*/
struct wlr_scene_tree *wlmtk_container_wlr_scene_tree(
wlmtk_container_t *container_ptr);
/** Unit tests for the container. */
extern const bs_test_case_t wlmtk_container_test_cases[];
/** Constructor for a fake container with a scene tree. */
wlmtk_container_t *wlmtk_container_create_fake_parent(void);
/** Destructor for that fake container. */
void wlmtk_container_destroy_fake_parent(wlmtk_container_t *container_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_CONTAINER_H__ */
/* == End of container.h =================================================== */
wlmaker-0.3/src/toolkit/content.c 0000664 0000000 0000000 00000045645 14641446446 0017143 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file content.c
*
* @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.
*/
#include "content.h"
#include "surface.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static void _wlmtk_content_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
/* == Data ================================================================= */
/** Virtual method table for the content's superclass @ref wlmtk_element_t. */
static const wlmtk_element_vmt_t _wlmtk_content_element_vmt = {
.get_dimensions = _wlmtk_content_element_get_dimensions,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_content_init(
wlmtk_content_t *content_ptr,
wlmtk_surface_t *surface_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != content_ptr);
memset(content_ptr, 0, sizeof(wlmtk_content_t));
if (!wlmtk_container_init(&content_ptr->super_container, env_ptr)) {
return false;
}
content_ptr->orig_super_element_vmt = wlmtk_element_extend(
&content_ptr->super_container.super_element,
&_wlmtk_content_element_vmt);
if (NULL != surface_ptr) {
wlmtk_content_set_surface(content_ptr, surface_ptr);
}
if (!wlmtk_container_init(&content_ptr->popup_container, env_ptr)) {
wlmtk_content_fini(content_ptr);
return false;
}
wlmtk_container_add_element(
&content_ptr->super_container,
&content_ptr->popup_container.super_element);
wlmtk_element_set_visible(
&content_ptr->popup_container.super_element,
true);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_fini(
wlmtk_content_t *content_ptr)
{
bs_dllist_node_t *dlnode_ptr;
while (NULL != (dlnode_ptr = content_ptr->popups.head_ptr)) {
wlmtk_content_t *popup_content_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmtk_content_t, dlnode);
wlmtk_content_remove_popup(content_ptr, popup_content_ptr);
}
if (content_ptr->popup_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&content_ptr->super_container,
&content_ptr->popup_container.super_element);
}
wlmtk_container_fini(&content_ptr->popup_container);
if (NULL != content_ptr->surface_ptr) {
wlmtk_container_remove_element(
&content_ptr->super_container,
wlmtk_surface_element(content_ptr->surface_ptr));
content_ptr->surface_ptr = NULL;
}
memset(content_ptr, 0, sizeof(wlmtk_content_t));
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_set_surface(
wlmtk_content_t *content_ptr,
wlmtk_surface_t *surface_ptr)
{
if (NULL == surface_ptr && NULL == content_ptr->surface_ptr) return;
if (NULL != content_ptr->surface_ptr) {
wlmtk_element_set_visible(
wlmtk_surface_element(content_ptr->surface_ptr), false);
wlmtk_container_remove_element(
&content_ptr->super_container,
wlmtk_surface_element(content_ptr->surface_ptr));
content_ptr->surface_ptr = NULL;
}
if (NULL != surface_ptr) {
wlmtk_container_add_element(
&content_ptr->super_container,
wlmtk_surface_element(surface_ptr));
content_ptr->surface_ptr = surface_ptr;
wlmtk_element_set_visible(wlmtk_surface_element(surface_ptr), true);
}
}
/* ------------------------------------------------------------------------- */
wlmtk_content_vmt_t wlmtk_content_extend(
wlmtk_content_t *content_ptr,
const wlmtk_content_vmt_t *content_vmt_ptr)
{
wlmtk_content_vmt_t orig_vmt = content_ptr->vmt;
if (NULL != content_vmt_ptr->request_maximized) {
content_ptr->vmt.request_maximized =
content_vmt_ptr->request_maximized;
}
if (NULL != content_vmt_ptr->request_fullscreen) {
content_ptr->vmt.request_fullscreen =
content_vmt_ptr->request_fullscreen;
}
if (NULL != content_vmt_ptr->request_size) {
content_ptr->vmt.request_size =
content_vmt_ptr->request_size;
}
if (NULL != content_vmt_ptr->request_close) {
content_ptr->vmt.request_close =
content_vmt_ptr->request_close;
}
if (NULL != content_vmt_ptr->set_activated) {
content_ptr->vmt.set_activated =
content_vmt_ptr->set_activated;
}
return orig_vmt;
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_get_size(
wlmtk_content_t *content_ptr,
int *width_ptr,
int *height_ptr)
{
if (NULL != width_ptr) *width_ptr = content_ptr->committed_width;
if (NULL != height_ptr) *height_ptr = content_ptr->committed_height;
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_commit(
wlmtk_content_t *content_ptr,
int width,
int height,
uint32_t serial)
{
content_ptr->committed_width = width;
content_ptr->committed_height = height;
if (NULL != content_ptr->window_ptr) {
wlmtk_window_serial(content_ptr->window_ptr, serial);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_set_window(
wlmtk_content_t *content_ptr,
wlmtk_window_t *window_ptr)
{
content_ptr->window_ptr = window_ptr;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_content_element(wlmtk_content_t *content_ptr)
{
return &content_ptr->super_container.super_element;
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_add_popup(
wlmtk_content_t *content_ptr,
wlmtk_content_t *popup_content_ptr)
{
BS_ASSERT(wlmtk_content_element(popup_content_ptr)->parent_container_ptr ==
NULL);
BS_ASSERT(NULL == popup_content_ptr->parent_content_ptr);
wlmtk_container_add_element(
&content_ptr->super_container,
wlmtk_content_element(popup_content_ptr));
popup_content_ptr->parent_content_ptr = content_ptr;
bs_dllist_push_back(
&content_ptr->popups,
&popup_content_ptr->dlnode);
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_remove_popup(
wlmtk_content_t *content_ptr,
wlmtk_content_t *popup_content_ptr)
{
BS_ASSERT(wlmtk_content_element(popup_content_ptr)->parent_container_ptr ==
&content_ptr->super_container);
BS_ASSERT(content_ptr == popup_content_ptr->parent_content_ptr);
bs_dllist_remove(
&content_ptr->popups,
&popup_content_ptr->dlnode);
wlmtk_container_remove_element(
&content_ptr->super_container,
wlmtk_content_element(popup_content_ptr));
popup_content_ptr->parent_content_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_add_wlmtk_popup(
wlmtk_content_t *content_ptr,
wlmtk_popup_t *popup_ptr)
{
wlmtk_container_add_element(
&content_ptr->popup_container,
wlmtk_popup_element(popup_ptr));
}
/* ------------------------------------------------------------------------- */
void wlmtk_content_remove_wlmtk_popup(
wlmtk_content_t *content_ptr,
wlmtk_popup_t *popup_ptr)
{
wlmtk_container_remove_element(
&content_ptr->popup_container,
wlmtk_popup_element(popup_ptr));
}
/* ------------------------------------------------------------------------- */
wlmtk_content_t *wlmtk_content_get_parent_content(
wlmtk_content_t *content_ptr)
{
return content_ptr->parent_content_ptr;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Returns the content's dimension: Considers only the surface, and leaves
* out pop-ups, in order to draw margins and decorations for just the main
* surface.
*
* @param element_ptr
* @param left_ptr
* @param top_ptr
* @param right_ptr
* @param bottom_ptr
*/
void _wlmtk_content_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_content_t *content_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_content_t, super_container.super_element);
wlmtk_element_get_dimensions(
wlmtk_surface_element(content_ptr->surface_ptr),
left_ptr, top_ptr, right_ptr, bottom_ptr);
}
/* == Fake content, for tests ============================================== */
static void _wlmtk_fake_content_request_close(wlmtk_content_t *content_ptr);
static uint32_t _wlmtk_fake_content_request_size(
wlmtk_content_t *content_ptr,
int width,
int height);
static void _wlmtk_fake_content_set_activated(
wlmtk_content_t *content_ptr,
bool activated);
/** Virtual method table for the fake content. */
static wlmtk_content_vmt_t _wlmtk_fake_content_vmt = {
.request_size = _wlmtk_fake_content_request_size,
.request_close = _wlmtk_fake_content_request_close,
.set_activated = _wlmtk_fake_content_set_activated,
};
/* ------------------------------------------------------------------------- */
wlmtk_fake_content_t *wlmtk_fake_content_create(
wlmtk_fake_surface_t *fake_surface_ptr)
{
wlmtk_fake_content_t *fake_content_ptr = logged_calloc(
1, sizeof(wlmtk_fake_content_t));
if (NULL == fake_content_ptr) return NULL;
fake_content_ptr->fake_surface_ptr = fake_surface_ptr;
if (!wlmtk_content_init(&fake_content_ptr->content,
&fake_surface_ptr->surface,
NULL)) {
wlmtk_fake_content_destroy(fake_content_ptr);
return NULL;
}
wlmtk_content_extend(&fake_content_ptr->content, &_wlmtk_fake_content_vmt);
return fake_content_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_content_destroy(wlmtk_fake_content_t *fake_content_ptr)
{
wlmtk_content_fini(&fake_content_ptr->content);
free(fake_content_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_content_commit(wlmtk_fake_content_t *fake_content_ptr)
{
int w = fake_content_ptr->requested_width;
int h = fake_content_ptr->requested_height;
wlmtk_content_commit(
&fake_content_ptr->content, w, h, fake_content_ptr->serial);
wlmtk_fake_surface_commit_size(
fake_content_ptr->fake_surface_ptr, w, h);
}
/* ------------------------------------------------------------------------- */
/** Test implementation of @ref wlmtk_content_vmt_t::request_size. */
uint32_t _wlmtk_fake_content_request_size(
wlmtk_content_t *content_ptr,
int width,
int height)
{
wlmtk_fake_content_t *fake_content_ptr = BS_CONTAINER_OF(
content_ptr, wlmtk_fake_content_t, content);
fake_content_ptr->requested_width = width;
fake_content_ptr->requested_height = height;
return fake_content_ptr->serial;
}
/* ------------------------------------------------------------------------- */
/** Test implementation of @ref wlmtk_content_vmt_t::request_close. */
void _wlmtk_fake_content_request_close(wlmtk_content_t *content_ptr)
{
wlmtk_fake_content_t *fake_content_ptr = BS_CONTAINER_OF(
content_ptr, wlmtk_fake_content_t, content);
fake_content_ptr->request_close_called = true;
}
/* ------------------------------------------------------------------------- */
/** Test implementation of @ref wlmtk_content_vmt_t::set_activated. */
void _wlmtk_fake_content_set_activated(
wlmtk_content_t *content_ptr,
bool activated)
{
wlmtk_fake_content_t *fake_content_ptr = BS_CONTAINER_OF(
content_ptr, wlmtk_fake_content_t, content);
fake_content_ptr->activated = activated;
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
static void test_set_clear_surface(bs_test_t *test_ptr);
static void test_add_remove_popup(bs_test_t *test_ptr);
static void test_add_remove_wlmtk_popup(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_content_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 1, "set_clear_surface", test_set_clear_surface },
{ 1, "add_remove_popup", test_add_remove_popup },
{ 1, "add_remove_wlmtk_popup", test_add_remove_wlmtk_popup },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests setup and teardown. */
void test_init_fini(bs_test_t *test_ptr)
{
struct wlr_box box;
wlmtk_fake_surface_t *fs_ptr = wlmtk_fake_surface_create();
BS_ASSERT(NULL != fs_ptr);
wlmtk_fake_content_t *fake_content_ptr = wlmtk_fake_content_create(fs_ptr);
BS_ASSERT(NULL != fake_content_ptr);
wlmtk_element_t *element_ptr = wlmtk_content_element(
&fake_content_ptr->content);
// Initial size is zero.
box = wlmtk_element_get_dimensions_box(element_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.height);
// Pointer motion, should report to not be within the content.
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 10, 10, 0));
// Request & commit a sensible size, verifies the content reports it.
wlmtk_content_request_size(&fake_content_ptr->content, 200, 100);
wlmtk_fake_content_commit(fake_content_ptr);
box = wlmtk_element_get_dimensions_box(element_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
// Pointer motion shouuld now report to be within the content.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 10, 10, 0));
wlmtk_fake_content_destroy(fake_content_ptr);
wlmtk_fake_surface_destroy(fs_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests setting and clearing the surface. */
void test_set_clear_surface(bs_test_t *test_ptr)
{
wlmtk_fake_surface_t *fs_ptr = wlmtk_fake_surface_create();
BS_ASSERT(NULL != fs_ptr);
wlmtk_content_t content;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_content_init(&content, NULL, NULL));
BS_TEST_VERIFY_EQ(test_ptr, NULL, content.surface_ptr);
wlmtk_content_set_surface(&content, &fs_ptr->surface);
BS_TEST_VERIFY_EQ(test_ptr, &fs_ptr->surface, content.surface_ptr);
wlmtk_content_set_surface(&content, NULL);
BS_TEST_VERIFY_EQ(test_ptr, NULL, content.surface_ptr);
wlmtk_content_fini(&content);
wlmtk_fake_surface_destroy(fs_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests adding and removing popups. */
void test_add_remove_popup(bs_test_t *test_ptr)
{
wlmtk_content_t parent, popup;
wlmtk_fake_surface_t *fs0_ptr = wlmtk_fake_surface_create();
wlmtk_fake_surface_commit_size(fs0_ptr, 100, 10);
wlmtk_fake_surface_t *fs1_ptr = wlmtk_fake_surface_create();
wlmtk_fake_surface_commit_size(fs1_ptr, 200, 20);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_content_init(&parent, &fs0_ptr->surface, NULL));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_content_init(&popup, &fs1_ptr->surface, NULL));
wlmtk_element_set_visible(wlmtk_content_element(&parent), true);
wlmtk_element_set_visible(wlmtk_content_element(&popup), true);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_content_get_parent_content(&parent));
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_content_get_parent_content(&popup));
struct wlr_box box;
box = wlmtk_element_get_dimensions_box(wlmtk_content_element(&parent));
BS_TEST_VERIFY_EQ(test_ptr, 100, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.height);
wlmtk_content_add_popup(&parent, &popup);
BS_TEST_VERIFY_EQ(
test_ptr,
&parent,
wlmtk_content_get_parent_content(&popup));
box = wlmtk_element_get_dimensions_box(wlmtk_content_element(&parent));
BS_TEST_VERIFY_EQ(test_ptr, 100, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.height);
wlmtk_content_remove_popup(&parent, &popup);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_content_get_parent_content(&popup));
wlmtk_content_fini(&popup);
wlmtk_content_fini(&parent);
wlmtk_fake_surface_destroy(fs1_ptr);
wlmtk_fake_surface_destroy(fs0_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests adding and removing popups. */
void test_add_remove_wlmtk_popup(bs_test_t *test_ptr)
{
wlmtk_content_t content;
wlmtk_popup_t popup;
wlmtk_fake_surface_t *fs0_ptr = wlmtk_fake_surface_create();
wlmtk_fake_surface_commit_size(fs0_ptr, 100, 10);
wlmtk_fake_surface_t *fs1_ptr = wlmtk_fake_surface_create();
wlmtk_fake_surface_commit_size(fs1_ptr, 200, 20);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_content_init(&content, &fs0_ptr->surface, NULL));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_popup_init(&popup, NULL, &fs1_ptr->surface));
wlmtk_element_set_visible(wlmtk_content_element(&content), true);
wlmtk_element_set_visible(wlmtk_popup_element(&popup), true);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_content_get_parent_content(&content));
struct wlr_box box;
box = wlmtk_element_get_dimensions_box(wlmtk_content_element(&content));
BS_TEST_VERIFY_EQ(test_ptr, 100, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.height);
wlmtk_content_add_wlmtk_popup(&content, &popup);
box = wlmtk_element_get_dimensions_box(wlmtk_content_element(&content));
BS_TEST_VERIFY_EQ(test_ptr, 100, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.height);
wlmtk_content_remove_wlmtk_popup(&content, &popup);
wlmtk_popup_fini(&popup);
wlmtk_content_fini(&content);
wlmtk_fake_surface_destroy(fs1_ptr);
wlmtk_fake_surface_destroy(fs0_ptr);
}
/* == End of content.c ===================================================== */
wlmaker-0.3/src/toolkit/content.h 0000664 0000000 0000000 00000025076 14641446446 0017144 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file content.h
*
* @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.
*/
#ifndef __WLMTK_CONTENT_H__
#define __WLMTK_CONTENT_H__
/** Forward declaration: Content state. */
typedef struct _wlmtk_content_t wlmtk_content_t;
/** Forward declaration: Content virtual method table. */
typedef struct _wlmtk_content_vmt_t wlmtk_content_vmt_t;
/** Forward declaration: Window. */
typedef struct _wlmtk_window_t wlmtk_window_t
;/** Forward declaration: State of a toolkit's WLR surface. */
typedef struct _wlmtk_surface_t wlmtk_surface_t;
/** Forward declaration: Fake content, for tests. */
typedef struct _wlmtk_fake_content_t wlmtk_fake_content_t;
#include "container.h"
#include "popup.h"
#include "surface.h"
#include "util.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Virtual method table of @ref wlmtk_content_t. */
struct _wlmtk_content_vmt_t {
/**
* Requests the content to be set to maximized mode.
*
* Once the content has changed to `maximized` mode (potentially an
* asynchronous operation), @ref wlmtk_window_commit_maximized ought to be
* called, if the content belongs to a window.
*
* @param content_ptr
* @param maximized
*
* @return XDG toplevel configuration serial.
*/
uint32_t (*request_maximized)(wlmtk_content_t *content_ptr,
bool maximized);
/**
* Requests the content to be set to fullscreen mode.
*
* Some contents may adjust the decoration suitably. Once the content has
* changed to fullscreen mode (potentially an asynchronous operation),
* @ref wlmtk_window_commit_fullscreen ought to be called, if the content
* belongs to a window.
*
* @param content_ptr
* @param fullscreen
*
* @return XDG toplevel configuration serial.
*/
uint32_t (*request_fullscreen)(wlmtk_content_t *content_ptr,
bool fullscreen);
/**
* Requests the content to change to the specified size.
*
* This may be implemented as an asynchronous implementation. Once the
* content has committed the adapted size, @ref wlmtk_content_commit should
* be called with the corresponding serial.
*
* @param content_ptr
* @param width
* @param height
*
* @return XDG toplevel configuration serial.
*/
uint32_t (*request_size)(wlmtk_content_t *content_ptr,
int width,
int height);
/**
* Requests the content to close.
*
* @param content_ptr
*/
void (*request_close)(wlmtk_content_t *content_ptr);
/**
* Sets whether this content as activated (keyboard focus).
*
* @param content_ptr
* @param activated
*/
void (*set_activated)(wlmtk_content_t *content_ptr, bool activated);
};
/** State of window content. */
struct _wlmtk_content_t {
/** Super class of the content: A container, holding surface & popups. */
wlmtk_container_t super_container;
/** Virtual method table of the content. */
wlmtk_content_vmt_t vmt;
/** Virtual method table of the super element before extending it. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** And the popup container. Contents can contain popups. */
// TODO(kaeser@gubbe.ch): Re-think whether this better be part of window?
wlmtk_container_t popup_container;
/** The principal surface of the content. */
wlmtk_surface_t *surface_ptr;
/** The window this content belongs to. Set when creating the window. */
wlmtk_window_t *window_ptr;
/** The client connected to the @ref wlmtk_content_t::surface_ptr. */
wlmtk_util_client_t client;
/**
* The parent content, or NULL. Set in @ref wlmtk_content_add_popup,
* respectively in @ref wlmtk_content_remove_popup.
*/
wlmtk_content_t *parent_content_ptr;
/** Committed width of the content. See @ref wlmtk_content_commit. */
int committed_width;
/** Committed height of the content. See @ref wlmtk_content_commit. */
int committed_height;
/** Set of registered popup contents. See @ref wlmtk_content_add_popup. */
bs_dllist_t popups;
/** Connects to the parent's @ref wlmtk_content_t::popups, if a popup. */
bs_dllist_node_t dlnode;
};
/**
* Initializes the content with the given surface.
*
* @param content_ptr
* @param surface_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_content_init(
wlmtk_content_t *content_ptr,
wlmtk_surface_t *surface_ptr,
wlmtk_env_t *env_ptr);
/**
* Un-initializes the content.
*
* @param content_ptr
*/
void wlmtk_content_fini(
wlmtk_content_t *content_ptr);
/**
* Sets or clears the content's surface.
*
* @param content_ptr
* @param surface_ptr Surface to set for the content, or NULL.
*/
void wlmtk_content_set_surface(
wlmtk_content_t *content_ptr,
wlmtk_surface_t *surface_ptr);
/**
* Extends the content by specifying virtual methods.
*
* @param content_ptr
* @param content_vmt_ptr
*
* @return The original virtual method table.
*/
wlmtk_content_vmt_t wlmtk_content_extend(
wlmtk_content_t *content_ptr,
const wlmtk_content_vmt_t *content_vmt_ptr);
/** Requests maximized. See @ref wlmtk_content_vmt_t::request_maximized. */
static inline uint32_t wlmtk_content_request_maximized(
wlmtk_content_t *content_ptr,
bool maximized) {
if (NULL == content_ptr->vmt.request_maximized) return 0;
return content_ptr->vmt.request_maximized(content_ptr, maximized);
}
/** Requests fullscreen. See @ref wlmtk_content_vmt_t::request_fullscreen. */
static inline uint32_t wlmtk_content_request_fullscreen(
wlmtk_content_t *content_ptr,
bool fullscreen) {
if (NULL == content_ptr->vmt.request_fullscreen) return 0;
return content_ptr->vmt.request_fullscreen(content_ptr, fullscreen);
}
/** Requests new size. See @ref wlmtk_content_vmt_t::request_size. */
static inline uint32_t wlmtk_content_request_size(
wlmtk_content_t *content_ptr,
int width,
int height) {
return content_ptr->vmt.request_size(content_ptr, width, height);
}
/** Requests close. See @ref wlmtk_content_vmt_t::request_close. */
static inline void wlmtk_content_request_close(wlmtk_content_t *content_ptr) {
if (NULL == content_ptr->vmt.request_close) return;
return content_ptr->vmt.request_close(content_ptr);
}
/** Requests activation. See @ref wlmtk_content_vmt_t::set_activated. */
static inline void wlmtk_content_set_activated(
wlmtk_content_t *content_ptr,
bool activated) {
if (NULL == content_ptr->vmt.set_activated) return;
content_ptr->vmt.set_activated(content_ptr, activated);
}
/**
* Sets the window for the content.
*
* Private: Should only be called by Window ctor (a friend).
*
* @param content_ptr
* @param window_ptr
*/
void wlmtk_content_set_window(
wlmtk_content_t *content_ptr,
wlmtk_window_t *window_ptr);
/** Gets size: Forwards to @ref wlmtk_surface_get_size. */
void wlmtk_content_get_size(
wlmtk_content_t *content_ptr,
int *width_ptr,
int *height_ptr);
/** Commits size and serial: Calls into @ref wlmtk_window_serial. */
void wlmtk_content_commit(
wlmtk_content_t *content_ptr,
int width,
int height,
uint32_t serial);
/** Returns the superclass' instance of @ref wlmtk_element_t. */
wlmtk_element_t *wlmtk_content_element(wlmtk_content_t *content_ptr);
/**
* Adds a popup to the content.
*
* @param content_ptr
* @param popup_content_ptr
*/
void wlmtk_content_add_popup(
wlmtk_content_t *content_ptr,
wlmtk_content_t *popup_content_ptr);
/**
* Removes a popup from the content.
*
* `popup_content_ptr` must have previously been added to `content_ptr`.
*
* @param content_ptr
* @param popup_content_ptr
*/
void wlmtk_content_remove_popup(
wlmtk_content_t *content_ptr,
wlmtk_content_t *popup_content_ptr);
/**
* Adds a popup to the content.
*
* @param content_ptr
* @param popup_ptr
*/
void wlmtk_content_add_wlmtk_popup(
wlmtk_content_t *content_ptr,
wlmtk_popup_t *popup_ptr);
/**
* Removes a popup from the content.
*
* `popup_ptr` must have previously been added to `content_ptr`.
*
* @param content_ptr
* @param popup_ptr
*/
void wlmtk_content_remove_wlmtk_popup(
wlmtk_content_t *content_ptr,
wlmtk_popup_t *popup_ptr);
/** @return A pointer to the parent content, or NULL if none. */
wlmtk_content_t *wlmtk_content_get_parent_content(
wlmtk_content_t *content_ptr);
/** Content's unit tests. */
extern const bs_test_case_t wlmtk_content_test_cases[];
/** Fake content, useful for unit tests. */
struct _wlmtk_fake_content_t {
/** Superclass: content. */
wlmtk_content_t content;
/** Fake surface, the argument to @ref wlmtk_fake_content_create. */
wlmtk_fake_surface_t *fake_surface_ptr;
/** Reports whether @ref wlmtk_content_request_close was called. */
bool request_close_called;
/** Serial to return on next request_size call. */
uint32_t serial;
/** `width` argument eof last @ref wlmtk_content_request_size call. */
int requested_width;
/** `height` argument of last @ref wlmtk_content_request_size call. */
int requested_height;
/** Last call to @ref wlmtk_content_set_activated. */
bool activated;
};
/** Creates a fake content, for tests. */
wlmtk_fake_content_t *wlmtk_fake_content_create(
wlmtk_fake_surface_t *fake_surface_ptr);
/** Destroys the fake content. */
void wlmtk_fake_content_destroy(wlmtk_fake_content_t *fake_content_ptr);
/** Commits the state of last @ref wlmtk_content_request_size call. */
void wlmtk_fake_content_commit(wlmtk_fake_content_t *fake_content_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_CONTENT_H__ */
/* == End of content.h ===================================================== */
wlmaker-0.3/src/toolkit/dock.c 0000664 0000000 0000000 00000025221 14641446446 0016375 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file dock.c
*
* @copyright
* Copyright 2024 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.
*/
#include "dock.h"
#include "box.h"
/* == Declarations ========================================================= */
/** State of the toolkit dock. */
struct _wlmtk_dock_t {
/** Parent class: The panel. */
wlmtk_panel_t super_panel;
/** Positioning information for the panel. */
wlmtk_panel_positioning_t panel_positioning;
/** Copy of the positioning information this dock was called from. */
wlmtk_dock_positioning_t dock_positioning;
/** Styling info of the dock. */
wlmtk_dock_style_t dock_style;
/** Principal element of the dock is a box, holding tiles. */
wlmtk_box_t tile_box;
};
static uint32_t _wlmtk_dock_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height);
static wlmtk_box_orientation_t _wlmtk_dock_orientation(wlmtk_dock_t *dock_ptr);
static bool _wlmtk_dock_positioning(
wlmtk_dock_t *dock_ptr,
wlmtk_panel_positioning_t *panel_positioning_ptr);
/* == Data ================================================================= */
/** Virtual method table of the panel. */
static const wlmtk_panel_vmt_t _wlmtk_dock_panel_vmt = {
.request_size = _wlmtk_dock_panel_request_size
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_dock_t *wlmtk_dock_create(
const wlmtk_dock_positioning_t *dock_positioning_ptr,
const wlmtk_dock_style_t *style_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_dock_t *dock_ptr = logged_calloc(1, sizeof(wlmtk_dock_t));
if (NULL == dock_ptr) return NULL;
dock_ptr->dock_positioning = *dock_positioning_ptr;
dock_ptr->dock_style = *style_ptr;
if (!wlmtk_box_init(
&dock_ptr->tile_box,
env_ptr,
_wlmtk_dock_orientation(dock_ptr),
&dock_ptr->dock_style.margin)) {
wlmtk_dock_destroy(dock_ptr);
return NULL;
}
wlmtk_element_set_visible(wlmtk_box_element(&dock_ptr->tile_box), true);
if (!_wlmtk_dock_positioning(
dock_ptr,
&dock_ptr->panel_positioning)) {
wlmtk_dock_destroy(dock_ptr);
return NULL;
}
if (!wlmtk_panel_init(
&dock_ptr->super_panel,
&dock_ptr->panel_positioning,
env_ptr)) {
bs_log(BS_ERROR, "Failed wlmtk_panel_init.");
wlmtk_dock_destroy(dock_ptr);
return NULL;
}
wlmtk_panel_extend(&dock_ptr->super_panel, &_wlmtk_dock_panel_vmt);
wlmtk_container_add_element(
&dock_ptr->super_panel.super_container,
wlmtk_box_element(&dock_ptr->tile_box));
return dock_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_dock_destroy(wlmtk_dock_t *dock_ptr)
{
if (wlmtk_box_element(&dock_ptr->tile_box)->parent_container_ptr) {
wlmtk_container_remove_element(
&dock_ptr->super_panel.super_container,
wlmtk_box_element(&dock_ptr->tile_box));
wlmtk_box_fini(&dock_ptr->tile_box);
}
wlmtk_panel_fini(&dock_ptr->super_panel);
free(dock_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_dock_add_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr)
{
BS_ASSERT(NULL == wlmtk_tile_element(tile_ptr)->parent_container_ptr);
if (WLR_EDGE_TOP == dock_ptr->dock_positioning.anchor ||
WLR_EDGE_LEFT == dock_ptr->dock_positioning.anchor) {
wlmtk_box_add_element_back(
&dock_ptr->tile_box,
wlmtk_tile_element(tile_ptr));
} else {
wlmtk_box_add_element_front(
&dock_ptr->tile_box,
wlmtk_tile_element(tile_ptr));
}
wlmtk_panel_t *panel_ptr = wlmtk_dock_panel(dock_ptr);
struct wlr_box box = wlmtk_element_get_dimensions_box(
wlmtk_panel_element(panel_ptr));
wlmtk_panel_request_size(panel_ptr, box.width, box.height);
}
/* ------------------------------------------------------------------------- */
void wlmtk_dock_remove_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr)
{
BS_ASSERT(
&dock_ptr->tile_box.element_container ==
wlmtk_tile_element(tile_ptr)->parent_container_ptr);
wlmtk_box_remove_element(
&dock_ptr->tile_box,
wlmtk_tile_element(tile_ptr));
wlmtk_panel_t *panel_ptr = wlmtk_dock_panel(dock_ptr);
struct wlr_box box = wlmtk_element_get_dimensions_box(
wlmtk_panel_element(panel_ptr));
wlmtk_panel_request_size(panel_ptr, box.width, box.height);
}
/* ------------------------------------------------------------------------- */
wlmtk_panel_t *wlmtk_dock_panel(wlmtk_dock_t *dock_ptr)
{
return &dock_ptr->super_panel;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_dock_element(wlmtk_dock_t *dock_ptr)
{
return wlmtk_panel_element(wlmtk_dock_panel(dock_ptr));
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Returns the panel to change to the specified size.
*
* @param panel_ptr
* @param width
* @param height
*
* @return 0
*/
uint32_t _wlmtk_dock_panel_request_size(
wlmtk_panel_t *panel_ptr,
__UNUSED__ int width,
__UNUSED__ int height)
{
wlmtk_dock_t *dock_ptr = BS_CONTAINER_OF(
panel_ptr, wlmtk_dock_t, super_panel);
wlmtk_panel_positioning_t panel_positioning = {};
if (!_wlmtk_dock_positioning(dock_ptr, &panel_positioning)) {
bs_log(BS_ERROR, "Panel %p invalid positioning data.", panel_ptr);
return 0;
}
wlmtk_panel_commit(panel_ptr, 0, &panel_positioning);
return 0;
}
/* ------------------------------------------------------------------------- */
/** Derives the box' orientation for the dock. */
wlmtk_box_orientation_t _wlmtk_dock_orientation(wlmtk_dock_t *dock_ptr)
{
switch (dock_ptr->dock_positioning.edge) {
case WLR_EDGE_LEFT:
case WLR_EDGE_RIGHT:
return WLMTK_BOX_VERTICAL;
case WLR_EDGE_TOP:
case WLR_EDGE_BOTTOM:
return WLMTK_BOX_HORIZONTAL;
default:
bs_log(BS_FATAL, "wlmtk_dock %p: Invalid edge %"PRIx32,
dock_ptr, dock_ptr->dock_positioning.edge);
}
/* Not reached. */
return WLMTK_BOX_HORIZONTAL;
}
/* ------------------------------------------------------------------------- */
/** Fills the panel positioning parameters from the dock's. */
bool _wlmtk_dock_positioning(
wlmtk_dock_t *dock_ptr,
wlmtk_panel_positioning_t *panel_positioning_ptr)
{
struct wlr_box box = wlmtk_element_get_dimensions_box(
wlmtk_box_element(&dock_ptr->tile_box));
switch (dock_ptr->dock_positioning.edge) {
case WLR_EDGE_LEFT:
case WLR_EDGE_RIGHT:
panel_positioning_ptr->anchor = dock_ptr->dock_positioning.edge;
panel_positioning_ptr->desired_width = BS_MAX(box.width, 1);
if (dock_ptr->dock_positioning.anchor != WLR_EDGE_TOP &&
dock_ptr->dock_positioning.anchor != WLR_EDGE_BOTTOM) {
bs_log(BS_ERROR, "wlmtk_dock_t anchor must be adjacent to edge: "
"anchor %"PRIx32", edge %"PRIx32,
dock_ptr->dock_positioning.anchor,
dock_ptr->dock_positioning.edge);
return false;
}
panel_positioning_ptr->anchor |= dock_ptr->dock_positioning.anchor;
// The layer protocol requires a non-zero value for panels not spanning
// the entire height. Go with a one-tile dimension, as long as there's
// no tiles yet.
panel_positioning_ptr->desired_height = BS_MAX(box.height, 1);
break;
case WLR_EDGE_TOP:
case WLR_EDGE_BOTTOM:
panel_positioning_ptr->anchor = dock_ptr->dock_positioning.edge;
panel_positioning_ptr->desired_height = BS_MAX(box.height, 1);
if (dock_ptr->dock_positioning.anchor != WLR_EDGE_LEFT &&
dock_ptr->dock_positioning.anchor != WLR_EDGE_RIGHT) {
bs_log(BS_ERROR, "wlmtk_dock_t anchor must be adjacent to edge: "
"anchor %"PRIx32", edge %"PRIx32,
dock_ptr->dock_positioning.anchor,
dock_ptr->dock_positioning.edge);
return false;
}
panel_positioning_ptr->anchor |= dock_ptr->dock_positioning.anchor;
// The layer protocol requires a non-zero value for panels not spanning
// the entire width. Go with a one-tile dimension, as long as there's
// no tiles yet.
panel_positioning_ptr->desired_width = BS_MAX(box.width, 1);
break;
default:
bs_log(BS_ERROR, "Unexpected wlmtk_dock_t positioning edge 0x%"PRIx32,
dock_ptr->dock_positioning.edge);
return false;
}
return true;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_dock_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises ctor and dtor. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_dock_positioning_t pos = {
.edge = WLR_EDGE_LEFT,
.anchor = WLR_EDGE_BOTTOM,
};
wlmtk_dock_style_t style = {};
wlmtk_dock_t *dock_ptr = wlmtk_dock_create(&pos, &style, NULL);
BS_TEST_VERIFY_EQ(
test_ptr,
WLR_EDGE_LEFT | WLR_EDGE_BOTTOM,
dock_ptr->super_panel.positioning.anchor);
BS_TEST_VERIFY_EQ(
test_ptr,
1,
dock_ptr->super_panel.positioning.desired_width);
BS_TEST_VERIFY_EQ(
test_ptr,
1,
dock_ptr->super_panel.positioning.desired_height);
BS_TEST_VERIFY_EQ(
test_ptr,
WLMTK_BOX_VERTICAL,
dock_ptr->tile_box.orientation);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, dock_ptr);
wlmtk_dock_destroy(dock_ptr);
}
/* == End of dock.c ======================================================== */
wlmaker-0.3/src/toolkit/dock.h 0000664 0000000 0000000 00000005252 14641446446 0016404 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file dock.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_DOCK_H__
#define __WLMTK_DOCK_H__
#include
/** Forward declaration: Dock handle. */
typedef struct _wlmtk_dock_t wlmtk_dock_t;
#include "env.h"
#include "panel.h"
#include "tile.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Positioning options for the dock. */
typedef struct {
/** Principal edge the dock aligns to. Must not be WLR_EDGE_NONE. */
enum wlr_edges edge;
/** Dock anchor, along @ref wlmtk_dock_positioning_t::edge. */
enum wlr_edges anchor;
} wlmtk_dock_positioning_t;
/**
* Creates a dock. A dock contains icons, launchers and the likes.
*
* The dock is an implementation of a @ref wlmtk_panel_t.
*
* @param dock_positioning_ptr
* @param style_ptr
* @param env_ptr
*
* @return The dock handle, or NULL on error. Must be destroyed calling
* @ref wlmtk_dock_destroy.
*/
wlmtk_dock_t *wlmtk_dock_create(
const wlmtk_dock_positioning_t *dock_positioning_ptr,
const wlmtk_dock_style_t *style_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the dock.
*
* @param dock_ptr
*/
void wlmtk_dock_destroy(wlmtk_dock_t *dock_ptr);
/**
* Adds the tile to the dock.
*
* @param dock_ptr
* @param tile_ptr
*/
void wlmtk_dock_add_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr);
/**
* Removes the tile from the dock.
*
* @param dock_ptr
* @param tile_ptr
*/
void wlmtk_dock_remove_tile(
wlmtk_dock_t *dock_ptr,
wlmtk_tile_t *tile_ptr);
/** @return Pointer to the superclass @ref wlmtk_panel_t of `dock_ptr`. */
wlmtk_panel_t *wlmtk_dock_panel(wlmtk_dock_t *dock_ptr);
/** @return Pointer to the superclass @ref wlmtk_element_t of `dock_ptr`. */
wlmtk_element_t *wlmtk_dock_element(wlmtk_dock_t *dock_ptr);
/** Unit tests for @ref wlmtk_dock_t. */
extern const bs_test_case_t wlmtk_dock_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_DOCK_H__ */
/* == End of dock.h ======================================================== */
wlmaker-0.3/src/toolkit/element.c 0000664 0000000 0000000 00000076211 14641446446 0017113 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file element.c
*
* @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.
*/
#include "element.h"
#include "container.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static void _wlmtk_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr);
static bool _wlmtk_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec);
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(
__UNUSED__ wlmtk_element_t *element_ptr,
__UNUSED__ struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static void _wlmtk_element_pointer_enter(
wlmtk_element_t *element_ptr);
static void _wlmtk_element_pointer_leave(
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,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
static void handle_wlr_scene_node_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** Default virtual method table. Initializes the non-abstract methods. */
static const wlmtk_element_vmt_t element_vmt = {
.get_pointer_area = _wlmtk_element_get_pointer_area,
.pointer_motion = _wlmtk_element_pointer_motion,
.pointer_button = _wlmtk_element_pointer_button,
.pointer_axis = _wlmtk_element_pointer_axis,
.pointer_enter = _wlmtk_element_pointer_enter,
.pointer_leave = _wlmtk_element_pointer_leave,
.keyboard_event = _wlmtk_element_keyboard_event,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_element_init(
wlmtk_element_t *element_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != element_ptr);
memset(element_ptr, 0, sizeof(wlmtk_element_t));
element_ptr->vmt = element_vmt;
element_ptr->env_ptr = env_ptr;
element_ptr->last_pointer_x = NAN;
element_ptr->last_pointer_y = NAN;
element_ptr->last_pointer_time_msec = 0;
return true;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_vmt_t wlmtk_element_extend(
wlmtk_element_t *element_ptr,
const wlmtk_element_vmt_t *element_vmt_ptr)
{
wlmtk_element_vmt_t orig_vmt = element_ptr->vmt;
// Only overwrite provided methods.
if (NULL != element_vmt_ptr->destroy) {
element_ptr->vmt.destroy = element_vmt_ptr->destroy;
}
if (NULL != element_vmt_ptr->create_scene_node) {
element_ptr->vmt.create_scene_node = element_vmt_ptr->create_scene_node;
}
if (NULL != element_vmt_ptr->get_dimensions) {
element_ptr->vmt.get_dimensions = element_vmt_ptr->get_dimensions;
}
if (NULL != element_vmt_ptr->get_pointer_area) {
element_ptr->vmt.get_pointer_area = element_vmt_ptr->get_pointer_area;
}
if (NULL != element_vmt_ptr->pointer_motion) {
element_ptr->vmt.pointer_motion = element_vmt_ptr->pointer_motion;
}
if (NULL != element_vmt_ptr->pointer_button) {
element_ptr->vmt.pointer_button = element_vmt_ptr->pointer_button;
}
if (NULL != element_vmt_ptr->pointer_axis) {
element_ptr->vmt.pointer_axis = element_vmt_ptr->pointer_axis;
}
if (NULL != element_vmt_ptr->pointer_enter) {
element_ptr->vmt.pointer_enter = element_vmt_ptr->pointer_enter;
}
if (NULL != element_vmt_ptr->pointer_leave) {
element_ptr->vmt.pointer_leave = element_vmt_ptr->pointer_leave;
}
if (NULL != element_vmt_ptr->keyboard_event) {
element_ptr->vmt.keyboard_event = element_vmt_ptr->keyboard_event;
}
return orig_vmt;
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_fini(
wlmtk_element_t *element_ptr)
{
// Verify we're no longer part of the scene graph, nor part of a container.
BS_ASSERT(NULL == element_ptr->wlr_scene_node_ptr);
BS_ASSERT(NULL == element_ptr->parent_container_ptr);
memset(element_ptr, 0, sizeof(wlmtk_element_t));
}
/* ------------------------------------------------------------------------- */
bs_dllist_node_t *wlmtk_dlnode_from_element(
wlmtk_element_t *element_ptr)
{
return &element_ptr->dlnode;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_element_from_dlnode(
bs_dllist_node_t *dlnode_ptr)
{
return BS_CONTAINER_OF(dlnode_ptr, wlmtk_element_t, dlnode);
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_set_parent_container(
wlmtk_element_t *element_ptr,
wlmtk_container_t *parent_container_ptr)
{
if (element_ptr->parent_container_ptr == parent_container_ptr) return;
element_ptr->parent_container_ptr = parent_container_ptr;
wlmtk_element_attach_to_scene_graph(element_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_attach_to_scene_graph(
wlmtk_element_t *element_ptr)
{
struct wlr_scene_tree *parent_wlr_scene_tree_ptr = NULL;
if (NULL != element_ptr->parent_container_ptr) {
parent_wlr_scene_tree_ptr = wlmtk_container_wlr_scene_tree(
element_ptr->parent_container_ptr);
}
if (NULL == parent_wlr_scene_tree_ptr) {
if (NULL != element_ptr->wlr_scene_node_ptr) {
wl_list_remove(&element_ptr->wlr_scene_node_destroy_listener.link);
wlr_scene_node_destroy(element_ptr->wlr_scene_node_ptr);
element_ptr->wlr_scene_node_ptr = NULL;
}
return;
}
if (NULL == element_ptr->wlr_scene_node_ptr) {
element_ptr->wlr_scene_node_ptr = element_ptr->vmt.create_scene_node(
element_ptr, parent_wlr_scene_tree_ptr);
wlmtk_util_connect_listener_signal(
&element_ptr->wlr_scene_node_ptr->events.destroy,
&element_ptr->wlr_scene_node_destroy_listener,
handle_wlr_scene_node_destroy);
wlr_scene_node_set_enabled(element_ptr->wlr_scene_node_ptr,
element_ptr->visible);
wlr_scene_node_set_position(element_ptr->wlr_scene_node_ptr,
element_ptr->x,
element_ptr->y);
return;
}
BS_ASSERT(NULL != element_ptr->wlr_scene_node_ptr);
if (element_ptr->wlr_scene_node_ptr->parent == parent_wlr_scene_tree_ptr) {
// Parent does not change, nothing to do.
return;
}
wlr_scene_node_reparent(element_ptr->wlr_scene_node_ptr,
parent_wlr_scene_tree_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_set_visible(wlmtk_element_t *element_ptr, bool visible)
{
// Nothing to do?
if (element_ptr->visible == visible) return;
element_ptr->visible = visible;
if (NULL != element_ptr->wlr_scene_node_ptr) {
wlr_scene_node_set_enabled(element_ptr->wlr_scene_node_ptr, visible);
}
if (NULL != element_ptr->parent_container_ptr) {
wlmtk_container_update_layout(element_ptr->parent_container_ptr);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_get_position(
wlmtk_element_t *element_ptr,
int *x_ptr,
int *y_ptr)
{
// The node may have been moved without us noticing... update it.
if (NULL != element_ptr->wlr_scene_node_ptr) {
element_ptr->x = element_ptr->wlr_scene_node_ptr->x;
element_ptr->y = element_ptr->wlr_scene_node_ptr->y;
}
if (NULL != x_ptr) *x_ptr = element_ptr->x;
if (NULL != y_ptr) *y_ptr = element_ptr->y;
}
/* ------------------------------------------------------------------------- */
void wlmtk_element_set_position(
wlmtk_element_t *element_ptr,
int x,
int y)
{
if (NULL != element_ptr->wlr_scene_node_ptr) {
wlr_scene_node_set_position(element_ptr->wlr_scene_node_ptr, x, y);
}
// Optimization clause: Can leave here, if coordinates didn't change.
if (element_ptr->x == x && element_ptr->y == y) return;
element_ptr->x = x;
element_ptr->y = y;
if (NULL != element_ptr->parent_container_ptr) {
wlmtk_container_update_pointer_focus(
element_ptr->parent_container_ptr);
}
}
/* ------------------------------------------------------------------------- */
bool wlmtk_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
bool within = element_ptr->vmt.pointer_motion(element_ptr, x, y, time_msec);
if (within == element_ptr->pointer_inside) return within;
if (within) {
element_ptr->pointer_inside = true;
element_ptr->vmt.pointer_enter(element_ptr);
} else {
element_ptr->pointer_inside = false;
element_ptr->vmt.pointer_leave(element_ptr);
}
return within;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Wraps to wlmtk_element_vmt_t::get_dimensions as default implementation. */
void _wlmtk_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr)
{
wlmtk_element_get_dimensions(element_ptr, x1_ptr, y1_ptr, x2_ptr, y2_ptr);
}
/* ------------------------------------------------------------------------- */
/** Stores pointer coordinates and timestamp. Returns true is x,y not NAN. */
bool _wlmtk_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
if (isnan(x) || isnan(y)) {
x = NAN;
y = NAN;
}
element_ptr->last_pointer_x = x;
element_ptr->last_pointer_y = y;
element_ptr->last_pointer_time_msec = time_msec;
return !isnan(x) && !isnan(y);
}
/* ------------------------------------------------------------------------- */
/** Does nothing, returns false. */
bool _wlmtk_element_pointer_button(
__UNUSED__ wlmtk_element_t *element_ptr,
__UNUSED__ const wlmtk_button_event_t *button_event_ptr)
{
return false;
}
/* ------------------------------------------------------------------------- */
/** Does nothing, returns false. */
bool _wlmtk_element_pointer_axis(
__UNUSED__ wlmtk_element_t *element_ptr,
__UNUSED__ struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
return false;
}
/* ------------------------------------------------------------------------- */
/** Handler for when the pointer enters the area. Sets default cursor. */
void _wlmtk_element_pointer_enter(wlmtk_element_t *element_ptr)
{
// TODO(kaeser@gubbe.ch): Consider forking this out into a 'leaf element'
// class. 'enter' and 'leave' don't make that much sense for eg. a
// container.
wlmtk_env_set_cursor(element_ptr->env_ptr, WLMTK_CURSOR_DEFAULT);
}
/* ------------------------------------------------------------------------- */
/** Handler for when the pointer leaves the area. Nothing for default impl. */
void _wlmtk_element_pointer_leave(__UNUSED__ wlmtk_element_t *element_ptr)
{
// Nothing.
}
/* ------------------------------------------------------------------------- */
/** Handler for keyboard events. By default: Nothing is handled. */
bool _wlmtk_element_keyboard_event(
__UNUSED__ wlmtk_element_t *element_ptr,
__UNUSED__ struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
__UNUSED__ const xkb_keysym_t *key_syms,
__UNUSED__ size_t key_syms_count,
__UNUSED__ uint32_t modifiers)
{
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Handles the 'destroy' callback of the wlr_scene_node.
*
* A call here indicates that teardown was not executed properly!
*
* @param listener_ptr
* @param data_ptr
*/
void handle_wlr_scene_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_element_t *element_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_element_t, wlr_scene_node_destroy_listener);
bs_log(BS_FATAL, "Unexpected call into node's dtor on %p!", element_ptr);
}
/* == Fake element, useful for unit tests. ================================= */
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 void fake_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static bool fake_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
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_enter(
wlmtk_element_t *element_ptr);
static void fake_pointer_leave(
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,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
/** Virtual method table for the fake element. */
static const wlmtk_element_vmt_t fake_element_vmt = {
.destroy = fake_destroy,
.create_scene_node = fake_create_scene_node,
.get_dimensions = fake_get_dimensions,
.get_pointer_area = fake_get_pointer_area,
.pointer_motion = fake_pointer_motion,
.pointer_button = fake_pointer_button,
.pointer_axis = fake_pointer_axis,
.pointer_enter = fake_pointer_enter,
.pointer_leave = fake_pointer_leave,
.keyboard_event = fake_keyboard_event,
};
/* ------------------------------------------------------------------------- */
wlmtk_fake_element_t *wlmtk_fake_element_create(void)
{
wlmtk_fake_element_t *fake_element_ptr = logged_calloc(
1, sizeof(wlmtk_fake_element_t));
if (NULL == fake_element_ptr) return NULL;
if (!wlmtk_element_init(&fake_element_ptr->element, NULL)) {
fake_destroy(&fake_element_ptr->element);
return NULL;
}
fake_element_ptr->orig_vmt = wlmtk_element_extend(
&fake_element_ptr->element, &fake_element_vmt);
return fake_element_ptr;
}
/* ------------------------------------------------------------------------- */
/** dtor for the "fake" element used for tests. */
void fake_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
wlmtk_element_fini(&fake_element_ptr->element);
free(fake_element_ptr);
}
/* ------------------------------------------------------------------------- */
/** A "fake" 'create_scene_node': Creates a non-attached buffer node. */
struct wlr_scene_node *fake_create_scene_node(
__UNUSED__ wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
struct wlr_scene_buffer *wlr_scene_buffer_ptr = wlr_scene_buffer_create(
wlr_scene_tree_ptr, NULL);
return &wlr_scene_buffer_ptr->node;
}
/* ------------------------------------------------------------------------- */
/** A "fake" 'get_dimensions'. */
void fake_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
if (NULL != left_ptr) *left_ptr = fake_element_ptr->dimensions.x;
if (NULL != top_ptr) *top_ptr = fake_element_ptr->dimensions.y;
if (NULL != right_ptr) *right_ptr = (
fake_element_ptr->dimensions.width - fake_element_ptr->dimensions.x);
if (NULL != bottom_ptr) *bottom_ptr = (
fake_element_ptr->dimensions.height - fake_element_ptr->dimensions.y);
}
/* ------------------------------------------------------------------------- */
/** A "fake" 'get_pointer_area'. */
void fake_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
if (NULL != left_ptr) *left_ptr = -1;
if (NULL != top_ptr) *top_ptr = -2;
if (NULL != right_ptr) *right_ptr = (
fake_element_ptr->dimensions.width + 3);
if (NULL != bottom_ptr) *bottom_ptr = (
fake_element_ptr->dimensions.height + 4);
}
/* ------------------------------------------------------------------------- */
/** Handles 'motion' events for the fake element, updates last position. */
bool fake_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->orig_vmt.pointer_motion(element_ptr, x, y, time_msec);
fake_element_ptr->pointer_motion_called = true;
return (-1 <= x && x < fake_element_ptr->dimensions.width + 3 &&
-2 < y && y < fake_element_ptr->dimensions.height + 4);
}
/* ------------------------------------------------------------------------- */
/** Handles 'button' events for the fake element. */
bool fake_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->pointer_button_called = true;
memcpy(
&fake_element_ptr->pointer_button_event,
button_event_ptr,
sizeof(wlmtk_button_event_t));
return true;
}
/* ------------------------------------------------------------------------- */
/** Handles 'axis' events for the fake element. */
bool fake_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->pointer_axis_called = true;
memcpy(
&fake_element_ptr->wlr_pointer_axis_event,
wlr_pointer_axis_event_ptr,
sizeof(struct wlr_pointer_axis_event));
return true;
}
/* ------------------------------------------------------------------------- */
/** Handles 'enter' events for the fake element. */
void fake_pointer_enter(
wlmtk_element_t *element_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->orig_vmt.pointer_enter(element_ptr);
fake_element_ptr->pointer_enter_called = true;
}
/* ------------------------------------------------------------------------- */
/** Handles 'leave' events for the fake element. */
void fake_pointer_leave(
wlmtk_element_t *element_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->orig_vmt.pointer_leave(element_ptr);
fake_element_ptr->pointer_leave_called = true;
}
/* ------------------------------------------------------------------------- */
/** Handles 'keyboard_event' events for the fake element. */
bool fake_keyboard_event(
wlmtk_element_t *element_ptr,
__UNUSED__ struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
__UNUSED__ const xkb_keysym_t *key_syms,
__UNUSED__ size_t key_syms_count,
__UNUSED__ uint32_t modifiers)
{
wlmtk_fake_element_t *fake_element_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_element_t, element);
fake_element_ptr->keyboard_event_called = true;
return true;
}
/* == Unit tests =========================================================== */
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_get_pointer_area(bs_test_t *test_ptr);
static void test_pointer_motion_leave(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_event(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_element_test_cases[] = {
{ 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, "get_pointer_area", test_get_pointer_area },
{ 1, "pointer_motion_leave", test_pointer_motion_leave },
{ 1, "pointer_button", test_pointer_button },
{ 1, "pointer_axis", test_pointer_axis },
{ 1, "keyboard_event", test_keyboard_event },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises init() and fini() methods, verifies dtor forwarding. */
void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_element_t element;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_element_init(&element, NULL));
wlmtk_element_extend(&element, &fake_element_vmt);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, element.vmt.destroy);
wlmtk_element_fini(&element);
BS_TEST_VERIFY_EQ(test_ptr, NULL, element.vmt.destroy);
}
/* ------------------------------------------------------------------------- */
/** Tests set_parent_container, and that scene graph follows. */
void test_set_parent_container(bs_test_t *test_ptr)
{
wlmtk_element_t element;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_element_init(&element, NULL));
wlmtk_element_extend(&element, &fake_element_vmt);
// Setting a parent without a scene graph tree will not set a node.
wlmtk_container_t parent_no_tree;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_container_init(&parent_no_tree, NULL));
wlmtk_element_set_parent_container(&element, &parent_no_tree);
BS_TEST_VERIFY_EQ(test_ptr, NULL, element.wlr_scene_node_ptr);
wlmtk_element_set_parent_container(&element, NULL);
BS_TEST_VERIFY_EQ(test_ptr, NULL, element.wlr_scene_node_ptr);
wlmtk_container_fini(&parent_no_tree);
// Setting a parent with a tree must create & attach the node there.
wlmtk_container_t *parent_ptr = wlmtk_container_create_fake_parent();
BS_ASSERT(NULL != parent_ptr);
wlmtk_element_set_visible(&element, true);
wlmtk_element_set_parent_container(&element, parent_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
parent_ptr->wlr_scene_tree_ptr,
element.wlr_scene_node_ptr->parent);
BS_TEST_VERIFY_TRUE(test_ptr, element.wlr_scene_node_ptr->enabled);
// Resetting the parent must also re-attach the node.
wlmtk_container_t *other_parent_ptr = wlmtk_container_create_fake_parent();
BS_ASSERT(NULL != other_parent_ptr);
wlmtk_element_set_parent_container(&element, other_parent_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
other_parent_ptr->wlr_scene_tree_ptr,
element.wlr_scene_node_ptr->parent);
BS_TEST_VERIFY_TRUE(test_ptr, element.wlr_scene_node_ptr->enabled);
// Clearing the parent most remove the node.
wlmtk_element_set_parent_container(&element, NULL);
BS_TEST_VERIFY_EQ(test_ptr, NULL, element.wlr_scene_node_ptr);
wlmtk_container_destroy_fake_parent(other_parent_ptr);
wlmtk_container_destroy_fake_parent(parent_ptr);
wlmtk_element_fini(&element);
}
/* ------------------------------------------------------------------------- */
/** Tests get_position and set_position, and that scene graph follows. */
void test_set_get_position(bs_test_t *test_ptr)
{
wlmtk_element_t element;
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_element_init(&element, NULL));
wlmtk_element_extend(&element, &fake_element_vmt);
// Exercise, must not crash.
wlmtk_element_get_position(&element, NULL, NULL);
int x, y;
wlmtk_element_get_position(&element, &x, &y);
BS_TEST_VERIFY_EQ(test_ptr, 0, x);
BS_TEST_VERIFY_EQ(test_ptr, 0, y);
wlmtk_element_set_position(&element, 10, 20);
wlmtk_element_get_position(&element, &x, &y);
BS_TEST_VERIFY_EQ(test_ptr, 10, x);
BS_TEST_VERIFY_EQ(test_ptr, 20, y);
wlmtk_container_t *fake_parent_ptr = wlmtk_container_create_fake_parent();
BS_ASSERT(NULL != fake_parent_ptr);
wlmtk_element_set_parent_container(&element, fake_parent_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 10, element.wlr_scene_node_ptr->x);
BS_TEST_VERIFY_EQ(test_ptr, 20, element.wlr_scene_node_ptr->y);
wlmtk_element_set_position(&element, 30, 40);
BS_TEST_VERIFY_EQ(test_ptr, 30, element.wlr_scene_node_ptr->x);
BS_TEST_VERIFY_EQ(test_ptr, 40, element.wlr_scene_node_ptr->y);
wlr_scene_node_set_position(element.wlr_scene_node_ptr, 50, 60);
wlmtk_element_get_position(&element, &x, &y);
BS_TEST_VERIFY_EQ(test_ptr, 50, x);
BS_TEST_VERIFY_EQ(test_ptr, 60, y);
wlmtk_element_set_parent_container(&element, NULL);
wlmtk_element_fini(&element);
wlmtk_container_destroy_fake_parent(fake_parent_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests get_dimensions. */
void test_get_dimensions(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
fake_element_ptr->dimensions.x = -10;
fake_element_ptr->dimensions.y = -20;
fake_element_ptr->dimensions.width = 42;
fake_element_ptr->dimensions.height = 21;
// Must not crash.
wlmtk_element_get_dimensions(
&fake_element_ptr->element, NULL, NULL, NULL, NULL);
int top, left, right, bottom;
wlmtk_element_get_dimensions(
&fake_element_ptr->element, &top, &left, &right, &bottom);
BS_TEST_VERIFY_EQ(test_ptr, -10, top);
BS_TEST_VERIFY_EQ(test_ptr, -20, left);
BS_TEST_VERIFY_EQ(test_ptr, 52, right);
BS_TEST_VERIFY_EQ(test_ptr, 41, bottom);
struct wlr_box box = wlmtk_element_get_dimensions_box(
&fake_element_ptr->element);
BS_TEST_VERIFY_EQ(test_ptr, -10, box.x);
BS_TEST_VERIFY_EQ(test_ptr, -20, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 42, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 21, box.height);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* ------------------------------------------------------------------------- */
/** Tests get_dimensions. */
void test_get_pointer_area(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
fake_element_ptr->dimensions.width = 42;
fake_element_ptr->dimensions.height = 21;
// Must not crash.
wlmtk_element_get_pointer_area(
&fake_element_ptr->element, NULL, NULL, NULL, NULL);
int top, left, right, bottom;
wlmtk_element_get_pointer_area(
&fake_element_ptr->element, &top, &left, &right, &bottom);
BS_TEST_VERIFY_EQ(test_ptr, -1, top);
BS_TEST_VERIFY_EQ(test_ptr, -2, left);
BS_TEST_VERIFY_EQ(test_ptr, 45, right);
BS_TEST_VERIFY_EQ(test_ptr, 25, bottom);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* ------------------------------------------------------------------------- */
/** Exercises "pointer_motion" and "pointer_leave" methods. */
void test_pointer_motion_leave(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != fake_element_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
isnan(fake_element_ptr->element.last_pointer_x));
BS_TEST_VERIFY_TRUE(
test_ptr,
isnan(fake_element_ptr->element.last_pointer_y));
wlmtk_element_pointer_motion(&fake_element_ptr->element, 1.0, 2.0, 1234);
BS_TEST_VERIFY_TRUE(test_ptr, fake_element_ptr->pointer_enter_called);
BS_TEST_VERIFY_EQ(test_ptr, 1.0, fake_element_ptr->element.last_pointer_x);
BS_TEST_VERIFY_EQ(test_ptr, 2.0, fake_element_ptr->element.last_pointer_y);
BS_TEST_VERIFY_EQ(
test_ptr,
1234,
fake_element_ptr->element.last_pointer_time_msec);
wlmtk_element_pointer_motion(&fake_element_ptr->element, NAN, NAN, 1235);
BS_TEST_VERIFY_TRUE(test_ptr, fake_element_ptr->pointer_leave_called);
BS_TEST_VERIFY_TRUE(
test_ptr,
isnan(fake_element_ptr->element.last_pointer_x));
BS_TEST_VERIFY_TRUE(
test_ptr,
isnan(fake_element_ptr->element.last_pointer_y));
BS_TEST_VERIFY_EQ(
test_ptr,
1235,
fake_element_ptr->element.last_pointer_time_msec);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* ------------------------------------------------------------------------- */
/** Exercises "pointer_button" method. */
void test_pointer_button(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != fake_element_ptr);
wlmtk_button_event_t event = {};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(&fake_element_ptr->element, &event));
BS_TEST_VERIFY_TRUE(test_ptr, fake_element_ptr->pointer_button_called);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* ------------------------------------------------------------------------- */
/** Exercises "pointer_axis" method. */
void test_pointer_axis(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != fake_element_ptr);
struct wlr_pointer_axis_event event = {};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_axis(&fake_element_ptr->element, &event));
BS_TEST_VERIFY_TRUE(test_ptr, fake_element_ptr->pointer_axis_called);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* ------------------------------------------------------------------------- */
/** Exercises "keyboard_event" method. */
void test_keyboard_event(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
BS_ASSERT(NULL != fake_element_ptr);
struct wlr_keyboard_key_event event = {};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_keyboard_event(
&fake_element_ptr->element, &event, NULL, 0, 0));
BS_TEST_VERIFY_TRUE(test_ptr, fake_element_ptr->keyboard_event_called);
wlmtk_element_destroy(&fake_element_ptr->element);
}
/* == End of toolkit.c ===================================================== */
wlmaker-0.3/src/toolkit/element.h 0000664 0000000 0000000 00000036161 14641446446 0017120 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file element.h
*
* @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.
*/
#ifndef __WLMTK_ELEMENT_H__
#define __WLMTK_ELEMENT_H__
#include
#include
#include
#include "wlr/util/box.h"
/** Forward declaration: Element. */
typedef struct _wlmtk_element_t wlmtk_element_t;
/** Forward declaration: Element virtual method table. */
typedef struct _wlmtk_element_vmt_t wlmtk_element_vmt_t;
/** Forward declaration: Container. */
typedef struct _wlmtk_container_t wlmtk_container_t;
struct wlr_scene_tree;
/** Forward declaration: Axis event. */
struct wlr_pointer_axis_event;
/** Forward declaration: Wlroots keyboard event. */
struct wlr_keyboard_key_event;
#include "env.h"
#include "input.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Virtual method table for the element. */
struct _wlmtk_element_vmt_t {
/** Abstract: Destroys the implementation of the element. */
void (*destroy)(wlmtk_element_t *element_ptr);
/** Abstract: Creates element's scene graph API node, child to wlr_scene_tree_ptr. */
struct wlr_scene_node *(*create_scene_node)(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
/** Abstract: Gets dimensions of the element, relative to the element's position. */
void (*get_dimensions)(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr);
/** Gets element area to accept pointer activity, relative to position. */
void (*get_pointer_area)(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
/**
* Indicates pointer motion into or within the element area to (x,y).
*
* The default implementation at @ref _wlmtk_element_pointer_motion updates
* @ref wlmtk_element_t::last_pointer_x,
* @ref wlmtk_element_t::last_pointer_y
* and @ref wlmtk_element_t::last_pointer_time_msec.
*
* Derived classes that overwrite this method are advised to call the
* initial implementation for keeping these internals updated.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*
* @return Whether the motion is considered within the element's pointer
* area. If it returns true, the caller should consider this element
* as having pointer focus.
*/
bool (*pointer_motion)(wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
/**
* Indicates pointer button event.
*
* @param element_ptr
* @param button_event_ptr
*
* @return true If the button event was consumed.
*/
bool (*pointer_button)(wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
/**
* Indicates a pointer axis event.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return true If the axis event was consumed.
*/
bool (*pointer_axis)(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
/**
* Indicates the pointer has entered the element's area.
*
* TODO(kaeser@gubbe.ch): pointer_enter and pointer_leave would better be
* handled as events, where clients subscribe via listeners. Consider
* changing that.
*
* @param element_ptr
*/
void (*pointer_enter)(wlmtk_element_t *element_ptr);
/**
* Indicates the pointer has left the element's area.
*
* @param element_ptr
*/
void (*pointer_leave)(wlmtk_element_t *element_ptr);
/**
* Handler for keyboard events.
*
* @param element_ptr
* @param wlr_keyboard_key_event_ptr
* @param key_syms
* @param key_syms_count
* @param modifiers
*
* @return true if the key was handled.
*/
bool (*keyboard_event)(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
};
/** State of an element. */
struct _wlmtk_element_t {
/**
* X position of the element in pixels, relative to parent container.
*
* This value may be stale, if @ref wlmtk_element_t::wlr_scene_node_ptr is
* set and had been updated directly. Therefore, consider the value as
* "private", and access only through @ref wlmtk_element_get_position.
*/
int x;
/**
* Y position of the element, relative to the container.
*
* Same observations apply as for @ref wlmtk_element_t::x.
*/
int y;
/** The container this element belongs to, if any. */
wlmtk_container_t *parent_container_ptr;
/** The node of elements. */
bs_dllist_node_t dlnode;
/** Virtual method table for the element. */
wlmtk_element_vmt_t vmt;
/** Toolkit environment. */
wlmtk_env_t *env_ptr;
/** Points to the wlroots scene graph API node, if attached. */
struct wlr_scene_node *wlr_scene_node_ptr;
/** Whether the element is visible (drawn, when part of a scene graph). */
bool visible;
/** Listener for the `destroy` signal of `wlr_scene_node_ptr`. */
struct wl_listener wlr_scene_node_destroy_listener;
/**
* Horizontal pointer position from last @ref wlmtk_element_pointer_motion
* call. NAN if there was no motion call yet, or if the last motion call
* had NAN arguments.
*
* Does not imply that the element has pointer focus.
*/
double last_pointer_x;
/**
* Vertical pointer position from last @ref wlmtk_element_pointer_motion
* call. NAN if there was no motion call yet, or if the last motion call
* had NAN arguments.
*
* Does not imply that the element has pointer focus.
*/
double last_pointer_y;
/** Time of last @ref wlmtk_element_pointer_motion call, 0 otherwise. */
uint32_t last_pointer_time_msec;
/** Whether the pointer is currently within the element's bounds. */
bool pointer_inside;
};
/**
* Initializes the element.
*
* @param element_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_element_init(wlmtk_element_t *element_ptr,
wlmtk_env_t *env_ptr);
/**
* Extends the element's virtual methods.
*
* @param element_ptr
* @param element_vmt_ptr
*
* @return The previous virtual method table.
*/
wlmtk_element_vmt_t wlmtk_element_extend(
wlmtk_element_t *element_ptr,
const wlmtk_element_vmt_t *element_vmt_ptr);
/**
* Cleans up the element.
*
* @param element_ptr
*/
void wlmtk_element_fini(
wlmtk_element_t *element_ptr);
/** Gets the dlnode from the element. */
bs_dllist_node_t *wlmtk_dlnode_from_element(
wlmtk_element_t *element_ptr);
/** Gets the element from the dlnode. */
wlmtk_element_t *wlmtk_element_from_dlnode(
bs_dllist_node_t *dlnode_ptr);
/**
* Sets the parent container for the element.
*
* Will call @ref 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").
*
* @param element_ptr
* @param parent_container_ptr Pointer to the parent container, or NULL if
* the parent should be cleared.
*/
void wlmtk_element_set_parent_container(
wlmtk_element_t *element_ptr,
wlmtk_container_t *parent_container_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 @ref 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.
*
* @param element_ptr
*/
void wlmtk_element_attach_to_scene_graph(
wlmtk_element_t *element_ptr);
/**
* Sets the element's visibility.
*
* @param element_ptr
* @param visible
*/
void wlmtk_element_set_visible(wlmtk_element_t *element_ptr, bool visible);
/**
* Returns the position of the element.
*
* @param element_ptr
* @param x_ptr Optional, may be NULL.
* @param y_ptr Optional, may be NULL.
*/
void wlmtk_element_get_position(
wlmtk_element_t *element_ptr,
int *x_ptr,
int *y_ptr);
/**
* Sets the position of the element.
*
* @param element_ptr
* @param x
* @param y
*/
void wlmtk_element_set_position(
wlmtk_element_t *element_ptr,
int x,
int y);
/**
* Gets the area that the element on which the element accepts pointer events.
*
* The area extents are relative to the element's position. By default, this
* overlaps with the element dimensions. Some elements (eg. a surface with
* further-extending sub-surfaces) may differ.
*
* @param element_ptr
* @param x1_ptr Leftmost position of pointer area. May be NULL.
* @param y1_ptr Topmost position of pointer area. May be NULL.
* @param x2_ptr Rightmost position of pointer area. May be NULL.
* @param y2_ptr Bottommost position of pointer area. May be NULL.
*/
static inline void wlmtk_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr)
{
element_ptr->vmt.get_pointer_area(
element_ptr, x1_ptr, y1_ptr, x2_ptr, y2_ptr);
}
/**
* Gets the dimensions of the element in pixels, relative to the position.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
static inline void wlmtk_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
element_ptr->vmt.get_dimensions(
element_ptr, left_ptr, top_ptr, right_ptr, bottom_ptr);
}
/**
* Gets the element's dimensions in pixel as wlr_box, relative to the position.
*
* @param element_ptr
*
* @return A struct wlr_box that specifies the top-left corner of the element
* relative to it's position, and the element's total width and height.
*/
static inline struct wlr_box wlmtk_element_get_dimensions_box(
wlmtk_element_t *element_ptr)
{
struct wlr_box box;
element_ptr->vmt.get_dimensions(
element_ptr, &box.x, &box.y, &box.width, &box.height);
box.width += box.x;
box.height += box.y;
return box;
}
/**
* Passes a pointer motion event on to the element.
*
* Will forward to @ref wlmtk_element_vmt_t::pointer_motion, and (depending on
* that return value) trigger @ref wlmtk_element_vmt_t::pointer_enter of
* @ref wlmtk_element_vmt_t::pointer_leave calls.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*/
bool wlmtk_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec);
/** Calls @ref wlmtk_element_vmt_t::pointer_button. */
static inline bool wlmtk_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
return element_ptr->vmt.pointer_button(element_ptr, button_event_ptr);
}
/** Calls @ref wlmtk_element_vmt_t::pointer_axis. */
static inline bool wlmtk_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
return element_ptr->vmt.pointer_axis(
element_ptr, wlr_pointer_axis_event_ptr);
}
/** Calls @ref wlmtk_element_vmt_t::keyboard_event. */
static inline bool wlmtk_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers)
{
return element_ptr->vmt.keyboard_event(
element_ptr, wlr_keyboard_key_event_ptr,
key_syms, key_syms_count, modifiers);
}
/**
* Virtual method: Calls the dtor of the element's implementation.
*
* The implementation is required to call @ref wlmtk_element_fini().
*
* @param element_ptr
*/
static inline void wlmtk_element_destroy(
wlmtk_element_t *element_ptr) {
element_ptr->vmt.destroy(element_ptr);
}
/** Unit tests for the element. */
extern const bs_test_case_t wlmtk_element_test_cases[];
/** Fake element, useful for unit test. */
typedef struct {
/** State of the element. */
wlmtk_element_t element;
/** Original VMT. */
wlmtk_element_vmt_t orig_vmt;
/** Dimensions of the fake element, in pixels. */
struct wlr_box dimensions;
/** Indicates @ref wlmtk_element_vmt_t::pointer_motion() was called. */
bool pointer_motion_called;
/** Indicates @ref wlmtk_element_vmt_t::pointer_enter() was called. */
bool pointer_enter_called;
/** Indicates @ref wlmtk_element_vmt_t::pointer_leave() was called. */
bool pointer_leave_called;
/** Indicates @ref wlmtk_element_vmt_t::pointer_button() was called. */
bool pointer_button_called;
/** Last button event received. */
wlmtk_button_event_t pointer_button_event;
/** Indicates @ref wlmtk_element_vmt_t::pointer_axis() was called. */
bool pointer_axis_called;
/** Indicates that @ref wlmtk_element_vmt_t::keyboard_event() was called. */
bool keyboard_event_called;
/** Last axis event received. */
struct wlr_pointer_axis_event wlr_pointer_axis_event;
} wlmtk_fake_element_t;
/**
* Ctor for the fake element, useful for tests.
*
* @return A pointer to @ref wlmtk_fake_element_t. Should be destroyed via
* @ref wlmtk_element_destroy, by passing the pointer to
* @ref wlmtk_fake_element_t::element as argument.
*/
wlmtk_fake_element_t *wlmtk_fake_element_create(void);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_ELEMENT_H__ */
/* == End of element.h ===================================================== */
wlmaker-0.3/src/toolkit/env.c 0000664 0000000 0000000 00000007014 14641446446 0016245 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file env.c
*
* @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.
*/
#include "env.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the environment. */
struct _wlmtk_env_t {
/** Points to a `wlr_cursor`. */
struct wlr_cursor *wlr_cursor_ptr;
/** Points to a `wlr_xcursor_manager`. */
struct wlr_xcursor_manager *wlr_xcursor_manager_ptr;
/** Points to a `wlr_seat`. */
struct wlr_seat *wlr_seat_ptr;
};
/** Struct to identify a @ref wlmtk_env_cursor_t with the xcursor name. */
typedef struct {
/** The cursor. */
wlmtk_env_cursor_t cursor;
/** And the xcursor name. */
const char *xcursor_name_ptr;
} wlmtk_env_cursor_lookup_t;
/** Lookup table for xcursor names. */
static const wlmtk_env_cursor_lookup_t _wlmtk_env_cursor_lookup[] = {
{ WLMTK_CURSOR_DEFAULT, "default" },
{ WLMTK_CURSOR_RESIZE_S, "s-resize" },
{ WLMTK_CURSOR_RESIZE_SE, "se-resize" },
{ WLMTK_CURSOR_RESIZE_SW, "sw-resize" },
{ 0, NULL },
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_env_t *wlmtk_env_create(
struct wlr_cursor *wlr_cursor_ptr,
struct wlr_xcursor_manager *wlr_xcursor_manager_ptr,
struct wlr_seat *wlr_seat_ptr)
{
wlmtk_env_t *env_ptr = logged_calloc(1, sizeof(wlmtk_env_t));
if (NULL == env_ptr) return NULL;
env_ptr->wlr_cursor_ptr = wlr_cursor_ptr;
env_ptr->wlr_xcursor_manager_ptr = wlr_xcursor_manager_ptr;
env_ptr->wlr_seat_ptr = wlr_seat_ptr;
return env_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_env_destroy(wlmtk_env_t *env_ptr)
{
free(env_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_env_set_cursor(wlmtk_env_t *env_ptr, wlmtk_env_cursor_t cursor)
{
const wlmtk_env_cursor_lookup_t *lookup_ptr = &_wlmtk_env_cursor_lookup[0];
for (;
NULL != lookup_ptr->xcursor_name_ptr && cursor != lookup_ptr->cursor;
++lookup_ptr) ;
if (NULL == lookup_ptr->xcursor_name_ptr) {
bs_log(BS_FATAL, "No name for cursor %d", cursor);
return;
}
if (NULL != env_ptr &&
NULL != env_ptr->wlr_cursor_ptr &&
NULL != env_ptr->wlr_xcursor_manager_ptr) {
wlr_cursor_set_xcursor(
env_ptr->wlr_cursor_ptr,
env_ptr->wlr_xcursor_manager_ptr,
lookup_ptr->xcursor_name_ptr);
}
}
/* ------------------------------------------------------------------------- */
struct wlr_seat *wlmtk_env_wlr_seat(wlmtk_env_t *env_ptr)
{
return env_ptr->wlr_seat_ptr;
}
/* == End of env.c ========================================================= */
wlmaker-0.3/src/toolkit/env.h 0000664 0000000 0000000 00000004326 14641446446 0016255 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file env.h
*
* @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.
*/
#ifndef __WLMTK_ENV_H__
#define __WLMTK_ENV_H__
/** Forward declaration: Environment. */
typedef struct _wlmtk_env_t wlmtk_env_t;
/** Forward declaration. */
struct wlr_cursor;
/** Forward declaration. */
struct wlr_seat;
/** Forward declaration. */
struct wlr_xcursor_manager;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Cursor types. */
typedef enum {
/** Default. */
WLMTK_CURSOR_DEFAULT,
/** Resizing, southern border. */
WLMTK_CURSOR_RESIZE_S,
/** Resizing, south-eastern corner. */
WLMTK_CURSOR_RESIZE_SE,
/** Resizing, south-western corner. */
WLMTK_CURSOR_RESIZE_SW,
} wlmtk_env_cursor_t;
/**
* Creates an environment state from the cursor.
*
* @param wlr_cursor_ptr
* @param wlr_xcursor_manager_ptr
* @param wlr_seat_ptr
*
* @return An environment state or NULL on error.
*/
wlmtk_env_t *wlmtk_env_create(
struct wlr_cursor *wlr_cursor_ptr,
struct wlr_xcursor_manager *wlr_xcursor_manager_ptr,
struct wlr_seat *wlr_seat_ptr);
/**
* Destroys the environment state.
*
* @param env_ptr
*/
void wlmtk_env_destroy(wlmtk_env_t *env_ptr);
/**
* Sets a cursor.
*
* @param env_ptr
* @param cursor
*/
void wlmtk_env_set_cursor(wlmtk_env_t *env_ptr, wlmtk_env_cursor_t cursor);
/**
* Returns the pointer to the wlr_seat.
*
* @param env_ptr
*/
struct wlr_seat *wlmtk_env_wlr_seat(wlmtk_env_t *env_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_ENV_H__ */
/* == End of env.h ========================================================= */
wlmaker-0.3/src/toolkit/fsm.c 0000664 0000000 0000000 00000006501 14641446446 0016242 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file fsm.c
* Event-driven finite state machine.
*
* @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.
*/
#include "fsm.h"
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
void wlmtk_fsm_init(
wlmtk_fsm_t *fsm_ptr,
const wlmtk_fsm_transition_t *transitions,
int initial_state)
{
fsm_ptr->transitions = transitions;
fsm_ptr->state = initial_state;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_fsm_event(
wlmtk_fsm_t *fsm_ptr,
int event,
void *ud_ptr)
{
for (const wlmtk_fsm_transition_t *transition_ptr = fsm_ptr->transitions;
0 <= transition_ptr->state;
++transition_ptr) {
if (transition_ptr->state == fsm_ptr->state &&
transition_ptr->event == event) {
bool rv = true;
if (NULL != transition_ptr->handler) {
rv = transition_ptr->handler(fsm_ptr, ud_ptr);
}
fsm_ptr->state = transition_ptr->to_state;
return rv;
}
}
return false;
}
/* == Unit tests =========================================================== */
static void test_event(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_fsm_test_cases[] = {
{ 1, "event", test_event },
{ 0, NULL, NULL }
};
/** Test handler for the FSM unit test: Sets the bool to true. */
static bool test_fsm_handler(__UNUSED__ wlmtk_fsm_t *fsm_ptr, void *ud_ptr) {
*((bool*)ud_ptr) = true;
return true;
}
/** Test transition table for the FSM unit test. */
static const wlmtk_fsm_transition_t test_transitions[] = {
{ 1, 100, 2, test_fsm_handler },
{ 2, 101, 3, NULL },
WLMTK_FSM_TRANSITION_SENTINEL
};
/* ------------------------------------------------------------------------- */
/** Tests FSM. */
void test_event(bs_test_t *test_ptr)
{
wlmtk_fsm_t fsm;
bool called = false;
wlmtk_fsm_init(&fsm, test_transitions, 1);
BS_TEST_VERIFY_EQ(test_ptr, 1, fsm.state);
// (1, 100) should trigger call to handler and move to (2).
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_fsm_event(&fsm, 100, &called));
BS_TEST_VERIFY_EQ(test_ptr, 2, fsm.state);
BS_TEST_VERIFY_TRUE(test_ptr, called);
called = false;
// (2, 100) is not defined. return false.
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_fsm_event(&fsm, 100, &called));
// (2, 101) is defined. No handler == no crash. moves to (3).
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_fsm_event(&fsm, 101, &called));
BS_TEST_VERIFY_EQ(test_ptr, 3, fsm.state);
BS_TEST_VERIFY_FALSE(test_ptr, called);
}
/* == End of fsm.c ========================================================= */
wlmaker-0.3/src/toolkit/fsm.h 0000664 0000000 0000000 00000005553 14641446446 0016255 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file fsm.h
* Event-driven finite state machine.
*
* @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.
*/
#ifndef __WLMTK_FSM_H__
#define __WLMTK_FSM_H__
#include
#include
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration. */
typedef struct _wlmtk_fsm_t wlmtk_fsm_t;
/** State machine definition. */
typedef struct {
/** State before receiving the event. */
int state;
/** Event. */
int event;
/** Upon having (state, event): State to transition to. */
int to_state;
/** Handler for the activity at (state, event). */
bool (*handler)(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
} wlmtk_fsm_transition_t;
/** Finite state machine. State. */
struct _wlmtk_fsm_t {
/** The transitions table. */
const wlmtk_fsm_transition_t *transitions;
/** Current state. */
int state;
};
/** Sentinel element for state transition table. */
#define WLMTK_FSM_TRANSITION_SENTINEL { \
.state = -1, \
.event = -1, \
.to_state = -1, \
.handler = NULL, \
}
/**
* Initializes the finite-state machine.
*
* @param fsm_ptr
* @param transitions
* @param initial_state
*/
void wlmtk_fsm_init(
wlmtk_fsm_t *fsm_ptr,
const wlmtk_fsm_transition_t *transitions,
int initial_state);
/**
* Handles an event for the finite-state machine.
*
* Will search for the transition matching (current state, event) and call the
* associate handler.
*
* @param fsm_ptr
* @param event
* @param ud_ptr
*
* @return If a matching transition was found: The return value of the
* associated handler (or true, if no handler was given). Otherwise,
* returns false.
*/
bool wlmtk_fsm_event(
wlmtk_fsm_t *fsm_ptr,
int event,
void *ud_ptr);
/** Unit tests for the finite-state machine. */
extern const bs_test_case_t wlmtk_fsm_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_FSM_H__ */
/* == End of fsm.h ====================================================== */
wlmaker-0.3/src/toolkit/gfxbuf.c 0000664 0000000 0000000 00000014305 14641446446 0016737 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file gfxbuf.c
*
* @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.
*/
#include "gfxbuf.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the wrapped graphics buffer. */
typedef struct {
/** The wlroots buffer. */
struct wlr_buffer wlr_buffer;
/** The actual graphics buffer. */
bs_gfxbuf_t *gfxbuf_ptr;
} wlmaker_gfxbuf_t;
static wlmaker_gfxbuf_t *wlmaker_gfxbuf_from_wlr_buffer(
struct wlr_buffer *wlr_buffer_ptr);
static void wlmaker_gfxbuf_impl_destroy(
struct wlr_buffer *wlr_buffer_ptr);
static bool wlmaker_gfxbuf_impl_begin_data_ptr_access(
struct wlr_buffer *wlr_buffer_ptr,
uint32_t flags,
void **data_ptr_ptr,
uint32_t *format_ptr,
size_t *stride_ptr);
static void wlmaker_gfxbuf_impl_end_data_ptr_access(
struct wlr_buffer *wlr_buffer_ptr);
/** Implementation callbacks for wlroots' `struct wlr_buffer`. */
static const struct wlr_buffer_impl wlmaker_gfxbuf_impl = {
.destroy = wlmaker_gfxbuf_impl_destroy,
.begin_data_ptr_access = wlmaker_gfxbuf_impl_begin_data_ptr_access,
.end_data_ptr_access = wlmaker_gfxbuf_impl_end_data_ptr_access
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
struct wlr_buffer *bs_gfxbuf_create_wlr_buffer(
unsigned width,
unsigned height)
{
wlmaker_gfxbuf_t *gfxbuf_ptr = logged_calloc(1, sizeof(wlmaker_gfxbuf_t));
if (NULL == gfxbuf_ptr) return NULL;
wlr_buffer_init(
&gfxbuf_ptr->wlr_buffer,
&wlmaker_gfxbuf_impl,
width,
height);
gfxbuf_ptr->gfxbuf_ptr = bs_gfxbuf_create(width, height);
if (NULL == gfxbuf_ptr->gfxbuf_ptr) {
wlmaker_gfxbuf_impl_destroy(&gfxbuf_ptr->wlr_buffer);
return NULL;
}
return &gfxbuf_ptr->wlr_buffer;
}
/* ------------------------------------------------------------------------- */
void wlr_buffer_drop_nullify(struct wlr_buffer **wlr_buffer_ptr_ptr)
{
if (NULL == *wlr_buffer_ptr_ptr) return;
wlr_buffer_drop(*wlr_buffer_ptr_ptr);
*wlr_buffer_ptr_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
bs_gfxbuf_t *bs_gfxbuf_from_wlr_buffer(
struct wlr_buffer *wlr_buffer_ptr)
{
wlmaker_gfxbuf_t *gfxbuf_ptr = wlmaker_gfxbuf_from_wlr_buffer(
wlr_buffer_ptr);
return gfxbuf_ptr->gfxbuf_ptr;
}
/* ------------------------------------------------------------------------- */
cairo_t *cairo_create_from_wlr_buffer(struct wlr_buffer *wlr_buffer_ptr)
{
return cairo_create_from_bs_gfxbuf(
bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr));
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Returns the @ref wlmaker_gfxbuf_t for `wlr_buffer_ptr`.
*
* @param wlr_buffer_ptr Pointer to a `struct wlr_buffer`. Must be a
* `wlr_buffer` that was previously created by
* @ref bs_gfxbuf_create_wlr_buffer.
*
* @return A pointer to the @ref wlmaker_gfxbuf_t.
*/
wlmaker_gfxbuf_t *wlmaker_gfxbuf_from_wlr_buffer(
struct wlr_buffer *wlr_buffer_ptr)
{
// Verifies this is indeed a graphics-buffer-backed WLR buffer. */
BS_ASSERT(0 == memcmp(
wlr_buffer_ptr->impl,
&wlmaker_gfxbuf_impl,
sizeof(struct wlr_buffer_impl)));
return BS_CONTAINER_OF(wlr_buffer_ptr, wlmaker_gfxbuf_t, wlr_buffer);
}
/* ------------------------------------------------------------------------- */
/**
* `struct wlr_buffer_impl` callback: Destroys the graphics buffer.
*
* This function Will be called only once producer and all consumers of the
* corresponding wlr_buffer have lifted their locks (references).
*
* @param wlr_buffer_ptr
*/
void wlmaker_gfxbuf_impl_destroy(
struct wlr_buffer *wlr_buffer_ptr)
{
wlmaker_gfxbuf_t *gfxbuf_ptr = wlmaker_gfxbuf_from_wlr_buffer(
wlr_buffer_ptr);
if (NULL != gfxbuf_ptr->gfxbuf_ptr) {
bs_gfxbuf_destroy(gfxbuf_ptr->gfxbuf_ptr);
gfxbuf_ptr->gfxbuf_ptr = NULL;
}
free(gfxbuf_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* `struct wlr_buffer_impl` callback: Set up for data access.
*
* @param wlr_buffer_ptr
* @param flags unused.
* @param data_ptr_ptr Output argument, point to the surface data.
* @param format_ptr Output argument, set to the surface's format.
* @param stride_ptr Output argument, set to the surface's stride.
*/
bool wlmaker_gfxbuf_impl_begin_data_ptr_access(
struct wlr_buffer *wlr_buffer_ptr,
__UNUSED__ uint32_t flags,
void **data_ptr_ptr,
uint32_t *format_ptr,
size_t *stride_ptr)
{
wlmaker_gfxbuf_t *gfxbuf_ptr = wlmaker_gfxbuf_from_wlr_buffer(
wlr_buffer_ptr);
*data_ptr_ptr = gfxbuf_ptr->gfxbuf_ptr->data_ptr;
*format_ptr = DRM_FORMAT_ARGB8888; // Equivalent to CAIRO ARGB32.
*stride_ptr =gfxbuf_ptr->gfxbuf_ptr->pixels_per_line * sizeof(uint32_t);
return true;
}
/* ------------------------------------------------------------------------- */
/** `struct wlr_buffer_impl` callback: End data access. Here, a no-op. */
void wlmaker_gfxbuf_impl_end_data_ptr_access(
__UNUSED__ struct wlr_buffer *wlr_buffer_ptr)
{
// Nothing to do.
}
/* == End of gfxbuf.c ====================================================== */
wlmaker-0.3/src/toolkit/gfxbuf.h 0000664 0000000 0000000 00000005434 14641446446 0016747 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file gfxbuf.h
*
* @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.
*/
#ifndef __WLMTK_GFXBUF_H__
#define __WLMTK_GFXBUF_H__
#include
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a wlroots buffer tied to a libbase graphics buffer.
*
* This creates a libbase graphics buffer, and wraps it as `struct wlr_buffer`.
*
* @param width
* @param height
*
* @return A struct wlr_buffer. Must be released using wlr_buffer_drop().
*/
struct wlr_buffer *bs_gfxbuf_create_wlr_buffer(
unsigned width,
unsigned height);
/**
* Drops a WLR buffer, and sets the pointer to NULL.
*
* @param wlr_buffer_ptr_ptr Points to a pointer to a WLR buffer. The pointer
* to the WLR buffer may be NULL; in that case, the
* call is a no-op.
*/
void wlr_buffer_drop_nullify(struct wlr_buffer **wlr_buffer_ptr_ptr);
/**
* Returns the libbase graphics buffer for the `struct wlr_buffer`.
*
* @param wlr_buffer_ptr Pointer to a `struct wlr_buffer`. Must be a
* `wlr_buffer` that was previously created by
* @ref bs_gfxbuf_create_wlr_buffer.
*
* @return Pointer to the libbase graphics buffer. The `wlr_buffer_ptr` must
* outlive the `bs_gfxbuf_t*`. Must not be destroyed.
*/
bs_gfxbuf_t *bs_gfxbuf_from_wlr_buffer(struct wlr_buffer *wlr_buffer_ptr);
/**
* Returns a `cairo_t` for the WLR buffer backed by a libbase graphics buffer.
*
* @param wlr_buffer_ptr Pointer to a `struct wlr_buffer`. Must be a
* `wlr_buffer` that was previously created by
* @ref bs_gfxbuf_create_wlr_buffer.
*
* @return Pointer to the the cairo. The `wlr_buffer_ptr` must outlive the
* `cairo_t*`. It must be destroyed using `cairo_destroy`.
*/
cairo_t *cairo_create_from_wlr_buffer(struct wlr_buffer *wlr_buffer_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_GFXBUF_H__ */
/* == End of gfxbuf.h ====================================================== */
wlmaker-0.3/src/toolkit/image.c 0000664 0000000 0000000 00000012500 14641446446 0016533 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file image.c
* Copyright (c) 2024 by Philipp Kaeser
*/
#include "image.h"
#include "buffer.h"
#include "gfxbuf.h"
/* == Declarations ========================================================= */
/** State of the image. */
struct _wlmtk_image_t {
/** The image's superclass: A buffer. */
wlmtk_buffer_t super_buffer;
};
struct wlr_buffer *_wlmtk_image_create_wlr_buffer_from_image(
const char *path_ptr);
static void _wlmtk_image_element_destroy(wlmtk_element_t *element_ptr);
/* == Data ================================================================= */
/** The imag'es virtual method table for @ref wlmtk_element_t superclass. */
static const wlmtk_element_vmt_t _wlmtk_image_element_vmt = {
.destroy = _wlmtk_image_element_destroy,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_image_t *wlmtk_image_create(
const char *image_path_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_image_t *image_ptr = logged_calloc(1, sizeof(wlmtk_image_t));
if (NULL == image_ptr) return NULL;
if (!wlmtk_buffer_init(&image_ptr->super_buffer, env_ptr)) {
wlmtk_image_destroy(image_ptr);
return NULL;
}
wlmtk_element_extend(
wlmtk_image_element(image_ptr),
&_wlmtk_image_element_vmt);
struct wlr_buffer *wlr_buffer_ptr =
_wlmtk_image_create_wlr_buffer_from_image(image_path_ptr);
if (NULL == wlr_buffer_ptr) {
wlmtk_image_destroy(image_ptr);
return NULL;
}
wlmtk_buffer_set(&image_ptr->super_buffer, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
return image_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_image_destroy(wlmtk_image_t *image_ptr)
{
wlmtk_buffer_fini(&image_ptr->super_buffer);
free(image_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_image_element(wlmtk_image_t *image_ptr)
{
return wlmtk_buffer_element(&image_ptr->super_buffer);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Creates a wlr_buffer that holds the image loaded from path, at that image's
* size.
*
* @param path_ptr
*
* @return the wlr_buffer or NULL on error.
*/
struct wlr_buffer *_wlmtk_image_create_wlr_buffer_from_image(
const char *path_ptr)
{
cairo_surface_t *icon_surface_ptr = cairo_image_surface_create_from_png(
path_ptr);
if (NULL == icon_surface_ptr) {
bs_log(BS_ERROR, "Failed cairo_image_surface_create_from_png(%s).",
path_ptr);
return false;
}
if (CAIRO_STATUS_SUCCESS != cairo_surface_status(icon_surface_ptr)) {
bs_log(BS_ERROR,
"Bad surface after cairo_image_surface_create_from_png(%s): %s",
path_ptr,
cairo_status_to_string(cairo_surface_status(icon_surface_ptr)));
cairo_surface_destroy(icon_surface_ptr);
return NULL;
}
int w = cairo_image_surface_get_width(icon_surface_ptr);
int h = cairo_image_surface_get_height(icon_surface_ptr);
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(w, h);
if (NULL == wlr_buffer_ptr) {
cairo_surface_destroy(icon_surface_ptr);
return NULL;
}
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
cairo_surface_destroy(icon_surface_ptr);
return NULL;
}
cairo_set_source_surface(cairo_ptr, icon_surface_ptr, 0, 0);
cairo_rectangle(cairo_ptr, 0, 0, w, h);
cairo_fill(cairo_ptr);
cairo_stroke(cairo_ptr);
cairo_destroy(cairo_ptr);
cairo_surface_destroy(icon_surface_ptr);
return wlr_buffer_ptr;
}
/* ------------------------------------------------------------------------- */
/** Implements @ref wlmtk_element_vmt_t::destroy -- virtual dtor. */
void _wlmtk_image_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_image_t *image_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_image_t, super_buffer.super_element);
wlmtk_image_destroy(image_ptr);
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_image_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises ctor and dtor. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_image_t *image_ptr = wlmtk_image_create(
bs_test_resolve_path("toolkit/test_icon.png"), NULL);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, image_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(image_ptr->super_buffer.wlr_buffer_ptr),
"toolkit/test_icon.png");
BS_TEST_VERIFY_EQ(
test_ptr,
&image_ptr->super_buffer.super_element,
wlmtk_image_element(image_ptr));
wlmtk_image_destroy(image_ptr);
}
/* == End of image.c ======================================================= */
wlmaker-0.3/src/toolkit/image.h 0000664 0000000 0000000 00000003307 14641446446 0016545 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file image.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_IMAGE_H__
#define __WLMTK_IMAGE_H__
#include
#include "element.h"
#include "env.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: State of a toolkit image. */
typedef struct _wlmtk_image_t wlmtk_image_t;
/**
* Creates a toolkit image: An element showing the image.
*
* @param image_path_ptr
* @param env_ptr
*
* @return Pointer to the toolkit image, or NULL on error.
*/
wlmtk_image_t *wlmtk_image_create(
const char *image_path_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the toolkit image.
*
* @param image_ptr
*/
void wlmtk_image_destroy(wlmtk_image_t *image_ptr);
/** @return the parent @ref wlmtk_element_t of `image_ptr`. */
wlmtk_element_t *wlmtk_image_element(wlmtk_image_t *image_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_image_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __IMAGE_H__ */
/* == End of image.h ================================================== */
wlmaker-0.3/src/toolkit/input.h 0000664 0000000 0000000 00000003176 14641446446 0016626 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file input.h
*
* @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.
*/
#ifndef __WLMTK_INPUT_H__
#define __WLMTK_INPUT_H__
// BTN_LEFT, BTN_RIGHT, ...
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Button event. */
typedef struct _wlmtk_button_event_t wlmtk_button_event_t;
/** Button state. */
typedef enum {
WLMTK_BUTTON_DOWN,
WLMTK_BUTTON_UP,
WLMTK_BUTTON_CLICK,
WLMTK_BUTTON_DOUBLE_CLICK,
} wlmtk_button_event_type_t;
/** Button events. */
struct _wlmtk_button_event_t {
/** Button for which the event applies: linux/input-event-codes.h */
uint32_t button;
/** Type of the event: DOWN, UP, ... */
wlmtk_button_event_type_t type;
/** Time of the button event, in milliseconds. */
uint32_t time_msec;
};
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_INPUT_H__ */
/* == End of input.h ======================================================= */
wlmaker-0.3/src/toolkit/layer.c 0000664 0000000 0000000 00000022637 14641446446 0016601 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer.c
*
* @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.
*/
#include "layer.h"
#include "container.h"
#include
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of a layer. */
struct _wlmtk_layer_t {
/** Super class of the layer. */
wlmtk_container_t super_container;
/** Workspace that the layer belongs to. */
wlmtk_workspace_t *workspace_ptr;
/** Panels, holds nodes at @ref wlmtk_panel_t::dlnode. */
bs_dllist_t panels;
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_layer_t *wlmtk_layer_create(wlmtk_env_t *env_ptr)
{
wlmtk_layer_t *layer_ptr = logged_calloc(1, sizeof(wlmtk_layer_t));
if (NULL == layer_ptr) return NULL;
if (!wlmtk_container_init(&layer_ptr->super_container, env_ptr)) {
wlmtk_layer_destroy(layer_ptr);
return NULL;
}
return layer_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_layer_destroy(wlmtk_layer_t *layer_ptr)
{
wlmtk_container_fini(&layer_ptr->super_container);
free(layer_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_layer_element(wlmtk_layer_t *layer_ptr)
{
return &layer_ptr->super_container.super_element;
}
/* ------------------------------------------------------------------------- */
void wlmtk_layer_add_panel(wlmtk_layer_t *layer_ptr,
wlmtk_panel_t *panel_ptr)
{
BS_ASSERT(NULL == wlmtk_panel_get_layer(panel_ptr));
wlmtk_container_add_element(
&layer_ptr->super_container,
wlmtk_panel_element(panel_ptr));
wlmtk_panel_set_layer(panel_ptr, layer_ptr);
bs_dllist_push_back(
&layer_ptr->panels,
wlmtk_dlnode_from_panel(panel_ptr));
wlmtk_layer_reconfigure(layer_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_layer_remove_panel(wlmtk_layer_t *layer_ptr,
wlmtk_panel_t *panel_ptr)
{
BS_ASSERT(layer_ptr == wlmtk_panel_get_layer(panel_ptr));
bs_dllist_remove(
&layer_ptr->panels,
wlmtk_dlnode_from_panel(panel_ptr));
wlmtk_panel_set_layer(panel_ptr, NULL);
wlmtk_container_remove_element(
&layer_ptr->super_container,
wlmtk_panel_element(panel_ptr));
wlmtk_layer_reconfigure(layer_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_layer_reconfigure(wlmtk_layer_t *layer_ptr)
{
struct wlr_box extents = wlmtk_workspace_get_fullscreen_extents(
layer_ptr->workspace_ptr);
struct wlr_box usable_area = extents;
for (bs_dllist_node_t *dlnode_ptr = layer_ptr->panels.head_ptr;
dlnode_ptr != NULL;
dlnode_ptr = dlnode_ptr->next_ptr) {
wlmtk_panel_t *panel_ptr = wlmtk_panel_from_dlnode(dlnode_ptr);
struct wlr_box new_usable_area = usable_area;
struct wlr_box panel_dimensions = wlmtk_panel_compute_dimensions(
panel_ptr, &extents, &new_usable_area);
if (wlmtk_panel_element(panel_ptr)->visible) {
usable_area = new_usable_area;
}
wlmtk_panel_request_size(
panel_ptr,
panel_dimensions.width,
panel_dimensions.height);
wlmtk_element_set_position(
wlmtk_panel_element(panel_ptr),
panel_dimensions.x,
panel_dimensions.y);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_layer_set_workspace(wlmtk_layer_t *layer_ptr,
wlmtk_workspace_t *workspace_ptr)
{
layer_ptr->workspace_ptr = workspace_ptr;
}
/* == Local (static) methods =============================================== */
/* == Unit tests =========================================================== */
static void test_add_remove(bs_test_t *test_ptr);
static void test_layout(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_layer_test_cases[] = {
{ 1, "add_remove", test_add_remove },
{ 1, "layout", test_layout },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises the panel add & remove methods. */
void test_add_remove(bs_test_t *test_ptr)
{
wlmtk_layer_t *layer_ptr = BS_ASSERT_NOTNULL(wlmtk_layer_create(NULL));
wlmtk_fake_workspace_t *fake_workspace_ptr = BS_ASSERT_NOTNULL(
wlmtk_fake_workspace_create(1024, 768));
wlmtk_layer_set_workspace(layer_ptr, fake_workspace_ptr->workspace_ptr);
wlmtk_panel_positioning_t pos = {
.desired_width = 100,
.desired_height = 50
};
wlmtk_fake_panel_t *fake_panel_ptr = BS_ASSERT_NOTNULL(
wlmtk_fake_panel_create(&pos));
BS_TEST_VERIFY_EQ(test_ptr, 0, fake_panel_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 0, fake_panel_ptr->requested_height);
// Adds the panel. Triggers a 'compute_dimensions' call and then calls
// into wlmtk_panel_request_size.
wlmtk_layer_add_panel(layer_ptr, &fake_panel_ptr->panel);
BS_TEST_VERIFY_EQ(
test_ptr, layer_ptr,
wlmtk_panel_get_layer(&fake_panel_ptr->panel));
BS_TEST_VERIFY_EQ(test_ptr, 100, fake_panel_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 50, fake_panel_ptr->requested_height);
wlmtk_layer_remove_panel(layer_ptr, &fake_panel_ptr->panel);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_panel_get_layer(&fake_panel_ptr->panel));
wlmtk_fake_panel_destroy(fake_panel_ptr);
wlmtk_layer_set_workspace(layer_ptr, NULL);
wlmtk_fake_workspace_destroy(fake_workspace_ptr);
wlmtk_layer_destroy(layer_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests panel layout with multiple panels. */
void test_layout(bs_test_t *test_ptr)
{
wlmtk_layer_t *layer_ptr = BS_ASSERT_NOTNULL(wlmtk_layer_create(NULL));
wlmtk_fake_workspace_t *fake_workspace_ptr = BS_ASSERT_NOTNULL(
wlmtk_fake_workspace_create(1024, 768));
wlmtk_layer_set_workspace(layer_ptr, fake_workspace_ptr->workspace_ptr);
// Adds a left-bounded panel with an exclusive zone.
wlmtk_panel_positioning_t pos = {
.desired_width = 100,
.desired_height = 50,
.exclusive_zone = 40,
.anchor = WLR_EDGE_LEFT
};
wlmtk_fake_panel_t *fp1_ptr = wlmtk_fake_panel_create(&pos);
BS_ASSERT_NOTNULL(fp1_ptr);
wlmtk_element_set_visible(wlmtk_panel_element(&fp1_ptr->panel), true);
wlmtk_layer_add_panel(layer_ptr, &fp1_ptr->panel);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_panel_element(&fp1_ptr->panel)->x);
BS_TEST_VERIFY_EQ(test_ptr, 359, wlmtk_panel_element(&fp1_ptr->panel)->y);
BS_TEST_VERIFY_EQ(test_ptr, 100, fp1_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 50, fp1_ptr->requested_height);
// Next panel is to respect the exclusive zone. It is invisible => later
// panels won't shift, but it still will be positioned.
pos.anchor = WLR_EDGE_LEFT | WLR_EDGE_TOP | WLR_EDGE_BOTTOM;
pos.desired_height = 0;
wlmtk_fake_panel_t *fp2_ptr = wlmtk_fake_panel_create(&pos);
wlmtk_element_set_visible(wlmtk_panel_element(&fp2_ptr->panel), false);
BS_ASSERT_NOTNULL(fp2_ptr);
wlmtk_layer_add_panel(layer_ptr, &fp2_ptr->panel);
BS_TEST_VERIFY_EQ(test_ptr, 40, wlmtk_panel_element(&fp2_ptr->panel)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_panel_element(&fp2_ptr->panel)->y);
BS_TEST_VERIFY_EQ(test_ptr, 100, fp2_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 768, fp2_ptr->requested_height);
// Next panel: Same size and position, since the former is invisible.
wlmtk_fake_panel_t *fp3_ptr = wlmtk_fake_panel_create(&pos);
wlmtk_element_set_visible(wlmtk_panel_element(&fp3_ptr->panel), true);
BS_ASSERT_NOTNULL(fp3_ptr);
wlmtk_layer_add_panel(layer_ptr, &fp3_ptr->panel);
BS_TEST_VERIFY_EQ(test_ptr, 40, wlmtk_panel_element(&fp3_ptr->panel)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_panel_element(&fp3_ptr->panel)->y);
BS_TEST_VERIFY_EQ(test_ptr, 100, fp3_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 768, fp3_ptr->requested_height);
wlmtk_layer_remove_panel(layer_ptr, &fp3_ptr->panel);
wlmtk_fake_panel_destroy(fp3_ptr);
wlmtk_layer_remove_panel(layer_ptr, &fp2_ptr->panel);
wlmtk_fake_panel_destroy(fp2_ptr);
wlmtk_layer_remove_panel(layer_ptr, &fp1_ptr->panel);
wlmtk_fake_panel_destroy(fp1_ptr);
wlmtk_layer_set_workspace(layer_ptr, NULL);
wlmtk_fake_workspace_destroy(fake_workspace_ptr);
wlmtk_layer_destroy(layer_ptr);
}
/* == End of layer.c ======================================================= */
wlmaker-0.3/src/toolkit/layer.h 0000664 0000000 0000000 00000005534 14641446446 0016603 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file layer.h
*
* @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.
*/
#ifndef __WLMTK_LAYER_H__
#define __WLMTK_LAYER_H__
/** Forward declaration: Layer state. */
typedef struct _wlmtk_layer_t wlmtk_layer_t;
#include "element.h"
#include "env.h"
#include "panel.h"
#include "workspace.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a layer. Layers contain panels, such as layer shells.
*
* @param env_ptr
*
* @return Pointer to the layer handle or NULL on error.
*/
wlmtk_layer_t *wlmtk_layer_create(wlmtk_env_t *env_ptr);
/**
* Destroys the layer.
*
* @param layer_ptr
*/
void wlmtk_layer_destroy(wlmtk_layer_t *layer_ptr);
/** @return Pointer to super @ref wlmtk_element_t of the layer. */
wlmtk_element_t *wlmtk_layer_element(wlmtk_layer_t *layer_ptr);
/**
* Adds the panel to the layer. This will trigger an update to the layer's
* layout, and a call to request_size of each panel.
*
* @param layer_ptr
* @param panel_ptr
*/
void wlmtk_layer_add_panel(wlmtk_layer_t *layer_ptr,
wlmtk_panel_t *panel_ptr);
/**
* Removes the panel from the layer.
*
* @param layer_ptr
* @param panel_ptr
*/
void wlmtk_layer_remove_panel(wlmtk_layer_t *layer_ptr,
wlmtk_panel_t *panel_ptr);
/**
* Calls @ref wlmtk_panel_compute_dimensions for each contained panel.
*
* The Wayland protocol spells it is 'undefined' how panels (layer shells)
* are stacked and configured within a layer. For wlmaker, we'll configure
* the panels in sequence as they were added (found in the container, back
* to front).
*
* @param layer_ptr
*/
void wlmtk_layer_reconfigure(wlmtk_layer_t *layer_ptr);
/**
* Sets the parent workspace for the layer.
*
* Should only be called from @ref wlmtk_workspace_t methods.
*
* @param layer_ptr
* @param workspace_ptr NULL to clear the workspace reference.
*/
void wlmtk_layer_set_workspace(wlmtk_layer_t *layer_ptr,
wlmtk_workspace_t *workspace_ptr);
/** Layer unit test. */
extern const bs_test_case_t wlmtk_layer_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_LAYER_H__ */
/* == End of layer.h ======================================================= */
wlmaker-0.3/src/toolkit/lock.c 0000664 0000000 0000000 00000037465 14641446446 0016422 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file lock.c
*
* @copyright
* Copyright 2024 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.
*/
#include "lock.h"
#include "container.h"
#include "surface.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** Forward declaration: Lock surface. */
typedef struct _wlmtk_lock_surface_t wlmtk_lock_surface_t;
/** State of the session lock. */
struct _wlmtk_lock_t {
/** The wlroots session lock. */
struct wlr_session_lock_v1 *wlr_session_lock_v1_ptr;
/** The root this lock is applied for. */
wlmtk_root_t *root_ptr;
/** List of surfaces, via @ref wlmtk_lock_surface_t::dlnode. */
bs_dllist_t lock_surfaces;
/** Container holding the lock surfaces. */
wlmtk_container_t container;
/** Listener for the `new_surface` signal of `wlr_session_lock_v1`. */
struct wl_listener new_surface_listener;
/** Listener for the `unlock` signal of `wlr_session_lock_v1`. */
struct wl_listener unlock_listener;
/** Listener for the `destroy` signal of `wlr_session_lock_v1`. */
struct wl_listener destroy_listener;
};
/** State of a lock surface. */
struct _wlmtk_lock_surface_t {
/** The wlroots session lock surface. */
struct wlr_session_lock_surface_v1 *wlr_session_lock_surface_v1_ptr;
/** Toolkit surface for the associated wl_surface. */
wlmtk_surface_t *wlmtk_surface_ptr;
/** Back-link to the lock. */
wlmtk_lock_t *lock_ptr;
/** Link node, element of @ref wlmtk_lock_t::lock_surfaces. */
bs_dllist_node_t dlnode;
/** Serial returned by `wlr_session_lock_surface_v1_configure`. */
uint32_t configure_serial;
/** Listener for the `destroy` signal of `wlr_session_lock_surface_v1`. */
struct wl_listener destroy_listener;
/** Listener for `commit` signal of `wlr_session_lock_surface_v1::surface`. */
struct wl_listener surface_commit_listener;
};
static void _wlmtk_lock_report_surface_locked(
wlmtk_lock_t *lock_ptr,
wlmtk_lock_surface_t *lock_surface_ptr);
static void _wlmtk_lock_handle_new_surface(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_lock_handle_unlock(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_lock_handle_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static wlmtk_lock_surface_t *_wlmtk_lock_surface_create(
struct wlr_session_lock_surface_v1 *wlr_session_lock_surface_v1_ptr,
wlmtk_lock_t *lock_ptr);
static void _wlmtk_lock_surface_destroy(
wlmtk_lock_surface_t *lock_surface_ptr);
static void _wlmtk_lock_surface_dlnode_destroy(
bs_dllist_node_t *dlnode_ptr, void *ud_ptr);
static bool _wlmtk_lock_surface_has_wlr_output(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr);
static void _wlmtk_lock_surface_handle_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_lock_surface_handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_lock_t *wlmtk_lock_create(
struct wlr_session_lock_v1 *wlr_session_lock_v1_ptr,
wlmtk_root_t *root_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_lock_t *lock_ptr = logged_calloc(1, sizeof(wlmtk_lock_t));
if (NULL == lock_ptr) return NULL;
lock_ptr->wlr_session_lock_v1_ptr = wlr_session_lock_v1_ptr;
lock_ptr->root_ptr = root_ptr;
if (!wlmtk_container_init(&lock_ptr->container, env_ptr)) {
wlmtk_lock_destroy(lock_ptr);
return NULL;
}
wlmtk_element_set_visible(&lock_ptr->container.super_element, true);
wlmtk_util_connect_listener_signal(
&lock_ptr->wlr_session_lock_v1_ptr->events.new_surface,
&lock_ptr->new_surface_listener,
_wlmtk_lock_handle_new_surface);
wlmtk_util_connect_listener_signal(
&lock_ptr->wlr_session_lock_v1_ptr->events.unlock,
&lock_ptr->unlock_listener,
_wlmtk_lock_handle_unlock);
wlmtk_util_connect_listener_signal(
&lock_ptr->wlr_session_lock_v1_ptr->events.destroy,
&lock_ptr->destroy_listener,
_wlmtk_lock_handle_destroy);
return lock_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_lock_destroy(wlmtk_lock_t *lock_ptr)
{
bs_dllist_for_each(
&lock_ptr->lock_surfaces, _wlmtk_lock_surface_dlnode_destroy, NULL);
wl_list_remove(&lock_ptr->destroy_listener.link);
wl_list_remove(&lock_ptr->unlock_listener.link);
wl_list_remove(&lock_ptr->new_surface_listener.link);
wlmtk_root_lock_unreference(lock_ptr->root_ptr, lock_ptr);
wlmtk_container_fini(&lock_ptr->container);
free(lock_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_lock_element(wlmtk_lock_t *lock_ptr)
{
return &lock_ptr->container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Registers the provided surface as 'locked'. Locks the session, if all
* outputs have been locked.
*
* @param lock_ptr
* @param lock_surface_ptr
*/
void _wlmtk_lock_report_surface_locked(
wlmtk_lock_t *lock_ptr,
wlmtk_lock_surface_t *lock_surface_ptr)
{
// Guard clause: Don't add the surface if already reported.
if (bs_dllist_contains(
&lock_ptr->lock_surfaces, &lock_surface_ptr->dlnode)) return;
// Another guard: Don't accept the same output twice.
if (bs_dllist_find(
&lock_ptr->lock_surfaces,
_wlmtk_lock_surface_has_wlr_output,
lock_surface_ptr->wlr_session_lock_surface_v1_ptr->output)) {
bs_log(BS_WARNING, "Extra lock surface detected for wlr_output %p",
lock_surface_ptr->wlr_session_lock_surface_v1_ptr->output);
wl_resource_post_error(
lock_surface_ptr->wlr_session_lock_surface_v1_ptr->resource,
WL_DISPLAY_ERROR_INVALID_METHOD,
"Extra lock surface detected for wlr_output %p",
lock_surface_ptr->wlr_session_lock_surface_v1_ptr->output);
return;
}
bs_dllist_push_back(&lock_ptr->lock_surfaces, &lock_surface_ptr->dlnode);
wlmtk_container_add_element(
&lock_ptr->container,
wlmtk_surface_element(lock_surface_ptr->wlmtk_surface_ptr));
wlmtk_element_set_visible(
wlmtk_surface_element(lock_surface_ptr->wlmtk_surface_ptr), true);
// If not all outputs are covered: No lock yet.
// FIXME
/* if (bs_dllist_size(&lock_ptr->lock_surfaces) < */
/* bs_dllist_size(&lock_ptr->lock_mgr_ptr->server_ptr->outputs)) return; */
if (!wlmtk_root_lock(lock_ptr->root_ptr, lock_ptr)) {
wl_resource_post_error(
lock_surface_ptr->wlr_session_lock_surface_v1_ptr->resource,
WL_DISPLAY_ERROR_INVALID_METHOD,
"Failed wlmtk_root_lock(%p, %p): Already locked?",
lock_ptr->root_ptr, lock_ptr);
return;
}
__UNUSED__ wlmtk_lock_surface_t *first_surface_ptr = BS_CONTAINER_OF(
lock_ptr->lock_surfaces.head_ptr, wlmtk_lock_surface_t, dlnode);
wlmtk_root_set_lock_surface(
lock_ptr->root_ptr,
first_surface_ptr->wlmtk_surface_ptr);
// Root is locked. Send confirmation to the client.
wlr_session_lock_v1_send_locked(lock_ptr->wlr_session_lock_v1_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `new_surface` signal of `wlr_session_lock_v1`: Creates the
* associated surface and enables it on the screenlock container.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_lock_handle_new_surface(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmtk_lock_t *lock_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_lock_t, new_surface_listener);
struct wlr_session_lock_surface_v1 *wlr_session_lock_surface_v1_ptr =
data_ptr;
wlmtk_lock_surface_t *lock_surface_ptr = _wlmtk_lock_surface_create(
wlr_session_lock_surface_v1_ptr,
lock_ptr);
if (NULL == lock_surface_ptr) {
wl_resource_post_error(
wlr_session_lock_surface_v1_ptr->resource,
WL_DISPLAY_ERROR_NO_MEMORY,
"Failed _wlmtk_lock_surface_create(%p, %p)",
wlr_session_lock_surface_v1_ptr->surface,
lock_ptr);
return;
}
bs_log(BS_INFO, "Lock %p: New lock surface %p", lock_ptr, lock_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `unlock` signal of `wlr_session_lock_v1`: Marks the session
* as unlocked.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_lock_handle_unlock(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
__UNUSED__ wlmtk_lock_t *lock_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_lock_t, unlock_listener);
wlmtk_root_unlock(lock_ptr->root_ptr, lock_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of `wlr_session_lock_v1`: Destroy the lock.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_lock_handle_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_lock_t *lock_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_lock_t, destroy_listener);
wlmtk_lock_destroy(lock_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Creates a lock surface.
*
* @param wlr_session_lock_surface_v1_ptr
* @param lock_ptr
*
* @return The lock surface or NULL on error.
*/
wlmtk_lock_surface_t *_wlmtk_lock_surface_create(
struct wlr_session_lock_surface_v1 *wlr_session_lock_surface_v1_ptr,
wlmtk_lock_t *lock_ptr)
{
// Guard clause: We expect the output to be set.
if (NULL == wlr_session_lock_surface_v1_ptr->output) {
bs_log(BS_ERROR, "Session lock surface %p does not have an output!",
wlr_session_lock_surface_v1_ptr);
return NULL;
}
wlmtk_lock_surface_t *lock_surface_ptr = logged_calloc(
1, sizeof(wlmtk_lock_surface_t));
if (NULL == lock_surface_ptr) return NULL;
lock_surface_ptr->wlr_session_lock_surface_v1_ptr =
wlr_session_lock_surface_v1_ptr;
lock_surface_ptr->lock_ptr = lock_ptr;
lock_surface_ptr->wlmtk_surface_ptr = wlmtk_surface_create(
wlr_session_lock_surface_v1_ptr->surface,
wlmtk_lock_element(lock_ptr)->env_ptr);
if (NULL == lock_surface_ptr->wlmtk_surface_ptr) {
bs_log(BS_ERROR, "Failed wlmtk_surface_create(%p, %p)",
wlr_session_lock_surface_v1_ptr->surface,
wlmtk_lock_element(lock_ptr)->env_ptr);
_wlmtk_lock_surface_destroy(lock_surface_ptr);
return NULL;
}
wlmtk_util_connect_listener_signal(
&lock_surface_ptr->wlr_session_lock_surface_v1_ptr->events.destroy,
&lock_surface_ptr->destroy_listener,
_wlmtk_lock_surface_handle_destroy);
wlmtk_util_connect_listener_signal(
&lock_surface_ptr->wlr_session_lock_surface_v1_ptr->surface->events.commit,
&lock_surface_ptr->surface_commit_listener,
_wlmtk_lock_surface_handle_surface_commit);
lock_surface_ptr->configure_serial = wlr_session_lock_surface_v1_configure(
lock_surface_ptr->wlr_session_lock_surface_v1_ptr,
wlr_session_lock_surface_v1_ptr->output->width,
wlr_session_lock_surface_v1_ptr->output->height);
return lock_surface_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Destroys the lock surface.
*
* @param lock_surface_ptr
*/
void _wlmtk_lock_surface_destroy(wlmtk_lock_surface_t *lock_surface_ptr)
{
if (bs_dllist_contains(&lock_surface_ptr->lock_ptr->lock_surfaces,
&lock_surface_ptr->dlnode)) {
bs_dllist_remove(&lock_surface_ptr->lock_ptr->lock_surfaces,
&lock_surface_ptr->dlnode);
wlmtk_container_remove_element(
&lock_surface_ptr->lock_ptr->container,
wlmtk_surface_element(lock_surface_ptr->wlmtk_surface_ptr));
}
wl_list_remove(&lock_surface_ptr->surface_commit_listener.link);
wl_list_remove(&lock_surface_ptr->destroy_listener.link);
if (NULL != lock_surface_ptr->wlmtk_surface_ptr) {
wlmtk_surface_destroy(lock_surface_ptr->wlmtk_surface_ptr);
lock_surface_ptr->wlmtk_surface_ptr = NULL;
}
free(lock_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Callback for `bs_dllist_for_each` to destroy all lock surfaces. */
void _wlmtk_lock_surface_dlnode_destroy(
bs_dllist_node_t *dlnode_ptr, __UNUSED__ void *ud_ptr)
{
wlmtk_lock_surface_t *lock_surface_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmtk_lock_surface_t, dlnode);
_wlmtk_lock_surface_destroy(lock_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Returns whether the surface at dlnode_ptr has wlr_output == ud_ptr. */
bool _wlmtk_lock_surface_has_wlr_output(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr)
{
wlmtk_lock_surface_t *lock_surface_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmtk_lock_surface_t, dlnode);
return lock_surface_ptr->wlr_session_lock_surface_v1_ptr->output == ud_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of `wlr_session_lock_surface_v1`: Destroy
* the surface.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_lock_surface_handle_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_lock_surface_t *lock_surface_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_lock_surface_t, destroy_listener);
_wlmtk_lock_surface_destroy(lock_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `commit` signal of `wlr_session_lock_surface_v1::surface`.
*
* Checks whether the serial is at-or-above the 'configure' serial, and
* reports the surface and output as locked. Once all surfaces are locked,
* a 'send_locked' event will be sent.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_lock_surface_handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr)
{
wlmtk_lock_surface_t *lock_surface_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_lock_surface_t, surface_commit_listener);
struct wlr_session_lock_surface_v1 *wlr_session_lock_surface_v1_ptr =
wlr_session_lock_surface_v1_try_from_wlr_surface(data_ptr);
// Do not accept locking for commits before the requested configuration.
if (wlr_session_lock_surface_v1_ptr->current.configure_serial >=
lock_surface_ptr->configure_serial) {
_wlmtk_lock_report_surface_locked(
lock_surface_ptr->lock_ptr, lock_surface_ptr);
}
}
/* == End of lock.c ======================================================== */
wlmaker-0.3/src/toolkit/lock.h 0000664 0000000 0000000 00000003333 14641446446 0016412 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file lock.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_LOCK_H__
#define __WLMTK_LOCK_H__
/** Forward declaration: Lock. */
typedef struct _wlmtk_lock_t wlmtk_lock_t;
#include "element.h"
#include "root.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Session lock handle. */
struct wlr_session_lock_v1;
/**
* Creates a session lock handle.
*
* @param wlr_session_lock_v1_ptr
* @param root_ptr
* @param env_ptr
*
* @return The lock handle or NULL on error.
*/
wlmtk_lock_t *wlmtk_lock_create(
struct wlr_session_lock_v1 *wlr_session_lock_v1_ptr,
wlmtk_root_t *root_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the session lock handle.
*
* @param lock_ptr
*/
void wlmtk_lock_destroy(wlmtk_lock_t *lock_ptr);
/**
* @returns Pointer to @ref wlmtk_element_t of @ref wlmtk_lock_t::container.
* */
wlmtk_element_t *wlmtk_lock_element(wlmtk_lock_t *lock_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_LOCK_H__ */
/* == End of lock.h ======================================================== */
wlmaker-0.3/src/toolkit/panel.c 0000664 0000000 0000000 00000040760 14641446446 0016561 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file panel.c
*
* @copyright
* Copyright 2024 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.
*/
#include "panel.h"
#include "test.h"
#include
/* == Declarations ========================================================= */
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_panel_init(
wlmtk_panel_t *panel_ptr,
const wlmtk_panel_positioning_t *positioning_ptr,
wlmtk_env_t *env_ptr)
{
memset(panel_ptr, 0, sizeof(wlmtk_panel_t));
if (!wlmtk_container_init(&panel_ptr->super_container, env_ptr)) {
wlmtk_panel_fini(panel_ptr);
return false;
}
panel_ptr->positioning = *positioning_ptr;
if (!wlmtk_container_init(&panel_ptr->popup_container, env_ptr)) {
wlmtk_panel_fini(panel_ptr);
return false;
}
wlmtk_container_add_element(
&panel_ptr->super_container,
&panel_ptr->popup_container.super_element);
wlmtk_element_set_visible(&panel_ptr->popup_container.super_element, true);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_panel_fini(wlmtk_panel_t *panel_ptr)
{
if (panel_ptr->popup_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&panel_ptr->super_container,
&panel_ptr->popup_container.super_element);
}
wlmtk_container_fini(&panel_ptr->popup_container);
wlmtk_container_fini(&panel_ptr->super_container);
}
/* ------------------------------------------------------------------------- */
wlmtk_panel_vmt_t wlmtk_panel_extend(
wlmtk_panel_t *panel_ptr,
const wlmtk_panel_vmt_t *panel_vmt_ptr)
{
wlmtk_panel_vmt_t orig_panel_vmt = panel_ptr->vmt;
if (NULL != panel_vmt_ptr->request_size) {
panel_ptr->vmt.request_size = panel_vmt_ptr->request_size;
}
return orig_panel_vmt;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_panel_element(wlmtk_panel_t *panel_ptr)
{
return &panel_ptr->super_container.super_element;
}
/* ------------------------------------------------------------------------- */
bs_dllist_node_t *wlmtk_dlnode_from_panel(wlmtk_panel_t *panel_ptr)
{
if (NULL == panel_ptr) return NULL;
return &panel_ptr->dlnode;
}
/* ------------------------------------------------------------------------- */
wlmtk_panel_t *wlmtk_panel_from_dlnode(bs_dllist_node_t *dlnode_ptr)
{
if (NULL == dlnode_ptr) return NULL;
return BS_CONTAINER_OF(dlnode_ptr, wlmtk_panel_t, dlnode);
}
/* ------------------------------------------------------------------------- */
void wlmtk_panel_set_layer(wlmtk_panel_t *panel_ptr,
wlmtk_layer_t *layer_ptr)
{
// Guard condition: Permit setting layer only if none set. And clearing
// only if one is set.
BS_ASSERT((NULL == layer_ptr) != (NULL == panel_ptr->layer_ptr));
panel_ptr->layer_ptr = layer_ptr;
}
/* ------------------------------------------------------------------------- */
wlmtk_layer_t *wlmtk_panel_get_layer(wlmtk_panel_t *panel_ptr)
{
return panel_ptr->layer_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_panel_commit(
wlmtk_panel_t *panel_ptr,
__UNUSED__ uint32_t serial,
const wlmtk_panel_positioning_t *positioning_ptr)
{
// TODO(kaeser@gubbe.ch): Make use of `serial` and only update the
// element's position once this matches the corresponding call to
// @ref wlmtk_panel_request_size.
// Guard clause: No updates, nothing more to do.
if (0 == memcmp(
&panel_ptr->positioning,
positioning_ptr,
sizeof(wlmtk_panel_positioning_t))) return;
panel_ptr->positioning = *positioning_ptr;
if (NULL != panel_ptr->layer_ptr) {
wlmtk_layer_reconfigure(panel_ptr->layer_ptr);
}
}
/* ------------------------------------------------------------------------- */
struct wlr_box wlmtk_panel_compute_dimensions(
const wlmtk_panel_t *panel_ptr,
const struct wlr_box *full_area_ptr,
struct wlr_box *usable_area_ptr)
{
// Copied for readability.
uint32_t anchor = panel_ptr->positioning.anchor;
int margin_left = panel_ptr->positioning.margin_left;
int margin_right = panel_ptr->positioning.margin_right;
int margin_top = panel_ptr->positioning.margin_top;
int margin_bottom = panel_ptr->positioning.margin_bottom;
// Negative 'exclusive_zone' values mean to ignore other panels.
struct wlr_box max_dims = *usable_area_ptr;
if (0 > panel_ptr->positioning.exclusive_zone) {
max_dims = *full_area_ptr;
}
struct wlr_box dims = {
.width = panel_ptr->positioning.desired_width,
.height = panel_ptr->positioning.desired_height
};
// Set horizontal position and width.
if (0 == dims.width) {
// Width not given. Protocol requires the anchor to be set on left &
// right edges, and translates to full width (minus margins).
BS_ASSERT(anchor & WLR_EDGE_LEFT && anchor & WLR_EDGE_RIGHT);
dims.x = max_dims.x + margin_left;
dims.width = max_dims.width - margin_left - margin_right;
} else if (anchor & WLR_EDGE_LEFT && !(anchor & WLR_EDGE_RIGHT)) {
// Width given, anchored only on the left: At margin.
dims.x = max_dims.x + margin_left;
} else if (anchor & WLR_EDGE_RIGHT && !(anchor & WLR_EDGE_LEFT)) {
// Width given, anchored only on the right: At margin minus width.
dims.x = max_dims.x + max_dims.width - margin_right - dims.width;
} else {
// There was a width, and no one-sided anchoring: Center it.
dims.x = max_dims.x + max_dims.width / 2 - dims.width / 2;
}
// Set vertical position and height.
if (0 == dims.height) {
// Height not given. Protocol requires the anchor to be set on top &
// bottom edges, and translates to full height (minus margins).
BS_ASSERT(anchor & WLR_EDGE_TOP && anchor & WLR_EDGE_BOTTOM);
dims.y = max_dims.y + margin_top;
dims.height = max_dims.height - margin_top - margin_bottom;
} else if (anchor & WLR_EDGE_TOP && !(anchor & WLR_EDGE_BOTTOM)) {
// Height given, anchored only on the top: At margin.
dims.y = max_dims.y + margin_top;
} else if (anchor & WLR_EDGE_BOTTOM && !(anchor & WLR_EDGE_TOP)) {
// Height given, anchored only on the bottom: At margin minus height.
dims.y = max_dims.y + max_dims.height - margin_bottom - dims.height;
} else {
// There was a height, and no vertical anchoring: Center it.
dims.y = max_dims.y + max_dims.height / 2 - dims.height / 2;
}
// Update the usable area, if there is an exclusive zone.
int exclusive_zone = panel_ptr->positioning.exclusive_zone;
if (0 < exclusive_zone) {
if (anchor == WLR_EDGE_LEFT ||
anchor == (WLR_EDGE_LEFT | WLR_EDGE_TOP | WLR_EDGE_BOTTOM)) {
usable_area_ptr->x += exclusive_zone + margin_left;
usable_area_ptr->width -= exclusive_zone + margin_left;
}
if (anchor == WLR_EDGE_RIGHT ||
anchor == (WLR_EDGE_RIGHT | WLR_EDGE_TOP | WLR_EDGE_BOTTOM)) {
usable_area_ptr->width -= exclusive_zone + margin_right;
}
if (anchor == WLR_EDGE_TOP ||
anchor == (WLR_EDGE_TOP | WLR_EDGE_LEFT | WLR_EDGE_RIGHT)) {
usable_area_ptr->y += exclusive_zone + margin_top;
usable_area_ptr->height -= exclusive_zone + margin_top;
}
if (anchor == WLR_EDGE_BOTTOM ||
anchor == (WLR_EDGE_BOTTOM | WLR_EDGE_LEFT | WLR_EDGE_RIGHT)) {
usable_area_ptr->height -= exclusive_zone + margin_bottom;
}
}
return dims;
}
/* == Local (static) methods =============================================== */
static uint32_t _wlmtk_fake_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height);
/** Virtual methods of the fake panel. */
static const wlmtk_panel_vmt_t _wlmtk_fake_panel_vmt = {
.request_size = _wlmtk_fake_panel_request_size
};
/* ------------------------------------------------------------------------- */
wlmtk_fake_panel_t *wlmtk_fake_panel_create(
const wlmtk_panel_positioning_t *positioning_ptr)
{
wlmtk_fake_panel_t *fake_panel_ptr = logged_calloc(
1, sizeof(wlmtk_fake_panel_t));
if (NULL == fake_panel_ptr) return NULL;
if (!wlmtk_panel_init(&fake_panel_ptr->panel, positioning_ptr, NULL)) {
wlmtk_fake_panel_destroy(fake_panel_ptr);
return NULL;
}
wlmtk_panel_extend(&fake_panel_ptr->panel, &_wlmtk_fake_panel_vmt);
return fake_panel_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_panel_destroy(wlmtk_fake_panel_t *fake_panel_ptr)
{
wlmtk_panel_fini(&fake_panel_ptr->panel);
free(fake_panel_ptr);
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of @ref wlmtk_panel_vmt_t::request_size. */
uint32_t _wlmtk_fake_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height)
{
wlmtk_fake_panel_t *fake_panel_ptr = BS_CONTAINER_OF(
panel_ptr, wlmtk_fake_panel_t, panel);
fake_panel_ptr->requested_width = width;
fake_panel_ptr->requested_height = height;
return fake_panel_ptr->serial;
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
static void test_compute_dimensions(bs_test_t *test_ptr);
static void test_compute_dimensions_exclusive(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_panel_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 1, "compute_dimensions", test_compute_dimensions },
{ 1, "compute_dimensions_exclusive", test_compute_dimensions_exclusive },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests setup, teardown and some accessors. */
void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_panel_t p;
wlmtk_panel_positioning_t pos = {};
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_panel_init(&p, &pos, NULL));
bs_dllist_node_t *dlnode_ptr = wlmtk_dlnode_from_panel(&p);
BS_TEST_VERIFY_EQ(test_ptr, &p.dlnode, dlnode_ptr);
BS_TEST_VERIFY_EQ(test_ptr, &p, wlmtk_panel_from_dlnode(dlnode_ptr));
wlmtk_panel_fini(&p);
}
/* ------------------------------------------------------------------------- */
/** Verifies wlmtk_panel_compute_dimensions. */
void test_compute_dimensions(bs_test_t *test_ptr)
{
wlmtk_panel_positioning_t pos = {
.desired_width = 100,
.desired_height = 50
};
wlmtk_fake_panel_t *fake_panel_ptr = BS_ASSERT_NOTNULL(
wlmtk_fake_panel_create(&pos));
wlmtk_panel_t *p_ptr = &fake_panel_ptr->panel;
struct wlr_box extents = { .x = 0, .y = 0, .width = 200, .height = 100 };
struct wlr_box usable = extents;
struct wlr_box dims;
p_ptr->positioning.margin_left = 10;
p_ptr->positioning.margin_right = 20;
p_ptr->positioning.margin_top = 8;
p_ptr->positioning.margin_bottom = 4;
// Not anchored: Keep proposed dimensions.
p_ptr->positioning.anchor = 0;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 50, 25, 100, 50, dims);
// Anchored left or right: Respect margin.
p_ptr->positioning.anchor = WLR_EDGE_LEFT;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 10, 25, 100, 50, dims);
p_ptr->positioning.anchor = WLR_EDGE_RIGHT;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 80, 25, 100, 50, dims);
// Anchored left & right: Centered, and keep proposed dimensions.
p_ptr->positioning.anchor = WLR_EDGE_LEFT | WLR_EDGE_RIGHT;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 50, 25, 100, 50, dims);
// Anchored top or bottom: Respect margin.
p_ptr->positioning.anchor = WLR_EDGE_TOP;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 50, 8, 100, 50, dims);
p_ptr->positioning.anchor = WLR_EDGE_BOTTOM;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 50, 46, 100, 50, dims);
// Anchored top and bottom: Centered.
p_ptr->positioning.anchor = WLR_EDGE_TOP | WLR_EDGE_BOTTOM;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 50, 25, 100, 50, dims);
// Anchored all around, and no size proposed: Use full extents,
// while respecting margins.
p_ptr->positioning.anchor =
WLR_EDGE_LEFT | WLR_EDGE_RIGHT | WLR_EDGE_TOP | WLR_EDGE_BOTTOM;
p_ptr->positioning.desired_height = 0;
p_ptr->positioning.desired_width = 0;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 10, 8, 170, 88, dims);
wlmtk_fake_panel_destroy(fake_panel_ptr);
}
/* ------------------------------------------------------------------------- */
/** Verifies dimension computation with an exclusive_zone. */
void test_compute_dimensions_exclusive(bs_test_t *test_ptr)
{
wlmtk_panel_positioning_t pos = {
.exclusive_zone = 16,
.anchor = (WLR_EDGE_LEFT | WLR_EDGE_RIGHT |
WLR_EDGE_TOP | WLR_EDGE_BOTTOM),
.margin_left = 40,
.margin_right = 30,
.margin_top = 20,
.margin_bottom = 10
};
wlmtk_fake_panel_t *fake_panel_ptr = BS_ASSERT_NOTNULL(
wlmtk_fake_panel_create(&pos));
wlmtk_panel_t *p_ptr = &fake_panel_ptr->panel;
struct wlr_box extents = { .x = 0, .y = 0, .width = 200, .height = 100 };
struct wlr_box usable = { .x = 1, .y = 2, .width = 195, .height = 90 };
struct wlr_box dims;
// Use full extents on negative exclusive_zone value.
p_ptr->positioning.exclusive_zone = -1;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 40, 20, 130, 70, dims);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 1, 2, 195, 90, usable);
// Respect the usable area, for non-negative exclusive zone.
p_ptr->positioning.exclusive_zone = 0;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 41, 22, 125, 60, dims);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 1, 2, 195, 90, usable);
// Respect the usable area, for non-negative exclusive zone. Do not
// update the usable zone, since anchored not appropriately.
p_ptr->positioning.exclusive_zone = 7;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 41, 22, 125, 60, dims);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 1, 2, 195, 90, usable);
// Respect usable zone, and update, since anchored left and full-height.
p_ptr->positioning.desired_width = 20;
p_ptr->positioning.exclusive_zone = 7;
p_ptr->positioning.anchor = WLR_EDGE_LEFT | WLR_EDGE_TOP | WLR_EDGE_BOTTOM;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 41, 22, 20, 60, dims);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 48, 2, 148, 90, usable);
// Check for usable zone at the bottom.
usable.x = 1; usable.y = 2; usable.width = 195; usable.height = 90;
p_ptr->positioning.desired_width = 100;
p_ptr->positioning.desired_height = 20;
p_ptr->positioning.exclusive_zone = 7;
p_ptr->positioning.anchor = WLR_EDGE_BOTTOM;
dims = wlmtk_panel_compute_dimensions(p_ptr, &extents, &usable);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 48, 62, 100, 20, dims);
WLMTK_TEST_VERIFY_WLRBOX_EQ(test_ptr, 1, 2, 195, 73, usable);
wlmtk_fake_panel_destroy(fake_panel_ptr);
}
/* == End of panel.c ======================================================= */
wlmaker-0.3/src/toolkit/panel.h 0000664 0000000 0000000 00000016070 14641446446 0016563 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file panel.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_PANEL_H__
#define __WLMTK_PANEL_H__
#include
/** Forward declaration: An element of a layer, we call it: Panel. */
typedef struct _wlmtk_panel_t wlmtk_panel_t;
/** Forward declaration: The panel's virtual method table. */
typedef struct _wlmtk_panel_vmt_t wlmtk_panel_vmt_t;
/** Forward declaration: The panel's positioning parameters. */
typedef struct _wlmtk_panel_positioning_t wlmtk_panel_positioning_t;
#include "container.h"
#include "layer.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** The panel's virtual method table. */
struct _wlmtk_panel_vmt_t {
/**
* Requests the panel to change to the specified size.
*
* This may be implemented as an asynchronous implementation. Once the
* panel has committed the adapted size, @ref wlmtk_panel_commit should
* be called with the corresponding serial.
*
* @param content_ptr
* @param width_ptr
* @param height
*
* @return WLR Layer Shell configuration serial.
*/
uint32_t (*request_size)(
wlmtk_panel_t *panel_ptr,
int width,
int height);
};
/** The panel's positioning parameters. */
struct _wlmtk_panel_positioning_t {
/** Desired width of the panel. */
int desired_width;
/** Desired height of the panel. */
int desired_height;
/** Edges the panel is anchored to. See `enum wlr_edges`. */
uint32_t anchor;
/** Margin on the left of the panel. */
int margin_left;
/** Margin on the right of the panel. */
int margin_right;
/** Margin on the top of the panel. */
int margin_top;
/** Margin on the bottom of the panel. */
int margin_bottom;
/** Size of the exclusive zone, in pixels. -1 to request all. */
int exclusive_zone;
};
/** State of the panel. */
struct _wlmtk_panel_t {
/** Super class of the panel. */
wlmtk_container_t super_container;
/** The panel's virtual method table. */
wlmtk_panel_vmt_t vmt;
/** Virtual method table of the superclass' container. */
wlmtk_container_vmt_t orig_super_container_vmt;
/** Popup container. Panels may contain popups. */
wlmtk_container_t popup_container;
/** The layer that this panel belongs to. NULL if none. */
wlmtk_layer_t *layer_ptr;
/** Node of @ref wlmtk_layer_t::panels. */
bs_dllist_node_t dlnode;
/** Positioning parameters. */
wlmtk_panel_positioning_t positioning;
};
/**
* Initializes the panel.
*
* @param panel_ptr
* @param positioning_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_panel_init(
wlmtk_panel_t *panel_ptr,
const wlmtk_panel_positioning_t *positioning_ptr,
wlmtk_env_t *env_ptr);
/**
* Un-initializes the panel.
*
* @param panel_ptr
*/
void wlmtk_panel_fini(wlmtk_panel_t *panel_ptr);
/**
* Extends the panel by the specified virtual methods.
*
* @param panel_ptr
* @param panel_vmt_ptr
*
* @return The original virtual method table.
*/
wlmtk_panel_vmt_t wlmtk_panel_extend(
wlmtk_panel_t *panel_ptr,
const wlmtk_panel_vmt_t *panel_vmt_ptr);
/** @return pointer to the super @ref wlmtk_element_t of the panel. */
wlmtk_element_t *wlmtk_panel_element(wlmtk_panel_t *panel_ptr);
/** @return Pointer to @ref wlmtk_panel_t::dlnode. */
bs_dllist_node_t *wlmtk_dlnode_from_panel(wlmtk_panel_t *panel_ptr);
/** @return Pointer to @ref wlmtk_panel_t for the given dlnode. */
wlmtk_panel_t *wlmtk_panel_from_dlnode(bs_dllist_node_t *dlnode_ptr);
/**
* Sets the layer for the `panel_ptr`.
*
* @protected This method must only be called from @ref wlmtk_layer_t.
*
* @param panel_ptr
* @param layer_ptr
*/
void wlmtk_panel_set_layer(wlmtk_panel_t *panel_ptr,
wlmtk_layer_t *layer_ptr);
/** @return the wlmtk_layer_t this panel belongs to. Or NULL, if unmapped. */
wlmtk_layer_t *wlmtk_panel_get_layer(wlmtk_panel_t *panel_ptr);
/** Requests new size. See @ref wlmtk_panel_vmt_t::request_size. */
static inline uint32_t wlmtk_panel_request_size(
wlmtk_panel_t *panel_ptr,
int width,
int height) {
return panel_ptr->vmt.request_size(panel_ptr, width, height);
}
/**
* Reports a commit for the given serial, and updates positioning.
*
* @param panel_ptr
* @param serial
* @param positioning_ptr
*/
void wlmtk_panel_commit(
wlmtk_panel_t *panel_ptr,
uint32_t serial,
const wlmtk_panel_positioning_t *positioning_ptr);
/**
* Computes the requested dimension for the panel.
*
* @param panel_ptr
* @param full_area_ptr
* @param usable_area_ptr Are that remains usable from the output and layer
* after factoring in other panels. *usable_area_ptr
* will be updated with this panel's exclusive area
* (if any) subtracted.
*
* @return A wlr_box with the requested position and size for this panel. The
* caller is advised to issue a call to @ref wlmtk_panel_request_size call and
* update the panel element's position with the box' information.
*/
struct wlr_box wlmtk_panel_compute_dimensions(
const wlmtk_panel_t *panel_ptr,
const struct wlr_box *full_area_ptr,
struct wlr_box *usable_area_ptr);
/** Unit test cases of panel. */
extern const bs_test_case_t wlmtk_panel_test_cases[];
/** Forward declaration: Fake panel, for tests. */
typedef struct _wlmtk_fake_panel_t wlmtk_fake_panel_t;
/** State of fake panel. */
struct _wlmtk_fake_panel_t {
/** Superclass: panel. */
wlmtk_panel_t panel;
/** Serial to return on next request_size call. */
uint32_t serial;
/** `width` argument eof last @ref wlmtk_content_request_size call. */
int requested_width;
/** `height` argument of last @ref wlmtk_content_request_size call. */
int requested_height;
};
/** Creates a fake panel, for tests. */
wlmtk_fake_panel_t *wlmtk_fake_panel_create(
const wlmtk_panel_positioning_t *positioning_ptr);
/** Destroys the fake panel. */
void wlmtk_fake_panel_destroy(wlmtk_fake_panel_t *fake_panel_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_PANEL_H__ */
/* == End of panel.h ======================================================= */
wlmaker-0.3/src/toolkit/popup.c 0000664 0000000 0000000 00000011421 14641446446 0016615 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file popup.c
*
* @copyright
* Copyright 2024 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.
*/
#include "popup.h"
/* == Declarations ========================================================= */
static void _wlmtk_popup_handle_surface_map(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_popup_handle_surface_unmap(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_popup_init(
wlmtk_popup_t *popup_ptr,
wlmtk_env_t *env_ptr,
wlmtk_surface_t *surface_ptr)
{
memset(popup_ptr, 0, sizeof(wlmtk_popup_t));
if (!wlmtk_container_init(&popup_ptr->super_container, env_ptr)) {
return false;
}
if (!wlmtk_container_init(&popup_ptr->popup_container, env_ptr)) {
wlmtk_popup_fini(popup_ptr);
return false;
}
wlmtk_container_add_element(
&popup_ptr->super_container,
&popup_ptr->popup_container.super_element);
wlmtk_element_set_visible(&popup_ptr->popup_container.super_element, true);
if (NULL != surface_ptr) {
wlmtk_container_add_element(
&popup_ptr->super_container,
wlmtk_surface_element(surface_ptr));
popup_ptr->surface_ptr = surface_ptr;
wlmtk_surface_connect_map_listener_signal(
surface_ptr,
&popup_ptr->surface_map_listener,
_wlmtk_popup_handle_surface_map);
wlmtk_surface_connect_unmap_listener_signal(
surface_ptr,
&popup_ptr->surface_unmap_listener,
_wlmtk_popup_handle_surface_unmap);
}
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_popup_fini(wlmtk_popup_t *popup_ptr)
{
if (NULL != wlmtk_popup_element(popup_ptr)->parent_container_ptr) {
wlmtk_container_remove_element(
wlmtk_popup_element(popup_ptr)->parent_container_ptr,
wlmtk_popup_element(popup_ptr));
}
if (NULL != popup_ptr->surface_ptr) {
wlmtk_util_disconnect_listener(&popup_ptr->surface_unmap_listener);
wlmtk_util_disconnect_listener(&popup_ptr->surface_map_listener);
wlmtk_container_remove_element(
&popup_ptr->super_container,
wlmtk_surface_element(popup_ptr->surface_ptr));
popup_ptr->surface_ptr = NULL;
}
if (popup_ptr->popup_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&popup_ptr->super_container,
&popup_ptr->popup_container.super_element);
}
wlmtk_container_fini(&popup_ptr->popup_container);
wlmtk_container_fini(&popup_ptr->super_container);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_popup_element(wlmtk_popup_t *popup_ptr)
{
return &popup_ptr->super_container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Handles the `surface_map` signal of the `wlr_surface`: Makes the popup
* visible.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_popup_handle_surface_map(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_popup_t *popup_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_popup_t, surface_map_listener);
wlmtk_element_set_visible(
wlmtk_surface_element(popup_ptr->surface_ptr),
true);
}
/* ------------------------------------------------------------------------- */
/**
* Handles the `surface_unmap` signal of the `wlr_surface`: Makes the popup
* invisible.
*
* @param listener_ptr
* @param data_ptr
*/
void _wlmtk_popup_handle_surface_unmap(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_popup_t *popup_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_popup_t, surface_unmap_listener);
wlmtk_element_set_visible(
wlmtk_surface_element(popup_ptr->surface_ptr),
false);
}
/* == End of popup.c ======================================================= */
wlmaker-0.3/src/toolkit/popup.h 0000664 0000000 0000000 00000004512 14641446446 0016625 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file popup.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_POPUP_H__
#define __WLMTK_POPUP_H__
/** Forward declaration: Popup. */
typedef struct _wlmtk_popup_t wlmtk_popup_t;
#include "container.h"
#include "env.h"
#include "surface.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* State of a popup.
*
* A popup contains a @ref wlmtk_surface_t, and may contain further popups.
* These further popups will be stacked above the principal surface, in order
* of them being added.
*/
struct _wlmtk_popup_t {
/** Super class of the panel. */
wlmtk_container_t super_container;
/** And the popup container. Popups can contain child popups. */
wlmtk_container_t popup_container;
/** The contained surface. */
wlmtk_surface_t *surface_ptr;
/** Listener for the `map` signal of `wlr_surface`. */
struct wl_listener surface_map_listener;
/** Listener for the `map` signal of `wlr_surface`. */
struct wl_listener surface_unmap_listener;
};
/**
* Initializes the popup.
*
* @param popup_ptr
* @param env_ptr
* @param surface_ptr
*
* @return true on success.
*/
bool wlmtk_popup_init(
wlmtk_popup_t *popup_ptr,
wlmtk_env_t *env_ptr,
wlmtk_surface_t *surface_ptr);
/**
* Un-initializes the popup. Will remove it from the parent container.
*
* @param popup_ptr
*/
void wlmtk_popup_fini(wlmtk_popup_t *popup_ptr);
/** Returns the base @ref wlmtk_element_t. */
wlmtk_element_t *wlmtk_popup_element(wlmtk_popup_t *popup_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_POPUP_H__ */
/* == End of popup.h ======================================================= */
wlmaker-0.3/src/toolkit/primitives.c 0000664 0000000 0000000 00000032336 14641446446 0017655 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file primitives.c
*
* @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.
*/
#include "primitives.h"
#include
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_cairo_fill(
cairo_t *cairo_ptr,
const wlmtk_style_fill_t *fill_ptr)
{
cairo_surface_t *surface_ptr = cairo_get_target(cairo_ptr);
uint32_t width = cairo_image_surface_get_width(surface_ptr);
uint32_t height = cairo_image_surface_get_height(surface_ptr);
wlmaker_primitives_cairo_fill_at(cairo_ptr, 0, 0, width, height, fill_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_cairo_fill_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
const wlmtk_style_fill_t *fill_ptr)
{
cairo_pattern_t *cairo_pattern_ptr;
float r, g, b, alpha;
switch (fill_ptr->type) {
case WLMTK_STYLE_COLOR_SOLID:
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.solid.color, &r, &g, &b, &alpha);
cairo_pattern_ptr = cairo_pattern_create_rgba(r, g, b, alpha);
break;
case WLMTK_STYLE_COLOR_HGRADIENT:
cairo_pattern_ptr = cairo_pattern_create_linear(0, 0, width, 0);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.hgradient.from, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 0, r, g, b, alpha);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.hgradient.to, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 1, r, g, b, alpha);
break;
case WLMTK_STYLE_COLOR_VGRADIENT:
cairo_pattern_ptr = cairo_pattern_create_linear(0, 0, 0, height);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.vgradient.from, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 0, r, g, b, alpha);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.vgradient.to, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 1, r, g, b, alpha);
break;
case WLMTK_STYLE_COLOR_DGRADIENT:
cairo_pattern_ptr = cairo_pattern_create_linear(0, 0, width, height);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.dgradient.from, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 0, r, g, b, alpha);
bs_gfxbuf_argb8888_to_floats(
fill_ptr->param.dgradient.to, &r, &g, &b, &alpha);
cairo_pattern_add_color_stop_rgba(
cairo_pattern_ptr, 1, r, g, b, alpha);
break;
default:
bs_log(BS_FATAL, "Unsupported fill_type %d", fill_ptr->type);
BS_ABORT();
return;
}
cairo_save(cairo_ptr);
cairo_set_source(cairo_ptr, cairo_pattern_ptr);
cairo_pattern_destroy(cairo_pattern_ptr);
cairo_rectangle(cairo_ptr, x, y, width, height);
cairo_fill(cairo_ptr);
cairo_restore(cairo_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_set_bezel_color(
cairo_t *cairo_ptr,
bool illuminated)
{
if (illuminated) {
cairo_set_source_rgba(cairo_ptr, 1.0, 1.0, 1.0, 0.6);
} else {
cairo_set_source_rgba(cairo_ptr, 0.0, 0.0, 0.0, 0.4);
}
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_draw_bezel(
cairo_t *cairo_ptr,
double bezel_width,
bool raised)
{
int width = cairo_image_surface_get_width(cairo_get_target(cairo_ptr));
int height = cairo_image_surface_get_height(cairo_get_target(cairo_ptr));
wlmaker_primitives_draw_bezel_at(
cairo_ptr, 0, 0, width, height, bezel_width, raised);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_draw_bezel_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
double bezel_width,
bool raised)
{
cairo_save(cairo_ptr);
cairo_set_line_width(cairo_ptr, 0);
// Northwestern corner is illuminted when raised.
wlmaker_primitives_set_bezel_color(cairo_ptr, raised);
cairo_move_to(cairo_ptr, x, y);
cairo_line_to(cairo_ptr, x + width, y + 0);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + 0, y + height);
cairo_line_to(cairo_ptr, x + 0, y + 0);
cairo_fill(cairo_ptr);
// Southeastern corner is illuminated when sunken.
wlmaker_primitives_set_bezel_color(cairo_ptr, !raised);
cairo_move_to(cairo_ptr, x + width, y + height);
cairo_line_to(cairo_ptr, x + 0, y + height);
cairo_line_to(cairo_ptr, x + bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + height - bezel_width);
cairo_line_to(cairo_ptr, x + width - bezel_width, y + bezel_width);
cairo_line_to(cairo_ptr, x + width, y + 0);
cairo_line_to(cairo_ptr, x + width, y + height);
cairo_fill(cairo_ptr);
cairo_restore(cairo_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_draw_minimize_icon(
cairo_t *cairo_ptr,
int size,
uint32_t color)
{
double scale = size / 22.0;
cairo_save(cairo_ptr);
cairo_set_line_width(cairo_ptr, 0);
cairo_set_source_argb8888(cairo_ptr, color);
cairo_set_fill_rule(cairo_ptr, CAIRO_FILL_RULE_EVEN_ODD);
cairo_rectangle(cairo_ptr, 6 * scale, 6 * scale, 10 * scale, 10 * scale);
cairo_rectangle(cairo_ptr,
(6+ 1) * scale, (6 + 3) * scale, 8 * scale, 6 * scale);
cairo_fill(cairo_ptr);
cairo_stroke(cairo_ptr);
cairo_restore(cairo_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_draw_close_icon(
cairo_t *cairo_ptr,
int size,
uint32_t color)
{
double scale = size / 22.0;
cairo_save(cairo_ptr);
cairo_set_line_width(cairo_ptr, 2.5 * scale);
cairo_set_line_cap(cairo_ptr, CAIRO_LINE_CAP_ROUND);
cairo_set_source_argb8888(cairo_ptr, color);
cairo_move_to(cairo_ptr, 7 * scale, 7 * scale);
cairo_line_to(cairo_ptr, (7 + 8) * scale, (7 + 8) * scale);
cairo_move_to(cairo_ptr, (7 + 8) * scale, 7 * scale);
cairo_line_to(cairo_ptr, 7 * scale, (7 + 8) * scale);
cairo_stroke(cairo_ptr);
cairo_stroke(cairo_ptr);
cairo_restore(cairo_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmaker_primitives_draw_window_title(
cairo_t *cairo_ptr,
const wlmtk_style_font_t *font_style_ptr,
const char *title_ptr,
uint32_t color)
{
cairo_save(cairo_ptr);
cairo_select_font_face(
cairo_ptr,
font_style_ptr->face,
CAIRO_FONT_SLANT_NORMAL,
wlmtk_style_font_weight_cairo_from_wlmtk(font_style_ptr->weight));
cairo_set_font_size(cairo_ptr, font_style_ptr->size);
cairo_set_source_argb8888(cairo_ptr, color);
cairo_move_to(cairo_ptr, 6, 2 + font_style_ptr->size);
cairo_show_text(cairo_ptr, title_ptr ? title_ptr : "Unnamed");
cairo_restore(cairo_ptr);
}
/* == Local (static) methods =============================================== */
static void test_fill(bs_test_t *test_ptr);
static void test_close(bs_test_t *test_ptr);
static void test_close_large(bs_test_t *test_ptr);
static void test_minimize(bs_test_t *test_ptr);
static void test_minimize_large(bs_test_t *test_ptr);
static void test_window_title(bs_test_t *test_ptr);
/** Unit tests. */
const bs_test_case_t wlmaker_primitives_test_cases[] = {
{ 1, "fill", test_fill },
{ 1, "close", test_close },
{ 1, "close_large", test_close_large },
{ 1, "minimize", test_minimize },
{ 1, "minimize_large", test_minimize_large },
{ 1, "window_title", test_window_title },
{ 0, NULL, NULL }
};
/** Verifies the fill styles */
void test_fill(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(16, 8);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, gfxbuf_ptr);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
// Solid fill.
wlmtk_style_fill_t fill_solid = {
.type = WLMTK_STYLE_COLOR_SOLID,
.param = { .solid = { .color = 0xff4080c0} }
};
wlmaker_primitives_cairo_fill(cairo_ptr, &fill_solid);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_fill_solid.png");
// Horizontal gradient fill.
wlmtk_style_fill_t fill_hgradient = {
.type = WLMTK_STYLE_COLOR_HGRADIENT,
.param = { .hgradient = { .from = 0xff102040, .to = 0xff4080ff }}
};
wlmaker_primitives_cairo_fill(cairo_ptr, &fill_hgradient);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_fill_hgradient.png");
// Vertical gradient fill.
wlmtk_style_fill_t fill_vgradient = {
.type = WLMTK_STYLE_COLOR_VGRADIENT,
.param = { .vgradient = { .from = 0xff102040, .to = 0xff4080ff }}
};
wlmaker_primitives_cairo_fill(cairo_ptr, &fill_vgradient);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_fill_vgradient.png");
// Diagonal fill.
wlmtk_style_fill_t fill_dgradient = {
.type = WLMTK_STYLE_COLOR_DGRADIENT,
.param = { .dgradient = { .from = 0xff102040, .to = 0xff4080ff }}
};
wlmaker_primitives_cairo_fill(cairo_ptr, &fill_dgradient);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_fill_dgradient.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/** Verifies the looks of the "close" icon. */
void test_close(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(22, 22);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, cairo_ptr);
wlmaker_primitives_draw_close_icon(cairo_ptr, 22, 0xffffffff);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_close_icon.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/** Verifies the looks of the "close" icon, with non-default size. */
void test_close_large(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(50, 50);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, cairo_ptr);
wlmaker_primitives_draw_close_icon(cairo_ptr, 50, 0xffffffff);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_close_icon_large.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/** Verifies the looks of the "minimize" icon. */
void test_minimize(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(22, 22);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, cairo_ptr);
wlmaker_primitives_draw_minimize_icon(cairo_ptr, 22, 0xffffffff);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_minimize_icon.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/** Verifies the looks of the "minimize" icon, widht non-default size. */
void test_minimize_large(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(50, 50);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, cairo_ptr);
wlmaker_primitives_draw_minimize_icon(cairo_ptr, 50, 0xffffffff);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_minimize_icon_large.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/** Verifies the looks of the window title. */
void test_window_title(bs_test_t *test_ptr)
{
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(80, 22);
cairo_t *cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, cairo_ptr);
static const wlmtk_style_font_t font_style = {
.face = "Helvetica",
.weight = WLMTK_FONT_WEIGHT_BOLD,
.size = 15,
};
wlmaker_primitives_draw_window_title(
cairo_ptr, &font_style, "Title", 0xffffffff);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr, gfxbuf_ptr, "toolkit/primitive_window_title.png");
cairo_destroy(cairo_ptr);
bs_gfxbuf_destroy(gfxbuf_ptr);
}
/* == End of primitives.c ================================================== */
wlmaker-0.3/src/toolkit/primitives.h 0000664 0000000 0000000 00000007677 14641446446 0017674 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file primitives.h
*
* @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.
*/
#ifndef __WLMTK_PRIMITIVES_H__
#define __WLMTK_PRIMITIVES_H__
#include
#include
#include "style.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Completely fills the cairo with the specified style.
*
* @param cairo_ptr A cairo, backed by an image surface.
* @param fill_ptr
*/
void wlmaker_primitives_cairo_fill(
cairo_t *cairo_ptr,
const wlmtk_style_fill_t *fill_ptr);
/**
* Fills the cairo with the specified style at the specified rectangle.
*
* @param cairo_ptr A cairo, backed by an image surface.
* @param x
* @param y
* @param width
* @param height
* @param fill_ptr
*/
void wlmaker_primitives_cairo_fill_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
const wlmtk_style_fill_t *fill_ptr);
/**
* Sets the bezel color.
*
* Note: Window Maker draws the bezel by adding 80 (0x50) to each R, G, B of
* the underlying title for the illuminated side; respectively by subtracting
* 40 (0x28) on the non-illuminated side.
* We are using cairo's overlaying with the respective "alpha" values below,
* which leads to different results.
*
* @param cairo_ptr
* @param illuminated
*/
void wlmaker_primitives_set_bezel_color(
cairo_t *cairo_ptr,
bool illuminated);
/**
* Draws a bezel into the cairo.
*
* @param cairo_ptr A cairo, backed by an image surface.
* @param bezel_width
* @param raised Whether the bezel is to highlight a raised (true)
* or pressed (false) state.
*/
void wlmaker_primitives_draw_bezel(
cairo_t *cairo_ptr,
double bezel_width,
bool raised);
/**
* Draws a bezel into the cairo, at specified position and width/height.
*
* @param cairo_ptr A cairo, backed by an image surface.
* @param x
* @param y
* @param width
* @param height
* @param bezel_width
* @param raised Whether the bezel is to highlight a raised (true)
* or pressed (false) state.
*/
void wlmaker_primitives_draw_bezel_at(
cairo_t *cairo_ptr,
int x,
int y,
unsigned width,
unsigned height,
double bezel_width,
bool raised);
/**
* Draws the "minimize" icon, as used in the title bar.
*
* @param cairo_ptr
* @param size
* @param color
*/
void wlmaker_primitives_draw_minimize_icon(
cairo_t *cairo_ptr,
int size,
uint32_t color);
/**
* Draws the "close" icon, as used in the title bar.
*
* @param cairo_ptr
* @param size
* @param color
*/
void wlmaker_primitives_draw_close_icon(
cairo_t *cairo_ptr,
int size,
uint32_t color);
/**
* Draws the window title into the `cairo_t`.
*
* @param cairo_ptr
* @param font_style_ptr The font style to use.
* @param title_ptr Title string, or NULL.
* @param color As an ARGB 8888 value.
*/
void wlmaker_primitives_draw_window_title(
cairo_t *cairo_ptr,
const wlmtk_style_font_t *font_style_ptr,
const char *title_ptr,
uint32_t color);
/** Unit tests. */
extern const bs_test_case_t wlmaker_primitives_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_PRIMITIVES_H__ */
/* == End of primitives.h ================================================== */
wlmaker-0.3/src/toolkit/rectangle.c 0000664 0000000 0000000 00000025313 14641446446 0017423 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file rectangle.c
*
* @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.
*/
#include "rectangle.h"
#include "container.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of a unicolor rectangle. */
struct _wlmtk_rectangle_t {
/** Superclass element. */
wlmtk_element_t super_element;
/** Original virtual method table of the superclass element. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Width of the rectangle. */
int width;
/** Height of the rectangle. */
int height;
/** Color of the rectangle, as an ARGB8888 value. */
uint32_t color;
/** WLR rectangle. */
struct wlr_scene_rect *wlr_scene_rect_ptr;
/** Listener for the `destroy` signal of `wlr_rect_buffer_ptr->node`. */
struct wl_listener wlr_scene_rect_node_destroy_listener;
};
static void _wlmtk_rectangle_element_destroy(wlmtk_element_t *element_ptr);
static struct wlr_scene_node *_wlmtk_rectangle_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
static void _wlmtk_rectangle_get_dimensions(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr);
static void handle_wlr_scene_rect_node_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
/* == Data ================================================================= */
/** Virtual method table of the rectangle, extending the element. */
static const wlmtk_element_vmt_t _wlmtk_rectangle_element_vmt = {
.destroy = _wlmtk_rectangle_element_destroy,
.create_scene_node = _wlmtk_rectangle_element_create_scene_node,
.get_dimensions = _wlmtk_rectangle_get_dimensions,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_rectangle_t *wlmtk_rectangle_create(
wlmtk_env_t *env_ptr,
int width,
int height,
uint32_t color)
{
wlmtk_rectangle_t *rectangle_ptr = logged_calloc(
1, sizeof(wlmtk_rectangle_t));
if (NULL == rectangle_ptr) return NULL;
rectangle_ptr->width = width;
rectangle_ptr->height = height;
wlmtk_rectangle_set_color(rectangle_ptr, color);
if (!wlmtk_element_init(&rectangle_ptr->super_element, env_ptr)) {
wlmtk_rectangle_destroy(rectangle_ptr);
return NULL;
}
rectangle_ptr->orig_super_element_vmt = wlmtk_element_extend(
&rectangle_ptr->super_element,
&_wlmtk_rectangle_element_vmt);
return rectangle_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_rectangle_destroy(wlmtk_rectangle_t *rectangle_ptr)
{
if (NULL != rectangle_ptr->wlr_scene_rect_ptr) {
wlr_scene_node_destroy(&rectangle_ptr->wlr_scene_rect_ptr->node);
rectangle_ptr->wlr_scene_rect_ptr = NULL;
}
wlmtk_element_fini(&rectangle_ptr->super_element);
free(rectangle_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_rectangle_set_size(
wlmtk_rectangle_t *rectangle_ptr,
int width,
int height)
{
rectangle_ptr->width = width;
rectangle_ptr->height = height;
if (NULL != rectangle_ptr->wlr_scene_rect_ptr) {
wlr_scene_rect_set_size(
rectangle_ptr->wlr_scene_rect_ptr,
rectangle_ptr->width,
rectangle_ptr->height);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_rectangle_set_color(
wlmtk_rectangle_t *rectangle_ptr,
uint32_t color)
{
rectangle_ptr->color = color;
if (NULL != rectangle_ptr->wlr_scene_rect_ptr) {
float fcolor[4];
bs_gfxbuf_argb8888_to_floats(
color, &fcolor[0], &fcolor[1], &fcolor[2], &fcolor[3]);
wlr_scene_rect_set_color(rectangle_ptr->wlr_scene_rect_ptr, fcolor);
}
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_rectangle_element(wlmtk_rectangle_t *rectangle_ptr)
{
return &rectangle_ptr->super_element;
}
/* ------------------------------------------------------------------------- */
wlmtk_rectangle_t *wlmtk_rectangle_from_element(wlmtk_element_t *element_ptr)
{
BS_ASSERT(element_ptr->vmt.destroy = _wlmtk_rectangle_element_destroy);
wlmtk_rectangle_t *rectangle_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_rectangle_t, super_element);
return rectangle_ptr;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Virtual dtor: Invoke the rectangle's dtor. */
void _wlmtk_rectangle_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_rectangle_t, super_element);
wlmtk_rectangle_destroy(rectangle_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the superclass wlmtk_element_t::create_scene_node method.
*
* Creates a `struct wlr_scene_rect` attached to `wlr_scene_tree_ptr`.
*
* @param element_ptr
* @param wlr_scene_tree_ptr
*/
struct wlr_scene_node *_wlmtk_rectangle_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_rectangle_t, super_element);
BS_ASSERT(NULL == rectangle_ptr->wlr_scene_rect_ptr);
float color[4];
bs_gfxbuf_argb8888_to_floats(
rectangle_ptr->color, &color[0], &color[1], &color[2], &color[3]);
rectangle_ptr->wlr_scene_rect_ptr = wlr_scene_rect_create(
wlr_scene_tree_ptr,
rectangle_ptr->width,
rectangle_ptr->height,
color);
if (NULL == rectangle_ptr->wlr_scene_rect_ptr) return NULL;
wlmtk_util_connect_listener_signal(
&rectangle_ptr->wlr_scene_rect_ptr->node.events.destroy,
&rectangle_ptr->wlr_scene_rect_node_destroy_listener,
handle_wlr_scene_rect_node_destroy);
return &rectangle_ptr->wlr_scene_rect_ptr->node;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's get_dimensions method: Return dimensions.
*
* @param element_ptr
* @param x1_ptr 0.
* @param y1_ptr 0.
* @param x2_ptr Width. May be NULL.
* @param y2_ptr Height. May be NULL.
*/
void _wlmtk_rectangle_get_dimensions(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_rectangle_t, super_element);
if (NULL != x1_ptr) *x1_ptr = 0;
if (NULL != y1_ptr) *y1_ptr = 0;
if (NULL != x2_ptr) *x2_ptr = rectangle_ptr->width;
if (NULL != y2_ptr) *y2_ptr = rectangle_ptr->height;
}
/* ------------------------------------------------------------------------- */
/**
* Handles the 'destroy' callback of wlr_scene_rect_ptr->node.
*
* Will reset the wlr_scene_rect_ptr value. Destruction of the node had
* been triggered (hence the callback).
*
* @param listener_ptr
* @param data_ptr
*/
void handle_wlr_scene_rect_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_rectangle_t, wlr_scene_rect_node_destroy_listener);
rectangle_ptr->wlr_scene_rect_ptr = NULL;
wl_list_remove(&rectangle_ptr->wlr_scene_rect_node_destroy_listener.link);
}
/* == Unit Tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_create_destroy_scene(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_rectangle_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "create_destroy_scene", test_create_destroy_scene },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests setup and teardown of rectangle. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_rectangle_t *rectangle_ptr = wlmtk_rectangle_create(
NULL, 10, 20, 0x01020304);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, rectangle_ptr);
int x1, y1, x2, y2;
wlmtk_element_get_dimensions(
&rectangle_ptr->super_element, &x1, &y1, &x2, &y2);
BS_TEST_VERIFY_EQ(test_ptr, 0, x1);
BS_TEST_VERIFY_EQ(test_ptr, 0, y1);
BS_TEST_VERIFY_EQ(test_ptr, 10, x2);
BS_TEST_VERIFY_EQ(test_ptr, 20, y2);
BS_TEST_VERIFY_EQ(
test_ptr,
&rectangle_ptr->super_element,
wlmtk_rectangle_element(rectangle_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
rectangle_ptr,
wlmtk_rectangle_from_element(&rectangle_ptr->super_element));
wlmtk_rectangle_destroy(rectangle_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests setup and teardown of rectangle, when attached to scene graph. */
void test_create_destroy_scene(bs_test_t *test_ptr)
{
wlmtk_container_t *c_ptr = wlmtk_container_create_fake_parent();
wlmtk_rectangle_t *rectangle_ptr = wlmtk_rectangle_create(
NULL, 10, 20, 0x01020304);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, rectangle_ptr);
wlmtk_element_t *element_ptr = wlmtk_rectangle_element(rectangle_ptr);
wlmtk_container_add_element(c_ptr, element_ptr);
int x1, y1, x2, y2;
wlmtk_element_get_dimensions(element_ptr, &x1, &y1, &x2, &y2);
BS_TEST_VERIFY_EQ(test_ptr, 0, x1);
BS_TEST_VERIFY_EQ(test_ptr, 0, y1);
BS_TEST_VERIFY_EQ(test_ptr, 10, x2);
BS_TEST_VERIFY_EQ(test_ptr, 20, y2);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, rectangle_ptr->wlr_scene_rect_ptr);
wlmtk_container_remove_element(c_ptr, element_ptr);
wlmtk_element_destroy(element_ptr);
wlmtk_container_destroy_fake_parent(c_ptr);
}
/* == End of rectangle.c =================================================== */
wlmaker-0.3/src/toolkit/rectangle.h 0000664 0000000 0000000 00000004773 14641446446 0017437 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file rectangle.h
*
* @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.
*/
#ifndef __WLMTK_RECTANGLE_H__
#define __WLMTK_RECTANGLE_H__
#include "element.h"
#include "env.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration: Rectangle state. */
typedef struct _wlmtk_rectangle_t wlmtk_rectangle_t;
/**
* Creates a rectangle. Useful for margins and borders.
*
* @param env_ptr
* @param width
* @param height
* @param color
*
* @return Pointer to the rectangle state or NULL on error.
*/
wlmtk_rectangle_t *wlmtk_rectangle_create(
wlmtk_env_t *env_ptr,
int width,
int height,
uint32_t color);
/**
* Destroys the rectangle.
*
* @param rectangle_ptr
*/
void wlmtk_rectangle_destroy(wlmtk_rectangle_t *rectangle_ptr);
/**
* Sets (or updates) the size of the rectangle.
*
* @param rectangle_ptr
* @param width
* @param height
*/
void wlmtk_rectangle_set_size(
wlmtk_rectangle_t *rectangle_ptr,
int width,
int height);
/**
* Sets (or updates) the color of the rectangle.
*
* @param rectangle_ptr
* @param color
*/
void wlmtk_rectangle_set_color(
wlmtk_rectangle_t *rectangle_ptr,
uint32_t color);
/** Returns the superclass @ref wlmtk_element_t of the rectangle. */
wlmtk_element_t *wlmtk_rectangle_element(wlmtk_rectangle_t *rectangle_ptr);
/**
* Gets the @ref wlmtk_rectangle_t instance from it's element superclass.
*
* Requires `element_ptr` as pointer to @ref wlmtk_rectangle_t::super_element.
*
* @param element_ptr
*
* @return The pointer to the @ref wlmtk_rectangle_t instance.
*/
wlmtk_rectangle_t *wlmtk_rectangle_from_element(wlmtk_element_t *element_ptr);
/** Unit tests. */
extern const bs_test_case_t wlmtk_rectangle_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_RECTANGLE_H__ */
/* == End of rectangle.h =================================================== */
wlmaker-0.3/src/toolkit/resizebar.c 0000664 0000000 0000000 00000030325 14641446446 0017444 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file resizebar.c
*
* @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.
*/
#include "resizebar.h"
#include "box.h"
#include "buffer.h"
#include "gfxbuf.h"
#include "primitives.h"
#include "resizebar_area.h"
#include
#define WLR_USE_UNSTABLE
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the title bar. */
struct _wlmtk_resizebar_t {
/** Superclass: Box. */
wlmtk_box_t super_box;
/** Current width of the resize bar. */
unsigned width;
/** Style of the resize bar. */
wlmtk_resizebar_style_t style;
/** Background. */
bs_gfxbuf_t *gfxbuf_ptr;
/** Left element of the resizebar. */
wlmtk_resizebar_area_t *left_area_ptr;
/** Center element of the resizebar. */
wlmtk_resizebar_area_t *center_area_ptr;
/** Right element of the resizebar. */
wlmtk_resizebar_area_t *right_area_ptr;
};
static void _wlmtk_resizebar_element_destroy(wlmtk_element_t *element_ptr);
static bool redraw_buffers(wlmtk_resizebar_t *resizebar_ptr, unsigned width);
/* == Data ================================================================= */
/** Virtual method table extension for the resizebar's element superclass. */
static const wlmtk_element_vmt_t resizebar_element_vmt = {
.destroy = _wlmtk_resizebar_element_destroy,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_resizebar_t *wlmtk_resizebar_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr,
const wlmtk_resizebar_style_t *style_ptr)
{
static const wlmtk_margin_style_t empty_margin_style = {};
wlmtk_resizebar_t *resizebar_ptr = logged_calloc(
1, sizeof(wlmtk_resizebar_t));
if (NULL == resizebar_ptr) return NULL;
memcpy(&resizebar_ptr->style, style_ptr, sizeof(wlmtk_resizebar_style_t));
if (!wlmtk_box_init(&resizebar_ptr->super_box,
env_ptr,
WLMTK_BOX_HORIZONTAL,
&empty_margin_style)) {
wlmtk_resizebar_destroy(resizebar_ptr);
return NULL;
}
wlmtk_element_extend(
&resizebar_ptr->super_box.super_container.super_element,
&resizebar_element_vmt);
resizebar_ptr->left_area_ptr = wlmtk_resizebar_area_create(
window_ptr, env_ptr, WLR_EDGE_LEFT | WLR_EDGE_BOTTOM);
if (NULL == resizebar_ptr->left_area_ptr) {
wlmtk_resizebar_destroy(resizebar_ptr);
return NULL;
}
wlmtk_box_add_element_front(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->left_area_ptr));
resizebar_ptr->center_area_ptr = wlmtk_resizebar_area_create(
window_ptr, env_ptr, WLR_EDGE_BOTTOM);
if (NULL == resizebar_ptr->center_area_ptr) {
wlmtk_resizebar_destroy(resizebar_ptr);
return NULL;
}
wlmtk_box_add_element_back(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->center_area_ptr));
resizebar_ptr->right_area_ptr = wlmtk_resizebar_area_create(
window_ptr, env_ptr, WLR_EDGE_RIGHT | WLR_EDGE_BOTTOM);
if (NULL == resizebar_ptr->right_area_ptr) {
wlmtk_resizebar_destroy(resizebar_ptr);
return NULL;
}
wlmtk_box_add_element_back(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->right_area_ptr));
return resizebar_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_resizebar_destroy(wlmtk_resizebar_t *resizebar_ptr)
{
if (NULL != resizebar_ptr->right_area_ptr) {
wlmtk_box_remove_element(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->right_area_ptr));
wlmtk_resizebar_area_destroy(resizebar_ptr->right_area_ptr);
resizebar_ptr->right_area_ptr = NULL;
}
if (NULL != resizebar_ptr->center_area_ptr) {
wlmtk_box_remove_element(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->center_area_ptr));
wlmtk_resizebar_area_destroy(resizebar_ptr->center_area_ptr);
resizebar_ptr->center_area_ptr = NULL;
}
if (NULL != resizebar_ptr->left_area_ptr) {
wlmtk_box_remove_element(
&resizebar_ptr->super_box,
wlmtk_resizebar_area_element(resizebar_ptr->left_area_ptr));
wlmtk_resizebar_area_destroy(resizebar_ptr->left_area_ptr);
resizebar_ptr->left_area_ptr = NULL;
}
if (NULL != resizebar_ptr->gfxbuf_ptr) {
bs_gfxbuf_destroy(resizebar_ptr->gfxbuf_ptr);
resizebar_ptr->gfxbuf_ptr = NULL;
}
wlmtk_box_fini(&resizebar_ptr->super_box);
free(resizebar_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_resizebar_set_width(
wlmtk_resizebar_t *resizebar_ptr,
unsigned width)
{
if (resizebar_ptr->width == width) return true;
if (!redraw_buffers(resizebar_ptr, width)) return false;
BS_ASSERT(width == resizebar_ptr->width);
BS_ASSERT(width == resizebar_ptr->gfxbuf_ptr->width);
int right_corner_width = BS_MIN(
(int)width, (int)resizebar_ptr->style.corner_width);
int left_corner_width = BS_MAX(
0, BS_MIN((int)width - right_corner_width,
(int)resizebar_ptr->style.corner_width));
int center_width = BS_MAX(
0, (int)width - right_corner_width - left_corner_width);
wlmtk_element_set_visible(
wlmtk_resizebar_area_element(resizebar_ptr->left_area_ptr),
0 < left_corner_width);
wlmtk_element_set_visible(
wlmtk_resizebar_area_element(resizebar_ptr->center_area_ptr),
0 < center_width);
wlmtk_element_set_visible(
wlmtk_resizebar_area_element(resizebar_ptr->right_area_ptr),
0 < right_corner_width);
if (!wlmtk_resizebar_area_redraw(
resizebar_ptr->left_area_ptr,
resizebar_ptr->gfxbuf_ptr,
0, left_corner_width,
&resizebar_ptr->style)) {
return false;
}
if (!wlmtk_resizebar_area_redraw(
resizebar_ptr->center_area_ptr,
resizebar_ptr->gfxbuf_ptr,
left_corner_width, center_width,
&resizebar_ptr->style)) {
return false;
}
if (!wlmtk_resizebar_area_redraw(
resizebar_ptr->right_area_ptr,
resizebar_ptr->gfxbuf_ptr,
left_corner_width + center_width, right_corner_width,
&resizebar_ptr->style)) {
return false;
}
wlmtk_container_update_layout(&resizebar_ptr->super_box.super_container);
return true;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_resizebar_element(wlmtk_resizebar_t *resizebar_ptr)
{
return &resizebar_ptr->super_box.super_container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Virtual destructor: Wraps to our dtor. */
void _wlmtk_resizebar_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_resizebar_t *resizebar_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_resizebar_t,
super_box.super_container.super_element);
wlmtk_resizebar_destroy(resizebar_ptr);
}
/* ------------------------------------------------------------------------- */
/** Redraws the resizebar's background in appropriate size. */
bool redraw_buffers(wlmtk_resizebar_t *resizebar_ptr, unsigned width)
{
cairo_t *cairo_ptr;
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(
width, resizebar_ptr->style.height);
if (NULL == gfxbuf_ptr) return false;
cairo_ptr = cairo_create_from_bs_gfxbuf(gfxbuf_ptr);
if (NULL == cairo_ptr) {
bs_gfxbuf_destroy(gfxbuf_ptr);
return false;
}
wlmaker_primitives_cairo_fill(cairo_ptr, &resizebar_ptr->style.fill);
cairo_destroy(cairo_ptr);
if (NULL != resizebar_ptr->gfxbuf_ptr) {
bs_gfxbuf_destroy(resizebar_ptr->gfxbuf_ptr);
}
resizebar_ptr->gfxbuf_ptr = gfxbuf_ptr;
resizebar_ptr->width = width;
return true;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_variable_width(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_resizebar_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "variable_width", test_variable_width },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises @ref wlmtk_resizebar_create and @ref wlmtk_resizebar_destroy. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_resizebar_style_t style = {};
wlmtk_resizebar_t *resizebar_ptr = wlmtk_resizebar_create(
NULL, fake_window_ptr->window_ptr, &style);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, resizebar_ptr);
wlmtk_element_destroy(wlmtk_resizebar_element(resizebar_ptr));
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Performs resizing and verifies the elements are shown as expected. */
void test_variable_width(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_resizebar_style_t style = { .height = 7, .corner_width = 16 };
wlmtk_resizebar_t *resizebar_ptr = wlmtk_resizebar_create(
NULL, fake_window_ptr->window_ptr, &style);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, resizebar_ptr);
wlmtk_element_t *left_elem_ptr = wlmtk_resizebar_area_element(
resizebar_ptr->left_area_ptr);
wlmtk_element_t *center_elem_ptr = wlmtk_resizebar_area_element(
resizebar_ptr->center_area_ptr);
wlmtk_element_t *right_elem_ptr = wlmtk_resizebar_area_element(
resizebar_ptr->right_area_ptr);
// Zero width. Zero visibility.
BS_TEST_VERIFY_FALSE(test_ptr, left_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, center_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, right_elem_ptr->visible);
// Sufficient space for all the elements.
BS_TEST_VERIFY_TRUE(
test_ptr, wlmtk_resizebar_set_width(resizebar_ptr, 33));
BS_TEST_VERIFY_TRUE(test_ptr, left_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, center_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, right_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 16, center_elem_ptr->x);
BS_TEST_VERIFY_EQ(test_ptr, 17, right_elem_ptr->x);
// Not enough space for the center element with all margins.
BS_TEST_VERIFY_TRUE(
test_ptr, wlmtk_resizebar_set_width(resizebar_ptr, 32));
BS_TEST_VERIFY_TRUE(test_ptr, left_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, center_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, right_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 16, right_elem_ptr->x);
// Not enough space for center and left element.
BS_TEST_VERIFY_TRUE(
test_ptr, wlmtk_resizebar_set_width(resizebar_ptr, 16));
BS_TEST_VERIFY_FALSE(test_ptr, left_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, center_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, right_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 0, right_elem_ptr->x);
wlmtk_element_destroy(wlmtk_resizebar_element(resizebar_ptr));
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of resizebar.c =================================================== */
wlmaker-0.3/src/toolkit/resizebar.h 0000664 0000000 0000000 00000005037 14641446446 0017453 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file resizebar.h
*
* @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.
*/
#ifndef __WLMTK_RESIZEBAR_H__
#define __WLMTK_RESIZEBAR_H__
/** Forward declaration: Title bar. */
typedef struct _wlmtk_resizebar_t wlmtk_resizebar_t;
/** Forward declaration. */
struct wlr_cursor;
/** Forward declaration. */
struct wlr_xcursor_manager;
#include "element.h"
#include "primitives.h"
/** Style options for the resizebar. */
typedef struct {
/** Fill style for the complete resizebar. */
wlmtk_style_fill_t fill;
/** Height of the resize bar. */
uint64_t height;
/** Width of the corners. */
uint64_t corner_width;
/** Width of the bezel. */
uint64_t bezel_width;
} wlmtk_resizebar_style_t;
#include "window.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates the resize bar.
*
* @param env_ptr
* @param window_ptr
* @param style_ptr
*
* @return Pointer to the resizebar state, or NULL on error.
*/
wlmtk_resizebar_t *wlmtk_resizebar_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr,
const wlmtk_resizebar_style_t *style_ptr);
/**
* Destroys the resize bar.
*
* @param resizebar_ptr
*/
void wlmtk_resizebar_destroy(wlmtk_resizebar_t *resizebar_ptr);
/**
* Sets the width of the resize bar.
*
* @param resizebar_ptr
* @param width
*
* @return true on success.
*/
bool wlmtk_resizebar_set_width(
wlmtk_resizebar_t * resizebar_ptr,
unsigned width);
/**
* Returns the super Element of the resizebar.
*
* @param resizebar_ptr
*
* @return Pointer to the element.
*/
wlmtk_element_t *wlmtk_resizebar_element(wlmtk_resizebar_t *resizebar_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_resizebar_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_RESIZEBAR_H__ */
/* == End of resizebar.h ================================================== */
wlmaker-0.3/src/toolkit/resizebar_area.c 0000664 0000000 0000000 00000030050 14641446446 0020427 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file resizebar_area.c
*
* @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.
*/
#include "resizebar_area.h"
#include "box.h"
#include "buffer.h"
#include "gfxbuf.h"
#include "primitives.h"
#include "window.h"
#include
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of an element of the resize bar. */
struct _wlmtk_resizebar_area_t {
/** Superclass: Buffer. */
wlmtk_buffer_t super_buffer;
/** Original virtual method table of the superclass element. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** WLR buffer holding the buffer in released state. */
struct wlr_buffer *released_wlr_buffer_ptr;
/** WLR buffer holding the buffer in pressed state. */
struct wlr_buffer *pressed_wlr_buffer_ptr;
/** Whether the area is currently pressed or not. */
bool pressed;
/** Window to which the resize bar area belongs. To initiate resizing. */
wlmtk_window_t *window_ptr;
/** Edges that the resizebar area controls. */
uint32_t edges;
/** The cursor to use when having pointer focus. */
wlmtk_env_cursor_t cursor;
};
static void _wlmtk_resizebar_area_element_destroy(
wlmtk_element_t *element_ptr);
static bool _wlmtk_resizebar_area_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
static bool _wlmtk_resizebar_area_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void draw_state(wlmtk_resizebar_area_t *resizebar_area_ptr);
static struct wlr_buffer *create_buffer(
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
const wlmtk_resizebar_style_t *style_ptr,
bool pressed);
/* ========================================================================= */
/** Buffer implementation for title of the title bar. */
static const wlmtk_element_vmt_t resizebar_area_element_vmt = {
.destroy = _wlmtk_resizebar_area_element_destroy,
.pointer_motion = _wlmtk_resizebar_area_element_pointer_motion,
.pointer_button = _wlmtk_resizebar_area_element_pointer_button,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_resizebar_area_t *wlmtk_resizebar_area_create(
wlmtk_window_t *window_ptr,
wlmtk_env_t *env_ptr,
uint32_t edges)
{
wlmtk_resizebar_area_t *resizebar_area_ptr = logged_calloc(
1, sizeof(wlmtk_resizebar_area_t));
if (NULL == resizebar_area_ptr) return NULL;
BS_ASSERT(NULL != window_ptr);
resizebar_area_ptr->window_ptr = window_ptr;
resizebar_area_ptr->edges = edges;
resizebar_area_ptr->cursor = WLMTK_CURSOR_DEFAULT;
switch (resizebar_area_ptr->edges) {
case WLR_EDGE_BOTTOM:
resizebar_area_ptr->cursor = WLMTK_CURSOR_RESIZE_S;
break;
case WLR_EDGE_BOTTOM | WLR_EDGE_LEFT:
resizebar_area_ptr->cursor = WLMTK_CURSOR_RESIZE_SW;
break;
case WLR_EDGE_BOTTOM | WLR_EDGE_RIGHT:
resizebar_area_ptr->cursor = WLMTK_CURSOR_RESIZE_SE;
break;
default:
bs_log(BS_ERROR, "Unsupported edge %"PRIx32, edges);
}
if (!wlmtk_buffer_init(&resizebar_area_ptr->super_buffer, env_ptr)) {
wlmtk_resizebar_area_destroy(resizebar_area_ptr);
return NULL;
}
resizebar_area_ptr->orig_super_element_vmt = wlmtk_element_extend(
&resizebar_area_ptr->super_buffer.super_element,
&resizebar_area_element_vmt);
draw_state(resizebar_area_ptr);
return resizebar_area_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_resizebar_area_destroy(
wlmtk_resizebar_area_t *resizebar_area_ptr)
{
wlr_buffer_drop_nullify(
&resizebar_area_ptr->released_wlr_buffer_ptr);
wlr_buffer_drop_nullify(
&resizebar_area_ptr->pressed_wlr_buffer_ptr);
wlmtk_buffer_fini(&resizebar_area_ptr->super_buffer);
free(resizebar_area_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_resizebar_area_redraw(
wlmtk_resizebar_area_t *resizebar_area_ptr,
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
const wlmtk_resizebar_style_t *style_ptr)
{
struct wlr_buffer *released_wlr_buffer_ptr = create_buffer(
gfxbuf_ptr, position, width, style_ptr, false);
struct wlr_buffer *pressed_wlr_buffer_ptr = create_buffer(
gfxbuf_ptr, position, width, style_ptr, true);
if (NULL == released_wlr_buffer_ptr ||
NULL == pressed_wlr_buffer_ptr) {
wlr_buffer_drop_nullify(&released_wlr_buffer_ptr);
wlr_buffer_drop_nullify(&pressed_wlr_buffer_ptr);
return false;
}
wlr_buffer_drop_nullify(
&resizebar_area_ptr->released_wlr_buffer_ptr);
resizebar_area_ptr->released_wlr_buffer_ptr = released_wlr_buffer_ptr;
wlr_buffer_drop_nullify(
&resizebar_area_ptr->pressed_wlr_buffer_ptr);
resizebar_area_ptr->pressed_wlr_buffer_ptr = pressed_wlr_buffer_ptr;
draw_state(resizebar_area_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_resizebar_area_element(
wlmtk_resizebar_area_t *resizebar_area_ptr)
{
return &resizebar_area_ptr->super_buffer.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Dtor. */
void _wlmtk_resizebar_area_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_resizebar_area_t *resizebar_area_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_resizebar_area_t, super_buffer.super_element);
wlmtk_resizebar_area_destroy(resizebar_area_ptr);
}
/* ------------------------------------------------------------------------- */
/** See @ref wlmtk_element_vmt_t::pointer_motion. */
bool _wlmtk_resizebar_area_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
wlmtk_resizebar_area_t *resizebar_area_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_resizebar_area_t, super_buffer.super_element);
resizebar_area_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
wlmtk_env_set_cursor(element_ptr->env_ptr, resizebar_area_ptr->cursor);
return true;
}
/* ------------------------------------------------------------------------- */
/** See @ref wlmtk_element_vmt_t::pointer_button. */
bool _wlmtk_resizebar_area_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_resizebar_area_t *resizebar_area_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_resizebar_area_t, super_buffer.super_element);
if (button_event_ptr->button != BTN_LEFT) return false;
switch (button_event_ptr->type) {
case WLMTK_BUTTON_DOWN:
resizebar_area_ptr->pressed = true;
wlmtk_window_request_resize(
resizebar_area_ptr->window_ptr,
resizebar_area_ptr->edges);
draw_state(resizebar_area_ptr);
break;
case WLMTK_BUTTON_UP:
resizebar_area_ptr->pressed = false;
draw_state(resizebar_area_ptr);
break;
default:
break;
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Draws the buffer in current state (released or pressed).
*
* @param resizebar_area_ptr
*/
void draw_state(wlmtk_resizebar_area_t *resizebar_area_ptr)
{
if (!resizebar_area_ptr->pressed) {
wlmtk_buffer_set(
&resizebar_area_ptr->super_buffer,
resizebar_area_ptr->released_wlr_buffer_ptr);
} else {
wlmtk_buffer_set(
&resizebar_area_ptr->super_buffer,
resizebar_area_ptr->pressed_wlr_buffer_ptr);
}
}
/* ------------------------------------------------------------------------- */
/**
* Creates a resizebar area texture.
*
* @param gfxbuf_ptr
* @param position
* @param width
* @param style_ptr
* @param pressed
*
* @return A pointer to a newly allocated `struct wlr_buffer`.
*/
struct wlr_buffer *create_buffer(
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
const wlmtk_resizebar_style_t *style_ptr,
bool pressed)
{
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
width, style_ptr->height);
if (NULL == wlr_buffer_ptr) return NULL;
bs_gfxbuf_copy_area(
bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr), 0, 0,
gfxbuf_ptr, position, 0, width, style_ptr->height);
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return false;
}
wlmaker_primitives_draw_bezel_at(
cairo_ptr, 0, 0, width,
style_ptr->height, style_ptr->bezel_width, !pressed);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* == Unit tests =========================================================== */
static void test_area(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_resizebar_area_test_cases[] = {
{ 1, "area", test_area },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests the area behaviour. */
void test_area(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_resizebar_area_t *area_ptr = wlmtk_resizebar_area_create(
fake_window_ptr->window_ptr, NULL, WLR_EDGE_BOTTOM);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, area_ptr);
wlmtk_element_t *element_ptr = wlmtk_resizebar_area_element(area_ptr);
// Draw and verify release state.
wlmtk_resizebar_style_t style = { .height = 7, .bezel_width = 1.0 };
bs_gfxbuf_t *gfxbuf_ptr = bs_gfxbuf_create(30, 7);
bs_gfxbuf_clear(gfxbuf_ptr, 0xff604020);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_resizebar_area_redraw(area_ptr, gfxbuf_ptr, 10, 12, &style));
bs_gfxbuf_destroy(gfxbuf_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(area_ptr->super_buffer.wlr_buffer_ptr),
"toolkit/resizebar_area_released.png");
BS_TEST_VERIFY_FALSE(test_ptr, fake_window_ptr->request_resize_called);
// Pointer must be inside the button for accepting DOWN.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 1, 1, 0));
// Button down: pressed.
wlmtk_button_event_t button = {
.button = BTN_LEFT, .type = WLMTK_BUTTON_DOWN
};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &button));
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(area_ptr->super_buffer.wlr_buffer_ptr),
"toolkit/resizebar_area_pressed.png");
// TODO(kaeser@gubbe.ch): Should verify setting the cursor.
BS_TEST_VERIFY_TRUE(test_ptr, fake_window_ptr->request_resize_called);
BS_TEST_VERIFY_EQ(
test_ptr,
WLR_EDGE_BOTTOM,
fake_window_ptr->request_resize_edges);
wlmtk_element_destroy(element_ptr);
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of resizebar_area.c ============================================== */
wlmaker-0.3/src/toolkit/resizebar_area.h 0000664 0000000 0000000 00000004404 14641446446 0020440 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file resizebar_area.h
*
* @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.
*/
#ifndef __WLMTK_RESIZEBAR_AREA_H__
#define __WLMTK_RESIZEBAR_AREA_H__
#include
/** Forward declaration: Element of the resizebar. */
typedef struct _wlmtk_resizebar_area_t wlmtk_resizebar_area_t ;
#include "resizebar.h"
#include "window.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a resizebar button.
*
* @param window_ptr
* @param env_ptr
* @param edges
*
* @return Pointer to the resizebar button.
*/
wlmtk_resizebar_area_t *wlmtk_resizebar_area_create(
wlmtk_window_t *window_ptr,
wlmtk_env_t *env_ptr,
uint32_t edges);
/**
* Destroys the resizebar element.
*
* @param resizebar_area_ptr
*/
void wlmtk_resizebar_area_destroy(
wlmtk_resizebar_area_t *resizebar_area_ptr);
/**
* Redraws the element, with updated position and width.
*
* @param resizebar_area_ptr
* @param gfxbuf_ptr
* @param position
* @param width
* @param style_ptr
*
* @return true on success.
*/
bool wlmtk_resizebar_area_redraw(
wlmtk_resizebar_area_t *resizebar_area_ptr,
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
const wlmtk_resizebar_style_t *style_ptr);
/** Returns the button's super_buffer.super_element address. */
wlmtk_element_t *wlmtk_resizebar_area_element(
wlmtk_resizebar_area_t *resizebar_area_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_resizebar_area_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_RESIZEBAR_AREA_H__ */
/* == End of resizebar_area.h ============================================== */
wlmaker-0.3/src/toolkit/root.c 0000664 0000000 0000000 00000065707 14641446446 0016455 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file root.c
*
* @copyright
* Copyright 2024 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.
*/
#include "root.h"
#define WLR_USE_UNSTABLE
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the root element. */
struct _wlmtk_root_t {
/** The root's container: Holds workspaces and the curtain. */
wlmtk_container_t container;
/** Overwritten virtual method table before extending ig. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Extents to be used by root. */
struct wlr_box extents;
/** Events availabe of the root. */
wlmtk_root_events_t events;
/** Whether the root is currently locked. */
bool locked;
/** Reference to the lock, see @ref wlmtk_root_lock. */
wlmtk_lock_t *lock_ptr;
/** Curtain element: Permit dimming or hiding everything. */
wlmtk_rectangle_t *curtain_rectangle_ptr;
/** List of workspaces attached to root. @see wlmtk_workspace_t::dlnode. */
bs_dllist_t workspaces;
/** Currently-active workspace. */
wlmtk_workspace_t *current_workspace_ptr;
};
static void _wlmtk_root_switch_to_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr);
static void _wlmtk_root_set_workspace_extents(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr);
static void _wlmtk_root_enumerate_workspaces(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr);
static void _wlmtk_root_destroy_workspace(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr);
static bool _wlmtk_root_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
static bool _wlmtk_root_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static bool _wlmtk_root_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static bool _wlmtk_root_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
/** Virtual method table for the container's super class: Element. */
static const wlmtk_element_vmt_t _wlmtk_root_element_vmt = {
.pointer_motion = _wlmtk_root_element_pointer_motion,
.pointer_button = _wlmtk_root_element_pointer_button,
.pointer_axis = _wlmtk_root_element_pointer_axis,
.keyboard_event = _wlmtk_root_element_keyboard_event,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_root_t *wlmtk_root_create(
struct wlr_scene *wlr_scene_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_root_t *root_ptr = logged_calloc(1, sizeof(wlmtk_root_t));
if (NULL == root_ptr) return NULL;
if (!wlmtk_container_init_attached(
&root_ptr->container,
env_ptr,
&wlr_scene_ptr->tree)) {
wlmtk_root_destroy(root_ptr);
return NULL;
}
wlmtk_element_set_visible(&root_ptr->container.super_element, true);
root_ptr->orig_super_element_vmt = wlmtk_element_extend(
&root_ptr->container.super_element,
&_wlmtk_root_element_vmt);
root_ptr->curtain_rectangle_ptr = wlmtk_rectangle_create(
env_ptr, root_ptr->extents.width, root_ptr->extents.height, 0xff000020);
if (NULL == root_ptr->curtain_rectangle_ptr) {
wlmtk_root_destroy(root_ptr);
return NULL;
}
wlmtk_container_add_element(
&root_ptr->container,
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr));
wl_signal_init(&root_ptr->events.workspace_changed);
wl_signal_init(&root_ptr->events.unlock_event);
wl_signal_init(&root_ptr->events.window_mapped);
wl_signal_init(&root_ptr->events.window_unmapped);
return root_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_destroy(wlmtk_root_t *root_ptr)
{
bs_dllist_for_each(
&root_ptr->workspaces,
_wlmtk_root_destroy_workspace,
root_ptr);
if (NULL != root_ptr->curtain_rectangle_ptr) {
wlmtk_container_remove_element(
&root_ptr->container,
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr));
wlmtk_rectangle_destroy(root_ptr->curtain_rectangle_ptr);
root_ptr->curtain_rectangle_ptr = NULL;
}
wlmtk_container_fini(&root_ptr->container);
free(root_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_root_events_t *wlmtk_root_events(wlmtk_root_t *root_ptr)
{
return &root_ptr->events;
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_set_extents(
wlmtk_root_t *root_ptr,
const struct wlr_box *extents_ptr)
{
root_ptr->extents = *extents_ptr;
wlmtk_rectangle_set_size(
root_ptr->curtain_rectangle_ptr,
root_ptr->extents.width,
root_ptr->extents.height);
bs_dllist_for_each(
&root_ptr->workspaces, _wlmtk_root_set_workspace_extents,
&root_ptr->extents);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_root_pointer_motion(
wlmtk_root_t *root_ptr,
double x,
double y,
uint32_t time_msec)
{
return wlmtk_element_pointer_motion(
&root_ptr->container.super_element, x, y, time_msec);
}
/* ------------------------------------------------------------------------- */
// TODO(kaeser@gubbe.ch): Improve this, has multiple bugs: It won't keep
// different buttons apart, and there's currently no test associated.
bool wlmtk_root_pointer_button(
wlmtk_root_t *root_ptr,
const struct wlr_pointer_button_event *event_ptr)
{
wlmtk_button_event_t event;
// Guard clause: nothing to pass on if no element has the focus.
event.button = event_ptr->button;
event.time_msec = event_ptr->time_msec;
if (WLR_BUTTON_PRESSED == event_ptr->state) {
event.type = WLMTK_BUTTON_DOWN;
return wlmtk_element_pointer_button(
&root_ptr->container.super_element, &event);
} else if (WLR_BUTTON_RELEASED == event_ptr->state) {
event.type = WLMTK_BUTTON_UP;
wlmtk_element_pointer_button(
&root_ptr->container.super_element, &event);
event.type = WLMTK_BUTTON_CLICK;
return wlmtk_element_pointer_button(
&root_ptr->container.super_element, &event);
}
bs_log(BS_WARNING,
"Root %p: Unhandled state 0x%x for button 0x%x",
root_ptr, event_ptr->state, event_ptr->button);
return false;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_root_pointer_axis(
wlmtk_root_t *root_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
return wlmtk_element_pointer_axis(
&root_ptr->container.super_element,
wlr_pointer_axis_event_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_add_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr)
{
BS_ASSERT(NULL == wlmtk_workspace_get_root(workspace_ptr));
wlmtk_container_add_element(
&root_ptr->container,
wlmtk_workspace_element(workspace_ptr));
// Keep the curtain on top.
wlmtk_container_remove_element(
&root_ptr->container,
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr));
wlmtk_container_add_element(
&root_ptr->container,
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr));
bs_dllist_push_back(
&root_ptr->workspaces,
wlmtk_dlnode_from_workspace(workspace_ptr));
wlmtk_workspace_set_details(
workspace_ptr, bs_dllist_size(&root_ptr->workspaces));
wlmtk_workspace_set_root(workspace_ptr, root_ptr);
wlmtk_workspace_set_extents(workspace_ptr, &root_ptr->extents);
if (NULL == root_ptr->current_workspace_ptr) {
_wlmtk_root_switch_to_workspace(root_ptr, workspace_ptr);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_remove_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr)
{
BS_ASSERT(root_ptr == wlmtk_workspace_get_root(workspace_ptr));
wlmtk_workspace_set_root(workspace_ptr, NULL);
bs_dllist_remove(
&root_ptr->workspaces,
wlmtk_dlnode_from_workspace(workspace_ptr));
wlmtk_container_remove_element(
&root_ptr->container,
wlmtk_workspace_element(workspace_ptr));
wlmtk_element_set_visible(
wlmtk_workspace_element(workspace_ptr), false);
if (root_ptr->current_workspace_ptr == workspace_ptr) {
_wlmtk_root_switch_to_workspace(
root_ptr,
wlmtk_workspace_from_dlnode(root_ptr->workspaces.head_ptr));
}
int index = 0;
bs_dllist_for_each(
&root_ptr->workspaces,
_wlmtk_root_enumerate_workspaces,
&index);
}
/* ------------------------------------------------------------------------- */
wlmtk_workspace_t *wlmtk_root_get_current_workspace(wlmtk_root_t *root_ptr)
{
return root_ptr->current_workspace_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_switch_to_next_workspace(wlmtk_root_t *root_ptr)
{
if (NULL == root_ptr->current_workspace_ptr) return;
bs_dllist_node_t *dlnode_ptr = wlmtk_dlnode_from_workspace(
root_ptr->current_workspace_ptr);
if (NULL == dlnode_ptr->next_ptr) {
dlnode_ptr = root_ptr->workspaces.head_ptr;
} else {
dlnode_ptr = dlnode_ptr->next_ptr;
}
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_from_dlnode(dlnode_ptr);
_wlmtk_root_switch_to_workspace(root_ptr, workspace_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_switch_to_previous_workspace(wlmtk_root_t *root_ptr)
{
if (NULL == root_ptr->current_workspace_ptr) return;
bs_dllist_node_t *dlnode_ptr = wlmtk_dlnode_from_workspace(
root_ptr->current_workspace_ptr);
if (NULL == dlnode_ptr->prev_ptr) {
dlnode_ptr = root_ptr->workspaces.tail_ptr;
} else {
dlnode_ptr = dlnode_ptr->prev_ptr;
}
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_from_dlnode(dlnode_ptr);
_wlmtk_root_switch_to_workspace(root_ptr, workspace_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_root_lock(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr)
{
if (root_ptr->locked) {
bs_log(BS_WARNING, "Root already locked by %p", root_ptr->lock_ptr);
return false;
}
wlmtk_rectangle_set_size(
root_ptr->curtain_rectangle_ptr,
root_ptr->extents.width, root_ptr->extents.height);
wlmtk_element_set_visible(
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr),
true);
wlmtk_container_add_element(
&root_ptr->container,
wlmtk_lock_element(lock_ptr));
root_ptr->lock_ptr = lock_ptr;
root_ptr->locked = true;
return true;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_root_unlock(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr)
{
// Guard clause: Not locked => nothing to do.
if (!root_ptr->locked) return false;
if (lock_ptr != root_ptr->lock_ptr) {
bs_log(BS_ERROR, "Lock held by %p, but attempted to unlock by %p",
root_ptr->lock_ptr, lock_ptr);
return false;
}
wlmtk_root_lock_unreference(root_ptr, lock_ptr);
root_ptr->locked = false;
wlmtk_element_set_visible(
wlmtk_rectangle_element(root_ptr->curtain_rectangle_ptr),
false);
wl_signal_emit(&root_ptr->events.unlock_event, NULL);
// TODO(kaeser@gubbe.ch): Handle re-establishing keyboard focus better.
wlmtk_workspace_t *workspace_ptr = root_ptr->current_workspace_ptr;
if (NULL != wlmtk_workspace_get_activated_window(workspace_ptr)) {
wlmtk_element_t *el_ptr = wlmtk_window_element(
wlmtk_workspace_get_activated_window(workspace_ptr));
wlmtk_container_update_keyboard_focus(
el_ptr->parent_container_ptr, el_ptr);
}
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_lock_unreference(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr)
{
if (lock_ptr != root_ptr->lock_ptr) return;
wlmtk_container_remove_element(
&root_ptr->container,
wlmtk_lock_element(root_ptr->lock_ptr));
root_ptr->lock_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
void wlmtk_root_set_lock_surface(
__UNUSED__ wlmtk_root_t *root_ptr,
wlmtk_surface_t *surface_ptr)
{
wlmtk_surface_set_activated(surface_ptr, true);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_root_element(wlmtk_root_t *root_ptr)
{
return &root_ptr->container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Switches to `workspace_ptr` as the current workspace.
*
* @param root_ptr
* @param workspace_ptr
*/
void _wlmtk_root_switch_to_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr)
{
if (root_ptr->current_workspace_ptr == workspace_ptr) return;
if (NULL == workspace_ptr) {
root_ptr->current_workspace_ptr = NULL;
} else {
BS_ASSERT(root_ptr = wlmtk_workspace_get_root(workspace_ptr));
if (NULL != root_ptr->current_workspace_ptr) {
wlmtk_element_set_visible(
wlmtk_workspace_element(root_ptr->current_workspace_ptr),
false);
}
root_ptr->current_workspace_ptr = workspace_ptr;
wlmtk_element_set_visible(
wlmtk_workspace_element(root_ptr->current_workspace_ptr), true);
}
wl_signal_emit(
&root_ptr->events.workspace_changed,
root_ptr->current_workspace_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Callback for `bs_dllist_for_each` to set extents of the workspace.
*
* @param dlnode_ptr
* @param ud_ptr
*/
void _wlmtk_root_set_workspace_extents(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr)
{
wlmtk_workspace_set_extents(
wlmtk_workspace_from_dlnode(dlnode_ptr), ud_ptr);
}
/* ------------------------------------------------------------------------- */
/** Callback for bs_dllist_for_each: Destroys the workspace. */
void _wlmtk_root_destroy_workspace(bs_dllist_node_t *dlnode_ptr, void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_from_dlnode(dlnode_ptr);
wlmtk_root_remove_workspace(ud_ptr, workspace_ptr);
wlmtk_workspace_destroy(workspace_ptr);
}
/* ------------------------------------------------------------------------- */
/** Callback for bs_dllist_for_each: Enumerates the workspace. */
void _wlmtk_root_enumerate_workspaces(
bs_dllist_node_t *dlnode_ptr,
void *ud_ptr)
{
int *index_ptr = ud_ptr;
wlmtk_workspace_set_details(
wlmtk_workspace_from_dlnode(dlnode_ptr),
*index_ptr);
*index_ptr += 1;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_motion. Handle pointer moves.
*
* When locked, the root container will forward the events strictly only to
* the lock container.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*
* @return Whether the move was accepted.
*/
bool _wlmtk_root_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec)
{
wlmtk_root_t *root_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_root_t, container.super_element);
if (!root_ptr->locked) {
// TODO(kaeser@gubbe.ch): We'll want to pass this on to the non-curtain
// elements only.
return root_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
} else if (NULL != root_ptr->lock_ptr) {
return wlmtk_element_pointer_motion(
wlmtk_lock_element(root_ptr->lock_ptr),
x, y, time_msec);
}
// Fall-through.
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_button. Handle button events.
*
* When locked, the root container will forward the events strictly only to
* the lock container.
*
* @param element_ptr
* @param button_event_ptr
*
* @return true if the button was handled.
*/
bool _wlmtk_root_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_root_t *root_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_root_t, container.super_element);
if (!root_ptr->locked) {
// TODO(kaeser@gubbe.ch): We'll want to pass this on to the non-curtain
// elements only.
return root_ptr->orig_super_element_vmt.pointer_button(
element_ptr, button_event_ptr);
} else if (NULL != root_ptr->lock_ptr) {
return wlmtk_element_pointer_button(
wlmtk_lock_element(root_ptr->lock_ptr),
button_event_ptr);
}
// Fall-through.
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::pointer_axis. Handle axis events.
*
* When locked, the root container will forward the events strictly only to
* the lock container.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return true if the axis event was handled.
*/
bool _wlmtk_root_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmtk_root_t *root_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_root_t, container.super_element);
if (!root_ptr->locked) {
// TODO(kaeser@gubbe.ch): We'll want to pass this on to the non-curtain
// elements only.
return root_ptr->orig_super_element_vmt.pointer_axis(
element_ptr, wlr_pointer_axis_event_ptr);
} else if (NULL != root_ptr->lock_ptr) {
return wlmtk_element_pointer_axis(
wlmtk_lock_element(root_ptr->lock_ptr),
wlr_pointer_axis_event_ptr);
}
// Fall-through.
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::keyboard_event. Handle keyboard events.
*
* When locked, the root container will forward the events strictly only to
* the lock container.
*
* @param element_ptr
* @param wlr_keyboard_key_event_ptr
* @param key_syms
* @param key_syms_count
* @param modifiers
*
* @return true if the axis event was handled.
*/
bool _wlmtk_root_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers)
{
wlmtk_root_t *root_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_root_t, container.super_element);
if (!root_ptr->locked) {
// TODO(kaeser@gubbe.ch): We'll want to pass this on to the non-curtain
// elements only.
return root_ptr->orig_super_element_vmt.keyboard_event(
element_ptr,
wlr_keyboard_key_event_ptr,
key_syms, key_syms_count, modifiers);
} else if (NULL != root_ptr->lock_ptr) {
return wlmtk_element_keyboard_event(
wlmtk_lock_element(root_ptr->lock_ptr),
wlr_keyboard_key_event_ptr,
key_syms, key_syms_count, modifiers);
}
// Fall-through: Too bad -- the screen is locked, but the lock element
// disappeared (crashed?). No more handling of keys here...
return false;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_workspaces(bs_test_t *test_ptr);
static void test_pointer_button(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_root_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "workspaces", test_workspaces },
{ 1, "pointer_button", test_pointer_button },
{ 0, NULL, NULL }
};
/** Helper struct for listeners in tests. */
typedef struct {
/** Listener. */
struct wl_listener listener;
/** Will be set to the `data_ptr` arg of the callback. */
wlmtk_workspace_t *workspace_ptr;
} _wlmtk_root_test_workspace_t;
/** Test helper callback for @ref wlmtk_root_events_t::workspace_changed. */
static void _wlmtk_root_test_workspace_changed_handler(
struct wl_listener *listener_ptr,
void *data_ptr)
{
_wlmtk_root_test_workspace_t *test_ws_ptr = BS_CONTAINER_OF(
listener_ptr, _wlmtk_root_test_workspace_t, listener);
test_ws_ptr->workspace_ptr = data_ptr;
}
/* ------------------------------------------------------------------------- */
/** Exercises ctor and dtor. */
void test_create_destroy(bs_test_t *test_ptr)
{
struct wlr_scene *wlr_scene_ptr = wlr_scene_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, wlr_scene_ptr);
wlmtk_root_t *root_ptr = wlmtk_root_create(wlr_scene_ptr, NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, root_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, &root_ptr->events, wlmtk_root_events(root_ptr));
struct wlr_box extents = { .width = 100, .height = 50 };
wlmtk_root_set_extents(root_ptr, &extents);
BS_TEST_VERIFY_EQ(test_ptr, 100, root_ptr->extents.width);
BS_TEST_VERIFY_EQ(test_ptr, 50, root_ptr->extents.height);
wlmtk_root_destroy(root_ptr);
free(wlr_scene_ptr);
}
/* ------------------------------------------------------------------------- */
/** Exercises workspace adding and removal. */
void test_workspaces(bs_test_t *test_ptr)
{
struct wlr_scene *wlr_scene_ptr = wlr_scene_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, wlr_scene_ptr);
wlmtk_root_t *root_ptr = wlmtk_root_create(wlr_scene_ptr, NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, root_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, NULL, wlmtk_root_get_current_workspace(root_ptr));
_wlmtk_root_test_workspace_t test_ws = {};
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(root_ptr)->workspace_changed,
&test_ws.listener,
_wlmtk_root_test_workspace_changed_handler);
wlmtk_workspace_t *ws1_ptr = wlmtk_workspace_create("1", NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, ws1_ptr);
wlmtk_root_add_workspace(root_ptr, ws1_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, ws1_ptr, wlmtk_root_get_current_workspace(root_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_workspace_element(ws1_ptr)->visible);
BS_TEST_VERIFY_EQ(
test_ptr, ws1_ptr, test_ws.workspace_ptr);
wlmtk_workspace_t *ws2_ptr = wlmtk_workspace_create("2", NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, ws2_ptr);
wlmtk_root_add_workspace(root_ptr, ws2_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, ws1_ptr, wlmtk_root_get_current_workspace(root_ptr));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_workspace_element(ws2_ptr)->visible);
wlmtk_root_remove_workspace(root_ptr, ws1_ptr);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_workspace_element(ws1_ptr)->visible);
wlmtk_workspace_destroy(ws1_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, ws2_ptr, wlmtk_root_get_current_workspace(root_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_workspace_element(ws2_ptr)->visible);
BS_TEST_VERIFY_EQ(
test_ptr, ws2_ptr, test_ws.workspace_ptr);
wlmtk_root_remove_workspace(root_ptr, ws2_ptr);
wlmtk_workspace_destroy(ws2_ptr);
BS_TEST_VERIFY_EQ(
test_ptr, NULL, wlmtk_root_get_current_workspace(root_ptr));
BS_TEST_VERIFY_EQ(
test_ptr, NULL, test_ws.workspace_ptr);
wlmtk_util_disconnect_listener(&test_ws.listener);
wlmtk_root_destroy(root_ptr);
free(wlr_scene_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests wlmtk_root_pointer_button. */
void test_pointer_button(bs_test_t *test_ptr)
{
wlmtk_fake_element_t *fake_element_ptr = wlmtk_fake_element_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, fake_element_ptr);
wlmtk_element_set_visible(&fake_element_ptr->element, true);
struct wlr_scene *wlr_scene_ptr = wlr_scene_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, wlr_scene_ptr);
wlmtk_root_t *root_ptr = wlmtk_root_create(wlr_scene_ptr, NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, root_ptr);
wlmtk_container_add_element(
&root_ptr->container, &fake_element_ptr->element);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_root_pointer_motion(root_ptr, 0, 0, 1234));
BS_TEST_VERIFY_TRUE(
test_ptr,
fake_element_ptr->pointer_motion_called);
// Verify that a button down event is passed.
struct wlr_pointer_button_event wlr_pointer_button_event = {
.button = 42,
.state = WLR_BUTTON_PRESSED,
.time_msec = 4321,
};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_root_pointer_button(root_ptr, &wlr_pointer_button_event));
wlmtk_button_event_t expected_event = {
.button = 42,
.type = WLMTK_BUTTON_DOWN,
.time_msec = 4321,
};
BS_TEST_VERIFY_MEMEQ(
test_ptr,
&expected_event,
&fake_element_ptr->pointer_button_event,
sizeof(wlmtk_button_event_t));
// The button up event should trigger a click.
wlr_pointer_button_event.state = WLR_BUTTON_RELEASED;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_root_pointer_button(root_ptr, &wlr_pointer_button_event));
expected_event.type = WLMTK_BUTTON_CLICK;
BS_TEST_VERIFY_MEMEQ(
test_ptr,
&expected_event,
&fake_element_ptr->pointer_button_event,
sizeof(wlmtk_button_event_t));
wlmtk_container_remove_element(
&root_ptr->container, &fake_element_ptr->element);
wlmtk_element_destroy(&fake_element_ptr->element);
wlmtk_root_destroy(root_ptr);
free(wlr_scene_ptr);
}
/* == End of root.c ======================================================== */
wlmaker-0.3/src/toolkit/root.h 0000664 0000000 0000000 00000014433 14641446446 0016450 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file root.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_ROOT_H__
#define __WLMTK_ROOT_H__
/** Forward declaration: Root element (technically: container). */
typedef struct _wlmtk_root_t wlmtk_root_t;
#include "lock.h"
#include "surface.h"
/** Forward declaration: Wlroots scene. */
struct wlr_scene;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Signals available for the @ref wlmtk_root_t class. */
typedef struct {
/**
* Signal: Raised when the current workspace is changed.
* Data: Pointer to the new `wlmaker_workspace_t`.
*/
struct wl_signal workspace_changed;
/** Triggers whenever @ref wlmtk_root_unlock succeeds. */
struct wl_signal unlock_event;
/** Triggers when a window is mapped to a workspace. */
struct wl_signal window_mapped;
/** Triggers when a window is unmapped from a workspace. */
struct wl_signal window_unmapped;
} wlmtk_root_events_t;
/**
* Creates the root element.
*
* @param wlr_scene_ptr
* @param env_ptr
*
* @return Handle of the root element or NULL on error.
*/
wlmtk_root_t *wlmtk_root_create(
struct wlr_scene *wlr_scene_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the root element.
*
* @param root_ptr
*/
void wlmtk_root_destroy(wlmtk_root_t *root_ptr);
/**
* Gets the set of events available in root. To bind listeners to.
*
* @param root_ptr
*
* @return Pointer to @ref wlmtk_root_t::events.
*/
wlmtk_root_events_t *wlmtk_root_events(wlmtk_root_t *root_ptr);
/**
* Sets the extents of root (and all workspaces thereof).
*
* @param root_ptr
* @param extents_ptr
*/
void wlmtk_root_set_extents(
wlmtk_root_t *root_ptr,
const struct wlr_box *extents_ptr);
/**
* Handles a pointer motion event.
*
* @param root_ptr
* @param x
* @param y
* @param time_msec
*
* @return Whether there was an element under the pointer.
*/
bool wlmtk_root_pointer_motion(
wlmtk_root_t *root_ptr,
double x,
double y,
uint32_t time_msec);
/**
* Handles a button event: Translates to button down/up/click/dblclick events.
*
* Each button activity (button pressed or released) will directly trigger a
* corresponding BUTTON_DOWN or BUTTON_UP event. Depending on timing and
* motion, a "released" event may also triccer a CLICK, DOUBLE_CLICK or
* DRAG event.
* These events will be forwarded to the event currently having pointer focus.
*
* TODO(kaeser@gubbe.ch): Implement DOUBLE_CLICK and DRAG events, and make it
* well tested.
*
* @param root_ptr
* @param event_ptr
*
* @return Whether the button was consumed.
*/
bool wlmtk_root_pointer_button(
wlmtk_root_t *root_ptr,
const struct wlr_pointer_button_event *event_ptr);
/**
* Handles a pointer axis event.
*
* @param root_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return Whether the axis event was consumed.
*/
bool wlmtk_root_pointer_axis(
wlmtk_root_t *root_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
/**
* Adds a workspace.
*
* @param root_ptr
* @param workspace_ptr
*/
void wlmtk_root_add_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr);
/**
* Removes the workspace.
*
* @param root_ptr
* @param workspace_ptr
*/
void wlmtk_root_remove_workspace(
wlmtk_root_t *root_ptr,
wlmtk_workspace_t *workspace_ptr);
/**
* Returns a pointer to the currently-active workspace.
*
* @param root_ptr
*/
wlmtk_workspace_t *wlmtk_root_get_current_workspace(wlmtk_root_t *root_ptr);
/**
* Switches to the next workspace.
*
* @param root_ptr
*/
void wlmtk_root_switch_to_next_workspace(wlmtk_root_t *root_ptr);
/**
* Switches to the previous workspace.
*
* @param root_ptr
*/
void wlmtk_root_switch_to_previous_workspace(wlmtk_root_t *root_ptr);
/**
* Locks the root, using the provided lock.
*
* The root must not be locked already. If locked successfully, the root will
* keep a reference to `lock_ptr`. The lock must call @ref wlmtk_root_unlock
* to unlock root, and for releasing the reference.
*
* @param root_ptr
* @param lock_ptr
*
* @return Whether the lock was established.
*/
bool wlmtk_root_lock(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr);
/**
* Unlocks the root, and releases the reference from @ref wlmtk_root_lock.
*
* Unlocking can only be done with `lock_ptr` matching the `lock_ptr` argument
* from @ref wlmtk_root_lock.
*
* @param root_ptr
* @param lock_ptr
*
* @return Whether the lock was lifted.
*/
bool wlmtk_root_unlock(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr);
/**
* Releases the lock reference, but keeps the root locked.
*
* This is in accordance with the session lock protocol specification [1],
* stating the session should remain locked if the client dies.
* This call is a no-op if `lock_ptr` is not currently the lock of `root_ptr`.
*
* [1] https://wayland.app/protocols/ext-session-lock-v1
*
* @param root_ptr
* @param lock_ptr
*/
void wlmtk_root_lock_unreference(
wlmtk_root_t *root_ptr,
wlmtk_lock_t *lock_ptr);
/**
* Temporary: Set the lock surface, so events get passed correctly.
*
* TODO(kaeser@gubbe.ch): Remove the method, events should get passed via
* the container.
*
* @param root_ptr
* @param surface_ptr
*/
void wlmtk_root_set_lock_surface(
wlmtk_root_t *root_ptr,
wlmtk_surface_t *surface_ptr);
/** @returns pointer to the root's @ref wlmtk_element_t. (Temporary) */
wlmtk_element_t *wlmtk_root_element(wlmtk_root_t *root_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_root_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_ROOT_H__ */
/* == End of root.h ======================================================== */
wlmaker-0.3/src/toolkit/style.c 0000664 0000000 0000000 00000002563 14641446446 0016621 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file style.c
*
* @copyright
* Copyright 2024 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.
*/
#include "style.h"
#include
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
cairo_font_weight_t wlmtk_style_font_weight_cairo_from_wlmtk(
wlmtk_style_font_weight_t weight)
{
switch (weight) {
case WLMTK_FONT_WEIGHT_NORMAL: return CAIRO_FONT_WEIGHT_NORMAL;
case WLMTK_FONT_WEIGHT_BOLD: return CAIRO_FONT_WEIGHT_BOLD;
default:
bs_log(BS_FATAL, "Unhandled font weight %d", weight);
BS_ABORT();
}
return CAIRO_FONT_WEIGHT_NORMAL;
}
/* == End of style.c ======================================================= */
wlmaker-0.3/src/toolkit/style.h 0000664 0000000 0000000 00000007156 14641446446 0016631 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file style.h
*
* @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.
*/
#ifndef __WLMTK_STYLE_H__
#define __WLMTK_STYLE_H__
#include
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Specifies the type of coloring to use for the fill. */
typedef enum {
/** Horizontal color gradient. */
WLMTK_STYLE_COLOR_SOLID,
/** Horizontal color gradient. */
WLMTK_STYLE_COLOR_HGRADIENT,
/** Vertical color gradient. */
WLMTK_STYLE_COLOR_VGRADIENT,
/** Diagonal color gradient, top-left to bottom-right. */
WLMTK_STYLE_COLOR_DGRADIENT
// TODO(kaeser@gubbe.ch): Add VGRADIENT.
} wlmtk_style_fill_type_t;
/** Specifies the color for a solid fill. */
typedef struct {
/** Color to start from, as ARGB 8888. Left, for the HGRADIENT type. */
uint32_t color;
} wlmtk_style_color_solid_data_t;
/** Specifies the two colors to span a gradient between. */
typedef struct {
/** Color to start from, as ARGB 8888. Left, for the HGRADIENT type. */
uint32_t from;
/** Color to end with, as ARGB 8888. Right, for the HGRADIENT type. */
uint32_t to;
} wlmtk_style_color_gradient_data_t;
/** Specification for the fill of the titlebar. */
typedef struct {
/** The type of fill to apply. */
wlmtk_style_fill_type_t type;
/** Parameters for the fill. */
union {
/** Solid color. */
wlmtk_style_color_solid_data_t solid;
/** Horizontal color gradient. */
wlmtk_style_color_gradient_data_t hgradient;
/** Vertical color gradient. */
wlmtk_style_color_gradient_data_t vgradient;
/** Diagonal color gradient. */
wlmtk_style_color_gradient_data_t dgradient;
} param;
} wlmtk_style_fill_t;
/** Hardcoded max length of the font face name. */
#define WLMTK_STYLE_FONT_FACE_LENGTH 128
/** Weight of a font. */
typedef enum {
WLMTK_FONT_WEIGHT_NORMAL,
WLMTK_FONT_WEIGHT_BOLD,
} wlmtk_style_font_weight_t;
/** Style of font. */
typedef struct {
/** Font face family name. */
char face[WLMTK_STYLE_FONT_FACE_LENGTH];
/** Weight. */
wlmtk_style_font_weight_t weight;
/** Size of the font, in pixels per "em" square side. */
uint64_t size;
} wlmtk_style_font_t;
/** Specifies color and width of a margin. */
typedef struct {
/** Width of the margin. */
uint64_t width;
/** Color of the margin. */
uint32_t color;
} wlmtk_margin_style_t;
/** Styling information for the dock. */
typedef struct {
/** The margin's style of the dock's box. */
wlmtk_margin_style_t margin;
} wlmtk_dock_style_t;
/** Translates the font weight from toolkit into cairo enum. */
cairo_font_weight_t wlmtk_style_font_weight_cairo_from_wlmtk(
wlmtk_style_font_weight_t weight);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_STYLE_H__ */
/* == End of style.h ================================================== */
wlmaker-0.3/src/toolkit/surface.c 0000664 0000000 0000000 00000070760 14641446446 0017115 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file surface.c
*
* @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.
*/
#include "surface.h"
#include "element.h"
#include "gfxbuf.h"
#include "util.h"
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
static bool _wlmtk_surface_init(
wlmtk_surface_t *surface_ptr,
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr);
static void _wlmtk_surface_fini(wlmtk_surface_t *surface_ptr);
static void _wlmtk_surface_element_destroy(wlmtk_element_t *element_ptr);
static struct wlr_scene_node *_wlmtk_surface_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
static void _wlmtk_surface_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static void _wlmtk_surface_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static void _wlmtk_surface_element_pointer_leave(wlmtk_element_t *element_ptr);
static bool _wlmtk_surface_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec);
static bool _wlmtk_surface_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static bool _wlmtk_surface_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static bool _wlmtk_surface_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
const xkb_keysym_t *key_syms,
size_t key_syms_count,
uint32_t modifiers);
static void _wlmtk_surface_handle_wlr_scene_tree_node_destroy(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_surface_handle_surface_commit(
struct wl_listener *listener_ptr,
void *data_ptr);
static void _wlmtk_surface_commit_size(
wlmtk_surface_t *surface_ptr,
int width,
int height);
/* == Data ================================================================= */
/** Method table for the element's virtual methods. */
static const wlmtk_element_vmt_t surface_element_vmt = {
.destroy = _wlmtk_surface_element_destroy,
.create_scene_node = _wlmtk_surface_element_create_scene_node,
.get_dimensions = _wlmtk_surface_element_get_dimensions,
.get_pointer_area = _wlmtk_surface_element_get_pointer_area,
.pointer_leave = _wlmtk_surface_element_pointer_leave,
.pointer_motion = _wlmtk_surface_element_pointer_motion,
.pointer_button = _wlmtk_surface_element_pointer_button,
.pointer_axis = _wlmtk_surface_element_pointer_axis,
.keyboard_event = _wlmtk_surface_element_keyboard_event,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_surface_t *wlmtk_surface_create(
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_surface_t *surface_ptr = logged_calloc(1, sizeof(wlmtk_surface_t));
if (NULL == surface_ptr) return NULL;
if (!_wlmtk_surface_init(surface_ptr, wlr_surface_ptr, env_ptr)) {
wlmtk_surface_destroy(surface_ptr);
return NULL;
}
return surface_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_surface_destroy(wlmtk_surface_t *surface_ptr)
{
_wlmtk_surface_fini(surface_ptr);
free(surface_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_surface_element(wlmtk_surface_t *surface_ptr)
{
return &surface_ptr->super_element;
}
/* ------------------------------------------------------------------------- */
void wlmtk_surface_get_size(
wlmtk_surface_t *surface_ptr,
int *width_ptr,
int *height_ptr)
{
if (NULL != width_ptr) *width_ptr = surface_ptr->committed_width;
if (NULL != height_ptr) *height_ptr = surface_ptr->committed_height;
}
/* ------------------------------------------------------------------------- */
void wlmtk_surface_set_activated(
wlmtk_surface_t *surface_ptr,
bool activated)
{
if (surface_ptr->activated == activated) return;
struct wlr_seat *wlr_seat_ptr = wlmtk_env_wlr_seat(surface_ptr->env_ptr);
struct wlr_keyboard *wlr_keyboard_ptr = wlr_seat_get_keyboard(wlr_seat_ptr);
if (activated) {
if (NULL != wlr_keyboard_ptr) {
wlr_seat_keyboard_notify_enter(
wlr_seat_ptr,
surface_ptr->wlr_surface_ptr,
wlr_keyboard_ptr->keycodes,
wlr_keyboard_ptr->num_keycodes,
&wlr_keyboard_ptr->modifiers);
}
wlmtk_container_update_keyboard_focus(
surface_ptr->super_element.parent_container_ptr,
&surface_ptr->super_element);
} else {
if (wlr_seat_ptr->keyboard_state.focused_surface ==
surface_ptr->wlr_surface_ptr) {
wlr_seat_keyboard_clear_focus(wlr_seat_ptr);
wlmtk_container_update_keyboard_focus(
surface_ptr->super_element.parent_container_ptr,
NULL);
}
}
surface_ptr->activated = activated;
}
/* ------------------------------------------------------------------------- */
void wlmtk_surface_connect_map_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler)
{
if (NULL == surface_ptr->wlr_surface_ptr) return;
wlmtk_util_connect_listener_signal(
&surface_ptr->wlr_surface_ptr->events.map,
listener_ptr,
handler);
}
/* ------------------------------------------------------------------------- */
void wlmtk_surface_connect_unmap_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler)
{
if (NULL == surface_ptr->wlr_surface_ptr) return;
wlmtk_util_connect_listener_signal(
&surface_ptr->wlr_surface_ptr->events.unmap,
listener_ptr,
handler);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Initializes the surface.
*
* @param surface_ptr
* @param wlr_surface_ptr
* @param env_ptr
*
* @return true on success.
*/
bool _wlmtk_surface_init(
wlmtk_surface_t *surface_ptr,
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr)
{
BS_ASSERT(NULL != surface_ptr);
memset(surface_ptr, 0, sizeof(wlmtk_surface_t));
if (!wlmtk_element_init(&surface_ptr->super_element, env_ptr)) {
_wlmtk_surface_fini(surface_ptr);
return false;
}
surface_ptr->orig_super_element_vmt = wlmtk_element_extend(
&surface_ptr->super_element, &surface_element_vmt);
surface_ptr->env_ptr = env_ptr;
surface_ptr->wlr_surface_ptr = wlr_surface_ptr;
if (NULL != surface_ptr->wlr_surface_ptr) {
wlmtk_util_connect_listener_signal(
&wlr_surface_ptr->events.commit,
&surface_ptr->surface_commit_listener,
_wlmtk_surface_handle_surface_commit);
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Un-initializes the surface.
*
* @param surface_ptr
*/
void _wlmtk_surface_fini(wlmtk_surface_t *surface_ptr)
{
if (NULL != surface_ptr->wlr_scene_tree_ptr) {
wlmtk_util_disconnect_listener(
&surface_ptr->wlr_scene_tree_node_destroy_listener);
}
if (NULL != surface_ptr->wlr_surface_ptr) {
surface_ptr->wlr_surface_ptr = NULL;
wlmtk_util_disconnect_listener(&surface_ptr->surface_commit_listener);
}
wlmtk_element_fini(&surface_ptr->super_element);
memset(surface_ptr, 0, sizeof(wlmtk_surface_t));
}
/* ------------------------------------------------------------------------- */
/** Implements @ref wlmtk_element_vmt_t::destroy. Calls the dtor. */
void _wlmtk_surface_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
wlmtk_surface_destroy(surface_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::create_scene_node. Creates the node.
*
* @param element_ptr
* @param wlr_scene_tree_ptr
*
* @return The scene graph API node of the node displaying the surface and all
* of it's sub-surfaces. Or NULL on error.
*/
struct wlr_scene_node *_wlmtk_surface_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
BS_ASSERT(NULL == surface_ptr->wlr_scene_tree_ptr);
surface_ptr->wlr_scene_tree_ptr = wlr_scene_subsurface_tree_create(
wlr_scene_tree_ptr, surface_ptr->wlr_surface_ptr);
if (NULL == surface_ptr->wlr_scene_tree_ptr) return NULL;
wlmtk_util_connect_listener_signal(
&surface_ptr->wlr_scene_tree_ptr->node.events.destroy,
&surface_ptr->wlr_scene_tree_node_destroy_listener,
_wlmtk_surface_handle_wlr_scene_tree_node_destroy);
return &surface_ptr->wlr_scene_tree_ptr->node;
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of the element's get_dimensions method: Return dimensions.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
void _wlmtk_surface_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
if (NULL != left_ptr) *left_ptr = 0;
if (NULL != top_ptr) *top_ptr = 0;
if (NULL != right_ptr) *right_ptr = surface_ptr->committed_width;
if (NULL != bottom_ptr) *bottom_ptr = surface_ptr->committed_height;
}
/* ------------------------------------------------------------------------- */
/**
* Overwrites the element's get_pointer_area method: Returns the extents of
* the surface and all subsurfaces.
*
* @param element_ptr
* @param left_ptr Leftmost position. May be NULL.
* @param top_ptr Topmost position. May be NULL.
* @param right_ptr Rightmost position. Ma be NULL.
* @param bottom_ptr Bottommost position. May be NULL.
*/
void _wlmtk_surface_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
struct wlr_box box;
if (NULL == surface_ptr->wlr_surface_ptr) {
box.x = 0;
box.y = 0;
box.width = surface_ptr->committed_width;
box.height = surface_ptr->committed_height;
} else {
wlr_surface_get_extends(surface_ptr->wlr_surface_ptr, &box);
}
if (NULL != left_ptr) *left_ptr = box.x;
if (NULL != top_ptr) *top_ptr = box.y;
if (NULL != right_ptr) *right_ptr = box.width - box.x;
if (NULL != bottom_ptr) *bottom_ptr = box.height - box.y;
}
/* ------------------------------------------------------------------------- */
/**
* Implements the element's leave method: If there's a WLR (sub)surface
* currently holding focus, that will be cleared.
*
* @param element_ptr
*/
void _wlmtk_surface_element_pointer_leave(wlmtk_element_t *element_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
// If the current surface's parent is our surface: clear it.
struct wlr_surface *focused_wlr_surface_ptr =
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr
)->pointer_state.focused_surface;
if (NULL != focused_wlr_surface_ptr &&
wlr_surface_get_root_surface(focused_wlr_surface_ptr) ==
surface_ptr->wlr_surface_ptr) {
wlr_seat_pointer_clear_focus(
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr));
}
}
/* ------------------------------------------------------------------------- */
/**
* Pass pointer motion events to client's surface.
*
* Identifies the surface (or sub-surface) at the given coordinates, and pass
* on the motion event to that surface. If needed, will update the seat's
* pointer focus.
*
* @param element_ptr
* @param x Pointer horizontal position, relative to this
* element's node.
* @param y Pointer vertical position, relative to this
* element's node.
* @param time_msec
*
* @return Whether if the motion is within the area.
*/
bool _wlmtk_surface_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x,
double y,
uint32_t time_msec)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
surface_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
if (NULL == surface_ptr->super_element.wlr_scene_node_ptr) return false;
// Get the layout local coordinates of the node, so we can adjust the
// node-local (x, y) for the `wlr_scene_node_at` call.
int lx, ly;
if (!wlr_scene_node_coords(
surface_ptr->super_element.wlr_scene_node_ptr, &lx, &ly)) {
return false;
}
// Get the node below the cursor. Return if there's no buffer node.
double node_x, node_y;
struct wlr_scene_node *wlr_scene_node_ptr = wlr_scene_node_at(
surface_ptr->super_element.wlr_scene_node_ptr,
x + lx, y + ly, &node_x, &node_y);
if (NULL == wlr_scene_node_ptr ||
WLR_SCENE_NODE_BUFFER != wlr_scene_node_ptr->type) {
return false;
}
struct wlr_scene_buffer *wlr_scene_buffer_ptr =
wlr_scene_buffer_from_node(wlr_scene_node_ptr);
struct wlr_scene_surface *wlr_scene_surface_ptr =
wlr_scene_surface_try_from_buffer(wlr_scene_buffer_ptr);
if (NULL == wlr_scene_surface_ptr) {
return true;
}
BS_ASSERT(surface_ptr->wlr_surface_ptr ==
wlr_surface_get_root_surface(wlr_scene_surface_ptr->surface));
wlr_seat_pointer_notify_enter(
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr),
wlr_scene_surface_ptr->surface,
node_x, node_y);
wlr_seat_pointer_notify_motion(
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr),
time_msec,
node_x, node_y);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Passes pointer button event further to the focused surface, if any.
*
* The actual passing is handled by `wlr_seat`. Here we just verify that the
* currently-focused surface (or sub-surface) is part of this surface.
*
* @param element_ptr
* @param button_event_ptr
*
* @return Whether the button event was consumed.
*/
bool _wlmtk_surface_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
// Complain if the surface isn't part of our responsibility.
struct wlr_surface *focused_wlr_surface_ptr =
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr
)->pointer_state.focused_surface;
if (NULL == focused_wlr_surface_ptr) return false;
// TODO(kaeser@gubbe.ch): Dragging the pointer from an activated window
// over to a non-activated window will trigger the condition here on the
// WLMTK_BUTTON_UP event. Needs a test and fixing.
// Additionally, this appears to trigger when creating a new XWL popup and
// the UP event goes to the new surface. Also needs test & fixing.
if (WLMTK_BUTTON_UP != button_event_ptr->type) {
BS_ASSERT(surface_ptr->wlr_surface_ptr ==
wlr_surface_get_root_surface(focused_wlr_surface_ptr));
}
// We're only forwarding PRESSED & RELEASED events.
if (WLMTK_BUTTON_DOWN == button_event_ptr->type ||
WLMTK_BUTTON_UP == button_event_ptr->type) {
wlr_seat_pointer_notify_button(
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr),
button_event_ptr->time_msec,
button_event_ptr->button,
(button_event_ptr->type == WLMTK_BUTTON_DOWN) ?
WLR_BUTTON_PRESSED : WLR_BUTTON_RELEASED);
return true;
}
return false;
}
/* ------------------------------------------------------------------------- */
/**
* Passes pointer axis events further to the focused surface, if any.
*
* The actual passing is handled by `wlr_seat`. Here we just verify that the
* currently-focused surface (or sub-surface) is part of this surface.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return Whether the axis event was consumed.
*/
bool _wlmtk_surface_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
// Complain if the surface isn't part of our responsibility.
struct wlr_surface *focused_wlr_surface_ptr =
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr
)->pointer_state.focused_surface;
if (NULL == focused_wlr_surface_ptr) return false;
wlr_seat_pointer_notify_axis(
wlmtk_env_wlr_seat(surface_ptr->super_element.env_ptr),
wlr_pointer_axis_event_ptr->time_msec,
wlr_pointer_axis_event_ptr->orientation,
wlr_pointer_axis_event_ptr->delta,
wlr_pointer_axis_event_ptr->delta_discrete,
wlr_pointer_axis_event_ptr->source);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Implements @ref wlmtk_element_vmt_t::keyboard_event. Handle keyboard events.
*
* Registers the surface as active, and forwards events there.
*
* @param element_ptr
* @param wlr_keyboard_key_event_ptr
* @param key_syms
* @param key_syms_count
* @param modifiers
*
* @return true if the axis event was handled.
*/
bool _wlmtk_surface_element_keyboard_event(
wlmtk_element_t *element_ptr,
struct wlr_keyboard_key_event *wlr_keyboard_key_event_ptr,
__UNUSED__ const xkb_keysym_t *key_syms,
__UNUSED__ size_t key_syms_count,
__UNUSED__ uint32_t modifiers)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_surface_t, super_element);
struct wlr_seat *wlr_seat_ptr = wlmtk_env_wlr_seat(element_ptr->env_ptr);
struct wlr_keyboard *wlr_keyboard_ptr = wlr_seat_get_keyboard(
wlr_seat_ptr);
if (NULL == wlr_keyboard_ptr) return false;
wlr_seat_keyboard_notify_enter(
wlr_seat_ptr,
surface_ptr->wlr_surface_ptr,
wlr_keyboard_ptr->keycodes,
wlr_keyboard_ptr->num_keycodes,
&wlr_keyboard_ptr->modifiers);
wlr_seat_set_keyboard(
wlr_seat_ptr,
wlr_keyboard_ptr);
wlr_seat_keyboard_notify_key(
wlr_seat_ptr,
wlr_keyboard_key_event_ptr->time_msec,
wlr_keyboard_key_event_ptr->keycode,
wlr_keyboard_key_event_ptr->state);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Handler for the `destroy` signal of `wlr_scene_tree_ptr->node`.
*
* We have this registered to clear out the extra pointer we're holding to
* @ref wlmtk_surface_t::wlr_scene_tree_ptr. @ref wlmtk_element_t has a
* separate destroy handler that will take care of actual cleanup.
* */
void _wlmtk_surface_handle_wlr_scene_tree_node_destroy(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_surface_t, wlr_scene_tree_node_destroy_listener);
surface_ptr->wlr_scene_tree_ptr = NULL;
wl_list_remove(&surface_ptr->wlr_scene_tree_node_destroy_listener.link);
}
/* ------------------------------------------------------------------------- */
/** Handler for the `commit` signal of `wlr_surface`. */
void _wlmtk_surface_handle_surface_commit(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
wlmtk_surface_t *surface_ptr = BS_CONTAINER_OF(
listener_ptr, wlmtk_surface_t, surface_commit_listener);
_wlmtk_surface_commit_size(
surface_ptr,
surface_ptr->wlr_surface_ptr->current.width,
surface_ptr->wlr_surface_ptr->current.height);
}
/* ------------------------------------------------------------------------- */
/**
* Surface commits a new size: Store the size, and update the parent's layout.
*
* @param surface_ptr
* @param width
* @param height
*/
void _wlmtk_surface_commit_size(
wlmtk_surface_t *surface_ptr,
int width,
int height)
{
if (surface_ptr->committed_width != width ||
surface_ptr->committed_height != height) {
surface_ptr->committed_width = width;
surface_ptr->committed_height = height;
}
if (NULL != surface_ptr->super_element.parent_container_ptr) {
wlmtk_container_update_layout(
surface_ptr->super_element.parent_container_ptr);
}
}
/* == Fake surface methods ================================================= */
static void _wlmtk_fake_surface_element_destroy(
wlmtk_element_t *element_ptr);
static struct wlr_scene_node *_wlmtk_fake_surface_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr);
static bool _wlmtk_fake_surface_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
__UNUSED__ uint32_t time_msec);
static bool _wlmtk_fake_surface_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void _wlmtk_fake_surface_element_pointer_leave(
wlmtk_element_t *element_ptr);
/** Extensions to the surface's super elements virtual methods. */
static const wlmtk_element_vmt_t _wlmtk_fake_surface_element_vmt = {
.destroy = _wlmtk_fake_surface_element_destroy,
.create_scene_node = _wlmtk_fake_surface_element_create_scene_node,
.pointer_motion = _wlmtk_fake_surface_element_pointer_motion,
.pointer_button = _wlmtk_fake_surface_element_pointer_button,
.pointer_leave = _wlmtk_fake_surface_element_pointer_leave,
};
/* ------------------------------------------------------------------------- */
wlmtk_fake_surface_t *wlmtk_fake_surface_create(void)
{
wlmtk_fake_surface_t *fake_surface_ptr = logged_calloc(
1, sizeof(wlmtk_fake_surface_t));
if (NULL == fake_surface_ptr) return NULL;
_wlmtk_surface_init(&fake_surface_ptr->surface, NULL, NULL);
wlmtk_element_extend(
&fake_surface_ptr->surface.super_element,
&_wlmtk_fake_surface_element_vmt);
return fake_surface_ptr;
}
/* ------------------------------------------------------------------------- */
wlmtk_surface_t *wlmtk_fake_surface_create_inject(
__UNUSED__ struct wlr_surface *wlr_surface_ptr,
__UNUSED__ wlmtk_env_t *env_ptr)
{
wlmtk_fake_surface_t *fake_surface_ptr = wlmtk_fake_surface_create();
if (NULL == fake_surface_ptr) return NULL;
return &fake_surface_ptr->surface;
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_surface_commit_size(
wlmtk_fake_surface_t *fake_surface_ptr,
int width,
int height)
{
_wlmtk_surface_commit_size(&fake_surface_ptr->surface, width, height);
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_surface_destroy(wlmtk_fake_surface_t *fake_surface_ptr)
{
_wlmtk_surface_fini(&fake_surface_ptr->surface);
free(fake_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of the dtor, @ref wlmtk_element_vmt_t::destroy. */
void _wlmtk_fake_surface_element_destroy(
wlmtk_element_t *element_ptr)
{
wlmtk_fake_surface_t *fake_surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_surface_t, surface.super_element);
wlmtk_fake_surface_destroy(fake_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of @ref wlmtk_element_vmt_t::create_scene_node. */
struct wlr_scene_node *_wlmtk_fake_surface_element_create_scene_node(
wlmtk_element_t *element_ptr,
struct wlr_scene_tree *wlr_scene_tree_ptr)
{
wlmtk_fake_surface_t *fake_surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_surface_t, surface.super_element);
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
fake_surface_ptr->surface.committed_width,
fake_surface_ptr->surface.committed_height);
BS_ASSERT(NULL != wlr_buffer_ptr);
struct wlr_scene_buffer *wlr_scene_buffer_ptr = wlr_scene_buffer_create(
wlr_scene_tree_ptr, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
return &wlr_scene_buffer_ptr->node;
}
/* ------------------------------------------------------------------------- */
/** Fake for @ref wlmtk_element_vmt_t::pointer_motion. True if in committed. */
bool _wlmtk_fake_surface_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
__UNUSED__ uint32_t time_msec)
{
wlmtk_fake_surface_t *fake_surface_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_fake_surface_t, surface.super_element);
return (0 <= x && x < fake_surface_ptr->surface.committed_width &&
0 <= y && y < fake_surface_ptr->surface.committed_height);
}
/* ------------------------------------------------------------------------- */
/** Fake for @ref wlmtk_element_vmt_t::pointer_button. Returns true. */
bool _wlmtk_fake_surface_element_pointer_button(
__UNUSED__ wlmtk_element_t *element_ptr,
__UNUSED__ const wlmtk_button_event_t *button_event_ptr)
{
return true;
}
/* ------------------------------------------------------------------------- */
/** Fake for @ref wlmtk_element_vmt_t::pointer_leave. Does nothing. */
void _wlmtk_fake_surface_element_pointer_leave(
__UNUSED__ wlmtk_element_t *element_ptr)
{
// Nothing to do.
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_fake_commit(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_surface_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "fake_commit", test_fake_commit },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests ctor and dtor. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_surface_t *surface_ptr = wlmtk_surface_create(NULL, NULL);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, surface_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
&surface_ptr->super_element,
wlmtk_surface_element(surface_ptr));
wlmtk_surface_destroy(surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Exercises the request_size / commit flow. */
void test_fake_commit(bs_test_t *test_ptr)
{
wlmtk_fake_surface_t *fake_surface_ptr = wlmtk_fake_surface_create();
int w, h;
wlmtk_surface_get_size(&fake_surface_ptr->surface, &w, &h);
BS_TEST_VERIFY_EQ(test_ptr, 0, w);
BS_TEST_VERIFY_EQ(test_ptr, 0, h);
wlmtk_fake_surface_commit_size(fake_surface_ptr, 200, 100);
wlmtk_surface_get_size(&fake_surface_ptr->surface, &w, &h);
BS_TEST_VERIFY_EQ(test_ptr, 200, w);
BS_TEST_VERIFY_EQ(test_ptr, 100, h);
wlmtk_fake_surface_destroy(fake_surface_ptr);
}
/* == End of surface.c ===================================================== */
wlmaker-0.3/src/toolkit/surface.h 0000664 0000000 0000000 00000012237 14641446446 0017115 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file surface.h
*
* @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.
*/
#ifndef __WLMTK_SURFACE_H__
#define __WLMTK_SURFACE_H__
#include
/** Forward declaration: State of a toolkit's WLR surface. */
typedef struct _wlmtk_surface_t wlmtk_surface_t;
/** Forward declaration: Virtual method table of the toolkit's WLR surface. */
typedef struct _wlmtk_surface_vmt_t wlmtk_surface_vmt_t;
/** Forward declaration: State of fake surface, for tests. */
typedef struct _wlmtk_fake_surface_t wlmtk_fake_surface_t;
#include "element.h"
#include "env.h"
#include "window.h"
/** Forward declaration. */
struct wlr_surface;
/** Forward declaration. */
struct wlr_scene_surface;
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** State of a `struct wlr_surface`, encapsuled for toolkit. */
struct _wlmtk_surface_t {
/** Super class of the surface: An element. */
wlmtk_element_t super_element;
/** Virtual method table of the super element before extending it. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Toolkit environment. See @ref wlmtk_surface_create. */
wlmtk_env_t *env_ptr;
/** The `struct wlr_surface` wrapped. */
struct wlr_surface *wlr_surface_ptr;
/** The scene API node displaying a surface and all it's sub-surfaces. */
struct wlr_scene_tree *wlr_scene_tree_ptr;
/** Listener for the `destroy` signal of `wlr_scene_tree_ptr->node`. */
struct wl_listener wlr_scene_tree_node_destroy_listener;
/** Committed width of the surface, in pixels. */
int committed_width;
/** Committed height of the surface, in pixels. */
int committed_height;
/** Listener for the `events.commit` signal of `wlr_surface`. */
struct wl_listener surface_commit_listener;
/** Whether this surface is activated, ie. has keyboard focus. */
bool activated;
};
/** Type of the surface ctor, for injection. @see wlmtk_surface_create. */
typedef wlmtk_surface_t *(*wlmtk_surface_create_t)(
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr);
/**
* Creates a toolkit surface from the `wlr_surface_ptr`.
*
* @param wlr_surface_ptr
* @param env_ptr
*
* @return A pointer to the @ref wlmtk_surface_t. Must be destroyed by calling
* @ref wlmtk_surface_destroy.
*/
wlmtk_surface_t *wlmtk_surface_create(
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the toolkit surface.
*
* @param surface_ptr
*/
void wlmtk_surface_destroy(wlmtk_surface_t *surface_ptr);
/**
* Returns a pointer to the surface's element superclass instance.
*
* @param surface_ptr
*
* @return Pointer to the corresponding @ref wlmtk_element_t.
*/
wlmtk_element_t *wlmtk_surface_element(wlmtk_surface_t *surface_ptr);
/**
* Returns committed size of the surface.
*
* @param surface_ptr
* @param width_ptr
* @param height_ptr
*/
void wlmtk_surface_get_size(
wlmtk_surface_t *surface_ptr,
int *width_ptr,
int *height_ptr);
/**
* Activates the surface.
*
* @param surface_ptr
* @param activated
*/
void wlmtk_surface_set_activated(
wlmtk_surface_t *surface_ptr,
bool activated);
/** Connects a listener and handler to the `map` signal of `wlr_surface`. */
void wlmtk_surface_connect_map_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler);
/** Connects a listener and handler to the `unmap` signal of `wlr_surface`. */
void wlmtk_surface_connect_unmap_listener_signal(
wlmtk_surface_t *surface_ptr,
struct wl_listener *listener_ptr,
wl_notify_func_t handler);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_surface_test_cases[];
/** Fake surface, useful for unit test. */
struct _wlmtk_fake_surface_t {
/** Superclass: surface. */
wlmtk_surface_t surface;
};
/** Ctor for the fake surface.*/
wlmtk_fake_surface_t *wlmtk_fake_surface_create(void);
/** Injectable ctor for the fake surface. */
wlmtk_surface_t *wlmtk_fake_surface_create_inject(
struct wlr_surface *wlr_surface_ptr,
wlmtk_env_t *env_ptr);
/** Fakes a wlr_surface commit event. */
void wlmtk_fake_surface_commit_size(
wlmtk_fake_surface_t *fake_surface_ptr,
int width,
int height);
/** Dtor for the fake surface.*/
void wlmtk_fake_surface_destroy(wlmtk_fake_surface_t *fake_surface_ptr);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_SURFACE_H__ */
/* == End of surface.h ===================================================== */
wlmaker-0.3/src/toolkit/test.h 0000664 0000000 0000000 00000003713 14641446446 0016443 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file test.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_TEST_H__
#define __WLMTK_TEST_H__
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Unit test comparator: Whether _box matches expected dimensions. */
#define WLMTK_TEST_VERIFY_WLRBOX_EQ(_test, _x, _y, _width, _height, _box) \
do { \
struct wlr_box __box = (_box); \
int __x = (_x), __y = (_y), __width = (_width), __height = (_height); \
if (__x != __box.x || __y != __box.y || \
__height != __box.height || __width != __box.width) { \
bs_test_fail_at( \
(_test), __FILE__, __LINE__, \
"Expecting {%d, %d, %d, %d}, got '%s' {%d, %d, %d, %d}", \
__x, __y, __width, __height, \
#_box, __box.x, __box.y, __box.width, __box.height); \
} \
} while (false)
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TEST_H__ */
/* == End of test.h ================================================== */
wlmaker-0.3/src/toolkit/tile.c 0000664 0000000 0000000 00000020743 14641446446 0016416 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file tile.c
*
* @copyright
* Copyright 2024 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.
*/
#include "tile.h"
#include "gfxbuf.h"
#include "primitives.h"
/* == Declarations ========================================================= */
static void _wlmtk_tile_update_layout(wlmtk_container_t *container_ptr);
static struct wlr_buffer *_wlmtk_tile_create_buffer(
const wlmtk_tile_style_t *style_ptr);
/* == Data ================================================================= */
/** Virtual methods implemented by @ref wlmtk_tile_t. */
static const wlmtk_container_vmt_t _wlmtk_tile_container_vmt = {
.update_layout = _wlmtk_tile_update_layout
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
bool wlmtk_tile_init(
wlmtk_tile_t *tile_ptr,
const wlmtk_tile_style_t *style_ptr,
wlmtk_env_t *env_ptr)
{
memset(tile_ptr, 0, sizeof(wlmtk_tile_t));
memcpy(&tile_ptr->style, style_ptr, sizeof(wlmtk_tile_style_t));
if (!wlmtk_container_init(&tile_ptr->super_container, env_ptr)) {
wlmtk_tile_fini(tile_ptr);
return false;
}
tile_ptr->orig_super_container_vmt = wlmtk_container_extend(
&tile_ptr->super_container, &_wlmtk_tile_container_vmt);
if (!wlmtk_buffer_init(&tile_ptr->buffer, NULL)) {
wlmtk_tile_fini(tile_ptr);
return false;
}
wlmtk_element_set_visible(wlmtk_buffer_element(&tile_ptr->buffer), true);
wlmtk_container_add_element(
&tile_ptr->super_container,
wlmtk_buffer_element(&tile_ptr->buffer));
struct wlr_buffer *wlr_buffer_ptr = _wlmtk_tile_create_buffer(
&tile_ptr->style);
if (NULL == wlr_buffer_ptr) {
wlmtk_tile_fini(tile_ptr);
return false;
}
wlmtk_tile_set_background_buffer(tile_ptr, wlr_buffer_ptr);
wlr_buffer_drop(wlr_buffer_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_tile_fini(wlmtk_tile_t *tile_ptr)
{
if (NULL != tile_ptr->background_wlr_buffer_ptr) {
wlr_buffer_unlock(tile_ptr->background_wlr_buffer_ptr);
tile_ptr->background_wlr_buffer_ptr = NULL;
}
if (wlmtk_buffer_element(&tile_ptr->buffer)->parent_container_ptr) {
wlmtk_container_remove_element(
&tile_ptr->super_container,
wlmtk_buffer_element(&tile_ptr->buffer));
wlmtk_buffer_fini(&tile_ptr->buffer);
}
wlmtk_container_fini(&tile_ptr->super_container);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_tile_set_background_buffer(
wlmtk_tile_t *tile_ptr,
struct wlr_buffer *wlr_buffer_ptr)
{
if (tile_ptr->style.size != (uint64_t)wlr_buffer_ptr->width ||
tile_ptr->style.size != (uint64_t)wlr_buffer_ptr->height) return false;
if (NULL != tile_ptr->background_wlr_buffer_ptr) {
wlr_buffer_unlock(tile_ptr->background_wlr_buffer_ptr);
}
tile_ptr->background_wlr_buffer_ptr = wlr_buffer_lock(wlr_buffer_ptr);
wlmtk_buffer_set(&tile_ptr->buffer, tile_ptr->background_wlr_buffer_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_tile_set_content(
wlmtk_tile_t *tile_ptr,
wlmtk_element_t *element_ptr)
{
if (element_ptr == tile_ptr->content_element_ptr) return;
if (NULL != tile_ptr->content_element_ptr) {
wlmtk_container_remove_element(
&tile_ptr->super_container,
tile_ptr->content_element_ptr);
tile_ptr->content_element_ptr = NULL;
}
if (NULL != element_ptr) {
wlmtk_container_add_element_atop(
&tile_ptr->super_container,
wlmtk_buffer_element(&tile_ptr->buffer),
element_ptr);
tile_ptr->content_element_ptr = element_ptr;
struct wlr_box box = wlmtk_element_get_dimensions_box(element_ptr);
if ((unsigned)box.width > tile_ptr->style.size ||
(unsigned)box.height > tile_ptr->style.size) {
bs_log(BS_WARNING, "Content size %d x %d > tile size %"PRIu64,
box.width, box.height, tile_ptr->style.size);
}
wlmtk_element_set_position(
element_ptr,
((int)tile_ptr->style.size - box.width) / 2,
((int)tile_ptr->style.size - box.height) / 2);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_tile_set_overlay(
wlmtk_tile_t *tile_ptr,
wlmtk_element_t *element_ptr)
{
if (element_ptr == tile_ptr->overlay_element_ptr) return;
if (NULL != tile_ptr->overlay_element_ptr) {
wlmtk_container_remove_element(
&tile_ptr->super_container,
tile_ptr->overlay_element_ptr);
tile_ptr->overlay_element_ptr = NULL;
}
if (NULL != element_ptr) {
wlmtk_container_add_element(&tile_ptr->super_container, element_ptr);
tile_ptr->overlay_element_ptr = element_ptr;
struct wlr_box box = wlmtk_element_get_dimensions_box(element_ptr);
if ((unsigned)box.width > tile_ptr->style.size ||
(unsigned)box.height > tile_ptr->style.size) {
bs_log(BS_WARNING, "Overlay size %d x %d > tile size %"PRIu64,
box.width, box.height, tile_ptr->style.size);
}
wlmtk_element_set_position(
element_ptr,
((int)tile_ptr->style.size - box.width) / 2,
((int)tile_ptr->style.size - box.height) / 2);
}
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_tile_element(wlmtk_tile_t *tile_ptr)
{
return &tile_ptr->super_container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Handles requests to update layout. Called when elements are added. */
void _wlmtk_tile_update_layout(__UNUSED__ wlmtk_container_t *container_ptr)
{
}
/* ------------------------------------------------------------------------- */
/** Crates a wlr_buffer with background, as described in `style_ptr`. */
struct wlr_buffer *_wlmtk_tile_create_buffer(
const wlmtk_tile_style_t *style_ptr)
{
struct wlr_buffer* wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
style_ptr->size, style_ptr->size);
if (NULL == wlr_buffer_ptr) return NULL;
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
wlmaker_primitives_cairo_fill(cairo_ptr, &style_ptr->fill);
wlmaker_primitives_draw_bezel(cairo_ptr, style_ptr->bezel_width, true);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* == Unit tests =========================================================== */
static void test_init_fini(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_tile_test_cases[] = {
{ 1, "init_fini", test_init_fini },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Exercises setup and teardown. */
static void test_init_fini(bs_test_t *test_ptr)
{
wlmtk_tile_t tile;
wlmtk_tile_style_t style = { .size = 64 };
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_tile_init(&tile, &style, NULL));
BS_TEST_VERIFY_EQ(
test_ptr,
&tile.super_container.super_element,
wlmtk_tile_element(&tile));
// Adds content and verifies it's centered.
wlmtk_fake_element_t *fe_ptr = wlmtk_fake_element_create();
fe_ptr->dimensions.width = 48;
fe_ptr->dimensions.height = 36;
wlmtk_tile_set_content(&tile, &fe_ptr->element);
int x, y;
wlmtk_element_get_position(&fe_ptr->element, &x, &y);
BS_TEST_VERIFY_EQ(test_ptr, 8, x);
BS_TEST_VERIFY_EQ(test_ptr, 14, y);
wlmtk_tile_fini(&tile);
}
/* == End of tile.c ======================================================== */
wlmaker-0.3/src/toolkit/tile.h 0000664 0000000 0000000 00000010235 14641446446 0016416 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file tile.h
*
* @copyright
* Copyright 2024 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.
*/
#ifndef __WLMTK_TILE_H__
#define __WLMTK_TILE_H__
/** Forward declaration: State of a tile. */
typedef struct _wlmtk_tile_t wlmtk_tile_t;
#include "buffer.h"
#include "container.h"
#include "style.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Style options for the tile. */
typedef struct {
/** Fill style for the tile's background. */
wlmtk_style_fill_t fill;
/** Size of the tile, in pixels. Tiles are of quadratic shape. */
uint64_t size;
/** Width of the bezel. */
uint64_t bezel_width;
} wlmtk_tile_style_t;
/** State of a tile. */
struct _wlmtk_tile_t {
/** A tile is a container. Holds a background and contents. */
wlmtk_container_t super_container;
/** Virtual method table of the superclass' container. */
wlmtk_container_vmt_t orig_super_container_vmt;
/** The tile background is modelled as @ref wlmtk_buffer_t. */
wlmtk_buffer_t buffer;
/** Style to be used for this tile. */
wlmtk_tile_style_t style;
/** Holds the tile's background, used in @ref wlmtk_tile_t::buffer. */
struct wlr_buffer *background_wlr_buffer_ptr;
/** References the content element from @ref wlmtk_tile_set_content. */
wlmtk_element_t *content_element_ptr;
/** References the content element from @ref wlmtk_tile_set_overlay. */
wlmtk_element_t *overlay_element_ptr;
};
/**
* Initializes the tile.
*
* @param tile_ptr
* @param style_ptr
* @param env_ptr
*
* @return true on success.
*/
bool wlmtk_tile_init(
wlmtk_tile_t *tile_ptr,
const wlmtk_tile_style_t *style_ptr,
wlmtk_env_t *env_ptr);
/**
* Un-initializes the tile.
*
* @param tile_ptr
*/
void wlmtk_tile_fini(wlmtk_tile_t *tile_ptr);
/**
* Sets (overwrites) the default tile's background buffer.
*
* This permits specific tiles, eg. a Dock Clip to include active elements in
* the background, or change the bezel or texture.
*
* @param tile_ptr
* @param wlr_buffer_ptr Points to a `struct wlr_buffer`. The tile will
* add a buffer lock, so the caller may safely
* drop or unlock the buffer.
* The buffer must match the tile's size.
*
* @return false if the buffer did not match the tile size.
*/
bool wlmtk_tile_set_background_buffer(
wlmtk_tile_t *tile_ptr,
struct wlr_buffer *wlr_buffer_ptr);
/**
* Sets `element_ptr` as the content of `tile_ptr`.
*
* TODO(kaeser@gubbe.ch): Flesh out the behaviour -- permit only 1 content?
* Does the tile claim ownerwhip? How to reset the content?
*
* @param tile_ptr
* @param element_ptr
*/
void wlmtk_tile_set_content(
wlmtk_tile_t *tile_ptr,
wlmtk_element_t *element_ptr);
/**
* Sets `element_ptr` as the overlay of `tile_ptr`.
*
* TODO(kaeser@gubbe.ch): Flesh out the behaviour -- permit only 1 overlay?
* Does the tile claim ownerwhip? How to reset the overlay?
*
* @param tile_ptr
* @param element_ptr
*/
void wlmtk_tile_set_overlay(
wlmtk_tile_t *tile_ptr,
wlmtk_element_t *element_ptr);
/** @return the superclass' @ref wlmtk_element_t of `tile_ptr`. */
wlmtk_element_t *wlmtk_tile_element(wlmtk_tile_t *tile_ptr);
/** Unit test cases for @ref wlmtk_tile_t. */
extern const bs_test_case_t wlmtk_tile_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TILE_H__ */
/* == End of tile.h ======================================================== */
wlmaker-0.3/src/toolkit/titlebar.c 0000664 0000000 0000000 00000041104 14641446446 0017261 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar.c
*
* @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.
*/
#include "titlebar.h"
#include "box.h"
#include "button.h"
#include "buffer.h"
#include "gfxbuf.h"
#include "primitives.h"
#include "titlebar_button.h"
#include "titlebar_title.h"
#include "window.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the title bar. */
struct _wlmtk_titlebar_t {
/** Superclass: Box. */
wlmtk_box_t super_box;
/** Link to the titlebar's title. */
const char *title_ptr;
/** Title element of the title bar. */
wlmtk_titlebar_title_t *titlebar_title_ptr;
/** Minimize button. */
wlmtk_titlebar_button_t *minimize_button_ptr;
/** Close button. */
wlmtk_titlebar_button_t *close_button_ptr;
/** Titlebar background, when focussed. */
bs_gfxbuf_t *focussed_gfxbuf_ptr;
/** Titlebar background, when blurred. */
bs_gfxbuf_t *blurred_gfxbuf_ptr;
/** Current width of the title bar. */
unsigned width;
/** Position of the close button. */
int close_position;
/** Position of the title element. */
int title_position;
/** Width of the title element. */
int title_width;
/** Whether the title bar is currently displayed as activated. */
bool activated;
/** Title bar style. */
wlmtk_titlebar_style_t style;
};
static void _wlmtk_titlebar_element_destroy(wlmtk_element_t *element_ptr);
static bool redraw_buffers(
wlmtk_titlebar_t *titlebar_ptr,
unsigned width);
static bool redraw(wlmtk_titlebar_t *titlebar_ptr);
/* == Data ================================================================= */
/** Virtual method table extension for the titlebar's element superclass. */
static const wlmtk_element_vmt_t titlebar_element_vmt = {
.destroy = _wlmtk_titlebar_element_destroy
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_titlebar_t *wlmtk_titlebar_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr,
const wlmtk_titlebar_style_t *style_ptr)
{
wlmtk_titlebar_t *titlebar_ptr = logged_calloc(
1, sizeof(wlmtk_titlebar_t));
if (NULL == titlebar_ptr) return NULL;
memcpy(&titlebar_ptr->style, style_ptr, sizeof(wlmtk_titlebar_style_t));
titlebar_ptr->title_ptr = wlmtk_window_get_title(window_ptr);
if (!wlmtk_box_init(&titlebar_ptr->super_box, env_ptr,
WLMTK_BOX_HORIZONTAL,
&titlebar_ptr->style.margin)) {
wlmtk_titlebar_destroy(titlebar_ptr);
return NULL;
}
wlmtk_element_extend(
&titlebar_ptr->super_box.super_container.super_element,
&titlebar_element_vmt);
titlebar_ptr->titlebar_title_ptr = wlmtk_titlebar_title_create(
env_ptr, window_ptr);
if (NULL == titlebar_ptr->titlebar_title_ptr) {
wlmtk_titlebar_destroy(titlebar_ptr);
return NULL;
}
wlmtk_box_add_element_front(
&titlebar_ptr->super_box,
wlmtk_titlebar_title_element(titlebar_ptr->titlebar_title_ptr));
titlebar_ptr->minimize_button_ptr = wlmtk_titlebar_button_create(
env_ptr,
wlmtk_window_request_minimize,
window_ptr,
wlmaker_primitives_draw_minimize_icon);
if (NULL == titlebar_ptr->minimize_button_ptr) {
wlmtk_titlebar_destroy(titlebar_ptr);
return NULL;
}
wlmtk_box_add_element_front(
&titlebar_ptr->super_box,
wlmtk_titlebar_button_element(titlebar_ptr->minimize_button_ptr));
titlebar_ptr->close_button_ptr = wlmtk_titlebar_button_create(
env_ptr,
wlmtk_window_request_close,
window_ptr,
wlmaker_primitives_draw_close_icon);
if (NULL == titlebar_ptr->close_button_ptr) {
wlmtk_titlebar_destroy(titlebar_ptr);
return NULL;
}
wlmtk_box_add_element_back(
&titlebar_ptr->super_box,
wlmtk_titlebar_button_element(titlebar_ptr->close_button_ptr));
return titlebar_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_destroy(wlmtk_titlebar_t *titlebar_ptr)
{
if (NULL != titlebar_ptr->close_button_ptr) {
wlmtk_box_remove_element(
&titlebar_ptr->super_box,
wlmtk_titlebar_button_element(titlebar_ptr->close_button_ptr));
wlmtk_titlebar_button_destroy(titlebar_ptr->close_button_ptr);
titlebar_ptr->close_button_ptr = NULL;
}
if (NULL != titlebar_ptr->minimize_button_ptr) {
wlmtk_box_remove_element(
&titlebar_ptr->super_box,
wlmtk_titlebar_button_element(titlebar_ptr->minimize_button_ptr));
wlmtk_titlebar_button_destroy(titlebar_ptr->minimize_button_ptr);
titlebar_ptr->minimize_button_ptr = NULL;
}
if (NULL != titlebar_ptr->titlebar_title_ptr) {
wlmtk_box_remove_element(
&titlebar_ptr->super_box,
wlmtk_titlebar_title_element(titlebar_ptr->titlebar_title_ptr));
wlmtk_titlebar_title_destroy(titlebar_ptr->titlebar_title_ptr);
titlebar_ptr->titlebar_title_ptr = NULL;
}
if (NULL != titlebar_ptr->blurred_gfxbuf_ptr) {
bs_gfxbuf_destroy(titlebar_ptr->blurred_gfxbuf_ptr);
titlebar_ptr->blurred_gfxbuf_ptr = NULL;
}
if (NULL != titlebar_ptr->focussed_gfxbuf_ptr) {
bs_gfxbuf_destroy(titlebar_ptr->focussed_gfxbuf_ptr);
titlebar_ptr->focussed_gfxbuf_ptr = NULL;
}
wlmtk_box_fini(&titlebar_ptr->super_box);
free(titlebar_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_titlebar_set_width(
wlmtk_titlebar_t *titlebar_ptr,
unsigned width)
{
if (titlebar_ptr->width == width) return true;
if (!redraw_buffers(titlebar_ptr, width)) return false;
BS_ASSERT(width == titlebar_ptr->width);
titlebar_ptr->title_width = width;
// Room for a close button?
titlebar_ptr->close_position = width;
if (3 * titlebar_ptr->style.height < width) {
titlebar_ptr->close_position = width - titlebar_ptr->style.height;
titlebar_ptr->title_width -= titlebar_ptr->style.height +
titlebar_ptr->style.margin.width;
}
titlebar_ptr->title_position = 0;
// Also having room for a minimize button?
if (4 * titlebar_ptr->style.height < width) {
titlebar_ptr->title_position = titlebar_ptr->style.height +
titlebar_ptr->style.margin.width;
titlebar_ptr->title_width -= titlebar_ptr->style.height +
titlebar_ptr->style.margin.width;
}
if (!redraw(titlebar_ptr)) {
return false;
}
// Don't forget to re-position the elements.
wlmtk_container_update_layout(&titlebar_ptr->super_box.super_container);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_set_activated(
wlmtk_titlebar_t *titlebar_ptr,
bool activated)
{
if (titlebar_ptr->activated == activated) return;
titlebar_ptr->activated = activated;
wlmtk_titlebar_button_set_activated(
titlebar_ptr->minimize_button_ptr, titlebar_ptr->activated);
wlmtk_titlebar_title_set_activated(
titlebar_ptr->titlebar_title_ptr, titlebar_ptr->activated);
wlmtk_titlebar_button_set_activated(
titlebar_ptr->close_button_ptr, titlebar_ptr->activated);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_titlebar_is_activated(wlmtk_titlebar_t *titlebar_ptr)
{
return titlebar_ptr->activated;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_set_title(
wlmtk_titlebar_t *titlebar_ptr,
const char *title_ptr)
{
if (titlebar_ptr->title_ptr == title_ptr) return;
titlebar_ptr->title_ptr = title_ptr;
redraw(titlebar_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_titlebar_element(wlmtk_titlebar_t *titlebar_ptr)
{
return &titlebar_ptr->super_box.super_container.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Virtual destructor, wraps to our dtor. */
void _wlmtk_titlebar_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_titlebar_t *titlebar_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_titlebar_t,
super_box.super_container.super_element);
wlmtk_titlebar_destroy(titlebar_ptr);
}
/* ------------------------------------------------------------------------- */
/** Redraws the titlebar's background in appropriate size. */
bool redraw_buffers(wlmtk_titlebar_t *titlebar_ptr, unsigned width)
{
cairo_t *cairo_ptr;
bs_gfxbuf_t *focussed_gfxbuf_ptr = bs_gfxbuf_create(
width, titlebar_ptr->style.height);
if (NULL == focussed_gfxbuf_ptr) return false;
cairo_ptr = cairo_create_from_bs_gfxbuf(focussed_gfxbuf_ptr);
if (NULL == cairo_ptr) {
bs_gfxbuf_destroy(focussed_gfxbuf_ptr);
return false;
}
wlmaker_primitives_cairo_fill(
cairo_ptr, &titlebar_ptr->style.focussed_fill);
cairo_destroy(cairo_ptr);
bs_gfxbuf_t *blurred_gfxbuf_ptr = bs_gfxbuf_create(
width, titlebar_ptr->style.height);
if (NULL == blurred_gfxbuf_ptr) return false;
cairo_ptr = cairo_create_from_bs_gfxbuf(blurred_gfxbuf_ptr);
if (NULL == cairo_ptr) {
bs_gfxbuf_destroy(blurred_gfxbuf_ptr);
bs_gfxbuf_destroy(focussed_gfxbuf_ptr);
return false;
}
wlmaker_primitives_cairo_fill(
cairo_ptr, &titlebar_ptr->style.blurred_fill);
cairo_destroy(cairo_ptr);
if (NULL != titlebar_ptr->focussed_gfxbuf_ptr) {
bs_gfxbuf_destroy(titlebar_ptr->focussed_gfxbuf_ptr);
}
titlebar_ptr->focussed_gfxbuf_ptr = focussed_gfxbuf_ptr;
if (NULL != titlebar_ptr->blurred_gfxbuf_ptr) {
bs_gfxbuf_destroy(titlebar_ptr->blurred_gfxbuf_ptr);
}
titlebar_ptr->blurred_gfxbuf_ptr = blurred_gfxbuf_ptr;
titlebar_ptr->width = width;
return true;
}
/* ------------------------------------------------------------------------- */
/** Redraws the titlebar elements. */
bool redraw(wlmtk_titlebar_t *titlebar_ptr)
{
// Guard clause: Nothing to do... yet.
if (0 >= titlebar_ptr->width) return true;
if (!wlmtk_titlebar_title_redraw(
titlebar_ptr->titlebar_title_ptr,
titlebar_ptr->focussed_gfxbuf_ptr,
titlebar_ptr->blurred_gfxbuf_ptr,
titlebar_ptr->title_position,
titlebar_ptr->title_width,
titlebar_ptr->activated,
titlebar_ptr->title_ptr,
&titlebar_ptr->style)) {
return false;
}
wlmtk_element_set_visible(
wlmtk_titlebar_title_element(titlebar_ptr->titlebar_title_ptr), true);
if (0 < titlebar_ptr->title_position) {
if (!wlmtk_titlebar_button_redraw(
titlebar_ptr->minimize_button_ptr,
titlebar_ptr->focussed_gfxbuf_ptr,
titlebar_ptr->blurred_gfxbuf_ptr,
0,
&titlebar_ptr->style)) {
return false;
}
wlmtk_element_set_visible(
wlmtk_titlebar_button_element(titlebar_ptr->minimize_button_ptr),
true);
} else {
wlmtk_element_set_visible(
wlmtk_titlebar_button_element(titlebar_ptr->minimize_button_ptr),
false);
}
if (titlebar_ptr->close_position < (int)titlebar_ptr->width) {
if (!wlmtk_titlebar_button_redraw(
titlebar_ptr->close_button_ptr,
titlebar_ptr->focussed_gfxbuf_ptr,
titlebar_ptr->blurred_gfxbuf_ptr,
titlebar_ptr->close_position,
&titlebar_ptr->style)) {
return false;
}
wlmtk_element_set_visible(
wlmtk_titlebar_button_element(titlebar_ptr->close_button_ptr),
true);
} else {
wlmtk_element_set_visible(
wlmtk_titlebar_button_element(titlebar_ptr->close_button_ptr),
false);
}
return true;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_variable_width(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_titlebar_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "variable_width", test_variable_width },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests setup and teardown. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_titlebar_style_t style = {};
wlmtk_titlebar_t *titlebar_ptr = wlmtk_titlebar_create(
NULL, fake_window_ptr->window_ptr, &style);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, titlebar_ptr);
wlmtk_element_destroy(wlmtk_titlebar_element(titlebar_ptr));
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests titlebar with variable width. */
void test_variable_width(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_titlebar_style_t style = { .height = 22, .margin = { .width = 2 } };
wlmtk_titlebar_t *titlebar_ptr = wlmtk_titlebar_create(
NULL, fake_window_ptr->window_ptr, &style);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, titlebar_ptr);
// Short names, for improved readability.
wlmtk_element_t *title_elem_ptr = wlmtk_titlebar_title_element(
titlebar_ptr->titlebar_title_ptr);
wlmtk_element_t *minimize_elem_ptr = wlmtk_titlebar_button_element(
titlebar_ptr->minimize_button_ptr);
wlmtk_element_t *close_elem_ptr = wlmtk_titlebar_button_element(
titlebar_ptr->close_button_ptr);
int width;
// Created with zero width: All invisible. */
BS_TEST_VERIFY_FALSE(test_ptr, title_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, minimize_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, close_elem_ptr->visible);
// Width sufficient for all: All elements visible and placed.
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_titlebar_set_width(titlebar_ptr, 89));
BS_TEST_VERIFY_TRUE(test_ptr, title_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, minimize_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, close_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 24, title_elem_ptr->x);
wlmtk_element_get_dimensions(title_elem_ptr, NULL, NULL, &width, NULL);
BS_TEST_VERIFY_EQ(test_ptr, 41, width);
BS_TEST_VERIFY_EQ(test_ptr, 67, close_elem_ptr->x);
// Width sufficient only for 1 button.
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_titlebar_set_width(titlebar_ptr, 67));
BS_TEST_VERIFY_TRUE(test_ptr, title_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, minimize_elem_ptr->visible);
BS_TEST_VERIFY_TRUE(test_ptr, close_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 0, title_elem_ptr->x);
wlmtk_element_get_dimensions(title_elem_ptr, NULL, NULL, &width, NULL);
BS_TEST_VERIFY_EQ(test_ptr, 43, width);
// Width doesn't permit any button.
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_titlebar_set_width(titlebar_ptr, 66));
BS_TEST_VERIFY_TRUE(test_ptr, title_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, minimize_elem_ptr->visible);
BS_TEST_VERIFY_FALSE(test_ptr, close_elem_ptr->visible);
BS_TEST_VERIFY_EQ(test_ptr, 0, title_elem_ptr->x);
wlmtk_element_get_dimensions(title_elem_ptr, NULL, NULL, &width, NULL);
BS_TEST_VERIFY_EQ(test_ptr, 66, width);
wlmtk_element_destroy(wlmtk_titlebar_element(titlebar_ptr));
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of titlebar.c ==================================================== */
wlmaker-0.3/src/toolkit/titlebar.h 0000664 0000000 0000000 00000007267 14641446446 0017302 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar.h
*
* @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.
*/
#ifndef __WLMTK_TITLEBAR_H__
#define __WLMTK_TITLEBAR_H__
/** Forward declaration: Title bar. */
typedef struct _wlmtk_titlebar_t wlmtk_titlebar_t;
#include "element.h"
#include "primitives.h"
/** Style options for the titlebar. */
typedef struct {
/** Fill style for when the titlebar is focussed (activated). */
wlmtk_style_fill_t focussed_fill;
/** Fill style for when the titlebar is blurred (not activated). */
wlmtk_style_fill_t blurred_fill;
/** Color of the title text when focussed. */
uint32_t focussed_text_color;
/** Color of the title text when blurred. */
uint32_t blurred_text_color;
/** Height of the title bar, in pixels. */
uint64_t height;
/** Width of the bezel. */
uint64_t bezel_width;
/** Style of the margin within the resizebar. */
wlmtk_margin_style_t margin;
/** Font style for the titlebar's title. */
wlmtk_style_font_t font;
} wlmtk_titlebar_style_t;
#include "window.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a title bar, suitable as a window title.
*
* @param env_ptr
* @param window_ptr
* @param style_ptr
*
* @return Pointer to the title bar state, or NULL on error. Must be free'd
* by calling @ref wlmtk_titlebar_destroy.
*/
wlmtk_titlebar_t *wlmtk_titlebar_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr,
const wlmtk_titlebar_style_t *style_ptr);
/**
* Destroys the title bar.
*
* @param titlebar_ptr
*/
void wlmtk_titlebar_destroy(wlmtk_titlebar_t *titlebar_ptr);
/**
* Sets the width of the title bar.
*
* @param titlebar_ptr
* @param width
*
* @return Whether the operation was successful.
*/
bool wlmtk_titlebar_set_width(
wlmtk_titlebar_t *titlebar_ptr,
unsigned width);
/**
* Sets whether the title bar is activated.
*
* @param titlebar_ptr
* @param activated
*/
void wlmtk_titlebar_set_activated(
wlmtk_titlebar_t *titlebar_ptr,
bool activated);
/** Returns whether the title bar is activated. */
bool wlmtk_titlebar_is_activated(wlmtk_titlebar_t *titlebar_ptr);
/**
* Updates the title text of the titlebar.
*
* @param titlebar_ptr
* @param title_ptr Expected to remain valid until the next call of
* @ref wlmtk_titlebar_set_title or until the
* `titlebar_ptr` is destroyed.
*/
void wlmtk_titlebar_set_title(
wlmtk_titlebar_t *titlebar_ptr,
const char *title_ptr);
/**
* Returns the super Element of the titlebar.
*
* @param titlebar_ptr
*
* @return Pointer to the @ref wlmtk_element_t base instantiation to
* titlebar_ptr.
*/
wlmtk_element_t *wlmtk_titlebar_element(wlmtk_titlebar_t *titlebar_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_titlebar_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TITLEBAR_H__ */
/* == End of titlebar.h ==================================================== */
wlmaker-0.3/src/toolkit/titlebar_button.c 0000664 0000000 0000000 00000032674 14641446446 0020670 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar_button.c
*
* @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.
*/
#include "titlebar_button.h"
#include "button.h"
#include "content.h"
#include "gfxbuf.h"
#include "primitives.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of a titlebar button. */
struct _wlmtk_titlebar_button_t {
/** Superclass: Button. */
wlmtk_button_t super_button;
/** Whether the titlebar button is activated (focussed). */
bool activated;
/** Callback for when the button is clicked. */
void (*click_handler)(wlmtk_window_t *window_ptr);
/** Points to the @ref wlmtk_window_t that carries this titlebar. */
wlmtk_window_t *window_ptr;
/** For drawing the button contents. */
wlmtk_titlebar_button_draw_t draw;
/** WLR buffer of the button when focussed & released. */
struct wlr_buffer *focussed_released_wlr_buffer_ptr;
/** WLR buffer of the button when focussed & pressed. */
struct wlr_buffer *focussed_pressed_wlr_buffer_ptr;
/** WLR buffer of the button when blurred. */
struct wlr_buffer *blurred_wlr_buffer_ptr;
};
static void titlebar_button_element_destroy(wlmtk_element_t *element_ptr);
static void titlebar_button_clicked(wlmtk_button_t *button_ptr);
static void update_buffers(wlmtk_titlebar_button_t *titlebar_button_ptr);
static struct wlr_buffer *create_buf(
bs_gfxbuf_t *gfxbuf_ptr,
int position,
bool pressed,
bool focussed,
const wlmtk_titlebar_style_t *style_ptr,
wlmtk_titlebar_button_draw_t draw);
/* == Data ================================================================= */
/** Extension to the superclass element's virtual method table. */
static const wlmtk_element_vmt_t titlebar_button_element_vmt = {
.destroy = titlebar_button_element_destroy,
};
/** Extension to the parent button class' virtual methods. */
static const wlmtk_button_vmt_t titlebar_button_vmt = {
.clicked = titlebar_button_clicked,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_titlebar_button_t *wlmtk_titlebar_button_create(
wlmtk_env_t *env_ptr,
void (*click_handler)(wlmtk_window_t *window_ptr),
wlmtk_window_t *window_ptr,
wlmtk_titlebar_button_draw_t draw)
{
BS_ASSERT(NULL != window_ptr);
BS_ASSERT(NULL != click_handler);
BS_ASSERT(NULL != draw);
wlmtk_titlebar_button_t *titlebar_button_ptr = logged_calloc(
1, sizeof(wlmtk_titlebar_button_t));
if (NULL == titlebar_button_ptr) return NULL;
titlebar_button_ptr->click_handler = click_handler;
titlebar_button_ptr->window_ptr = window_ptr;
titlebar_button_ptr->draw = draw;
if (!wlmtk_button_init(&titlebar_button_ptr->super_button, env_ptr)) {
wlmtk_titlebar_button_destroy(titlebar_button_ptr);
return NULL;
}
wlmtk_element_extend(
&titlebar_button_ptr->super_button.super_buffer.super_element,
&titlebar_button_element_vmt);
wlmtk_button_extend(
&titlebar_button_ptr->super_button,
&titlebar_button_vmt);
return titlebar_button_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_button_destroy(
wlmtk_titlebar_button_t *titlebar_button_ptr)
{
wlr_buffer_drop_nullify(
&titlebar_button_ptr->focussed_released_wlr_buffer_ptr);
wlr_buffer_drop_nullify(
&titlebar_button_ptr->focussed_pressed_wlr_buffer_ptr);
wlr_buffer_drop_nullify(
&titlebar_button_ptr->blurred_wlr_buffer_ptr);
wlmtk_button_fini(&titlebar_button_ptr->super_button);
free(titlebar_button_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_button_set_activated(
wlmtk_titlebar_button_t *titlebar_button_ptr,
bool activated)
{
if (titlebar_button_ptr->activated == activated) return;
titlebar_button_ptr->activated = activated;
update_buffers(titlebar_button_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_titlebar_button_redraw(
wlmtk_titlebar_button_t *titlebar_button_ptr,
bs_gfxbuf_t *focussed_gfxbuf_ptr,
bs_gfxbuf_t *blurred_gfxbuf_ptr,
int position,
const wlmtk_titlebar_style_t *style_ptr)
{
BS_ASSERT(focussed_gfxbuf_ptr->width == blurred_gfxbuf_ptr->width);
BS_ASSERT(focussed_gfxbuf_ptr->height == blurred_gfxbuf_ptr->height);
BS_ASSERT(style_ptr->height == focussed_gfxbuf_ptr->height);
BS_ASSERT(position + style_ptr->height <= focussed_gfxbuf_ptr->width);
struct wlr_buffer *focussed_released_ptr = create_buf(
focussed_gfxbuf_ptr, position, false, true, style_ptr,
titlebar_button_ptr->draw);
struct wlr_buffer *focussed_pressed_ptr = create_buf(
focussed_gfxbuf_ptr, position, true, true, style_ptr,
titlebar_button_ptr->draw);
struct wlr_buffer *blurred_ptr = create_buf(
blurred_gfxbuf_ptr, position, false, false, style_ptr,
titlebar_button_ptr->draw);
if (NULL != focussed_released_ptr &&
NULL != focussed_pressed_ptr &&
NULL != blurred_ptr) {
wlr_buffer_drop_nullify(
&titlebar_button_ptr->focussed_released_wlr_buffer_ptr);
wlr_buffer_drop_nullify(
&titlebar_button_ptr->focussed_pressed_wlr_buffer_ptr);
wlr_buffer_drop_nullify(
&titlebar_button_ptr->blurred_wlr_buffer_ptr);
titlebar_button_ptr->focussed_released_wlr_buffer_ptr =
focussed_released_ptr;
titlebar_button_ptr->focussed_pressed_wlr_buffer_ptr =
focussed_pressed_ptr;
titlebar_button_ptr->blurred_wlr_buffer_ptr = blurred_ptr;
update_buffers(titlebar_button_ptr);
return true;
}
wlr_buffer_drop_nullify(&focussed_released_ptr);
wlr_buffer_drop_nullify(&focussed_pressed_ptr);
wlr_buffer_drop_nullify(&blurred_ptr);
return false;
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_titlebar_button_element(
wlmtk_titlebar_button_t *titlebar_button_ptr)
{
return &titlebar_button_ptr->super_button.super_buffer.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Virtual destructor, wraps to @ref wlmtk_titlebar_button_destroy. */
void titlebar_button_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_titlebar_button_t *titlebar_button_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_titlebar_button_t,
super_button.super_buffer.super_element);
wlmtk_titlebar_button_destroy(titlebar_button_ptr);
}
/* ------------------------------------------------------------------------- */
/** Handles button clicks: Passes the request to the window. */
void titlebar_button_clicked(wlmtk_button_t *button_ptr)
{
wlmtk_titlebar_button_t *titlebar_button_ptr = BS_CONTAINER_OF(
button_ptr, wlmtk_titlebar_button_t, super_button);
titlebar_button_ptr->click_handler(titlebar_button_ptr->window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Updates the button's buffer depending on activation status. */
void update_buffers(wlmtk_titlebar_button_t *titlebar_button_ptr)
{
// No buffer: Nothing to update.
if (NULL == titlebar_button_ptr->focussed_released_wlr_buffer_ptr ||
NULL == titlebar_button_ptr->focussed_pressed_wlr_buffer_ptr ||
NULL == titlebar_button_ptr->blurred_wlr_buffer_ptr) return;
if (titlebar_button_ptr->activated) {
wlmtk_button_set(
&titlebar_button_ptr->super_button,
titlebar_button_ptr->focussed_released_wlr_buffer_ptr,
titlebar_button_ptr->focussed_pressed_wlr_buffer_ptr);
} else {
wlmtk_button_set(
&titlebar_button_ptr->super_button,
titlebar_button_ptr->blurred_wlr_buffer_ptr,
titlebar_button_ptr->blurred_wlr_buffer_ptr);
}
}
/* ------------------------------------------------------------------------- */
/** Helper: Creates a WLR buffer for the button. */
struct wlr_buffer *create_buf(
bs_gfxbuf_t *gfxbuf_ptr,
int position,
bool pressed,
bool focussed,
const wlmtk_titlebar_style_t *style_ptr,
wlmtk_titlebar_button_draw_t draw)
{
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
style_ptr->height, style_ptr->height);
if (NULL == wlr_buffer_ptr) return NULL;
bs_gfxbuf_copy_area(
bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr), 0, 0,
gfxbuf_ptr, position, 0, style_ptr->height, style_ptr->height);
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
wlmaker_primitives_draw_bezel(
cairo_ptr, style_ptr->bezel_width, !pressed);
uint32_t color = style_ptr->focussed_text_color;
if (!focussed) color = style_ptr->blurred_text_color;
draw(cairo_ptr, style_ptr->height, color);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* == Unit tests =========================================================== */
static void test_button(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_titlebar_button_test_cases[] = {
{ 1, "button", test_button },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests button visualization. */
void test_button(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_titlebar_button_t *button_ptr = wlmtk_titlebar_button_create(
NULL,
wlmtk_window_request_close,
fake_window_ptr->window_ptr,
wlmaker_primitives_draw_close_icon);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, button_ptr);
wlmtk_titlebar_button_set_activated(button_ptr, true);
// For improved readability.
wlmtk_buffer_t *super_buffer_ptr = &button_ptr->super_button.super_buffer;
wlmtk_element_t *element_ptr = wlmtk_titlebar_button_element(button_ptr);
// Draw contents.
wlmtk_titlebar_style_t style = {
.height = 22,
.focussed_text_color = 0xffffffff,
.blurred_text_color = 0xffe0c0a0,
.bezel_width = 1
};
bs_gfxbuf_t *f_ptr = bs_gfxbuf_create(100, 22);
bs_gfxbuf_clear(f_ptr, 0xff4040c0);
bs_gfxbuf_t *b_ptr = bs_gfxbuf_create(100, 22);
bs_gfxbuf_clear(b_ptr, 0xff303030);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_titlebar_button_redraw(button_ptr, f_ptr, b_ptr, 30, &style));
bs_gfxbuf_destroy(b_ptr);
bs_gfxbuf_destroy(f_ptr);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_button_focussed_released.png");
// Pointer must be inside the button for accepting DOWN.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(element_ptr, 11, 11, 0));
// Button down: pressed.
wlmtk_button_event_t button = {
.button = BTN_LEFT, .type = WLMTK_BUTTON_DOWN
};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &button));
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_button_focussed_pressed.png");
button.type = WLMTK_BUTTON_UP;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &button));
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_button_focussed_released.png");
// Click: To be passed along, no change to visual.
BS_TEST_VERIFY_FALSE(
test_ptr,
fake_window_ptr->fake_content_ptr->request_close_called);
button.type = WLMTK_BUTTON_CLICK;
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &button));
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_button_focussed_released.png");
BS_TEST_VERIFY_TRUE(
test_ptr,
fake_window_ptr->fake_content_ptr->request_close_called);
// De-activate: Show as blurred.
wlmtk_titlebar_button_set_activated(button_ptr, false);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_button_blurred.png");
wlmtk_element_destroy(element_ptr);
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of titlebar_button.c ============================================= */
wlmaker-0.3/src/toolkit/titlebar_button.h 0000664 0000000 0000000 00000005641 14641446446 0020667 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar_button.h
*
* @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.
*/
#ifndef __WLMTK_TITLEBAR_BUTTON_H__
#define __WLMTK_TITLEBAR_BUTTON_H__
#include
#include
/** Forward declaration. */
typedef struct _wlmtk_titlebar_button_t wlmtk_titlebar_button_t;
#include "titlebar.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Function pointer to method for drawing the button contents. */
typedef void (*wlmtk_titlebar_button_draw_t)(
cairo_t *cairo_ptr, int siye, uint32_t color);
/**
* Creates a button for the titlebar.
*
* @param env_ptr
* @param click_handler
* @param window_ptr
* @param draw
*
* @return Pointer to the titlebar button, or NULL on error.
*/
wlmtk_titlebar_button_t *wlmtk_titlebar_button_create(
wlmtk_env_t *env_ptr,
void (*click_handler)(wlmtk_window_t *window_ptr),
wlmtk_window_t *window_ptr,
wlmtk_titlebar_button_draw_t draw);
/**
* Destroys the titlebar button.
*
* @param titlebar_button_ptr
*/
void wlmtk_titlebar_button_destroy(
wlmtk_titlebar_button_t *titlebar_button_ptr);
/**
* Sets the activation status (focussed / blurred) of the titlebar button.
*
* @param titlebar_button_ptr
* @param activated
*/
void wlmtk_titlebar_button_set_activated(
wlmtk_titlebar_button_t *titlebar_button_ptr,
bool activated);
/**
* Redraws the titlebar button for given textures, position and style.
*
* @param titlebar_button_ptr
* @param focussed_gfxbuf_ptr
* @param blurred_gfxbuf_ptr
* @param position
* @param style_ptr
*
* @return true on success.
*/
bool wlmtk_titlebar_button_redraw(
wlmtk_titlebar_button_t *titlebar_button_ptr,
bs_gfxbuf_t *focussed_gfxbuf_ptr,
bs_gfxbuf_t *blurred_gfxbuf_ptr,
int position,
const wlmtk_titlebar_style_t *style_ptr);
/**
* Returns the titlebar button's super element.
*
* @param titlebar_button_ptr
*
* @return Pointer to the superclass @ref wlmtk_element_t.
*/
wlmtk_element_t *wlmtk_titlebar_button_element(
wlmtk_titlebar_button_t *titlebar_button_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_titlebar_button_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TITLEBAR_BUTTON_H__ */
/* == End of titlebar_button.h ============================================= */
wlmaker-0.3/src/toolkit/titlebar_title.c 0000664 0000000 0000000 00000036221 14641446446 0020466 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar_title.c
*
* @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.
*/
#include "titlebar_title.h"
#include "buffer.h"
#include "gfxbuf.h"
#include "primitives.h"
#include "window.h"
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the title bar's title. */
struct _wlmtk_titlebar_title_t {
/** Superclass: Buffer. */
wlmtk_buffer_t super_buffer;
/** Pointer to the window the title element belongs to. */
wlmtk_window_t *window_ptr;
/** The drawn title, when focussed. */
struct wlr_buffer *focussed_wlr_buffer_ptr;
/** The drawn title, when blurred. */
struct wlr_buffer *blurred_wlr_buffer_ptr;
};
static void _wlmtk_titlebar_title_element_destroy(
wlmtk_element_t *element_ptr);
static bool _wlmtk_titlebar_title_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static bool _wlmtk_titlebar_title_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr);
static void title_set_activated(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bool activated);
struct wlr_buffer *title_create_buffer(
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
uint32_t text_color,
const char *title_ptr,
const wlmtk_titlebar_style_t *style_ptr);
/* == Data ================================================================= */
/** Extension to the superclass elment's virtual method table. */
static const wlmtk_element_vmt_t titlebar_title_element_vmt = {
.destroy = _wlmtk_titlebar_title_element_destroy,
.pointer_button = _wlmtk_titlebar_title_element_pointer_button,
.pointer_axis = _wlmtk_titlebar_title_element_pointer_axis,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_titlebar_title_t *wlmtk_titlebar_title_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr)
{
wlmtk_titlebar_title_t *titlebar_title_ptr = logged_calloc(
1, sizeof(wlmtk_titlebar_title_t));
if (NULL == titlebar_title_ptr) return NULL;
titlebar_title_ptr->window_ptr = window_ptr;
if (!wlmtk_buffer_init(&titlebar_title_ptr->super_buffer, env_ptr)) {
wlmtk_titlebar_title_destroy(titlebar_title_ptr);
return NULL;
}
wlmtk_element_extend(
&titlebar_title_ptr->super_buffer.super_element,
&titlebar_title_element_vmt);
return titlebar_title_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_title_destroy(wlmtk_titlebar_title_t *titlebar_title_ptr)
{
wlr_buffer_drop_nullify(&titlebar_title_ptr->focussed_wlr_buffer_ptr);
wlr_buffer_drop_nullify(&titlebar_title_ptr->blurred_wlr_buffer_ptr);
wlmtk_buffer_fini(&titlebar_title_ptr->super_buffer);
free(titlebar_title_ptr);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_titlebar_title_redraw(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bs_gfxbuf_t *focussed_gfxbuf_ptr,
bs_gfxbuf_t *blurred_gfxbuf_ptr,
int position,
int width,
bool activated,
const char *title_ptr,
const wlmtk_titlebar_style_t *style_ptr)
{
BS_ASSERT(focussed_gfxbuf_ptr->width == blurred_gfxbuf_ptr->width);
BS_ASSERT(style_ptr->height == focussed_gfxbuf_ptr->height);
BS_ASSERT(style_ptr->height == blurred_gfxbuf_ptr->height);
BS_ASSERT(position <= (int)focussed_gfxbuf_ptr->width);
BS_ASSERT(position + width <= (int)focussed_gfxbuf_ptr->width);
if (NULL == title_ptr) title_ptr = "";
struct wlr_buffer *focussed_wlr_buffer_ptr = title_create_buffer(
focussed_gfxbuf_ptr, position, width,
style_ptr->focussed_text_color, title_ptr, style_ptr);
struct wlr_buffer *blurred_wlr_buffer_ptr = title_create_buffer(
blurred_gfxbuf_ptr, position, width,
style_ptr->blurred_text_color, title_ptr, style_ptr);
if (NULL == focussed_wlr_buffer_ptr ||
NULL == blurred_wlr_buffer_ptr) {
wlr_buffer_drop_nullify(&focussed_wlr_buffer_ptr);
wlr_buffer_drop_nullify(&blurred_wlr_buffer_ptr);
return false;
}
wlr_buffer_drop_nullify(&titlebar_title_ptr->focussed_wlr_buffer_ptr);
titlebar_title_ptr->focussed_wlr_buffer_ptr = focussed_wlr_buffer_ptr;
wlr_buffer_drop_nullify(&titlebar_title_ptr->blurred_wlr_buffer_ptr);
titlebar_title_ptr->blurred_wlr_buffer_ptr = blurred_wlr_buffer_ptr;
title_set_activated(titlebar_title_ptr, activated);
return true;
}
/* ------------------------------------------------------------------------- */
void wlmtk_titlebar_title_set_activated(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bool activated)
{
title_set_activated(titlebar_title_ptr, activated);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_titlebar_title_element(
wlmtk_titlebar_title_t *titlebar_title_ptr)
{
return &titlebar_title_ptr->super_buffer.super_element;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Dtor. */
void _wlmtk_titlebar_title_element_destroy(
wlmtk_element_t *element_ptr)
{
wlmtk_titlebar_title_t *titlebar_title_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_titlebar_title_t, super_buffer.super_element);
wlmtk_titlebar_title_destroy(titlebar_title_ptr);
}
/* ------------------------------------------------------------------------- */
/** See @ref wlmtk_element_vmt_t::pointer_button. */
bool _wlmtk_titlebar_title_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_titlebar_title_t *titlebar_title_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_titlebar_title_t, super_buffer.super_element);
if (button_event_ptr->button != BTN_LEFT) return false;
switch (button_event_ptr->type) {
case WLMTK_BUTTON_DOWN:
wlmtk_window_request_move(titlebar_title_ptr->window_ptr);
break;
default: // Can be ignored.
break;
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Handles pointer axis events: Scroll wheel up will shade, down will unshade.
*
* @param element_ptr
* @param wlr_pointer_axis_event_ptr
*
* @return true, if the axis event was consumed. That is the case if it's
* source is a scroll wheel, and the orientation is vertical.
*/
bool _wlmtk_titlebar_title_element_pointer_axis(
wlmtk_element_t *element_ptr,
struct wlr_pointer_axis_event *wlr_pointer_axis_event_ptr)
{
wlmtk_titlebar_title_t *titlebar_title_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_titlebar_title_t, super_buffer.super_element);
// Only consider vertical wheel moves.
if (WLR_AXIS_SOURCE_WHEEL != wlr_pointer_axis_event_ptr->source ||
WLR_AXIS_ORIENTATION_VERTICAL !=
wlr_pointer_axis_event_ptr->orientation) {
return false;
}
if (wlr_pointer_axis_event_ptr->delta > 0) {
wlmtk_window_request_shaded(titlebar_title_ptr->window_ptr, false);
} else if (wlr_pointer_axis_event_ptr->delta < 0) {
wlmtk_window_request_shaded(titlebar_title_ptr->window_ptr, true);
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Sets whether the title is drawn focussed (activated) or blurred.
*
* @param titlebar_title_ptr
* @param activated
*/
void title_set_activated(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bool activated)
{
wlmtk_buffer_set(
&titlebar_title_ptr->super_buffer,
activated ?
titlebar_title_ptr->focussed_wlr_buffer_ptr :
titlebar_title_ptr->blurred_wlr_buffer_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Creates a WLR buffer with the title's texture, as specified.
*
* @param gfxbuf_ptr
* @param position
* @param width
* @param text_color
* @param title_ptr
* @param style_ptr
*
* @return A pointer to a `struct wlr_buffer` with the texture.
*/
struct wlr_buffer *title_create_buffer(
bs_gfxbuf_t *gfxbuf_ptr,
unsigned position,
unsigned width,
uint32_t text_color,
const char *title_ptr,
const wlmtk_titlebar_style_t *style_ptr)
{
BS_ASSERT(NULL != title_ptr);
struct wlr_buffer *wlr_buffer_ptr = bs_gfxbuf_create_wlr_buffer(
width, style_ptr->height);
if (NULL == wlr_buffer_ptr) return NULL;
bs_gfxbuf_copy_area(
bs_gfxbuf_from_wlr_buffer(wlr_buffer_ptr),
0, 0,
gfxbuf_ptr,
position, 0,
width, style_ptr->height);
cairo_t *cairo_ptr = cairo_create_from_wlr_buffer(wlr_buffer_ptr);
if (NULL == cairo_ptr) {
wlr_buffer_drop(wlr_buffer_ptr);
return NULL;
}
wlmaker_primitives_draw_bezel_at(
cairo_ptr, 0, 0, width, style_ptr->height, 1.0, true);
wlmaker_primitives_draw_window_title(
cairo_ptr, &style_ptr->font, title_ptr, text_color);
cairo_destroy(cairo_ptr);
return wlr_buffer_ptr;
}
/* == Unit tests =========================================================== */
static void test_title(bs_test_t *test_ptr);
static void test_shade(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_titlebar_title_test_cases[] = {
{ 1, "title", test_title },
{ 1, "shade", test_shade },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests title drawing. */
void test_title(bs_test_t *test_ptr)
{
const wlmtk_titlebar_style_t style = {
.focussed_text_color = 0xffc0c0c0,
.blurred_text_color = 0xff808080,
.height = 22,
.font = {
.face = "Helvetica",
.weight = WLMTK_FONT_WEIGHT_BOLD,
.size = 15,
}
};
bs_gfxbuf_t *focussed_gfxbuf_ptr = bs_gfxbuf_create(120, 22);
bs_gfxbuf_t *blurred_gfxbuf_ptr = bs_gfxbuf_create(120, 22);
bs_gfxbuf_clear(focussed_gfxbuf_ptr, 0xff2020c0);
bs_gfxbuf_clear(blurred_gfxbuf_ptr, 0xff404040);
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_titlebar_title_t *titlebar_title_ptr = wlmtk_titlebar_title_create(
NULL, fake_window_ptr->window_ptr);
wlmtk_element_t *element_ptr = wlmtk_titlebar_title_element(
titlebar_title_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, titlebar_title_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_titlebar_title_redraw(
titlebar_title_ptr,
focussed_gfxbuf_ptr, blurred_gfxbuf_ptr,
10, 90, true, "Title", &style));
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(titlebar_title_ptr->focussed_wlr_buffer_ptr),
"toolkit/title_focussed.png");
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(titlebar_title_ptr->blurred_wlr_buffer_ptr),
"toolkit/title_blurred.png");
// We had started as "activated", verify that's correct.
wlmtk_buffer_t *super_buffer_ptr = &titlebar_title_ptr->super_buffer;
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_focussed.png");
// De-activated the title. Verify that was propagated.
title_set_activated(titlebar_title_ptr, false);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_blurred.png");
// Redraw with shorter width. Verify that's still correct.
wlmtk_titlebar_title_redraw(
titlebar_title_ptr, focussed_gfxbuf_ptr, blurred_gfxbuf_ptr,
10, 70, false, "Title", &style);
BS_TEST_VERIFY_GFXBUF_EQUALS_PNG(
test_ptr,
bs_gfxbuf_from_wlr_buffer(super_buffer_ptr->wlr_buffer_ptr),
"toolkit/title_blurred_short.png");
// Pressing a button should trigger a move.
BS_TEST_VERIFY_FALSE(test_ptr, fake_window_ptr->request_move_called);
wlmtk_button_event_t button = {
.button = BTN_LEFT, .type = WLMTK_BUTTON_DOWN
};
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_button(element_ptr, &button));
BS_TEST_VERIFY_TRUE(test_ptr, fake_window_ptr->request_move_called);
wlmtk_element_destroy(element_ptr);
wlmtk_fake_window_destroy(fake_window_ptr);
bs_gfxbuf_destroy(focussed_gfxbuf_ptr);
bs_gfxbuf_destroy(blurred_gfxbuf_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests that axis actions trigger 'shade'. */
void test_shade(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
wlmtk_titlebar_title_t *titlebar_title_ptr = wlmtk_titlebar_title_create(
NULL, fake_window_ptr->window_ptr);
wlmtk_element_t *element_ptr = wlmtk_titlebar_title_element(
titlebar_title_ptr);
// Initial state: Not shaded.
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_shaded(fake_window_ptr->window_ptr));
struct wlr_pointer_axis_event axis_event = {
.source = WLR_AXIS_SOURCE_WHEEL,
.orientation = WLR_AXIS_ORIENTATION_VERTICAL,
.delta = -0.01
};
// Initial state: Not server-side-decorated, won't shade.
wlmtk_element_pointer_axis(element_ptr, &axis_event);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_shaded(fake_window_ptr->window_ptr));
// Decorate. Now it shall shade.
wlmtk_window_set_server_side_decorated(fake_window_ptr->window_ptr, true);
wlmtk_element_pointer_axis(element_ptr, &axis_event);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_shaded(fake_window_ptr->window_ptr));
// Scroll the other way: Unshade.
axis_event.delta = 0.01;
wlmtk_element_pointer_axis(element_ptr, &axis_event);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_shaded(fake_window_ptr->window_ptr));
// Axis from another source: Ignored.
axis_event.source = WLR_AXIS_SOURCE_FINGER;
axis_event.delta = -0.01;
wlmtk_element_pointer_axis(element_ptr, &axis_event);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_shaded(fake_window_ptr->window_ptr));
wlmtk_titlebar_title_destroy(titlebar_title_ptr);
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of titlebar_title.c ============================================== */
wlmaker-0.3/src/toolkit/titlebar_title.h 0000664 0000000 0000000 00000005544 14641446446 0020477 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file titlebar_title.h
*
* @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.
*/
#ifndef __WLMTK_TITLEBAR_TITLE_H__
#define __WLMTK_TITLEBAR_TITLE_H__
/** Forward declaration. */
typedef struct _wlmtk_titlebar_title_t wlmtk_titlebar_title_t;
#include
#include
#include "titlebar.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* Creates a title bar title.
*
* @param env_ptr
* @param window_ptr
*
* @return Title handle.
*/
wlmtk_titlebar_title_t *wlmtk_titlebar_title_create(
wlmtk_env_t *env_ptr,
wlmtk_window_t *window_ptr);
/**
* Destroys the titlebar title.
*
* @param titlebar_title_ptr
*/
void wlmtk_titlebar_title_destroy(
wlmtk_titlebar_title_t *titlebar_title_ptr);
/**
* Redraws the title section of the title bar.
*
* @param titlebar_title_ptr
* @param focussed_gfxbuf_ptr Titlebar background when focussed.
* @param blurred_gfxbuf_ptr Titlebar background when blurred.
* @param position Position of title telative to titlebar.
* @param width Width of title.
* @param activated Whether the title bar should start focussed.
* @param title_ptr Title, or NULL.
* @param style_ptr
*
* @return true on success.
*/
bool wlmtk_titlebar_title_redraw(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bs_gfxbuf_t *focussed_gfxbuf_ptr,
bs_gfxbuf_t *blurred_gfxbuf_ptr,
int position,
int width,
bool activated,
const char *title_ptr,
const wlmtk_titlebar_style_t *style_ptr);
/**
* Sets activation status of the titlebar's title.
*
* @param titlebar_title_ptr
* @param activated
*/
void wlmtk_titlebar_title_set_activated(
wlmtk_titlebar_title_t *titlebar_title_ptr,
bool activated);
/**
* Returns the superclass @ref wlmtk_element_t for the titlebar title.
*
* @param titlebar_title_ptr
*
* @return Pointer to the super element.
*/
wlmtk_element_t *wlmtk_titlebar_title_element(
wlmtk_titlebar_title_t *titlebar_title_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_titlebar_title_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TITLEBAR_TITLE_H__ */
/* == End of titlebar_title.h ============================================== */
wlmaker-0.3/src/toolkit/toolkit.h 0000664 0000000 0000000 00000003320 14641446446 0017143 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file toolkit.h
*
* See @ref toolkit_page for documentation.
*
* @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.
*/
#ifndef __WLMTK_TOOLKIT_H__
#define __WLMTK_TOOLKIT_H__
#include "gfxbuf.h"
#include "primitives.h"
#include "style.h"
#include "util.h"
#include
#include
#include "bordered.h"
#include "box.h"
#include "buffer.h"
#include "button.h"
#include "container.h"
#include "content.h"
#include "dock.h"
#include "element.h"
#include "env.h"
#include "fsm.h"
#include "image.h"
#include "input.h"
#include "lock.h"
#include "panel.h"
#include "popup.h"
#include "rectangle.h"
#include "resizebar.h"
#include "resizebar_area.h"
#include "root.h"
#include "surface.h"
#include "tile.h"
#include "titlebar.h"
#include "titlebar_button.h"
#include "titlebar_title.h"
#include "util.h"
#include "window.h"
#include "workspace.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_TOOLKIT_H__ */
/* == End of toolkit.h ===================================================== */
wlmaker-0.3/src/toolkit/toolkit.md 0000664 0000000 0000000 00000025056 14641446446 0017326 0 ustar 00root root 0000000 0000000
# Toolkit {#toolkit_page}
## Compositor Elements
### Class Hierarchy
* Where do we use composition, vs. inheritance?
```plantuml
class Element {
int x, y
struct wlr_scene_node *node_ptr
Container *parent_container_ptr
bool init(handlers)
bool init_attached(handlers, struct wlr_scene_tree *)
void fini()
-void set_parent_container(Container*)
-void attach_to_scene_graph()
void set_visible(bool)
bool is_visible()
void set_position(int, int)
void get_position(int*, int*)
void get_size(int*, int*)
{abstract}#void destroy()
{abstract}#struct wlr_scene_node *create_scene_node(parent_node*)
#void pointer_motion(double, double)
#void pointer_button(wlmtk_button_event_t)
#void pointer_leave()
}
note right of Element::"set_parent_container(Container*)"
Will invoke set_parent_container.
end note
note right of Element::"attach_to_scene_graph()"
Will create or reparent this element's node to the parent's scene tree, or
detach and destroy this element's node, if the parent does not have a scene
tree.
end note
class Container {
Element super_element
Element elements[]
bool init(handlers)
void fini()
add_element(Element*)
remove_element(Element*)
-struct wlr_scene_tree *wlr_scene_tree()
{abstract}#void destroy()
#void configure()
}
Element <|-- Container
note right of Element::"add_element(Element*)"
Both add_element() and remove_element() will call
Element::set_parent_container() and thus alignt he element's scene node
with the container's tree.
end note
class Workspace {
Container super_container
Layer layers[]
Container *create()
void destroy()
map_window(Window*)
unmap_window(Window*)
activate_window(Window*)
begin_window_move(Window*)
map_panel(Panel *, layer)
unmap_panel(Panel *)
}
Container *-- Workspace
class Box {
Container super_container
bool init(handlers, wlmtk_box_orientation_t)
}
Container <|-- Box
abstract class Surface {
Element super_element
request_size()
get_size()
}
abstract class Content {
Container super_container
Surface surface
Surface popups[]
init(surface)
fini()
request_size()
get_size()
request_close()
set_activated()
}
class Toplevel {
Content super_content
-- because: implement request_close, set_activated, ...
-- but: Window ?
}
class Popup {
Surface super_surface
}
abstract class Content {
Element super_element
init(handlers)
fini()
struct wlr_scene_node *create_scene_node()
Element *element()
-set_window(Window*)
{abstract}#void get_size(int *, int *)
{abstract}#void set_size(int, int)
{abstract}#void set_activated(bool)
{abstract}#void set_maximized(bool)
{abstract}#void set_fullscreen(bool)
}
Element <|-- Content
note right of Content
Interface for Window contents.
A surface (or... buffer? ...). Ultimately wraps a node,
thus may be an element.
end note
class Layer {
Container super_container
add_panel()
remove_panel()
}
Container <|-- Layer
class Panel {
Element super_element
{abstract}configure()
#set_layer(Layer *)
}
Element <|-- Panel
class XdgToplevelSurface {
}
Content <|-- XdgToplevelSurface
class Buffer {
Element parent
init(handlers, struct wlr_buffer *)
set(struct wlr_buffer *)
}
Element <|-- Buffer
class Button {
Buffer super_buffer
init(handlers, texture_up, texture_down, texture_blurred)
update(texture_up, texture_down, texture_blurred)
}
Buffer <|-- Button
class Window {
Box super_box
Content *content
TitleBar *title_bar
Window *create(Content*)
destroy()
Element *element()
set_activated(bool)
set_server_side_decorated(bool)
get_size(int *, int *)
set_size(int, int)
}
Box *-- Window
class TitleBar {
Box super_box
}
Box *-- TitleBar
class TitleBarButton {
Button super_button
init(handlers, overlay_texture, texture, posx, posy)
redraw(texture, posx, posy)
get_width(int *)
set_width(int)
}
class Menu {
Box super_box
}
Box *-- Menu
class MenuItem {
}
Buffer <|-- MenuItem
class Cursor {
Cursor *create()
void destroy()
attach_input_device(struct wlr_input_device*)
set_image(const char *
}
class LayerShell {
}
Panel *-- LayerShell
```
### Pending work
* Separate the "map" method into "attach_to_node" and "set_visible". Elements
should be marked as visible even if their parent is not "mapped" yet; thus
leading to lazy instantiation of the node, once their parent gets "mapped"
(ie. attached to the scene graph).
### User Journeys
#### Creating a new XDG toplevel
* xdg_toplevel... => on handle_new_surface
* XdgToplevelSurface::create(wlr surface)
* listeners for map, unmap, destroy
=> so yes, what will this do when mapped?
* Window::create(surface)
* registers the window for workspace
* creates the container, with parent of window element
* if decoration:
* will setup listeners for the various events, ...
* request maximize
* request move
* request show window menu
* set title
* ...
set title handler:
* window::set_title
request maximize handler:
* window::request_maximize
* window::set_maximized
* internally: get view from workspace, ... set_size
* callback to surface (if set): set_maximized
upon surface::map
* workspace::add_window(window) (unsure: do we need this?)
=> should set "container" of window parent... element to workspace::container
(ie. set_parent(...); and add "element" to "container")
* workspace::map_window(window)
=> this should add window to the set of workspace::mapped_windows
=> window element->container -> map_element(element)
(expects the container to be mapped)
=> will call map(node?) on window element
- is implemented in Container:
- create a scene tree (from parents node) oc reparent (from parent)
- calls map for every item in container
upon surface::unmap
* workspace::unmap_window
=> window element->container -> unmap_element(element)
=> will call unmap() on window element
=> destroy the node
* workspace::remove_window(window) (do we need this?)
There is a click ("pointer button event") -> goes to workspace.
* use node lookup -> should give data -> element
* element::click(...)
* Button::click gets called. Has a "button_from_element" & goes from there.
Button is pressed => pass down to pointer-focussed element.
Would eg. show the "pressed" state of a button, but not activate.
button_down
Button is released => pass down to pointer-focussed element.
(actually: pass down to the element where the button-press was passed to)
Would eg. acivate the button, and restore the state of a pressed button.
button_up
click
Button remains pressed and pointer moves.
Means: We might be dragging something around.
Start a "drag" => pass down a "drag" event to pointer focussed element.
Keep track of drag start, and pass on relative drag motion down to element.
Keeps passing drag elements to same element until drag ends.
Would keep the element pointer focussed (?)
A 'button' would ignore drags. drag_begin, drag_end, drag_motion ?
A 'titlebar' would use this to begin a move, and update position.
A 'iconified' would use this to de-couple from eg. dock
drags have a pointer button associated (left, middle, right),
and a relative position since. They also have the starting position,
relative to the element.
button_down
[lingering time, some light move]
drag_begin
drag_motion
drag_motion
button_up
drag_end
Button is pressed again, without much move since last press.
Means: We have a double-click.
Pass down a double-click to the pointer-focussed element.
button_down
button_up
double_click
## Dock and Clip class elements
```plantuml
class DockOptions {
int anchor
int orientation
int layer
}
class Dock {
Panel super_panel
init(DockOptions options)
Tile entries[];
add_entry()
remove_entry()
}
class Tile {
Element
set_size(int size)
}
class Launcher {
const char *icon_file_path;
const char *commandline;
}
Tile <|-- Launcher
class Icon {}
Tile <|-- Icon
class IconSurface {}
Tile <|-- IconSurface
class Clip {}
Dock <|-- Clip
class IconArea {}
Dock <|-- IconArea
```
### Description
* A `Dock` is the base class for the Dock, Clip or icon area. It has an anchor
to either a corner or an edge of the screen, and an orientation (vertical or
horizontal). On screen edges, the orientation must be parallel to the edge's
orientation.
* A `Tile` is the parent for what's shown in the dock, clip or the icon
area. An entry is quadratic, and the size is given by the dock. The size may
change during execution.
A Tile will accept and may pass on pointer events.
* A `Launcher` is an implementation of a Tile.
It shows an image (the application icon), and will spawn a subprocess to
execute the configured commandline when invoked.
A launcher is invoked by a click (TODO: doubleclick?).
It shows status of the spawned subprocesses ("running", "starting", "error").
If the application is running, it may show the application's icon (provided by
the running application via a Wayland protocol), instead of the pre-configured
one.
The Launcher is not part of wlmtk, but of wlmaker implementation.
### Thoughts
* A running application in WLMaker may (1) have an icon, and (2) be in
miniaturized (*iconified*) state.
An "application" in this context refers to ... a wayland client? an XDG
toplevel? Any toplevel (eg. X11 toplevel)? For UI interaction, a "toplevel"
seems a good answer, as it's the *toplevel* that can be *iconified*.
That would apply to both X11 and XDG shell toplevels.
Implication: WLMaker needs to keep track of "applications".
If there is an icon, it should be shown on the launcher that spawned the
"application". (showing the icon of the most recently launched one).
Otherwise, it should be displayed in the icon area.
An "application" that is *iconified* will be shown in the icon area. This is
irrespective of whether there is already an icon shown for that "application".
wlmaker-0.3/src/toolkit/toolkit_test.c 0000664 0000000 0000000 00000004640 14641446446 0020203 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file toolkit_test.c
*
* @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.
*/
#include "toolkit.h"
/** Toolkit unit tests. */
const bs_test_set_t toolkit_tests[] = {
{ 1, "bordered", wlmtk_bordered_test_cases },
{ 1, "box", wlmtk_box_test_cases },
{ 1, "button", wlmtk_button_test_cases },
{ 1, "container", wlmtk_container_test_cases },
{ 1, "content", wlmtk_content_test_cases },
{ 1, "dock", wlmtk_dock_test_cases },
{ 1, "element", wlmtk_element_test_cases },
{ 1, "fsm", wlmtk_fsm_test_cases },
{ 1, "image", wlmtk_image_test_cases },
{ 1, "layer", wlmtk_layer_test_cases },
{ 1, "panel", wlmtk_panel_test_cases },
{ 1, "surface", wlmtk_surface_test_cases },
{ 1, "rectangle", wlmtk_rectangle_test_cases },
{ 1, "resizebar", wlmtk_resizebar_test_cases },
{ 1, "resizebar_area", wlmtk_resizebar_area_test_cases },
{ 1, "root", wlmtk_root_test_cases },
{ 1, "tile", wlmtk_tile_test_cases },
{ 1, "titlebar", wlmtk_titlebar_test_cases },
{ 1, "titlebar_button", wlmtk_titlebar_button_test_cases },
{ 1, "titlebar_title", wlmtk_titlebar_title_test_cases },
{ 1, "util", wlmtk_util_test_cases },
{ 1, "window", wlmtk_window_test_cases },
{ 1, "workspace", wlmtk_workspace_test_cases },
{ 1, "primitives", wlmaker_primitives_test_cases },
{ 0, NULL, NULL }
};
#if !defined(TEST_DATA_DIR)
/** Directory root for looking up test data. See `bs_test_resolve_path`. */
#define TEST_DATA_DIR "./"
#endif // TEST_DATA_DIR
/** Main program, runs the unit tests. */
int main(int argc, const char **argv)
{
const bs_test_param_t params = {
.test_data_dir_ptr = TEST_DATA_DIR
};
return bs_test(toolkit_tests, argc, argv, ¶ms);
}
/* == End of toolkit_test.c ================================================ */
wlmaker-0.3/src/toolkit/util.c 0000664 0000000 0000000 00000006774 14641446446 0016446 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file util.c
*
* @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.
*/
#include "util.h"
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
void wlmtk_util_connect_listener_signal(
struct wl_signal *signal_ptr,
struct wl_listener *listener_ptr,
void (*notifier_func)(struct wl_listener *, void *))
{
listener_ptr->notify = notifier_func;
wl_signal_add(signal_ptr, listener_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_util_disconnect_listener(
struct wl_listener *listener_ptr)
{
// Guard clause: No disconnect if it hadn't been connected.
if (NULL == listener_ptr || NULL == listener_ptr->link.prev) return;
wl_list_remove(&listener_ptr->link);
}
/* == Unit tests =========================================================== */
static void test_listener(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_util_test_cases[] = {
{ 1, "listener", test_listener },
{ 0, NULL, NULL }
};
/** Struct for testing listener code. */
typedef struct {
/** Listener. */
struct wl_listener listener;
/** Data. */
int data;
} _wlmtk_util_listener;
static void _wlmtk_util_listener_handler(
struct wl_listener *listener_ptr,
void *data_ptr);
/* ------------------------------------------------------------------------- */
/** A test to verify listener handlers are called in order of subscription. */
static void test_listener(bs_test_t *test_ptr)
{
struct wl_signal signal;
_wlmtk_util_listener l1 = {}, l2 = {};
int i = 0;
wl_signal_init(&signal);
// First test: disconnect must not crash.
wlmtk_util_disconnect_listener(&l1.listener);
// Second test: Connect, and verify signal is emitted and handled.
wlmtk_util_connect_listener_signal(
&signal, &l1.listener, _wlmtk_util_listener_handler);
BS_TEST_VERIFY_EQ(test_ptr, 0, l1.data);
wl_signal_emit(&signal, &i);
BS_TEST_VERIFY_EQ(test_ptr, 1, l1.data);
// Third test: One more listener, and verify both handlers aacted.
wlmtk_util_connect_listener_signal(
&signal, &l2.listener, _wlmtk_util_listener_handler);
wl_signal_emit(&signal, &i);
BS_TEST_VERIFY_EQ(test_ptr, 2, l1.data);
BS_TEST_VERIFY_EQ(test_ptr, 3, l2.data);
// Cleanup.
wlmtk_util_disconnect_listener(&l2.listener);
wlmtk_util_disconnect_listener(&l1.listener);
}
/** Test handler for the listener. */
void _wlmtk_util_listener_handler(
struct wl_listener *listener_ptr,
void *data_ptr)
{
_wlmtk_util_listener *wlmtk_util_listener_ptr = BS_CONTAINER_OF(
listener_ptr, _wlmtk_util_listener, listener);
int *i_ptr = data_ptr;
wlmtk_util_listener_ptr->data = ++(*i_ptr);
}
/* == End of util.c ======================================================== */
wlmaker-0.3/src/toolkit/util.h 0000664 0000000 0000000 00000004414 14641446446 0016440 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file util.h
*
* @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.
*/
#ifndef __WLMTK_UTIL_H__
#define __WLMTK_UTIL_H__
#include
#include
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Information regarding a client. Drawn from `struct wl_client`. */
typedef struct {
/** Process ID. */
pid_t pid;
/** User ID. */
uid_t uid;
/** Group ID. */
gid_t gid;
} wlmtk_util_client_t;
/**
* Sets |notifier_func| as the notifier for |listener_ptr|, and registers it
* with |signal_ptr|.
*
* This is merely a convenience helper for the usual two-liner of boilerplate.
* To disconnect from the listener signal, call `wl_list_remove` on a reference
* to the `link` element of `*listener_ptr`.
*
* @param signal_ptr
* @param listener_ptr
* @param notifier_func
*/
// TODO(kaeser@gubbe.ch): Either swap arguments (listener first) or rename,
// eg. . wlm_util_connect_signal_to_listener(...).
void wlmtk_util_connect_listener_signal(
struct wl_signal *signal_ptr,
struct wl_listener *listener_ptr,
void (*notifier_func)(struct wl_listener *, void *));
/**
* Disconnects a listener from the signal.
*
* Does that in a safe way: Will only disconnect, if the `link` is set.
*
* @param listener_ptr
*/
void wlmtk_util_disconnect_listener(
struct wl_listener *listener_ptr);
/** Unit test cases. */
extern const bs_test_case_t wlmtk_util_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_UTIL_H__ */
/* == End of util.h ======================================================== */
wlmaker-0.3/src/toolkit/window.c 0000664 0000000 0000000 00000156364 14641446446 0017001 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file window.c
*
* @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.
*/
#include "window.h"
#include "rectangle.h"
#include "workspace.h"
#include "wlr/util/box.h"
/// Include unstable interfaces of wlroots.
#define WLR_USE_UNSTABLE
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** Maximum number of pending state updates. */
#define WLMTK_WINDOW_MAX_PENDING 64
/** Virtual method table for the window. */
struct _wlmtk_window_vmt_t {
/** Destructor. */
void (*destroy)(wlmtk_window_t *window_ptr);
/** Virtual method for @ref wlmtk_window_request_minimize. */
void (*request_minimize)(wlmtk_window_t *window_ptr);
/** Virtual method for @ref wlmtk_window_request_move. */
void (*request_move)(wlmtk_window_t *window_ptr);
/** Virtual method for @ref wlmtk_window_request_resize. */
void (*request_resize)(wlmtk_window_t *window_ptr,
uint32_t edges);
};
/** Pending positional updates for @ref wlmtk_window_t::content_ptr. */
typedef struct {
/** Node within @ref wlmtk_window_t::pending_updates. */
bs_dllist_node_t dlnode;
/** Serial of the update. */
uint32_t serial;
/** Pending X position of the surface. */
int x;
/** Pending Y position of the surface. */
int y;
/** Surface's width that is to be committed at serial. */
int width;
/** Surface's hehight that is to be committed at serial. */
int height;
} wlmtk_pending_update_t;
/** State of the window. */
struct _wlmtk_window_t {
/** Superclass: Bordered. */
wlmtk_bordered_t super_bordered;
/** Original virtual method table of the window's element superclass. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Original virtual method table of the window' container superclass. */
wlmtk_container_vmt_t orig_super_container_vmt;
/** Virtual method table. */
wlmtk_window_vmt_t vmt;
/** Box: In `super_bordered`, holds surface, title bar and resizebar. */
wlmtk_box_t box;
/** FIXME: Element. */
wlmtk_element_t *element_ptr;
/** Points to the workspace, if mapped. */
wlmtk_workspace_t *workspace_ptr;
/** Environment, the argument passet to @ref wlmtk_window_create. */
wlmtk_env_t *env_ptr;
/** Element in @ref wlmtk_workspace_t::windows, when mapped. */
bs_dllist_node_t dlnode;
/** Content of the window. */
wlmtk_content_t *content_ptr;
/** Titlebar. */
wlmtk_titlebar_t *titlebar_ptr;
/** Resizebar. */
wlmtk_resizebar_t *resizebar_ptr;
/** Window title. Set through @ref wlmtk_window_set_title. */
char *title_ptr;
/** Pending updates. */
bs_dllist_t pending_updates;
/** List of udpates currently available. */
bs_dllist_t available_updates;
/** Pre-alloocated updates. */
wlmtk_pending_update_t pre_allocated_updates[WLMTK_WINDOW_MAX_PENDING];
/** Organic size of the window, ie. when not maximized. */
struct wlr_box organic_size;
/** Whether the window has been requested as maximized. */
bool maximized;
/** Whether the window has been requested as fullscreen. */
bool fullscreen;
/**
* Whether an "inorganic" sizing operation is in progress, and thus size
* changes should not be recorded in @ref wlmtk_window_t::organic_size.
*
* This is eg. between @ref wlmtk_window_request_fullscreen and
* @ref wlmtk_window_commit_fullscreen.
*/
bool inorganic_sizing;
/** Whether the window is currently shaded. */
bool shaded;
/**
* Stores whether the window is server-side decorated.
*
* If the window is NOT fullscreen, then this is equivalent to
* (titlebar_ptr != NULL && resizebar_ptr != NULL). For a fullscreen
* window, titlebar and resizebar would be NULL, but the flag stores
* whether decoration should be enabled on organic/maximized modes.
*/
bool server_side_decorated;
/** Stores whether the window is activated (keyboard focus). */
bool activated;
/** The style used for this window. */
wlmtk_window_style_t style;
};
/** State of a fake window: Includes the public record and the window. */
typedef struct {
/** Window state. */
wlmtk_window_t window;
/** Fake window - public state. */
wlmtk_fake_window_t fake_window;
} wlmtk_fake_window_state_t;
static bool _wlmtk_window_init(
wlmtk_window_t *window_ptr,
wlmtk_env_t *env_ptr,
wlmtk_element_t *element_ptr);
static void _wlmtk_window_fini(wlmtk_window_t *window_ptr);
static wlmtk_window_vmt_t _wlmtk_window_extend(
wlmtk_window_t *window_ptr,
const wlmtk_window_vmt_t *window_vmt_ptr);
static bool _wlmtk_window_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void _wlmtk_window_container_update_layout(
wlmtk_container_t *container_ptr);
static void _wlmtk_window_request_minimize(wlmtk_window_t *window_ptr);
static void _wlmtk_window_request_move(wlmtk_window_t *window_ptr);
static void _wlmtk_window_request_resize(
wlmtk_window_t *window_ptr,
uint32_t edges);
static void _wlmtk_window_create_titlebar(wlmtk_window_t *window_ptr);
static void _wlmtk_window_create_resizebar(wlmtk_window_t *window_ptr);
static void _wlmtk_window_destroy_titlebar(wlmtk_window_t *window_ptr);
static void _wlmtk_window_destroy_resizebar(wlmtk_window_t *window_ptr);
static void _wlmtk_window_apply_decoration(wlmtk_window_t *window_ptr);
static void _wlmtk_window_request_position_and_size_decorated(
wlmtk_window_t *window_ptr,
int x,
int y,
int width,
int height,
bool include_titlebar,
bool include_resizebar,
bool include_extra);
static wlmtk_pending_update_t *_wlmtk_window_prepare_update(
wlmtk_window_t *window_ptr);
static void _wlmtk_window_release_update(
wlmtk_window_t *window_ptr,
wlmtk_pending_update_t *update_ptr);
/* == Data ================================================================= */
/** Virtual method table for the window's element superclass. */
static const wlmtk_element_vmt_t window_element_vmt = {
.pointer_button = _wlmtk_window_element_pointer_button,
};
/** Virtual method table for the window's container superclass. */
static const wlmtk_container_vmt_t window_container_vmt = {
.update_layout = _wlmtk_window_container_update_layout,
};
/** Virtual method table for the window itself. */
static const wlmtk_window_vmt_t _wlmtk_window_vmt = {
.request_minimize = _wlmtk_window_request_minimize,
.request_move = _wlmtk_window_request_move,
.request_resize = _wlmtk_window_request_resize,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_window_t *wlmtk_window_create(
wlmtk_content_t *content_ptr,
const wlmtk_window_style_t *style_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_window_t *window_ptr = logged_calloc(1, sizeof(wlmtk_window_t));
if (NULL == window_ptr) return NULL;
window_ptr->style = *style_ptr;
if (!_wlmtk_window_init(
window_ptr,
env_ptr,
wlmtk_content_element(content_ptr))) {
wlmtk_window_destroy(window_ptr);
return NULL;
}
window_ptr->content_ptr = content_ptr;
wlmtk_content_set_window(content_ptr, window_ptr);
return window_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_destroy(wlmtk_window_t *window_ptr)
{
_wlmtk_window_fini(window_ptr);
free(window_ptr);
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_window_element(wlmtk_window_t *window_ptr)
{
return &window_ptr->super_bordered.super_container.super_element;
}
/* ------------------------------------------------------------------------- */
wlmtk_window_t *wlmtk_window_from_element(wlmtk_element_t *element_ptr)
{
wlmtk_window_t *window_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_window_t, super_bordered.super_container.super_element);
BS_ASSERT(_wlmtk_window_container_update_layout ==
window_ptr->super_bordered.super_container.vmt.update_layout);
return window_ptr;
}
/* ------------------------------------------------------------------------- */
wlmtk_window_t *wlmtk_window_from_dlnode(bs_dllist_node_t *dlnode_ptr)
{
return BS_CONTAINER_OF(dlnode_ptr, wlmtk_window_t, dlnode);
}
/* ------------------------------------------------------------------------- */
bs_dllist_node_t *wlmtk_dlnode_from_window(wlmtk_window_t *window_ptr)
{
return &window_ptr->dlnode;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_set_activated(
wlmtk_window_t *window_ptr,
bool activated)
{
window_ptr->activated = activated;
wlmtk_content_set_activated(window_ptr->content_ptr, activated);
if (NULL != window_ptr->titlebar_ptr) {
wlmtk_titlebar_set_activated(window_ptr->titlebar_ptr, activated);
}
}
/* ------------------------------------------------------------------------- */
bool wlmtk_window_is_activated(wlmtk_window_t *window_ptr)
{
return window_ptr->activated;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_set_server_side_decorated(
wlmtk_window_t *window_ptr,
bool decorated)
{
if (window_ptr->server_side_decorated == decorated) return;
window_ptr->server_side_decorated = decorated;
_wlmtk_window_apply_decoration(window_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_set_title(
wlmtk_window_t *window_ptr,
const char *title_ptr)
{
char *new_title_ptr = NULL;
if (NULL != title_ptr) {
new_title_ptr = logged_strdup(title_ptr);
BS_ASSERT(NULL != new_title_ptr);
} else {
char buf[64];
snprintf(buf, sizeof(buf), "Unnamed window %p", window_ptr);
new_title_ptr = logged_strdup(buf);
BS_ASSERT(NULL != new_title_ptr);
}
if (NULL != window_ptr->title_ptr) {
if (0 == strcmp(window_ptr->title_ptr, new_title_ptr)) {
free(new_title_ptr);
return;
}
free(window_ptr->title_ptr);
}
window_ptr->title_ptr = new_title_ptr;
if (NULL != window_ptr->titlebar_ptr) {
wlmtk_titlebar_set_title(window_ptr->titlebar_ptr,
window_ptr->title_ptr);
}
}
/* ------------------------------------------------------------------------- */
const char *wlmtk_window_get_title(wlmtk_window_t *window_ptr)
{
BS_ASSERT(NULL != window_ptr->title_ptr);
return window_ptr->title_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_close(wlmtk_window_t *window_ptr)
{
wlmtk_content_request_close(window_ptr->content_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_minimize(wlmtk_window_t *window_ptr)
{
window_ptr->vmt.request_minimize(window_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_maximized(
wlmtk_window_t *window_ptr,
bool maximized)
{
if (window_ptr->shaded) return;
BS_ASSERT(NULL != wlmtk_window_get_workspace(window_ptr));
if (window_ptr->maximized == maximized) return;
if (window_ptr->fullscreen) return;
window_ptr->inorganic_sizing = maximized;
struct wlr_box box;
if (maximized) {
box = wlmtk_workspace_get_maximize_extents(
wlmtk_window_get_workspace(window_ptr));
} else {
box = window_ptr->organic_size;
}
wlmtk_content_request_maximized(window_ptr->content_ptr, maximized);
_wlmtk_window_request_position_and_size_decorated(
window_ptr, box.x, box.y, box.width, box.height,
window_ptr->server_side_decorated,
window_ptr->server_side_decorated,
!maximized);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_commit_maximized(
wlmtk_window_t *window_ptr,
bool maximized)
{
// Guard clause: Nothing to do if already as committed.
if (window_ptr->maximized == maximized) return;
window_ptr->maximized = maximized;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_window_is_maximized(wlmtk_window_t *window_ptr)
{
return window_ptr->maximized;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_fullscreen(
wlmtk_window_t *window_ptr,
bool fullscreen)
{
struct wlr_box box;
uint32_t serial;
wlmtk_pending_update_t *pending_update_ptr;
if (window_ptr->shaded) return;
// Must be mapped.
BS_ASSERT(NULL != wlmtk_window_get_workspace(window_ptr));
window_ptr->inorganic_sizing = fullscreen;
// Will not line up another pending update.
wlmtk_content_request_fullscreen(window_ptr->content_ptr, fullscreen);
if (fullscreen) {
box = wlmtk_workspace_get_fullscreen_extents(
wlmtk_window_get_workspace(window_ptr));
serial = wlmtk_content_request_size(
window_ptr->content_ptr, box.width, box.height);
pending_update_ptr = _wlmtk_window_prepare_update(window_ptr);
pending_update_ptr->serial = serial;
pending_update_ptr->x = box.x;
pending_update_ptr->y = box.y;
pending_update_ptr->width = box.width;
pending_update_ptr->height = box.height;
} else {
box = window_ptr->organic_size;
_wlmtk_window_request_position_and_size_decorated(
window_ptr, box.x, box.y, box.width, box.height,
window_ptr->server_side_decorated,
window_ptr->server_side_decorated,
true);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_commit_fullscreen(
wlmtk_window_t *window_ptr,
bool fullscreen)
{
// Guard clause: Nothing to do if we're already there.
if (window_ptr->fullscreen == fullscreen) return;
window_ptr->fullscreen = fullscreen;
_wlmtk_window_apply_decoration(window_ptr);
wlmtk_workspace_window_to_fullscreen(
wlmtk_window_get_workspace(window_ptr), window_ptr, fullscreen);
}
/* ------------------------------------------------------------------------- */
bool wlmtk_window_is_fullscreen(wlmtk_window_t *window_ptr)
{
return window_ptr->fullscreen;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_shaded(wlmtk_window_t *window_ptr, bool shaded)
{
if (window_ptr->fullscreen ||
!window_ptr->server_side_decorated ||
window_ptr->shaded == shaded) return;
wlmtk_element_set_visible(
wlmtk_content_element(window_ptr->content_ptr), !shaded);
if (NULL != window_ptr->resizebar_ptr) {
wlmtk_element_set_visible(
wlmtk_resizebar_element(window_ptr->resizebar_ptr), !shaded);
}
window_ptr->shaded = shaded;
}
/* ------------------------------------------------------------------------- */
bool wlmtk_window_is_shaded(wlmtk_window_t *window_ptr)
{
return window_ptr->shaded;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_move(wlmtk_window_t *window_ptr)
{
window_ptr->vmt.request_move(window_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_resize(wlmtk_window_t *window_ptr,
uint32_t edges)
{
window_ptr->vmt.request_resize(window_ptr, edges);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_set_position(wlmtk_window_t *window_ptr, int x, int y)
{
window_ptr->organic_size.x = x;
window_ptr->organic_size.y = y;
wlmtk_element_set_position(wlmtk_window_element(window_ptr), x, y);
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_get_size(
wlmtk_window_t *window_ptr,
int *width_ptr,
int *height_ptr)
{
struct wlr_box dimensions = wlmtk_element_get_dimensions_box(
wlmtk_content_element(window_ptr->content_ptr));
*width_ptr = dimensions.width;
*height_ptr = dimensions.height;
if (NULL != window_ptr->titlebar_ptr) {
*height_ptr += window_ptr->style.titlebar.height +
window_ptr->style.margin.width;
}
if (NULL != window_ptr->resizebar_ptr) {
*height_ptr += window_ptr->style.resizebar.height +
window_ptr->style.margin.width;
}
*height_ptr += 2 * window_ptr->super_bordered.style.width;
*width_ptr += 2 * window_ptr->super_bordered.style.width;
}
/* ------------------------------------------------------------------------- */
struct wlr_box wlmtk_window_get_position_and_size(
wlmtk_window_t *window_ptr)
{
struct wlr_box box;
wlmtk_element_get_position(
wlmtk_window_element(window_ptr), &box.x, &box.y);
wlmtk_window_get_size(window_ptr, &box.width, &box.height);
return box;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_request_position_and_size(
wlmtk_window_t *window_ptr,
int x,
int y,
int width,
int height)
{
_wlmtk_window_request_position_and_size_decorated(
window_ptr, x, y, width, height,
NULL != window_ptr->titlebar_ptr,
NULL != window_ptr->resizebar_ptr,
true);
window_ptr->organic_size.x = x;
window_ptr->organic_size.y = y;
window_ptr->organic_size.width = width;
window_ptr->organic_size.height = height;
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_serial(wlmtk_window_t *window_ptr, uint32_t serial)
{
bs_dllist_node_t *dlnode_ptr;
if (!window_ptr->inorganic_sizing &&
NULL == window_ptr->pending_updates.head_ptr) {
wlmtk_window_get_size(window_ptr,
&window_ptr->organic_size.width,
&window_ptr->organic_size.height);
return;
}
while (NULL != (dlnode_ptr = window_ptr->pending_updates.head_ptr)) {
wlmtk_pending_update_t *pending_update_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmtk_pending_update_t, dlnode);
int32_t delta = pending_update_ptr->serial - serial;
if (0 < delta) break;
wlmtk_element_set_position(
wlmtk_window_element(window_ptr),
pending_update_ptr->x,
pending_update_ptr->y);
_wlmtk_window_release_update(window_ptr, pending_update_ptr);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_window_set_workspace(
wlmtk_window_t *window_ptr,
wlmtk_workspace_t *workspace_ptr)
{
window_ptr->workspace_ptr = workspace_ptr;
}
/* ------------------------------------------------------------------------- */
wlmtk_workspace_t *wlmtk_window_get_workspace(wlmtk_window_t *window_ptr)
{
return window_ptr->workspace_ptr;
}
/* ------------------------------------------------------------------------- */
const wlmtk_util_client_t *wlmtk_window_get_client_ptr(
wlmtk_window_t *window_ptr)
{
if (NULL == window_ptr->content_ptr) return NULL;
return &window_ptr->content_ptr->client;
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/**
* Initializes an (allocated) window.
*
* @param window_ptr
* @param env_ptr
* @param element_ptr
*
* @return true on success.
*/
bool _wlmtk_window_init(
wlmtk_window_t *window_ptr,
wlmtk_env_t *env_ptr,
wlmtk_element_t *element_ptr)
{
BS_ASSERT(NULL != window_ptr);
memcpy(&window_ptr->vmt, &_wlmtk_window_vmt, sizeof(wlmtk_window_vmt_t));
window_ptr->env_ptr = env_ptr;
for (size_t i = 0; i < WLMTK_WINDOW_MAX_PENDING; ++i) {
bs_dllist_push_back(&window_ptr->available_updates,
&window_ptr->pre_allocated_updates[i].dlnode);
}
if (!wlmtk_box_init(&window_ptr->box, env_ptr,
WLMTK_BOX_VERTICAL,
&window_ptr->style.margin)) {
_wlmtk_window_fini(window_ptr);
return false;
}
wlmtk_element_set_visible(
&window_ptr->box.super_container.super_element, true);
if (!wlmtk_bordered_init(&window_ptr->super_bordered,
env_ptr,
&window_ptr->box.super_container.super_element,
&window_ptr->style.border)) {
_wlmtk_window_fini(window_ptr);
return false;
}
window_ptr->orig_super_element_vmt = wlmtk_element_extend(
&window_ptr->super_bordered.super_container.super_element,
&window_element_vmt);
window_ptr->orig_super_container_vmt = wlmtk_container_extend(
&window_ptr->super_bordered.super_container, &window_container_vmt);
window_ptr->element_ptr = element_ptr;
wlmtk_window_set_title(window_ptr, NULL);
_wlmtk_window_apply_decoration(window_ptr);
wlmtk_box_add_element_front(&window_ptr->box, element_ptr);
wlmtk_element_set_visible(element_ptr, true);
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Uninitializes the window.
*
* @param window_ptr
*/
void _wlmtk_window_fini(wlmtk_window_t *window_ptr)
{
wlmtk_window_set_server_side_decorated(window_ptr, false);
if (NULL != window_ptr->content_ptr) {
wlmtk_content_set_window(window_ptr->content_ptr, NULL);
}
if (NULL != window_ptr->element_ptr) {
wlmtk_box_remove_element(
&window_ptr->box, window_ptr->element_ptr);
wlmtk_element_set_visible(window_ptr->element_ptr, false);
window_ptr->element_ptr = NULL;
}
if (NULL != window_ptr->title_ptr) {
free(window_ptr->title_ptr);
window_ptr->title_ptr = NULL;
}
wlmtk_bordered_fini(&window_ptr->super_bordered);
wlmtk_box_fini(&window_ptr->box);
}
/* ------------------------------------------------------------------------- */
/**
* Extends the window's virtual methods.
*
* @param window_ptr
* @param window_vmt_ptr
*
* @return The previous virtual method table.
*/
wlmtk_window_vmt_t _wlmtk_window_extend(
wlmtk_window_t *window_ptr,
const wlmtk_window_vmt_t *window_vmt_ptr)
{
wlmtk_window_vmt_t orig_vmt = window_ptr->vmt;
if (NULL != window_vmt_ptr->request_minimize) {
window_ptr->vmt.request_minimize = window_vmt_ptr->request_minimize;
}
if (NULL != window_vmt_ptr->request_move) {
window_ptr->vmt.request_move = window_vmt_ptr->request_move;
}
if (NULL != window_vmt_ptr->request_resize) {
window_ptr->vmt.request_resize = window_vmt_ptr->request_resize;
}
return orig_vmt;
}
/* ------------------------------------------------------------------------- */
/** Activates window on button press, and calls the parent's implementation. */
bool _wlmtk_window_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_window_t *window_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_window_t, super_bordered.super_container.super_element);
// Permit drag-move with the (hardcoded) modifier.
// TODO(kaeser@gubbe.ch): This should be changed to make use of "DRAG"
// events, with corresponding modifiers. Do so, once added to toolkit.
if (NULL != window_ptr->env_ptr) {
struct wlr_keyboard *wlr_keyboard_ptr = wlr_seat_get_keyboard(
wlmtk_env_wlr_seat(window_ptr->env_ptr));
uint32_t modifiers = wlr_keyboard_get_modifiers(wlr_keyboard_ptr);
if (BTN_LEFT == button_event_ptr->button &&
WLMTK_BUTTON_DOWN == button_event_ptr->type &&
(WLR_MODIFIER_ALT | WLR_MODIFIER_LOGO) == modifiers) {
wlmtk_window_request_move(window_ptr);
return true;
}
}
// We shouldn't receive buttons when not mapped.
wlmtk_workspace_t *workspace_ptr = wlmtk_window_get_workspace(window_ptr);
wlmtk_workspace_activate_window(workspace_ptr, window_ptr);
if (!window_ptr->fullscreen) {
wlmtk_workspace_raise_window(workspace_ptr, window_ptr);
}
return window_ptr->orig_super_element_vmt.pointer_button(
element_ptr, button_event_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Implementation of @ref wlmtk_container_vmt_t::update_layout.
*
* Invoked when the window's contained elements triggered a layout update,
* and will use this to trigger (potential) size updates to the window
* decorations.
*
* @param container_ptr
*/
void _wlmtk_window_container_update_layout(wlmtk_container_t *container_ptr)
{
wlmtk_window_t *window_ptr = BS_CONTAINER_OF(
container_ptr, wlmtk_window_t, super_bordered.super_container);
window_ptr->orig_super_container_vmt.update_layout(container_ptr);
if (NULL != window_ptr->content_ptr) {
int width;
wlmtk_content_get_size(window_ptr->content_ptr, &width, NULL);
if (NULL != window_ptr->titlebar_ptr) {
wlmtk_titlebar_set_width(window_ptr->titlebar_ptr, width);
}
if (NULL != window_ptr->resizebar_ptr) {
wlmtk_resizebar_set_width(window_ptr->resizebar_ptr, width);
}
}
}
/* ------------------------------------------------------------------------- */
/** Default implementation of @ref wlmtk_window_request_minimize. */
void _wlmtk_window_request_minimize(wlmtk_window_t *window_ptr)
{
bs_log(BS_INFO, "Requesting window %p to minimize.", window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Default implementation of @ref wlmtk_window_request_move. */
void _wlmtk_window_request_move(wlmtk_window_t *window_ptr)
{
BS_ASSERT(NULL != wlmtk_window_get_workspace(window_ptr));
wlmtk_workspace_begin_window_move(
wlmtk_window_get_workspace(window_ptr), window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Default implementation of @ref wlmtk_window_request_resize. */
void _wlmtk_window_request_resize(wlmtk_window_t *window_ptr, uint32_t edges)
{
BS_ASSERT(NULL != wlmtk_window_get_workspace(window_ptr));
wlmtk_workspace_begin_window_resize(
wlmtk_window_get_workspace(window_ptr), window_ptr, edges);
}
/* ------------------------------------------------------------------------- */
/** Creates the titlebar. Expects server_side_decorated to be set. */
void _wlmtk_window_create_titlebar(wlmtk_window_t *window_ptr)
{
BS_ASSERT(window_ptr->server_side_decorated && !window_ptr->fullscreen);
// Guard clause: Don't add decoration.
if (NULL != window_ptr->titlebar_ptr) return;
// Create decoration.
window_ptr->titlebar_ptr = wlmtk_titlebar_create(
window_ptr->super_bordered.super_container.super_element.env_ptr,
window_ptr, &window_ptr->style.titlebar);
BS_ASSERT(NULL != window_ptr->titlebar_ptr);
wlmtk_titlebar_set_activated(
window_ptr->titlebar_ptr, window_ptr->activated);
wlmtk_element_set_visible(
wlmtk_titlebar_element(window_ptr->titlebar_ptr), true);
// Hm, if the content has a popup that extends over the titlebar area,
// it'll be partially obscured. That will look odd... Well, let's
// address that problem once there's a situation.
wlmtk_box_add_element_front(
&window_ptr->box,
wlmtk_titlebar_element(window_ptr->titlebar_ptr));
}
/* ------------------------------------------------------------------------- */
/** Creates the resizebar. Expects server_side_decorated to be set. */
void _wlmtk_window_create_resizebar(wlmtk_window_t *window_ptr)
{
BS_ASSERT(window_ptr->server_side_decorated && !window_ptr->fullscreen);
// Guard clause: Don't add decoration.
if (NULL != window_ptr->resizebar_ptr) return;
window_ptr->resizebar_ptr = wlmtk_resizebar_create(
window_ptr->super_bordered.super_container.super_element.env_ptr,
window_ptr, &window_ptr->style.resizebar);
BS_ASSERT(NULL != window_ptr->resizebar_ptr);
wlmtk_element_set_visible(
wlmtk_resizebar_element(window_ptr->resizebar_ptr), true);
wlmtk_box_add_element_back(
&window_ptr->box,
wlmtk_resizebar_element(window_ptr->resizebar_ptr));
}
/* ------------------------------------------------------------------------- */
/** Destroys the titlebar. */
void _wlmtk_window_destroy_titlebar(wlmtk_window_t *window_ptr)
{
BS_ASSERT(!window_ptr->server_side_decorated || window_ptr->fullscreen);
if (NULL == window_ptr->titlebar_ptr) return;
wlmtk_box_remove_element(
&window_ptr->box,
wlmtk_titlebar_element(window_ptr->titlebar_ptr));
wlmtk_titlebar_destroy(window_ptr->titlebar_ptr);
window_ptr->titlebar_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
/** Destroys the resizebar. */
void _wlmtk_window_destroy_resizebar(wlmtk_window_t *window_ptr)
{
BS_ASSERT(!window_ptr->server_side_decorated || window_ptr->fullscreen);
if (NULL == window_ptr->resizebar_ptr) return;
wlmtk_box_remove_element(
&window_ptr->box,
wlmtk_resizebar_element(window_ptr->resizebar_ptr));
wlmtk_resizebar_destroy(window_ptr->resizebar_ptr);
window_ptr->resizebar_ptr = NULL;
}
/* ------------------------------------------------------------------------- */
/** Applies window decoration depending on current state. */
void _wlmtk_window_apply_decoration(wlmtk_window_t *window_ptr)
{
wlmtk_margin_style_t bstyle = window_ptr->style.border;
if (window_ptr->server_side_decorated && !window_ptr->fullscreen) {
_wlmtk_window_create_titlebar(window_ptr);
_wlmtk_window_create_resizebar(window_ptr);
} else {
bstyle.width = 0;
_wlmtk_window_destroy_titlebar(window_ptr);
_wlmtk_window_destroy_resizebar(window_ptr);
}
wlmtk_bordered_set_style(&window_ptr->super_bordered, &bstyle);
}
/* ------------------------------------------------------------------------- */
/**
* Helper: Requests position and size, factoring in decoration.
*
* @param window_ptr
* @param x
* @param y
* @param width
* @param height
* @param include_titlebar
* @param include_resizebar
* @param include_extra
*/
void _wlmtk_window_request_position_and_size_decorated(
wlmtk_window_t *window_ptr,
int x,
int y,
int width,
int height,
bool include_titlebar,
bool include_resizebar,
bool include_extra)
{
// Correct for borders, margin and decoration.
if (include_titlebar) {
height -= window_ptr->style.titlebar.height +
window_ptr->style.margin.width;
}
if (include_resizebar) {
height -= window_ptr->style.resizebar.height +
window_ptr->style.margin.width;
}
if (include_titlebar || include_resizebar) {
height -= 2 * window_ptr->style.border.width;
width -= 2 * window_ptr->style.border.width;
}
height = BS_MAX(0, height);
width = BS_MAX(0, width);
// Account for potential extra size beyond the content: For example, by
// sub-surfaces that clients use for borders or resize-areas.
if (include_extra) {
struct wlr_box dimensions = wlmtk_element_get_dimensions_box(
wlmtk_content_element(window_ptr->content_ptr));
int w, h;
wlmtk_content_get_size(window_ptr->content_ptr, &w, &h);
width += w - dimensions.width;
height += h - dimensions.height;
}
uint32_t serial = wlmtk_content_request_size(
window_ptr->content_ptr, width, height);
wlmtk_pending_update_t *pending_update_ptr =
_wlmtk_window_prepare_update(window_ptr);
pending_update_ptr->serial = serial;
pending_update_ptr->x = x;
pending_update_ptr->y = y;
pending_update_ptr->width = width;
pending_update_ptr->height = height;
// TODO(kaeser@gubbe.ch): Handle synchronous case: @ref wlmtk_window_serial
// may have been called early, so we should check if serial had just been
// called before (or is below the last @wlmt_window_serial). In that case,
// the pending state should be applied right away.
}
/* ------------------------------------------------------------------------- */
/**
* Prepares a positional update: Allocates an item and attach it to the end
* of the list of pending updates.
*
* @param window_ptr
*
* @return A pointer to a @ref wlmtk_pending_update_t, already positioned at the
* back of @ref wlmtk_window_t::pending_updates.
*/
wlmtk_pending_update_t *_wlmtk_window_prepare_update(
wlmtk_window_t *window_ptr)
{
bs_dllist_node_t *dlnode_ptr = bs_dllist_pop_front(
&window_ptr->available_updates);
if (NULL == dlnode_ptr) {
dlnode_ptr = bs_dllist_pop_front(&window_ptr->pending_updates);
bs_log(BS_WARNING, "Window %p: No updates available.", window_ptr);
// TODO(kaeser@gubbe.ch): Hm, should we apply this (old) update?
}
wlmtk_pending_update_t *update_ptr = BS_CONTAINER_OF(
dlnode_ptr, wlmtk_pending_update_t, dlnode);
bs_dllist_push_back(&window_ptr->pending_updates, &update_ptr->dlnode);
return update_ptr;
}
/* ------------------------------------------------------------------------- */
/**
* Releases a pending positional update. Moves it to the list of
* @ref wlmtk_window_t::available_updates.
*
* @param window_ptr
* @param update_ptr
*/
void _wlmtk_window_release_update(
wlmtk_window_t *window_ptr,
wlmtk_pending_update_t *update_ptr)
{
bs_dllist_remove(&window_ptr->pending_updates, &update_ptr->dlnode);
bs_dllist_push_front(&window_ptr->available_updates, &update_ptr->dlnode);
}
/* == Implementation of the fake window ==================================== */
static void _wlmtk_fake_window_request_minimize(wlmtk_window_t *window_ptr);
static void _wlmtk_fake_window_request_move(wlmtk_window_t *window_ptr);
static void _wlmtk_fake_window_request_resize(
wlmtk_window_t *window_ptr,
uint32_t edges);
/** Virtual method table for the fake window itself. */
static const wlmtk_window_vmt_t _wlmtk_fake_window_vmt = {
.request_minimize = _wlmtk_fake_window_request_minimize,
.request_move = _wlmtk_fake_window_request_move,
.request_resize = _wlmtk_fake_window_request_resize,
};
/* ------------------------------------------------------------------------- */
wlmtk_fake_window_t *wlmtk_fake_window_create(void)
{
wlmtk_fake_window_state_t *fake_window_state_ptr = logged_calloc(
1, sizeof(wlmtk_fake_window_state_t));
if (NULL == fake_window_state_ptr) return NULL;
fake_window_state_ptr->fake_window.fake_surface_ptr =
wlmtk_fake_surface_create();
if (NULL == fake_window_state_ptr->fake_window.fake_surface_ptr) {
wlmtk_fake_window_destroy(&fake_window_state_ptr->fake_window);
return NULL;
}
fake_window_state_ptr->fake_window.fake_content_ptr = wlmtk_fake_content_create(
fake_window_state_ptr->fake_window.fake_surface_ptr);
if (NULL == fake_window_state_ptr->fake_window.fake_content_ptr) {
wlmtk_fake_window_destroy(&fake_window_state_ptr->fake_window);
return NULL;
}
fake_window_state_ptr->window.style.border.width = 1;
if (!_wlmtk_window_init(
&fake_window_state_ptr->window,
NULL,
wlmtk_content_element(
&fake_window_state_ptr->fake_window.fake_content_ptr->content)
)) {
wlmtk_fake_window_destroy(&fake_window_state_ptr->fake_window);
return NULL;
}
fake_window_state_ptr->fake_window.window_ptr =
&fake_window_state_ptr->window;
fake_window_state_ptr->fake_window.window_ptr->content_ptr =
&fake_window_state_ptr->fake_window.fake_content_ptr->content;
wlmtk_content_set_window(
&fake_window_state_ptr->fake_window.fake_content_ptr->content,
fake_window_state_ptr->fake_window.window_ptr);
// Extend. We don't save the VMT, since it's for fake only.
_wlmtk_window_extend(&fake_window_state_ptr->window,
&_wlmtk_fake_window_vmt);
return &fake_window_state_ptr->fake_window;
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_window_destroy(wlmtk_fake_window_t *fake_window_ptr)
{
wlmtk_fake_window_state_t *fake_window_state_ptr = BS_CONTAINER_OF(
fake_window_ptr, wlmtk_fake_window_state_t, fake_window);
_wlmtk_window_fini(&fake_window_state_ptr->window);
if (NULL != fake_window_state_ptr->fake_window.fake_content_ptr) {
wlmtk_fake_content_destroy(
fake_window_state_ptr->fake_window.fake_content_ptr);
fake_window_state_ptr->fake_window.fake_content_ptr = NULL;
}
if (NULL != fake_window_state_ptr->fake_window.fake_surface_ptr) {
wlmtk_fake_surface_destroy(
fake_window_state_ptr->fake_window.fake_surface_ptr);
fake_window_state_ptr->fake_window.fake_surface_ptr = NULL;
}
free(fake_window_state_ptr);
}
/* ------------------------------------------------------------------------- */
/** Calls commit_size with the fake surface's serial and dimensions. */
void wlmtk_fake_window_commit_size(wlmtk_fake_window_t *fake_window_ptr)
{
wlmtk_fake_content_commit(fake_window_ptr->fake_content_ptr);
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of @ref wlmtk_window_request_minimize. Records call. */
void _wlmtk_fake_window_request_minimize(wlmtk_window_t *window_ptr)
{
wlmtk_fake_window_state_t *fake_window_state_ptr = BS_CONTAINER_OF(
window_ptr, wlmtk_fake_window_state_t, window);
fake_window_state_ptr->fake_window.request_minimize_called = true;
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of @ref wlmtk_window_request_move. Records call */
void _wlmtk_fake_window_request_move(wlmtk_window_t *window_ptr)
{
wlmtk_fake_window_state_t *fake_window_state_ptr = BS_CONTAINER_OF(
window_ptr, wlmtk_fake_window_state_t, window);
fake_window_state_ptr->fake_window.request_move_called = true;
}
/* ------------------------------------------------------------------------- */
/** Fake implementation of @ref wlmtk_window_request_resize. Records call. */
void _wlmtk_fake_window_request_resize(
wlmtk_window_t *window_ptr,
uint32_t edges)
{
wlmtk_fake_window_state_t *fake_window_state_ptr = BS_CONTAINER_OF(
window_ptr, wlmtk_fake_window_state_t, window);
fake_window_state_ptr->fake_window.request_resize_called = true;
fake_window_state_ptr->fake_window.request_resize_edges = edges;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_set_title(bs_test_t *test_ptr);
static void test_request_close(bs_test_t *test_ptr);
static void test_set_activated(bs_test_t *test_ptr);
static void test_server_side_decorated(bs_test_t *test_ptr);
static void test_maximize(bs_test_t *test_ptr);
static void test_fullscreen(bs_test_t *test_ptr);
static void test_fullscreen_unmap(bs_test_t *test_ptr);
static void test_fake(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_window_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "set_title", test_set_title },
{ 1, "request_close", test_request_close },
{ 1, "set_activated", test_set_activated },
{ 1, "set_server_side_decorated", test_server_side_decorated },
{ 1, "maximize", test_maximize },
{ 1, "fullscreen", test_fullscreen },
{ 1, "fullscreen_unmap", test_fullscreen_unmap },
{ 1, "fake", test_fake },
{ 0, NULL, NULL }
};
/* ------------------------------------------------------------------------- */
/** Tests setup and teardown. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_fake_surface_t *fake_surface_ptr = wlmtk_fake_surface_create();
wlmtk_window_style_t style = {};
wlmtk_content_t content;
wlmtk_content_init(&content, &fake_surface_ptr->surface, NULL);
wlmtk_window_t *window_ptr = wlmtk_window_create(&content, &style, NULL);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, window_ptr, content.window_ptr);
bs_dllist_node_t *dln_ptr = wlmtk_dlnode_from_window(window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, dln_ptr, &window_ptr->dlnode);
BS_TEST_VERIFY_EQ(test_ptr, window_ptr, wlmtk_window_from_dlnode(dln_ptr));
wlmtk_window_destroy(window_ptr);
wlmtk_content_fini(&content);
wlmtk_fake_surface_destroy(fake_surface_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests title. */
void test_set_title(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_window_set_title(fw_ptr->window_ptr, "Title");
BS_TEST_VERIFY_STREQ(
test_ptr,
"Title",
wlmtk_window_get_title(fw_ptr->window_ptr));
wlmtk_window_set_title(fw_ptr->window_ptr, NULL);
BS_TEST_VERIFY_STRMATCH(
test_ptr,
wlmtk_window_get_title(fw_ptr->window_ptr),
"Unnamed window .*");
wlmtk_fake_window_destroy(fw_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests activation. */
void test_request_close(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_window_request_close(fw_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
fw_ptr->fake_content_ptr->request_close_called);
wlmtk_fake_window_destroy(fw_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests activation. */
void test_set_activated(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_window_set_activated(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
wlmtk_window_set_activated(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_FALSE(test_ptr, fw_ptr->fake_content_ptr->activated);
wlmtk_fake_window_destroy(fw_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests enabling and disabling server-side decoration. */
void test_server_side_decorated(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
wlmtk_window_set_server_side_decorated(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
// Maximize the window: We keep the decoration.
wlmtk_window_request_maximized(fw_ptr->window_ptr, true);
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_maximized(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
// Make the window fullscreen: Hide the decoration.
wlmtk_window_request_fullscreen(fw_ptr->window_ptr, true);
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_maximized(fw_ptr->window_ptr, false);
wlmtk_window_commit_fullscreen(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
// Back to organic size: Decoration is on.
wlmtk_window_request_fullscreen(fw_ptr->window_ptr, false);
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_fullscreen(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
// Disable decoration.
wlmtk_window_set_server_side_decorated(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests maximizing and un-maximizing a window. */
void test_maximize(bs_test_t *test_ptr)
{
struct wlr_box box;
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
// Window must be mapped to get maximized: Need workspace dimensions.
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
// Set up initial organic size, and verify.
wlmtk_window_request_position_and_size(fw_ptr->window_ptr, 20, 10, 200, 100);
wlmtk_fake_window_commit_size(fw_ptr);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 20, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_maximized(fw_ptr->window_ptr));
// Re-position the window.
wlmtk_window_set_position(fw_ptr->window_ptr, 50, 30);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 50, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 30, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
// Trigger another serial update. Should not change position nor size.
wlmtk_window_serial(fw_ptr->window_ptr, 1234);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 50, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 30, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
// Maximize.
wlmtk_window_request_maximized(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_maximized(fw_ptr->window_ptr));
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_maximized(fw_ptr->window_ptr, true);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 960, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 704, box.height);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_is_maximized(fw_ptr->window_ptr));
// A second commit: should not overwrite the organic dimension.
wlmtk_fake_window_commit_size(fw_ptr);
// Unmaximize. Restore earlier organic size and position.
wlmtk_window_request_maximized(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_is_maximized(fw_ptr->window_ptr));
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_maximized(fw_ptr->window_ptr, false);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 50, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 30, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_maximized(fw_ptr->window_ptr));
// TODO(kaeser@gubbe.ch): Define what should happen when a maximized
// window is moved. Should it lose maximization? Should it not move?
// Or just move on?
// Window Maker keeps maximization, but it's ... odd.
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests turning a window to fullscreen and back. */
void test_fullscreen(bs_test_t *test_ptr)
{
struct wlr_box box;
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_window_set_server_side_decorated(fw_ptr->window_ptr, true);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
BS_TEST_VERIFY_EQ(
test_ptr,
fw_ptr->window_ptr,
wlmtk_workspace_get_activated_window(fws_ptr->workspace_ptr));
// Set up initial organic size, and verify.
wlmtk_window_request_position_and_size(fw_ptr->window_ptr, 20, 10, 200, 100);
wlmtk_fake_window_commit_size(fw_ptr);
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 20, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
BS_TEST_VERIFY_FALSE(test_ptr, fw_ptr->window_ptr->inorganic_sizing);
// Request fullscreen. Does not take immediate effect.
wlmtk_window_request_fullscreen(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_titlebar_is_activated(fw_ptr->window_ptr->titlebar_ptr));
// Only after "commit", it will take effect.
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_fullscreen(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 1024, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 768, box.height);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
BS_TEST_VERIFY_EQ(
test_ptr,
fw_ptr->window_ptr,
wlmtk_workspace_get_activated_window(fws_ptr->workspace_ptr));
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
// Request to end fullscreen. Not taking immediate effect.
wlmtk_window_request_fullscreen(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
// Takes effect after commit. We'll want the same position as before.
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_fullscreen(fw_ptr->window_ptr, false);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 20, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 10, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.height);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_titlebar_is_activated(fw_ptr->window_ptr->titlebar_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
fw_ptr->window_ptr,
wlmtk_workspace_get_activated_window(fws_ptr->workspace_ptr));
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->window_ptr->server_side_decorated);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->titlebar_ptr);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fw_ptr->window_ptr->resizebar_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests that unmapping a fullscreen window works. */
void test_fullscreen_unmap(bs_test_t *test_ptr)
{
struct wlr_box box;
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
BS_TEST_VERIFY_EQ(
test_ptr,
fw_ptr->window_ptr,
wlmtk_workspace_get_activated_window(fws_ptr->workspace_ptr));
// Request fullscreen. Does not take immediate effect.
wlmtk_window_request_fullscreen(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
// Only after "commit", it will take effect.
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_commit_fullscreen(fw_ptr->window_ptr, true);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_is_fullscreen(fw_ptr->window_ptr));
box = wlmtk_window_get_position_and_size(fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.x);
BS_TEST_VERIFY_EQ(test_ptr, 0, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 1024, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 768, box.height);
BS_TEST_VERIFY_TRUE(test_ptr, fw_ptr->fake_content_ptr->activated);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_FALSE(test_ptr, fw_ptr->fake_content_ptr->activated);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_workspace_get_activated_window(fws_ptr->workspace_ptr));
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests fake window ctor and dtor. */
void test_fake(bs_test_t *test_ptr)
{
wlmtk_fake_window_t *fake_window_ptr = wlmtk_fake_window_create();
BS_TEST_VERIFY_NEQ(test_ptr, NULL, fake_window_ptr);
wlmtk_fake_window_destroy(fake_window_ptr);
}
/* == End of window.c ====================================================== */
wlmaker-0.3/src/toolkit/window.h 0000664 0000000 0000000 00000030075 14641446446 0016774 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file window.h
*
* @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.
*/
#ifndef __WLMTK_WINDOW_H__
#define __WLMTK_WINDOW_H__
/** Forward declaration: Window. */
typedef struct _wlmtk_window_t wlmtk_window_t;
/** Forward declaration: Virtual method table. */
typedef struct _wlmtk_window_vmt_t wlmtk_window_vmt_t;
#include "bordered.h"
#include "box.h"
#include "content.h"
#include "element.h"
#include "resizebar.h"
#include "surface.h"
#include "titlebar.h"
#include "util.h"
#include "workspace.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Style options for the window. */
typedef struct {
/** The titlebar's style. */
wlmtk_titlebar_style_t titlebar;
/** The resizebar's style. */
wlmtk_resizebar_style_t resizebar;
/** Style of the window border. */
wlmtk_margin_style_t border;
/** Style of the margins between titlebar, window and resizebar. */
wlmtk_margin_style_t margin;
} wlmtk_window_style_t;
/**
* Creates a window for the given content.
*
* @param env_ptr
* @param style_ptr
* @param content_ptr
*
* @return Pointer to the window state, or NULL on error. Must be free'd
* by calling @ref wlmtk_window_destroy.
*/
wlmtk_window_t *wlmtk_window_create(
wlmtk_content_t *content_ptr,
const wlmtk_window_style_t *style_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the window.
*
* @param window_ptr
*/
void wlmtk_window_destroy(wlmtk_window_t *window_ptr);
/**
* Returns the super Element of the window.
*
* TODO(kaeser@gubbe.ch): Re-evaluate whether to work with accessors, or
* whether to keep the ancestry members public.
*
* @param window_ptr
*
* @return Pointer to the @ref wlmtk_element_t base instantiation to
* window_ptr.
*/
wlmtk_element_t *wlmtk_window_element(wlmtk_window_t *window_ptr);
/**
* Returns the window from the super Element.
*
* @param element_ptr
*
* @return Pointer to the @ref wlmtk_window_t, for which `element_ptr` is
* the ancestor.
*/
wlmtk_window_t *wlmtk_window_from_element(wlmtk_element_t *element_ptr);
/** Returns @ref wlmtk_window_t for the `dlnode_ptr`. */
wlmtk_window_t *wlmtk_window_from_dlnode(bs_dllist_node_t *dlnode_ptr);
/** Accessor: Returns pointer to @ref wlmtk_window_t::dlnode. */
bs_dllist_node_t *wlmtk_dlnode_from_window(wlmtk_window_t *window_ptr);
/**
* Sets the window as activated, depending on the argument's value.
*
* An activated window will have keyboard focus and would have distinct
* decorations to indicate state.
*
* @param window_ptr
* @param activated
*/
void wlmtk_window_set_activated(
wlmtk_window_t *window_ptr,
bool activated);
/**
* Returns whether the window is activated (has keyboard focus).
*
* @param window_ptr
*
* @return activation status.
*/
bool wlmtk_window_is_activated(wlmtk_window_t *window_ptr);
/**
* Sets whether to have server-side decorations for this window.
*
* @param window_ptr
* @param decorated
*/
void wlmtk_window_set_server_side_decorated(
wlmtk_window_t *window_ptr,
bool decorated);
/**
* Sets the title for the window.
*
* If `title_ptr` is NULL, a generic name is set.
*
* @param window_ptr
* @param title_ptr May be NULL.
*/
void wlmtk_window_set_title(
wlmtk_window_t *window_ptr,
const char *title_ptr);
/**
* Returns the title of the window.
*
* @param window_ptr
*
* @returns Pointer to the window title. Will remain valid until the next call
* to @ref wlmtk_window_set_title, or until the window is destroyed. Will
* never be NULL.
*/
const char *wlmtk_window_get_title(wlmtk_window_t *window_ptr);
/**
* Requests to close the window.
*
* @param window_ptr
*/
void wlmtk_window_request_close(wlmtk_window_t *window_ptr);
/**
* Requests to minimize (iconify) the window.
*
* @param window_ptr
*/
void wlmtk_window_request_minimize(wlmtk_window_t *window_ptr);
/**
* Requests a move for the window.
*
* Requires the window to be mapped (to a workspace), and forwards the call to
* @ref wlmtk_workspace_begin_window_move.
*
* @param window_ptr
*/
void wlmtk_window_request_move(wlmtk_window_t *window_ptr);
/**
* Requests the window to be resized.
*
* Requires the window to be mapped (to a workspace), and forwards the call to
* @ref wlmtk_workspace_begin_window_resize.
*
* @param window_ptr
* @param edges
*/
void wlmtk_window_request_resize(wlmtk_window_t *window_ptr,
uint32_t edges);
/**
* Sets the window's position. This is a synchronous operation.
*
* Updates the position in @ref wlmtk_window_t::organic_size.
* @param window_ptr
* @param x
* @param y
*/
void wlmtk_window_set_position(wlmtk_window_t *window_ptr, int x, int y);
/**
* Obtains the size of the window, including potential decorations.
*
* @param window_ptr
* @param width_ptr May be NULL.
* @param height_ptr May be NULL.
*/
void wlmtk_window_get_size(
wlmtk_window_t *window_ptr,
int *width_ptr,
int *height_ptr);
/**
* Reuests the window to be maximized.
*
* Requires the window to be mapped (to a workspace). Will lookup the maximize
* extents from the workspace, and request a corresponding updated position and
* size for the window. @ref wlmtk_window_t::organic_size will not be updated.
*
* This may be implemented as an asynchronous operation. Maximization will be
* applied once the size change has been committed by the surface.
*
* @param window_ptr
* @param maximized
*/
void wlmtk_window_request_maximized(
wlmtk_window_t *window_ptr,
bool maximized);
/**
* Commits the `maximized` mode for the window.
*
* This is the "commit" part of the potentially asynchronous operation. To be
* called by @ref wlmtk_content_t, after @ref wlmtk_content_request_maximized
* has completed by the client.
*
* The call is idempotent: Once the window is committed, further calls with
* the same `maximized` value will return straight away.
*
* @param window_ptr
* @param maximized
*/
void wlmtk_window_commit_maximized(
wlmtk_window_t *window_ptr,
bool maximized);
/** Returns whether the window is currently (requested to be) maximized. */
bool wlmtk_window_is_maximized(wlmtk_window_t *window_ptr);
/**
* Requests the window to be made fullscreen (or stops so).
*
* Requires the window to be mapped (to a workspace). This may be implemented
* as an asynchronous operation. Once the window content is ready, it should
* call @ref wlmtk_window_commit_fullscreen to complete the operation.
*
* @param window_ptr
* @param fullscreen Whether to enable fullscreen mode.
*/
void wlmtk_window_request_fullscreen(
wlmtk_window_t *window_ptr,
bool fullscreen);
/**
* Commits the fullscreen mode for the window.
*
* This is the "commit" part of the potentially asynchronous operation. To be
* called by @ref wlmtk_content_t, after @ref wlmtk_content_request_fullscreen
* has completed by the client.
*
* The call is idempotent: Once the window is committed, further calls with
* the same `fullscreen` value will return straight away.
*
* @param window_ptr
* @param fullscreen
*/
void wlmtk_window_commit_fullscreen(
wlmtk_window_t *window_ptr,
bool fullscreen);
/**
* Returns whether the window is currently in fullscreen mode.
*
* Will return the state after @ref wlmtk_window_commit_fullscreen has
* completed.
*
* @param window_ptr
*
* @return Whether it's in fullscreen mode or not.
*/
bool wlmtk_window_is_fullscreen(wlmtk_window_t *window_ptr);
/**
* Requests the window to be "shaded", ie. rolled-up to just the title bar.
*
* This is supported only for server-side decorated windows.
* @param window_ptr
* @param shaded
*/
void wlmtk_window_request_shaded(wlmtk_window_t *window_ptr, bool shaded);
/**
* Returns whether the window is currently "shaded".
*
* @param window_ptr
*
* @return true if shaded.
*/
bool wlmtk_window_is_shaded(wlmtk_window_t *window_ptr);
/**
* Returns the current position and size of the window.
*
* @param window_ptr
*
* @return The position of the window (the window's element), and the currently
* committed width and height of the window.
*/
struct wlr_box wlmtk_window_get_position_and_size(
wlmtk_window_t *window_ptr);
/**
* Requests an updated position and size for the window, including potential
* decorations.
*
* This may be implemented as an asynchronous operation. The re-positioning
* will be applied only once the size change has been committed by the client.
*
* The position and size will be stored in @ref wlmtk_window_t::organic_size.
*
* @param window_ptr
* @param x
* @param y
* @param width
* @param height
*/
void wlmtk_window_request_position_and_size(
wlmtk_window_t *window_ptr,
int x,
int y,
int width,
int height);
/**
* Updates the window state to what was requested at the `serial`.
*
* Used for example when resizing a window from the top or left edges. In that
* case, @ref wlmtk_content_request_size may be asynchronous and returns a
* serial. The surface is expected to call @ref wlmtk_window_serial with the
* returned serial when the size is committed.
* Only then, the corresponding positional update on the top/left edges are
* supposed to be applied.
*
* @ref wlmtk_window_t::organic_size will be updated, if there was no pending
* update: Meaning that the commit originated not from an earlier
* @ref wlmtk_window_request_position_and_size or @ref
* wlmtk_window_request_maximized call.
*
* @param window_ptr
* @param serial
*/
void wlmtk_window_serial(wlmtk_window_t *window_ptr, uint32_t serial);
/**
* Sets @ref wlmtk_window_t::workspace_ptr.
*
* Protected method, to be called only from @ref wlmtk_workspace_t.
*
* @param window_ptr
* @param workspace_ptr
*/
void wlmtk_window_set_workspace(
wlmtk_window_t *window_ptr,
wlmtk_workspace_t *workspace_ptr);
/** @return The value of @ref wlmtk_window_t::workspace_ptr. */
wlmtk_workspace_t *wlmtk_window_get_workspace(wlmtk_window_t *window_ptr);
/** @return Pointer to @ref wlmtk_content_t::client for `content_ptr`. */
const wlmtk_util_client_t *wlmtk_window_get_client_ptr(
wlmtk_window_t *window_ptr);
/* ------------------------------------------------------------------------- */
/** State of the fake window, for tests. */
typedef struct {
/** Window state. */
wlmtk_window_t *window_ptr;
/** Fake surface, to manipulate the fake window's surface. */
wlmtk_fake_surface_t *fake_surface_ptr;
/** Fake content, wraps the fake surface. */
wlmtk_fake_content_t *fake_content_ptr;
/** Whether @ref wlmtk_window_request_minimize was called. */
bool request_minimize_called;
/** Whether @ref wlmtk_window_request_move was called. */
bool request_move_called;
/** Whether @ref wlmtk_window_request_resize was called. */
bool request_resize_called;
/** Argument to last @ref wlmtk_window_request_resize call. */
uint32_t request_resize_edges;
} wlmtk_fake_window_t;
/** Ctor. */
wlmtk_fake_window_t *wlmtk_fake_window_create(void);
/** Dtor. */
void wlmtk_fake_window_destroy(wlmtk_fake_window_t *fake_window_ptr);
/** Calls commit_size with the fake surface's serial and dimensions. */
void wlmtk_fake_window_commit_size(wlmtk_fake_window_t *fake_window_ptr);
/** Unit tests for window. */
extern const bs_test_case_t wlmtk_window_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_WINDOW_H__ */
/* == End of window.h ====================================================== */
wlmaker-0.3/src/toolkit/workspace.c 0000664 0000000 0000000 00000155112 14641446446 0017456 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file workspace.c
*
* @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.
*/
#include "workspace.h"
#include "fsm.h"
#include "layer.h"
#define WLR_USE_UNSTABLE
#include
#include
#include
#undef WLR_USE_UNSTABLE
/* == Declarations ========================================================= */
/** State of the workspace. */
struct _wlmtk_workspace_t {
/** Superclass: Container. */
wlmtk_container_t super_container;
/** Original virtual method table. We're overwriting parts. */
wlmtk_element_vmt_t orig_super_element_vmt;
/** Link to the @ref wlmtk_root_t this workspace is attached to. */
wlmtk_root_t *root_ptr;
/** An element of @ref wlmtk_root_t::workspaces. */
bs_dllist_node_t dlnode;
/** Name of the workspace. */
char *name_ptr;
/** Index of this workspace. */
int index;
/** Current FSM state. */
wlmtk_fsm_t fsm;
/** Container that holds the windows, ie. the window layer. */
wlmtk_container_t window_container;
/** Container that holds the fullscreen elements. Should have only one. */
wlmtk_container_t fullscreen_container;
/** List of toplevel windows. Via @ref wlmtk_window_t::dlnode. */
bs_dllist_t windows;
/** The activated window. */
wlmtk_window_t *activated_window_ptr;
/** The grabbed window. */
wlmtk_window_t *grabbed_window_ptr;
/** Motion X */
int motion_x;
/** Motion Y */
int motion_y;
/** Element's X position when initiating a move or resize. */
int initial_x;
/** Element's Y position when initiating a move or resize. */
int initial_y;
/** Window's width when initiazing the resize. */
int initial_width;
/** Window's height when initiazing the resize. */
int initial_height;
/** Edges currently active for resizing: `enum wlr_edges`. */
uint32_t resize_edges;
/** Top left X coordinate of workspace. */
int x1;
/** Top left Y coordinate of workspace. */
int y1;
/** Bottom right X coordinate of workspace. */
int x2;
/** Bottom right Y coordinate of workspace. */
int y2;
/** Background layer. */
wlmtk_layer_t *background_layer_ptr;
/** Bottom layer. */
wlmtk_layer_t *bottom_layer_ptr;
/** Top layer. */
wlmtk_layer_t *top_layer_ptr;
/** Overlay layer. */
wlmtk_layer_t *overlay_layer_ptr;
};
static void _wlmtk_workspace_element_destroy(wlmtk_element_t *element_ptr);
static void _wlmtk_workspace_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr);
static void _wlmtk_workspace_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr);
static bool _wlmtk_workspace_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec);
static bool _wlmtk_workspace_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr);
static void _wlmtk_workspace_element_pointer_leave(
wlmtk_element_t *element_ptr);
static bool pfsm_move_begin(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
static bool pfsm_move_motion(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
static bool pfsm_resize_begin(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
static bool pfsm_resize_motion(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
static bool pfsm_reset(wlmtk_fsm_t *fsm_ptr, void *ud_ptr);
/* == Data ================================================================= */
/** States of the pointer FSM. */
typedef enum {
PFSMS_PASSTHROUGH,
PFSMS_MOVE,
PFSMS_RESIZE
} pointer_state_t;
/** Events for the pointer FSM. */
typedef enum {
PFSME_BEGIN_MOVE,
PFSME_BEGIN_RESIZE,
PFSME_RELEASED,
PFSME_MOTION,
PFSME_RESET,
} pointer_state_event_t;
/** Extensions to the workspace's super element's virtual methods. */
const wlmtk_element_vmt_t workspace_element_vmt = {
.destroy = _wlmtk_workspace_element_destroy,
.get_dimensions = _wlmtk_workspace_element_get_dimensions,
.get_pointer_area = _wlmtk_workspace_element_get_pointer_area,
.pointer_motion = _wlmtk_workspace_element_pointer_motion,
.pointer_button = _wlmtk_workspace_element_pointer_button,
.pointer_leave = _wlmtk_workspace_element_pointer_leave,
};
/** Finite state machine definition for pointer events. */
static const wlmtk_fsm_transition_t pfsm_transitions[] = {
{ PFSMS_PASSTHROUGH, PFSME_BEGIN_MOVE, PFSMS_MOVE, pfsm_move_begin },
{ PFSMS_MOVE, PFSME_MOTION, PFSMS_MOVE, pfsm_move_motion },
{ PFSMS_MOVE, PFSME_RELEASED, PFSMS_PASSTHROUGH, pfsm_reset },
{ PFSMS_MOVE, PFSME_RESET, PFSMS_PASSTHROUGH, pfsm_reset },
{ PFSMS_PASSTHROUGH, PFSME_BEGIN_RESIZE, PFSMS_RESIZE, pfsm_resize_begin },
{ PFSMS_RESIZE, PFSME_MOTION, PFSMS_RESIZE, pfsm_resize_motion },
{ PFSMS_RESIZE, PFSME_RELEASED, PFSMS_PASSTHROUGH, pfsm_reset },
{ PFSMS_RESIZE, PFSME_RESET, PFSMS_PASSTHROUGH, pfsm_reset },
WLMTK_FSM_TRANSITION_SENTINEL,
};
/* == Exported methods ===================================================== */
/* ------------------------------------------------------------------------- */
wlmtk_workspace_t *wlmtk_workspace_create(
const char *name_ptr,
wlmtk_env_t *env_ptr)
{
wlmtk_workspace_t *workspace_ptr =
logged_calloc(1, sizeof(wlmtk_workspace_t));
if (NULL == workspace_ptr) return NULL;
workspace_ptr->name_ptr = logged_strdup(name_ptr);
if (NULL == workspace_ptr->name_ptr) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
if (!wlmtk_container_init(&workspace_ptr->super_container, env_ptr)) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
workspace_ptr->orig_super_element_vmt = wlmtk_element_extend(
&workspace_ptr->super_container.super_element,
&workspace_element_vmt);
if (!wlmtk_container_init(&workspace_ptr->window_container, env_ptr)) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
&workspace_ptr->window_container.super_element,
true);
wlmtk_container_add_element(
&workspace_ptr->super_container,
&workspace_ptr->window_container.super_element);
if (!wlmtk_container_init(&workspace_ptr->fullscreen_container, env_ptr)) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
&workspace_ptr->fullscreen_container.super_element,
true);
wlmtk_container_add_element(
&workspace_ptr->super_container,
&workspace_ptr->fullscreen_container.super_element);
workspace_ptr->background_layer_ptr = wlmtk_layer_create(env_ptr);
if (NULL == workspace_ptr->background_layer_ptr) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_layer_element(workspace_ptr->background_layer_ptr),
true);
wlmtk_container_add_element_atop(
&workspace_ptr->super_container,
NULL,
wlmtk_layer_element(workspace_ptr->background_layer_ptr));
wlmtk_layer_set_workspace(
workspace_ptr->background_layer_ptr,
workspace_ptr);
workspace_ptr->bottom_layer_ptr = wlmtk_layer_create(env_ptr);
if (NULL == workspace_ptr->bottom_layer_ptr) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_layer_element(workspace_ptr->bottom_layer_ptr),
true);
wlmtk_container_add_element_atop(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->background_layer_ptr),
wlmtk_layer_element(workspace_ptr->bottom_layer_ptr));
wlmtk_layer_set_workspace(workspace_ptr->bottom_layer_ptr, workspace_ptr);
workspace_ptr->top_layer_ptr = wlmtk_layer_create(env_ptr);
if (NULL == workspace_ptr->top_layer_ptr) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_layer_element(workspace_ptr->top_layer_ptr),
true);
wlmtk_container_add_element_atop(
&workspace_ptr->super_container,
&workspace_ptr->window_container.super_element,
wlmtk_layer_element(workspace_ptr->top_layer_ptr));
wlmtk_layer_set_workspace(workspace_ptr->top_layer_ptr, workspace_ptr);
workspace_ptr->overlay_layer_ptr = wlmtk_layer_create(env_ptr);
if (NULL == workspace_ptr->overlay_layer_ptr) {
wlmtk_workspace_destroy(workspace_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_layer_element(workspace_ptr->overlay_layer_ptr),
true);
wlmtk_container_add_element_atop(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->top_layer_ptr),
wlmtk_layer_element(workspace_ptr->overlay_layer_ptr));
wlmtk_layer_set_workspace(workspace_ptr->overlay_layer_ptr, workspace_ptr);
wlmtk_fsm_init(&workspace_ptr->fsm, pfsm_transitions, PFSMS_PASSTHROUGH);
return workspace_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_destroy(wlmtk_workspace_t *workspace_ptr)
{
if (NULL != workspace_ptr->overlay_layer_ptr) {
wlmtk_layer_set_workspace(workspace_ptr->overlay_layer_ptr, NULL);
wlmtk_container_remove_element(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->overlay_layer_ptr));
wlmtk_layer_destroy(workspace_ptr->overlay_layer_ptr);
workspace_ptr->overlay_layer_ptr = NULL;
}
if (NULL != workspace_ptr->top_layer_ptr) {
wlmtk_layer_set_workspace(workspace_ptr->top_layer_ptr, NULL);
wlmtk_container_remove_element(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->top_layer_ptr));
wlmtk_layer_destroy(workspace_ptr->top_layer_ptr);
workspace_ptr->top_layer_ptr = NULL;
}
if (NULL != workspace_ptr->bottom_layer_ptr) {
wlmtk_layer_set_workspace(workspace_ptr->bottom_layer_ptr, NULL);
wlmtk_container_remove_element(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->bottom_layer_ptr));
wlmtk_layer_destroy(workspace_ptr->bottom_layer_ptr);
workspace_ptr->bottom_layer_ptr = NULL;
}
if (NULL != workspace_ptr->background_layer_ptr) {
wlmtk_layer_set_workspace(workspace_ptr->background_layer_ptr, NULL);
wlmtk_container_remove_element(
&workspace_ptr->super_container,
wlmtk_layer_element(workspace_ptr->background_layer_ptr));
wlmtk_layer_destroy(workspace_ptr->background_layer_ptr);
workspace_ptr->background_layer_ptr = NULL;
}
if (NULL != workspace_ptr->fullscreen_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&workspace_ptr->super_container,
&workspace_ptr->fullscreen_container.super_element);
}
wlmtk_container_fini(&workspace_ptr->fullscreen_container);
if (NULL != workspace_ptr->window_container.super_element.parent_container_ptr) {
wlmtk_container_remove_element(
&workspace_ptr->super_container,
&workspace_ptr->window_container.super_element);
}
wlmtk_container_fini(&workspace_ptr->window_container);
wlmtk_container_fini(&workspace_ptr->super_container);
if (NULL != workspace_ptr->name_ptr) {
free(workspace_ptr->name_ptr);
workspace_ptr->name_ptr = NULL;
}
free(workspace_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_set_details(
wlmtk_workspace_t *workspace_ptr,
int index)
{
workspace_ptr->index = index;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_get_details(
wlmtk_workspace_t *workspace_ptr,
const char **name_ptr_ptr,
int *index_ptr)
{
*index_ptr = workspace_ptr->index;
*name_ptr_ptr = workspace_ptr->name_ptr;
}
/* ------------------------------------------------------------------------- */
// TODO(kaeser@gubbe.ch): Add test to verify layers are reconfigured.
void wlmtk_workspace_set_extents(wlmtk_workspace_t *workspace_ptr,
const struct wlr_box *extents_ptr)
{
workspace_ptr->x1 = extents_ptr->x;
workspace_ptr->y1 = extents_ptr->y;
workspace_ptr->x2 = extents_ptr->x + extents_ptr->width;
workspace_ptr->y2 = extents_ptr->y + extents_ptr->height;
if (NULL != workspace_ptr->background_layer_ptr) {
wlmtk_layer_reconfigure(workspace_ptr->background_layer_ptr);
}
if (NULL != workspace_ptr->bottom_layer_ptr) {
wlmtk_layer_reconfigure(workspace_ptr->bottom_layer_ptr);
}
if (NULL != workspace_ptr->top_layer_ptr) {
wlmtk_layer_reconfigure(workspace_ptr->top_layer_ptr);
}
if (NULL != workspace_ptr->overlay_layer_ptr) {
wlmtk_layer_reconfigure(workspace_ptr->overlay_layer_ptr);
}
}
/* ------------------------------------------------------------------------- */
struct wlr_box wlmtk_workspace_get_maximize_extents(
wlmtk_workspace_t *workspace_ptr)
{
// TODO(kaeser@gubbe.ch): Well, actually compute something sensible.
struct wlr_box box = {
.x = workspace_ptr->x1,
.y = workspace_ptr->y1,
.width = workspace_ptr->x2 - workspace_ptr->x1 - 64,
.height = workspace_ptr->y2 - workspace_ptr->y1 - 64 };
return box;
}
/* ------------------------------------------------------------------------- */
struct wlr_box wlmtk_workspace_get_fullscreen_extents(
wlmtk_workspace_t *workspace_ptr)
{
struct wlr_box box = {
.x = workspace_ptr->x1,
.y = workspace_ptr->y1,
.width = workspace_ptr->x2 - workspace_ptr->x1,
.height = workspace_ptr->y2 - workspace_ptr->y1 };
return box;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_map_window(wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr)
{
BS_ASSERT(NULL == wlmtk_window_get_workspace(window_ptr));
wlmtk_element_set_visible(wlmtk_window_element(window_ptr), true);
wlmtk_container_add_element(
&workspace_ptr->window_container,
wlmtk_window_element(window_ptr));
bs_dllist_push_front(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
wlmtk_window_set_workspace(window_ptr, workspace_ptr);
wlmtk_workspace_activate_window(workspace_ptr, window_ptr);
if (NULL != workspace_ptr->root_ptr) {
wl_signal_emit(
&wlmtk_root_events(workspace_ptr->root_ptr)->window_mapped,
window_ptr);
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_unmap_window(wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr)
{
bool need_activation = false;
BS_ASSERT(workspace_ptr == wlmtk_window_get_workspace(window_ptr));
if (workspace_ptr->grabbed_window_ptr == window_ptr) {
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_RESET, NULL);
BS_ASSERT(NULL == workspace_ptr->grabbed_window_ptr);
}
if (workspace_ptr->activated_window_ptr == window_ptr) {
wlmtk_workspace_activate_window(workspace_ptr, NULL);
need_activation = true;
}
wlmtk_element_set_visible(wlmtk_window_element(window_ptr), false);
if (wlmtk_window_is_fullscreen(window_ptr)) {
wlmtk_container_remove_element(
&workspace_ptr->fullscreen_container,
wlmtk_window_element(window_ptr));
} else {
wlmtk_container_remove_element(
&workspace_ptr->window_container,
wlmtk_window_element(window_ptr));
}
bs_dllist_remove(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
wlmtk_window_set_workspace(window_ptr, NULL);
if (NULL != workspace_ptr->root_ptr) {
wl_signal_emit(
&wlmtk_root_events(workspace_ptr->root_ptr)->window_unmapped,
window_ptr);
}
if (need_activation) {
// FIXME: What about raising?
bs_dllist_node_t *dlnode_ptr =
workspace_ptr->window_container.elements.head_ptr;
if (NULL != dlnode_ptr) {
wlmtk_element_t *element_ptr = wlmtk_element_from_dlnode(dlnode_ptr);
wlmtk_window_t *window_ptr = wlmtk_window_from_element(element_ptr);
wlmtk_workspace_activate_window(workspace_ptr, window_ptr);
}
}
}
/* ------------------------------------------------------------------------- */
wlmtk_layer_t *wlmtk_workspace_get_layer(
wlmtk_workspace_t *workspace_ptr,
wlmtk_workspace_layer_t layer)
{
wlmtk_layer_t *layer_ptr = NULL;
switch (layer) {
case WLMTK_WORKSPACE_LAYER_BACKGROUND:
layer_ptr = workspace_ptr->background_layer_ptr;
break;
case WLMTK_WORKSPACE_LAYER_BOTTOM:
layer_ptr = workspace_ptr->bottom_layer_ptr;
break;
case WLMTK_WORKSPACE_LAYER_TOP:
layer_ptr = workspace_ptr->top_layer_ptr;
break;
case WLMTK_WORKSPACE_LAYER_OVERLAY:
layer_ptr = workspace_ptr->overlay_layer_ptr;
break;
default:
break;
}
return layer_ptr;
}
/* ------------------------------------------------------------------------- */
bs_dllist_t *wlmtk_workspace_get_windows_dllist(
wlmtk_workspace_t *workspace_ptr)
{
return &workspace_ptr->windows;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_window_to_fullscreen(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr,
bool fullscreen)
{
BS_ASSERT(workspace_ptr == wlmtk_window_get_workspace(window_ptr));
BS_ASSERT(fullscreen == wlmtk_window_is_fullscreen(window_ptr));
if (fullscreen) {
BS_ASSERT(
bs_dllist_contains(
&workspace_ptr->window_container.elements,
wlmtk_dlnode_from_element(wlmtk_window_element(window_ptr))));
// TODO(kaeser@gubbe.ch): Add a method to just reparent an element. The
// current implementation will destroy, then re-create each of the
// scene nodes.
wlmtk_container_remove_element(
&workspace_ptr->window_container,
wlmtk_window_element(window_ptr));
wlmtk_container_add_element(
&workspace_ptr->fullscreen_container,
wlmtk_window_element(window_ptr));
wlmtk_workspace_activate_window(workspace_ptr, window_ptr);
} else {
BS_ASSERT(
bs_dllist_contains(
&workspace_ptr->fullscreen_container.elements,
wlmtk_dlnode_from_element(wlmtk_window_element(window_ptr))));
wlmtk_container_remove_element(
&workspace_ptr->fullscreen_container,
wlmtk_window_element(window_ptr));
wlmtk_container_add_element(
&workspace_ptr->window_container,
wlmtk_window_element(window_ptr));
wlmtk_workspace_activate_window(workspace_ptr, window_ptr);
// The un-fullscreened window will come on top of the container. Also
// reflect that in @ref wlmtk_workspace_t::windows.
bs_dllist_remove(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
bs_dllist_push_front(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
}
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_begin_window_move(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr)
{
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_BEGIN_MOVE, window_ptr);
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_begin_window_resize(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr,
uint32_t edges)
{
workspace_ptr->resize_edges = edges;
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_BEGIN_RESIZE, window_ptr);
}
/* ------------------------------------------------------------------------- */
/** Acticates `window_ptr`. Will de-activate an earlier window. */
void wlmtk_workspace_activate_window(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr)
{
// Nothing to do.
if (workspace_ptr->activated_window_ptr == window_ptr) return;
if (NULL != workspace_ptr->activated_window_ptr) {
wlmtk_window_set_activated(workspace_ptr->activated_window_ptr, false);
workspace_ptr->activated_window_ptr = NULL;
}
if (NULL != window_ptr) {
wlmtk_window_set_activated(window_ptr, true);
workspace_ptr->activated_window_ptr = window_ptr;
}
}
/* ------------------------------------------------------------------------- */
wlmtk_window_t *wlmtk_workspace_get_activated_window(
wlmtk_workspace_t *workspace_ptr)
{
return workspace_ptr->activated_window_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_activate_previous_window(
wlmtk_workspace_t *workspace_ptr)
{
bs_dllist_node_t *dlnode_ptr = NULL;
if (NULL != workspace_ptr->activated_window_ptr) {
dlnode_ptr = wlmtk_dlnode_from_window(
workspace_ptr->activated_window_ptr);
dlnode_ptr = dlnode_ptr->prev_ptr;
}
if (NULL == dlnode_ptr) {
dlnode_ptr = workspace_ptr->windows.tail_ptr;
}
if (NULL == dlnode_ptr) return;
wlmtk_workspace_activate_window(
workspace_ptr, wlmtk_window_from_dlnode(dlnode_ptr));
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_activate_next_window(
wlmtk_workspace_t *workspace_ptr)
{
bs_dllist_node_t *dlnode_ptr = NULL;
if (NULL != workspace_ptr->activated_window_ptr) {
dlnode_ptr = wlmtk_dlnode_from_window(
workspace_ptr->activated_window_ptr);
dlnode_ptr = dlnode_ptr->next_ptr;
}
if (NULL == dlnode_ptr) {
dlnode_ptr = workspace_ptr->windows.head_ptr;
}
if (NULL == dlnode_ptr) return;
wlmtk_workspace_activate_window(
workspace_ptr, wlmtk_window_from_dlnode(dlnode_ptr));
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_raise_window(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr)
{
BS_ASSERT(workspace_ptr == wlmtk_window_get_workspace(window_ptr));
bs_dllist_remove(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
bs_dllist_push_front(&workspace_ptr->windows,
wlmtk_dlnode_from_window(window_ptr));
wlmtk_container_raise_element_to_top(&workspace_ptr->window_container,
wlmtk_window_element(window_ptr));
}
/* ------------------------------------------------------------------------- */
wlmtk_element_t *wlmtk_workspace_element(wlmtk_workspace_t *workspace_ptr)
{
return &workspace_ptr->super_container.super_element;
}
/* ------------------------------------------------------------------------- */
wlmtk_root_t *wlmtk_workspace_get_root(wlmtk_workspace_t *workspace_ptr)
{
return workspace_ptr->root_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_workspace_set_root(
wlmtk_workspace_t *workspace_ptr,
wlmtk_root_t *root_ptr)
{
workspace_ptr->root_ptr = root_ptr;
}
/* ------------------------------------------------------------------------- */
bs_dllist_node_t *wlmtk_dlnode_from_workspace(
wlmtk_workspace_t *workspace_ptr)
{
return &workspace_ptr->dlnode;
}
/* ------------------------------------------------------------------------- */
wlmtk_workspace_t *wlmtk_workspace_from_dlnode(
bs_dllist_node_t *dlnode_ptr)
{
if (NULL == dlnode_ptr) return NULL;
return BS_CONTAINER_OF(dlnode_ptr, wlmtk_workspace_t, dlnode);
}
/* == Fake workspace methods, useful for tests ============================= */
/* ------------------------------------------------------------------------- */
wlmtk_fake_workspace_t *wlmtk_fake_workspace_create(int width, int height)
{
wlmtk_fake_workspace_t *fw_ptr = logged_calloc(
1, sizeof(wlmtk_fake_workspace_t));
if (NULL == fw_ptr) return NULL;
fw_ptr->workspace_ptr = wlmtk_workspace_create("fake", NULL);
if (NULL == fw_ptr->workspace_ptr) {
wlmtk_fake_workspace_destroy(fw_ptr);
return NULL;
}
wlmtk_element_set_visible(
wlmtk_workspace_element(fw_ptr->workspace_ptr), true);
fw_ptr->fake_parent_ptr = wlmtk_container_create_fake_parent();
if (NULL == fw_ptr->fake_parent_ptr) {
wlmtk_fake_workspace_destroy(fw_ptr);
return NULL;
}
wlmtk_container_add_element(
fw_ptr->fake_parent_ptr,
wlmtk_workspace_element(fw_ptr->workspace_ptr));
struct wlr_box extents = { .width = width, .height = height };
wlmtk_workspace_set_extents(fw_ptr->workspace_ptr, &extents);
return fw_ptr;
}
/* ------------------------------------------------------------------------- */
void wlmtk_fake_workspace_destroy(wlmtk_fake_workspace_t *fw_ptr)
{
if (NULL != fw_ptr->fake_parent_ptr) {
wlmtk_container_remove_element(
fw_ptr->fake_parent_ptr,
wlmtk_workspace_element(fw_ptr->workspace_ptr));
wlmtk_container_destroy_fake_parent(fw_ptr->fake_parent_ptr);
fw_ptr->fake_parent_ptr = NULL;
}
if (NULL != fw_ptr->workspace_ptr) {
wlmtk_workspace_destroy(fw_ptr->workspace_ptr);
fw_ptr->workspace_ptr = NULL;
}
free(fw_ptr);
}
/* == Local (static) methods =============================================== */
/* ------------------------------------------------------------------------- */
/** Virtual destructor, wraps to our dtor. */
void _wlmtk_workspace_element_destroy(wlmtk_element_t *element_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_workspace_t, super_container.super_element);
wlmtk_workspace_destroy(workspace_ptr);
}
/* ------------------------------------------------------------------------- */
/** Returns the workspace area. */
void _wlmtk_workspace_element_get_dimensions(
wlmtk_element_t *element_ptr,
int *left_ptr,
int *top_ptr,
int *right_ptr,
int *bottom_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_workspace_t, super_container.super_element);
if (NULL != left_ptr) *left_ptr = workspace_ptr->x1;
if (NULL != top_ptr) *top_ptr = workspace_ptr->y1;
if (NULL != right_ptr) *right_ptr = workspace_ptr->x2;
if (NULL != bottom_ptr) *bottom_ptr = workspace_ptr->y2;
}
/* ------------------------------------------------------------------------- */
/** Returns workspace area: @ref _wlmtk_workspace_element_get_dimensions. */
void _wlmtk_workspace_element_get_pointer_area(
wlmtk_element_t *element_ptr,
int *x1_ptr,
int *y1_ptr,
int *x2_ptr,
int *y2_ptr)
{
return _wlmtk_workspace_element_get_dimensions(
element_ptr, x1_ptr, y1_ptr, x2_ptr, y2_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Extends wlmtk_container_t::pointer_button: Feeds the motion into the
* workspace's pointer state machine, and only passes it to the container's
* handler if the event isn't consumed yet.
*
* @param element_ptr
* @param x
* @param y
* @param time_msec
*
* @return Always true.
*/
bool _wlmtk_workspace_element_pointer_motion(
wlmtk_element_t *element_ptr,
double x, double y,
uint32_t time_msec)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_workspace_t, super_container.super_element);
// Note: Workspace ignores the return value. All motion events are whitin.
bool rv = workspace_ptr->orig_super_element_vmt.pointer_motion(
element_ptr, x, y, time_msec);
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_MOTION, NULL);
// Focus wasn't claimed, so we'll set the cursor here.
if (!rv) {
wlmtk_env_set_cursor(
workspace_ptr->super_container.super_element.env_ptr,
WLMTK_CURSOR_DEFAULT);
}
return true;
}
/* ------------------------------------------------------------------------- */
/**
* Extends wlmtk_container_t::pointer_button.
*
* @param element_ptr
* @param button_event_ptr
*
* @return Whether the button event was consumed.
*/
bool _wlmtk_workspace_element_pointer_button(
wlmtk_element_t *element_ptr,
const wlmtk_button_event_t *button_event_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_workspace_t, super_container.super_element);
// TODO(kaeser@gubbe.ch): We should retract as to which event had triggered
// the move, and then figure out the exit condition (button up? key? ...)
// from there.
// See xdg_toplevel::move doc at https://wayland.app/protocols/xdg-shell.
if (button_event_ptr->button == BTN_LEFT &&
button_event_ptr->type == WLMTK_BUTTON_UP) {
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_RELEASED, NULL);
}
return workspace_ptr->orig_super_element_vmt.pointer_button(
element_ptr, button_event_ptr);
}
/* ------------------------------------------------------------------------- */
/**
* Extends wlmtk_container_t::leave.
*
* @param element_ptr
*/
void _wlmtk_workspace_element_pointer_leave(
wlmtk_element_t *element_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
element_ptr, wlmtk_workspace_t, super_container.super_element);
wlmtk_fsm_event(&workspace_ptr->fsm, PFSME_RESET, NULL);
workspace_ptr->orig_super_element_vmt.pointer_leave(element_ptr);
}
/* ------------------------------------------------------------------------- */
/** Initiates a move. */
bool pfsm_move_begin(wlmtk_fsm_t *fsm_ptr, void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
fsm_ptr, wlmtk_workspace_t, fsm);
workspace_ptr->grabbed_window_ptr = ud_ptr;
workspace_ptr->motion_x =
workspace_ptr->super_container.super_element.last_pointer_x;
workspace_ptr->motion_y =
workspace_ptr->super_container.super_element.last_pointer_y;
wlmtk_element_get_position(
wlmtk_window_element(workspace_ptr->grabbed_window_ptr),
&workspace_ptr->initial_x,
&workspace_ptr->initial_y);
// TODO(kaeser@gubbe.ch): When in move mode, set (and keep) a corresponding
// cursor image.
return true;
}
/* ------------------------------------------------------------------------- */
/** Handles motion during a move. */
bool pfsm_move_motion(wlmtk_fsm_t *fsm_ptr, __UNUSED__ void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
fsm_ptr, wlmtk_workspace_t, fsm);
double rel_x = workspace_ptr->super_container.super_element.last_pointer_x -
workspace_ptr->motion_x;
double rel_y = workspace_ptr->super_container.super_element.last_pointer_y -
workspace_ptr->motion_y;
wlmtk_window_set_position(
workspace_ptr->grabbed_window_ptr,
workspace_ptr->initial_x + rel_x,
workspace_ptr->initial_y + rel_y);
return true;
}
/* ------------------------------------------------------------------------- */
/** Initiates a resize. */
bool pfsm_resize_begin(wlmtk_fsm_t *fsm_ptr, void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
fsm_ptr, wlmtk_workspace_t, fsm);
workspace_ptr->grabbed_window_ptr = ud_ptr;
workspace_ptr->motion_x =
workspace_ptr->super_container.super_element.last_pointer_x;
workspace_ptr->motion_y =
workspace_ptr->super_container.super_element.last_pointer_y;
wlmtk_element_get_position(
wlmtk_window_element(workspace_ptr->grabbed_window_ptr),
&workspace_ptr->initial_x,
&workspace_ptr->initial_y);
wlmtk_window_get_size(
workspace_ptr->grabbed_window_ptr,
&workspace_ptr->initial_width,
&workspace_ptr->initial_height);
return true;
}
/* ------------------------------------------------------------------------- */
/** Handles motion during a resize. */
bool pfsm_resize_motion(wlmtk_fsm_t *fsm_ptr, __UNUSED__ void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
fsm_ptr, wlmtk_workspace_t, fsm);
double rel_x = workspace_ptr->super_container.super_element.last_pointer_x -
workspace_ptr->motion_x;
double rel_y = workspace_ptr->super_container.super_element.last_pointer_y -
workspace_ptr->motion_y;
// Update new boundaries by the relative movement.
int top = workspace_ptr->initial_y;
int bottom = workspace_ptr->initial_y + workspace_ptr->initial_height;
if (workspace_ptr->resize_edges & WLR_EDGE_TOP) {
top += rel_y;
if (top >= bottom) top = bottom - 1;
} else if (workspace_ptr->resize_edges & WLR_EDGE_BOTTOM) {
bottom += rel_y;
if (bottom <= top) bottom = top + 1;
}
int left = workspace_ptr->initial_x;
int right = workspace_ptr->initial_x + workspace_ptr->initial_width;
if (workspace_ptr->resize_edges & WLR_EDGE_LEFT) {
left += rel_x;
if (left >= right) left = right - 1 ;
} else if (workspace_ptr->resize_edges & WLR_EDGE_RIGHT) {
right += rel_x;
if (right <= left) right = left + 1;
}
wlmtk_window_request_position_and_size(
workspace_ptr->grabbed_window_ptr,
left, top,
right - left, bottom - top);
return true;
}
/* ------------------------------------------------------------------------- */
/** Resets the state machine. */
bool pfsm_reset(wlmtk_fsm_t *fsm_ptr, __UNUSED__ void *ud_ptr)
{
wlmtk_workspace_t *workspace_ptr = BS_CONTAINER_OF(
fsm_ptr, wlmtk_workspace_t, fsm);
workspace_ptr->grabbed_window_ptr = NULL;
return true;
}
/* == Unit tests =========================================================== */
static void test_create_destroy(bs_test_t *test_ptr);
static void test_map_unmap(bs_test_t *test_ptr);
static void test_move(bs_test_t *test_ptr);
static void test_unmap_during_move(bs_test_t *test_ptr);
static void test_resize(bs_test_t *test_ptr);
static void test_activate(bs_test_t *test_ptr);
static void test_activate_cycling(bs_test_t *test_ptr);
const bs_test_case_t wlmtk_workspace_test_cases[] = {
{ 1, "create_destroy", test_create_destroy },
{ 1, "map_unmap", test_map_unmap },
{ 1, "move", test_move },
{ 1, "unmap_during_move", test_unmap_during_move },
{ 1, "resize", test_resize },
{ 1, "activate", test_activate },
{ 1, "activate_cycling", test_activate_cycling },
{ 0, NULL, NULL }
};
/** Listeners for tests. */
typedef struct {
/** Listener for when the window is mapped. */
struct wl_listener window_mapped_listener;
/** Listener for when the window is unmapped. */
struct wl_listener window_unmapped_listener;
/** Reports whether the handler was invoked. */
bool window_mapped_handler_invoked;
/** Reports whether the handler was invoked. */
bool window_unmapped_handler_invoked;
} _wlmtk_workspace_test_listeners_t;
/** Test handler for @ref wlmtk_root_events_t::window_mapped. */
static void _wlmtk_workspace_test_handle_window_mapped(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
_wlmtk_workspace_test_listeners_t *tl_ptr = BS_CONTAINER_OF(
listener_ptr,
_wlmtk_workspace_test_listeners_t,
window_mapped_listener);
tl_ptr->window_mapped_handler_invoked = true;
}
/** Test handler for @ref wlmtk_root_events_t::window_unmapped. */
static void _wlmtk_workspace_test_handle_window_unmapped(
struct wl_listener *listener_ptr,
__UNUSED__ void *data_ptr)
{
_wlmtk_workspace_test_listeners_t *tl_ptr = BS_CONTAINER_OF(
listener_ptr,
_wlmtk_workspace_test_listeners_t,
window_unmapped_listener);
tl_ptr->window_unmapped_handler_invoked = true;
}
/* ------------------------------------------------------------------------- */
/** Exercises workspace create & destroy methods. */
void test_create_destroy(bs_test_t *test_ptr)
{
wlmtk_container_t *fake_parent_ptr = wlmtk_container_create_fake_parent();
BS_ASSERT(NULL != fake_parent_ptr);
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_create("test", NULL);
BS_TEST_VERIFY_NEQ(test_ptr, NULL, workspace_ptr);
struct wlr_box box = { .x = -10, .y = -20, .width = 100, .height = 200 };
wlmtk_workspace_set_extents(workspace_ptr, &box);
int x1, y1, x2, y2;
wlmtk_element_get_pointer_area(
&workspace_ptr->super_container.super_element, &x1, &y1, &x2, &y2);
BS_TEST_VERIFY_EQ(test_ptr, -10, x1);
BS_TEST_VERIFY_EQ(test_ptr, -20, y1);
BS_TEST_VERIFY_EQ(test_ptr, 90, x2);
BS_TEST_VERIFY_EQ(test_ptr, 180, y2);
box = wlmtk_workspace_get_maximize_extents(workspace_ptr);
BS_TEST_VERIFY_EQ(test_ptr, -10, box.x);
BS_TEST_VERIFY_EQ(test_ptr, -20, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 36, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 136, box.height);
box = wlmtk_workspace_get_fullscreen_extents(workspace_ptr);
BS_TEST_VERIFY_EQ(test_ptr, -10, box.x);
BS_TEST_VERIFY_EQ(test_ptr, -20, box.y);
BS_TEST_VERIFY_EQ(test_ptr, 100, box.width);
BS_TEST_VERIFY_EQ(test_ptr, 200, box.height);
const char *name_ptr;
int index;
wlmtk_workspace_set_details(workspace_ptr, 42);
wlmtk_workspace_get_details(workspace_ptr, &name_ptr, &index);
BS_TEST_VERIFY_STREQ(test_ptr, "test", name_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 42, index);
wlmtk_workspace_destroy(workspace_ptr);
wlmtk_container_destroy_fake_parent(fake_parent_ptr);
}
/* ------------------------------------------------------------------------- */
/** Verifies that mapping and unmapping windows works. */
void test_map_unmap(bs_test_t *test_ptr)
{
struct wlr_scene *wlr_scene_ptr = wlr_scene_create();
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, wlr_scene_ptr);
wlmtk_root_t *root_ptr = wlmtk_root_create(wlr_scene_ptr, NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, root_ptr);
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_create("test", NULL);
BS_TEST_VERIFY_NEQ_OR_RETURN(test_ptr, NULL, workspace_ptr);
wlmtk_root_add_workspace(root_ptr, workspace_ptr);
_wlmtk_workspace_test_listeners_t test_listeners = {};
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(root_ptr)->window_mapped,
&test_listeners.window_mapped_listener,
_wlmtk_workspace_test_handle_window_mapped);
wlmtk_util_connect_listener_signal(
&wlmtk_root_events(root_ptr)->window_unmapped,
&test_listeners.window_unmapped_listener,
_wlmtk_workspace_test_handle_window_unmapped);
bs_dllist_t *wdl_ptr = wlmtk_workspace_get_windows_dllist(workspace_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, bs_dllist_size(wdl_ptr));
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_element(fw_ptr->window_ptr)->visible);
wlmtk_workspace_map_window(workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_NEQ(
test_ptr,
NULL,
wlmtk_window_element(fw_ptr->window_ptr)->wlr_scene_node_ptr);
BS_TEST_VERIFY_NEQ(
test_ptr,
NULL,
fw_ptr->fake_surface_ptr->surface.super_element.wlr_scene_node_ptr);
BS_TEST_VERIFY_TRUE(test_ptr, wlmtk_window_element(fw_ptr->window_ptr)->visible);
BS_TEST_VERIFY_EQ(test_ptr, 1, bs_dllist_size(wdl_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr, test_listeners.window_mapped_handler_invoked);
wlmtk_workspace_unmap_window(workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
wlmtk_window_element(fw_ptr->window_ptr)->wlr_scene_node_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
NULL,
fw_ptr->fake_surface_ptr->surface.super_element.wlr_scene_node_ptr);
BS_TEST_VERIFY_FALSE(test_ptr, wlmtk_window_element(fw_ptr->window_ptr)->visible);
BS_TEST_VERIFY_EQ(test_ptr, 0, bs_dllist_size(wdl_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr, test_listeners.window_unmapped_handler_invoked);
wlmtk_util_disconnect_listener(&test_listeners.window_mapped_listener);
wlmtk_util_disconnect_listener(&test_listeners.window_unmapped_listener);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_root_remove_workspace(root_ptr, workspace_ptr);
wlmtk_workspace_destroy(workspace_ptr);
wlmtk_root_destroy(root_ptr);
free(wlr_scene_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests moving a window. */
void test_move(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 0, 0, 42);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->y);
// Starts a move for the window. Will move it...
wlmtk_workspace_begin_window_move(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 1, 2, 43);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
// Releases the button. Should end the move.
wlmtk_button_event_t button_event = {
.button = BTN_LEFT,
.type = WLMTK_BUTTON_UP,
.time_msec = 44,
};
wlmtk_element_pointer_button(
wlmtk_workspace_element(fws_ptr->workspace_ptr),
&button_event);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fws_ptr->workspace_ptr->grabbed_window_ptr);
// More motion, no longer updates the position.
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 3, 4, 45);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests moving a window that unmaps during the move. */
void test_unmap_during_move(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 0, 0, 42);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->y);
// Starts a move for the window. Will move it...
wlmtk_workspace_begin_window_move(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 1, 2, 43);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fws_ptr->workspace_ptr->grabbed_window_ptr);
// More motion, no longer updates the position.
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 3, 4, 45);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
// More motion, no longer updates the position.
wlmtk_element_pointer_motion(
wlmtk_workspace_element(fws_ptr->workspace_ptr), 3, 4, 45);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests resizing a window. */
void test_resize(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
wlmtk_fake_window_t *fw_ptr = wlmtk_fake_window_create();
BS_ASSERT(NULL != fw_ptr);
wlmtk_window_request_position_and_size(fw_ptr->window_ptr, 0, 0, 40, 20);
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_element_pointer_motion(
&fws_ptr->fake_parent_ptr->super_element, 0, 0, 42);
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->y);
int width, height;
wlmtk_window_get_size(fw_ptr->window_ptr, &width, &height);
BS_TEST_VERIFY_EQ(test_ptr, 40, width);
BS_TEST_VERIFY_EQ(test_ptr, 20, height);
// Starts a resize for the window. Will resize & move it...
wlmtk_workspace_begin_window_resize(
fws_ptr->workspace_ptr, fw_ptr->window_ptr, WLR_EDGE_TOP | WLR_EDGE_LEFT);
fw_ptr->fake_content_ptr->serial = 1; // The serial.
wlmtk_element_pointer_motion(
&fws_ptr->fake_parent_ptr->super_element, 1, 2, 44);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 0, wlmtk_window_element(fw_ptr->window_ptr)->y);
BS_TEST_VERIFY_EQ(test_ptr, 39, fw_ptr->fake_content_ptr->requested_width);
BS_TEST_VERIFY_EQ(test_ptr, 18, fw_ptr->fake_content_ptr->requested_height);
// This updates for the given serial.
wlmtk_fake_window_commit_size(fw_ptr);
wlmtk_window_get_size(fw_ptr->window_ptr, &width, &height);
BS_TEST_VERIFY_EQ(test_ptr, 1, wlmtk_window_element(fw_ptr->window_ptr)->x);
BS_TEST_VERIFY_EQ(test_ptr, 2, wlmtk_window_element(fw_ptr->window_ptr)->y);
BS_TEST_VERIFY_EQ(test_ptr, 39, width);
BS_TEST_VERIFY_EQ(test_ptr, 18, height);
// Releases the button. Should end the move.
wlmtk_button_event_t button_event = {
.button = BTN_LEFT,
.type = WLMTK_BUTTON_UP,
.time_msec = 44,
};
wlmtk_element_pointer_button(
wlmtk_workspace_element(fws_ptr->workspace_ptr),
&button_event);
BS_TEST_VERIFY_EQ(test_ptr, NULL, fws_ptr->workspace_ptr->grabbed_window_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw_ptr->window_ptr);
wlmtk_fake_window_destroy(fw_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests window activation. */
void test_activate(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
// Window 1: from (0, 0) to (100, 100)
wlmtk_fake_window_t *fw1_ptr = wlmtk_fake_window_create();
wlmtk_content_request_size(&fw1_ptr->fake_content_ptr->content, 100, 100);
wlmtk_fake_window_commit_size(fw1_ptr);
wlmtk_window_set_position(fw1_ptr->window_ptr, 0, 0);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
// Window 1 is mapped => it's activated.
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw1_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
// Window 2: from (200, 0) to (300, 100).
// Window 2 is mapped: Will get activated, and 1st one de-activated.
wlmtk_fake_window_t *fw2_ptr = wlmtk_fake_window_create();
wlmtk_content_request_size(&fw2_ptr->fake_content_ptr->content, 100, 100);
wlmtk_fake_window_commit_size(fw2_ptr);
wlmtk_window_set_position(fw2_ptr->window_ptr, 200, 0);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw2_ptr->window_ptr);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
// Pointer move, over window 1. Nothing happens: We have click-to-focus.
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_element_pointer_motion(
&fws_ptr->fake_parent_ptr->super_element, 50, 50, 0));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
// Click on window 1: Gets activated.
wlmtk_button_event_t button_event = {
.button = BTN_RIGHT,
.type = WLMTK_BUTTON_DOWN,
};
wlmtk_element_pointer_button(
wlmtk_workspace_element(fws_ptr->workspace_ptr),
&button_event);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
// Unmap window 1. Now window 2 gets activated.
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw1_ptr->window_ptr);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
// Unmap the remaining window 2. Nothing is activated.
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw2_ptr->window_ptr);
BS_TEST_VERIFY_FALSE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
wlmtk_fake_window_destroy(fw2_ptr);
wlmtk_fake_window_destroy(fw1_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* ------------------------------------------------------------------------- */
/** Tests cycling through windows. */
void test_activate_cycling(bs_test_t *test_ptr)
{
wlmtk_fake_workspace_t *fws_ptr = wlmtk_fake_workspace_create(1024, 768);
BS_ASSERT(NULL != fws_ptr);
bs_dllist_t *windows_ptr = wlmtk_workspace_get_windows_dllist(
fws_ptr->workspace_ptr);
// Window 1 gets mapped: Activated and on top.
wlmtk_fake_window_t *fw1_ptr = wlmtk_fake_window_create();
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw1_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw1_ptr->window_ptr),
windows_ptr->head_ptr);
// Window 2 gets mapped: Activated and on top.
wlmtk_fake_window_t *fw2_ptr = wlmtk_fake_window_create();
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw2_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw2_ptr->window_ptr),
windows_ptr->head_ptr);
// Window 3 gets mapped: Activated and on top.
wlmtk_fake_window_t *fw3_ptr = wlmtk_fake_window_create();
wlmtk_workspace_map_window(fws_ptr->workspace_ptr, fw3_ptr->window_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw3_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw3_ptr->window_ptr),
windows_ptr->head_ptr);
// From mapping sequence: We have 3 -> 2 -> 1. Cycling brings us to
// window 2, but must not change the top window.
wlmtk_workspace_activate_next_window(fws_ptr->workspace_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw2_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw3_ptr->window_ptr),
windows_ptr->head_ptr);
// One more cycle: 1.
wlmtk_workspace_activate_next_window(fws_ptr->workspace_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw3_ptr->window_ptr),
windows_ptr->head_ptr);
// One more cycle: Back at 3.
wlmtk_workspace_activate_next_window(fws_ptr->workspace_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw3_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw3_ptr->window_ptr),
windows_ptr->head_ptr);
// Cycle backward: Gets us to 1.
wlmtk_workspace_activate_previous_window(fws_ptr->workspace_ptr);
BS_TEST_VERIFY_TRUE(
test_ptr,
wlmtk_window_is_activated(fw1_ptr->window_ptr));
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw3_ptr->window_ptr),
windows_ptr->head_ptr);
// Raise: Must come to top.
wlmtk_workspace_raise_window(fws_ptr->workspace_ptr,
fw1_ptr->window_ptr);
BS_TEST_VERIFY_EQ(
test_ptr,
wlmtk_dlnode_from_window(fw1_ptr->window_ptr),
windows_ptr->head_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw3_ptr->window_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw2_ptr->window_ptr);
wlmtk_workspace_unmap_window(fws_ptr->workspace_ptr, fw1_ptr->window_ptr);
wlmtk_fake_window_destroy(fw3_ptr);
wlmtk_fake_window_destroy(fw2_ptr);
wlmtk_fake_window_destroy(fw1_ptr);
wlmtk_fake_workspace_destroy(fws_ptr);
}
/* == End of workspace.c =================================================== */
wlmaker-0.3/src/toolkit/workspace.h 0000664 0000000 0000000 00000017501 14641446446 0017462 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file workspace.h
*
* @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.
*/
#ifndef __WLMTK_WORKSPACE_H__
#define __WLMTK_WORKSPACE_H__
/** State of the workspace. */
typedef struct _wlmtk_workspace_t wlmtk_workspace_t;
#include "container.h"
#include "panel.h"
#include "root.h"
#include "window.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/** Forward declaration. */
struct wlr_pointer_button_event;
/** Forward declaration. */
struct wlr_box;
/**
* Indicates which layer the view shall be rendered in.
*
* See `enum layer` at:
* https://wayland.app/protocols/wlr-layer-shell-unstable-v1.
*/
typedef enum {
WLMTK_WORKSPACE_LAYER_BACKGROUND = 0,
WLMTK_WORKSPACE_LAYER_BOTTOM = 1,
WLMTK_WORKSPACE_LAYER_TOP = 3,
WLMTK_WORKSPACE_LAYER_OVERLAY = 4,
} wlmtk_workspace_layer_t;
/**
* Creates a workspace.
*
* @param name_ptr
* @param env_ptr
*
* @return Pointer to the workspace state, or NULL on error. Must be free'd
* via @ref wlmtk_workspace_destroy.
*/
wlmtk_workspace_t *wlmtk_workspace_create(
const char *name_ptr,
wlmtk_env_t *env_ptr);
/**
* Destroys the workspace. Will destroy any stil-contained element.
*
* @param workspace_ptr
*/
void wlmtk_workspace_destroy(wlmtk_workspace_t *workspace_ptr);
/**
* Sets or updates workspace details.
*
* @param workspace_ptr
* @param index
*/
void wlmtk_workspace_set_details(
wlmtk_workspace_t *workspace_ptr,
int index);
/**
* Retrieves the naming details of this workspace.
*
* @param workspace_ptr
* @param name_ptr_ptr
* @param index_ptr
*/
void wlmtk_workspace_get_details(
wlmtk_workspace_t *workspace_ptr,
const char **name_ptr_ptr,
int *index_ptr);
/**
* Sets (or updates) the extents of the workspace.
*
* @param workspace_ptr
* @param extents_ptr
*/
void wlmtk_workspace_set_extents(wlmtk_workspace_t *workspace_ptr,
const struct wlr_box *extents_ptr);
/**
* Returns the extents of the workspace available for maximized windows.
*
* @param workspace_ptr
*
* @return A `struct wlr_box` that lines out the available space and position.
*/
struct wlr_box wlmtk_workspace_get_maximize_extents(
wlmtk_workspace_t *workspace_ptr);
/**
* Returns the extents of the workspace available for fullscreen windows.
*
* @param workspace_ptr
*
* @return A `struct wlr_box` that lines out the available space and position.
*/
struct wlr_box wlmtk_workspace_get_fullscreen_extents(
wlmtk_workspace_t *workspace_ptr);
/**
* Maps the window: Adds it to the workspace container and makes it visible.
*
* @param workspace_ptr
* @param window_ptr
*/
void wlmtk_workspace_map_window(wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr);
/**
* Unmaps the window: Sets it as invisible and removes it from the container.
*
* @param workspace_ptr
* @param window_ptr
*/
void wlmtk_workspace_unmap_window(wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr);
/**
* Returns pointer to the @ref wlmtk_layer_t handle serving `layer`.
*
* @param workspace_ptr
* @param layer
*
* @return Pointer to the layer state.
*/
wlmtk_layer_t *wlmtk_workspace_get_layer(
wlmtk_workspace_t *workspace_ptr,
wlmtk_workspace_layer_t layer);
/**
* Returns the `bs_dllist_t` of currently mapped windows.
*
* @param workspace_ptr
*
* @return A pointer to the list. Note that the list should not be manipulated
* directly. It's contents can change on @ref wlmtk_workspace_map_window or
* @ref wlmtk_workspace_unmap_window calls.
*/
bs_dllist_t *wlmtk_workspace_get_windows_dllist(
wlmtk_workspace_t *workspace_ptr);
/**
* Promotes the window to the fullscreen layer (or back).
*
* To be called by @ref wlmtk_window_commit_fullscreen.
*
* @param workspace_ptr
* @param window_ptr
* @param fullscreen
*/
void wlmtk_workspace_window_to_fullscreen(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr,
bool fullscreen);
/**
* Initiates a 'move' for the window.
*
* @param workspace_ptr
* @param window_ptr
*/
void wlmtk_workspace_begin_window_move(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr);
/**
* Initiates a 'resize' for the window.
*
* @param workspace_ptr
* @param window_ptr
* @param edges
*/
void wlmtk_workspace_begin_window_resize(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr,
uint32_t edges);
/** Acticates `window_ptr`. Will de-activate an earlier window. */
void wlmtk_workspace_activate_window(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr);
/** @return Pointer to the activated @ref wlmtk_window_t, if any. */
wlmtk_window_t *wlmtk_workspace_get_activated_window(
wlmtk_workspace_t *workspace_ptr);
/**
* Activates the @ref wlmtk_window_t *before* the currently activated one.
*
* Intended to permit cycling through tasks. Will activate the window, but not
* raise it. See @ref wlmtk_workspace_activate_next_window.
*
* @param workspace_ptr
*/
void wlmtk_workspace_activate_previous_window(
wlmtk_workspace_t *workspace_ptr);
/**
* Activates the @ref wlmtk_window_t *after* the currently activated one.
*
* Intended to permit cycling through tasks. Will activate the window, but not
* raise it. See @ref wlmtk_workspace_activate_previous_window.
*
* @param workspace_ptr
*/
void wlmtk_workspace_activate_next_window(
wlmtk_workspace_t *workspace_ptr);
/** Raises `window_ptr`: Will show it atop all other windows. */
void wlmtk_workspace_raise_window(
wlmtk_workspace_t *workspace_ptr,
wlmtk_window_t *window_ptr);
/** @return Pointer to wlmtk_workspace_t::super_container::super_element. */
wlmtk_element_t *wlmtk_workspace_element(wlmtk_workspace_t *workspace_ptr);
/** @return pointer to the anchor @ref wlmtk_root_t of `workspace_ptr`. */
wlmtk_root_t *wlmtk_workspace_get_root(wlmtk_workspace_t *workspace_ptr);
/**
* Sets the anchor @ref wlmtk_root_t of `workspace_ptr`.
*
* @protected Must only be called from @ref wlmtk_root_t.
*
* @param workspace_ptr
* @param root_ptr
*/
void wlmtk_workspace_set_root(
wlmtk_workspace_t *workspace_ptr,
wlmtk_root_t *root_ptr);
/** @return Pointer to @ref wlmtk_workspace_t::dlnode. */
bs_dllist_node_t *wlmtk_dlnode_from_workspace(
wlmtk_workspace_t *workspace_ptr);
/** @return Poitner to the @ref wlmtk_workspace_t of the `dlnode_ptr`. */
wlmtk_workspace_t *wlmtk_workspace_from_dlnode(
bs_dllist_node_t *dlnode_ptr);
/** Fake workspace: A real workspace, but with a fake parent. For testing. */
typedef struct {
/** The workspace. */
wlmtk_workspace_t *workspace_ptr;
/** The (fake) parent container. */
wlmtk_container_t *fake_parent_ptr;
} wlmtk_fake_workspace_t;
/** Creates a fake workspace with specified extents. */
wlmtk_fake_workspace_t *wlmtk_fake_workspace_create(int width, int height);
/** Destroys the fake workspace. */
void wlmtk_fake_workspace_destroy(wlmtk_fake_workspace_t *fake_workspace_ptr);
/** Unit tests for the workspace. */
extern const bs_test_case_t wlmtk_workspace_test_cases[];
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif /* __WLMTK_WORKSPACE_H__ */
/* == End of workspace.h =================================================== */
wlmaker-0.3/src/wlmaker.c 0000664 0000000 0000000 00000031357 14641446446 0015441 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file wlmaker.c
*
* @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.
*/
/// setenv() is a POSIX extension.
#define _POSIX_C_SOURCE 200112L
#include
#include
#include
#include
#include
#include
#include
#include "conf/plist.h"
#include "action.h"
#include "background.h"
#include "clip.h"
#include "config.h"
#include "dock.h"
#include "server.h"
#include "task_list.h"
#include "style_default.h"
/** Will hold the value of --config_file. */
static char *wlmaker_arg_config_file_ptr = NULL;
/** Will hold the value of --state_file. */
static char *wlmaker_arg_state_file_ptr = NULL;
/** Will hold the value of --style_file. */
static char *wlmaker_arg_style_file_ptr = NULL;
/** Startup options for the server. */
static wlmaker_server_options_t wlmaker_server_options = {};
/** Definition of commandline arguments. */
static const bs_arg_t wlmaker_args[] = {
#if defined(WLMAKER_HAVE_XWAYLAND)
BS_ARG_BOOL(
"start_xwayland",
"Optional: Whether to start XWayland. Disabled by default.",
false,
&wlmaker_server_options.start_xwayland),
#endif // defined(WLMAKER_HAVE_XWAYLAND)
BS_ARG_STRING(
"config_file",
"Optional: Path to a configuration file. If not provided, wlmaker "
"will scan default paths for a configuration file, or fall back to "
"a built-in configuration.",
NULL,
&wlmaker_arg_config_file_ptr),
BS_ARG_STRING(
"state_file",
"Optional: Path to a state file, with state of workspaces, dock and "
"clips configured. If not provided, wlmaker will scan default paths "
"for a state file, or fall back to a built-in default.",
NULL,
&wlmaker_arg_state_file_ptr),
BS_ARG_STRING(
"style_file",
"Optional: Path to a style (\"theme\") file. If not provided, wlmaker "
"will use a built-in default style.",
NULL,
&wlmaker_arg_style_file_ptr),
BS_ARG_SENTINEL()
};
/** References auto-started subprocesses. */
static bs_ptr_stack_t wlmaker_subprocess_stack;
/** Compiled regular expression for extracting file & line no. from wlr_log. */
static regex_t wlmaker_wlr_log_regex;
/** Regular expression string for extracting file & line no. from wlr_log. */
static const char *wlmaker_wlr_log_regex_string =
"^\\[([^\\:]+)\\:([0-9]+)\\]\\ ";
/** Contents of the workspace style. */
typedef struct {
/** Workspace name. */
char name[32];
/** Background color. */
uint32_t color;
} wlmaker_workspace_style_t;
/** Style descriptor for the "Workspace" dict of wlmaker-state.plist. */
static const wlmcfg_desc_t wlmaker_workspace_style_desc[] = {
WLMCFG_DESC_CHARBUF(
"Name", true, wlmaker_workspace_style_t, name, 32, NULL),
WLMCFG_DESC_ARGB32(
"Color", false, wlmaker_workspace_style_t, color, 0),
WLMCFG_DESC_SENTINEL()
};
/* ------------------------------------------------------------------------- */
/**
* Wraps the wlr_log calls on bs_log.
*
* @param importance
* @param fmt
* @param args
*/
static void wlr_to_bs_log(
enum wlr_log_importance importance,
const char *fmt,
va_list args)
{
bs_log_severity_t severity = BS_DEBUG;
switch (importance) {
case WLR_SILENT: // Fall-through to DEBUG severity.
case WLR_DEBUG: severity = BS_DEBUG; break;
case WLR_INFO: severity = BS_INFO; break;
case WLR_ERROR: severity = BS_ERROR; break;
default: severity = BS_INFO; break;
}
if (!bs_will_log(severity)) return;
// Log to buffer. Ignores overflows.
char buf[BS_LOG_MAX_BUF_SIZE];
vsnprintf(buf, sizeof(buf), fmt, args);
regmatch_t matches[4];
if (0 != regexec(&wlmaker_wlr_log_regex, buf, 4, &matches[0], 0) ||
matches[0].rm_so != 0 ||
!(matches[0].rm_eo >= 6) || // Minimum "[x:1] ".
matches[1].rm_so != 1 ||
!(matches[2].rm_so > 2) ||
matches[3].rm_so != -1) {
bs_log(severity, "%s (wlr_log unexpected format!)", buf);
return;
}
buf[matches[1].rm_eo] = '\0';
buf[matches[2].rm_eo] = '\0';
uint64_t line_no = 0;
bs_strconvert_uint64(&buf[matches[2].rm_so], &line_no, 10);
line_no = BS_MIN((uint64_t)INT_MAX, line_no);
bs_log_write(severity, &buf[matches[1].rm_so], (int)line_no, "%s",
&buf[matches[0].rm_eo]);
}
/* ------------------------------------------------------------------------- */
/** Launches a sub-process, and keeps it on the subprocess stack. */
bool start_subprocess(const char *cmdline_ptr)
{
bs_subprocess_t *sp_ptr = bs_subprocess_create_cmdline(cmdline_ptr);
if (NULL == sp_ptr) {
bs_log(BS_ERROR, "Failed bs_subprocess_create_cmdline(\"%s\")",
cmdline_ptr);
return false;
}
if (!bs_subprocess_start(sp_ptr)) {
bs_log(BS_ERROR, "Failed bs_subprocess_start for \"%s\"",
cmdline_ptr);
return false;
}
// Push to stack. Ignore errors: We'll keep it running untracked.
bs_ptr_stack_push(&wlmaker_subprocess_stack, sp_ptr);
return true;
}
/* ------------------------------------------------------------------------- */
/** Creates workspaces as configured in the state dict. */
bool create_workspaces(
wlmcfg_dict_t *state_dict_ptr,
wlmaker_server_t *server_ptr)
{
wlmcfg_array_t *array_ptr = wlmcfg_dict_get_array(
state_dict_ptr, "Workspaces");
if (NULL == array_ptr) return false;
bool rv = true;
for (size_t i = 0; i < wlmcfg_array_size(array_ptr); ++i) {
wlmcfg_dict_t *dict_ptr = wlmcfg_dict_from_object(
wlmcfg_array_at(array_ptr, i));
if (NULL == dict_ptr) {
bs_log(BS_ERROR, "Array element in \"Workspaces\" is not a dict");
rv = false;
break;
}
wlmaker_workspace_style_t s;
if (!wlmcfg_decode_dict(dict_ptr, wlmaker_workspace_style_desc, &s)) {
bs_log(BS_ERROR,
"Failed to decode dict element %zu in \"Workspace\"",
i);
rv = false;
break;
}
wlmtk_workspace_t *workspace_ptr = wlmtk_workspace_create(
s.name, server_ptr->env_ptr);
if (NULL == workspace_ptr) {
bs_log(BS_ERROR, "Failed wlmtk_workspace_create(\"%s\", %p)",
s.name, server_ptr->env_ptr);
rv = false;
break;
}
if (s.color == 0) {
s.color = server_ptr->style.background_color;
}
wlmaker_background_t *background_ptr = wlmaker_background_create(
s.color, server_ptr->env_ptr);
if (NULL == background_ptr) {
bs_log(BS_ERROR, "Failed wlmaker_background(%p)",
server_ptr->env_ptr);
rv = false;
break;
}
wlmtk_layer_t *layer_ptr = wlmtk_workspace_get_layer(
workspace_ptr,
WLMTK_WORKSPACE_LAYER_BACKGROUND);
wlmtk_layer_add_panel(
layer_ptr,
wlmaker_background_panel(background_ptr));
wlmtk_root_add_workspace(server_ptr->root_ptr, workspace_ptr);
}
return rv;
}
/* == Main program ========================================================= */
/** The main program. */
int main(__UNUSED__ int argc, __UNUSED__ const char **argv)
{
wlmaker_dock_t *dock_ptr = NULL;
wlmaker_clip_t *clip_ptr = NULL;
wlmaker_task_list_t *task_list_ptr = NULL;
int rv = EXIT_SUCCESS;
rv = regcomp(
&wlmaker_wlr_log_regex,
wlmaker_wlr_log_regex_string,
REG_EXTENDED);
if (0 != rv) {
char err_buf[512];
regerror(rv, &wlmaker_wlr_log_regex, err_buf, sizeof(err_buf));
bs_log(BS_ERROR, "Failed compiling regular expression: %s", err_buf);
return EXIT_FAILURE;
}
wlr_log_init(WLR_DEBUG, wlr_to_bs_log);
bs_log_severity = BS_INFO;
BS_ASSERT(bs_ptr_stack_init(&wlmaker_subprocess_stack));
if (!bs_arg_parse(wlmaker_args, BS_ARG_MODE_NO_EXTRA, &argc, argv)) {
fprintf(stderr, "Failed to parse commandline arguments.\n");
bs_arg_print_usage(stderr, wlmaker_args);
return EXIT_FAILURE;
}
wlmcfg_dict_t *config_dict_ptr = wlmaker_config_load(
wlmaker_arg_config_file_ptr);
if (NULL != wlmaker_arg_config_file_ptr) free(wlmaker_arg_config_file_ptr);
if (NULL == config_dict_ptr) {
fprintf(stderr, "Failed to load & initialize configuration.\n");
return EXIT_FAILURE;
}
wlmcfg_dict_t *state_dict_ptr = wlmaker_state_load(
wlmaker_arg_state_file_ptr);
if (NULL != wlmaker_arg_state_file_ptr) free(wlmaker_arg_state_file_ptr);
if (NULL == state_dict_ptr) {
fprintf(stderr, "Failed to load & initialize state.\n");
return EXIT_FAILURE;
}
wlmaker_server_t *server_ptr = wlmaker_server_create(
config_dict_ptr, &wlmaker_server_options);
wlmcfg_dict_unref(config_dict_ptr);
if (NULL == server_ptr) return EXIT_FAILURE;
// TODO: Should be loaded from file, if given in the config. Or on the
// commandline.
wlmcfg_dict_t *style_dict_ptr = NULL;
if (NULL != wlmaker_arg_style_file_ptr) {
style_dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_file(
wlmaker_arg_style_file_ptr));
} else {
style_dict_ptr = wlmcfg_dict_from_object(
wlmcfg_create_object_from_plist_data(
embedded_binary_style_default_data,
embedded_binary_style_default_size));
}
if (NULL == style_dict_ptr) return EXIT_FAILURE;
BS_ASSERT(wlmcfg_decode_dict(
style_dict_ptr,
wlmaker_config_style_desc,
&server_ptr->style));
wlmcfg_dict_unref(style_dict_ptr);
wlmaker_action_handle_t *action_handle_ptr = wlmaker_action_bind_keys(
server_ptr,
wlmcfg_dict_get_dict(config_dict_ptr, wlmaker_action_config_dict_key));
if (NULL == action_handle_ptr) {
bs_log(BS_ERROR, "Failed to bind keys.");
return EXIT_FAILURE;
}
if (!create_workspaces(state_dict_ptr, server_ptr)) {
return EXIT_FAILURE;
}
rv = EXIT_SUCCESS;
if (wlr_backend_start(server_ptr->wlr_backend_ptr)) {
bs_log(BS_INFO, "Starting Wayland compositor for server %p at %s ...",
server_ptr, server_ptr->wl_socket_name_ptr);
setenv("WAYLAND_DISPLAY", server_ptr->wl_socket_name_ptr, true);
wlmcfg_array_t *autostarted_ptr = wlmcfg_dict_get_array(
config_dict_ptr, "Autostart");
if (NULL != autostarted_ptr) {
for (size_t i = 0; i < wlmcfg_array_size(autostarted_ptr); ++i) {
const char *cmd_ptr = wlmcfg_array_string_value_at(
autostarted_ptr, i);
if (!start_subprocess(cmd_ptr)) return EXIT_FAILURE;
}
}
dock_ptr = wlmaker_dock_create(
server_ptr, state_dict_ptr, &server_ptr->style);
clip_ptr = wlmaker_clip_create(
server_ptr, state_dict_ptr, &server_ptr->style);
task_list_ptr = wlmaker_task_list_create(server_ptr, &server_ptr->style);
if (NULL == dock_ptr || NULL == clip_ptr || NULL == task_list_ptr) {
bs_log(BS_ERROR, "Failed to create dock, clip or task list.");
} else {
wl_display_run(server_ptr->wl_display_ptr);
}
} else {
bs_log(BS_ERROR, "Failed wlmaker_server_start()");
rv = EXIT_FAILURE;
}
if (NULL != task_list_ptr) wlmaker_task_list_destroy(task_list_ptr);
if (NULL != clip_ptr) wlmaker_clip_destroy(clip_ptr);
if (NULL != dock_ptr) wlmaker_dock_destroy(dock_ptr);
wlmaker_action_unbind_keys(action_handle_ptr);
wlmaker_server_destroy(server_ptr);
bs_subprocess_t *sp_ptr;
while (NULL != (sp_ptr = bs_ptr_stack_pop(&wlmaker_subprocess_stack))) {
bs_subprocess_destroy(sp_ptr);
}
bs_ptr_stack_fini(&wlmaker_subprocess_stack);
wlmcfg_dict_unref(state_dict_ptr);
regfree(&wlmaker_wlr_log_regex);
return rv;
}
/* == End of wlmaker.c ===================================================== */
wlmaker-0.3/src/wlmaker_test.c 0000664 0000000 0000000 00000003602 14641446446 0016470 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file wlmaker_test.c
*
* @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.
*/
#include "action.h"
#include "clip.h"
#include "config.h"
#include "dock.h"
#include "keyboard.h"
#include "launcher.h"
#include "layer_panel.h"
#include "xwl_content.h"
/** WLMaker unit tests. */
const bs_test_set_t wlmaker_tests[] = {
{ 1, "action", wlmaker_action_test_cases },
{ 1, "clip", wlmaker_clip_test_cases },
{ 1, "config", wlmaker_config_test_cases },
{ 1, "dock", wlmaker_dock_test_cases },
{ 1, "launc her", wlmaker_launcher_test_cases},
{ 1, "layer_panel", wlmaker_layer_panel_test_cases },
{ 1, "server", wlmaker_server_test_cases },
#if defined(WLMAKER_HAVE_XWAYLAND)
{ 1, "xwl_content", wlmaker_xwl_content_test_cases },
#endif // defined(WLMAKER_HAVE_XWAYLAND)
{ 0, NULL, NULL }
};
#if !defined(TEST_DATA_DIR)
/** Directory root for looking up test data. See `bs_test_resolve_path`. */
#define TEST_DATA_DIR "./"
#endif // TEST_DATA_DIR
/** Main program, runs the unit tests. */
int main(int argc, const char **argv)
{
const bs_test_param_t params = {
.test_data_dir_ptr = TEST_DATA_DIR
};
return bs_test(wlmaker_tests, argc, argv, ¶ms);
}
/* == End of wlmaker_test.c ================================================ */
wlmaker-0.3/src/x11_cursor.xpm 0000664 0000000 0000000 00000003431 14641446446 0016357 0 ustar 00root root 0000000 0000000 /* XPM */
static char * x11_cursor_xpm[] = {
"20 20 85 1",
" c None",
". c #000000",
"+ c #FFFFFF",
"@ c #A2A2A2",
"# c #DDDDDD",
"$ c #969696",
"% c #2C2C2C",
"& c #E1E1E1",
"* c #8E8E8E",
"= c #0E0E0E",
"- c #343434",
"; c #E3E3E3",
"> c #8C8C8C",
", c #090909",
"' c #151515",
") c #414141",
"! c #E8E8E8",
"~ c #7F7F7F",
"{ c #030303",
"] c #101010",
"^ c #1C1C1C",
"/ c #4A4A4A",
"( c #EAEAEA",
"_ c #7D7D7D",
": c #0B0B0B",
"< c #171717",
"[ c #242424",
"} c #565656",
"| c #ECECEC",
"1 c #727272",
"2 c #050505",
"3 c #121212",
"4 c #1E1E1E",
"5 c #2B2B2B",
"6 c #626262",
"7 c #EEEEEE",
"8 c #666666",
"9 c #0C0C0C",
"0 c #191919",
"a c #262626",
"b c #323232",
"c c #6B6B6B",
"d c #646464",
"e c #070707",
"f c #141414",
"g c #202020",
"h c #2D2D2D",
"i c #393939",
"j c #777777",
"k c #585858",
"l c #020202",
"m c #1B1B1B",
"n c #272727",
"o c #404040",
"p c #7C7C7C",
"q c #535353",
"r c #DEDEDE",
"s c #EFEFEF",
"t c #4E4E4E",
"u c #1F1F1F",
"v c #6A6A6A",
"w c #C2C2C2",
"x c #222222",
"y c #E0E0E0",
"z c #434343",
"A c #B1B1B1",
"B c #828282",
"C c #878787",
"D c #B7B7B7",
"E c #E5E5E5",
"F c #767676",
"G c #1A1A1A",
"H c #FCFCFC",
"I c #737373",
"J c #BCBCBC",
"K c #808080",
"L c #B4B4B4",
"M c #757575",
"N c #818181",
"O c #4F4F4F",
"P c #EBEBEB",
"Q c #BEBEBE",
"R c #444444",
"S c #131313",
"T c #BDBDBD",
"T ",
"+@ ",
"+#$ ",
"+%&* ",
"+=-;> ",
"+,')!~ ",
"+{]^/(_ ",
"+.:<[}|1 ",
"+.2345678 ",
"+..90abc7d ",
"+..efghij7k ",
"+..l=mn-op7q ",
"+...,0r++++st ",
"+..uv]jw ",
"+.xy7m4!z ",
"+a;~AB3CD ",
"+EF )|Gn7b ",
"HI JKfLM ",
"N OPQ!n ",
" RkS "};
wlmaker-0.3/src/xdg_decoration.c 0000664 0000000 0000000 00000023750 14641446446 0016766 0 ustar 00root root 0000000 0000000 /* ========================================================================= */
/**
* @file xdg_decoration.c
*
* @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.
*/
#include "xdg_decoration.h"
#include