Add herbe (notification display)
This commit is contained in:
24
programs/herbe/Makefile
Normal file
24
programs/herbe/Makefile
Normal file
@@ -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
|
||||
|
||||
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
|
||||
139
programs/herbe/README.md
Normal file
139
programs/herbe/README.md
Normal file
@@ -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.
|
||||
19
programs/herbe/config.def.h
Normal file
19
programs/herbe/config.def.h
Normal file
@@ -0,0 +1,19 @@
|
||||
static const char *background_color = "#3e3e3e";
|
||||
static const char *border_color = "#ececec";
|
||||
static const char *font_color = "#ececec";
|
||||
static const char *font_pattern = "JetBrainsMono NF:size=10";
|
||||
static const unsigned line_spacing = 5;
|
||||
static const unsigned int padding = 15;
|
||||
|
||||
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
|
||||
220
programs/herbe/herbe.c
Normal file
220
programs/herbe/herbe.c
Normal file
@@ -0,0 +1,220 @@
|
||||
#include <X11/Xlib.h>
|
||||
#include <X11/Xft/Xft.h>
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <signal.h>
|
||||
#include <unistd.h>
|
||||
#include <string.h>
|
||||
#include <stdarg.h>
|
||||
#include <fcntl.h>
|
||||
#include <semaphore.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);
|
||||
}
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
if (argc == 1)
|
||||
{
|
||||
sem_unlink("/herbe");
|
||||
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_width = DisplayWidth(display, screen);
|
||||
int screen_height = DisplayHeight(display, screen);
|
||||
|
||||
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';
|
||||
}
|
||||
}
|
||||
|
||||
unsigned int x = pos_x;
|
||||
unsigned int 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;
|
||||
|
||||
if (corner == BOTTOM_LEFT || corner == BOTTOM_RIGHT)
|
||||
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);
|
||||
|
||||
sem_t *mutex = sem_open("/herbe", O_CREAT, 0644, 1);
|
||||
sem_wait(mutex);
|
||||
|
||||
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;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
sem_post(mutex);
|
||||
sem_close(mutex);
|
||||
|
||||
for (int i = 0; i < num_of_lines; i++)
|
||||
free(lines[i]);
|
||||
|
||||
free(lines);
|
||||
XftDrawDestroy(draw);
|
||||
XftColorFree(display, visual, colormap, &color);
|
||||
XftFontClose(display, font);
|
||||
XCloseDisplay(display);
|
||||
|
||||
return exit_code;
|
||||
}
|
||||
Reference in New Issue
Block a user