swaylock/include/swaylock.h
Manuel Stoeckl 31ebd85fe0 Separate input and auth state
This commit establishes separate state machines for auth state (whether
the password submitted is being verified or is wrong) and input state
(typing indicators and clear message -- things relevant to the state of
the password being typed in, before it is submitted.) This makes it
possible to display the auth state while updating the input state (for
example, show that the previously submitted password is 'verifying' or
'wrong' while typing another.)

The two state machines interact only when submitting a password. There
is some interference with the rendering code -- a 'cleared' message
from the input state machine supersedes verifying/wrong messages from
the auth state machine; although since the 'clear' state has a shorter
timeout than the auth 'invalid' state, this is unlikely to hide the 'wrong'
message.
2023-05-09 12:40:41 +02:00

147 lines
4.3 KiB
C

#ifndef _SWAYLOCK_H
#define _SWAYLOCK_H
#include <stdbool.h>
#include <stdint.h>
#include <wayland-client.h>
#include "background-image.h"
#include "cairo.h"
#include "pool-buffer.h"
#include "seat.h"
// Indicator state: status of authentication attempt
enum auth_state {
AUTH_STATE_IDLE, // nothing happening
AUTH_STATE_VALIDATING, // currently validating password
AUTH_STATE_INVALID, // displaying message: password was wrong
};
// Indicator state: status of password buffer / typing letters
enum input_state {
INPUT_STATE_IDLE, // nothing happening; other states decay to this after time
INPUT_STATE_CLEAR, // displaying message: password buffer was cleared
INPUT_STATE_LETTER, // pressed a key that input a letter
INPUT_STATE_BACKSPACE, // pressed backspace and removed a letter
INPUT_STATE_NEUTRAL, // pressed a key (like Ctrl) that did nothing
};
struct swaylock_colorset {
uint32_t input;
uint32_t cleared;
uint32_t caps_lock;
uint32_t verifying;
uint32_t wrong;
};
struct swaylock_colors {
uint32_t background;
uint32_t bs_highlight;
uint32_t key_highlight;
uint32_t caps_lock_bs_highlight;
uint32_t caps_lock_key_highlight;
uint32_t separator;
uint32_t layout_background;
uint32_t layout_border;
uint32_t layout_text;
struct swaylock_colorset inside;
struct swaylock_colorset line;
struct swaylock_colorset ring;
struct swaylock_colorset text;
};
struct swaylock_args {
struct swaylock_colors colors;
enum background_mode mode;
char *font;
uint32_t font_size;
uint32_t radius;
uint32_t thickness;
uint32_t indicator_x_position;
uint32_t indicator_y_position;
bool override_indicator_x_position;
bool override_indicator_y_position;
bool ignore_empty;
bool show_indicator;
bool show_caps_lock_text;
bool show_caps_lock_indicator;
bool show_keyboard_layout;
bool hide_keyboard_layout;
bool show_failed_attempts;
bool daemonize;
int ready_fd;
bool indicator_idle_visible;
};
struct swaylock_password {
size_t len;
size_t buffer_len;
char *buffer;
};
struct swaylock_state {
struct loop *eventloop;
struct loop_timer *input_idle_timer; // timer to reset input state to IDLE
struct loop_timer *auth_idle_timer; // timer to stop displaying AUTH_STATE_INVALID
struct loop_timer *clear_password_timer; // clears the password buffer
struct wl_display *display;
struct wl_compositor *compositor;
struct wl_subcompositor *subcompositor;
struct wl_shm *shm;
struct wl_list surfaces;
struct wl_list images;
struct swaylock_args args;
struct swaylock_password password;
struct swaylock_xkb xkb;
cairo_surface_t *test_surface;
cairo_t *test_cairo; // used to estimate font/text sizes
enum auth_state auth_state; // state of the authentication attempt
enum input_state input_state; // state of the password buffer and key inputs
uint32_t highlight_start; // position of highlight; 2048 = 1 full turn
int failed_attempts;
bool run_display, locked;
struct ext_session_lock_manager_v1 *ext_session_lock_manager_v1;
struct ext_session_lock_v1 *ext_session_lock_v1;
};
struct swaylock_surface {
cairo_surface_t *image;
struct swaylock_state *state;
struct wl_output *output;
uint32_t output_global_name;
struct wl_surface *surface; // surface for background
struct wl_surface *child; // indicator surface made into subsurface
struct wl_subsurface *subsurface;
struct ext_session_lock_surface_v1 *ext_session_lock_surface_v1;
struct pool_buffer indicator_buffers[2];
bool frame_pending, dirty;
uint32_t width, height;
int32_t scale;
enum wl_output_subpixel subpixel;
char *output_name;
struct wl_list link;
// Dimensions of last wl_buffer committed to background surface
int last_buffer_width, last_buffer_height;
};
// There is exactly one swaylock_image for each -i argument
struct swaylock_image {
char *path;
char *output_name;
cairo_surface_t *cairo_surface;
struct wl_list link;
};
void swaylock_handle_key(struct swaylock_state *state,
xkb_keysym_t keysym, uint32_t codepoint);
void render_frame_background(struct swaylock_surface *surface);
void render_frame(struct swaylock_surface *surface);
void damage_surface(struct swaylock_surface *surface);
void damage_state(struct swaylock_state *state);
void clear_password_buffer(struct swaylock_password *pw);
void schedule_auth_idle(struct swaylock_state *state);
void initialize_pw_backend(int argc, char **argv);
void run_pw_backend_child(void);
void clear_buffer(char *buf, size_t size);
#endif