diff options
Diffstat (limited to '')
| -rw-r--r-- | .gitignore | 5 | ||||
| -rw-r--r-- | LICENSE | 21 | ||||
| -rw-r--r-- | Makefile | 24 | ||||
| -rw-r--r-- | README.md | 139 | ||||
| -rw-r--r-- | applied/19.diff | 100 | ||||
| -rw-r--r-- | applied/21.diff | 80 | ||||
| -rw-r--r-- | config.def.h | 20 | ||||
| -rw-r--r-- | herbe.c | 248 |
8 files changed, 637 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2fde11 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +herbe +config.h +.ccls-cache +.rej +.orig @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Samuel Dudík + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..55509cf --- /dev/null +++ b/Makefile @@ -0,0 +1,24 @@ +CFLAGS = -Wall -Wextra -pedantic -lX11 -lXft -I/usr/include/freetype2 -pthread + +PREFIX ?= /usr/local +CC ?= cc + +all: herbe + +config.h: config.def.h + cp config.def.h config.h + +herbe: herbe.c config.h + $(CC) herbe.c $(CFLAGS) -o herbe -lXrandr + +install: herbe + mkdir -p ${DESTDIR}${PREFIX}/bin + cp -f herbe ${DESTDIR}${PREFIX}/bin + +uninstall: + rm -f ${DESTDIR}${PREFIX}/bin/herbe + +clean: + rm -f herbe + +.PHONY: all install uninstall clean diff --git a/README.md b/README.md new file mode 100644 index 0000000..25eb20c --- /dev/null +++ b/README.md @@ -0,0 +1,139 @@ +# 🌱 herbe +> Daemon-less notifications without D-Bus. Minimal and lightweight. + +<p align="center"> + <img src="https://user-images.githubusercontent.com/24730635/90975811-cd62fd00-e537-11ea-9169-92e68a71d0a0.gif" /> +</p> + +## Features +* Under 200 lines of code +* Doesn't run in the background, just displays the notification and exits +* No external dependencies except Xlib and Xft +* Configurable through `config.h` or Xresources ([using this patch](https://github.com/dudik/herbe/pull/11)) +* [Actions support](#actions) +* Extensible through [patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch) + +## Table of contents + +* [Usage](#usage) + * [Patches](#patches) + * [Dismiss a notification](#dismiss-a-notification) + * [Actions](#actions) + * [Newlines](#newlines) + * [Multiple notifications](#multiple-notifications) + * [Notifications don't show up](#notifications-dont-show-up) +* [Installation](#installation) + * [Packages](#packages) + * [Dependencies](#dependencies) + * [Build](#build) +* [Configuration](#configuration) +* [Contribute](#contribute) + +## Usage + +### Patches +[List of available patches](https://github.com/dudik/herbe/pulls?q=is%3Aopen+is%3Apr+label%3Apatch) + +To create a new patch you'll have to open a pull request with your changes. Append `.diff` to the pull request URL to get a downloadable diff file. Don't forget to prefix the title with `patch:` and to apply the `patch` label to it. For inspiration, look at [my Xresources patch](https://github.com/dudik/herbe/pull/11). Thank you. + +_Note: This patching method was heavily inspired by [dylan's sowm](https://github.com/dylanaraps/sowm)._ + +### Dismiss a notification +A notification can be dismissed either by clicking on it with `DISMISS_BUTTON` (set in config.h, defaults to left mouse button) or sending a `SIGUSR1` signal to it: +```shell +$ pkill -SIGUSR1 herbe +``` +Dismissed notifications return exit code 2. + +### Actions +Action is a piece of shell code that runs when a notification gets accepted. Accepting a notification is the same as dismissing it, but you have to use either `ACTION_BUTTON` (defaults to right mouse button) or the `SIGUSR2` signal. +An accepted notification always returns exit code 0. To specify an action: +```shell +$ herbe "Notification body" && echo "This is an action" +``` +Where everything after `&&` is the action and will get executed after the notification gets accepted. + +### Newlines +Every command line argument gets printed on a separate line by default e.g.: +```shell +$ herbe "First line" "Second line" "Third line" ... +``` +You can also use `\n` e.g. in `bash`: +```shell +$ herbe $'First line\nSecond line\nThird line' +``` +But by default `herbe` prints `\n` literally: +```shell +$ herbe "First line\nStill the first line" +``` +Output of other programs will get printed correctly, just make sure to escape it (so you don't end up with every word on a separate line): +```shell +$ herbe "$(ps axch -o cmd:15,%cpu --sort=-%cpu | head)" +``` + +### Multiple notifications +Notifications are put in a queue and shown one after another in order of creation (first in, first out). They don't overlap and each one is shown for its entire duration. + +### Notifications don't show up +Most likely a running notification got terminated forcefully (SIGKILL or any uncaught signal) which caused the semaphore not getting unlocked. First, kill any `herbe` instance that is stuck: +```shell +$ pkill -SIGKILL herbe +``` +Then just call `herbe` without any arguments: +```shell +$ herbe +``` +Notifications should now show up as expected. + +Don't ever send any signals to `herbe` except these: +```shell +# same as pkill -SIGTERM herbe, terminates every running herbe process +$ pkill herbe + +$ pkill -SIGUSR1 herbe +$ pkill -SIGUSR2 herbe +``` +And you should be fine. That's all you really need to interact with `herbe`. + +## Installation +### Packages +[](https://repology.org/project/herbe/versions) + +[OpenBSD patch](https://github.com/dudik/herbe/pull/4) + +[FreeBSD patch](https://github.com/dudik/herbe/pull/16) + +[Wayland port](https://github.com/muevoid/Wayherb) by [muevoid](https://github.com/muevoid) + +**Only the [herbe-git AUR package](https://aur.archlinux.org/packages/herbe-git/) is maintained by me.** + +### Dependencies +* X11 (Xlib) +* Xft + +The names of packages are different depending on which distribution you use. +For example, if you use [Void Linux](https://voidlinux.org/) you will have to install these dependencies: +```shell +sudo xbps-install base-devel libX11-devel libXft-devel +``` + +### Build +```shell +git clone https://github.com/dudik/herbe +cd herbe +sudo make install +``` +`make install` requires root privileges because it copies the resulting binary to `/usr/local/bin`. This makes `herbe` accessible globally. + +You can also use `make clean` to remove the binary from the build folder, `sudo make uninstall` to remove the binary from `/usr/local/bin` or just `make` to build the binary locally. + +## Configuration +herbe is configured at compile-time by editing `config.h`. Every option should be self-explanatory. There is no `height` option because height is determined by font size and text padding. + +[Xresources patch](https://github.com/dudik/herbe/pull/11) + +## Contribute +If you want to report a bug or you have a feature request, feel free to [open an issue](https://github.com/dudik/herbe/issues). + +## Projects with herbe integration +- [qutebrowser](https://qutebrowser.org/) supports showing web notifications via herbe, via the `content.notifications.presenter` setting. diff --git a/applied/19.diff b/applied/19.diff new file mode 100644 index 0000000..2ece3fb --- /dev/null +++ b/applied/19.diff @@ -0,0 +1,100 @@ +diff --git a/herbe.c b/herbe.c +index 51d3990..8bfdbc1 100644 +--- a/herbe.c ++++ b/herbe.c +@@ -7,7 +7,8 @@ + #include <string.h> + #include <stdarg.h> + #include <fcntl.h> +-#include <semaphore.h> ++#include <sys/ipc.h> ++#include <sys/shm.h> + + #include "config.h" + +@@ -79,13 +80,23 @@ void expire(int sig) + XFlush(display); + } + ++void read_y_offset(unsigned int **offset, int *id) { ++ int shm_id = shmget(8432, sizeof(unsigned int), IPC_CREAT | 0660); ++ if (shm_id == -1) die("shmget failed"); ++ ++ *offset = (unsigned int *)shmat(shm_id, 0, 0); ++ if (*offset == (unsigned int *)-1) die("shmat failed\n"); ++ *id = shm_id; ++} ++ ++void free_y_offset(int id) { ++ shmctl(id, IPC_RMID, NULL); ++} ++ + int main(int argc, char *argv[]) + { + if (argc == 1) +- { +- sem_unlink("/herbe"); +- die("Usage: %s body", argv[0]); +- } ++ die("Usage: %s body", argv[0]); + + struct sigaction act_expire, act_ignore; + +@@ -151,16 +162,22 @@ int main(int argc, char *argv[]) + } + } + +- unsigned int x = pos_x; +- unsigned int y = pos_y; ++ int y_offset_id; ++ unsigned int *y_offset; ++ read_y_offset(&y_offset, &y_offset_id); ++ + unsigned int text_height = font->ascent - font->descent; + unsigned int height = (num_of_lines - 1) * line_spacing + num_of_lines * text_height + 2 * padding; ++ unsigned int x = pos_x; ++ unsigned int y = pos_y + *y_offset; ++ ++ unsigned int used_y_offset = (*y_offset) += height + padding; + + if (corner == TOP_RIGHT || corner == BOTTOM_RIGHT) +- x = screen_width - width - border_size * 2 - pos_x; ++ x = screen_width - width - border_size * 2 - x; + + if (corner == BOTTOM_LEFT || corner == BOTTOM_RIGHT) +- y = screen_height - height - border_size * 2 - pos_y; ++ y = screen_height - height - border_size * 2 - y; + + window = XCreateWindow(display, RootWindow(display, screen), x, y, width, height, border_size, DefaultDepth(display, screen), + CopyFromParent, visual, CWOverrideRedirect | CWBackPixel | CWBorderPixel, &attributes); +@@ -171,9 +188,6 @@ int main(int argc, char *argv[]) + XSelectInput(display, window, ExposureMask | ButtonPress); + XMapWindow(display, window); + +- sem_t *mutex = sem_open("/herbe", O_CREAT, 0644, 1); +- sem_wait(mutex); +- + sigaction(SIGUSR1, &act_expire, 0); + sigaction(SIGUSR2, &act_expire, 0); + +@@ -204,12 +218,11 @@ int main(int argc, char *argv[]) + } + } + +- sem_post(mutex); +- sem_close(mutex); + + for (int i = 0; i < num_of_lines; i++) + free(lines[i]); + ++ if (used_y_offset == *y_offset) free_y_offset(y_offset_id); + free(lines); + XftDrawDestroy(draw); + XftColorFree(display, visual, colormap, &color); +@@ -217,4 +230,4 @@ int main(int argc, char *argv[]) + XCloseDisplay(display); + + return exit_code; +-} +\ No newline at end of file ++} diff --git a/applied/21.diff b/applied/21.diff new file mode 100644 index 0000000..412c034 --- /dev/null +++ b/applied/21.diff @@ -0,0 +1,80 @@ +diff --git a/Makefile b/Makefile +index 3225e36..55509cf 100644 +--- a/Makefile ++++ b/Makefile +@@ -9,7 +9,7 @@ config.h: config.def.h + cp config.def.h config.h + + herbe: herbe.c config.h +- $(CC) herbe.c $(CFLAGS) -o herbe ++ $(CC) herbe.c $(CFLAGS) -o herbe -lXrandr + + install: herbe + mkdir -p ${DESTDIR}${PREFIX}/bin +diff --git a/config.def.h b/config.def.h +index 86b7e76..f8bf499 100644 +--- a/config.def.h ++++ b/config.def.h +@@ -4,6 +4,7 @@ static const char *font_color = "#ececec"; + static const char *font_pattern = "monospace:size=10"; + static const unsigned line_spacing = 5; + static const unsigned int padding = 15; ++static const int use_primary_monitor = 0; + + static const unsigned int width = 450; + static const unsigned int border_size = 2; +diff --git a/herbe.c b/herbe.c +index 51d3990..a2277f0 100644 +--- a/herbe.c ++++ b/herbe.c +@@ -1,5 +1,6 @@ + #include <X11/Xlib.h> + #include <X11/Xft/Xft.h> ++#include <X11/extensions/Xrandr.h> + #include <stdio.h> + #include <stdlib.h> + #include <signal.h> +@@ -111,8 +112,22 @@ int main(int argc, char *argv[]) + Visual *visual = DefaultVisual(display, screen); + Colormap colormap = DefaultColormap(display, screen); + ++ int screen_x = 0; ++ int screen_y = 0; + int screen_width = DisplayWidth(display, screen); + int screen_height = DisplayHeight(display, screen); ++ if(use_primary_monitor) { ++ int nMonitors; ++ XRRMonitorInfo* info = XRRGetMonitors(display, RootWindow(display, screen), 1, &nMonitors); ++ for(int i = 0; i < nMonitors; i++) { ++ if(info[i].primary) { ++ screen_x = info[i].x; ++ screen_y = info[i].y; ++ screen_width = info[i].width; ++ screen_height = info[i].height; ++ } ++ } ++ } + + XSetWindowAttributes attributes; + attributes.override_redirect = True; +@@ -151,16 +166,16 @@ int main(int argc, char *argv[]) + } + } + +- unsigned int x = pos_x; +- unsigned int y = pos_y; ++ unsigned int x = screen_x + pos_x; ++ unsigned int y = screen_y + pos_y; + unsigned int text_height = font->ascent - font->descent; + unsigned int height = (num_of_lines - 1) * line_spacing + num_of_lines * text_height + 2 * padding; + + if (corner == TOP_RIGHT || corner == BOTTOM_RIGHT) +- x = screen_width - width - border_size * 2 - pos_x; ++ x = screen_x + screen_width - width - border_size * 2 - pos_x; + + if (corner == BOTTOM_LEFT || corner == BOTTOM_RIGHT) +- y = screen_height - height - border_size * 2 - pos_y; ++ y = screen_y + screen_height - height - border_size * 2 - pos_y; + + window = XCreateWindow(display, RootWindow(display, screen), x, y, width, height, border_size, DefaultDepth(display, screen), + CopyFromParent, visual, CWOverrideRedirect | CWBackPixel | CWBorderPixel, &attributes); diff --git a/config.def.h b/config.def.h new file mode 100644 index 0000000..7d83bc3 --- /dev/null +++ b/config.def.h @@ -0,0 +1,20 @@ +static const char *background_color = "#3e3e3e"; +static const char *border_color = "#ececec"; +static const char *font_color = "#ececec"; +static const char *font_pattern = "monospace:size=10"; +static const unsigned line_spacing = 5; +static const unsigned int padding = 15; +static const int use_primary_monitor = 1; + +static const unsigned int width = 450; +static const unsigned int border_size = 2; +static const unsigned int pos_x = 30; +static const unsigned int pos_y = 60; + +enum corners { TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT }; +enum corners corner = TOP_RIGHT; + +static const unsigned int duration = 5; /* in seconds */ + +#define DISMISS_BUTTON Button1 +#define ACTION_BUTTON Button3 @@ -0,0 +1,248 @@ +#include <X11/Xlib.h> +#include <X11/Xft/Xft.h> +#include <X11/extensions/Xrandr.h> +#include <stdio.h> +#include <stdlib.h> +#include <signal.h> +#include <unistd.h> +#include <string.h> +#include <stdarg.h> +#include <fcntl.h> +#include <sys/ipc.h> +#include <sys/shm.h> + +#include "config.h" + +#define EXIT_ACTION 0 +#define EXIT_FAIL 1 +#define EXIT_DISMISS 2 + +Display *display; +Window window; +int exit_code = EXIT_DISMISS; + +static void die(const char *format, ...) +{ + va_list ap; + va_start(ap, format); + vfprintf(stderr, format, ap); + fprintf(stderr, "\n"); + va_end(ap); + exit(EXIT_FAIL); +} + +int get_max_len(char *string, XftFont *font, int max_text_width) +{ + int eol = strlen(string); + XGlyphInfo info; + XftTextExtentsUtf8(display, font, (FcChar8 *)string, eol, &info); + + if (info.width > max_text_width) + { + eol = max_text_width / font->max_advance_width; + info.width = 0; + + while (info.width < max_text_width) + { + eol++; + XftTextExtentsUtf8(display, font, (FcChar8 *)string, eol, &info); + } + + eol--; + } + + for (int i = 0; i < eol; i++) + if (string[i] == '\n') + { + string[i] = ' '; + return ++i; + } + + if (info.width <= max_text_width) + return eol; + + int temp = eol; + + while (string[eol] != ' ' && eol) + --eol; + + if (eol == 0) + return temp; + else + return ++eol; +} + +void expire(int sig) +{ + XEvent event; + event.type = ButtonPress; + event.xbutton.button = (sig == SIGUSR2) ? (ACTION_BUTTON) : (DISMISS_BUTTON); + XSendEvent(display, window, 0, 0, &event); + XFlush(display); +} + +void read_y_offset(unsigned int **offset, int *id) { + int shm_id = shmget(8432, sizeof(unsigned int), IPC_CREAT | 0660); + if (shm_id == -1) die("shmget failed"); + + *offset = (unsigned int *)shmat(shm_id, 0, 0); + if (*offset == (unsigned int *)-1) die("shmat failed\n"); + *id = shm_id; +} + +void free_y_offset(int id) { + shmctl(id, IPC_RMID, NULL); +} + +int main(int argc, char *argv[]) +{ + if (argc == 1) + die("Usage: %s body", argv[0]); + + struct sigaction act_expire, act_ignore; + + act_expire.sa_handler = expire; + act_expire.sa_flags = SA_RESTART; + sigemptyset(&act_expire.sa_mask); + + act_ignore.sa_handler = SIG_IGN; + act_ignore.sa_flags = 0; + sigemptyset(&act_ignore.sa_mask); + + sigaction(SIGALRM, &act_expire, 0); + sigaction(SIGTERM, &act_expire, 0); + sigaction(SIGINT, &act_expire, 0); + + sigaction(SIGUSR1, &act_ignore, 0); + sigaction(SIGUSR2, &act_ignore, 0); + + if (!(display = XOpenDisplay(0))) + die("Cannot open display"); + + int screen = DefaultScreen(display); + Visual *visual = DefaultVisual(display, screen); + Colormap colormap = DefaultColormap(display, screen); + + int screen_x = 0; + int screen_y = 0; + int screen_width = DisplayWidth(display, screen); + int screen_height = DisplayHeight(display, screen); + if(use_primary_monitor) { + int nMonitors; + XRRMonitorInfo* info = XRRGetMonitors(display, RootWindow(display, screen), 1, &nMonitors); + for(int i = 0; i < nMonitors; i++) { + if(info[i].primary) { + screen_x = info[i].x; + screen_y = info[i].y; + screen_width = info[i].width; + screen_height = info[i].height; + } + } + } + + XSetWindowAttributes attributes; + attributes.override_redirect = True; + XftColor color; + XftColorAllocName(display, visual, colormap, background_color, &color); + attributes.background_pixel = color.pixel; + XftColorAllocName(display, visual, colormap, border_color, &color); + attributes.border_pixel = color.pixel; + + int num_of_lines = 0; + int max_text_width = width - 2 * padding; + int lines_size = 5; + char **lines = malloc(lines_size * sizeof(char *)); + if (!lines) + die("malloc failed"); + + XftFont *font = XftFontOpenName(display, screen, font_pattern); + + for (int i = 1; i < argc; i++) + { + for (unsigned int eol = get_max_len(argv[i], font, max_text_width); eol; argv[i] += eol, num_of_lines++, eol = get_max_len(argv[i], font, max_text_width)) + { + if (lines_size <= num_of_lines) + { + lines = realloc(lines, (lines_size += 5) * sizeof(char *)); + if (!lines) + die("realloc failed"); + } + + lines[num_of_lines] = malloc((eol + 1) * sizeof(char)); + if (!lines[num_of_lines]) + die("malloc failed"); + + strncpy(lines[num_of_lines], argv[i], eol); + lines[num_of_lines][eol] = '\0'; + } + } + + int y_offset_id; + unsigned int *y_offset; + read_y_offset(&y_offset, &y_offset_id); + + unsigned int text_height = font->ascent - font->descent; + unsigned int height = (num_of_lines - 1) * line_spacing + num_of_lines * text_height + 2 * padding; + unsigned int x = screen_x + pos_x; + unsigned int y = screen_y + pos_y + *y_offset; + + unsigned int used_y_offset = (*y_offset) += height + padding; + + if (corner == TOP_RIGHT || corner == BOTTOM_RIGHT) + x = screen_x + screen_width - width - border_size * 2 - pos_x; + + if (corner == BOTTOM_LEFT || corner == BOTTOM_RIGHT) + y = screen_y + screen_height - height - border_size * 2 - pos_y; + + window = XCreateWindow(display, RootWindow(display, screen), x, y, width, height, border_size, DefaultDepth(display, screen), + CopyFromParent, visual, CWOverrideRedirect | CWBackPixel | CWBorderPixel, &attributes); + + XftDraw *draw = XftDrawCreate(display, window, visual, colormap); + XftColorAllocName(display, visual, colormap, font_color, &color); + + XSelectInput(display, window, ExposureMask | ButtonPress); + XMapWindow(display, window); + + sigaction(SIGUSR1, &act_expire, 0); + sigaction(SIGUSR2, &act_expire, 0); + + if (duration != 0) + alarm(duration); + + for (;;) + { + XEvent event; + XNextEvent(display, &event); + + if (event.type == Expose) + { + XClearWindow(display, window); + for (int i = 0; i < num_of_lines; i++) + XftDrawStringUtf8(draw, &color, font, padding, line_spacing * i + text_height * (i + 1) + padding, + (FcChar8 *)lines[i], strlen(lines[i])); + } + else if (event.type == ButtonPress) + { + if (event.xbutton.button == DISMISS_BUTTON) + break; + else if (event.xbutton.button == ACTION_BUTTON) + { + exit_code = EXIT_ACTION; + break; + } + } + } + + + for (int i = 0; i < num_of_lines; i++) + free(lines[i]); + + if (used_y_offset == *y_offset) free_y_offset(y_offset_id); + free(lines); + XftDrawDestroy(draw); + XftColorFree(display, visual, colormap, &color); + XftFontClose(display, font); + XCloseDisplay(display); + + return exit_code; +} |