mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2025-11-03 09:01:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
sway/include/commands.h

182 lines
4.5 KiB
C
Raw Normal View History

Build out command subsystem Everyone loves code stolen from your own projects
2015-08-05 17:30:40 -04:00
#ifndef _SWAY_COMMANDS_H
#define _SWAY_COMMANDS_H
#include <stdbool.h>
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
#include <json-c/json.h>
commands: Learn mouse_warping. Place mouse at center of focused view when changing to a workspace on a different output, if option is enabled. (This replicates existing i3 option.) This can be triggered in multiple ways: A) via `workspace <name>` which changes output B) via `focus <direction>` which changes output C) via `focus output <name>` which (obviously) changes output
2015-10-26 12:20:32 +01:00
#include <wlc/wlc.h>
Build out command subsystem Everyone loves code stolen from your own projects
2015-08-05 17:30:40 -04:00
#include "config.h"
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Indicates the result of a command's execution.
*/
enum cmd_status {
CMD_SUCCESS, /**< The command was successful */
CMD_FAILURE, /**< The command resulted in an error */
CMD_INVALID, /**< Unknown command or parser error */
CMD_DEFER, /**< Command execution deferred */
multi command keybinds
2015-09-14 19:59:25 -07:00
// Config Blocks
CMD_BLOCK_END,
CMD_BLOCK_MODE,
Add bar config struct and defaults
2015-11-29 17:02:09 -05:00
CMD_BLOCK_BAR,
libinput
2016-01-17 02:53:37 -08:00
CMD_BLOCK_BAR_COLORS,
CMD_BLOCK_INPUT
Build out command subsystem Everyone loves code stolen from your own projects
2015-08-05 17:30:40 -04:00
};
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Stores the result of executing a command.
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
struct cmd_results {
enum cmd_status status;
commands: cmd_results->input is duplicated/freed.
2015-10-23 13:03:14 +02:00
char *input;
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Human friendly error message, or NULL on success
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
char *error;
};
refactor commands.c
2016-09-01 21:39:08 -05:00
enum expected_args {
EXPECTED_MORE_THAN,
EXPECTED_AT_LEAST,
EXPECTED_LESS_THAN,
EXPECTED_EQUAL_TO
};
struct cmd_results *checkarg(int argc, const char *name, enum expected_args type, int val);
struct cmd_results *add_color(const char*, char*, const char*);
void input_cmd_apply(struct input_config *input);
void hide_view_in_scratchpad(swayc_t *sp_view);
swayc_t *sp_view;
int sp_index;
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Parse and handles a command.
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
struct cmd_results *handle_command(char *command);
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Parse and handles a command during config file loading.
*
* Do not use this under normal conditions.
*/
Add framework for switching command sets This will allow the bar {} block to have a different command set (and also bar { colors { } }.
2015-11-29 17:20:27 -05:00
struct cmd_results *config_command(char *command, enum cmd_status block);
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Allocates a cmd_results object.
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
struct cmd_results *cmd_results_new(enum cmd_status status, const char* input, const char *error, ...);
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Frees a cmd_results object.
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
void free_cmd_results(struct cmd_results *results);
Add some documentation comments This is mostly setting a precedent, I hope that others will continue to write docs for more headers. Ref #218
2015-11-08 12:06:12 -05:00
/**
* Serializes cmd_results to a JSON string.
*
* Free the JSON string later on.
*/
ipc,commands,config: Replace cmd_status enum with cmd_results struct. In i3 the ipc reply will contain a human readable error message, and this patch replicates that behaviour. However, that error message is also useful for logging, which this patch takes advantage of. E.g. instead of logging errors directly in commands.c/checkargs, it is fed back to the caller which eventually ends up logging everything with maximum context available (config.c/read_config). So instead of logging e.g. "Error on line 'exit'" it will now log: "Error on line 'exit': Can't execute from config."
2015-10-22 14:14:13 +02:00
const char *cmd_results_to_json(struct cmd_results *results);
Build out command subsystem Everyone loves code stolen from your own projects
2015-08-05 17:30:40 -04:00
Match definition with declaration
2016-05-23 14:42:03 +02:00
void remove_view_from_scratchpad(swayc_t *);
Made scratchpad handling identical to i3
2015-08-29 21:14:13 -05:00
refactor commands.c
2016-09-01 21:39:08 -05:00
/**
* Actual command function signatures for individual .c files in commands/ directory.
*/
typedef struct cmd_results *sway_cmd(int argc, char **argv);
sway_cmd cmd_assign;
sway_cmd cmd_bar;
sway_cmd cmd_bindcode;
sway_cmd cmd_bindsym;
sway_cmd cmd_border;
sway_cmd cmd_client_focused;
sway_cmd cmd_client_focused_inactive;
sway_cmd cmd_client_unfocused;
sway_cmd cmd_client_urgent;
sway_cmd cmd_client_placeholder;
sway_cmd cmd_client_background;
sway_cmd cmd_debuglog;
sway_cmd cmd_exec;
sway_cmd cmd_exec_always;
sway_cmd cmd_exit;
sway_cmd cmd_floating;
sway_cmd cmd_floating_maximum_size;
sway_cmd cmd_floating_minimum_size;
sway_cmd cmd_floating_mod;
sway_cmd cmd_floating_scroll;
sway_cmd cmd_focus;
sway_cmd cmd_focus_follows_mouse;
sway_cmd cmd_font;
sway_cmd cmd_for_window;
sway_cmd cmd_fullscreen;
sway_cmd cmd_gaps;
sway_cmd cmd_hide_edge_borders;
sway_cmd cmd_include;
sway_cmd cmd_input;
sway_cmd cmd_kill;
sway_cmd cmd_layout;
sway_cmd cmd_log_colors;
sway_cmd cmd_mode;
sway_cmd cmd_mouse_warping;
sway_cmd cmd_move;
sway_cmd cmd_new_float;
sway_cmd cmd_new_window;
sway_cmd cmd_orientation;
sway_cmd cmd_output;
sway_cmd cmd_reload;
sway_cmd cmd_resize;
sway_cmd cmd_scratchpad;
sway_cmd cmd_seamless_mouse;
sway_cmd cmd_set;
sway_cmd cmd_smart_gaps;
sway_cmd cmd_split;
sway_cmd cmd_splith;
sway_cmd cmd_splitt;
sway_cmd cmd_splitv;
sway_cmd cmd_sticky;
sway_cmd cmd_workspace;
sway_cmd cmd_ws_auto_back_and_forth;
sway_cmd cmd_workspace_layout;
sway_cmd bar_cmd_binding_mode_indicator;
sway_cmd bar_cmd_bindsym;
sway_cmd bar_cmd_colors;
sway_cmd bar_cmd_font;
sway_cmd bar_cmd_mode;
sway_cmd bar_cmd_modifier;
sway_cmd bar_cmd_output;
sway_cmd bar_cmd_height;
sway_cmd bar_cmd_hidden_state;
sway_cmd bar_cmd_id;
sway_cmd bar_cmd_position;
sway_cmd bar_cmd_separator_symbol;
sway_cmd bar_cmd_status_command;
sway_cmd bar_cmd_pango_markup;
sway_cmd bar_cmd_strip_workspace_numbers;
sway_cmd bar_cmd_swaybar_command;
sway_cmd bar_cmd_tray_output;
sway_cmd bar_cmd_tray_padding;
sway_cmd bar_cmd_wrap_scroll;
sway_cmd bar_cmd_workspace_buttons;
sway_cmd bar_colors_cmd_active_workspace;
sway_cmd bar_colors_cmd_background;
sway_cmd bar_colors_cmd_background;
sway_cmd bar_colors_cmd_binding_mode;
sway_cmd bar_colors_cmd_focused_workspace;
sway_cmd bar_colors_cmd_inactive_workspace;
sway_cmd bar_colors_cmd_separator;
sway_cmd bar_colors_cmd_statusline;
sway_cmd bar_colors_cmd_urgent_workspace;
sway_cmd input_cmd_accel_profile;
sway_cmd input_cmd_click_method;
sway_cmd input_cmd_drag_lock;
sway_cmd input_cmd_dwt;
sway_cmd input_cmd_events;
sway_cmd input_cmd_middle_emulation;
sway_cmd input_cmd_natural_scroll;
sway_cmd input_cmd_pointer_accel;
sway_cmd input_cmd_scroll_method;
sway_cmd input_cmd_tap;
Build out command subsystem Everyone loves code stolen from your own projects
2015-08-05 17:30:40 -04:00
#endif
Reference in a new issue Copy permalink