From 5d71ccc174aafc22053ae0ca98a58ca216737499 Mon Sep 17 00:00:00 2001 From: Ryan Farley Date: Thu, 29 Apr 2021 04:12:55 -0500 Subject: enhanced bell configuration Add a separate section for bell configuration, with a bell-specific command option and a setting to allow that command to run without regard to keyboard focus (for those of us who enjoy being beeped at at all times, for example). The actions are also no longer mutually exclusive; this is primarily anticipating urgency support which cannot be replicated outside the process (in server mode anyway) and would thus be complementary to any notification or arbitrary command. --- config.c | 52 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 34 insertions(+), 18 deletions(-) (limited to 'config.c') diff --git a/config.c b/config.c index 59534ec9..bc3dc9c0 100644 --- a/config.c +++ b/config.c @@ -593,23 +593,6 @@ parse_section_main(const char *key, const char *value, struct config *conf, } } - else if (strcmp(key, "bell") == 0) { - if (strcmp(value, "set-urgency") == 0) - conf->bell_action = BELL_ACTION_URGENT; - else if (strcmp(value, "notify") == 0) - conf->bell_action = BELL_ACTION_NOTIFY; - else if (strcmp(value, "none") == 0) - conf->bell_action = BELL_ACTION_NONE; - else { - LOG_AND_NOTIFY_ERR( - "%s:%d: [default]: bell: " - "expected either 'set-urgency', 'notify' or 'none'", - path, lineno); - conf->bell_action = BELL_ACTION_NONE; - return false; - } - } - else if (strcmp(key, "initial-window-mode") == 0) { if (strcmp(value, "windowed") == 0) conf->startup_mode = STARTUP_WINDOWED; @@ -788,6 +771,28 @@ parse_section_main(const char *key, const char *value, struct config *conf, return true; } +static bool +parse_section_bell(const char *key, const char *value, struct config *conf, + const char *path, unsigned lineno) +{ + if (strcmp(key, "urgent") == 0) + conf->bell.urgent = str_to_bool(value); + else if (strcmp(key, "notify") == 0) + conf->bell.notify = str_to_bool(value); + else if (strcmp(key, "command") == 0) { + if (!str_to_spawn_template(conf, value, &conf->bell.command, path, lineno, "bell", key)) + return false; + } + else if (strcmp(key, "command-focused") == 0) + conf->bell.command_focused = str_to_bool(value); + else { + LOG_AND_NOTIFY_ERR("%s:%u: [bell]: %s: invalid key", path, lineno, key); + return false; + } + + return true; +} + static bool parse_section_scrollback(const char *key, const char *value, struct config *conf, const char *path, unsigned lineno) @@ -1864,6 +1869,7 @@ parse_config_file(FILE *f, struct config *conf, const char *path, bool errors_ar { enum section { SECTION_MAIN, + SECTION_BELL, SECTION_SCROLLBACK, SECTION_COLORS, SECTION_CURSOR, @@ -1887,6 +1893,7 @@ parse_config_file(FILE *f, struct config *conf, const char *path, bool errors_ar const char *name; } section_info[] = { [SECTION_MAIN] = {&parse_section_main, "main"}, + [SECTION_BELL] = {&parse_section_bell, "bell"}, [SECTION_SCROLLBACK] = {&parse_section_scrollback, "scrollback"}, [SECTION_COLORS] = {&parse_section_colors, "colors"}, [SECTION_CURSOR] = {&parse_section_cursor, "cursor"}, @@ -2212,7 +2219,6 @@ config_load(struct config *conf, const char *conf_path, .enabled = false, .palette_based = false, }, - .bell_action = BELL_ACTION_NONE, .startup_mode = STARTUP_WINDOWED, .fonts = {tll_init(), tll_init(), tll_init(), tll_init()}, .line_height = { .pt = 0, .px = -1, }, @@ -2221,6 +2227,15 @@ config_load(struct config *conf, const char *conf_path, .vertical_letter_offset = {.pt = 0, .px = 0, }, .box_drawings_uses_font_glyphs = false, .dpi_aware = DPI_AWARE_AUTO, /* DPI-aware when scaling-factor == 1 */ + .bell = { + .urgent = false, + .notify = false, + .command = { + .raw_cmd = NULL, + .argv = NULL, + }, + .command_focused = false, + }, .scrollback = { .lines = 1000, .indicator = { @@ -2446,6 +2461,7 @@ config_free(struct config conf) free(conf.app_id); free(conf.word_delimiters); free(conf.jump_label_letters); + free_spawn_template(&conf.bell.command); free(conf.scrollback.indicator.text); free_spawn_template(&conf.notify); free_spawn_template(&conf.url_launch); -- cgit v1.3 From dc9751cbfe6adc8a7e7a8e6a1c61452b65a84dd6 Mon Sep 17 00:00:00 2001 From: Ryan Farley Date: Fri, 7 May 2021 04:40:07 -0500 Subject: style, consistent bool names, deprecate old config --- config.c | 26 ++++++++++++++++++++++++++ doc/foot.ini.5.scd | 10 +++++----- terminal.c | 2 +- 3 files changed, 32 insertions(+), 6 deletions(-) (limited to 'config.c') diff --git a/config.c b/config.c index bc3dc9c0..8dbd86d6 100644 --- a/config.c +++ b/config.c @@ -593,6 +593,32 @@ parse_section_main(const char *key, const char *value, struct config *conf, } } + else if (strcmp(key, "bell") == 0) { + LOG_WARN("deprecated: %s:%d: [default]: bell: set actions in section 'bell' instead", path, lineno); + + const char fmt[] = "%s:%d \033[1mbell\033[21m, use section \033[1m[bell]\033[21m instead"; + char *text = xasprintf(fmt, path, lineno); + + struct user_notification deprecation = { + .kind = USER_NOTIFICATION_DEPRECATED, + .text = text, + }; + tll_push_back(conf->notifications, deprecation); + + if (strcmp(value, "set-urgency") == 0) + conf->bell.urgent = true; + else if (strcmp(value, "notify") == 0) + conf->bell.notify = true; + /* we do nothing by default, so none may be ignored */ + else { + LOG_AND_NOTIFY_ERR( + "%s%d: [default]: bell: " + "expected either 'set-urgency', 'notify' or 'none'", + path, lineno); + return false; + } + } + else if (strcmp(key, "initial-window-mode") == 0) { if (strcmp(value, "windowed") == 0) conf->startup_mode = STARTUP_WINDOWED; diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd index 59da6f2e..1030c841 100644 --- a/doc/foot.ini.5.scd +++ b/doc/foot.ini.5.scd @@ -265,7 +265,7 @@ in this order: # SECTION: bell *urgent* - When set to _true_, the margins will be painted in red + When set to _yes_, the margins will be painted in red whenever *BEL* is received while the window does *not* have keyboard focus. Note that Wayland currently does not have an _urgency_ hint like X11. The name *urgent* was chosen for @@ -278,13 +278,13 @@ in this order: _Note_: expect this feature to be *replaced* with proper compositor urgency support once/if that gets implemented. - Default: _false_ + Default: _no_ *notify* - When set to _true_, foot will emit a desktop notification using + When set to _yes_, foot will emit a desktop notification using the command specified in the *notify* option whenever *BEL* is received and the window does *not* have keyboard focus. Default: - _false_ + _no_ *command* When set, foot will execute this command when *BEL* is received. @@ -292,7 +292,7 @@ in this order: *command-focused* Whether to run the command on *BEL* even while focused. Default: - _false_ + _no_ # SECTION: scrollback diff --git a/terminal.c b/terminal.c index f77a6d79..ab82b75b 100644 --- a/terminal.c +++ b/terminal.c @@ -2641,7 +2641,7 @@ term_bell(struct terminal *term) notify_notify(term, "Bell", "Bell in terminal"); } - if (term->conf->bell.command.argv && (!term->kbd_focus || term->conf->bell.command_focused)) { + if ((term->conf->bell.command.argv != NULL) && (!term->kbd_focus || term->conf->bell.command_focused)) { int devnull = open("/dev/null", O_RDONLY); spawn(term->reaper, NULL, term->conf->bell.command.argv, devnull, -1, -1); -- cgit v1.3 From b3117f75d8b227e98d4a9b5827e453020be76c5c Mon Sep 17 00:00:00 2001 From: Ryan Farley Date: Fri, 7 May 2021 04:41:50 -0500 Subject: clearly mark bell as a section --- config.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'config.c') diff --git a/config.c b/config.c index 8dbd86d6..044e5fce 100644 --- a/config.c +++ b/config.c @@ -594,7 +594,7 @@ parse_section_main(const char *key, const char *value, struct config *conf, } else if (strcmp(key, "bell") == 0) { - LOG_WARN("deprecated: %s:%d: [default]: bell: set actions in section 'bell' instead", path, lineno); + LOG_WARN("deprecated: %s:%d: [default]: bell: set actions in section '[bell]' instead", path, lineno); const char fmt[] = "%s:%d \033[1mbell\033[21m, use section \033[1m[bell]\033[21m instead"; char *text = xasprintf(fmt, path, lineno); -- cgit v1.3 From 5df981d23fba6241e9e16c9f623d6790cf85040d Mon Sep 17 00:00:00 2001 From: Ryan Farley Date: Fri, 7 May 2021 07:16:48 -0500 Subject: consistent booleans in config, reset legacy bell --- config.c | 12 +++++++++--- foot.ini | 6 +++--- 2 files changed, 12 insertions(+), 6 deletions(-) (limited to 'config.c') diff --git a/config.c b/config.c index 044e5fce..bf6e125a 100644 --- a/config.c +++ b/config.c @@ -605,11 +605,17 @@ parse_section_main(const char *key, const char *value, struct config *conf, }; tll_push_back(conf->notifications, deprecation); - if (strcmp(value, "set-urgency") == 0) + if (strcmp(value, "set-urgency") == 0) { + memset(&conf->bell, 0, sizeof(conf->bell)); conf->bell.urgent = true; - else if (strcmp(value, "notify") == 0) + } + else if (strcmp(value, "notify") == 0) { + memset(&conf->bell, 0, sizeof(conf->bell)); conf->bell.notify = true; - /* we do nothing by default, so none may be ignored */ + } + else if (strcmp(value, "none") == 0) { + memset(&conf->bell, 0, sizeof(conf->bell)); + } else { LOG_AND_NOTIFY_ERR( "%s%d: [default]: bell: " diff --git a/foot.ini b/foot.ini index 5b348cf1..6f0948a2 100644 --- a/foot.ini +++ b/foot.ini @@ -33,10 +33,10 @@ # osc8-underline=url-mode [bell] -# urgent=false -# notify=false +# urgent=no +# notify=no # command= -# command_focused=false +# command_focused=no [scrollback] # lines=1000 -- cgit v1.3