sway-patched-tray-menu-github/include/sway/config.h

538 lines
12 KiB
C
Raw Normal View History

2017-12-05 10:40:55 +01:00
#ifndef _SWAY_CONFIG_H
#define _SWAY_CONFIG_H
#include <libinput.h>
#include <stdint.h>
2017-12-05 18:21:48 +01:00
#include <string.h>
#include <time.h>
2017-12-05 18:21:48 +01:00
#include <wlr/types/wlr_box.h>
2017-12-05 10:40:55 +01:00
#include <xkbcommon/xkbcommon.h>
#include "list.h"
#include "swaynag.h"
#include "tree/container.h"
#include "sway/tree/root.h"
#include "wlr-layer-shell-unstable-v1-protocol.h"
2017-12-05 10:40:55 +01:00
2018-03-29 23:41:02 +02:00
// TODO: Refactor this shit
2017-12-05 10:40:55 +01:00
/**
* Describes a variable created via the `set` command.
*/
struct sway_variable {
char *name;
char *value;
};
enum binding_input_type {
BINDING_KEYCODE,
BINDING_KEYSYM,
BINDING_MOUSE,
};
enum binding_flags {
BINDING_RELEASE=1,
BINDING_LOCKED=2, // keyboard only
BINDING_BORDER=4, // mouse only; trigger on container border
BINDING_CONTENTS=8, // mouse only; trigger on container contents
BINDING_TITLEBAR=16, // mouse only; trigger on container titlebar
BINDING_RELOAD=32, // the binding runs the reload command
};
2017-12-05 10:40:55 +01:00
/**
* A key binding and an associated command.
*/
struct sway_binding {
enum binding_input_type type;
2017-12-05 10:40:55 +01:00
int order;
uint32_t flags;
list_t *keys; // sorted in ascending order
2017-12-05 10:40:55 +01:00
uint32_t modifiers;
char *command;
};
/**
* A mouse binding and an associated command.
*/
struct sway_mouse_binding {
uint32_t button;
char *command;
};
/**
* Focus on window activation.
*/
enum sway_fowa {
FOWA_SMART,
FOWA_URGENT,
FOWA_FOCUS,
FOWA_NONE,
};
2017-12-05 10:40:55 +01:00
/**
* A "mode" of keybindings created via the `mode` command.
*/
struct sway_mode {
char *name;
2017-12-27 16:08:18 +01:00
list_t *keysym_bindings;
list_t *keycode_bindings;
list_t *mouse_bindings;
2018-07-06 00:12:14 +02:00
bool pango;
2017-12-05 10:40:55 +01:00
};
2018-04-24 20:39:29 +02:00
struct input_config_mapped_from_region {
double x1, y1;
double x2, y2;
bool mm;
};
2017-12-05 10:40:55 +01:00
/**
* options for input devices
2017-12-05 10:40:55 +01:00
*/
struct input_config {
char *identifier;
int accel_profile;
int click_method;
int drag_lock;
int dwt;
int left_handed;
int middle_emulation;
int natural_scroll;
float pointer_accel;
int repeat_delay;
int repeat_rate;
int scroll_button;
2017-12-05 10:40:55 +01:00
int scroll_method;
int send_events;
int tap;
int tap_button_map;
2017-12-05 10:40:55 +01:00
2017-12-15 11:22:51 +01:00
char *xkb_layout;
char *xkb_model;
char *xkb_options;
char *xkb_rules;
char *xkb_variant;
int xkb_numlock;
int xkb_capslock;
2018-04-24 20:39:29 +02:00
struct input_config_mapped_from_region *mapped_from_region;
char *mapped_to_output;
2017-12-05 10:40:55 +01:00
bool capturable;
2017-12-05 18:21:48 +01:00
struct wlr_box region;
2017-12-14 17:11:56 +01:00
};
/**
* Options for misc device configurations that happen in the seat block
*/
struct seat_attachment_config {
char *identifier;
// TODO other things are configured here for some reason
};
/**
* Options for multiseat and other misc device configurations
*/
struct seat_config {
char *name;
2017-12-17 16:39:22 +01:00
int fallback; // -1 means not set
2017-12-14 17:11:56 +01:00
list_t *attachments; // list of seat_attachment configs
2017-12-05 10:40:55 +01:00
};
enum config_dpms {
DPMS_IGNORE,
DPMS_ON,
DPMS_OFF
};
2017-12-05 10:40:55 +01:00
/**
* Size and position configuration for a particular output.
*
* This is set via the `output` command.
*/
struct output_config {
char *name;
int enabled;
int width, height;
2017-12-06 12:36:06 +01:00
float refresh_rate;
2017-12-05 10:40:55 +01:00
int x, y;
float scale;
int32_t transform;
2017-12-06 12:36:06 +01:00
2017-12-05 10:40:55 +01:00
char *background;
char *background_option;
char *background_fallback;
enum config_dpms dpms_state;
2017-12-05 10:40:55 +01:00
};
/**
* Maps a workspace name to an output name.
*
* Set via `workspace <x> output <y>`
*/
struct workspace_output {
char *output;
char *workspace;
};
struct bar_config {
/**
* One of "dock", "hide", "invisible"
*
* Always visible in dock mode. Visible only when modifier key is held in hide mode.
* Never visible in invisible mode.
*/
char *mode;
/**
* One of "show" or "hide".
*
* In "show" mode, it will always be shown on top of the active workspace.
*/
char *hidden_state;
/**
* Id name used to identify the bar through IPC.
*
* Defaults to bar-x, where x corresponds to the position of the
* embedding bar block in the config file (bar-0, bar-1, ...).
*/
char *id;
uint32_t modifier;
list_t *outputs;
char *position;
2017-12-05 10:40:55 +01:00
list_t *bindings;
char *status_command;
bool pango_markup;
char *swaybar_command;
char *font;
int height; // -1 not defined
bool workspace_buttons;
bool wrap_scroll;
char *separator_symbol;
bool strip_workspace_numbers;
bool binding_mode_indicator;
bool verbose;
pid_t pid;
struct {
char *background;
char *statusline;
char *separator;
char *focused_background;
char *focused_statusline;
char *focused_separator;
char *focused_workspace_border;
char *focused_workspace_bg;
char *focused_workspace_text;
char *active_workspace_border;
char *active_workspace_bg;
char *active_workspace_text;
char *inactive_workspace_border;
char *inactive_workspace_bg;
char *inactive_workspace_text;
char *urgent_workspace_border;
char *urgent_workspace_bg;
char *urgent_workspace_text;
char *binding_mode_border;
char *binding_mode_bg;
char *binding_mode_text;
} colors;
};
struct border_colors {
float border[4];
float background[4];
2018-05-03 14:14:17 +02:00
float text[4];
float indicator[4];
float child_border[4];
2017-12-05 10:40:55 +01:00
};
enum edge_border_types {
E_NONE, /**< Don't hide edge borders */
E_VERTICAL, /**< hide vertical edge borders */
E_HORIZONTAL, /**< hide horizontal edge borders */
E_BOTH, /**< hide vertical and horizontal edge borders */
E_SMART /**< hide both if precisely one window is present in workspace */
};
enum command_context {
CONTEXT_CONFIG = 1,
CONTEXT_BINDING = 2,
CONTEXT_IPC = 4,
CONTEXT_CRITERIA = 8,
CONTEXT_ALL = 0xFFFFFFFF,
};
struct command_policy {
char *command;
uint32_t context;
};
enum secure_feature {
FEATURE_LOCK = 1,
FEATURE_PANEL = 2,
FEATURE_BACKGROUND = 4,
FEATURE_SCREENSHOT = 8,
FEATURE_FULLSCREEN = 16,
FEATURE_KEYBOARD = 32,
FEATURE_MOUSE = 64,
};
struct feature_policy {
char *program;
uint32_t features;
};
enum ipc_feature {
IPC_FEATURE_COMMAND = 1,
IPC_FEATURE_GET_WORKSPACES = 2,
IPC_FEATURE_GET_OUTPUTS = 4,
IPC_FEATURE_GET_TREE = 8,
IPC_FEATURE_GET_MARKS = 16,
IPC_FEATURE_GET_BAR_CONFIG = 32,
IPC_FEATURE_GET_VERSION = 64,
IPC_FEATURE_GET_INPUTS = 128,
IPC_FEATURE_EVENT_WORKSPACE = 256,
IPC_FEATURE_EVENT_OUTPUT = 512,
IPC_FEATURE_EVENT_MODE = 1024,
IPC_FEATURE_EVENT_WINDOW = 2048,
IPC_FEATURE_EVENT_BINDING = 4096,
IPC_FEATURE_EVENT_INPUT = 8192,
IPC_FEATURE_GET_SEATS = 16384,
2017-12-05 10:40:55 +01:00
2018-05-11 15:51:47 +02:00
IPC_FEATURE_ALL_COMMANDS =
1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 16384,
2017-12-05 10:40:55 +01:00
IPC_FEATURE_ALL_EVENTS = 256 | 512 | 1024 | 2048 | 4096 | 8192,
IPC_FEATURE_ALL = IPC_FEATURE_ALL_COMMANDS | IPC_FEATURE_ALL_EVENTS,
};
struct ipc_policy {
char *program;
uint32_t features;
};
2018-05-28 05:20:21 +02:00
enum focus_wrapping_mode {
WRAP_NO,
WRAP_YES,
WRAP_FORCE
};
2017-12-05 10:40:55 +01:00
/**
* The configuration struct. The result of loading a config file.
*/
struct sway_config {
char *swaynag_command;
struct swaynag_instance swaynag_config_errors;
2017-12-05 10:40:55 +01:00
list_t *symbols;
list_t *modes;
list_t *bars;
list_t *cmd_queue;
list_t *workspace_outputs;
list_t *output_configs;
list_t *input_configs;
2017-12-14 17:11:56 +01:00
list_t *seat_configs;
2017-12-05 10:40:55 +01:00
list_t *criteria;
list_t *no_focus;
list_t *active_bar_modifiers;
struct sway_mode *current_mode;
struct bar_config *current_bar;
2018-03-29 23:49:44 +02:00
char *swaybg_command;
2017-12-05 10:40:55 +01:00
uint32_t floating_mod;
bool floating_mod_inverse;
2017-12-05 10:40:55 +01:00
uint32_t dragging_key;
uint32_t resizing_key;
char *floating_scroll_up_cmd;
char *floating_scroll_down_cmd;
char *floating_scroll_left_cmd;
char *floating_scroll_right_cmd;
enum sway_container_layout default_orientation;
enum sway_container_layout default_layout;
2017-12-05 10:40:55 +01:00
char *font;
size_t font_height;
size_t font_baseline;
bool pango_markup;
size_t urgent_timeout;
enum sway_fowa focus_on_window_activation;
2017-12-05 10:40:55 +01:00
// Flags
bool focus_follows_mouse;
bool mouse_warping;
2018-05-28 05:20:21 +02:00
enum focus_wrapping_mode focus_wrapping;
2017-12-05 10:40:55 +01:00
bool active;
bool failed;
bool reloading;
bool reading;
bool validating;
2017-12-05 10:40:55 +01:00
bool auto_back_and_forth;
bool show_marks;
bool edge_gaps;
bool smart_gaps;
int gaps_inner;
int gaps_outer;
list_t *config_chain;
2018-07-08 21:34:47 +02:00
const char *current_config_path;
2017-12-05 10:40:55 +01:00
const char *current_config;
enum sway_container_border border;
enum sway_container_border floating_border;
2017-12-05 10:40:55 +01:00
int border_thickness;
int floating_border_thickness;
enum edge_border_types hide_edge_borders;
// border colors
struct {
struct border_colors focused;
struct border_colors focused_inactive;
struct border_colors unfocused;
struct border_colors urgent;
struct border_colors placeholder;
float background[4];
2017-12-05 10:40:55 +01:00
} border_colors;
// floating view
int32_t floating_maximum_width;
int32_t floating_maximum_height;
int32_t floating_minimum_width;
int32_t floating_minimum_height;
// Security
list_t *command_policies;
list_t *feature_policies;
list_t *ipc_policies;
2018-01-20 17:32:07 +01:00
// Context for command handlers
struct {
struct input_config *input_config;
struct output_config *output_config;
2018-01-20 17:44:34 +01:00
struct seat_config *seat_config;
2018-01-20 20:10:11 +01:00
struct sway_seat *seat;
Implement type safe arguments and demote sway_container This commit changes the meaning of sway_container so that it only refers to layout containers and view containers. Workspaces, outputs and the root are no longer known as containers. Instead, root, outputs, workspaces and containers are all a type of node, and containers come in two types: layout containers and view containers. In addition to the above, this implements type safe variables. This means we use specific types such as sway_output and sway_workspace instead of generic containers or nodes. However, it's worth noting that in a few places places (eg. seat focus and transactions) referring to them in a generic way is unavoidable which is why we still use nodes in some places. If you want a TL;DR, look at node.h, as well as the struct definitions for root, output, workspace and container. Note that sway_output now contains a workspaces list, and workspaces now contain a tiling and floating list, and containers now contain a pointer back to the workspace. There are now functions for seat_get_focused_workspace and seat_get_focused_container. The latter will return NULL if a workspace itself is focused. Most other seat functions like seat_get_focus and seat_set_focus now accept and return nodes. In the config->handler_context struct, current_container has been replaced with three pointers: node, container and workspace. node is the same as what current_container was, while workspace is the workspace that the node resides on and container is the actual container, which may be NULL if a workspace itself is focused. The global root_container variable has been replaced with one simply called root, which is a pointer to the sway_root instance. The way outputs are created, enabled, disabled and destroyed has changed. Previously we'd wrap the sway_output in a container when it is enabled, but as we don't have containers any more it needs a different approach. The output_create and output_destroy functions previously created/destroyed the container, but now they create/destroy the sway_output. There is a new function output_disable to disable an output without destroying it. Containers have a new view property. If this is populated then the container is a view container, otherwise it's a layout container. Like before, this property is immutable for the life of the container. Containers have both a `sway_container *parent` and `sway_workspace *workspace`. As we use specific types now, parent cannot point to a workspace so it'll be NULL for containers which are direct children of the workspace. The workspace property is set for all containers, except those which are hidden in the scratchpad as they have no workspace. In some cases we need to refer to workspaces in a container-like way. For example, workspaces have layout and children, but when using specific types this makes it difficult. Likewise, it's difficult for a container to get its parent's layout when the parent could be another container or a workspace. To make it easier, some helper functions have been created: container_parent_layout and container_get_siblings. container_remove_child has been renamed to container_detach and container_replace_child has been renamed to container_replace. `container_handle_fullscreen_reparent(con, old_parent)` has had the old_parent removed. We now unfullscreen the workspace when detaching the container, so this function is simplified and only needs one argument now. container_notify_subtree_changed has been renamed to container_update_representation. This is more descriptive of its purpose. I also wanted to be able to call it with whatever container was changed rather than the container's parent, which makes bubbling up to the workspace easier. There are now state structs per node thing. ie. sway_output_state, sway_workspace_state and sway_container_state. The focus, move and layout commands have been completely refactored to work with the specific types. I considered making these a separate PR, but I'd be backporting my changes only to replace them again, and it's easier just to test everything at once.
2018-08-30 13:00:10 +02:00
struct sway_node *node;
struct sway_container *container;
struct sway_workspace *workspace;
bool using_criteria;
struct {
int argc;
char **argv;
} leftovers;
2018-01-20 17:32:07 +01:00
} handler_context;
2017-12-05 10:40:55 +01:00
};
/**
* Loads the main config from the given path. is_active should be true when
* reloading the config.
*/
bool load_main_config(const char *path, bool is_active, bool validating);
2017-12-05 10:40:55 +01:00
/**
* Loads an included config. Can only be used after load_main_config.
*/
2018-08-02 05:54:40 +02:00
bool load_include_configs(const char *path, struct sway_config *config,
struct swaynag_instance *swaynag);
2017-12-05 10:40:55 +01:00
/**
* Reads the config from the given FILE.
*/
bool read_config(FILE *file, struct sway_config *config,
struct swaynag_instance *swaynag);
2017-12-05 10:40:55 +01:00
/**
* Free config struct
*/
void free_config(struct sway_config *config);
2018-01-20 17:32:07 +01:00
2017-12-29 15:31:04 +01:00
void free_sway_variable(struct sway_variable *var);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
/**
* Does variable replacement for a string based on the config's currently loaded variables.
*/
char *do_var_replacement(char *str);
struct cmd_results *check_security_config();
int input_identifier_cmp(const void *item, const void *data);
2018-04-02 18:16:00 +02:00
2017-12-12 14:29:37 +01:00
struct input_config *new_input_config(const char* identifier);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
void merge_input_config(struct input_config *dst, struct input_config *src);
2018-04-02 18:16:00 +02:00
struct input_config *copy_input_config(struct input_config *ic);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
void free_input_config(struct input_config *ic);
2018-04-02 18:16:00 +02:00
2017-12-16 18:14:24 +01:00
void apply_input_config(struct input_config *input);
2017-12-05 10:40:55 +01:00
2017-12-14 17:11:56 +01:00
int seat_name_cmp(const void *item, const void *data);
2018-04-02 18:16:00 +02:00
2017-12-14 17:11:56 +01:00
struct seat_config *new_seat_config(const char* name);
2018-04-02 18:16:00 +02:00
2017-12-14 17:11:56 +01:00
void merge_seat_config(struct seat_config *dst, struct seat_config *src);
2018-04-02 18:16:00 +02:00
struct seat_config *copy_seat_config(struct seat_config *seat);
2018-04-02 18:16:00 +02:00
2017-12-14 17:11:56 +01:00
void free_seat_config(struct seat_config *ic);
2018-04-02 18:16:00 +02:00
2017-12-14 17:11:56 +01:00
struct seat_attachment_config *seat_attachment_config_new();
2018-04-02 18:16:00 +02:00
2017-12-14 17:11:56 +01:00
struct seat_attachment_config *seat_config_get_attachment(
struct seat_config *seat_config, char *identifier);
2018-04-02 18:16:00 +02:00
2017-12-16 18:14:24 +01:00
void apply_seat_config(struct seat_config *seat);
2017-12-14 17:11:56 +01:00
2017-12-05 10:40:55 +01:00
int output_name_cmp(const void *item, const void *data);
2018-04-02 18:16:00 +02:00
void output_get_identifier(char *identifier, size_t len,
struct sway_output *output);
2018-04-02 18:16:00 +02:00
struct output_config *new_output_config(const char *name);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
void merge_output_config(struct output_config *dst, struct output_config *src);
2018-04-02 18:16:00 +02:00
Implement type safe arguments and demote sway_container This commit changes the meaning of sway_container so that it only refers to layout containers and view containers. Workspaces, outputs and the root are no longer known as containers. Instead, root, outputs, workspaces and containers are all a type of node, and containers come in two types: layout containers and view containers. In addition to the above, this implements type safe variables. This means we use specific types such as sway_output and sway_workspace instead of generic containers or nodes. However, it's worth noting that in a few places places (eg. seat focus and transactions) referring to them in a generic way is unavoidable which is why we still use nodes in some places. If you want a TL;DR, look at node.h, as well as the struct definitions for root, output, workspace and container. Note that sway_output now contains a workspaces list, and workspaces now contain a tiling and floating list, and containers now contain a pointer back to the workspace. There are now functions for seat_get_focused_workspace and seat_get_focused_container. The latter will return NULL if a workspace itself is focused. Most other seat functions like seat_get_focus and seat_set_focus now accept and return nodes. In the config->handler_context struct, current_container has been replaced with three pointers: node, container and workspace. node is the same as what current_container was, while workspace is the workspace that the node resides on and container is the actual container, which may be NULL if a workspace itself is focused. The global root_container variable has been replaced with one simply called root, which is a pointer to the sway_root instance. The way outputs are created, enabled, disabled and destroyed has changed. Previously we'd wrap the sway_output in a container when it is enabled, but as we don't have containers any more it needs a different approach. The output_create and output_destroy functions previously created/destroyed the container, but now they create/destroy the sway_output. There is a new function output_disable to disable an output without destroying it. Containers have a new view property. If this is populated then the container is a view container, otherwise it's a layout container. Like before, this property is immutable for the life of the container. Containers have both a `sway_container *parent` and `sway_workspace *workspace`. As we use specific types now, parent cannot point to a workspace so it'll be NULL for containers which are direct children of the workspace. The workspace property is set for all containers, except those which are hidden in the scratchpad as they have no workspace. In some cases we need to refer to workspaces in a container-like way. For example, workspaces have layout and children, but when using specific types this makes it difficult. Likewise, it's difficult for a container to get its parent's layout when the parent could be another container or a workspace. To make it easier, some helper functions have been created: container_parent_layout and container_get_siblings. container_remove_child has been renamed to container_detach and container_replace_child has been renamed to container_replace. `container_handle_fullscreen_reparent(con, old_parent)` has had the old_parent removed. We now unfullscreen the workspace when detaching the container, so this function is simplified and only needs one argument now. container_notify_subtree_changed has been renamed to container_update_representation. This is more descriptive of its purpose. I also wanted to be able to call it with whatever container was changed rather than the container's parent, which makes bubbling up to the workspace easier. There are now state structs per node thing. ie. sway_output_state, sway_workspace_state and sway_container_state. The focus, move and layout commands have been completely refactored to work with the specific types. I considered making these a separate PR, but I'd be backporting my changes only to replace them again, and it's easier just to test everything at once.
2018-08-30 13:00:10 +02:00
void apply_output_config(struct output_config *oc, struct sway_output *output);
2018-04-02 18:16:00 +02:00
2018-07-20 18:32:29 +02:00
struct output_config *store_output_config(struct output_config *oc);
2018-07-21 04:17:20 +02:00
void apply_output_config_to_outputs(struct output_config *oc);
2017-12-05 10:40:55 +01:00
void free_output_config(struct output_config *oc);
2018-07-21 04:17:20 +02:00
void create_default_output_configs(void);
2017-12-05 10:40:55 +01:00
int workspace_output_cmp_workspace(const void *a, const void *b);
int sway_binding_cmp(const void *a, const void *b);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
int sway_binding_cmp_qsort(const void *a, const void *b);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
int sway_binding_cmp_keys(const void *a, const void *b);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
void free_sway_binding(struct sway_binding *sb);
2018-04-02 18:16:00 +02:00
void seat_execute_command(struct sway_seat *seat, struct sway_binding *binding);
2017-12-05 10:40:55 +01:00
void load_swaybars();
2018-04-02 18:16:00 +02:00
2018-03-30 00:07:03 +02:00
void invoke_swaybar(struct bar_config *bar);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
void terminate_swaybg(pid_t pid);
2018-04-02 18:16:00 +02:00
2017-12-05 10:40:55 +01:00
struct bar_config *default_bar_config(void);
2018-04-02 18:16:00 +02:00
2018-03-29 23:41:02 +02:00
void free_bar_config(struct bar_config *bar);
2017-12-05 10:40:55 +01:00
/**
* Updates the value of config->font_height based on the max title height
* reported by each container. If recalculate is true, the containers will
* recalculate their heights before reporting.
*
* If the height has changed, all containers will be rearranged to take on the
* new size.
*/
void config_update_font_height(bool recalculate);
2018-05-02 15:07:52 +02:00
2018-03-29 23:41:02 +02:00
/* Global config singleton. */
2017-12-05 10:40:55 +01:00
extern struct sway_config *config;
#endif